Django 2.1 - The syndication feed framework

सिंडिकेशन फ़ीड रूपरेखा




django

सिंडिकेशन फ़ीड रूपरेखा

Django एक उच्च-स्तरीय सिंडिकेशन-फीड-जनरेटिंग फ्रेमवर्क के साथ आता है जो RSS और Atom फीड को आसान बनाता है।

किसी भी सिंडिकेशन फ़ीड को बनाने के लिए, आपको केवल एक छोटा पायथन वर्ग लिखना होगा। आप जितने चाहें उतने फीड बना सकते हैं।

Django लो-लेवल फीड-जनरेटिंग API के साथ भी आता है। यदि आप वेब संदर्भ के बाहर या किसी अन्य निचले-स्तर के तरीके से फ़ीड उत्पन्न करना चाहते हैं तो इसका उपयोग करें।

उच्च स्तर की रूपरेखा

अवलोकन

उच्च-स्तरीय फीड-जनरेटिंग फ्रेमवर्क की आपूर्ति Feed क्लास द्वारा की जाती है। एक फ़ीड बनाने के लिए, एक Feed वर्ग लिखें और अपने URLconf में इसका एक उदाहरण इंगित करें।

Feed कक्षाएं

एक Feed वर्ग एक पायथन वर्ग है जो एक सिंडिकेशन फ़ीड का प्रतिनिधित्व करता है। एक फ़ीड सरल हो सकती है (उदाहरण के लिए, "साइट समाचार" फ़ीड, या किसी ब्लॉग की नवीनतम प्रविष्टियों को प्रदर्शित करने वाला एक बुनियादी फ़ीड) या अधिक जटिल (जैसे, किसी विशेष श्रेणी में सभी ब्लॉग प्रविष्टियों को प्रदर्शित करने वाला फ़ीड, जहाँ श्रेणी चर है )।

फ़ीड कक्षाएं उपवर्ग 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 को इस फ़ीड से जोड़ने के लिए, अपने URLconf में फ़ीड ऑब्जेक्ट का एक उदाहरण URLconf । उदाहरण के लिए:

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

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

ध्यान दें:

  • फ़ीड वर्ग उप-वर्ग Feed
  • title , link और description मानक RSS के अनुरूप हैं <title> , <link> और <description> तत्व, क्रमशः।
  • items() , बस, एक विधि है जो वस्तुओं की एक सूची लौटाती है जिसे फ़ीड में शामिल होना चाहिए <item> तत्व। यद्यपि यह उदाहरण Django के ऑब्जेक्ट-रिलेशनल मैपर का उपयोग करके NewsItem ऑब्जेक्ट लौटाता है, items() को मॉडल इंस्टेंस वापस नहीं करना है। यद्यपि आपको Django मॉडल का उपयोग करके कार्यक्षमता के कुछ बिट्स "मुफ्त में" मिलते हैं, items() आप चाहते हैं किसी भी प्रकार की वस्तु वापस कर सकते हैं।
  • यदि आप RSS फ़ीड के बजाय एटम फ़ीड बना रहे हैं, तो description विशेषता के बजाय subtitle विशेषता सेट करें। प्रकाशन एटम और आरएसएस को एक उदाहरण के लिए बाद में मिलकर में देखें।

एक काम करना बाकी है। RSS फ़ीड में, प्रत्येक <item> में एक <title> , <link> और <description> । हमें यह बताने की जरूरत है कि उन तत्वों में क्या डेटा डाला जाए।

  • <title> और <description> की सामग्री के लिए, Django Feed वर्ग पर item_title() और item_description() विधियों को कॉल करने का प्रयास करता है। उन्हें एक एकल पैरामीटर, item पारित किया जाता है, जो स्वयं वस्तु है। ये वैकल्पिक हैं; डिफ़ॉल्ट रूप से, ऑब्जेक्ट का स्ट्रिंग प्रतिनिधित्व दोनों के लिए उपयोग किया जाता है।

    यदि आप शीर्षक या विवरण के लिए कोई विशेष प्रारूपण करना चाहते हैं, तो इसके बजाय Django टेम्प्लेट का उपयोग किया जा सकता है। उनके रास्तों को title_template और Feed क्लास पर description_template विशेषताओं के साथ निर्दिष्ट किया जा सकता है। टेम्प्लेट प्रत्येक आइटम के लिए दिए गए हैं और दो टेम्प्लेट संदर्भ संदर्भ चर पास किए गए हैं:

    • {{ obj }} - वर्तमान वस्तु (वस्तुओं में से जो भी आप लौटे हैं उनमें से एक items() )।
    • {{ site }} - एक django.contrib.sites.models.Site वर्तमान साइट का प्रतिनिधित्व करने वाली वस्तु। यह {{ site.domain }} या {{ site.name }} लिए उपयोगी है। यदि आपके पास Django साइट्स फ्रेमवर्क स्थापित नहीं है, तो यह RequestSite ऑब्जेक्ट पर सेट हो जाएगा। अधिक के लिए साइट्स फ्रेमवर्क प्रलेखन का अनुरोध अनुभाग देखें।

    नीचे एक जटिल उदाहरण देखें जो विवरण टेम्पलेट का उपयोग करता है।

    Feed.get_context_data(**kwargs)

    शीर्षक और विवरण टेम्पलेट्स के लिए अतिरिक्त जानकारी पास करने का एक तरीका भी है, अगर आपको पहले बताए गए दो चर से अधिक की आपूर्ति करने की आवश्यकता है। आप अपने Feed उपवर्ग में get_context_data पद्धति का अपना कार्यान्वयन प्रदान कर सकते हैं। उदाहरण के लिए:

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

    और टेम्पलेट:

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

    इस पद्धति को आइटम द्वारा लौटाए गए सूची के प्रत्येक आइटम के अनुसार एक बार बुलाया जाएगा items() निम्नलिखित खोजशब्द तर्क के साथ:

    • item : वर्तमान आइटम। पश्चगामी संगतता कारणों के लिए, इस संदर्भ चर का नाम {{ obj }}
    • obj : get_object() द्वारा लौटाया गया ऑब्जेक्ट। डिफ़ॉल्ट रूप से यह {{ obj }} (ऊपर देखें) के साथ भ्रम से बचने के लिए टेम्पलेट्स के संपर्क में नहीं है, लेकिन आप इसे get_context_data() अपने कार्यान्वयन में उपयोग कर सकते हैं।
    • site : वर्तमान साइट जैसा कि ऊपर वर्णित है।
    • request : वर्तमान अनुरोध।

    get_context_data() का व्यवहार जेनेरिक विचारों की नकल करता है - आपको मूल डेटा से संदर्भ डेटा पुनर्प्राप्त करने के लिए super() कॉल करने वाला है, अपना डेटा जोड़ें और संशोधित शब्दकोश लौटाएं।

  • <link> की सामग्री को निर्दिष्ट करने के लिए, आपके पास दो विकल्प हैं। items() में प्रत्येक आइटम के लिए, Django पहले Feed वर्ग पर item_link() विधि को कॉल करने का प्रयास करता है। शीर्षक और विवरण के समान तरीके से, इसे एक एकल पैरामीटर, item पारित किया जाता है। यदि वह विधि मौजूद नहीं है, तो Django उस ऑब्जेक्ट पर एक get_absolute_url() विधि निष्पादित करने का प्रयास करता है। दोनों get_absolute_url() और item_link() को सामान्य पायथन स्ट्रिंग के रूप में आइटम का URL वापस करना चाहिए। जैसा कि get_absolute_url() साथ, get_absolute_url() के परिणाम item_link() को सीधे URL में शामिल किया जाएगा, इसलिए आप सभी आवश्यक URL उद्धृत करने और ASCII में विधि के अंदर ही रूपांतरण करने के लिए ज़िम्मेदार हैं।

एक जटिल उदाहरण

तर्कों के माध्यम से फ्रेमवर्क अधिक जटिल फ़ीड्स का भी समर्थन करता है।

उदाहरण के लिए, एक वेबसाइट एक शहर में हर पुलिस बीट के लिए हाल के अपराधों की आरएसएस फ़ीड की पेशकश कर सकती है। प्रत्येक पुलिस बीट के लिए अलग Feed क्लास बनाना मूर्खतापूर्ण होगा; जो DRY सिद्धांत का उल्लंघन करेगा और डेटा को प्रोग्रामिंग लॉजिक में जोड़ेगा। इसके बजाय, सिंडिकेशन फ्रेमवर्क आपको अपने URLconf से पारित तर्कों को एक्सेस करने देता है, ताकि फ़ीड्स के URL में जानकारी के आधार पर फ़ीड्स आउटपुट कर सकें।

पुलिस बीट फ़ीड इस तरह यूआरएल के माध्यम से सुलभ हो सकता है:

  • /beats/613/rss/ - बीट 613 के लिए हाल के अपराध लौटाता है।
  • /beats/1424/rss/ - 1424 बीट के लिए हाल के अपराध लौटाता है।

इन्हें URLconf लाइन से मिलान किया जा सकता है जैसे:

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

एक दृश्य की तरह, URL में तर्क अनुरोध ऑब्जेक्ट के साथ get_object() विधि से पारित किए जाते हैं।

यहाँ इन बीट-विशिष्ट फ़ीड्स के लिए कोड है:

from django.contrib.syndication.views import Feed

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

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

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

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

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

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

फ़ीड का <title> , <link> और <description> उत्पन्न करने के लिए, Django title() , link() और description() विधियों का उपयोग करता है। पिछले उदाहरण में, वे सरल स्ट्रिंग क्लास गुण थे, लेकिन यह उदाहरण दिखाता है कि वे या तो तार या तरीके हो सकते हैं। title , link और description प्रत्येक के लिए, Django इस एल्गोरिथ्म का अनुसरण करता है:

  • सबसे पहले, यह एक विधि को कॉल करने की कोशिश करता है, जो obj तर्क को पारित करता है, जहां obj get_object() द्वारा लौटाया गया ऑब्जेक्ट है।
  • असफल होने पर, यह बिना तर्क के एक विधि को कॉल करने की कोशिश करता है।
  • उसको विफल करते हुए, यह वर्ग विशेषता का उपयोग करता है।

यह भी ध्यान दें कि items() भी उसी एल्गोरिथ्म का अनुसरण करता है - पहले, यह items(obj) , फिर items() , फिर अंत में एक items वर्ग विशेषता (जो एक सूची होनी चाहिए) का प्रयास करता है।

हम आइटम विवरण के लिए एक टेम्पलेट का उपयोग कर रहे हैं। यह बहुत सरल हो सकता है:

{{ obj.description }}

हालाँकि, आप इच्छानुसार स्वरूपण जोड़ने के लिए स्वतंत्र हैं।

नीचे दिए गए ExampleFeed वर्ग Feed वर्गों के तरीकों और विशेषताओं पर पूर्ण प्रलेखन देता है।

फ़ीड के प्रकार को निर्दिष्ट करना

डिफ़ॉल्ट रूप से, इस ढांचे में उत्पादित फ़ीड्स आरएसएस 2.0 का उपयोग करते हैं।

इसे बदलने के लिए, अपने Feed वर्ग में एक feed_type विशेषता जोड़ें, जैसे:

from django.utils.feedgenerator import Atom1Feed

class MyFeed(Feed):
    feed_type = Atom1Feed

ध्यान दें कि आपने feed_type को क्लास ऑब्जेक्ट पर सेट किया है, उदाहरण के लिए नहीं।

वर्तमान में उपलब्ध फ़ीड प्रकार हैं:

बाड़ों

बाड़ों को निर्दिष्ट करने के लिए, जैसे कि पॉडकास्ट फीड बनाने में उपयोग किए जाने वाले item_enclosures , item_enclosures हुक का उपयोग करें या, वैकल्पिक रूप से और यदि आपके पास केवल प्रति आइटम एक एकल संलग्नक है, तो item_enclosure_url , item_enclosure_length , और item_enclosure_mime_type हुक। उपयोग उदाहरणों के लिए नीचे उदाहरण देखें।

भाषा

सिंडिकेशन फ्रेमवर्क द्वारा बनाई गई फ़ीड में स्वचालित रूप से उपयुक्त <language> टैग (RSS 2.0) या xml:lang विशेषता (Atom) शामिल हैं। यह सीधे आपके LANGUAGE_CODE सेटिंग से आता है।

यूआरएल

link विधि / विशेषता या तो एक पूर्ण पथ (जैसे "/blog/" ) या पूरी तरह से योग्य डोमेन और प्रोटोकॉल के साथ एक URL (जैसे "https://www.example.com/blog/" ) पर वापस आ सकती है। यदि link डोमेन को वापस नहीं करता है, तो सिंडिकेशन फ्रेमवर्क आपके SITE_ID setting अनुसार, वर्तमान साइट के डोमेन को सम्मिलित करेगा।

एटम फ़ीड को एक <link rel="self"> आवश्यकता होती है जो फ़ीड के वर्तमान स्थान को परिभाषित करता है। SITE_ID सेटिंग के अनुसार वर्तमान साइट के डोमेन का उपयोग करके सिंडिकेशन फ़्रेमवर्क स्वचालित रूप से इसे SITE_ID करता है।

एटम और आरएसएस को प्रकाशित करना अग्रानुक्रम में फ़ीड करता है

कुछ डेवलपर्स अपने फ़ीड के एटम और आरएसएस दोनों संस्करणों को उपलब्ध कराना पसंद करते हैं। Django के साथ ऐसा करना आसान है: बस अपने Feed वर्ग का एक उपवर्ग बनाएं और feed_type को कुछ अलग करने के लिए सेट करें। फिर अतिरिक्त संस्करण जोड़ने के लिए अपने URLconf को अपडेट करें।

यहाँ एक पूर्ण उदाहरण है:

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

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

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

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

ध्यान दें

इस उदाहरण में, आरएसएस फ़ीड एक description का उपयोग करता है जबकि एटम फ़ीड एक subtitle का उपयोग करता है। ऐसा इसलिए है क्योंकि एटम फ़ीड एक फ़ीड-स्तर "विवरण" के लिए प्रदान नहीं करते हैं, लेकिन वे एक "उपशीर्षक" के लिए प्रदान करते हैं।

यदि आप अपने Feed वर्ग में description प्रदान करते हैं, तो Django स्वचालित रूप से उस subtitle तत्व में नहीं डालेगा, क्योंकि एक उपशीर्षक और विवरण आवश्यक रूप से एक ही चीज़ नहीं है। इसके बजाय, आपको एक subtitle विशेषता को परिभाषित करना चाहिए।

उपरोक्त उदाहरण में, हम एटम फ़ीड के subtitle को RSS फ़ीड के description सेट करते हैं, क्योंकि यह पहले से ही काफी छोटा है।

और साथ में URLconf:

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

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

Feed क्लास संदर्भ

class views.Feed

यह उदाहरण Feed क्लास के लिए सभी संभावित विशेषताओं और विधियों को दिखाता है:

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

class ExampleFeed(Feed):

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

    feed_type = feedgenerator.Rss201rev2Feed

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

    title_template = None
    description_template = None

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

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

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

    title = 'foo' # Hard-coded title.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    author_email = '[email protected]' # 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 = '[email protected]' # 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.

निम्न स्तर की रूपरेखा

पर्दे के पीछे, उच्च-स्तरीय आरएसएस ढांचा फीड्स एक्सएमएल बनाने के लिए निचले स्तर के ढांचे का उपयोग करता है। यह ढांचा एकल मॉड्यूल में रहता है: django/utils/feedgenerator.py

आप इस ढांचे का उपयोग अपने स्तर पर करते हैं, निचले स्तर की फ़ीड पीढ़ी के लिए। आप feed_type Feed विकल्प के साथ उपयोग के लिए कस्टम फ़ीड जनरेटर उप-वर्ग भी बना सकते हैं।

SyndicationFeed कक्षाएं

feedgenerator मॉड्यूल में एक बेस क्लास होता है:

और कई उपवर्ग:

इन तीनों वर्गों में से प्रत्येक एक्सएमएल के रूप में एक निश्चित प्रकार के फ़ीड को प्रस्तुत करना जानता है। वे इस इंटरफ़ेस को साझा करते हैं:

SyndicationFeed.__init__()

मेटाडेटा के दिए गए शब्दकोश के साथ फ़ीड को आरम्भ करें, जो संपूर्ण फ़ीड पर लागू होता है। आवश्यक खोजशब्द तर्क हैं:

  • title
  • link
  • description

अन्य वैकल्पिक कीवर्ड का एक गुच्छा भी है:

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

आपके द्वारा self.feed को पास किए गए किसी भी अतिरिक्त कीवर्ड तर्क कस्टम फ़ीड जनरेटर के साथ उपयोग के लिए self.feed में संग्रहीत किए self.feed

categories को छोड़कर सभी पैरामीटर स्ट्रिंग्स होने चाहिए, जो स्ट्रिंग्स का एक क्रम होना चाहिए। एक्सएमएल दस्तावेजों में कुछ नियंत्रण वर्णों की अनुमति नहीं है कि खबरदार। यदि आपकी सामग्री में उनमें से कुछ हैं, तो आप फ़ीड का उत्पादन करते समय एक ValueError सामना कर सकते हैं।

SyndicationFeed.add_item()

दिए गए मापदंडों के साथ फ़ीड में एक आइटम जोड़ें।

आवश्यक खोजशब्द तर्क हैं:

  • title
  • link
  • description

वैकल्पिक खोजशब्द तर्क हैं:

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

कस्टम फ़ीड जनरेटर के लिए अतिरिक्त कीवर्ड तर्क संग्रहीत किए जाएंगे।

सभी पैरामीटर, यदि दिए गए हैं, तो तार होने चाहिए, सिवाय:

  • pubdate एक Python pubdate ऑब्जेक्ट होना चाहिए।
  • updateddate पायथन updateddate ऑब्जेक्ट होना चाहिए।
  • enclosures में django.utils.feedgenerator.Enclosure इंस्टेंस की सूची होनी चाहिए।
  • categories को तार का एक क्रम होना चाहिए।
SyndicationFeed.write()
आउटफिट को दिए गए एन्कोडिंग में फ़ीड को आउटपुट करता है, जो एक फ़ाइल जैसी वस्तु है।
SyndicationFeed.writeString()
दिए गए एन्कोडिंग में स्ट्रिंग के रूप में फ़ीड लौटाता है।

उदाहरण के लिए, एटम 1.0 फ़ीड बनाने और इसे मानक आउटपुट पर प्रिंट करने के लिए:

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

कस्टम फ़ीड जनरेटर

यदि आपको एक कस्टम फ़ीड प्रारूप तैयार करने की आवश्यकता है, तो आपको कुछ विकल्प मिलेंगे।

यदि फ़ीड प्रारूप पूरी तरह से कस्टम है, तो आप SyndicationFeed को उप- SyndicationFeed करना चाहते हैं और पूरी तरह से write() और writeString() विधियों को बदल सकते हैं।

हालाँकि, यदि फ़ीड प्रारूप RSS या Atom (यानी GeoRSS , Apple के iTunes पॉडकास्ट प्रारूप , आदि) का स्पिन-ऑफ है, तो आपको एक बेहतर विकल्प मिला है। इस प्रकार के फ़ीड आमतौर पर अंतर्निहित प्रारूप में अतिरिक्त तत्वों और / या विशेषताओं को जोड़ते हैं, और इन अतिरिक्त विशेषताओं को प्राप्त करने के लिए SyndicationFeed कॉल के तरीकों का एक सेट है। इस प्रकार, आप उपयुक्त फीड जनरेटर क्लास ( Atom1Feed या Rss201rev2Feed ) को उप-वर्ग कर सकते हैं और इन कॉलबैक का विस्तार कर सकते हैं। वो हैं:

SyndicationFeed.root_attributes(self)
रूट फ़ीड तत्व ( feed / channel ) में जोड़ने के लिए विशेषताओं का एक बड़ा विवरण लौटाएँ।
SyndicationFeed.add_root_elements(self, handler)
रूट फ़ीड तत्व ( feed / channel ) के अंदर तत्वों को जोड़ने के लिए कॉलबैक। handler पाइथन की अंतर्निहित SAX लाइब्रेरी से एक XMLGenerator है; प्रक्रिया में XML दस्तावेज़ में जोड़ने के लिए आप इस पर तरीकों को कॉल करेंगे।
SyndicationFeed.item_attributes(self, item)
प्रत्येक आइटम ( item / entry ) तत्व में जोड़ने के लिए विशेषताओं का एक बड़ा हिस्सा लौटाएं। तर्क, item , SyndicationFeed.add_item() को दिए गए सभी डेटा का एक शब्दकोश है।
SyndicationFeed.add_item_elements(self, handler, item)
प्रत्येक आइटम ( item / entry ) तत्व में तत्व जोड़ने के लिए कॉलबैक। handler और item ऊपर हैं।

चेतावनी

यदि आप इनमें से किसी भी विधि को ओवरराइड करते हैं, तो सुपरक्लास विधियों को कॉल करना सुनिश्चित करें क्योंकि वे प्रत्येक फ़ीड प्रारूप के लिए आवश्यक तत्व जोड़ते हैं।

उदाहरण के लिए, आप एक iTunes RSS फ़ीड जनरेटर को लागू करना शुरू कर सकते हैं जैसे:

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

जाहिर है कि पूर्ण कस्टम फ़ीड वर्ग के लिए और भी बहुत से काम किए जाने हैं, लेकिन ऊपर दिए गए उदाहरण में मूल विचार प्रदर्शित होना चाहिए।

Original text