1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
.. _reference.feed.subtitle_detail:
:py:attr:`feed.subtitle_detail`
===============================
A dictionary with details about the feed subtitle.
.. rubric:: Comes from
* /atom03:feed/atom03:tagline
* /atom10:feed/atom10:subtitle
* /rdf:RDF/rdf:channel/dc:description
* /rdf:RDF/rdf:channel/rdf:description
* /rss/channel/dc:description
* /rss/channel/description
* /rss/channel/itunes:subtitle
.. seealso::
* :ref:`reference.feed.subtitle`
.. _reference.feed.subtitle_detail.value:
:py:attr:`feed.subtitle_detail.value`
-------------------------------------
Same as :ref:`reference.feed.subtitle`.
If this contains :abbr:`HTML (HyperText Markup Language)` or :abbr:`XHTML
(Extensible HyperText Markup Language)`, it is :ref:`sanitized
<advanced.sanitization>` by default.
If this contains :abbr:`HTML (HyperText Markup Language)` or :abbr:`XHTML
(Extensible HyperText Markup Language)`, certain (X)HTML elements within this
value may contain relative :abbr:`URI (Uniform Resource Identifier)`\s. If so,
they are :ref:`resolved according to a set of rules <advanced.base>`.
.. _reference.feed.subtitle_detail.type:
:py:attr:`feed.subtitle_detail.type`
------------------------------------
The content type of the feed subtitle.
Most likely values for :py:attr:`~feed.subtitle_detail.type`:
* :mimetype:`text/plain`
* :mimetype:`text/html`
* :mimetype:`application/xhtml+xml`
For Atom feeds, the content type is taken from the type attribute, which
defaults to :mimetype:`text/plain` if not specified. For :abbr:`RSS (Rich Site
Summary)` feeds, the content type is auto-determined by inspecting the content,
and defaults to :mimetype:`text/html`. Note that this may cause silent data
loss if the value contains plain text with angle brackets. There is nothing I
can do about this problem; it is a limitation of :abbr:`RSS (Rich Site
Summary)`.
Future enhancement: some versions of :abbr:`RSS (Rich Site Summary)` clearly
specify that certain values default to :mimetype:`text/plain`, and
:program:`Universal Feed Parser` should respect this, but it doesn't yet.
:py:attr:`feed.subtitle_detail.language`
----------------------------------------
The language of the feed subtitle.
:py:attr:`~feed.subtitle_detail.language` is supposed to be a language code, as
specified by `:abbr:`RFC (Request For Comments)` 3066
<http://www.ietf.org/rfc/rfc3066.txt>`_, but publishers have been known to
publish random values like "English" or "German". :program:`Universal Feed
Parser` does not do any parsing or normalization of language codes.
:py:attr:`~feed.subtitle_detail.language` may come from the element's xml:lang
attribute, or it may inherit from a parent element's xml:lang, or the
Content-Language :abbr:`HTTP (Hypertext Transfer Protocol)` header. If the
feed does not specify a language, :py:attr:`~feed.subtitle_detail.language`
will be ``None``, the :program:`Python` null value.
:py:attr:`feed.subtitle_detail.base`
------------------------------------
The original base :abbr:`URI (Uniform Resource Identifier)` for links within
the feed subtitle.
:py:attr:`~feed.subtitle_detail.base` is only useful in rare situations and can
usually be ignored. It is the original base :abbr:`URI (Uniform Resource
Identifier)` for this value, as specified by the element's xml:base attribute,
or a parent element's xml:base, or the appropriate :abbr:`HTTP (Hypertext
Transfer Protocol)` header, or the :abbr:`URI (Uniform Resource Identifier)` of
the feed. (See :ref:`advanced.base` for more details.) By the time you see
it, :program:`Universal Feed Parser` has already resolved relative links in all
values where it makes sense to do so. *Clients should never need to manually
resolve relative links.*
|
