diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst index 475c41d203d..15049ac55af 100644 --- a/.github/CONTRIBUTING.rst +++ b/.github/CONTRIBUTING.rst @@ -22,12 +22,16 @@ Setting things up $ git remote add upstream https://github.com/python-telegram-bot/python-telegram-bot -4. Install dependencies: +4. Install the package in development mode as well as optional dependencies and development dependencies. + Note that the `--group` argument requires `pip` 25.1 or later. + + Alternatively, you can use your preferred package manager (such as uv, hatch, poetry, etc.) instead of pip. .. code-block:: bash - $ pip install -r requirements-dev-all.txt + $ pip install -e .[all] --group all + Installing the package itself is necessary because python-telegram-bot uses a src-based layout where the package code is located in the ``src/`` directory. 5. Install pre-commit hooks: diff --git a/.github/workflows/chango.yml b/.github/workflows/chango.yml index d845f6bc019..1b3dfe0caa8 100644 --- a/.github/workflows/chango.yml +++ b/.github/workflows/chango.yml @@ -45,7 +45,7 @@ jobs: # Run `chango release` if applicable - needs some additional setup. - name: Set up Python if: steps.check_title.outputs.IS_RELEASE_PR == 'true' - uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5.5.0 + uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 with: python-version: "3.x" @@ -54,7 +54,7 @@ jobs: run: | cd ./target-repo git add changes/unreleased/* - pip install . -r docs/requirements-docs.txt + pip install . --group docs VERSION_TAG=$(python -c "from telegram import __version__; print(f'{__version__}')") chango release --uid $VERSION_TAG diff --git a/.github/workflows/dependabot-prs.yml b/.github/workflows/dependabot-prs.yml index 9bb7a5299c3..7c60835624c 100644 --- a/.github/workflows/dependabot-prs.yml +++ b/.github/workflows/dependabot-prs.yml @@ -18,7 +18,7 @@ jobs: - name: Fetch Dependabot metadata id: dependabot-metadata - uses: dependabot/fetch-metadata@d7267f607e9d3fb96fc2fbe83e0af444713e90b7 # v2.3.0 + uses: dependabot/fetch-metadata@08eff52bf64351f401fb50d4972fa95b9f2c2d1b # v2.4.0 - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 with: diff --git a/.github/workflows/docs-admonitions.yml b/.github/workflows/docs-admonitions.yml index 00b03ae4cca..b78d3381cb4 100644 --- a/.github/workflows/docs-admonitions.yml +++ b/.github/workflows/docs-admonitions.yml @@ -2,7 +2,7 @@ name: Test Admonitions Generation on: pull_request: paths: - - telegram/** + - src/telegram/** - docs/** - .github/workflows/docs-admonitions.yml push: @@ -28,14 +28,14 @@ jobs: with: persist-credentials: false - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5.5.0 + uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 with: python-version: ${{ matrix.python-version }} cache: 'pip' - cache-dependency-path: '**/requirements*.txt' + cache-dependency-path: 'pyproject.toml' - name: Install dependencies run: | python -W ignore -m pip install --upgrade pip - python -W ignore -m pip install -r requirements-dev-all.txt + python -W ignore -m pip install .[all] --group all - name: Test autogeneration of admonitions run: pytest -v --tb=short tests/docs/admonition_inserter.py \ No newline at end of file diff --git a/.github/workflows/docs-linkcheck.yml b/.github/workflows/docs-linkcheck.yml index 65453ad11f3..83186d24aa4 100644 --- a/.github/workflows/docs-linkcheck.yml +++ b/.github/workflows/docs-linkcheck.yml @@ -23,13 +23,13 @@ jobs: with: persist-credentials: false - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5.5.0 + uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 with: python-version: ${{ matrix.python-version }} - name: Install dependencies run: | python -W ignore -m pip install --upgrade pip - python -W ignore -m pip install -r requirements-dev-all.txt + python -W ignore -m pip install .[all] --group all - name: Check Links run: sphinx-build docs/source docs/build/html --keep-going -j auto -b linkcheck - name: Upload linkcheck output diff --git a/.github/workflows/gha_security.yml b/.github/workflows/gha_security.yml index df0d0f10bb5..ff207f3e8b7 100644 --- a/.github/workflows/gha_security.yml +++ b/.github/workflows/gha_security.yml @@ -27,7 +27,7 @@ jobs: env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} - name: Upload SARIF file - uses: github/codeql-action/upload-sarif@28deaeda66b76a05916b6923827895f2b14ab387 # v3.28.16 + uses: github/codeql-action/upload-sarif@ff0a06e83cb2de871e5a09832bc6a81e7276941f # v3.28.18 with: sarif_file: results.sarif category: zizmor \ No newline at end of file diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml index a9e9e468010..ec8e822da3b 100644 --- a/.github/workflows/release_pypi.yml +++ b/.github/workflows/release_pypi.yml @@ -21,7 +21,7 @@ jobs: with: persist-credentials: false - name: Set up Python - uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5.5.0 + uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 with: python-version: "3.x" - name: Install pypa/build @@ -145,7 +145,9 @@ jobs: telegram-channel: name: Publish to Telegram Channel needs: - - github-release + # required to have the output available for the env var + - build + - github-release runs-on: ubuntu-latest environment: diff --git a/.github/workflows/release_test_pypi.yml b/.github/workflows/release_test_pypi.yml index a59baec5e67..9e673517765 100644 --- a/.github/workflows/release_test_pypi.yml +++ b/.github/workflows/release_test_pypi.yml @@ -21,7 +21,7 @@ jobs: with: persist-credentials: false - name: Set up Python - uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5.5.0 + uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 with: python-version: "3.x" - name: Install pypa/build diff --git a/.github/workflows/test_official.yml b/.github/workflows/test_official.yml index 14224d0901a..4f46be494a3 100644 --- a/.github/workflows/test_official.yml +++ b/.github/workflows/test_official.yml @@ -2,7 +2,7 @@ name: Bot API Tests on: pull_request: paths: - - telegram/** + - src/telegram/** - tests/** push: branches: @@ -27,14 +27,13 @@ jobs: with: persist-credentials: false - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5.5.0 + uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 with: python-version: ${{ matrix.python-version }} - name: Install dependencies run: | python -W ignore -m pip install --upgrade pip - python -W ignore -m pip install .[all] - python -W ignore -m pip install -r requirements-unit-tests.txt + python -W ignore -m pip install .[all] --group tests - name: Compare to official api run: | pytest -v tests/test_official/test_official.py --junit-xml=.test_report_official.xml diff --git a/.github/workflows/type_completeness.yml b/.github/workflows/type_completeness.yml index 3b3f30e4873..56b57f5e539 100644 --- a/.github/workflows/type_completeness.yml +++ b/.github/workflows/type_completeness.yml @@ -2,7 +2,7 @@ name: Check Type Completeness on: pull_request: paths: - - telegram/** + - src/telegram/** - pyproject.toml - .github/workflows/type_completeness.yml push: diff --git a/.github/workflows/unit_tests.yml b/.github/workflows/unit_tests.yml index affb519fce2..a4fd47910c2 100644 --- a/.github/workflows/unit_tests.yml +++ b/.github/workflows/unit_tests.yml @@ -2,11 +2,10 @@ name: Unit Tests on: pull_request: paths: - - telegram/** + - src/telegram/** - tests/** - .github/workflows/unit_tests.yml - pyproject.toml - - requirements-unit-tests.txt push: branches: - master @@ -22,7 +21,7 @@ jobs: runs-on: ${{matrix.os}} strategy: matrix: - python-version: ['3.9', '3.10', '3.11', '3.12', '3.13'] + python-version: ['3.9', '3.10', '3.11', '3.12', '3.13', '3.14.0-beta.3'] os: [ubuntu-latest, windows-latest, macos-latest] fail-fast: False steps: @@ -30,18 +29,14 @@ jobs: with: persist-credentials: false - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5.5.0 + uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0 with: python-version: ${{ matrix.python-version }} cache: 'pip' - cache-dependency-path: '**/requirements*.txt' - name: Install dependencies run: | python -W ignore -m pip install --upgrade pip - python -W ignore -m pip install -U pytest-cov - python -W ignore -m pip install . - python -W ignore -m pip install -r requirements-unit-tests.txt - python -W ignore -m pip install pytest-xdist + python -W ignore -m pip install . --group tests - name: Test with pytest # We run 4 different suites here @@ -63,11 +58,10 @@ jobs: TO_TEST="test_no_passport.py or test_datetime.py or test_defaults.py or test_jobqueue.py or test_applicationbuilder.py or test_ratelimiter.py or test_updater.py or test_callbackdatacache.py or test_request.py" pytest -v --cov -k "${TO_TEST}" --junit-xml=.test_report_no_optionals_junit.xml opt_dep_status=$? - + # Test the rest export TEST_WITH_OPT_DEPS='true' - # need to manually install pytz here, because it's no longer in the optional reqs - pip install .[all] pytz + pip install .[all] # `-n auto --dist worksteal` uses pytest-xdist to run tests on multiple CPU # workers. Increasing number of workers has little effect on test duration, but it seems # to increase flakyness. @@ -92,14 +86,14 @@ jobs: .test_report_optionals_junit.xml - name: Submit coverage - uses: codecov/codecov-action@ad3126e916f78f00edff4ed0317cf185271ccc2d # v5.4.2 + uses: codecov/codecov-action@18283e04ce6e62d37312384ff67231eb8fd56d24 # v5.4.3 with: env_vars: OS,PYTHON name: ${{ matrix.os }}-${{ matrix.python-version }} fail_ci_if_error: true token: ${{ secrets.CODECOV_TOKEN }} - name: Upload test results to Codecov - uses: codecov/test-results-action@f2dba722c67b86c6caa034178c6e4d35335f6706 # v1.1.0 + uses: codecov/test-results-action@47f89e9acb64b76debcd5ea40642d25a4adced9f # v1.1.1 if: ${{ !cancelled() }} with: files: .test_report_no_optionals_junit.xml,.test_report_optionals_junit.xml diff --git a/.gitignore b/.gitignore index 9e944f66958..2bd243a7416 100644 --- a/.gitignore +++ b/.gitignore @@ -93,6 +93,8 @@ telegram.jpg # virtual env venv* +pyvenv.cfg +Scripts/ # environment manager: .mise.toml \ No newline at end of file diff --git a/.readthedocs.yml b/.readthedocs.yml index 11075b0fe2b..6d89b823dba 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -18,13 +18,16 @@ python: install: - method: pip path: . - - requirements: requirements-dev-all.txt build: os: ubuntu-22.04 tools: python: "3" # latest stable cpython version jobs: + install: + - pip install -U pip + - pip install .[all] --group 'all' # install all the dependency groups + post_build: # Based on https://github.com/readthedocs/readthedocs.org/issues/3242#issuecomment-1410321534 # This provides a HTML zip file for download, with the same structure as the hosted website diff --git a/AUTHORS.rst b/AUTHORS.rst index 61535397919..9ca986b53e5 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -80,6 +80,7 @@ The following wonderful people contributed directly or indirectly to this projec - `Kirill Vasin `_ - `Kjwon15 `_ - `Li-aung Yip `_ +- `locobott `_ - `Loo Zheng Yuan `_ - `LRezende `_ - `Luca Bellanti `_ @@ -109,6 +110,7 @@ The following wonderful people contributed directly or indirectly to this projec - `Patrick Hofmann `_ - `Paul Larsen `_ - `Pawan `_ +- `Philipp Isachenko `_ - `Pieter Schutz `_ - `Piraty `_ - `Poolitzer `_ diff --git a/README.rst b/README.rst index 633dc383ad7..a1aa26871e8 100644 --- a/README.rst +++ b/README.rst @@ -114,6 +114,8 @@ You can also install ``python-telegram-bot`` from source, though this is usually $ pip install build $ python -m build +You can also use your favored package manager (such as ``uv``, ``hatch``, ``poetry``, etc.) instead of ``pip``. + Verifying Releases ~~~~~~~~~~~~~~~~~~ @@ -139,7 +141,7 @@ As these features are *optional*, the corresponding 3rd party dependencies are n Instead, they are listed as optional dependencies. This allows to avoid unnecessary dependency conflicts for users who don't need the optional features. -The only required dependency is `httpx ~= 0.27 `_ for +The only required dependency is `httpx >=0.27,<0.29 `_ for ``telegram.request.HTTPXRequest``, the default networking backend. ``python-telegram-bot`` is most useful when used along with additional libraries. @@ -157,7 +159,7 @@ PTB can be installed with optional dependencies: * ``pip install "python-telegram-bot[http2]"`` installs `httpx[http2] `_. Use this, if you want to use HTTP/2. * ``pip install "python-telegram-bot[rate-limiter]"`` installs `aiolimiter~=1.1,<1.3 `_. Use this, if you want to use ``telegram.ext.AIORateLimiter``. * ``pip install "python-telegram-bot[webhooks]"`` installs the `tornado~=6.4 `_ library. Use this, if you want to use ``telegram.ext.Updater.start_webhook``/``telegram.ext.Application.run_webhook``. -* ``pip install "python-telegram-bot[callback-data]"`` installs the `cachetools>=5.3.3,<5.6.0 `_ library. Use this, if you want to use `arbitrary callback_data `_. +* ``pip install "python-telegram-bot[callback-data]"`` installs the `cachetools>=5.3.3,<6.2.0 `_ library. Use this, if you want to use `arbitrary callback_data `_. * ``pip install "python-telegram-bot[job-queue]"`` installs the `APScheduler>=3.10.4,<3.12.0 `_ library. Use this, if you want to use the ``telegram.ext.JobQueue``. To install multiple optional dependencies, separate them by commas, e.g. ``pip install "python-telegram-bot[socks,webhooks]"``. diff --git a/changes/22.2_2025-06-29/4750.jJBu7iAgZa96hdqcpHK96W.toml b/changes/22.2_2025-06-29/4750.jJBu7iAgZa96hdqcpHK96W.toml new file mode 100644 index 00000000000..5d9d75d7ca9 --- /dev/null +++ b/changes/22.2_2025-06-29/4750.jJBu7iAgZa96hdqcpHK96W.toml @@ -0,0 +1,36 @@ +features = "Use `timedelta` to represent time periods in class arguments and attributes" +deprecations = """In this release, we're migrating attributes of Telegram objects that represent durations/time periods from having :obj:`int` type to Python's native :class:`datetime.timedelta`. This change is opt-in for now to allow for a smooth transition phase. It will become opt-out in future releases. + +Set ``PTB_TIMEDELTA=true`` or ``PTB_TIMEDELTA=1`` as an environment variable to make these attributes return :obj:`datetime.timedelta` objects instead of integers. Support for :obj:`int` values is deprecated and will be removed in a future major version. + +Affected Attributes: +- :attr:`telegram.ChatFullInfo.slow_mode_delay` and :attr:`telegram.ChatFullInfo.message_auto_delete_time` +- :attr:`telegram.Animation.duration` +- :attr:`telegram.Audio.duration` +- :attr:`telegram.Video.duration` and :attr:`telegram.Video.start_timestamp` +- :attr:`telegram.VideoNote.duration` +- :attr:`telegram.Voice.duration` +- :attr:`telegram.PaidMediaPreview.duration` +- :attr:`telegram.VideoChatEnded.duration` +- :attr:`telegram.InputMediaVideo.duration` +- :attr:`telegram.InputMediaAnimation.duration` +- :attr:`telegram.InputMediaAudio.duration` +- :attr:`telegram.InputPaidMediaVideo.duration` +- :attr:`telegram.InlineQueryResultGif.gif_duration` +- :attr:`telegram.InlineQueryResultMpeg4Gif.mpeg4_duration` +- :attr:`telegram.InlineQueryResultVideo.video_duration` +- :attr:`telegram.InlineQueryResultAudio.audio_duration` +- :attr:`telegram.InlineQueryResultVoice.voice_duration` +- :attr:`telegram.InlineQueryResultLocation.live_period` +- :attr:`telegram.Poll.open_period` +- :attr:`telegram.Location.live_period` +- :attr:`telegram.MessageAutoDeleteTimerChanged.message_auto_delete_time` +- :attr:`telegram.ChatInviteLink.subscription_period` +- :attr:`telegram.InputLocationMessageContent.live_period` +- :attr:`telegram.error.RetryAfter.retry_after` +""" +internal = "Modify `test_official` to handle time periods as timedelta automatically." +[[pull_requests]] +uid = "4750" +author_uid = "aelkheir" +closes_threads = ["4575"] diff --git a/changes/22.2_2025-06-29/4792.YsK6LmbEhZv6y3dvhHbXD7.toml b/changes/22.2_2025-06-29/4792.YsK6LmbEhZv6y3dvhHbXD7.toml new file mode 100644 index 00000000000..675c2904b4d --- /dev/null +++ b/changes/22.2_2025-06-29/4792.YsK6LmbEhZv6y3dvhHbXD7.toml @@ -0,0 +1,5 @@ +internal = "Fix Bug in Automated Channel Announcement" +[[pull_requests]] +uid = "4792" +author_uid = "Bibo-Joshi" +closes_threads = [] diff --git a/changes/22.2_2025-06-29/4793.mDR5p3mrSmPFQkvWFGWBmD.toml b/changes/22.2_2025-06-29/4793.mDR5p3mrSmPFQkvWFGWBmD.toml new file mode 100644 index 00000000000..7a6ca4c3e95 --- /dev/null +++ b/changes/22.2_2025-06-29/4793.mDR5p3mrSmPFQkvWFGWBmD.toml @@ -0,0 +1,5 @@ +internal = "Fix a Failing Test Case" +[[pull_requests]] +uid = "4793" +author_uid = "Bibo-Joshi" +closes_threads = [] diff --git a/changes/22.2_2025-06-29/4798.g7G3jRf2ns4ath9LRFEcit.toml b/changes/22.2_2025-06-29/4798.g7G3jRf2ns4ath9LRFEcit.toml new file mode 100644 index 00000000000..c238ebdfc67 --- /dev/null +++ b/changes/22.2_2025-06-29/4798.g7G3jRf2ns4ath9LRFEcit.toml @@ -0,0 +1,5 @@ +internal = "Rework Repository to `src` Layout" +[[pull_requests]] +uid = "4798" +author_uid = "Bibo-Joshi" +closes_threads = ["4797"] diff --git a/changes/22.2_2025-06-29/4800.2Z9Q8uvzdU2TqMJ9biBLam.toml b/changes/22.2_2025-06-29/4800.2Z9Q8uvzdU2TqMJ9biBLam.toml new file mode 100644 index 00000000000..4f670da8bd0 --- /dev/null +++ b/changes/22.2_2025-06-29/4800.2Z9Q8uvzdU2TqMJ9biBLam.toml @@ -0,0 +1,5 @@ +dependencies = "Implement PEP 735 Dependency Groups for Development Dependencies" +[[pull_requests]] +uid = "4800" +author_uid = "harshil21" +closes_threads = ["4795"] diff --git a/changes/22.2_2025-06-29/4801.feKaYKKZTZq2KBjhyxVVAM.toml b/changes/22.2_2025-06-29/4801.feKaYKKZTZq2KBjhyxVVAM.toml new file mode 100644 index 00000000000..3531270fc8d --- /dev/null +++ b/changes/22.2_2025-06-29/4801.feKaYKKZTZq2KBjhyxVVAM.toml @@ -0,0 +1,5 @@ +dependencies = "Update cachetools requirement from <5.6.0,>=5.3.3 to >=5.3.3,<6.1.0" +[[pull_requests]] +uid = "4801" +author_uid = "dependabot" +closes_threads = [] diff --git a/changes/22.2_2025-06-29/4802.RMLufX4UazobYg5aZojyoD.toml b/changes/22.2_2025-06-29/4802.RMLufX4UazobYg5aZojyoD.toml new file mode 100644 index 00000000000..28745b0d9a8 --- /dev/null +++ b/changes/22.2_2025-06-29/4802.RMLufX4UazobYg5aZojyoD.toml @@ -0,0 +1,14 @@ +bugfixes = """ +Fixed a bug where calling ``Application.remove/add_handler`` during update handling can cause a ``RuntimeError`` in ``Application.process_update``. + +.. hint:: + Calling ``Application.add/remove_handler`` now has no influence on calls to :meth:`process_update` that are + already in progress. The same holds for ``Application.add/remove_error_handler`` and ``Application.process_error``, respectively. + + .. warning:: + This behavior should currently be considered an implementation detail and not as guaranteed behavior. +""" +[[pull_requests]] +uid = "4802" +author_uid = "Bibo-Joshi" +closes_threads = ["4803"] diff --git a/changes/22.2_2025-06-29/4810.KyRnffWk3ARyQFNcF88Uh3.toml b/changes/22.2_2025-06-29/4810.KyRnffWk3ARyQFNcF88Uh3.toml new file mode 100644 index 00000000000..dcb64b0d66b --- /dev/null +++ b/changes/22.2_2025-06-29/4810.KyRnffWk3ARyQFNcF88Uh3.toml @@ -0,0 +1,20 @@ +documentation = """Documentation Improvements. Among other things + +* mention alternative package managers in README and contribution guide +* remove ``furo-sphinx-search`` +""" + +[[pull_requests]] +uid = "4810" +author_uid = "Bibo-Joshi" +closes_threads = [] + +[[pull_requests]] +uid = "4824" +author_uid = "Aweryc" +closes_threads = ["4823"] + +[[pull_requests]] +uid = "4826" +author_uid = "harshil21" +closes_threads = [] diff --git a/changes/22.2_2025-06-29/4811.TQgVr5Sa6uDFtWXdTS5wfw.toml b/changes/22.2_2025-06-29/4811.TQgVr5Sa6uDFtWXdTS5wfw.toml new file mode 100644 index 00000000000..cefe0bb045c --- /dev/null +++ b/changes/22.2_2025-06-29/4811.TQgVr5Sa6uDFtWXdTS5wfw.toml @@ -0,0 +1,5 @@ +internal = "Bump github/codeql-action from 3.28.16 to 3.28.18" +[[pull_requests]] +uid = "4811" +author_uid = "dependabot" +closes_threads = [] diff --git a/changes/22.2_2025-06-29/4812.i4aqsTfCkdEs8uYNYS59si.toml b/changes/22.2_2025-06-29/4812.i4aqsTfCkdEs8uYNYS59si.toml new file mode 100644 index 00000000000..0382ab61f34 --- /dev/null +++ b/changes/22.2_2025-06-29/4812.i4aqsTfCkdEs8uYNYS59si.toml @@ -0,0 +1,5 @@ +internal = "Bump actions/setup-python from 5.5.0 to 5.6.0" +[[pull_requests]] +uid = "4812" +author_uid = "dependabot" +closes_threads = [] diff --git a/changes/22.2_2025-06-29/4813.cnbzL2eSRzj3i9NcUMFyFo.toml b/changes/22.2_2025-06-29/4813.cnbzL2eSRzj3i9NcUMFyFo.toml new file mode 100644 index 00000000000..afd93290d34 --- /dev/null +++ b/changes/22.2_2025-06-29/4813.cnbzL2eSRzj3i9NcUMFyFo.toml @@ -0,0 +1,5 @@ +internal = "Bump dependabot/fetch-metadata from 2.3.0 to 2.4.0" +[[pull_requests]] +uid = "4813" +author_uid = "dependabot" +closes_threads = [] diff --git a/changes/22.2_2025-06-29/4814.RMQVXTNywcpBQ3HkX2TuyA.toml b/changes/22.2_2025-06-29/4814.RMQVXTNywcpBQ3HkX2TuyA.toml new file mode 100644 index 00000000000..789f6ebdc68 --- /dev/null +++ b/changes/22.2_2025-06-29/4814.RMQVXTNywcpBQ3HkX2TuyA.toml @@ -0,0 +1,5 @@ +internal = "Bump codecov/codecov-action from 5.4.2 to 5.4.3" +[[pull_requests]] +uid = "4814" +author_uid = "dependabot" +closes_threads = [] diff --git a/changes/22.2_2025-06-29/4815.9dLSFHFozQiAM7oCpX4NyL.toml b/changes/22.2_2025-06-29/4815.9dLSFHFozQiAM7oCpX4NyL.toml new file mode 100644 index 00000000000..e2559792f7b --- /dev/null +++ b/changes/22.2_2025-06-29/4815.9dLSFHFozQiAM7oCpX4NyL.toml @@ -0,0 +1,5 @@ +internal = "Bump codecov/test-results-action from 1.1.0 to 1.1.1" +[[pull_requests]] +uid = "4815" +author_uid = "dependabot" +closes_threads = [] diff --git a/changes/22.2_2025-06-29/4816.hhYVDfdzUgoQoMNRKkCDjb.toml b/changes/22.2_2025-06-29/4816.hhYVDfdzUgoQoMNRKkCDjb.toml new file mode 100644 index 00000000000..ade061585de --- /dev/null +++ b/changes/22.2_2025-06-29/4816.hhYVDfdzUgoQoMNRKkCDjb.toml @@ -0,0 +1,5 @@ +internal = "Fix Typo in `TelegramObject._get_attrs`" +[[pull_requests]] +uid = "4816" +author_uid = "harshil21" +closes_threads = [] diff --git a/changes/22.2_2025-06-29/4817.ZHx38jvj9zKRNZfQh9Xrpb.toml b/changes/22.2_2025-06-29/4817.ZHx38jvj9zKRNZfQh9Xrpb.toml new file mode 100644 index 00000000000..31e63a6a7ef --- /dev/null +++ b/changes/22.2_2025-06-29/4817.ZHx38jvj9zKRNZfQh9Xrpb.toml @@ -0,0 +1,5 @@ +bugfixes = "Allow for pattern matching empty inline queries" +[[pull_requests]] +uid = "4817" +author_uid = "locobott" +closes_threads = [] \ No newline at end of file diff --git a/changes/22.2_2025-06-29/4818.3VPDqqEWEhDCrTipFY8KKU.toml b/changes/22.2_2025-06-29/4818.3VPDqqEWEhDCrTipFY8KKU.toml new file mode 100644 index 00000000000..503e69ae82e --- /dev/null +++ b/changes/22.2_2025-06-29/4818.3VPDqqEWEhDCrTipFY8KKU.toml @@ -0,0 +1,12 @@ +bugfixes = """ +Correctly parse parameter ``allow_sending_without_reply`` in ``Message.reply_*`` when used in combination with ``do_quote=True``. + +.. hint:: + + Using ``dict`` valued input for ``do_quote`` along with passing ``allow_sending_without_reply`` is not supported and will raise an error. +""" + +[[pull_requests]] +uid = "4818" +author_uid = "Bibo-Joshi" +closes_threads = ["4807"] diff --git a/changes/22.2_2025-06-29/4820.7bFkjLSeWKdNVhThPpVMAT.toml b/changes/22.2_2025-06-29/4820.7bFkjLSeWKdNVhThPpVMAT.toml new file mode 100644 index 00000000000..f0b2f0f9ff0 --- /dev/null +++ b/changes/22.2_2025-06-29/4820.7bFkjLSeWKdNVhThPpVMAT.toml @@ -0,0 +1,5 @@ +dependencies = "Bump ``httpx`` from ~=0.27 to >=0.27,<0.29" +[[pull_requests]] +uid = "4820" +author_uid = "Bibo-Joshi" +closes_threads = ["4819"] diff --git a/changes/22.2_2025-06-29/4822.DrW3tJ3KoB8kTmHtNnNEpQ.toml b/changes/22.2_2025-06-29/4822.DrW3tJ3KoB8kTmHtNnNEpQ.toml new file mode 100644 index 00000000000..060021dc6af --- /dev/null +++ b/changes/22.2_2025-06-29/4822.DrW3tJ3KoB8kTmHtNnNEpQ.toml @@ -0,0 +1,5 @@ +other = "Improve Informativeness of Network Errors Raised by ``BaseRequest.post/retrieve``" + +[[pull_requests]] +uid = "4822" +author_uid = "Bibo-Joshi" diff --git a/changes/22.2_2025-06-29/4825.R7wiTzvN37KAV656s9kfnC.toml b/changes/22.2_2025-06-29/4825.R7wiTzvN37KAV656s9kfnC.toml new file mode 100644 index 00000000000..5f932e8254d --- /dev/null +++ b/changes/22.2_2025-06-29/4825.R7wiTzvN37KAV656s9kfnC.toml @@ -0,0 +1,5 @@ +other = "Add Python 3.14 Beta To Test Matrix. *Python 3.14 is not officially supported by PTB yet!*" +[[pull_requests]] +uid = "4825" +author_uid = "harshil21" +closes_threads = [] diff --git a/changes/22.2_2025-06-29/4830.EZzGEAk7DiFuedKPoQMMvd.toml b/changes/22.2_2025-06-29/4830.EZzGEAk7DiFuedKPoQMMvd.toml new file mode 100644 index 00000000000..40e5f0fb805 --- /dev/null +++ b/changes/22.2_2025-06-29/4830.EZzGEAk7DiFuedKPoQMMvd.toml @@ -0,0 +1,5 @@ +dependencies = "Update ``cachetools`` requirement from <6.1.0,>=5.3.3 to >=5.3.3,<6.2.0" + +[[pull_requests]] +uid = "4830" +author_uid = "dependabot" diff --git a/changes/22.2_2025-06-29/4834.oBWsiGWNMuoSXvJNom6N6A.toml b/changes/22.2_2025-06-29/4834.oBWsiGWNMuoSXvJNom6N6A.toml new file mode 100644 index 00000000000..db25128ceaa --- /dev/null +++ b/changes/22.2_2025-06-29/4834.oBWsiGWNMuoSXvJNom6N6A.toml @@ -0,0 +1,5 @@ +other = "Bump Version to v22.2" +[[pull_requests]] +uid = "4834" +author_uid = "Bibo-Joshi" +closes_threads = [] diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt deleted file mode 100644 index e207cc48175..00000000000 --- a/docs/requirements-docs.txt +++ /dev/null @@ -1,10 +0,0 @@ -chango~=0.4.0 -sphinx==8.2.3 -furo==2024.8.6 -furo-sphinx-search @ git+https://github.com/harshil21/furo-sphinx-search@v0.2.0.1 -sphinx-paramlinks==0.6.0 -sphinxcontrib-mermaid==1.0.0 -sphinx-copybutton==0.5.2 -sphinx-inline-tabs==2023.4.21 -# Temporary. See #4387 -sphinx-build-compatibility @ git+https://github.com/readthedocs/sphinx-build-compatibility.git@58aabc5f207c6c2421f23d3578adc0b14af57047 diff --git a/docs/source/conf.py b/docs/source/conf.py index a0352d2c509..86943cb3970 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -51,7 +51,6 @@ "sphinx_copybutton", "sphinx_inline_tabs", "sphinxcontrib.mermaid", - "sphinx_search.extension", ] # Temporary. See #4387 diff --git a/docs/source/telegram.animation.rst b/docs/source/telegram.animation.rst index 94b5f818721..4e654fad49c 100644 --- a/docs/source/telegram.animation.rst +++ b/docs/source/telegram.animation.rst @@ -6,4 +6,4 @@ Animation .. autoclass:: telegram.Animation :members: :show-inheritance: - :inherited-members: TelegramObject + :inherited-members: TelegramObject, object diff --git a/docs/source/telegram.audio.rst b/docs/source/telegram.audio.rst index 9e501f70141..563de6c0289 100644 --- a/docs/source/telegram.audio.rst +++ b/docs/source/telegram.audio.rst @@ -6,4 +6,4 @@ Audio .. autoclass:: telegram.Audio :members: :show-inheritance: - :inherited-members: TelegramObject + :inherited-members: TelegramObject, object diff --git a/docs/source/telegram.chat.rst b/docs/source/telegram.chat.rst index d69b08b60e8..df53940c4a7 100644 --- a/docs/source/telegram.chat.rst +++ b/docs/source/telegram.chat.rst @@ -5,4 +5,4 @@ Chat .. autoclass:: telegram.Chat :members: :show-inheritance: - :inherited-members: TelegramObject + :inherited-members: TelegramObject, object diff --git a/docs/source/telegram.chatfullinfo.rst b/docs/source/telegram.chatfullinfo.rst index 3bbc9fa9e18..7ba8f3d3828 100644 --- a/docs/source/telegram.chatfullinfo.rst +++ b/docs/source/telegram.chatfullinfo.rst @@ -5,4 +5,4 @@ ChatFullInfo .. autoclass:: telegram.ChatFullInfo :members: :show-inheritance: - :inherited-members: TelegramObject \ No newline at end of file + :inherited-members: TelegramObject, object \ No newline at end of file diff --git a/docs/source/telegram.document.rst b/docs/source/telegram.document.rst index e59a84ba674..1a337077069 100644 --- a/docs/source/telegram.document.rst +++ b/docs/source/telegram.document.rst @@ -5,4 +5,4 @@ Document .. autoclass:: telegram.Document :members: :show-inheritance: - :inherited-members: TelegramObject + :inherited-members: TelegramObject, object diff --git a/docs/source/telegram.paidmeessagepricechanged.rst b/docs/source/telegram.paidmessagepricechanged.rst similarity index 100% rename from docs/source/telegram.paidmeessagepricechanged.rst rename to docs/source/telegram.paidmessagepricechanged.rst diff --git a/docs/source/telegram.photosize.rst b/docs/source/telegram.photosize.rst index be044f1164b..53632ac9bd4 100644 --- a/docs/source/telegram.photosize.rst +++ b/docs/source/telegram.photosize.rst @@ -5,4 +5,4 @@ PhotoSize .. autoclass:: telegram.PhotoSize :members: :show-inheritance: - :inherited-members: TelegramObject + :inherited-members: TelegramObject, object diff --git a/docs/source/telegram.revenuewithdrawalstate.rst b/docs/source/telegram.revenuewithdrawalstate.rst index d3f7eef81cc..a8b0d9ef0ef 100644 --- a/docs/source/telegram.revenuewithdrawalstate.rst +++ b/docs/source/telegram.revenuewithdrawalstate.rst @@ -4,4 +4,3 @@ RevenueWithdrawalState .. autoclass:: telegram.RevenueWithdrawalState :members: :show-inheritance: - :inherited-members: TelegramObject diff --git a/docs/source/telegram.revenuewithdrawalstatefailed.rst b/docs/source/telegram.revenuewithdrawalstatefailed.rst index ac319c6a67a..63379122869 100644 --- a/docs/source/telegram.revenuewithdrawalstatefailed.rst +++ b/docs/source/telegram.revenuewithdrawalstatefailed.rst @@ -4,4 +4,3 @@ RevenueWithdrawalStateFailed .. autoclass:: telegram.RevenueWithdrawalStateFailed :members: :show-inheritance: - :inherited-members: TelegramObject diff --git a/docs/source/telegram.revenuewithdrawalstatepending.rst b/docs/source/telegram.revenuewithdrawalstatepending.rst index 19a74e5f28c..3c2110271c0 100644 --- a/docs/source/telegram.revenuewithdrawalstatepending.rst +++ b/docs/source/telegram.revenuewithdrawalstatepending.rst @@ -4,4 +4,3 @@ RevenueWithdrawalStatePending .. autoclass:: telegram.RevenueWithdrawalStatePending :members: :show-inheritance: - :inherited-members: TelegramObject diff --git a/docs/source/telegram.revenuewithdrawalstatesucceeded.rst b/docs/source/telegram.revenuewithdrawalstatesucceeded.rst index 7f7980e799f..40bd6fdb5c7 100644 --- a/docs/source/telegram.revenuewithdrawalstatesucceeded.rst +++ b/docs/source/telegram.revenuewithdrawalstatesucceeded.rst @@ -4,4 +4,3 @@ RevenueWithdrawalStateSucceeded .. autoclass:: telegram.RevenueWithdrawalStateSucceeded :members: :show-inheritance: - :inherited-members: TelegramObject diff --git a/docs/source/telegram.startransaction.rst b/docs/source/telegram.startransaction.rst index 42f84e39b67..b8a68c8e99e 100644 --- a/docs/source/telegram.startransaction.rst +++ b/docs/source/telegram.startransaction.rst @@ -4,4 +4,3 @@ StarTransaction .. autoclass:: telegram.StarTransaction :members: :show-inheritance: - :inherited-members: TelegramObject diff --git a/docs/source/telegram.startransactions.rst b/docs/source/telegram.startransactions.rst index 1f1860920b5..e71439c8c87 100644 --- a/docs/source/telegram.startransactions.rst +++ b/docs/source/telegram.startransactions.rst @@ -4,5 +4,4 @@ StarTransactions .. autoclass:: telegram.StarTransactions :members: :show-inheritance: - :inherited-members: TelegramObject diff --git a/docs/source/telegram.sticker.rst b/docs/source/telegram.sticker.rst index 65b4a0f23c6..459629b7ecc 100644 --- a/docs/source/telegram.sticker.rst +++ b/docs/source/telegram.sticker.rst @@ -6,4 +6,4 @@ Sticker .. autoclass:: telegram.Sticker :members: :show-inheritance: - :inherited-members: TelegramObject + :inherited-members: TelegramObject, object diff --git a/docs/source/telegram.transactionpartner.rst b/docs/source/telegram.transactionpartner.rst index 9ccca02cec0..1970cfb3f94 100644 --- a/docs/source/telegram.transactionpartner.rst +++ b/docs/source/telegram.transactionpartner.rst @@ -4,4 +4,3 @@ TransactionPartner .. autoclass:: telegram.TransactionPartner :members: :show-inheritance: - :inherited-members: TelegramObject diff --git a/docs/source/telegram.transactionpartnerchat.rst b/docs/source/telegram.transactionpartnerchat.rst index d57cf128378..3f278f05d80 100644 --- a/docs/source/telegram.transactionpartnerchat.rst +++ b/docs/source/telegram.transactionpartnerchat.rst @@ -4,4 +4,3 @@ TransactionPartnerChat .. autoclass:: telegram.TransactionPartnerChat :members: :show-inheritance: - :inherited-members: TransactionPartner diff --git a/docs/source/telegram.transactionpartnerfragment.rst b/docs/source/telegram.transactionpartnerfragment.rst index c65f9262f81..dbdad66f2df 100644 --- a/docs/source/telegram.transactionpartnerfragment.rst +++ b/docs/source/telegram.transactionpartnerfragment.rst @@ -4,4 +4,3 @@ TransactionPartnerFragment .. autoclass:: telegram.TransactionPartnerFragment :members: :show-inheritance: - :inherited-members: TransactionPartner diff --git a/docs/source/telegram.transactionpartnerother.rst b/docs/source/telegram.transactionpartnerother.rst index b0c14f0713c..cbc4c41be52 100644 --- a/docs/source/telegram.transactionpartnerother.rst +++ b/docs/source/telegram.transactionpartnerother.rst @@ -4,4 +4,3 @@ TransactionPartnerOther .. autoclass:: telegram.TransactionPartnerOther :members: :show-inheritance: - :inherited-members: TransactionPartner diff --git a/docs/source/telegram.transactionpartnertelegramads.rst b/docs/source/telegram.transactionpartnertelegramads.rst index ce9a52a117f..8304bc84a06 100644 --- a/docs/source/telegram.transactionpartnertelegramads.rst +++ b/docs/source/telegram.transactionpartnertelegramads.rst @@ -4,4 +4,3 @@ TransactionPartnerTelegramAds .. autoclass:: telegram.TransactionPartnerTelegramAds :members: :show-inheritance: - :inherited-members: TransactionPartner diff --git a/docs/source/telegram.transactionpartnertelegramapi.rst b/docs/source/telegram.transactionpartnertelegramapi.rst index 9aeba6b94b8..619b4a0c89f 100644 --- a/docs/source/telegram.transactionpartnertelegramapi.rst +++ b/docs/source/telegram.transactionpartnertelegramapi.rst @@ -4,4 +4,3 @@ TransactionPartnerTelegramApi .. autoclass:: telegram.TransactionPartnerTelegramApi :members: :show-inheritance: - :inherited-members: TransactionPartner diff --git a/docs/source/telegram.transactionpartneruser.rst b/docs/source/telegram.transactionpartneruser.rst index def37495344..7709bd668c4 100644 --- a/docs/source/telegram.transactionpartneruser.rst +++ b/docs/source/telegram.transactionpartneruser.rst @@ -4,4 +4,3 @@ TransactionPartnerUser .. autoclass:: telegram.TransactionPartnerUser :members: :show-inheritance: - :inherited-members: TransactionPartner diff --git a/docs/source/telegram.video.rst b/docs/source/telegram.video.rst index 34c81eb242a..bcda1026431 100644 --- a/docs/source/telegram.video.rst +++ b/docs/source/telegram.video.rst @@ -6,4 +6,4 @@ Video .. autoclass:: telegram.Video :members: :show-inheritance: - :inherited-members: TelegramObject \ No newline at end of file + :inherited-members: TelegramObject, object \ No newline at end of file diff --git a/docs/source/telegram.videonote.rst b/docs/source/telegram.videonote.rst index 5217acb0479..e7b504fb515 100644 --- a/docs/source/telegram.videonote.rst +++ b/docs/source/telegram.videonote.rst @@ -6,4 +6,4 @@ VideoNote .. autoclass:: telegram.VideoNote :members: :show-inheritance: - :inherited-members: TelegramObject \ No newline at end of file + :inherited-members: TelegramObject, object \ No newline at end of file diff --git a/docs/source/telegram.voice.rst b/docs/source/telegram.voice.rst index b3667b6edcb..b1530967bd2 100644 --- a/docs/source/telegram.voice.rst +++ b/docs/source/telegram.voice.rst @@ -6,4 +6,4 @@ Voice .. autoclass:: telegram.Voice :members: :show-inheritance: - :inherited-members: TelegramObject + :inherited-members: TelegramObject, object diff --git a/docs/substitutions/global.rst b/docs/substitutions/global.rst index 8fb9e9360d7..c161278591a 100644 --- a/docs/substitutions/global.rst +++ b/docs/substitutions/global.rst @@ -80,7 +80,7 @@ .. |reply_quote| replace:: If set to :obj:`True`, the reply is sent as an actual reply to this message. If ``reply_to_message_id`` is passed, this parameter will be ignored. Default: :obj:`True` in group chats and :obj:`False` in private chats. -.. |do_quote| replace:: If set to :obj:`True`, the replied message is quoted. For a dict, it must be the output of :meth:`~telegram.Message.build_reply_arguments` to specify exact ``reply_parameters``. If ``reply_to_message_id`` or ``reply_parameters`` are passed, this parameter will be ignored. Default: :obj:`True` in group chats and :obj:`False` in private chats. +.. |do_quote| replace:: If set to :obj:`True`, the replied message is quoted. For a dict, it must be the output of :meth:`~telegram.Message.build_reply_arguments` to specify exact ``reply_parameters``. If ``reply_to_message_id`` or ``reply_parameters`` are passed, this parameter will be ignored. When passing dict-valued input, ``do_quote`` is mutually exclusive with ``allow_sending_without_reply``. Default: :obj:`True` in group chats and :obj:`False` in private chats. .. |non_optional_story_argument| replace:: As of this version, this argument is now required. In accordance with our `stability policy `__, the signature will be kept as optional for now, though they are mandatory and an error will be raised if you don't pass it. @@ -101,3 +101,5 @@ .. |org-verify| replace:: `on behalf of the organization `__ .. |time-period-input| replace:: :class:`datetime.timedelta` objects are accepted in addition to plain :obj:`int` values. + +.. |time-period-int-deprecated| replace:: In a future major version this attribute will be of type :obj:`datetime.timedelta`. You can opt-in early by setting `PTB_TIMEDELTA=true` or ``PTB_TIMEDELTA=1`` as an environment variable. diff --git a/examples/rawapibot.py b/examples/rawapibot.py index b6a70fc3de0..34ac964c4b7 100644 --- a/examples/rawapibot.py +++ b/examples/rawapibot.py @@ -7,6 +7,7 @@ """ import asyncio import contextlib +import datetime as dtm import logging from typing import NoReturn @@ -47,7 +48,9 @@ async def main() -> NoReturn: async def echo(bot: Bot, update_id: int) -> int: """Echo the message the user sent.""" # Request updates after the last update_id - updates = await bot.get_updates(offset=update_id, timeout=10, allowed_updates=Update.ALL_TYPES) + updates = await bot.get_updates( + offset=update_id, timeout=dtm.timedelta(seconds=10), allowed_updates=Update.ALL_TYPES + ) for update in updates: next_update_id = update.update_id + 1 diff --git a/pyproject.toml b/pyproject.toml index 1ffe02f8efe..181fb0e0ed3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -36,9 +36,10 @@ classifiers = [ "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", "Programming Language :: Python :: 3.13", + "Programming Language :: Python :: 3.14", ] dependencies = [ - "httpx ~= 0.27", + "httpx >=0.27,<0.29", ] [project.urls] @@ -66,7 +67,7 @@ all = [ ] callback-data = [ # Cachetools doesn't have a strict stability policy. Let's be cautious for now. - "cachetools>=5.3.3,<5.6.0", + "cachetools>=5.3.3,<6.2.0", ] ext = [ "python-telegram-bot[callback-data,job-queue,rate-limiter,webhooks]", @@ -91,19 +92,64 @@ socks = [ ] webhooks = [ # tornado is rather stable, but let's not allow the next major release without prior testing - "tornado~=6.4", + "tornado~=6.5", ] +[dependency-groups] +tests = [ + # required for building the wheels for releases + "build", + # For the test suite + "pytest==8.4.0", + # needed because pytest doesn't come with native support for coroutines as tests + "pytest-asyncio==0.21.2", + # xdist runs tests in parallel + "pytest-xdist==3.6.1", + # Used for flaky tests (flaky decorator) + "flaky>=3.8.1", + # used in test_official for parsing tg docs + "beautifulsoup4", + # For testing with timezones. Might not be needed on all systems, but to ensure that unit tests + # run correctly on all systems, we include it here. + "tzdata", + # We've deprecated support pytz, but we still need it for testing that it works with the library. + "pytz", + # Install coverage: + "pytest-cov" +] +docs = [ + "chango~=0.4.0; python_version >= '3.12'", + "sphinx==8.2.3; python_version >= '3.11'", + "furo==2024.8.6", + "sphinx-paramlinks==0.6.0", + "sphinxcontrib-mermaid==1.0.0", + "sphinx-copybutton==0.5.2", + "sphinx-inline-tabs==2023.4.21", + # Temporary. See #4387 + "sphinx-build-compatibility @ git+https://github.com/readthedocs/sphinx-build-compatibility.git@58aabc5f207c6c2421f23d3578adc0b14af57047", + # For python 3.14 support, we need a version of pydantic-core >= 2.35.0, since it upgrades the + # rust toolchain, required for building the project. But there isn't a version of pydantic + # which allows that pydantic-core version yet, so we use the latest commit on the + # pydantic repository, which has the required version of pydantic-core. + # This should ideally be done in `chango`'s dependencies. We can remove this once a new pydantic + # version is released. + "pydantic @ git+https://github.com/pydantic/pydantic ; python_version >= '3.14'" +] +all = ["pre-commit", { include-group = "tests" }, { include-group = "docs" }] # HATCH [tool.hatch.version] # dynamically evaluates the `__version__` variable in that file source = "code" -path = "telegram/_version.py" -search-paths = ["telegram"] +path = "src/telegram/_version.py" -[tool.hatch.build] -packages = ["telegram"] +# See also https://github.com/pypa/hatch/issues/1230 for discussion +# the source distribution will include most of the files in the root directory +[tool.hatch.build.targets.sdist] +exclude = [".venv*", "venv*", ".github"] +# the wheel will only include the src/telegram package +[tool.hatch.build.targets.wheel] +packages = ["src/telegram"] # CHANGO [tool.chango] @@ -136,9 +182,9 @@ select = ["E", "F", "I", "PL", "UP", "RUF", "PTH", "C4", "B", "PIE", "SIM", "RET [tool.ruff.lint.per-file-ignores] "tests/*.py" = ["B018"] "tests/**.py" = ["RUF012", "ASYNC230", "DTZ", "ARG", "T201", "ASYNC109", "D", "S", "TRY"] -"telegram/**.py" = ["TRY003"] -"telegram/ext/_applicationbuilder.py" = ["TRY004"] -"telegram/ext/filters.py" = ["D102"] +"src/telegram/**.py" = ["TRY003"] +"src/telegram/ext/_applicationbuilder.py" = ["TRY004"] +"src/telegram/ext/filters.py" = ["D102"] "docs/**.py" = ["INP001", "ARG", "D", "TRY003", "S"] "examples/**.py" = ["ARG", "D", "S105", "TRY003"] @@ -166,6 +212,7 @@ exclude-protected = ["_unfrozen"] # PYTEST: [tool.pytest.ini_options] testpaths = ["tests"] +pythonpath = ["src"] addopts = "--no-success-flaky-report -rX" filterwarnings = [ "error", @@ -188,6 +235,7 @@ log_cli_format = "%(funcName)s - Line %(lineno)d - %(message)s" # MYPY: [tool.mypy] +mypy_path = "src" warn_unused_ignores = true warn_unused_configs = true disallow_untyped_defs = true @@ -230,12 +278,12 @@ ignore_missing_imports = true # COVERAGE: [tool.coverage.run] branch = true -source = ["telegram"] +source = ["src/telegram"] parallel = true concurrency = ["thread", "multiprocessing"] omit = [ "tests/", - "telegram/__main__.py" + "src/telegram/__main__.py" ] [tool.coverage.report] diff --git a/requirements-dev-all.txt b/requirements-dev-all.txt deleted file mode 100644 index 995e067c420..00000000000 --- a/requirements-dev-all.txt +++ /dev/null @@ -1,5 +0,0 @@ --e .[all] -# needed for pre-commit hooks in the git commit command -pre-commit --r requirements-unit-tests.txt --r docs/requirements-docs.txt diff --git a/requirements-unit-tests.txt b/requirements-unit-tests.txt deleted file mode 100644 index f90d2950f60..00000000000 --- a/requirements-unit-tests.txt +++ /dev/null @@ -1,23 +0,0 @@ --e . - -# required for building the wheels for releases -build - -# For the test suite -pytest==8.3.5 - -# needed because pytest doesn't come with native support for coroutines as tests -pytest-asyncio==0.21.2 - -# xdist runs tests in parallel -pytest-xdist==3.6.1 - -# Used for flaky tests (flaky decorator) -flaky>=3.8.1 - -# used in test_official for parsing tg docs -beautifulsoup4 - -# For testing with timezones. Might not be needed on all systems, but to ensure that unit tests -# run correctly on all systems, we include it here. -tzdata \ No newline at end of file diff --git a/telegram/__init__.py b/src/telegram/__init__.py similarity index 100% rename from telegram/__init__.py rename to src/telegram/__init__.py diff --git a/telegram/__main__.py b/src/telegram/__main__.py similarity index 100% rename from telegram/__main__.py rename to src/telegram/__main__.py diff --git a/telegram/_birthdate.py b/src/telegram/_birthdate.py similarity index 100% rename from telegram/_birthdate.py rename to src/telegram/_birthdate.py diff --git a/telegram/_bot.py b/src/telegram/_bot.py similarity index 99% rename from telegram/_bot.py rename to src/telegram/_bot.py index 90f6cf0bf42..56072fbe0d6 100644 --- a/telegram/_bot.py +++ b/src/telegram/_bot.py @@ -4519,7 +4519,7 @@ async def get_updates( self, offset: Optional[int] = None, limit: Optional[int] = None, - timeout: Optional[int] = None, + timeout: Optional[TimePeriod] = None, allowed_updates: Optional[Sequence[str]] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, @@ -4554,9 +4554,12 @@ async def get_updates( between :tg-const:`telegram.constants.PollingLimit.MIN_LIMIT`- :tg-const:`telegram.constants.PollingLimit.MAX_LIMIT` are accepted. Defaults to ``100``. - timeout (:obj:`int`, optional): Timeout in seconds for long polling. Defaults to ``0``, - i.e. usual short polling. Should be positive, short polling should be used for - testing purposes only. + timeout (:obj:`int` | :class:`datetime.timedelta`, optional): Timeout in seconds for + long polling. Defaults to ``0``, i.e. usual short polling. Should be positive, + short polling should be used for testing purposes only. + + .. versionchanged:: v22.2 + |time-period-input| allowed_updates (Sequence[:obj:`str`]), optional): A sequence the types of updates you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. @@ -4591,6 +4594,12 @@ async def get_updates( else: arg_read_timeout = self._request[0].read_timeout or 0 + read_timeout = ( + (arg_read_timeout + timeout.total_seconds()) + if isinstance(timeout, dtm.timedelta) + else (arg_read_timeout + timeout if timeout else arg_read_timeout) + ) + # Ideally we'd use an aggressive read timeout for the polling. However, # * Short polling should return within 2 seconds. # * Long polling poses a different problem: the connection might have been dropped while @@ -4601,7 +4610,7 @@ async def get_updates( await self._post( "getUpdates", data, - read_timeout=arg_read_timeout + timeout if timeout else arg_read_timeout, + read_timeout=read_timeout, write_timeout=write_timeout, connect_timeout=connect_timeout, pool_timeout=pool_timeout, diff --git a/telegram/_botcommand.py b/src/telegram/_botcommand.py similarity index 100% rename from telegram/_botcommand.py rename to src/telegram/_botcommand.py diff --git a/telegram/_botcommandscope.py b/src/telegram/_botcommandscope.py similarity index 100% rename from telegram/_botcommandscope.py rename to src/telegram/_botcommandscope.py diff --git a/telegram/_botdescription.py b/src/telegram/_botdescription.py similarity index 100% rename from telegram/_botdescription.py rename to src/telegram/_botdescription.py diff --git a/telegram/_botname.py b/src/telegram/_botname.py similarity index 100% rename from telegram/_botname.py rename to src/telegram/_botname.py diff --git a/telegram/_business.py b/src/telegram/_business.py similarity index 100% rename from telegram/_business.py rename to src/telegram/_business.py diff --git a/telegram/_callbackquery.py b/src/telegram/_callbackquery.py similarity index 100% rename from telegram/_callbackquery.py rename to src/telegram/_callbackquery.py diff --git a/telegram/_chat.py b/src/telegram/_chat.py similarity index 100% rename from telegram/_chat.py rename to src/telegram/_chat.py diff --git a/telegram/_chatadministratorrights.py b/src/telegram/_chatadministratorrights.py similarity index 100% rename from telegram/_chatadministratorrights.py rename to src/telegram/_chatadministratorrights.py diff --git a/telegram/_chatbackground.py b/src/telegram/_chatbackground.py similarity index 100% rename from telegram/_chatbackground.py rename to src/telegram/_chatbackground.py diff --git a/telegram/_chatboost.py b/src/telegram/_chatboost.py similarity index 100% rename from telegram/_chatboost.py rename to src/telegram/_chatboost.py diff --git a/telegram/_chatfullinfo.py b/src/telegram/_chatfullinfo.py similarity index 92% rename from telegram/_chatfullinfo.py rename to src/telegram/_chatfullinfo.py index 4b0fae53c6b..1850429b027 100644 --- a/telegram/_chatfullinfo.py +++ b/src/telegram/_chatfullinfo.py @@ -20,7 +20,7 @@ """This module contains an object that represents a Telegram ChatFullInfo.""" import datetime as dtm from collections.abc import Sequence -from typing import TYPE_CHECKING, Optional +from typing import TYPE_CHECKING, Optional, Union from telegram._birthdate import Birthdate from telegram._chat import Chat, _ChatBase @@ -29,9 +29,18 @@ from telegram._files.chatphoto import ChatPhoto from telegram._gifts import AcceptedGiftTypes from telegram._reaction import ReactionType -from telegram._utils.argumentparsing import de_json_optional, de_list_optional, parse_sequence_arg -from telegram._utils.datetime import extract_tzinfo_from_defaults, from_timestamp -from telegram._utils.types import JSONDict +from telegram._utils.argumentparsing import ( + de_json_optional, + de_list_optional, + parse_sequence_arg, + to_timedelta, +) +from telegram._utils.datetime import ( + extract_tzinfo_from_defaults, + from_timestamp, + get_timedelta_value, +) +from telegram._utils.types import JSONDict, TimePeriod from telegram._utils.warnings import warn from telegram._utils.warnings_transition import ( build_deprecation_warning_message, @@ -166,17 +175,23 @@ class ChatFullInfo(_ChatBase): (by sending date). permissions (:class:`telegram.ChatPermissions`): Optional. Default chat member permissions, for groups and supergroups. - slow_mode_delay (:obj:`int`, optional): For supergroups, the minimum allowed delay between - consecutive messages sent by each unprivileged user. + slow_mode_delay (:obj:`int` | :class:`datetime.timedelta`, optional): For supergroups, + the minimum allowed delay between consecutive messages sent by each unprivileged user. + + .. versionchanged:: v22.2 + |time-period-input| unrestrict_boost_count (:obj:`int`, optional): For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions. .. versionadded:: 21.0 - message_auto_delete_time (:obj:`int`, optional): The time after which all messages sent to - the chat will be automatically deleted; in seconds. + message_auto_delete_time (:obj:`int` | :class:`datetime.timedelta`, optional): The time + after which all messages sent to the chat will be automatically deleted; in seconds. .. versionadded:: 13.4 + + .. versionchanged:: v22.2 + |time-period-input| has_aggressive_anti_spam_enabled (:obj:`bool`, optional): :obj:`True`, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. @@ -331,17 +346,23 @@ class ChatFullInfo(_ChatBase): (by sending date). permissions (:class:`telegram.ChatPermissions`): Optional. Default chat member permissions, for groups and supergroups. - slow_mode_delay (:obj:`int`): Optional. For supergroups, the minimum allowed delay between - consecutive messages sent by each unprivileged user. + slow_mode_delay (:obj:`int` | :class:`datetime.timedelta`): Optional. For supergroups, + the minimum allowed delay between consecutive messages sent by each unprivileged user. + + .. deprecated:: v22.2 + |time-period-int-deprecated| unrestrict_boost_count (:obj:`int`): Optional. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions. .. versionadded:: 21.0 - message_auto_delete_time (:obj:`int`): Optional. The time after which all messages sent to - the chat will be automatically deleted; in seconds. + message_auto_delete_time (:obj:`int` | :class:`datetime.timedelta`): Optional. The time + after which all messages sent to the chat will be automatically deleted; in seconds. .. versionadded:: 13.4 + + .. deprecated:: v22.2 + |time-period-int-deprecated| has_aggressive_anti_spam_enabled (:obj:`bool`): Optional. :obj:`True`, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. @@ -383,6 +404,8 @@ class ChatFullInfo(_ChatBase): __slots__ = ( "_can_send_gift", + "_message_auto_delete_time", + "_slow_mode_delay", "accent_color_id", "accepted_gift_types", "active_usernames", @@ -411,14 +434,12 @@ class ChatFullInfo(_ChatBase): "linked_chat_id", "location", "max_reaction_count", - "message_auto_delete_time", "permissions", "personal_chat", "photo", "pinned_message", "profile_accent_color_id", "profile_background_custom_emoji_id", - "slow_mode_delay", "sticker_set_name", "unrestrict_boost_count", ) @@ -456,9 +477,9 @@ def __init__( invite_link: Optional[str] = None, pinned_message: Optional["Message"] = None, permissions: Optional[ChatPermissions] = None, - slow_mode_delay: Optional[int] = None, + slow_mode_delay: Optional[TimePeriod] = None, unrestrict_boost_count: Optional[int] = None, - message_auto_delete_time: Optional[int] = None, + message_auto_delete_time: Optional[TimePeriod] = None, has_aggressive_anti_spam_enabled: Optional[bool] = None, has_hidden_members: Optional[bool] = None, has_protected_content: Optional[bool] = None, @@ -513,9 +534,9 @@ def __init__( self.invite_link: Optional[str] = invite_link self.pinned_message: Optional[Message] = pinned_message self.permissions: Optional[ChatPermissions] = permissions - self.slow_mode_delay: Optional[int] = slow_mode_delay - self.message_auto_delete_time: Optional[int] = ( - int(message_auto_delete_time) if message_auto_delete_time is not None else None + self._slow_mode_delay: Optional[dtm.timedelta] = to_timedelta(slow_mode_delay) + self._message_auto_delete_time: Optional[dtm.timedelta] = to_timedelta( + message_auto_delete_time ) self.has_protected_content: Optional[bool] = has_protected_content self.has_visible_history: Optional[bool] = has_visible_history @@ -576,6 +597,16 @@ def can_send_gift(self) -> Optional[bool]: ) return self._can_send_gift + @property + def slow_mode_delay(self) -> Optional[Union[int, dtm.timedelta]]: + return get_timedelta_value(self._slow_mode_delay, attribute="slow_mode_delay") + + @property + def message_auto_delete_time(self) -> Optional[Union[int, dtm.timedelta]]: + return get_timedelta_value( + self._message_auto_delete_time, attribute="message_auto_delete_time" + ) + @classmethod def de_json(cls, data: JSONDict, bot: Optional["Bot"] = None) -> "ChatFullInfo": """See :meth:`telegram.TelegramObject.de_json`.""" diff --git a/telegram/_chatinvitelink.py b/src/telegram/_chatinvitelink.py similarity index 86% rename from telegram/_chatinvitelink.py rename to src/telegram/_chatinvitelink.py index 289ee48bdba..cf973a20281 100644 --- a/telegram/_chatinvitelink.py +++ b/src/telegram/_chatinvitelink.py @@ -18,13 +18,17 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents an invite link for a chat.""" import datetime as dtm -from typing import TYPE_CHECKING, Optional +from typing import TYPE_CHECKING, Optional, Union from telegram._telegramobject import TelegramObject from telegram._user import User -from telegram._utils.argumentparsing import de_json_optional -from telegram._utils.datetime import extract_tzinfo_from_defaults, from_timestamp -from telegram._utils.types import JSONDict +from telegram._utils.argumentparsing import de_json_optional, to_timedelta +from telegram._utils.datetime import ( + extract_tzinfo_from_defaults, + from_timestamp, + get_timedelta_value, +) +from telegram._utils.types import JSONDict, TimePeriod if TYPE_CHECKING: from telegram import Bot @@ -70,10 +74,13 @@ class ChatInviteLink(TelegramObject): created using this link. .. versionadded:: 13.8 - subscription_period (:obj:`int`, optional): The number of seconds the subscription will be - active for before the next payment. + subscription_period (:obj:`int` | :class:`datetime.timedelta`, optional): The number of + seconds the subscription will be active for before the next payment. .. versionadded:: 21.5 + + .. versionchanged:: v22.2 + |time-period-input| subscription_price (:obj:`int`, optional): The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link. @@ -107,10 +114,13 @@ class ChatInviteLink(TelegramObject): created using this link. .. versionadded:: 13.8 - subscription_period (:obj:`int`): Optional. The number of seconds the subscription will be - active for before the next payment. + subscription_period (:obj:`int` | :class:`datetime.timedelta`): Optional. The number of + seconds the subscription will be active for before the next payment. .. versionadded:: 21.5 + + .. deprecated:: v22.2 + |time-period-int-deprecated| subscription_price (:obj:`int`): Optional. The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link. @@ -120,6 +130,7 @@ class ChatInviteLink(TelegramObject): """ __slots__ = ( + "_subscription_period", "creates_join_request", "creator", "expire_date", @@ -129,7 +140,6 @@ class ChatInviteLink(TelegramObject): "member_limit", "name", "pending_join_request_count", - "subscription_period", "subscription_price", ) @@ -144,7 +154,7 @@ def __init__( member_limit: Optional[int] = None, name: Optional[str] = None, pending_join_request_count: Optional[int] = None, - subscription_period: Optional[int] = None, + subscription_period: Optional[TimePeriod] = None, subscription_price: Optional[int] = None, *, api_kwargs: Optional[JSONDict] = None, @@ -164,7 +174,7 @@ def __init__( self.pending_join_request_count: Optional[int] = ( int(pending_join_request_count) if pending_join_request_count is not None else None ) - self.subscription_period: Optional[int] = subscription_period + self._subscription_period: Optional[dtm.timedelta] = to_timedelta(subscription_period) self.subscription_price: Optional[int] = subscription_price self._id_attrs = ( @@ -177,6 +187,10 @@ def __init__( self._freeze() + @property + def subscription_period(self) -> Optional[Union[int, dtm.timedelta]]: + return get_timedelta_value(self._subscription_period, attribute="subscription_period") + @classmethod def de_json(cls, data: JSONDict, bot: Optional["Bot"] = None) -> "ChatInviteLink": """See :meth:`telegram.TelegramObject.de_json`.""" diff --git a/telegram/_chatjoinrequest.py b/src/telegram/_chatjoinrequest.py similarity index 100% rename from telegram/_chatjoinrequest.py rename to src/telegram/_chatjoinrequest.py diff --git a/telegram/_chatlocation.py b/src/telegram/_chatlocation.py similarity index 100% rename from telegram/_chatlocation.py rename to src/telegram/_chatlocation.py diff --git a/telegram/_chatmember.py b/src/telegram/_chatmember.py similarity index 100% rename from telegram/_chatmember.py rename to src/telegram/_chatmember.py diff --git a/telegram/_chatmemberupdated.py b/src/telegram/_chatmemberupdated.py similarity index 100% rename from telegram/_chatmemberupdated.py rename to src/telegram/_chatmemberupdated.py diff --git a/telegram/_chatpermissions.py b/src/telegram/_chatpermissions.py similarity index 100% rename from telegram/_chatpermissions.py rename to src/telegram/_chatpermissions.py diff --git a/telegram/_choseninlineresult.py b/src/telegram/_choseninlineresult.py similarity index 100% rename from telegram/_choseninlineresult.py rename to src/telegram/_choseninlineresult.py diff --git a/telegram/_copytextbutton.py b/src/telegram/_copytextbutton.py similarity index 100% rename from telegram/_copytextbutton.py rename to src/telegram/_copytextbutton.py diff --git a/telegram/_dice.py b/src/telegram/_dice.py similarity index 100% rename from telegram/_dice.py rename to src/telegram/_dice.py diff --git a/telegram/_files/__init__.py b/src/telegram/_files/__init__.py similarity index 100% rename from telegram/_files/__init__.py rename to src/telegram/_files/__init__.py diff --git a/telegram/_files/_basemedium.py b/src/telegram/_files/_basemedium.py similarity index 100% rename from telegram/_files/_basemedium.py rename to src/telegram/_files/_basemedium.py diff --git a/telegram/_files/_basethumbedmedium.py b/src/telegram/_files/_basethumbedmedium.py similarity index 100% rename from telegram/_files/_basethumbedmedium.py rename to src/telegram/_files/_basethumbedmedium.py diff --git a/telegram/_files/_inputstorycontent.py b/src/telegram/_files/_inputstorycontent.py similarity index 92% rename from telegram/_files/_inputstorycontent.py rename to src/telegram/_files/_inputstorycontent.py index 1eaf14682f3..dd8f25c5810 100644 --- a/telegram/_files/_inputstorycontent.py +++ b/src/telegram/_files/_inputstorycontent.py @@ -25,6 +25,7 @@ from telegram._files.inputfile import InputFile from telegram._telegramobject import TelegramObject from telegram._utils import enum +from telegram._utils.argumentparsing import to_timedelta from telegram._utils.files import parse_file_input from telegram._utils.types import FileInput, JSONDict @@ -158,18 +159,8 @@ def __init__( with self._unfrozen(): self.video: Union[str, InputFile] = self._parse_file_input(video) - self.duration: Optional[dtm.timedelta] = self._parse_period_arg(duration) - self.cover_frame_timestamp: Optional[dtm.timedelta] = self._parse_period_arg( + self.duration: Optional[dtm.timedelta] = to_timedelta(duration) + self.cover_frame_timestamp: Optional[dtm.timedelta] = to_timedelta( cover_frame_timestamp ) self.is_animation: Optional[bool] = is_animation - - # This helper is temporarly here until we can use `argumentparsing.parse_period_arg` - # from https://github.com/python-telegram-bot/python-telegram-bot/pull/4750 - @staticmethod - def _parse_period_arg(arg: Optional[Union[float, dtm.timedelta]]) -> Optional[dtm.timedelta]: - if arg is None: - return None - if isinstance(arg, dtm.timedelta): - return arg - return dtm.timedelta(seconds=arg) diff --git a/telegram/_files/animation.py b/src/telegram/_files/animation.py similarity index 79% rename from telegram/_files/animation.py rename to src/telegram/_files/animation.py index 537ffc0a0db..e2f0315d10b 100644 --- a/telegram/_files/animation.py +++ b/src/telegram/_files/animation.py @@ -17,11 +17,14 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram Animation.""" -from typing import Optional +import datetime as dtm +from typing import Optional, Union from telegram._files._basethumbedmedium import _BaseThumbedMedium from telegram._files.photosize import PhotoSize -from telegram._utils.types import JSONDict +from telegram._utils.argumentparsing import to_timedelta +from telegram._utils.datetime import get_timedelta_value +from telegram._utils.types import JSONDict, TimePeriod class Animation(_BaseThumbedMedium): @@ -41,7 +44,11 @@ class Animation(_BaseThumbedMedium): Can't be used to download or reuse the file. width (:obj:`int`): Video width as defined by the sender. height (:obj:`int`): Video height as defined by the sender. - duration (:obj:`int`): Duration of the video in seconds as defined by the sender. + duration (:obj:`int` | :class:`datetime.timedelta`, optional): Duration of the video + in seconds as defined by the sender. + + .. versionchanged:: v22.2 + |time-period-input| file_name (:obj:`str`, optional): Original animation filename as defined by the sender. mime_type (:obj:`str`, optional): MIME type of the file as defined by the sender. file_size (:obj:`int`, optional): File size in bytes. @@ -58,7 +65,11 @@ class Animation(_BaseThumbedMedium): Can't be used to download or reuse the file. width (:obj:`int`): Video width as defined by the sender. height (:obj:`int`): Video height as defined by the sender. - duration (:obj:`int`): Duration of the video in seconds as defined by the sender. + duration (:obj:`int` | :class:`datetime.timedelta`): Duration of the video in seconds + as defined by the sender. + + .. deprecated:: v22.2 + |time-period-int-deprecated| file_name (:obj:`str`): Optional. Original animation filename as defined by the sender. mime_type (:obj:`str`): Optional. MIME type of the file as defined by the sender. file_size (:obj:`int`): Optional. File size in bytes. @@ -69,7 +80,7 @@ class Animation(_BaseThumbedMedium): """ - __slots__ = ("duration", "file_name", "height", "mime_type", "width") + __slots__ = ("_duration", "file_name", "height", "mime_type", "width") def __init__( self, @@ -77,7 +88,7 @@ def __init__( file_unique_id: str, width: int, height: int, - duration: int, + duration: TimePeriod, file_name: Optional[str] = None, mime_type: Optional[str] = None, file_size: Optional[int] = None, @@ -96,7 +107,13 @@ def __init__( # Required self.width: int = width self.height: int = height - self.duration: int = duration + self._duration: dtm.timedelta = to_timedelta(duration) # Optional self.mime_type: Optional[str] = mime_type self.file_name: Optional[str] = file_name + + @property + def duration(self) -> Union[int, dtm.timedelta]: + return get_timedelta_value( # type: ignore[return-value] + self._duration, attribute="duration" + ) diff --git a/telegram/_files/audio.py b/src/telegram/_files/audio.py similarity index 80% rename from telegram/_files/audio.py rename to src/telegram/_files/audio.py index af5e420e1b2..0ae3588e1d1 100644 --- a/telegram/_files/audio.py +++ b/src/telegram/_files/audio.py @@ -17,11 +17,14 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram Audio.""" -from typing import Optional +import datetime as dtm +from typing import Optional, Union from telegram._files._basethumbedmedium import _BaseThumbedMedium from telegram._files.photosize import PhotoSize -from telegram._utils.types import JSONDict +from telegram._utils.argumentparsing import to_timedelta +from telegram._utils.datetime import get_timedelta_value +from telegram._utils.types import JSONDict, TimePeriod class Audio(_BaseThumbedMedium): @@ -39,7 +42,11 @@ class Audio(_BaseThumbedMedium): or reuse the file. file_unique_id (:obj:`str`): Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. - duration (:obj:`int`): Duration of the audio in seconds as defined by the sender. + duration (:obj:`int` | :class:`datetime.timedelta`): Duration of the audio in + seconds as defined by the sender. + + .. versionchanged:: v22.2 + |time-period-input| performer (:obj:`str`, optional): Performer of the audio as defined by the sender or by audio tags. title (:obj:`str`, optional): Title of the audio as defined by the sender or by audio tags. @@ -56,7 +63,11 @@ class Audio(_BaseThumbedMedium): or reuse the file. file_unique_id (:obj:`str`): Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. - duration (:obj:`int`): Duration of the audio in seconds as defined by the sender. + duration (:obj:`int` | :class:`datetime.timedelta`): Duration of the audio in seconds as + defined by the sender. + + .. deprecated:: v22.2 + |time-period-int-deprecated| performer (:obj:`str`): Optional. Performer of the audio as defined by the sender or by audio tags. title (:obj:`str`): Optional. Title of the audio as defined by the sender or by audio tags. @@ -71,13 +82,13 @@ class Audio(_BaseThumbedMedium): """ - __slots__ = ("duration", "file_name", "mime_type", "performer", "title") + __slots__ = ("_duration", "file_name", "mime_type", "performer", "title") def __init__( self, file_id: str, file_unique_id: str, - duration: int, + duration: TimePeriod, performer: Optional[str] = None, title: Optional[str] = None, mime_type: Optional[str] = None, @@ -96,9 +107,15 @@ def __init__( ) with self._unfrozen(): # Required - self.duration: int = duration + self._duration: dtm.timedelta = to_timedelta(duration) # Optional self.performer: Optional[str] = performer self.title: Optional[str] = title self.mime_type: Optional[str] = mime_type self.file_name: Optional[str] = file_name + + @property + def duration(self) -> Union[int, dtm.timedelta]: + return get_timedelta_value( # type: ignore[return-value] + self._duration, attribute="duration" + ) diff --git a/telegram/_files/chatphoto.py b/src/telegram/_files/chatphoto.py similarity index 100% rename from telegram/_files/chatphoto.py rename to src/telegram/_files/chatphoto.py diff --git a/telegram/_files/contact.py b/src/telegram/_files/contact.py similarity index 100% rename from telegram/_files/contact.py rename to src/telegram/_files/contact.py diff --git a/telegram/_files/document.py b/src/telegram/_files/document.py similarity index 100% rename from telegram/_files/document.py rename to src/telegram/_files/document.py diff --git a/telegram/_files/file.py b/src/telegram/_files/file.py similarity index 100% rename from telegram/_files/file.py rename to src/telegram/_files/file.py diff --git a/telegram/_files/inputfile.py b/src/telegram/_files/inputfile.py similarity index 100% rename from telegram/_files/inputfile.py rename to src/telegram/_files/inputfile.py diff --git a/telegram/_files/inputmedia.py b/src/telegram/_files/inputmedia.py similarity index 91% rename from telegram/_files/inputmedia.py rename to src/telegram/_files/inputmedia.py index 2b7e6b21fd5..7c831a8246f 100644 --- a/telegram/_files/inputmedia.py +++ b/src/telegram/_files/inputmedia.py @@ -17,6 +17,7 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """Base class for Telegram InputMedia Objects.""" +import datetime as dtm from collections.abc import Sequence from typing import Final, Optional, Union @@ -30,10 +31,11 @@ from telegram._messageentity import MessageEntity from telegram._telegramobject import TelegramObject from telegram._utils import enum -from telegram._utils.argumentparsing import parse_sequence_arg +from telegram._utils.argumentparsing import parse_sequence_arg, to_timedelta +from telegram._utils.datetime import get_timedelta_value from telegram._utils.defaultvalue import DEFAULT_NONE from telegram._utils.files import parse_file_input -from telegram._utils.types import FileInput, JSONDict, ODVInput +from telegram._utils.types import FileInput, JSONDict, ODVInput, TimePeriod from telegram.constants import InputMediaType MediaType = Union[Animation, Audio, Document, PhotoSize, Video] @@ -215,7 +217,10 @@ class InputPaidMediaVideo(InputPaidMedia): .. versionchanged:: 21.11 width (:obj:`int`, optional): Video width. height (:obj:`int`, optional): Video height. - duration (:obj:`int`, optional): Video duration in seconds. + duration (:obj:`int` | :class:`datetime.timedelta`, optional): Video duration in seconds. + + .. versionchanged:: v22.2 + |time-period-input| supports_streaming (:obj:`bool`, optional): Pass :obj:`True`, if the uploaded video is suitable for streaming. @@ -233,14 +238,17 @@ class InputPaidMediaVideo(InputPaidMedia): .. versionchanged:: 21.11 width (:obj:`int`): Optional. Video width. height (:obj:`int`): Optional. Video height. - duration (:obj:`int`): Optional. Video duration in seconds. + duration (:obj:`int` | :class:`datetime.timedelta`): Optional. Video duration in seconds. + + .. deprecated:: v22.2 + |time-period-int-deprecated| supports_streaming (:obj:`bool`): Optional. :obj:`True`, if the uploaded video is suitable for streaming. """ __slots__ = ( + "_duration", "cover", - "duration", "height", "start_timestamp", "supports_streaming", @@ -254,7 +262,7 @@ def __init__( thumbnail: Optional[FileInput] = None, width: Optional[int] = None, height: Optional[int] = None, - duration: Optional[int] = None, + duration: Optional[TimePeriod] = None, supports_streaming: Optional[bool] = None, cover: Optional[FileInput] = None, start_timestamp: Optional[int] = None, @@ -264,7 +272,7 @@ def __init__( if isinstance(media, Video): width = width if width is not None else media.width height = height if height is not None else media.height - duration = duration if duration is not None else media.duration + duration = duration if duration is not None else media._duration media = media.file_id else: # We use local_mode=True because we don't have access to the actual setting and want @@ -278,13 +286,17 @@ def __init__( ) self.width: Optional[int] = width self.height: Optional[int] = height - self.duration: Optional[int] = duration + self._duration: Optional[dtm.timedelta] = to_timedelta(duration) self.supports_streaming: Optional[bool] = supports_streaming self.cover: Optional[Union[InputFile, str]] = ( parse_file_input(cover, attach=True, local_mode=True) if cover else None ) self.start_timestamp: Optional[int] = start_timestamp + @property + def duration(self) -> Optional[Union[int, dtm.timedelta]]: + return get_timedelta_value(self._duration, attribute="duration") + class InputMediaAnimation(InputMedia): """Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent. @@ -322,7 +334,11 @@ class InputMediaAnimation(InputMedia): width (:obj:`int`, optional): Animation width. height (:obj:`int`, optional): Animation height. - duration (:obj:`int`, optional): Animation duration in seconds. + duration (:obj:`int` | :class:`datetime.timedelta`, optional): Animation duration + in seconds. + + .. versionchanged:: v22.2 + |time-period-input| has_spoiler (:obj:`bool`, optional): Pass :obj:`True`, if the animation needs to be covered with a spoiler animation. @@ -350,7 +366,11 @@ class InputMediaAnimation(InputMedia): * |alwaystuple| width (:obj:`int`): Optional. Animation width. height (:obj:`int`): Optional. Animation height. - duration (:obj:`int`): Optional. Animation duration in seconds. + duration (:obj:`int` | :class:`datetime.timedelta`): Optional. Animation duration + in seconds. + + .. deprecated:: v22.2 + |time-period-int-deprecated| has_spoiler (:obj:`bool`): Optional. :obj:`True`, if the animation is covered with a spoiler animation. @@ -364,7 +384,7 @@ class InputMediaAnimation(InputMedia): """ __slots__ = ( - "duration", + "_duration", "has_spoiler", "height", "show_caption_above_media", @@ -379,7 +399,7 @@ def __init__( parse_mode: ODVInput[str] = DEFAULT_NONE, width: Optional[int] = None, height: Optional[int] = None, - duration: Optional[int] = None, + duration: Optional[TimePeriod] = None, caption_entities: Optional[Sequence[MessageEntity]] = None, filename: Optional[str] = None, has_spoiler: Optional[bool] = None, @@ -391,7 +411,7 @@ def __init__( if isinstance(media, Animation): width = media.width if width is None else width height = media.height if height is None else height - duration = media.duration if duration is None else duration + duration = duration if duration is not None else media._duration media = media.file_id else: # We use local_mode=True because we don't have access to the actual setting and want @@ -412,10 +432,14 @@ def __init__( ) self.width: Optional[int] = width self.height: Optional[int] = height - self.duration: Optional[int] = duration + self._duration: Optional[dtm.timedelta] = to_timedelta(duration) self.has_spoiler: Optional[bool] = has_spoiler self.show_caption_above_media: Optional[bool] = show_caption_above_media + @property + def duration(self) -> Optional[Union[int, dtm.timedelta]]: + return get_timedelta_value(self._duration, attribute="duration") + class InputMediaPhoto(InputMedia): """Represents a photo to be sent. @@ -545,7 +569,10 @@ class InputMediaVideo(InputMedia): width (:obj:`int`, optional): Video width. height (:obj:`int`, optional): Video height. - duration (:obj:`int`, optional): Video duration in seconds. + duration (:obj:`int` | :class:`datetime.timedelta`, optional): Video duration in seconds. + + .. versionchanged:: v22.2 + |time-period-input| supports_streaming (:obj:`bool`, optional): Pass :obj:`True`, if the uploaded video is suitable for streaming. has_spoiler (:obj:`bool`, optional): Pass :obj:`True`, if the video needs to be covered @@ -582,7 +609,10 @@ class InputMediaVideo(InputMedia): * |alwaystuple| width (:obj:`int`): Optional. Video width. height (:obj:`int`): Optional. Video height. - duration (:obj:`int`): Optional. Video duration in seconds. + duration (:obj:`int` | :class:`datetime.timedelta`): Optional. Video duration in seconds. + + .. deprecated:: v22.2 + |time-period-int-deprecated| supports_streaming (:obj:`bool`): Optional. :obj:`True`, if the uploaded video is suitable for streaming. has_spoiler (:obj:`bool`): Optional. :obj:`True`, if the video is covered with a @@ -605,8 +635,8 @@ class InputMediaVideo(InputMedia): """ __slots__ = ( + "_duration", "cover", - "duration", "has_spoiler", "height", "show_caption_above_media", @@ -622,7 +652,7 @@ def __init__( caption: Optional[str] = None, width: Optional[int] = None, height: Optional[int] = None, - duration: Optional[int] = None, + duration: Optional[TimePeriod] = None, supports_streaming: Optional[bool] = None, parse_mode: ODVInput[str] = DEFAULT_NONE, caption_entities: Optional[Sequence[MessageEntity]] = None, @@ -638,7 +668,7 @@ def __init__( if isinstance(media, Video): width = width if width is not None else media.width height = height if height is not None else media.height - duration = duration if duration is not None else media.duration + duration = duration if duration is not None else media._duration media = media.file_id else: # We use local_mode=True because we don't have access to the actual setting and want @@ -656,7 +686,7 @@ def __init__( with self._unfrozen(): self.width: Optional[int] = width self.height: Optional[int] = height - self.duration: Optional[int] = duration + self._duration: Optional[dtm.timedelta] = to_timedelta(duration) self.thumbnail: Optional[Union[str, InputFile]] = self._parse_thumbnail_input( thumbnail ) @@ -668,6 +698,10 @@ def __init__( ) self.start_timestamp: Optional[int] = start_timestamp + @property + def duration(self) -> Optional[Union[int, dtm.timedelta]]: + return get_timedelta_value(self._duration, attribute="duration") + class InputMediaAudio(InputMedia): """Represents an audio file to be treated as music to be sent. @@ -703,7 +737,11 @@ class InputMediaAudio(InputMedia): .. versionchanged:: 20.0 |sequenceclassargs| - duration (:obj:`int`, optional): Duration of the audio in seconds as defined by the sender. + duration (:obj:`int` | :class:`datetime.timedelta`, optional): Duration of the audio + in seconds as defined by the sender. + + .. versionchanged:: v22.2 + |time-period-input| performer (:obj:`str`, optional): Performer of the audio as defined by the sender or by audio tags. title (:obj:`str`, optional): Title of the audio as defined by the sender or by audio tags. @@ -725,7 +763,11 @@ class InputMediaAudio(InputMedia): * |tupleclassattrs| * |alwaystuple| - duration (:obj:`int`): Optional. Duration of the audio in seconds. + duration (:obj:`int` | :class:`datetime.timedelta`): Optional. Duration of the audio + in seconds. + + .. deprecated:: v22.2 + |time-period-int-deprecated| performer (:obj:`str`): Optional. Performer of the audio as defined by the sender or by audio tags. title (:obj:`str`): Optional. Title of the audio as defined by the sender or by audio tags. @@ -735,14 +777,14 @@ class InputMediaAudio(InputMedia): """ - __slots__ = ("duration", "performer", "thumbnail", "title") + __slots__ = ("_duration", "performer", "thumbnail", "title") def __init__( self, media: Union[FileInput, Audio], caption: Optional[str] = None, parse_mode: ODVInput[str] = DEFAULT_NONE, - duration: Optional[int] = None, + duration: Optional[TimePeriod] = None, performer: Optional[str] = None, title: Optional[str] = None, caption_entities: Optional[Sequence[MessageEntity]] = None, @@ -752,7 +794,7 @@ def __init__( api_kwargs: Optional[JSONDict] = None, ): if isinstance(media, Audio): - duration = media.duration if duration is None else duration + duration = duration if duration is not None else media._duration performer = media.performer if performer is None else performer title = media.title if title is None else title media = media.file_id @@ -773,10 +815,14 @@ def __init__( self.thumbnail: Optional[Union[str, InputFile]] = self._parse_thumbnail_input( thumbnail ) - self.duration: Optional[int] = duration + self._duration: Optional[dtm.timedelta] = to_timedelta(duration) self.title: Optional[str] = title self.performer: Optional[str] = performer + @property + def duration(self) -> Optional[Union[int, dtm.timedelta]]: + return get_timedelta_value(self._duration, attribute="duration") + class InputMediaDocument(InputMedia): """Represents a general file to be sent. diff --git a/telegram/_files/inputprofilephoto.py b/src/telegram/_files/inputprofilephoto.py similarity index 93% rename from telegram/_files/inputprofilephoto.py rename to src/telegram/_files/inputprofilephoto.py index 8ec1ae93492..5a37ab6af80 100644 --- a/telegram/_files/inputprofilephoto.py +++ b/src/telegram/_files/inputprofilephoto.py @@ -24,6 +24,7 @@ from telegram import constants from telegram._telegramobject import TelegramObject from telegram._utils import enum +from telegram._utils.argumentparsing import to_timedelta from telegram._utils.files import parse_file_input from telegram._utils.types import FileInput, JSONDict @@ -134,9 +135,4 @@ def __init__( animation, attach=True, local_mode=True ) - if isinstance(main_frame_timestamp, dtm.timedelta): - self.main_frame_timestamp: Optional[dtm.timedelta] = main_frame_timestamp - elif main_frame_timestamp is None: - self.main_frame_timestamp = None - else: - self.main_frame_timestamp = dtm.timedelta(seconds=main_frame_timestamp) + self.main_frame_timestamp: Optional[dtm.timedelta] = to_timedelta(main_frame_timestamp) diff --git a/telegram/_files/inputsticker.py b/src/telegram/_files/inputsticker.py similarity index 100% rename from telegram/_files/inputsticker.py rename to src/telegram/_files/inputsticker.py diff --git a/telegram/_files/location.py b/src/telegram/_files/location.py similarity index 78% rename from telegram/_files/location.py rename to src/telegram/_files/location.py index 87c895b711a..e0bea4520ef 100644 --- a/telegram/_files/location.py +++ b/src/telegram/_files/location.py @@ -18,11 +18,14 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram Location.""" -from typing import Final, Optional +import datetime as dtm +from typing import Final, Optional, Union from telegram import constants from telegram._telegramobject import TelegramObject -from telegram._utils.types import JSONDict +from telegram._utils.argumentparsing import to_timedelta +from telegram._utils.datetime import get_timedelta_value +from telegram._utils.types import JSONDict, TimePeriod class Location(TelegramObject): @@ -36,8 +39,12 @@ class Location(TelegramObject): latitude (:obj:`float`): Latitude as defined by the sender. horizontal_accuracy (:obj:`float`, optional): The radius of uncertainty for the location, measured in meters; 0-:tg-const:`telegram.Location.HORIZONTAL_ACCURACY`. - live_period (:obj:`int`, optional): Time relative to the message sending date, during which - the location can be updated, in seconds. For active live locations only. + live_period (:obj:`int` | :class:`datetime.timedelta`, optional): Time relative to the + message sending date, during which the location can be updated, in seconds. For active + live locations only. + + .. versionchanged:: v22.2 + |time-period-input| heading (:obj:`int`, optional): The direction in which user is moving, in degrees; :tg-const:`telegram.Location.MIN_HEADING`-:tg-const:`telegram.Location.MAX_HEADING`. For active live locations only. @@ -49,8 +56,12 @@ class Location(TelegramObject): latitude (:obj:`float`): Latitude as defined by the sender. horizontal_accuracy (:obj:`float`): Optional. The radius of uncertainty for the location, measured in meters; 0-:tg-const:`telegram.Location.HORIZONTAL_ACCURACY`. - live_period (:obj:`int`): Optional. Time relative to the message sending date, during which - the location can be updated, in seconds. For active live locations only. + live_period (:obj:`int` | :class:`datetime.timedelta`): Optional. Time relative to the + message sending date, during which the location can be updated, in seconds. For active + live locations only. + + .. deprecated:: v22.2 + |time-period-int-deprecated| heading (:obj:`int`): Optional. The direction in which user is moving, in degrees; :tg-const:`telegram.Location.MIN_HEADING`-:tg-const:`telegram.Location.MAX_HEADING`. For active live locations only. @@ -60,10 +71,10 @@ class Location(TelegramObject): """ __slots__ = ( + "_live_period", "heading", "horizontal_accuracy", "latitude", - "live_period", "longitude", "proximity_alert_radius", ) @@ -73,7 +84,7 @@ def __init__( longitude: float, latitude: float, horizontal_accuracy: Optional[float] = None, - live_period: Optional[int] = None, + live_period: Optional[TimePeriod] = None, heading: Optional[int] = None, proximity_alert_radius: Optional[int] = None, *, @@ -86,7 +97,7 @@ def __init__( # Optionals self.horizontal_accuracy: Optional[float] = horizontal_accuracy - self.live_period: Optional[int] = live_period + self._live_period: Optional[dtm.timedelta] = to_timedelta(live_period) self.heading: Optional[int] = heading self.proximity_alert_radius: Optional[int] = ( int(proximity_alert_radius) if proximity_alert_radius else None @@ -96,6 +107,10 @@ def __init__( self._freeze() + @property + def live_period(self) -> Optional[Union[int, dtm.timedelta]]: + return get_timedelta_value(self._live_period, attribute="live_period") + HORIZONTAL_ACCURACY: Final[int] = constants.LocationLimit.HORIZONTAL_ACCURACY """:const:`telegram.constants.LocationLimit.HORIZONTAL_ACCURACY` diff --git a/telegram/_files/photosize.py b/src/telegram/_files/photosize.py similarity index 100% rename from telegram/_files/photosize.py rename to src/telegram/_files/photosize.py diff --git a/telegram/_files/sticker.py b/src/telegram/_files/sticker.py similarity index 100% rename from telegram/_files/sticker.py rename to src/telegram/_files/sticker.py diff --git a/telegram/_files/venue.py b/src/telegram/_files/venue.py similarity index 100% rename from telegram/_files/venue.py rename to src/telegram/_files/venue.py diff --git a/telegram/_files/video.py b/src/telegram/_files/video.py similarity index 73% rename from telegram/_files/video.py rename to src/telegram/_files/video.py index 36381ebbf6b..7c838d53fc8 100644 --- a/telegram/_files/video.py +++ b/src/telegram/_files/video.py @@ -17,13 +17,15 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram Video.""" +import datetime as dtm from collections.abc import Sequence -from typing import TYPE_CHECKING, Optional +from typing import TYPE_CHECKING, Optional, Union from telegram._files._basethumbedmedium import _BaseThumbedMedium from telegram._files.photosize import PhotoSize -from telegram._utils.argumentparsing import de_list_optional, parse_sequence_arg -from telegram._utils.types import JSONDict +from telegram._utils.argumentparsing import de_list_optional, parse_sequence_arg, to_timedelta +from telegram._utils.datetime import get_timedelta_value +from telegram._utils.types import JSONDict, TimePeriod if TYPE_CHECKING: from telegram import Bot @@ -46,7 +48,11 @@ class Video(_BaseThumbedMedium): Can't be used to download or reuse the file. width (:obj:`int`): Video width as defined by the sender. height (:obj:`int`): Video height as defined by the sender. - duration (:obj:`int`): Duration of the video in seconds as defined by the sender. + duration (:obj:`int` | :class:`datetime.timedelta`): Duration of the video + in seconds as defined by the sender. + + .. versionchanged:: v22.2 + |time-period-input| file_name (:obj:`str`, optional): Original filename as defined by the sender. mime_type (:obj:`str`, optional): MIME type of a file as defined by the sender. file_size (:obj:`int`, optional): File size in bytes. @@ -57,10 +63,13 @@ class Video(_BaseThumbedMedium): the video in the message. .. versionadded:: 21.11 - start_timestamp (:obj:`int`, optional): Timestamp in seconds from which the video - will play in the message + start_timestamp (:obj:`int` | :class:`datetime.timedelta`, optional): Timestamp in seconds + from which the video will play in the message .. versionadded:: 21.11 + .. versionchanged:: v22.2 + |time-period-input| + Attributes: file_id (:obj:`str`): Identifier for this file, which can be used to download or reuse the file. @@ -69,7 +78,11 @@ class Video(_BaseThumbedMedium): Can't be used to download or reuse the file. width (:obj:`int`): Video width as defined by the sender. height (:obj:`int`): Video height as defined by the sender. - duration (:obj:`int`): Duration of the video in seconds as defined by the sender. + duration (:obj:`int` | :class:`datetime.timedelta`): Duration of the video in seconds + as defined by the sender. + + .. deprecated:: v22.2 + |time-period-int-deprecated| file_name (:obj:`str`): Optional. Original filename as defined by the sender. mime_type (:obj:`str`): Optional. MIME type of a file as defined by the sender. file_size (:obj:`int`): Optional. File size in bytes. @@ -80,18 +93,21 @@ class Video(_BaseThumbedMedium): the video in the message. .. versionadded:: 21.11 - start_timestamp (:obj:`int`): Optional, Timestamp in seconds from which the video - will play in the message + start_timestamp (:obj:`int` | :class:`datetime.timedelta`): Optional. Timestamp in seconds + from which the video will play in the message .. versionadded:: 21.11 + + .. deprecated:: v22.2 + |time-period-int-deprecated| """ __slots__ = ( + "_duration", + "_start_timestamp", "cover", - "duration", "file_name", "height", "mime_type", - "start_timestamp", "width", ) @@ -101,13 +117,13 @@ def __init__( file_unique_id: str, width: int, height: int, - duration: int, + duration: TimePeriod, mime_type: Optional[str] = None, file_size: Optional[int] = None, file_name: Optional[str] = None, thumbnail: Optional[PhotoSize] = None, cover: Optional[Sequence[PhotoSize]] = None, - start_timestamp: Optional[int] = None, + start_timestamp: Optional[TimePeriod] = None, *, api_kwargs: Optional[JSONDict] = None, ): @@ -122,12 +138,22 @@ def __init__( # Required self.width: int = width self.height: int = height - self.duration: int = duration + self._duration: dtm.timedelta = to_timedelta(duration) # Optional self.mime_type: Optional[str] = mime_type self.file_name: Optional[str] = file_name self.cover: Optional[Sequence[PhotoSize]] = parse_sequence_arg(cover) - self.start_timestamp: Optional[int] = start_timestamp + self._start_timestamp: Optional[dtm.timedelta] = to_timedelta(start_timestamp) + + @property + def duration(self) -> Union[int, dtm.timedelta]: + return get_timedelta_value( # type: ignore[return-value] + self._duration, attribute="duration" + ) + + @property + def start_timestamp(self) -> Optional[Union[int, dtm.timedelta]]: + return get_timedelta_value(self._start_timestamp, attribute="start_timestamp") @classmethod def de_json(cls, data: JSONDict, bot: Optional["Bot"] = None) -> "Video": diff --git a/telegram/_files/videonote.py b/src/telegram/_files/videonote.py similarity index 76% rename from telegram/_files/videonote.py rename to src/telegram/_files/videonote.py index edb9e555372..2eb8619c5c6 100644 --- a/telegram/_files/videonote.py +++ b/src/telegram/_files/videonote.py @@ -18,11 +18,14 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram VideoNote.""" -from typing import Optional +import datetime as dtm +from typing import Optional, Union from telegram._files._basethumbedmedium import _BaseThumbedMedium from telegram._files.photosize import PhotoSize -from telegram._utils.types import JSONDict +from telegram._utils.argumentparsing import to_timedelta +from telegram._utils.datetime import get_timedelta_value +from telegram._utils.types import JSONDict, TimePeriod class VideoNote(_BaseThumbedMedium): @@ -42,7 +45,11 @@ class VideoNote(_BaseThumbedMedium): Can't be used to download or reuse the file. length (:obj:`int`): Video width and height (diameter of the video message) as defined by sender. - duration (:obj:`int`): Duration of the video in seconds as defined by the sender. + duration (:obj:`int` | :class:`datetime.timedelta`): Duration of the video in + seconds as defined by the sender. + + .. versionchanged:: v22.2 + |time-period-input| file_size (:obj:`int`, optional): File size in bytes. thumbnail (:class:`telegram.PhotoSize`, optional): Video thumbnail. @@ -56,7 +63,11 @@ class VideoNote(_BaseThumbedMedium): Can't be used to download or reuse the file. length (:obj:`int`): Video width and height (diameter of the video message) as defined by sender. - duration (:obj:`int`): Duration of the video in seconds as defined by the sender. + duration (:obj:`int` | :class:`datetime.timedelta`): Duration of the video in seconds as + defined by the sender. + + .. deprecated:: v22.2 + |time-period-int-deprecated| file_size (:obj:`int`): Optional. File size in bytes. thumbnail (:class:`telegram.PhotoSize`): Optional. Video thumbnail. @@ -64,14 +75,14 @@ class VideoNote(_BaseThumbedMedium): """ - __slots__ = ("duration", "length") + __slots__ = ("_duration", "length") def __init__( self, file_id: str, file_unique_id: str, length: int, - duration: int, + duration: TimePeriod, file_size: Optional[int] = None, thumbnail: Optional[PhotoSize] = None, *, @@ -87,4 +98,10 @@ def __init__( with self._unfrozen(): # Required self.length: int = length - self.duration: int = duration + self._duration: dtm.timedelta = to_timedelta(duration) + + @property + def duration(self) -> Union[int, dtm.timedelta]: + return get_timedelta_value( # type: ignore[return-value] + self._duration, attribute="duration" + ) diff --git a/telegram/_files/voice.py b/src/telegram/_files/voice.py similarity index 73% rename from telegram/_files/voice.py rename to src/telegram/_files/voice.py index 19c0e856d14..d77cdc66aa1 100644 --- a/telegram/_files/voice.py +++ b/src/telegram/_files/voice.py @@ -17,10 +17,13 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram Voice.""" -from typing import Optional +import datetime as dtm +from typing import Optional, Union from telegram._files._basemedium import _BaseMedium -from telegram._utils.types import JSONDict +from telegram._utils.argumentparsing import to_timedelta +from telegram._utils.datetime import get_timedelta_value +from telegram._utils.types import JSONDict, TimePeriod class Voice(_BaseMedium): @@ -35,7 +38,11 @@ class Voice(_BaseMedium): file_unique_id (:obj:`str`): Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. - duration (:obj:`int`): Duration of the audio in seconds as defined by the sender. + duration (:obj:`int` | :class:`datetime.timedelta`): Duration of the audio in + seconds as defined by the sender. + + .. versionchanged:: v22.2 + |time-period-input| mime_type (:obj:`str`, optional): MIME type of the file as defined by the sender. file_size (:obj:`int`, optional): File size in bytes. @@ -45,19 +52,23 @@ class Voice(_BaseMedium): file_unique_id (:obj:`str`): Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. - duration (:obj:`int`): Duration of the audio in seconds as defined by the sender. + duration (:obj:`int` | :class:`datetime.timedelta`): Duration of the audio in seconds as + defined by the sender. + + .. deprecated:: v22.2 + |time-period-int-deprecated| mime_type (:obj:`str`): Optional. MIME type of the file as defined by the sender. file_size (:obj:`int`): Optional. File size in bytes. """ - __slots__ = ("duration", "mime_type") + __slots__ = ("_duration", "mime_type") def __init__( self, file_id: str, file_unique_id: str, - duration: int, + duration: TimePeriod, mime_type: Optional[str] = None, file_size: Optional[int] = None, *, @@ -71,6 +82,12 @@ def __init__( ) with self._unfrozen(): # Required - self.duration: int = duration + self._duration: dtm.timedelta = to_timedelta(duration) # Optional self.mime_type: Optional[str] = mime_type + + @property + def duration(self) -> Union[int, dtm.timedelta]: + return get_timedelta_value( # type: ignore[return-value] + self._duration, attribute="duration" + ) diff --git a/telegram/_forcereply.py b/src/telegram/_forcereply.py similarity index 100% rename from telegram/_forcereply.py rename to src/telegram/_forcereply.py diff --git a/telegram/_forumtopic.py b/src/telegram/_forumtopic.py similarity index 100% rename from telegram/_forumtopic.py rename to src/telegram/_forumtopic.py diff --git a/telegram/_games/__init__.py b/src/telegram/_games/__init__.py similarity index 100% rename from telegram/_games/__init__.py rename to src/telegram/_games/__init__.py diff --git a/telegram/_games/callbackgame.py b/src/telegram/_games/callbackgame.py similarity index 100% rename from telegram/_games/callbackgame.py rename to src/telegram/_games/callbackgame.py diff --git a/telegram/_games/game.py b/src/telegram/_games/game.py similarity index 100% rename from telegram/_games/game.py rename to src/telegram/_games/game.py diff --git a/telegram/_games/gamehighscore.py b/src/telegram/_games/gamehighscore.py similarity index 100% rename from telegram/_games/gamehighscore.py rename to src/telegram/_games/gamehighscore.py diff --git a/telegram/_gifts.py b/src/telegram/_gifts.py similarity index 100% rename from telegram/_gifts.py rename to src/telegram/_gifts.py diff --git a/telegram/_giveaway.py b/src/telegram/_giveaway.py similarity index 100% rename from telegram/_giveaway.py rename to src/telegram/_giveaway.py diff --git a/telegram/_inline/__init__.py b/src/telegram/_inline/__init__.py similarity index 100% rename from telegram/_inline/__init__.py rename to src/telegram/_inline/__init__.py diff --git a/telegram/_inline/inlinekeyboardbutton.py b/src/telegram/_inline/inlinekeyboardbutton.py similarity index 100% rename from telegram/_inline/inlinekeyboardbutton.py rename to src/telegram/_inline/inlinekeyboardbutton.py diff --git a/telegram/_inline/inlinekeyboardmarkup.py b/src/telegram/_inline/inlinekeyboardmarkup.py similarity index 100% rename from telegram/_inline/inlinekeyboardmarkup.py rename to src/telegram/_inline/inlinekeyboardmarkup.py diff --git a/telegram/_inline/inlinequery.py b/src/telegram/_inline/inlinequery.py similarity index 100% rename from telegram/_inline/inlinequery.py rename to src/telegram/_inline/inlinequery.py diff --git a/telegram/_inline/inlinequeryresult.py b/src/telegram/_inline/inlinequeryresult.py similarity index 100% rename from telegram/_inline/inlinequeryresult.py rename to src/telegram/_inline/inlinequeryresult.py diff --git a/telegram/_inline/inlinequeryresultarticle.py b/src/telegram/_inline/inlinequeryresultarticle.py similarity index 100% rename from telegram/_inline/inlinequeryresultarticle.py rename to src/telegram/_inline/inlinequeryresultarticle.py diff --git a/telegram/_inline/inlinequeryresultaudio.py b/src/telegram/_inline/inlinequeryresultaudio.py similarity index 84% rename from telegram/_inline/inlinequeryresultaudio.py rename to src/telegram/_inline/inlinequeryresultaudio.py index 8e3376a458f..9fcffd07951 100644 --- a/telegram/_inline/inlinequeryresultaudio.py +++ b/src/telegram/_inline/inlinequeryresultaudio.py @@ -17,15 +17,17 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram InlineQueryResultAudio.""" +import datetime as dtm from collections.abc import Sequence -from typing import TYPE_CHECKING, Optional +from typing import TYPE_CHECKING, Optional, Union from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult from telegram._messageentity import MessageEntity -from telegram._utils.argumentparsing import parse_sequence_arg +from telegram._utils.argumentparsing import parse_sequence_arg, to_timedelta +from telegram._utils.datetime import get_timedelta_value from telegram._utils.defaultvalue import DEFAULT_NONE -from telegram._utils.types import JSONDict, ODVInput +from telegram._utils.types import JSONDict, ODVInput, TimePeriod from telegram.constants import InlineQueryResultType if TYPE_CHECKING: @@ -47,7 +49,11 @@ class InlineQueryResultAudio(InlineQueryResult): audio_url (:obj:`str`): A valid URL for the audio file. title (:obj:`str`): Title. performer (:obj:`str`, optional): Performer. - audio_duration (:obj:`str`, optional): Audio duration in seconds. + audio_duration (:obj:`int` | :class:`datetime.timedelta`, optional): Audio duration + in seconds. + + .. versionchanged:: v22.2 + |time-period-input| caption (:obj:`str`, optional): Caption, 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. @@ -69,7 +75,11 @@ class InlineQueryResultAudio(InlineQueryResult): audio_url (:obj:`str`): A valid URL for the audio file. title (:obj:`str`): Title. performer (:obj:`str`): Optional. Performer. - audio_duration (:obj:`str`): Optional. Audio duration in seconds. + audio_duration (:obj:`int` | :class:`datetime.timedelta`): Optional. Audio duration + in seconds. + + .. deprecated:: v22.2 + |time-period-int-deprecated| caption (:obj:`str`): Optional. Caption, 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. @@ -88,7 +98,7 @@ class InlineQueryResultAudio(InlineQueryResult): """ __slots__ = ( - "audio_duration", + "_audio_duration", "audio_url", "caption", "caption_entities", @@ -105,7 +115,7 @@ def __init__( audio_url: str, title: str, performer: Optional[str] = None, - audio_duration: Optional[int] = None, + audio_duration: Optional[TimePeriod] = None, caption: Optional[str] = None, reply_markup: Optional[InlineKeyboardMarkup] = None, input_message_content: Optional["InputMessageContent"] = None, @@ -122,9 +132,13 @@ def __init__( # Optionals self.performer: Optional[str] = performer - self.audio_duration: Optional[int] = audio_duration + self._audio_duration: Optional[dtm.timedelta] = to_timedelta(audio_duration) self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode self.caption_entities: tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) self.reply_markup: Optional[InlineKeyboardMarkup] = reply_markup self.input_message_content: Optional[InputMessageContent] = input_message_content + + @property + def audio_duration(self) -> Optional[Union[int, dtm.timedelta]]: + return get_timedelta_value(self._audio_duration, attribute="audio_duration") diff --git a/telegram/_inline/inlinequeryresultcachedaudio.py b/src/telegram/_inline/inlinequeryresultcachedaudio.py similarity index 100% rename from telegram/_inline/inlinequeryresultcachedaudio.py rename to src/telegram/_inline/inlinequeryresultcachedaudio.py diff --git a/telegram/_inline/inlinequeryresultcacheddocument.py b/src/telegram/_inline/inlinequeryresultcacheddocument.py similarity index 100% rename from telegram/_inline/inlinequeryresultcacheddocument.py rename to src/telegram/_inline/inlinequeryresultcacheddocument.py diff --git a/telegram/_inline/inlinequeryresultcachedgif.py b/src/telegram/_inline/inlinequeryresultcachedgif.py similarity index 100% rename from telegram/_inline/inlinequeryresultcachedgif.py rename to src/telegram/_inline/inlinequeryresultcachedgif.py diff --git a/telegram/_inline/inlinequeryresultcachedmpeg4gif.py b/src/telegram/_inline/inlinequeryresultcachedmpeg4gif.py similarity index 100% rename from telegram/_inline/inlinequeryresultcachedmpeg4gif.py rename to src/telegram/_inline/inlinequeryresultcachedmpeg4gif.py diff --git a/telegram/_inline/inlinequeryresultcachedphoto.py b/src/telegram/_inline/inlinequeryresultcachedphoto.py similarity index 100% rename from telegram/_inline/inlinequeryresultcachedphoto.py rename to src/telegram/_inline/inlinequeryresultcachedphoto.py diff --git a/telegram/_inline/inlinequeryresultcachedsticker.py b/src/telegram/_inline/inlinequeryresultcachedsticker.py similarity index 100% rename from telegram/_inline/inlinequeryresultcachedsticker.py rename to src/telegram/_inline/inlinequeryresultcachedsticker.py diff --git a/telegram/_inline/inlinequeryresultcachedvideo.py b/src/telegram/_inline/inlinequeryresultcachedvideo.py similarity index 100% rename from telegram/_inline/inlinequeryresultcachedvideo.py rename to src/telegram/_inline/inlinequeryresultcachedvideo.py diff --git a/telegram/_inline/inlinequeryresultcachedvoice.py b/src/telegram/_inline/inlinequeryresultcachedvoice.py similarity index 100% rename from telegram/_inline/inlinequeryresultcachedvoice.py rename to src/telegram/_inline/inlinequeryresultcachedvoice.py diff --git a/telegram/_inline/inlinequeryresultcontact.py b/src/telegram/_inline/inlinequeryresultcontact.py similarity index 100% rename from telegram/_inline/inlinequeryresultcontact.py rename to src/telegram/_inline/inlinequeryresultcontact.py diff --git a/telegram/_inline/inlinequeryresultdocument.py b/src/telegram/_inline/inlinequeryresultdocument.py similarity index 100% rename from telegram/_inline/inlinequeryresultdocument.py rename to src/telegram/_inline/inlinequeryresultdocument.py diff --git a/telegram/_inline/inlinequeryresultgame.py b/src/telegram/_inline/inlinequeryresultgame.py similarity index 100% rename from telegram/_inline/inlinequeryresultgame.py rename to src/telegram/_inline/inlinequeryresultgame.py diff --git a/telegram/_inline/inlinequeryresultgif.py b/src/telegram/_inline/inlinequeryresultgif.py similarity index 88% rename from telegram/_inline/inlinequeryresultgif.py rename to src/telegram/_inline/inlinequeryresultgif.py index 398d61cc79a..cbd1f2514b0 100644 --- a/telegram/_inline/inlinequeryresultgif.py +++ b/src/telegram/_inline/inlinequeryresultgif.py @@ -17,15 +17,17 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram InlineQueryResultGif.""" +import datetime as dtm from collections.abc import Sequence -from typing import TYPE_CHECKING, Optional +from typing import TYPE_CHECKING, Optional, Union from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult from telegram._messageentity import MessageEntity -from telegram._utils.argumentparsing import parse_sequence_arg +from telegram._utils.argumentparsing import parse_sequence_arg, to_timedelta +from telegram._utils.datetime import get_timedelta_value from telegram._utils.defaultvalue import DEFAULT_NONE -from telegram._utils.types import JSONDict, ODVInput +from telegram._utils.types import JSONDict, ODVInput, TimePeriod from telegram.constants import InlineQueryResultType if TYPE_CHECKING: @@ -50,7 +52,11 @@ class InlineQueryResultGif(InlineQueryResult): gif_url (:obj:`str`): A valid URL for the GIF file. gif_width (:obj:`int`, optional): Width of the GIF. gif_height (:obj:`int`, optional): Height of the GIF. - gif_duration (:obj:`int`, optional): Duration of the GIF in seconds. + gif_duration (:obj:`int` | :class:`datetime.timedelta`, optional): Duration of the GIF + in seconds. + + .. versionchanged:: v22.2 + |time-period-input| thumbnail_url (:obj:`str`): URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result. @@ -89,7 +95,11 @@ class InlineQueryResultGif(InlineQueryResult): gif_url (:obj:`str`): A valid URL for the GIF file. gif_width (:obj:`int`): Optional. Width of the GIF. gif_height (:obj:`int`): Optional. Height of the GIF. - gif_duration (:obj:`int`): Optional. Duration of the GIF in seconds. + gif_duration (:obj:`int` | :class:`datetime.timedelta`): Optional. Duration of the GIF + in seconds. + + .. deprecated:: v22.2 + |time-period-int-deprecated| thumbnail_url (:obj:`str`): URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result. @@ -120,9 +130,9 @@ class InlineQueryResultGif(InlineQueryResult): """ __slots__ = ( + "_gif_duration", "caption", "caption_entities", - "gif_duration", "gif_height", "gif_url", "gif_width", @@ -146,7 +156,7 @@ def __init__( caption: Optional[str] = None, reply_markup: Optional[InlineKeyboardMarkup] = None, input_message_content: Optional["InputMessageContent"] = None, - gif_duration: Optional[int] = None, + gif_duration: Optional[TimePeriod] = None, parse_mode: ODVInput[str] = DEFAULT_NONE, caption_entities: Optional[Sequence[MessageEntity]] = None, thumbnail_mime_type: Optional[str] = None, @@ -163,7 +173,7 @@ def __init__( # Optionals self.gif_width: Optional[int] = gif_width self.gif_height: Optional[int] = gif_height - self.gif_duration: Optional[int] = gif_duration + self._gif_duration: Optional[dtm.timedelta] = to_timedelta(gif_duration) self.title: Optional[str] = title self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode @@ -172,3 +182,7 @@ def __init__( self.input_message_content: Optional[InputMessageContent] = input_message_content self.thumbnail_mime_type: Optional[str] = thumbnail_mime_type self.show_caption_above_media: Optional[bool] = show_caption_above_media + + @property + def gif_duration(self) -> Optional[Union[int, dtm.timedelta]]: + return get_timedelta_value(self._gif_duration, attribute="gif_duration") diff --git a/telegram/_inline/inlinequeryresultlocation.py b/src/telegram/_inline/inlinequeryresultlocation.py similarity index 89% rename from telegram/_inline/inlinequeryresultlocation.py rename to src/telegram/_inline/inlinequeryresultlocation.py index 01035537840..6407c45fbe8 100644 --- a/telegram/_inline/inlinequeryresultlocation.py +++ b/src/telegram/_inline/inlinequeryresultlocation.py @@ -18,12 +18,15 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram InlineQueryResultLocation.""" -from typing import TYPE_CHECKING, Final, Optional +import datetime as dtm +from typing import TYPE_CHECKING, Final, Optional, Union from telegram import constants from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult -from telegram._utils.types import JSONDict +from telegram._utils.argumentparsing import to_timedelta +from telegram._utils.datetime import get_timedelta_value +from telegram._utils.types import JSONDict, TimePeriod if TYPE_CHECKING: from telegram import InputMessageContent @@ -48,10 +51,13 @@ class InlineQueryResultLocation(InlineQueryResult): horizontal_accuracy (:obj:`float`, optional): The radius of uncertainty for the location, measured in meters; 0- :tg-const:`telegram.InlineQueryResultLocation.HORIZONTAL_ACCURACY`. - live_period (:obj:`int`, optional): Period in seconds for which the location will be - updated, should be between + live_period (:obj:`int` | :class:`datetime.timedelta`, optional): Period in seconds for + which the location will be updated, should be between :tg-const:`telegram.InlineQueryResultLocation.MIN_LIVE_PERIOD` and :tg-const:`telegram.InlineQueryResultLocation.MAX_LIVE_PERIOD`. + + .. versionchanged:: v22.2 + |time-period-input| heading (:obj:`int`, optional): For live locations, a direction in which the user is moving, in degrees. Must be between :tg-const:`telegram.InlineQueryResultLocation.MIN_HEADING` and @@ -86,12 +92,15 @@ class InlineQueryResultLocation(InlineQueryResult): horizontal_accuracy (:obj:`float`): Optional. The radius of uncertainty for the location, measured in meters; 0- :tg-const:`telegram.InlineQueryResultLocation.HORIZONTAL_ACCURACY`. - live_period (:obj:`int`): Optional. Period in seconds for which the location will be - updated, should be between + live_period (:obj:`int` | :class:`datetime.timedelta`): Optional. Period in seconds for + which the location will be updated, should be between :tg-const:`telegram.InlineQueryResultLocation.MIN_LIVE_PERIOD` and :tg-const:`telegram.InlineQueryResultLocation.MAX_LIVE_PERIOD` or :tg-const:`telegram.constants.LocationLimit.LIVE_PERIOD_FOREVER` for live locations that can be edited indefinitely. + + .. deprecated:: v22.2 + |time-period-int-deprecated| heading (:obj:`int`): Optional. For live locations, a direction in which the user is moving, in degrees. Must be between :tg-const:`telegram.InlineQueryResultLocation.MIN_HEADING` and @@ -118,11 +127,11 @@ class InlineQueryResultLocation(InlineQueryResult): """ __slots__ = ( + "_live_period", "heading", "horizontal_accuracy", "input_message_content", "latitude", - "live_period", "longitude", "proximity_alert_radius", "reply_markup", @@ -138,7 +147,7 @@ def __init__( latitude: float, longitude: float, title: str, - live_period: Optional[int] = None, + live_period: Optional[TimePeriod] = None, reply_markup: Optional[InlineKeyboardMarkup] = None, input_message_content: Optional["InputMessageContent"] = None, horizontal_accuracy: Optional[float] = None, @@ -158,7 +167,7 @@ def __init__( self.title: str = title # Optionals - self.live_period: Optional[int] = live_period + self._live_period: Optional[dtm.timedelta] = to_timedelta(live_period) self.reply_markup: Optional[InlineKeyboardMarkup] = reply_markup self.input_message_content: Optional[InputMessageContent] = input_message_content self.thumbnail_url: Optional[str] = thumbnail_url @@ -170,6 +179,10 @@ def __init__( int(proximity_alert_radius) if proximity_alert_radius else None ) + @property + def live_period(self) -> Optional[Union[int, dtm.timedelta]]: + return get_timedelta_value(self._live_period, attribute="live_period") + HORIZONTAL_ACCURACY: Final[int] = constants.LocationLimit.HORIZONTAL_ACCURACY """:const:`telegram.constants.LocationLimit.HORIZONTAL_ACCURACY` diff --git a/telegram/_inline/inlinequeryresultmpeg4gif.py b/src/telegram/_inline/inlinequeryresultmpeg4gif.py similarity index 88% rename from telegram/_inline/inlinequeryresultmpeg4gif.py rename to src/telegram/_inline/inlinequeryresultmpeg4gif.py index b47faa0186a..9ca96e12b8e 100644 --- a/telegram/_inline/inlinequeryresultmpeg4gif.py +++ b/src/telegram/_inline/inlinequeryresultmpeg4gif.py @@ -17,15 +17,17 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram InlineQueryResultMpeg4Gif.""" +import datetime as dtm from collections.abc import Sequence -from typing import TYPE_CHECKING, Optional +from typing import TYPE_CHECKING, Optional, Union from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult from telegram._messageentity import MessageEntity -from telegram._utils.argumentparsing import parse_sequence_arg +from telegram._utils.argumentparsing import parse_sequence_arg, to_timedelta +from telegram._utils.datetime import get_timedelta_value from telegram._utils.defaultvalue import DEFAULT_NONE -from telegram._utils.types import JSONDict, ODVInput +from telegram._utils.types import JSONDict, ODVInput, TimePeriod from telegram.constants import InlineQueryResultType if TYPE_CHECKING: @@ -51,7 +53,11 @@ class InlineQueryResultMpeg4Gif(InlineQueryResult): mpeg4_url (:obj:`str`): A valid URL for the MP4 file. mpeg4_width (:obj:`int`, optional): Video width. mpeg4_height (:obj:`int`, optional): Video height. - mpeg4_duration (:obj:`int`, optional): Video duration in seconds. + mpeg4_duration (:obj:`int` | :class:`datetime.timedelta`, optional): Video duration + in seconds. + + .. versionchanged:: v22.2 + |time-period-input| thumbnail_url (:obj:`str`): URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result. @@ -91,7 +97,11 @@ class InlineQueryResultMpeg4Gif(InlineQueryResult): mpeg4_url (:obj:`str`): A valid URL for the MP4 file. mpeg4_width (:obj:`int`): Optional. Video width. mpeg4_height (:obj:`int`): Optional. Video height. - mpeg4_duration (:obj:`int`): Optional. Video duration in seconds. + mpeg4_duration (:obj:`int` | :class:`datetime.timedelta`): Optional. Video duration + in seconds. + + .. deprecated:: v22.2 + |time-period-int-deprecated| thumbnail_url (:obj:`str`): URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result. @@ -122,10 +132,10 @@ class InlineQueryResultMpeg4Gif(InlineQueryResult): """ __slots__ = ( + "_mpeg4_duration", "caption", "caption_entities", "input_message_content", - "mpeg4_duration", "mpeg4_height", "mpeg4_url", "mpeg4_width", @@ -148,7 +158,7 @@ def __init__( caption: Optional[str] = None, reply_markup: Optional[InlineKeyboardMarkup] = None, input_message_content: Optional["InputMessageContent"] = None, - mpeg4_duration: Optional[int] = None, + mpeg4_duration: Optional[TimePeriod] = None, parse_mode: ODVInput[str] = DEFAULT_NONE, caption_entities: Optional[Sequence[MessageEntity]] = None, thumbnail_mime_type: Optional[str] = None, @@ -165,7 +175,7 @@ def __init__( # Optional self.mpeg4_width: Optional[int] = mpeg4_width self.mpeg4_height: Optional[int] = mpeg4_height - self.mpeg4_duration: Optional[int] = mpeg4_duration + self._mpeg4_duration: Optional[dtm.timedelta] = to_timedelta(mpeg4_duration) self.title: Optional[str] = title self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode @@ -174,3 +184,7 @@ def __init__( self.input_message_content: Optional[InputMessageContent] = input_message_content self.thumbnail_mime_type: Optional[str] = thumbnail_mime_type self.show_caption_above_media: Optional[bool] = show_caption_above_media + + @property + def mpeg4_duration(self) -> Optional[Union[int, dtm.timedelta]]: + return get_timedelta_value(self._mpeg4_duration, attribute="mpeg4_duration") diff --git a/telegram/_inline/inlinequeryresultphoto.py b/src/telegram/_inline/inlinequeryresultphoto.py similarity index 100% rename from telegram/_inline/inlinequeryresultphoto.py rename to src/telegram/_inline/inlinequeryresultphoto.py diff --git a/telegram/_inline/inlinequeryresultsbutton.py b/src/telegram/_inline/inlinequeryresultsbutton.py similarity index 100% rename from telegram/_inline/inlinequeryresultsbutton.py rename to src/telegram/_inline/inlinequeryresultsbutton.py diff --git a/telegram/_inline/inlinequeryresultvenue.py b/src/telegram/_inline/inlinequeryresultvenue.py similarity index 100% rename from telegram/_inline/inlinequeryresultvenue.py rename to src/telegram/_inline/inlinequeryresultvenue.py diff --git a/telegram/_inline/inlinequeryresultvideo.py b/src/telegram/_inline/inlinequeryresultvideo.py similarity index 88% rename from telegram/_inline/inlinequeryresultvideo.py rename to src/telegram/_inline/inlinequeryresultvideo.py index edc6ce343ac..1764816b8a6 100644 --- a/telegram/_inline/inlinequeryresultvideo.py +++ b/src/telegram/_inline/inlinequeryresultvideo.py @@ -17,15 +17,17 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram InlineQueryResultVideo.""" +import datetime as dtm from collections.abc import Sequence -from typing import TYPE_CHECKING, Optional +from typing import TYPE_CHECKING, Optional, Union from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult from telegram._messageentity import MessageEntity -from telegram._utils.argumentparsing import parse_sequence_arg +from telegram._utils.argumentparsing import parse_sequence_arg, to_timedelta +from telegram._utils.datetime import get_timedelta_value from telegram._utils.defaultvalue import DEFAULT_NONE -from telegram._utils.types import JSONDict, ODVInput +from telegram._utils.types import JSONDict, ODVInput, TimePeriod from telegram.constants import InlineQueryResultType if TYPE_CHECKING: @@ -73,7 +75,11 @@ class InlineQueryResultVideo(InlineQueryResult): video_width (:obj:`int`, optional): Video width. video_height (:obj:`int`, optional): Video height. - video_duration (:obj:`int`, optional): Video duration in seconds. + video_duration (:obj:`int` | :class:`datetime.timedelta`, optional): Video duration + in seconds. + + .. versionchanged:: v22.2 + |time-period-input| description (:obj:`str`, optional): Short description of the result. reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): Inline keyboard attached to the message. @@ -110,7 +116,11 @@ class InlineQueryResultVideo(InlineQueryResult): video_width (:obj:`int`): Optional. Video width. video_height (:obj:`int`): Optional. Video height. - video_duration (:obj:`int`): Optional. Video duration in seconds. + video_duration (:obj:`int` | :class:`datetime.timedelta`): Optional. Video duration + in seconds. + + .. deprecated:: v22.2 + |time-period-int-deprecated| description (:obj:`str`): Optional. Short description of the result. reply_markup (:class:`telegram.InlineKeyboardMarkup`): Optional. Inline keyboard attached to the message. @@ -125,6 +135,7 @@ class InlineQueryResultVideo(InlineQueryResult): """ __slots__ = ( + "_video_duration", "caption", "caption_entities", "description", @@ -135,7 +146,6 @@ class InlineQueryResultVideo(InlineQueryResult): "show_caption_above_media", "thumbnail_url", "title", - "video_duration", "video_height", "video_url", "video_width", @@ -151,7 +161,7 @@ def __init__( caption: Optional[str] = None, video_width: Optional[int] = None, video_height: Optional[int] = None, - video_duration: Optional[int] = None, + video_duration: Optional[TimePeriod] = None, description: Optional[str] = None, reply_markup: Optional[InlineKeyboardMarkup] = None, input_message_content: Optional["InputMessageContent"] = None, @@ -175,8 +185,12 @@ def __init__( self.caption_entities: tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) self.video_width: Optional[int] = video_width self.video_height: Optional[int] = video_height - self.video_duration: Optional[int] = video_duration + self._video_duration: Optional[dtm.timedelta] = to_timedelta(video_duration) self.description: Optional[str] = description self.reply_markup: Optional[InlineKeyboardMarkup] = reply_markup self.input_message_content: Optional[InputMessageContent] = input_message_content self.show_caption_above_media: Optional[bool] = show_caption_above_media + + @property + def video_duration(self) -> Optional[Union[int, dtm.timedelta]]: + return get_timedelta_value(self._video_duration, attribute="video_duration") diff --git a/telegram/_inline/inlinequeryresultvoice.py b/src/telegram/_inline/inlinequeryresultvoice.py similarity index 83% rename from telegram/_inline/inlinequeryresultvoice.py rename to src/telegram/_inline/inlinequeryresultvoice.py index b798040b1aa..6f9ef6cee1d 100644 --- a/telegram/_inline/inlinequeryresultvoice.py +++ b/src/telegram/_inline/inlinequeryresultvoice.py @@ -17,15 +17,17 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram InlineQueryResultVoice.""" +import datetime as dtm from collections.abc import Sequence -from typing import TYPE_CHECKING, Optional +from typing import TYPE_CHECKING, Optional, Union from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult from telegram._messageentity import MessageEntity -from telegram._utils.argumentparsing import parse_sequence_arg +from telegram._utils.argumentparsing import parse_sequence_arg, to_timedelta +from telegram._utils.datetime import get_timedelta_value from telegram._utils.defaultvalue import DEFAULT_NONE -from telegram._utils.types import JSONDict, ODVInput +from telegram._utils.types import JSONDict, ODVInput, TimePeriod from telegram.constants import InlineQueryResultType if TYPE_CHECKING: @@ -56,7 +58,11 @@ class InlineQueryResultVoice(InlineQueryResult): .. versionchanged:: 20.0 |sequenceclassargs| - voice_duration (:obj:`int`, optional): Recording duration in seconds. + voice_duration (:obj:`int` | :class:`datetime.timedelta`, optional): Recording duration + in seconds. + + .. versionchanged:: v22.2 + |time-period-input| reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): Inline keyboard attached to the message. input_message_content (:class:`telegram.InputMessageContent`, optional): Content of the @@ -79,7 +85,11 @@ class InlineQueryResultVoice(InlineQueryResult): * |tupleclassattrs| * |alwaystuple| - voice_duration (:obj:`int`): Optional. Recording duration in seconds. + voice_duration (:obj:`int` | :class:`datetime.timedelta`): Optional. Recording duration + in seconds. + + .. deprecated:: v22.2 + |time-period-int-deprecated| reply_markup (:class:`telegram.InlineKeyboardMarkup`): Optional. Inline keyboard attached to the message. input_message_content (:class:`telegram.InputMessageContent`): Optional. Content of the @@ -88,13 +98,13 @@ class InlineQueryResultVoice(InlineQueryResult): """ __slots__ = ( + "_voice_duration", "caption", "caption_entities", "input_message_content", "parse_mode", "reply_markup", "title", - "voice_duration", "voice_url", ) @@ -103,7 +113,7 @@ def __init__( id: str, # pylint: disable=redefined-builtin voice_url: str, title: str, - voice_duration: Optional[int] = None, + voice_duration: Optional[TimePeriod] = None, caption: Optional[str] = None, reply_markup: Optional[InlineKeyboardMarkup] = None, input_message_content: Optional["InputMessageContent"] = None, @@ -119,9 +129,13 @@ def __init__( self.title: str = title # Optional - self.voice_duration: Optional[int] = voice_duration + self._voice_duration: Optional[dtm.timedelta] = to_timedelta(voice_duration) self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode self.caption_entities: tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) self.reply_markup: Optional[InlineKeyboardMarkup] = reply_markup self.input_message_content: Optional[InputMessageContent] = input_message_content + + @property + def voice_duration(self) -> Optional[Union[int, dtm.timedelta]]: + return get_timedelta_value(self._voice_duration, attribute="voice_duration") diff --git a/telegram/_inline/inputcontactmessagecontent.py b/src/telegram/_inline/inputcontactmessagecontent.py similarity index 100% rename from telegram/_inline/inputcontactmessagecontent.py rename to src/telegram/_inline/inputcontactmessagecontent.py diff --git a/telegram/_inline/inputinvoicemessagecontent.py b/src/telegram/_inline/inputinvoicemessagecontent.py similarity index 100% rename from telegram/_inline/inputinvoicemessagecontent.py rename to src/telegram/_inline/inputinvoicemessagecontent.py diff --git a/telegram/_inline/inputlocationmessagecontent.py b/src/telegram/_inline/inputlocationmessagecontent.py similarity index 85% rename from telegram/_inline/inputlocationmessagecontent.py rename to src/telegram/_inline/inputlocationmessagecontent.py index f71a716c259..5d7e3ebd0dd 100644 --- a/telegram/_inline/inputlocationmessagecontent.py +++ b/src/telegram/_inline/inputlocationmessagecontent.py @@ -18,11 +18,14 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram InputLocationMessageContent.""" -from typing import Final, Optional +import datetime as dtm +from typing import Final, Optional, Union from telegram import constants from telegram._inline.inputmessagecontent import InputMessageContent -from telegram._utils.types import JSONDict +from telegram._utils.argumentparsing import to_timedelta +from telegram._utils.datetime import get_timedelta_value +from telegram._utils.types import JSONDict, TimePeriod class InputLocationMessageContent(InputMessageContent): @@ -39,12 +42,15 @@ class InputLocationMessageContent(InputMessageContent): horizontal_accuracy (:obj:`float`, optional): The radius of uncertainty for the location, measured in meters; 0- :tg-const:`telegram.InputLocationMessageContent.HORIZONTAL_ACCURACY`. - live_period (:obj:`int`, optional): Period in seconds for which the location will be - updated, should be between + live_period (:obj:`int` | :class:`datetime.timedelta`, optional): Period in seconds for + which the location will be updated, should be between :tg-const:`telegram.InputLocationMessageContent.MIN_LIVE_PERIOD` and :tg-const:`telegram.InputLocationMessageContent.MAX_LIVE_PERIOD` or :tg-const:`telegram.constants.LocationLimit.LIVE_PERIOD_FOREVER` for live locations that can be edited indefinitely. + + .. versionchanged:: v22.2 + |time-period-input| heading (:obj:`int`, optional): For live locations, a direction in which the user is moving, in degrees. Must be between :tg-const:`telegram.InputLocationMessageContent.MIN_HEADING` and @@ -61,10 +67,13 @@ class InputLocationMessageContent(InputMessageContent): horizontal_accuracy (:obj:`float`): Optional. The radius of uncertainty for the location, measured in meters; 0- :tg-const:`telegram.InputLocationMessageContent.HORIZONTAL_ACCURACY`. - live_period (:obj:`int`): Optional. Period in seconds for which the location can be - updated, should be between + live_period (:obj:`int` | :class:`datetime.timedelta`): Optional. Period in seconds for + which the location can be updated, should be between :tg-const:`telegram.InputLocationMessageContent.MIN_LIVE_PERIOD` and :tg-const:`telegram.InputLocationMessageContent.MAX_LIVE_PERIOD`. + + .. deprecated:: v22.2 + |time-period-int-deprecated| heading (:obj:`int`): Optional. For live locations, a direction in which the user is moving, in degrees. Must be between :tg-const:`telegram.InputLocationMessageContent.MIN_HEADING` and @@ -78,19 +87,20 @@ class InputLocationMessageContent(InputMessageContent): """ __slots__ = ( + "_live_period", "heading", "horizontal_accuracy", "latitude", - "live_period", "longitude", - "proximity_alert_radius") + "proximity_alert_radius", + ) # fmt: on def __init__( self, latitude: float, longitude: float, - live_period: Optional[int] = None, + live_period: Optional[TimePeriod] = None, horizontal_accuracy: Optional[float] = None, heading: Optional[int] = None, proximity_alert_radius: Optional[int] = None, @@ -104,7 +114,7 @@ def __init__( self.longitude: float = longitude # Optionals - self.live_period: Optional[int] = live_period + self._live_period: Optional[dtm.timedelta] = to_timedelta(live_period) self.horizontal_accuracy: Optional[float] = horizontal_accuracy self.heading: Optional[int] = heading self.proximity_alert_radius: Optional[int] = ( @@ -113,6 +123,10 @@ def __init__( self._id_attrs = (self.latitude, self.longitude) + @property + def live_period(self) -> Optional[Union[int, dtm.timedelta]]: + return get_timedelta_value(self._live_period, attribute="live_period") + HORIZONTAL_ACCURACY: Final[int] = constants.LocationLimit.HORIZONTAL_ACCURACY """:const:`telegram.constants.LocationLimit.HORIZONTAL_ACCURACY` diff --git a/telegram/_inline/inputmessagecontent.py b/src/telegram/_inline/inputmessagecontent.py similarity index 100% rename from telegram/_inline/inputmessagecontent.py rename to src/telegram/_inline/inputmessagecontent.py diff --git a/telegram/_inline/inputtextmessagecontent.py b/src/telegram/_inline/inputtextmessagecontent.py similarity index 100% rename from telegram/_inline/inputtextmessagecontent.py rename to src/telegram/_inline/inputtextmessagecontent.py diff --git a/telegram/_inline/inputvenuemessagecontent.py b/src/telegram/_inline/inputvenuemessagecontent.py similarity index 100% rename from telegram/_inline/inputvenuemessagecontent.py rename to src/telegram/_inline/inputvenuemessagecontent.py diff --git a/telegram/_inline/preparedinlinemessage.py b/src/telegram/_inline/preparedinlinemessage.py similarity index 100% rename from telegram/_inline/preparedinlinemessage.py rename to src/telegram/_inline/preparedinlinemessage.py diff --git a/telegram/_keyboardbutton.py b/src/telegram/_keyboardbutton.py similarity index 100% rename from telegram/_keyboardbutton.py rename to src/telegram/_keyboardbutton.py diff --git a/telegram/_keyboardbuttonpolltype.py b/src/telegram/_keyboardbuttonpolltype.py similarity index 100% rename from telegram/_keyboardbuttonpolltype.py rename to src/telegram/_keyboardbuttonpolltype.py diff --git a/telegram/_keyboardbuttonrequest.py b/src/telegram/_keyboardbuttonrequest.py similarity index 100% rename from telegram/_keyboardbuttonrequest.py rename to src/telegram/_keyboardbuttonrequest.py diff --git a/telegram/_linkpreviewoptions.py b/src/telegram/_linkpreviewoptions.py similarity index 100% rename from telegram/_linkpreviewoptions.py rename to src/telegram/_linkpreviewoptions.py diff --git a/telegram/_loginurl.py b/src/telegram/_loginurl.py similarity index 100% rename from telegram/_loginurl.py rename to src/telegram/_loginurl.py diff --git a/telegram/_menubutton.py b/src/telegram/_menubutton.py similarity index 100% rename from telegram/_menubutton.py rename to src/telegram/_menubutton.py diff --git a/telegram/_message.py b/src/telegram/_message.py similarity index 97% rename from telegram/_message.py rename to src/telegram/_message.py index 58e18aa0e01..274089bff50 100644 --- a/telegram/_message.py +++ b/src/telegram/_message.py @@ -1541,11 +1541,17 @@ def effective_attachment( return self._effective_attachment # type: ignore[return-value] - def _do_quote(self, do_quote: Optional[bool]) -> Optional[ReplyParameters]: + def _do_quote( + self, do_quote: Optional[bool], allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE + ) -> Optional[ReplyParameters]: """Modify kwargs for replying with or without quoting.""" + # `Defaults` handling for allow_sending_without_reply is not necessary, as + # `ReplyParameters` have special defaults handling in (ExtBot)._insert_defaults if do_quote is not None: if do_quote: - return ReplyParameters(self.message_id) + return ReplyParameters( + self.message_id, allow_sending_without_reply=allow_sending_without_reply + ) else: # Unfortunately we need some ExtBot logic here because it's hard to move shortcut @@ -1555,7 +1561,9 @@ def _do_quote(self, do_quote: Optional[bool]) -> Optional[ReplyParameters]: else: default_quote = None if (default_quote is None and self.chat.type != Chat.PRIVATE) or default_quote: - return ReplyParameters(self.message_id) + return ReplyParameters( + self.message_id, allow_sending_without_reply=allow_sending_without_reply + ) return None @@ -1729,7 +1737,13 @@ async def _parse_quote_arguments( do_quote: Optional[Union[bool, _ReplyKwargs]], reply_to_message_id: Optional[int], reply_parameters: Optional["ReplyParameters"], + allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, ) -> tuple[Union[str, int], ReplyParameters]: + if allow_sending_without_reply is not DEFAULT_NONE and reply_parameters is not None: + raise ValueError( + "`allow_sending_without_reply` and `reply_parameters` are mutually exclusive." + ) + if reply_to_message_id is not None and reply_parameters is not None: raise ValueError( "`reply_to_message_id` and `reply_parameters` are mutually exclusive." @@ -1741,12 +1755,21 @@ async def _parse_quote_arguments( if reply_parameters is not None: effective_reply_parameters = reply_parameters elif reply_to_message_id is not None: - effective_reply_parameters = ReplyParameters(message_id=reply_to_message_id) + effective_reply_parameters = ReplyParameters( + message_id=reply_to_message_id, + allow_sending_without_reply=allow_sending_without_reply, + ) elif isinstance(do_quote, dict): + if allow_sending_without_reply is not DEFAULT_NONE: + raise ValueError( + "`allow_sending_without_reply` and `dict`-value input for `do_quote` are " + "mutually exclusive." + ) + effective_reply_parameters = do_quote["reply_parameters"] chat_id = do_quote["chat_id"] else: - effective_reply_parameters = self._do_quote(do_quote) + effective_reply_parameters = self._do_quote(do_quote, allow_sending_without_reply) return chat_id, effective_reply_parameters @@ -1814,7 +1837,6 @@ async def reply_text( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -1823,7 +1845,7 @@ async def reply_text( """ chat_id, effective_reply_parameters = await self._parse_quote_arguments( - do_quote, reply_to_message_id, reply_parameters + do_quote, reply_to_message_id, reply_parameters, allow_sending_without_reply ) message_thread_id = self._parse_message_thread_id(chat_id, message_thread_id) return await self.get_bot().send_message( @@ -1835,7 +1857,6 @@ async def reply_text( disable_notification=disable_notification, reply_parameters=effective_reply_parameters, reply_markup=reply_markup, - allow_sending_without_reply=allow_sending_without_reply, entities=entities, protect_content=protect_content, message_thread_id=message_thread_id, @@ -1899,7 +1920,6 @@ async def reply_markdown( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -1907,7 +1927,7 @@ async def reply_markdown( :class:`telegram.Message`: On success, instance representing the message posted. """ chat_id, effective_reply_parameters = await self._parse_quote_arguments( - do_quote, reply_to_message_id, reply_parameters + do_quote, reply_to_message_id, reply_parameters, allow_sending_without_reply ) message_thread_id = self._parse_message_thread_id(chat_id, message_thread_id) return await self.get_bot().send_message( @@ -1919,7 +1939,6 @@ async def reply_markdown( disable_notification=disable_notification, reply_parameters=effective_reply_parameters, reply_markup=reply_markup, - allow_sending_without_reply=allow_sending_without_reply, entities=entities, protect_content=protect_content, message_thread_id=message_thread_id, @@ -1979,7 +1998,6 @@ async def reply_markdown_v2( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -1987,7 +2005,7 @@ async def reply_markdown_v2( :class:`telegram.Message`: On success, instance representing the message posted. """ chat_id, effective_reply_parameters = await self._parse_quote_arguments( - do_quote, reply_to_message_id, reply_parameters + do_quote, reply_to_message_id, reply_parameters, allow_sending_without_reply ) message_thread_id = self._parse_message_thread_id(chat_id, message_thread_id) return await self.get_bot().send_message( @@ -1999,7 +2017,6 @@ async def reply_markdown_v2( disable_notification=disable_notification, reply_parameters=effective_reply_parameters, reply_markup=reply_markup, - allow_sending_without_reply=allow_sending_without_reply, entities=entities, protect_content=protect_content, message_thread_id=message_thread_id, @@ -2059,7 +2076,6 @@ async def reply_html( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2067,7 +2083,7 @@ async def reply_html( :class:`telegram.Message`: On success, instance representing the message posted. """ chat_id, effective_reply_parameters = await self._parse_quote_arguments( - do_quote, reply_to_message_id, reply_parameters + do_quote, reply_to_message_id, reply_parameters, allow_sending_without_reply ) message_thread_id = self._parse_message_thread_id(chat_id, message_thread_id) return await self.get_bot().send_message( @@ -2079,7 +2095,6 @@ async def reply_html( disable_notification=disable_notification, reply_parameters=effective_reply_parameters, reply_markup=reply_markup, - allow_sending_without_reply=allow_sending_without_reply, entities=entities, protect_content=protect_content, message_thread_id=message_thread_id, @@ -2137,7 +2152,6 @@ async def reply_media_group( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2148,7 +2162,7 @@ async def reply_media_group( :class:`telegram.error.TelegramError` """ chat_id, effective_reply_parameters = await self._parse_quote_arguments( - do_quote, reply_to_message_id, reply_parameters + do_quote, reply_to_message_id, reply_parameters, allow_sending_without_reply ) message_thread_id = self._parse_message_thread_id(chat_id, message_thread_id) return await self.get_bot().send_media_group( @@ -2161,7 +2175,6 @@ async def reply_media_group( connect_timeout=connect_timeout, pool_timeout=pool_timeout, api_kwargs=api_kwargs, - allow_sending_without_reply=allow_sending_without_reply, protect_content=protect_content, message_thread_id=message_thread_id, caption=caption, @@ -2218,7 +2231,6 @@ async def reply_photo( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2227,7 +2239,7 @@ async def reply_photo( """ chat_id, effective_reply_parameters = await self._parse_quote_arguments( - do_quote, reply_to_message_id, reply_parameters + do_quote, reply_to_message_id, reply_parameters, allow_sending_without_reply ) message_thread_id = self._parse_message_thread_id(chat_id, message_thread_id) return await self.get_bot().send_photo( @@ -2238,7 +2250,6 @@ async def reply_photo( reply_parameters=effective_reply_parameters, reply_markup=reply_markup, parse_mode=parse_mode, - allow_sending_without_reply=allow_sending_without_reply, caption_entities=caption_entities, filename=filename, protect_content=protect_content, @@ -2303,7 +2314,6 @@ async def reply_audio( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2312,7 +2322,7 @@ async def reply_audio( """ chat_id, effective_reply_parameters = await self._parse_quote_arguments( - do_quote, reply_to_message_id, reply_parameters + do_quote, reply_to_message_id, reply_parameters, allow_sending_without_reply ) message_thread_id = self._parse_message_thread_id(chat_id, message_thread_id) return await self.get_bot().send_audio( @@ -2326,7 +2336,6 @@ async def reply_audio( reply_parameters=effective_reply_parameters, reply_markup=reply_markup, parse_mode=parse_mode, - allow_sending_without_reply=allow_sending_without_reply, caption_entities=caption_entities, filename=filename, protect_content=protect_content, @@ -2388,7 +2397,6 @@ async def reply_document( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2397,7 +2405,7 @@ async def reply_document( """ chat_id, effective_reply_parameters = await self._parse_quote_arguments( - do_quote, reply_to_message_id, reply_parameters + do_quote, reply_to_message_id, reply_parameters, allow_sending_without_reply ) message_thread_id = self._parse_message_thread_id(chat_id, message_thread_id) return await self.get_bot().send_document( @@ -2415,7 +2423,6 @@ async def reply_document( parse_mode=parse_mode, api_kwargs=api_kwargs, disable_content_type_detection=disable_content_type_detection, - allow_sending_without_reply=allow_sending_without_reply, caption_entities=caption_entities, protect_content=protect_content, message_thread_id=message_thread_id, @@ -2475,7 +2482,6 @@ async def reply_animation( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2484,7 +2490,7 @@ async def reply_animation( """ chat_id, effective_reply_parameters = await self._parse_quote_arguments( - do_quote, reply_to_message_id, reply_parameters + do_quote, reply_to_message_id, reply_parameters, allow_sending_without_reply ) message_thread_id = self._parse_message_thread_id(chat_id, message_thread_id) return await self.get_bot().send_animation( @@ -2503,7 +2509,6 @@ async def reply_animation( connect_timeout=connect_timeout, pool_timeout=pool_timeout, api_kwargs=api_kwargs, - allow_sending_without_reply=allow_sending_without_reply, caption_entities=caption_entities, filename=filename, protect_content=protect_content, @@ -2557,7 +2562,6 @@ async def reply_sticker( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2566,7 +2570,7 @@ async def reply_sticker( """ chat_id, effective_reply_parameters = await self._parse_quote_arguments( - do_quote, reply_to_message_id, reply_parameters + do_quote, reply_to_message_id, reply_parameters, allow_sending_without_reply ) message_thread_id = self._parse_message_thread_id(chat_id, message_thread_id) return await self.get_bot().send_sticker( @@ -2580,7 +2584,6 @@ async def reply_sticker( connect_timeout=connect_timeout, pool_timeout=pool_timeout, api_kwargs=api_kwargs, - allow_sending_without_reply=allow_sending_without_reply, protect_content=protect_content, message_thread_id=message_thread_id, emoji=emoji, @@ -2642,7 +2645,6 @@ async def reply_video( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2651,7 +2653,7 @@ async def reply_video( """ chat_id, effective_reply_parameters = await self._parse_quote_arguments( - do_quote, reply_to_message_id, reply_parameters + do_quote, reply_to_message_id, reply_parameters, allow_sending_without_reply ) message_thread_id = self._parse_message_thread_id(chat_id, message_thread_id) return await self.get_bot().send_video( @@ -2671,7 +2673,6 @@ async def reply_video( parse_mode=parse_mode, supports_streaming=supports_streaming, api_kwargs=api_kwargs, - allow_sending_without_reply=allow_sending_without_reply, caption_entities=caption_entities, filename=filename, protect_content=protect_content, @@ -2730,7 +2731,6 @@ async def reply_video_note( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2739,7 +2739,7 @@ async def reply_video_note( """ chat_id, effective_reply_parameters = await self._parse_quote_arguments( - do_quote, reply_to_message_id, reply_parameters + do_quote, reply_to_message_id, reply_parameters, allow_sending_without_reply ) message_thread_id = self._parse_message_thread_id(chat_id, message_thread_id) return await self.get_bot().send_video_note( @@ -2755,7 +2755,6 @@ async def reply_video_note( connect_timeout=connect_timeout, pool_timeout=pool_timeout, api_kwargs=api_kwargs, - allow_sending_without_reply=allow_sending_without_reply, filename=filename, protect_content=protect_content, message_thread_id=message_thread_id, @@ -2810,7 +2809,6 @@ async def reply_voice( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2819,7 +2817,7 @@ async def reply_voice( """ chat_id, effective_reply_parameters = await self._parse_quote_arguments( - do_quote, reply_to_message_id, reply_parameters + do_quote, reply_to_message_id, reply_parameters, allow_sending_without_reply ) message_thread_id = self._parse_message_thread_id(chat_id, message_thread_id) return await self.get_bot().send_voice( @@ -2836,7 +2834,6 @@ async def reply_voice( pool_timeout=pool_timeout, parse_mode=parse_mode, api_kwargs=api_kwargs, - allow_sending_without_reply=allow_sending_without_reply, caption_entities=caption_entities, filename=filename, protect_content=protect_content, @@ -2892,7 +2889,6 @@ async def reply_location( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2901,7 +2897,7 @@ async def reply_location( """ chat_id, effective_reply_parameters = await self._parse_quote_arguments( - do_quote, reply_to_message_id, reply_parameters + do_quote, reply_to_message_id, reply_parameters, allow_sending_without_reply ) message_thread_id = self._parse_message_thread_id(chat_id, message_thread_id) return await self.get_bot().send_location( @@ -2921,7 +2917,6 @@ async def reply_location( horizontal_accuracy=horizontal_accuracy, heading=heading, proximity_alert_radius=proximity_alert_radius, - allow_sending_without_reply=allow_sending_without_reply, protect_content=protect_content, message_thread_id=message_thread_id, business_connection_id=self.business_connection_id, @@ -2977,7 +2972,6 @@ async def reply_venue( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -2986,7 +2980,7 @@ async def reply_venue( """ chat_id, effective_reply_parameters = await self._parse_quote_arguments( - do_quote, reply_to_message_id, reply_parameters + do_quote, reply_to_message_id, reply_parameters, allow_sending_without_reply ) message_thread_id = self._parse_message_thread_id(chat_id, message_thread_id) return await self.get_bot().send_venue( @@ -3008,7 +3002,6 @@ async def reply_venue( api_kwargs=api_kwargs, google_place_id=google_place_id, google_place_type=google_place_type, - allow_sending_without_reply=allow_sending_without_reply, protect_content=protect_content, message_thread_id=message_thread_id, business_connection_id=self.business_connection_id, @@ -3060,7 +3053,6 @@ async def reply_contact( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -3069,7 +3061,7 @@ async def reply_contact( """ chat_id, effective_reply_parameters = await self._parse_quote_arguments( - do_quote, reply_to_message_id, reply_parameters + do_quote, reply_to_message_id, reply_parameters, allow_sending_without_reply ) message_thread_id = self._parse_message_thread_id(chat_id, message_thread_id) return await self.get_bot().send_contact( @@ -3087,7 +3079,6 @@ async def reply_contact( contact=contact, vcard=vcard, api_kwargs=api_kwargs, - allow_sending_without_reply=allow_sending_without_reply, protect_content=protect_content, message_thread_id=message_thread_id, business_connection_id=self.business_connection_id, @@ -3148,7 +3139,6 @@ async def reply_poll( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -3157,7 +3147,7 @@ async def reply_poll( """ chat_id, effective_reply_parameters = await self._parse_quote_arguments( - do_quote, reply_to_message_id, reply_parameters + do_quote, reply_to_message_id, reply_parameters, allow_sending_without_reply ) message_thread_id = self._parse_message_thread_id(chat_id, message_thread_id) return await self.get_bot().send_poll( @@ -3181,7 +3171,6 @@ async def reply_poll( open_period=open_period, close_date=close_date, api_kwargs=api_kwargs, - allow_sending_without_reply=allow_sending_without_reply, explanation_entities=explanation_entities, protect_content=protect_content, message_thread_id=message_thread_id, @@ -3232,7 +3221,6 @@ async def reply_dice( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -3241,7 +3229,7 @@ async def reply_dice( """ chat_id, effective_reply_parameters = await self._parse_quote_arguments( - do_quote, reply_to_message_id, reply_parameters + do_quote, reply_to_message_id, reply_parameters, allow_sending_without_reply ) message_thread_id = self._parse_message_thread_id(chat_id, message_thread_id) return await self.get_bot().send_dice( @@ -3255,7 +3243,6 @@ async def reply_dice( pool_timeout=pool_timeout, emoji=emoji, api_kwargs=api_kwargs, - allow_sending_without_reply=allow_sending_without_reply, protect_content=protect_content, message_thread_id=message_thread_id, business_connection_id=self.business_connection_id, @@ -3347,7 +3334,6 @@ async def reply_game( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -3358,7 +3344,7 @@ async def reply_game( """ chat_id, effective_reply_parameters = await self._parse_quote_arguments( - do_quote, reply_to_message_id, reply_parameters + do_quote, reply_to_message_id, reply_parameters, allow_sending_without_reply ) message_thread_id = self._parse_message_thread_id(chat_id, message_thread_id) return await self.get_bot().send_game( @@ -3372,7 +3358,6 @@ async def reply_game( connect_timeout=connect_timeout, pool_timeout=pool_timeout, api_kwargs=api_kwargs, - allow_sending_without_reply=allow_sending_without_reply, protect_content=protect_content, message_thread_id=message_thread_id, business_connection_id=self.business_connection_id, @@ -3451,7 +3436,6 @@ async def reply_invoice( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -3460,7 +3444,7 @@ async def reply_invoice( """ chat_id, effective_reply_parameters = await self._parse_quote_arguments( - do_quote, reply_to_message_id, reply_parameters + do_quote, reply_to_message_id, reply_parameters, allow_sending_without_reply ) message_thread_id = self._parse_message_thread_id(chat_id, message_thread_id) return await self.get_bot().send_invoice( @@ -3492,7 +3476,6 @@ async def reply_invoice( connect_timeout=connect_timeout, pool_timeout=pool_timeout, api_kwargs=api_kwargs, - allow_sending_without_reply=allow_sending_without_reply, max_tip_amount=max_tip_amount, suggested_tip_amounts=suggested_tip_amounts, protect_content=protect_content, @@ -3661,7 +3644,6 @@ async def reply_copy( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. .. versionadded:: 20.8 @@ -3670,7 +3652,7 @@ async def reply_copy( """ chat_id, effective_reply_parameters = await self._parse_quote_arguments( - do_quote, reply_to_message_id, reply_parameters + do_quote, reply_to_message_id, reply_parameters, allow_sending_without_reply ) message_thread_id = self._parse_message_thread_id(chat_id, message_thread_id) return await self.get_bot().copy_message( @@ -3683,7 +3665,6 @@ async def reply_copy( caption_entities=caption_entities, disable_notification=disable_notification, reply_parameters=effective_reply_parameters, - allow_sending_without_reply=allow_sending_without_reply, reply_markup=reply_markup, read_timeout=read_timeout, write_timeout=write_timeout, @@ -3735,14 +3716,13 @@ async def reply_paid_media( Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| - Mutually exclusive with :paramref:`quote`. Returns: :class:`telegram.Message`: On success, the sent message is returned. """ chat_id, effective_reply_parameters = await self._parse_quote_arguments( - do_quote, reply_to_message_id, reply_parameters + do_quote, reply_to_message_id, reply_parameters, allow_sending_without_reply ) return await self.get_bot().send_paid_media( chat_id=chat_id, @@ -3755,7 +3735,6 @@ async def reply_paid_media( caption_entities=caption_entities, disable_notification=disable_notification, reply_parameters=effective_reply_parameters, - allow_sending_without_reply=allow_sending_without_reply, reply_markup=reply_markup, read_timeout=read_timeout, write_timeout=write_timeout, diff --git a/telegram/_messageautodeletetimerchanged.py b/src/telegram/_messageautodeletetimerchanged.py similarity index 59% rename from telegram/_messageautodeletetimerchanged.py rename to src/telegram/_messageautodeletetimerchanged.py index 1653c050d59..0fb37f29dbc 100644 --- a/telegram/_messageautodeletetimerchanged.py +++ b/src/telegram/_messageautodeletetimerchanged.py @@ -20,10 +20,13 @@ deletion. """ -from typing import Optional +import datetime as dtm +from typing import Optional, Union from telegram._telegramobject import TelegramObject -from telegram._utils.types import JSONDict +from telegram._utils.argumentparsing import to_timedelta +from telegram._utils.datetime import get_timedelta_value +from telegram._utils.types import JSONDict, TimePeriod class MessageAutoDeleteTimerChanged(TelegramObject): @@ -35,26 +38,38 @@ class MessageAutoDeleteTimerChanged(TelegramObject): .. versionadded:: 13.4 Args: - message_auto_delete_time (:obj:`int`): New auto-delete time for messages in the - chat. + message_auto_delete_time (:obj:`int` | :class:`datetime.timedelta`): New auto-delete time + for messages in the chat. + + .. versionchanged:: v22.2 + |time-period-input| Attributes: - message_auto_delete_time (:obj:`int`): New auto-delete time for messages in the - chat. + message_auto_delete_time (:obj:`int` | :class:`datetime.timedelta`): New auto-delete time + for messages in the chat. + + .. deprecated:: v22.2 + |time-period-int-deprecated| """ - __slots__ = ("message_auto_delete_time",) + __slots__ = ("_message_auto_delete_time",) def __init__( self, - message_auto_delete_time: int, + message_auto_delete_time: TimePeriod, *, api_kwargs: Optional[JSONDict] = None, ): super().__init__(api_kwargs=api_kwargs) - self.message_auto_delete_time: int = message_auto_delete_time + self._message_auto_delete_time: dtm.timedelta = to_timedelta(message_auto_delete_time) self._id_attrs = (self.message_auto_delete_time,) self._freeze() + + @property + def message_auto_delete_time(self) -> Union[int, dtm.timedelta]: + return get_timedelta_value( # type: ignore[return-value] + self._message_auto_delete_time, attribute="message_auto_delete_time" + ) diff --git a/telegram/_messageentity.py b/src/telegram/_messageentity.py similarity index 100% rename from telegram/_messageentity.py rename to src/telegram/_messageentity.py diff --git a/telegram/_messageid.py b/src/telegram/_messageid.py similarity index 100% rename from telegram/_messageid.py rename to src/telegram/_messageid.py diff --git a/telegram/_messageorigin.py b/src/telegram/_messageorigin.py similarity index 100% rename from telegram/_messageorigin.py rename to src/telegram/_messageorigin.py diff --git a/telegram/_messagereactionupdated.py b/src/telegram/_messagereactionupdated.py similarity index 100% rename from telegram/_messagereactionupdated.py rename to src/telegram/_messagereactionupdated.py diff --git a/telegram/_ownedgift.py b/src/telegram/_ownedgift.py similarity index 100% rename from telegram/_ownedgift.py rename to src/telegram/_ownedgift.py diff --git a/telegram/_paidmedia.py b/src/telegram/_paidmedia.py similarity index 87% rename from telegram/_paidmedia.py rename to src/telegram/_paidmedia.py index 972c46fa333..3940da0702e 100644 --- a/telegram/_paidmedia.py +++ b/src/telegram/_paidmedia.py @@ -18,8 +18,9 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains objects that represent paid media in Telegram.""" +import datetime as dtm from collections.abc import Sequence -from typing import TYPE_CHECKING, Final, Optional +from typing import TYPE_CHECKING, Final, Optional, Union from telegram import constants from telegram._files.photosize import PhotoSize @@ -27,8 +28,14 @@ from telegram._telegramobject import TelegramObject from telegram._user import User from telegram._utils import enum -from telegram._utils.argumentparsing import de_json_optional, de_list_optional, parse_sequence_arg -from telegram._utils.types import JSONDict +from telegram._utils.argumentparsing import ( + de_json_optional, + de_list_optional, + parse_sequence_arg, + to_timedelta, +) +from telegram._utils.datetime import get_timedelta_value +from telegram._utils.types import JSONDict, TimePeriod if TYPE_CHECKING: from telegram import Bot @@ -98,6 +105,9 @@ def de_json(cls, data: JSONDict, bot: Optional["Bot"] = None) -> "PaidMedia": if cls is PaidMedia and data.get("type") in _class_mapping: return _class_mapping[data.pop("type")].de_json(data=data, bot=bot) + if "duration" in data: + data["duration"] = dtm.timedelta(seconds=s) if (s := data.get("duration")) else None + return super().de_json(data=data, bot=bot) @@ -110,26 +120,38 @@ class PaidMediaPreview(PaidMedia): .. versionadded:: 21.4 + .. versionchanged:: v22.2 + As part of the migration to representing time periods using ``datetime.timedelta``, + equality comparison now considers integer durations and equivalent timedeltas as equal. + Args: type (:obj:`str`): Type of the paid media, always :tg-const:`telegram.PaidMedia.PREVIEW`. width (:obj:`int`, optional): Media width as defined by the sender. height (:obj:`int`, optional): Media height as defined by the sender. - duration (:obj:`int`, optional): Duration of the media in seconds as defined by the sender. + duration (:obj:`int` | :class:`datetime.timedelta`, optional): Duration of the media in + seconds as defined by the sender. + + .. versionchanged:: v22.2 + |time-period-input| Attributes: type (:obj:`str`): Type of the paid media, always :tg-const:`telegram.PaidMedia.PREVIEW`. width (:obj:`int`): Optional. Media width as defined by the sender. height (:obj:`int`): Optional. Media height as defined by the sender. - duration (:obj:`int`): Optional. Duration of the media in seconds as defined by the sender. + duration (:obj:`int` | :class:`datetime.timedelta`): Optional. Duration of the media in + seconds as defined by the sender. + + .. deprecated:: v22.2 + |time-period-int-deprecated| """ - __slots__ = ("duration", "height", "width") + __slots__ = ("_duration", "height", "width") def __init__( self, width: Optional[int] = None, height: Optional[int] = None, - duration: Optional[int] = None, + duration: Optional[TimePeriod] = None, *, api_kwargs: Optional[JSONDict] = None, ) -> None: @@ -138,9 +160,13 @@ def __init__( with self._unfrozen(): self.width: Optional[int] = width self.height: Optional[int] = height - self.duration: Optional[int] = duration + self._duration: Optional[dtm.timedelta] = to_timedelta(duration) + + self._id_attrs = (self.type, self.width, self.height, self._duration) - self._id_attrs = (self.type, self.width, self.height, self.duration) + @property + def duration(self) -> Optional[Union[int, dtm.timedelta]]: + return get_timedelta_value(self._duration, attribute="duration") class PaidMediaPhoto(PaidMedia): diff --git a/telegram/_paidmessagepricechanged.py b/src/telegram/_paidmessagepricechanged.py similarity index 100% rename from telegram/_paidmessagepricechanged.py rename to src/telegram/_paidmessagepricechanged.py diff --git a/telegram/_passport/__init__.py b/src/telegram/_passport/__init__.py similarity index 100% rename from telegram/_passport/__init__.py rename to src/telegram/_passport/__init__.py diff --git a/telegram/_passport/credentials.py b/src/telegram/_passport/credentials.py similarity index 100% rename from telegram/_passport/credentials.py rename to src/telegram/_passport/credentials.py diff --git a/telegram/_passport/data.py b/src/telegram/_passport/data.py similarity index 100% rename from telegram/_passport/data.py rename to src/telegram/_passport/data.py diff --git a/telegram/_passport/encryptedpassportelement.py b/src/telegram/_passport/encryptedpassportelement.py similarity index 100% rename from telegram/_passport/encryptedpassportelement.py rename to src/telegram/_passport/encryptedpassportelement.py diff --git a/telegram/_passport/passportdata.py b/src/telegram/_passport/passportdata.py similarity index 100% rename from telegram/_passport/passportdata.py rename to src/telegram/_passport/passportdata.py diff --git a/telegram/_passport/passportelementerrors.py b/src/telegram/_passport/passportelementerrors.py similarity index 100% rename from telegram/_passport/passportelementerrors.py rename to src/telegram/_passport/passportelementerrors.py diff --git a/telegram/_passport/passportfile.py b/src/telegram/_passport/passportfile.py similarity index 100% rename from telegram/_passport/passportfile.py rename to src/telegram/_passport/passportfile.py diff --git a/telegram/_payment/__init__.py b/src/telegram/_payment/__init__.py similarity index 100% rename from telegram/_payment/__init__.py rename to src/telegram/_payment/__init__.py diff --git a/telegram/_payment/invoice.py b/src/telegram/_payment/invoice.py similarity index 100% rename from telegram/_payment/invoice.py rename to src/telegram/_payment/invoice.py diff --git a/telegram/_payment/labeledprice.py b/src/telegram/_payment/labeledprice.py similarity index 100% rename from telegram/_payment/labeledprice.py rename to src/telegram/_payment/labeledprice.py diff --git a/telegram/_payment/orderinfo.py b/src/telegram/_payment/orderinfo.py similarity index 100% rename from telegram/_payment/orderinfo.py rename to src/telegram/_payment/orderinfo.py diff --git a/telegram/_payment/precheckoutquery.py b/src/telegram/_payment/precheckoutquery.py similarity index 100% rename from telegram/_payment/precheckoutquery.py rename to src/telegram/_payment/precheckoutquery.py diff --git a/telegram/_payment/refundedpayment.py b/src/telegram/_payment/refundedpayment.py similarity index 100% rename from telegram/_payment/refundedpayment.py rename to src/telegram/_payment/refundedpayment.py diff --git a/telegram/_payment/shippingaddress.py b/src/telegram/_payment/shippingaddress.py similarity index 100% rename from telegram/_payment/shippingaddress.py rename to src/telegram/_payment/shippingaddress.py diff --git a/telegram/_payment/shippingoption.py b/src/telegram/_payment/shippingoption.py similarity index 100% rename from telegram/_payment/shippingoption.py rename to src/telegram/_payment/shippingoption.py diff --git a/telegram/_payment/shippingquery.py b/src/telegram/_payment/shippingquery.py similarity index 100% rename from telegram/_payment/shippingquery.py rename to src/telegram/_payment/shippingquery.py diff --git a/telegram/_payment/stars/__init__.py b/src/telegram/_payment/stars/__init__.py similarity index 100% rename from telegram/_payment/stars/__init__.py rename to src/telegram/_payment/stars/__init__.py diff --git a/telegram/_payment/stars/affiliateinfo.py b/src/telegram/_payment/stars/affiliateinfo.py similarity index 100% rename from telegram/_payment/stars/affiliateinfo.py rename to src/telegram/_payment/stars/affiliateinfo.py diff --git a/telegram/_payment/stars/revenuewithdrawalstate.py b/src/telegram/_payment/stars/revenuewithdrawalstate.py similarity index 100% rename from telegram/_payment/stars/revenuewithdrawalstate.py rename to src/telegram/_payment/stars/revenuewithdrawalstate.py diff --git a/telegram/_payment/stars/staramount.py b/src/telegram/_payment/stars/staramount.py similarity index 98% rename from telegram/_payment/stars/staramount.py rename to src/telegram/_payment/stars/staramount.py index a8d61b2a118..c78a4aa9aba 100644 --- a/telegram/_payment/stars/staramount.py +++ b/src/telegram/_payment/stars/staramount.py @@ -16,7 +16,6 @@ # # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. -# pylint: disable=redefined-builtin """This module contains an object that represents a Telegram StarAmount.""" diff --git a/telegram/_payment/stars/startransactions.py b/src/telegram/_payment/stars/startransactions.py similarity index 100% rename from telegram/_payment/stars/startransactions.py rename to src/telegram/_payment/stars/startransactions.py diff --git a/telegram/_payment/stars/transactionpartner.py b/src/telegram/_payment/stars/transactionpartner.py similarity index 97% rename from telegram/_payment/stars/transactionpartner.py rename to src/telegram/_payment/stars/transactionpartner.py index 723e4d826c7..ffe970bc6a8 100644 --- a/telegram/_payment/stars/transactionpartner.py +++ b/src/telegram/_payment/stars/transactionpartner.py @@ -18,7 +18,6 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. # pylint: disable=redefined-builtin """This module contains the classes for Telegram Stars transaction partners.""" -import datetime as dtm from collections.abc import Sequence from typing import TYPE_CHECKING, Final, Optional @@ -29,13 +28,20 @@ from telegram._telegramobject import TelegramObject from telegram._user import User from telegram._utils import enum -from telegram._utils.argumentparsing import de_json_optional, de_list_optional, parse_sequence_arg -from telegram._utils.types import JSONDict +from telegram._utils.argumentparsing import ( + de_json_optional, + de_list_optional, + parse_sequence_arg, + to_timedelta, +) +from telegram._utils.types import JSONDict, TimePeriod from .affiliateinfo import AffiliateInfo from .revenuewithdrawalstate import RevenueWithdrawalState if TYPE_CHECKING: + import datetime as dtm + from telegram import Bot @@ -312,11 +318,14 @@ class TransactionPartnerUser(TransactionPartner): invoice_payload (:obj:`str`, optional): Bot-specified invoice payload. Can be available only for :tg-const:`telegram.constants.TransactionPartnerUser.INVOICE_PAYMENT` transactions. - subscription_period (:class:`datetime.timedelta`, optional): The duration of the paid - subscription. Can be available only for + subscription_period (:obj:`int` | :class:`datetime.timedelta`, optional): The duration of + the paid subscription. Can be available only for :tg-const:`telegram.constants.TransactionPartnerUser.INVOICE_PAYMENT` transactions. .. versionadded:: 21.8 + + .. versionchanged:: v22.2 + Accepts :obj:`int` objects as well as :class:`datetime.timedelta`. paid_media (Sequence[:class:`telegram.PaidMedia`], optional): Information about the paid media bought by the user. for :tg-const:`telegram.constants.TransactionPartnerUser.PAID_MEDIA_PAYMENT` @@ -411,7 +420,7 @@ def __init__( invoice_payload: Optional[str] = None, paid_media: Optional[Sequence[PaidMedia]] = None, paid_media_payload: Optional[str] = None, - subscription_period: Optional[dtm.timedelta] = None, + subscription_period: Optional[TimePeriod] = None, gift: Optional[Gift] = None, affiliate: Optional[AffiliateInfo] = None, premium_subscription_duration: Optional[int] = None, @@ -432,7 +441,7 @@ def __init__( self.invoice_payload: Optional[str] = invoice_payload self.paid_media: Optional[tuple[PaidMedia, ...]] = parse_sequence_arg(paid_media) self.paid_media_payload: Optional[str] = paid_media_payload - self.subscription_period: Optional[dtm.timedelta] = subscription_period + self.subscription_period: Optional[dtm.timedelta] = to_timedelta(subscription_period) self.gift: Optional[Gift] = gift self.premium_subscription_duration: Optional[int] = premium_subscription_duration self.transaction_type: str = transaction_type @@ -451,11 +460,6 @@ def de_json(cls, data: JSONDict, bot: Optional["Bot"] = None) -> "TransactionPar data["user"] = de_json_optional(data.get("user"), User, bot) data["affiliate"] = de_json_optional(data.get("affiliate"), AffiliateInfo, bot) data["paid_media"] = de_list_optional(data.get("paid_media"), PaidMedia, bot) - data["subscription_period"] = ( - dtm.timedelta(seconds=sp) - if (sp := data.get("subscription_period")) is not None - else None - ) data["gift"] = de_json_optional(data.get("gift"), Gift, bot) return super().de_json(data=data, bot=bot) # type: ignore[return-value] diff --git a/telegram/_payment/successfulpayment.py b/src/telegram/_payment/successfulpayment.py similarity index 100% rename from telegram/_payment/successfulpayment.py rename to src/telegram/_payment/successfulpayment.py diff --git a/telegram/_poll.py b/src/telegram/_poll.py similarity index 95% rename from telegram/_poll.py rename to src/telegram/_poll.py index 8ecdc4105f9..d8c63389cfd 100644 --- a/telegram/_poll.py +++ b/src/telegram/_poll.py @@ -19,7 +19,7 @@ """This module contains an object that represents a Telegram Poll.""" import datetime as dtm from collections.abc import Sequence -from typing import TYPE_CHECKING, Final, Optional +from typing import TYPE_CHECKING, Final, Optional, Union from telegram import constants from telegram._chat import Chat @@ -27,11 +27,20 @@ from telegram._telegramobject import TelegramObject from telegram._user import User from telegram._utils import enum -from telegram._utils.argumentparsing import de_json_optional, de_list_optional, parse_sequence_arg -from telegram._utils.datetime import extract_tzinfo_from_defaults, from_timestamp +from telegram._utils.argumentparsing import ( + de_json_optional, + de_list_optional, + parse_sequence_arg, + to_timedelta, +) +from telegram._utils.datetime import ( + extract_tzinfo_from_defaults, + from_timestamp, + get_timedelta_value, +) from telegram._utils.defaultvalue import DEFAULT_NONE from telegram._utils.entities import parse_message_entities, parse_message_entity -from telegram._utils.types import JSONDict, ODVInput +from telegram._utils.types import JSONDict, ODVInput, TimePeriod if TYPE_CHECKING: from telegram import Bot @@ -343,8 +352,11 @@ class Poll(TelegramObject): * This attribute is now always a (possibly empty) list and never :obj:`None`. * |sequenceclassargs| - open_period (:obj:`int`, optional): Amount of time in seconds the poll will be active - after creation. + open_period (:obj:`int` | :class:`datetime.timedelta`, optional): Amount of time in seconds + the poll will be active after creation. + + .. versionchanged:: v22.2 + |time-period-input| close_date (:obj:`datetime.datetime`, optional): Point in time (Unix timestamp) when the poll will be automatically closed. Converted to :obj:`datetime.datetime`. @@ -384,8 +396,11 @@ class Poll(TelegramObject): .. versionchanged:: 20.0 This attribute is now always a (possibly empty) list and never :obj:`None`. - open_period (:obj:`int`): Optional. Amount of time in seconds the poll will be active - after creation. + open_period (:obj:`int` | :class:`datetime.timedelta`): Optional. Amount of time in seconds + the poll will be active after creation. + + .. deprecated:: v22.2 + |time-period-int-deprecated| close_date (:obj:`datetime.datetime`): Optional. Point in time when the poll will be automatically closed. @@ -401,6 +416,7 @@ class Poll(TelegramObject): """ __slots__ = ( + "_open_period", "allows_multiple_answers", "close_date", "correct_option_id", @@ -409,7 +425,6 @@ class Poll(TelegramObject): "id", "is_anonymous", "is_closed", - "open_period", "options", "question", "question_entities", @@ -430,7 +445,7 @@ def __init__( correct_option_id: Optional[int] = None, explanation: Optional[str] = None, explanation_entities: Optional[Sequence[MessageEntity]] = None, - open_period: Optional[int] = None, + open_period: Optional[TimePeriod] = None, close_date: Optional[dtm.datetime] = None, question_entities: Optional[Sequence[MessageEntity]] = None, *, @@ -450,7 +465,7 @@ def __init__( self.explanation_entities: tuple[MessageEntity, ...] = parse_sequence_arg( explanation_entities ) - self.open_period: Optional[int] = open_period + self._open_period: Optional[dtm.timedelta] = to_timedelta(open_period) self.close_date: Optional[dtm.datetime] = close_date self.question_entities: tuple[MessageEntity, ...] = parse_sequence_arg(question_entities) @@ -458,6 +473,10 @@ def __init__( self._freeze() + @property + def open_period(self) -> Optional[Union[int, dtm.timedelta]]: + return get_timedelta_value(self._open_period, attribute="open_period") + @classmethod def de_json(cls, data: JSONDict, bot: Optional["Bot"] = None) -> "Poll": """See :meth:`telegram.TelegramObject.de_json`.""" diff --git a/telegram/_proximityalerttriggered.py b/src/telegram/_proximityalerttriggered.py similarity index 100% rename from telegram/_proximityalerttriggered.py rename to src/telegram/_proximityalerttriggered.py diff --git a/telegram/_reaction.py b/src/telegram/_reaction.py similarity index 100% rename from telegram/_reaction.py rename to src/telegram/_reaction.py diff --git a/telegram/_reply.py b/src/telegram/_reply.py similarity index 100% rename from telegram/_reply.py rename to src/telegram/_reply.py diff --git a/telegram/_replykeyboardmarkup.py b/src/telegram/_replykeyboardmarkup.py similarity index 100% rename from telegram/_replykeyboardmarkup.py rename to src/telegram/_replykeyboardmarkup.py diff --git a/telegram/_replykeyboardremove.py b/src/telegram/_replykeyboardremove.py similarity index 100% rename from telegram/_replykeyboardremove.py rename to src/telegram/_replykeyboardremove.py diff --git a/telegram/_sentwebappmessage.py b/src/telegram/_sentwebappmessage.py similarity index 100% rename from telegram/_sentwebappmessage.py rename to src/telegram/_sentwebappmessage.py diff --git a/telegram/_shared.py b/src/telegram/_shared.py similarity index 100% rename from telegram/_shared.py rename to src/telegram/_shared.py diff --git a/telegram/_story.py b/src/telegram/_story.py similarity index 100% rename from telegram/_story.py rename to src/telegram/_story.py diff --git a/telegram/_storyarea.py b/src/telegram/_storyarea.py similarity index 100% rename from telegram/_storyarea.py rename to src/telegram/_storyarea.py diff --git a/telegram/_switchinlinequerychosenchat.py b/src/telegram/_switchinlinequerychosenchat.py similarity index 100% rename from telegram/_switchinlinequerychosenchat.py rename to src/telegram/_switchinlinequerychosenchat.py diff --git a/telegram/_telegramobject.py b/src/telegram/_telegramobject.py similarity index 90% rename from telegram/_telegramobject.py rename to src/telegram/_telegramobject.py index ca0d20555eb..70968826bb7 100644 --- a/telegram/_telegramobject.py +++ b/src/telegram/_telegramobject.py @@ -259,7 +259,7 @@ def __getstate__(self) -> dict[str, Union[str, object]]: state (dict[:obj:`str`, :obj:`object`]): The state of the object. """ out = self._get_attrs( - include_private=True, recursive=False, remove_bot=True, convert_default_vault=False + include_private=True, recursive=False, remove_bot=True, convert_default_value=False ) # MappingProxyType is not pickable, so we convert it to a dict and revert in # __setstate__ @@ -499,6 +499,12 @@ def _apply_api_kwargs(self, api_kwargs: JSONDict) -> None: elif getattr(self, key, True) is None: setattr(self, key, api_kwargs.pop(key)) + def _is_deprecated_attr(self, attr: str) -> bool: + """Checks whether `attr` is in the list of deprecated time period attributes.""" + return ( + class_name := self.__class__.__name__ + ) in _TIME_PERIOD_DEPRECATIONS and attr in _TIME_PERIOD_DEPRECATIONS[class_name] + def _get_attrs_names(self, include_private: bool) -> Iterator[str]: """ Returns the names of the attributes of this object. This is used to determine which @@ -521,14 +527,19 @@ def _get_attrs_names(self, include_private: bool) -> Iterator[str]: if include_private: return all_attrs - return (attr for attr in all_attrs if not attr.startswith("_")) + return ( + attr + for attr in all_attrs + # Include deprecated private attributes, which are exposed via properties + if not attr.startswith("_") or self._is_deprecated_attr(attr) + ) def _get_attrs( self, include_private: bool = False, recursive: bool = False, remove_bot: bool = False, - convert_default_vault: bool = True, + convert_default_value: bool = True, ) -> dict[str, Union[str, object]]: """This method is used for obtaining the attributes of the object. @@ -537,7 +548,7 @@ def _get_attrs( recursive (:obj:`bool`): If :obj:`True`, will convert any ``TelegramObjects`` (if found) in the attributes to a dictionary. Else, preserves it as an object itself. remove_bot (:obj:`bool`): Whether the bot should be included in the result. - convert_default_vault (:obj:`bool`): Whether :class:`telegram.DefaultValue` should be + convert_default_value (:obj:`bool`): Whether :class:`telegram.DefaultValue` should be converted to its true value. This is necessary when converting to a dictionary for end users since DefaultValue is used in some classes that work with `tg.ext.defaults` (like `LinkPreviewOptions`) @@ -550,7 +561,7 @@ def _get_attrs( for key in self._get_attrs_names(include_private=include_private): value = ( DefaultValue.get_value(getattr(self, key, None)) - if convert_default_vault + if convert_default_value else getattr(self, key, None) ) @@ -603,6 +614,7 @@ def to_dict(self, recursive: bool = True) -> JSONDict: # datetimes to timestamps. This mostly eliminates the need for subclasses to override # `to_dict` pop_keys: set[str] = set() + timedelta_dict: dict = {} for key, value in out.items(): if isinstance(value, (tuple, list)): if not value: @@ -629,11 +641,25 @@ def to_dict(self, recursive: bool = True) -> JSONDict: elif isinstance(value, dtm.datetime): out[key] = to_timestamp(value) elif isinstance(value, dtm.timedelta): - out[key] = value.total_seconds() + # Converting to int here is neccassry in some cases where Bot API returns + # 'BadRquest' when expecting integers (e.g. InputMediaVideo.duration). + # Other times, floats are accepted but the Bot API handles ints just as well + # (e.g. InputStoryContentVideo.duration). + # Not updating `out` directly to avoid changing the dict size during iteration + timedelta_dict[key.removeprefix("_")] = ( + int(seconds) if (seconds := value.total_seconds()).is_integer() else seconds + ) + # This will sometimes add non-deprecated timedelta attributes to pop_keys. + # We'll restore them shortly. + pop_keys.add(key) for key in pop_keys: out.pop(key) + # `out.update` must to be called *after* we pop deprecated time period attributes + # this ensures that we restore attributes that were already using datetime.timdelta + out.update(timedelta_dict) + # Effectively "unpack" api_kwargs into `out`: out.update(out.pop("api_kwargs", {})) # type: ignore[call-overload] return out @@ -665,3 +691,31 @@ def set_bot(self, bot: Optional["Bot"]) -> None: bot (:class:`telegram.Bot` | :obj:`None`): The bot instance. """ self._bot = bot + + +# We use str keys to avoid importing which causes circular dependencies +_TIME_PERIOD_DEPRECATIONS: dict[str, tuple[str, ...]] = { + "ChatFullInfo": ("_message_auto_delete_time", "_slow_mode_delay"), + "Animation": ("_duration",), + "Audio": ("_duration",), + "Video": ("_duration", "_start_timestamp"), + "VideoNote": ("_duration",), + "Voice": ("_duration",), + "PaidMediaPreview": ("_duration",), + "VideoChatEnded": ("_duration",), + "InputMediaVideo": ("_duration",), + "InputMediaAnimation": ("_duration",), + "InputMediaAudio": ("_duration",), + "InputPaidMediaVideo": ("_duration",), + "InlineQueryResultGif": ("_gif_duration",), + "InlineQueryResultMpeg4Gif": ("_mpeg4_duration",), + "InlineQueryResultVideo": ("_video_duration",), + "InlineQueryResultAudio": ("_audio_duration",), + "InlineQueryResultVoice": ("_voice_duration",), + "InlineQueryResultLocation": ("_live_period",), + "Poll": ("_open_period",), + "Location": ("_live_period",), + "MessageAutoDeleteTimerChanged": ("_message_auto_delete_time",), + "ChatInviteLink": ("_subscription_period",), + "InputLocationMessageContent": ("_live_period",), +} diff --git a/telegram/_uniquegift.py b/src/telegram/_uniquegift.py similarity index 100% rename from telegram/_uniquegift.py rename to src/telegram/_uniquegift.py diff --git a/telegram/_update.py b/src/telegram/_update.py similarity index 100% rename from telegram/_update.py rename to src/telegram/_update.py diff --git a/telegram/_user.py b/src/telegram/_user.py similarity index 100% rename from telegram/_user.py rename to src/telegram/_user.py diff --git a/telegram/_userprofilephotos.py b/src/telegram/_userprofilephotos.py similarity index 100% rename from telegram/_userprofilephotos.py rename to src/telegram/_userprofilephotos.py diff --git a/telegram/_utils/__init__.py b/src/telegram/_utils/__init__.py similarity index 100% rename from telegram/_utils/__init__.py rename to src/telegram/_utils/__init__.py diff --git a/telegram/_utils/argumentparsing.py b/src/telegram/_utils/argumentparsing.py similarity index 84% rename from telegram/_utils/argumentparsing.py rename to src/telegram/_utils/argumentparsing.py index 84ca1bc6a2f..acebbf06440 100644 --- a/telegram/_utils/argumentparsing.py +++ b/src/telegram/_utils/argumentparsing.py @@ -23,8 +23,9 @@ user. Changes to this module are not considered breaking changes and may not be documented in the changelog. """ +import datetime as dtm from collections.abc import Sequence -from typing import TYPE_CHECKING, Optional, Protocol, TypeVar +from typing import TYPE_CHECKING, Optional, Protocol, TypeVar, Union, overload from telegram._linkpreviewoptions import LinkPreviewOptions from telegram._telegramobject import TelegramObject @@ -50,6 +51,34 @@ def parse_sequence_arg(arg: Optional[Sequence[T]]) -> tuple[T, ...]: return tuple(arg) if arg else () +@overload +def to_timedelta(arg: None) -> None: ... + + +@overload +def to_timedelta( + arg: Union[ # noqa: PYI041 (be more explicit about `int` and `float` arguments) + int, float, dtm.timedelta + ], +) -> dtm.timedelta: ... + + +def to_timedelta(arg: Optional[Union[int, float, dtm.timedelta]]) -> Optional[dtm.timedelta]: + """Parses an optional time period in seconds into a timedelta + + Args: + arg (:obj:`int` | :class:`datetime.timedelta`, optional): The time period to parse. + + Returns: + :obj:`timedelta`: The time period converted to a timedelta object or :obj:`None`. + """ + if arg is None: + return None + if isinstance(arg, (int, float)): + return dtm.timedelta(seconds=arg) + return arg + + def parse_lpo_and_dwpp( disable_web_page_preview: Optional[bool], link_preview_options: ODVInput[LinkPreviewOptions] ) -> ODVInput[LinkPreviewOptions]: diff --git a/telegram/_utils/datetime.py b/src/telegram/_utils/datetime.py similarity index 84% rename from telegram/_utils/datetime.py rename to src/telegram/_utils/datetime.py index 8e6ebdda1b4..a0cc126dd94 100644 --- a/telegram/_utils/datetime.py +++ b/src/telegram/_utils/datetime.py @@ -29,9 +29,13 @@ """ import contextlib import datetime as dtm +import os import time from typing import TYPE_CHECKING, Optional, Union +from telegram._utils.warnings import warn +from telegram.warnings import PTBDeprecationWarning + if TYPE_CHECKING: from telegram import Bot @@ -224,3 +228,47 @@ def _datetime_to_float_timestamp(dt_obj: dtm.datetime) -> float: if dt_obj.tzinfo is None: dt_obj = dt_obj.replace(tzinfo=dtm.timezone.utc) return dt_obj.timestamp() + + +def get_timedelta_value( + value: Optional[dtm.timedelta], attribute: str +) -> Optional[Union[int, dtm.timedelta]]: + """ + Convert a `datetime.timedelta` to seconds or return it as-is, based on environment config. + + This utility is part of the migration process from integer-based time representations + to using `datetime.timedelta`. The behavior is controlled by the `PTB_TIMEDELTA` + environment variable. + + Note: + When `PTB_TIMEDELTA` is not enabled, the function will issue a deprecation warning. + + Args: + value (:obj:`datetime.timedelta`): The timedelta value to process. + attribute (:obj:`str`): The name of the attribute at the caller scope, used for + warning messages. + + Returns: + - :obj:`None` if :paramref:`value` is None. + - :obj:`datetime.timedelta` if `PTB_TIMEDELTA=true` or ``PTB_TIMEDELTA=1``. + - :obj:`int` if the total seconds is a whole number. + - float: otherwise. + """ + if value is None: + return None + if os.getenv("PTB_TIMEDELTA", "false").lower().strip() in ["true", "1"]: + return value + warn( + PTBDeprecationWarning( + "v22.2", + f"In a future major version attribute `{attribute}` will be of type" + " `datetime.timedelta`. You can opt-in early by setting `PTB_TIMEDELTA=true`" + " or ``PTB_TIMEDELTA=1`` as an environment variable.", + ), + stacklevel=2, + ) + return ( + int(seconds) + if (seconds := value.total_seconds()).is_integer() + else seconds # type: ignore[return-value] + ) diff --git a/telegram/_utils/defaultvalue.py b/src/telegram/_utils/defaultvalue.py similarity index 100% rename from telegram/_utils/defaultvalue.py rename to src/telegram/_utils/defaultvalue.py diff --git a/telegram/_utils/entities.py b/src/telegram/_utils/entities.py similarity index 100% rename from telegram/_utils/entities.py rename to src/telegram/_utils/entities.py diff --git a/telegram/_utils/enum.py b/src/telegram/_utils/enum.py similarity index 100% rename from telegram/_utils/enum.py rename to src/telegram/_utils/enum.py diff --git a/telegram/_utils/files.py b/src/telegram/_utils/files.py similarity index 100% rename from telegram/_utils/files.py rename to src/telegram/_utils/files.py diff --git a/telegram/_utils/logging.py b/src/telegram/_utils/logging.py similarity index 100% rename from telegram/_utils/logging.py rename to src/telegram/_utils/logging.py diff --git a/telegram/_utils/markup.py b/src/telegram/_utils/markup.py similarity index 100% rename from telegram/_utils/markup.py rename to src/telegram/_utils/markup.py diff --git a/telegram/_utils/repr.py b/src/telegram/_utils/repr.py similarity index 100% rename from telegram/_utils/repr.py rename to src/telegram/_utils/repr.py diff --git a/telegram/_utils/strings.py b/src/telegram/_utils/strings.py similarity index 100% rename from telegram/_utils/strings.py rename to src/telegram/_utils/strings.py diff --git a/telegram/_utils/types.py b/src/telegram/_utils/types.py similarity index 100% rename from telegram/_utils/types.py rename to src/telegram/_utils/types.py diff --git a/telegram/_utils/warnings.py b/src/telegram/_utils/warnings.py similarity index 100% rename from telegram/_utils/warnings.py rename to src/telegram/_utils/warnings.py diff --git a/telegram/_utils/warnings_transition.py b/src/telegram/_utils/warnings_transition.py similarity index 100% rename from telegram/_utils/warnings_transition.py rename to src/telegram/_utils/warnings_transition.py diff --git a/telegram/_version.py b/src/telegram/_version.py similarity index 96% rename from telegram/_version.py rename to src/telegram/_version.py index 412650e88d6..64654ba8ed4 100644 --- a/telegram/_version.py +++ b/src/telegram/_version.py @@ -51,6 +51,6 @@ def __str__(self) -> str: __version_info__: Final[Version] = Version( - major=22, minor=1, micro=0, releaselevel="final", serial=0 + major=22, minor=2, micro=0, releaselevel="final", serial=0 ) __version__: Final[str] = str(__version_info__) diff --git a/telegram/_videochat.py b/src/telegram/_videochat.py similarity index 81% rename from telegram/_videochat.py rename to src/telegram/_videochat.py index 7c1ec00aabb..97f51501da4 100644 --- a/telegram/_videochat.py +++ b/src/telegram/_videochat.py @@ -19,13 +19,17 @@ """This module contains objects related to Telegram video chats.""" import datetime as dtm from collections.abc import Sequence -from typing import TYPE_CHECKING, Optional +from typing import TYPE_CHECKING, Optional, Union from telegram._telegramobject import TelegramObject from telegram._user import User -from telegram._utils.argumentparsing import parse_sequence_arg -from telegram._utils.datetime import extract_tzinfo_from_defaults, from_timestamp -from telegram._utils.types import JSONDict +from telegram._utils.argumentparsing import parse_sequence_arg, to_timedelta +from telegram._utils.datetime import ( + extract_tzinfo_from_defaults, + from_timestamp, + get_timedelta_value, +) +from telegram._utils.types import JSONDict, TimePeriod if TYPE_CHECKING: from telegram import Bot @@ -62,28 +66,45 @@ class VideoChatEnded(TelegramObject): .. versionchanged:: 20.0 This class was renamed from ``VoiceChatEnded`` in accordance to Bot API 6.0. + .. versionchanged:: v22.2 + As part of the migration to representing time periods using ``datetime.timedelta``, + equality comparison now considers integer durations and equivalent timedeltas as equal. + Args: - duration (:obj:`int`): Voice chat duration in seconds. + duration (:obj:`int` | :class:`datetime.timedelta`): Voice chat duration + in seconds. + + .. versionchanged:: v22.2 + |time-period-input| Attributes: - duration (:obj:`int`): Voice chat duration in seconds. + duration (:obj:`int` | :class:`datetime.timedelta`): Voice chat duration in seconds. + + .. deprecated:: v22.2 + |time-period-int-deprecated| """ - __slots__ = ("duration",) + __slots__ = ("_duration",) def __init__( self, - duration: int, + duration: TimePeriod, *, api_kwargs: Optional[JSONDict] = None, ) -> None: super().__init__(api_kwargs=api_kwargs) - self.duration: int = duration - self._id_attrs = (self.duration,) + self._duration: dtm.timedelta = to_timedelta(duration) + self._id_attrs = (self._duration,) self._freeze() + @property + def duration(self) -> Union[int, dtm.timedelta]: + return get_timedelta_value( # type: ignore[return-value] + self._duration, attribute="duration" + ) + class VideoChatParticipantsInvited(TelegramObject): """ diff --git a/telegram/_webappdata.py b/src/telegram/_webappdata.py similarity index 100% rename from telegram/_webappdata.py rename to src/telegram/_webappdata.py diff --git a/telegram/_webappinfo.py b/src/telegram/_webappinfo.py similarity index 100% rename from telegram/_webappinfo.py rename to src/telegram/_webappinfo.py diff --git a/telegram/_webhookinfo.py b/src/telegram/_webhookinfo.py similarity index 100% rename from telegram/_webhookinfo.py rename to src/telegram/_webhookinfo.py diff --git a/telegram/_writeaccessallowed.py b/src/telegram/_writeaccessallowed.py similarity index 100% rename from telegram/_writeaccessallowed.py rename to src/telegram/_writeaccessallowed.py diff --git a/telegram/constants.py b/src/telegram/constants.py similarity index 99% rename from telegram/constants.py rename to src/telegram/constants.py index 2c4b7526354..3e5777803b7 100644 --- a/telegram/constants.py +++ b/src/telegram/constants.py @@ -2152,7 +2152,7 @@ class MessageType(StringEnum): PAID_MESSAGE_PRICE_CHANGED = "paid_message_price_changed" """:obj:`str`: Messages with :attr:`telegram.Message.paid_message_price_changed`. - .. versionadded:: Next.VERSION + .. versionadded:: v22.2 """ PASSPORT_DATA = "passport_data" """:obj:`str`: Messages with :attr:`telegram.Message.passport_data`.""" diff --git a/telegram/error.py b/src/telegram/error.py similarity index 81% rename from telegram/error.py rename to src/telegram/error.py index 2de0361762d..5deb00f5f4f 100644 --- a/telegram/error.py +++ b/src/telegram/error.py @@ -22,6 +22,13 @@ Replaced ``Unauthorized`` by :class:`Forbidden`. """ +import datetime as dtm +from typing import Optional, Union + +from telegram._utils.argumentparsing import to_timedelta +from telegram._utils.datetime import get_timedelta_value +from telegram._utils.types import TimePeriod + __all__ = ( "BadRequest", "ChatMigrated", @@ -36,8 +43,6 @@ "TimedOut", ) -from typing import Optional, Union - class TelegramError(Exception): """ @@ -208,21 +213,42 @@ class RetryAfter(TelegramError): :attr:`retry_after` is now an integer to comply with the Bot API. Args: - retry_after (:obj:`int`): Time in seconds, after which the bot can retry the request. + retry_after (:obj:`int` | :class:`datetime.timedelta`): Time in seconds, after which the + bot can retry the request. + + .. versionchanged:: v22.2 + |time-period-input| Attributes: - retry_after (:obj:`int`): Time in seconds, after which the bot can retry the request. + retry_after (:obj:`int` | :class:`datetime.timedelta`): Time in seconds, after which the + bot can retry the request. + + .. deprecated:: v22.2 + |time-period-int-deprecated| """ - __slots__ = ("retry_after",) + __slots__ = ("_retry_after",) + + def __init__(self, retry_after: TimePeriod): + self._retry_after: dtm.timedelta = to_timedelta(retry_after) + + if isinstance(self.retry_after, int): + super().__init__(f"Flood control exceeded. Retry in {self.retry_after} seconds") + else: + super().__init__(f"Flood control exceeded. Retry in {self.retry_after!s}") - def __init__(self, retry_after: int): - super().__init__(f"Flood control exceeded. Retry in {retry_after} seconds") - self.retry_after: int = retry_after + @property + def retry_after(self) -> Union[int, dtm.timedelta]: # noqa: D102 + # Diableing D102 because docstring for `retry_after` is present at the class's level + return get_timedelta_value( # type: ignore[return-value] + self._retry_after, attribute="retry_after" + ) def __reduce__(self) -> tuple[type, tuple[float]]: # type: ignore[override] - return self.__class__, (self.retry_after,) + # Until support for `int` time periods is lifted, leave pickle behaviour the same + # tag: deprecated: v22.2 + return self.__class__, (int(self._retry_after.total_seconds()),) class Conflict(TelegramError): diff --git a/telegram/ext/__init__.py b/src/telegram/ext/__init__.py similarity index 100% rename from telegram/ext/__init__.py rename to src/telegram/ext/__init__.py diff --git a/telegram/ext/_aioratelimiter.py b/src/telegram/ext/_aioratelimiter.py similarity index 99% rename from telegram/ext/_aioratelimiter.py rename to src/telegram/ext/_aioratelimiter.py index f4ecf917f66..d2d537e7e27 100644 --- a/telegram/ext/_aioratelimiter.py +++ b/src/telegram/ext/_aioratelimiter.py @@ -288,7 +288,7 @@ async def process_request( ) raise - sleep = exc.retry_after + 0.1 + sleep = exc._retry_after.total_seconds() + 0.1 # pylint: disable=protected-access _LOGGER.info("Rate limit hit. Retrying after %f seconds", sleep) # Make sure we don't allow other requests to be processed self._retry_after_event.clear() diff --git a/telegram/ext/_application.py b/src/telegram/ext/_application.py similarity index 96% rename from telegram/ext/_application.py rename to src/telegram/ext/_application.py index e856fa85321..d287b3a375d 100644 --- a/telegram/ext/_application.py +++ b/src/telegram/ext/_application.py @@ -20,6 +20,7 @@ import asyncio import contextlib +import datetime as dtm import inspect import itertools import platform @@ -42,7 +43,7 @@ ) from telegram._utils.logging import get_logger from telegram._utils.repr import build_repr_with_selected_attrs -from telegram._utils.types import SCT, DVType, ODVInput +from telegram._utils.types import SCT, DVType, ODVInput, TimePeriod from telegram._utils.warnings import warn from telegram.error import TelegramError from telegram.ext._basepersistence import BasePersistence @@ -739,7 +740,7 @@ def stop_running(self) -> None: def run_polling( self, poll_interval: float = 0.0, - timeout: int = 10, + timeout: TimePeriod = dtm.timedelta(seconds=10), bootstrap_retries: int = 0, allowed_updates: Optional[Sequence[str]] = None, drop_pending_updates: Optional[bool] = None, @@ -780,8 +781,12 @@ def run_polling( Args: poll_interval (:obj:`float`, optional): Time to wait between polling updates from Telegram in seconds. Default is ``0.0``. - timeout (:obj:`int`, optional): Passed to - :paramref:`telegram.Bot.get_updates.timeout`. Default is ``10`` seconds. + timeout (:obj:`int` | :class:`datetime.timedelta`, optional): Passed to + :paramref:`telegram.Bot.get_updates.timeout`. + Default is :obj:`timedelta(seconds=10)`. + + .. versionchanged:: v22.2 + |time-period-input| bootstrap_retries (:obj:`int`, optional): Whether the bootstrapping phase (calling :meth:`initialize` and the boostrapping of :meth:`telegram.ext.Updater.start_polling`) @@ -1256,8 +1261,14 @@ async def process_update(self, update: object) -> None: context = None any_blocking = False # Flag which is set to True if any handler specifies block=True - for handlers in self.handlers.values(): + # We copy the lists to avoid issues with concurrent modification of the + # handlers (groups or handlers in groups) while iterating over it via add/remove_handler. + # Currently considered implementation detail as described in docstrings of + # add/remove_handler + # do *not* use `copy.deepcopy` here, as we don't want to deepcopy the handlers themselves + for handlers in [v.copy() for v in self.handlers.values()]: try: + # no copy needed b/c we copy above for handler in handlers: check = handler.check_update(update) # Should the handler handle this update? if check is None or check is False: @@ -1343,6 +1354,14 @@ def add_handler(self, handler: BaseHandler[Any, CCT, Any], group: int = DEFAULT_ might lead to race conditions and undesired behavior. In particular, current conversation states may be overridden by the loaded data. + Hint: + This method currently has no influence on calls to :meth:`process_update` that are + already in progress. + + .. warning:: + This behavior should currently be considered an implementation detail and not as + guaranteed behavior. + Args: handler (:class:`telegram.ext.BaseHandler`): A BaseHandler instance. group (:obj:`int`, optional): The group identifier. Default is ``0``. @@ -1444,6 +1463,14 @@ def remove_handler( ) -> None: """Remove a handler from the specified group. + Hint: + This method currently has no influence on calls to :meth:`process_update` that are + already in progress. + + .. warning:: + This behavior should currently be considered an implementation detail and not as + guaranteed behavior. + Args: handler (:class:`telegram.ext.BaseHandler`): A :class:`telegram.ext.BaseHandler` instance. @@ -1774,6 +1801,14 @@ def add_error_handler( Examples: :any:`Errorhandler Bot ` + Hint: + This method currently has no influence on calls to :meth:`process_error` that are + already in progress. + + .. warning:: + This behavior should currently be considered an implementation detail and not as + guaranteed behavior. + .. seealso:: :wiki:`Exceptions, Warnings and Logging ` Args: @@ -1797,6 +1832,14 @@ async def callback(update: Optional[object], context: CallbackContext) def remove_error_handler(self, callback: HandlerCallback[object, CCT, None]) -> None: """Removes an error handler. + Hint: + This method currently has no influence on calls to :meth:`process_error` that are + already in progress. + + .. warning:: + This behavior should currently be considered an implementation detail and not as + guaranteed behavior. + Args: callback (:term:`coroutine function`): The error handler to remove. @@ -1838,10 +1881,12 @@ async def process_error( :class:`telegram.ext.ApplicationHandlerStop`. :obj:`False`, otherwise. """ if self.error_handlers: - for ( - callback, - block, - ) in self.error_handlers.items(): + # We copy the list to avoid issues with concurrent modification of the + # error handlers while iterating over it via add/remove_error_handler. + # Currently considered implementation detail as described in docstrings of + # add/remove_error_handler + error_handler_items = list(self.error_handlers.items()) + for callback, block in error_handler_items: try: context = self.context_types.context.from_error( update=update, diff --git a/telegram/ext/_applicationbuilder.py b/src/telegram/ext/_applicationbuilder.py similarity index 100% rename from telegram/ext/_applicationbuilder.py rename to src/telegram/ext/_applicationbuilder.py diff --git a/telegram/ext/_basepersistence.py b/src/telegram/ext/_basepersistence.py similarity index 100% rename from telegram/ext/_basepersistence.py rename to src/telegram/ext/_basepersistence.py diff --git a/telegram/ext/_baseratelimiter.py b/src/telegram/ext/_baseratelimiter.py similarity index 100% rename from telegram/ext/_baseratelimiter.py rename to src/telegram/ext/_baseratelimiter.py diff --git a/telegram/ext/_baseupdateprocessor.py b/src/telegram/ext/_baseupdateprocessor.py similarity index 100% rename from telegram/ext/_baseupdateprocessor.py rename to src/telegram/ext/_baseupdateprocessor.py diff --git a/telegram/ext/_callbackcontext.py b/src/telegram/ext/_callbackcontext.py similarity index 100% rename from telegram/ext/_callbackcontext.py rename to src/telegram/ext/_callbackcontext.py diff --git a/telegram/ext/_callbackdatacache.py b/src/telegram/ext/_callbackdatacache.py similarity index 100% rename from telegram/ext/_callbackdatacache.py rename to src/telegram/ext/_callbackdatacache.py diff --git a/telegram/ext/_contexttypes.py b/src/telegram/ext/_contexttypes.py similarity index 100% rename from telegram/ext/_contexttypes.py rename to src/telegram/ext/_contexttypes.py diff --git a/telegram/ext/_defaults.py b/src/telegram/ext/_defaults.py similarity index 100% rename from telegram/ext/_defaults.py rename to src/telegram/ext/_defaults.py diff --git a/telegram/ext/_dictpersistence.py b/src/telegram/ext/_dictpersistence.py similarity index 100% rename from telegram/ext/_dictpersistence.py rename to src/telegram/ext/_dictpersistence.py diff --git a/telegram/ext/_extbot.py b/src/telegram/ext/_extbot.py similarity index 99% rename from telegram/ext/_extbot.py rename to src/telegram/ext/_extbot.py index 7afadaa89fa..5781cf817bc 100644 --- a/telegram/ext/_extbot.py +++ b/src/telegram/ext/_extbot.py @@ -657,7 +657,7 @@ async def get_updates( self, offset: Optional[int] = None, limit: Optional[int] = None, - timeout: Optional[int] = None, + timeout: Optional[TimePeriod] = None, allowed_updates: Optional[Sequence[str]] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, diff --git a/telegram/ext/_handlers/__init__.py b/src/telegram/ext/_handlers/__init__.py similarity index 100% rename from telegram/ext/_handlers/__init__.py rename to src/telegram/ext/_handlers/__init__.py diff --git a/telegram/ext/_handlers/basehandler.py b/src/telegram/ext/_handlers/basehandler.py similarity index 100% rename from telegram/ext/_handlers/basehandler.py rename to src/telegram/ext/_handlers/basehandler.py diff --git a/telegram/ext/_handlers/businessconnectionhandler.py b/src/telegram/ext/_handlers/businessconnectionhandler.py similarity index 100% rename from telegram/ext/_handlers/businessconnectionhandler.py rename to src/telegram/ext/_handlers/businessconnectionhandler.py diff --git a/telegram/ext/_handlers/businessmessagesdeletedhandler.py b/src/telegram/ext/_handlers/businessmessagesdeletedhandler.py similarity index 100% rename from telegram/ext/_handlers/businessmessagesdeletedhandler.py rename to src/telegram/ext/_handlers/businessmessagesdeletedhandler.py diff --git a/telegram/ext/_handlers/callbackqueryhandler.py b/src/telegram/ext/_handlers/callbackqueryhandler.py similarity index 100% rename from telegram/ext/_handlers/callbackqueryhandler.py rename to src/telegram/ext/_handlers/callbackqueryhandler.py diff --git a/telegram/ext/_handlers/chatboosthandler.py b/src/telegram/ext/_handlers/chatboosthandler.py similarity index 100% rename from telegram/ext/_handlers/chatboosthandler.py rename to src/telegram/ext/_handlers/chatboosthandler.py diff --git a/telegram/ext/_handlers/chatjoinrequesthandler.py b/src/telegram/ext/_handlers/chatjoinrequesthandler.py similarity index 100% rename from telegram/ext/_handlers/chatjoinrequesthandler.py rename to src/telegram/ext/_handlers/chatjoinrequesthandler.py diff --git a/telegram/ext/_handlers/chatmemberhandler.py b/src/telegram/ext/_handlers/chatmemberhandler.py similarity index 100% rename from telegram/ext/_handlers/chatmemberhandler.py rename to src/telegram/ext/_handlers/chatmemberhandler.py diff --git a/telegram/ext/_handlers/choseninlineresulthandler.py b/src/telegram/ext/_handlers/choseninlineresulthandler.py similarity index 100% rename from telegram/ext/_handlers/choseninlineresulthandler.py rename to src/telegram/ext/_handlers/choseninlineresulthandler.py diff --git a/telegram/ext/_handlers/commandhandler.py b/src/telegram/ext/_handlers/commandhandler.py similarity index 100% rename from telegram/ext/_handlers/commandhandler.py rename to src/telegram/ext/_handlers/commandhandler.py diff --git a/telegram/ext/_handlers/conversationhandler.py b/src/telegram/ext/_handlers/conversationhandler.py similarity index 100% rename from telegram/ext/_handlers/conversationhandler.py rename to src/telegram/ext/_handlers/conversationhandler.py diff --git a/telegram/ext/_handlers/inlinequeryhandler.py b/src/telegram/ext/_handlers/inlinequeryhandler.py similarity index 96% rename from telegram/ext/_handlers/inlinequeryhandler.py rename to src/telegram/ext/_handlers/inlinequeryhandler.py index 0285d259c25..3e7b7c4d400 100644 --- a/telegram/ext/_handlers/inlinequeryhandler.py +++ b/src/telegram/ext/_handlers/inlinequeryhandler.py @@ -118,11 +118,7 @@ def check_update(self, update: object) -> Optional[Union[bool, Match[str]]]: update.inline_query.chat_type not in self.chat_types ): return False - if ( - self.pattern - and update.inline_query.query - and (match := re.match(self.pattern, update.inline_query.query)) - ): + if self.pattern and (match := re.match(self.pattern, update.inline_query.query)): return match if not self.pattern: return True diff --git a/telegram/ext/_handlers/messagehandler.py b/src/telegram/ext/_handlers/messagehandler.py similarity index 100% rename from telegram/ext/_handlers/messagehandler.py rename to src/telegram/ext/_handlers/messagehandler.py diff --git a/telegram/ext/_handlers/messagereactionhandler.py b/src/telegram/ext/_handlers/messagereactionhandler.py similarity index 100% rename from telegram/ext/_handlers/messagereactionhandler.py rename to src/telegram/ext/_handlers/messagereactionhandler.py diff --git a/telegram/ext/_handlers/paidmediapurchasedhandler.py b/src/telegram/ext/_handlers/paidmediapurchasedhandler.py similarity index 100% rename from telegram/ext/_handlers/paidmediapurchasedhandler.py rename to src/telegram/ext/_handlers/paidmediapurchasedhandler.py diff --git a/telegram/ext/_handlers/pollanswerhandler.py b/src/telegram/ext/_handlers/pollanswerhandler.py similarity index 100% rename from telegram/ext/_handlers/pollanswerhandler.py rename to src/telegram/ext/_handlers/pollanswerhandler.py diff --git a/telegram/ext/_handlers/pollhandler.py b/src/telegram/ext/_handlers/pollhandler.py similarity index 100% rename from telegram/ext/_handlers/pollhandler.py rename to src/telegram/ext/_handlers/pollhandler.py diff --git a/telegram/ext/_handlers/precheckoutqueryhandler.py b/src/telegram/ext/_handlers/precheckoutqueryhandler.py similarity index 100% rename from telegram/ext/_handlers/precheckoutqueryhandler.py rename to src/telegram/ext/_handlers/precheckoutqueryhandler.py diff --git a/telegram/ext/_handlers/prefixhandler.py b/src/telegram/ext/_handlers/prefixhandler.py similarity index 100% rename from telegram/ext/_handlers/prefixhandler.py rename to src/telegram/ext/_handlers/prefixhandler.py diff --git a/telegram/ext/_handlers/shippingqueryhandler.py b/src/telegram/ext/_handlers/shippingqueryhandler.py similarity index 100% rename from telegram/ext/_handlers/shippingqueryhandler.py rename to src/telegram/ext/_handlers/shippingqueryhandler.py diff --git a/telegram/ext/_handlers/stringcommandhandler.py b/src/telegram/ext/_handlers/stringcommandhandler.py similarity index 100% rename from telegram/ext/_handlers/stringcommandhandler.py rename to src/telegram/ext/_handlers/stringcommandhandler.py diff --git a/telegram/ext/_handlers/stringregexhandler.py b/src/telegram/ext/_handlers/stringregexhandler.py similarity index 100% rename from telegram/ext/_handlers/stringregexhandler.py rename to src/telegram/ext/_handlers/stringregexhandler.py diff --git a/telegram/ext/_handlers/typehandler.py b/src/telegram/ext/_handlers/typehandler.py similarity index 100% rename from telegram/ext/_handlers/typehandler.py rename to src/telegram/ext/_handlers/typehandler.py diff --git a/telegram/ext/_jobqueue.py b/src/telegram/ext/_jobqueue.py similarity index 100% rename from telegram/ext/_jobqueue.py rename to src/telegram/ext/_jobqueue.py diff --git a/telegram/ext/_picklepersistence.py b/src/telegram/ext/_picklepersistence.py similarity index 100% rename from telegram/ext/_picklepersistence.py rename to src/telegram/ext/_picklepersistence.py diff --git a/telegram/ext/_updater.py b/src/telegram/ext/_updater.py similarity index 98% rename from telegram/ext/_updater.py rename to src/telegram/ext/_updater.py index 95f7e225ed1..c67d147d6d0 100644 --- a/telegram/ext/_updater.py +++ b/src/telegram/ext/_updater.py @@ -20,6 +20,7 @@ import asyncio import contextlib +import datetime as dtm import ssl from collections.abc import Coroutine, Sequence from pathlib import Path @@ -29,7 +30,7 @@ from telegram._utils.defaultvalue import DEFAULT_80, DEFAULT_IP, DefaultValue from telegram._utils.logging import get_logger from telegram._utils.repr import build_repr_with_selected_attrs -from telegram._utils.types import DVType +from telegram._utils.types import DVType, TimePeriod from telegram.error import TelegramError from telegram.ext._utils.networkloop import network_retry_loop @@ -206,7 +207,7 @@ async def shutdown(self) -> None: async def start_polling( self, poll_interval: float = 0.0, - timeout: int = 10, + timeout: TimePeriod = dtm.timedelta(seconds=10), bootstrap_retries: int = 0, allowed_updates: Optional[Sequence[str]] = None, drop_pending_updates: Optional[bool] = None, @@ -226,8 +227,12 @@ async def start_polling( Args: poll_interval (:obj:`float`, optional): Time to wait between polling updates from Telegram in seconds. Default is ``0.0``. - timeout (:obj:`int`, optional): Passed to - :paramref:`telegram.Bot.get_updates.timeout`. Defaults to ``10`` seconds. + timeout (:obj:`int` | :class:`datetime.timedelta`, optional): Passed to + :paramref:`telegram.Bot.get_updates.timeout`. Defaults to + ``timedelta(seconds=10)``. + + .. versionchanged:: v22.2 + |time-period-input| bootstrap_retries (:obj:`int`, optional): Whether the bootstrapping phase of will retry on failures on the Telegram server. @@ -309,7 +314,7 @@ def callback(error: telegram.error.TelegramError) async def _start_polling( self, poll_interval: float, - timeout: int, + timeout: TimePeriod, bootstrap_retries: int, drop_pending_updates: Optional[bool], allowed_updates: Optional[Sequence[str]], @@ -394,7 +399,7 @@ async def _get_updates_cleanup() -> None: await self.bot.get_updates( offset=self._last_update_id, # We don't want to do long polling here! - timeout=0, + timeout=dtm.timedelta(seconds=0), allowed_updates=allowed_updates, ) except TelegramError: diff --git a/telegram/ext/_utils/__init__.py b/src/telegram/ext/_utils/__init__.py similarity index 100% rename from telegram/ext/_utils/__init__.py rename to src/telegram/ext/_utils/__init__.py diff --git a/telegram/ext/_utils/_update_parsing.py b/src/telegram/ext/_utils/_update_parsing.py similarity index 100% rename from telegram/ext/_utils/_update_parsing.py rename to src/telegram/ext/_utils/_update_parsing.py diff --git a/telegram/ext/_utils/asyncio.py b/src/telegram/ext/_utils/asyncio.py similarity index 100% rename from telegram/ext/_utils/asyncio.py rename to src/telegram/ext/_utils/asyncio.py diff --git a/telegram/ext/_utils/networkloop.py b/src/telegram/ext/_utils/networkloop.py similarity index 97% rename from telegram/ext/_utils/networkloop.py rename to src/telegram/ext/_utils/networkloop.py index 03c54e8e8a2..2cc93113272 100644 --- a/telegram/ext/_utils/networkloop.py +++ b/src/telegram/ext/_utils/networkloop.py @@ -119,7 +119,8 @@ async def do_action() -> bool: _LOGGER.info( "%s %s. Adding %s seconds to the specified time.", log_prefix, exc, slack_time ) - cur_interval = slack_time + exc.retry_after + # pylint: disable=protected-access + cur_interval = slack_time + exc._retry_after.total_seconds() except TimedOut as toe: _LOGGER.debug("%s Timed out: %s. Retrying immediately.", log_prefix, toe) # If failure is due to timeout, we should retry asap. diff --git a/telegram/ext/_utils/stack.py b/src/telegram/ext/_utils/stack.py similarity index 100% rename from telegram/ext/_utils/stack.py rename to src/telegram/ext/_utils/stack.py diff --git a/telegram/ext/_utils/trackingdict.py b/src/telegram/ext/_utils/trackingdict.py similarity index 100% rename from telegram/ext/_utils/trackingdict.py rename to src/telegram/ext/_utils/trackingdict.py diff --git a/telegram/ext/_utils/types.py b/src/telegram/ext/_utils/types.py similarity index 100% rename from telegram/ext/_utils/types.py rename to src/telegram/ext/_utils/types.py diff --git a/telegram/ext/_utils/webhookhandler.py b/src/telegram/ext/_utils/webhookhandler.py similarity index 100% rename from telegram/ext/_utils/webhookhandler.py rename to src/telegram/ext/_utils/webhookhandler.py diff --git a/telegram/ext/filters.py b/src/telegram/ext/filters.py similarity index 100% rename from telegram/ext/filters.py rename to src/telegram/ext/filters.py diff --git a/telegram/helpers.py b/src/telegram/helpers.py similarity index 100% rename from telegram/helpers.py rename to src/telegram/helpers.py diff --git a/telegram/py.typed b/src/telegram/py.typed similarity index 100% rename from telegram/py.typed rename to src/telegram/py.typed diff --git a/telegram/request/__init__.py b/src/telegram/request/__init__.py similarity index 100% rename from telegram/request/__init__.py rename to src/telegram/request/__init__.py diff --git a/telegram/request/_baserequest.py b/src/telegram/request/_baserequest.py similarity index 89% rename from telegram/request/_baserequest.py rename to src/telegram/request/_baserequest.py index 666f2d042db..879d79d1ce2 100644 --- a/telegram/request/_baserequest.py +++ b/src/telegram/request/_baserequest.py @@ -317,45 +317,61 @@ async def _request_wrapper( if HTTPStatus.OK <= code <= 299: # 200-299 range are HTTP success statuses + # starting with Py 3.12 we can use `HTTPStatus.is_success` return payload - response_data = self.parse_json_payload(payload) - - description = response_data.get("description") - message = description if description else "Unknown HTTPError" + try: + message = f"{HTTPStatus(code).phrase} ({code})" + except ValueError: + message = f"Unknown HTTPError ({code})" - # In some special cases, we can raise more informative exceptions: - # see https://core.telegram.org/bots/api#responseparameters and - # https://core.telegram.org/bots/api#making-requests - # TGs response also has the fields 'ok' and 'error_code'. - # However, we rather rely on the HTTP status code for now. - parameters = response_data.get("parameters") - if parameters: - migrate_to_chat_id = parameters.get("migrate_to_chat_id") - if migrate_to_chat_id: - raise ChatMigrated(migrate_to_chat_id) - retry_after = parameters.get("retry_after") - if retry_after: - raise RetryAfter(retry_after) + parsing_exception: Optional[TelegramError] = None - message += f"\nThe server response contained unknown parameters: {parameters}" + try: + response_data = self.parse_json_payload(payload) + except TelegramError as exc: + message += f". Parsing the server response {payload!r} failed" + parsing_exception = exc + else: + message = response_data.get("description") or message + + # In some special cases, we can raise more informative exceptions: + # see https://core.telegram.org/bots/api#responseparameters and + # https://core.telegram.org/bots/api#making-requests + # TGs response also has the fields 'ok' and 'error_code'. + # However, we rather rely on the HTTP status code for now. + parameters = response_data.get("parameters") + if parameters: + migrate_to_chat_id = parameters.get("migrate_to_chat_id") + if migrate_to_chat_id: + raise ChatMigrated(migrate_to_chat_id) + retry_after = parameters.get("retry_after") + if retry_after: + raise RetryAfter(retry_after) + + message += f". The server response contained unknown parameters: {parameters}" if code == HTTPStatus.FORBIDDEN: # 403 - raise Forbidden(message) - if code in (HTTPStatus.NOT_FOUND, HTTPStatus.UNAUTHORIZED): # 404 and 401 + exception: TelegramError = Forbidden(message) + elif code in (HTTPStatus.NOT_FOUND, HTTPStatus.UNAUTHORIZED): # 404 and 401 # TG returns 404 Not found for # 1) malformed tokens # 2) correct tokens but non-existing method, e.g. api.tg.org/botTOKEN/unkonwnMethod # 2) is relevant only for Bot.do_api_request, where we have special handing for it. # TG returns 401 Unauthorized for correctly formatted tokens that are not valid - raise InvalidToken(message) - if code == HTTPStatus.BAD_REQUEST: # 400 - raise BadRequest(message) - if code == HTTPStatus.CONFLICT: # 409 - raise Conflict(message) - if code == HTTPStatus.BAD_GATEWAY: # 502 - raise NetworkError(description or "Bad Gateway") - raise NetworkError(f"{message} ({code})") + exception = InvalidToken(message) + elif code == HTTPStatus.BAD_REQUEST: # 400 + exception = BadRequest(message) + elif code == HTTPStatus.CONFLICT: # 409 + exception = Conflict(message) + elif code == HTTPStatus.BAD_GATEWAY: # 502 + exception = NetworkError(message) + else: + exception = NetworkError(message) + + if parsing_exception: + raise exception from parsing_exception + raise exception @staticmethod def parse_json_payload(payload: bytes) -> JSONDict: diff --git a/telegram/request/_httpxrequest.py b/src/telegram/request/_httpxrequest.py similarity index 100% rename from telegram/request/_httpxrequest.py rename to src/telegram/request/_httpxrequest.py diff --git a/telegram/request/_requestdata.py b/src/telegram/request/_requestdata.py similarity index 100% rename from telegram/request/_requestdata.py rename to src/telegram/request/_requestdata.py diff --git a/telegram/request/_requestparameter.py b/src/telegram/request/_requestparameter.py similarity index 100% rename from telegram/request/_requestparameter.py rename to src/telegram/request/_requestparameter.py diff --git a/telegram/warnings.py b/src/telegram/warnings.py similarity index 100% rename from telegram/warnings.py rename to src/telegram/warnings.py diff --git a/tests/README.rst b/tests/README.rst index a6724558041..77fbd7b1855 100644 --- a/tests/README.rst +++ b/tests/README.rst @@ -6,6 +6,12 @@ PTB uses `pytest`_ for testing. To run the tests, you need to have pytest installed along with a few other dependencies. You can find the list of dependencies in the ``pyproject.toml`` file in the root of the repository. +Since PTB uses a src-based layout, make sure you have installed the package in development mode before running the tests: + +.. code-block:: bash + + $ pip install -e . + Running tests ============= @@ -36,7 +42,7 @@ such that tests marked with ``@pytest.mark.xdist_group("name")`` are run on the .. code-block:: bash - $ pytest -n auto --dist=loadgroup + $ pytest -n auto --dist=worksteal This will result in a significant speedup, but may cause some tests to fail. If you want to run the failed tests in isolation, you can use the ``--lf`` flag: diff --git a/tests/_files/test_animation.py b/tests/_files/test_animation.py index 5ae93dd61ef..50437e69877 100644 --- a/tests/_files/test_animation.py +++ b/tests/_files/test_animation.py @@ -28,6 +28,7 @@ from telegram.error import BadRequest, TelegramError from telegram.helpers import escape_markdown from telegram.request import RequestData +from telegram.warnings import PTBDeprecationWarning from tests.auxil.bot_method_checks import ( check_defaults_handling, check_shortcut_call, @@ -43,7 +44,7 @@ class AnimationTestBase: animation_file_unique_id = "adc3145fd2e84d95b64d68eaa22aa33e" width = 320 height = 180 - duration = 1 + duration = dtm.timedelta(seconds=1) # animation_file_url = 'https://python-telegram-bot.org/static/testfiles/game.gif' # Shortened link, the above one is cached with the wrong duration. animation_file_url = "http://bit.ly/2L18jua" @@ -77,7 +78,7 @@ def test_de_json(self, offline_bot, animation): "file_unique_id": self.animation_file_unique_id, "width": self.width, "height": self.height, - "duration": self.duration, + "duration": self.duration.total_seconds(), "thumbnail": animation.thumbnail.to_dict(), "file_name": self.file_name, "mime_type": self.mime_type, @@ -90,6 +91,7 @@ def test_de_json(self, offline_bot, animation): assert animation.file_name == self.file_name assert animation.mime_type == self.mime_type assert animation.file_size == self.file_size + assert animation._duration == self.duration def test_to_dict(self, animation): animation_dict = animation.to_dict() @@ -99,12 +101,31 @@ def test_to_dict(self, animation): assert animation_dict["file_unique_id"] == animation.file_unique_id assert animation_dict["width"] == animation.width assert animation_dict["height"] == animation.height - assert animation_dict["duration"] == animation.duration + assert animation_dict["duration"] == int(self.duration.total_seconds()) + assert isinstance(animation_dict["duration"], int) assert animation_dict["thumbnail"] == animation.thumbnail.to_dict() assert animation_dict["file_name"] == animation.file_name assert animation_dict["mime_type"] == animation.mime_type assert animation_dict["file_size"] == animation.file_size + def test_time_period_properties(self, PTB_TIMEDELTA, animation): + if PTB_TIMEDELTA: + assert animation.duration == self.duration + assert isinstance(animation.duration, dtm.timedelta) + else: + assert animation.duration == int(self.duration.total_seconds()) + assert isinstance(animation.duration, int) + + def test_time_period_int_deprecated(self, recwarn, PTB_TIMEDELTA, animation): + animation.duration + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + else: + assert len(recwarn) == 1 + assert "`duration` will be of type `datetime.timedelta`" in str(recwarn[0].message) + assert recwarn[0].category is PTBDeprecationWarning + def test_equality(self): a = Animation( self.animation_file_id, diff --git a/tests/_files/test_audio.py b/tests/_files/test_audio.py index 78112058cdd..47d8dff9c2f 100644 --- a/tests/_files/test_audio.py +++ b/tests/_files/test_audio.py @@ -28,6 +28,7 @@ from telegram.error import BadRequest, TelegramError from telegram.helpers import escape_markdown from telegram.request import RequestData +from telegram.warnings import PTBDeprecationWarning from tests.auxil.bot_method_checks import ( check_defaults_handling, check_shortcut_call, @@ -43,7 +44,7 @@ class AudioTestBase: performer = "Leandro Toledo" title = "Teste" file_name = "telegram.mp3" - duration = 3 + duration = dtm.timedelta(seconds=3) # audio_file_url = 'https://python-telegram-bot.org/static/testfiles/telegram.mp3' # Shortened link, the above one is cached with the wrong duration. audio_file_url = "https://goo.gl/3En24v" @@ -71,7 +72,7 @@ def test_creation(self, audio): assert audio.file_unique_id def test_expected_values(self, audio): - assert audio.duration == self.duration + assert audio._duration == self.duration assert audio.performer is None assert audio.title is None assert audio.mime_type == self.mime_type @@ -84,7 +85,7 @@ def test_de_json(self, offline_bot, audio): json_dict = { "file_id": self.audio_file_id, "file_unique_id": self.audio_file_unique_id, - "duration": self.duration, + "duration": int(self.duration.total_seconds()), "performer": self.performer, "title": self.title, "file_name": self.file_name, @@ -97,7 +98,7 @@ def test_de_json(self, offline_bot, audio): assert json_audio.file_id == self.audio_file_id assert json_audio.file_unique_id == self.audio_file_unique_id - assert json_audio.duration == self.duration + assert json_audio._duration == self.duration assert json_audio.performer == self.performer assert json_audio.title == self.title assert json_audio.file_name == self.file_name @@ -111,11 +112,30 @@ def test_to_dict(self, audio): assert isinstance(audio_dict, dict) assert audio_dict["file_id"] == audio.file_id assert audio_dict["file_unique_id"] == audio.file_unique_id - assert audio_dict["duration"] == audio.duration + assert audio_dict["duration"] == int(self.duration.total_seconds()) + assert isinstance(audio_dict["duration"], int) assert audio_dict["mime_type"] == audio.mime_type assert audio_dict["file_size"] == audio.file_size assert audio_dict["file_name"] == audio.file_name + def test_time_period_properties(self, PTB_TIMEDELTA, audio): + if PTB_TIMEDELTA: + assert audio.duration == self.duration + assert isinstance(audio.duration, dtm.timedelta) + else: + assert audio.duration == int(self.duration.total_seconds()) + assert isinstance(audio.duration, int) + + def test_time_period_int_deprecated(self, recwarn, PTB_TIMEDELTA, audio): + audio.duration + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + else: + assert len(recwarn) == 1 + assert "`duration` will be of type `datetime.timedelta`" in str(recwarn[0].message) + assert recwarn[0].category is PTBDeprecationWarning + def test_equality(self, audio): a = Audio(audio.file_id, audio.file_unique_id, audio.duration) b = Audio("", audio.file_unique_id, audio.duration) @@ -237,7 +257,7 @@ async def test_send_all_args(self, bot, chat_id, audio_file, thumb_file, duratio assert isinstance(message.audio.file_unique_id, str) assert message.audio.file_unique_id is not None assert message.audio.file_id is not None - assert message.audio.duration == self.duration + assert message.audio._duration == self.duration assert message.audio.performer == self.performer assert message.audio.title == self.title assert message.audio.file_name == self.file_name diff --git a/tests/_files/test_inputmedia.py b/tests/_files/test_inputmedia.py index a077c309cc5..08bdf3428a3 100644 --- a/tests/_files/test_inputmedia.py +++ b/tests/_files/test_inputmedia.py @@ -18,6 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. import asyncio import copy +import datetime as dtm from collections.abc import Sequence from typing import Optional @@ -40,6 +41,7 @@ from telegram.constants import InputMediaType, ParseMode from telegram.error import BadRequest from telegram.request import RequestData +from telegram.warnings import PTBDeprecationWarning from tests.auxil.files import data_file from tests.auxil.networking import expect_bad_request from tests.auxil.slots import mro_slots @@ -147,7 +149,7 @@ class InputMediaVideoTestBase: caption = "My Caption" width = 3 height = 4 - duration = 5 + duration = dtm.timedelta(seconds=5) start_timestamp = 3 parse_mode = "HTML" supports_streaming = True @@ -169,7 +171,7 @@ def test_expected_values(self, input_media_video): assert input_media_video.caption == self.caption assert input_media_video.width == self.width assert input_media_video.height == self.height - assert input_media_video.duration == self.duration + assert input_media_video._duration == self.duration assert input_media_video.parse_mode == self.parse_mode assert input_media_video.caption_entities == tuple(self.caption_entities) assert input_media_video.supports_streaming == self.supports_streaming @@ -190,7 +192,8 @@ def test_to_dict(self, input_media_video): assert input_media_video_dict["caption"] == input_media_video.caption assert input_media_video_dict["width"] == input_media_video.width assert input_media_video_dict["height"] == input_media_video.height - assert input_media_video_dict["duration"] == input_media_video.duration + assert input_media_video_dict["duration"] == int(self.duration.total_seconds()) + assert isinstance(input_media_video_dict["duration"], int) assert input_media_video_dict["parse_mode"] == input_media_video.parse_mode assert input_media_video_dict["caption_entities"] == [ ce.to_dict() for ce in input_media_video.caption_entities @@ -204,7 +207,27 @@ def test_to_dict(self, input_media_video): assert input_media_video_dict["cover"] == input_media_video.cover assert input_media_video_dict["start_timestamp"] == input_media_video.start_timestamp - def test_with_video(self, video): + def test_time_period_properties(self, PTB_TIMEDELTA, input_media_video): + duration = input_media_video.duration + + if PTB_TIMEDELTA: + assert duration == self.duration + assert isinstance(duration, dtm.timedelta) + else: + assert duration == int(self.duration.total_seconds()) + assert isinstance(duration, int) + + def test_time_period_int_deprecated(self, recwarn, PTB_TIMEDELTA, input_media_video): + input_media_video.duration + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + else: + assert len(recwarn) == 1 + assert "`duration` will be of type `datetime.timedelta`" in str(recwarn[0].message) + assert recwarn[0].category is PTBDeprecationWarning + + def test_with_video(self, video, PTB_TIMEDELTA): # fixture found in test_video input_media_video = InputMediaVideo(video, caption="test 3") assert input_media_video.type == self.type_ @@ -324,7 +347,7 @@ class InputMediaAnimationTestBase: caption_entities = [MessageEntity(MessageEntity.BOLD, 0, 2)] width = 30 height = 30 - duration = 1 + duration = dtm.timedelta(seconds=1) has_spoiler = True show_caption_above_media = True @@ -345,6 +368,7 @@ def test_expected_values(self, input_media_animation): assert isinstance(input_media_animation.thumbnail, InputFile) assert input_media_animation.has_spoiler == self.has_spoiler assert input_media_animation.show_caption_above_media == self.show_caption_above_media + assert input_media_animation._duration == self.duration def test_caption_entities_always_tuple(self): input_media_animation = InputMediaAnimation(self.media) @@ -361,13 +385,34 @@ def test_to_dict(self, input_media_animation): ] assert input_media_animation_dict["width"] == input_media_animation.width assert input_media_animation_dict["height"] == input_media_animation.height - assert input_media_animation_dict["duration"] == input_media_animation.duration + assert input_media_animation_dict["duration"] == int(self.duration.total_seconds()) + assert isinstance(input_media_animation_dict["duration"], int) assert input_media_animation_dict["has_spoiler"] == input_media_animation.has_spoiler assert ( input_media_animation_dict["show_caption_above_media"] == input_media_animation.show_caption_above_media ) + def test_time_period_properties(self, PTB_TIMEDELTA, input_media_animation): + duration = input_media_animation.duration + + if PTB_TIMEDELTA: + assert duration == self.duration + assert isinstance(duration, dtm.timedelta) + else: + assert duration == int(self.duration.total_seconds()) + assert isinstance(duration, int) + + def test_time_period_int_deprecated(self, recwarn, PTB_TIMEDELTA, input_media_animation): + input_media_animation.duration + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + else: + assert len(recwarn) == 1 + assert "`duration` will be of type `datetime.timedelta`" in str(recwarn[0].message) + assert recwarn[0].category is PTBDeprecationWarning + def test_with_animation(self, animation): # fixture found in test_animation input_media_animation = InputMediaAnimation(animation, caption="test 2") @@ -394,7 +439,7 @@ class InputMediaAudioTestBase: type_ = "audio" media = "NOTAREALFILEID" caption = "My Caption" - duration = 3 + duration = dtm.timedelta(seconds=3) performer = "performer" title = "title" parse_mode = "HTML" @@ -412,7 +457,7 @@ def test_expected_values(self, input_media_audio): assert input_media_audio.type == self.type_ assert input_media_audio.media == self.media assert input_media_audio.caption == self.caption - assert input_media_audio.duration == self.duration + assert input_media_audio._duration == self.duration assert input_media_audio.performer == self.performer assert input_media_audio.title == self.title assert input_media_audio.parse_mode == self.parse_mode @@ -428,7 +473,9 @@ def test_to_dict(self, input_media_audio): assert input_media_audio_dict["type"] == input_media_audio.type assert input_media_audio_dict["media"] == input_media_audio.media assert input_media_audio_dict["caption"] == input_media_audio.caption - assert input_media_audio_dict["duration"] == input_media_audio.duration + assert isinstance(input_media_audio_dict["duration"], int) + assert input_media_audio_dict["duration"] == int(self.duration.total_seconds()) + assert isinstance(input_media_audio_dict["duration"], int) assert input_media_audio_dict["performer"] == input_media_audio.performer assert input_media_audio_dict["title"] == input_media_audio.title assert input_media_audio_dict["parse_mode"] == input_media_audio.parse_mode @@ -436,6 +483,26 @@ def test_to_dict(self, input_media_audio): ce.to_dict() for ce in input_media_audio.caption_entities ] + def test_time_period_properties(self, PTB_TIMEDELTA, input_media_audio): + duration = input_media_audio.duration + + if PTB_TIMEDELTA: + assert duration == self.duration + assert isinstance(duration, dtm.timedelta) + else: + assert duration == int(self.duration.total_seconds()) + assert isinstance(duration, int) + + def test_time_period_int_deprecated(self, recwarn, PTB_TIMEDELTA, input_media_audio): + input_media_audio.duration + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + else: + assert len(recwarn) == 1 + assert "`duration` will be of type `datetime.timedelta`" in str(recwarn[0].message) + assert recwarn[0].category is PTBDeprecationWarning + def test_with_audio(self, audio): # fixture found in test_audio input_media_audio = InputMediaAudio(audio, caption="test 3") @@ -574,7 +641,7 @@ def test_expected_values(self, input_paid_media_video): assert input_paid_media_video.media == self.media assert input_paid_media_video.width == self.width assert input_paid_media_video.height == self.height - assert input_paid_media_video.duration == self.duration + assert input_paid_media_video._duration == self.duration assert input_paid_media_video.supports_streaming == self.supports_streaming assert isinstance(input_paid_media_video.thumbnail, InputFile) assert isinstance(input_paid_media_video.cover, InputFile) @@ -586,7 +653,8 @@ def test_to_dict(self, input_paid_media_video): assert input_paid_media_video_dict["media"] == input_paid_media_video.media assert input_paid_media_video_dict["width"] == input_paid_media_video.width assert input_paid_media_video_dict["height"] == input_paid_media_video.height - assert input_paid_media_video_dict["duration"] == input_paid_media_video.duration + assert input_paid_media_video_dict["duration"] == int(self.duration.total_seconds()) + assert isinstance(input_paid_media_video_dict["duration"], int) assert ( input_paid_media_video_dict["supports_streaming"] == input_paid_media_video.supports_streaming @@ -598,6 +666,26 @@ def test_to_dict(self, input_paid_media_video): == input_paid_media_video.start_timestamp ) + def test_time_period_properties(self, PTB_TIMEDELTA, input_paid_media_video): + duration = input_paid_media_video.duration + + if PTB_TIMEDELTA: + assert duration == self.duration + assert isinstance(duration, dtm.timedelta) + else: + assert duration == int(self.duration.total_seconds()) + assert isinstance(duration, int) + + def test_time_period_int_deprecated(self, recwarn, PTB_TIMEDELTA, input_paid_media_video): + input_paid_media_video.duration + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + else: + assert len(recwarn) == 1 + assert "`duration` will be of type `datetime.timedelta`" in str(recwarn[0].message) + assert recwarn[0].category is PTBDeprecationWarning + def test_with_video(self, video): # fixture found in test_video input_paid_media_video = InputPaidMediaVideo(video) diff --git a/tests/_files/test_inputstorycontent.py b/tests/_files/test_inputstorycontent.py index 9e826409584..37762a24e1a 100644 --- a/tests/_files/test_inputstorycontent.py +++ b/tests/_files/test_inputstorycontent.py @@ -107,7 +107,7 @@ class InputStoryContentVideoTestBase: is_animation = False -class TestInputMediaVideoWithoutRequest(InputStoryContentVideoTestBase): +class TestInputStoryContentVideoWithoutRequest(InputStoryContentVideoTestBase): def test_slot_behaviour(self, input_story_content_video): inst = input_story_content_video for attr in inst.__slots__: @@ -131,6 +131,25 @@ def test_to_dict(self, input_story_content_video): assert json_dict["cover_frame_timestamp"] == self.cover_frame_timestamp.total_seconds() assert json_dict["is_animation"] is self.is_animation + @pytest.mark.parametrize( + ("argument", "expected"), + [(4, 4), (4.0, 4), (dtm.timedelta(seconds=4), 4), (4.5, 4.5)], + ) + def test_to_dict_float_time_period(self, argument, expected): + # We test that whole number conversion works properly. Only tested here but + # relevant for some other classes too (e.g InputProfilePhotoAnimated.main_frame_timestamp) + inst = InputStoryContentVideo( + video=self.video.read_bytes(), + duration=argument, + cover_frame_timestamp=argument, + ) + json_dict = inst.to_dict() + + assert json_dict["duration"] == expected + assert type(json_dict["duration"]) is type(expected) + assert json_dict["cover_frame_timestamp"] == expected + assert type(json_dict["cover_frame_timestamp"]) is type(expected) + def test_with_video_file(self, video_file): inst = InputStoryContentVideo(video=video_file) assert inst.type is self.type diff --git a/tests/_files/test_location.py b/tests/_files/test_location.py index 5ccddbac527..30cfb20595f 100644 --- a/tests/_files/test_location.py +++ b/tests/_files/test_location.py @@ -25,6 +25,7 @@ from telegram.constants import ParseMode from telegram.error import BadRequest from telegram.request import RequestData +from telegram.warnings import PTBDeprecationWarning from tests.auxil.build_messages import make_message from tests.auxil.slots import mro_slots @@ -45,7 +46,7 @@ class LocationTestBase: latitude = -23.691288 longitude = -46.788279 horizontal_accuracy = 999 - live_period = 60 + live_period = dtm.timedelta(seconds=60) heading = 90 proximity_alert_radius = 50 @@ -61,7 +62,7 @@ def test_de_json(self, offline_bot): "latitude": self.latitude, "longitude": self.longitude, "horizontal_accuracy": self.horizontal_accuracy, - "live_period": self.live_period, + "live_period": int(self.live_period.total_seconds()), "heading": self.heading, "proximity_alert_radius": self.proximity_alert_radius, } @@ -71,7 +72,7 @@ def test_de_json(self, offline_bot): assert location.latitude == self.latitude assert location.longitude == self.longitude assert location.horizontal_accuracy == self.horizontal_accuracy - assert location.live_period == self.live_period + assert location._live_period == self.live_period assert location.heading == self.heading assert location.proximity_alert_radius == self.proximity_alert_radius @@ -81,10 +82,29 @@ def test_to_dict(self, location): assert location_dict["latitude"] == location.latitude assert location_dict["longitude"] == location.longitude assert location_dict["horizontal_accuracy"] == location.horizontal_accuracy - assert location_dict["live_period"] == location.live_period + assert location_dict["live_period"] == int(self.live_period.total_seconds()) + assert isinstance(location_dict["live_period"], int) assert location["heading"] == location.heading assert location["proximity_alert_radius"] == location.proximity_alert_radius + def test_time_period_properties(self, PTB_TIMEDELTA, location): + if PTB_TIMEDELTA: + assert location.live_period == self.live_period + assert isinstance(location.live_period, dtm.timedelta) + else: + assert location.live_period == int(self.live_period.total_seconds()) + assert isinstance(location.live_period, int) + + def test_time_period_int_deprecated(self, recwarn, PTB_TIMEDELTA, location): + location.live_period + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + else: + assert len(recwarn) == 1 + assert "`live_period` will be of type `datetime.timedelta`" in str(recwarn[0].message) + assert recwarn[0].category is PTBDeprecationWarning + def test_equality(self): a = Location(self.longitude, self.latitude) b = Location(self.longitude, self.latitude) diff --git a/tests/_files/test_video.py b/tests/_files/test_video.py index d4d87122576..b701c11928a 100644 --- a/tests/_files/test_video.py +++ b/tests/_files/test_video.py @@ -28,6 +28,7 @@ from telegram.error import BadRequest, TelegramError from telegram.helpers import escape_markdown from telegram.request import RequestData +from telegram.warnings import PTBDeprecationWarning from tests.auxil.bot_method_checks import ( check_defaults_handling, check_shortcut_call, @@ -38,15 +39,26 @@ from tests.auxil.slots import mro_slots +# Override `video` fixture to provide start_timestamp +@pytest.fixture(scope="module") +async def video(bot, chat_id): + with data_file("telegram.mp4").open("rb") as f: + return ( + await bot.send_video( + chat_id, video=f, start_timestamp=VideoTestBase.start_timestamp, read_timeout=50 + ) + ).video + + class VideoTestBase: width = 360 height = 640 - duration = 5 + duration = dtm.timedelta(seconds=5) file_size = 326534 mime_type = "video/mp4" supports_streaming = True file_name = "telegram.mp4" - start_timestamp = 3 + start_timestamp = dtm.timedelta(seconds=3) cover = (PhotoSize("file_id", "unique_id", 640, 360, file_size=0),) thumb_width = 180 thumb_height = 320 @@ -80,9 +92,10 @@ def test_creation(self, video): def test_expected_values(self, video): assert video.width == self.width assert video.height == self.height - assert video.duration == self.duration + assert video._duration == self.duration assert video.file_size == self.file_size assert video.mime_type == self.mime_type + assert video._start_timestamp == self.start_timestamp def test_de_json(self, offline_bot): json_dict = { @@ -90,11 +103,11 @@ def test_de_json(self, offline_bot): "file_unique_id": self.video_file_unique_id, "width": self.width, "height": self.height, - "duration": self.duration, + "duration": int(self.duration.total_seconds()), "mime_type": self.mime_type, "file_size": self.file_size, "file_name": self.file_name, - "start_timestamp": self.start_timestamp, + "start_timestamp": int(self.start_timestamp.total_seconds()), "cover": [photo_size.to_dict() for photo_size in self.cover], } json_video = Video.de_json(json_dict, offline_bot) @@ -104,11 +117,11 @@ def test_de_json(self, offline_bot): assert json_video.file_unique_id == self.video_file_unique_id assert json_video.width == self.width assert json_video.height == self.height - assert json_video.duration == self.duration + assert json_video._duration == self.duration assert json_video.mime_type == self.mime_type assert json_video.file_size == self.file_size assert json_video.file_name == self.file_name - assert json_video.start_timestamp == self.start_timestamp + assert json_video._start_timestamp == self.start_timestamp assert json_video.cover == self.cover def test_to_dict(self, video): @@ -119,10 +132,39 @@ def test_to_dict(self, video): assert video_dict["file_unique_id"] == video.file_unique_id assert video_dict["width"] == video.width assert video_dict["height"] == video.height - assert video_dict["duration"] == video.duration + assert video_dict["duration"] == int(self.duration.total_seconds()) + assert isinstance(video_dict["duration"], int) assert video_dict["mime_type"] == video.mime_type assert video_dict["file_size"] == video.file_size assert video_dict["file_name"] == video.file_name + assert video_dict["start_timestamp"] == int(self.start_timestamp.total_seconds()) + assert isinstance(video_dict["start_timestamp"], int) + + def test_time_period_properties(self, PTB_TIMEDELTA, video): + if PTB_TIMEDELTA: + assert video.duration == self.duration + assert isinstance(video.duration, dtm.timedelta) + + assert video.start_timestamp == self.start_timestamp + assert isinstance(video.start_timestamp, dtm.timedelta) + else: + assert video.duration == int(self.duration.total_seconds()) + assert isinstance(video.duration, int) + + assert video.start_timestamp == int(self.start_timestamp.total_seconds()) + assert isinstance(video.start_timestamp, int) + + def test_time_period_int_deprecated(self, recwarn, PTB_TIMEDELTA, video): + video.duration + video.start_timestamp + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + else: + assert len(recwarn) == 2 + for i, attr in enumerate(["duration", "start_timestamp"]): + assert f"`{attr}` will be of type `datetime.timedelta`" in str(recwarn[i].message) + assert recwarn[i].category is PTBDeprecationWarning def test_equality(self, video): a = Video(video.file_id, video.file_unique_id, self.width, self.height, self.duration) @@ -266,7 +308,7 @@ async def test_send_all_args( assert message.video.thumbnail.width == self.thumb_width assert message.video.thumbnail.height == self.thumb_height - assert message.video.start_timestamp == self.start_timestamp + assert message.video._start_timestamp == self.start_timestamp assert isinstance(message.video.cover, tuple) assert isinstance(message.video.cover[0], PhotoSize) diff --git a/tests/_files/test_videonote.py b/tests/_files/test_videonote.py index 5edab597806..40f853bca52 100644 --- a/tests/_files/test_videonote.py +++ b/tests/_files/test_videonote.py @@ -27,6 +27,7 @@ from telegram.constants import ParseMode from telegram.error import BadRequest, TelegramError from telegram.request import RequestData +from telegram.warnings import PTBDeprecationWarning from tests.auxil.bot_method_checks import ( check_defaults_handling, check_shortcut_call, @@ -51,7 +52,7 @@ async def video_note(bot, chat_id): class VideoNoteTestBase: length = 240 - duration = 3 + duration = dtm.timedelta(seconds=3) file_size = 132084 thumb_width = 240 thumb_height = 240 @@ -81,17 +82,12 @@ def test_creation(self, video_note): assert video_note.thumbnail.file_id assert video_note.thumbnail.file_unique_id - def test_expected_values(self, video_note): - assert video_note.length == self.length - assert video_note.duration == self.duration - assert video_note.file_size == self.file_size - def test_de_json(self, offline_bot): json_dict = { "file_id": self.videonote_file_id, "file_unique_id": self.videonote_file_unique_id, "length": self.length, - "duration": self.duration, + "duration": int(self.duration.total_seconds()), "file_size": self.file_size, } json_video_note = VideoNote.de_json(json_dict, offline_bot) @@ -100,7 +96,7 @@ def test_de_json(self, offline_bot): assert json_video_note.file_id == self.videonote_file_id assert json_video_note.file_unique_id == self.videonote_file_unique_id assert json_video_note.length == self.length - assert json_video_note.duration == self.duration + assert json_video_note._duration == self.duration assert json_video_note.file_size == self.file_size def test_to_dict(self, video_note): @@ -110,9 +106,28 @@ def test_to_dict(self, video_note): assert video_note_dict["file_id"] == video_note.file_id assert video_note_dict["file_unique_id"] == video_note.file_unique_id assert video_note_dict["length"] == video_note.length - assert video_note_dict["duration"] == video_note.duration + assert video_note_dict["duration"] == int(self.duration.total_seconds()) + assert isinstance(video_note_dict["duration"], int) assert video_note_dict["file_size"] == video_note.file_size + def test_time_period_properties(self, PTB_TIMEDELTA, video_note): + if PTB_TIMEDELTA: + assert video_note.duration == self.duration + assert isinstance(video_note.duration, dtm.timedelta) + else: + assert video_note.duration == int(self.duration.total_seconds()) + assert isinstance(video_note.duration, int) + + def test_time_period_int_deprecated(self, recwarn, PTB_TIMEDELTA, video_note): + video_note.duration + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + else: + assert len(recwarn) == 1 + assert "`duration` will be of type `datetime.timedelta`" in str(recwarn[0].message) + assert recwarn[0].category is PTBDeprecationWarning + def test_equality(self, video_note): a = VideoNote(video_note.file_id, video_note.file_unique_id, self.length, self.duration) b = VideoNote("", video_note.file_unique_id, self.length, self.duration) diff --git a/tests/_files/test_voice.py b/tests/_files/test_voice.py index c06b1218139..62fdb4e79f8 100644 --- a/tests/_files/test_voice.py +++ b/tests/_files/test_voice.py @@ -28,6 +28,7 @@ from telegram.error import BadRequest, TelegramError from telegram.helpers import escape_markdown from telegram.request import RequestData +from telegram.warnings import PTBDeprecationWarning from tests.auxil.bot_method_checks import ( check_defaults_handling, check_shortcut_call, @@ -51,7 +52,7 @@ async def voice(bot, chat_id): class VoiceTestBase: - duration = 3 + duration = dtm.timedelta(seconds=3) mime_type = "audio/ogg" file_size = 9199 caption = "Test *voice*" @@ -75,7 +76,7 @@ async def test_creation(self, voice): assert voice.file_unique_id def test_expected_values(self, voice): - assert voice.duration == self.duration + assert voice._duration == self.duration assert voice.mime_type == self.mime_type assert voice.file_size == self.file_size @@ -83,7 +84,7 @@ def test_de_json(self, offline_bot): json_dict = { "file_id": self.voice_file_id, "file_unique_id": self.voice_file_unique_id, - "duration": self.duration, + "duration": int(self.duration.total_seconds()), "mime_type": self.mime_type, "file_size": self.file_size, } @@ -92,7 +93,7 @@ def test_de_json(self, offline_bot): assert json_voice.file_id == self.voice_file_id assert json_voice.file_unique_id == self.voice_file_unique_id - assert json_voice.duration == self.duration + assert json_voice._duration == self.duration assert json_voice.mime_type == self.mime_type assert json_voice.file_size == self.file_size @@ -102,10 +103,29 @@ def test_to_dict(self, voice): assert isinstance(voice_dict, dict) assert voice_dict["file_id"] == voice.file_id assert voice_dict["file_unique_id"] == voice.file_unique_id - assert voice_dict["duration"] == voice.duration + assert voice_dict["duration"] == int(self.duration.total_seconds()) + assert isinstance(voice_dict["duration"], int) assert voice_dict["mime_type"] == voice.mime_type assert voice_dict["file_size"] == voice.file_size + def test_time_period_properties(self, PTB_TIMEDELTA, voice): + if PTB_TIMEDELTA: + assert voice.duration == self.duration + assert isinstance(voice.duration, dtm.timedelta) + else: + assert voice.duration == int(self.duration.total_seconds()) + assert isinstance(voice.duration, int) + + def test_time_period_int_deprecated(self, recwarn, PTB_TIMEDELTA, voice): + voice.duration + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + else: + assert len(recwarn) == 1 + assert "`duration` will be of type `datetime.timedelta`" in str(recwarn[0].message) + assert recwarn[0].category is PTBDeprecationWarning + def test_equality(self, voice): a = Voice(voice.file_id, voice.file_unique_id, self.duration) b = Voice("", voice.file_unique_id, self.duration) diff --git a/tests/_inline/test_inlinequeryresultaudio.py b/tests/_inline/test_inlinequeryresultaudio.py index 4c781655910..17871fa854d 100644 --- a/tests/_inline/test_inlinequeryresultaudio.py +++ b/tests/_inline/test_inlinequeryresultaudio.py @@ -17,6 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. +import datetime as dtm + import pytest from telegram import ( @@ -27,6 +29,7 @@ InputTextMessageContent, MessageEntity, ) +from telegram.warnings import PTBDeprecationWarning from tests.auxil.slots import mro_slots @@ -52,7 +55,7 @@ class InlineQueryResultAudioTestBase: audio_url = "audio url" title = "title" performer = "performer" - audio_duration = "audio_duration" + audio_duration = dtm.timedelta(seconds=10) caption = "caption" parse_mode = "Markdown" caption_entities = [MessageEntity(MessageEntity.ITALIC, 0, 7)] @@ -73,7 +76,7 @@ def test_expected_values(self, inline_query_result_audio): assert inline_query_result_audio.audio_url == self.audio_url assert inline_query_result_audio.title == self.title assert inline_query_result_audio.performer == self.performer - assert inline_query_result_audio.audio_duration == self.audio_duration + assert inline_query_result_audio._audio_duration == self.audio_duration assert inline_query_result_audio.caption == self.caption assert inline_query_result_audio.parse_mode == self.parse_mode assert inline_query_result_audio.caption_entities == tuple(self.caption_entities) @@ -92,10 +95,10 @@ def test_to_dict(self, inline_query_result_audio): assert inline_query_result_audio_dict["audio_url"] == inline_query_result_audio.audio_url assert inline_query_result_audio_dict["title"] == inline_query_result_audio.title assert inline_query_result_audio_dict["performer"] == inline_query_result_audio.performer - assert ( - inline_query_result_audio_dict["audio_duration"] - == inline_query_result_audio.audio_duration + assert inline_query_result_audio_dict["audio_duration"] == int( + self.audio_duration.total_seconds() ) + assert isinstance(inline_query_result_audio_dict["audio_duration"], int) assert inline_query_result_audio_dict["caption"] == inline_query_result_audio.caption assert inline_query_result_audio_dict["parse_mode"] == inline_query_result_audio.parse_mode assert inline_query_result_audio_dict["caption_entities"] == [ @@ -114,6 +117,28 @@ def test_caption_entities_always_tuple(self): inline_query_result_audio = InlineQueryResultAudio(self.id_, self.audio_url, self.title) assert inline_query_result_audio.caption_entities == () + def test_time_period_properties(self, PTB_TIMEDELTA, inline_query_result_audio): + audio_duration = inline_query_result_audio.audio_duration + + if PTB_TIMEDELTA: + assert audio_duration == self.audio_duration + assert isinstance(audio_duration, dtm.timedelta) + else: + assert audio_duration == int(self.audio_duration.total_seconds()) + assert isinstance(audio_duration, int) + + def test_time_period_int_deprecated(self, recwarn, PTB_TIMEDELTA, inline_query_result_audio): + inline_query_result_audio.audio_duration + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + else: + assert len(recwarn) == 1 + assert "`audio_duration` will be of type `datetime.timedelta`" in str( + recwarn[0].message + ) + assert recwarn[0].category is PTBDeprecationWarning + def test_equality(self): a = InlineQueryResultAudio(self.id_, self.audio_url, self.title) b = InlineQueryResultAudio(self.id_, self.title, self.title) diff --git a/tests/_inline/test_inlinequeryresultgif.py b/tests/_inline/test_inlinequeryresultgif.py index 878b9b61d3c..2806e895623 100644 --- a/tests/_inline/test_inlinequeryresultgif.py +++ b/tests/_inline/test_inlinequeryresultgif.py @@ -16,6 +16,8 @@ # # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. +import datetime as dtm + import pytest from telegram import ( @@ -26,6 +28,7 @@ InputTextMessageContent, MessageEntity, ) +from telegram.warnings import PTBDeprecationWarning from tests.auxil.slots import mro_slots @@ -55,7 +58,7 @@ class InlineQueryResultGifTestBase: gif_url = "gif url" gif_width = 10 gif_height = 15 - gif_duration = 1 + gif_duration = dtm.timedelta(seconds=1) thumbnail_url = "thumb url" thumbnail_mime_type = "image/jpeg" title = "title" @@ -84,7 +87,7 @@ def test_expected_values(self, inline_query_result_gif): assert inline_query_result_gif.gif_url == self.gif_url assert inline_query_result_gif.gif_width == self.gif_width assert inline_query_result_gif.gif_height == self.gif_height - assert inline_query_result_gif.gif_duration == self.gif_duration + assert inline_query_result_gif._gif_duration == self.gif_duration assert inline_query_result_gif.thumbnail_url == self.thumbnail_url assert inline_query_result_gif.thumbnail_mime_type == self.thumbnail_mime_type assert inline_query_result_gif.title == self.title @@ -107,7 +110,10 @@ def test_to_dict(self, inline_query_result_gif): assert inline_query_result_gif_dict["gif_url"] == inline_query_result_gif.gif_url assert inline_query_result_gif_dict["gif_width"] == inline_query_result_gif.gif_width assert inline_query_result_gif_dict["gif_height"] == inline_query_result_gif.gif_height - assert inline_query_result_gif_dict["gif_duration"] == inline_query_result_gif.gif_duration + assert inline_query_result_gif_dict["gif_duration"] == int( + self.gif_duration.total_seconds() + ) + assert isinstance(inline_query_result_gif_dict["gif_duration"], int) assert ( inline_query_result_gif_dict["thumbnail_url"] == inline_query_result_gif.thumbnail_url ) @@ -134,6 +140,26 @@ def test_to_dict(self, inline_query_result_gif): == inline_query_result_gif.show_caption_above_media ) + def test_time_period_properties(self, PTB_TIMEDELTA, inline_query_result_gif): + gif_duration = inline_query_result_gif.gif_duration + + if PTB_TIMEDELTA: + assert gif_duration == self.gif_duration + assert isinstance(gif_duration, dtm.timedelta) + else: + assert gif_duration == int(self.gif_duration.total_seconds()) + assert isinstance(gif_duration, int) + + def test_time_period_int_deprecated(self, recwarn, PTB_TIMEDELTA, inline_query_result_gif): + inline_query_result_gif.gif_duration + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + else: + assert len(recwarn) == 1 + assert "`gif_duration` will be of type `datetime.timedelta`" in str(recwarn[0].message) + assert recwarn[0].category is PTBDeprecationWarning + def test_equality(self): a = InlineQueryResultGif(self.id_, self.gif_url, self.thumbnail_url) b = InlineQueryResultGif(self.id_, self.gif_url, self.thumbnail_url) diff --git a/tests/_inline/test_inlinequeryresultlocation.py b/tests/_inline/test_inlinequeryresultlocation.py index db9c64cfd10..a9471f0d55d 100644 --- a/tests/_inline/test_inlinequeryresultlocation.py +++ b/tests/_inline/test_inlinequeryresultlocation.py @@ -16,6 +16,8 @@ # # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. +import datetime as dtm + import pytest from telegram import ( @@ -25,6 +27,7 @@ InlineQueryResultVoice, InputTextMessageContent, ) +from telegram.warnings import PTBDeprecationWarning from tests.auxil.slots import mro_slots @@ -54,7 +57,7 @@ class InlineQueryResultLocationTestBase: longitude = 1.0 title = "title" horizontal_accuracy = 999 - live_period = 70 + live_period = dtm.timedelta(seconds=70) heading = 90 proximity_alert_radius = 1000 thumbnail_url = "thumb url" @@ -77,7 +80,7 @@ def test_expected_values(self, inline_query_result_location): assert inline_query_result_location.latitude == self.latitude assert inline_query_result_location.longitude == self.longitude assert inline_query_result_location.title == self.title - assert inline_query_result_location.live_period == self.live_period + assert inline_query_result_location._live_period == self.live_period assert inline_query_result_location.thumbnail_url == self.thumbnail_url assert inline_query_result_location.thumbnail_width == self.thumbnail_width assert inline_query_result_location.thumbnail_height == self.thumbnail_height @@ -104,10 +107,10 @@ def test_to_dict(self, inline_query_result_location): == inline_query_result_location.longitude ) assert inline_query_result_location_dict["title"] == inline_query_result_location.title - assert ( - inline_query_result_location_dict["live_period"] - == inline_query_result_location.live_period + assert inline_query_result_location_dict["live_period"] == int( + self.live_period.total_seconds() ) + assert isinstance(inline_query_result_location_dict["live_period"], int) assert ( inline_query_result_location_dict["thumbnail_url"] == inline_query_result_location.thumbnail_url @@ -138,6 +141,28 @@ def test_to_dict(self, inline_query_result_location): == inline_query_result_location.proximity_alert_radius ) + def test_time_period_properties(self, PTB_TIMEDELTA, inline_query_result_location): + live_period = inline_query_result_location.live_period + + if PTB_TIMEDELTA: + assert live_period == self.live_period + assert isinstance(live_period, dtm.timedelta) + else: + assert live_period == int(self.live_period.total_seconds()) + assert isinstance(live_period, int) + + def test_time_period_int_deprecated( + self, recwarn, PTB_TIMEDELTA, inline_query_result_location + ): + inline_query_result_location.live_period + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + else: + assert len(recwarn) == 1 + assert "`live_period` will be of type `datetime.timedelta`" in str(recwarn[0].message) + assert recwarn[0].category is PTBDeprecationWarning + def test_equality(self): a = InlineQueryResultLocation(self.id_, self.longitude, self.latitude, self.title) b = InlineQueryResultLocation(self.id_, self.longitude, self.latitude, self.title) diff --git a/tests/_inline/test_inlinequeryresultmpeg4gif.py b/tests/_inline/test_inlinequeryresultmpeg4gif.py index 03b6ca991d1..4c8291c4e5a 100644 --- a/tests/_inline/test_inlinequeryresultmpeg4gif.py +++ b/tests/_inline/test_inlinequeryresultmpeg4gif.py @@ -16,6 +16,8 @@ # # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. +import datetime as dtm + import pytest from telegram import ( @@ -26,6 +28,7 @@ InputTextMessageContent, MessageEntity, ) +from telegram.warnings import PTBDeprecationWarning from tests.auxil.slots import mro_slots @@ -55,7 +58,7 @@ class InlineQueryResultMpeg4GifTestBase: mpeg4_url = "mpeg4 url" mpeg4_width = 10 mpeg4_height = 15 - mpeg4_duration = 1 + mpeg4_duration = dtm.timedelta(seconds=1) thumbnail_url = "thumb url" thumbnail_mime_type = "image/jpeg" title = "title" @@ -80,7 +83,7 @@ def test_expected_values(self, inline_query_result_mpeg4_gif): assert inline_query_result_mpeg4_gif.mpeg4_url == self.mpeg4_url assert inline_query_result_mpeg4_gif.mpeg4_width == self.mpeg4_width assert inline_query_result_mpeg4_gif.mpeg4_height == self.mpeg4_height - assert inline_query_result_mpeg4_gif.mpeg4_duration == self.mpeg4_duration + assert inline_query_result_mpeg4_gif._mpeg4_duration == self.mpeg4_duration assert inline_query_result_mpeg4_gif.thumbnail_url == self.thumbnail_url assert inline_query_result_mpeg4_gif.thumbnail_mime_type == self.thumbnail_mime_type assert inline_query_result_mpeg4_gif.title == self.title @@ -118,10 +121,10 @@ def test_to_dict(self, inline_query_result_mpeg4_gif): inline_query_result_mpeg4_gif_dict["mpeg4_height"] == inline_query_result_mpeg4_gif.mpeg4_height ) - assert ( - inline_query_result_mpeg4_gif_dict["mpeg4_duration"] - == inline_query_result_mpeg4_gif.mpeg4_duration + assert inline_query_result_mpeg4_gif_dict["mpeg4_duration"] == int( + self.mpeg4_duration.total_seconds() ) + assert isinstance(inline_query_result_mpeg4_gif_dict["mpeg4_duration"], int) assert ( inline_query_result_mpeg4_gif_dict["thumbnail_url"] == inline_query_result_mpeg4_gif.thumbnail_url @@ -154,6 +157,30 @@ def test_to_dict(self, inline_query_result_mpeg4_gif): == inline_query_result_mpeg4_gif.show_caption_above_media ) + def test_time_period_properties(self, PTB_TIMEDELTA, inline_query_result_mpeg4_gif): + mpeg4_duration = inline_query_result_mpeg4_gif.mpeg4_duration + + if PTB_TIMEDELTA: + assert mpeg4_duration == self.mpeg4_duration + assert isinstance(mpeg4_duration, dtm.timedelta) + else: + assert mpeg4_duration == int(self.mpeg4_duration.total_seconds()) + assert isinstance(mpeg4_duration, int) + + def test_time_period_int_deprecated( + self, recwarn, PTB_TIMEDELTA, inline_query_result_mpeg4_gif + ): + inline_query_result_mpeg4_gif.mpeg4_duration + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + else: + assert len(recwarn) == 1 + assert "`mpeg4_duration` will be of type `datetime.timedelta`" in str( + recwarn[0].message + ) + assert recwarn[0].category is PTBDeprecationWarning + def test_equality(self): a = InlineQueryResultMpeg4Gif(self.id_, self.mpeg4_url, self.thumbnail_url) b = InlineQueryResultMpeg4Gif(self.id_, self.mpeg4_url, self.thumbnail_url) diff --git a/tests/_inline/test_inlinequeryresultvideo.py b/tests/_inline/test_inlinequeryresultvideo.py index d165d9af3f2..dd07b9c9719 100644 --- a/tests/_inline/test_inlinequeryresultvideo.py +++ b/tests/_inline/test_inlinequeryresultvideo.py @@ -16,6 +16,8 @@ # # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. +import datetime as dtm + import pytest from telegram import ( @@ -26,6 +28,7 @@ InputTextMessageContent, MessageEntity, ) +from telegram.warnings import PTBDeprecationWarning from tests.auxil.slots import mro_slots @@ -57,7 +60,7 @@ class InlineQueryResultVideoTestBase: mime_type = "mime type" video_width = 10 video_height = 15 - video_duration = 15 + video_duration = dtm.timedelta(seconds=15) thumbnail_url = "thumbnail url" title = "title" caption = "caption" @@ -83,7 +86,7 @@ def test_expected_values(self, inline_query_result_video): assert inline_query_result_video.mime_type == self.mime_type assert inline_query_result_video.video_width == self.video_width assert inline_query_result_video.video_height == self.video_height - assert inline_query_result_video.video_duration == self.video_duration + assert inline_query_result_video._video_duration == self.video_duration assert inline_query_result_video.thumbnail_url == self.thumbnail_url assert inline_query_result_video.title == self.title assert inline_query_result_video.description == self.description @@ -118,10 +121,10 @@ def test_to_dict(self, inline_query_result_video): inline_query_result_video_dict["video_height"] == inline_query_result_video.video_height ) - assert ( - inline_query_result_video_dict["video_duration"] - == inline_query_result_video.video_duration + assert inline_query_result_video_dict["video_duration"] == int( + self.video_duration.total_seconds() ) + assert isinstance(inline_query_result_video_dict["video_duration"], int) assert ( inline_query_result_video_dict["thumbnail_url"] == inline_query_result_video.thumbnail_url @@ -148,6 +151,29 @@ def test_to_dict(self, inline_query_result_video): == inline_query_result_video.show_caption_above_media ) + def test_time_period_properties(self, PTB_TIMEDELTA, inline_query_result_video): + iqrv = inline_query_result_video + if PTB_TIMEDELTA: + assert iqrv.video_duration == self.video_duration + assert isinstance(iqrv.video_duration, dtm.timedelta) + else: + assert iqrv.video_duration == int(self.video_duration.total_seconds()) + assert isinstance(iqrv.video_duration, int) + + def test_time_period_int_deprecated(self, recwarn, PTB_TIMEDELTA, inline_query_result_video): + value = inline_query_result_video.video_duration + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + assert isinstance(value, dtm.timedelta) + else: + assert len(recwarn) == 1 + assert "`video_duration` will be of type `datetime.timedelta`" in str( + recwarn[0].message + ) + assert recwarn[0].category is PTBDeprecationWarning + assert isinstance(value, int) + def test_equality(self): a = InlineQueryResultVideo( self.id_, self.video_url, self.mime_type, self.thumbnail_url, self.title diff --git a/tests/_inline/test_inlinequeryresultvoice.py b/tests/_inline/test_inlinequeryresultvoice.py index 01662700c74..f4e58cca371 100644 --- a/tests/_inline/test_inlinequeryresultvoice.py +++ b/tests/_inline/test_inlinequeryresultvoice.py @@ -16,6 +16,8 @@ # # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. +import datetime as dtm + import pytest from telegram import ( @@ -26,6 +28,7 @@ InputTextMessageContent, MessageEntity, ) +from telegram.warnings import PTBDeprecationWarning from tests.auxil.slots import mro_slots @@ -49,7 +52,7 @@ class InlineQueryResultVoiceTestBase: type_ = "voice" voice_url = "voice url" title = "title" - voice_duration = "voice_duration" + voice_duration = dtm.timedelta(seconds=10) caption = "caption" parse_mode = "HTML" caption_entities = [MessageEntity(MessageEntity.ITALIC, 0, 7)] @@ -69,7 +72,7 @@ def test_expected_values(self, inline_query_result_voice): assert inline_query_result_voice.id == self.id_ assert inline_query_result_voice.voice_url == self.voice_url assert inline_query_result_voice.title == self.title - assert inline_query_result_voice.voice_duration == self.voice_duration + assert inline_query_result_voice._voice_duration == self.voice_duration assert inline_query_result_voice.caption == self.caption assert inline_query_result_voice.parse_mode == self.parse_mode assert inline_query_result_voice.caption_entities == tuple(self.caption_entities) @@ -96,10 +99,10 @@ def test_to_dict(self, inline_query_result_voice): assert inline_query_result_voice_dict["id"] == inline_query_result_voice.id assert inline_query_result_voice_dict["voice_url"] == inline_query_result_voice.voice_url assert inline_query_result_voice_dict["title"] == inline_query_result_voice.title - assert ( - inline_query_result_voice_dict["voice_duration"] - == inline_query_result_voice.voice_duration + assert inline_query_result_voice_dict["voice_duration"] == int( + self.voice_duration.total_seconds() ) + assert isinstance(inline_query_result_voice_dict["voice_duration"], int) assert inline_query_result_voice_dict["caption"] == inline_query_result_voice.caption assert inline_query_result_voice_dict["parse_mode"] == inline_query_result_voice.parse_mode assert inline_query_result_voice_dict["caption_entities"] == [ @@ -114,6 +117,28 @@ def test_to_dict(self, inline_query_result_voice): == inline_query_result_voice.reply_markup.to_dict() ) + def test_time_period_properties(self, PTB_TIMEDELTA, inline_query_result_voice): + voice_duration = inline_query_result_voice.voice_duration + + if PTB_TIMEDELTA: + assert voice_duration == self.voice_duration + assert isinstance(voice_duration, dtm.timedelta) + else: + assert voice_duration == int(self.voice_duration.total_seconds()) + assert isinstance(voice_duration, int) + + def test_time_period_int_deprecated(self, recwarn, PTB_TIMEDELTA, inline_query_result_voice): + inline_query_result_voice.voice_duration + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + else: + assert len(recwarn) == 1 + assert "`voice_duration` will be of type `datetime.timedelta`" in str( + recwarn[0].message + ) + assert recwarn[0].category is PTBDeprecationWarning + def test_equality(self): a = InlineQueryResultVoice(self.id_, self.voice_url, self.title) b = InlineQueryResultVoice(self.id_, self.voice_url, self.title) diff --git a/tests/_inline/test_inputlocationmessagecontent.py b/tests/_inline/test_inputlocationmessagecontent.py index 05e86086852..1fd79ee9ad0 100644 --- a/tests/_inline/test_inputlocationmessagecontent.py +++ b/tests/_inline/test_inputlocationmessagecontent.py @@ -16,9 +16,12 @@ # # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. +import datetime as dtm + import pytest from telegram import InputLocationMessageContent, Location +from telegram.warnings import PTBDeprecationWarning from tests.auxil.slots import mro_slots @@ -37,7 +40,7 @@ def input_location_message_content(): class InputLocationMessageContentTestBase: latitude = -23.691288 longitude = -46.788279 - live_period = 80 + live_period = dtm.timedelta(seconds=80) horizontal_accuracy = 50.5 heading = 90 proximity_alert_radius = 999 @@ -53,7 +56,7 @@ def test_slot_behaviour(self, input_location_message_content): def test_expected_values(self, input_location_message_content): assert input_location_message_content.longitude == self.longitude assert input_location_message_content.latitude == self.latitude - assert input_location_message_content.live_period == self.live_period + assert input_location_message_content._live_period == self.live_period assert input_location_message_content.horizontal_accuracy == self.horizontal_accuracy assert input_location_message_content.heading == self.heading assert input_location_message_content.proximity_alert_radius == self.proximity_alert_radius @@ -70,10 +73,10 @@ def test_to_dict(self, input_location_message_content): input_location_message_content_dict["longitude"] == input_location_message_content.longitude ) - assert ( - input_location_message_content_dict["live_period"] - == input_location_message_content.live_period + assert input_location_message_content_dict["live_period"] == int( + self.live_period.total_seconds() ) + assert isinstance(input_location_message_content_dict["live_period"], int) assert ( input_location_message_content_dict["horizontal_accuracy"] == input_location_message_content.horizontal_accuracy @@ -87,6 +90,28 @@ def test_to_dict(self, input_location_message_content): == input_location_message_content.proximity_alert_radius ) + def test_time_period_properties(self, PTB_TIMEDELTA, input_location_message_content): + live_period = input_location_message_content.live_period + + if PTB_TIMEDELTA: + assert live_period == self.live_period + assert isinstance(live_period, dtm.timedelta) + else: + assert live_period == int(self.live_period.total_seconds()) + assert isinstance(live_period, int) + + def test_time_period_int_deprecated( + self, recwarn, PTB_TIMEDELTA, input_location_message_content + ): + input_location_message_content.live_period + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + else: + assert len(recwarn) == 1 + assert "`live_period` will be of type `datetime.timedelta`" in str(recwarn[0].message) + assert recwarn[0].category is PTBDeprecationWarning + def test_equality(self): a = InputLocationMessageContent(123, 456, 70) b = InputLocationMessageContent(123, 456, 90) diff --git a/tests/_passport/test_passport.py b/tests/_passport/test_passport.py index 8f5776fd819..4104a2c6b4c 100644 --- a/tests/_passport/test_passport.py +++ b/tests/_passport/test_passport.py @@ -418,7 +418,10 @@ def test_bot_init_invalid_key(self, offline_bot): with pytest.raises(TypeError): Bot(offline_bot.token, private_key="Invalid key!") - with pytest.raises(ValueError, match="Could not deserialize key data"): + # Different error messages for different cryptography versions + with pytest.raises( + ValueError, match="(Could not deserialize key data)|(Unable to load PEM file)" + ): Bot(offline_bot.token, private_key=b"Invalid key!") def test_all_types(self, passport_data, offline_bot, all_passport_data): diff --git a/tests/_utils/test_datetime.py b/tests/_utils/test_datetime.py index dfcaca67587..8628f0c109f 100644 --- a/tests/_utils/test_datetime.py +++ b/tests/_utils/test_datetime.py @@ -192,3 +192,20 @@ def test_extract_tzinfo_from_defaults(self, tz_bot, bot, raw_bot): assert tg_dtm.extract_tzinfo_from_defaults(tz_bot) == tz_bot.defaults.tzinfo assert tg_dtm.extract_tzinfo_from_defaults(bot) is None assert tg_dtm.extract_tzinfo_from_defaults(raw_bot) is None + + @pytest.mark.parametrize( + ("arg", "timedelta_result", "number_result"), + [ + (None, None, None), + (dtm.timedelta(seconds=10), dtm.timedelta(seconds=10), 10), + (dtm.timedelta(seconds=10.5), dtm.timedelta(seconds=10.5), 10.5), + ], + ) + def test_get_timedelta_value(self, PTB_TIMEDELTA, arg, timedelta_result, number_result): + result = tg_dtm.get_timedelta_value(arg, attribute="") + + if PTB_TIMEDELTA: + assert result == timedelta_result + else: + assert result == number_result + assert type(result) is type(number_result) diff --git a/tests/auxil/bot_method_checks.py b/tests/auxil/bot_method_checks.py index f7f43088681..508fa3d9aa7 100644 --- a/tests/auxil/bot_method_checks.py +++ b/tests/auxil/bot_method_checks.py @@ -70,7 +70,7 @@ def check_shortcut_signature( bot_method: The bot method, e.g. :meth:`telegram.Bot.send_message` shortcut_kwargs: The kwargs passed by the shortcut directly, e.g. ``chat_id`` additional_kwargs: Additional kwargs of the shortcut that the bot method doesn't have, e.g. - ``quote``. + ``do_quote``. annotation_overrides: A dictionary of exceptions for the annotation comparison. The key is the name of the argument, the value is a tuple of the expected annotation and the default value. E.g. ``{'parse_mode': (str, 'None')}``. @@ -228,21 +228,18 @@ async def check_shortcut_call( shortcut_signature = inspect.signature(shortcut_method) # auto_pagination: Special casing for InlineQuery.answer - # quote: Don't test deprecated "quote" parameter of Message.reply_* kwargs = { - name: name - for name in shortcut_signature.parameters - if name not in ["auto_pagination", "quote"] + name: name for name in shortcut_signature.parameters if name not in ["auto_pagination"] } if "reply_parameters" in kwargs: kwargs["reply_parameters"] = ReplyParameters(message_id=1) # We tested this for a long time, but Bot API 7.0 deprecated it in favor of - # reply_parameters. In the transition phase, both exist in a mutually exclusive - # way. Testing both cases would require a lot of additional code, so we just - # ignore this parameter here until it is removed. - kwargs.pop("reply_to_message_id", None) - expected_args.discard("reply_to_message_id") + # reply_parameters. Testing both cases would require a lot of additional code, so we just + # ignore these parameters here. + for arg in ["reply_to_message_id", "allow_sending_without_reply"]: + kwargs.pop(arg, None) + expected_args.discard(arg) async def make_assertion(**kw): # name == value makes sure that @@ -254,7 +251,7 @@ async def make_assertion(**kw): if name in ignored_args or (value == name or (name == "reply_parameters" and value.message_id == 1)) } - if not received_kwargs == expected_args: + if received_kwargs != expected_args: raise Exception( f"{orig_bot_method.__name__} did not receive correct value for the parameters " f"{expected_args - received_kwargs}" diff --git a/tests/auxil/envvars.py b/tests/auxil/envvars.py index 5fb2d20c8a1..890c9e20bbb 100644 --- a/tests/auxil/envvars.py +++ b/tests/auxil/envvars.py @@ -24,7 +24,7 @@ def env_var_2_bool(env_var: object) -> bool: return env_var if not isinstance(env_var, str): return False - return env_var.lower().strip() == "true" + return env_var.lower().strip() in ["true", "1"] GITHUB_ACTIONS: bool = env_var_2_bool(os.getenv("GITHUB_ACTIONS", "false")) diff --git a/tests/auxil/files.py b/tests/auxil/files.py index 21571b1988a..583ae615cef 100644 --- a/tests/auxil/files.py +++ b/tests/auxil/files.py @@ -19,6 +19,7 @@ from pathlib import Path PROJECT_ROOT_PATH = Path(__file__).parent.parent.parent.resolve() +SOURCE_ROOT_PATH = PROJECT_ROOT_PATH / "src" / "telegram" TEST_DATA_PATH = PROJECT_ROOT_PATH / "tests" / "data" diff --git a/tests/conftest.py b/tests/conftest.py index 935daada498..f9725136ccc 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -18,6 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. import asyncio import logging +import os import sys import zoneinfo from pathlib import Path @@ -40,7 +41,12 @@ from tests.auxil.build_messages import DATE, make_message from tests.auxil.ci_bots import BOT_INFO_PROVIDER, JOB_INDEX from tests.auxil.constants import PRIVATE_KEY, TEST_TOPIC_ICON_COLOR, TEST_TOPIC_NAME -from tests.auxil.envvars import GITHUB_ACTIONS, RUN_TEST_OFFICIAL, TEST_WITH_OPT_DEPS +from tests.auxil.envvars import ( + GITHUB_ACTIONS, + RUN_TEST_OFFICIAL, + TEST_WITH_OPT_DEPS, + env_var_2_bool, +) from tests.auxil.files import data_file from tests.auxil.networking import NonchalantHttpxRequest from tests.auxil.pytest_classes import PytestBot, make_bot @@ -129,6 +135,18 @@ def _disallow_requests_in_without_request_tests(request): ) +@pytest.fixture(scope="module", params=["true", "1", "false", "gibberish", None]) +def PTB_TIMEDELTA(request): + # Here we manually use monkeypatch to give this fixture module scope + monkeypatch = pytest.MonkeyPatch() + if request.param is not None: + monkeypatch.setenv("PTB_TIMEDELTA", request.param) + else: + monkeypatch.delenv("PTB_TIMEDELTA", raising=False) + yield env_var_2_bool(os.getenv("PTB_TIMEDELTA")) + monkeypatch.undo() + + # Redefine the event_loop fixture to have a session scope. Otherwise `bot` fixture can't be # session. See https://github.com/pytest-dev/pytest-asyncio/issues/68 for more details. @pytest.fixture(scope="session") diff --git a/tests/ext/test_application.py b/tests/ext/test_application.py index fd96aa99e1f..c99a1311d27 100644 --- a/tests/ext/test_application.py +++ b/tests/ext/test_application.py @@ -58,7 +58,7 @@ from telegram.warnings import PTBDeprecationWarning, PTBUserWarning from tests.auxil.asyncio_helpers import call_after from tests.auxil.build_messages import make_message_update -from tests.auxil.files import PROJECT_ROOT_PATH +from tests.auxil.files import SOURCE_ROOT_PATH from tests.auxil.monkeypatch import empty_get_updates, return_true from tests.auxil.networking import send_webhook_message from tests.auxil.pytest_classes import PytestApplication, PytestUpdater, make_bot @@ -1006,7 +1006,7 @@ async def callback(update, context): == "ApplicationHandlerStop is not supported with handlers running non-blocking." ) assert ( - Path(recwarn[0].filename) == PROJECT_ROOT_PATH / "telegram" / "ext" / "_application.py" + Path(recwarn[0].filename) == SOURCE_ROOT_PATH / "ext" / "_application.py" ), "incorrect stacklevel!" async def test_non_blocking_no_error_handler(self, app, caplog): @@ -1079,7 +1079,7 @@ async def error_handler(update, context): == "ApplicationHandlerStop is not supported with handlers running non-blocking." ) assert ( - Path(recwarn[0].filename) == PROJECT_ROOT_PATH / "telegram" / "ext" / "_application.py" + Path(recwarn[0].filename) == SOURCE_ROOT_PATH / "ext" / "_application.py" ), "incorrect stacklevel!" @pytest.mark.parametrize(("block", "expected_output"), [(False, 0), (True, 5)]) @@ -2583,6 +2583,70 @@ async def callback(update, context): assert received_updates == {2} assert len(caplog.records) == 0 + @pytest.mark.parametrize("change_type", ["remove", "add"]) + async def test_process_update_handler_change_groups_during_iteration(self, app, change_type): + run_groups = set() + + async def dummy_callback(_, __, g: int): + run_groups.add(g) + + for group in range(10, 20): + handler = TypeHandler(int, functools.partial(dummy_callback, g=group)) + app.add_handler(handler, group=group) + + async def wait_callback(_, context): + # Trigger a change of the app.handlers dict during the iteration + if change_type == "remove": + context.application.remove_handler(handler, group) + else: + context.application.add_handler( + TypeHandler(int, functools.partial(dummy_callback, g=42)), group=42 + ) + + app.add_handler(TypeHandler(int, wait_callback)) + + async with app: + await app.process_update(1) + + # check that exactly those handlers were called that were configured when + # process_update was called + assert run_groups == set(range(10, 20)) + + async def test_process_update_handler_change_group_during_iteration(self, app): + async def dummy_callback(_, __): + pass + + checked_handlers = set() + + class TrackHandler(TypeHandler): + def __init__(self, name: str, *args, **kwargs): + self.name = name + super().__init__(*args, **kwargs) + + def check_update(self, update: object) -> bool: + checked_handlers.add(self.name) + return super().check_update(update) + + remove_handler = TrackHandler("remove", int, dummy_callback) + add_handler = TrackHandler("add", int, dummy_callback) + + class TriggerHandler(TypeHandler): + def check_update(self, update: object) -> bool: + # Trigger a change of the app.handlers *in the same group* during the iteration + app.remove_handler(remove_handler) + app.add_handler(add_handler) + # return False to ensure that additional handlers in the same group are checked + return False + + app.add_handler(TriggerHandler(str, dummy_callback)) + app.add_handler(remove_handler) + async with app: + await app.process_update("string update") + + # check that exactly those handlers were checked that were configured when + # process_update was called + assert checked_handlers == {"remove"} + async def test_process_error_exception_in_building_context(self, monkeypatch, caplog, app): # Makes sure that exceptions in building the context don't stop the application exception = ValueError("TestException") @@ -2622,3 +2686,28 @@ async def callback(update, context): assert received_errors == {2} assert len(caplog.records) == 0 + + @pytest.mark.parametrize("change_type", ["remove", "add"]) + async def test_process_error_change_during_iteration(self, app, change_type): + called_handlers = set() + + async def dummy_process_error(name: str, *_, **__): + called_handlers.add(name) + + add_error_handler = functools.partial(dummy_process_error, "add_handler") + remove_error_handler = functools.partial(dummy_process_error, "remove_handler") + + async def trigger_change(*_, **__): + if change_type == "remove": + app.remove_error_handler(remove_error_handler) + else: + app.add_error_handler(add_error_handler) + + app.add_error_handler(trigger_change) + app.add_error_handler(remove_error_handler) + async with app: + await app.process_error(update=None, error=None) + + # check that exactly those handlers were checked that were configured when + # add_error_handler was called + assert called_handlers == {"remove_handler"} diff --git a/tests/ext/test_applicationbuilder.py b/tests/ext/test_applicationbuilder.py index 15e85b6416e..bfbce15dd93 100644 --- a/tests/ext/test_applicationbuilder.py +++ b/tests/ext/test_applicationbuilder.py @@ -17,6 +17,7 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. import asyncio +import datetime as dtm import inspect from dataclasses import dataclass from http import HTTPStatus @@ -576,9 +577,12 @@ def test_no_job_queue(self, bot, builder): (None, None, 0), (1, None, 1), (None, 1, 1), + (None, dtm.timedelta(seconds=1), 1), (DEFAULT_NONE, None, 10), (DEFAULT_NONE, 1, 11), + (DEFAULT_NONE, dtm.timedelta(seconds=1), 11), (1, 2, 3), + (1, dtm.timedelta(seconds=2), 3), ], ) async def test_get_updates_read_timeout_value_passing( diff --git a/tests/ext/test_conversationhandler.py b/tests/ext/test_conversationhandler.py index e57c1faa373..64959f47f47 100644 --- a/tests/ext/test_conversationhandler.py +++ b/tests/ext/test_conversationhandler.py @@ -60,7 +60,7 @@ ) from telegram.warnings import PTBUserWarning from tests.auxil.build_messages import make_command_message -from tests.auxil.files import PROJECT_ROOT_PATH +from tests.auxil.files import SOURCE_ROOT_PATH from tests.auxil.pytest_classes import PytestBot, make_bot from tests.auxil.slots import mro_slots @@ -725,7 +725,7 @@ async def callback(_, __): assert recwarn[0].category is PTBUserWarning assert ( Path(recwarn[0].filename) - == PROJECT_ROOT_PATH / "telegram" / "ext" / "_handlers" / "conversationhandler.py" + == SOURCE_ROOT_PATH / "ext" / "_handlers" / "conversationhandler.py" ), "wrong stacklevel!" assert ( str(recwarn[0].message) @@ -1105,11 +1105,7 @@ async def test_no_running_job_queue_warning(self, app, bot, user1, recwarn, jq): assert warning.category is PTBUserWarning assert ( Path(warning.filename) - == PROJECT_ROOT_PATH - / "telegram" - / "ext" - / "_handlers" - / "conversationhandler.py" + == SOURCE_ROOT_PATH / "ext" / "_handlers" / "conversationhandler.py" ), "wrong stacklevel!" # now set app.job_queue back to it's original value @@ -1428,8 +1424,7 @@ def timeout(*args, **kwargs): assert str(recwarn[0].message).startswith("ApplicationHandlerStop in TIMEOUT") assert recwarn[0].category is PTBUserWarning assert ( - Path(recwarn[0].filename) - == PROJECT_ROOT_PATH / "telegram" / "ext" / "_jobqueue.py" + Path(recwarn[0].filename) == SOURCE_ROOT_PATH / "ext" / "_jobqueue.py" ), "wrong stacklevel!" await app.stop() diff --git a/tests/ext/test_filters.py b/tests/ext/test_filters.py index ae125c98a40..6802db2a206 100644 --- a/tests/ext/test_filters.py +++ b/tests/ext/test_filters.py @@ -18,6 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. import datetime as dtm import inspect +import platform import re import pytest @@ -711,7 +712,9 @@ def test_filters_document_type(self, update): assert not filters.Document.WAV.check_update(update) assert not filters.Document.AUDIO.check_update(update) - update.message.document.mime_type = "audio/x-wav" + update.message.document.mime_type = ( + "audio/x-wav" if int(platform.python_version_tuple()[1]) < 14 else "audio/vnd.wave" + ) assert filters.Document.WAV.check_update(update) assert filters.Document.AUDIO.check_update(update) assert not filters.Document.XML.check_update(update) diff --git a/tests/ext/test_inlinequeryhandler.py b/tests/ext/test_inlinequeryhandler.py index 24aa69f01f6..cd20e1aeceb 100644 --- a/tests/ext/test_inlinequeryhandler.py +++ b/tests/ext/test_inlinequeryhandler.py @@ -152,6 +152,28 @@ async def test_context_pattern(self, app, inline_query): update.inline_query.query = "not_a_match" assert not handler.check_update(update) + @pytest.mark.parametrize( + ("query", "expected_result"), + [ + pytest.param("", True, id="empty string"), + pytest.param("not empty", False, id="non_empty_string"), + ], + ) + async def test_empty_inline_query_pattern(self, app, query, expected_result): + handler = InlineQueryHandler(self.callback, pattern=r"^$") + app.add_handler(handler) + + update = Update( + update_id=0, + inline_query=InlineQuery( + id="id", from_user=User(1, "test", False), query=query, offset="" + ), + ) + + async with app: + await app.process_update(update) + assert self.test_flag == expected_result + @pytest.mark.parametrize("chat_types", [[Chat.SENDER], [Chat.SENDER, Chat.SUPERGROUP], []]) @pytest.mark.parametrize( ("chat_type", "result"), [(Chat.SENDER, True), (Chat.CHANNEL, False), (None, False)] diff --git a/tests/ext/test_picklepersistence.py b/tests/ext/test_picklepersistence.py index 5ce998c9018..f5c15c5cb9b 100644 --- a/tests/ext/test_picklepersistence.py +++ b/tests/ext/test_picklepersistence.py @@ -28,7 +28,7 @@ from telegram import Chat, Message, TelegramObject, Update, User from telegram.ext import ContextTypes, PersistenceInput, PicklePersistence from telegram.warnings import PTBUserWarning -from tests.auxil.files import PROJECT_ROOT_PATH +from tests.auxil.files import SOURCE_ROOT_PATH from tests.auxil.pytest_classes import make_bot from tests.auxil.slots import mro_slots @@ -899,8 +899,7 @@ async def test_custom_pickler_unpickler_simple( assert recwarn[-1].category is PTBUserWarning assert str(recwarn[-1].message).startswith("Unknown bot instance found.") assert ( - Path(recwarn[-1].filename) - == PROJECT_ROOT_PATH / "telegram" / "ext" / "_picklepersistence.py" + Path(recwarn[-1].filename) == SOURCE_ROOT_PATH / "ext" / "_picklepersistence.py" ), "wrong stacklevel!" pp = PicklePersistence("pickletest", single_file=False, on_flush=False) pp.set_bot(bot) diff --git a/tests/ext/test_updater.py b/tests/ext/test_updater.py index 147fc6128df..92a2d65ce7d 100644 --- a/tests/ext/test_updater.py +++ b/tests/ext/test_updater.py @@ -17,6 +17,7 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. import asyncio +import datetime as dtm import logging import platform from collections import defaultdict @@ -294,7 +295,7 @@ async def test_polling_mark_updates_as_read(self, monkeypatch, updater, caplog): tracking_flag = False received_kwargs = {} expected_kwargs = { - "timeout": 0, + "timeout": dtm.timedelta(seconds=0), "allowed_updates": "allowed_updates", } @@ -416,7 +417,7 @@ async def test_start_polling_get_updates_parameters(self, updater, monkeypatch): on_stop_flag = False expected = { - "timeout": 10, + "timeout": dtm.timedelta(seconds=10), "allowed_updates": None, "api_kwargs": None, } @@ -456,14 +457,14 @@ async def get_updates(*args, **kwargs): on_stop_flag = False expected = { - "timeout": 42, + "timeout": dtm.timedelta(seconds=42), "allowed_updates": ["message"], "api_kwargs": None, } await update_queue.put(Update(update_id=2)) await updater.start_polling( - timeout=42, + timeout=dtm.timedelta(seconds=42), allowed_updates=["message"], ) await update_queue.join() diff --git a/tests/request/test_request.py b/tests/request/test_request.py index 1672b8fb64e..0ebfe73532f 100644 --- a/tests/request/test_request.py +++ b/tests/request/test_request.py @@ -19,6 +19,7 @@ """Here we run tests directly with HTTPXRequest because that's easier than providing dummy implementations for BaseRequest and we want to test HTTPXRequest anyway.""" import asyncio +import datetime as dtm import json import logging from collections import defaultdict @@ -244,7 +245,7 @@ async def test_chat_migrated(self, monkeypatch, httpx_request: HTTPXRequest): assert exc_info.value.new_chat_id == 123 - async def test_retry_after(self, monkeypatch, httpx_request: HTTPXRequest): + async def test_retry_after(self, monkeypatch, httpx_request: HTTPXRequest, PTB_TIMEDELTA): server_response = b'{"ok": "False", "parameters": {"retry_after": 42}}' monkeypatch.setattr( @@ -253,10 +254,12 @@ async def test_retry_after(self, monkeypatch, httpx_request: HTTPXRequest): mocker_factory(response=server_response, return_code=HTTPStatus.BAD_REQUEST), ) - with pytest.raises(RetryAfter, match="Retry in 42") as exc_info: + with pytest.raises( + RetryAfter, match="Retry in " + "0:00:42" if PTB_TIMEDELTA else "42" + ) as exc_info: await httpx_request.post(None, None, None) - assert exc_info.value.retry_after == 42 + assert exc_info.value.retry_after == (dtm.timdelta(seconds=42) if PTB_TIMEDELTA else 42) async def test_unknown_request_params(self, monkeypatch, httpx_request: HTTPXRequest): server_response = b'{"ok": "False", "parameters": {"unknown": "42"}}' @@ -316,10 +319,14 @@ async def test_error_description(self, monkeypatch, httpx_request: HTTPXRequest, (-1, NetworkError), ], ) + @pytest.mark.parametrize("description", ["Test Message", None]) async def test_special_errors( - self, monkeypatch, httpx_request: HTTPXRequest, code, exception_class + self, monkeypatch, httpx_request: HTTPXRequest, code, exception_class, description ): - server_response = b'{"ok": "False", "description": "Test Message"}' + server_response_json = {"ok": False} + if description: + server_response_json["description"] = description + server_response = json.dumps(server_response_json).encode(TextEncoding.UTF_8) monkeypatch.setattr( httpx_request, @@ -327,7 +334,25 @@ async def test_special_errors( mocker_factory(response=server_response, return_code=code), ) - with pytest.raises(exception_class, match="Test Message"): + if not description and code not in list(HTTPStatus): + match = f"Unknown HTTPError.*{code}" + else: + match = description or str(code.value) + + with pytest.raises(exception_class, match=match): + await httpx_request.post("", None, None) + + async def test_error_parsing_payload(self, monkeypatch, httpx_request: HTTPXRequest): + """Test that we raise an error if the payload is not a valid JSON.""" + server_response = b"invalid_json" + + monkeypatch.setattr( + httpx_request, + "do_request", + mocker_factory(response=server_response, return_code=HTTPStatus.BAD_GATEWAY), + ) + + with pytest.raises(TelegramError, match=r"502.*\. Parsing.*b'invalid_json' failed"): await httpx_request.post("", None, None) @pytest.mark.parametrize( diff --git a/tests/test_bot.py b/tests/test_bot.py index 16c878dd29c..4e78cd0a449 100644 --- a/tests/test_bot.py +++ b/tests/test_bot.py @@ -3266,9 +3266,10 @@ async def test_edit_reply_markup_inline(self): pass # TODO: Actually send updates to the test bot so this can be tested properly - async def test_get_updates(self, bot): + @pytest.mark.parametrize("timeout", [1, dtm.timedelta(seconds=1)]) + async def test_get_updates(self, bot, timeout): await bot.delete_webhook() # make sure there is no webhook set if webhook tests failed - updates = await bot.get_updates(timeout=1) + updates = await bot.get_updates(timeout=timeout) assert isinstance(updates, tuple) if updates: @@ -3280,9 +3281,12 @@ async def test_get_updates(self, bot): (None, None, 0), (1, None, 1), (None, 1, 1), + (None, dtm.timedelta(seconds=1), 1), (DEFAULT_NONE, None, 10), (DEFAULT_NONE, 1, 11), + (DEFAULT_NONE, dtm.timedelta(seconds=1), 11), (1, 2, 3), + (1, dtm.timedelta(seconds=2), 3), ], ) async def test_get_updates_read_timeout_value_passing( diff --git a/tests/test_business_methods.py b/tests/test_business_methods.py index 13017eca8e6..721df6353b9 100644 --- a/tests/test_business_methods.py +++ b/tests/test_business_methods.py @@ -32,6 +32,7 @@ StoryAreaTypeUniqueGift, User, ) +from telegram._files._inputstorycontent import InputStoryContentVideo from telegram._files.sticker import Sticker from telegram._gifts import AcceptedGiftTypes, Gift from telegram._ownedgift import OwnedGiftRegular, OwnedGifts @@ -492,6 +493,39 @@ async def make_assertion(url, request_data, *args, **kwargs): await default_bot.post_story(**kwargs) + @pytest.mark.parametrize( + ("argument", "expected"), + [(4, 4), (4.0, 4), (dtm.timedelta(seconds=4), 4), (4.5, 4.5)], + ) + async def test_post_story_float_time_period( + self, offline_bot, monkeypatch, argument, expected + ): + # We test that whole number conversion works properly. Only tested here but + # relevant for some other methods too (e.g bot.set_business_account_profile_photo) + async def make_assertion(url, request_data, *args, **kwargs): + data = request_data.parameters + content = data["content"] + + assert content["duration"] == expected + assert type(content["duration"]) is type(expected) + assert content["cover_frame_timestamp"] == expected + assert type(content["cover_frame_timestamp"]) is type(expected) + + return Story(chat=Chat(123, "private"), id=123).to_dict() + + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + kwargs = { + "business_connection_id": self.bci, + "content": InputStoryContentVideo( + video=data_file("telegram.mp4"), + duration=argument, + cover_frame_timestamp=argument, + ), + "active_period": dtm.timedelta(seconds=20), + } + + assert await offline_bot.post_story(**kwargs) + async def test_edit_story_all_args(self, offline_bot, monkeypatch): story_id = 1234 content = InputStoryContentPhoto(photo=data_file("telegram.jpg").read_bytes()) diff --git a/tests/test_chatfullinfo.py b/tests/test_chatfullinfo.py index dff26aa7398..52444fcbd34 100644 --- a/tests/test_chatfullinfo.py +++ b/tests/test_chatfullinfo.py @@ -55,6 +55,7 @@ def chat_full_info(bot): can_set_sticker_set=ChatFullInfoTestBase.can_set_sticker_set, permissions=ChatFullInfoTestBase.permissions, slow_mode_delay=ChatFullInfoTestBase.slow_mode_delay, + message_auto_delete_time=ChatFullInfoTestBase.message_auto_delete_time, bio=ChatFullInfoTestBase.bio, linked_chat_id=ChatFullInfoTestBase.linked_chat_id, location=ChatFullInfoTestBase.location, @@ -106,7 +107,8 @@ class ChatFullInfoTestBase: can_change_info=False, can_invite_users=True, ) - slow_mode_delay = 30 + slow_mode_delay = dtm.timedelta(seconds=30) + message_auto_delete_time = dtm.timedelta(60) bio = "I'm a Barbie Girl in a Barbie World" linked_chat_id = 11880 location = ChatLocation(Location(123, 456), "Barbie World") @@ -168,7 +170,8 @@ def test_de_json(self, offline_bot): "sticker_set_name": self.sticker_set_name, "can_set_sticker_set": self.can_set_sticker_set, "permissions": self.permissions.to_dict(), - "slow_mode_delay": self.slow_mode_delay, + "slow_mode_delay": self.slow_mode_delay.total_seconds(), + "message_auto_delete_time": self.message_auto_delete_time.total_seconds(), "bio": self.bio, "business_intro": self.business_intro.to_dict(), "business_location": self.business_location.to_dict(), @@ -201,6 +204,7 @@ def test_de_json(self, offline_bot): "last_name": self.last_name, "can_send_paid_media": self.can_send_paid_media, } + cfi = ChatFullInfo.de_json(json_dict, offline_bot) assert cfi.api_kwargs == {} assert cfi.id == self.id_ @@ -211,7 +215,8 @@ def test_de_json(self, offline_bot): assert cfi.sticker_set_name == self.sticker_set_name assert cfi.can_set_sticker_set == self.can_set_sticker_set assert cfi.permissions == self.permissions - assert cfi.slow_mode_delay == self.slow_mode_delay + assert cfi._slow_mode_delay == self.slow_mode_delay + assert cfi._message_auto_delete_time == self.message_auto_delete_time assert cfi.bio == self.bio assert cfi.business_intro == self.business_intro assert cfi.business_location == self.business_location @@ -281,7 +286,10 @@ def test_to_dict(self, chat_full_info): assert cfi_dict["type"] == cfi.type assert cfi_dict["username"] == cfi.username assert cfi_dict["permissions"] == cfi.permissions.to_dict() - assert cfi_dict["slow_mode_delay"] == cfi.slow_mode_delay + assert cfi_dict["slow_mode_delay"] == int(self.slow_mode_delay.total_seconds()) + assert cfi_dict["message_auto_delete_time"] == int( + self.message_auto_delete_time.total_seconds() + ) assert cfi_dict["bio"] == cfi.bio assert cfi_dict["business_intro"] == cfi.business_intro.to_dict() assert cfi_dict["business_location"] == cfi.business_location.to_dict() @@ -355,6 +363,35 @@ def test_can_send_gift_deprecation_warning(self): ): chat_full_info.can_send_gift + def test_time_period_properties(self, PTB_TIMEDELTA, chat_full_info): + cfi = chat_full_info + if PTB_TIMEDELTA: + assert cfi.slow_mode_delay == self.slow_mode_delay + assert isinstance(cfi.slow_mode_delay, dtm.timedelta) + + assert cfi.message_auto_delete_time == self.message_auto_delete_time + assert isinstance(cfi.message_auto_delete_time, dtm.timedelta) + else: + assert cfi.slow_mode_delay == int(self.slow_mode_delay.total_seconds()) + assert isinstance(cfi.slow_mode_delay, int) + + assert cfi.message_auto_delete_time == int( + self.message_auto_delete_time.total_seconds() + ) + assert isinstance(cfi.message_auto_delete_time, int) + + def test_time_period_int_deprecated(self, recwarn, PTB_TIMEDELTA, chat_full_info): + chat_full_info.slow_mode_delay + chat_full_info.message_auto_delete_time + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + else: + assert len(recwarn) == 2 + for i, attr in enumerate(["slow_mode_delay", "message_auto_delete_time"]): + assert f"`{attr}` will be of type `datetime.timedelta`" in str(recwarn[i].message) + assert recwarn[i].category is PTBDeprecationWarning + def test_always_tuples_attributes(self): cfi = ChatFullInfo( id=123, diff --git a/tests/test_chatinvitelink.py b/tests/test_chatinvitelink.py index 55cfc5763a9..f111d7bf2b6 100644 --- a/tests/test_chatinvitelink.py +++ b/tests/test_chatinvitelink.py @@ -22,6 +22,7 @@ from telegram import ChatInviteLink, User from telegram._utils.datetime import UTC, to_timestamp +from telegram.warnings import PTBDeprecationWarning from tests.auxil.slots import mro_slots @@ -56,7 +57,7 @@ class ChatInviteLinkTestBase: member_limit = 42 name = "LinkName" pending_join_request_count = 42 - subscription_period = 43 + subscription_period = dtm.timedelta(seconds=43) subscription_price = 44 @@ -95,7 +96,7 @@ def test_de_json_all_args(self, offline_bot, creator): "member_limit": self.member_limit, "name": self.name, "pending_join_request_count": str(self.pending_join_request_count), - "subscription_period": self.subscription_period, + "subscription_period": int(self.subscription_period.total_seconds()), "subscription_price": self.subscription_price, } @@ -112,7 +113,7 @@ def test_de_json_all_args(self, offline_bot, creator): assert invite_link.member_limit == self.member_limit assert invite_link.name == self.name assert invite_link.pending_join_request_count == self.pending_join_request_count - assert invite_link.subscription_period == self.subscription_period + assert invite_link._subscription_period == self.subscription_period assert invite_link.subscription_price == self.subscription_price def test_de_json_localization(self, tz_bot, offline_bot, raw_bot, creator): @@ -154,9 +155,32 @@ def test_to_dict(self, invite_link): assert invite_link_dict["member_limit"] == self.member_limit assert invite_link_dict["name"] == self.name assert invite_link_dict["pending_join_request_count"] == self.pending_join_request_count - assert invite_link_dict["subscription_period"] == self.subscription_period + assert invite_link_dict["subscription_period"] == int( + self.subscription_period.total_seconds() + ) + assert isinstance(invite_link_dict["subscription_period"], int) assert invite_link_dict["subscription_price"] == self.subscription_price + def test_time_period_properties(self, PTB_TIMEDELTA, invite_link): + if PTB_TIMEDELTA: + assert invite_link.subscription_period == self.subscription_period + assert isinstance(invite_link.subscription_period, dtm.timedelta) + else: + assert invite_link.subscription_period == int(self.subscription_period.total_seconds()) + assert isinstance(invite_link.subscription_period, int) + + def test_time_period_int_deprecated(self, recwarn, PTB_TIMEDELTA, invite_link): + invite_link.subscription_period + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + else: + assert len(recwarn) == 1 + assert "`subscription_period` will be of type `datetime.timedelta`" in str( + recwarn[0].message + ) + assert recwarn[0].category is PTBDeprecationWarning + def test_equality(self): a = ChatInviteLink("link", User(1, "", False), True, True, True) b = ChatInviteLink("link", User(1, "", False), True, True, True) diff --git a/tests/test_error.py b/tests/test_error.py index 9fd0ba707fc..863ec0c4c5e 100644 --- a/tests/test_error.py +++ b/tests/test_error.py @@ -16,6 +16,7 @@ # # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. +import datetime as dtm import pickle from collections import defaultdict @@ -35,6 +36,7 @@ TimedOut, ) from telegram.ext import InvalidCallbackData +from telegram.warnings import PTBDeprecationWarning from tests.auxil.slots import mro_slots @@ -92,9 +94,28 @@ def test_chat_migrated(self): raise ChatMigrated(1234) assert e.value.new_chat_id == 1234 - def test_retry_after(self): - with pytest.raises(RetryAfter, match="Flood control exceeded. Retry in 12 seconds"): - raise RetryAfter(12) + @pytest.mark.parametrize("retry_after", [12, dtm.timedelta(seconds=12)]) + def test_retry_after(self, PTB_TIMEDELTA, retry_after): + if PTB_TIMEDELTA: + with pytest.raises(RetryAfter, match="Flood control exceeded. Retry in 0:00:12"): + raise (exception := RetryAfter(retry_after)) + assert type(exception.retry_after) is dtm.timedelta + else: + with pytest.raises(RetryAfter, match="Flood control exceeded. Retry in 12 seconds"): + raise (exception := RetryAfter(retry_after)) + assert type(exception.retry_after) is int + + def test_retry_after_int_deprecated(self, PTB_TIMEDELTA, recwarn): + retry_after = RetryAfter(12).retry_after + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + assert type(retry_after) is dtm.timedelta + else: + assert len(recwarn) == 1 + assert "`retry_after` will be of type `datetime.timedelta`" in str(recwarn[0].message) + assert recwarn[0].category is PTBDeprecationWarning + assert type(retry_after) is int def test_conflict(self): with pytest.raises(Conflict, match="Something something."): @@ -111,6 +132,7 @@ def test_conflict(self): (TimedOut(), ["message"]), (ChatMigrated(1234), ["message", "new_chat_id"]), (RetryAfter(12), ["message", "retry_after"]), + (RetryAfter(dtm.timedelta(seconds=12)), ["message", "retry_after"]), (Conflict("test message"), ["message"]), (PassportDecryptionError("test message"), ["message"]), (InvalidCallbackData("test data"), ["callback_data"]), @@ -136,7 +158,7 @@ def test_errors_pickling(self, exception, attributes): (BadRequest("test message")), (TimedOut()), (ChatMigrated(1234)), - (RetryAfter(12)), + (RetryAfter(dtm.timedelta(seconds=12))), (Conflict("test message")), (PassportDecryptionError("test message")), (InvalidCallbackData("test data")), @@ -181,15 +203,19 @@ def make_assertion(cls): make_assertion(TelegramError) - def test_string_representations(self): + def test_string_representations(self, PTB_TIMEDELTA): """We just randomly test a few of the subclasses - should suffice""" e = TelegramError("This is a message") assert repr(e) == "TelegramError('This is a message')" assert str(e) == "This is a message" - e = RetryAfter(42) - assert repr(e) == "RetryAfter('Flood control exceeded. Retry in 42 seconds')" - assert str(e) == "Flood control exceeded. Retry in 42 seconds" + e = RetryAfter(dtm.timedelta(seconds=42)) + if PTB_TIMEDELTA: + assert repr(e) == "RetryAfter('Flood control exceeded. Retry in 0:00:42')" + assert str(e) == "Flood control exceeded. Retry in 0:00:42" + else: + assert repr(e) == "RetryAfter('Flood control exceeded. Retry in 42 seconds')" + assert str(e) == "Flood control exceeded. Retry in 42 seconds" e = BadRequest("This is a message") assert repr(e) == "BadRequest('This is a message')" diff --git a/tests/test_message.py b/tests/test_message.py index e145720d705..1c5cd152859 100644 --- a/tests/test_message.py +++ b/tests/test_message.py @@ -495,9 +495,8 @@ class MessageTestBase: class TestMessageWithoutRequest(MessageTestBase): - @staticmethod async def check_quote_parsing( - message: Message, method, bot_method_name: str, args, monkeypatch + self, message: Message, method, bot_method_name: str, args, monkeypatch ): """Used in testing reply_* below. Makes sure that do_quote is handled correctly""" with pytest.raises( @@ -506,30 +505,74 @@ async def check_quote_parsing( ): await method(*args, reply_to_message_id=42, reply_parameters=42) + with pytest.raises( + ValueError, + match="`allow_sending_without_reply` and `reply_parameters` are mutually exclusive.", + ): + await method(*args, allow_sending_without_reply=True, reply_parameters=42) + async def make_assertion(*args, **kwargs): return kwargs.get("chat_id"), kwargs.get("reply_parameters") monkeypatch.setattr(message.get_bot(), bot_method_name, make_assertion) + for aswr in (DEFAULT_NONE, True): + await self._check_quote_parsing( + message=message, + method=method, + bot_method_name=bot_method_name, + args=args, + monkeypatch=monkeypatch, + aswr=aswr, + ) + + @staticmethod + async def _check_quote_parsing( + message: Message, method, bot_method_name: str, args, monkeypatch, aswr + ): + # test that boolean input for do_quote is parse correctly for value in (True, False): - chat_id, reply_parameters = await method(*args, do_quote=value) + chat_id, reply_parameters = await method( + *args, do_quote=value, allow_sending_without_reply=aswr + ) if chat_id != message.chat.id: pytest.fail(f"chat_id is {chat_id} but should be {message.chat.id}") - expected = ReplyParameters(message.message_id) if value else None + expected = ( + ReplyParameters(message.message_id, allow_sending_without_reply=aswr) + if value + else None + ) if reply_parameters != expected: pytest.fail(f"reply_parameters is {reply_parameters} but should be {expected}") + # test that dict input for do_quote is parsed correctly input_chat_id = object() input_reply_parameters = ReplyParameters(message_id=1, chat_id=42) - chat_id, reply_parameters = await method( - *args, do_quote={"chat_id": input_chat_id, "reply_parameters": input_reply_parameters} - ) - if chat_id is not input_chat_id: - pytest.fail(f"chat_id is {chat_id} but should be {chat_id}") - if reply_parameters is not input_reply_parameters: - pytest.fail(f"reply_parameters is {reply_parameters} but should be {reply_parameters}") + coro = method( + *args, + do_quote={"chat_id": input_chat_id, "reply_parameters": input_reply_parameters}, + allow_sending_without_reply=aswr, + ) + if aswr is True: + with pytest.raises( + ValueError, + match="`allow_sending_without_reply` and `dict`-value input", + ): + await coro + else: + chat_id, reply_parameters = await coro + if chat_id is not input_chat_id: + pytest.fail(f"chat_id is {chat_id} but should be {input_chat_id}") + if reply_parameters is not input_reply_parameters: + pytest.fail( + f"reply_parameters is {reply_parameters} " + f"but should be {input_reply_parameters}" + ) - input_parameters_2 = ReplyParameters(message_id=2, chat_id=43) + # test that do_quote input is overridden by reply_parameters + input_parameters_2 = ReplyParameters( + message_id=message.message_id + 1, chat_id=message.chat_id + 1 + ) chat_id, reply_parameters = await method( *args, reply_parameters=input_parameters_2, @@ -543,16 +586,23 @@ async def make_assertion(*args, **kwargs): f"reply_parameters is {reply_parameters} but should be {input_parameters_2}" ) + # test that do_quote input is overridden by reply_to_message_id chat_id, reply_parameters = await method( *args, reply_to_message_id=42, # passing these here to make sure that `reply_to_message_id` has higher priority do_quote={"chat_id": input_chat_id, "reply_parameters": input_reply_parameters}, + allow_sending_without_reply=aswr, ) if chat_id != message.chat.id: pytest.fail(f"chat_id is {chat_id} but should be {message.chat.id}") if reply_parameters is None or reply_parameters.message_id != 42: pytest.fail(f"reply_parameters is {reply_parameters} but should be 42") + if reply_parameters is None or reply_parameters.allow_sending_without_reply != aswr: + pytest.fail( + f"reply_parameters.allow_sending_without_reply is " + f"{reply_parameters.allow_sending_without_reply} it should be {aswr}" + ) @staticmethod async def check_thread_id_parsing( diff --git a/tests/test_messageautodeletetimerchanged.py b/tests/test_messageautodeletetimerchanged.py index 19133e9aaa9..9e0ab16476f 100644 --- a/tests/test_messageautodeletetimerchanged.py +++ b/tests/test_messageautodeletetimerchanged.py @@ -16,12 +16,15 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. +import datetime as dtm + from telegram import MessageAutoDeleteTimerChanged, VideoChatEnded +from telegram.warnings import PTBDeprecationWarning from tests.auxil.slots import mro_slots class TestMessageAutoDeleteTimerChangedWithoutRequest: - message_auto_delete_time = 100 + message_auto_delete_time = dtm.timedelta(seconds=100) def test_slot_behaviour(self): action = MessageAutoDeleteTimerChanged(self.message_auto_delete_time) @@ -30,18 +33,47 @@ def test_slot_behaviour(self): assert len(mro_slots(action)) == len(set(mro_slots(action))), "duplicate slot" def test_de_json(self): - json_dict = {"message_auto_delete_time": self.message_auto_delete_time} + json_dict = { + "message_auto_delete_time": int(self.message_auto_delete_time.total_seconds()) + } madtc = MessageAutoDeleteTimerChanged.de_json(json_dict, None) assert madtc.api_kwargs == {} - assert madtc.message_auto_delete_time == self.message_auto_delete_time + assert madtc._message_auto_delete_time == self.message_auto_delete_time def test_to_dict(self): madtc = MessageAutoDeleteTimerChanged(self.message_auto_delete_time) madtc_dict = madtc.to_dict() assert isinstance(madtc_dict, dict) - assert madtc_dict["message_auto_delete_time"] == self.message_auto_delete_time + assert madtc_dict["message_auto_delete_time"] == int( + self.message_auto_delete_time.total_seconds() + ) + assert isinstance(madtc_dict["message_auto_delete_time"], int) + + def test_time_period_properties(self, PTB_TIMEDELTA): + message_auto_delete_time = MessageAutoDeleteTimerChanged( + self.message_auto_delete_time + ).message_auto_delete_time + + if PTB_TIMEDELTA: + assert message_auto_delete_time == self.message_auto_delete_time + assert isinstance(message_auto_delete_time, dtm.timedelta) + else: + assert message_auto_delete_time == int(self.message_auto_delete_time.total_seconds()) + assert isinstance(message_auto_delete_time, int) + + def test_time_period_int_deprecated(self, recwarn, PTB_TIMEDELTA): + MessageAutoDeleteTimerChanged(self.message_auto_delete_time).message_auto_delete_time + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + else: + assert len(recwarn) == 1 + assert "`message_auto_delete_time` will be of type `datetime.timedelta`" in str( + recwarn[0].message + ) + assert recwarn[0].category is PTBDeprecationWarning def test_equality(self): a = MessageAutoDeleteTimerChanged(100) diff --git a/tests/test_modules.py b/tests/test_modules.py index 086e7fe5a8f..eead2b183f4 100644 --- a/tests/test_modules.py +++ b/tests/test_modules.py @@ -23,9 +23,11 @@ import os from pathlib import Path +from tests.auxil.files import SOURCE_ROOT_PATH + def test_public_submodules_dunder_all(): - modules_to_search = list(Path("telegram").rglob("*.py")) + modules_to_search = list(SOURCE_ROOT_PATH.rglob("*.py")) if not modules_to_search: raise AssertionError("No modules found to search through, please modify this test.") @@ -52,6 +54,7 @@ def test_public_submodules_dunder_all(): def load_module(path: Path): + path = path.relative_to(SOURCE_ROOT_PATH.parent) if path.name == "__init__.py": mod_name = str(path.parent).replace(os.sep, ".") # telegram(.ext) format else: diff --git a/tests/test_official/arg_type_checker.py b/tests/test_official/arg_type_checker.py index 4b0e3630691..19ec1825014 100644 --- a/tests/test_official/arg_type_checker.py +++ b/tests/test_official/arg_type_checker.py @@ -68,7 +68,7 @@ """, re.VERBOSE, ) -TIMEDELTA_REGEX = re.compile(r"\w+_period$") # Parameter names ending with "_period" +TIMEDELTA_REGEX = re.compile(r"((in|number of) seconds)|(\w+_period$)") log = logging.debug @@ -194,15 +194,11 @@ def check_param_type( mapped_type = dtm.datetime if is_class else mapped_type | dtm.datetime # 4) HANDLING TIMEDELTA: - elif re.search(TIMEDELTA_REGEX, ptb_param.name) and obj.__name__ in ( - "TransactionPartnerUser", - "create_invoice_link", + elif re.search(TIMEDELTA_REGEX, tg_parameter.param_description) or re.search( + TIMEDELTA_REGEX, ptb_param.name ): - # Currently we only support timedelta for `subscription_period` in `TransactionPartnerUser` - # and `create_invoice_link`. - # See https://github.com/python-telegram-bot/python-telegram-bot/issues/4575 log("Checking that `%s` is a timedelta!\n", ptb_param.name) - mapped_type = dtm.timedelta if is_class else mapped_type | dtm.timedelta + mapped_type = mapped_type | dtm.timedelta # 5) COMPLEX TYPES: # Some types are too complicated, so we replace our annotation with a simpler type: diff --git a/tests/test_official/exceptions.py b/tests/test_official/exceptions.py index 40144f803d3..a1e7a8157b0 100644 --- a/tests/test_official/exceptions.py +++ b/tests/test_official/exceptions.py @@ -17,7 +17,6 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains exceptions to our API compared to the official API.""" -import datetime as dtm from telegram import Animation, Audio, Document, Gift, PhotoSize, Sticker, Video, VideoNote, Voice from tests.test_official.helpers import _get_params_base @@ -55,12 +54,6 @@ class ParamTypeCheckingExceptions: "replace_sticker_in_set": { "old_sticker$": Sticker, }, - # The underscore will match any method - r"\w+_[\w_]+": { - "duration": dtm.timedelta, - r"\w+_period": dtm.timedelta, - "cache_time": dtm.timedelta, - }, } # TODO: Look into merging this with COMPLEX_TYPES @@ -102,7 +95,6 @@ class ParamTypeCheckingExceptions: }, "InputProfilePhotoAnimated": { "animation": str, # actual: Union[str, FileInput] - "main_frame_timestamp": float, # actual: Union[float, dtm.timedelta] }, "InputSticker": { "sticker": str, # actual: Union[str, FileInput] @@ -110,8 +102,6 @@ class ParamTypeCheckingExceptions: "InputStoryContent.*": { "photo": str, # actual: Union[str, FileInput] "video": str, # actual: Union[str, FileInput] - "duration": float, # actual: dtm.timedelta - "cover_frame_timestamp": float, # actual: dtm.timedelta }, "EncryptedPassportElement": { "data": str, # actual: Union[IdDocumentData, PersonalDetails, ResidentialAddress] @@ -169,7 +159,7 @@ class ParamTypeCheckingExceptions: "InputStoryContent": {"type"}, # attributes common to all subclasses "StoryAreaType": {"type"}, # attributes common to all subclasses # backwards compatibility for api 9.0 changes - # tags: deprecated NEXT.VERSION, bot api 9.0 + # tags: deprecated v22.2, bot api 9.0 "BusinessConnection": {"can_reply"}, "ChatFullInfo": {"can_send_gift"}, "InputProfilePhoto": {"type"}, # attributes common to all subclasses @@ -221,7 +211,7 @@ def ptb_ignored_params(object_name: str) -> set[str]: "send_contact": {"phone_number", "first_name"}, # ----> # backwards compatibility for api 9.0 changes - # tags: deprecated NEXT.VERSION, bot api 9.0 + # tags: deprecated v22.2, bot api 9.0 "BusinessConnection": {"is_enabled"}, "ChatFullInfo": {"accepted_gift_types"}, "TransactionPartnerUser": {"transaction_type"}, diff --git a/tests/test_paidmedia.py b/tests/test_paidmedia.py index a696c416b58..8055e161e84 100644 --- a/tests/test_paidmedia.py +++ b/tests/test_paidmedia.py @@ -17,6 +17,7 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. +import datetime as dtm from copy import deepcopy import pytest @@ -34,6 +35,7 @@ Video, ) from telegram.constants import PaidMediaType +from telegram.warnings import PTBDeprecationWarning from tests.auxil.slots import mro_slots @@ -46,13 +48,13 @@ class PaidMediaTestBase: type = PaidMediaType.PHOTO width = 640 height = 480 - duration = 60 + duration = dtm.timedelta(60) video = Video( file_id="video_file_id", width=640, height=480, file_unique_id="file_unique_id", - duration=60, + duration=dtm.timedelta(seconds=60), ) photo = ( PhotoSize( @@ -96,14 +98,17 @@ def test_de_json_subclass(self, offline_bot, pm_type, subclass): "photo": [p.to_dict() for p in self.photo], "width": self.width, "height": self.height, - "duration": self.duration, + "duration": int(self.duration.total_seconds()), } pm = PaidMedia.de_json(json_dict, offline_bot) + # TODO: Should be removed when the timedelta migartion is complete + extra_slots = {"duration"} if subclass is PaidMediaPreview else set() + assert type(pm) is subclass - assert set(pm.api_kwargs.keys()) == set(json_dict.keys()) - set(subclass.__slots__) - { - "type" - } + assert set(pm.api_kwargs.keys()) == set(json_dict.keys()) - ( + set(subclass.__slots__) | extra_slots + ) - {"type"} assert pm.type == pm_type def test_to_dict(self, paid_media): @@ -243,21 +248,23 @@ def test_de_json(self, offline_bot): json_dict = { "width": self.width, "height": self.height, - "duration": self.duration, + "duration": int(self.duration.total_seconds()), } pmp = PaidMediaPreview.de_json(json_dict, offline_bot) assert pmp.width == self.width assert pmp.height == self.height - assert pmp.duration == self.duration + assert pmp._duration == self.duration assert pmp.api_kwargs == {} def test_to_dict(self, paid_media_preview): - assert paid_media_preview.to_dict() == { - "type": paid_media_preview.type, - "width": self.width, - "height": self.height, - "duration": self.duration, - } + paid_media_preview_dict = paid_media_preview.to_dict() + + assert isinstance(paid_media_preview_dict, dict) + assert paid_media_preview_dict["type"] == paid_media_preview.type + assert paid_media_preview_dict["width"] == paid_media_preview.width + assert paid_media_preview_dict["height"] == paid_media_preview.height + assert paid_media_preview_dict["duration"] == int(self.duration.total_seconds()) + assert isinstance(paid_media_preview_dict["duration"], int) def test_equality(self, paid_media_preview): a = paid_media_preview @@ -266,6 +273,11 @@ def test_equality(self, paid_media_preview): height=self.height, duration=self.duration, ) + x = PaidMediaPreview( + width=self.width, + height=self.height, + duration=int(self.duration.total_seconds()), + ) c = PaidMediaPreview( width=100, height=100, @@ -274,7 +286,9 @@ def test_equality(self, paid_media_preview): d = Dice(5, "test") assert a == b + assert b == x assert hash(a) == hash(b) + assert hash(b) == hash(x) assert a != c assert hash(a) != hash(c) @@ -282,6 +296,26 @@ def test_equality(self, paid_media_preview): assert a != d assert hash(a) != hash(d) + def test_time_period_properties(self, PTB_TIMEDELTA, paid_media_preview): + duration = paid_media_preview.duration + + if PTB_TIMEDELTA: + assert duration == self.duration + assert isinstance(duration, dtm.timedelta) + else: + assert duration == int(self.duration.total_seconds()) + assert isinstance(duration, int) + + def test_time_period_int_deprecated(self, recwarn, PTB_TIMEDELTA, paid_media_preview): + paid_media_preview.duration + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + else: + assert len(recwarn) == 1 + assert "`duration` will be of type `datetime.timedelta`" in str(recwarn[0].message) + assert recwarn[0].category is PTBDeprecationWarning + # =========================================================================================== # =========================================================================================== diff --git a/tests/test_poll.py b/tests/test_poll.py index c7e3da447f5..484e18710a2 100644 --- a/tests/test_poll.py +++ b/tests/test_poll.py @@ -22,6 +22,7 @@ from telegram import Chat, InputPollOption, MessageEntity, Poll, PollAnswer, PollOption, User from telegram._utils.datetime import UTC, to_timestamp from telegram.constants import PollType +from telegram.warnings import PTBDeprecationWarning from tests.auxil.slots import mro_slots @@ -295,7 +296,7 @@ class PollTestBase: b"\\u200d\\U0001f467\\U0001f431http://google.com" ).decode("unicode-escape") explanation_entities = [MessageEntity(13, 17, MessageEntity.URL)] - open_period = 42 + open_period = dtm.timedelta(seconds=42) close_date = dtm.datetime.now(dtm.timezone.utc) question_entities = [ MessageEntity(MessageEntity.BOLD, 0, 4), @@ -316,7 +317,7 @@ def test_de_json(self, offline_bot): "allows_multiple_answers": self.allows_multiple_answers, "explanation": self.explanation, "explanation_entities": [self.explanation_entities[0].to_dict()], - "open_period": self.open_period, + "open_period": int(self.open_period.total_seconds()), "close_date": to_timestamp(self.close_date), "question_entities": [e.to_dict() for e in self.question_entities], } @@ -337,7 +338,7 @@ def test_de_json(self, offline_bot): assert poll.allows_multiple_answers == self.allows_multiple_answers assert poll.explanation == self.explanation assert poll.explanation_entities == tuple(self.explanation_entities) - assert poll.open_period == self.open_period + assert poll._open_period == self.open_period assert abs(poll.close_date - self.close_date) < dtm.timedelta(seconds=1) assert to_timestamp(poll.close_date) == to_timestamp(self.close_date) assert poll.question_entities == tuple(self.question_entities) @@ -354,7 +355,7 @@ def test_de_json_localization(self, tz_bot, offline_bot, raw_bot): "allows_multiple_answers": self.allows_multiple_answers, "explanation": self.explanation, "explanation_entities": [self.explanation_entities[0].to_dict()], - "open_period": self.open_period, + "open_period": int(self.open_period.total_seconds()), "close_date": to_timestamp(self.close_date), "question_entities": [e.to_dict() for e in self.question_entities], } @@ -387,10 +388,28 @@ def test_to_dict(self, poll): assert poll_dict["allows_multiple_answers"] == poll.allows_multiple_answers assert poll_dict["explanation"] == poll.explanation assert poll_dict["explanation_entities"] == [poll.explanation_entities[0].to_dict()] - assert poll_dict["open_period"] == poll.open_period + assert poll_dict["open_period"] == int(self.open_period.total_seconds()) assert poll_dict["close_date"] == to_timestamp(poll.close_date) assert poll_dict["question_entities"] == [e.to_dict() for e in poll.question_entities] + def test_time_period_properties(self, PTB_TIMEDELTA, poll): + if PTB_TIMEDELTA: + assert poll.open_period == self.open_period + assert isinstance(poll.open_period, dtm.timedelta) + else: + assert poll.open_period == int(self.open_period.total_seconds()) + assert isinstance(poll.open_period, int) + + def test_time_period_int_deprecated(self, recwarn, PTB_TIMEDELTA, poll): + poll.open_period + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + else: + assert len(recwarn) == 1 + assert "`open_period` will be of type `datetime.timedelta`" in str(recwarn[0].message) + assert recwarn[0].category is PTBDeprecationWarning + def test_equality(self): a = Poll(123, "question", ["O1", "O2"], 1, False, True, Poll.REGULAR, True) b = Poll(123, "question", ["o1", "o2"], 1, True, False, Poll.REGULAR, True) diff --git a/tests/test_videochat.py b/tests/test_videochat.py index 57d91003c29..df8151940cf 100644 --- a/tests/test_videochat.py +++ b/tests/test_videochat.py @@ -28,6 +28,7 @@ VideoChatStarted, ) from telegram._utils.datetime import UTC, to_timestamp +from telegram.warnings import PTBDeprecationWarning from tests.auxil.slots import mro_slots @@ -60,7 +61,7 @@ def test_to_dict(self): class TestVideoChatEndedWithoutRequest: - duration = 100 + duration = dtm.timedelta(seconds=100) def test_slot_behaviour(self): action = VideoChatEnded(8) @@ -69,27 +70,50 @@ def test_slot_behaviour(self): assert len(mro_slots(action)) == len(set(mro_slots(action))), "duplicate slot" def test_de_json(self): - json_dict = {"duration": self.duration} + json_dict = {"duration": int(self.duration.total_seconds())} video_chat_ended = VideoChatEnded.de_json(json_dict, None) assert video_chat_ended.api_kwargs == {} - assert video_chat_ended.duration == self.duration + assert video_chat_ended._duration == self.duration def test_to_dict(self): video_chat_ended = VideoChatEnded(self.duration) video_chat_dict = video_chat_ended.to_dict() assert isinstance(video_chat_dict, dict) - assert video_chat_dict["duration"] == self.duration + assert video_chat_dict["duration"] == int(self.duration.total_seconds()) + + def test_time_period_properties(self, PTB_TIMEDELTA): + duration = VideoChatEnded(duration=self.duration).duration + + if PTB_TIMEDELTA: + assert duration == self.duration + assert isinstance(duration, dtm.timedelta) + else: + assert duration == int(self.duration.total_seconds()) + assert isinstance(duration, int) + + def test_time_period_int_deprecated(self, recwarn, PTB_TIMEDELTA): + VideoChatEnded(self.duration).duration + + if PTB_TIMEDELTA: + assert len(recwarn) == 0 + else: + assert len(recwarn) == 1 + assert "`duration` will be of type `datetime.timedelta`" in str(recwarn[0].message) + assert recwarn[0].category is PTBDeprecationWarning def test_equality(self): a = VideoChatEnded(100) b = VideoChatEnded(100) + x = VideoChatEnded(dtm.timedelta(seconds=100)) c = VideoChatEnded(50) d = VideoChatStarted() assert a == b assert hash(a) == hash(b) + assert b == x + assert hash(b) == hash(x) assert a != c assert hash(a) != hash(c) diff --git a/tests/test_warnings.py b/tests/test_warnings.py index 18be85689ed..555d5dcb132 100644 --- a/tests/test_warnings.py +++ b/tests/test_warnings.py @@ -23,7 +23,7 @@ from telegram._utils.warnings import warn from telegram.warnings import PTBDeprecationWarning, PTBRuntimeWarning, PTBUserWarning -from tests.auxil.files import PROJECT_ROOT_PATH +from tests.auxil.files import SOURCE_ROOT_PATH from tests.auxil.slots import mro_slots @@ -66,7 +66,7 @@ def make_assertion(cls): make_assertion(PTBUserWarning) def test_warn(self, recwarn): - expected_file = PROJECT_ROOT_PATH / "telegram" / "_utils" / "warnings.py" + expected_file = SOURCE_ROOT_PATH / "_utils" / "warnings.py" warn("test message") assert len(recwarn) == 1