API 6.3 (#3392)

Co-authored-by: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com> Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>
python-telegram-bot · Dec 6, 2022 · d6c6cc2 · d6c6cc2
1 parent 01167c8
commit d6c6cc2
Show file tree

Hide file tree

Showing 34 changed files with 1,956 additions and 29 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -14,7 +14,7 @@ repos:
         args:
         - --diff
         - --check
--   repo: https://gitlab.com/pycqa/flake8
+-   repo: https://github.com/PyCQA/flake8
     rev: 3.9.2
     hooks:
     -   id: flake8

diff --git a/README.rst b/README.rst
@@ -20,7 +20,7 @@ We have a vibrant community of developers helping each other in our `Telegram gr
    :target: https://pypi.org/project/python-telegram-bot/
    :alt: Supported Python versions
 
-.. image:: https://img.shields.io/badge/Bot%20API-6.2-blue?logo=telegram
+.. image:: https://img.shields.io/badge/Bot%20API-6.3-blue?logo=telegram
    :target: https://core.telegram.org/bots/api-changelog
    :alt: Supported Bot API versions
 

diff --git a/README_RAW.rst b/README_RAW.rst
@@ -20,7 +20,7 @@ We have a vibrant community of developers helping each other in our `Telegram gr
    :target: https://pypi.org/project/python-telegram-bot-raw/
    :alt: Supported Python versions
 
-.. image:: https://img.shields.io/badge/Bot%20API-6.2-blue?logo=telegram
+.. image:: https://img.shields.io/badge/Bot%20API-6.3-blue?logo=telegram
    :target: https://core.telegram.org/bots/api-changelog
    :alt: Supported Bot API versions
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -13,6 +13,7 @@
 # serve to show the default.
 import sys
 import os
+from pathlib import Path
 # import telegram
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -50,6 +51,9 @@
 # The master toctree document.
 master_doc = 'index'
 
+# Global substitutions
+rst_prolog = (Path.cwd() / "substitutions/global.rst").read_text(encoding="utf-8")
+
 # General information about the project.
 project = u'python-telegram-bot'
 copyright = u'2015-2022, Leandro Toledo'

diff --git a/docs/source/substitutions/global.rst b/docs/source/substitutions/global.rst
@@ -0,0 +1,5 @@
+.. |message_thread_id| replace:: Unique identifier for the target message thread of the forum topic.
+
+.. |message_thread_id_arg| replace:: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.
+
+.. |chat_id_group| replace:: Unique identifier for the target chat or username of the target supergroup (in the format ``@supergroupusername``).
diff --git a/docs/source/telegram.forumtopic.rst b/docs/source/telegram.forumtopic.rst
@@ -0,0 +1,8 @@
+:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/v13.x/telegram/forumtopic.py
+
+telegram.ForumTopic
+===================
+
+.. autoclass:: telegram.ForumTopic
+    :members:
+    :show-inheritance:
diff --git a/docs/source/telegram.forumtopicclosed.rst b/docs/source/telegram.forumtopicclosed.rst
@@ -0,0 +1,8 @@
+:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/v13.x/telegram/forumtopic.py
+
+telegram.ForumTopicClosed
+=========================
+
+.. autoclass:: telegram.ForumTopicClosed
+    :members:
+    :show-inheritance:
diff --git a/docs/source/telegram.forumtopiccreated.rst b/docs/source/telegram.forumtopiccreated.rst
@@ -0,0 +1,8 @@
+:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/v13.x/telegram/forumtopic.py
+
+telegram.ForumTopicCreated
+==========================
+
+.. autoclass:: telegram.ForumTopicCreated
+    :members:
+    :show-inheritance:
diff --git a/docs/source/telegram.forumtopicreopened.rst b/docs/source/telegram.forumtopicreopened.rst
@@ -0,0 +1,8 @@
+:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/v13.x/telegram/forumtopic.py
+
+telegram.ForumTopicReopened
+===========================
+
+.. autoclass:: telegram.ForumTopicReopened
+    :members:
+    :show-inheritance:
diff --git a/docs/source/telegram.rst b/docs/source/telegram.rst
@@ -39,6 +39,10 @@ telegram package
     telegram.error
     telegram.file
     telegram.forcereply
+    telegram.forumtopic
+    telegram.forumtopicclosed
+    telegram.forumtopiccreated
+    telegram.forumtopicreopened
     telegram.inlinekeyboardbutton
     telegram.inlinekeyboardmarkup
     telegram.inputfile

diff --git a/telegram/__init__.py b/telegram/__init__.py
@@ -64,6 +64,7 @@
 from .replykeyboardmarkup import ReplyKeyboardMarkup
 from .replykeyboardremove import ReplyKeyboardRemove
 from .forcereply import ForceReply
+from .forumtopic import ForumTopic, ForumTopicClosed, ForumTopicCreated, ForumTopicReopened
 from .error import TelegramError
 from .files.inputfile import InputFile
 from .files.file import File
@@ -230,6 +231,10 @@
     'File',
     'FileCredentials',
     'ForceReply',
+    'ForumTopic',
+    'ForumTopicClosed',
+    'ForumTopicCreated',
+    'ForumTopicReopened',
     'Game',
     'GameHighScore',
     'IdDocumentData',