U g@sdZddlmZmZmZmZmZddlmZddl m Z ddl m Z ddl mZddlmZddlmZdd lmZdd lmZdd lmZdd lmZdd lmZddlmZddlm Z ddl!m"Z"m#Z#m$Z$ddl%m&Z&ee e eeefZ'GdddeZ(GdddeZ)Gddde)Z*Gddde)Z+Gddde(Z,Gddde(Z-Gddde(Z.Gd d!d!e(Z/Gd"d#d#e(Z0d$S)%z+Base class for Telegram InputMedia Objects.)FinalOptionalSequenceTupleUnion) constants) Animation)Audio)Document) InputFile) PhotoSize)Video) MessageEntity)TelegramObject)enum)parse_sequence_arg) DEFAULT_NONEparse_file_input) FileInputJSONDictODVInput)InputMediaTypec seZdZdZdZddefddeeeee fe ee e e e ee edfddZee ee eeefdd d ZZS) InputMediaaX Base class for Telegram InputMedia Objects. .. versionchanged:: 20.0 Added arguments and attributes :attr:`type`, :attr:`media`, :attr:`caption`, :attr:`caption_entities`, :paramref:`parse_mode`. .. seealso:: :wiki:`Working with Files and Media ` Args: media_type (:obj:`str`): Type of media that the instance represents. media (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | :class:`pathlib.Path` | :class:`telegram.Animation` | :class:`telegram.Audio` | :class:`telegram.Document` | :class:`telegram.PhotoSize` | :class:`telegram.Video`): File to send. |fileinputnopath| Lastly you can pass an existing telegram media object of the corresponding type to send. caption (:obj:`str`, optional): Caption of the media to be sent, 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. caption_entities (Sequence[:class:`telegram.MessageEntity`], optional): |caption_entities| .. versionchanged:: 20.0 |sequenceclassargs| parse_mode (:obj:`str`, optional): |parse_mode| Attributes: type (:obj:`str`): Type of the input media. media (:obj:`str` | :class:`telegram.InputFile`): Media to send. caption (:obj:`str`): Optional. Caption of the media to be sent, 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 * |tupleclassattrs| * |alwaystuple| )captioncaption_entitiesmedia parse_modetypeN api_kwargs) media_typerrrrr csHtj|dttj|||_||_||_t ||_ ||_ | dSNr) super__init__r get_memberrrrrrrrr_freeze)selfr!rrrrr  __class__>/tmp/pip-unpacked-wheel-swnnwir2/telegram/_files/inputmedia.pyr$Xs  zInputMedia.__init__) thumbnailreturncCs|dk rt|dddS|S)NTattach local_moder)r,r*r*r+_parse_thumbnail_inputksz!InputMedia._parse_thumbnail_input)__name__ __module__ __qualname____doc__ __slots__rstrrr MediaTyperrrrrr$ staticmethodrr1 __classcell__r*r*r(r+r)s",  rcsneZdZUdZejjZeee d<ejj Z eee d<dZ ddee ee eefeedfdd ZZS) InputPaidMediaaR Base class for Telegram InputPaidMedia Objects. Currently, it can be one of: * :class:`telegram.InputMediaPhoto` * :class:`telegram.InputMediaVideo` .. seealso:: :wiki:`Working with Files and Media ` .. versionadded:: 21.4 Args: type (:obj:`str`): Type of media that the instance represents. media (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | :class:`pathlib.Path` | :class:`telegram.PhotoSize` | :class:`telegram.Video`): File to send. |fileinputnopath| Lastly you can pass an existing telegram media object of the corresponding type to send. Attributes: type (:obj:`str`): Type of the input media. media (:obj:`str` | :class:`telegram.InputFile`): Media to send. PHOTOVIDEO)rrNrrrr cs2tj|dttj|||_||_|dSr") r#r$rr%rInputPaidMediaTyperrr&)r'rrr r(r*r+r$szInputPaidMedia.__init__)r2r3r4r5rr?r<rr7__annotations__r=r6rr r r rrr$r:r*r*r(r+r;vs r;cs>eZdZdZdZddeeefee dfddZ Z S)InputPaidMediaPhotoaThe paid media to send is a photo. .. seealso:: :wiki:`Working with Files and Media ` .. versionadded:: 21.4 Args: media (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | :class:`pathlib.Path` | :class:`telegram.PhotoSize`): File to send. |fileinputnopath| Lastly you can pass an existing :class:`telegram.PhotoSize` object to send. Attributes: type (:obj:`str`): Type of the media, always :tg-const:`telegram.constants.InputPaidMediaType.PHOTO`. media (:obj:`str` | :class:`telegram.InputFile`): Photo to send. r*Nr)rr cs0t|tddd}tjtj||d|dSNTr.r>)rr r#r$r;r<r&)r'rr r(r*r+r$szInputPaidMediaPhoto.__init__) r2r3r4r5r6rrr rrr$r:r*r*r(r+rAs rAc s^eZdZdZdZdddeeefeeee ee ee ee ee dfddZ Z S) InputPaidMediaVideoa The paid media to send is a video. .. seealso:: :wiki:`Working with Files and Media ` .. versionadded:: 21.4 Note: * When using a :class:`telegram.Video` for the :attr:`media` attribute, it will take the width, height and duration from that video, unless otherwise specified with the optional arguments. * :paramref:`thumbnail` will be ignored for small video files, for which Telegram can easily generate thumbnails. However, this behaviour is undocumented and might be changed by Telegram. Args: media (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | :class:`pathlib.Path` | :class:`telegram.Video`): File to send. |fileinputnopath| Lastly you can pass an existing :class:`telegram.Video` object to send. thumbnail (:term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | :obj:`str`, optional): |thumbdocstringnopath| width (:obj:`int`, optional): Video width. height (:obj:`int`, optional): Video height. duration (:obj:`int`, optional): Video duration in seconds. supports_streaming (:obj:`bool`, optional): Pass :obj:`True`, if the uploaded video is suitable for streaming. Attributes: type (:obj:`str`): Type of the media, always :tg-const:`telegram.constants.InputPaidMediaType.VIDEO`. media (:obj:`str` | :class:`telegram.InputFile`): Video to send. thumbnail (:class:`telegram.InputFile`): Optional. |thumbdocstringbase| width (:obj:`int`): Optional. Video width. height (:obj:`int`): Optional. Video height. duration (:obj:`int`): Optional. Video duration in seconds. supports_streaming (:obj:`bool`): Optional. :obj:`True`, if the uploaded video is suitable for streaming. )durationheightsupports_streamingr,widthNr)rr,rGrErDrFr c st|trH|dk r|n|j}|dk r(|n|j}|dk r:|n|j}|j}nt|ddd}tjt j ||d| *t ||_||_||_||_||_W5QRXdSrB) isinstancer rGrErDfile_idrr#r$r;r= _unfrozenrr1r,rF)r'rr,rGrErDrFr r(r*r+r$s  zInputPaidMediaVideo.__init__)NNNNN)r2r3r4r5r6rrr rintboolrr$r:r*r*r(r+rCs$'  rCcseZdZdZdZdeddddddddf ddeeefe e e e e e e e e e e e ee e e ee ee ee ed fddZZS)InputMediaAnimationa` Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent. Note: When using a :class:`telegram.Animation` for the :attr:`media` attribute, it will take the width, height and duration from that animation, unless otherwise specified with the optional arguments. .. seealso:: :wiki:`Working with Files and Media ` .. versionchanged:: 20.5 |removed_thumb_note| Args: media (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | :class:`pathlib.Path` | :class:`telegram.Animation`): File to send. |fileinputnopath| Lastly you can pass an existing :class:`telegram.Animation` object to send. .. versionchanged:: 13.2 Accept :obj:`bytes` as input. filename (:obj:`str`, optional): Custom file name for the animation, when uploading a new file. Convenience parameter, useful e.g. when sending files generated by the :obj:`tempfile` module. .. versionadded:: 13.1 caption (:obj:`str`, optional): Caption of the animation to be sent, 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`, optional): |parse_mode| caption_entities (Sequence[:class:`telegram.MessageEntity`], optional): |caption_entities| .. versionchanged:: 20.0 |sequenceclassargs| width (:obj:`int`, optional): Animation width. height (:obj:`int`, optional): Animation height. duration (:obj:`int`, optional): Animation duration in seconds. has_spoiler (:obj:`bool`, optional): Pass :obj:`True`, if the animation needs to be covered with a spoiler animation. .. versionadded:: 20.0 thumbnail (:term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | :obj:`str`, optional): |thumbdocstringnopath| .. versionadded:: 20.2 show_caption_above_media (:obj:`bool`, optional): Pass |show_cap_above_med| .. versionadded:: 21.3 Attributes: type (:obj:`str`): :tg-const:`telegram.constants.InputMediaType.ANIMATION`. media (:obj:`str` | :class:`telegram.InputFile`): Animation to send. caption (:obj:`str`): Optional. Caption of the animation to be sent, 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. The parse mode to use for text formatting. caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 * |tupleclassattrs| * |alwaystuple| width (:obj:`int`): Optional. Animation width. height (:obj:`int`): Optional. Animation height. duration (:obj:`int`): Optional. Animation duration in seconds. has_spoiler (:obj:`bool`): Optional. :obj:`True`, if the animation is covered with a spoiler animation. .. versionadded:: 20.0 thumbnail (:class:`telegram.InputFile`): Optional. |thumbdocstringbase| .. versionadded:: 20.2 show_caption_above_media (:obj:`bool`): Optional. |show_cap_above_med| .. versionadded:: 21.3 )rD has_spoilerrEshow_caption_above_mediar,rGNr) rrrrGrErDrfilenamerNr,rOr c  st|trH|dkr|jn|}|dkr*|jn|}|dkr<|jn|}|j}nt||ddd}tjt j ||||| d| 0| | |_ ||_||_||_| |_| |_W5QRXdSNT)rPr/r0r)rHrrGrErDrIrr#r$rZ ANIMATIONrJr1r,rNrO) r'rrrrGrErDrrPrNr,rOr r(r*r+r$bs.  zInputMediaAnimation.__init__)r2r3r4r5r6rrrrrr7rrKrrrLrr$r:r*r*r(r+rM s8L   rMc steZdZdZdZdeddddfddeeefe e e e e e e e e e ee ee edfddZZS)InputMediaPhotoa9 Represents a photo to be sent. .. seealso:: :wiki:`Working with Files and Media ` Args: media (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | :class:`pathlib.Path` | :class:`telegram.PhotoSize`): File to send. |fileinputnopath| Lastly you can pass an existing :class:`telegram.PhotoSize` object to send. .. versionchanged:: 13.2 Accept :obj:`bytes` as input. filename (:obj:`str`, optional): Custom file name for the photo, when uploading a new file. Convenience parameter, useful e.g. when sending files generated by the :obj:`tempfile` module. .. versionadded:: 13.1 caption (:obj:`str`, optional ): Caption of the photo to be sent, 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`, optional): |parse_mode| caption_entities (Sequence[:class:`telegram.MessageEntity`], optional): |caption_entities| .. versionchanged:: 20.0 |sequenceclassargs| has_spoiler (:obj:`bool`, optional): Pass :obj:`True`, if the photo needs to be covered with a spoiler animation. .. versionadded:: 20.0 show_caption_above_media (:obj:`bool`, optional): Pass |show_cap_above_med| .. versionadded:: 21.3 Attributes: type (:obj:`str`): :tg-const:`telegram.constants.InputMediaType.PHOTO`. media (:obj:`str` | :class:`telegram.InputFile`): Photo to send. caption (:obj:`str`): Optional. Caption of the photo to be sent, 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 * |tupleclassattrs| * |alwaystuple| has_spoiler (:obj:`bool`): Optional. :obj:`True`, if the photo is covered with a spoiler animation. .. versionadded:: 20.0 show_caption_above_media (:obj:`bool`): Optional. |show_cap_above_med| .. versionadded:: 21.3 )rNrONr)rrrrrPrNrOr c sPt|t|ddd}tjtj|||||d|||_||_W5QRXdSrQ) rr r#r$rr<rJrNrO) r'rrrrrPrNrOr r(r*r+r$s zInputMediaPhoto.__init__)r2r3r4r5r6rrrr rr7rrrrLrr$r:r*r*r(r+rRs(6   rRcseZdZdZdZdddddedddddf ddeeefe e e e e e e e e e e e e eee e e e e ee e e ed fddZZS)InputMediaVideoaRepresents a video to be sent. .. seealso:: :wiki:`Working with Files and Media ` Note: * When using a :class:`telegram.Video` for the :attr:`media` attribute, it will take the width, height and duration from that video, unless otherwise specified with the optional arguments. * :paramref:`thumbnail` will be ignored for small video files, for which Telegram can easily generate thumbnails. However, this behaviour is undocumented and might be changed by Telegram. .. versionchanged:: 20.5 |removed_thumb_note| Args: media (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | :class:`pathlib.Path` | :class:`telegram.Video`): File to send. |fileinputnopath| Lastly you can pass an existing :class:`telegram.Video` object to send. .. versionchanged:: 13.2 Accept :obj:`bytes` as input. filename (:obj:`str`, optional): Custom file name for the video, when uploading a new file. Convenience parameter, useful e.g. when sending files generated by the :obj:`tempfile` module. .. versionadded:: 13.1 caption (:obj:`str`, optional): Caption of the video to be sent, 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`, optional): |parse_mode| caption_entities (Sequence[:class:`telegram.MessageEntity`], optional): |caption_entities| .. versionchanged:: 20.0 |sequenceclassargs| width (:obj:`int`, optional): Video width. height (:obj:`int`, optional): Video height. duration (:obj:`int`, optional): Video duration in seconds. supports_streaming (:obj:`bool`, optional): Pass :obj:`True`, if the uploaded video is suitable for streaming. has_spoiler (:obj:`bool`, optional): Pass :obj:`True`, if the video needs to be covered with a spoiler animation. .. versionadded:: 20.0 thumbnail (:term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | :obj:`str`, optional): |thumbdocstringnopath| .. versionadded:: 20.2 show_caption_above_media (:obj:`bool`, optional): Pass |show_cap_above_med| .. versionadded:: 21.3 Attributes: type (:obj:`str`): :tg-const:`telegram.constants.InputMediaType.VIDEO`. media (:obj:`str` | :class:`telegram.InputFile`): Video file to send. caption (:obj:`str`): Optional. Caption of the video to be sent, 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 * |tupleclassattrs| * |alwaystuple| width (:obj:`int`): Optional. Video width. height (:obj:`int`): Optional. Video height. duration (:obj:`int`): Optional. Video duration in seconds. supports_streaming (:obj:`bool`): Optional. :obj:`True`, if the uploaded video is suitable for streaming. has_spoiler (:obj:`bool`): Optional. :obj:`True`, if the video is covered with a spoiler animation. .. versionadded:: 20.0 thumbnail (:class:`telegram.InputFile`): Optional. |thumbdocstringbase| .. versionadded:: 20.2 show_caption_above_media (:obj:`bool`): Optional. |show_cap_above_med| .. versionadded:: 21.3 )rDrNrErOrFr,rGNr) rrrGrErDrFrrrPrNr,rOr c  st|trH|dk r|n|j}|dk r(|n|j}|dk r:|n|j}|j}nt|| ddd}tjt j ||||| d| 6||_||_||_| | |_ ||_| |_| |_W5QRXdSrQ)rHr rGrErDrIrr#r$rr=rJr1r,rFrNrO)r'rrrGrErDrFrrrPrNr,rOr r(r*r+r$Fs0  zInputMediaVideo.__init__)r2r3r4r5r6rrrr rr7rKrLrrrrr$r:r*r*r(r+rSs<S   rSc seZdZdZdZdeddddddfddeeefe e e e e e e e e e e e ee e e ee ed fddZZS)InputMediaAudioa Represents an audio file to be treated as music to be sent. .. seealso:: :wiki:`Working with Files and Media ` Note: When using a :class:`telegram.Audio` for the :attr:`media` attribute, it will take the duration, performer and title from that video, unless otherwise specified with the optional arguments. .. versionchanged:: 20.5 |removed_thumb_note| Args: media (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | :class:`pathlib.Path` | :class:`telegram.Audio`): File to send. |fileinputnopath| Lastly you can pass an existing :class:`telegram.Audio` object to send. .. versionchanged:: 13.2 Accept :obj:`bytes` as input. filename (:obj:`str`, optional): Custom file name for the audio, when uploading a new file. Convenience parameter, useful e.g. when sending files generated by the :obj:`tempfile` module. .. versionadded:: 13.1 caption (:obj:`str`, optional): Caption of the audio to be sent, 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`, optional): |parse_mode| caption_entities (Sequence[:class:`telegram.MessageEntity`], optional): |caption_entities| .. versionchanged:: 20.0 |sequenceclassargs| duration (:obj:`int`, optional): Duration of the audio in seconds as defined by the sender. performer (:obj:`str`, optional): Performer of the audio as defined by the sender or by audio tags. title (:obj:`str`, optional): Title of the audio as defined by the sender or by audio tags. thumbnail (:term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | :obj:`str`, optional): |thumbdocstringnopath| .. versionadded:: 20.2 Attributes: type (:obj:`str`): :tg-const:`telegram.constants.InputMediaType.AUDIO`. media (:obj:`str` | :class:`telegram.InputFile`): Audio file to send. caption (:obj:`str`): Optional. Caption of the audio to be sent, 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 * |tupleclassattrs| * |alwaystuple| duration (:obj:`int`): Optional. Duration of the audio in seconds. performer (:obj:`str`): Optional. Performer of the audio as defined by the sender or by audio tags. title (:obj:`str`): Optional. Title of the audio as defined by the sender or by audio tags. thumbnail (:class:`telegram.InputFile`): Optional. |thumbdocstringbase| .. versionadded:: 20.2 )rD performerr,titleNr) rrrrDrUrVrrPr,r c  st|trH|dkr|jn|}|dkr*|jn|}|dkr<|jn|}|j}nt||ddd}tjt j ||||| d| $| | |_ ||_||_||_W5QRXdSrQ)rHr rDrUrVrIrr#r$rZAUDIOrJr1r,) r'rrrrDrUrVrrPr,r r(r*r+r$s*  zInputMediaAudio.__init__)r2r3r4r5r6rrrr rr7rrKrrrr$r:r*r*r(r+rTus0A   rTc steZdZdZdZdeddddfddeeefe e e e e e e e ee e e ee edfddZZS)InputMediaDocumentaq Represents a general file to be sent. .. seealso:: :wiki:`Working with Files and Media ` .. versionchanged:: 20.5 |removed_thumb_note| Args: media (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | :class:`pathlib.Path` | :class:`telegram.Document`): File to send. |fileinputnopath| Lastly you can pass an existing :class:`telegram.Document` object to send. .. versionchanged:: 13.2 Accept :obj:`bytes` as input. filename (:obj:`str`, optional): Custom file name for the document, when uploading a new file. Convenience parameter, useful e.g. when sending files generated by the :obj:`tempfile` module. .. versionadded:: 13.1 caption (:obj:`str`, optional): Caption of the document to be sent, 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`, optional): |parse_mode| caption_entities (Sequence[:class:`telegram.MessageEntity`], optional): |caption_entities| .. versionchanged:: 20.0 |sequenceclassargs| disable_content_type_detection (:obj:`bool`, optional): Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always :obj:`True`, if the document is sent as part of an album. thumbnail (:term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | :obj:`str`, optional): |thumbdocstringnopath| .. versionadded:: 20.2 Attributes: type (:obj:`str`): :tg-const:`telegram.constants.InputMediaType.DOCUMENT`. media (:obj:`str` | :class:`telegram.InputFile`): File to send. caption (:obj:`str`): Optional. Caption of the document to be sent, 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 * |tupleclassattrs| * |alwaystuple| disable_content_type_detection (:obj:`bool`): Optional. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always :obj:`True`, if the document is sent as part of an album. thumbnail (:class:`telegram.InputFile`): Optional. |thumbdocstringbase| .. versionadded:: 20.2 )disable_content_type_detectionr,Nr)rrrrXrrPr,r c sVt|t|ddd}tjtj|||||d||||_||_ W5QRXdSrQ) rr r#r$rZDOCUMENTrJr1r,rX) r'rrrrXrrPr,r r(r*r+r$s zInputMediaDocument.__init__)r2r3r4r5r6rrrr rr7rrLrrrr$r:r*r*r(r+rWs(9   rWN)1r5typingrrrrrZtelegramrZtelegram._files.animationrZtelegram._files.audior Ztelegram._files.documentr Ztelegram._files.inputfiler Ztelegram._files.photosizer Ztelegram._files.videor Ztelegram._messageentityrZtelegram._telegramobjectrZtelegram._utilsrZtelegram._utils.argumentparsingrZtelegram._utils.defaultvaluerZtelegram._utils.filesrZtelegram._utils.typesrrrZtelegram.constantsrr8rr;rArCrMrRrSrTrWr*r*r*r+s8              M-JYm