U
(Q^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_typesescape) 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 ;/tmp/pip-install-bd4o36v9/Werkzeug/werkzeug/contrib/atom.py_make_text_block* s r c C s | }| 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.
)ZWerkzeugNNNc K s || _ |dd| _|d| _|d| j| _|d| j| _|d| _|dd| _|d | _|d
| _ |d | _
|d | _ |d
| _ |dd| _
|d| _| jd kr| j| _|dg | _|rt|ng | _t| jdrt| jttf r| jg| _t| jD ]$\}}t|tsd|i| j|< q| j sNtd| js^td| jD ]}d|krdtdqdd S )N
title_typetexturlfeed_urlidupdatedauthorr iconlogorights rights_typesubtitle
subtitle_type generatorlinks__iter__r title is requiredid 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 sB
zAtomFeed.__init__c O sP t |dkr0|s0t|d tr0| j|d n | j|d< | jt|| 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 )r4 argsr5 r r r add s
z AtomFeed.addc C s d| j j| jt| jf S )Nz<%s %r (%d entries)>) __class____name__r) r9 r- r4 r r r __repr__ s
zAtomFeed.__repr__c # s` | j s&tdd | jD r&ddif| _ | jsVtdd | jD }|rL|d nt | _dV d V d
td | j| j V d t
| j V d
t | j V | j
rdt
| j
V | jrdt
| j V | jD ]" dd fdd D V q| j D ]Z}dV dt
|d V d|kr,dt
|d V d|krHdt
|d V dV q| jrnd
td| j| j V | jrdt
| j V | jrd t
| j V | jrd
td | j| j V | j\}}}|s|s|r.d g}|r|d t
| |r|d t
| |d!t
| d|V | jD ] }| D ]}d
| V q@q4d"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 )rC entryr r r
s z%AtomFeed.generate..z'
z+
r) %s%s
z
c 3 s" | ]}d |t | f V qdS z%s="%s" Nr rC klinkr r rE s %s
uri %s
email %s
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$ r; generate) r4 datesr Zgenerator_nameZ
generator_urlZgenerator_versiontmprF liner rR r r_ s`
zAtomFeed.generatec C s d | S )z Convert the feed into a string.rN r^ r_ r@ r r r to_string s zAtomFeed.to_stringc C s t | ddS )z&Return a response object for the feed.zapplication/atom+xml)mimetype)r rd r@ r r r get_response s zAtomFeed.get_responsec C s | ||S )z&Use the class as WSGI response object.)rf )r4 environZstart_responser r r __call__ s zAtomFeed.__call__c C s | S rB rd r@ r r r __str__ s zAtomFeed.__str__)NN)
r?
__module__ __qualname____doc__r+ r7 r= rA r_ rd rf rh rj r r r r r @ s /
$ 6r c @ s: e Zd ZdZd
ddZdd Zdd Zd d
Zd d ZdS )r: 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 sB || _ |dd| _|| _|dd| _|d| _|d| j| _|d| _|d| _|d d| _ |d
d | _
|d | _ |d
| _ |dg | _
|dg | _|d|| _t| j
drt| j
ttf r| j
g| _
t| j
D ] \}}t|tsd|i| j
|< q| j s td| js.td| js>tdd S )Nr r r
htmlr r r summary summary_typer r publishedr r%
categoriesxml_baser& r r' r( zupdated is required)r) r* r r r
r r r ro rp r rq r r% rr rs r. r/ r r0 r1 r2 )r4 r) r r r5 r6 r r r r r7 s:
zFeedEntry.__init__c C s d| j j| jf S )Nz<%s %r>)r> r? r) r@ r r r rA ? 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 | j
D ]V}d
V d t|d V d
|krdt|d
V d|krdt|d V dV q| j D ]"dd fddD V q| j
D ]$ dd fdd D V q| jrVdtd| j| j V | jrtdtd| j| j V dV dS )zYields pieces of ATOM XML.rN z xml:base="%s"z
rI r) rJ rK z %s
rL rT rU r rV rW rX rY rZ rM c 3 s" | ]}d |t | f V qdS rO r rP rR r r rE X s z%FeedEntry.generate..z
c 3 s" | ]}d |t | f V qdS rO r rP )categoryr r rE \ s ro r z
N)rs r r r) r r r r rq r r r% r^ rr ro rp r r
)r4 baser r )rt rS r r_ B s@
zFeedEntry.generatec C s d | S )z,Convert the feed item into a unicode object.rN rc r@ r r r rd e s zFeedEntry.to_stringc C s | S rB ri r@ r r r rj i s zFeedEntry.__str__)NNN) r? rk rl rm r7 rA r_ rd rj r r r r r: s ,
#r: )N)rm warningsr _compatr r utilsr wrappersr warnDeprecationWarningr
r r objectr r: r r r r s&
0