iQdZddlmZmZmZmZddlddlmZddl Z ddl m Z ddl m Z ddl ZddlZddlmZdd lmZmZdd lmZGd d eZy) z podgen.episode ~~~~~~~~~~~~~~ :copyright: 2013, Lars Kiesow and 2016, Thorben Dahl :license: FreeBSD and LGPL, see license.* for more details. )absolute_importdivisionprint_functionunicode_literals)*) iteritemsN)etree)datetime)NotSupportedByItunesWarning) formatRFC2822listToHumanreadableStr) string_typesceZdZdZdZdZedZejdZedZ e jdZ edZ e jd Z ed Z e jd Z ed Z e jd Z edZ e jdZ edZejdZy)EpisodeaClass representing an episode in a podcast. Corresponds to an RSS Item. When creating a new Episode, you can populate any attribute using keyword arguments. Use the attribute's name on the left side of the equals sign and its value on the right side. Here's an example:: >>> # This... >>> ep = Episode() >>> ep.title = "Exploring the RTS genre" >>> ep.summary = "Tory and I talk about a genre of games we've " + \ ... "never dared try out before now..." >>> # ...is equal to this: >>> ep = Episode( ... title="Exploring the RTS genre", ... summary="Tory and I talk about a genre of games we've " ... "never dared try out before now..." ... ) :raises: TypeError if you try to set an attribute which doesn't exist, ValueError if you set an attribute to an invalid value. You must have filled in either :attr:`.title` or :attr:`.summary` before the RSS can be generated. To add an episode to a podcast:: >>> import podgen >>> p = podgen.Podcast() >>> episode = podgen.Episode() >>> p.episodes.append(episode) You may also replace the last two lines with a shortcut:: >>> episode = p.add_episode(podgen.Episode()) .. seealso:: :doc:`/usage_guide/episodes` A friendlier introduction to episodes. c `g|_d|_ d|_ d|_d|_ d|_ d|_d|_ d|_d|_ d|_ d|_ d|_ d|_ d|_ t|D]0\}}t!||rt#||| t%d|d|dy)NFzKeyword argument z (with value z) not recognized!)_Episode__authorssummary long_summary_Episode__mediaidlink_Episode__publication_datetitle_Episode__withhold_from_itunes_Episode__image_Episode__itunes_duration_Episode__explicitis_closed_captioned_Episode__positionsubtitlerhasattrsetattr TypeError)selfkwargs attributevalues G/root/podcast_feed/.venv/lib/python3.12/site-packages/podgen/episode.py__init__zEpisode.__init__Gs  (!   2  #'  ',# !%#(    !*& 1 IutY'i/1:E!CDD !2c d}d}tjd}|js|js t d|jr'tj |d}|j|_|jr'tj |d}|j|_|js |jr|jr|jrxtj |d}tj|j|_tj |dd z}tj|j|_nHtj |d}tj|jxs |j|_|jrW|jDcgc]}|js|j} }| r)tj |d |z} t| | _t|jd kDs|jd js|jxsgD]}tj |d |z} |jr.|jr"|jd|jd| _V|jr|j| _t|j| _n3tj |d} t|jd | _|j r |j } n1|j"r#|j |j"j$} nd} | r,tj |d} | | _d| j&d<|j"rtj |d}|j"j$|j&d<t|j"j(|j&d<|j"j*|j&d<|j"j,r4tj |d|z}|j"j.|_|j0r0tj |d}t3|j0|_|j4r tj |d|z}d|_|j6r2tj |d|z}|j6|j&d<|j8.tj |d|z}|j8rdnd |_|j:r tj |d!|z}d|_|j<B|j<d k\r3tj |d"|z}t|j<|_|j>r*tj |d#|z}|j>|_|Scc}w)$zCreate an RSS item using lxml's etree and return it. This is primarily used by :class:`podgen.Podcast` when generating the podcast's RSS feed. :returns: etree.Element('item') z*http://www.itunes.com/dtds/podcast-1.0.dtdz http://purl.org/dc/elements/1.1/itemzBRequired fields not set, make sure either title or summary is set!rr descriptionz {%s}encodedz(http://purl.org/rss/1.0/modules/content/z {%s}authorrz {%s}creatorz <>authorNguidfalse isPermaLink enclosureurllengthtypez {%s}durationpubDatez {%s}blockYesz {%s}imagehrefz {%s}explicitNoz{%s}isClosedCaptionedz {%s}orderz {%s}subtitle) r Elementrr ValueError SubElementtextrrCDATArnamer lenemailstrrrr5attribsizer7duration duration_strrr rrrrrr )r$ ITUNES_NS DUBLIN_NSentryrrr-contentaauthors_with_name itunes_authorr0rss_guidr1r4rGr8blockimageexplicitrorderr s r( rss_entryzEpisode.rss_entrysA 6  f% dll89 9 ::$$UG4EEJ 99##E62D DI <<4,,|| 1 1#..umD #(;;t||#<  **5-%O3PQ${{4+<+<= $..umD KK A0A0AB  >>15 JA166  J $$UL9,DE%;>"Q&dnnQ.?.E.E-2-A"--e]Y5NOFvv!''3466177&C &'ff &'gg .))%:!$.."34 77wwH \\dggo||''HH ##E62D DI)0DKK & <<(( ->)?I  X &'+||'8'8I  V $||$$ ++E>I3MN $ 9 9  " "&&ui8G()@)@AGL  & &$$UK),CDEEJ <<$$UK),CDE#'<>> # This results in an error >>> ep.authors = Person("John Doe", "johndoe@example.org") TypeError: Only iterable types can be assigned to authors, ... >>> # This is the correct way: >>> ep.authors = [Person("John Doe", "johndoe@example.org")] The initial value is an empty list, so you can use the list methods right away. Example:: >>> # This attribute is just a list - you can for example append: >>> ep.authors.append(Person("John Doe", "johndoe@example.org")) >>> # Or assign a new list (discarding earlier authors) >>> ep.authors = [Person("John Doe", "johndoe@example.org"), ... Person("Mary Sue", "marysue@example.org")] :type: :obj:`list` of :class:`podgen.Person` :RSS: author or dc:creator, and itunes:author )rr$s r(authorszEpisode.authors9sL~~r*c\ t||_y#t$rtd|zwxYw)Nz~Only iterable types can be assigned to authors, %s given. You must put your object in a list, even if there's only one author.)listrr#)r$rXs r(rXzEpisode.authorsasA J!']DN J?AHIJ J Js+c|jS)aThe time and date this episode was first published. The value can be a :obj:`str`, which will be parsed and made into a :class:`datetime.datetime` object when assigned. You may also assign a :class:`datetime.datetime` object directly. In both cases, you must ensure that the value includes timezone information. :type: :obj:`str` (will be converted to and stored as :class:`datetime.datetime`) or :class:`datetime.datetime`. :RSS: pubDate .. note:: Don't use the media file's modification date as the publication date, unless they're the same. It looks very odd when an episode suddenly pops up in the feed, but it claims to be several hours old! )rrWs r(publication_datezEpisode.publication_datejs&&&&r*c|it|trtjj |}t|t s t d|j t d||_yd|_y)NzInvalid datetime formatz$Datetime object has no timezone info) isinstancerdateutilparserparser r=tzinfor)r$r\s r(r\zEpisode.publication_datesh  '*L9#+??#8#89I#J .9 !:;;&&. !GHH&6D #&*D #r*c|jS)aGet or set the :class:`~podgen.Media` object that is attached to this episode. Note that if :py:attr:`.id` is not set, the media's URL is used as the id. If you rely on this, you should make sure the URL never changes, since changing the id messes up with clients (they will think this episode is new again, even if the user has listened to it already). Therefore, you should only rely on this behaviour if you own the domain which the episodes reside on. If you don't, then you must set :py:attr:`.id` to an appropriate value manually. :type: :class:`podgen.Media` :RSS: enclosure and itunes:duration )rrWs r(mediaz Episode.medias ||r*c|7t|dr t|drt|dr||_ytdd|_y)Nr5rFr7z@The parameter media must have the attributes url, size and type.)r!rr#)r$rds r(rdz Episode.mediasG  ue$)?uf%$ !677 DLr*c|jS)azPrevent this episode from appearing in the iTunes podcast directory. Note that the episode can still be found by inspecting the XML, so it is still public. One use case would be if you knew that this episode would get you kicked out from iTunes, should it make it there. In such cases, you can set withhold_from_itunes to ``True`` so this episode isn't published on iTunes, allowing you to publish it to everyone else while keeping your podcast on iTunes. This attribute defaults to ``False``, of course. :type: :obj:`bool` :RSS: itunes:block )rrWs r(withhold_from_ituneszEpisode.withhold_from_ituness"***r*cR||dus|dur||_ytd|zd|_y)NTFz1withhold_from_itunes expects bool or None, got %s)rr#)r$rgs r(rgzEpisode.withhold_from_itunessG  +#t+/Cu/L.B+!)+?!@AA+/D 'r*c|jS)uThe podcast episode's image, overriding the podcast's :attr:`~.Podcast.image`. This attribute specifies the absolute URL to the artwork for your podcast. iTunes prefers square images that are at least ``1400x1400`` pixels. iTunes supports images in JPEG and PNG formats with an RGB color space (CMYK is not supported). The URL must end in ".jpg" or ".png"; a :class:`.NotSupportedByItunesWarning` will be issued if it doesn't. :type: :obj:`str` :RSS: itunes:image .. note:: If you change an episode’s image, you should also change the file’s name; iTunes doesn't check the actual file to see if it's changed. Additionally, the server hosting your cover art image must allow HTTP HEAD requests. .. warning:: Almost no podcatchers support this. iTunes supports it only if you embed the cover in the media file (the same way you would embed an album cover), and recommends that you use Garageband's Enhanced Podcast feature. The podcast's image is used if this isn't supported. )rrWs r(rRz Episode.imagesB||r*c|ct|j}|jds1tjd|j ddzt d||_yd|_y)N)z.jpgz.jpegz.pngz/Image filename must end with png or jpg, not %s.) stacklevel)rDlowerendswithwarningswarnsplitr r)r$rRlowercase_images r(rRz Episode.imagesf  !%j..0O#,,-FG "[[-b123N!"$!DLDLr*c|jS)aqWhether this podcast episode contains material which may be inappropriate for children. The value of the podcast's explicit attribute is used by default, if this is kept as ``None``. If you set this to ``True``, an "explicit" parental advisory graphic will appear in the Name column in iTunes. If the value is ``False``, the parental advisory type is considered Clean, meaning that no explicit language or adult content is included anywhere in this episode, and a "clean" graphic will appear. :type: :obj:`bool` :RSS: itunes:explicit )rrWs r(rSzEpisode.explicits"r*cJ||dvrtd|z||_yd|_y)N)TFz#Invalid value "%s" for explicit tag)r=r)r$rSs r(rSzEpisode.explicit s6  }, !F#+",--&DO"DOr*c|jS)aA custom position for this episode on the iTunes store page. If you would like this episode to appear first, set it to ``1``. If you want it second, set it to ``2``, and so on. If multiple episodes share the same position, they will be sorted by their :attr:`publication date <.Episode.publication_date>`. To remove the order from the episode, set the position back to :obj:`None`. :type: :obj:`int` :RSS: itunes:order )rrWs r(positionzEpisode.positionsr*c8|t||_yd|_y)N)intr)r$rxs r(rxzEpisode.position(s  !(mDO"DOr*N)__name__ __module__ __qualname____doc__r)rUpropertyrXsetterr\rdrgrRrSrxr*r(rrsS(TzDxtl%%N ^^JJ''( + +" \\    ++$  /!/  D \\    $__## __##r*r)r~ __future__rrrrbuiltins future.utilsrrqlxmlr r dateutil.parserr_ dateutil.tzpodgen.warningsr podgen.utilr r podgen.compatrobjectrrr*r(rs?SR"7=&Q#fQ#r*