o "h=@sdZddlZddlmZddlmZddlmZddl m Z m Z m Z ddl mZddlmZddlmZdd lmZdd lmZmZmZe rLdd lmZGd d d eZdS)z?This module contains an object that represents a Telegram File.N) b64decode)Path) TYPE_CHECKINGBinaryIOOptional)decrypt)TelegramObject) DEFAULT_NONE) is_local_file) FilePathInputJSONDictODVInput)FileCredentialscsFeZdZdZdZ  d#dddededeedeed eef fd d Z d efd dZ de d e fddZ d$e e e e ddeedeedeedeedeed ef ddZe e e e ddedeedeedeedeed df ddZ d$e e e e ddeedeedeedeedeed ef ddZd%d!d"ZZS)&Filea This object represents a file ready to be downloaded. The file can be e.g. downloaded with :attr:`download_to_drive`. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling :meth:`telegram.Bot.get_file`. Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their :attr:`file_unique_id` is equal. .. versionchanged:: 20.0 ``download`` was split into :meth:`download_to_drive` and :meth:`download_to_memory`. Note: * Maximum file size to download is :tg-const:`telegram.constants.FileSizeLimit.FILESIZE_DOWNLOAD`. * If you obtain an instance of this class from :attr:`telegram.PassportFile.get_file`, then it will automatically be decrypted as it downloads when you call e.g. :meth:`download_to_drive`. Args: file_id (:obj:`str`): Identifier for this file, which can be used to download or reuse the file. file_unique_id (:obj:`str`): Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. file_size (:obj:`int`, optional): File size in bytes, if known. file_path (:obj:`str`, optional): File path. Use e.g. :meth:`download_to_drive` to get the file. Attributes: file_id (:obj:`str`): Identifier for this file, which can be used to download or reuse the file. file_unique_id (:obj:`str`): Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. file_size (:obj:`int`): Optional. File size in bytes, if known. file_path (:obj:`str`): Optional. File path. Use e.g. :meth:`download_to_drive` to get the file. ) _credentialsfile_id file_path file_sizefile_unique_idN api_kwargsrrrrrcsJtj|dt||_t||_||_||_d|_|jf|_| dS)Nr) super__init__strrrrrr _id_attrs_freeze)selfrrrrr __class__G/var/www/html/venv/lib/python3.10/site-packages/telegram/_files/file.pyrTs    z File.__init__returnc Cs8tt|j}tt|j|jt|j |j |j S)zPConvert any UTF-8 char in :obj:`File.file_path` into a url encoded ASCII string.) urllib_parseurlsplitrr urlunsplit SplitResultschemenetlocquotepathqueryfragment)rsresrrr _get_encoded_urlls zFile._get_encoded_urlbufcCstt|jjt|jj|SN)rrrsecrethash)rr.rrr _prepare_decryptuszFile._prepare_decrypt read_timeout write_timeoutconnect_timeout pool_timeout custom_pathr4r5r6r7c s|jstdt|j}|rdn|}|rB|jrBt|j}||} |dur/t|} n tt|j d|j } | | | S|durU|rUt |jt|t|S|r\t|} n|rct|jStt|jj } |jj|||||dIdH} |jr|| } | | | S)a Download this file. By default, the file is saved in the current working directory with :attr:`file_path` as file name. If :paramref:`custom_path` is supplied as a :obj:`str` or :obj:`pathlib.Path`, it will be saved to that path. Note: If :paramref:`custom_path` isn't provided and :attr:`file_path` is the path of a local file (which is the case when a Bot API Server is running in local mode), this method will just return the path. The only exception to this are encrypted files (e.g. a passport file). For these, a file with the prefix `decrypted_` will be created in the same directory as the original file in order to decrypt the file without changing the existing one in-place. .. seealso:: :wiki:`Working with Files and Media ` .. versionchanged:: 20.0 * :paramref:`custom_path` parameter now also accepts :class:`pathlib.Path` as argument. * Returns :class:`pathlib.Path` object in cases where previously a :obj:`str` was returned. * This method was previously called ``download``. It was split into :meth:`download_to_drive` and :meth:`download_to_memory`. .. versionchanged:: 21.7 Raises :exc:`RuntimeError` if :attr:`file_path` is not set. Note that files without a :attr:`file_path` could never be downloaded, as this attribute is mandatory for that operation. Args: custom_path (:class:`pathlib.Path` | :obj:`str` , optional): The path where the file will be saved to. If not specified, will be saved in the current working directory with :attr:`file_path` as file name or the :attr:`file_id` if :attr:`file_path` is not set. Keyword Args: read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. Returns: :class:`pathlib.Path`: Returns the Path object the file was downloaded to. Raises: RuntimeError: If :attr:`file_path` is not set. 9No `file_path` available for this file. Can not download.Nz /decrypted_r3)r RuntimeErrorr r-rrr2 read_bytesrparentname write_bytesshutilcopyfileget_botrequestretrieve) rr8r4r5r6r7 local_fileurlfile_to_decryptr.r)filenamerrr download_to_drivexs@B            zFile.download_to_driveoutc s|jstdt|j}|rdn|}|rt|jnd}|r%|} n|jj|||||dIdH} |j r=| | } | | dS)a Download this file into memory. :paramref:`out` needs to be supplied with a :obj:`io.BufferedIOBase`, the file contents will be saved to that object using the :obj:`out.write` method. .. seealso:: :wiki:`Working with Files and Media ` Hint: If you want to immediately read the data from ``out`` after calling this method, you should call ``out.seek(0)`` first. See also :meth:`io.IOBase.seek`. .. versionadded:: 20.0 .. versionchanged:: 21.7 Raises :exc:`RuntimeError` if :attr:`file_path` is not set. Note that files without a :attr:`file_path` could never be downloaded, as this attribute is mandatory for that operation. Args: out (:obj:`io.BufferedIOBase`): A file-like object. Must be opened for writing in binary mode. Keyword Args: read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. Raises: RuntimeError: If :attr:`file_path` is not set. r9Nr3) rr:r r-rr;rArBrCrr2write) rrIr4r5r6r7rDrEr)r.rrr download_to_memorys$0     zFile.download_to_memorycs|jstd|durt}t|jrt|j}n|jj| ||||dIdH}|j r;| | ||S| ||S)a Download this file and return it as a bytearray. .. versionchanged:: 21.7 Raises :exc:`RuntimeError` if :attr:`file_path` is not set. Note that files without a :attr:`file_path` could never be downloaded, as this attribute is mandatory for that operation. Args: buf (:obj:`bytearray`, optional): Extend the given bytearray with the downloaded data. Keyword Args: read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. .. versionadded:: 20.0 write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. .. versionadded:: 20.0 connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. .. versionadded:: 20.0 pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. .. versionadded:: 20.0 Returns: :obj:`bytearray`: The same object as :paramref:`buf` if it was specified. Otherwise a newly allocated :obj:`bytearray`. Raises: RuntimeError: If :attr:`file_path` is not set. r9Nr3) rr: bytearrayr rr;rArBrCr-rextendr2)rr.r4r5r6r7 bytes_datarrr download_as_bytearray&s&1    zFile.download_as_bytearray credentialsrcCs ||_dS)zSets the passport credentials for the file. Args: credentials (:class:`telegram.FileCredentials`): The credentials. N)r)rrPrrr set_credentialsms zFile.set_credentials)NNr/)rPrr!N)__name__ __module__ __qualname____doc__ __slots__rrintr rr-bytesr2r r r floatrrHrrKrLrOrQ __classcell__rrrr r$s'   n F Gr)rUr? urllib.parseparser"base64rpathlibrtypingrrrtelegram._passport.credentialsrtelegram._telegramobjectrtelegram._utils.defaultvaluer telegram._utils.filesr telegram._utils.typesr r r telegramrrrrrr s