Фреймворк для создания лент агрегации

Django поставляется с фреймворком высокого уровня для генерации лент агрегации, который упрощает создание лент RSS и Atom.

Для создания любой ленты агрегации вам нужно написать небольшой класс Python. Вы можете создать любое количество лент.

Django также поставляет API для генерации лент низкого уровня. Используйте его, если вам нужно сгенерировать ленты вне контекста веб-страницы или другим способом низкого уровня.

Фреймворк высокого уровня

Обзор

Фреймворк высокого уровня для генерации лент предоставляется классом Feed. Для создания ленты напишите класс Feed и укажите на его экземпляр в вашем URLconf.

Feed классы

Класс Feed — это класс Python, представляющий ленту агрегации. Лента может быть простой (например, лента «новостей сайта» или базовая лента, отображающая последние записи блога) или более сложной (например, лента, отображающая все записи блога в определенной категории, где категория переменная).

Классы лент наследуются от django.contrib.syndication.views.Feed. Они могут находиться где угодно в вашем коде.

Экземпляры классов Feed являются представлениями, которые могут использоваться в вашем URLconf.

Простой пример

Этот простой пример, взятый с гипотетического новостного сайта, описывает ленту пяти последних новостных элементов:

from django.contrib.syndication.views import Feed
from django.urls import reverse
from policebeat.models import NewsItem

class LatestEntriesFeed(Feed):
    title = "Police beat site news"
    link = "/sitenews/"
    description = "Updates on changes and additions to police beat central."

    def items(self):
        return NewsItem.objects.order_by('-pub_date')[:5]

    def item_title(self, item):
        return item.title

    def item_description(self, item):
        return item.description

    # item_link is only needed if NewsItem has no get_absolute_url method.
    def item_link(self, item):
        return reverse('news-item', args=[item.pk])

Чтобы связать URL с этой лентой, поместите экземпляр объекта Feed в свой URLconf. Например:

from django.urls import path
from myproject.feeds import LatestEntriesFeed

urlpatterns = [
    # ...
    path('latest/feed/', LatestEntriesFeed()),
    # ...
]

Примечание:

• Класс Feed наследуется от django.contrib.syndication.views.Feed.
• title, link и description соответствуют стандартным элементам RSS <title>, <link> и <description> соответственно.
• items() — это просто метод, который возвращает список объектов, которые должны быть включены в ленту в качестве элементов <item>. Хотя в этом примере возвращаются объекты NewsItem с помощью ORM Django, items() не обязательно должен возвращать экземпляры моделей. Несмотря на то, что при использовании моделей Django вы получаете несколько функций «бесплатно», items() может возвращать любые объекты, которые вам нужны.
• Если вы создаете ленту Atom, а не RSS, установите атрибут subtitle вместо атрибута description. Смотрите Публикация лент Atom и RSS совместно ниже для примера.

Осталось одно дело. В ленте RSS каждый <item> имеет <title>, <link> и <description>. Мы должны указать фреймворку, какие данные поместить в эти элементы.

• Для содержимого <title> и <description> Django пытается вызвать методы item_title() и item_description() в классе Feed. Им передается один параметр, item, который представляет сам объект. Эти методы необязательны; по умолчанию используется строковое представление объекта для обоих.

  Если вам необходимо выполнить специальное форматирование заголовка или описания, вместо этого можно использовать шаблоны Django. Их пути могут быть указаны с помощью атрибутов title_template и description_template в классе Feed. Шаблоны рендерятся для каждого элемента и получают две переменные контекста шаблона:

  • {{ obj }} — текущий объект (один из объектов, возвращенных в items()).
  • {{ site }} — объект django.contrib.sites.models.Site, представляющий текущий сайт. Это полезно для {{ site.domain }} или {{ site.name }}. Если у вас не установлен фреймворк Django sites, это будет объект RequestSite. Смотрите раздел RequestSite в документации фреймворка sites для получения дополнительной информации.

  См. сложный пример ниже, который использует шаблон описания.

  Feed.get_context_data(**kwargs)

  Также есть способ передать дополнительную информацию в шаблоны заголовка и описания, если вам нужно предоставить больше, чем две упомянутые переменные. Вы можете реализовать метод get_context_data в подклассе Feed. Например:

  from mysite.models import Article
  from django.contrib.syndication.views import Feed
  
  class ArticlesFeed(Feed):
      title = "My articles"
      description_template = "feeds/articles.html"
  
      def items(self):
          return Article.objects.order_by('-pub_date')[:5]
  
      def get_context_data(self, **kwargs):
          context = super().get_context_data(**kwargs)
          context['foo'] = 'bar'
          return context
  

  И шаблон:

  Something about {{ foo }}: {{ obj.description }}
  

  Этот метод вызывается один раз для каждого элемента в списке, возвращенном методом items(), с указанными ниже ключевыми аргументами:

  • item: текущий элемент. Для совместимости со старыми версиями имя этой переменной контекста — {{ obj }}.
  • obj: объект, возвращенный методом get_object(). По умолчанию он не предоставляется шаблонам, чтобы избежать путаницы с {{ obj }} (см. выше), но вы можете использовать его в своей реализации метода get_context_data().
  • site: текущий сайт, как описано выше.
  • request: текущий запрос.

  Поведение метода get_context_data() аналогично поведению общих представлений — вы должны вызвать super() для получения данных контекста от родительского класса, добавить свои данные и вернуть измененный словарь.

• Для указания содержимого <link> у вас есть два варианта. Для каждого элемента в items() Django сначала пытается вызвать метод item_link() в классе Feed. Аналогично заголовку и описанию, ему передается один параметр item. Если этот метод не существует, Django пытается выполнить метод get_absolute_url() для этого объекта. Как get_absolute_url(), так и item_link() должны возвращать URL элемента в виде обычной строки Python. Как и в случае с get_absolute_url(), результат item_link() будет включен непосредственно в URL, поэтому вы несете ответственность за выполнение всех необходимых операций URL-кодирования и преобразования в ASCII внутри самого метода.

Сложный пример

Фреймворк также поддерживает более сложные ленты через аргументы.

Например, веб-сайт может предложить ленту RSS последних преступлений для каждого участка полиции в городе. Было бы неразумно создавать отдельный класс Feed для каждого участка полиции; это нарушило бы принцип DRY и привело бы к связыванию данных с логикой программирования. Вместо этого фреймворк агрегации позволяет получить доступ к аргументам, переданным из вашего URLconf, чтобы ленты могли выводить элементы, основанные на информации в URL ленты.

Ленты участков полиции могут быть доступны по URL-адресам:

• /beats/613/rss/ — Возвращает последние преступления для участка 613.
• /beats/1424/rss/ — Возвращает последние преступления для участка 1424.

Их можно сопоставить с строкой URLconf, такой как:

path('beats/<int:beat_id>/rss/', BeatFeed()),

Как и представление, аргументы в URL передаются методу get_object() вместе с объектом запроса.

Вот код для этих лент, относящихся к определённому участку:

from django.contrib.syndication.views import Feed

class BeatFeed(Feed):
    description_template = 'feeds/beat_description.html'

    def get_object(self, request, beat_id):
        return Beat.objects.get(pk=beat_id)

    def title(self, obj):
        return "Police beat central: Crimes for beat %s" % obj.beat

    def link(self, obj):
        return obj.get_absolute_url()

    def description(self, obj):
        return "Crimes recently reported in police beat %s" % obj.beat

    def items(self, obj):
        return Crime.objects.filter(beat=obj).order_by('-crime_date')[:30]

Для генерации <title>, <link> и <description> ленты Django использует методы title(), link() и description(). В предыдущем примере они были простыми строковыми атрибутами класса, но этот пример показывает, что они могут быть либо строками, либо методами. Для каждого из title, link и description Django следует этому алгоритму:

• Сначала он пытается вызвать метод, передав аргумент obj, где obj — объект, возвращенный методом get_object().
• В случае неудачи он пытается вызвать метод без аргументов.
• В случае неудачи он использует атрибут класса.

Также обратите внимание, что items() также следует тому же алгоритму — сначала он пытается вызвать items(obj), затем items(), а затем, наконец, атрибут класса items (который должен быть списком).

Мы используем шаблон для описаний элементов. Он может быть очень простым:

{{ obj.description }}

Однако вы можете добавлять форматирование по своему усмотрению.

Класс ExampleFeed ниже предоставляет полную документацию по методам и атрибутам классов Feed.

Указание типа ленты

По умолчанию ленты, создаваемые в этой системе, используют RSS 2.0.

Чтобы изменить это, добавьте атрибут feed_type в ваш класс Feed, как показано ниже:

from django.utils.feedgenerator import Atom1Feed

class MyFeed(Feed):
    feed_type = Atom1Feed

Обратите внимание, что вы устанавливаете feed_type в объект класса, а не в экземпляр.

В настоящее время доступны следующие типы лент:

• django.utils.feedgenerator.Rss201rev2Feed (RSS 2.01. По умолчанию.)
• django.utils.feedgenerator.RssUserland091Feed (RSS 0.91.)
• django.utils.feedgenerator.Atom1Feed (Atom 1.0.)

Вложения

Чтобы указать вложения, такие как те, что используются при создании лент подкастов, используйте хук item_enclosures или, как альтернативу, если у вас только одно вложение на элемент, хуки item_enclosure_url, item_enclosure_length, и item_enclosure_mime_type. Примеры использования см. в классе ExampleFeed ниже.

Язык

Ленты, созданные системой агрегации, автоматически включают соответствующий тег <language> (RSS 2.0) или атрибут xml:lang (Atom). Он непосредственно взят из вашего параметра LANGUAGE_CODE.

URL-адреса

Метод/атрибут link может возвращать либо абсолютный путь (например, "/blog/"), либо URL с полным доменным именем и протоколом (например, "https://www.example.com/blog/"). Если link не возвращает домен, система агрегации вставит домен текущего сайта в соответствии с вашим параметром SITE_ID setting.

Для Atom-лент требуется <link rel="self">, определяющий текущее расположение ленты. Система агрегации автоматически заполняет его, используя домен текущего сайта в соответствии с параметром SITE_ID.

Публикация Atom и RSS лент одновременно

Некоторые разработчики предпочитают предоставлять как Atom, так и RSS версии своих лент. Это легко сделать с Django: просто создайте подкласс своего класса Feed и установите feed_type на другое значение. Затем обновите свой URLconf, чтобы добавить дополнительные версии.

Вот полный пример:

from django.contrib.syndication.views import Feed
from policebeat.models import NewsItem
from django.utils.feedgenerator import Atom1Feed

class RssSiteNewsFeed(Feed):
    title = "Police beat site news"
    link = "/sitenews/"
    description = "Updates on changes and additions to police beat central."

    def items(self):
        return NewsItem.objects.order_by('-pub_date')[:5]

class AtomSiteNewsFeed(RssSiteNewsFeed):
    feed_type = Atom1Feed
    subtitle = RssSiteNewsFeed.description

И соответствующий URLconf:

from django.urls import path
from myproject.feeds import AtomSiteNewsFeed, RssSiteNewsFeed

urlpatterns = [
    # ...
    path('sitenews/rss/', RssSiteNewsFeed()),
    path('sitenews/atom/', AtomSiteNewsFeed()),
    # ...
]

Feed Справочник по классу ленты

class views.Feed

Этот пример иллюстрирует все возможные атрибуты и методы класса Feed:

from django.contrib.syndication.views import Feed
from django.utils import feedgenerator

class ExampleFeed(Feed):

    # FEED TYPE -- Optional. This should be a class that subclasses
    # django.utils.feedgenerator.SyndicationFeed. This designates
    # which type of feed this should be: RSS 2.0, Atom 1.0, etc. If
    # you don't specify feed_type, your feed will be RSS 2.0. This
    # should be a class, not an instance of the class.

    feed_type = feedgenerator.Rss201rev2Feed

    # TEMPLATE NAMES -- Optional. These should be strings
    # representing names of Django templates that the system should
    # use in rendering the title and description of your feed items.
    # Both are optional. If a template is not specified, the
    # item_title() or item_description() methods are used instead.

    title_template = None
    description_template = None

    # TITLE -- One of the following three is required. The framework
    # looks for them in this order.

    def title(self, obj):
        """
        Takes the object returned by get_object() and returns the
        feed's title as a normal Python string.
        """

    def title(self):
        """
        Returns the feed's title as a normal Python string.
        """

    title = 'foo' # Hard-coded title.

    # LINK -- One of the following three is required. The framework
    # looks for them in this order.

    def link(self, obj):
        """
        # Takes the object returned by get_object() and returns the URL
        # of the HTML version of the feed as a normal Python string.
        """

    def link(self):
        """
        Returns the URL of the HTML version of the feed as a normal Python
        string.
        """

    link = '/blog/' # Hard-coded URL.

    # FEED_URL -- One of the following three is optional. The framework
    # looks for them in this order.

    def feed_url(self, obj):
        """
        # Takes the object returned by get_object() and returns the feed's
        # own URL as a normal Python string.
        """

    def feed_url(self):
        """
        Returns the feed's own URL as a normal Python string.
        """

    feed_url = '/blog/rss/' # Hard-coded URL.

    # GUID -- One of the following three is optional. The framework looks
    # for them in this order. This property is only used for Atom feeds
    # (where it is the feed-level ID element). If not provided, the feed
    # link is used as the ID.

    def feed_guid(self, obj):
        """
        Takes the object returned by get_object() and returns the globally
        unique ID for the feed as a normal Python string.
        """

    def feed_guid(self):
        """
        Returns the feed's globally unique ID as a normal Python string.
        """

    feed_guid = '/foo/bar/1234' # Hard-coded guid.

    # DESCRIPTION -- One of the following three is required. The framework
    # looks for them in this order.

    def description(self, obj):
        """
        Takes the object returned by get_object() and returns the feed's
        description as a normal Python string.
        """

    def description(self):
        """
        Returns the feed's description as a normal Python string.
        """

    description = 'Foo bar baz.' # Hard-coded description.

    # AUTHOR NAME --One of the following three is optional. The framework
    # looks for them in this order.

    def author_name(self, obj):
        """
        Takes the object returned by get_object() and returns the feed's
        author's name as a normal Python string.
        """

    def author_name(self):
        """
        Returns the feed's author's name as a normal Python string.
        """

    author_name = 'Sally Smith' # Hard-coded author name.

    # AUTHOR EMAIL --One of the following three is optional. The framework
    # looks for them in this order.

    def author_email(self, obj):
        """
        Takes the object returned by get_object() and returns the feed's
        author's email as a normal Python string.
        """

    def author_email(self):
        """
        Returns the feed's author's email as a normal Python string.
        """

    author_email = 'test@example.com' # Hard-coded author email.

    # AUTHOR LINK --One of the following three is optional. The framework
    # looks for them in this order. In each case, the URL should include
    # the "http://" and domain name.

    def author_link(self, obj):
        """
        Takes the object returned by get_object() and returns the feed's
        author's URL as a normal Python string.
        """

    def author_link(self):
        """
        Returns the feed's author's URL as a normal Python string.
        """

    author_link = 'https://www.example.com/' # Hard-coded author URL.

    # CATEGORIES -- One of the following three is optional. The framework
    # looks for them in this order. In each case, the method/attribute
    # should return an iterable object that returns strings.

    def categories(self, obj):
        """
        Takes the object returned by get_object() and returns the feed's
        categories as iterable over strings.
        """

    def categories(self):
        """
        Returns the feed's categories as iterable over strings.
        """

    categories = ("python", "django") # Hard-coded list of categories.

    # COPYRIGHT NOTICE -- One of the following three is optional. The
    # framework looks for them in this order.

    def feed_copyright(self, obj):
        """
        Takes the object returned by get_object() and returns the feed's
        copyright notice as a normal Python string.
        """

    def feed_copyright(self):
        """
        Returns the feed's copyright notice as a normal Python string.
        """

    feed_copyright = 'Copyright (c) 2007, Sally Smith' # Hard-coded copyright notice.

    # TTL -- One of the following three is optional. The framework looks
    # for them in this order. Ignored for Atom feeds.

    def ttl(self, obj):
        """
        Takes the object returned by get_object() and returns the feed's
        TTL (Time To Live) as a normal Python string.
        """

    def ttl(self):
        """
        Returns the feed's TTL as a normal Python string.
        """

    ttl = 600 # Hard-coded Time To Live.

    # ITEMS -- One of the following three is required. The framework looks
    # for them in this order.

    def items(self, obj):
        """
        Takes the object returned by get_object() and returns a list of
        items to publish in this feed.
        """

    def items(self):
        """
        Returns a list of items to publish in this feed.
        """

    items = ('Item 1', 'Item 2') # Hard-coded items.

    # GET_OBJECT -- This is required for feeds that publish different data
    # for different URL parameters. (See "A complex example" above.)

    def get_object(self, request, *args, **kwargs):
        """
        Takes the current request and the arguments from the URL, and
        returns an object represented by this feed. Raises
        django.core.exceptions.ObjectDoesNotExist on error.
        """

    # ITEM TITLE AND DESCRIPTION -- If title_template or
    # description_template are not defined, these are used instead. Both are
    # optional, by default they will use the string representation of the
    # item.

    def item_title(self, item):
        """
        Takes an item, as returned by items(), and returns the item's
        title as a normal Python string.
        """

    def item_title(self):
        """
        Returns the title for every item in the feed.
        """

    item_title = 'Breaking News: Nothing Happening' # Hard-coded title.

    def item_description(self, item):
        """
        Takes an item, as returned by items(), and returns the item's
        description as a normal Python string.
        """

    def item_description(self):
        """
        Returns the description for every item in the feed.
        """

    item_description = 'A description of the item.' # Hard-coded description.

    def get_context_data(self, **kwargs):
        """
        Returns a dictionary to use as extra context if either
        description_template or item_template are used.

        Default implementation preserves the old behavior
        of using {'obj': item, 'site': current_site} as the context.
        """

    # ITEM LINK -- One of these three is required. The framework looks for
    # them in this order.

    # First, the framework tries the two methods below, in
    # order. Failing that, it falls back to the get_absolute_url()
    # method on each item returned by items().

    def item_link(self, item):
        """
        Takes an item, as returned by items(), and returns the item's URL.
        """

    def item_link(self):
        """
        Returns the URL for every item in the feed.
        """

    # ITEM_GUID -- The following method is optional. If not provided, the
    # item's link is used by default.

    def item_guid(self, obj):
        """
        Takes an item, as return by items(), and returns the item's ID.
        """

    # ITEM_GUID_IS_PERMALINK -- The following method is optional. If
    # provided, it sets the 'isPermaLink' attribute of an item's
    # GUID element. This method is used only when 'item_guid' is
    # specified.

    def item_guid_is_permalink(self, obj):
        """
        Takes an item, as returned by items(), and returns a boolean.
        """

    item_guid_is_permalink = False  # Hard coded value

    # ITEM AUTHOR NAME -- One of the following three is optional. The
    # framework looks for them in this order.

    def item_author_name(self, item):
        """
        Takes an item, as returned by items(), and returns the item's
        author's name as a normal Python string.
        """

    def item_author_name(self):
        """
        Returns the author name for every item in the feed.
        """

    item_author_name = 'Sally Smith' # Hard-coded author name.

    # ITEM AUTHOR EMAIL --One of the following three is optional. The
    # framework looks for them in this order.
    #
    # If you specify this, you must specify item_author_name.

    def item_author_email(self, obj):
        """
        Takes an item, as returned by items(), and returns the item's
        author's email as a normal Python string.
        """

    def item_author_email(self):
        """
        Returns the author email for every item in the feed.
        """

    item_author_email = 'test@example.com' # Hard-coded author email.

    # ITEM AUTHOR LINK -- One of the following three is optional. The
    # framework looks for them in this order. In each case, the URL should
    # include the "http://" and domain name.
    #
    # If you specify this, you must specify item_author_name.

    def item_author_link(self, obj):
        """
        Takes an item, as returned by items(), and returns the item's
        author's URL as a normal Python string.
        """

    def item_author_link(self):
        """
        Returns the author URL for every item in the feed.
        """

    item_author_link = 'https://www.example.com/' # Hard-coded author URL.

    # ITEM ENCLOSURES -- One of the following three is optional. The
    # framework looks for them in this order. If one of them is defined,
    # ``item_enclosure_url``, ``item_enclosure_length``, and
    # ``item_enclosure_mime_type`` will have no effect.

    def item_enclosures(self, item):
        """
        Takes an item, as returned by items(), and returns a list of
        ``django.utils.feedgenerator.Enclosure`` objects.
        """

    def item_enclosures(self):
        """
        Returns the ``django.utils.feedgenerator.Enclosure`` list for every
        item in the feed.
        """

    item_enclosures = []  # Hard-coded enclosure list

    # ITEM ENCLOSURE URL -- One of these three is required if you're
    # publishing enclosures and you're not using ``item_enclosures``. The
    # framework looks for them in this order.

    def item_enclosure_url(self, item):
        """
        Takes an item, as returned by items(), and returns the item's
        enclosure URL.
        """

    def item_enclosure_url(self):
        """
        Returns the enclosure URL for every item in the feed.
        """

    item_enclosure_url = "/foo/bar.mp3" # Hard-coded enclosure link.

    # ITEM ENCLOSURE LENGTH -- One of these three is required if you're
    # publishing enclosures and you're not using ``item_enclosures``. The
    # framework looks for them in this order. In each case, the returned
    # value should be either an integer, or a string representation of the
    # integer, in bytes.

    def item_enclosure_length(self, item):
        """
        Takes an item, as returned by items(), and returns the item's
        enclosure length.
        """

    def item_enclosure_length(self):
        """
        Returns the enclosure length for every item in the feed.
        """

    item_enclosure_length = 32000 # Hard-coded enclosure length.

    # ITEM ENCLOSURE MIME TYPE -- One of these three is required if you're
    # publishing enclosures and you're not using ``item_enclosures``. The
    # framework looks for them in this order.

    def item_enclosure_mime_type(self, item):
        """
        Takes an item, as returned by items(), and returns the item's
        enclosure MIME type.
        """

    def item_enclosure_mime_type(self):
        """
        Returns the enclosure MIME type for every item in the feed.
        """

    item_enclosure_mime_type = "audio/mpeg" # Hard-coded enclosure MIME type.

    # ITEM PUBDATE -- It's optional to use one of these three. This is a
    # hook that specifies how to get the pubdate for a given item.
    # In each case, the method/attribute should return a Python
    # datetime.datetime object.

    def item_pubdate(self, item):
        """
        Takes an item, as returned by items(), and returns the item's
        pubdate.
        """

    def item_pubdate(self):
        """
        Returns the pubdate for every item in the feed.
        """

    item_pubdate = datetime.datetime(2005, 5, 3) # Hard-coded pubdate.

    # ITEM UPDATED -- It's optional to use one of these three. This is a
    # hook that specifies how to get the updateddate for a given item.
    # In each case, the method/attribute should return a Python
    # datetime.datetime object.

    def item_updateddate(self, item):
        """
        Takes an item, as returned by items(), and returns the item's
        updateddate.
        """

    def item_updateddate(self):
        """
        Returns the updateddate for every item in the feed.
        """

    item_updateddate = datetime.datetime(2005, 5, 3) # Hard-coded updateddate.

    # ITEM CATEGORIES -- It's optional to use one of these three. This is
    # a hook that specifies how to get the list of categories for a given
    # item. In each case, the method/attribute should return an iterable
    # object that returns strings.

    def item_categories(self, item):
        """
        Takes an item, as returned by items(), and returns the item's
        categories.
        """

    def item_categories(self):
        """
        Returns the categories for every item in the feed.
        """

    item_categories = ("python", "django") # Hard-coded categories.

    # ITEM COPYRIGHT NOTICE (only applicable to Atom feeds) -- One of the
    # following three is optional. The framework looks for them in this
    # order.

    def item_copyright(self, obj):
        """
        Takes an item, as returned by items(), and returns the item's
        copyright notice as a normal Python string.
        """

    def item_copyright(self):
        """
        Returns the copyright notice for every item in the feed.
        """

    item_copyright = 'Copyright (c) 2007, Sally Smith' # Hard-coded copyright notice.

Фреймворк низкого уровня

За кулисами фреймворк высокого уровня для RSS использует фреймворк низкого уровня для генерации XML лент. Этот фреймворк находится в одном модуле: django/utils/feedgenerator.py.

Вы можете использовать этот фреймворк самостоятельно для генерации лент на низком уровне. Вы также можете создать пользовательские подклассы генераторов лент для использования с feed_type Feed опцией.

SyndicationFeed Классы

Модуль feedgenerator содержит базовый класс:

• django.utils.feedgenerator.SyndicationFeed

и несколько подклассов:

• django.utils.feedgenerator.RssUserland091Feed
• django.utils.feedgenerator.Rss201rev2Feed
• django.utils.feedgenerator.Atom1Feed

Каждый из этих трех классов знает, как отображать определенный тип ленты в виде XML. Они разделяют этот интерфейс:

SyndicationFeed.__init__()

Инициализирует ленту заданным словарем метаданных, который относится ко всей ленте. Обязательные ключевые аргументы:

• title
• link
• description

Также есть множество других необязательных ключевых аргументов:

• language
• author_email
• author_name
• author_link
• subtitle
• categories
• feed_url
• feed_copyright
• feed_guid
• ttl

Все дополнительные ключевые аргументы, которые вы передаете в __init__, будут сохранены в self.feed для использования с пользовательскими генераторами лент.

Все параметры должны быть строками, за исключением categories, которое должно быть последовательностью строк. Будьте осторожны, некоторые управляющие символы не разрешены в XML-документах. Если ваш контент содержит некоторые из них, вы можете столкнуться с ValueError при создании ленты.

SyndicationFeed.add_item()

Добавляет элемент в ленту с заданными параметрами.

Обязательные ключевые аргументы:

• title
• link
• description

Необязательные ключевые аргументы:

• author_email
• author_name
• author_link
• pubdate
• comments
• unique_id
• enclosures
• categories
• item_copyright
• ttl
• updateddate

Дополнительные ключевые аргументы будут сохранены для пользовательских генераторов лент.

Все параметры, если заданы, должны быть строками, за исключением:

• pubdate должен быть объектом Python datetime.
• updateddate должен быть объектом Python datetime.
• enclosures должен быть списком экземпляров django.utils.feedgenerator.Enclosure.
• categories должна быть последовательностью строк.

SyndicationFeed.write()

Выводит ленту в заданной кодировке в outfile, который является объектом файла.

SyndicationFeed.writeString()

Возвращает ленту в виде строки в заданной кодировке.

Например, чтобы создать ленту Atom 1.0 и вывести её в стандартный вывод:

>>> from django.utils import feedgenerator
>>> from datetime import datetime
>>> f = feedgenerator.Atom1Feed(
...     title="My Weblog",
...     link="https://www.example.com/",
...     description="In which I write about what I ate today.",
...     language="en",
...     author_name="Myself",
...     feed_url="https://example.com/atom.xml")
>>> f.add_item(title="Hot dog today",
...     link="https://www.example.com/entries/1/",
...     pubdate=datetime.now(),
...     description="<p>Today I had a Vienna Beef hot dog. It was pink, plump and perfect.</p>")
>>> print(f.writeString('UTF-8'))
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom" xml:lang="en">
...
</feed>

Пользовательские генераторы лент

Если вам нужно создать пользовательский формат ленты, у вас есть несколько вариантов.

Если формат ленты полностью пользовательский, вам нужно будет создать подкласс SyndicationFeed и полностью заменить методы write() и writeString().

Однако, если формат ленты является производным от RSS или Atom (например, GeoRSS, формат подкастов iTunes от Apple iTunes podcast format и т. д.), у вас есть лучший выбор. Эти типы лент обычно добавляют дополнительные элементы и/или атрибуты к основному формату, и есть набор методов, которые SyndicationFeed вызывает для получения этих дополнительных атрибутов. Таким образом, вы можете создать подкласс соответствующего класса генератора ленты (Atom1Feed или Rss201rev2Feed) и расширить эти обратные вызовы. Они следующие:

SyndicationFeed.root_attributes(self)

Возвращает dict атрибутов, которые нужно добавить к корневому элементу ленты (feed/channel).

SyndicationFeed.add_root_elements(self, handler)

Обратный вызов для добавления элементов внутри корневого элемента ленты (feed/channel). handler является XMLGenerator из встроенной библиотеки SAX Python; вы вызываете методы на нём, чтобы добавить элементы в XML-документ в процессе.

SyndicationFeed.item_attributes(self, item)

Возвращает dict атрибутов, которые нужно добавить к каждому элементу (item/entry) . Аргумент, item, представляет собой словарь всех данных, переданных в SyndicationFeed.add_item().

SyndicationFeed.add_item_elements(self, handler, item)

Обратный вызов для добавления элементов к каждому элементу (item/entry) . handler и item такие же, как выше.

Например, вы можете начать реализацию генератора ленты RSS iTunes следующим образом:

class iTunesFeed(Rss201rev2Feed):
    def root_attributes(self):
        attrs = super().root_attributes()
        attrs['xmlns:itunes'] = 'http://www.itunes.com/dtds/podcast-1.0.dtd'
        return attrs

    def add_root_elements(self, handler):
        super().add_root_elements(handler)
        handler.addQuickElement('itunes:explicit', 'clean')

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