mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-12-22 22:45:09 +01:00
417 lines
17 KiB
Python
417 lines
17 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2023
|
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Lesser Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Lesser Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Lesser Public License
|
|
# along with this program. If not, see [http://www.gnu.org/licenses/].
|
|
# pylint: disable=redefined-builtin
|
|
"""This module contains the classes that represent Telegram PassportElementError."""
|
|
|
|
from typing import Optional
|
|
|
|
from telegram._telegramobject import TelegramObject
|
|
from telegram._utils.types import JSONDict
|
|
|
|
|
|
class PassportElementError(TelegramObject):
|
|
"""Baseclass for the PassportElementError* classes.
|
|
|
|
This object represents an error in the Telegram Passport element which was submitted that
|
|
should be resolved by the user.
|
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
considered equal, if their :attr:`source` and :attr:`type` are equal.
|
|
|
|
Args:
|
|
source (:obj:`str`): Error source.
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the error.
|
|
message (:obj:`str`): Error message.
|
|
|
|
Attributes:
|
|
source (:obj:`str`): Error source.
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the error.
|
|
message (:obj:`str`): Error message.
|
|
|
|
"""
|
|
|
|
__slots__ = ("message", "source", "type")
|
|
|
|
def __init__(
|
|
self, source: str, type: str, message: str, *, api_kwargs: Optional[JSONDict] = None
|
|
):
|
|
super().__init__(api_kwargs=api_kwargs)
|
|
# Required
|
|
self.source: str = str(source)
|
|
self.type: str = str(type)
|
|
self.message: str = str(message)
|
|
|
|
self._id_attrs = (self.source, self.type)
|
|
|
|
self._freeze()
|
|
|
|
|
|
class PassportElementErrorDataField(PassportElementError):
|
|
"""
|
|
Represents an issue in one of the data fields that was provided by the user. The error is
|
|
considered resolved when the field's value changes.
|
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
considered equal, if their :attr:`~telegram.PassportElementError.source`, :attr:`type`,
|
|
:attr:`field_name`, :attr:`data_hash` and :attr:`message` are equal.
|
|
|
|
Args:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the error, one of
|
|
``"personal_details"``, ``"passport"``, ``"driver_license"``, ``"identity_card"``,
|
|
``"internal_passport"``, ``"address"``.
|
|
field_name (:obj:`str`): Name of the data field which has the error.
|
|
data_hash (:obj:`str`): Base64-encoded data hash.
|
|
message (:obj:`str`): Error message.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the error, one of
|
|
``"personal_details"``, ``"passport"``, ``"driver_license"``, ``"identity_card"``,
|
|
``"internal_passport"``, ``"address"``.
|
|
field_name (:obj:`str`): Name of the data field which has the error.
|
|
data_hash (:obj:`str`): Base64-encoded data hash.
|
|
message (:obj:`str`): Error message.
|
|
|
|
"""
|
|
|
|
__slots__ = ("data_hash", "field_name")
|
|
|
|
def __init__(
|
|
self,
|
|
type: str,
|
|
field_name: str,
|
|
data_hash: str,
|
|
message: str,
|
|
*,
|
|
api_kwargs: Optional[JSONDict] = None,
|
|
):
|
|
# Required
|
|
super().__init__("data", type, message, api_kwargs=api_kwargs)
|
|
with self._unfrozen():
|
|
self.field_name: str = field_name
|
|
self.data_hash: str = data_hash
|
|
|
|
self._id_attrs = (
|
|
self.source,
|
|
self.type,
|
|
self.field_name,
|
|
self.data_hash,
|
|
self.message,
|
|
)
|
|
|
|
|
|
class PassportElementErrorFile(PassportElementError):
|
|
"""
|
|
Represents an issue with a document scan. The error is considered resolved when the file with
|
|
the document scan changes.
|
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
considered equal, if their :attr:`~telegram.PassportElementError.source`, :attr:`type`,
|
|
:attr:`file_hash`, and :attr:`message` are equal.
|
|
|
|
Args:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of
|
|
``"utility_bill"``, ``"bank_statement"``, ``"rental_agreement"``,
|
|
``"passport_registration"``, ``"temporary_registration"``.
|
|
file_hash (:obj:`str`): Base64-encoded file hash.
|
|
message (:obj:`str`): Error message.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of
|
|
``"utility_bill"``, ``"bank_statement"``, ``"rental_agreement"``,
|
|
``"passport_registration"``, ``"temporary_registration"``.
|
|
file_hash (:obj:`str`): Base64-encoded file hash.
|
|
message (:obj:`str`): Error message.
|
|
|
|
"""
|
|
|
|
__slots__ = ("file_hash",)
|
|
|
|
def __init__(
|
|
self, type: str, file_hash: str, message: str, *, api_kwargs: Optional[JSONDict] = None
|
|
):
|
|
# Required
|
|
super().__init__("file", type, message, api_kwargs=api_kwargs)
|
|
with self._unfrozen():
|
|
self.file_hash: str = file_hash
|
|
|
|
self._id_attrs = (self.source, self.type, self.file_hash, self.message)
|
|
|
|
|
|
class PassportElementErrorFiles(PassportElementError):
|
|
"""
|
|
Represents an issue with a list of scans. The error is considered resolved when the list of
|
|
files with the document scans changes.
|
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
considered equal, if their :attr:`~telegram.PassportElementError.source`, :attr:`type`,
|
|
:attr:`file_hashes`, and :attr:`message` are equal.
|
|
|
|
Args:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of
|
|
``"utility_bill"``, ``"bank_statement"``, ``"rental_agreement"``,
|
|
``"passport_registration"``, ``"temporary_registration"``.
|
|
file_hashes (List[:obj:`str`]): List of base64-encoded file hashes.
|
|
message (:obj:`str`): Error message.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of
|
|
``"utility_bill"``, ``"bank_statement"``, ``"rental_agreement"``,
|
|
``"passport_registration"``, ``"temporary_registration"``.
|
|
file_hashes (List[:obj:`str`]): List of base64-encoded file hashes.
|
|
message (:obj:`str`): Error message.
|
|
|
|
"""
|
|
|
|
__slots__ = ("file_hashes",)
|
|
|
|
def __init__(
|
|
self, type: str, file_hashes: str, message: str, *, api_kwargs: Optional[JSONDict] = None
|
|
):
|
|
# Required
|
|
super().__init__("files", type, message, api_kwargs=api_kwargs)
|
|
with self._unfrozen():
|
|
self.file_hashes: str = file_hashes
|
|
|
|
self._id_attrs = (self.source, self.type, self.message, *tuple(file_hashes))
|
|
|
|
|
|
class PassportElementErrorFrontSide(PassportElementError):
|
|
"""
|
|
Represents an issue with the front side of a document. The error is considered resolved when
|
|
the file with the front side of the document changes.
|
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
considered equal, if their :attr:`~telegram.PassportElementError.source`, :attr:`type`,
|
|
:attr:`file_hash`, and :attr:`message` are equal.
|
|
|
|
Args:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of
|
|
``"passport"``, ``"driver_license"``, ``"identity_card"``, ``"internal_passport"``.
|
|
file_hash (:obj:`str`): Base64-encoded hash of the file with the front side of the
|
|
document.
|
|
message (:obj:`str`): Error message.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of
|
|
``"passport"``, ``"driver_license"``, ``"identity_card"``, ``"internal_passport"``.
|
|
file_hash (:obj:`str`): Base64-encoded hash of the file with the front side of the
|
|
document.
|
|
message (:obj:`str`): Error message.
|
|
|
|
"""
|
|
|
|
__slots__ = ("file_hash",)
|
|
|
|
def __init__(
|
|
self, type: str, file_hash: str, message: str, *, api_kwargs: Optional[JSONDict] = None
|
|
):
|
|
# Required
|
|
super().__init__("front_side", type, message, api_kwargs=api_kwargs)
|
|
with self._unfrozen():
|
|
self.file_hash: str = file_hash
|
|
|
|
self._id_attrs = (self.source, self.type, self.file_hash, self.message)
|
|
|
|
|
|
class PassportElementErrorReverseSide(PassportElementError):
|
|
"""
|
|
Represents an issue with the reverse side of a document. The error is considered resolved when
|
|
the file with the reverse side of the document changes.
|
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
considered equal, if their :attr:`~telegram.PassportElementError.source`, :attr:`type`,
|
|
:attr:`file_hash`, and :attr:`message` are equal.
|
|
|
|
Args:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of
|
|
``"driver_license"``, ``"identity_card"``.
|
|
file_hash (:obj:`str`): Base64-encoded hash of the file with the reverse side of the
|
|
document.
|
|
message (:obj:`str`): Error message.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of
|
|
``"driver_license"``, ``"identity_card"``.
|
|
file_hash (:obj:`str`): Base64-encoded hash of the file with the reverse side of the
|
|
document.
|
|
message (:obj:`str`): Error message.
|
|
|
|
"""
|
|
|
|
__slots__ = ("file_hash",)
|
|
|
|
def __init__(
|
|
self, type: str, file_hash: str, message: str, *, api_kwargs: Optional[JSONDict] = None
|
|
):
|
|
# Required
|
|
super().__init__("reverse_side", type, message, api_kwargs=api_kwargs)
|
|
with self._unfrozen():
|
|
self.file_hash: str = file_hash
|
|
|
|
self._id_attrs = (self.source, self.type, self.file_hash, self.message)
|
|
|
|
|
|
class PassportElementErrorSelfie(PassportElementError):
|
|
"""
|
|
Represents an issue with the selfie with a document. The error is considered resolved when
|
|
the file with the selfie changes.
|
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
considered equal, if their :attr:`~telegram.PassportElementError.source`, :attr:`type`,
|
|
:attr:`file_hash`, and :attr:`message` are equal.
|
|
|
|
Args:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of
|
|
``"passport"``, ``"driver_license"``, ``"identity_card"``, ``"internal_passport"``.
|
|
file_hash (:obj:`str`): Base64-encoded hash of the file with the selfie.
|
|
message (:obj:`str`): Error message.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of
|
|
``"passport"``, ``"driver_license"``, ``"identity_card"``, ``"internal_passport"``.
|
|
file_hash (:obj:`str`): Base64-encoded hash of the file with the selfie.
|
|
message (:obj:`str`): Error message.
|
|
|
|
"""
|
|
|
|
__slots__ = ("file_hash",)
|
|
|
|
def __init__(
|
|
self, type: str, file_hash: str, message: str, *, api_kwargs: Optional[JSONDict] = None
|
|
):
|
|
# Required
|
|
super().__init__("selfie", type, message, api_kwargs=api_kwargs)
|
|
with self._unfrozen():
|
|
self.file_hash: str = file_hash
|
|
|
|
self._id_attrs = (self.source, self.type, self.file_hash, self.message)
|
|
|
|
|
|
class PassportElementErrorTranslationFile(PassportElementError):
|
|
"""
|
|
Represents an issue with one of the files that constitute the translation of a document.
|
|
The error is considered resolved when the file changes.
|
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
considered equal, if their :attr:`~telegram.PassportElementError.source`, :attr:`type`,
|
|
:attr:`file_hash`, and :attr:`message` are equal.
|
|
|
|
Args:
|
|
type (:obj:`str`): Type of element of the user's Telegram Passport which has the issue,
|
|
one of ``"passport"``, ``"driver_license"``, ``"identity_card"``,
|
|
``"internal_passport"``, ``"utility_bill"``, ``"bank_statement"``,
|
|
``"rental_agreement"``, ``"passport_registration"``, ``"temporary_registration"``.
|
|
file_hash (:obj:`str`): Base64-encoded hash of the file.
|
|
message (:obj:`str`): Error message.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): Type of element of the user's Telegram Passport which has the issue,
|
|
one of ``"passport"``, ``"driver_license"``, ``"identity_card"``,
|
|
``"internal_passport"``, ``"utility_bill"``, ``"bank_statement"``,
|
|
``"rental_agreement"``, ``"passport_registration"``, ``"temporary_registration"``.
|
|
file_hash (:obj:`str`): Base64-encoded hash of the file.
|
|
message (:obj:`str`): Error message.
|
|
|
|
"""
|
|
|
|
__slots__ = ("file_hash",)
|
|
|
|
def __init__(
|
|
self, type: str, file_hash: str, message: str, *, api_kwargs: Optional[JSONDict] = None
|
|
):
|
|
# Required
|
|
super().__init__("translation_file", type, message, api_kwargs=api_kwargs)
|
|
with self._unfrozen():
|
|
self.file_hash: str = file_hash
|
|
|
|
self._id_attrs = (self.source, self.type, self.file_hash, self.message)
|
|
|
|
|
|
class PassportElementErrorTranslationFiles(PassportElementError):
|
|
"""
|
|
Represents an issue with the translated version of a document. The error is considered
|
|
resolved when a file with the document translation changes.
|
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
considered equal, if their :attr:`~telegram.PassportElementError.source`, :attr:`type`,
|
|
:attr:`file_hashes`, and :attr:`message` are equal.
|
|
|
|
Args:
|
|
type (:obj:`str`): Type of element of the user's Telegram Passport which has the issue,
|
|
one of ``"passport"``, ``"driver_license"``, ``"identity_card"``,
|
|
``"internal_passport"``, ``"utility_bill"``, ``"bank_statement"``,
|
|
``"rental_agreement"``, ``"passport_registration"``, ``"temporary_registration"``.
|
|
file_hashes (List[:obj:`str`]): List of base64-encoded file hashes.
|
|
message (:obj:`str`): Error message.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): Type of element of the user's Telegram Passport which has the issue,
|
|
one of ``"passport"``, ``"driver_license"``, ``"identity_card"``,
|
|
``"internal_passport"``, ``"utility_bill"``, ``"bank_statement"``,
|
|
``"rental_agreement"``, ``"passport_registration"``, ``"temporary_registration"``.
|
|
file_hashes (List[:obj:`str`]): List of base64-encoded file hashes.
|
|
message (:obj:`str`): Error message.
|
|
|
|
"""
|
|
|
|
__slots__ = ("file_hashes",)
|
|
|
|
def __init__(
|
|
self, type: str, file_hashes: str, message: str, *, api_kwargs: Optional[JSONDict] = None
|
|
):
|
|
# Required
|
|
super().__init__("translation_files", type, message, api_kwargs=api_kwargs)
|
|
with self._unfrozen():
|
|
self.file_hashes: str = file_hashes
|
|
|
|
self._id_attrs = (self.source, self.type, self.message, *tuple(file_hashes))
|
|
|
|
|
|
class PassportElementErrorUnspecified(PassportElementError):
|
|
"""
|
|
Represents an issue in an unspecified place. The error is considered resolved when new
|
|
data is added.
|
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
considered equal, if their :attr:`~telegram.PassportElementError.source`, :attr:`type`,
|
|
:attr:`element_hash`, and :attr:`message` are equal.
|
|
|
|
Args:
|
|
type (:obj:`str`): Type of element of the user's Telegram Passport which has the issue.
|
|
element_hash (:obj:`str`): Base64-encoded element hash.
|
|
message (:obj:`str`): Error message.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): Type of element of the user's Telegram Passport which has the issue.
|
|
element_hash (:obj:`str`): Base64-encoded element hash.
|
|
message (:obj:`str`): Error message.
|
|
|
|
"""
|
|
|
|
__slots__ = ("element_hash",)
|
|
|
|
def __init__(
|
|
self, type: str, element_hash: str, message: str, *, api_kwargs: Optional[JSONDict] = None
|
|
):
|
|
# Required
|
|
super().__init__("unspecified", type, message, api_kwargs=api_kwargs)
|
|
with self._unfrozen():
|
|
self.element_hash: str = element_hash
|
|
|
|
self._id_attrs = (self.source, self.type, self.element_hash, self.message)
|