Синдикация Atom

werkzeug.contrib.atom

Этот модуль предоставляет класс под названием AtomFeed, который можно использовать для генерации лент в формате Atom syndication (см. RFC 4287).

Пример:

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()

class werkzeug.contrib.atom.AtomFeed(title=None, entries=None, **kwargs)

Класс-помощник, который создает ленты Atom.

Параметры:

title – заголовок ленты. Обязательный. title_type – атрибут типа для элемента заголовка. Один из 'html', 'text' или 'xhtml'. url – url для ленты (не url *самих* данных ленты) id – глобально уникальный идентификатор ленты. Должен быть URI. Если не указан, используется feed_url, но один из этих двух параметров необходим. updated – время последнего изменения ленты. Должен быть объектом datetime.datetime. Если не указан, используется последнее обновление записи. Если используется объект datetime без указания часового пояса, он обрабатывается как UTC. feed_url – URL ленты. Должен быть запрошенным URL. author – автор ленты. Должен быть либо строкой (имя), либо словарем с ключом name (обязательно) и uri или email (оба необязательны). Может быть списком строк и словарей (смешанным), если авторов несколько. Требуется, если у каждой записи нет элемента author. icon – значок для ленты. logo – логотип для ленты. rights – информация об авторских правах для ленты. rights_type – атрибут типа для элемента прав. Один из 'html', 'text' или 'xhtml'. По умолчанию 'text'. subtitle – краткое описание ленты. subtitle_type – атрибут типа для элемента подзаголовка. Один из 'text', 'html', 'text' или 'xhtml'. По умолчанию 'text'. links – дополнительные ссылки. Должен быть списком словарей с href (обязательно) и rel, type, hreflang, title, length (все необязательно). generator – программное обеспечение, которое сгенерировало эту ленту. Должен быть кортежем в формате (name, url, version). Если вы не хотите указывать один из них, установите значение элемента в None. entries – список записей для ленты. Записи также можно добавить позже с помощью add().

Для получения дополнительной информации об элементах см. http://www.atomenabled.org/developers/syndication/

В любом месте, где требуется список, можно использовать любой итерируемый объект.

add(*args, **kwargs)

Добавить новую запись в ленту. Эту функцию можно вызвать с FeedEntry или с некоторыми ключевыми и позиционными аргументами, которые передаются конструктору FeedEntry.

generate()

Возвращает генератор, который выдает части XML.

get_response()

Возвращает объект ответа для ленты.

to_string()

Преобразовать ленту в строку.

class werkzeug.contrib.atom.FeedEntry(title=None, content=None, feed_url=None, **kwargs)

Представляет отдельную запись в ленте.

Параметры:

title – заголовок записи. Обязательный. title_type – атрибут типа для элемента заголовка. Один из 'html', 'text' или 'xhtml'. content – содержимое записи. content_type – атрибут типа для элемента содержимого. Один из 'html', 'text' или 'xhtml'. summary – краткое содержание содержимого записи. summary_type – атрибут типа для элемента краткого описания. Один из 'html', 'text' или 'xhtml'. url – URL записи. id – глобально уникальный идентификатор записи. Должен быть URI. Если не указан, используется URL, но один из них необходим. updated – время последнего изменения записи. Должен быть объектом datetime.datetime. Если используется объект datetime без указания часового пояса, он обрабатывается как UTC. Обязательный. author – автор записи. Должен быть либо строкой (имя), либо словарем с ключом name (обязательно) и uri или email (оба необязательны). Может быть списком строк и словарей (смешанным), если авторов несколько. Требуется, если у ленты нет элемента author. published – время первоначальной публикации записи. Должен быть объектом datetime.datetime. Если используется объект datetime без указания часового пояса, он обрабатывается как UTC. rights – информация об авторских правах для записи. rights_type – атрибут типа для элемента прав. Один из 'html', 'text' или 'xhtml'. По умолчанию 'text'. links – дополнительные ссылки. Должен быть списком словарей с href (обязательно) и rel, type, hreflang, title, length (все необязательно) categories – категории для записи. Должен быть списком словарей с term (обязательно), scheme и label (оба необязательно). xml_base – Базовый URL (xml base) для этой записи ленты. Если не указан, по умолчанию используется URL записи.

Для получения дополнительной информации об элементах см. http://www.atomenabled.org/developers/syndication/

В любом месте, где требуется список, можно использовать любой итерируемый объект.