3
[]7< @ s d Z ddlZddlmZ ddlmZ ddlmZ ddlmZ ddlm Z ej
d e dd
d Z dd d
Z
dd ZeG dd deZeG dd deZdS )a
werkzeug.contrib.atom
~~~~~~~~~~~~~~~~~~~~~
This module provides a class called :class:`AtomFeed` which can be
used to generate feeds in the Atom syndication format (see :rfc:`4287`).
Example::
def atom_feed(request):
feed = AtomFeed("My Blog", feed_url=request.url,
url=request.host_url,
subtitle="My example blog for a feed test.")
for post in Post.query.limit(10).all():
feed.add(post.title, post.body, content_type='html',
author=post.author, url=post.url, id=post.uid,
updated=post.last_update, published=post.pub_date)
return feed.get_response()
:copyright: 2007 Pallets
:license: BSD-3-Clause
N)datetime )implements_to_string) string_types)escape) BaseResponsez\'werkzeug.contrib.atom' is deprecated as of version 0.15 and will be removed in version 1.0.)
stacklevelz http://www.w3.org/1999/xhtmlc C sB |dkrd| t || f S |s.d| t|| f S d| |t|| f S )z?Helper function for the builder that creates an XML text block.Zxhtmlz/<%s type="xhtml">
%s
z <%s>%s
z<%s type="%s">%s
)XHTML_NAMESPACEr )namecontent content_type r
9/tmp/pip-build-w1as9q70/Werkzeug/werkzeug/contrib/atom.py_make_text_block* s r c C s | j }| jr|S |d S )z$Format a datetime object for iso8601Z) isoformattzinfo)objZiso8601r
r
r format_iso86018 s r c @ sV e Zd ZdZdZdddZdd Zdd Zd
d Zd d
Z dd Z
dd Z dd Z dS )AtomFeeda A helper class that creates Atom feeds.
:param title: the title of the feed. Required.
:param title_type: the type attribute for the title element. One of
``'html'``, ``'text'`` or ``'xhtml'``.
:param url: the url for the feed (not the url *of* the feed)
:param id: a globally unique id for the feed. Must be an URI. If
not present the `feed_url` is used, but one of both is
required.
:param updated: the time the feed was modified the last time. Must
be a :class:`datetime.datetime` object. If not
present the latest entry's `updated` is used.
Treated as UTC if naive datetime.
:param feed_url: the URL to the feed. Should be the URL that was
requested.
:param author: the author of the feed. Must be either a string (the
name) or a dict with name (required) and uri or
email (both optional). Can be a list of (may be
mixed, too) strings and dicts, too, if there are
multiple authors. Required if not every entry has an
author element.
:param icon: an icon for the feed.
:param logo: a logo for the feed.
:param rights: copyright information for the feed.
:param rights_type: the type attribute for the rights element. One of
``'html'``, ``'text'`` or ``'xhtml'``. Default is
``'text'``.
:param subtitle: a short description of the feed.
:param subtitle_type: the type attribute for the subtitle element.
One of ``'text'``, ``'html'``, ``'text'``
or ``'xhtml'``. Default is ``'text'``.
:param links: additional links. Must be a list of dictionaries with
href (required) and rel, type, hreflang, title, length
(all optional)
:param generator: the software that generated this feed. This must be
a tuple in the form ``(name, url, version)``. If
you don't want to specify one of them, set the item
to `None`.
:param entries: a list with the entries for the feed. Entries can also
be added later with :meth:`add`.
For more information on the elements see
http://www.atomenabled.org/developers/syndication/
Everywhere where a list is demanded, any iterable can be used.
WerkzeugNc K s || _ |jdd| _|jd| _|jd| j| _|jd| j| _|jd| _|jdf | _|jd| _|jd | _ |jd
| _
|jd | _ |jd | _ |jd
d| _
|jd| _| jd kr| j| _|jdg | _|rt|ng | _t| jd st| jttf r| jg| _x2t| jD ]$\}}t|ts d|i| j|< q W | j sTtd| jsdtdx"| jD ]}d|krltdqlW d S )N
title_typetexturlfeed_urlidupdatedauthoriconlogorights rights_typesubtitle
subtitle_type generatorlinks__iter__r
ztitle is requiredzid is requiredz#author must contain at least a name)titlegetr r r r r r r r r r! r" r# r$ default_generatorr% listentrieshasattr
isinstancer dict enumerate
ValueError TypeError)selfr' r+ kwargsir r
r
r __init__t s>
zAtomFeed.__init__c O sR t |dkr2| r2t|d tr2| jj|d n | j|d< | jjt|| dS )zAdd a new entry to the feed. This function can either be called
with a :class:`FeedEntry` or some keyword and positional arguments
that are forwarded to the :class:`FeedEntry` constructor.
r r N)lenr- FeedEntryr+ appendr )r2 argsr3 r
r
r add s
z AtomFeed.addc C s d| j j| jt| jf S )Nz<%s %r (%d entries)>) __class____name__r' r7 r+ )r2 r
r
r __repr__ s zAtomFeed.__repr__c # sr | j s&tdd | jD r&ddif| _ | jsVtdd | jD }|rL|d$ ntj | _dV d V d
td | j| j V d t
| j V d
t | j V | j
rdt
| j
V | jrdt
| j V x,| jD ]" ddj fdd D V qW xf| j D ]\}dV dt
|d V d|kr2dt
|d V d|krNdt
|d V dV qW | jrxd
td| j| j V | jrdt
| j V | jrd t
| j V | jrd
td | j| j V | j\}}}|s|s|r8d g}|r|jd t
| |r|jd t
| |jd!t
| dj|V x.| jD ]$}x |j D ]}d
| V qNW q@W d"V d#S )%z-Return a generator that yields pieces of XML.c s s | ]}|j V qd S )N)r ).0er
r
r s z$AtomFeed.generate..r
zUnknown authorc S s g | ]
}|j qS r
)r )r? entryr
r
r
s z%AtomFeed.generate..r6 z'
z+
z r' z %s
z %s
z
z
z
c 3 s" | ]}d |t | f V qdS )z%s="%s" N)r )r? k)linkr
r rA s z
z %s
uriz %s
emailz %s
z
r" z %s
z %s
r z %s
z
N)r anyr+ r sortedr utcnowr r' r r r r r r r% joinr" r# r r r r! r$ r9 generate) r2 datesr Zgenerator_nameZ
generator_urlZgenerator_versiontmprB liner
)rF r rN s^
zAtomFeed.generatec C s dj | j S )z Convert the feed into a string.rD )rM rN )r2 r
r
r to_string s zAtomFeed.to_stringc C s t | j ddS )z&Return a response object for the feed.zapplication/atom+xml)mimetype)r rR )r2 r
r
r get_response s zAtomFeed.get_responsec C s | j ||S )z&Use the class as WSGI response object.)rT )r2 environZstart_responser
r
r __call__ s zAtomFeed.__call__c C s | j S )N)rR )r2 r
r
r __str__ s zAtomFeed.__str__)r NN)NN)
r=
__module__ __qualname____doc__r) r5 r; r> rN rR rT rV rW r
r
r
r r @ s 0
$ 6r c @ s: e Zd ZdZd
ddZdd Zdd Zd d
Zd d ZdS )r8 a Represents a single entry in a feed.
:param title: the title of the entry. Required.
:param title_type: the type attribute for the title element. One of
``'html'``, ``'text'`` or ``'xhtml'``.
:param content: the content of the entry.
:param content_type: the type attribute for the content element. One
of ``'html'``, ``'text'`` or ``'xhtml'``.
:param summary: a summary of the entry's content.
:param summary_type: the type attribute for the summary element. One
of ``'html'``, ``'text'`` or ``'xhtml'``.
:param url: the url for the entry.
:param id: a globally unique id for the entry. Must be an URI. If
not present the URL is used, but one of both is required.
:param updated: the time the entry was modified the last time. Must
be a :class:`datetime.datetime` object. Treated as
UTC if naive datetime. Required.
:param author: the author of the entry. Must be either a string (the
name) or a dict with name (required) and uri or
email (both optional). Can be a list of (may be
mixed, too) strings and dicts, too, if there are
multiple authors. Required if the feed does not have an
author element.
:param published: the time the entry was initially published. Must
be a :class:`datetime.datetime` object. Treated as
UTC if naive datetime.
:param rights: copyright information for the entry.
:param rights_type: the type attribute for the rights element. One of
``'html'``, ``'text'`` or ``'xhtml'``. Default is
``'text'``.
:param links: additional links. Must be a list of dictionaries with
href (required) and rel, type, hreflang, title, length
(all optional)
:param categories: categories for the entry. Must be a list of dictionaries
with term (required), scheme and label (all optional)
:param xml_base: The xml base (url) for this feed item. If not provided
it will default to the item url.
For more information on the elements see
http://www.atomenabled.org/developers/syndication/
Everywhere where a list is demanded, any iterable can be used.
Nc K sH || _ |jdd| _|| _|jdd| _|jd| _|jd| j| _|jd| _|jd| _|jd d| _ |jd
f | _
|jd | _ |jd | _ |jd
g | _
|jdg | _|jd|| _t| j
d st| j
ttf r| j
g| _
x.t| j
D ] \}}t|tsd|i| j
|< qW | j s$td| js4td| jsDtdd S )Nr r r htmlr r r summary summary_typer publishedr r%
categoriesxml_baser& r
ztitle is requiredzid is requiredzupdated is required)r' r( r r r r r r r\ r] r r^ r r% r_ r` r, r- r r. r/ r0 )r2 r' r r r3 r4 r r
r
r r5 s6
zFeedEntry.__init__c C s d| j j| jf S )Nz<%s %r>)r< r= r' )r2 r
r
r r> ? s zFeedEntry.__repr__c # s d}| j rdt| j }d| V dtd| j| j V dt| j V dt| j V | jrndt| j V | j rd t| j V x`| j
D ]V}d
V d t|d V d
|krdt|d
V d|krdt|d V dV qW x,| j D ]"ddj fddD V qW x.| j
D ]$ ddj fdd D V q W | jrbdtd| j| j V | jrdtd| j| j V dV dS )zYields pieces of ATOM XML.rD z xml:base="%s"z
z r' z %s
z %s
z %s
z
z
z %s
r
rG z %s
rH z %s
z
z
c 3 s" | ]}d |t | f V qdS )z%s="%s" N)r )r? rE )rF r
r rA Y s z%FeedEntry.generate..z
c 3 s" | ]}d |t | f V qdS )z%s="%s" N)r )r? rE )categoryr
r rA ] s r\ r z
N)r` r r r' r r r r r^ r r r% rM r_ r\ r] r r )r2 baser r
)ra rF r rN B s<
zFeedEntry.generatec C s dj | j S )z,Convert the feed item into a unicode object.rD )rM rN )r2 r
r
r rR e s zFeedEntry.to_stringc C s | j S )N)rR )r2 r
r
r rW i s zFeedEntry.__str__)NNN) r= rX rY rZ r5 r> rN rR rW r
r
r
r r8 s -
#r8 )N)rZ warningsr _compatr r utilsr Zwrappersr warnDeprecationWarningr r r objectr r8 r
r
r
r s$
0