{"title":"Kerangka kerja umpan perkongsian","version":"5.2","locale":"id","docname":"ref/contrib/syndication","url":"/id/5.2/ref/contrib/syndication/","canonical":"https://djangodocs.dev/id/5.2/ref/contrib/syndication/","summary":"Django comes with a high-level syndication-feed-generating framework for creating RSS and Atom feeds. Untuk membuat umpan sindikasi apapun, semua anda harus lakukan…","html":"

Kerangka kerja umpan perkongsianLink to this heading#

\n

Django comes with a high-level syndication-feed-generating framework for\ncreating RSS and Atom feeds.

\n

Untuk membuat umpan sindikasi apapun, semua anda harus lakukan adalah menulis kelas Python pendek. Anda dapat membuat sebanyak umpan anda inginkan.

\n

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

\n
\n

Kerangka kerja tingkat-tinggiLink to this heading#

\n
\n

IkhtisarLink to this heading#

\n

Kerangka kerja membangkitkan-umpan tingkat-tinggi didukung oleh kelas Feed dan tunjuk kesebuah contoh dari itu dalam URLconf anda.

\n
\n
\n

Kelas-kelas FeedLink to this heading#

\n

Sebuah kelas Feed adalah sebuah kelas Python yang mewakili umpan persengkongkolan. Sebuah umpan dapat berupa sederhana (misalnya, sebuah umpan "situs berita", atau umpan dasar menampilkan masukan terakhir dari blog) atau lebih rumit (misalnya, sebuah umpan menampilkan semua masukan blog dalam sebuah kategori tertentu, dimana kategori adalah variabel).

\n

Subkelas kelas-kelas umpan django.contrib.syndication.views.Feed. Mereka dapat berada dimana saka dalam dasar kode anda.

\n

Instance dari kelas-kelas Feed adalah tampilan dimana dapat digunakan dalam URLconf anda.

\n
\n
\n

Sebuah contoh sederhanaLink to this heading#

\n

Contoh sederhana ini, diambil daro hipotesa polisi melebihi situs berita menggambarkan sebuah umpan dari lima barang berita terakhir.

\n
Code
from django.contrib.syndication.views import Feed\nfrom django.urls import reverse\nfrom policebeat.models import NewsItem\n\n\nclass LatestEntriesFeed(Feed):\n    title = "Police beat site news"\n    link = "/sitenews/"\n    description = "Updates on changes and additions to police beat central."\n\n    def items(self):\n        return NewsItem.objects.order_by("-pub_date")[:5]\n\n    def item_title(self, item):\n        return item.title\n\n    def item_description(self, item):\n        return item.description\n\n    # item_link is only needed if NewsItem has no get_absolute_url method.\n    def item_link(self, item):\n        return reverse("news-item", args=[item.pk])\n
\n

Untuk menghubungi URL ke umpan ini, taruh sebuah instance dari obyek Feed dalam URLconf anda. Sebagai contoh:

\n
Code
from django.urls import path\nfrom myproject.feeds import LatestEntriesFeed\n\nurlpatterns = [\n    # ...\n    path("latest/feed/", LatestEntriesFeed()),\n    # ...\n]\n
\n

Catatan:

\n\n

Satu hal tersisa untuk dilakukan. Dalam sebuah umpan RSS, setiap <item> mempunyai sebuah <title>, <link> dan <description>. Kami butuh memberitahu kerangka kerja data apa untuk ditaruh kedalam unsur-unsur tersebut.

\n\n
\n
\n

Sebuah contoh rumitLink to this heading#

\n

Kerangka kerja juga mendukung umpan kebih rumit, melalui argumen.

\n

Sebagai contoh, sebuah situs jaringan dapat menawarkan sebuah umpan RSS pada kesalahan baru untuk setiap polisi dikalahkan dalam kota. Itu konyol untuk membuat kelas Feed terpisah untuk polisi kalah; itu akan melanggar DRY principle dan akan memasangkan data ke logika pemrograman. Sebagai gantinya, persengkongkolan kerangka kerja membiarkan anda mengakses argumen-argumen dilewatkan dari URLconf anda sehingga umpan dapat mengeluarkan barang berdasarkan pada informasi dalam URL umpan.

\n

Polisi mengalahkan umpan dapat diakses melalui URL seperti ini:

\n\n

Ini dapat cocok dengan baris URLconf seperti:

\n
Code
path("beats/<int:beat_id>/rss/", BeatFeed()),\n
\n

Seperti sebuah tampilan, argumen-argumen dalam URL dilewatkan ke metode get_object() bersama dengan obyek diminta.

\n

Ini adalah kode untuk umpan kalah-khusus:

\n
Code
from django.contrib.syndication.views import Feed\n\n\nclass BeatFeed(Feed):\n    description_template = "feeds/beat_description.html"\n\n    def get_object(self, request, beat_id):\n        return Beat.objects.get(pk=beat_id)\n\n    def title(self, obj):\n        return "Police beat central: Crimes for beat %s" % obj.beat\n\n    def link(self, obj):\n        return obj.get_absolute_url()\n\n    def description(self, obj):\n        return "Crimes recently reported in police beat %s" % obj.beat\n\n    def items(self, obj):\n        return Crime.objects.filter(beat=obj).order_by("-crime_date")[:30]\n
\n

To generate the feed's <title>, <link> and <description>, Django\nuses the title(), link() and description() methods. In\nthe previous example, they were string class attributes, but this example\nillustrates that they can be either strings or methods. For each of\ntitle, link and description, Django follows this\nalgorithm:

\n\n

Juga catat bahwa items() juga mengikuti algoritma sama -- pertama, itu mencoba items(obj), kemudian items(), lalu akhirnya atribut kelas items (yang harus berupa list).

\n

We are using a template for the item descriptions. It can be as minimal as\nthis:

\n
Django template
{{ obj.description }}\n
\n

Bagaimanapun, anda bebas menambahkan bentuk seperti diinginkan.

\n

Kelas ExampleFeed dibawah memberikan dokumentasi penuh pada metode dan atribut dari kelas-kelas Feed.

\n
\n
\n

Menentukan jenis dari umpanLink to this heading#

\n

Seperti awalan, umpan-umpan dihasilkan dalam kerangka kerja ini menggunakan RSS 2.0.

\n

Untuk merubah itu, tambah sebuah atribut feed_type ke kelas class:~django.contrib.syndication.views.Feed anda, seperti itu:

\n
Code
from django.utils.feedgenerator import Atom1Feed\n\n\nclass MyFeed(Feed):\n    feed_type = Atom1Feed\n
\n

Catat bahwa mensetel feed_type pada sebuah obyek kelas, bukan sebuah instance.

\n

Saat ini jenis umpan tersedia adalah:

\n\n
\n
\n

LampiranLink to this heading#

\n

Untuk menentukan penutup, seperti yang digunakan dalam membuat umpan podcast , gunakan kaitan item_enclosures atau, cara lain dan jika anda hanya mempunyai penutup tunggal per barang, kaitan item_enclosure_url, item_enclosure_length, dan item_enclosure_mime_type. Lihat kelas ExampleFeed dibawah untuk contoh penggunaan.

\n
\n
\n

BahasaLink to this heading#

\n

Feeds created by the syndication framework automatically include the\nappropriate <language> tag (RSS 2.0) or xml:lang attribute (Atom). By\ndefault, this is django.utils.translation.get_language(). You can change it\nby setting the language class attribute.

\n
\n
\n

URLLink to this heading#

\n

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

\n

Umpan-umpan atom membutuhkan sebuah <link rel="self"> yang menentukan tempat saat ini umpan. Kerangka kerja persengkongkolan mengumpulkan ini otomatis, menggunakan ranah dari situs saat ini menurut pada pengaturan SITE_ID.

\n
\n
\n

menerbitkan Atom dan umpan RSS secara berduaanLink to this heading#

\n

Some developers like to make available both Atom and RSS versions of their\nfeeds. To do that, you can create a subclass of your\nFeed class and set the feed_type\nto something different. Then update your URLconf to add the extra versions.

\n

Ini adalah contoh lengkap:

\n
Code
from django.contrib.syndication.views import Feed\nfrom policebeat.models import NewsItem\nfrom django.utils.feedgenerator import Atom1Feed\n\n\nclass RssSiteNewsFeed(Feed):\n    title = "Police beat site news"\n    link = "/sitenews/"\n    description = "Updates on changes and additions to police beat central."\n\n    def items(self):\n        return NewsItem.objects.order_by("-pub_date")[:5]\n\n\nclass AtomSiteNewsFeed(RssSiteNewsFeed):\n    feed_type = Atom1Feed\n    subtitle = RssSiteNewsFeed.description\n
\n\n

Dan menemani URLconf:

\n
Code
from django.urls import path\nfrom myproject.feeds import AtomSiteNewsFeed, RssSiteNewsFeed\n\nurlpatterns = [\n    # ...\n    path("sitenews/rss/", RssSiteNewsFeed()),\n    path("sitenews/atom/", AtomSiteNewsFeed()),\n    # ...\n]\n
\n
\n
\n

Acuan kelas FeedLink to this heading#

\n
\n
\nclass views.FeedLink to this definition#
\n
\n\n

Contoh ini menggambarkan semua kemungkinan atribut dan metode untuk sebuah kelas Feed.

\n
Code
from django.contrib.syndication.views import Feed\nfrom django.utils import feedgenerator\n\n\nclass ExampleFeed(Feed):\n    # FEED TYPE -- Optional. This should be a class that subclasses\n    # django.utils.feedgenerator.SyndicationFeed. This designates\n    # which type of feed this should be: RSS 2.0, Atom 1.0, etc. If\n    # you don't specify feed_type, your feed will be RSS 2.0. This\n    # should be a class, not an instance of the class.\n\n    feed_type = feedgenerator.Rss201rev2Feed\n\n    # TEMPLATE NAMES -- Optional. These should be strings\n    # representing names of Django templates that the system should\n    # use in rendering the title and description of your feed items.\n    # Both are optional. If a template is not specified, the\n    # item_title() or item_description() methods are used instead.\n\n    title_template = None\n    description_template = None\n\n    # LANGUAGE -- Optional. This should be a string specifying a language\n    # code. Defaults to django.utils.translation.get_language().\n    language = "de"\n\n    # TITLE -- One of the following three is required. The framework\n    # looks for them in this order.\n\n    def title(self, obj):\n        """\n        Takes the object returned by get_object() and returns the\n        feed's title as a normal Python string.\n        """\n\n    def title(self):\n        """\n        Returns the feed's title as a normal Python string.\n        """\n\n    title = "foo"  # Hard-coded title.\n\n    # LINK -- One of the following three is required. The framework\n    # looks for them in this order.\n\n    def link(self, obj):\n        """\n        # Takes the object returned by get_object() and returns the URL\n        # of the HTML version of the feed as a normal Python string.\n        """\n\n    def link(self):\n        """\n        Returns the URL of the HTML version of the feed as a normal Python\n        string.\n        """\n\n    link = "/blog/"  # Hard-coded URL.\n\n    # FEED_URL -- One of the following three is optional. The framework\n    # looks for them in this order.\n\n    def feed_url(self, obj):\n        """\n        # Takes the object returned by get_object() and returns the feed's\n        # own URL as a normal Python string.\n        """\n\n    def feed_url(self):\n        """\n        Returns the feed's own URL as a normal Python string.\n        """\n\n    feed_url = "/blog/rss/"  # Hard-coded URL.\n\n    # GUID -- One of the following three is optional. The framework looks\n    # for them in this order. This property is only used for Atom feeds\n    # (where it is the feed-level ID element). If not provided, the feed\n    # link is used as the ID.\n\n    def feed_guid(self, obj):\n        """\n        Takes the object returned by get_object() and returns the globally\n        unique ID for the feed as a normal Python string.\n        """\n\n    def feed_guid(self):\n        """\n        Returns the feed's globally unique ID as a normal Python string.\n        """\n\n    feed_guid = "/foo/bar/1234"  # Hard-coded guid.\n\n    # DESCRIPTION -- One of the following three is required. The framework\n    # looks for them in this order.\n\n    def description(self, obj):\n        """\n        Takes the object returned by get_object() and returns the feed's\n        description as a normal Python string.\n        """\n\n    def description(self):\n        """\n        Returns the feed's description as a normal Python string.\n        """\n\n    description = "Foo bar baz."  # Hard-coded description.\n\n    # AUTHOR NAME --One of the following three is optional. The framework\n    # looks for them in this order.\n\n    def author_name(self, obj):\n        """\n        Takes the object returned by get_object() and returns the feed's\n        author's name as a normal Python string.\n        """\n\n    def author_name(self):\n        """\n        Returns the feed's author's name as a normal Python string.\n        """\n\n    author_name = "Sally Smith"  # Hard-coded author name.\n\n    # AUTHOR EMAIL --One of the following three is optional. The framework\n    # looks for them in this order.\n\n    def author_email(self, obj):\n        """\n        Takes the object returned by get_object() and returns the feed's\n        author's email as a normal Python string.\n        """\n\n    def author_email(self):\n        """\n        Returns the feed's author's email as a normal Python string.\n        """\n\n    author_email = "test@example.com"  # Hard-coded author email.\n\n    # AUTHOR LINK --One of the following three is optional. The framework\n    # looks for them in this order. In each case, the URL should include\n    # the scheme (such as "https://") and domain name.\n\n    def author_link(self, obj):\n        """\n        Takes the object returned by get_object() and returns the feed's\n        author's URL as a normal Python string.\n        """\n\n    def author_link(self):\n        """\n        Returns the feed's author's URL as a normal Python string.\n        """\n\n    author_link = "https://www.example.com/"  # Hard-coded author URL.\n\n    # CATEGORIES -- One of the following three is optional. The framework\n    # looks for them in this order. In each case, the method/attribute\n    # should return an iterable object that returns strings.\n\n    def categories(self, obj):\n        """\n        Takes the object returned by get_object() and returns the feed's\n        categories as iterable over strings.\n        """\n\n    def categories(self):\n        """\n        Returns the feed's categories as iterable over strings.\n        """\n\n    categories = ["python", "django"]  # Hard-coded list of categories.\n\n    # COPYRIGHT NOTICE -- One of the following three is optional. The\n    # framework looks for them in this order.\n\n    def feed_copyright(self, obj):\n        """\n        Takes the object returned by get_object() and returns the feed's\n        copyright notice as a normal Python string.\n        """\n\n    def feed_copyright(self):\n        """\n        Returns the feed's copyright notice as a normal Python string.\n        """\n\n    feed_copyright = "Copyright (c) 2007, Sally Smith"  # Hard-coded copyright notice.\n\n    # TTL -- One of the following three is optional. The framework looks\n    # for them in this order. Ignored for Atom feeds.\n\n    def ttl(self, obj):\n        """\n        Takes the object returned by get_object() and returns the feed's\n        TTL (Time To Live) as a normal Python string.\n        """\n\n    def ttl(self):\n        """\n        Returns the feed's TTL as a normal Python string.\n        """\n\n    ttl = 600  # Hard-coded Time To Live.\n\n    # STYLESHEETS -- Optional. To set, provide one of the following three.\n    # The framework looks for them in this order.\n\n    def stylesheets(self, obj):\n        """\n        Takes the object returned by get_object() and returns the feed's\n        stylesheets (as URL strings or as Stylesheet instances).\n        """\n\n    def stylesheets(self):\n        """\n        Returns the feed's stylesheets (as URL strings or Stylesheet\n        instances).\n        """\n\n    # Hardcoded stylesheets.\n    stylesheets = ["/stylesheet1.xsl", "stylesheet2.xsl"]\n\n    # ITEMS -- One of the following three is required. The framework looks\n    # for them in this order.\n\n    def items(self, obj):\n        """\n        Takes the object returned by get_object() and returns a list of\n        items to publish in this feed.\n        """\n\n    def items(self):\n        """\n        Returns a list of items to publish in this feed.\n        """\n\n    items = ["Item 1", "Item 2"]  # Hard-coded items.\n\n    # GET_OBJECT -- This is required for feeds that publish different data\n    # for different URL parameters. (See "A complex example" above.)\n\n    def get_object(self, request, *args, **kwargs):\n        """\n        Takes the current request and the arguments from the URL, and\n        returns an object represented by this feed. Raises\n        django.core.exceptions.ObjectDoesNotExist on error.\n        """\n\n    # ITEM TITLE AND DESCRIPTION -- If title_template or\n    # description_template are not defined, these are used instead. Both are\n    # optional, by default they will use the string representation of the\n    # item.\n\n    def item_title(self, item):\n        """\n        Takes an item, as returned by items(), and returns the item's\n        title as a normal Python string.\n        """\n\n    def item_title(self):\n        """\n        Returns the title for every item in the feed.\n        """\n\n    item_title = "Breaking News: Nothing Happening"  # Hard-coded title.\n\n    def item_description(self, item):\n        """\n        Takes an item, as returned by items(), and returns the item's\n        description as a normal Python string.\n        """\n\n    def item_description(self):\n        """\n        Returns the description for every item in the feed.\n        """\n\n    item_description = "A description of the item."  # Hard-coded description.\n\n    def get_context_data(self, **kwargs):\n        """\n        Returns a dictionary to use as extra context if either\n        description_template or item_template are used.\n\n        Default implementation preserves the old behavior\n        of using {'obj': item, 'site': current_site} as the context.\n        """\n\n    # ITEM LINK -- One of these three is required. The framework looks for\n    # them in this order.\n\n    # First, the framework tries the two methods below, in\n    # order. Failing that, it falls back to the get_absolute_url()\n    # method on each item returned by items().\n\n    def item_link(self, item):\n        """\n        Takes an item, as returned by items(), and returns the item's URL.\n        """\n\n    def item_link(self):\n        """\n        Returns the URL for every item in the feed.\n        """\n\n    # ITEM_GUID -- The following method is optional. If not provided, the\n    # item's link is used by default.\n\n    def item_guid(self, obj):\n        """\n        Takes an item, as return by items(), and returns the item's ID.\n        """\n\n    # ITEM_GUID_IS_PERMALINK -- The following method is optional. If\n    # provided, it sets the 'isPermaLink' attribute of an item's\n    # GUID element. This method is used only when 'item_guid' is\n    # specified.\n\n    def item_guid_is_permalink(self, obj):\n        """\n        Takes an item, as returned by items(), and returns a boolean.\n        """\n\n    item_guid_is_permalink = False  # Hard coded value\n\n    # ITEM AUTHOR NAME -- One of the following three is optional. The\n    # framework looks for them in this order.\n\n    def item_author_name(self, item):\n        """\n        Takes an item, as returned by items(), and returns the item's\n        author's name as a normal Python string.\n        """\n\n    def item_author_name(self):\n        """\n        Returns the author name for every item in the feed.\n        """\n\n    item_author_name = "Sally Smith"  # Hard-coded author name.\n\n    # ITEM AUTHOR EMAIL --One of the following three is optional. The\n    # framework looks for them in this order.\n    #\n    # If you specify this, you must specify item_author_name.\n\n    def item_author_email(self, obj):\n        """\n        Takes an item, as returned by items(), and returns the item's\n        author's email as a normal Python string.\n        """\n\n    def item_author_email(self):\n        """\n        Returns the author email for every item in the feed.\n        """\n\n    item_author_email = "test@example.com"  # Hard-coded author email.\n\n    # ITEM AUTHOR LINK -- One of the following three is optional. The\n    # framework looks for them in this order. In each case, the URL should\n    # include the scheme (such as "https://") and domain name.\n    #\n    # If you specify this, you must specify item_author_name.\n\n    def item_author_link(self, obj):\n        """\n        Takes an item, as returned by items(), and returns the item's\n        author's URL as a normal Python string.\n        """\n\n    def item_author_link(self):\n        """\n        Returns the author URL for every item in the feed.\n        """\n\n    item_author_link = "https://www.example.com/"  # Hard-coded author URL.\n\n    # ITEM ENCLOSURES -- One of the following three is optional. The\n    # framework looks for them in this order. If one of them is defined,\n    # ``item_enclosure_url``, ``item_enclosure_length``, and\n    # ``item_enclosure_mime_type`` will have no effect.\n\n    def item_enclosures(self, item):\n        """\n        Takes an item, as returned by items(), and returns a list of\n        ``django.utils.feedgenerator.Enclosure`` objects.\n        """\n\n    def item_enclosures(self):\n        """\n        Returns the ``django.utils.feedgenerator.Enclosure`` list for every\n        item in the feed.\n        """\n\n    item_enclosures = []  # Hard-coded enclosure list\n\n    # ITEM ENCLOSURE URL -- One of these three is required if you're\n    # publishing enclosures and you're not using ``item_enclosures``. The\n    # framework looks for them in this order.\n\n    def item_enclosure_url(self, item):\n        """\n        Takes an item, as returned by items(), and returns the item's\n        enclosure URL.\n        """\n\n    def item_enclosure_url(self):\n        """\n        Returns the enclosure URL for every item in the feed.\n        """\n\n    item_enclosure_url = "/foo/bar.mp3"  # Hard-coded enclosure link.\n\n    # ITEM ENCLOSURE LENGTH -- One of these three is required if you're\n    # publishing enclosures and you're not using ``item_enclosures``. The\n    # framework looks for them in this order. In each case, the returned\n    # value should be either an integer, or a string representation of the\n    # integer, in bytes.\n\n    def item_enclosure_length(self, item):\n        """\n        Takes an item, as returned by items(), and returns the item's\n        enclosure length.\n        """\n\n    def item_enclosure_length(self):\n        """\n        Returns the enclosure length for every item in the feed.\n        """\n\n    item_enclosure_length = 32000  # Hard-coded enclosure length.\n\n    # ITEM ENCLOSURE MIME TYPE -- One of these three is required if you're\n    # publishing enclosures and you're not using ``item_enclosures``. The\n    # framework looks for them in this order.\n\n    def item_enclosure_mime_type(self, item):\n        """\n        Takes an item, as returned by items(), and returns the item's\n        enclosure MIME type.\n        """\n\n    def item_enclosure_mime_type(self):\n        """\n        Returns the enclosure MIME type for every item in the feed.\n        """\n\n    item_enclosure_mime_type = "audio/mpeg"  # Hard-coded enclosure MIME type.\n\n    # ITEM PUBDATE -- It's optional to use one of these three. This is a\n    # hook that specifies how to get the pubdate for a given item.\n    # In each case, the method/attribute should return a Python\n    # datetime.datetime object.\n\n    def item_pubdate(self, item):\n        """\n        Takes an item, as returned by items(), and returns the item's\n        pubdate.\n        """\n\n    def item_pubdate(self):\n        """\n        Returns the pubdate for every item in the feed.\n        """\n\n    item_pubdate = datetime.datetime(2005, 5, 3)  # Hard-coded pubdate.\n\n    # ITEM UPDATED -- It's optional to use one of these three. This is a\n    # hook that specifies how to get the updateddate for a given item.\n    # In each case, the method/attribute should return a Python\n    # datetime.datetime object.\n\n    def item_updateddate(self, item):\n        """\n        Takes an item, as returned by items(), and returns the item's\n        updateddate.\n        """\n\n    def item_updateddate(self):\n        """\n        Returns the updateddate for every item in the feed.\n        """\n\n    item_updateddate = datetime.datetime(2005, 5, 3)  # Hard-coded updateddate.\n\n    # ITEM CATEGORIES -- It's optional to use one of these three. This is\n    # a hook that specifies how to get the list of categories for a given\n    # item. In each case, the method/attribute should return an iterable\n    # object that returns strings.\n\n    def item_categories(self, item):\n        """\n        Takes an item, as returned by items(), and returns the item's\n        categories.\n        """\n\n    def item_categories(self):\n        """\n        Returns the categories for every item in the feed.\n        """\n\n    item_categories = ["python", "django"]  # Hard-coded categories.\n\n    # ITEM COPYRIGHT NOTICE (only applicable to Atom feeds) -- One of the\n    # following three is optional. The framework looks for them in this\n    # order.\n\n    def item_copyright(self, obj):\n        """\n        Takes an item, as returned by items(), and returns the item's\n        copyright notice as a normal Python string.\n        """\n\n    def item_copyright(self):\n        """\n        Returns the copyright notice for every item in the feed.\n        """\n\n    item_copyright = "Copyright (c) 2007, Sally Smith"  # Hard-coded copyright notice.\n\n    # ITEM COMMENTS URL -- It's optional to use one of these three. This is\n    # a hook that specifies how to get the URL of a page for comments for a\n    # given item.\n\n    def item_comments(self, obj):\n        """\n        Takes an item, as returned by items(), and returns the item's\n        comments URL as a normal Python string.\n        """\n\n    def item_comments(self):\n        """\n        Returns the comments URL for every item in the feed.\n        """\n\n    item_comments = "https://www.example.com/comments"  # Hard-coded comments URL\n
\n
\n
\n
\n

Kerangka kerja tingkat-rendahLink to this heading#

\n

Behind the scenes, the high-level RSS framework uses a lower-level framework\nfor generating feeds' XML. This framework lives in a single module:\ndjango/utils/feedgenerator.py.

\n

Anda menggunakan kerangka kerja ini pada milik anda, untuk pembangkitan umpan tingkat-rendah. Anda dapat juga membuat pembangkit umpan penyesuaian subkelas-subkelas untuk digunakan dengan pilihan feed_type Feed.

\n
\n

Kelas-kelas SyndicationFeedLink to this heading#

\n

Modul feedgenerator megnandung kelas dasar:

\n\n

dan beberapa subkelas:

\n\n

Setiap dari ketiga kelas ini mengetahui bagaimana membangun jenis tertentu dari umpan sebagai XML. Mereka berbagi antarmuka ini:

\n
\n
SyndicationFeed.__init__()

Awalkan umpan dengan direktori yang diberikan dari metadata, yang berlaku ke seluruh umpan. Argumen kata kunci yang dibutuhkan adalah:

\n
    \n

  • title

    • \n

  • link

    • \n

  • description

    • \n
\n

Ada juga banyak dari katakunci pilihan lain:

\n
    \n

  • language

    • \n

  • author_email

    • \n

  • author_name

    • \n

  • author_link

    • \n

  • subtitle

    • \n

  • categories

    • \n

  • feed_url

    • \n

  • feed_copyright

    • \n

  • feed_guid

    • \n

  • ttl

    • \n

  • stylesheets

    • \n
\n

Argumen kata kunci tambahan apapun anda lewatkan ke __init__ akan disimpan dalam self.feed untuk digunakan dengan custom feed generators.

\n

All parameters should be strings, except for two:

\n
    \n

  • categories harus berupa urutan string.

    • \n

  • stylesheets should be a sequence of either strings or\nStylesheet instances.

    • \n
\n

Beware that some control characters are\nnot allowed in\nXML documents. If your content has some of them, you might encounter a\nValueError when producing the feed.

\n\n
\n
SyndicationFeed.add_item()

Tambah sebuah barang ke umpan dengan parameter yang diberikan.

\n

Argumen kata kunci yang diwajibkan adalah:

\n
    \n

  • title

    • \n

  • link

    • \n

  • description

    • \n
\n

Argumen kata kunci pilihan adalah:

\n
    \n

  • author_email

    • \n

  • author_name

    • \n

  • author_link

    • \n

  • pubdate

    • \n

  • comments

    • \n

  • unique_id

    • \n

  • enclosures

    • \n

  • categories

    • \n

  • item_copyright

    • \n

  • ttl

    • \n

  • updateddate

    • \n
\n

Argumen kata kunci tambahan akan disimpan untuk custom feed generators.

\n

Semua parameter, jika diberikan, harus berupa string, kecuali:

\n\n
\n
SyndicationFeed.write()

Keluaran umpan dalam penyandian diberikan ke outfile, yang adalah obyek seperti-berkas.

\n
\n
SyndicationFeed.writeString()

Mengembalikan umpan sebagai string dalam penyandian yang diberikan.

\n
\n
\n

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

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

Pembangkit umpan penyesuaianLink to this heading#

\n

Jika anda butuh menghasilkan bentuk umpan penyesuaian, anda mendapatkan sepasang pilihan.

\n

Jika bentuk umpan sama sekali penyesuaian, anda akan ingin mensubkelaskan SyndicationFeed dan sama sekali mengganti metode write() dan writeString().

\n

Bagaimanapun, jika bentuk umpan adalah berputar dari RSS atau Atom (yaitu GeoRSS, iTunes podcast format Apple, dll.), anda mendapatkan pilihan lebih baik. Jenis-jenis ini dari umpan khususnya menambahkan unsur-unsur tambahan dan/atau atribut pada bentuk pokok, dan ada kumpulan dari metode yang SyndicationFeed panggil untuk mendapatkan atribut tambahan ini. Dengan demikian, anda dapat mensubkelaskan kelas pembangkit umpan sesuai (Atom1Feed atau Rss201rev2Feed) dan memperpanjang callback ini. mereka adalah:

\n
\n
SyndicationFeed.root_attributes(self)

Mengembalikan atribut dict untuk menamabhkan ke unsur umpan akar (feed/channel).

\n
\n
SyndicationFeed.add_root_elements(self, handler)

Callback untuk menambahkan unsur-unsur didalam akar unsur umpan (feed/channel). handler adalah sebuah XMLGenerator dari pustaka SAX Python siap-pakai; anda dapat memanggil metode pada itu untuk menambahkan dokumen XML dalam pengolahan.

\n
\n
SyndicationFeed.item_attributes(self, item)

Mengembalikan sebuah atribut dict untuk menambahkan ke setiap unsur barang (item/entry). Argumen, item, adalah sebuah dictionary dari semua data dilewatkan ke SyndicationFeed.add_item().

\n
\n
SyndicationFeed.add_item_elements(self, handler, item)

Callback pada tambah untus pada setiap unsur barang (item/entry). handler dan item seperti diatas.

\n
\n
\n\n

Sebagai contoh, anda mungkin memulai menerapkan pembangkit umpan RSS iTunes seperti itu:

\n
Code
class iTunesFeed(Rss201rev2Feed):\n    def root_attributes(self):\n        attrs = super().root_attributes()\n        attrs["xmlns:itunes"] = "http://www.itunes.com/dtds/podcast-1.0.dtd"\n        return attrs\n\n    def add_root_elements(self, handler):\n        super().add_root_elements(handler)\n        handler.addQuickElement("itunes:explicit", "clean")\n
\n

There's a lot more work to be done for a complete custom feed class, but the\nabove example should demonstrate the basic idea.

\n
\n
\n

Feed stylesheetsLink to this heading#

\n\n

If you wish to have your RSS feed render nicely in a browser, you will need to\nprovide styling information for the XML file, typically in XSLT or CSS\nformats.

\n

You can add this to your RSS feed by setting the stylesheets attribute on\nthe feed class.

\n

This can be a hardcoded URL:

\n
Code
from django.contrib.syndication.views import Feed\n\n\nclass FeedWithHardcodedStylesheet(Feed):\n    stylesheets = [\n        "https://example.com/rss_stylesheet.xslt",\n    ]\n
\n

You can also use Django's static files system:

\n
Code
from django.contrib.syndication.views import Feed\nfrom django.templatetags.static import static\n\n\nclass FeedWithStaticFileStylesheet(Feed):\n    stylesheets = [\n        static("rss_styles.xslt"),\n    ]\n
\n

Another option is to have a view in your project that renders the XSLT\ndocument. You can then link it like so:

\n
Code
from django.contrib.syndication.views import Feed\nfrom django.urls import reverse_lazy\n\n\nclass FeedWithStylesheetView(Feed):\n    stylesheets = [\n        reverse_lazy("your-custom-view-name"),\n    ]\n
\n

Django will normally try to guess the MIME type of the given URL based on its\nextension, but if that fails you can specify it using the\nStylesheet class:

\n
Code
from django.contrib.syndication.views import Feed\nfrom django.utils.feedgenerator import Stylesheet\n\n\nclass FeedWithHardcodedStylesheet(Feed):\n    stylesheets = [\n        Stylesheet("https://example.com/rss_stylesheet", mimetype="text/xsl"),\n    ]\n
\n

Similarly, if you'd like to use a different media attribute than screen\n(Django's default), you can use the\nStylesheet class again:

\n
Code
from django.contrib.syndication.views import Feed\nfrom django.utils.feedgenerator import Stylesheet\n\n\nclass FeedWithHardcodedStylesheet(Feed):\n    stylesheets = [\n        Stylesheet("https://example.com/rss_stylesheet.xslt", media="print"),\n    ]\n
\n

Any of these options can be combined when using multiple stylesheets:

\n
Code
from django.contrib.syndication.views import Feed\nfrom django.utils.feedgenerator import Stylesheet\n\n\nclass MultiStylesheetFeed(Feed):\n    stylesheets = [\n        "/stylesheet1.xsl",\n        Stylesheet("/stylesheet2.xsl"),\n    ]\n
\n
\n
","rootId":"module-django.contrib.syndication","toc":[{"title":"Kerangka kerja tingkat-tinggi","anchor":"the-high-level-framework","children":[{"title":"Ikhtisar","anchor":"overview","children":[]},{"title":"Kelas-kelas Feed","anchor":"feed-classes","children":[]},{"title":"Sebuah contoh sederhana","anchor":"a-simple-example","children":[]},{"title":"Sebuah contoh rumit","anchor":"a-complex-example","children":[]},{"title":"Menentukan jenis dari umpan","anchor":"specifying-the-type-of-feed","children":[]},{"title":"Lampiran","anchor":"enclosures","children":[]},{"title":"Bahasa","anchor":"language","children":[]},{"title":"URL","anchor":"urls","children":[]},{"title":"menerbitkan Atom dan umpan RSS secara berduaan","anchor":"publishing-atom-and-rss-feeds-in-tandem","children":[]},{"title":"Acuan kelas Feed","anchor":"feed-class-reference","children":[]}]},{"title":"Kerangka kerja tingkat-rendah","anchor":"the-low-level-framework","children":[{"title":"Kelas-kelas SyndicationFeed","anchor":"syndicationfeed-classes","children":[]},{"title":"Pembangkit umpan penyesuaian","anchor":"custom-feed-generators","children":[]},{"title":"Feed stylesheets","anchor":"feed-stylesheets","children":[]}]}],"breadcrumbs":[{"docname":"ref/index","title":"Acuan API","url":"/id/5.2/ref/"},{"docname":"ref/contrib/index","title":"Paket contrib","url":"/id/5.2/ref/contrib/"}],"prev":{"docname":"ref/contrib/staticfiles","title":"Aplikasi staticfiles","url":"/id/5.2/ref/contrib/staticfiles/"},"next":{"docname":"ref/csrf","title":"Perlindungan Cross Site Request Forgery","url":"/id/5.2/ref/csrf/"},"formats":{"html":"/id/5.2/ref/contrib/syndication/","markdown":"/id/5.2/ref/contrib/syndication.md","json":"/id/5.2/ref/contrib/syndication.json"},"source":"https://github.com/django/django/blob/stable/5.2.x/docs/ref/contrib/syndication.txt","official":"https://docs.djangoproject.com/id/5.2/ref/contrib/syndication/","inVersions":["6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0","1.11","1.10","1.9"],"inLocales":["en","sv","zh-hans","ga","fr","ja","id","it","pt-br","ko","es","el","pl"]}