Механизм подачи синдиката

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

Чтобы создать любой синдикационный канал, достаточно написать короткий класс на языке Python. Вы можете создать столько фидов, сколько захотите.

Django also comes with a lower-level feed-generating API. Use this if you want to generate feeds outside of a web context, or in some other lower-level way.

Высокоуровневая структура

Быстрый обзор

Высокоуровневая основа для создания фидов предоставляется классом 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 объекты, используя object-relational mapper Django, items() не обязательно должен возвращать экземпляры моделей. Хотя вы получаете несколько битов функциональности «бесплатно», используя модели Django, items() может возвращать любой тип объекта, который вы хотите.
  • Если вы создаете Atom-канал, а не RSS-канал, установите атрибут subtitle вместо атрибута description. Пример смотрите ниже в разделе Publishing Atom and RSS feeds in tandem.

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

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

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

    • {{ obj }} – Текущий объект (один из тех объектов, которые вы вернули в items()).
    • {{ site }} – Объект django.contrib.sites.models.Site, представляющий текущий сайт. Это полезно для {{ site.domain }} или {{ site.name }}. Если у вас не установлен фреймворк сайтов Django, то будет установлен объект RequestSite. Подробнее см. в RequestSite section of the sites framework documentation.

    См. ниже a complex example, где используется шаблон описания.

    Feed.get_context_data(**kwargs)

    Существует также способ передачи дополнительной информации в шаблоны title и description, если вам нужно предоставить больше, чем две переменные, упомянутые ранее. Вы можете предоставить свою реализацию метода 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() имитирует поведение generic views - вы должны вызвать 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 principle и связало бы данные с логикой программирования. Вместо этого фреймворк синдикации позволяет вам получить доступ к аргументам, переданным из вашего URLconf, чтобы фиды могли выводить элементы на основе информации в URL фида.

Доступ к ленте полицейских новостей может осуществляться по таким URL-адресам:

  • /beats/613/rss/ – Returns recent crimes for beat 613.
  • /beats/1424/rss/ – Returns recent crimes for beat 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(). В предыдущем примере это были атрибуты класса string, но этот пример показывает, что они могут быть как строками, так и методами. Для каждого из title, link и description, Django следует следующему алгоритму:

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

Также обратите внимание, что 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 объекту класса, а не экземпляру.

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

Ограждающие конструкции

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

Мова

Каналы, созданные фреймворком синдикации, автоматически включают соответствующий тег <language> (RSS 2.0) или атрибут xml:lang (Atom). По умолчанию это django.utils.translation.get_language(). Вы можете изменить его, установив атрибут language class.

URLs

The link method/attribute can return either an absolute path (e.g. "/blog/") or a URL with the fully-qualified domain and protocol (e.g. "https://www.example.com/blog/"). If link doesn’t return the domain, the syndication framework will insert the domain of the current site, according to your SITE_ID setting.

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

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

Некоторые разработчики хотят сделать доступными как Atom *, так и RSS версии своих фидов. Для этого вы можете создать подкласс вашего класса 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

Примечание

В данном примере RSS-канал использует description, а Atom-канал - subtitle. Это потому, что в лентах Atom не предусмотрено «описание» на уровне ленты, но они до предусматривают «подзаголовок».

Если вы зададите description в классе Feed, Django не будет автоматически помещать его в элемент subtitle, потому что подзаголовок и описание - это не обязательно одно и то же. Вместо этого вы должны определить атрибут subtitle.

В приведенном выше примере мы установили subtitle Atom-ленты на description RSS-ленты, поскольку она уже довольно короткая.

И сопутствующий 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

    # LANGUAGE -- Optional. This should be a string specifying a language
    # code. Defaults to django.utils.translation.get_language().
    language = 'de'

    # 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.

    # ITEM COMMENTS URL -- It's optional to use one of these three. This is
    # a hook that specifies how to get the URL of a page for comments for a
    # given item.

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

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

    item_comments = 'https://www.example.com/comments' # Hard-coded comments URL

Низкоуровневая структура

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

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

SyndicationFeed классы

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

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

Каждый из этих трех классов знает, как отобразить определенный тип фида в виде 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 для использования в custom feed generators.

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

SyndicationFeed.add_item()

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

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

  • title
  • link
  • description

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

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

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

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

  • 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 Blog",
...     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, Apple iTunes podcast format и т.д.), у вас есть лучший выбор. Эти типы каналов обычно добавляют дополнительные элементы и/или атрибуты к основному формату, и существует набор методов, которые SyndicationFeed вызывает для получения этих дополнительных атрибутов. Таким образом, вы можете подклассифицировать соответствующий класс генератора фида (Atom1Feed или Rss201rev2Feed) и расширить эти обратные вызовы. К ним относятся:

SyndicationFeed.root_attributes(self)
Возвращает dict атрибутов для добавления к корневому элементу корма (feed/channel).
SyndicationFeed.add_root_elements(self, handler)
Обратный вызов для добавления элементов внутри корневого элемента feed (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')

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

Вернуться на верх