source: mauRepo/CedaMarkup/trunk/ceda_markup/atom/info.py @ 8418

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/mauRepo/CedaMarkup/trunk/ceda_markup/atom/info.py@8418
Revision 8418, 3.0 KB checked in by mnagni, 7 years ago (diff)

Incomplete - # 22513: missing ValidTime? in the GML tag library
 http://team.ceda.ac.uk/trac/ceda/ticket/22513

Even if this release adds the required tag, the most important difference with the version 0.0.2 is the library itself which has been deeply changed to add more flexibility for future development.
The main difference is that now the class is not composed by classes per markup type but from createXXX function per markup type which directly return an Element instance.

Another major add is a rich collection of unittests

  • Property svn:mime-type set to text/plain
Line 
1'''
2BSD Licence
3Copyright (c) 2012, Science & Technology Facilities Council (STFC)
4All rights reserved.
5
6Redistribution and use in source and binary forms, with or without modification,
7are permitted provided that the following conditions are met:
8
9    * Redistributions of source code must retain the above copyright notice,
10        this list of conditions and the following disclaimer.
11    * Redistributions in binary form must reproduce the above copyright notice,
12        this list of conditions and the following disclaimer in the documentation
13        and/or other materials provided with the distribution.
14    * Neither the name of the Science & Technology Facilities Council (STFC)
15        nor the names of its contributors may be used to endorse or promote
16        products derived from this software without specific prior written permission.
17
18THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
20THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
22BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
23OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29Created on 25 May 2012
30
31@author: Maurizio Nagni
32'''
33from xml.etree.ElementTree import Element
34from ceda_markup.atom.atom import ATOM_NAMESPACE, ATOM_PREFIX
35from ceda_markup.markup import createMarkup
36
37'''
38classdocs
39'''
40TEXT_TYPE = 'text'
41HTML_TYPE = 'html'
42XHTML_TYPE = 'xhtml'
43TYPES = [TEXT_TYPE, HTML_TYPE, XHTML_TYPE]
44
45def _assignTypeAtribute(itype, markup, body):
46    if itype not in TYPES:
47        raise Exception("Type is not allowed")
48
49    if itype != TEXT_TYPE:
50        markup.set('type', itype)
51    if itype == HTML_TYPE or itype == TEXT_TYPE:
52        markup.text = body
53
54    if itype == XHTML_TYPE and isinstance(body, Element):
55        markup.append(body)
56    return markup   
57
58
59def createTitle(root = None, ns = ATOM_NAMESPACE, body = None, itype = TEXT_TYPE):
60    markup = createMarkup('title', ATOM_PREFIX, ns, root = root)
61    return _assignTypeAtribute(itype, markup, body)
62
63def createSummary(root = None, ns = ATOM_NAMESPACE, body = None, itype = TEXT_TYPE):
64    markup = createMarkup('summary', ATOM_PREFIX, ns, root = root)
65    return _assignTypeAtribute(itype, markup, body)
66
67def createContent(root = None, ns = ATOM_NAMESPACE, body = None, itype = TEXT_TYPE):
68    markup = createMarkup('content', ATOM_PREFIX, ns, root = root)
69    return _assignTypeAtribute(itype, markup, body)
70
71def createRights(root = None, ns = ATOM_NAMESPACE, body = None, itype = TEXT_TYPE):
72    markup = createMarkup('rights', ATOM_PREFIX, ns, root = root)
73    return _assignTypeAtribute(itype, markup, body)
Note: See TracBrowser for help on using the repository browser.