• 3.2
  • 5.0
  • 6.1
  • Версия документации: 3.1

Система каналов синдикации

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

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

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

Структура высокого уровня

Обзор

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

Классы Подача

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

Подкласс классов каналов django.contrib.syndiction.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.syndiction.views.Feed.

  • title, link и description соответствуют стандартным элементам RSS <title>, <link> и <description> соответственно.

  • items() — это метод, который возвращает список объектов, которые должны быть включены в фид как элементы <item>. Хотя этот пример возвращает объекты NewsItem с использованием объектно-реляционного преобразователя 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 </ref/templates/language>`. Их пути могут быть указаны с помощью атрибутов title_template и description_template в классе Feed. Шаблоны визуализируются для каждого элемента, и им передаются две переменные контекста шаблона:

    • {{ obj }} – Текущий объект (один из тех объектов, которые вы вернули в items()).

    • {{ site }} – Объект django.contrib.sites.models.Site`, представляющий текущий сайт. Это полезно для {{ site.domain }} или {{ site.name }}. Если у вас не установлена ​​платформа сайтов Django, это будет установлено в объект RequestSite. Дополнительную информацию см. в разделе RequestSite документации по платформе сайтов.

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

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

    • сайт: текущий сайт, как описано выше.

    • запрос: текущий запрос.

    Поведение get_context_data() имитирует поведение generic view - вы должны вызывать 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/ – 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(). В предыдущем примере это были атрибуты строкового класса, но этот пример показывает, что они могут быть либо строками, либо или методами. Для каждого из «заголовка», «ссылки» и «описания» 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 для объекта класса, а не для экземпляра.

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

Корпуса

Чтобы указать вложения, например те, которые используются при создании каналов подкастов, используйте крючок 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.

Changed in Django 3.0:

The language class attribute was added. In older versions, the behavior is the same as language = settings.LANGUAGE_CODE.

URL-ы

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 использует «описание», а канал Atom использует «подзаголовок». Это связано с тем, что каналы Atom не предоставляют «описание» на уровне канала, но они предоставляют «подзаголовок».

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

В приведенном выше примере мы установили «подзаголовок» канала Atom на «описание» 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.

Структура низкого уровня

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

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

Классы SyndicateFeed

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

  • django.utils.feedgenerator.SyndictionFeed

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

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

SyndictionFeed.__init__()

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

  • title

  • ссылка

  • description

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

  • язык

  • author_email

  • имя_автора

  • author_link

  • субтитры

  • категории

  • feed_url

  • feed_copyright

  • feed_guid

  • ттл

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

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

SyndictionFeed.add_item()

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

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

  • title

  • ссылка

  • description

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

  • author_email

  • имя_автора

  • author_link

  • опубликовать

  • комментарии

  • уникальный_ид

  • корпуса

  • категории

  • item_copyright

  • ттл

  • обновлено

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

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

  • pubdate должен быть объектом Python datetime.

  • updateddate должен быть объектом Python datetime.

  • enclosures должен быть списком экземпляров django.utils.feedgenerator.Enclosure.

  • Категории должны быть последовательностью строк.

SyndictionFeed.write()

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

SyndictionFeed.writeString()

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

For example, to create an Atom 1.0 feed and print it to standard output:

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

Генераторы пользовательских каналов

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

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

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

SyndictionFeed.root_attributes(self)

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

SyndictionFeed.add_root_elements(self, handler)

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

SyndictionFeed.item_attributes(self, item)

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

SyndictionFeed.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')

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

Back to Top