B
bA Z< @ sz d Z ddlmZ ddlmZ ddlmZ ddlmZmZ dZ ddd Z
d
d Z eG d d
d
e Z
eG dd de ZdS )ae
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: (c) 2014 by the Werkzeug Team, see AUTHORS for more details.
:license: BSD, see LICENSE for more details.
)datetime)escape) BaseResponse)implements_to_string string_typesz http://www.w3.org/1999/xhtmlNc 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 4lib/python3.7/site-packages/werkzeug/contrib/atom.py_make_text_block" s r
c C s | }| jr|S |d S )z$Format a datetime object for iso8601Z)Z isoformatZtzinfo)objZiso8601r r r format_iso8601- 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|pg | _t| jdrt| jttf r| jg| _x2t| jD ]$\}}t|tsd|i| j|< qW | j sRtd| jsbtdx"| jD ]}d|krjtdqjW d S )N
title_typetexturlfeed_urlidupdatedauthorr iconlogorights 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__i s>
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 )r- argsr. r r r add s
z AtomFeed.addc C s d| j j| jt| jf S )Nz<%s %r (%d entries)>) __class____name__r" r2 r& )r- r r r __repr__ s zAtomFeed.__repr__c # sp | j s&tdd | jD r&ddif| _ | jsVtdd | jD }|rL|d pRt | _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 ]" dd fdd D V qW xd| j D ]Z}dV dt
|d V d|kr2dt
|d V d|krNdt
|d V dV qW | jrvd
td| j| j V | jrdt
| j V | jrd t
| j V | jrd
td | j| j V | j\}}}|s|s|r6d g}|r |d t
| |r|d t
| |d!t
| d|V x.| jD ]$}x | D ]}d
| V qLW 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..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 r< s z
z %s
uriz %s
emailz %s
z
r z %s
z %s
r z %s
z
N)r anyr& r sortedr Zutcnowr
r" r r r r r r r joinr r r r r r r r4 generate) r- Zdatesr Zgenerator_nameZ
generator_urlZgenerator_versionZtmpr= liner )rB r rH sd
zAtomFeed.generatec C s d | S )z Convert the feed into a string.r@ )rG rH )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)Zmimetype)r rJ )r- r r r get_response s zAtomFeed.get_responsec C s | ||S )z&Use the class as WSGI response object.)rK )r- environZstart_responser r r __call__ s zAtomFeed.__call__c C s | S )N)rJ )r- r r r __str__ s zAtomFeed.__str__)NN)
r8
__module__ __qualname____doc__r$ r0 r6 r9 rH rJ rK rM rN r r r r r 5 s 0
# 8r c @ s: e Zd ZdZd
ddZdd Zdd Zd d
Zd d ZdS )r3 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 sF || _ |dd| _|| _|dd| _|d| _|d| j| _|d| _|d| _|d d| _ |d
d | _
|d | _ |d
| _ |dg | _
|dg | _|d|| _t| j
drt| j
ttf r| j
g| _
x.t| j
D ] \}}t|tsd|i| j
|< qW | j s"td| js2td| jsBtdd S )Nr r r
Zhtmlr r r summary summary_typer r publishedr r
categoriesxml_baser! r ztitle is requiredzid is requiredzupdated is required)r" r# r r r
r r r rR rS r rT r r rU rV r' r( r r) r* r+ )r- r" r r r. r/ r r r r r0 s6
zFeedEntry.__init__c C s d| j j| jf S )Nz<%s %r>)r7 r8 r" )r- r r r r9 4 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 ]"dd fddD V qW x.| j
D ]$ dd fdd D V q W | jrbdtd| j| j V | jrdtd| j| j V dV dS )zYields pieces of ATOM XML.r@ z xml:base="%s"z
z r" z %s
z %s
z %s
z
z
z %s
r rC z %s
rD z %s
z
z
c 3 s" | ]}d |t | f V qdS )z%s="%s" N)r )r: rA )rB r r r< Q s z%FeedEntry.generate..z
c 3 s" | ]}d |t | f V qdS )z%s="%s" N)r )r: rA )categoryr r r< T s rR r z
N)rV r r
r" r r r r rT r r r rG rU rR rS r r
)r- baser r )rW rB r rH : sB
zFeedEntry.generatec C s d | S )z,Convert the feed item into a unicode object.r@ )rG rH )r- r r r rJ ^ s zFeedEntry.to_stringc C s | S )N)rJ )r- r r r rN b s zFeedEntry.__str__)NNN) r8 rO rP rQ r0 r9 rH rJ rN r r r r r3 s -
$r3 )N)rQ r Zwerkzeug.utilsr Zwerkzeug.wrappersr Zwerkzeug._compatr r r r
r objectr r3 r r r r s
1