python-telegram-bot · Bibo-Joshi · May 27, 2021 · Apr 6, 2021 · Apr 6, 2021 · Apr 6, 2021
diff --git a/.deepsource.toml b/.deepsource.toml
@@ -0,0 +1,20 @@
+version = 1
+
+test_patterns = ["tests/**"]
+
+exclude_patterns = [
+    "tests/**",
+    "docs/**",
+    "telegram/vendor/**",
+    "setup.py",
+    "setup-raw.py"
+]
+
+[[analyzers]]
+name = "python"
+enabled = true
+
+  [analyzers.meta]
+  runtime_version = "3.x.x"
+  max_line_length = 99
+  skip_doc_coverage = ["module", "magic", "init", "nonpublic"]
diff --git a/README.rst b/README.rst
@@ -50,10 +50,14 @@ We have a vibrant community of developers helping each other in our `Telegram gr
 
 .. image:: https://api.codacy.com/project/badge/Grade/99d901eaa09b44b4819aec05c330c968
    :target: https://www.codacy.com/app/python-telegram-bot/python-telegram-bot?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=python-telegram-bot/python-telegram-bot&amp;utm_campaign=Badge_Grade
-   :alt: Code quality
+   :alt: Code quality: Codacy
+
+.. image:: https://deepsource.io/gh/python-telegram-bot/python-telegram-bot.svg/?label=active+issues
+   :target: https://deepsource.io/gh/python-telegram-bot/python-telegram-bot/?ref=repository-badge
+   :alt: Code quality: DeepSource
 
 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :target: https://github.com/psf/black
+   :target: https://github.com/psf/black
 
 .. image:: https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram
    :target: https://telegram.me/pythontelegrambotgroup

diff --git a/README_RAW.rst b/README_RAW.rst
@@ -50,10 +50,14 @@ We have a vibrant community of developers helping each other in our `Telegram gr
 
 .. image:: https://api.codacy.com/project/badge/Grade/99d901eaa09b44b4819aec05c330c968
    :target: https://www.codacy.com/app/python-telegram-bot/python-telegram-bot?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=python-telegram-bot/python-telegram-bot&amp;utm_campaign=Badge_Grade
-   :alt: Code quality
+   :alt: Code quality: Codacy
+
+.. image:: https://deepsource.io/gh/python-telegram-bot/python-telegram-bot.svg/?label=active+issues
+   :target: https://deepsource.io/gh/python-telegram-bot/python-telegram-bot/?ref=repository-badge
+   :alt: Code quality: DeepSource
 
 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :target: https://github.com/psf/black
+   :target: https://github.com/psf/black
 
 .. image:: https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram
    :target: https://telegram.me/pythontelegrambotgroup

diff --git a/examples/passportbot.py b/examples/passportbot.py
@@ -24,6 +24,7 @@
 
 
 def msg(update: Update, _: CallbackContext) -> None:
+    """Downloads and prints the received passport data."""
     # Retrieve passport data
     passport_data = update.message.passport_data
     # If our nonce doesn't match what we think, this Update did not originate from us
@@ -61,21 +62,24 @@ def msg(update: Update, _: CallbackContext) -> None:
                 actual_file = file.get_file()
                 print(actual_file)
                 actual_file.download()
-        if data.type in ('passport', 'driver_license', 'identity_card', 'internal_passport'):
-            if data.front_side:
-                front_file = data.front_side.get_file()
-                print(data.type, front_file)
-                front_file.download()
-        if data.type in ('driver_license' and 'identity_card'):
-            if data.reverse_side:
-                reverse_file = data.reverse_side.get_file()
-                print(data.type, reverse_file)
-                reverse_file.download()
-        if data.type in ('passport', 'driver_license', 'identity_card', 'internal_passport'):
-            if data.selfie:
-                selfie_file = data.selfie.get_file()
-                print(data.type, selfie_file)
-                selfie_file.download()
+        if (
+            data.type in ('passport', 'driver_license', 'identity_card', 'internal_passport')
+            and data.front_side
+        ):
+            front_file = data.front_side.get_file()
+            print(data.type, front_file)
+            front_file.download()
+        if data.type in ('driver_license' and 'identity_card') and data.reverse_side:
+            reverse_file = data.reverse_side.get_file()
+            print(data.type, reverse_file)
+            reverse_file.download()
+        if (
+            data.type in ('passport', 'driver_license', 'identity_card', 'internal_passport')
+            and data.selfie
+        ):
+            selfie_file = data.selfie.get_file()
+            print(data.type, selfie_file)
+            selfie_file.download()
         if data.type in (
             'passport',
             'driver_license',
@@ -97,7 +101,8 @@ def msg(update: Update, _: CallbackContext) -> None:
 def main() -> None:
     """Start the bot."""
     # Create the Updater and pass it your token and private key
-    updater = Updater("TOKEN", private_key=open('private.key', 'rb').read())
+    with open('private.key', 'rb') as private_key:
+        updater = Updater("TOKEN", private_key=private_key.read())
 
     # Get the dispatcher to register handlers
     dispatcher = updater.dispatcher

diff --git a/telegram/__main__.py b/telegram/__main__.py
@@ -29,15 +29,15 @@
 
 def _git_revision() -> Optional[str]:
     try:
-        output = subprocess.check_output(
+        output = subprocess.check_output(  # skipcq: BAN-B607
             ["git", "describe", "--long", "--tags"], stderr=subprocess.STDOUT
         )
     except (subprocess.SubprocessError, OSError):
         return None
     return output.decode().strip()
 
 
-def print_ver_info() -> None:
+def print_ver_info() -> None:  # skipcq: PY-D0003
     git_revision = _git_revision()
     print(f'python-telegram-bot {telegram_ver}' + (f' ({git_revision})' if git_revision else ''))
     print(f'Bot API {BOT_API_VERSION}')
@@ -46,7 +46,7 @@ def print_ver_info() -> None:
     print(f'Python {sys_version}')
 
 
-def main() -> None:
+def main() -> None:  # skipcq: PY-D0003
     print_ver_info()
 
 

diff --git a/telegram/base.py b/telegram/base.py
@@ -34,7 +34,7 @@
 
 
 class TelegramObject:
-    """Base class for most telegram objects."""
+    """Base class for most Telegram objects."""
 
     _id_attrs: Tuple[object, ...] = ()
 
@@ -45,12 +45,22 @@ def __getitem__(self, item: str) -> object:
         return self.__dict__[item]
 
     @staticmethod
-    def parse_data(data: Optional[JSONDict]) -> Optional[JSONDict]:
+    def _parse_data(data: Optional[JSONDict]) -> Optional[JSONDict]:
         return None if data is None else data.copy()
 
     @classmethod
     def de_json(cls: Type[TO], data: Optional[JSONDict], bot: 'Bot') -> Optional[TO]:
-        data = cls.parse_data(data)
+        """Converts JSON data to a Telegram object.
+
+        Args:
+            data (Dict[:obj:`str`, ...]): The JSON data.
+            bot (:class:`telegram.Bot`): The bot associated with this object.
+
+        Returns:
+            The Telegram object.
+
+        """
+        data = cls._parse_data(data)
 
         if data is None:
             return None
@@ -61,21 +71,35 @@ def de_json(cls: Type[TO], data: Optional[JSONDict], bot: 'Bot') -> Optional[TO]
 
     @classmethod
     def de_list(cls: Type[TO], data: Optional[List[JSONDict]], bot: 'Bot') -> List[Optional[TO]]:
+        """Converts JSON data to a list of Telegram objects.
+
+        Args:
+            data (Dict[:obj:`str`, ...]): The JSON data.
+            bot (:class:`telegram.Bot`): The bot associated with these objects.
+
+        Returns:
+            A list of Telegram objects.
+
+        """
         if not data:
             return []
 
         return [cls.de_json(d, bot) for d in data]
 
     def to_json(self) -> str:
-        """
+        """Gives a JSON representation of object.
+
         Returns:
             :obj:`str`
-
         """
-
         return json.dumps(self.to_dict())
 
     def to_dict(self) -> JSONDict:
+        """Gives representation of object as :obj:`dict`.
+
+        Returns:
+            :obj:`dict`
+        """
         data = {}
 
         for key in iter(self.__dict__):

diff --git a/telegram/bot.py b/telegram/bot.py
@@ -116,7 +116,7 @@
 RT = TypeVar('RT')
 
 
-def log(
+def log(  # skipcq: PY-D0003
     func: Callable[..., RT], *args: object, **kwargs: object  # pylint: disable=W0613
 ) -> Callable[..., RT]:
     logger = logging.getLogger(func.__module__)
@@ -301,7 +301,7 @@ def _message(
         return Message.de_json(result, self)  # type: ignore[return-value, arg-type]
 
     @property
-    def request(self) -> Request:
+    def request(self) -> Request:  # skip-cq: PY-D0003
         return self._request
 
     @staticmethod
@@ -319,71 +319,60 @@ def _validate_token(token: str) -> str:
     @property
     def bot(self) -> User:
         """:class:`telegram.User`: User instance for the bot as returned by :meth:`get_me`."""
-
         if self._bot is None:
             self._bot = self.get_me()
         return self._bot
 
     @property
     def id(self) -> int:  # pylint: disable=C0103
         """:obj:`int`: Unique identifier for this bot."""
-
         return self.bot.id
 
     @property
     def first_name(self) -> str:
         """:obj:`str`: Bot's first name."""
-
         return self.bot.first_name
 
     @property
     def last_name(self) -> str:
         """:obj:`str`: Optional. Bot's last name."""
-
         return self.bot.last_name  # type: ignore
 
     @property
     def username(self) -> str:
         """:obj:`str`: Bot's username."""
-
         return self.bot.username  # type: ignore
 
     @property
     def link(self) -> str:
         """:obj:`str`: Convenience property. Returns the t.me link of the bot."""
-
         return f"https://t.me/{self.username}"
 
     @property
     def can_join_groups(self) -> bool:
         """:obj:`bool`: Bot's :attr:`telegram.User.can_join_groups` attribute."""
-
         return self.bot.can_join_groups  # type: ignore
 
     @property
     def can_read_all_group_messages(self) -> bool:
         """:obj:`bool`: Bot's :attr:`telegram.User.can_read_all_group_messages` attribute."""
-
         return self.bot.can_read_all_group_messages  # type: ignore
 
     @property
     def supports_inline_queries(self) -> bool:
         """:obj:`bool`: Bot's :attr:`telegram.User.supports_inline_queries` attribute."""
-
         return self.bot.supports_inline_queries  # type: ignore
 
     @property
     def commands(self) -> List[BotCommand]:
         """List[:class:`BotCommand`]: Bot's commands."""
-
         if self._commands is None:
             self._commands = self.get_my_commands()
         return self._commands
 
     @property
     def name(self) -> str:
         """:obj:`str`: Bot's @username."""
-
         return f'@{self.username}'
 
     @log
@@ -2606,7 +2595,6 @@ def edit_message_media(
         Raises:
             :class:`telegram.error.TelegramError`
         """
-
         if inline_message_id is None and (chat_id is None or message_id is None):
             raise ValueError(
                 'edit_message_media: Both chat_id and message_id are required when '
@@ -4257,7 +4245,6 @@ def unpin_all_chat_messages(
             :class:`telegram.error.TelegramError`
 
         """
-
         data: JSONDict = {'chat_id': chat_id}
 
         return self._post(  # type: ignore[return-value]
@@ -5089,6 +5076,7 @@ def copy_message(
         return MessageId.de_json(result, self)  # type: ignore[return-value, arg-type]
 
     def to_dict(self) -> JSONDict:
+        """See :meth:`telegram.TelegramObject.to_dict`."""
         data: JSONDict = {'id': self.id, 'username': self.username, 'first_name': self.first_name}
 
         if self.last_name:

diff --git a/telegram/callbackquery.py b/telegram/callbackquery.py
@@ -113,7 +113,8 @@ def __init__(
 
     @classmethod
     def de_json(cls, data: Optional[JSONDict], bot: 'Bot') -> Optional['CallbackQuery']:
-        data = cls.parse_data(data)
+        """See :meth:`telegram.TelegramObject.de_json`."""
+        data = cls._parse_data(data)
 
         if not data:
             return None

diff --git a/telegram/chat.py b/telegram/chat.py
@@ -229,14 +229,16 @@ def full_name(self) -> Optional[str]:
     @property
     def link(self) -> Optional[str]:
         """:obj:`str`: Convenience property. If the chat has a :attr:`username`, returns a t.me
-        link of the chat."""
+        link of the chat.
+        """
         if self.username:
             return f"https://t.me/{self.username}"
         return None
 
     @classmethod
     def de_json(cls, data: Optional[JSONDict], bot: 'Bot') -> Optional['Chat']:
-        data = cls.parse_data(data)
+        """See :meth:`telegram.TelegramObject.de_json`."""
+        data = cls._parse_data(data)
 
         if not data:
             return None

diff --git a/telegram/chatinvitelink.py b/telegram/chatinvitelink.py
@@ -84,7 +84,8 @@ def __init__(
 
     @classmethod
     def de_json(cls, data: Optional[JSONDict], bot: 'Bot') -> Optional['ChatInviteLink']:
-        data = cls.parse_data(data)
+        """See :meth:`telegram.TelegramObject.de_json`."""
+        data = cls._parse_data(data)
 
         if not data:
             return None
@@ -95,6 +96,7 @@ def de_json(cls, data: Optional[JSONDict], bot: 'Bot') -> Optional['ChatInviteLi
         return cls(**data)
 
     def to_dict(self) -> JSONDict:
+        """See :meth:`telegram.TelegramObject.to_dict`."""
         data = super().to_dict()
 
         data['expire_date'] = to_timestamp(self.expire_date)

diff --git a/telegram/chatlocation.py b/telegram/chatlocation.py
@@ -60,7 +60,8 @@ def __init__(
 
     @classmethod
     def de_json(cls, data: Optional[JSONDict], bot: 'Bot') -> Optional['ChatLocation']:
-        data = cls.parse_data(data)
+        """See :meth:`telegram.TelegramObject.de_json`."""
+        data = cls._parse_data(data)
 
         if not data:
             return None