diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst index e34cb1dd7..03044145b 100644 --- a/.github/CONTRIBUTING.rst +++ b/.github/CONTRIBUTING.rst @@ -1,10 +1,11 @@ +================= How To Contribute ================= Every open source project lives from the generous help by contributors that sacrifice their time and ``python-telegram-bot`` is no different. To make participation as pleasant as possible, this project adheres to the `Code of Conduct`_ by the Python Software Foundation. Setting things up ------------------ +================= 1. Fork the ``python-telegram-bot`` repository to your GitHub account. @@ -35,18 +36,18 @@ Setting things up $ pre-commit install Finding something to do -####################### +======================= If you already know what you'd like to work on, you can skip this section. If you have an idea for something to do, first check if it's already been filed on the `issue tracker`_. If so, add a comment to the issue saying you'd like to work on it, and we'll help you get started! Otherwise, please file a new issue and assign yourself to it. -Another great way to start contributing is by writing tests. Tests are really important because they help prevent developers from accidentally breaking existing code, allowing them to build cool things faster. If you're interested in helping out, let the development team know by posting to the `Telegram group`_ (use `@admins` to mention the maintainers), and we'll help you get started. +Another great way to start contributing is by writing tests. Tests are really important because they help prevent developers from accidentally breaking existing code, allowing them to build cool things faster. If you're interested in helping out, let the development team know by posting to the `Telegram group`_, and we'll help you get started. That being said, we want to mention that we are very hesitant about adding new requirements to our projects. If you intend to do this, please state this in an issue and get a verification from one of the maintainers. Instructions for making a code change -##################################### +===================================== The central development branch is ``master``, which should be clean and ready for release at any time. In general, all changes should be done as feature branches based off of ``master``. @@ -93,13 +94,13 @@ Here's how to make a one-off code change. - Before making a commit ensure that all automated tests still pass: - .. code-block:: + .. code-block:: bash $ pytest -v To run ``test_official`` (particularly useful if you made API changes), run - .. code-block:: + .. code-block:: bash $ export TEST_OFFICIAL=true @@ -107,7 +108,7 @@ Here's how to make a one-off code change. - If you want run style & type checks before committing run - .. code-block:: + .. code-block:: bash $ pre-commit run -a @@ -208,10 +209,10 @@ for new to make relevant changes if said lines don't do what they are supposed t Style commandments ------------------- +================== Assert comparison order -####################### +----------------------- Assert statements should compare in **actual** == **expected** order. For example (assuming ``test_call`` is the thing being tested): @@ -225,7 +226,7 @@ For example (assuming ``test_call`` is the thing being tested): assert 5 == test_call() Properly calling callables -########################## +-------------------------- Methods, functions and classes can specify optional parameters (with default values) using Python's keyword arg syntax. When providing a value to such a @@ -243,7 +244,7 @@ This gives us the flexibility to re-order arguments and more importantly to add new required arguments. It's also more explicit and easier to read. Properly defining optional arguments -#################################### +------------------------------------ It's always good to not initialize optional arguments at class creation, instead use ``**kwargs`` to get them. It's well known Telegram API can diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.rst similarity index 85% rename from CODE_OF_CONDUCT.md rename to CODE_OF_CONDUCT.rst index c61bb3e50..6920482dc 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.rst @@ -1,10 +1,14 @@ -# Contributor Covenant Code of Conduct +==================================== +Contributor Covenant Code of Conduct +==================================== -## Our Pledge +Our Pledge +========== In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. -## Our Standards +Our Standards +============= Examples of behavior that contributes to creating a positive environment include: @@ -23,25 +27,26 @@ Examples of unacceptable behavior by participants include: * Publishing others' private information, such as a physical or electronic address, without explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting -## Our Responsibilities +Our Responsibilities +==================== Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. -## Scope +Scope +===== This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. -## Enforcement +Enforcement +=========== Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at devs@python-telegram-bot.org. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. -## Attribution +Attribution +=========== -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] - -[homepage]: http://contributor-covenant.org -[version]: http://contributor-covenant.org/version/1/4/ +This Code of Conduct is adapted from the `Contributor Covenant `_, version 1.4, available at `http://contributor-covenant.org/version/1/4 `_. diff --git a/README.rst b/README.rst index bb6a183fb..4413c72b9 100644 --- a/README.rst +++ b/README.rst @@ -6,12 +6,6 @@ :target: https://python-telegram-bot.org :alt: python-telegram-bot Logo -We have made you a wrapper you can't refuse - -We have a vibrant community of developers helping each other in our `Telegram group `_. Join us! - -*Stay tuned for library updates and new releases on our* `Telegram Channel `_. - .. image:: https://img.shields.io/pypi/v/python-telegram-bot.svg :target: https://pypi.org/project/python-telegram-bot/ :alt: PyPi Package Version @@ -29,7 +23,7 @@ We have a vibrant community of developers helping each other in our `Telegram gr :alt: PyPi Package Monthly Download .. image:: https://readthedocs.org/projects/python-telegram-bot/badge/?version=stable - :target: https://python-telegram-bot.readthedocs.io/en/stable/?badge=stable + :target: https://python-telegram-bot.readthedocs.io/en/stable/ :alt: Documentation Status .. image:: https://img.shields.io/pypi/l/python-telegram-bot.svg @@ -56,44 +50,34 @@ We have a vibrant community of developers helping each other in our `Telegram gr :target: https://deepsource.io/gh/python-telegram-bot/python-telegram-bot/?ref=repository-badge :alt: Code quality: DeepSource +.. image:: https://results.pre-commit.ci/badge/github/python-telegram-bot/python-telegram-bot/master.svg + :target: https://results.pre-commit.ci/latest/github/python-telegram-bot/python-telegram-bot/master + :alt: pre-commit.ci status + .. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black + :alt: Code Style: Black + +.. image:: https://img.shields.io/badge/Telegram-Channel-blue.svg?logo=telegram + :target: https://t.me/pythontelegrambotchannel + :alt: Telegram Channel .. image:: https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram :target: https://telegram.me/pythontelegrambotgroup :alt: Telegram Group -================= -Table of contents -================= +We have made you a wrapper you can't refuse -- `Introduction`_ +We have a vibrant community of developers helping each other in our `Telegram group `_. Join us! -- `Telegram API support`_ +*Stay tuned for library updates and new releases on our* `Telegram Channel `_. -- `Installing`_ - -- `Getting started`_ - - #. `Learning by example`_ - - #. `Logging`_ - - #. `Documentation`_ - -- `Getting help`_ - -- `Contributing`_ - -- `License`_ - -============ Introduction ============ -This library provides a pure Python interface for the +This library provides a pure Python, asynchronous interface for the `Telegram Bot API `_. -It's compatible with Python versions **3.7+**. PTB might also work on `PyPy `_, though there have been a lot of issues before. Hence, PyPy is not officially supported. +It's compatible with Python versions **3.7+**. In addition to the pure API implementation, this library features a number of high-level classes to make the development of bots easy and straightforward. These classes are contained in the @@ -101,51 +85,35 @@ make the development of bots easy and straightforward. These classes are contain A pure API implementation *without* ``telegram.ext`` is available as the standalone package ``python-telegram-bot-raw``. `See here for details. `_ ----- Note ---- Installing both ``python-telegram-bot`` and ``python-telegram-bot-raw`` in conjunction will result in undesired side-effects, so only install *one* of both. -==================== Telegram API support ==================== All types and methods of the Telegram Bot API **6.0** are supported. -=========== -Concurrency -=========== - -Since v14.0, ``python-telegram-bot`` is built on top of Pythons ``asyncio`` module. -Because ``asyncio`` is in general single-threaded, ``python-telegram-bot`` does currently not aim to be thread-safe. -Noteworthy parts of ``python-telegram-bots`` API that are likely to cause issues (e.g. race conditions) when used in a multi-threaded setting include: - -* ``telegram.ext.Application/Updater.update_queue`` -* ``telegram.ext.ConversationHandler.check/handle_update`` -* ``telegram.ext.CallbackDataCache`` -* ``telegram.ext.BasePersistence`` -* all classes in the ``telegram.ext.filters`` module that allow to add/remove allowed users/chats at runtime - -========== Installing ========== -You can install or upgrade python-telegram-bot with: +You can install or upgrade ``python-telegram-bot`` via .. code:: shell $ pip install python-telegram-bot --upgrade -Or you can install from source with: +To install a pre-release, use the ``--pre`` `flag `_ in addition. + +You can also install ``python-telegram-bot`` from source, though this is usually not necessary. .. code:: shell - $ git clone https://github.com/python-telegram-bot/python-telegram-bot --recursive + $ git clone https://github.com/python-telegram-bot/python-telegram-bot $ cd python-telegram-bot $ python setup.py install ------------------------------ Dependencies & Their Versions ----------------------------- @@ -163,7 +131,6 @@ To minimize dependency conflicts, we try to be liberal in terms of version requi On the other hand, we have to ensure stability of ``python-telegram-bot``, which is why we do apply version bounds. If you encounter dependency conflicts due to these bounds, feel free to reach out. ---------------------- Optional Dependencies --------------------- @@ -173,96 +140,62 @@ PTB can be installed with optional dependencies: * ``pip install python-telegram-bot[json]`` installs the `ujson>=4.0.0 `_ library. It will then be used for JSON de- & encoding, which can bring speed up compared to the standard `json `_ library. * ``pip install python-telegram-bot[socks]`` installs ``httpx[socks]``. Use this, if you want to work behind a Socks5 server. -=============== -Getting started -=============== +Quick Start +=========== -Our Wiki contains a lot of resources to get you started with ``python-telegram-bot``: +Our Wiki contains an `Introduction to the API `_ explaining how the pure Bot API can be accessed via ``python-telegram-bot``. +Moreover, the `Tutorial: Your first Bot `_ gives an introduction on how chatbots can be easily programmed with the help of the ``telegram.ext`` module. -- `Introduction to the API `_ -- Tutorial: `Your first Bot `_ +Resources +========= -Other references: +- The `package documentation `_ is the technical reference for ``python-telegram-bot``. + It contains descriptions of all available classes, modules, methods and arguments. +- The `wiki `_ is home to number of more elaborate introductions of the different features of ``python-telegram-bot`` and other useful resources that go beyond the technical documentation. +- Our `examples directory `_ contains several examples that showcase the different features of both the Bot API and ``python-telegram-bot``. + Even if it is not your approach for learning, please take a look at ``echobot.py``. It is the de facto base for most of the bots out there. + The code for these examples is released to the public domain, so you can start by grabbing the code and building on top of it. +- The `official Telegram Bot API documentation `_ is of course always worth a read. -- `Telegram API documentation `_ -- `python-telegram-bot documentation `_ - -------------------- -Learning by example -------------------- - -We believe that the best way to learn this package is by example. Here -are some examples for you to review. Even if it is not your approach for learning, please take a -look at ``echobot.py``. It is the de facto base for most of the bots out there. Best of all, -the code for these examples is released to the public domain, so you can start by grabbing the -code and building on top of it. - -Visit `this page `_ to discover the official examples or look at the examples on the `wiki `_ to see other bots the community has built. - -------- -Logging -------- - -This library uses the ``logging`` module. To set up logging to standard output, put: - -.. code:: python - - import logging - - logging.basicConfig( - level=logging.DEBUG, format="%(asctime)s - %(name)s - %(levelname)s - %(message)s" - ) - -at the beginning of your script. - -You can also use logs in your application by calling ``logging.getLogger()`` and setting the log level you want: - -.. code:: python - - logger = logging.getLogger() - logger.setLevel(logging.INFO) - -If you want DEBUG logs instead: - -.. code:: python - - logger.setLevel(logging.DEBUG) - - -============= -Documentation -============= - -``python-telegram-bot``'s documentation lives at `readthedocs.io `_. - -============ Getting help ============ -You can get help in several ways: +If the resources mentioned above don't answer your questions or simply overwhelm you, there are several ways of getting help. -1. We have a vibrant community of developers helping each other in our `Telegram group `_. Join us! +1. We have a vibrant community of developers helping each other in our `Telegram group `_. Join us! Asking a question here is often the quickest way to get a pointer in the right direction. -2. Report bugs, request new features or ask questions by `creating an issue `_ or `a discussion `_. +2. Ask questions by opening `a discussion `_. -3. Our `Wiki pages `_ offer a growing amount of resources. +3. You can even ask for help on Stack Overflow using the `python-telegram-bot tag `_. -4. You can even ask for help on Stack Overflow using the `python-telegram-bot tag `_. +Concurrency +=========== +Since v20.0, ``python-telegram-bot`` is built on top of Pythons ``asyncio`` module. +Because ``asyncio`` is in general single-threaded, ``python-telegram-bot`` does currently not aim to be thread-safe. +Noteworthy parts of ``python-telegram-bots`` API that are likely to cause issues (e.g. race conditions) when used in a multi-threaded setting include: + +* ``telegram.ext.Application/Updater.update_queue`` +* ``telegram.ext.ConversationHandler.check/handle_update`` +* ``telegram.ext.CallbackDataCache`` +* ``telegram.ext.BasePersistence`` +* all classes in the ``telegram.ext.filters`` module that allow to add/remove allowed users/chats at runtime -============ Contributing ============ -Contributions of all sizes are welcome. Please review our `contribution guidelines `_ to get started. You can also help by `reporting bugs `_. +Contributions of all sizes are welcome. +Please review our `contribution guidelines `_ to get started. +You can also help by `reporting bugs or feature requests `_. -======== Donating ======== -Occasionally we are asked if we accept donations to support the development. While we appreciate the thought, maintaining PTB is our hobby, and we have almost no running costs for it. We therefore have nothing set up to accept donations. If you still want to donate, we kindly ask you to donate to another open source project/initiative of your choice instead. +Occasionally we are asked if we accept donations to support the development. +While we appreciate the thought, maintaining PTB is our hobby, and we have almost no running costs for it. We therefore have nothing set up to accept donations. +If you still want to donate, we kindly ask you to donate to another open source project/initiative of your choice instead. -======= License ======= -You may copy, distribute and modify the software provided that modifications are described and licensed for free under `LGPL-3 `_. Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL-3, but applications that use the library don't have to be. +You may copy, distribute and modify the software provided that modifications are described and licensed for free under `LGPL-3 `_. +Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL-3, but applications that use the library don't have to be. diff --git a/README_RAW.rst b/README_RAW.rst index 5f5f8d1f2..ff5ed745d 100644 --- a/README_RAW.rst +++ b/README_RAW.rst @@ -6,12 +6,6 @@ :target: https://python-telegram-bot.org :alt: python-telegram-bot-raw Logo -We have made you a wrapper you can't refuse - -We have a vibrant community of developers helping each other in our `Telegram group `_. Join us! - -*Stay tuned for library updates and new releases on our* `Telegram Channel `_. - .. image:: https://img.shields.io/pypi/v/python-telegram-bot-raw.svg :target: https://pypi.org/project/python-telegram-bot-raw/ :alt: PyPi Package Version @@ -56,89 +50,71 @@ We have a vibrant community of developers helping each other in our `Telegram gr :target: https://deepsource.io/gh/python-telegram-bot/python-telegram-bot/?ref=repository-badge :alt: Code quality: DeepSource +.. image:: https://results.pre-commit.ci/badge/github/python-telegram-bot/python-telegram-bot/master.svg + :target: https://results.pre-commit.ci/latest/github/python-telegram-bot/python-telegram-bot/master + :alt: pre-commit.ci status + .. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black + :alt: Code Style: Black + +.. image:: https://img.shields.io/badge/Telegram-Channel-blue.svg?logo=telegram + :target: https://t.me/pythontelegrambotchannel + :alt: Telegram Channel .. image:: https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram :target: https://telegram.me/pythontelegrambotgroup :alt: Telegram Group -================= -Table of contents -================= +We have made you a wrapper you can't refuse -- `Introduction`_ +We have a vibrant community of developers helping each other in our `Telegram group `_. Join us! -- `Telegram API support`_ +*Stay tuned for library updates and new releases on our* `Telegram Channel `_. -- `Installing`_ - -- `Getting started`_ - - #. `Logging`_ - - #. `Documentation`_ - -- `Getting help`_ - -- `Contributing`_ - -- `License`_ - -============ Introduction ============ -This library provides a pure Python, lightweight interface for the +This library provides a pure Python, asynchronous interface for the `Telegram Bot API `_. -It's compatible with Python versions **3.7+**. PTB-Raw might also work on `PyPy `_, though there have been a lot of issues before. Hence, PyPy is not officially supported. +It's compatible with Python versions **3.7+**. -``python-telegram-bot-raw`` is part of the `python-telegram-bot `_ ecosystem and provides the pure API functionality extracted from PTB. It therefore does *not* have independent release schedules, changelogs or documentation. Please consult the PTB resources. +``python-telegram-bot-raw`` is part of the `python-telegram-bot `_ ecosystem and provides the pure API functionality extracted from PTB. It therefore does not have independent release schedules, changelogs or documentation. ----- Note ---- Installing both ``python-telegram-bot`` and ``python-telegram-bot-raw`` in conjunction will result in undesired side-effects, so only install *one* of both. -==================== Telegram API support ==================== All types and methods of the Telegram Bot API **6.0** are supported. -=========== -Concurrency -=========== - -Since v14.0, ``python-telegram-bot`` is built on top of Pythons ``asyncio`` module. -Because ``asyncio`` is in general single-threaded, ``python-telegram-bot`` does currently not aim to be thread-safe. - -========== Installing ========== -You can install or upgrade python-telegram-bot-raw with: +You can install or upgrade ``python-telegram-bot`` via .. code:: shell $ pip install python-telegram-bot-raw --upgrade -Or you can install from source with: +To install a pre-release, use the ``--pre`` `flag `_ in addition. + +You can also install ``python-telegram-bot-raw`` from source, though this is usually not necessary. .. code:: shell - $ git clone https://github.com/python-telegram-bot/python-telegram-bot --recursive + $ git clone https://github.com/python-telegram-bot/python-telegram-bot $ cd python-telegram-bot $ python setup-raw.py install ----- Note ---- -Installing the `.tar.gz` archive available on PyPi directly via `pip` will *not* work as expected, as `pip` does not recognize that it should use `setup-raw.py` instead of `setup.py`. +Installing the ``.tar.gz`` archive available on PyPi directly via ``pip`` will *not* work as expected, as ``pip`` does not recognize that it should use ``setup-raw.py`` instead of ``setup.py``. ------------------------------ Dependencies & Their Versions ----------------------------- @@ -153,88 +129,63 @@ To minimize dependency conflicts, we try to be liberal in terms of version requi On the other hand, we have to ensure stability of ``python-telegram-bot``, which is why we do apply version bounds. If you encounter dependency conflicts due to these bounds, feel free to reach out. ---------------------- Optional Dependencies --------------------- -PTB can be installed with optional dependencies: +``python-telegram-bot-raw`` can be installed with optional dependencies: -* ``pip install python-telegram-bot-raw[passport]`` installs the `cryptography>=3.0 `_ library. Use this, if you want to use Telegram Passport related functionality. -* ``pip install python-telegram-bot-raw[json]`` installs the `ujson>=4.0.0 `_ library. It will then be used for JSON de- & encoding, which can bring speed up compared to the standard `json `_ library. +* ``pip install python-telegram-bot[passport]`` installs the `cryptography `_ library. Use this, if you want to use Telegram Passport related functionality. +* ``pip install python-telegram-bot[json]`` installs the `ujson `_ library. It will then be used for JSON de- & encoding, which can bring speed up compared to the standard `json `_ library. +* ``pip install python-telegram-bot[socks]`` installs the `PySocks `_ library. Use this, if you want to work behind a Socks5 server. -=============== -Getting started -=============== +Quick Start +=========== -Our Wiki contains an `Introduction to the API `_. Other references are: +Our Wiki contains an `Introduction to the API `_ explaining how the pure Bot API can be accessed via ``python-telegram-bot``. -- the `Telegram API documentation `_ -- the `python-telegram-bot documentation `_ +Resources +========= -------- -Logging -------- +- The `package documentation `_ is the technical reference for ``python-telegram-bot``. + It contains descriptions of all available classes, modules, methods and arguments. +- The `wiki `_ is home to number of more elaborate introductions of the different features of ``python-telegram-bot`` and other useful resources that go beyond the technical documentation. +- Our `examples directory `_ contains several examples that showcase the different features of both the Bot API and ``python-telegram-bot``. + Even if it is not your approach for learning, please take a look at ``echobot.py``. It is the de facto base for most of the bots out there. + The code for these examples is released to the public domain, so you can start by grabbing the code and building on top of it. +- The `official Telegram Bot API documentation `_ is of course always worth a read. -This library uses the ``logging`` module. To set up logging to standard output, put: - -.. code:: python - - import logging - - logging.basicConfig( - level=logging.DEBUG, format="%(asctime)s - %(name)s - %(levelname)s - %(message)s" - ) - -at the beginning of your script. - -You can also use logs in your application by calling ``logging.getLogger()`` and setting the log level you want: - -.. code:: python - - logger = logging.getLogger() - logger.setLevel(logging.INFO) - -If you want DEBUG logs instead: - -.. code:: python - - logger.setLevel(logging.DEBUG) - - -============= -Documentation -============= - -``python-telegram-bot``'s documentation lives at `readthedocs.io `_, which -includes the relevant documentation for ``python-telegram-bot-raw``. - -============ Getting help ============ -You can get help in several ways: +If the resources mentioned above don't answer your questions or simply overwhelm you, there are several ways of getting help. -1. We have a vibrant community of developers helping each other in our `Telegram group `_. Join us! +1. We have a vibrant community of developers helping each other in our `Telegram group `_. Join us! Asking a question here is often the quickest way to get a pointer in the right direction. -2. Report bugs, request new features or ask questions by `creating an issue `_ or `a discussion `_. +2. Ask questions by opening `a discussion `_. -3. Our `Wiki pages `_ offer a growing amount of resources. +3. You can even ask for help on Stack Overflow using the `python-telegram-bot tag `_. -4. You can even ask for help on Stack Overflow using the `python-telegram-bot tag `_. +Concurrency +=========== + +Since v20.0, ``python-telegram-bot`` is built on top of Pythons ``asyncio`` module. +Because ``asyncio`` is in general single-threaded, ``python-telegram-bot`` does currently not aim to be thread-safe. -============ Contributing ============ -Contributions of all sizes are welcome. Please review our `contribution guidelines `_ to get started. You can also help by `reporting bugs `_. +Contributions of all sizes are welcome. +Please review our `contribution guidelines `_ to get started. +You can also help by `reporting bugs or feature requests `_. -======== Donating ======== -Occasionally we are asked if we accept donations to support the development. While we appreciate the thought, maintaining PTB is our hobby, and we have almost no running costs for it. We therefore have nothing set up to accept donations. If you still want to donate, we kindly ask you to donate to another open source project/initiative of your choice instead. +Occasionally we are asked if we accept donations to support the development. +While we appreciate the thought, maintaining PTB is our hobby, and we have almost no running costs for it. We therefore have nothing set up to accept donations. +If you still want to donate, we kindly ask you to donate to another open source project/initiative of your choice instead. -======= License ======= -You may copy, distribute and modify the software provided that modifications are described and licensed for free under `LGPL-3 `_. Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL-3, but applications that use the library don't have to be. +You may copy, distribute and modify the software provided that modifications are described and licensed for free under `LGPL-3 `_. +Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL-3, but applications that use the library don't have to be. diff --git a/docs/source/coc.rst b/docs/source/coc.rst new file mode 100644 index 000000000..fb1859c75 --- /dev/null +++ b/docs/source/coc.rst @@ -0,0 +1 @@ +.. include:: ../../CODE_OF_CONDUCT.rst \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index ccda9189d..5a3126615 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -147,8 +147,7 @@ todo_include_todos = False html_theme = "furo" # Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. +# further. For a list of options available for each theme, see the documentation. html_theme_options = { "navigation_with_keys": True, "dark_css_variables": { @@ -159,10 +158,74 @@ html_theme_options = { "admonition-title-font-size": "0.95rem", "admonition-font-size": "0.92rem", }, - "announcement": "PTB has undergone significant changes in v14. Please read the documentation " + "announcement": "PTB has undergone significant changes in v20. Please read the documentation " "carefully and also check out the transition guide in the " - '' - "wiki.", + 'wiki.', + "footer_icons": [ + { + # Telegram channel logo + "name": "Telegram Channel", + "url": "https://t.me/pythontelegrambotchannel/", + # Following svg is from https://react-icons.github.io/react-icons/search?q=telegram + "html": '' + '', + "class": "", + }, + { # Github logo + "name": "GitHub", + "url": "https://github.com/python-telegram-bot/python-telegram-bot/", + "html": '' + "", + "class": "", + }, + { # PTB website logo - globe + "name": "python-telegram-bot website", + "url": "https://python-telegram-bot.org/", + "html": '' + '', + "class": "", + }, + ], } # Add any paths that contain custom themes here, relative to this directory. @@ -170,7 +233,7 @@ html_theme_options = { # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -html_title = f"python-telegram-bot
v{version}" +html_title = f"python-telegram-bot
v{version}" # A shorter title for the navigation bar. Default is the same as html_title. # html_short_title = None diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst new file mode 100644 index 000000000..03db3edaa --- /dev/null +++ b/docs/source/contributing.rst @@ -0,0 +1 @@ +.. include:: ../../.github/CONTRIBUTING.rst \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 9b42222ec..d3b743c2b 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,39 +3,29 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Python Telegram Bot's documentation! -=============================================== +.. include:: ../../README.rst -Guides and tutorials -==================== - -If you're just starting out with the library, we recommend following our `"Your first Bot" `_ tutorial that you can find on our `wiki `_. -While being there, you will also find guides to learn how to use handlers, webhooks, proxies, making your bot persistent, and much more. - -Examples -======== - -A great way to learn is by looking at examples. Ours can be found in our `examples folder on Github `_. - - -Reference -========= - -Below you can find a reference of all the classes and methods in python-telegram-bot. -Apart from the `telegram.ext` package and the `Auxiliary` modules, the objects reflect the types defined in the `official Telegram Bot API documentation `_. +.. The toctrees are hidden such that they don't reander on the start page but still include the contents into the documentation. .. toctree:: - telegram.ext + :hidden: + :caption: Reference -.. toctree:: telegram - -Changelog ---------- + telegram.ext + telegram_auxil + Telegrams Bot API Docs .. toctree:: - :maxdepth: 2 + :hidden: + :caption: Project changelog + Website + GitHub Repository + Telegram Channel + Telegram User Group + contributing + coc diff --git a/docs/source/telegram.animation.rst b/docs/source/telegram.animation.rst index 908e824e9..05776f0fc 100644 --- a/docs/source/telegram.animation.rst +++ b/docs/source/telegram.animation.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/animation.py - telegram.Animation ================== diff --git a/docs/source/telegram.audio.rst b/docs/source/telegram.audio.rst index 09065d8fe..ae4928eca 100644 --- a/docs/source/telegram.audio.rst +++ b/docs/source/telegram.audio.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/audio.py - telegram.Audio ============== diff --git a/docs/source/telegram.bot.rst b/docs/source/telegram.bot.rst index 9869dedc1..6b620b5fb 100644 --- a/docs/source/telegram.bot.rst +++ b/docs/source/telegram.bot.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/bot.py - telegram.Bot ============ diff --git a/docs/source/telegram.botcommand.rst b/docs/source/telegram.botcommand.rst index 26dece6ad..9ceb402c5 100644 --- a/docs/source/telegram.botcommand.rst +++ b/docs/source/telegram.botcommand.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommand.py - telegram.BotCommand =================== diff --git a/docs/source/telegram.botcommandscope.rst b/docs/source/telegram.botcommandscope.rst index 625712520..0cbbca97d 100644 --- a/docs/source/telegram.botcommandscope.rst +++ b/docs/source/telegram.botcommandscope.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py - telegram.BotCommandScope ======================== diff --git a/docs/source/telegram.botcommandscopeallchatadministrators.rst b/docs/source/telegram.botcommandscopeallchatadministrators.rst index fa30ce538..e77bb0987 100644 --- a/docs/source/telegram.botcommandscopeallchatadministrators.rst +++ b/docs/source/telegram.botcommandscopeallchatadministrators.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py - telegram.BotCommandScopeAllChatAdministrators ============================================= diff --git a/docs/source/telegram.botcommandscopeallgroupchats.rst b/docs/source/telegram.botcommandscopeallgroupchats.rst index 2c4f672eb..c00d78380 100644 --- a/docs/source/telegram.botcommandscopeallgroupchats.rst +++ b/docs/source/telegram.botcommandscopeallgroupchats.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py - telegram.BotCommandScopeAllGroupChats ======================================= diff --git a/docs/source/telegram.botcommandscopeallprivatechats.rst b/docs/source/telegram.botcommandscopeallprivatechats.rst index 91ea4d034..c63bf9039 100644 --- a/docs/source/telegram.botcommandscopeallprivatechats.rst +++ b/docs/source/telegram.botcommandscopeallprivatechats.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py - telegram.BotCommandScopeAllPrivateChats ======================================= diff --git a/docs/source/telegram.botcommandscopechat.rst b/docs/source/telegram.botcommandscopechat.rst index dd7795428..cd54df932 100644 --- a/docs/source/telegram.botcommandscopechat.rst +++ b/docs/source/telegram.botcommandscopechat.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py - telegram.BotCommandScopeChat ============================ diff --git a/docs/source/telegram.botcommandscopechatadministrators.rst b/docs/source/telegram.botcommandscopechatadministrators.rst index 68cb13282..7e4734293 100644 --- a/docs/source/telegram.botcommandscopechatadministrators.rst +++ b/docs/source/telegram.botcommandscopechatadministrators.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py - telegram.BotCommandScopeChatAdministrators ========================================== diff --git a/docs/source/telegram.botcommandscopechatmember.rst b/docs/source/telegram.botcommandscopechatmember.rst index e28105179..c86175c80 100644 --- a/docs/source/telegram.botcommandscopechatmember.rst +++ b/docs/source/telegram.botcommandscopechatmember.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py - telegram.BotCommandScopeChatMember ================================== diff --git a/docs/source/telegram.botcommandscopedefault.rst b/docs/source/telegram.botcommandscopedefault.rst index 2705a734c..cbf90cfe3 100644 --- a/docs/source/telegram.botcommandscopedefault.rst +++ b/docs/source/telegram.botcommandscopedefault.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/botcommandscope.py - telegram.BotCommandScopeDefault =============================== diff --git a/docs/source/telegram.callbackgame.rst b/docs/source/telegram.callbackgame.rst index e2facc41e..6fa11ded8 100644 --- a/docs/source/telegram.callbackgame.rst +++ b/docs/source/telegram.callbackgame.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/games/callbackgame.py - telegram.Callbackgame ===================== diff --git a/docs/source/telegram.callbackquery.rst b/docs/source/telegram.callbackquery.rst index b628b0236..297189aaf 100644 --- a/docs/source/telegram.callbackquery.rst +++ b/docs/source/telegram.callbackquery.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/callbackquery.py - telegram.CallbackQuery ====================== diff --git a/docs/source/telegram.chat.rst b/docs/source/telegram.chat.rst index 7347e5d13..cd04bb87b 100644 --- a/docs/source/telegram.chat.rst +++ b/docs/source/telegram.chat.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chat.py - telegram.Chat ============= diff --git a/docs/source/telegram.chatinvitelink.rst b/docs/source/telegram.chatinvitelink.rst index e85f97fb6..ca24e5340 100644 --- a/docs/source/telegram.chatinvitelink.rst +++ b/docs/source/telegram.chatinvitelink.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatinvitelink.py - telegram.ChatInviteLink ======================= diff --git a/docs/source/telegram.chatjoinrequest.rst b/docs/source/telegram.chatjoinrequest.rst index 401173845..e1450cc10 100644 --- a/docs/source/telegram.chatjoinrequest.rst +++ b/docs/source/telegram.chatjoinrequest.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatjoinrequest.py - telegram.ChatJoinRequest ======================== diff --git a/docs/source/telegram.chatlocation.rst b/docs/source/telegram.chatlocation.rst index dd0c2f006..8994d138e 100644 --- a/docs/source/telegram.chatlocation.rst +++ b/docs/source/telegram.chatlocation.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatlocation.py - telegram.ChatLocation ===================== diff --git a/docs/source/telegram.chatmember.rst b/docs/source/telegram.chatmember.rst index 2aa4a58f2..7bba9e448 100644 --- a/docs/source/telegram.chatmember.rst +++ b/docs/source/telegram.chatmember.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatmember.py - telegram.ChatMember =================== diff --git a/docs/source/telegram.chatmemberadministrator.rst b/docs/source/telegram.chatmemberadministrator.rst index ac5108651..62a56f183 100644 --- a/docs/source/telegram.chatmemberadministrator.rst +++ b/docs/source/telegram.chatmemberadministrator.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatmember.py - telegram.ChatMemberAdministrator ================================ diff --git a/docs/source/telegram.chatmemberbanned.rst b/docs/source/telegram.chatmemberbanned.rst index 168c2df96..15f5ff2db 100644 --- a/docs/source/telegram.chatmemberbanned.rst +++ b/docs/source/telegram.chatmemberbanned.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatmember.py - telegram.ChatMemberBanned ========================= diff --git a/docs/source/telegram.chatmemberleft.rst b/docs/source/telegram.chatmemberleft.rst index 6840063c6..6a0ca2b15 100644 --- a/docs/source/telegram.chatmemberleft.rst +++ b/docs/source/telegram.chatmemberleft.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatmember.py - telegram.ChatMemberLeft ======================= diff --git a/docs/source/telegram.chatmembermember.rst b/docs/source/telegram.chatmembermember.rst index 7e2d8293b..55ca6fe99 100644 --- a/docs/source/telegram.chatmembermember.rst +++ b/docs/source/telegram.chatmembermember.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatmember.py - telegram.ChatMemberMember ========================= diff --git a/docs/source/telegram.chatmemberowner.rst b/docs/source/telegram.chatmemberowner.rst index 784cb644a..03f162a7f 100644 --- a/docs/source/telegram.chatmemberowner.rst +++ b/docs/source/telegram.chatmemberowner.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatmember.py - telegram.ChatMemberOwner ======================== diff --git a/docs/source/telegram.chatmemberrestricted.rst b/docs/source/telegram.chatmemberrestricted.rst index cd76611fd..957414ed3 100644 --- a/docs/source/telegram.chatmemberrestricted.rst +++ b/docs/source/telegram.chatmemberrestricted.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatmember.py - telegram.ChatMemberRestricted ============================= diff --git a/docs/source/telegram.chatmemberupdated.rst b/docs/source/telegram.chatmemberupdated.rst index c5c141260..d6feecc44 100644 --- a/docs/source/telegram.chatmemberupdated.rst +++ b/docs/source/telegram.chatmemberupdated.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatmemberupdated.py - telegram.ChatMemberUpdated ========================== diff --git a/docs/source/telegram.chatpermissions.rst b/docs/source/telegram.chatpermissions.rst index bb180946d..7cefdbc23 100644 --- a/docs/source/telegram.chatpermissions.rst +++ b/docs/source/telegram.chatpermissions.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/chatpermissions.py - telegram.ChatPermissions ======================== diff --git a/docs/source/telegram.chatphoto.rst b/docs/source/telegram.chatphoto.rst index 22a9aaad3..4ab6ae0a2 100644 --- a/docs/source/telegram.chatphoto.rst +++ b/docs/source/telegram.chatphoto.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/chatphoto.py - telegram.ChatPhoto ================== diff --git a/docs/source/telegram.choseninlineresult.rst b/docs/source/telegram.choseninlineresult.rst index cb997a913..d60547d4b 100644 --- a/docs/source/telegram.choseninlineresult.rst +++ b/docs/source/telegram.choseninlineresult.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/choseninlineresult.py - telegram.ChosenInlineResult =========================== diff --git a/docs/source/telegram.constants.rst b/docs/source/telegram.constants.rst index a223a220b..124951465 100644 --- a/docs/source/telegram.constants.rst +++ b/docs/source/telegram.constants.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/constants.py - telegram.constants Module ========================= diff --git a/docs/source/telegram.contact.rst b/docs/source/telegram.contact.rst index 345c00584..f38079be9 100644 --- a/docs/source/telegram.contact.rst +++ b/docs/source/telegram.contact.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/contact.py - telegram.Contact ================ diff --git a/docs/source/telegram.credentials.rst b/docs/source/telegram.credentials.rst index 59f4f36e4..6a3fe39e1 100644 --- a/docs/source/telegram.credentials.rst +++ b/docs/source/telegram.credentials.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/credentials.py - telegram.Credentials ==================== diff --git a/docs/source/telegram.datacredentials.rst b/docs/source/telegram.datacredentials.rst index 51d85455f..b0916762e 100644 --- a/docs/source/telegram.datacredentials.rst +++ b/docs/source/telegram.datacredentials.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/credentials.py - telegram.DataCredentials ======================== diff --git a/docs/source/telegram.dice.rst b/docs/source/telegram.dice.rst index 29dedd5b5..6e80f6d48 100644 --- a/docs/source/telegram.dice.rst +++ b/docs/source/telegram.dice.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/dice.py - telegram.Dice ============= diff --git a/docs/source/telegram.document.rst b/docs/source/telegram.document.rst index ac492ff48..83db9ffa0 100644 --- a/docs/source/telegram.document.rst +++ b/docs/source/telegram.document.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/document.py - telegram.Document ================= .. Also lists methods of _BaseThumbedMedium, but not the ones of TelegramObject diff --git a/docs/source/telegram.encryptedcredentials.rst b/docs/source/telegram.encryptedcredentials.rst index 096efbcc0..d42851436 100644 --- a/docs/source/telegram.encryptedcredentials.rst +++ b/docs/source/telegram.encryptedcredentials.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/credentials.py - telegram.EncryptedCredentials ============================= diff --git a/docs/source/telegram.encryptedpassportelement.rst b/docs/source/telegram.encryptedpassportelement.rst index 5a9693be3..f22963601 100644 --- a/docs/source/telegram.encryptedpassportelement.rst +++ b/docs/source/telegram.encryptedpassportelement.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/encryptedpassportelement.py - telegram.EncryptedPassportElement ================================= diff --git a/docs/source/telegram.error.rst b/docs/source/telegram.error.rst index b2fd1f4d6..c5cd7aee0 100644 --- a/docs/source/telegram.error.rst +++ b/docs/source/telegram.error.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/error.py - telegram.error Module ===================== diff --git a/docs/source/telegram.ext.application.rst b/docs/source/telegram.ext.application.rst index b2fc8ff41..722340ea8 100644 --- a/docs/source/telegram.ext.application.rst +++ b/docs/source/telegram.ext.application.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/_application.py - telegram.ext.Application ======================== diff --git a/docs/source/telegram.ext.applicationbuilder.rst b/docs/source/telegram.ext.applicationbuilder.rst index cff3899c4..a5e7d6126 100644 --- a/docs/source/telegram.ext.applicationbuilder.rst +++ b/docs/source/telegram.ext.applicationbuilder.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/_applicationbuilder.py - telegram.ext.ApplicationBuilder =============================== diff --git a/docs/source/telegram.ext.applicationhandlerstop.rst b/docs/source/telegram.ext.applicationhandlerstop.rst index b2ee0c6ed..fe2feb9d2 100644 --- a/docs/source/telegram.ext.applicationhandlerstop.rst +++ b/docs/source/telegram.ext.applicationhandlerstop.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/_application.py - telegram.ext.ApplicationHandlerStop =================================== diff --git a/docs/source/telegram.ext.basepersistence.rst b/docs/source/telegram.ext.basepersistence.rst index 178d95a80..013c052d8 100644 --- a/docs/source/telegram.ext.basepersistence.rst +++ b/docs/source/telegram.ext.basepersistence.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/basepersistence.py - telegram.ext.BasePersistence ============================ diff --git a/docs/source/telegram.ext.callbackcontext.rst b/docs/source/telegram.ext.callbackcontext.rst index bd5ff3706..364879318 100644 --- a/docs/source/telegram.ext.callbackcontext.rst +++ b/docs/source/telegram.ext.callbackcontext.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/callbackcontext.py - telegram.ext.CallbackContext ============================ diff --git a/docs/source/telegram.ext.callbackdatacache.rst b/docs/source/telegram.ext.callbackdatacache.rst index e1467e02a..96dbedd9f 100644 --- a/docs/source/telegram.ext.callbackdatacache.rst +++ b/docs/source/telegram.ext.callbackdatacache.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/callbackdatacache.py - telegram.ext.CallbackDataCache ============================== diff --git a/docs/source/telegram.ext.callbackqueryhandler.rst b/docs/source/telegram.ext.callbackqueryhandler.rst index 8f72eecb2..4e876e413 100644 --- a/docs/source/telegram.ext.callbackqueryhandler.rst +++ b/docs/source/telegram.ext.callbackqueryhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/callbackqueryhandler.py - telegram.ext.CallbackQueryHandler ================================= diff --git a/docs/source/telegram.ext.chatjoinrequesthandler.rst b/docs/source/telegram.ext.chatjoinrequesthandler.rst index 650ff1b35..e36596b4a 100644 --- a/docs/source/telegram.ext.chatjoinrequesthandler.rst +++ b/docs/source/telegram.ext.chatjoinrequesthandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/chatjoinrequesthandler.py - telegram.ext.ChatJoinRequestHandler =================================== diff --git a/docs/source/telegram.ext.chatmemberhandler.rst b/docs/source/telegram.ext.chatmemberhandler.rst index 976014959..59675b954 100644 --- a/docs/source/telegram.ext.chatmemberhandler.rst +++ b/docs/source/telegram.ext.chatmemberhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/chatmemberhandler.py - telegram.ext.ChatMemberHandler ============================== diff --git a/docs/source/telegram.ext.choseninlineresulthandler.rst b/docs/source/telegram.ext.choseninlineresulthandler.rst index 8ada326a6..e415c2d7e 100644 --- a/docs/source/telegram.ext.choseninlineresulthandler.rst +++ b/docs/source/telegram.ext.choseninlineresulthandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/choseninlineresulthandler.py - telegram.ext.ChosenInlineResultHandler ====================================== diff --git a/docs/source/telegram.ext.commandhandler.rst b/docs/source/telegram.ext.commandhandler.rst index 4b8d869e9..a892d3ca8 100644 --- a/docs/source/telegram.ext.commandhandler.rst +++ b/docs/source/telegram.ext.commandhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/commandhandler.py - telegram.ext.CommandHandler =========================== diff --git a/docs/source/telegram.ext.contexttypes.rst b/docs/source/telegram.ext.contexttypes.rst index d0cc0a29a..28f3e31a7 100644 --- a/docs/source/telegram.ext.contexttypes.rst +++ b/docs/source/telegram.ext.contexttypes.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/contexttypes.py - telegram.ext.ContextTypes ========================= diff --git a/docs/source/telegram.ext.conversationhandler.rst b/docs/source/telegram.ext.conversationhandler.rst index 2f5007d15..aa4bac815 100644 --- a/docs/source/telegram.ext.conversationhandler.rst +++ b/docs/source/telegram.ext.conversationhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/conversationhandler.py - telegram.ext.ConversationHandler ================================ diff --git a/docs/source/telegram.ext.defaults.rst b/docs/source/telegram.ext.defaults.rst index 66a338704..d08a6ed5c 100644 --- a/docs/source/telegram.ext.defaults.rst +++ b/docs/source/telegram.ext.defaults.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/defaults.py - telegram.ext.Defaults ===================== diff --git a/docs/source/telegram.ext.dictpersistence.rst b/docs/source/telegram.ext.dictpersistence.rst index 95ea3ef3f..08b78de37 100644 --- a/docs/source/telegram.ext.dictpersistence.rst +++ b/docs/source/telegram.ext.dictpersistence.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/dictpersistence.py - telegram.ext.DictPersistence ============================ diff --git a/docs/source/telegram.ext.extbot.rst b/docs/source/telegram.ext.extbot.rst index a295f2aa4..d0e85027c 100644 --- a/docs/source/telegram.ext.extbot.rst +++ b/docs/source/telegram.ext.extbot.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/extbot.py - telegram.ext.ExtBot =================== diff --git a/docs/source/telegram.ext.filters.rst b/docs/source/telegram.ext.filters.rst index 8eb415771..d332480cd 100644 --- a/docs/source/telegram.ext.filters.rst +++ b/docs/source/telegram.ext.filters.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/filters.py - telegram.ext.filters Module =========================== diff --git a/docs/source/telegram.ext.handler.rst b/docs/source/telegram.ext.handler.rst index 065cbba98..45822d223 100644 --- a/docs/source/telegram.ext.handler.rst +++ b/docs/source/telegram.ext.handler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/handler.py - telegram.ext.Handler ==================== diff --git a/docs/source/telegram.ext.inlinequeryhandler.rst b/docs/source/telegram.ext.inlinequeryhandler.rst index ea2ddeaf7..5b249c9fa 100644 --- a/docs/source/telegram.ext.inlinequeryhandler.rst +++ b/docs/source/telegram.ext.inlinequeryhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/inlinequeryhandler.py - telegram.ext.InlineQueryHandler =============================== diff --git a/docs/source/telegram.ext.invalidcallbackdata.rst b/docs/source/telegram.ext.invalidcallbackdata.rst index 58588d1fe..b19bed91c 100644 --- a/docs/source/telegram.ext.invalidcallbackdata.rst +++ b/docs/source/telegram.ext.invalidcallbackdata.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/callbackdatacache.py - telegram.ext.InvalidCallbackData ================================ diff --git a/docs/source/telegram.ext.job.rst b/docs/source/telegram.ext.job.rst index d6c4f6914..c150bc37c 100644 --- a/docs/source/telegram.ext.job.rst +++ b/docs/source/telegram.ext.job.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/jobqueue.py - telegram.ext.Job ===================== diff --git a/docs/source/telegram.ext.jobqueue.rst b/docs/source/telegram.ext.jobqueue.rst index ec5f98398..080d64226 100644 --- a/docs/source/telegram.ext.jobqueue.rst +++ b/docs/source/telegram.ext.jobqueue.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/jobqueue.py - telegram.ext.JobQueue ===================== diff --git a/docs/source/telegram.ext.messagehandler.rst b/docs/source/telegram.ext.messagehandler.rst index 262c1aa06..2d1ca39bf 100644 --- a/docs/source/telegram.ext.messagehandler.rst +++ b/docs/source/telegram.ext.messagehandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/messagehandler.py - telegram.ext.MessageHandler =========================== diff --git a/docs/source/telegram.ext.persistenceinput.rst b/docs/source/telegram.ext.persistenceinput.rst index ea5a0b38c..b2d491979 100644 --- a/docs/source/telegram.ext.persistenceinput.rst +++ b/docs/source/telegram.ext.persistenceinput.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/basepersistence.py - telegram.ext.PersistenceInput ============================= diff --git a/docs/source/telegram.ext.picklepersistence.rst b/docs/source/telegram.ext.picklepersistence.rst index fc1dcd7a5..f8691b181 100644 --- a/docs/source/telegram.ext.picklepersistence.rst +++ b/docs/source/telegram.ext.picklepersistence.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/picklepersistence.py - telegram.ext.PicklePersistence ============================== diff --git a/docs/source/telegram.ext.pollanswerhandler.rst b/docs/source/telegram.ext.pollanswerhandler.rst index fa049fa9f..5113f135e 100644 --- a/docs/source/telegram.ext.pollanswerhandler.rst +++ b/docs/source/telegram.ext.pollanswerhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/pollanswerhandler.py - telegram.ext.PollAnswerHandler ============================== diff --git a/docs/source/telegram.ext.pollhandler.rst b/docs/source/telegram.ext.pollhandler.rst index 14a9d003a..da30d879f 100644 --- a/docs/source/telegram.ext.pollhandler.rst +++ b/docs/source/telegram.ext.pollhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/pollhandler.py - telegram.ext.PollHandler ======================== diff --git a/docs/source/telegram.ext.precheckoutqueryhandler.rst b/docs/source/telegram.ext.precheckoutqueryhandler.rst index c7138853d..28fe9d49a 100644 --- a/docs/source/telegram.ext.precheckoutqueryhandler.rst +++ b/docs/source/telegram.ext.precheckoutqueryhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/precheckoutqueryhandler.py - telegram.ext.PreCheckoutQueryHandler ==================================== diff --git a/docs/source/telegram.ext.prefixhandler.rst b/docs/source/telegram.ext.prefixhandler.rst index d61e35892..18fb2be14 100644 --- a/docs/source/telegram.ext.prefixhandler.rst +++ b/docs/source/telegram.ext.prefixhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/commandhandler.py - telegram.ext.PrefixHandler =========================== diff --git a/docs/source/telegram.ext.shippingqueryhandler.rst b/docs/source/telegram.ext.shippingqueryhandler.rst index 013ef57b8..7da2992b9 100644 --- a/docs/source/telegram.ext.shippingqueryhandler.rst +++ b/docs/source/telegram.ext.shippingqueryhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/shippingqueryhandler.py - telegram.ext.ShippingQueryHandler ================================= diff --git a/docs/source/telegram.ext.stringcommandhandler.rst b/docs/source/telegram.ext.stringcommandhandler.rst index 5fe5dc82b..57ed1710e 100644 --- a/docs/source/telegram.ext.stringcommandhandler.rst +++ b/docs/source/telegram.ext.stringcommandhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/stringcommandhandler.py - telegram.ext.StringCommandHandler ================================= diff --git a/docs/source/telegram.ext.stringregexhandler.rst b/docs/source/telegram.ext.stringregexhandler.rst index 127239db9..621d9b732 100644 --- a/docs/source/telegram.ext.stringregexhandler.rst +++ b/docs/source/telegram.ext.stringregexhandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/stringregexhandler.py - telegram.ext.StringRegexHandler =============================== diff --git a/docs/source/telegram.ext.typehandler.rst b/docs/source/telegram.ext.typehandler.rst index 49dfbbf11..05ebd4ee3 100644 --- a/docs/source/telegram.ext.typehandler.rst +++ b/docs/source/telegram.ext.typehandler.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/typehandler.py - telegram.ext.TypeHandler ======================== diff --git a/docs/source/telegram.ext.updater.rst b/docs/source/telegram.ext.updater.rst index dcd8ce4c0..2a52132d7 100644 --- a/docs/source/telegram.ext.updater.rst +++ b/docs/source/telegram.ext.updater.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/updater.py - telegram.ext.Updater ==================== diff --git a/docs/source/telegram.file.rst b/docs/source/telegram.file.rst index 8db85d86d..f04d547ab 100644 --- a/docs/source/telegram.file.rst +++ b/docs/source/telegram.file.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/file.py - telegram.File ============= diff --git a/docs/source/telegram.filecredentials.rst b/docs/source/telegram.filecredentials.rst index bc2d88e77..600661e50 100644 --- a/docs/source/telegram.filecredentials.rst +++ b/docs/source/telegram.filecredentials.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/credentials.py - telegram.FileCredentials ======================== diff --git a/docs/source/telegram.forcereply.rst b/docs/source/telegram.forcereply.rst index 2ee8edce8..75bfc166a 100644 --- a/docs/source/telegram.forcereply.rst +++ b/docs/source/telegram.forcereply.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/forcereply.py - telegram.ForceReply =================== diff --git a/docs/source/telegram.game.rst b/docs/source/telegram.game.rst index c6f2c51c1..ada1140d5 100644 --- a/docs/source/telegram.game.rst +++ b/docs/source/telegram.game.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/games/game.py - telegram.Game ============= diff --git a/docs/source/telegram.gamehighscore.rst b/docs/source/telegram.gamehighscore.rst index 84528bdb9..c69c7fe1d 100644 --- a/docs/source/telegram.gamehighscore.rst +++ b/docs/source/telegram.gamehighscore.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/games/gamehighscore.py - telegram.GameHighScore ====================== diff --git a/docs/source/telegram.helpers.rst b/docs/source/telegram.helpers.rst index f75937653..7d589f3e3 100644 --- a/docs/source/telegram.helpers.rst +++ b/docs/source/telegram.helpers.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/helpers.py - telegram.helpers Module ======================= diff --git a/docs/source/telegram.iddocumentdata.rst b/docs/source/telegram.iddocumentdata.rst index 85c32271a..1333f7ed4 100644 --- a/docs/source/telegram.iddocumentdata.rst +++ b/docs/source/telegram.iddocumentdata.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/data.py - telegram.IdDocumentData ======================= diff --git a/docs/source/telegram.inlinekeyboardbutton.rst b/docs/source/telegram.inlinekeyboardbutton.rst index dde7af030..9a118a75c 100644 --- a/docs/source/telegram.inlinekeyboardbutton.rst +++ b/docs/source/telegram.inlinekeyboardbutton.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinekeyboardbutton.py - telegram.InlineKeyboardButton ============================= diff --git a/docs/source/telegram.inlinekeyboardmarkup.rst b/docs/source/telegram.inlinekeyboardmarkup.rst index 1a41e0d1d..63aba4630 100644 --- a/docs/source/telegram.inlinekeyboardmarkup.rst +++ b/docs/source/telegram.inlinekeyboardmarkup.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinekeyboardmarkup.py - telegram.InlineKeyboardMarkup ============================= diff --git a/docs/source/telegram.inlinequery.rst b/docs/source/telegram.inlinequery.rst index 00c6566a9..ce17a816d 100644 --- a/docs/source/telegram.inlinequery.rst +++ b/docs/source/telegram.inlinequery.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequery.py - telegram.InlineQuery ==================== diff --git a/docs/source/telegram.inlinequeryresult.rst b/docs/source/telegram.inlinequeryresult.rst index 0d9970b1a..97e9a97ff 100644 --- a/docs/source/telegram.inlinequeryresult.rst +++ b/docs/source/telegram.inlinequeryresult.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresult.py - telegram.InlineQueryResult ========================== diff --git a/docs/source/telegram.inlinequeryresultarticle.rst b/docs/source/telegram.inlinequeryresultarticle.rst index 46ea88cd7..c8756fdc7 100644 --- a/docs/source/telegram.inlinequeryresultarticle.rst +++ b/docs/source/telegram.inlinequeryresultarticle.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultarticle.py - telegram.InlineQueryResultArticle ================================= diff --git a/docs/source/telegram.inlinequeryresultaudio.rst b/docs/source/telegram.inlinequeryresultaudio.rst index 414b437c7..83bb5d452 100644 --- a/docs/source/telegram.inlinequeryresultaudio.rst +++ b/docs/source/telegram.inlinequeryresultaudio.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultaudio.py - telegram.InlineQueryResultAudio =============================== diff --git a/docs/source/telegram.inlinequeryresultcachedaudio.rst b/docs/source/telegram.inlinequeryresultcachedaudio.rst index 01431917a..f7e992916 100644 --- a/docs/source/telegram.inlinequeryresultcachedaudio.rst +++ b/docs/source/telegram.inlinequeryresultcachedaudio.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedaudio.py - telegram.InlineQueryResultCachedAudio ===================================== diff --git a/docs/source/telegram.inlinequeryresultcacheddocument.rst b/docs/source/telegram.inlinequeryresultcacheddocument.rst index 5a23a317e..18db7ba7a 100644 --- a/docs/source/telegram.inlinequeryresultcacheddocument.rst +++ b/docs/source/telegram.inlinequeryresultcacheddocument.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcacheddocument.py - telegram.InlineQueryResultCachedDocument ======================================== diff --git a/docs/source/telegram.inlinequeryresultcachedgif.rst b/docs/source/telegram.inlinequeryresultcachedgif.rst index a639991db..9faaf071a 100644 --- a/docs/source/telegram.inlinequeryresultcachedgif.rst +++ b/docs/source/telegram.inlinequeryresultcachedgif.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedgif.py - telegram.InlineQueryResultCachedGif =================================== diff --git a/docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst b/docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst index d98da7434..1c6406ab5 100644 --- a/docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst +++ b/docs/source/telegram.inlinequeryresultcachedmpeg4gif.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedmpeg4gif.py - telegram.InlineQueryResultCachedMpeg4Gif ======================================== diff --git a/docs/source/telegram.inlinequeryresultcachedphoto.rst b/docs/source/telegram.inlinequeryresultcachedphoto.rst index 882f84ce4..9887210f3 100644 --- a/docs/source/telegram.inlinequeryresultcachedphoto.rst +++ b/docs/source/telegram.inlinequeryresultcachedphoto.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedphoto.py - telegram.InlineQueryResultCachedPhoto ===================================== diff --git a/docs/source/telegram.inlinequeryresultcachedsticker.rst b/docs/source/telegram.inlinequeryresultcachedsticker.rst index 19872be36..4b989ddba 100644 --- a/docs/source/telegram.inlinequeryresultcachedsticker.rst +++ b/docs/source/telegram.inlinequeryresultcachedsticker.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedsticker.py - telegram.InlineQueryResultCachedSticker ======================================= diff --git a/docs/source/telegram.inlinequeryresultcachedvideo.rst b/docs/source/telegram.inlinequeryresultcachedvideo.rst index 567b86b71..49efa7e89 100644 --- a/docs/source/telegram.inlinequeryresultcachedvideo.rst +++ b/docs/source/telegram.inlinequeryresultcachedvideo.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedvideo.py - telegram.InlineQueryResultCachedVideo ===================================== diff --git a/docs/source/telegram.inlinequeryresultcachedvoice.rst b/docs/source/telegram.inlinequeryresultcachedvoice.rst index c26bf1872..88a5377c8 100644 --- a/docs/source/telegram.inlinequeryresultcachedvoice.rst +++ b/docs/source/telegram.inlinequeryresultcachedvoice.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcachedvoice.py - telegram.InlineQueryResultCachedVoice ===================================== diff --git a/docs/source/telegram.inlinequeryresultcontact.rst b/docs/source/telegram.inlinequeryresultcontact.rst index cd40f9fe8..017ccfbca 100644 --- a/docs/source/telegram.inlinequeryresultcontact.rst +++ b/docs/source/telegram.inlinequeryresultcontact.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultcontact.py - telegram.InlineQueryResultContact ================================= diff --git a/docs/source/telegram.inlinequeryresultdocument.rst b/docs/source/telegram.inlinequeryresultdocument.rst index 7cdd4601f..ec8542260 100644 --- a/docs/source/telegram.inlinequeryresultdocument.rst +++ b/docs/source/telegram.inlinequeryresultdocument.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultdocument.py - telegram.InlineQueryResultDocument ================================== diff --git a/docs/source/telegram.inlinequeryresultgame.rst b/docs/source/telegram.inlinequeryresultgame.rst index dbc57c9de..7c6172d80 100644 --- a/docs/source/telegram.inlinequeryresultgame.rst +++ b/docs/source/telegram.inlinequeryresultgame.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultgame.py - telegram.InlineQueryResultGame ============================== diff --git a/docs/source/telegram.inlinequeryresultgif.rst b/docs/source/telegram.inlinequeryresultgif.rst index eb02ae709..a9c60f143 100644 --- a/docs/source/telegram.inlinequeryresultgif.rst +++ b/docs/source/telegram.inlinequeryresultgif.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultgif.py - telegram.InlineQueryResultGif ============================= diff --git a/docs/source/telegram.inlinequeryresultlocation.rst b/docs/source/telegram.inlinequeryresultlocation.rst index 49622306a..37980636d 100644 --- a/docs/source/telegram.inlinequeryresultlocation.rst +++ b/docs/source/telegram.inlinequeryresultlocation.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultlocation.py - telegram.InlineQueryResultLocation ================================== diff --git a/docs/source/telegram.inlinequeryresultmpeg4gif.rst b/docs/source/telegram.inlinequeryresultmpeg4gif.rst index 72d87c822..ad7e12d47 100644 --- a/docs/source/telegram.inlinequeryresultmpeg4gif.rst +++ b/docs/source/telegram.inlinequeryresultmpeg4gif.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultmpeg4gif.py - telegram.InlineQueryResultMpeg4Gif ================================== diff --git a/docs/source/telegram.inlinequeryresultphoto.rst b/docs/source/telegram.inlinequeryresultphoto.rst index 9e6edd7f4..40a9f63c3 100644 --- a/docs/source/telegram.inlinequeryresultphoto.rst +++ b/docs/source/telegram.inlinequeryresultphoto.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultphoto.py - telegram.InlineQueryResultPhoto =============================== diff --git a/docs/source/telegram.inlinequeryresultvenue.rst b/docs/source/telegram.inlinequeryresultvenue.rst index 50e026353..4378ed478 100644 --- a/docs/source/telegram.inlinequeryresultvenue.rst +++ b/docs/source/telegram.inlinequeryresultvenue.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultvenue.py - telegram.InlineQueryResultVenue =============================== diff --git a/docs/source/telegram.inlinequeryresultvideo.rst b/docs/source/telegram.inlinequeryresultvideo.rst index d760dda18..3cb445fd0 100644 --- a/docs/source/telegram.inlinequeryresultvideo.rst +++ b/docs/source/telegram.inlinequeryresultvideo.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultvideo.py - telegram.InlineQueryResultVideo =============================== diff --git a/docs/source/telegram.inlinequeryresultvoice.rst b/docs/source/telegram.inlinequeryresultvoice.rst index 2e7c139b3..e3efd0717 100644 --- a/docs/source/telegram.inlinequeryresultvoice.rst +++ b/docs/source/telegram.inlinequeryresultvoice.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inlinequeryresultvoice.py - telegram.InlineQueryResultVoice =============================== diff --git a/docs/source/telegram.inputcontactmessagecontent.rst b/docs/source/telegram.inputcontactmessagecontent.rst index d26eaebc3..3a98e7e98 100644 --- a/docs/source/telegram.inputcontactmessagecontent.rst +++ b/docs/source/telegram.inputcontactmessagecontent.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inputcontactmessagecontent.py - telegram.InputContactMessageContent =================================== diff --git a/docs/source/telegram.inputfile.rst b/docs/source/telegram.inputfile.rst index 7462feff4..cd55a869c 100644 --- a/docs/source/telegram.inputfile.rst +++ b/docs/source/telegram.inputfile.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputfile.py - telegram.InputFile ================== diff --git a/docs/source/telegram.inputinvoicemessagecontent.rst b/docs/source/telegram.inputinvoicemessagecontent.rst index 071d43109..f19f8c6da 100644 --- a/docs/source/telegram.inputinvoicemessagecontent.rst +++ b/docs/source/telegram.inputinvoicemessagecontent.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inputinvoicemessagecontent.py - telegram.InputInvoiceMessageContent =================================== diff --git a/docs/source/telegram.inputlocationmessagecontent.rst b/docs/source/telegram.inputlocationmessagecontent.rst index 40db11ceb..b5bc314e2 100644 --- a/docs/source/telegram.inputlocationmessagecontent.rst +++ b/docs/source/telegram.inputlocationmessagecontent.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inputlocationmessagecontent.py - telegram.InputLocationMessageContent ==================================== diff --git a/docs/source/telegram.inputmedia.rst b/docs/source/telegram.inputmedia.rst index 5d3e96cf1..26b9d76eb 100644 --- a/docs/source/telegram.inputmedia.rst +++ b/docs/source/telegram.inputmedia.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py - telegram.InputMedia =================== diff --git a/docs/source/telegram.inputmediaanimation.rst b/docs/source/telegram.inputmediaanimation.rst index ca0f302bf..b94711b06 100644 --- a/docs/source/telegram.inputmediaanimation.rst +++ b/docs/source/telegram.inputmediaanimation.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py - telegram.InputMediaAnimation ============================ diff --git a/docs/source/telegram.inputmediaaudio.rst b/docs/source/telegram.inputmediaaudio.rst index 9340ae86e..5a7a977fc 100644 --- a/docs/source/telegram.inputmediaaudio.rst +++ b/docs/source/telegram.inputmediaaudio.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py - telegram.InputMediaAudio ======================== diff --git a/docs/source/telegram.inputmediadocument.rst b/docs/source/telegram.inputmediadocument.rst index 7fa547ded..746b15f9a 100644 --- a/docs/source/telegram.inputmediadocument.rst +++ b/docs/source/telegram.inputmediadocument.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py - telegram.InputMediaDocument =========================== diff --git a/docs/source/telegram.inputmediaphoto.rst b/docs/source/telegram.inputmediaphoto.rst index 11dc5e99d..07bfe307f 100644 --- a/docs/source/telegram.inputmediaphoto.rst +++ b/docs/source/telegram.inputmediaphoto.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py - telegram.InputMediaPhoto ======================== diff --git a/docs/source/telegram.inputmediavideo.rst b/docs/source/telegram.inputmediavideo.rst index 6f6a12880..af28e4667 100644 --- a/docs/source/telegram.inputmediavideo.rst +++ b/docs/source/telegram.inputmediavideo.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/inputmedia.py - telegram.InputMediaVideo ======================== diff --git a/docs/source/telegram.inputmessagecontent.rst b/docs/source/telegram.inputmessagecontent.rst index 26efa6063..374510996 100644 --- a/docs/source/telegram.inputmessagecontent.rst +++ b/docs/source/telegram.inputmessagecontent.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inputmessagecontent.py - telegram.InputMessageContent ============================ diff --git a/docs/source/telegram.inputtextmessagecontent.rst b/docs/source/telegram.inputtextmessagecontent.rst index 992f02eed..88d7972f4 100644 --- a/docs/source/telegram.inputtextmessagecontent.rst +++ b/docs/source/telegram.inputtextmessagecontent.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inputtextmessagecontent.py - telegram.InputTextMessageContent ================================ diff --git a/docs/source/telegram.inputvenuemessagecontent.rst b/docs/source/telegram.inputvenuemessagecontent.rst index ba91631e1..009a39920 100644 --- a/docs/source/telegram.inputvenuemessagecontent.rst +++ b/docs/source/telegram.inputvenuemessagecontent.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/inline/inputvenuemessagecontent.py - telegram.InputVenueMessageContent ================================= diff --git a/docs/source/telegram.invoice.rst b/docs/source/telegram.invoice.rst index f5af48a06..f38c4e6c7 100644 --- a/docs/source/telegram.invoice.rst +++ b/docs/source/telegram.invoice.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/invoice.py - telegram.Invoice ================ diff --git a/docs/source/telegram.keyboardbutton.rst b/docs/source/telegram.keyboardbutton.rst index ccb5b508b..cec3de5d7 100644 --- a/docs/source/telegram.keyboardbutton.rst +++ b/docs/source/telegram.keyboardbutton.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/keyboardbutton.py - telegram.KeyboardButton ======================= diff --git a/docs/source/telegram.keyboardbuttonpolltype.rst b/docs/source/telegram.keyboardbuttonpolltype.rst index 1c4ef7f2d..fa4315abd 100644 --- a/docs/source/telegram.keyboardbuttonpolltype.rst +++ b/docs/source/telegram.keyboardbuttonpolltype.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/keyboardbuttonpolltype.py - telegram.KeyboardButtonPollType =============================== diff --git a/docs/source/telegram.labeledprice.rst b/docs/source/telegram.labeledprice.rst index 046cde062..7c9d5668a 100644 --- a/docs/source/telegram.labeledprice.rst +++ b/docs/source/telegram.labeledprice.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/labeledprice.py - telegram.LabeledPrice ===================== diff --git a/docs/source/telegram.location.rst b/docs/source/telegram.location.rst index 22effdd0b..7d3a62c21 100644 --- a/docs/source/telegram.location.rst +++ b/docs/source/telegram.location.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/location.py - telegram.Location ================= diff --git a/docs/source/telegram.loginurl.rst b/docs/source/telegram.loginurl.rst index 2a39d661e..3f8324d95 100644 --- a/docs/source/telegram.loginurl.rst +++ b/docs/source/telegram.loginurl.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/loginurl.py - telegram.LoginUrl ================= diff --git a/docs/source/telegram.maskposition.rst b/docs/source/telegram.maskposition.rst index f54fb5ea5..d38bb3445 100644 --- a/docs/source/telegram.maskposition.rst +++ b/docs/source/telegram.maskposition.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/sticker.py - telegram.MaskPosition ===================== diff --git a/docs/source/telegram.message.rst b/docs/source/telegram.message.rst index 91e3fe39a..97259744c 100644 --- a/docs/source/telegram.message.rst +++ b/docs/source/telegram.message.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/message.py - telegram.Message ================ diff --git a/docs/source/telegram.messageautodeletetimerchanged.rst b/docs/source/telegram.messageautodeletetimerchanged.rst index 3553f7d9f..ae1fd5472 100644 --- a/docs/source/telegram.messageautodeletetimerchanged.rst +++ b/docs/source/telegram.messageautodeletetimerchanged.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/messageautodeletetimerchanged.py - telegram.MessageAutoDeleteTimerChanged ====================================== diff --git a/docs/source/telegram.messageentity.rst b/docs/source/telegram.messageentity.rst index a9a9c421e..9e3fce97b 100644 --- a/docs/source/telegram.messageentity.rst +++ b/docs/source/telegram.messageentity.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/messageentity.py - telegram.MessageEntity ====================== diff --git a/docs/source/telegram.messageid.rst b/docs/source/telegram.messageid.rst index 1fb908661..9df1de2a1 100644 --- a/docs/source/telegram.messageid.rst +++ b/docs/source/telegram.messageid.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/messageid.py - telegram.MessageId ================== diff --git a/docs/source/telegram.orderinfo.rst b/docs/source/telegram.orderinfo.rst index 981768981..28741db79 100644 --- a/docs/source/telegram.orderinfo.rst +++ b/docs/source/telegram.orderinfo.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/orderinfo.py - telegram.OrderInfo ================== diff --git a/docs/source/telegram.passportdata.rst b/docs/source/telegram.passportdata.rst index 92b033e40..43a33b560 100644 --- a/docs/source/telegram.passportdata.rst +++ b/docs/source/telegram.passportdata.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportdata.py - telegram.PassportData ===================== diff --git a/docs/source/telegram.passportelementerror.rst b/docs/source/telegram.passportelementerror.rst index b431f05d8..00ef430d7 100644 --- a/docs/source/telegram.passportelementerror.rst +++ b/docs/source/telegram.passportelementerror.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py - telegram.PassportElementError ============================= diff --git a/docs/source/telegram.passportelementerrordatafield.rst b/docs/source/telegram.passportelementerrordatafield.rst index 8868e6b15..ac304f7b5 100644 --- a/docs/source/telegram.passportelementerrordatafield.rst +++ b/docs/source/telegram.passportelementerrordatafield.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py - telegram.PassportElementErrorDataField ====================================== diff --git a/docs/source/telegram.passportelementerrorfile.rst b/docs/source/telegram.passportelementerrorfile.rst index cb7432330..339d7a786 100644 --- a/docs/source/telegram.passportelementerrorfile.rst +++ b/docs/source/telegram.passportelementerrorfile.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py - telegram.PassportElementErrorFile ================================= diff --git a/docs/source/telegram.passportelementerrorfiles.rst b/docs/source/telegram.passportelementerrorfiles.rst index a6ed2e4a1..f9643d969 100644 --- a/docs/source/telegram.passportelementerrorfiles.rst +++ b/docs/source/telegram.passportelementerrorfiles.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py - telegram.PassportElementErrorFiles ================================== diff --git a/docs/source/telegram.passportelementerrorfrontside.rst b/docs/source/telegram.passportelementerrorfrontside.rst index 3e57cf2cd..a92635a27 100644 --- a/docs/source/telegram.passportelementerrorfrontside.rst +++ b/docs/source/telegram.passportelementerrorfrontside.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py - telegram.PassportElementErrorFrontSide ====================================== diff --git a/docs/source/telegram.passportelementerrorreverseside.rst b/docs/source/telegram.passportelementerrorreverseside.rst index 089eaffb0..380a10664 100644 --- a/docs/source/telegram.passportelementerrorreverseside.rst +++ b/docs/source/telegram.passportelementerrorreverseside.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py - telegram.PassportElementErrorReverseSide ======================================== diff --git a/docs/source/telegram.passportelementerrorselfie.rst b/docs/source/telegram.passportelementerrorselfie.rst index a29b72f5b..e79c2d8e3 100644 --- a/docs/source/telegram.passportelementerrorselfie.rst +++ b/docs/source/telegram.passportelementerrorselfie.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py - telegram.PassportElementErrorSelfie ======================================== diff --git a/docs/source/telegram.passportelementerrortranslationfile.rst b/docs/source/telegram.passportelementerrortranslationfile.rst index df48052ec..f195552cc 100644 --- a/docs/source/telegram.passportelementerrortranslationfile.rst +++ b/docs/source/telegram.passportelementerrortranslationfile.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py - telegram.PassportElementErrorTranslationFile ============================================ diff --git a/docs/source/telegram.passportelementerrortranslationfiles.rst b/docs/source/telegram.passportelementerrortranslationfiles.rst index 50c59a4df..0a01244bb 100644 --- a/docs/source/telegram.passportelementerrortranslationfiles.rst +++ b/docs/source/telegram.passportelementerrortranslationfiles.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py - telegram.PassportElementErrorTranslationFiles ============================================= diff --git a/docs/source/telegram.passportelementerrorunspecified.rst b/docs/source/telegram.passportelementerrorunspecified.rst index cca808144..aa5ce87ac 100644 --- a/docs/source/telegram.passportelementerrorunspecified.rst +++ b/docs/source/telegram.passportelementerrorunspecified.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportelementerrors.py - telegram.PassportElementErrorUnspecified ======================================== diff --git a/docs/source/telegram.passportfile.rst b/docs/source/telegram.passportfile.rst index e5577215e..a2af1c5f6 100644 --- a/docs/source/telegram.passportfile.rst +++ b/docs/source/telegram.passportfile.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/passportfile.py - telegram.PassportFile ===================== diff --git a/docs/source/telegram.personaldetails.rst b/docs/source/telegram.personaldetails.rst index 7a072b51c..145769f23 100644 --- a/docs/source/telegram.personaldetails.rst +++ b/docs/source/telegram.personaldetails.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/data.py - telegram.PersonalDetails ======================== diff --git a/docs/source/telegram.photosize.rst b/docs/source/telegram.photosize.rst index b71eefc70..978daa364 100644 --- a/docs/source/telegram.photosize.rst +++ b/docs/source/telegram.photosize.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/photosize.py - telegram.PhotoSize ================== .. Also lists methods of _BaseThumbedMedium, but not the ones of TelegramObject diff --git a/docs/source/telegram.poll.rst b/docs/source/telegram.poll.rst index ed401d707..cd369a027 100644 --- a/docs/source/telegram.poll.rst +++ b/docs/source/telegram.poll.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/poll.py - telegram.Poll ============= diff --git a/docs/source/telegram.pollanswer.rst b/docs/source/telegram.pollanswer.rst index a72a89340..b74899ebf 100644 --- a/docs/source/telegram.pollanswer.rst +++ b/docs/source/telegram.pollanswer.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/poll.py - telegram.PollAnswer =================== diff --git a/docs/source/telegram.polloption.rst b/docs/source/telegram.polloption.rst index 02663e932..53a6cd69e 100644 --- a/docs/source/telegram.polloption.rst +++ b/docs/source/telegram.polloption.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/poll.py - telegram.PollOption =================== diff --git a/docs/source/telegram.precheckoutquery.rst b/docs/source/telegram.precheckoutquery.rst index 2bac6fa57..1b3893981 100644 --- a/docs/source/telegram.precheckoutquery.rst +++ b/docs/source/telegram.precheckoutquery.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/precheckoutquery.py - telegram.PreCheckoutQuery ========================= diff --git a/docs/source/telegram.proximityalerttriggered.rst b/docs/source/telegram.proximityalerttriggered.rst index 251f3a53f..ab01987ab 100644 --- a/docs/source/telegram.proximityalerttriggered.rst +++ b/docs/source/telegram.proximityalerttriggered.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/proximityalerttriggered.py - telegram.ProximityAlertTriggered ================================ diff --git a/docs/source/telegram.replykeyboardmarkup.rst b/docs/source/telegram.replykeyboardmarkup.rst index 87ff3af9f..8f55975ea 100644 --- a/docs/source/telegram.replykeyboardmarkup.rst +++ b/docs/source/telegram.replykeyboardmarkup.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/replykeyboardmarkup.py - telegram.ReplyKeyboardMarkup ============================ diff --git a/docs/source/telegram.replykeyboardremove.rst b/docs/source/telegram.replykeyboardremove.rst index 7e7235b0c..0f318d2ca 100644 --- a/docs/source/telegram.replykeyboardremove.rst +++ b/docs/source/telegram.replykeyboardremove.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/replykeyboardremove.py - telegram.ReplyKeyboardRemove ============================ diff --git a/docs/source/telegram.request.baserequest.rst b/docs/source/telegram.request.baserequest.rst index 4ab11dbb7..9280772e2 100644 --- a/docs/source/telegram.request.baserequest.rst +++ b/docs/source/telegram.request.baserequest.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/request/_baserequest.py - telegram.request.BaseRequest ============================ diff --git a/docs/source/telegram.request.httpxrequest.rst b/docs/source/telegram.request.httpxrequest.rst index 676f3d1d1..8d33a943a 100644 --- a/docs/source/telegram.request.httpxrequest.rst +++ b/docs/source/telegram.request.httpxrequest.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/request/_httpxrequest.py - telegram.request.HTTPXRequest ============================= diff --git a/docs/source/telegram.request.requestdata.rst b/docs/source/telegram.request.requestdata.rst index f020347bd..e5d4e76a7 100644 --- a/docs/source/telegram.request.requestdata.rst +++ b/docs/source/telegram.request.requestdata.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/request/_requestdata.py - telegram.request.RequestData ============================ diff --git a/docs/source/telegram.request.rst b/docs/source/telegram.request.rst index 5279a8af1..0b9528ec5 100644 --- a/docs/source/telegram.request.rst +++ b/docs/source/telegram.request.rst @@ -1,9 +1,7 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/request - telegram.request Module ======================= -.. versionadded:: 14.0 +.. versionadded:: 20.0 .. toctree:: telegram.request.baserequest diff --git a/docs/source/telegram.residentialaddress.rst b/docs/source/telegram.residentialaddress.rst index 6243af42c..95be56963 100644 --- a/docs/source/telegram.residentialaddress.rst +++ b/docs/source/telegram.residentialaddress.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/data.py - telegram.ResidentialAddress =========================== diff --git a/docs/source/telegram.rst b/docs/source/telegram.rst index cd4805729..8b6fa05fe 100644 --- a/docs/source/telegram.rst +++ b/docs/source/telegram.rst @@ -175,14 +175,3 @@ Passport telegram.passportfile telegram.encryptedpassportelement telegram.encryptedcredentials - -Auxiliary modules ------------------ - -.. toctree:: - - telegram.constants - telegram.error - telegram.helpers - telegram.request - telegram.warnings diff --git a/docs/source/telegram.securedata.rst b/docs/source/telegram.securedata.rst index 29091caa2..ec24c8c4c 100644 --- a/docs/source/telegram.securedata.rst +++ b/docs/source/telegram.securedata.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/credentials.py - telegram.SecureData =================== diff --git a/docs/source/telegram.securevalue.rst b/docs/source/telegram.securevalue.rst index f9ca37a3b..ba756a2cc 100644 --- a/docs/source/telegram.securevalue.rst +++ b/docs/source/telegram.securevalue.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/passport/credentials.py - telegram.SecureValue ==================== diff --git a/docs/source/telegram.shippingaddress.rst b/docs/source/telegram.shippingaddress.rst index c6cee4571..6b89c4f86 100644 --- a/docs/source/telegram.shippingaddress.rst +++ b/docs/source/telegram.shippingaddress.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/shippingaddress.py - telegram.ShippingAddress ======================== diff --git a/docs/source/telegram.shippingoption.rst b/docs/source/telegram.shippingoption.rst index 64024ba90..f0af54f85 100644 --- a/docs/source/telegram.shippingoption.rst +++ b/docs/source/telegram.shippingoption.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/shippingoption.py - telegram.ShippingOption ======================= diff --git a/docs/source/telegram.shippingquery.rst b/docs/source/telegram.shippingquery.rst index d2bf7889c..5e3c6fd13 100644 --- a/docs/source/telegram.shippingquery.rst +++ b/docs/source/telegram.shippingquery.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/shippingquery.py - telegram.ShippingQuery ====================== diff --git a/docs/source/telegram.sticker.rst b/docs/source/telegram.sticker.rst index 36c719398..24dc77d57 100644 --- a/docs/source/telegram.sticker.rst +++ b/docs/source/telegram.sticker.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/sticker.py - telegram.Sticker ================ diff --git a/docs/source/telegram.stickerset.rst b/docs/source/telegram.stickerset.rst index 1c0f77cb2..3705c2ef8 100644 --- a/docs/source/telegram.stickerset.rst +++ b/docs/source/telegram.stickerset.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/sticker.py - telegram.StickerSet =================== diff --git a/docs/source/telegram.successfulpayment.rst b/docs/source/telegram.successfulpayment.rst index c703bd692..43228b505 100644 --- a/docs/source/telegram.successfulpayment.rst +++ b/docs/source/telegram.successfulpayment.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/payment/successfulpayment.py - telegram.SuccessfulPayment ========================== diff --git a/docs/source/telegram.telegramobject.rst b/docs/source/telegram.telegramobject.rst index 422096fa2..61432be18 100644 --- a/docs/source/telegram.telegramobject.rst +++ b/docs/source/telegram.telegramobject.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/telegramobject.py - telegram.TelegramObject ======================= diff --git a/docs/source/telegram.update.rst b/docs/source/telegram.update.rst index e19fc411b..e03ef4bd3 100644 --- a/docs/source/telegram.update.rst +++ b/docs/source/telegram.update.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/update.py - telegram.Update =============== diff --git a/docs/source/telegram.user.rst b/docs/source/telegram.user.rst index 338631f01..e6d05c27a 100644 --- a/docs/source/telegram.user.rst +++ b/docs/source/telegram.user.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/user.py - telegram.User ============= diff --git a/docs/source/telegram.userprofilephotos.rst b/docs/source/telegram.userprofilephotos.rst index be0cd388e..8ca19882e 100644 --- a/docs/source/telegram.userprofilephotos.rst +++ b/docs/source/telegram.userprofilephotos.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/userprofilephotos.py - telegram.UserProfilePhotos ========================== diff --git a/docs/source/telegram.venue.rst b/docs/source/telegram.venue.rst index a0322f471..0cba4d0d1 100644 --- a/docs/source/telegram.venue.rst +++ b/docs/source/telegram.venue.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/venue.py - telegram.Venue ============== diff --git a/docs/source/telegram.video.rst b/docs/source/telegram.video.rst index 3cea04e11..18c607c4b 100644 --- a/docs/source/telegram.video.rst +++ b/docs/source/telegram.video.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/video.py - telegram.Video ============== diff --git a/docs/source/telegram.videonote.rst b/docs/source/telegram.videonote.rst index 0bf030418..937a76d2c 100644 --- a/docs/source/telegram.videonote.rst +++ b/docs/source/telegram.videonote.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/videonote.py - telegram.VideoNote ================== diff --git a/docs/source/telegram.voice.rst b/docs/source/telegram.voice.rst index 89b92cd5e..479a143aa 100644 --- a/docs/source/telegram.voice.rst +++ b/docs/source/telegram.voice.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/files/voice.py - telegram.Voice ============== diff --git a/docs/source/telegram.warnings.rst b/docs/source/telegram.warnings.rst index 10523ba07..7af6887b1 100644 --- a/docs/source/telegram.warnings.rst +++ b/docs/source/telegram.warnings.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/warnings.py - telegram.warnings Module ======================== diff --git a/docs/source/telegram.webhookinfo.rst b/docs/source/telegram.webhookinfo.rst index fabf0e6e7..233b76637 100644 --- a/docs/source/telegram.webhookinfo.rst +++ b/docs/source/telegram.webhookinfo.rst @@ -1,5 +1,3 @@ -:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/webhookinfo.py - telegram.WebhookInfo ==================== diff --git a/docs/source/telegram_auxil.rst b/docs/source/telegram_auxil.rst new file mode 100644 index 000000000..0a7d951e2 --- /dev/null +++ b/docs/source/telegram_auxil.rst @@ -0,0 +1,10 @@ +Auxiliary modules +================= + +.. toctree:: + + telegram.constants + telegram.error + telegram.helpers + telegram.request + telegram.warnings diff --git a/telegram/_bot.py b/telegram/_bot.py index 8dccb55e3..23f2659f5 100644 --- a/telegram/_bot.py +++ b/telegram/_bot.py @@ -149,7 +149,7 @@ class Bot(TelegramObject, AbstractAsyncContextManager): Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their :attr:`bot` is equal. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 * Removed the deprecated methods ``kick_chat_member``, ``kickChatMember``, ``get_chat_members_count`` and ``getChatMembersCount``. @@ -363,7 +363,9 @@ class Bot(TelegramObject, AbstractAsyncContextManager): cache :attr:`bot` and calls :meth:`telegram.request.BaseRequest.initialize` for the request objects used by this bot. - .. versionadded:: 14.0 + .. seealso:: :meth:`shutdown` + + .. versionadded:: 20.0 """ if self._initialized: self._logger.debug("This Bot is already initialized.") @@ -377,7 +379,9 @@ class Bot(TelegramObject, AbstractAsyncContextManager): """Stop & clear resources used by this class. Currently just calls :meth:`telegram.request.BaseRequest.shutdown` for the request objects used by this bot. - .. versionadded:: 14.0 + .. seealso:: :meth:`initialize` + + .. versionadded:: 20.0 """ if not self._initialized: self._logger.debug("This Bot is already shut down. Returning.") @@ -518,13 +522,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -601,13 +605,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -678,13 +682,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -749,13 +753,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -858,12 +862,12 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to ``20``. 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -997,12 +1001,12 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to ``20``. 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -1138,12 +1142,12 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to ``20``. 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -1240,12 +1244,12 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to ``20``. 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -1372,12 +1376,12 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to ``20``. 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -1504,12 +1508,12 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to ``20``. 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -1641,12 +1645,12 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to ``20``. 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -1773,12 +1777,12 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to ``20``. 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -1859,12 +1863,12 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to ``20``. 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -1962,13 +1966,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -2072,13 +2076,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -2156,13 +2160,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -2261,13 +2265,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -2382,13 +2386,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -2477,13 +2481,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -2539,13 +2543,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -2707,13 +2711,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -2789,13 +2793,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -2864,13 +2868,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -2937,13 +2941,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. until_date (:obj:`int` | :obj:`datetime.datetime`, optional): Date when the user will @@ -3014,13 +3018,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3075,13 +3079,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3135,13 +3139,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3210,13 +3214,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3296,13 +3300,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3383,13 +3387,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3469,13 +3473,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3544,13 +3548,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3621,13 +3625,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): read_timeout (:obj:`float`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to ``2``. :paramref:`timeout` will be added to this value. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + 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 + 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`. allowed_updates (List[:obj:`str`]), optional): A list the types of @@ -3743,13 +3747,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3821,13 +3825,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3875,13 +3879,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3928,13 +3932,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -3980,13 +3984,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4034,13 +4038,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4085,13 +4089,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4140,13 +4144,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4188,13 +4192,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4232,13 +4236,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4294,13 +4298,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4371,13 +4375,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4535,13 +4539,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4645,13 +4649,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4736,13 +4740,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4873,13 +4877,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -4982,13 +4986,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5061,13 +5065,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5117,13 +5121,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5171,13 +5175,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5243,13 +5247,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5336,7 +5340,7 @@ class Bot(TelegramObject, AbstractAsyncContextManager): of the target channel (in the format ``@channelusername``). invite_link (:obj:`str` | :obj:`telegram.ChatInviteLink`): The invite link to edit. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Now also accepts :obj:`telegram.ChatInviteLink` instances. expire_date (:obj:`int` | :obj:`datetime.datetime`, optional): Date when the link will expire. @@ -5348,13 +5352,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5431,18 +5435,18 @@ class Bot(TelegramObject, AbstractAsyncContextManager): of the target channel (in the format ``@channelusername``). invite_link (:obj:`str` | :obj:`telegram.ChatInviteLink`): The invite link to revoke. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Now also accepts :obj:`telegram.ChatInviteLink` instances. 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5495,13 +5499,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5552,13 +5556,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5610,13 +5614,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5662,13 +5666,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5716,13 +5720,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5770,13 +5774,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5832,13 +5836,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5893,13 +5897,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5950,13 +5954,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -5997,13 +6001,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6059,13 +6063,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6111,17 +6115,17 @@ class Bot(TelegramObject, AbstractAsyncContextManager): """ Use this method to create new sticker set owned by a user. The bot will be able to edit the created sticker set. - You must use exactly one of the fields ``png_sticker``, ``tgs_sticker``, or - ``webm_sticker``. + You must use exactly one of the fields :paramref:`png_sticker`, :paramref:`tgs_sticker`, or + :paramref:`webm_sticker`. Warning: - As of API 4.7 ``png_sticker`` is an optional argument and therefore the order of the - arguments had to be changed. Use keyword arguments to make sure that the arguments are - passed correctly. + As of API 4.7 :paramref:`png_sticker` is an optional argument and therefore the order + of the arguments had to be changed. Use keyword arguments to make sure that the + arguments are passed correctly. Note: - The png_sticker and tgs_sticker argument can be either a file_id, an URL or a file from - disk ``open(filename, 'rb')`` + The :paramref:`png_sticker` and :paramref:`tgs_sticker` argument can be either a + file_id, an URL or a file from disk ``open(filename, 'rb')`` Args: user_id (:obj:`int`): User identifier of created sticker set owner. @@ -6163,13 +6167,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6225,19 +6229,19 @@ class Bot(TelegramObject, AbstractAsyncContextManager): ) -> bool: """ Use this method to add a new sticker to a set created by the bot. - You **must** use exactly one of the fields ``png_sticker``, ``tgs_sticker`` or - ``webm_sticker``. Animated stickers can be added to animated sticker sets and only to them. - Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 - stickers. + You **must** use exactly one of the fields :paramref:`png_sticker`, :paramref:`tgs_sticker` + or :paramref:`webm_sticker`. Animated stickers can be added to animated sticker sets and + only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can + have up to 120 stickers. Warning: - As of API 4.7 ``png_sticker`` is an optional argument and therefore the order of the - arguments had to be changed. Use keyword arguments to make sure that the arguments are - passed correctly. + As of API 4.7 :paramref:`png_sticker` is an optional argument and therefore the order + of the arguments had to be changed. Use keyword arguments to make sure that the + arguments are passed correctly. Note: - The png_sticker and tgs_sticker argument can be either a file_id, an URL or a file from - disk ``open(filename, 'rb')`` + The :paramref:`png_sticker` and :paramref:`tgs_sticker` argument can be either a + file_id, an URL or a file from disk ``open(filename, 'rb')`` Args: user_id (:obj:`int`): User identifier of created sticker set owner. @@ -6272,13 +6276,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6333,13 +6337,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6381,13 +6385,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6429,7 +6433,8 @@ class Bot(TelegramObject, AbstractAsyncContextManager): only. Note: - The thumb can be either a file_id, an URL or a file from disk ``open(filename, 'rb')`` + The :paramref:`thumb` can be either a file_id, an URL or a file from disk + ``open(filename, 'rb')`` Args: name (:obj:`str`): Sticker set name @@ -6452,13 +6457,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6515,13 +6520,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6600,7 +6605,7 @@ class Bot(TelegramObject, AbstractAsyncContextManager): available modes. explanation_entities (List[:class:`telegram.MessageEntity`], optional): List of special entities that appear in message text, which can be specified instead of - :paramref:`parse_mode`. + :paramref:`explanation_parse_mode`. open_period (:obj:`int`, optional): Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with :paramref:`close_date`. close_date (:obj:`int` | :obj:`datetime.datetime`, optional): Point in time (Unix @@ -6629,13 +6634,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6713,13 +6718,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6800,13 +6805,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -6982,13 +6987,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -7055,13 +7060,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -7135,13 +7140,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the @@ -7192,13 +7197,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. @@ -7235,13 +7240,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. @@ -7317,13 +7322,13 @@ class Bot(TelegramObject, AbstractAsyncContextManager): 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 + 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 + 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`. api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the diff --git a/telegram/_chat.py b/telegram/_chat.py index 0e1b00055..216538fd8 100644 --- a/telegram/_chat.py +++ b/telegram/_chat.py @@ -65,7 +65,7 @@ class Chat(TelegramObject): Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their :attr:`id` is equal. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Removed the deprecated methods ``kick_member`` and ``get_members_count``. Args: @@ -1296,12 +1296,14 @@ class Chat(TelegramObject): For the documentation of the arguments, please see :meth:`telegram.Bot.send_invoice`. Warning: - As of API 5.2 :paramref:`start_parameter` is an optional argument and therefore the + As of API 5.2 :paramref:`start_parameter ` + is an optional argument and therefore the order of the arguments had to be changed. Use keyword arguments to make sure that the arguments are passed correctly. .. versionchanged:: 13.5 - As of Bot API 5.2, the parameter :paramref:`start_parameter` is optional. + As of Bot API 5.2, the parameter + :paramref:`start_parameter ` is optional. Returns: :class:`telegram.Message`: On success, instance representing the message posted. diff --git a/telegram/_chatinvitelink.py b/telegram/_chatinvitelink.py index 147d774f9..4b1aa58ce 100644 --- a/telegram/_chatinvitelink.py +++ b/telegram/_chatinvitelink.py @@ -37,7 +37,7 @@ class ChatInviteLink(TelegramObject): :attr:`is_primary` and :attr:`is_revoked` are equal. .. versionadded:: 13.4 - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 * The argument & attribute :attr:`creates_join_request` is now required to comply with the Bot API. diff --git a/telegram/_chatmember.py b/telegram/_chatmember.py index a5b013e27..0cd45cfcc 100644 --- a/telegram/_chatmember.py +++ b/telegram/_chatmember.py @@ -44,7 +44,7 @@ class ChatMember(TelegramObject): Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their :attr:`user` and :attr:`status` are equal. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 * As of Bot API 5.3, :class:`ChatMember` is nothing but the base class for the subclasses listed above and is no longer returned directly by :meth:`~telegram.Bot.get_chat`. Therefore, most of the arguments and attributes were removed and you should no longer diff --git a/telegram/_files/file.py b/telegram/_files/file.py index 172564142..16861f9f2 100644 --- a/telegram/_files/file.py +++ b/telegram/_files/file.py @@ -119,7 +119,7 @@ class File(TelegramObject): :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. - .. versionchanged:: 14.0 + .. 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 @@ -132,13 +132,13 @@ class File(TelegramObject): 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 + 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 + 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`. diff --git a/telegram/_files/inputfile.py b/telegram/_files/inputfile.py index f16f756b2..1d5e7f78b 100644 --- a/telegram/_files/inputfile.py +++ b/telegram/_files/inputfile.py @@ -34,7 +34,7 @@ logger = logging.getLogger(__name__) class InputFile: """This object represents a Telegram InputFile. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 The former attribute ``attach`` was renamed to :attr:`attach_name`. Args: @@ -45,7 +45,7 @@ class InputFile: If :paramref:`obj` is a string, it will be encoded as bytes via :external:obj:`obj.encode('utf-8') `. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Accept string input. filename (:obj:`str`, optional): Filename for this InputFile. attach (:obj:`bool`, optional): Pass :obj:`True` if the parameter this file belongs to in diff --git a/telegram/_files/inputmedia.py b/telegram/_files/inputmedia.py index c0bf92dda..68445c882 100644 --- a/telegram/_files/inputmedia.py +++ b/telegram/_files/inputmedia.py @@ -39,7 +39,7 @@ class InputMedia(TelegramObject): """ Base class for Telegram InputMedia Objects. - .. versionchanged:: 14.0: + .. versionchanged:: 20.0: Added arguments and attributes :attr:`type`, :attr:`media`, :attr:`caption`, :attr:`caption_entities`, :paramref:`parse_mode`. diff --git a/telegram/_forcereply.py b/telegram/_forcereply.py index 8beb3b798..8d14d468b 100644 --- a/telegram/_forcereply.py +++ b/telegram/_forcereply.py @@ -33,7 +33,7 @@ class ForceReply(TelegramObject): Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their :attr:`selective` is equal. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 The (undocumented) argument ``force_reply`` was removed and instead :attr:`force_reply` is now always set to :obj:`True` as expected by the Bot API. diff --git a/telegram/_inline/inlinequery.py b/telegram/_inline/inlinequery.py index 22e1b5491..dab3b3883 100644 --- a/telegram/_inline/inlinequery.py +++ b/telegram/_inline/inlinequery.py @@ -143,12 +143,14 @@ class InlineQuery(TelegramObject): For the documentation of the arguments, please see :meth:`telegram.Bot.answer_inline_query`. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Raises :class:`ValueError` instead of :class:`TypeError`. Args: auto_pagination (:obj:`bool`, optional): If set to :obj:`True`, :attr:`offset` will be - passed as :paramref:`current_offset` to :meth:`telegram.Bot.answer_inline_query`. + passed as + :paramref:`current_offset ` to + :meth:`telegram.Bot.answer_inline_query`. Defaults to :obj:`False`. Raises: @@ -181,5 +183,5 @@ class InlineQuery(TelegramObject): MAX_SWITCH_PM_TEXT_LENGTH: ClassVar[int] = constants.InlineQueryLimit.SWITCH_PM_TEXT_LENGTH """:const:`telegram.constants.InlineQueryLimit.SWITCH_PM_TEXT_LENGTH` - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ diff --git a/telegram/_message.py b/telegram/_message.py index c8e03b8de..73eae2083 100644 --- a/telegram/_message.py +++ b/telegram/_message.py @@ -684,7 +684,7 @@ class Message(TelegramObject): Otherwise :obj:`None` is returned. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 :attr:`dice`, :attr:`passport_data` and :attr:`poll` are now also considered to be an attachment. @@ -1905,14 +1905,16 @@ class Message(TelegramObject): For the documentation of the arguments, please see :meth:`telegram.Bot.send_invoice`. Warning: - As of API 5.2 :paramref:`start_parameter` is an optional argument and therefore the + As of API 5.2 :paramref:`start_parameter ` + is an optional argument and therefore the order of the arguments had to be changed. Use keyword arguments to make sure that the arguments are passed correctly. .. versionadded:: 13.2 .. versionchanged:: 13.5 - As of Bot API 5.2, the parameter :paramref:`start_parameter` is optional. + As of Bot API 5.2, the parameter + :paramref:`start_parameter ` is optional. Args: quote (:obj:`bool`, optional): If set to :obj:`True`, the invoice is sent as an actual diff --git a/telegram/_poll.py b/telegram/_poll.py index 971914a12..f48ae85d0 100644 --- a/telegram/_poll.py +++ b/telegram/_poll.py @@ -298,5 +298,5 @@ class Poll(TelegramObject): MAX_OPTION_NUMBER: ClassVar[int] = constants.PollLimit.OPTION_NUMBER """:const:`telegram.constants.PollLimit.OPTION_NUMBER` - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ diff --git a/telegram/_telegramobject.py b/telegram/_telegramobject.py index 2e56f7fac..57c8b84ea 100644 --- a/telegram/_telegramobject.py +++ b/telegram/_telegramobject.py @@ -48,7 +48,7 @@ class TelegramObject: assert telegram_object.get_bot() is copy.deepcopy(telegram_object).get_bot() - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 ``telegram_object['from']`` will look up the key ``from_user``. This is to account for special cases like :attr:`Message.from_user` that deviate from the official Bot API. """ @@ -231,7 +231,7 @@ class TelegramObject: .. seealso:: :meth:`set_bot` - .. versionadded: 14.0 + .. versionadded: 20.0 Raises: RuntimeError: If no :class:`telegram.Bot` instance was set for this object. @@ -247,7 +247,7 @@ class TelegramObject: .. seealso:: :meth:`get_bot` - .. versionadded: 14.0 + .. versionadded: 20.0 Arguments: bot (:class:`telegram.Bot` | :obj:`None`): The bot instance. diff --git a/telegram/_user.py b/telegram/_user.py index 823a3e4b3..91095e6e5 100644 --- a/telegram/_user.py +++ b/telegram/_user.py @@ -774,12 +774,14 @@ class User(TelegramObject): For the documentation of the arguments, please see :meth:`telegram.Bot.send_invoice`. Warning: - As of API 5.2 :paramref:`start_parameter` is an optional argument and therefore the + As of API 5.2 :paramref:`start_parameter ` + is an optional argument and therefore the order of the arguments had to be changed. Use keyword arguments to make sure that the arguments are passed correctly. .. versionchanged:: 13.5 - As of Bot API 5.2, the parameter :paramref:`start_parameter` is optional. + As of Bot API 5.2, the parameter + :paramref:`start_parameter ` is optional. Returns: :class:`telegram.Message`: On success, instance representing the message posted. diff --git a/telegram/_utils/datetime.py b/telegram/_utils/datetime.py index f46780eb2..647968136 100644 --- a/telegram/_utils/datetime.py +++ b/telegram/_utils/datetime.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains helper functions related to datetime and timestamp conversations. -.. versionchanged:: 14.0 +.. versionchanged:: 20.0 Previously, the contents of this module were available through the (no longer existing) module ``telegram._utils.helpers``. diff --git a/telegram/_utils/defaultvalue.py b/telegram/_utils/defaultvalue.py index 11809e810..47545e3b8 100644 --- a/telegram/_utils/defaultvalue.py +++ b/telegram/_utils/defaultvalue.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the DefaultValue class. -.. versionchanged:: 14.0 +.. versionchanged:: 20.0 Previously, the contents of this module were available through the (no longer existing) module ``telegram._utils.helpers``. @@ -131,7 +131,7 @@ DEFAULT_FALSE: DefaultValue = DefaultValue(False) DEFAULT_TRUE: DefaultValue = DefaultValue(True) """:class:`DefaultValue`: Default :obj:`True` -.. versionadded:: 14.0 +.. versionadded:: 20.0 """ DEFAULT_20: DefaultValue = DefaultValue(20) diff --git a/telegram/_utils/files.py b/telegram/_utils/files.py index 1452e3546..045973d69 100644 --- a/telegram/_utils/files.py +++ b/telegram/_utils/files.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains helper functions related to handling of files. -.. versionchanged:: 14.0 +.. versionchanged:: 20.0 Previously, the contents of this module were available through the (no longer existing) module ``telegram._utils.helpers``. diff --git a/telegram/_utils/markup.py b/telegram/_utils/markup.py index 776cda57a..888937ba6 100644 --- a/telegram/_utils/markup.py +++ b/telegram/_utils/markup.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains a helper function for Telegram's ReplyMarkups -.. versionchanged:: 14.0 +.. versionchanged:: 20.0 Previously, the contents of this module were available through the (no longer existing) class ``telegram.ReplyMarkup``. diff --git a/telegram/_utils/types.py b/telegram/_utils/types.py index e3a736219..9be4d81bc 100644 --- a/telegram/_utils/types.py +++ b/telegram/_utils/types.py @@ -62,7 +62,7 @@ ReplyMarkup = Union[ ] """Type alias for reply markup objects. -.. versionadded:: 14.0 +.. versionadded:: 20.0 """ FieldTuple = Tuple[str, bytes, str] diff --git a/telegram/_utils/warnings.py b/telegram/_utils/warnings.py index afdd5827a..82c5a3aff 100644 --- a/telegram/_utils/warnings.py +++ b/telegram/_utils/warnings.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains helper functions related to warnings issued by the library. -.. versionadded:: 14.0 +.. versionadded:: 20.0 Warning: Contents of this module are intended to be used internally by the library and *not* by the @@ -35,7 +35,7 @@ def warn(message: str, category: Type[Warning] = PTBUserWarning, stacklevel: int """ Helper function used as a shortcut for warning with default values. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Args: message (:obj:`str`): Specify the warnings message to pass to ``warnings.warn()``. diff --git a/telegram/constants.py b/telegram/constants.py index 0af34f4d1..9f08973fb 100644 --- a/telegram/constants.py +++ b/telegram/constants.py @@ -20,8 +20,8 @@ Unless noted otherwise, all constants in this module were extracted from the `Telegram Bots FAQ `_ and `Telegram Bots API `_. -.. versionchanged:: 14.0 - Since v14.0, most of the constants in this module are grouped into enums. +.. versionchanged:: 20.0 + Since v20.0, most of the constants in this module are grouped into enums. Attributes: BOT_API_VERSION (:obj:`str`): :tg-const:`telegram.constants.BOT_API_VERSION`. Telegram Bot API @@ -81,7 +81,7 @@ class BotCommandScopeType(StringEnum): """This enum contains the available types of :class:`telegram.BotCommandScope`. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -107,7 +107,7 @@ class CallbackQueryLimit(IntEnum): :meth:`telegram.Bot.answer_callback_query`. The enum members of this enumeration are instances of :class:`int` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -121,7 +121,7 @@ class ChatAction(StringEnum): """This enum contains the available chat actions for :meth:`telegram.Bot.send_chat_action`. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -154,7 +154,7 @@ class ChatID(IntEnum): """This enum contains some special chat IDs. The enum members of this enumeration are instances of :class:`int` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -189,7 +189,7 @@ class ChatInviteLinkLimit(IntEnum): :meth:`telegram.Bot.create_chat_invite_link`/:meth:`telegram.Bot.edit_chat_invite_link`. The enum members of this enumeration are instances of :class:`int` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -206,7 +206,7 @@ class ChatMemberStatus(StringEnum): """This enum contains the available states for :class:`telegram.ChatMember`. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -229,7 +229,7 @@ class ChatType(StringEnum): """This enum contains the available types of :class:`telegram.Chat`. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -252,7 +252,7 @@ class DiceEmoji(StringEnum): :meth:`telegram.Bot.send_dice`. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -275,7 +275,7 @@ class FileSizeLimit(IntEnum): """This enum contains limitations regarding the upload and download of files. The enum members of this enumeration are instances of :class:`int` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -292,7 +292,7 @@ class FloodLimit(IntEnum): """This enum contains limitations regarding flood limits. The enum members of this enumeration are instances of :class:`int` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -317,7 +317,7 @@ class InlineKeyboardMarkupLimit(IntEnum): :meth:`telegram.Bot.send_message` & friends. The enum members of this enumeration are instances of :class:`int` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -340,7 +340,7 @@ class InputMediaType(StringEnum): """This enum contains the available types of :class:`telegram.InputMedia`. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -362,7 +362,7 @@ class InlineQueryLimit(IntEnum): :meth:`telegram.Bot.answer_inline_query`. The enum members of this enumeration are instances of :class:`int` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -379,7 +379,7 @@ class InlineQueryResultType(StringEnum): """This enum contains the available types of :class:`telegram.InlineQueryResult`. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -431,7 +431,7 @@ class LocationLimit(IntEnum): :meth:`telegram.Bot.send_location`. The enum members of this enumeration are instances of :class:`int` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -453,7 +453,7 @@ class MaskPosition(StringEnum): """This enum contains the available positions for :class:`telegram.MaskPosition`. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -490,7 +490,7 @@ class MessageAttachmentType(StringEnum): as attachment. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -538,7 +538,7 @@ class MessageEntityType(StringEnum): """This enum contains the available types of :class:`telegram.MessageEntity`. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -582,7 +582,7 @@ class MessageLimit(IntEnum): :meth:`telegram.Bot.send_message` & friends. The enum members of this enumeration are instances of :class:`int` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -606,7 +606,7 @@ class MessageType(StringEnum): as attachment. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -692,7 +692,7 @@ class ParseMode(StringEnum): """This enum contains the available parse modes. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -715,7 +715,7 @@ class PollLimit(IntEnum): :meth:`telegram.Bot.send_poll`. The enum members of this enumeration are instances of :class:`int` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -733,7 +733,7 @@ class PollType(StringEnum): :meth:`telegram.Bot.send_poll`. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -748,7 +748,7 @@ class UpdateType(StringEnum): """This enum contains the available types of :class:`telegram.Update`. The enum members of this enumeration are instances of :class:`str` and can be treated as such. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () diff --git a/telegram/error.py b/telegram/error.py index 4a9e6524a..979585617 100644 --- a/telegram/error.py +++ b/telegram/error.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains classes that represent Telegram errors. -.. versionchanged:: 14.0 +.. versionchanged:: 20.0 Replaced ``Unauthorized`` by :class:`Forbidden`. """ @@ -84,7 +84,7 @@ class TelegramError(Exception): class Forbidden(TelegramError): """Raised when the bot has not enough rights to perform the requested action. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 This class was previously named ``Unauthorized``. """ @@ -97,7 +97,7 @@ class InvalidToken(TelegramError): Args: message (:obj:`str`, optional): Any additional information about the exception. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = ("_message",) @@ -128,7 +128,7 @@ class TimedOut(NetworkError): Args: message (:obj:`str`, optional): Any additional information about the exception. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -187,7 +187,7 @@ class Conflict(TelegramError): class PassportDecryptionError(TelegramError): """Something went wrong with decryption. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 This class was previously named ``TelegramDecryptionError`` and was available via ``telegram.TelegramDecryptionError``. """ diff --git a/telegram/ext/_application.py b/telegram/ext/_application.py index 7f2869505..febfd97ad 100644 --- a/telegram/ext/_application.py +++ b/telegram/ext/_application.py @@ -133,7 +133,7 @@ class Application(Generic[BT, CCT, UD, CD, BD, JQ], AbstractAsyncContextManager) finally: await application.shutdown() - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 * Initialization is now done through the :class:`telegram.ext.ApplicationBuilder`. * Removed the attribute ``groups``. @@ -148,7 +148,7 @@ class Application(Generic[BT, CCT, UD, CD, BD, JQ], AbstractAsyncContextManager) chat_data (:obj:`types.MappingProxyType`): A dictionary handlers can use to store data for the chat. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 :attr:`chat_data` is now read-only .. tip:: @@ -157,7 +157,7 @@ class Application(Generic[BT, CCT, UD, CD, BD, JQ], AbstractAsyncContextManager) user_data (:obj:`types.MappingProxyType`): A dictionary handlers can use to store data for the user. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 :attr:`user_data` is now read-only .. tip:: @@ -426,7 +426,7 @@ class Application(Generic[BT, CCT, UD, CD, BD, JQ], AbstractAsyncContextManager) def builder() -> "InitApplicationBuilder": """Convenience method. Returns a new :class:`telegram.ext.ApplicationBuilder`. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ # Unfortunately this needs to be here due to cyclical imports from telegram.ext import ApplicationBuilder # pylint: disable=import-outside-toplevel @@ -575,13 +575,13 @@ class Application(Generic[BT, CCT, UD, CD, BD, JQ], AbstractAsyncContextManager) read_timeout (:obj:`float`, optional): Value to pass to :paramref:`telegram.Bot.get_updates.read_timeout`. Defaults to ``2``. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.Bot.get_updates.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.Bot.get_updates.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.Bot.get_updates.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. drop_pending_updates (:obj:`bool`, optional): Whether to clean any pending updates on @@ -906,7 +906,7 @@ class Application(Generic[BT, CCT, UD, CD, BD, JQ], AbstractAsyncContextManager) """Processes a single update and marks the update to be updated by the persistence later. Exceptions raised by handler callbacks will be processed by :meth:`process_update`. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Persistence is now updated in an interval set by :attr:`telegram.ext.BasePersistence.update_interval`. @@ -1033,7 +1033,7 @@ class Application(Generic[BT, CCT, UD, CD, BD, JQ], AbstractAsyncContextManager) """Registers multiple handlers at once. The order of the handlers in the passed sequence(s) matters. See :meth:`add_handler` for details. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Args: handlers (List[:class:`telegram.ext.Handler`] | \ @@ -1090,12 +1090,12 @@ class Application(Generic[BT, CCT, UD, CD, BD, JQ], AbstractAsyncContextManager) the persistence on the next run of :meth:`update_persistence`, if applicable. Warning: - When using :paramref:`concurrent_updates` or the :attr:`job_queue`, + When using :attr:`concurrent_updates` or the :attr:`job_queue`, :meth:`process_update` or :meth:`telegram.ext.Job.run` may re-create this entry due to the asynchronous nature of these features. Please make sure that your program can avoid or handle such situations. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Args: chat_id (:obj:`int`): The chat id to delete. The entry will be deleted even if it is @@ -1109,12 +1109,12 @@ class Application(Generic[BT, CCT, UD, CD, BD, JQ], AbstractAsyncContextManager) the persistence on the next run of :meth:`update_persistence`, if applicable. Warning: - When using :paramref:`concurrent_updates` or the :attr:`job_queue`, + When using :attr:`concurrent_updates` or the :attr:`job_queue`, :meth:`process_update` or :meth:`telegram.ext.Job.run` may re-create this entry due to the asynchronous nature of these features. Please make sure that your program can avoid or handle such situations. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Args: user_id (:obj:`int`): The user id to delete. The entry will be deleted even if it is @@ -1400,7 +1400,7 @@ class Application(Generic[BT, CCT, UD, CD, BD, JQ], AbstractAsyncContextManager) (even in other groups) will handle the update. All other exceptions raised by an error handler will just be logged. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 * ``dispatch_error`` was renamed to :meth:`process_error`. * Exceptions raised by error handlers are now properly logged. @@ -1412,7 +1412,7 @@ class Application(Generic[BT, CCT, UD, CD, BD, JQ], AbstractAsyncContextManager) error (:obj:`Exception`): The error that was raised. job (:class:`telegram.ext.Job`, optional): The job that caused the error. - .. versionadded:: 14.0 + .. versionadded:: 20.0 coroutine (:term:`coroutine function`, optional): The coroutine that caused the error. Returns: diff --git a/telegram/ext/_applicationbuilder.py b/telegram/ext/_applicationbuilder.py index 748f2019f..db34d15a9 100644 --- a/telegram/ext/_applicationbuilder.py +++ b/telegram/ext/_applicationbuilder.py @@ -759,7 +759,7 @@ class ApplicationBuilder(Generic[BT, CCT, UD, CD, BD, JQ]): that your bot does not (explicitly or implicitly) rely on updates being processed sequentially. - .. seealso:: :paramref:`telegram.ext.Application.concurrent_updates` + .. seealso:: :attr:`telegram.ext.Application.concurrent_updates` Args: concurrent_updates (:obj:`bool` | :obj:`int`): Passing :obj:`True` will allow for diff --git a/telegram/ext/_basepersistence.py b/telegram/ext/_basepersistence.py index b127dcbe6..09c82f7e7 100644 --- a/telegram/ext/_basepersistence.py +++ b/telegram/ext/_basepersistence.py @@ -98,7 +98,20 @@ class BasePersistence(Generic[UD, CD, BD], ABC): :class:`telegram.TelegramObject`, one may call :meth:`set_bot` to ensure that shortcuts like :meth:`telegram.Message.reply_text` are available. - .. versionchanged:: 14.0 + This class is a :class:`~typing.Generic` class and accepts three type variables: + + 1. The type of the second argument of :meth:`update_user_data`, which must coincide with the + type of the second argument of :meth:`refresh_user_data` and the values in the dictionary + returned by :meth:`get_user_data`. + 2. The type of the second argument of :meth:`update_chat_data`, which must coincide with the + type of the second argument of :meth:`refresh_chat_data` and the values in the dictionary + returned by :meth:`get_chat_data`. + 3. The type of the argument of :meth:`update_bot_data`, which must coincide with the + type of the argument of :meth:`refresh_bot_data` and the return value of + :meth:`get_bot_data`. + + .. versionchanged:: 20.0 + * The parameters and attributes ``store_*_data`` were replaced by :attr:`store_data`. * ``insert/replace_bot`` was dropped. Serialization of bot instances now needs to be handled by the specific implementation - see above note. @@ -112,7 +125,7 @@ class BasePersistence(Generic[UD, CD, BD], ABC): the persistence in regular intervals. This parameter specifies the time (in seconds) to wait between two consecutive runs of updating the persistence. Defaults to 60 seconds. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Attributes: store_data (:class:`PersistenceInput`): Specifies which kinds of data will be saved by this @@ -141,7 +154,7 @@ class BasePersistence(Generic[UD, CD, BD], ABC): """:obj:`float`: Time (in seconds) that the :class:`~telegram.ext.Application` will wait between two consecutive runs of updating the persistence. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ return self._update_interval @@ -177,7 +190,7 @@ class BasePersistence(Generic[UD, CD, BD], ABC): * The type from :attr:`telegram.ext.ContextTypes.user_data` if :class:`telegram.ext.ContextTypes` is used. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 This method may now return a :obj:`dict` instead of a :obj:`collections.defaultdict` Returns: @@ -196,7 +209,7 @@ class BasePersistence(Generic[UD, CD, BD], ABC): * The type from :attr:`telegram.ext.ContextTypes.chat_data` if :class:`telegram.ext.ContextTypes` is used. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 This method may now return a :obj:`dict` instead of a :obj:`collections.defaultdict` Returns: @@ -227,7 +240,7 @@ class BasePersistence(Generic[UD, CD, BD], ABC): .. versionadded:: 13.6 - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Changed this method into an :external:func:`~abc.abstractmethod`. Returns: @@ -303,7 +316,7 @@ class BasePersistence(Generic[UD, CD, BD], ABC): .. versionadded:: 13.6 - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Changed this method into an :external:func:`~abc.abstractmethod`. Args: @@ -317,7 +330,7 @@ class BasePersistence(Generic[UD, CD, BD], ABC): """Will be called by the :class:`telegram.ext.Application`, when using :meth:`~telegram.ext.Application.drop_chat_data`. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Args: chat_id (:obj:`int`): The chat id to delete from the persistence. @@ -328,7 +341,7 @@ class BasePersistence(Generic[UD, CD, BD], ABC): """Will be called by the :class:`telegram.ext.Application`, when using :meth:`~telegram.ext.Application.drop_user_data`. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Args: user_id (:obj:`int`): The user id to delete from the persistence. @@ -342,7 +355,7 @@ class BasePersistence(Generic[UD, CD, BD], ABC): .. versionadded:: 13.6 - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Changed this method into an :external:func:`~abc.abstractmethod`. Args: @@ -360,7 +373,7 @@ class BasePersistence(Generic[UD, CD, BD], ABC): .. versionadded:: 13.6 - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Changed this method into an :external:func:`~abc.abstractmethod`. Args: @@ -378,7 +391,7 @@ class BasePersistence(Generic[UD, CD, BD], ABC): .. versionadded:: 13.6 - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Changed this method into an :external:func:`~abc.abstractmethod`. Args: @@ -391,6 +404,6 @@ class BasePersistence(Generic[UD, CD, BD], ABC): """Will be called by :meth:`telegram.ext.Application.stop`. Gives the persistence a chance to finish up saving or close a database connection gracefully. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Changed this method into an :external:func:`~abc.abstractmethod`. """ diff --git a/telegram/ext/_callbackcontext.py b/telegram/ext/_callbackcontext.py index 7023e06ee..a02ffddac 100644 --- a/telegram/ext/_callbackcontext.py +++ b/telegram/ext/_callbackcontext.py @@ -66,10 +66,17 @@ class CallbackContext(Generic[BT, UD, CD, BD]): Warning: Do not combine custom attributes with :paramref:`telegram.ext.Handler.block` set to - :obj:`False` or :paramref:`telegram.ext.Application.concurrent_updates` set to + :obj:`False` or :attr:`telegram.ext.Application.concurrent_updates` set to :obj:`True`. Due to how those work, it will almost certainly execute the callbacks for an update out of order, and the attributes that you think you added will not be present. + This class is a :class:`~typing.Generic` class and accepts four type variables: + + 1. The type of :attr:`bot`. Must be :class:`telegram.Bot` or a subclass of that class. + 2. The type of :attr:`user_data` (if :attr:`user_data` is not :obj:`None`). + 3. The type of :attr:`chat_data` (if :attr:`chat_data` is not :obj:`None`). + 4. The type of :attr:`bot_data` (if :attr:`bot_data` is not :obj:`None`). + Args: application (:class:`telegram.ext.Application`): The application associated with this context. @@ -92,7 +99,7 @@ class CallbackContext(Generic[BT, UD, CD, BD]): Only present when passed to the callback of :class:`telegram.ext.Job` or in error handlers if the error is caused by a job. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 :attr:`job` is now also present in error handlers if the error is caused by a job. """ @@ -114,7 +121,7 @@ class CallbackContext(Generic[BT, UD, CD, BD]): async def callback(update: Update, context: CallbackContext.DEFAULT_TYPE): ... - .. versionadded: 14.0 + .. versionadded: 20.0 """ __slots__ = ( @@ -263,7 +270,7 @@ class CallbackContext(Generic[BT, UD, CD, BD]): .. seealso:: :meth:`telegram.ext.Application.add_error_handler` - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Removed arguments ``async_args`` and ``async_kwargs``. Args: @@ -274,7 +281,7 @@ class CallbackContext(Generic[BT, UD, CD, BD]): context. job (:class:`telegram.ext.Job`, optional): The job associated with the error. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Returns: :class:`telegram.ext.CallbackContext` diff --git a/telegram/ext/_conversationhandler.py b/telegram/ext/_conversationhandler.py index 9f5f98392..e44e8c6d9 100644 --- a/telegram/ext/_conversationhandler.py +++ b/telegram/ext/_conversationhandler.py @@ -225,7 +225,7 @@ class ConversationHandler(Handler[Update, CCT]): saved. :paramref:`name` is required and persistence has to be set in :attr:`Application <.Application.persistence>`. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Was previously named as ``persistence``. map_to_parent (Dict[:obj:`object`, :obj:`object`], optional): A :obj:`dict` that can be used to instruct a child conversation handler to transition into a mapped state on @@ -239,7 +239,7 @@ class ConversationHandler(Handler[Update, CCT]): 2. the value passed to this parameter (if any) 3. :attr:`telegram.ext.Defaults.block` (if defaults are used) - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 No longer overrides the handlers settings. Resolution order was changed. Raises: diff --git a/telegram/ext/_defaults.py b/telegram/ext/_defaults.py index 8f1a32b4a..1f3770909 100644 --- a/telegram/ext/_defaults.py +++ b/telegram/ext/_defaults.py @@ -26,11 +26,10 @@ import pytz class Defaults: """Convenience Class to gather all parameters with a (user defined) default value - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Removed the argument and attribute ``timeout``. Specify default timeout behavior for the networking backend directly via :class:`telegram.ext.ApplicationBuilder` instead. - Parameters: parse_mode (:obj:`str`, optional): Send :attr:`~telegram.constants.ParseMode.MARKDOWN` or :attr:`~telegram.constants.ParseMode.HTML`, if you want Telegram apps to show @@ -54,7 +53,7 @@ class Defaults: protect_content (:obj:`bool`, optional): Protects the contents of the sent message from forwarding and saving. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = ( @@ -120,7 +119,7 @@ class Defaults: @property def explanation_parse_mode(self) -> Optional[str]: - """:obj:`str`: Optional. Alias for :paramref:`parse_mode`, used for + """:obj:`str`: Optional. Alias for :attr:`parse_mode`, used for the corresponding parameter of :meth:`telegram.Bot.send_poll`. """ return self._parse_mode @@ -210,7 +209,7 @@ class Defaults: """:obj:`bool`: Optional. Protects the contents of the sent message from forwarding and saving. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ return self._protect_content diff --git a/telegram/ext/_dictpersistence.py b/telegram/ext/_dictpersistence.py index 833ab70d2..51901edba 100644 --- a/telegram/ext/_dictpersistence.py +++ b/telegram/ext/_dictpersistence.py @@ -48,7 +48,7 @@ class DictPersistence(BasePersistence): * This implementation of :class:`BasePersistence` does not handle data that cannot be serialized by :func:`json.dumps`. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 The parameters and attributes ``store_*_data`` were replaced by :attr:`store_data`. Args: @@ -72,7 +72,7 @@ class DictPersistence(BasePersistence): the persistence in regular intervals. This parameter specifies the time (in seconds) to wait between two consecutive runs of updating the persistence. Defaults to 60 seconds. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Attributes: store_data (:class:`PersistenceInput`): Specifies which kinds of data will be saved by this @@ -370,7 +370,7 @@ class DictPersistence(BasePersistence): async def drop_chat_data(self, chat_id: int) -> None: """Will delete the specified key from the :attr:`chat_data`. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Args: chat_id (:obj:`int`): The chat id to delete from the persistence. @@ -383,7 +383,7 @@ class DictPersistence(BasePersistence): async def drop_user_data(self, user_id: int) -> None: """Will delete the specified key from the :attr:`user_data`. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Args: user_id (:obj:`int`): The user id to delete from the persistence. @@ -417,7 +417,7 @@ class DictPersistence(BasePersistence): async def flush(self) -> None: """Does nothing. - .. versionadded:: 14.0 + .. versionadded:: 20.0 .. seealso:: :meth:`telegram.ext.BasePersistence.flush` """ diff --git a/telegram/ext/_handler.py b/telegram/ext/_handler.py index 80f96755c..d5dccd0fe 100644 --- a/telegram/ext/_handler.py +++ b/telegram/ext/_handler.py @@ -38,7 +38,23 @@ class Handler(Generic[UT, CCT], ABC): When setting :paramref:`block` to :obj:`False`, you cannot rely on adding custom attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info. - .. versionchanged:: 14.0 + This class is a :class:`~typing.Generic` class and accepts two type variables: + + 1. The type of the updates that this handler will handle. Must coincide with the type of the + first argument of :paramref:`callback`. :meth:`check_update` must only accept + updates of this type. + 2. The type of the second argument of :paramref:`callback`. Must coincide with the type of the + parameters :paramref:`handle_update.context` and + :paramref:`collect_additional_context.context` as well as the second argument of + :paramref:`callback`. Must be either :class:`~telegram.ext.CallbackContext` or a subclass + of that class. + + .. tip:: + For this type variable, one should usually provide a :class:`~typing.TypeVar` that is + also used for the mentioned method arguments. That way, a type checker can check whether + this handler fits the definition of the :class:`~Application`. + + .. versionchanged:: 20.0 The attribute ``run_async`` is now :paramref:`block`. Args: diff --git a/telegram/ext/_inlinequeryhandler.py b/telegram/ext/_inlinequeryhandler.py index 7e2e77e31..34e48514a 100644 --- a/telegram/ext/_inlinequeryhandler.py +++ b/telegram/ext/_inlinequeryhandler.py @@ -34,8 +34,9 @@ RT = TypeVar("RT") class InlineQueryHandler(Handler[Update, CCT]): """ - Handler class to handle Telegram inline queries. Optionally based on a regex. Read the - documentation of the :mod:`re` module for more information. + Handler class to handle Telegram updates that contain a :attr:`telegram.Update.inline_query`. + Optionally based on a regex. Read the documentation of the :mod:`re` module for more + information. Warning: * When setting :paramref:`block` to :obj:`False`, you cannot rely on adding custom diff --git a/telegram/ext/_jobqueue.py b/telegram/ext/_jobqueue.py index 6c76da1f6..9ea19b98f 100644 --- a/telegram/ext/_jobqueue.py +++ b/telegram/ext/_jobqueue.py @@ -42,7 +42,7 @@ class JobQueue: Attributes: scheduler (:class:`apscheduler.schedulers.asyncio.AsyncIOScheduler`): The scheduler. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Use :class:`~apscheduler.schedulers.asyncio.AsyncIOScheduler` instead of :class:`~apscheduler.schedulers.background.BackgroundScheduler` @@ -156,13 +156,13 @@ class JobQueue: passed, the corresponding :attr:`~telegram.ext.CallbackContext.chat_data` will be available in the callback. - .. versionadded:: 14.0 + .. versionadded:: 20.0 user_id (:obj:`int`, optional): User id of the user associated with this job. If passed, the corresponding :attr:`~telegram.ext.CallbackContext.user_data` will be available in the callback. - .. versionadded:: 14.0 + .. versionadded:: 20.0 context (:obj:`object`, optional): Additional data needed for the callback function. Can be accessed through :attr:`Job.context` in the callback. Defaults to :obj:`None`. @@ -263,13 +263,13 @@ class JobQueue: passed, the corresponding :attr:`~telegram.ext.CallbackContext.chat_data` will be available in the callback. - .. versionadded:: 14.0 + .. versionadded:: 20.0 user_id (:obj:`int`, optional): User id of the user associated with this job. If passed, the corresponding :attr:`~telegram.ext.CallbackContext.user_data` will be available in the callback. - .. versionadded:: 14.0 + .. versionadded:: 20.0 job_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to pass to the :meth:`apscheduler.schedulers.base.BaseScheduler.add_job()`. @@ -320,7 +320,7 @@ class JobQueue: ) -> "Job": """Creates a new :class:`Job` that runs on a monthly basis and adds it to the queue. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 The ``day_is_strict`` argument was removed. Instead one can now pass -1 to the ``day`` parameter to have the job run on the last day of the month. @@ -345,13 +345,13 @@ class JobQueue: passed, the corresponding :attr:`~telegram.ext.CallbackContext.chat_data` will be available in the callback. - .. versionadded:: 14.0 + .. versionadded:: 20.0 user_id (:obj:`int`, optional): User id of the user associated with this job. If passed, the corresponding :attr:`~telegram.ext.CallbackContext.user_data` will be available in the callback. - .. versionadded:: 14.0 + .. versionadded:: 20.0 job_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to pass to the :meth:`apscheduler.schedulers.base.BaseScheduler.add_job()`. @@ -420,13 +420,13 @@ class JobQueue: passed, the corresponding :attr:`~telegram.ext.CallbackContext.chat_data` will be available in the callback. - .. versionadded:: 14.0 + .. versionadded:: 20.0 user_id (:obj:`int`, optional): User id of the user associated with this job. If passed, the corresponding :attr:`~telegram.ext.CallbackContext.user_data` will be available in the callback. - .. versionadded:: 14.0 + .. versionadded:: 20.0 job_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to pass to the :meth:`apscheduler.schedulers.base.BaseScheduler.add_job()`. @@ -485,13 +485,13 @@ class JobQueue: passed, the corresponding :attr:`~telegram.ext.CallbackContext.chat_data` will be available in the callback. - .. versionadded:: 14.0 + .. versionadded:: 20.0 user_id (:obj:`int`, optional): User id of the user associated with this job. If passed, the corresponding :attr:`~telegram.ext.CallbackContext.user_data` will be available in the callback. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Returns: :class:`telegram.ext.Job`: The new :class:`Job` instance that has been added to the job @@ -563,7 +563,7 @@ class Job: * If :attr:`job` isn't passed on initialization, it must be set manually afterwards for this :class:`telegram.ext.Job` to be useful. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Removed argument and attribute ``job_queue``. Args: @@ -579,10 +579,10 @@ class Job: job (:class:`apscheduler.job.Job`, optional): The APS Job this job is a wrapper for. chat_id (:obj:`int`, optional): Chat id of the chat that this job is associated with. - .. versionadded:: 14.0 + .. versionadded:: 20.0 user_id (:obj:`int`, optional): User id of the user that this job is associated with. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Attributes: callback (:term:`coroutine function`): The callback function that should be executed by the @@ -592,10 +592,10 @@ class Job: job (:class:`apscheduler.job.Job`): Optional. The APS Job this job is a wrapper for. chat_id (:obj:`int`): Optional. Chat id of the chat that this job is associated with. - .. versionadded:: 14.0 + .. versionadded:: 20.0 user_id (:obj:`int`): Optional. User id of the user that this job is associated with. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = ( @@ -634,7 +634,7 @@ class Job: """Executes the callback function independently of the jobs schedule. Also calls :meth:`telegram.ext.Application.update_persistence`. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Calls :meth:`telegram.ext.Application.update_persistence`. Args: diff --git a/telegram/ext/_picklepersistence.py b/telegram/ext/_picklepersistence.py index 58069105f..77bd51f42 100644 --- a/telegram/ext/_picklepersistence.py +++ b/telegram/ext/_picklepersistence.py @@ -130,7 +130,7 @@ class PicklePersistence(BasePersistence[UD, CD, BD]): :attr:`~BasePersistence.bot` will be replaced by a placeholder before pickling and :attr:`~BasePersistence.bot` will be inserted back when loading the data. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 * The parameters and attributes ``store_*_data`` were replaced by :attr:`store_data`. * The parameter and attribute ``filename`` were replaced by :attr:`filepath`. @@ -160,7 +160,7 @@ class PicklePersistence(BasePersistence[UD, CD, BD]): the persistence in regular intervals. This parameter specifies the time (in seconds) to wait between two consecutive runs of updating the persistence. Defaults to 60 seconds. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Attributes: filepath (:obj:`str` | :obj:`pathlib.Path`): The filepath for storing the pickle files. @@ -478,7 +478,7 @@ class PicklePersistence(BasePersistence[UD, CD, BD]): """Will delete the specified key from the ``chat_data`` and depending on :attr:`on_flush` save the pickle file. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Args: chat_id (:obj:`int`): The chat id to delete from the persistence. @@ -497,7 +497,7 @@ class PicklePersistence(BasePersistence[UD, CD, BD]): """Will delete the specified key from the ``user_data`` and depending on :attr:`on_flush` save the pickle file. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Args: user_id (:obj:`int`): The user id to delete from the persistence. diff --git a/telegram/ext/_updater.py b/telegram/ext/_updater.py index 3749f285c..95133d075 100644 --- a/telegram/ext/_updater.py +++ b/telegram/ext/_updater.py @@ -59,7 +59,7 @@ class Updater(AbstractAsyncContextManager): finally: await updater.shutdown() - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 * Removed argument and attribute ``user_sig_handler`` * The only arguments and attributes are now :attr:`bot` and :attr:`update_queue` as now @@ -178,7 +178,7 @@ class Updater(AbstractAsyncContextManager): ) -> asyncio.Queue: """Starts polling updates from Telegram. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Removed the ``clean`` argument in favor of :paramref:`drop_pending_updates`. Args: @@ -194,13 +194,13 @@ class Updater(AbstractAsyncContextManager): * > 0 - retry up to X times read_timeout (:obj:`float`, optional): Value to pass to :paramref:`telegram.Bot.get_updates.read_timeout`. Defaults to ``2``. - write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.Bot.get_updates.write_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.Bot.get_updates.connect_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. - pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to + pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.Bot.get_updates.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. allowed_updates (List[:obj:`str`], optional): Passed to @@ -376,7 +376,7 @@ class Updater(AbstractAsyncContextManager): .. versionchanged:: 13.4 :meth:`start_webhook` now *always* calls :meth:`telegram.Bot.set_webhook`, so pass ``webhook_url`` instead of calling ``updater.bot.set_webhook(webhook_url)`` manually. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Removed the ``clean`` argument in favor of :paramref:`drop_pending_updates` and removed the deprecated argument ``force_event_loop``. diff --git a/telegram/ext/_utils/stack.py b/telegram/ext/_utils/stack.py index e4df470d7..d25379179 100644 --- a/telegram/ext/_utils/stack.py +++ b/telegram/ext/_utils/stack.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains helper functions related to inspecting the program stack. -.. versionadded:: 14.0 +.. versionadded:: 20.0 Warning: Contents of this module are intended to be used internally by the library and *not* by the diff --git a/telegram/ext/_utils/trackingdict.py b/telegram/ext/_utils/trackingdict.py index 2e6355cf0..c8b737c04 100644 --- a/telegram/ext/_utils/trackingdict.py +++ b/telegram/ext/_utils/trackingdict.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains a mutable mapping that keeps track of the keys that where accessed. -.. versionadded:: 14.0 +.. versionadded:: 20.0 Warning: Contents of this module are intended to be used internally by the library and *not* by the diff --git a/telegram/ext/_utils/types.py b/telegram/ext/_utils/types.py index bc4160ba7..3561d5e65 100644 --- a/telegram/ext/_utils/types.py +++ b/telegram/ext/_utils/types.py @@ -53,12 +53,12 @@ UT = TypeVar("UT") HandlerCallback = Callable[[UT, CCT], Coroutine[Any, Any, RT]] """Type of a handler callback - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ JobCallback = Callable[[CCT], Coroutine[Any, Any, Any]] """Type of a job callback - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ ConversationKey = Tuple[Union[int, str], ...] @@ -80,7 +80,7 @@ CDCData = Tuple[List[Tuple[str, float, Dict[str, Any]]], Dict[str, str]] BT = TypeVar("BT", bound="Bot") """Type of the bot. -.. versionadded:: 14.0 +.. versionadded:: 20.0 """ UD = TypeVar("UD") """Type of the user data for a single user. @@ -100,4 +100,4 @@ BD = TypeVar("BD") JQ = TypeVar("JQ", bound=Union[None, "JobQueue"]) """Type of the job queue. -.. versionadded:: 14.0""" +.. versionadded:: 20.0""" diff --git a/telegram/ext/filters.py b/telegram/ext/filters.py index 0557d9e18..0f54000ec 100644 --- a/telegram/ext/filters.py +++ b/telegram/ext/filters.py @@ -20,7 +20,7 @@ This module contains filters for use with :class:`telegram.ext.MessageHandler`, :class:`telegram.ext.CommandHandler`, or :class:`telegram.ext.PrefixHandler`. -.. versionchanged:: 14.0 +.. versionchanged:: 20.0 #. Filters are no longer callable, if you're using a custom filter and are calling an existing filter, then switch to the new syntax: ``filters.{filter}.check_update(update)``. @@ -159,7 +159,7 @@ class BaseFilter: will be the class name. If you want to overwrite this assign a better name to the :attr:`name` class variable. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Added the arguments :attr:`name` and :attr:`data_filter`. Args: @@ -1917,7 +1917,7 @@ class Sticker: """Messages that contain :attr:`telegram.Message.sticker` and :attr:`is animated `. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ class _Static(MessageFilter): @@ -1933,7 +1933,7 @@ class Sticker: """Messages that contain :attr:`telegram.Message.sticker` and is a static sticker, i.e. does not contain :attr:`telegram.Sticker.is_animated` or :attr:`telegram.Sticker.is_video`. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ class _Video(MessageFilter): @@ -1946,7 +1946,7 @@ class Sticker: """Messages that contain :attr:`telegram.Message.sticker` and is a :attr:`video sticker `. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ @@ -2054,7 +2054,7 @@ class UpdateType: """Updates with either :attr:`telegram.Update.edited_message` or :attr:`telegram.Update.edited_channel_post`. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ class _EditedChannelPost(UpdateFilter): diff --git a/telegram/helpers.py b/telegram/helpers.py index 093758263..7144ccf3a 100644 --- a/telegram/helpers.py +++ b/telegram/helpers.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains convenience helper functions. -.. versionchanged:: 14.0 +.. versionchanged:: 20.0 Previously, the contents of this module were available through the (no longer existing) module ``telegram.utils.helpers``. """ diff --git a/telegram/request/_baserequest.py b/telegram/request/_baserequest.py index 975b6e2cd..4f83dc5ff 100644 --- a/telegram/request/_baserequest.py +++ b/telegram/request/_baserequest.py @@ -71,7 +71,7 @@ class BaseRequest( finally: await request_object.shutdown() - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () diff --git a/telegram/request/_httpxrequest.py b/telegram/request/_httpxrequest.py index b4c3d14d9..6bc0f4f0f 100644 --- a/telegram/request/_httpxrequest.py +++ b/telegram/request/_httpxrequest.py @@ -40,7 +40,7 @@ class HTTPXRequest(BaseRequest): """Implementation of :class:`~telegram.request.BaseRequest` using the library `httpx `_. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Args: connection_pool_size (:obj:`int`, optional): Number of connections to keep in the diff --git a/telegram/request/_requestdata.py b/telegram/request/_requestdata.py index 38ec5b76b..0e433caea 100644 --- a/telegram/request/_requestdata.py +++ b/telegram/request/_requestdata.py @@ -33,7 +33,7 @@ class RequestData: """Instances of this class collect the data needed for one request to the Bot API, including all parameters and files to be sent along with the request. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Warning: How exactly instances of this will are created should be considered an implementation diff --git a/telegram/request/_requestparameter.py b/telegram/request/_requestparameter.py index b46175fa9..55e14aa6a 100644 --- a/telegram/request/_requestparameter.py +++ b/telegram/request/_requestparameter.py @@ -39,7 +39,7 @@ class RequestParameter: """Instances of this class represent a single parameter to be sent along with a request to the Bot API. - .. versionadded:: 14.0 + .. versionadded:: 20.0 Warning: This class intended is to be used internally by the library and *not* by the user. Changes diff --git a/telegram/warnings.py b/telegram/warnings.py index b043c60bf..0f25ea820 100644 --- a/telegram/warnings.py +++ b/telegram/warnings.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains classes used for warnings issued by this library. -.. versionadded:: 14.0 +.. versionadded:: 20.0 """ __all__ = ["PTBDeprecationWarning", "PTBRuntimeWarning", "PTBUserWarning"] @@ -28,7 +28,7 @@ class PTBUserWarning(UserWarning): """ Custom user warning class used for warnings in this library. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -38,7 +38,7 @@ class PTBRuntimeWarning(PTBUserWarning, RuntimeWarning): """ Custom runtime warning class used for warnings in this library. - .. versionadded:: 14.0 + .. versionadded:: 20.0 """ __slots__ = () @@ -50,7 +50,7 @@ class PTBDeprecationWarning(PTBUserWarning, DeprecationWarning): """ Custom warning class for deprecations in this library. - .. versionchanged:: 14.0 + .. versionchanged:: 20.0 Renamed TelegramDeprecationWarning to PTBDeprecationWarning. """