source: mauRepo/CedaMarkup/tags/0.0.4/ceda_markup/atom/atom.py @ 8448

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

Incomplete - # 22518: The description is broken
 http://team.ceda.ac.uk/trac/ceda/ticket/22518

The pythonlib is not able to correctly serialize boolean type as explained here  http://code.google.com/p/gdata-python-client/issues/detail?id=611 where a workaround is suggested and applied here

  • 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 6 May 2012
30
31@author: Maurizio Nagni
32'''
33from xml.etree.ElementTree import Element, SubElement, _ElementInterface
34from ceda_markup.markup import createMarkup
35
36ATOM_NAMESPACE = 'http://www.w3.org/2005/Atom'
37ATOM_PREFIX = 'atom'
38ATOM_ROOT_TAG = 'feed'
39
40def createDocument(iid, title, updated, subtitle = None, rights = None):
41    top = createAtom()       
42   
43    ititle = SubElement(top, 'title')
44    ititle.text = title
45   
46    iupdated = SubElement(top, 'updated')
47    iupdated.text = updated             
48   
49    doc_id = SubElement(top, 'id')
50    doc_id.text = iid
51   
52    if subtitle:
53        subtitle = SubElement(top, 'subtitle')
54        subtitle.text = subtitle
55       
56    if rights:
57        rights = SubElement(top, 'rights')
58        rights.text = rights           
59
60   
61    return top
62
63def createAtom(root = None, tagName = ATOM_ROOT_TAG, ns = ATOM_NAMESPACE):     
64    '''
65        @param root: the root tag of the document containing this element
66        @param tagName: the tagName
67        @param ns: the tag namespace       
68    '''
69    return createMarkup(tagName, ATOM_PREFIX, ns, root)
70
71def createID(iid, root = None, ns = ATOM_NAMESPACE):     
72    '''
73        @param iid: a unique identifier, eventually an URI   
74        @param root: the root tag of the document containing this element
75        @param ns: the tag namespace       
76    '''
77    markup = createMarkup('id', ATOM_PREFIX, ns, root)       
78    markup.text = str(iid)   
79    return markup
80
81def createUpdated(updated, root = None, ns = ATOM_NAMESPACE):     
82    '''
83        @param updated: is a Date construct indicating the most
84   recent instant in time when an entry or feed was modified in a way
85   the publisher considers significant.
86        @param root: the root tag of the document containing this element
87        @param ns: the tag namespace       
88    '''
89    markup = createMarkup('updated', ATOM_PREFIX, ns, root)       
90    markup.text = str(updated)   
91    return markup
92
93def createPublished(published, root = None, ns = ATOM_NAMESPACE):     
94    '''
95        @param published: is a Date construct indicating an
96   instant in time associated with an event early in the life cycle of
97   the entry   
98        @param root: the root tag of the document containing this element
99        @param ns: the tag namespace       
100    '''
101    markup = createMarkup('published', ATOM_PREFIX, ns, root)       
102    markup.text = str(published)   
103    return markup
104
105ATOM_LINK_REL_SELF = 'self'
106ATOM_LINK_REL_FIRST = 'first'
107ATOM_LINK_REL_LAST = 'last'
108ATOM_LINK_REL_SEARCH = 'search'
109ATOM_LINK_REL = [ATOM_LINK_REL_SELF, ATOM_LINK_REL_FIRST, ATOM_LINK_REL_LAST, ATOM_LINK_REL_SEARCH]
110def createLink(iri, rel = None, itype = None, root = None, ns = ATOM_NAMESPACE):     
111    '''
112        @param iri: contains the link's IRI
113        @param rel: a string like 'self', 'first', 'last', ...
114        @param itype: an advisory media type as 'application/atom+xml'       
115        @param root: the root tag of the document containing this element
116        @param ns: the tag namespace       
117    '''
118    markup = createMarkup('link', ATOM_PREFIX, ns, root)
119    markup.set('href', iri)
120    if rel is not None:
121        markup.set('rel', rel)           
122    if itype is not None:
123        markup.set('type', itype)       
124    return markup
Note: See TracBrowser for help on using the repository browser.