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 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
|
.. _reference.entry.source:
:py:attr:`entries[i].source`
============================
A dictionary with details about the source of the entry.
.. rubric:: Comes from
* /atom10:feed/atom10:entry/atom10:source
:py:attr:`entries[i].source.author`
-----------------------------------
The author of the source of this entry.
:py:attr:`entries[i].source.author_detail`
------------------------------------------
A dictionary containing details about the author of the source of this entry.
:py:attr:`entries[i].source.author_detail.name`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The name of the author of the source of this entry.
.. _reference.entry.source.author_detail.href:
:py:attr:`entries[i].source.author_detail.href`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The :abbr:`URL (Uniform Resource Locator)` of the author of the source of this
entry. This can be the author's home page, or a contact page with a webmail
form.
If this is a relative :abbr:`URI (Uniform Resource Identifier)`, it is
:ref:`resolved according to a set of rules <advanced.base>`.
:py:attr:`entries[i].source.author_detail.email`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The email address of the author of the source of this entry.
:py:attr:`entries[i].source.contributors`
-----------------------------------------
A list of contributors to the source of this entry.
:py:attr:`entries[i].source.contributors[j].name`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The name of a contributor to the source of this entry.
.. _reference.entry.source.contributors.href:
:py:attr:`entries[i].source.contributors[j].href`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The :abbr:`URL (Uniform Resource Locator)` of a contributor to the source of
this entry. This can be the contributor's home page, or a contact page with a
webmail form.
If this is a relative :abbr:`URI (Uniform Resource Identifier)`, it is
:ref:`resolved according to a set of rules <advanced.base>`.
:py:attr:`entries[i].source.contributors[j].email`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The email address of a contributor to the source of this entry.
:py:attr:`entries[i].source.icon`
---------------------------------
The :abbr:`URL (Uniform Resource Locator)` of an icon representing the source
of this entry.
If this is a relative :abbr:`URI (Uniform Resource Identifier)`, it is
:ref:`resolved according to a set of rules <advanced.base>`.
:py:attr:`entries[i].source.id`
-------------------------------
A globally unique identifier for the source of this entry.
:py:attr:`entries[i].source.link`
---------------------------------
The primary permanent link of the source of this entry
:py:attr:`entries[i].source.links`
----------------------------------
A list of all links defined by the source of this entry.
:py:attr:`entries[i].source.links[j].rel`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The relationship of a link defined by the source of this entry.
Atom 1.0 defines five standard link relationships and describes the process for
registering others. Here are the five standard rel values:
* ``alternate``
* ``self``
* ``related``
* ``via``
* ``enclosure``
:py:attr:`entries[i].source.links[j].type`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The content type of the page pointed to by a link defined by the source of this
entry.
.. _reference.entry.source.links.href:
:py:attr:`entries[i].source.links[j].href`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The :abbr:`URL (Uniform Resource Locator)` of the page pointed to by a link
defined by the source of this entry.
If this is a relative :abbr:`URI (Uniform Resource Identifier)`, it is
:ref:`resolved according to a set of rules <advanced.base>`.
:py:attr:`entries[i].source.links[j].title`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The title of a link defined by the source of this entry.
:py:attr:`entries[i].source.logo`
---------------------------------
The :abbr:`URL (Uniform Resource Locator)` of a logo representing the source of
this entry.
If this is a relative :abbr:`URI (Uniform Resource Identifier)`, it is
:ref:`resolved according to a set of rules <advanced.base>`.
.. _reference.entry.source.rights:
:py:attr:`entries[i].source.rights`
-----------------------------------
A human-readable copyright statement for the source of this entry.
:py:attr:`entries[i].source.rights_detail`
------------------------------------------
A dictionary containing details about the copyright statement for the source of
this entry.
:py:attr:`entries[i].source.rights_detail.value`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Same as :ref:`reference.entry.source.rights`.
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>`.
:py:attr:`entries[i].source.rights_detail.type`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The content type of the copyright statement for the source of this entry.
Most likely values for :py:attr:`~entries[i].source.rights_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:`entries[i].source.rights_detail.language`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The language of the copyright statement for the source of this entry.
:py:attr:`~entries[i].source.rights_detail.language` is supposed to be a
language code, as specified by `RFC 3066`_, 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.
.. _RFC 3066: http://www.ietf.org/rfc/rfc3066.txt
:py:attr:`~entries[i].source.rights_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:`~entries[i].source.rights_detail.language` will be ``None``, the
:program:`Python` null value.
:py:attr:`entries[i].source.rights_detail.base`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The original base :abbr:`URI (Uniform Resource Identifier)` for links within
the copyright statement for the source of this entry.
:py:attr:`entries[i].source.rights_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.*
.. _reference.entry.source.subtitle:
:py:attr:`entries[i].source.subtitle`
-------------------------------------
A subtitle, tagline, slogan, or other short description of the source of this
entry.
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>`.
:py:attr:`entries[i].source.subtitle_detail`
--------------------------------------------
A dictionary containing details about the subtitle for the source of this
entry.
:py:attr:`entries[i].source.subtitle_detail.value`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Same as :ref:`reference.entry.source.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>`.
:py:attr:`entries[i].source.subtitle_detail.type`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The content type of the subtitle of the source of this entry.
Most likely values for :py:attr:`~entries[i].source.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:`entries[i].source.subtitle_detail.language`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The language of the subtitle of the source of this entry.
:py:attr:`~entries[i].source.subtitle_detail.language` is supposed to be a
language code, as specified by `RFC 3066`_, 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:`~entries[i].source.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:`~entries[i].source.subtitle_detail.language` will be ``None``, the
:program:`Python` null value.
:py:attr:`entries[i].source.subtitle_detail.base`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The original base :abbr:`URI (Uniform Resource Identifier)` for links within
the subtitle of the source of this entry.
:py:attr:`entries[i].source.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.*
.. _reference.entry.source.title:
:py:attr:`entries[i].source.title`
----------------------------------
The title of the source of this entry.
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>`.
:py:attr:`entries[i].source.title_detail`
-----------------------------------------
A dictionary containing details about the title for the source of this entry.
:py:attr:`entries[i].source.title_detail.value`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Same as :ref:`reference.entry.source.title`.
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>`.
:py:attr:`entries[i].source.title_detail.type`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The content type of the title of the source of this entry.
Most likely values for :py:attr:`entries[i].source.title_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:`entries[i].source.title_detail.language`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The language of the title of the source of this entry.
:py:attr:`~entries[i].source.title_detail.language` is supposed to be a
language code, as specified by `RFC 3066`_, 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:`~entries[i].source.title_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:`~entries[i].source.title_detail.language` will be ``None``, the
:program:`Python` null value.
:py:attr:`entries[i].source.title_detail.base`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The original base :abbr:`URI (Uniform Resource Identifier)` for links within
the title of the source of this entry.
:py:attr:`entries[i].source.title_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.*
:py:attr:`entries[i].source.updated`
------------------------------------
The date the source of this entry was last updated, as a string in the same
format as it was published in the original feed.
This element is :ref:`parsed as a date <advanced.date>` and stored in
:ref:`reference.entry.source.updated_parsed`.
.. _reference.entry.source.updated_parsed:
:py:attr:`entries[i].source.updated_parsed`
-------------------------------------------
The date this entry was last updated, as a standard :program:`Python` 9-tuple.
|