diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst index 63906fabd6f..b64a368ac43 100644 --- a/.github/CONTRIBUTING.rst +++ b/.github/CONTRIBUTING.rst @@ -210,7 +210,7 @@ doc strings don't have a separate documentation site they generate, instead, the User facing documentation ------------------------- -We use `sphinx`_ to generate static HTML docs. To build them, first make sure you're running Python 3.9 or above and have the required dependencies installed as explained above. +We use `sphinx`_ to generate static HTML docs. To build them, first make sure you're running Python 3.10 or above and have the required dependencies installed as explained above. Then, run the following from the PTB root directory: .. code-block:: bash diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 509f689df40..53c89496b21 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,7 +1,7 @@ name: Bug Report description: Create a report to help us improve -title: "[BUG]" -labels: ["bug :bug:"] +labels: ["📋 triage"] +type: '🐛 bug' body: - type: markdown diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 6c7ff80390e..e6cc817a1bd 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -1,7 +1,7 @@ name: Feature Request description: Suggest an idea for this project -title: "[FEATURE]" -labels: ["enhancement"] +labels: ["📋 triage"] +type: '💡 feature' body: - type: textarea diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml index 1836230ff21..220da04007e 100644 --- a/.github/ISSUE_TEMPLATE/question.yml +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -1,7 +1,7 @@ name: Question description: Get help with errors or general questions -title: "[QUESTION]" labels: ["question"] +type: '❔ question' body: - type: markdown diff --git a/.github/labeler.yml b/.github/labeler.yml index 120c88f4b36..3d2eb437df9 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -3,7 +3,7 @@ version: 1 labels: -- label: "dependencies" +- label: "⚙️ dependencies" authors: ["dependabot[bot]", "pre-commit-ci[bot]"] -- label: "code quality ✨" +- label: "🛠 code-quality" authors: ["pre-commit-ci[bot]"] diff --git a/.github/workflows/dependabot-prs.yml b/.github/workflows/dependabot-prs.yml index 80bace2d95d..afb0fa6340e 100644 --- a/.github/workflows/dependabot-prs.yml +++ b/.github/workflows/dependabot-prs.yml @@ -16,14 +16,15 @@ jobs: - name: Fetch Dependabot metadata id: dependabot-metadata - uses: dependabot/fetch-metadata@v2.1.0 + uses: dependabot/fetch-metadata@dbb049abf0d677abbd7f7eee0375145b417fdd34 # v2.2.0 - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 with: ref: ${{ github.event.pull_request.head.ref }} + persist-credentials: false - name: Update Version Number in Other Files - uses: jacobtomlinson/gha-find-replace@v3 + uses: jacobtomlinson/gha-find-replace@f1069b438f125e5395d84d1c6fd3b559a7880cb5 # v3 with: find: ${{ steps.dependabot-metadata.outputs.previous-version }} replace: ${{ steps.dependabot-metadata.outputs.new-version }} @@ -31,7 +32,7 @@ jobs: exclude: CHANGES.rst - name: Commit & Push Changes to PR - uses: EndBug/add-and-commit@v9.1.4 + uses: EndBug/add-and-commit@a94899bca583c204427a224a7af87c02f9b325d5 # v9.1.4 with: message: 'Update version number in other files' committer_name: GitHub Actions diff --git a/.github/workflows/docs-linkcheck.yml b/.github/workflows/docs-linkcheck.yml index 82fafe3e53f..cb1aa840daf 100644 --- a/.github/workflows/docs-linkcheck.yml +++ b/.github/workflows/docs-linkcheck.yml @@ -3,6 +3,9 @@ on: schedule: # First day of month at 05:46 in every 2nd month - cron: '46 5 1 */2 *' + pull_request: + paths: + - .github/workflows/docs-linkcheck.yml jobs: test-sphinx-build: @@ -10,13 +13,15 @@ jobs: runs-on: ${{matrix.os}} strategy: matrix: - python-version: [3.9] + python-version: ['3.10'] os: [ubuntu-latest] fail-fast: False steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v5 + uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 with: python-version: ${{ matrix.python-version }} - name: Install dependencies diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 73e123e17ea..c0ea937c181 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -14,13 +14,15 @@ jobs: runs-on: ${{matrix.os}} strategy: matrix: - python-version: [3.9] + python-version: ['3.10'] os: [ubuntu-latest] fail-fast: False steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v5 + uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 with: python-version: ${{ matrix.python-version }} cache: 'pip' @@ -34,7 +36,7 @@ jobs: - name: Build docs run: sphinx-build docs/source docs/build/html -W --keep-going -j auto - name: Upload docs - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3 with: name: HTML Docs retention-days: 7 diff --git a/.github/workflows/gha_security.yml b/.github/workflows/gha_security.yml new file mode 100644 index 00000000000..74e4b756eac --- /dev/null +++ b/.github/workflows/gha_security.yml @@ -0,0 +1,31 @@ +name: GitHub Actions Security Analysis + +on: + push: + branches: + - master + pull_request: + +jobs: + zizmor: + name: Security Analysis with zizmor + runs-on: ubuntu-latest + permissions: + contents: read + security-events: write + steps: + - name: Checkout repository + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false + - name: Install the latest version of uv + uses: astral-sh/setup-uv@38f3f104447c67c051c4a08e39b64a148898af3a # v4.2.0 + - name: Run zizmor + run: uvx zizmor --persona=pedantic --format sarif . > results.sarif + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + - name: Upload SARIF file + uses: github/codeql-action/upload-sarif@df409f7d9260372bd5f19e5b04e83cb3c43714ae # v3.27.9 + with: + sarif_file: results.sarif + category: zizmor \ No newline at end of file diff --git a/.github/workflows/labelling.yml b/.github/workflows/labelling.yml index 12cd1b4bea7..60e3744d2d5 100644 --- a/.github/workflows/labelling.yml +++ b/.github/workflows/labelling.yml @@ -11,7 +11,7 @@ jobs: pull-requests: write # for srvaroa/labeler to add labels in PR runs-on: ubuntu-latest steps: - - uses: srvaroa/labeler@v1.10.1 + - uses: srvaroa/labeler@fe4b1c73bb8abf2f14a44a6912a8b4fee835d631 # v1.12.0 # Config file at .github/labeler.yml env: GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" diff --git a/.github/workflows/lock.yml b/.github/workflows/lock.yml index f2ab9d029b0..196b2c66704 100644 --- a/.github/workflows/lock.yml +++ b/.github/workflows/lock.yml @@ -8,7 +8,7 @@ jobs: lock: runs-on: ubuntu-latest steps: - - uses: dessant/lock-threads@v5.0.1 + - uses: dessant/lock-threads@1bf7ec25051fe7c00bdd17e6a7cf3d7bfb7dc771 # v5.0.1 with: github-token: ${{ github.token }} issue-inactive-days: '7' diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml index bcd1794c468..518194e0513 100644 --- a/.github/workflows/release_pypi.yml +++ b/.github/workflows/release_pypi.yml @@ -1,22 +1,22 @@ name: Publish to PyPI on: - # Run on any tag - push: - tags: - - '**' - # manually trigger the workflow - for testing only + # manually trigger the workflow workflow_dispatch: jobs: build: name: Build Distribution runs-on: ubuntu-latest + outputs: + TAG: ${{ steps.get_tag.outputs.TAG }} steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false - name: Set up Python - uses: actions/setup-python@v5 + uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 with: python-version: "3.x" - name: Install pypa/build @@ -25,15 +25,19 @@ jobs: - name: Build a binary wheel and a source tarball run: python3 -m build - name: Store the distribution packages - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3 with: name: python-package-distributions path: dist/ + - name: Get Tag Name + id: get_tag + run: | + pip install . + TAG=$(python -c "from telegram import __version__; print(f'v{__version__}')") + echo "TAG=$TAG" >> $GITHUB_OUTPUT publish-to-pypi: name: Publish to PyPI - # only publish to PyPI on tag pushes - if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags') needs: - build runs-on: ubuntu-latest @@ -45,56 +49,25 @@ jobs: steps: - name: Download all the dists - uses: actions/download-artifact@v4 + uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8 with: name: python-package-distributions path: dist/ - name: Publish to PyPI - uses: pypa/gh-action-pypi-publish@release/v1 - - publish-to-test-pypi: - name: Publish to Test PyPI - needs: - - build - runs-on: ubuntu-latest - environment: - name: release_test_pypi - url: https://test.pypi.org/p/python-telegram-bot - permissions: - id-token: write # IMPORTANT: mandatory for trusted publishing - - steps: - - name: Download all the dists - uses: actions/download-artifact@v4 - with: - name: python-package-distributions - path: dist/ - - name: Publish to Test PyPI - uses: pypa/gh-action-pypi-publish@release/v1 - with: - repository-url: https://test.pypi.org/legacy/ + uses: pypa/gh-action-pypi-publish@67339c736fd9354cd4f8cb0b744f2b82a74b5c70 # v1.12.3 compute-signatures: name: Compute SHA1 Sums and Sign with Sigstore runs-on: ubuntu-latest needs: - publish-to-pypi - - publish-to-test-pypi - # run if either of the publishing jobs ran successfully - # see also: - # https://github.com/actions/runner/issues/491#issuecomment-850884422 - if: | - always() && ( - (needs.publish-to-pypi.result == 'success') || - (needs.publish-to-test-pypi.result == 'success') - ) permissions: id-token: write # IMPORTANT: mandatory for sigstore steps: - name: Download all the dists - uses: actions/download-artifact@v4 + uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8 with: name: python-package-distributions path: dist/ @@ -106,13 +79,13 @@ jobs: sha1sum $file > $file.sha1 done - name: Sign the dists with Sigstore - uses: sigstore/gh-action-sigstore-python@v2.1.1 + uses: sigstore/gh-action-sigstore-python@f514d46b907ebcd5bedc05145c03b69c1edd8b46 # v3.0.0 with: inputs: >- ./dist/*.tar.gz ./dist/*.whl - name: Store the distribution packages and signatures - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3 with: name: python-package-distributions-and-signatures path: dist/ @@ -120,56 +93,9 @@ jobs: github-release: name: Upload to GitHub Release needs: - - publish-to-pypi + - build - compute-signatures - if: | - always() && ( - (needs.publish-to-pypi.result == 'success') && - (needs.compute-signatures.result == 'success') - ) - - runs-on: ubuntu-latest - - permissions: - contents: write # IMPORTANT: mandatory for making GitHub Releases - - steps: - - name: Download all the dists - uses: actions/download-artifact@v4 - with: - name: python-package-distributions-and-signatures - path: dist/ - - name: Create GitHub Release - env: - GITHUB_TOKEN: ${{ github.token }} - # Create a GitHub Release for this tag. The description can be changed later, as for now - # we don't define it through this workflow. - run: >- - gh release create - '${{ github.ref_name }}' - --repo '${{ github.repository }}' - --generate-notes - - name: Upload artifact signatures to GitHub Release - env: - GITHUB_TOKEN: ${{ github.token }} - # Upload to GitHub Release using the `gh` CLI. - # `dist/` contains the built packages, and the - # sigstore-produced signatures and certificates. - run: >- - gh release upload - '${{ github.ref_name }}' dist/** - --repo '${{ github.repository }}' - github-test-release: - name: Upload to GitHub Release Draft - needs: - - publish-to-test-pypi - - compute-signatures - if: | - always() && ( - (needs.publish-to-test-pypi.result == 'success') && - (needs.compute-signatures.result == 'success') - ) runs-on: ubuntu-latest permissions: @@ -177,28 +103,29 @@ jobs: steps: - name: Download all the dists - uses: actions/download-artifact@v4 + uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8 with: name: python-package-distributions-and-signatures path: dist/ - name: Create GitHub Release env: GITHUB_TOKEN: ${{ github.token }} - # Create a GitHub Release *draft*. The description can be changed later, as for now + TAG: ${{ needs.build.outputs.TAG }} + # Create a tag and a GitHub Release. The description can be changed later, as for now # we don't define it through this workflow. run: >- gh release create - '${{ github.ref_name }}' + "$TAG" --repo '${{ github.repository }}' --generate-notes - --draft - name: Upload artifact signatures to GitHub Release env: GITHUB_TOKEN: ${{ github.token }} + TAG: ${{ needs.build.outputs.TAG }} # Upload to GitHub Release using the `gh` CLI. # `dist/` contains the built packages, and the # sigstore-produced signatures and certificates. run: >- gh release upload - '${{ github.ref_name }}' dist/** + "$TAG" dist/** --repo '${{ github.repository }}' diff --git a/.github/workflows/release_test_pypi.yml b/.github/workflows/release_test_pypi.yml new file mode 100644 index 00000000000..0c70ab4079a --- /dev/null +++ b/.github/workflows/release_test_pypi.yml @@ -0,0 +1,134 @@ +name: Publish to Test PyPI + +on: + # manually trigger the workflow + workflow_dispatch: + +jobs: + build: + name: Build Distribution + runs-on: ubuntu-latest + outputs: + TAG: ${{ steps.get_tag.outputs.TAG }} + + steps: + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false + - name: Set up Python + uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 + with: + python-version: "3.x" + - name: Install pypa/build + run: >- + python3 -m pip install build --user + - name: Build a binary wheel and a source tarball + run: python3 -m build + - name: Store the distribution packages + uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3 + with: + name: python-package-distributions + path: dist/ + - name: Get Tag Name + id: get_tag + run: | + pip install . + TAG=$(python -c "from telegram import __version__; print(f'v{__version__}')") + echo "TAG=$TAG" >> $GITHUB_OUTPUT + + publish-to-test-pypi: + name: Publish to Test PyPI + needs: + - build + runs-on: ubuntu-latest + environment: + name: release_test_pypi + url: https://test.pypi.org/p/python-telegram-bot + permissions: + id-token: write # IMPORTANT: mandatory for trusted publishing + + steps: + - name: Download all the dists + uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8 + with: + name: python-package-distributions + path: dist/ + - name: Publish to Test PyPI + uses: pypa/gh-action-pypi-publish@67339c736fd9354cd4f8cb0b744f2b82a74b5c70 # v1.12.3 + with: + repository-url: https://test.pypi.org/legacy/ + + compute-signatures: + name: Compute SHA1 Sums and Sign with Sigstore + runs-on: ubuntu-latest + needs: + - publish-to-test-pypi + + permissions: + id-token: write # IMPORTANT: mandatory for sigstore + + steps: + - name: Download all the dists + uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8 + with: + name: python-package-distributions + path: dist/ + - name: Compute SHA1 Sums + run: | + # Compute SHA1 sum of the distribution packages and save it to a file with the same name, + # but with .sha1 extension + for file in dist/*; do + sha1sum $file > $file.sha1 + done + - name: Sign the dists with Sigstore + uses: sigstore/gh-action-sigstore-python@f514d46b907ebcd5bedc05145c03b69c1edd8b46 # v3.0.0 + with: + inputs: >- + ./dist/*.tar.gz + ./dist/*.whl + - name: Store the distribution packages and signatures + uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3 + with: + name: python-package-distributions-and-signatures + path: dist/ + + github-test-release: + name: Upload to GitHub Release Draft + needs: + - build + - compute-signatures + + runs-on: ubuntu-latest + + permissions: + contents: write # IMPORTANT: mandatory for making GitHub Releases + + steps: + - name: Download all the dists + uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8 + with: + name: python-package-distributions-and-signatures + path: dist/ + - name: Create GitHub Release + env: + GITHUB_TOKEN: ${{ github.token }} + TAG: ${{ needs.build.outputs.TAG }} + # Create a GitHub Release *draft*. The description can be changed later, as for now + # we don't define it through this workflow. + run: >- + gh release create + "$TAG" + --repo '${{ github.repository }}' + --generate-notes + --draft + - name: Upload artifact signatures to GitHub Release + env: + GITHUB_TOKEN: ${{ github.token }} + TAG: ${{ needs.build.outputs.TAG }} + # Upload to GitHub Release using the `gh` CLI. + # `dist/` contains the built packages, and the + # sigstore-produced signatures and certificates. + run: >- + gh release upload + "$TAG" dist/** + --repo '${{ github.repository }}' diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index 56ba7410946..6baacdedc1b 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -7,13 +7,13 @@ jobs: stale: runs-on: ubuntu-latest steps: - - uses: actions/stale@v9 + - uses: actions/stale@28ca1036281a5e5922ead5184a1bbf96e5fc984e # v9.0.0 with: # PRs never get stale days-before-stale: 3 days-before-close: 2 days-before-pr-stale: -1 - stale-issue-label: 'stale' + stale-issue-label: '📋 stale' only-labels: 'question' stale-issue-message: '' close-issue-message: 'This issue has been automatically closed due to inactivity. Feel free to comment in order to reopen or ask again in our Telegram support group at https://t.me/pythontelegrambotgroup.' diff --git a/.github/workflows/test_official.yml b/.github/workflows/test_official.yml index 5de11471eaa..cbf3b1b302f 100644 --- a/.github/workflows/test_official.yml +++ b/.github/workflows/test_official.yml @@ -21,9 +21,11 @@ jobs: os: [ubuntu-latest] fail-fast: False steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v5 + uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 with: python-version: ${{ matrix.python-version }} - name: Install dependencies @@ -41,7 +43,7 @@ jobs: - name: Test Summary id: test_summary - uses: test-summary/action@v2.3 + uses: test-summary/action@31493c76ec9e7aa675f1585d3ed6f1da69269a86 # v2.4 if: always() # always run, even if tests fail with: paths: .test_report_official.xml diff --git a/.github/workflows/type_completeness.yml b/.github/workflows/type_completeness.yml index 17dc249c81f..66b2f4f3d47 100644 --- a/.github/workflows/type_completeness.yml +++ b/.github/workflows/type_completeness.yml @@ -14,7 +14,7 @@ jobs: name: test-type-completeness runs-on: ubuntu-latest steps: - - uses: Bibo-Joshi/pyright-type-completeness@1.0.0 + - uses: Bibo-Joshi/pyright-type-completeness@c85a67ff3c66f51dcbb2d06bfcf4fe83a57d69cc # v1.0.1 with: package-name: telegram python-version: 3.12 diff --git a/.github/workflows/type_completeness_monthly.yml b/.github/workflows/type_completeness_monthly.yml new file mode 100644 index 00000000000..fecf73db948 --- /dev/null +++ b/.github/workflows/type_completeness_monthly.yml @@ -0,0 +1,33 @@ +name: Check Type Completeness Monthly Run +on: + schedule: + # Run first friday of the month at 03:17 - odd time to spread load on GitHub Actions + - cron: '17 3 1-7 * 5' + +jobs: + test-type-completeness: + name: test-type-completeness + runs-on: ubuntu-latest + steps: + - uses: Bibo-Joshi/pyright-type-completeness@c85a67ff3c66f51dcbb2d06bfcf4fe83a57d69cc # v1.0.1 + id: pyright-type-completeness + with: + package-name: telegram + python-version: 3.12 + pyright-version: ~=1.1.367 + - name: Check Output + uses: jannekem/run-python-script-action@bbfca66c612a28f3eeca0ae40e1f810265e2ea68 # v1.7 + env: + TYPE_COMPLETENESS: ${{ steps.pyright-type-completeness.outputs.base-completeness-score }} + with: + script: | + import os + completeness = float(os.getenv("TYPE_COMPLETENESS")) + + if completeness >= 1: + exit(0) + + text = f"Type Completeness Decreased to {completeness}. ❌" + error(text) + set_summary(text) + exit(1) diff --git a/.github/workflows/unit_tests.yml b/.github/workflows/unit_tests.yml index 6eac67758da..76eff5ec8d6 100644 --- a/.github/workflows/unit_tests.yml +++ b/.github/workflows/unit_tests.yml @@ -20,13 +20,15 @@ jobs: runs-on: ${{matrix.os}} strategy: matrix: - python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13.0-beta.3'] + python-version: ['3.9', '3.10', '3.11', '3.12', '3.13'] os: [ubuntu-latest, windows-latest, macos-latest] fail-fast: False steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + persist-credentials: false - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v5 + uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 with: python-version: ${{ matrix.python-version }} cache: 'pip' @@ -37,7 +39,7 @@ jobs: 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[psutil] + python -W ignore -m pip install pytest-xdist - name: Test with pytest # We run 4 different suites here @@ -57,21 +59,17 @@ jobs: # - without socks support # - without http2 support 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}" - # Rerun only failed tests (--lf), and don't run any tests if none failed (--lfnf=none) - pytest -v --cov --cov-append -k "${TO_TEST}" --lf --lfnf=none --junit-xml=.test_report_no_optionals.xml - # No tests were selected, convert returned status code to 0 - opt_dep_status=$(( $? == 5 ? 0 : $? )) + 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' pip install .[all] - # `-n auto --dist loadfile` uses pytest-xdist to run each test file on a different CPU - # worker. Increasing number of workers has little effect on test duration, but it seems - # to increase flakyness, specially on python 3.7 with --dist=loadgroup. - pytest -v --cov --cov-append -n auto --dist loadfile - pytest -v --cov --cov-append -n auto --dist loadfile --lf --lfnf=none --junit-xml=.test_report_optionals.xml - main_status=$(( $? == 5 ? 0 : $? )) + # `-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. + pytest -v --cov --cov-append -n auto --dist worksteal --junit-xml=.test_report_optionals_junit.xml + main_status=$? # exit with non-zero status if any of the two pytest runs failed exit $(( ${opt_dep_status} || ${main_status} )) env: @@ -83,17 +81,23 @@ jobs: - name: Test Summary id: test_summary - uses: test-summary/action@v2.3 + uses: test-summary/action@31493c76ec9e7aa675f1585d3ed6f1da69269a86 # v2.4 if: always() # always run, even if tests fail with: paths: | - .test_report_no_optionals.xml - .test_report_optionals.xml + .test_report_no_optionals_junit.xml + .test_report_optionals_junit.xml - name: Submit coverage - uses: codecov/codecov-action@v4 + uses: codecov/codecov-action@7f8b4b4bde536c465e797be725718b88c5d95e0e # v5.1.1 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@9739113ad922ea0a9abb4b2c0f8bf6a4aa8ef820 # v1.0.1 + if: ${{ !cancelled() }} + with: + files: .test_report_no_optionals_junit.xml,.test_report_optionals_junit.xml + token: ${{ secrets.CODECOV_TOKEN }} diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index e0d933ea11c..e2cd308e78f 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -7,7 +7,7 @@ ci: repos: - repo: https://github.com/astral-sh/ruff-pre-commit - rev: 'v0.5.0' + rev: 'v0.5.6' hooks: - id: ruff name: ruff @@ -15,8 +15,8 @@ repos: - httpx~=0.27 - tornado~=6.4 - APScheduler~=3.10.4 - - cachetools~=5.3.3 - - aiolimiter~=1.1.0 + - cachetools>=5.3.3,<5.5.0 + - aiolimiter~=1.1,<1.3 - repo: https://github.com/psf/black-pre-commit-mirror rev: 24.4.2 hooks: @@ -29,7 +29,7 @@ repos: hooks: - id: flake8 - repo: https://github.com/PyCQA/pylint - rev: v3.2.4 + rev: v3.3.2 hooks: - id: pylint files: ^(?!(tests|docs)).*\.py$ @@ -37,8 +37,8 @@ repos: - httpx~=0.27 - tornado~=6.4 - APScheduler~=3.10.4 - - cachetools~=5.3.3 - - aiolimiter~=1.1.0 + - cachetools>=5.3.3,<5.5.0 + - aiolimiter~=1.1,<1.3 - . # this basically does `pip install -e .` - repo: https://github.com/pre-commit/mirrors-mypy rev: v1.10.1 @@ -53,8 +53,8 @@ repos: - httpx~=0.27 - tornado~=6.4 - APScheduler~=3.10.4 - - cachetools~=5.3.3 - - aiolimiter~=1.1.0 + - cachetools>=5.3.3,<5.5.0 + - aiolimiter~=1.1,<1.3 - . # this basically does `pip install -e .` - id: mypy name: mypy-examples @@ -65,14 +65,14 @@ repos: additional_dependencies: - tornado~=6.4 - APScheduler~=3.10.4 - - cachetools~=5.3.3 + - cachetools>=5.3.3,<5.5.0 - . # this basically does `pip install -e .` - repo: https://github.com/asottile/pyupgrade rev: v3.16.0 hooks: - id: pyupgrade args: - - --py38-plus + - --py39-plus - repo: https://github.com/pycqa/isort rev: 5.13.2 hooks: diff --git a/AUTHORS.rst b/AUTHORS.rst index 403362aaab0..f6290a9294c 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -23,6 +23,7 @@ The following wonderful people contributed directly or indirectly to this projec - `Abdelrahman `_ - `Abshar `_ +- `Abubakar Alaya `_ - `Alateas `_ - `Ales Dokshanin `_ - `Alexandre `_ @@ -30,6 +31,7 @@ The following wonderful people contributed directly or indirectly to this projec - `Ambro17 `_ - `Andrej Zhilenkov `_ - `Anton Tagunov `_ +- `Anya Marcano ` - `Avanatiker `_ - `Balduro `_ - `Bibo-Joshi `_ @@ -57,12 +59,14 @@ The following wonderful people contributed directly or indirectly to this projec - `gamgi `_ - `Gauthamram Ravichandran `_ - `Harshil `_ +- `Henry Galue ` - `Hugo Damer `_ - `ihoru `_ - `Iulian Onofrei `_ - `Jainam Oswal `_ - `Jasmin Bom `_ - `JASON0916 `_ +- `Jeamhowards Montiel ` - `jeffffc `_ - `Jelle Besseling `_ - `jh0ker `_ @@ -71,6 +75,7 @@ The following wonderful people contributed directly or indirectly to this projec - `Joscha Götzer `_ - `jossalgon `_ - `JRoot3D `_ +- `Juan Cuevas ` - `kenjitagawa `_ - `kennethcheo `_ - `Kirill Vasin `_ @@ -80,13 +85,16 @@ The following wonderful people contributed directly or indirectly to this projec - `LRezende `_ - `Luca Bellanti `_ - `Lucas Molinari `_ +- `Luis Pérez `_ - `macrojames `_ - `Matheus Lemos `_ - `Michael Dix `_ - `Michael Elovskikh `_ - `Miguel C. R. `_ +- `Miguel Salomon ` - `miles `_ - `Mischa Krüger `_ +- `Mohd Yusuf `_ - `naveenvhegde `_ - `neurrone `_ - `NikitaPirate `_ @@ -97,6 +105,7 @@ The following wonderful people contributed directly or indirectly to this projec - `Oleg Sushchenko `_ - `Or Bin `_ - `overquota `_ +- `Pablo Martinez `_ - `Paradox `_ - `Patrick Hofmann `_ - `Paul Larsen `_ @@ -108,11 +117,13 @@ The following wonderful people contributed directly or indirectly to this projec - `Rahiel Kasim `_ - `Riko Naka `_ - `Rizlas `_ +- `Snehashish Biswas `_ - `Sahil Sharma `_ - `Sam Mosleh `_ - `Sascha `_ - `Shelomentsev D `_ - `Shivam Saini `_ +- `Siloé Garcez `_ - `Simon Schürrle `_ - `sooyhwang `_ - `syntx `_ diff --git a/CHANGES.rst b/CHANGES.rst index f56a61b9b0c..9ae55984ad7 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -4,6 +4,182 @@ Changelog ========= +Version 21.9 +============ + +*Released 2024-12-07* + +This is the technical changelog for version 21.9. More elaborate release notes can be found in the news channel `@pythontelegrambotchannel `_. + +Major Changes +------------- + +- Full Support for Bot API 8.1 (:pr:`4594` closes :issue:`4592`) + +Minor Changes +------------- + +- Use ``MessageLimit.DEEP_LINK_LENGTH`` in ``helpers.create_deep_linked_url`` (:pr:`4597` by `nemacysts `_) +- Allow ``Sequence`` Input for ``allowed_updates`` in ``Application`` and ``Updater`` Methods (:pr:`4589` by `nemacysts `_) + +Dependency Updates +------------------ + +- Update ``aiolimiter`` requirement from ~=1.1.0 to >=1.1,<1.3 (:pr:`4595`) +- Bump ``pytest`` from 8.3.3 to 8.3.4 (:pr:`4596`) +- Bump ``codecov/codecov-action`` from 4 to 5 (:pr:`4585`) +- Bump ``pylint`` to v3.3.2 to Improve Python 3.13 Support (:pr:`4590` by `nemacysts `_) +- Bump ``srvaroa/labeler`` from 1.11.1 to 1.12.0 (:pr:`4586`) + +Version 21.8 +============ +*Released 2024-12-01* + +This is the technical changelog for version 21.8. More elaborate release notes can be found in the news channel `@pythontelegrambotchannel `_. + +Major Changes +------------- + +- Full Support for Bot API 8.0 (:pr:`4568`, :pr:`4566` closes :issue:`4567`, :pr:`4572`, :pr:`4571`, :pr:`4570`, :pr:`4576`, :pr:`4574`) + +Documentation Improvements +-------------------------- + +- Documentation Improvements (:pr:`4565` by `Snehashish06 `_, :pr:`4573`) + +Version 21.7 +============ +*Released 2024-11-04* + +This is the technical changelog for version 21.7. More elaborate release notes can be found in the news channel `@pythontelegrambotchannel `_. + +Major Changes +------------- + +- Full Support for Bot API 7.11 (:pr:`4546` closes :issue:`4543`) +- Add ``Message.reply_paid_media`` (:pr:`4551`) +- Drop Support for Python 3.8 (:pr:`4398` by `elpekenin `_) + +Minor Changes +------------- + +- Allow ``Sequence`` in ``Application.add_handlers`` (:pr:`4531` by `roast-lord `_ closes :issue:`4530`) +- Improve Exception Handling in ``File.download_*`` (:pr:`4542`) +- Use Stable Python 3.13 Release in Test Suite (:pr:`4535`) + +Documentation Improvements +-------------------------- + +- Documentation Improvements (:pr:`4536` by `Ecode2 `_, :pr:`4556`) +- Fix Linkcheck Workflow (:pr:`4545`) +- Use ``sphinx-build-compatibility`` to Keep Sphinx Compatibility (:pr:`4492`) + +Internal Changes +---------------- + +- Improve Test Instability Caused by ``Message`` Fixtures (:pr:`4507`) +- Stabilize Some Flaky Tests (:pr:`4500`) +- Reduce Creation of HTTP Clients in Tests (:pr:`4493`) +- Update ``pytest-xdist`` Usage (:pr:`4491`) +- Fix Failing Tests by Making Them Independent (:pr:`4494`) +- Introduce Codecov's Test Analysis (:pr:`4487`) +- Maintenance Work on ``Bot`` Tests (:pr:`4489`) +- Introduce ``conftest.py`` for File Related Tests (:pr:`4488`) +- Update Issue Templates to Use Issue Types (:pr:`4553`) +- Update Automation to Label Changes (:pr:`4552`) + +Dependency Updates +------------------ + +- Bump ``srvaroa/labeler`` from 1.11.0 to 1.11.1 (:pr:`4549`) +- Bump ``sphinx`` from 8.0.2 to 8.1.3 (:pr:`4532`) +- Bump ``sphinxcontrib-mermaid`` from 0.9.2 to 1.0.0 (:pr:`4529`) +- Bump ``srvaroa/labeler`` from 1.10.1 to 1.11.0 (:pr:`4509`) +- Bump ``Bibo-Joshi/pyright-type-completeness`` from 1.0.0 to 1.0.1 (:pr:`4510`) + +Version 21.6 +============ + +*Released 2024-09-19* + +This is the technical changelog for version 21.6. More elaborate release notes can be found in the news channel `@pythontelegrambotchannel `_. + +New Features +------------ + +- Full Support for Bot API 7.10 (:pr:`4461` closes :issue:`4459`, :pr:`4460`, :pr:`4463` by `aelkheir `_, :pr:`4464`) +- Add Parameter ``httpx_kwargs`` to ``HTTPXRequest`` (:pr:`4451` closes :issue:`4424`) + +Minor Changes +------------- + +- Improve Type Completeness (:pr:`4466`) + +Internal Changes +---------------- + +- Update Python 3.13 Test Suite to RC2 (:pr:`4471`) +- Enforce the ``offline_bot`` Fixture in ``Test*WithoutRequest`` (:pr:`4465`) +- Make Tests for ``telegram.ext`` Independent of Networking (:pr:`4454`) +- Rename Testing Base Classes (:pr:`4453`) + +Dependency Updates +------------------ + +- Bump ``pytest`` from 8.3.2 to 8.3.3 (:pr:`4475`) + +Version 21.5 +============ + +*Released 2024-09-01* + +This is the technical changelog for version 21.5. More elaborate release notes can be found in the news channel `@pythontelegrambotchannel `_. + +Major Changes +------------- + +- Full Support for Bot API 7.9 (:pr:`4429`) +- Full Support for Bot API 7.8 (:pr:`4408`) + +New Features +------------ + +- Add ``MessageEntity.shift_entities`` and ``MessageEntity.concatenate`` (:pr:`4376` closes :issue:`4372`) +- Add Parameter ``game_pattern`` to ``CallbackQueryHandler`` (:pr:`4353` by `jainamoswal `_ closes :issue:`4269`) +- Add Parameter ``read_file_handle`` to ``InputFile`` (:pr:`4388` closes :issue:`4339`) + +Documentation Improvements +-------------------------- + +- Bugfix for "Available In" Admonitions (:pr:`4413`) +- Documentation Improvements (:pr:`4400` closes :issue:`4446`, :pr:`4448` by `Palaptin `_) +- Document Return Types of ``RequestData`` Members (:pr:`4396`) +- Add Introductory Paragraphs to Telegram Types Subsections (:pr:`4389` by `mohdyusuf2312 `_ closes :issue:`4380`) +- Start Adapting to RTD Addons (:pr:`4386`) + +Minor and Internal Changes +--------------------------- + +- Remove Surplus Logging from ``Updater`` Network Loop (:pr:`4432` by `MartinHjelmare `_) +- Add Internal Constants for Encodings (:pr:`4378` by `elpekenin `_) +- Improve PyPI Automation (:pr:`4375` closes :issue:`4373`) +- Update Test Suite to New Test Channel Setup (:pr:`4435`) +- Improve Fixture Usage in ``test_message.py`` (:pr:`4431` by `Palaptin `_) +- Update Python 3.13 Test Suite to RC1 (:pr:`4415`) +- Bump ``ruff`` and Add New Rules (:pr:`4416`) + +Dependency Updates +------------------ + +- Update ``cachetools`` requirement from <5.5.0,>=5.3.3 to >=5.3.3,<5.6.0 (:pr:`4437`) +- Bump ``sphinx`` from 7.4.7 to 8.0.2 and ``furo`` from 2024.7.18 to 2024.8.6 (:pr:`4412`) +- Bump ``test-summary/action`` from 2.3 to 2.4 (:pr:`4410`) +- Bump ``pytest`` from 8.2.2 to 8.3.2 (:pr:`4403`) +- Bump ``dependabot/fetch-metadata`` from 2.1.0 to 2.2.0 (:pr:`4411`) +- Update ``cachetools`` requirement from ~=5.3.3 to >=5.3.3,<5.5.0 (:pr:`4390`) +- Bump ``sphinx`` from 7.3.7 to 7.4.7 (:pr:`4395`) +- Bump ``furo`` from 2024.5.6 to 2024.7.18 (:pr:`4392`) + Version 21.4 ============ diff --git a/README.rst b/README.rst index 09b01d923a8..3721a834fd0 100644 --- a/README.rst +++ b/README.rst @@ -11,7 +11,7 @@ :target: https://pypi.org/project/python-telegram-bot/ :alt: Supported Python versions -.. image:: https://img.shields.io/badge/Bot%20API-7.7-blue?logo=telegram +.. image:: https://img.shields.io/badge/Bot%20API-8.1-blue?logo=telegram :target: https://core.telegram.org/bots/api-changelog :alt: Supported Bot API version @@ -70,7 +70,7 @@ Introduction This library provides a pure Python, asynchronous interface for the `Telegram Bot API `_. -It's compatible with Python versions **3.8+**. +It's compatible with Python versions **3.9+**. In addition to the pure API implementation, this library features several convenience methods and shortcuts as well as a number of high-level classes to make the development of bots easy and straightforward. These classes are contained in the @@ -81,7 +81,7 @@ After installing_ the library, be sure to check out the section on `working with Telegram API support ~~~~~~~~~~~~~~~~~~~~ -All types and methods of the Telegram Bot API **7.7** are natively supported by this library. +All types and methods of the Telegram Bot API **8.1** are natively supported by this library. In addition, Bot API functionality not yet natively included can still be used as described `in our wiki `_. Notable Features @@ -119,9 +119,9 @@ Verifying Releases To enable you to verify that a release file that you downloaded was indeed provided by the ``python-telegram-bot`` team, we have taken the following measures. -Starting with v21.4, all releases are signed via `sigstore `_. +Starting with v21.4, all releases are signed via `sigstore `_. The corresponding signature files are uploaded to the `GitHub releases page`_. -To verify the signature, please install the `sigstore Python client `_ and follow the instructions for `verifying signatures from GitHub Actions `_. As input for the ``--repository`` parameter, please use the value ``python-telegram-bot/python-telegram-bot``. +To verify the signature, please install the `sigstore Python client `_ and follow the instructions for `verifying signatures from GitHub Actions `_. As input for the ``--repository`` parameter, please use the value ``python-telegram-bot/python-telegram-bot``. Earlier releases are signed with a GPG key. The signatures are uploaded to both the `GitHub releases page`_ and the `PyPI project `_ and end with a suffix ``.asc``. @@ -155,9 +155,9 @@ PTB can be installed with optional dependencies: * ``pip install "python-telegram-bot[passport]"`` installs the `cryptography>=39.0.1 `_ library. Use this, if you want to use Telegram Passport related functionality. * ``pip install "python-telegram-bot[socks]"`` installs `httpx[socks] `_. Use this, if you want to work behind a Socks5 server. * ``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.0 `_. Use this, if you want to use ``telegram.ext.AIORateLimiter``. +* ``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 `_ library. Use this, if you want to use `arbitrary callback_data `_. +* ``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[job-queue]"`` installs the `APScheduler~=3.10.4 `_ library and enforces `pytz>=2018.6 `_, where ``pytz`` is a dependency of ``APScheduler``. 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]"``. @@ -230,6 +230,6 @@ License ------- You may copy, distribute and modify the software provided that modifications are described and licensed for free under `LGPL-3 `_. -Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL-3, but applications that use the library don't have to be. +Derivative works (including modifications or anything statically linked to the library) can only be redistributed under LGPL-3, but applications that use the library don't have to be. -.. _`GitHub releases page`: https://github.com/python-telegram-bot/python-telegram-bot/releases> \ No newline at end of file +.. _`GitHub releases page`: https://github.com/python-telegram-bot/python-telegram-bot/releases diff --git a/docs/auxil/admonition_inserter.py b/docs/auxil/admonition_inserter.py index 4227a845382..268b8e7e7b4 100644 --- a/docs/auxil/admonition_inserter.py +++ b/docs/auxil/admonition_inserter.py @@ -20,7 +20,8 @@ import re import typing from collections import defaultdict -from typing import Any, Iterator, Union +from collections.abc import Iterator +from typing import Any, Union import telegram import telegram.ext @@ -140,7 +141,7 @@ def _create_available_in(self) -> dict[type, str]: r"^\s*(?P[a-z_]+)" # Any number of spaces, named group for attribute r"\s?\(" # Optional whitespace, opening parenthesis r".*" # Any number of characters (that could denote a built-in type) - r":class:`.+`" # Marker of a classref, class name in backticks + r":(class|obj):`.+`" # Marker of a classref, class name in backticks r".*\):" # Any number of characters, closing parenthesis, colon. # The ^ colon above along with parenthesis is important because it makes sure that # the class is mentioned in the attribute description, not in free text. @@ -149,11 +150,11 @@ def _create_available_in(self) -> dict[type, str]: ) # for properties: there is no attr name in docstring. Just check if there's a class name. - prop_docstring_pattern = re.compile(r":class:`.+`.*:") + prop_docstring_pattern = re.compile(r":(class|obj):`.+`.*:") # pattern for iterating over potentially many class names in docstring for one attribute. # Tilde is optional (sometimes it is in the docstring, sometimes not). - single_class_name_pattern = re.compile(r":class:`~?(?P[\w.]*)`") + single_class_name_pattern = re.compile(r":(class|obj):`~?(?P[\w.]*)`") classes_to_inspect = inspect.getmembers(telegram, inspect.isclass) + inspect.getmembers( telegram.ext, inspect.isclass @@ -366,6 +367,7 @@ def _find_insert_pos_for_admonition(lines: list[str]) -> int: # to ".. admonition: Examples": ".. admonition:: Examples", ".. version", + "Args:", # The space after ":param" is important because docstring can contain # ":paramref:" in its plain text in the beginning of a line (e.g. ExtBot): ":param ", diff --git a/docs/auxil/kwargs_insertion.py b/docs/auxil/kwargs_insertion.py index ffb2ada137a..7bc4a9e0110 100644 --- a/docs/auxil/kwargs_insertion.py +++ b/docs/auxil/kwargs_insertion.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/]. import inspect -from typing import List keyword_args = [ "Keyword Arguments:", @@ -85,7 +84,7 @@ ] -def find_insert_pos_for_kwargs(lines: List[str]) -> int: +def find_insert_pos_for_kwargs(lines: list[str]) -> int: """Finds the correct position to insert the keyword arguments and returns the index.""" for idx, value in reversed(list(enumerate(lines))): # reversed since :returns: is at the end if value.startswith("Returns"): diff --git a/docs/auxil/link_code.py b/docs/auxil/link_code.py index 8c20f34b4af..f451dc50281 100644 --- a/docs/auxil/link_code.py +++ b/docs/auxil/link_code.py @@ -21,7 +21,6 @@ """ import subprocess from pathlib import Path -from typing import Dict, Tuple from sphinx.util import logging @@ -32,7 +31,7 @@ # must be a module-level variable so that it can be written to by the `autodoc-process-docstring` # event handler in `sphinx_hooks.py` -LINE_NUMBERS: Dict[str, Tuple[Path, int, int]] = {} +LINE_NUMBERS: dict[str, tuple[Path, int, int]] = {} def _git_branch() -> str: diff --git a/docs/auxil/sphinx_hooks.py b/docs/auxil/sphinx_hooks.py index 2cfbfe14049..dd0bf3aac31 100644 --- a/docs/auxil/sphinx_hooks.py +++ b/docs/auxil/sphinx_hooks.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 collections.abc +import contextlib import inspect import re import typing @@ -153,13 +154,11 @@ def autodoc_process_docstring( if isinstance(obj, telegram.ext.filters.BaseFilter): obj = obj.__class__ - try: + with contextlib.suppress(Exception): source_lines, start_line = inspect.getsourcelines(obj) end_line = start_line + len(source_lines) file = Path(inspect.getsourcefile(obj)).relative_to(FILE_ROOT) LINE_NUMBERS[name] = (file, start_line, end_line) - except Exception: - pass # Since we don't document the `__init__`, we call this manually to have it available for # attributes -- see the note above @@ -188,6 +187,11 @@ def autodoc_process_bases(app, name, obj, option, bases: list) -> None: bases[idx] = ":class:`enum.IntEnum`" continue + if "FloatEnum" in base: + bases[idx] = ":class:`enum.Enum`" + bases.insert(0, ":class:`float`") + continue + # Drop generics (at least for now) if base.endswith("]"): base = base.split("[", maxsplit=1)[0] diff --git a/docs/auxil/tg_const_role.py b/docs/auxil/tg_const_role.py index d4d5961ad7f..ee1b4051a78 100644 --- a/docs/auxil/tg_const_role.py +++ b/docs/auxil/tg_const_role.py @@ -15,7 +15,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 +import datetime as dtm from enum import Enum from docutils.nodes import Element @@ -75,7 +75,7 @@ def process_link( ): return str(value), target if ( - isinstance(value, datetime.datetime) + isinstance(value, dtm.datetime) and value == telegram.constants.ZERO_DATE and target in ("telegram.constants.ZERO_DATE",) ): @@ -88,7 +88,6 @@ def process_link( refnode.rawsource, CONSTANTS_ROLE, ) - return title, target except Exception as exc: sphinx_logger.exception( "%s:%d: WARNING: Did not convert reference %s due to an exception.", @@ -98,3 +97,5 @@ def process_link( exc_info=exc, ) return title, target + else: + return title, target diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 08fba15d32f..ab62b887813 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1,7 +1,9 @@ -sphinx==7.3.7 -furo==2024.5.6 +sphinx==8.1.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==0.9.2 +sphinxcontrib-mermaid==1.0.0 sphinx-copybutton==0.5.2 -sphinx-inline-tabs==2023.4.21 \ No newline at end of file +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 5858a79e2da..f54a3a4c7d8 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,3 +1,4 @@ +import os import re import sys from pathlib import Path @@ -29,7 +30,7 @@ release = telegram.__version__ # If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = "6.1.3" +needs_sphinx = "8.1.3" # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom @@ -47,6 +48,10 @@ "sphinx_search.extension", ] +# Temporary. See #4387 +if os.environ.get("READTHEDOCS", "") == "True": + extensions.append("sphinx_build_compatibility.extension") + # For shorter links to Wiki in docstrings extlinks = { "wiki": ("https://github.com/python-telegram-bot/python-telegram-bot/wiki/%s", "%s"), @@ -251,7 +256,14 @@ # The base URL which points to the root of the HTML documentation. It is used to indicate the # location of document using The Canonical Link Relation. Default: ''. -html_baseurl = "https://docs.python-telegram-bot.org" +# Set canonical URL from the Read the Docs Domain +html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "") + +# Tell Jinja2 templates the build is running on Read the Docs +html_context = {} +if os.environ.get("READTHEDOCS", "") == "True": + html_context["READTHEDOCS"] = True + # -- Options for LaTeX output --------------------------------------------- diff --git a/docs/source/inclusions/bot_methods.rst b/docs/source/inclusions/bot_methods.rst index 3189de1c1d3..b8501d8b2c7 100644 --- a/docs/source/inclusions/bot_methods.rst +++ b/docs/source/inclusions/bot_methods.rst @@ -25,6 +25,8 @@ - Used for sending documents * - :meth:`~telegram.Bot.send_game` - Used for sending a game + * - :meth:`~telegram.Bot.send_gift` + - Used for sending a gift * - :meth:`~telegram.Bot.send_invoice` - Used for sending an invoice * - :meth:`~telegram.Bot.send_location` @@ -151,6 +153,8 @@ - Used for setting a chat title * - :meth:`~telegram.Bot.set_chat_description` - Used for setting the description of a chat + * - :meth:`~telegram.Bot.set_user_emoji_status` + - Used for setting the users status emoji * - :meth:`~telegram.Bot.pin_chat_message` - Used for pinning a message * - :meth:`~telegram.Bot.unpin_chat_message` @@ -355,7 +359,7 @@ .. raw:: html
- Miscellaneous + Payments and Stars .. list-table:: :align: left @@ -363,18 +367,39 @@ * - :meth:`~telegram.Bot.create_invoice_link` - Used to generate an HTTP link for an invoice + * - :meth:`~telegram.Bot.edit_user_star_subscription` + - Used for editing a user's star subscription + * - :meth:`~telegram.Bot.get_star_transactions` + - Used for obtaining the bot's Telegram Stars transactions + * - :meth:`~telegram.Bot.refund_star_payment` + - Used for refunding a payment in Telegram Stars + +.. raw:: html + +
+
+ +.. raw:: html + +
+ Miscellaneous + +.. list-table:: + :align: left + :widths: 1 4 + * - :meth:`~telegram.Bot.close` - Used for closing server instance when switching to another local server * - :meth:`~telegram.Bot.log_out` - Used for logging out from cloud Bot API server * - :meth:`~telegram.Bot.get_file` - Used for getting basic info about a file + * - :meth:`~telegram.Bot.get_available_gifts` + - Used for getting information about gifts available for sending * - :meth:`~telegram.Bot.get_me` - Used for getting basic information about the bot - * - :meth:`~telegram.Bot.get_star_transactions` - - Used for obtaining the bot's Telegram Stars transactions - * - :meth:`~telegram.Bot.refund_star_payment` - - Used for refunding a payment in Telegram Stars + * - :meth:`~telegram.Bot.save_prepared_inline_message` + - Used for storing a message to be sent by a user of a Mini App .. raw:: html diff --git a/docs/source/telegram.affiliateinfo.rst b/docs/source/telegram.affiliateinfo.rst new file mode 100644 index 00000000000..0b2e51863af --- /dev/null +++ b/docs/source/telegram.affiliateinfo.rst @@ -0,0 +1,6 @@ +AffiliateInfo +============= + +.. autoclass:: telegram.AffiliateInfo + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.at-tree.rst b/docs/source/telegram.at-tree.rst index 8d3238a27e4..22abbfb3867 100644 --- a/docs/source/telegram.at-tree.rst +++ b/docs/source/telegram.at-tree.rst @@ -29,6 +29,7 @@ Available Types telegram.chat telegram.chatadministratorrights telegram.chatbackground + telegram.copytextbutton telegram.backgroundtype telegram.backgroundtypefill telegram.backgroundtypewallpaper @@ -92,7 +93,6 @@ Available Types telegram.inputpaidmediaphoto telegram.inputpaidmediavideo telegram.inputpolloption - telegram.inputsticker telegram.keyboardbutton telegram.keyboardbuttonpolltype telegram.keyboardbuttonrequestchat @@ -120,6 +120,7 @@ Available Types telegram.paidmediainfo telegram.paidmediaphoto telegram.paidmediapreview + telegram.paidmediapurchased telegram.paidmediavideo telegram.photosize telegram.poll @@ -130,6 +131,7 @@ Available Types telegram.reactiontype telegram.reactiontypecustomemoji telegram.reactiontypeemoji + telegram.reactiontypepaid telegram.replykeyboardmarkup telegram.replykeyboardremove telegram.replyparameters diff --git a/docs/source/telegram.constants.rst b/docs/source/telegram.constants.rst index 4b5edf51094..ef1e6720107 100644 --- a/docs/source/telegram.constants.rst +++ b/docs/source/telegram.constants.rst @@ -5,5 +5,5 @@ telegram.constants Module :members: :show-inheritance: :no-undoc-members: - :inherited-members: Enum, EnumMeta, str, int + :inherited-members: Enum, EnumMeta, str, int, float :exclude-members: __format__, __new__, __repr__, __str__ diff --git a/docs/source/telegram.copytextbutton.rst b/docs/source/telegram.copytextbutton.rst new file mode 100644 index 00000000000..7110fbf8b6b --- /dev/null +++ b/docs/source/telegram.copytextbutton.rst @@ -0,0 +1,6 @@ +CopyTextButton +============== + +.. autoclass:: telegram.CopyTextButton + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.ext.handlers-tree.rst b/docs/source/telegram.ext.handlers-tree.rst index 6749cacb9dd..72e0d824c53 100644 --- a/docs/source/telegram.ext.handlers-tree.rst +++ b/docs/source/telegram.ext.handlers-tree.rst @@ -18,6 +18,7 @@ Handlers telegram.ext.inlinequeryhandler telegram.ext.messagehandler telegram.ext.messagereactionhandler + telegram.ext.paidmediapurchasedhandler telegram.ext.pollanswerhandler telegram.ext.pollhandler telegram.ext.precheckoutqueryhandler diff --git a/docs/source/telegram.ext.paidmediapurchasedhandler.rst b/docs/source/telegram.ext.paidmediapurchasedhandler.rst new file mode 100644 index 00000000000..19bfbeea31e --- /dev/null +++ b/docs/source/telegram.ext.paidmediapurchasedhandler.rst @@ -0,0 +1,6 @@ +PaidMediaPurchasedHandler +========================= + +.. autoclass:: telegram.ext.PaidMediaPurchasedHandler + :members: + :show-inheritance: diff --git a/docs/source/telegram.games-tree.rst b/docs/source/telegram.games-tree.rst index 64f399d86a9..97b961a9e85 100644 --- a/docs/source/telegram.games-tree.rst +++ b/docs/source/telegram.games-tree.rst @@ -1,6 +1,21 @@ +.. _games-tree: + Games ----- +Your bot can offer users **HTML5 games** to play solo or to compete against each other in groups and one-on-one chats. Create games via `@BotFather `_ using the ``/newgame`` command. Please note that this kind of power requires responsibility: you will need to accept the terms for each game that your bots will be offering. + +* Games are a new type of content on Telegram, represented by the :class:`telegram.Game` and :class:`telegram.InlineQueryResultGame` objects. +* Once you've created a game via `BotFather `_, you can send games to chats as regular messages using the :meth:`~telegram.Bot.sendGame` method, or use :ref:`inline mode ` with :class:`telegram.InlineQueryResultGame`. +* If you send the game message without any buttons, it will automatically have a 'Play ``GameName``' button. When this button is pressed, your bot gets a :class:`telegram.CallbackQuery` with the ``game_short_name`` of the requested game. You provide the correct URL for this particular user and the app opens the game in the in-app browser. +* You can manually add multiple buttons to your game message. Please note that the first button in the first row **must always** launch the game, using the field ``callback_game`` in :class:`telegram.InlineKeyboardButton`. You can add extra buttons according to taste: e.g., for a description of the rules, or to open the game's official community. +* To make your game more attractive, you can upload a GIF animation that demonstrates the game to the users via `BotFather `_ (see `Lumberjack `_ for example). +* A game message will also display high scores for the current chat. Use :meth:`~telegram.Bot.setGameScore` to post high scores to the chat with the game, add the :paramref:`~telegram.Bot.set_game_score.disable_edit_message` parameter to disable automatic update of the message with the current scoreboard. +* Use :meth:`~telegram.Bot.getGameHighScores` to get data for in-game high score tables. +* You can also add an extra sharing button for users to share their best score to different chats. +* For examples of what can be done using this new stuff, check the `@gamebot `_ and `@gamee `_ bots. + + .. toctree:: :titlesonly: diff --git a/docs/source/telegram.gift.rst b/docs/source/telegram.gift.rst new file mode 100644 index 00000000000..e42cb720ac2 --- /dev/null +++ b/docs/source/telegram.gift.rst @@ -0,0 +1,6 @@ +Gift +==== + +.. autoclass:: telegram.Gift + :members: + :show-inheritance: diff --git a/docs/source/telegram.gifts.rst b/docs/source/telegram.gifts.rst new file mode 100644 index 00000000000..649522d0dce --- /dev/null +++ b/docs/source/telegram.gifts.rst @@ -0,0 +1,6 @@ +Gifts +===== + +.. autoclass:: telegram.Gifts + :members: + :show-inheritance: diff --git a/docs/source/telegram.inline-tree.rst b/docs/source/telegram.inline-tree.rst index 7fa52a94b58..c21b3c33828 100644 --- a/docs/source/telegram.inline-tree.rst +++ b/docs/source/telegram.inline-tree.rst @@ -1,6 +1,14 @@ +.. _inline-tree: + Inline Mode ----------- +The following methods and objects allow your bot to work in `inline mode `_. +Please see Telegrams `Introduction to Inline bots `_ for more details. + +To enable this option, send the ``/setinline`` command to `@BotFather `_ and provide the placeholder text that the user will see in the input field after typing your bot's name. + + .. toctree:: :titlesonly: @@ -34,3 +42,4 @@ Inline Mode telegram.inputvenuemessagecontent telegram.inputcontactmessagecontent telegram.inputinvoicemessagecontent + telegram.preparedinlinemessage diff --git a/docs/source/telegram.paidmediapurchased.rst b/docs/source/telegram.paidmediapurchased.rst new file mode 100644 index 00000000000..80568ae405c --- /dev/null +++ b/docs/source/telegram.paidmediapurchased.rst @@ -0,0 +1,6 @@ +PaidMediaPurchased +================== + +.. autoclass:: telegram.PaidMediaPurchased + :members: + :show-inheritance: diff --git a/docs/source/telegram.passport-tree.rst b/docs/source/telegram.passport-tree.rst index fb4e3b4ffde..079ce948924 100644 --- a/docs/source/telegram.passport-tree.rst +++ b/docs/source/telegram.passport-tree.rst @@ -1,6 +1,9 @@ Passport -------- +Passport is a unified authorization method for services that require personal identification. Users can upload their documents once, then instantly share their data with services that require real-world ID (finance, ICOs, etc.). Please see the `manual `_ for details. + + .. toctree:: :titlesonly: diff --git a/docs/source/telegram.payments-tree.rst b/docs/source/telegram.payments-tree.rst index 0db0ba21959..e8ec7bd3e3b 100644 --- a/docs/source/telegram.payments-tree.rst +++ b/docs/source/telegram.payments-tree.rst @@ -1,9 +1,15 @@ +.. _payments-tree: + Payments -------- +Your bot can accept payments from Telegram users. Please see the `introduction to payments `_ for more details on the process and how to set up payments for your bot. + + .. toctree:: :titlesonly: + telegram.affiliateinfo telegram.invoice telegram.labeledprice telegram.orderinfo @@ -20,7 +26,9 @@ Payments telegram.startransactions telegram.successfulpayment telegram.transactionpartner + telegram.transactionpartneraffiliateprogram telegram.transactionpartnerfragment telegram.transactionpartnerother telegram.transactionpartnertelegramads + telegram.transactionpartnertelegramapi telegram.transactionpartneruser diff --git a/docs/source/telegram.preparedinlinemessage.rst b/docs/source/telegram.preparedinlinemessage.rst new file mode 100644 index 00000000000..2522f8c58cf --- /dev/null +++ b/docs/source/telegram.preparedinlinemessage.rst @@ -0,0 +1,6 @@ +PreparedInlineMessage +===================== + +.. autoclass:: telegram.PreparedInlineMessage + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.reactiontypepaid.rst b/docs/source/telegram.reactiontypepaid.rst new file mode 100644 index 00000000000..f5035a1ba5b --- /dev/null +++ b/docs/source/telegram.reactiontypepaid.rst @@ -0,0 +1,6 @@ +ReactionTypePaid +================ + +.. autoclass:: telegram.ReactionTypePaid + :members: + :show-inheritance: diff --git a/docs/source/telegram.stickers-tree.rst b/docs/source/telegram.stickers-tree.rst index 783b90ec0c7..e45dcacb56b 100644 --- a/docs/source/telegram.stickers-tree.rst +++ b/docs/source/telegram.stickers-tree.rst @@ -1,9 +1,14 @@ Stickers -------- +The following methods and objects allow your bot to handle stickers and sticker sets. + .. toctree:: :titlesonly: + telegram.gift + telegram.gifts + telegram.inputsticker telegram.maskposition telegram.sticker telegram.stickerset diff --git a/docs/source/telegram.transactionpartneraffiliateprogram.rst b/docs/source/telegram.transactionpartneraffiliateprogram.rst new file mode 100644 index 00000000000..dfcab6ec22b --- /dev/null +++ b/docs/source/telegram.transactionpartneraffiliateprogram.rst @@ -0,0 +1,6 @@ +TransactionPartnerAffiliateProgram +=================================== + +.. autoclass:: telegram.TransactionPartnerAffiliateProgram + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.transactionpartnerfragment.rst b/docs/source/telegram.transactionpartnerfragment.rst index 0845b4a800b..c65f9262f81 100644 --- a/docs/source/telegram.transactionpartnerfragment.rst +++ b/docs/source/telegram.transactionpartnerfragment.rst @@ -4,4 +4,4 @@ TransactionPartnerFragment .. autoclass:: telegram.TransactionPartnerFragment :members: :show-inheritance: - :inherited-members: TelegramObject + :inherited-members: TransactionPartner diff --git a/docs/source/telegram.transactionpartnerother.rst b/docs/source/telegram.transactionpartnerother.rst index c3ffddc7de0..b0c14f0713c 100644 --- a/docs/source/telegram.transactionpartnerother.rst +++ b/docs/source/telegram.transactionpartnerother.rst @@ -4,4 +4,4 @@ TransactionPartnerOther .. autoclass:: telegram.TransactionPartnerOther :members: :show-inheritance: - :inherited-members: TelegramObject + :inherited-members: TransactionPartner diff --git a/docs/source/telegram.transactionpartnertelegramads.rst b/docs/source/telegram.transactionpartnertelegramads.rst index 926b25bdcd4..ce9a52a117f 100644 --- a/docs/source/telegram.transactionpartnertelegramads.rst +++ b/docs/source/telegram.transactionpartnertelegramads.rst @@ -4,4 +4,4 @@ TransactionPartnerTelegramAds .. autoclass:: telegram.TransactionPartnerTelegramAds :members: :show-inheritance: - :inherited-members: TelegramObject + :inherited-members: TransactionPartner diff --git a/docs/source/telegram.transactionpartnertelegramapi.rst b/docs/source/telegram.transactionpartnertelegramapi.rst new file mode 100644 index 00000000000..9aeba6b94b8 --- /dev/null +++ b/docs/source/telegram.transactionpartnertelegramapi.rst @@ -0,0 +1,7 @@ +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 d2e145e1866..def37495344 100644 --- a/docs/source/telegram.transactionpartneruser.rst +++ b/docs/source/telegram.transactionpartneruser.rst @@ -4,4 +4,4 @@ TransactionPartnerUser .. autoclass:: telegram.TransactionPartnerUser :members: :show-inheritance: - :inherited-members: TelegramObject + :inherited-members: TransactionPartner diff --git a/docs/substitutions/global.rst b/docs/substitutions/global.rst index c4e9e493bb3..b71ac1f0eac 100644 --- a/docs/substitutions/global.rst +++ b/docs/substitutions/global.rst @@ -60,10 +60,12 @@ .. |removed_thumb_note| replace:: Removed the deprecated argument and attribute ``thumb``. -.. |removed_thumb_url_note| replace:: Removed the deprecated argument and attribute ``thumb_url``. +.. |removed_thumb_url_note| replace:: Removed the deprecated argument and attribute ``thumb_url`` which made thumbnail_url mandatory. .. |removed_thumb_wildcard_note| replace:: Removed the deprecated arguments and attributes ``thumb_*``. +.. |thumbnail_url_mandatory| replace:: Removal of the deprecated argument ``thumb_url`` made ``thumbnail_url`` mandatory. + .. |async_context_manager| replace:: Asynchronous context manager which .. |reply_parameters| replace:: Description of the message to reply to. @@ -91,3 +93,7 @@ .. |show_cap_above_med| replace:: :obj:`True`, if the caption must be shown above the message media. .. |tg_stars| replace:: `Telegram Stars `__ + +.. |allow_paid_broadcast| replace:: Pass True to allow up to :tg-const:`telegram.constants.FloodLimit.PAID_MESSAGES_PER_SECOND` messages per second, ignoring `broadcasting limits `__ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. + +.. |tz-naive-dtms| replace:: For timezone naive :obj:`datetime.datetime` objects, the default timezone of the bot will be used, which is UTC unless :attr:`telegram.ext.Defaults.tzinfo` is used. \ No newline at end of file diff --git a/examples/arbitrarycallbackdatabot.py b/examples/arbitrarycallbackdatabot.py index cf3d46fa91b..e11620c1670 100644 --- a/examples/arbitrarycallbackdatabot.py +++ b/examples/arbitrarycallbackdatabot.py @@ -12,7 +12,7 @@ `pip install "python-telegram-bot[callback-data]"` """ import logging -from typing import List, Tuple, cast +from typing import cast from telegram import InlineKeyboardButton, InlineKeyboardMarkup, Update from telegram.ext import ( @@ -36,7 +36,7 @@ async def start(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None: """Sends a message with 5 inline buttons attached.""" - number_list: List[int] = [] + number_list: list[int] = [] await update.message.reply_text("Please choose:", reply_markup=build_keyboard(number_list)) @@ -55,7 +55,7 @@ async def clear(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None: await update.effective_message.reply_text("All clear!") -def build_keyboard(current_list: List[int]) -> InlineKeyboardMarkup: +def build_keyboard(current_list: list[int]) -> InlineKeyboardMarkup: """Helper function to build the next inline keyboard.""" return InlineKeyboardMarkup.from_column( [InlineKeyboardButton(str(i), callback_data=(i, current_list)) for i in range(1, 6)] @@ -69,7 +69,7 @@ async def list_button(update: Update, context: ContextTypes.DEFAULT_TYPE) -> Non # Get the data from the callback_data. # If you're using a type checker like MyPy, you'll have to use typing.cast # to make the checker get the expected type of the callback_data - number, number_list = cast(Tuple[int, List[int]], query.data) + number, number_list = cast(tuple[int, list[int]], query.data) # append the number to the list number_list.append(number) diff --git a/examples/chatmemberbot.py b/examples/chatmemberbot.py index dd299b73acf..34dad2a8385 100644 --- a/examples/chatmemberbot.py +++ b/examples/chatmemberbot.py @@ -12,7 +12,7 @@ """ import logging -from typing import Optional, Tuple +from typing import Optional from telegram import Chat, ChatMember, ChatMemberUpdated, Update from telegram.constants import ParseMode @@ -37,7 +37,7 @@ logger = logging.getLogger(__name__) -def extract_status_change(chat_member_update: ChatMemberUpdated) -> Optional[Tuple[bool, bool]]: +def extract_status_change(chat_member_update: ChatMemberUpdated) -> Optional[tuple[bool, bool]]: """Takes a ChatMemberUpdated instance and extracts whether the 'old_chat_member' was a member of the chat and whether the 'new_chat_member' is a member of the chat. Returns None, if the status didn't change. diff --git a/examples/contexttypesbot.py b/examples/contexttypesbot.py index 9c361772cdb..b89d8ffc7d7 100644 --- a/examples/contexttypesbot.py +++ b/examples/contexttypesbot.py @@ -12,7 +12,7 @@ import logging from collections import defaultdict -from typing import DefaultDict, Optional, Set +from typing import Optional from telegram import InlineKeyboardButton, InlineKeyboardMarkup, Update from telegram.constants import ParseMode @@ -40,7 +40,7 @@ class ChatData: """Custom class for chat_data. Here we store data per message.""" def __init__(self) -> None: - self.clicks_per_message: DefaultDict[int, int] = defaultdict(int) + self.clicks_per_message: defaultdict[int, int] = defaultdict(int) # The [ExtBot, dict, ChatData, dict] is for type checkers like mypy @@ -57,7 +57,7 @@ def __init__( self._message_id: Optional[int] = None @property - def bot_user_ids(self) -> Set[int]: + def bot_user_ids(self) -> set[int]: """Custom shortcut to access a value stored in the bot_data dict""" return self.bot_data.setdefault("user_ids", set()) diff --git a/examples/conversationbot2.py b/examples/conversationbot2.py index 6a5e54a8e5b..af29e0198e9 100644 --- a/examples/conversationbot2.py +++ b/examples/conversationbot2.py @@ -15,7 +15,6 @@ """ import logging -from typing import Dict from telegram import ReplyKeyboardMarkup, ReplyKeyboardRemove, Update from telegram.ext import ( @@ -46,7 +45,7 @@ markup = ReplyKeyboardMarkup(reply_keyboard, one_time_keyboard=True) -def facts_to_str(user_data: Dict[str, str]) -> str: +def facts_to_str(user_data: dict[str, str]) -> str: """Helper function for formatting the gathered user info.""" facts = [f"{key} - {value}" for key, value in user_data.items()] return "\n".join(facts).join(["\n", "\n"]) diff --git a/examples/nestedconversationbot.py b/examples/nestedconversationbot.py index 918f0becf24..bc940f4cd45 100644 --- a/examples/nestedconversationbot.py +++ b/examples/nestedconversationbot.py @@ -15,7 +15,7 @@ """ import logging -from typing import Any, Dict, Tuple +from typing import Any from telegram import InlineKeyboardButton, InlineKeyboardMarkup, Update from telegram.ext import ( @@ -66,7 +66,7 @@ # Helper -def _name_switcher(level: str) -> Tuple[str, str]: +def _name_switcher(level: str) -> tuple[str, str]: if level == PARENTS: return "Father", "Mother" return "Brother", "Sister" @@ -122,7 +122,7 @@ async def adding_self(update: Update, context: ContextTypes.DEFAULT_TYPE) -> str async def show_data(update: Update, context: ContextTypes.DEFAULT_TYPE) -> str: """Pretty print gathered data.""" - def pretty_print(data: Dict[str, Any], level: str) -> str: + def pretty_print(data: dict[str, Any], level: str) -> str: people = data.get(level) if not people: return "\nNo information yet." @@ -371,8 +371,8 @@ def main() -> None: entry_points=[CommandHandler("start", start)], states={ SHOWING: [CallbackQueryHandler(start, pattern="^" + str(END) + "$")], - SELECTING_ACTION: selection_handlers, - SELECTING_LEVEL: selection_handlers, + SELECTING_ACTION: selection_handlers, # type: ignore[dict-item] + SELECTING_LEVEL: selection_handlers, # type: ignore[dict-item] DESCRIBING_SELF: [description_conv], STOPPING: [CommandHandler("start", start)], }, diff --git a/examples/paymentbot.py b/examples/paymentbot.py index a18ee6c2827..90daa44ce2a 100644 --- a/examples/paymentbot.py +++ b/examples/paymentbot.py @@ -2,7 +2,7 @@ # pylint: disable=unused-argument # This program is dedicated to the public domain under the CC0 license. -"""Basic example for a bot that can receive payment from user.""" +"""Basic example for a bot that can receive payments from users.""" import logging @@ -26,36 +26,36 @@ logger = logging.getLogger(__name__) +# Insert the token from your payment provider. +# In order to get a provider_token see https://core.telegram.org/bots/payments#getting-a-token PAYMENT_PROVIDER_TOKEN = "PAYMENT_PROVIDER_TOKEN" async def start_callback(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None: - """Displays info on how to use the bot.""" + """Provides instructions on how to use the bot.""" msg = ( - "Use /shipping to get an invoice for shipping-payment, or /noshipping for an " + "Use /shipping to receive an invoice with shipping included, or /noshipping for an " "invoice without shipping." ) - await update.message.reply_text(msg) async def start_with_shipping_callback(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None: - """Sends an invoice with shipping-payment.""" + """Sends an invoice which triggers a shipping query.""" chat_id = update.message.chat_id title = "Payment Example" - description = "Payment Example using python-telegram-bot" - # select a payload just for you to recognize its the donation from your bot + description = "Example of a payment process using the python-telegram-bot library." + # Unique payload to identify this payment request as being from your bot payload = "Custom-Payload" - # In order to get a provider_token see https://core.telegram.org/bots/payments#getting-a-token + # Set up the currency. + # List of supported currencies: https://core.telegram.org/bots/payments#supported-currencies currency = "USD" - # price in dollars + # Price in dollars price = 1 - # price * 100 so as to include 2 decimal points - # check https://core.telegram.org/bots/payments#supported-currencies for more details + # Convert price to cents from dollars. prices = [LabeledPrice("Test", price * 100)] - - # optionally pass need_name=True, need_phone_number=True, - # need_email=True, need_shipping_address=True, is_flexible=True + # Optional parameters like need_shipping_address and is_flexible trigger extra user prompts + # https://docs.python-telegram-bot.org/en/stable/telegram.bot.html#telegram.Bot.send_invoice await context.bot.send_invoice( chat_id, title, @@ -75,17 +75,16 @@ async def start_with_shipping_callback(update: Update, context: ContextTypes.DEF async def start_without_shipping_callback( update: Update, context: ContextTypes.DEFAULT_TYPE ) -> None: - """Sends an invoice without shipping-payment.""" + """Sends an invoice without requiring shipping details.""" chat_id = update.message.chat_id title = "Payment Example" - description = "Payment Example using python-telegram-bot" - # select a payload just for you to recognize its the donation from your bot + description = "Example of a payment process using the python-telegram-bot library." + # Unique payload to identify this payment request as being from your bot payload = "Custom-Payload" - # In order to get a provider_token see https://core.telegram.org/bots/payments#getting-a-token currency = "USD" - # price in dollars + # Price in dollars price = 1 - # price * 100 so as to include 2 decimal points + # Convert price to cents from dollars. prices = [LabeledPrice("Test", price * 100)] # optionally pass need_name=True, need_phone_number=True, @@ -96,65 +95,65 @@ async def start_without_shipping_callback( async def shipping_callback(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None: - """Answers the ShippingQuery with ShippingOptions""" + """Handles the ShippingQuery with available shipping options.""" query = update.shipping_query - # check the payload, is this from your bot? + # Verify if the payload matches, ensure it's from your bot if query.invoice_payload != "Custom-Payload": - # answer False pre_checkout_query + # If not, respond with an error await query.answer(ok=False, error_message="Something went wrong...") return - # First option has a single LabeledPrice + # Define available shipping options + # First option with a single price entry options = [ShippingOption("1", "Shipping Option A", [LabeledPrice("A", 100)])] - # second option has an array of LabeledPrice objects + # Second option with multiple price entries price_list = [LabeledPrice("B1", 150), LabeledPrice("B2", 200)] options.append(ShippingOption("2", "Shipping Option B", price_list)) await query.answer(ok=True, shipping_options=options) -# after (optional) shipping, it's the pre-checkout +# After (optional) shipping, process the pre-checkout step async def precheckout_callback(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None: - """Answers the PreQecheckoutQuery""" + """Responds to the PreCheckoutQuery as the final confirmation for checkout.""" query = update.pre_checkout_query - # check the payload, is this from your bot? + # Verify if the payload matches, ensure it's from your bot if query.invoice_payload != "Custom-Payload": - # answer False pre_checkout_query + # If not, respond with an error await query.answer(ok=False, error_message="Something went wrong...") else: await query.answer(ok=True) -# finally, after contacting the payment provider... +# Final callback after successful payment async def successful_payment_callback(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None: - """Confirms the successful payment.""" - # do something after successfully receiving payment? - await update.message.reply_text("Thank you for your payment!") + """Acknowledges successful payment and thanks the user.""" + await update.message.reply_text("Thank you for your payment.") def main() -> None: - """Run the bot.""" + """Starts the bot and sets up handlers.""" # Create the Application and pass it your bot's token. application = Application.builder().token("TOKEN").build() - # simple start function + # Start command to display usage instructions application.add_handler(CommandHandler("start", start_callback)) - # Add command handler to start the payment invoice + # Command handlers for starting the payment process application.add_handler(CommandHandler("shipping", start_with_shipping_callback)) application.add_handler(CommandHandler("noshipping", start_without_shipping_callback)) - # Optional handler if your product requires shipping + # Handler for shipping query (if product requires shipping) application.add_handler(ShippingQueryHandler(shipping_callback)) - # Pre-checkout handler to final check + # Pre-checkout handler for verifying payment details. application.add_handler(PreCheckoutQueryHandler(precheckout_callback)) - # Success! Notify your user! + # Handler for successful payment. Notify the user that the payment was successful. application.add_handler( MessageHandler(filters.SUCCESSFUL_PAYMENT, successful_payment_callback) ) - # Run the bot until the user presses Ctrl-C + # Start polling for updates until interrupted (CTRL+C) application.run_polling(allowed_updates=Update.ALL_TYPES) diff --git a/examples/persistentconversationbot.py b/examples/persistentconversationbot.py index 19be96f562f..4c5322456bb 100644 --- a/examples/persistentconversationbot.py +++ b/examples/persistentconversationbot.py @@ -15,7 +15,6 @@ """ import logging -from typing import Dict from telegram import ReplyKeyboardMarkup, ReplyKeyboardRemove, Update from telegram.ext import ( @@ -47,7 +46,7 @@ markup = ReplyKeyboardMarkup(reply_keyboard, one_time_keyboard=True) -def facts_to_str(user_data: Dict[str, str]) -> str: +def facts_to_str(user_data: dict[str, str]) -> str: """Helper function for formatting the gathered user info.""" facts = [f"{key} - {value}" for key, value in user_data.items()] return "\n".join(facts).join(["\n", "\n"]) diff --git a/pyproject.toml b/pyproject.toml index 2484250c3d5..58752295610 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -8,7 +8,7 @@ dynamic = ["version"] name = "python-telegram-bot" description = "We have made you a wrapper you can't refuse" readme = "README.rst" -requires-python = ">=3.8" +requires-python = ">=3.9" license = "LGPL-3.0-only" license-files = { paths = ["LICENSE", "LICENSE.dual", "LICENSE.lesser"] } authors = [ @@ -31,7 +31,6 @@ classifiers = [ "Topic :: Internet", "Programming Language :: Python", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", @@ -67,7 +66,7 @@ all = [ ] callback-data = [ # Cachetools doesn't have a strict stability policy. Let's be cautious for now. - "cachetools~=5.3.3", + "cachetools>=5.3.3,<5.6.0", ] ext = [ "python-telegram-bot[callback-data,job-queue,rate-limiter,webhooks]", @@ -87,7 +86,7 @@ passport = [ "cffi >= 1.17.0rc1; python_version > '3.12'" ] rate-limiter = [ - "aiolimiter~=1.1.0", + "aiolimiter>=1.1,<1.3", ] socks = [ "httpx[socks]", @@ -128,14 +127,21 @@ explicit-preview-rules = true # TODO: Drop this when RUF022 and RUF023 are out ignore = ["PLR2004", "PLR0911", "PLR0912", "PLR0913", "PLR0915", "PERF203"] select = ["E", "F", "I", "PL", "UP", "RUF", "PTH", "C4", "B", "PIE", "SIM", "RET", "RSE", "G", "ISC", "PT", "ASYNC", "TCH", "SLOT", "PERF", "PYI", "FLY", "AIR", "RUF022", - "RUF023", "Q", "INP", "W", "YTT", "DTZ", "ARG", "T20", "FURB"] + "RUF023", "Q", "INP", "W", "YTT", "DTZ", "ARG", "T20", "FURB", "DOC", "TRY", + "D100", "D101", "D102", "D103", "D300", "D418", "D419", "S"] # Add "A (flake8-builtins)" after we drop pylint [tool.ruff.lint.per-file-ignores] "tests/*.py" = ["B018"] -"tests/**.py" = ["RUF012", "ASYNC230", "DTZ", "ARG", "T201"] -"docs/**.py" = ["INP001", "ARG"] -"examples/**.py" = ["ARG"] +"tests/**.py" = ["RUF012", "ASYNC230", "DTZ", "ARG", "T201", "ASYNC109", "D", "S", "TRY"] +"telegram/**.py" = ["TRY003"] +"telegram/ext/_applicationbuilder.py" = ["TRY004"] +"telegram/ext/filters.py" = ["D102"] +"docs/**.py" = ["INP001", "ARG", "D", "TRY003", "S"] +"examples/**.py" = ["ARG", "D", "S105", "TRY003"] + +[tool.ruff.lint.pydocstyle] +convention = "google" # PYLINT: [tool.pylint."messages control"] @@ -143,7 +149,8 @@ enable = ["useless-suppression"] disable = ["duplicate-code", "too-many-arguments", "too-many-public-methods", "too-few-public-methods", "broad-exception-caught", "too-many-instance-attributes", "fixme", "missing-function-docstring", "missing-class-docstring", "too-many-locals", - "too-many-lines", "too-many-branches", "too-many-statements", "cyclic-import" + "too-many-lines", "too-many-branches", "too-many-statements", "cyclic-import", + "too-many-positional-arguments", ] [tool.pylint.main] @@ -185,7 +192,7 @@ disallow_untyped_defs = true disallow_incomplete_defs = true disallow_untyped_decorators = true show_error_codes = true -python_version = "3.8" +python_version = "3.9" # For some files, it's easier to just disable strict-optional all together instead of # cluttering the code with `# type: ignore`s or stuff like diff --git a/requirements-unit-tests.txt b/requirements-unit-tests.txt index eb69f9d9283..654bc9e9fdb 100644 --- a/requirements-unit-tests.txt +++ b/requirements-unit-tests.txt @@ -4,7 +4,7 @@ build # For the test suite -pytest==8.2.2 +pytest==8.3.4 # needed because pytest doesn't come with native support for coroutines as tests pytest-asyncio==0.21.2 diff --git a/telegram/__init__.py b/telegram/__init__.py index 5b52bf85c40..a827670d66b 100644 --- a/telegram/__init__.py +++ b/telegram/__init__.py @@ -20,6 +20,7 @@ __author__ = "devs@python-telegram-bot.org" __all__ = ( + "AffiliateInfo", "Animation", "Audio", "BackgroundFill", @@ -81,6 +82,7 @@ "ChatShared", "ChosenInlineResult", "Contact", + "CopyTextButton", "Credentials", "DataCredentials", "Dice", @@ -100,6 +102,8 @@ "GameHighScore", "GeneralForumTopicHidden", "GeneralForumTopicUnhidden", + "Gift", + "Gifts", "Giveaway", "GiveawayCompleted", "GiveawayCreated", @@ -180,6 +184,7 @@ "PaidMediaInfo", "PaidMediaPhoto", "PaidMediaPreview", + "PaidMediaPurchased", "PaidMediaVideo", "PassportData", "PassportElementError", @@ -199,11 +204,13 @@ "PollAnswer", "PollOption", "PreCheckoutQuery", + "PreparedInlineMessage", "ProximityAlertTriggered", "ReactionCount", "ReactionType", "ReactionTypeCustomEmoji", "ReactionTypeEmoji", + "ReactionTypePaid", "RefundedPayment", "ReplyKeyboardMarkup", "ReplyKeyboardRemove", @@ -230,9 +237,11 @@ "TelegramObject", "TextQuote", "TransactionPartner", + "TransactionPartnerAffiliateProgram", "TransactionPartnerFragment", "TransactionPartnerOther", "TransactionPartnerTelegramAds", + "TransactionPartnerTelegramApi", "TransactionPartnerUser", "Update", "User", @@ -328,6 +337,7 @@ from ._chatmemberupdated import ChatMemberUpdated from ._chatpermissions import ChatPermissions from ._choseninlineresult import ChosenInlineResult +from ._copytextbutton import CopyTextButton from ._dice import Dice from ._files.animation import Animation from ._files.audio import Audio @@ -368,6 +378,7 @@ from ._games.callbackgame import CallbackGame from ._games.game import Game from ._games.gamehighscore import GameHighScore +from ._gifts import Gift, Gifts from ._giveaway import Giveaway, GiveawayCompleted, GiveawayCreated, GiveawayWinners from ._inline.inlinekeyboardbutton import InlineKeyboardButton from ._inline.inlinekeyboardmarkup import InlineKeyboardMarkup @@ -400,6 +411,7 @@ from ._inline.inputmessagecontent import InputMessageContent from ._inline.inputtextmessagecontent import InputTextMessageContent from ._inline.inputvenuemessagecontent import InputVenueMessageContent +from ._inline.preparedinlinemessage import PreparedInlineMessage from ._keyboardbutton import KeyboardButton from ._keyboardbuttonpolltype import KeyboardButtonPollType from ._keyboardbuttonrequest import KeyboardButtonRequestChat, KeyboardButtonRequestUsers @@ -418,7 +430,14 @@ MessageOriginUser, ) from ._messagereactionupdated import MessageReactionCountUpdated, MessageReactionUpdated -from ._paidmedia import PaidMedia, PaidMediaInfo, PaidMediaPhoto, PaidMediaPreview, PaidMediaVideo +from ._paidmedia import ( + PaidMedia, + PaidMediaInfo, + PaidMediaPhoto, + PaidMediaPreview, + PaidMediaPurchased, + PaidMediaVideo, +) from ._passport.credentials import ( Credentials, DataCredentials, @@ -452,6 +471,7 @@ from ._payment.shippingoption import ShippingOption from ._payment.shippingquery import ShippingQuery from ._payment.stars import ( + AffiliateInfo, RevenueWithdrawalState, RevenueWithdrawalStateFailed, RevenueWithdrawalStatePending, @@ -459,15 +479,23 @@ StarTransaction, StarTransactions, TransactionPartner, + TransactionPartnerAffiliateProgram, TransactionPartnerFragment, TransactionPartnerOther, TransactionPartnerTelegramAds, + TransactionPartnerTelegramApi, TransactionPartnerUser, ) from ._payment.successfulpayment import SuccessfulPayment from ._poll import InputPollOption, Poll, PollAnswer, PollOption from ._proximityalerttriggered import ProximityAlertTriggered -from ._reaction import ReactionCount, ReactionType, ReactionTypeCustomEmoji, ReactionTypeEmoji +from ._reaction import ( + ReactionCount, + ReactionType, + ReactionTypeCustomEmoji, + ReactionTypeEmoji, + ReactionTypePaid, +) from ._reply import ExternalReplyInfo, ReplyParameters, TextQuote from ._replykeyboardmarkup import ReplyKeyboardMarkup from ._replykeyboardremove import ReplyKeyboardRemove diff --git a/telegram/__main__.py b/telegram/__main__.py index 2491a330ac6..6a508e3574b 100644 --- a/telegram/__main__.py +++ b/telegram/__main__.py @@ -17,7 +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/]. # pylint: disable=missing-module-docstring -# ruff: noqa: T201 +# ruff: noqa: T201, D100, S603, S607 import subprocess import sys from typing import Optional diff --git a/telegram/_birthdate.py b/telegram/_birthdate.py index 06caf67d5ec..190c17e0f67 100644 --- a/telegram/_birthdate.py +++ b/telegram/_birthdate.py @@ -17,7 +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/]. """This module contains an object that represents a Telegram Birthday.""" -from datetime import date +import datetime as dtm from typing import Optional from telegram._telegramobject import TelegramObject @@ -70,7 +70,7 @@ def __init__( self._freeze() - def to_date(self, year: Optional[int] = None) -> date: + def to_date(self, year: Optional[int] = None) -> dtm.date: """Return the birthdate as a date object. .. versionchanged:: 21.2 @@ -89,4 +89,4 @@ def to_date(self, year: Optional[int] = None) -> date: "The `year` argument is required if the `year` attribute was not present." ) - return date(year or self.year, self.month, self.day) # type: ignore[arg-type] + return dtm.date(year or self.year, self.month, self.day) # type: ignore[arg-type] diff --git a/telegram/_bot.py b/telegram/_bot.py index 4d8a778cc63..dc1ef7ff43f 100644 --- a/telegram/_bot.py +++ b/telegram/_bot.py @@ -18,25 +18,20 @@ # 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 Bot.""" + import asyncio import contextlib import copy +import datetime as dtm import pickle -from datetime import datetime +from collections.abc import Sequence from types import TracebackType from typing import ( TYPE_CHECKING, Any, - AsyncContextManager, Callable, - Dict, - List, NoReturn, Optional, - Sequence, - Set, - Tuple, - Type, TypeVar, Union, cast, @@ -80,7 +75,9 @@ from telegram._files.voice import Voice from telegram._forumtopic import ForumTopic from telegram._games.gamehighscore import GameHighScore +from telegram._gifts import Gift, Gifts from telegram._inline.inlinequeryresultsbutton import InlineQueryResultsButton +from telegram._inline.preparedinlinemessage import PreparedInlineMessage from telegram._menubutton import MenuButton from telegram._message import Message from telegram._messageid import MessageId @@ -129,7 +126,7 @@ BT = TypeVar("BT", bound="Bot") -class Bot(TelegramObject, AsyncContextManager["Bot"]): +class Bot(TelegramObject, contextlib.AbstractAsyncContextManager["Bot"]): """This object represents a Telegram Bot. Instances of this class can be used as asyncio context managers, where @@ -262,7 +259,7 @@ def __init__( self._private_key: Optional[bytes] = None self._initialized: bool = False - self._request: Tuple[BaseRequest, BaseRequest] = ( + self._request: tuple[BaseRequest, BaseRequest] = ( HTTPXRequest() if get_updates_request is None else get_updates_request, HTTPXRequest() if request is None else request, ) @@ -324,14 +321,14 @@ async def __aenter__(self: BT) -> BT: """ try: await self.initialize() - return self - except Exception as exc: + except Exception: await self.shutdown() - raise exc + raise + return self async def __aexit__( self, - exc_type: Optional[Type[BaseException]], + exc_type: Optional[type[BaseException]], exc_val: Optional[BaseException], exc_tb: Optional[TracebackType], ) -> None: @@ -351,7 +348,7 @@ def __reduce__(self) -> NoReturn: """ raise pickle.PicklingError("Bot objects cannot be pickled!") - def __deepcopy__(self, memodict: Dict[int, object]) -> NoReturn: + def __deepcopy__(self, memodict: dict[int, object]) -> NoReturn: """Customizes how :func:`copy.deepcopy` processes objects of this type. Bots can not be deepcopied and this method will always raise an exception. @@ -527,7 +524,7 @@ def name(self) -> str: def _warn( cls, message: Union[str, PTBUserWarning], - category: Type[Warning] = PTBUserWarning, + category: type[Warning] = PTBUserWarning, stacklevel: int = 0, ) -> None: """Convenience method to issue a warning. This method is here mostly to make it easier @@ -538,7 +535,7 @@ def _warn( def _parse_file_input( self, file_input: Union[FileInput, "TelegramObject"], - tg_type: Optional[Type["TelegramObject"]] = None, + tg_type: Optional[type["TelegramObject"]] = None, filename: Optional[str] = None, attach: bool = False, ) -> Union[str, "InputFile", Any]: @@ -550,7 +547,7 @@ def _parse_file_input( local_mode=self._local_mode, ) - def _insert_defaults(self, data: Dict[str, object]) -> None: + def _insert_defaults(self, data: dict[str, object]) -> None: """This method is here to make ext.Defaults work. Because we need to be able to tell e.g. `send_message(chat_id, text)` from `send_message(chat_id, text, parse_mode=None)`, the default values for `parse_mode` etc are not `None` but `DEFAULT_NONE`. While this *could* @@ -604,7 +601,7 @@ async def _post( pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, ) -> Any: - # We know that the return type is Union[bool, JSONDict, List[JSONDict]], but it's hard + # We know that the return type is Union[bool, JSONDict, list[JSONDict]], but it's hard # to tell mypy which methods expects which of these return values and `Any` saves us a # lot of `type: ignore` comments if data is None: @@ -637,7 +634,7 @@ async def _do_post( write_timeout: ODVInput[float] = DEFAULT_NONE, connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, - ) -> Union[bool, JSONDict, List[JSONDict]]: + ) -> Union[bool, JSONDict, list[JSONDict]]: # This also converts datetimes into timestamps. # We don't do this earlier so that _insert_defaults (see above) has a chance to convert # to the default timezone in case this is called by ExtBot @@ -677,6 +674,7 @@ async def _send_message( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -713,33 +711,22 @@ async def _send_message( allow_sending_without_reply=allow_sending_without_reply, ) - data["disable_notification"] = disable_notification - data["protect_content"] = protect_content - data["parse_mode"] = parse_mode - - if reply_parameters is not None: - data["reply_parameters"] = reply_parameters - - if link_preview_options is not None: - data["link_preview_options"] = link_preview_options - - if reply_markup is not None: - data["reply_markup"] = reply_markup - - if message_thread_id is not None: - data["message_thread_id"] = message_thread_id - - if caption is not None: - data["caption"] = caption - - if caption_entities is not None: - data["caption_entities"] = caption_entities - - if business_connection_id is not None: - data["business_connection_id"] = business_connection_id - - if message_effect_id is not None: - data["message_effect_id"] = message_effect_id + data.update( + { + "allow_paid_broadcast": allow_paid_broadcast, + "business_connection_id": business_connection_id, + "caption": caption, + "caption_entities": caption_entities, + "disable_notification": disable_notification, + "link_preview_options": link_preview_options, + "message_thread_id": message_thread_id, + "message_effect_id": message_effect_id, + "parse_mode": parse_mode, + "protect_content": protect_content, + "reply_markup": reply_markup, + "reply_parameters": reply_parameters, + } + ) result = await self._post( endpoint, @@ -797,7 +784,7 @@ async def do_api_request( self, endpoint: str, api_kwargs: Optional[JSONDict] = None, - return_type: Optional[Type[TelegramObject]] = None, + return_type: Optional[type[TelegramObject]] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, write_timeout: ODVInput[float] = DEFAULT_NONE, @@ -930,6 +917,7 @@ async def send_message( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -981,6 +969,9 @@ async def send_message( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -1039,6 +1030,7 @@ async def send_message( link_preview_options=link_preview_options, reply_parameters=reply_parameters, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, read_timeout=read_timeout, write_timeout=write_timeout, connect_timeout=connect_timeout, @@ -1225,7 +1217,7 @@ async def forward_messages( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple[MessageId, ...]: + ) -> tuple[MessageId, ...]: """ Use this method to forward messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content @@ -1247,7 +1239,7 @@ async def forward_messages( message_thread_id (:obj:`int`, optional): |message_thread_id_arg| Returns: - Tuple[:class:`telegram.Message`]: On success, a tuple of ``MessageId`` of sent messages + tuple[:class:`telegram.Message`]: On success, a tuple of ``MessageId`` of sent messages is returned. Raises: @@ -1288,6 +1280,7 @@ async def send_photo( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1305,8 +1298,8 @@ async def send_photo( Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| - photo (:obj:`str` | :term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | \ - :class:`telegram.PhotoSize`): Photo to send. + photo (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` \ + | :class:`pathlib.Path` | :class:`telegram.PhotoSize`): Photo to send. |fileinput| Lastly you can pass an existing :class:`telegram.PhotoSize` object to send. @@ -1355,6 +1348,9 @@ async def send_photo( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: 21.7 show_caption_above_media (:obj:`bool`, optional): Pass |show_cap_above_med| .. versionadded:: 21.3 @@ -1418,6 +1414,7 @@ async def send_photo( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_audio( @@ -1438,6 +1435,7 @@ async def send_audio( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -1465,9 +1463,9 @@ async def send_audio( Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| - audio (:obj:`str` | :term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | \ - :class:`telegram.Audio`): Audio file to send. - |fileinput| + audio (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | \ + :obj:`bytes` | :class:`pathlib.Path` | :class:`telegram.Audio`): Audio file to + send. |fileinput| Lastly you can pass an existing :class:`telegram.Audio` object to send. .. versionchanged:: 13.2 @@ -1513,6 +1511,9 @@ async def send_audio( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -1575,6 +1576,7 @@ async def send_audio( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_document( @@ -1593,6 +1595,7 @@ async def send_document( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -1617,8 +1620,8 @@ async def send_document( Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| - document (:obj:`str` | :term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | \ - :class:`telegram.Document`): File to send. + document (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | \ + :obj:`bytes` | :class:`pathlib.Path` | :class:`telegram.Document`): File to send. |fileinput| Lastly you can pass an existing :class:`telegram.Document` object to send. @@ -1667,6 +1670,9 @@ async def send_document( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -1725,6 +1731,7 @@ async def send_document( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_sticker( @@ -1739,6 +1746,7 @@ async def send_sticker( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -1755,8 +1763,8 @@ async def send_sticker( Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| - sticker (:obj:`str` | :term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | \ - :class:`telegram.Sticker`): Sticker to send. + sticker (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | \ + :obj:`bytes` | :class:`pathlib.Path` | :class:`telegram.Sticker`): Sticker to send. |fileinput| Video stickers can only be sent by a ``file_id``. Video and animated stickers can't be sent via an HTTP URL. @@ -1793,6 +1801,9 @@ async def send_sticker( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -1843,6 +1854,7 @@ async def send_sticker( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_video( @@ -1865,6 +1877,7 @@ async def send_video( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1895,8 +1908,8 @@ async def send_video( Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| - video (:obj:`str` | :term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | \ - :class:`telegram.Video`): Video file to send. + video (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` \ + | :class:`pathlib.Path` | :class:`telegram.Video`): Video file to send. |fileinput| Lastly you can pass an existing :class:`telegram.Video` object to send. @@ -1949,6 +1962,9 @@ async def send_video( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: 21.7 show_caption_above_media (:obj:`bool`, optional): Pass |show_cap_above_med| .. versionadded:: 21.3 @@ -2017,6 +2033,7 @@ async def send_video( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_video_note( @@ -2033,6 +2050,7 @@ async def send_video_note( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -2059,8 +2077,9 @@ async def send_video_note( Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| - video_note (:obj:`str` | :term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | \ - :class:`telegram.VideoNote`): Video note to send. + video_note (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | \ + :obj:`bytes` | :class:`pathlib.Path` | :class:`telegram.VideoNote`): Video note + to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. |uploadinput| @@ -2101,6 +2120,9 @@ async def send_video_note( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -2159,6 +2181,7 @@ async def send_video_note( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_animation( @@ -2180,6 +2203,7 @@ async def send_animation( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2209,9 +2233,9 @@ async def send_animation( Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| - animation (:obj:`str` | :term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | \ - :class:`telegram.Animation`): Animation to send. - |fileinput| + animation (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | \ + :obj:`bytes` | :class:`pathlib.Path` | :class:`telegram.Animation`): Animation to + send. |fileinput| Lastly you can pass an existing :class:`telegram.Animation` object to send. .. versionchanged:: 13.2 @@ -2258,6 +2282,9 @@ async def send_animation( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: 21.7 show_caption_above_media (:obj:`bool`, optional): Pass |show_cap_above_med| .. versionadded:: 21.3 @@ -2325,6 +2352,7 @@ async def send_animation( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_voice( @@ -2342,6 +2370,7 @@ async def send_voice( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -2371,8 +2400,8 @@ async def send_voice( Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| - voice (:obj:`str` | :term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | \ - :class:`telegram.Voice`): Voice file to send. + voice (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` \ + | :class:`pathlib.Path` | :class:`telegram.Voice`): Voice file to send. |fileinput| Lastly you can pass an existing :class:`telegram.Voice` object to send. @@ -2413,6 +2442,9 @@ async def send_voice( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -2472,6 +2504,7 @@ async def send_voice( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_media_group( @@ -2486,6 +2519,7 @@ async def send_media_group( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -2497,7 +2531,7 @@ async def send_media_group( caption: Optional[str] = None, parse_mode: ODVInput[str] = DEFAULT_NONE, caption_entities: Optional[Sequence["MessageEntity"]] = None, - ) -> Tuple[Message, ...]: + ) -> tuple[Message, ...]: """Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. @@ -2539,6 +2573,9 @@ async def send_media_group( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -2579,7 +2616,7 @@ async def send_media_group( .. versionadded:: 20.0 Returns: - Tuple[:class:`telegram.Message`]: An array of the sent Messages. + tuple[:class:`telegram.Message`]: An array of the sent Messages. Raises: :class:`telegram.error.TelegramError` @@ -2633,6 +2670,7 @@ async def send_media_group( "reply_parameters": reply_parameters, "business_connection_id": business_connection_id, "message_effect_id": message_effect_id, + "allow_paid_broadcast": allow_paid_broadcast, } result = await self._post( @@ -2663,6 +2701,7 @@ async def send_location( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -2722,6 +2761,9 @@ async def send_location( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -2792,6 +2834,7 @@ async def send_location( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def edit_message_live_location( @@ -2974,6 +3017,7 @@ async def send_venue( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -3029,6 +3073,9 @@ async def send_venue( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -3110,6 +3157,7 @@ async def send_venue( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_contact( @@ -3126,6 +3174,7 @@ async def send_contact( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -3171,6 +3220,9 @@ async def send_contact( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -3243,6 +3295,7 @@ async def send_contact( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_game( @@ -3256,6 +3309,7 @@ async def send_game( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -3291,6 +3345,9 @@ async def send_game( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -3338,6 +3395,7 @@ async def send_game( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_chat_action( @@ -3401,7 +3459,7 @@ def _effective_inline_results( ], next_offset: Optional[str] = None, current_offset: Optional[str] = None, - ) -> Tuple[Sequence["InlineQueryResult"], Optional[str]]: + ) -> tuple[Sequence["InlineQueryResult"], Optional[str]]: """ Builds the effective results from the results input. We make this a stand-alone method so tg.ext.ExtBot can wrap it. @@ -3524,7 +3582,7 @@ async def answer_inline_query( Args: inline_query_id (:obj:`str`): Unique identifier for the answered query. - results (List[:class:`telegram.InlineQueryResult`] | Callable): A list of results for + results (list[:class:`telegram.InlineQueryResult`] | Callable): A list of results for the inline query. In case :paramref:`current_offset` is passed, :paramref:`results` may also be a callable that accepts the current page index starting from 0. It must return @@ -3585,6 +3643,65 @@ async def answer_inline_query( api_kwargs=api_kwargs, ) + async def save_prepared_inline_message( + self, + user_id: int, + result: "InlineQueryResult", + allow_user_chats: Optional[bool] = None, + allow_bot_chats: Optional[bool] = None, + allow_group_chats: Optional[bool] = None, + allow_channel_chats: Optional[bool] = None, + *, + read_timeout: ODVInput[float] = DEFAULT_NONE, + write_timeout: ODVInput[float] = DEFAULT_NONE, + connect_timeout: ODVInput[float] = DEFAULT_NONE, + pool_timeout: ODVInput[float] = DEFAULT_NONE, + api_kwargs: Optional[JSONDict] = None, + ) -> PreparedInlineMessage: + """Stores a message that can be sent by a user of a Mini App. + + .. versionadded:: 21.8 + + Args: + user_id (:obj:`int`): Unique identifier of the target user that can use the prepared + message. + result (:class:`telegram.InlineQueryResult`): The result to store. + allow_user_chats (:obj:`bool`, optional): Pass :obj:`True` if the message can be sent + to private chats with users + allow_bot_chats (:obj:`bool`, optional): Pass :obj:`True` if the message can be sent + to private chats with bots + allow_group_chats (:obj:`bool`, optional): Pass :obj:`True` if the message can be sent + to group and supergroup chats + allow_channel_chats (:obj:`bool`, optional): Pass :obj:`True` if the message can be + sent to channels + + Returns: + :class:`telegram.PreparedInlineMessage`: On success, the prepared message is returned. + + Raises: + :class:`telegram.error.TelegramError` + """ + data: JSONDict = { + "user_id": user_id, + "result": result, + "allow_user_chats": allow_user_chats, + "allow_bot_chats": allow_bot_chats, + "allow_group_chats": allow_group_chats, + "allow_channel_chats": allow_channel_chats, + } + return PreparedInlineMessage.de_json( # type: ignore[return-value] + await self._post( + "savePreparedInlineMessage", + data, + read_timeout=read_timeout, + write_timeout=write_timeout, + connect_timeout=connect_timeout, + pool_timeout=pool_timeout, + api_kwargs=api_kwargs, + ), + self, + ) + async def get_user_profile_photos( self, user_id: int, @@ -3698,7 +3815,7 @@ async def ban_chat_member( self, chat_id: Union[str, int], user_id: int, - until_date: Optional[Union[int, datetime]] = None, + until_date: Optional[Union[int, dtm.datetime]] = None, revoke_messages: Optional[bool] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, @@ -3723,9 +3840,7 @@ async def ban_chat_member( be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only. - For timezone naive :obj:`datetime.datetime` objects, the default timezone of the - bot will be used, which is UTC unless :attr:`telegram.ext.Defaults.tzinfo` is - used. + |tz-naive-dtms| revoke_messages (:obj:`bool`, optional): Pass :obj:`True` to delete all messages from the chat for the user that is being removed. If :obj:`False`, the user will be able to see messages in the group that were sent before the user was removed. @@ -4152,7 +4267,8 @@ async def edit_message_media( api_kwargs: Optional[JSONDict] = None, ) -> Union[Message, bool]: """ - Use this method to edit animation, audio, document, photo, or video messages. If a message + Use this method to edit animation, audio, document, photo, or video messages, or to add + media to text messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its @@ -4270,7 +4386,7 @@ async def get_updates( self, offset: Optional[int] = None, limit: Optional[int] = None, - timeout: Optional[int] = None, + timeout: Optional[int] = None, # noqa: ASYNC109 allowed_updates: Optional[Sequence[str]] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, @@ -4278,7 +4394,7 @@ async def get_updates( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple[Update, ...]: + ) -> tuple[Update, ...]: """Use this method to receive incoming updates using long polling. Note: @@ -4323,7 +4439,7 @@ async def get_updates( |sequenceargs| Returns: - Tuple[:class:`telegram.Update`] + tuple[:class:`telegram.Update`] Raises: :class:`telegram.error.TelegramError` @@ -4360,7 +4476,7 @@ async def get_updates( # waiting for the server to return and there's no way of knowing the connection had been # dropped in real time. result = cast( - List[JSONDict], + list[JSONDict], await self._post( "getUpdates", data, @@ -4386,7 +4502,7 @@ async def get_updates( self._LOGGER.critical( "Error while parsing updates! Received data was %r", result, exc_info=exc ) - raise exc + raise async def set_webhook( self, @@ -4426,18 +4542,6 @@ async def set_webhook( If you're having any trouble setting up webhooks, please check out this `guide to Webhooks`_. - Note: - 1. You will not be able to receive updates using :meth:`get_updates` for long as an - outgoing webhook is set up. - 2. To use a self-signed certificate, you need to upload your public key certificate - using certificate parameter. Please upload as InputFile, sending a String will not - work. - 3. Ports currently supported for Webhooks: - :attr:`telegram.constants.SUPPORTED_WEBHOOK_PORTS`. - - If you're having any trouble setting up webhooks, please check out this `guide to - Webhooks`_. - .. seealso:: :meth:`telegram.ext.Application.run_webhook`, :meth:`telegram.ext.Updater.start_webhook` @@ -4636,7 +4740,7 @@ async def get_chat_administrators( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple[ChatMember, ...]: + ) -> tuple[ChatMember, ...]: """ Use this method to get a list of administrators in a chat. @@ -4647,7 +4751,7 @@ async def get_chat_administrators( chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| Returns: - Tuple[:class:`telegram.ChatMember`]: On success, returns a tuple of ``ChatMember`` + tuple[:class:`telegram.ChatMember`]: On success, returns a tuple of ``ChatMember`` objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned. @@ -4911,7 +5015,7 @@ async def get_game_high_scores( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple[GameHighScore, ...]: + ) -> tuple[GameHighScore, ...]: """ Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. @@ -4934,7 +5038,7 @@ async def get_game_high_scores( :paramref:`message_id` are not specified. Identifier of the inline message. Returns: - Tuple[:class:`telegram.GameHighScore`] + tuple[:class:`telegram.GameHighScore`] Raises: :class:`telegram.error.TelegramError` @@ -4989,6 +5093,7 @@ async def send_invoice( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -5018,7 +5123,7 @@ async def send_invoice( payload (:obj:`str`): Bot-defined invoice payload. :tg-const:`telegram.Invoice.MIN_PAYLOAD_LENGTH`- :tg-const:`telegram.Invoice.MAX_PAYLOAD_LENGTH` bytes. This will not be - displayed to the user, use for your internal processes. + displayed to the user, use it for your internal processes. provider_token (:obj:`str`): Payments provider token, obtained via `@BotFather `_. Pass an empty string for payments in |tg_stars|. @@ -5106,6 +5211,9 @@ async def send_invoice( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -5175,6 +5283,7 @@ async def send_invoice( pool_timeout=pool_timeout, api_kwargs=api_kwargs, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def answer_shipping_query( @@ -5342,7 +5451,7 @@ async def restrict_chat_member( chat_id: Union[str, int], user_id: int, permissions: ChatPermissions, - until_date: Optional[Union[int, datetime]] = None, + until_date: Optional[Union[int, dtm.datetime]] = None, use_independent_chat_permissions: Optional[bool] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, @@ -5365,9 +5474,7 @@ async def restrict_chat_member( will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever. - For timezone naive :obj:`datetime.datetime` objects, the default timezone of the - bot will be used, which is UTC unless :attr:`telegram.ext.Defaults.tzinfo` is - used. + |tz-naive-dtms| permissions (:class:`telegram.ChatPermissions`): An object for new user permissions. use_independent_chat_permissions (:obj:`bool`, optional): Pass :obj:`True` if chat @@ -5681,7 +5788,7 @@ async def export_chat_invite_link( async def create_chat_invite_link( self, chat_id: Union[str, int], - expire_date: Optional[Union[int, datetime]] = None, + expire_date: Optional[Union[int, dtm.datetime]] = None, member_limit: Optional[int] = None, name: Optional[str] = None, creates_join_request: Optional[bool] = None, @@ -5711,9 +5818,7 @@ async def create_chat_invite_link( chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| expire_date (:obj:`int` | :obj:`datetime.datetime`, optional): Date when the link will expire. Integer input will be interpreted as Unix timestamp. - For timezone naive :obj:`datetime.datetime` objects, the default timezone of the - bot will be used, which is UTC unless :attr:`telegram.ext.Defaults.tzinfo` is - used. + |tz-naive-dtms| member_limit (:obj:`int`, optional): Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; :tg-const:`telegram.constants.ChatInviteLinkLimit.MIN_MEMBER_LIMIT`- @@ -5759,7 +5864,7 @@ async def edit_chat_invite_link( self, chat_id: Union[str, int], invite_link: Union[str, "ChatInviteLink"], - expire_date: Optional[Union[int, datetime]] = None, + expire_date: Optional[Union[int, dtm.datetime]] = None, member_limit: Optional[int] = None, name: Optional[str] = None, creates_join_request: Optional[bool] = None, @@ -5784,15 +5889,13 @@ async def edit_chat_invite_link( Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| - invite_link (:obj:`str` | :obj:`telegram.ChatInviteLink`): The invite link to edit. + invite_link (:obj:`str` | :class:`telegram.ChatInviteLink`): The invite link to edit. .. versionchanged:: 20.0 - Now also accepts :obj:`telegram.ChatInviteLink` instances. + Now also accepts :class:`telegram.ChatInviteLink` instances. expire_date (:obj:`int` | :obj:`datetime.datetime`, optional): Date when the link will expire. - For timezone naive :obj:`datetime.datetime` objects, the default timezone of the - bot will be used, which is UTC unless :attr:`telegram.ext.Defaults.tzinfo` is - used. + |tz-naive-dtms| member_limit (:obj:`int`, optional): Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; :tg-const:`telegram.constants.ChatInviteLinkLimit.MIN_MEMBER_LIMIT`- @@ -5856,10 +5959,10 @@ async def revoke_chat_invite_link( Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| - invite_link (:obj:`str` | :obj:`telegram.ChatInviteLink`): The invite link to revoke. + invite_link (:obj:`str` | :class:`telegram.ChatInviteLink`): The invite link to revoke. .. versionchanged:: 20.0 - Now also accepts :obj:`telegram.ChatInviteLink` instances. + Now also accepts :class:`telegram.ChatInviteLink` instances. Returns: :class:`telegram.ChatInviteLink` @@ -6126,11 +6229,62 @@ async def set_chat_description( api_kwargs=api_kwargs, ) + async def set_user_emoji_status( + self, + user_id: int, + emoji_status_custom_emoji_id: Optional[str] = None, + emoji_status_expiration_date: Optional[Union[int, dtm.datetime]] = None, + *, + read_timeout: ODVInput[float] = DEFAULT_NONE, + write_timeout: ODVInput[float] = DEFAULT_NONE, + connect_timeout: ODVInput[float] = DEFAULT_NONE, + pool_timeout: ODVInput[float] = DEFAULT_NONE, + api_kwargs: Optional[JSONDict] = None, + ) -> bool: + """Changes the emoji status for a given user that previously allowed the bot to manage + their emoji status via the Mini App method + `requestEmojiStatusAccess `_ + . + + .. versionadded:: 21.8 + + Args: + user_id (:obj:`int`): Unique identifier of the target user + emoji_status_custom_emoji_id (:obj:`str`, optional): Custom emoji identifier of the + emoji status to set. Pass an empty string to remove the status. + emoji_status_expiration_date (Union[:obj:`int`, :obj:`datetime.datetime`], optional): + Expiration date of the emoji status, if any, as unix timestamp or + :class:`datetime.datetime` object. + |tz-naive-dtms| + + Returns: + :obj:`bool`: On success, :obj:`True` is returned. + + Raises: + :class:`telegram.error.TelegramError` + + """ + data: JSONDict = { + "user_id": user_id, + "emoji_status_custom_emoji_id": emoji_status_custom_emoji_id, + "emoji_status_expiration_date": emoji_status_expiration_date, + } + return await self._post( + "setUserEmojiStatus", + data, + read_timeout=read_timeout, + write_timeout=write_timeout, + connect_timeout=connect_timeout, + pool_timeout=pool_timeout, + api_kwargs=api_kwargs, + ) + async def pin_chat_message( self, chat_id: Union[str, int], message_id: int, disable_notification: ODVInput[bool] = DEFAULT_NONE, + business_connection_id: Optional[str] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, write_timeout: ODVInput[float] = DEFAULT_NONE, @@ -6151,6 +6305,10 @@ async def pin_chat_message( disable_notification (:obj:`bool`, optional): Pass :obj:`True`, if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats. + business_connection_id (:obj:`str`, optional): Unique identifier of the business + connection on behalf of which the message will be pinned. + + .. versionadded:: 21.5 Returns: :obj:`bool`: On success, :obj:`True` is returned. @@ -6163,6 +6321,7 @@ async def pin_chat_message( "chat_id": chat_id, "message_id": message_id, "disable_notification": disable_notification, + "business_connection_id": business_connection_id, } return await self._post( @@ -6179,6 +6338,7 @@ async def unpin_chat_message( self, chat_id: Union[str, int], message_id: Optional[int] = None, + business_connection_id: Optional[str] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, write_timeout: ODVInput[float] = DEFAULT_NONE, @@ -6195,8 +6355,13 @@ async def unpin_chat_message( Args: chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| - message_id (:obj:`int`, optional): Identifier of a message to unpin. If not specified, + message_id (:obj:`int`, optional): Identifier of the message to unpin. Required if + :paramref:`business_connection_id` is specified. If not specified, the most recent pinned message (by sending date) will be unpinned. + business_connection_id (:obj:`str`, optional): Unique identifier of the business + connection on behalf of which the message will be unpinned. + + .. versionadded:: 21.5 Returns: :obj:`bool`: On success, :obj:`True` is returned. @@ -6205,7 +6370,11 @@ async def unpin_chat_message( :class:`telegram.error.TelegramError` """ - data: JSONDict = {"chat_id": chat_id, "message_id": message_id} + data: JSONDict = { + "chat_id": chat_id, + "message_id": message_id, + "business_connection_id": business_connection_id, + } return await self._post( "unpinChatMessage", @@ -6298,7 +6467,7 @@ async def get_custom_emoji_stickers( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple[Sticker, ...]: + ) -> tuple[Sticker, ...]: """ Use this method to get information about emoji stickers by their identifiers. @@ -6314,7 +6483,7 @@ async def get_custom_emoji_stickers( |sequenceargs| Returns: - Tuple[:class:`telegram.Sticker`] + tuple[:class:`telegram.Sticker`] Raises: :class:`telegram.error.TelegramError` @@ -6354,8 +6523,9 @@ async def upload_sticker_file( Args: user_id (:obj:`int`): User identifier of sticker file owner. - sticker (:obj:`str` | :term:`file object` | :obj:`bytes` | :class:`pathlib.Path`): - A file with the sticker in the ``".WEBP"``, ``".PNG"``, ``".TGS"`` or ``".WEBM"`` + sticker (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | \ + :obj:`bytes` | :class:`pathlib.Path`): A file with the sticker in the + ``".WEBP"``, ``".PNG"``, ``".TGS"`` or ``".WEBM"`` format. See `here `_ for technical requirements . |uploadinput| @@ -6679,8 +6849,9 @@ async def set_sticker_set_thumbnail( .. versionadded:: 21.1 - thumbnail (:obj:`str` | :term:`file object` | :obj:`bytes` | :class:`pathlib.Path`, \ - optional): A **.WEBP** or **.PNG** image with the thumbnail, must + thumbnail (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | \ + :obj:`bytes` | :class:`pathlib.Path`, optional): A **.WEBP** or **.PNG** image + with the thumbnail, must be up to :tg-const:`telegram.constants.StickerSetLimit.MAX_STATIC_THUMBNAIL_SIZE` kilobytes in size and have width and height of exactly :tg-const:`telegram.constants.StickerSetLimit.STATIC_THUMB_DIMENSIONS` px, or a @@ -6988,7 +7159,7 @@ async def send_poll( explanation: Optional[str] = None, explanation_parse_mode: ODVInput[str] = DEFAULT_NONE, open_period: Optional[int] = None, - close_date: Optional[Union[int, datetime]] = None, + close_date: Optional[Union[int, dtm.datetime]] = None, explanation_entities: Optional[Sequence["MessageEntity"]] = None, protect_content: ODVInput[bool] = DEFAULT_NONE, message_thread_id: Optional[int] = None, @@ -6997,6 +7168,7 @@ async def send_poll( question_parse_mode: ODVInput[str] = DEFAULT_NONE, question_entities: Optional[Sequence["MessageEntity"]] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -7058,9 +7230,7 @@ async def send_poll( :tg-const:`telegram.Poll.MIN_OPEN_PERIOD` and no more than :tg-const:`telegram.Poll.MAX_OPEN_PERIOD` seconds in the future. Can't be used together with :paramref:`open_period`. - For timezone naive :obj:`datetime.datetime` objects, the default timezone of the - bot will be used, which is UTC unless :attr:`telegram.ext.Defaults.tzinfo` is - used. + |tz-naive-dtms| is_closed (:obj:`bool`, optional): Pass :obj:`True`, if the poll needs to be immediately closed. This can be useful for poll preview. disable_notification (:obj:`bool`, optional): |disable_notification| @@ -7094,6 +7264,9 @@ async def send_poll( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -7160,6 +7333,7 @@ async def send_poll( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def stop_poll( @@ -7223,6 +7397,7 @@ async def send_dice( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -7272,6 +7447,9 @@ async def send_dice( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -7320,6 +7498,7 @@ async def send_dice( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def get_my_default_administrator_rights( @@ -7383,8 +7562,9 @@ async def set_my_default_administrator_rights( .. versionadded:: 20.0 Args: - rights (:obj:`telegram.ChatAdministratorRights`, optional): A - :obj:`telegram.ChatAdministratorRights` object describing new default administrator + rights (:class:`telegram.ChatAdministratorRights`, optional): A + :class:`telegram.ChatAdministratorRights` object describing new default + administrator rights. If not specified, the default administrator rights will be cleared. for_channels (:obj:`bool`, optional): Pass :obj:`True` to change the default administrator rights of the bot in channels. Otherwise, the default administrator @@ -7394,7 +7574,7 @@ async def set_my_default_administrator_rights( :obj:`bool`: Returns :obj:`True` on success. Raises: - :obj:`telegram.error.TelegramError` + :exc:`telegram.error.TelegramError` """ data: JSONDict = {"rights": rights, "for_channels": for_channels} @@ -7418,7 +7598,7 @@ async def get_my_commands( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple[BotCommand, ...]: + ) -> tuple[BotCommand, ...]: """ Use this method to get the current list of the bot's commands for the given scope and user language. @@ -7440,7 +7620,7 @@ async def get_my_commands( .. versionadded:: 13.7 Returns: - Tuple[:class:`telegram.BotCommand`]: On success, the commands set for the bot. An empty + tuple[:class:`telegram.BotCommand`]: On success, the commands set for the bot. An empty tuple is returned if commands are not set. Raises: @@ -7463,7 +7643,7 @@ async def get_my_commands( async def set_my_commands( self, - commands: Sequence[Union[BotCommand, Tuple[str, str]]], + commands: Sequence[Union[BotCommand, tuple[str, str]]], scope: Optional[BotCommandScope] = None, language_code: Optional[str] = None, *, @@ -7649,6 +7829,7 @@ async def copy_message( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, show_caption_above_media: Optional[bool] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -7696,6 +7877,9 @@ async def copy_message( show_caption_above_media (:obj:`bool`, optional): Pass |show_cap_above_med| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -7754,6 +7938,7 @@ async def copy_message( "message_thread_id": message_thread_id, "reply_parameters": reply_parameters, "show_caption_above_media": show_caption_above_media, + "allow_paid_broadcast": allow_paid_broadcast, } result = await self._post( @@ -7782,7 +7967,7 @@ async def copy_messages( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["MessageId", ...]: + ) -> tuple["MessageId", ...]: """ Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway @@ -7810,7 +7995,7 @@ async def copy_messages( their captions. Returns: - Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` + tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` of the sent messages is returned. Raises: @@ -7940,6 +8125,8 @@ async def create_invoice_link( send_phone_number_to_provider: Optional[bool] = None, send_email_to_provider: Optional[bool] = None, is_flexible: Optional[bool] = None, + subscription_period: Optional[Union[int, dtm.timedelta]] = None, + business_connection_id: Optional[str] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, write_timeout: ODVInput[float] = DEFAULT_NONE, @@ -7952,6 +8139,10 @@ async def create_invoice_link( .. versionadded:: 20.0 Args: + business_connection_id (:obj:`str`, optional): |business_id_str| + For payments in |tg_stars| only. + + .. versionadded:: 21.8 title (:obj:`str`): Product name. :tg-const:`telegram.Invoice.MIN_TITLE_LENGTH`- :tg-const:`telegram.Invoice.MAX_TITLE_LENGTH` characters. description (:obj:`str`): Product description. @@ -7960,7 +8151,7 @@ async def create_invoice_link( payload (:obj:`str`): Bot-defined invoice payload. :tg-const:`telegram.Invoice.MIN_PAYLOAD_LENGTH`- :tg-const:`telegram.Invoice.MAX_PAYLOAD_LENGTH` bytes. This will not be - displayed to the user, use for your internal processes. + displayed to the user, use it for your internal processes. provider_token (:obj:`str`): Payments provider token, obtained via `@BotFather `_. Pass an empty string for payments in |tg_stars|. @@ -7978,6 +8169,18 @@ async def create_invoice_link( .. versionchanged:: 20.0 |sequenceargs| + subscription_period (:obj:`int` | :class:`datetime.timedelta`, optional): The time the + subscription will be active for before the next payment, either as number of + seconds or as :class:`datetime.timedelta` object. The currency must be set to + ``“XTR”`` (Telegram Stars) if the parameter is used. Currently, it must always be + :tg-const:`telegram.constants.InvoiceLimit.SUBSCRIPTION_PERIOD` if specified. Any + number of subscriptions can be active for a given bot at the same time, including + multiple concurrent subscriptions from the same user. Subscription price must + not exceed + :tg-const:`telegram.constants.InvoiceLimit.SUBSCRIPTION_MAX_PRICE` + Telegram Stars. + + .. versionadded:: 21.8 max_tip_amount (:obj:`int`, optional): The maximum accepted amount for tips in the *smallest units* of the currency (integer, **not** float/double). For example, for a maximum tip of ``US$ 1.45`` pass ``max_tip_amount = 145``. See the ``exp`` @@ -8043,6 +8246,12 @@ async def create_invoice_link( "is_flexible": is_flexible, "send_phone_number_to_provider": send_phone_number_to_provider, "send_email_to_provider": send_email_to_provider, + "subscription_period": ( + subscription_period.total_seconds() + if isinstance(subscription_period, dtm.timedelta) + else subscription_period + ), + "business_connection_id": business_connection_id, } return await self._post( @@ -8063,14 +8272,14 @@ async def get_forum_topic_icon_stickers( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple[Sticker, ...]: + ) -> tuple[Sticker, ...]: """Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. .. versionadded:: 20.0 Returns: - Tuple[:class:`telegram.Sticker`] + tuple[:class:`telegram.Sticker`] Raises: :class:`telegram.error.TelegramError` @@ -8160,7 +8369,7 @@ async def edit_forum_topic( ) -> bool: """ Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must - be an administrator in the chat for this to work and must have + be an administrator in the chat for this to work and must have the :paramref:`~telegram.ChatAdministratorRights.can_manage_topics` administrator rights, unless it is the creator of the topic. @@ -8428,7 +8637,7 @@ async def edit_general_forum_topic( ) -> bool: """ Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot - must be an administrator in the chat for this to work and must have + must be an administrator in the chat for this to work and must have the :attr:`~telegram.ChatAdministratorRights.can_manage_topics` administrator rights. .. versionadded:: 20.0 @@ -8927,7 +9136,7 @@ async def set_message_reaction( """ Use this method to change the chosen reactions on a message. Service messages can't be reacted to. Automatically forwarded messages from a channel to its discussion group have - the same available reactions as messages in the channel. + the same available reactions as messages in the channel. Bots can't use paid reactions. .. versionadded:: 20.8 @@ -8940,7 +9149,8 @@ async def set_message_reaction( :class:`telegram.ReactionType` | :obj:`str`, optional): A list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either - already present on the message or explicitly allowed by chat administrators. + already present on the message or explicitly allowed by chat administrators. Paid + reactions can't be used by bots. Tip: Passed :obj:`str` values will be converted to either @@ -8958,7 +9168,7 @@ async def set_message_reaction( Raises: :class:`telegram.error.TelegramError` """ - allowed_reactions: Set[str] = set(ReactionEmoji) + allowed_reactions: set[str] = set(ReactionEmoji) parsed_reaction = ( [ ( @@ -9057,7 +9267,7 @@ async def replace_sticker_in_set( user_id (:obj:`int`): User identifier of the sticker set owner. name (:obj:`str`): Sticker set name. old_sticker (:obj:`str`): File identifier of the replaced sticker. - sticker (:obj:`telegram.InputSticker`): An object with information about the added + sticker (:class:`telegram.InputSticker`): An object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set remains unchanged. @@ -9169,6 +9379,53 @@ async def get_star_transactions( bot=self, ) + async def edit_user_star_subscription( + self, + user_id: int, + telegram_payment_charge_id: str, + is_canceled: bool, + *, + read_timeout: ODVInput[float] = DEFAULT_NONE, + write_timeout: ODVInput[float] = DEFAULT_NONE, + connect_timeout: ODVInput[float] = DEFAULT_NONE, + pool_timeout: ODVInput[float] = DEFAULT_NONE, + api_kwargs: Optional[JSONDict] = None, + ) -> bool: + """Allows the bot to cancel or re-enable extension of a subscription paid in Telegram + Stars. + + .. versionadded:: 21.8 + + Args: + user_id (:obj:`int`): Identifier of the user whose subscription will be edited. + telegram_payment_charge_id (:obj:`str`): Telegram payment identifier for the + subscription. + is_canceled (:obj:`bool`): Pass :obj:`True` to cancel extension of the user + subscription; the subscription must be active up to the end of the current + subscription period. Pass :obj:`False` to allow the user to re-enable a + subscription that was previously canceled by the bot. + + Returns: + :obj:`bool`: On success, :obj:`True` is returned. + + Raises: + :class:`telegram.error.TelegramError` + """ + data: JSONDict = { + "user_id": user_id, + "telegram_payment_charge_id": telegram_payment_charge_id, + "is_canceled": is_canceled, + } + return await self._post( + "editUserStartSubscription", + data, + read_timeout=read_timeout, + write_timeout=write_timeout, + connect_timeout=connect_timeout, + pool_timeout=pool_timeout, + api_kwargs=api_kwargs, + ) + async def send_paid_media( self, chat_id: Union[str, int], @@ -9182,6 +9439,9 @@ async def send_paid_media( protect_content: ODVInput[bool] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, reply_markup: Optional[ReplyMarkup] = None, + business_connection_id: Optional[str] = None, + payload: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -9191,16 +9451,24 @@ async def send_paid_media( pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, ) -> Message: - """Use this method to send paid media to channel chats. + """Use this method to send paid media. .. versionadded:: 21.4 Args: - chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| + chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| If the chat is a channel, all + Telegram Star proceeds from this media will be credited to the chat's balance. + Otherwise, they will be credited to the bot's balance. star_count (:obj:`int`): The number of Telegram Stars that must be paid to buy access - to the media. + to the media; :tg-const:`telegram.constants.InvoiceLimit.MIN_STAR_COUNT` - + :tg-const:`telegram.constants.InvoiceLimit.MAX_STAR_COUNT`. media (Sequence[:class:`telegram.InputPaidMedia`]): A list describing the media to be sent; up to :tg-const:`telegram.constants.MediaGroupLimit.MAX_MEDIA_LENGTH` items. + payload (:obj:`str`, optional): Bot-defined paid media payload, + 0-:tg-const:`telegram.constants.InvoiceLimit.MAX_PAYLOAD_LENGTH` bytes. This will + not be displayed to the user, use it for your internal processes. + + .. versionadded:: 21.6 caption (:obj:`str`, optional): Caption of the media to be sent, 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters. parse_mode (:obj:`str`, optional): |parse_mode| @@ -9214,6 +9482,12 @@ async def send_paid_media( :class:`ReplyKeyboardRemove` | :class:`ForceReply`, optional): Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. + business_connection_id (:obj:`str`, optional): |business_id_str| + + .. versionadded:: 21.5 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -9236,6 +9510,7 @@ async def send_paid_media( "star_count": star_count, "media": media, "show_caption_above_media": show_caption_above_media, + "payload": payload, } return await self._send_message( @@ -9255,6 +9530,214 @@ async def send_paid_media( connect_timeout=connect_timeout, pool_timeout=pool_timeout, api_kwargs=api_kwargs, + business_connection_id=business_connection_id, + allow_paid_broadcast=allow_paid_broadcast, + ) + + async def create_chat_subscription_invite_link( + self, + chat_id: Union[str, int], + subscription_period: int, + subscription_price: int, + name: Optional[str] = None, + *, + read_timeout: ODVInput[float] = DEFAULT_NONE, + write_timeout: ODVInput[float] = DEFAULT_NONE, + connect_timeout: ODVInput[float] = DEFAULT_NONE, + pool_timeout: ODVInput[float] = DEFAULT_NONE, + api_kwargs: Optional[JSONDict] = None, + ) -> ChatInviteLink: + """ + Use this method to create a `subscription invite link `_ for a channel chat. + The bot must have the :attr:`~telegram.ChatPermissions.can_invite_users` administrator + right. The link can be edited using the :meth:`edit_chat_subscription_invite_link` or + revoked using the :meth:`revoke_chat_invite_link`. + + .. versionadded:: 21.5 + + Args: + chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| + subscription_period (:obj:`int`): The number of seconds the subscription will be + active for before the next payment. Currently, it must always be + :tg-const:`telegram.constants.ChatSubscriptionLimit.SUBSCRIPTION_PERIOD` (30 days). + subscription_price (:obj:`int`): The number of Telegram Stars a user must pay initially + and after each subsequent subscription period to be a member of the chat; + :tg-const:`telegram.constants.ChatSubscriptionLimit.MIN_PRICE`- + :tg-const:`telegram.constants.ChatSubscriptionLimit.MAX_PRICE`. + name (:obj:`str`, optional): Invite link name; + 0-:tg-const:`telegram.constants.ChatInviteLinkLimit.NAME_LENGTH` characters. + + Returns: + :class:`telegram.ChatInviteLink` + + Raises: + :class:`telegram.error.TelegramError` + + """ + data: JSONDict = { + "chat_id": chat_id, + "subscription_period": subscription_period, + "subscription_price": subscription_price, + "name": name, + } + + result = await self._post( + "createChatSubscriptionInviteLink", + data, + read_timeout=read_timeout, + write_timeout=write_timeout, + connect_timeout=connect_timeout, + pool_timeout=pool_timeout, + api_kwargs=api_kwargs, + ) + + return ChatInviteLink.de_json(result, self) # type: ignore[return-value] + + async def edit_chat_subscription_invite_link( + self, + chat_id: Union[str, int], + invite_link: Union[str, "ChatInviteLink"], + name: Optional[str] = None, + *, + read_timeout: ODVInput[float] = DEFAULT_NONE, + write_timeout: ODVInput[float] = DEFAULT_NONE, + connect_timeout: ODVInput[float] = DEFAULT_NONE, + pool_timeout: ODVInput[float] = DEFAULT_NONE, + api_kwargs: Optional[JSONDict] = None, + ) -> ChatInviteLink: + """ + Use this method to edit a subscription invite link created by the bot. The bot must have + :attr:`telegram.ChatPermissions.can_invite_users` administrator right. + + .. versionadded:: 21.5 + + Args: + chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| + invite_link (:obj:`str` | :obj:`telegram.ChatInviteLink`): The invite link to edit. + name (:obj:`str`, optional): Invite link name; + 0-:tg-const:`telegram.constants.ChatInviteLinkLimit.NAME_LENGTH` characters. + + Tip: + Omitting this argument removes the name of the invite link. + + Returns: + :class:`telegram.ChatInviteLink` + + Raises: + :class:`telegram.error.TelegramError` + + """ + link = invite_link.invite_link if isinstance(invite_link, ChatInviteLink) else invite_link + data: JSONDict = { + "chat_id": chat_id, + "invite_link": link, + "name": name, + } + + result = await self._post( + "editChatSubscriptionInviteLink", + data, + read_timeout=read_timeout, + write_timeout=write_timeout, + connect_timeout=connect_timeout, + pool_timeout=pool_timeout, + api_kwargs=api_kwargs, + ) + + return ChatInviteLink.de_json(result, self) # type: ignore[return-value] + + async def get_available_gifts( + self, + *, + read_timeout: ODVInput[float] = DEFAULT_NONE, + write_timeout: ODVInput[float] = DEFAULT_NONE, + connect_timeout: ODVInput[float] = DEFAULT_NONE, + pool_timeout: ODVInput[float] = DEFAULT_NONE, + api_kwargs: Optional[JSONDict] = None, + ) -> Gifts: + """Returns the list of gifts that can be sent by the bot to users. + Requires no parameters. + + .. versionadded:: 21.8 + + Returns: + :class:`telegram.Gifts` + + Raises: + :class:`telegram.error.TelegramError` + """ + return Gifts.de_json( # type: ignore[return-value] + await self._post( + "getAvailableGifts", + read_timeout=read_timeout, + write_timeout=write_timeout, + connect_timeout=connect_timeout, + pool_timeout=pool_timeout, + api_kwargs=api_kwargs, + ) + ) + + async def send_gift( + self, + user_id: int, + gift_id: Union[str, Gift], + text: Optional[str] = None, + text_parse_mode: ODVInput[str] = DEFAULT_NONE, + text_entities: Optional[Sequence["MessageEntity"]] = None, + *, + read_timeout: ODVInput[float] = DEFAULT_NONE, + write_timeout: ODVInput[float] = DEFAULT_NONE, + connect_timeout: ODVInput[float] = DEFAULT_NONE, + pool_timeout: ODVInput[float] = DEFAULT_NONE, + api_kwargs: Optional[JSONDict] = None, + ) -> bool: + """Sends a gift to the given user. + The gift can't be converted to Telegram Stars by the user + + .. versionadded:: 21.8 + + Args: + user_id (:obj:`int`): Unique identifier of the target user that will receive the gift + gift_id (:obj:`str` | :class:`~telegram.Gift`): Identifier of the gift or a + :class:`~telegram.Gift` object + text (:obj:`str`, optional): Text that will be shown along with the gift; + 0- :tg-const:`telegram.constants.GiftLimit.MAX_TEXT_LENGTH` characters + text_parse_mode (:obj:`str`, optional): Mode for parsing entities. + See :class:`telegram.constants.ParseMode` and + `formatting options `__ for + more details. Entities other than :attr:`~MessageEntity.BOLD`, + :attr:`~MessageEntity.ITALIC`, :attr:`~MessageEntity.UNDERLINE`, + :attr:`~MessageEntity.STRIKETHROUGH`, :attr:`~MessageEntity.SPOILER`, and + :attr:`~MessageEntity.CUSTOM_EMOJI` are ignored. + text_entities (Sequence[:class:`telegram.MessageEntity`], optional): A list of special + entities that appear in the gift text. It can be specified instead of + :paramref:`text_parse_mode`. Entities other than :attr:`~MessageEntity.BOLD`, + :attr:`~MessageEntity.ITALIC`, :attr:`~MessageEntity.UNDERLINE`, + :attr:`~MessageEntity.STRIKETHROUGH`, :attr:`~MessageEntity.SPOILER`, and + :attr:`~MessageEntity.CUSTOM_EMOJI` are ignored. + + Returns: + :obj:`bool`: On success, :obj:`True` is returned. + + Raises: + :class:`telegram.error.TelegramError` + """ + data: JSONDict = { + "user_id": user_id, + "gift_id": gift_id.id if isinstance(gift_id, Gift) else gift_id, + "text": text, + "text_parse_mode": text_parse_mode, + "text_entities": text_entities, + } + return await self._post( + "sendGift", + data, + read_timeout=read_timeout, + write_timeout=write_timeout, + connect_timeout=connect_timeout, + pool_timeout=pool_timeout, + api_kwargs=api_kwargs, ) def to_dict(self, recursive: bool = True) -> JSONDict: # noqa: ARG002 @@ -9313,6 +9796,8 @@ def to_dict(self, recursive: bool = True) -> JSONDict: # noqa: ARG002 """Alias for :meth:`send_chat_action`""" answerInlineQuery = answer_inline_query """Alias for :meth:`answer_inline_query`""" + savePreparedInlineMessage = save_prepared_inline_message + """Alias for :meth:`save_prepared_inline_message`""" getUserProfilePhotos = get_user_profile_photos """Alias for :meth:`get_user_profile_photos`""" getFile = get_file @@ -9397,6 +9882,8 @@ def to_dict(self, recursive: bool = True) -> JSONDict: # noqa: ARG002 """Alias for :meth:`set_chat_title`""" setChatDescription = set_chat_description """Alias for :meth:`set_chat_description`""" + setUserEmojiStatus = set_user_emoji_status + """Alias for :meth:`set_user_emoji_status`""" pinChatMessage = pin_chat_message """Alias for :meth:`pin_chat_message`""" unpinChatMessage = unpin_chat_message @@ -9511,5 +9998,15 @@ def to_dict(self, recursive: bool = True) -> JSONDict: # noqa: ARG002 """Alias for :meth:`refund_star_payment`""" getStarTransactions = get_star_transactions """Alias for :meth:`get_star_transactions`""" + editUserStarSubscription = edit_user_star_subscription + """Alias for :meth:`edit_user_star_subscription`""" sendPaidMedia = send_paid_media """Alias for :meth:`send_paid_media`""" + createChatSubscriptionInviteLink = create_chat_subscription_invite_link + """Alias for :meth:`create_chat_subscription_invite_link`""" + editChatSubscriptionInviteLink = edit_chat_subscription_invite_link + """Alias for :meth:`edit_chat_subscription_invite_link`""" + getAvailableGifts = get_available_gifts + """Alias for :meth:`get_available_gifts`""" + sendGift = send_gift + """Alias for :meth:`send_gift`""" diff --git a/telegram/_botcommandscope.py b/telegram/_botcommandscope.py index 73cafd17599..8d068802ca0 100644 --- a/telegram/_botcommandscope.py +++ b/telegram/_botcommandscope.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. # pylint: disable=redefined-builtin """This module contains objects representing Telegram bot command scopes.""" -from typing import TYPE_CHECKING, Dict, Final, Optional, Type, Union +from typing import TYPE_CHECKING, Final, Optional, Union from telegram import constants from telegram._telegramobject import TelegramObject @@ -91,7 +91,7 @@ def de_json( care of selecting the correct subclass. Args: - data (Dict[:obj:`str`, ...]): The JSON data. + data (dict[:obj:`str`, ...]): The JSON data. bot (:class:`telegram.Bot`, optional): The bot associated with this object. Defaults to :obj:`None`, in which case shortcut methods will not be available. @@ -107,7 +107,7 @@ def de_json( if not data: return None - _class_mapping: Dict[str, Type[BotCommandScope]] = { + _class_mapping: dict[str, type[BotCommandScope]] = { cls.DEFAULT: BotCommandScopeDefault, cls.ALL_PRIVATE_CHATS: BotCommandScopeAllPrivateChats, cls.ALL_GROUP_CHATS: BotCommandScopeAllGroupChats, diff --git a/telegram/_business.py b/telegram/_business.py index 22c89e024b4..28075e9b580 100644 --- a/telegram/_business.py +++ b/telegram/_business.py @@ -18,9 +18,9 @@ # 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 Telegram Business related classes.""" - -from datetime import datetime -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +import datetime as dtm +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._chat import Chat from telegram._files.location import Location @@ -80,7 +80,7 @@ def __init__( id: str, user: "User", user_chat_id: int, - date: datetime, + date: dtm.datetime, can_reply: bool, is_enabled: bool, *, @@ -90,7 +90,7 @@ def __init__( self.id: str = id self.user: User = user self.user_chat_id: int = user_chat_id - self.date: datetime = date + self.date: dtm.datetime = date self.can_reply: bool = can_reply self.is_enabled: bool = is_enabled @@ -145,7 +145,7 @@ class BusinessMessagesDeleted(TelegramObject): business_connection_id (:obj:`str`): Unique identifier of the business connection. chat (:class:`telegram.Chat`): Information about a chat in the business account. The bot may not have access to the chat or the corresponding user. - message_ids (Tuple[:obj:`int`]): A list of identifiers of the deleted messages in the + message_ids (tuple[:obj:`int`]): A list of identifiers of the deleted messages in the chat of the business account. """ @@ -166,7 +166,7 @@ def __init__( super().__init__(api_kwargs=api_kwargs) self.business_connection_id: str = business_connection_id self.chat: Chat = chat - self.message_ids: Tuple[int, ...] = parse_sequence_arg(message_ids) + self.message_ids: tuple[int, ...] = parse_sequence_arg(message_ids) self._id_attrs = ( self.business_connection_id, @@ -359,37 +359,37 @@ def __init__( self.opening_minute: int = opening_minute self.closing_minute: int = closing_minute - self._opening_time: Optional[Tuple[int, int, int]] = None - self._closing_time: Optional[Tuple[int, int, int]] = None + self._opening_time: Optional[tuple[int, int, int]] = None + self._closing_time: Optional[tuple[int, int, int]] = None self._id_attrs = (self.opening_minute, self.closing_minute) self._freeze() - def _parse_minute(self, minute: int) -> Tuple[int, int, int]: + def _parse_minute(self, minute: int) -> tuple[int, int, int]: return (minute // 1440, minute % 1440 // 60, minute % 1440 % 60) @property - def opening_time(self) -> Tuple[int, int, int]: + def opening_time(self) -> tuple[int, int, int]: """Convenience attribute. A :obj:`tuple` parsed from :attr:`opening_minute`. It contains the `weekday`, `hour` and `minute` in the same ranges as :attr:`datetime.datetime.weekday`, :attr:`datetime.datetime.hour` and :attr:`datetime.datetime.minute` Returns: - Tuple[:obj:`int`, :obj:`int`, :obj:`int`]: + tuple[:obj:`int`, :obj:`int`, :obj:`int`]: """ if self._opening_time is None: self._opening_time = self._parse_minute(self.opening_minute) return self._opening_time @property - def closing_time(self) -> Tuple[int, int, int]: + def closing_time(self) -> tuple[int, int, int]: """Convenience attribute. A :obj:`tuple` parsed from :attr:`closing_minute`. It contains the `weekday`, `hour` and `minute` in the same ranges as :attr:`datetime.datetime.weekday`, :attr:`datetime.datetime.hour` and :attr:`datetime.datetime.minute` Returns: - Tuple[:obj:`int`, :obj:`int`, :obj:`int`]: + tuple[:obj:`int`, :obj:`int`, :obj:`int`]: """ if self._closing_time is None: self._closing_time = self._parse_minute(self.closing_minute) diff --git a/telegram/_callbackquery.py b/telegram/_callbackquery.py index bdfa569dbfd..9264feaaa8f 100644 --- a/telegram/_callbackquery.py +++ b/telegram/_callbackquery.py @@ -18,7 +18,8 @@ # 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 CallbackQuery""" -from typing import TYPE_CHECKING, Final, Optional, Sequence, Tuple, Union +from collections.abc import Sequence +from typing import TYPE_CHECKING, Final, Optional, Union from telegram import constants from telegram._files.location import Location @@ -676,7 +677,7 @@ async def get_game_high_scores( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["GameHighScore", ...]: + ) -> tuple["GameHighScore", ...]: """Shortcut for either:: await update.callback_query.message.get_game_high_score(*args, **kwargs) @@ -695,7 +696,7 @@ async def get_game_high_scores( Raises :exc:`TypeError` if :attr:`message` is not accessible. Returns: - Tuple[:class:`telegram.GameHighScore`] + tuple[:class:`telegram.GameHighScore`] Raises: :exc:`TypeError` if :attr:`message` is not accessible. @@ -833,6 +834,7 @@ async def copy_message( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, show_caption_above_media: Optional[bool] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -880,6 +882,7 @@ async def copy_message( message_thread_id=message_thread_id, reply_parameters=reply_parameters, show_caption_above_media=show_caption_above_media, + allow_paid_broadcast=allow_paid_broadcast, ) MAX_ANSWER_TEXT_LENGTH: Final[int] = ( diff --git a/telegram/_chat.py b/telegram/_chat.py index 200e192c95f..1ae884bb6b9 100644 --- a/telegram/_chat.py +++ b/telegram/_chat.py @@ -18,9 +18,10 @@ # 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 Chat.""" -from datetime import datetime +import datetime as dtm +from collections.abc import Sequence from html import escape -from typing import TYPE_CHECKING, Final, Optional, Sequence, Tuple, Union +from typing import TYPE_CHECKING, Final, Optional, Union from telegram import constants from telegram._chatpermissions import ChatPermissions @@ -43,6 +44,7 @@ ChatMember, Contact, Document, + Gift, InlineKeyboardMarkup, InputMediaAudio, InputMediaDocument, @@ -296,7 +298,7 @@ async def get_administrators( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["ChatMember", ...]: + ) -> tuple["ChatMember", ...]: """Shortcut for:: await bot.get_chat_administrators(update.effective_chat.id, *args, **kwargs) @@ -305,7 +307,7 @@ async def get_administrators( :meth:`telegram.Bot.get_chat_administrators`. Returns: - Tuple[:class:`telegram.ChatMember`]: A tuple of administrators in a chat. An Array of + tuple[:class:`telegram.ChatMember`]: A tuple of administrators in a chat. An Array of :class:`telegram.ChatMember` objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned. @@ -382,7 +384,7 @@ async def ban_member( self, user_id: int, revoke_messages: Optional[bool] = None, - until_date: Optional[Union[int, datetime]] = None, + until_date: Optional[Union[int, dtm.datetime]] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, write_timeout: ODVInput[float] = DEFAULT_NONE, @@ -654,7 +656,7 @@ async def restrict_member( self, user_id: int, permissions: ChatPermissions, - until_date: Optional[Union[int, datetime]] = None, + until_date: Optional[Union[int, dtm.datetime]] = None, use_independent_chat_permissions: Optional[bool] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, @@ -905,6 +907,7 @@ async def pin_message( self, message_id: int, disable_notification: ODVInput[bool] = DEFAULT_NONE, + business_connection_id: Optional[str] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, write_timeout: ODVInput[float] = DEFAULT_NONE, @@ -932,11 +935,13 @@ async def pin_message( connect_timeout=connect_timeout, pool_timeout=pool_timeout, api_kwargs=api_kwargs, + business_connection_id=business_connection_id, ) async def unpin_message( self, message_id: Optional[int] = None, + business_connection_id: Optional[str] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, write_timeout: ODVInput[float] = DEFAULT_NONE, @@ -963,6 +968,7 @@ async def unpin_message( pool_timeout=pool_timeout, api_kwargs=api_kwargs, message_id=message_id, + business_connection_id=business_connection_id, ) async def unpin_all_messages( @@ -1007,6 +1013,7 @@ async def send_message( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1048,6 +1055,7 @@ async def send_message( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def delete_message( @@ -1125,6 +1133,7 @@ async def send_media_group( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1136,7 +1145,7 @@ async def send_media_group( caption: Optional[str] = None, parse_mode: ODVInput[str] = DEFAULT_NONE, caption_entities: Optional[Sequence["MessageEntity"]] = None, - ) -> Tuple["Message", ...]: + ) -> tuple["Message", ...]: """Shortcut for:: await bot.send_media_group(update.effective_chat.id, *args, **kwargs) @@ -1144,7 +1153,7 @@ async def send_media_group( For the documentation of the arguments, please see :meth:`telegram.Bot.send_media_group`. Returns: - Tuple[:class:`telegram.Message`]: On success, a tuple of :class:`~telegram.Message` + tuple[:class:`telegram.Message`]: On success, a tuple of :class:`~telegram.Message` instances that were sent is returned. """ @@ -1167,6 +1176,7 @@ async def send_media_group( reply_parameters=reply_parameters, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_chat_action( @@ -1220,6 +1230,7 @@ async def send_photo( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -1263,6 +1274,7 @@ async def send_photo( has_spoiler=has_spoiler, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -1279,6 +1291,7 @@ async def send_contact( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1320,6 +1333,7 @@ async def send_contact( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_audio( @@ -1339,6 +1353,7 @@ async def send_audio( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1384,6 +1399,7 @@ async def send_audio( thumbnail=thumbnail, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_document( @@ -1401,6 +1417,7 @@ async def send_document( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1444,6 +1461,7 @@ async def send_document( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_dice( @@ -1456,6 +1474,7 @@ async def send_dice( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1492,6 +1511,7 @@ async def send_dice( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_game( @@ -1504,6 +1524,7 @@ async def send_game( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1540,6 +1561,7 @@ async def send_game( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_invoice( @@ -1571,6 +1593,7 @@ async def send_invoice( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1636,6 +1659,7 @@ async def send_invoice( message_thread_id=message_thread_id, reply_parameters=reply_parameters, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_location( @@ -1653,6 +1677,7 @@ async def send_location( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1696,6 +1721,7 @@ async def send_location( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_animation( @@ -1716,6 +1742,7 @@ async def send_animation( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -1763,6 +1790,7 @@ async def send_animation( thumbnail=thumbnail, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -1777,6 +1805,7 @@ async def send_sticker( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1814,6 +1843,7 @@ async def send_sticker( emoji=emoji, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_venue( @@ -1833,6 +1863,7 @@ async def send_venue( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1878,6 +1909,7 @@ async def send_venue( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_video( @@ -1899,6 +1931,7 @@ async def send_video( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -1947,6 +1980,7 @@ async def send_video( has_spoiler=has_spoiler, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -1963,6 +1997,7 @@ async def send_video_note( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2004,6 +2039,7 @@ async def send_video_note( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_voice( @@ -2020,6 +2056,7 @@ async def send_voice( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2062,6 +2099,7 @@ async def send_voice( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_poll( @@ -2078,7 +2116,7 @@ async def send_poll( explanation: Optional[str] = None, explanation_parse_mode: ODVInput[str] = DEFAULT_NONE, open_period: Optional[int] = None, - close_date: Optional[Union[int, datetime]] = None, + close_date: Optional[Union[int, dtm.datetime]] = None, explanation_entities: Optional[Sequence["MessageEntity"]] = None, protect_content: ODVInput[bool] = DEFAULT_NONE, message_thread_id: Optional[int] = None, @@ -2087,6 +2125,7 @@ async def send_poll( question_parse_mode: ODVInput[str] = DEFAULT_NONE, question_entities: Optional[Sequence["MessageEntity"]] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2124,6 +2163,7 @@ async def send_poll( connect_timeout=connect_timeout, pool_timeout=pool_timeout, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, explanation=explanation, explanation_parse_mode=explanation_parse_mode, open_period=open_period, @@ -2151,6 +2191,7 @@ async def send_copy( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, show_caption_above_media: Optional[bool] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2192,6 +2233,7 @@ async def send_copy( protect_content=protect_content, message_thread_id=message_thread_id, show_caption_above_media=show_caption_above_media, + allow_paid_broadcast=allow_paid_broadcast, ) async def copy_message( @@ -2207,6 +2249,7 @@ async def copy_message( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, show_caption_above_media: Optional[bool] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2248,6 +2291,7 @@ async def copy_message( protect_content=protect_content, message_thread_id=message_thread_id, show_caption_above_media=show_caption_above_media, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_copies( @@ -2264,7 +2308,7 @@ async def send_copies( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["MessageId", ...]: + ) -> tuple["MessageId", ...]: """Shortcut for:: await bot.copy_messages(chat_id=update.effective_chat.id, *args, **kwargs) @@ -2276,7 +2320,7 @@ async def send_copies( .. versionadded:: 20.8 Returns: - Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` + tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` of the sent messages is returned. """ @@ -2309,7 +2353,7 @@ async def copy_messages( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["MessageId", ...]: + ) -> tuple["MessageId", ...]: """Shortcut for:: await bot.copy_messages(from_chat_id=update.effective_chat.id, *args, **kwargs) @@ -2321,7 +2365,7 @@ async def copy_messages( .. versionadded:: 20.8 Returns: - Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` + tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` of the sent messages is returned. """ @@ -2438,7 +2482,7 @@ async def forward_messages_from( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["MessageId", ...]: + ) -> tuple["MessageId", ...]: """Shortcut for:: await bot.forward_messages(chat_id=update.effective_chat.id, *args, **kwargs) @@ -2450,7 +2494,7 @@ async def forward_messages_from( .. versionadded:: 20.8 Returns: - Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` + tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` of sent messages is returned. """ @@ -2481,7 +2525,7 @@ async def forward_messages_to( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["MessageId", ...]: + ) -> tuple["MessageId", ...]: """Shortcut for:: await bot.forward_messages(from_chat_id=update.effective_chat.id, *args, **kwargs) @@ -2493,7 +2537,7 @@ async def forward_messages_to( .. versionadded:: 20.8 Returns: - Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` + tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` of sent messages is returned. """ @@ -2544,7 +2588,7 @@ async def export_invite_link( async def create_invite_link( self, - expire_date: Optional[Union[int, datetime]] = None, + expire_date: Optional[Union[int, dtm.datetime]] = None, member_limit: Optional[int] = None, name: Optional[str] = None, creates_join_request: Optional[bool] = None, @@ -2588,7 +2632,7 @@ async def create_invite_link( async def edit_invite_link( self, invite_link: Union[str, "ChatInviteLink"], - expire_date: Optional[Union[int, datetime]] = None, + expire_date: Optional[Union[int, dtm.datetime]] = None, member_limit: Optional[int] = None, name: Optional[str] = None, creates_join_request: Optional[bool] = None, @@ -2662,6 +2706,81 @@ async def revoke_invite_link( api_kwargs=api_kwargs, ) + async def create_subscription_invite_link( + self, + subscription_period: int, + subscription_price: int, + name: Optional[str] = None, + *, + read_timeout: ODVInput[float] = DEFAULT_NONE, + write_timeout: ODVInput[float] = DEFAULT_NONE, + connect_timeout: ODVInput[float] = DEFAULT_NONE, + pool_timeout: ODVInput[float] = DEFAULT_NONE, + api_kwargs: Optional[JSONDict] = None, + ) -> "ChatInviteLink": + """Shortcut for:: + + await bot.create_chat_subscription_invite_link( + chat_id=update.effective_chat.id, *args, **kwargs + ) + + For the documentation of the arguments, please see + :meth:`telegram.Bot.create_chat_subscription_invite_link`. + + .. versionadded:: 21.5 + + Returns: + :class:`telegram.ChatInviteLink` + """ + return await self.get_bot().create_chat_subscription_invite_link( + chat_id=self.id, + subscription_period=subscription_period, + subscription_price=subscription_price, + name=name, + read_timeout=read_timeout, + write_timeout=write_timeout, + connect_timeout=connect_timeout, + pool_timeout=pool_timeout, + api_kwargs=api_kwargs, + ) + + async def edit_subscription_invite_link( + self, + invite_link: Union[str, "ChatInviteLink"], + name: Optional[str] = None, + *, + read_timeout: ODVInput[float] = DEFAULT_NONE, + write_timeout: ODVInput[float] = DEFAULT_NONE, + connect_timeout: ODVInput[float] = DEFAULT_NONE, + pool_timeout: ODVInput[float] = DEFAULT_NONE, + api_kwargs: Optional[JSONDict] = None, + ) -> "ChatInviteLink": + """Shortcut for:: + + await bot.edit_chat_subscription_invite_link( + chat_id=update.effective_chat.id, *args, **kwargs + ) + + For the documentation of the arguments, please see + :meth:`telegram.Bot.edit_chat_subscription_invite_link`. + + .. versionadded:: 21.5 + + Returns: + :class:`telegram.ChatInviteLink` + + """ + return await self.get_bot().edit_chat_subscription_invite_link( + chat_id=self.id, + invite_link=invite_link, + read_timeout=read_timeout, + write_timeout=write_timeout, + connect_timeout=connect_timeout, + pool_timeout=pool_timeout, + api_kwargs=api_kwargs, + name=name, + ) + async def approve_join_request( self, user_id: int, @@ -3270,6 +3389,9 @@ async def send_paid_media( protect_content: ODVInput[bool] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, reply_markup: Optional[ReplyMarkup] = None, + business_connection_id: Optional[str] = None, + payload: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -3310,6 +3432,49 @@ async def send_paid_media( connect_timeout=connect_timeout, pool_timeout=pool_timeout, api_kwargs=api_kwargs, + business_connection_id=business_connection_id, + payload=payload, + allow_paid_broadcast=allow_paid_broadcast, + ) + + async def send_gift( + self, + gift_id: Union[str, "Gift"], + text: Optional[str] = None, + text_parse_mode: ODVInput[str] = DEFAULT_NONE, + text_entities: Optional[Sequence["MessageEntity"]] = None, + *, + read_timeout: ODVInput[float] = DEFAULT_NONE, + write_timeout: ODVInput[float] = DEFAULT_NONE, + connect_timeout: ODVInput[float] = DEFAULT_NONE, + pool_timeout: ODVInput[float] = DEFAULT_NONE, + api_kwargs: Optional[JSONDict] = None, + ) -> bool: + """Shortcut for:: + + await bot.send_gift(user_id=update.effective_chat.id, *args, **kwargs ) + + For the documentation of the arguments, please see :meth:`telegram.Bot.send_gift`. + + Caution: + Can only work, if the chat is a private chat, see :attr:`type`. + + .. versionadded:: 21.8 + + Returns: + :obj:`bool`: On success, :obj:`True` is returned. + """ + return await self.get_bot().send_gift( + user_id=self.id, + gift_id=gift_id, + text=text, + text_parse_mode=text_parse_mode, + text_entities=text_entities, + read_timeout=read_timeout, + write_timeout=write_timeout, + connect_timeout=connect_timeout, + pool_timeout=pool_timeout, + api_kwargs=api_kwargs, ) diff --git a/telegram/_chatbackground.py b/telegram/_chatbackground.py index f9c77619f4c..148c628039d 100644 --- a/telegram/_chatbackground.py +++ b/telegram/_chatbackground.py @@ -17,7 +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/]. """This module contains objects related to chat backgrounds.""" -from typing import TYPE_CHECKING, Dict, Final, Optional, Sequence, Tuple, Type +from collections.abc import Sequence +from typing import TYPE_CHECKING, Final, Optional from telegram import constants from telegram._files.document import Document @@ -87,7 +88,7 @@ def de_json( if not data: return None - _class_mapping: Dict[str, Type[BackgroundFill]] = { + _class_mapping: dict[str, type[BackgroundFill]] = { cls.SOLID: BackgroundFillSolid, cls.GRADIENT: BackgroundFillGradient, cls.FREEFORM_GRADIENT: BackgroundFillFreeformGradient, @@ -212,7 +213,7 @@ def __init__( super().__init__(type=self.FREEFORM_GRADIENT, api_kwargs=api_kwargs) with self._unfrozen(): - self.colors: Tuple[int, ...] = parse_sequence_arg(colors) + self.colors: tuple[int, ...] = parse_sequence_arg(colors) self._id_attrs = (self.colors,) @@ -278,7 +279,7 @@ def de_json( if not data: return None - _class_mapping: Dict[str, Type[BackgroundType]] = { + _class_mapping: dict[str, type[BackgroundType]] = { cls.FILL: BackgroundTypeFill, cls.WALLPAPER: BackgroundTypeWallpaper, cls.PATTERN: BackgroundTypePattern, @@ -307,7 +308,7 @@ class BackgroundTypeFill(BackgroundType): .. versionadded:: 21.2 Args: - fill (:obj:`telegram.BackgroundFill`): The background fill. + fill (:class:`telegram.BackgroundFill`): The background fill. dark_theme_dimming (:obj:`int`): Dimming of the background in dark themes, as a percentage; 0-:tg-const:`telegram.constants.BackgroundTypeLimit.MAX_DIMMING`. @@ -315,7 +316,7 @@ class BackgroundTypeFill(BackgroundType): Attributes: type (:obj:`str`): Type of the background. Always :attr:`~telegram.BackgroundType.FILL`. - fill (:obj:`telegram.BackgroundFill`): The background fill. + fill (:class:`telegram.BackgroundFill`): The background fill. dark_theme_dimming (:obj:`int`): Dimming of the background in dark themes, as a percentage; 0-:tg-const:`telegram.constants.BackgroundTypeLimit.MAX_DIMMING`. @@ -349,7 +350,7 @@ class BackgroundTypeWallpaper(BackgroundType): .. versionadded:: 21.2 Args: - document (:obj:`telegram.Document`): Document with the wallpaper + document (:class:`telegram.Document`): Document with the wallpaper dark_theme_dimming (:obj:`int`): Dimming of the background in dark themes, as a percentage; 0-:tg-const:`telegram.constants.BackgroundTypeLimit.MAX_DIMMING`. @@ -361,7 +362,7 @@ class BackgroundTypeWallpaper(BackgroundType): Attributes: type (:obj:`str`): Type of the background. Always :attr:`~telegram.BackgroundType.WALLPAPER`. - document (:obj:`telegram.Document`): Document with the wallpaper + document (:class:`telegram.Document`): Document with the wallpaper dark_theme_dimming (:obj:`int`): Dimming of the background in dark themes, as a percentage; 0-:tg-const:`telegram.constants.BackgroundTypeLimit.MAX_DIMMING`. @@ -407,8 +408,8 @@ class BackgroundTypePattern(BackgroundType): .. versionadded:: 21.2 Args: - document (:obj:`telegram.Document`): Document with the pattern. - fill (:obj:`telegram.BackgroundFill`): The background fill that is combined with + document (:class:`telegram.Document`): Document with the pattern. + fill (:class:`telegram.BackgroundFill`): The background fill that is combined with the pattern. intensity (:obj:`int`): Intensity of the pattern when it is shown above the filled background; @@ -422,8 +423,8 @@ class BackgroundTypePattern(BackgroundType): Attributes: type (:obj:`str`): Type of the background. Always :attr:`~telegram.BackgroundType.PATTERN`. - document (:obj:`telegram.Document`): Document with the pattern. - fill (:obj:`telegram.BackgroundFill`): The background fill that is combined with + document (:class:`telegram.Document`): Document with the pattern. + fill (:class:`telegram.BackgroundFill`): The background fill that is combined with the pattern. intensity (:obj:`int`): Intensity of the pattern when it is shown above the filled background; @@ -511,10 +512,10 @@ class ChatBackground(TelegramObject): .. versionadded:: 21.2 Args: - type (:obj:`telegram.BackgroundType`): Type of the background. + type (:class:`telegram.BackgroundType`): Type of the background. Attributes: - type (:obj:`telegram.BackgroundType`): Type of the background. + type (:class:`telegram.BackgroundType`): Type of the background. """ __slots__ = ("type",) diff --git a/telegram/_chatboost.py b/telegram/_chatboost.py index 7b972eec6d8..55c7cba8060 100644 --- a/telegram/_chatboost.py +++ b/telegram/_chatboost.py @@ -17,9 +17,9 @@ # 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 ChatBoosts.""" - -from datetime import datetime -from typing import TYPE_CHECKING, Dict, Final, Optional, Sequence, Tuple, Type +import datetime as dtm +from collections.abc import Sequence +from typing import TYPE_CHECKING, Final, Optional from telegram import constants from telegram._chat import Chat @@ -119,7 +119,7 @@ def de_json( if not data: return None - _class_mapping: Dict[str, Type[ChatBoostSource]] = { + _class_mapping: dict[str, type[ChatBoostSource]] = { cls.PREMIUM: ChatBoostSourcePremium, cls.GIFT_CODE: ChatBoostSourceGiftCode, cls.GIVEAWAY: ChatBoostSourceGiveaway, @@ -187,15 +187,22 @@ def __init__(self, user: User, *, api_kwargs: Optional[JSONDict] = None): class ChatBoostSourceGiveaway(ChatBoostSource): """ - The boost was obtained by the creation of a Telegram Premium giveaway. This boosts the chat 4 - times for the duration of the corresponding Telegram Premium subscription. + The boost was obtained by the creation of a Telegram Premium giveaway or a Telegram Star. + This boosts the chat 4 times for the duration of the corresponding Telegram Premium + subscription for Telegram Premium giveaways and :attr:`prize_star_count` / 500 times for + one year for Telegram Star giveaways. .. versionadded:: 20.8 Args: giveaway_message_id (:obj:`int`): Identifier of a message in the chat with the giveaway; the message could have been deleted already. May be 0 if the message isn't sent yet. - user (:class:`telegram.User`, optional): User that won the prize in the giveaway if any. + user (:class:`telegram.User`, optional): User that won the prize in the giveaway if any; + for Telegram Premium giveaways only. + prize_star_count (:obj:`int`, optional): The number of Telegram Stars to be split between + giveaway winners; for Telegram Star giveaways only. + + .. versionadded:: 21.6 is_unclaimed (:obj:`bool`, optional): :obj:`True`, if the giveaway was completed, but there was no user to win the prize. @@ -205,17 +212,22 @@ class ChatBoostSourceGiveaway(ChatBoostSource): giveaway_message_id (:obj:`int`): Identifier of a message in the chat with the giveaway; the message could have been deleted already. May be 0 if the message isn't sent yet. user (:class:`telegram.User`): Optional. User that won the prize in the giveaway if any. + prize_star_count (:obj:`int`): Optional. The number of Telegram Stars to be split between + giveaway winners; for Telegram Star giveaways only. + + .. versionadded:: 21.6 is_unclaimed (:obj:`bool`): Optional. :obj:`True`, if the giveaway was completed, but there was no user to win the prize. """ - __slots__ = ("giveaway_message_id", "is_unclaimed", "user") + __slots__ = ("giveaway_message_id", "is_unclaimed", "prize_star_count", "user") def __init__( self, giveaway_message_id: int, user: Optional[User] = None, is_unclaimed: Optional[bool] = None, + prize_star_count: Optional[int] = None, *, api_kwargs: Optional[JSONDict] = None, ): @@ -224,6 +236,7 @@ def __init__( with self._unfrozen(): self.giveaway_message_id: int = giveaway_message_id self.user: Optional[User] = user + self.prize_star_count: Optional[int] = prize_star_count self.is_unclaimed: Optional[bool] = is_unclaimed @@ -260,8 +273,8 @@ class ChatBoost(TelegramObject): def __init__( self, boost_id: str, - add_date: datetime, - expiration_date: datetime, + add_date: dtm.datetime, + expiration_date: dtm.datetime, source: ChatBoostSource, *, api_kwargs: Optional[JSONDict] = None, @@ -269,8 +282,8 @@ def __init__( super().__init__(api_kwargs=api_kwargs) self.boost_id: str = boost_id - self.add_date: datetime = add_date - self.expiration_date: datetime = expiration_date + self.add_date: dtm.datetime = add_date + self.expiration_date: dtm.datetime = expiration_date self.source: ChatBoostSource = source self._id_attrs = (self.boost_id, self.add_date, self.expiration_date, self.source) @@ -372,7 +385,7 @@ def __init__( self, chat: Chat, boost_id: str, - remove_date: datetime, + remove_date: dtm.datetime, source: ChatBoostSource, *, api_kwargs: Optional[JSONDict] = None, @@ -381,7 +394,7 @@ def __init__( self.chat: Chat = chat self.boost_id: str = boost_id - self.remove_date: datetime = remove_date + self.remove_date: dtm.datetime = remove_date self.source: ChatBoostSource = source self._id_attrs = (self.chat, self.boost_id, self.remove_date, self.source) @@ -418,7 +431,7 @@ class UserChatBoosts(TelegramObject): user. Attributes: - boosts (Tuple[:class:`telegram.ChatBoost`]): List of boosts added to the chat by the user. + boosts (tuple[:class:`telegram.ChatBoost`]): List of boosts added to the chat by the user. """ __slots__ = ("boosts",) @@ -431,7 +444,7 @@ def __init__( ): super().__init__(api_kwargs=api_kwargs) - self.boosts: Tuple[ChatBoost, ...] = parse_sequence_arg(boosts) + self.boosts: tuple[ChatBoost, ...] = parse_sequence_arg(boosts) self._id_attrs = (self.boosts,) self._freeze() diff --git a/telegram/_chatfullinfo.py b/telegram/_chatfullinfo.py index 04898659c3c..3f8dc301dba 100644 --- a/telegram/_chatfullinfo.py +++ b/telegram/_chatfullinfo.py @@ -18,8 +18,9 @@ # 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 ChatFullInfo.""" -from datetime import datetime -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +import datetime as dtm +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._birthdate import Birthdate from telegram._chat import Chat, _ChatBase @@ -78,7 +79,7 @@ class ChatFullInfo(_ChatBase): #collectible-usernames>`_; for private chats, supergroups and channels. .. versionadded:: 20.0 - birthdate (:obj:`telegram.Birthdate`, optional): For private chats, + birthdate (:class:`telegram.Birthdate`, optional): For private chats, the date of birth of the user. .. versionadded:: 21.1 @@ -94,8 +95,8 @@ class ChatFullInfo(_ChatBase): chats with business accounts, the opening hours of the business. .. versionadded:: 21.1 - personal_chat (:obj:`telegram.Chat`, optional): For private chats, the personal channel of - the user. + personal_chat (:class:`telegram.Chat`, optional): For private chats, the personal channel + of the user. .. versionadded:: 21.1 available_reactions (Sequence[:class:`telegram.ReactionType`], optional): List of available @@ -224,7 +225,7 @@ class ChatFullInfo(_ChatBase): .. versionadded:: 20.0 photo (:class:`telegram.ChatPhoto`): Optional. Chat photo. - active_usernames (Tuple[:obj:`str`]): Optional. If set, the list of all `active chat + active_usernames (tuple[:obj:`str`]): Optional. If set, the list of all `active chat usernames `_; for private chats, supergroups and channels. @@ -232,7 +233,7 @@ class ChatFullInfo(_ChatBase): obtained via :meth:`~telegram.Bot.get_chat`. .. versionadded:: 20.0 - birthdate (:obj:`telegram.Birthdate`): Optional. For private chats, + birthdate (:class:`telegram.Birthdate`): Optional. For private chats, the date of birth of the user. .. versionadded:: 21.1 @@ -248,11 +249,11 @@ class ChatFullInfo(_ChatBase): chats with business accounts, the opening hours of the business. .. versionadded:: 21.1 - personal_chat (:obj:`telegram.Chat`): Optional. For private chats, the personal channel of - the user. + personal_chat (:class:`telegram.Chat`): Optional. For private chats, the personal channel + of the user. .. versionadded:: 21.1 - available_reactions (Tuple[:class:`telegram.ReactionType`]): Optional. List of available + available_reactions (tuple[:class:`telegram.ReactionType`]): Optional. List of available reactions allowed in the chat. If omitted, then all of :const:`telegram.constants.ReactionEmoji` are allowed. @@ -421,7 +422,7 @@ def __init__( profile_accent_color_id: Optional[int] = None, profile_background_custom_emoji_id: Optional[str] = None, emoji_status_custom_emoji_id: Optional[str] = None, - emoji_status_expiration_date: Optional[datetime] = None, + emoji_status_expiration_date: Optional[dtm.datetime] = None, bio: Optional[str] = None, has_private_forwards: Optional[bool] = None, has_restricted_voice_and_video_messages: Optional[bool] = None, @@ -483,14 +484,16 @@ def __init__( self.has_restricted_voice_and_video_messages: Optional[bool] = ( has_restricted_voice_and_video_messages ) - self.active_usernames: Tuple[str, ...] = parse_sequence_arg(active_usernames) + self.active_usernames: tuple[str, ...] = parse_sequence_arg(active_usernames) self.emoji_status_custom_emoji_id: Optional[str] = emoji_status_custom_emoji_id - self.emoji_status_expiration_date: Optional[datetime] = emoji_status_expiration_date + self.emoji_status_expiration_date: Optional[dtm.datetime] = ( + emoji_status_expiration_date + ) self.has_aggressive_anti_spam_enabled: Optional[bool] = ( has_aggressive_anti_spam_enabled ) self.has_hidden_members: Optional[bool] = has_hidden_members - self.available_reactions: Optional[Tuple[ReactionType, ...]] = parse_sequence_arg( + self.available_reactions: Optional[tuple[ReactionType, ...]] = parse_sequence_arg( available_reactions ) self.accent_color_id: Optional[int] = accent_color_id diff --git a/telegram/_chatinvitelink.py b/telegram/_chatinvitelink.py index 43e7e8ab62d..fd85ea92808 100644 --- a/telegram/_chatinvitelink.py +++ b/telegram/_chatinvitelink.py @@ -17,7 +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/]. """This module contains an object that represents an invite link for a chat.""" -import datetime +import datetime as dtm from typing import TYPE_CHECKING, Optional from telegram._telegramobject import TelegramObject @@ -69,6 +69,16 @@ 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. + + .. versionadded:: 21.5 + 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. + + .. versionadded:: 21.5 + Attributes: invite_link (:obj:`str`): The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with ``'…'``. @@ -96,6 +106,15 @@ 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. + + .. versionadded:: 21.5 + 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. + + .. versionadded:: 21.5 """ @@ -109,6 +128,8 @@ class ChatInviteLink(TelegramObject): "member_limit", "name", "pending_join_request_count", + "subscription_period", + "subscription_price", ) def __init__( @@ -118,10 +139,12 @@ def __init__( creates_join_request: bool, is_primary: bool, is_revoked: bool, - expire_date: Optional[datetime.datetime] = None, + expire_date: Optional[dtm.datetime] = None, member_limit: Optional[int] = None, name: Optional[str] = None, pending_join_request_count: Optional[int] = None, + subscription_period: Optional[int] = None, + subscription_price: Optional[int] = None, *, api_kwargs: Optional[JSONDict] = None, ): @@ -134,12 +157,15 @@ def __init__( self.is_revoked: bool = is_revoked # Optionals - self.expire_date: Optional[datetime.datetime] = expire_date + self.expire_date: Optional[dtm.datetime] = expire_date self.member_limit: Optional[int] = member_limit self.name: Optional[str] = name 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_price: Optional[int] = subscription_price + self._id_attrs = ( self.invite_link, self.creates_join_request, diff --git a/telegram/_chatjoinrequest.py b/telegram/_chatjoinrequest.py index 9c444d97b4d..9324e89a6df 100644 --- a/telegram/_chatjoinrequest.py +++ b/telegram/_chatjoinrequest.py @@ -17,7 +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/]. """This module contains an object that represents a Telegram ChatJoinRequest.""" -import datetime +import datetime as dtm from typing import TYPE_CHECKING, Optional from telegram._chat import Chat @@ -106,7 +106,7 @@ def __init__( self, chat: Chat, from_user: User, - date: datetime.datetime, + date: dtm.datetime, user_chat_id: int, bio: Optional[str] = None, invite_link: Optional[ChatInviteLink] = None, @@ -117,7 +117,7 @@ def __init__( # Required self.chat: Chat = chat self.from_user: User = from_user - self.date: datetime.datetime = date + self.date: dtm.datetime = date self.user_chat_id: int = user_chat_id # Optionals diff --git a/telegram/_chatmember.py b/telegram/_chatmember.py index 0cc06bf5804..d1b4051e60b 100644 --- a/telegram/_chatmember.py +++ b/telegram/_chatmember.py @@ -17,8 +17,9 @@ # 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 ChatMember.""" -import datetime -from typing import TYPE_CHECKING, Dict, Final, Optional, Type + +import datetime as dtm +from typing import TYPE_CHECKING, Final, Optional from telegram import constants from telegram._telegramobject import TelegramObject @@ -113,7 +114,7 @@ def de_json( if not data: return None - _class_mapping: Dict[str, Type[ChatMember]] = { + _class_mapping: dict[str, type[ChatMember]] = { cls.OWNER: ChatMemberOwner, cls.ADMINISTRATOR: ChatMemberAdministrator, cls.MEMBER: ChatMemberMember, @@ -391,24 +392,34 @@ class ChatMemberMember(ChatMember): Args: user (:class:`telegram.User`): Information about the user. + until_date (:class:`datetime.datetime`, optional): Date when the user's subscription will + expire. + + .. versionadded:: 21.5 Attributes: status (:obj:`str`): The member's status in the chat, always :tg-const:`telegram.ChatMember.MEMBER`. user (:class:`telegram.User`): Information about the user. + until_date (:class:`datetime.datetime`): Optional. Date when the user's subscription will + expire. + + .. versionadded:: 21.5 """ - __slots__ = () + __slots__ = ("until_date",) def __init__( self, user: User, + until_date: Optional[dtm.datetime] = None, *, api_kwargs: Optional[JSONDict] = None, ): super().__init__(status=ChatMember.MEMBER, user=user, api_kwargs=api_kwargs) - self._freeze() + with self._unfrozen(): + self.until_date: Optional[dtm.datetime] = until_date class ChatMemberRestricted(ChatMember): @@ -555,7 +566,7 @@ def __init__( can_send_other_messages: bool, can_add_web_page_previews: bool, can_manage_topics: bool, - until_date: datetime.datetime, + until_date: dtm.datetime, can_send_audios: bool, can_send_documents: bool, can_send_photos: bool, @@ -576,7 +587,7 @@ def __init__( self.can_send_other_messages: bool = can_send_other_messages self.can_add_web_page_previews: bool = can_add_web_page_previews self.can_manage_topics: bool = can_manage_topics - self.until_date: datetime.datetime = until_date + self.until_date: dtm.datetime = until_date self.can_send_audios: bool = can_send_audios self.can_send_documents: bool = can_send_documents self.can_send_photos: bool = can_send_photos @@ -645,10 +656,10 @@ class ChatMemberBanned(ChatMember): def __init__( self, user: User, - until_date: datetime.datetime, + until_date: dtm.datetime, *, api_kwargs: Optional[JSONDict] = None, ): super().__init__(status=ChatMember.BANNED, user=user, api_kwargs=api_kwargs) with self._unfrozen(): - self.until_date: datetime.datetime = until_date + self.until_date: dtm.datetime = until_date diff --git a/telegram/_chatmemberupdated.py b/telegram/_chatmemberupdated.py index 1aacb218533..cf71d772d06 100644 --- a/telegram/_chatmemberupdated.py +++ b/telegram/_chatmemberupdated.py @@ -17,8 +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/]. """This module contains an object that represents a Telegram ChatMemberUpdated.""" -import datetime -from typing import TYPE_CHECKING, Dict, Optional, Tuple, Union +import datetime as dtm +from typing import TYPE_CHECKING, Optional, Union from telegram._chat import Chat from telegram._chatinvitelink import ChatInviteLink @@ -108,7 +108,7 @@ def __init__( self, chat: Chat, from_user: User, - date: datetime.datetime, + date: dtm.datetime, old_chat_member: ChatMember, new_chat_member: ChatMember, invite_link: Optional[ChatInviteLink] = None, @@ -121,7 +121,7 @@ def __init__( # Required self.chat: Chat = chat self.from_user: User = from_user - self.date: datetime.datetime = date + self.date: dtm.datetime = date self.old_chat_member: ChatMember = old_chat_member self.new_chat_member: ChatMember = new_chat_member self.via_chat_folder_invite_link: Optional[bool] = via_chat_folder_invite_link @@ -162,7 +162,7 @@ def de_json( return super().de_json(data=data, bot=bot) - def _get_attribute_difference(self, attribute: str) -> Tuple[object, object]: + def _get_attribute_difference(self, attribute: str) -> tuple[object, object]: try: old = self.old_chat_member[attribute] except KeyError: @@ -177,11 +177,9 @@ def _get_attribute_difference(self, attribute: str) -> Tuple[object, object]: def difference( self, - ) -> Dict[ + ) -> dict[ str, - Tuple[ - Union[str, bool, datetime.datetime, User], Union[str, bool, datetime.datetime, User] - ], + tuple[Union[str, bool, dtm.datetime, User], Union[str, bool, dtm.datetime, User]], ]: """Computes the difference between :attr:`old_chat_member` and :attr:`new_chat_member`. @@ -198,7 +196,7 @@ def difference( .. versionadded:: 13.5 Returns: - Dict[:obj:`str`, Tuple[:class:`object`, :class:`object`]]: A dictionary mapping + dict[:obj:`str`, tuple[:class:`object`, :class:`object`]]: A dictionary mapping attribute names to tuples of the form ``(old_value, new_value)`` """ # we first get the names of the attributes that have changed diff --git a/telegram/_copytextbutton.py b/telegram/_copytextbutton.py new file mode 100644 index 00000000000..a2bf499a715 --- /dev/null +++ b/telegram/_copytextbutton.py @@ -0,0 +1,55 @@ +#!/usr/bin/env python +# +# A library that provides a Python interface to the Telegram Bot API +# Copyright (C) 2015-2024 +# Leandro Toledo de Souza +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser Public License for more details. +# +# You should have received a copy of the GNU Lesser Public License +# along with this program. If not, see [http://www.gnu.org/licenses/]. +"""This module contains an object that represents a Telegram CopyTextButton.""" +from typing import Optional + +from telegram._telegramobject import TelegramObject +from telegram._utils.types import JSONDict + + +class CopyTextButton(TelegramObject): + """ + This object represents an inline keyboard button that copies specified text to the clipboard. + + Objects of this class are comparable in terms of equality. Two objects of this class are + considered equal, if their :attr:`text` is equal. + + .. versionadded:: 21.7 + + Args: + text (:obj:`str`): The text to be copied to the clipboard; + :tg-const:`telegram.constants.InlineKeyboardButtonLimit.MIN_COPY_TEXT`- + :tg-const:`telegram.constants.InlineKeyboardButtonLimit.MAX_COPY_TEXT` characters + + Attributes: + text (:obj:`str`): The text to be copied to the clipboard; + :tg-const:`telegram.constants.InlineKeyboardButtonLimit.MIN_COPY_TEXT`- + :tg-const:`telegram.constants.InlineKeyboardButtonLimit.MAX_COPY_TEXT` characters + + """ + + __slots__ = ("text",) + + def __init__(self, text: str, *, api_kwargs: Optional[JSONDict] = None): + super().__init__(api_kwargs=api_kwargs) + self.text: str = text + + self._id_attrs = (self.text,) + + self._freeze() diff --git a/telegram/_dice.py b/telegram/_dice.py index 621e4b13f98..f0e752fdaa2 100644 --- a/telegram/_dice.py +++ b/telegram/_dice.py @@ -17,7 +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/]. """This module contains an object that represents a Telegram Dice.""" -from typing import Final, List, Optional +from typing import Final, Optional from telegram import constants from telegram._telegramobject import TelegramObject @@ -114,8 +114,8 @@ def __init__(self, value: int, emoji: str, *, api_kwargs: Optional[JSONDict] = N .. versionadded:: 13.4 """ - ALL_EMOJI: Final[List[str]] = list(constants.DiceEmoji) - """List[:obj:`str`]: A list of all available dice emoji.""" + ALL_EMOJI: Final[list[str]] = list(constants.DiceEmoji) + """list[:obj:`str`]: A list of all available dice emoji.""" MIN_VALUE: Final[int] = constants.DiceLimit.MIN_VALUE """:const:`telegram.constants.DiceLimit.MIN_VALUE` diff --git a/telegram/_files/_basethumbedmedium.py b/telegram/_files/_basethumbedmedium.py index 20ff82eab5e..d0b66f35c20 100644 --- a/telegram/_files/_basethumbedmedium.py +++ b/telegram/_files/_basethumbedmedium.py @@ -17,7 +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/]. """Common base class for media objects with thumbnails""" -from typing import TYPE_CHECKING, Optional, Type, TypeVar +from typing import TYPE_CHECKING, Optional, TypeVar from telegram._files._basemedium import _BaseMedium from telegram._files.photosize import PhotoSize @@ -82,7 +82,7 @@ def __init__( @classmethod def de_json( - cls: Type[ThumbedMT_co], data: Optional[JSONDict], bot: Optional["Bot"] = None + cls: type[ThumbedMT_co], data: Optional[JSONDict], bot: Optional["Bot"] = None ) -> Optional[ThumbedMT_co]: """See :meth:`telegram.TelegramObject.de_json`.""" data = cls._parse_data(data) diff --git a/telegram/_files/file.py b/telegram/_files/file.py index c9b8d22d49a..98575caded6 100644 --- a/telegram/_files/file.py +++ b/telegram/_files/file.py @@ -128,9 +128,8 @@ async def download_to_drive( ) -> Path: """ Download this file. By default, the file is saved in the current working directory with - :attr:`file_path` as file name. If the file has no filename, the file ID will be used as - filename. If :paramref:`custom_path` is supplied as a :obj:`str` or :obj:`pathlib.Path`, - it will be saved to that path. + :attr:`file_path` as file name. If :paramref:`custom_path` is supplied as a :obj:`str` or + :obj:`pathlib.Path`, it will be saved to that path. Note: If :paramref:`custom_path` isn't provided and :attr:`file_path` is the path of a @@ -152,6 +151,11 @@ async def download_to_drive( * This method was previously called ``download``. It was split into :meth:`download_to_drive` and :meth:`download_to_memory`. + .. versionchanged:: 21.7 + Raises :exc:`RuntimeError` if :attr:`file_path` is not set. Note that files without + a :attr:`file_path` could never be downloaded, as this attribute is mandatory for that + operation. + Args: custom_path (:class:`pathlib.Path` | :obj:`str` , optional): The path where the file will be saved to. If not specified, will be saved in the current working directory @@ -175,7 +179,13 @@ async def download_to_drive( Returns: :class:`pathlib.Path`: Returns the Path object the file was downloaded to. + Raises: + RuntimeError: If :attr:`file_path` is not set. + """ + if not self.file_path: + raise RuntimeError("No `file_path` available for this file. Can not download.") + local_file = is_local_file(self.file_path) url = None if local_file else self._get_encoded_url() @@ -198,10 +208,8 @@ async def download_to_drive( filename = Path(custom_path) elif local_file: return Path(self.file_path) - elif self.file_path: - filename = Path(Path(self.file_path).name) else: - filename = Path.cwd() / self.file_id + filename = Path(Path(self.file_path).name) buf = await self.get_bot().request.retrieve( url, @@ -237,6 +245,11 @@ async def download_to_memory( .. versionadded:: 20.0 + .. versionchanged:: 21.7 + Raises :exc:`RuntimeError` if :attr:`file_path` is not set. Note that files without + a :attr:`file_path` could never be downloaded, as this attribute is mandatory for that + operation. + Args: out (:obj:`io.BufferedIOBase`): A file-like object. Must be opened for writing in binary mode. @@ -254,7 +267,13 @@ async def download_to_memory( pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. + + Raises: + RuntimeError: If :attr:`file_path` is not set. """ + if not self.file_path: + raise RuntimeError("No `file_path` available for this file. Can not download.") + local_file = is_local_file(self.file_path) url = None if local_file else self._get_encoded_url() path = Path(self.file_path) if local_file else None @@ -283,6 +302,11 @@ async def download_as_bytearray( ) -> bytearray: """Download this file and return it as a bytearray. + .. versionchanged:: 21.7 + Raises :exc:`RuntimeError` if :attr:`file_path` is not set. Note that files without + a :attr:`file_path` could never be downloaded, as this attribute is mandatory for that + operation. + Args: buf (:obj:`bytearray`, optional): Extend the given bytearray with the downloaded data. @@ -312,7 +336,13 @@ async def download_as_bytearray( :obj:`bytearray`: The same object as :paramref:`buf` if it was specified. Otherwise a newly allocated :obj:`bytearray`. + Raises: + RuntimeError: If :attr:`file_path` is not set. + """ + if not self.file_path: + raise RuntimeError("No `file_path` available for this file. Can not download.") + if buf is None: buf = bytearray() diff --git a/telegram/_files/inputfile.py b/telegram/_files/inputfile.py index 994135bb5dd..61e5a94192d 100644 --- a/telegram/_files/inputfile.py +++ b/telegram/_files/inputfile.py @@ -22,7 +22,8 @@ from typing import IO, Optional, Union from uuid import uuid4 -from telegram._utils.files import load_file +from telegram._utils.files import guess_file_name, load_file +from telegram._utils.strings import TextEncoding from telegram._utils.types import FieldTuple _DEFAULT_MIME_TYPE = "application/octet-stream" @@ -52,9 +53,36 @@ class InputFile: attach (:obj:`bool`, optional): Pass :obj:`True` if the parameter this file belongs to in the request to Telegram should point to the multipart data via an ``attach://`` URI. Defaults to `False`. + read_file_handle (:obj:`bool`, optional): If :obj:`True` and :paramref:`obj` is a file + handle, the data will be read from the file handle on initialization of this object. + If :obj:`False`, the file handle will be passed on to the + :attr:`networking backend ` which will have + to handle the reading. Defaults to :obj:`True`. + + Tip: + If you upload extremely large files, you may want to set this to :obj:`False` to + avoid reading the complete file into memory. Additionally, this may be supported + better by the networking backend (in particular it is handled better by + the default :class:`~telegram.request.HTTPXRequest`). + + Important: + If you set this to :obj:`False`, you have to ensure that the file handle is still + open when the request is made. In particular, the following snippet can *not* work + as expected. + + .. code-block:: python + + with open('file.txt', 'rb') as file: + input_file = InputFile(file, read_file_handle=False) + + # here the file handle is already closed and the upload will fail + await bot.send_document(chat_id, input_file) + + .. versionadded:: 21.5 + Attributes: - input_file_content (:obj:`bytes`): The binary content of the file to send. + input_file_content (:obj:`bytes` | :class:`IO`): The binary content of the file to send. attach_name (:obj:`str`): Optional. If present, the parameter this file belongs to in the request to Telegram should point to the multipart data via a an URI of the form ``attach://`` URI. @@ -70,14 +98,18 @@ def __init__( obj: Union[IO[bytes], bytes, str], filename: Optional[str] = None, attach: bool = False, + read_file_handle: bool = True, ): if isinstance(obj, bytes): - self.input_file_content: bytes = obj + self.input_file_content: Union[bytes, IO[bytes]] = obj elif isinstance(obj, str): - self.input_file_content = obj.encode("utf-8") - else: + self.input_file_content = obj.encode(TextEncoding.UTF_8) + elif read_file_handle: reported_filename, self.input_file_content = load_file(obj) filename = filename or reported_filename + else: + self.input_file_content = obj + filename = filename or guess_file_name(obj) self.attach_name: Optional[str] = "attached" + uuid4().hex if attach else None @@ -94,8 +126,11 @@ def __init__( def field_tuple(self) -> FieldTuple: """Field tuple representing the contents of the file for upload to the Telegram servers. + .. versionchanged:: 21.5 + Content may now be a file handle. + Returns: - Tuple[:obj:`str`, :obj:`bytes`, :obj:`str`]: + tuple[:obj:`str`, :obj:`bytes` | :class:`IO`, :obj:`str`]: """ return self.filename, self.input_file_content, self.mimetype diff --git a/telegram/_files/inputmedia.py b/telegram/_files/inputmedia.py index 692369130a4..6dcf9d57809 100644 --- a/telegram/_files/inputmedia.py +++ b/telegram/_files/inputmedia.py @@ -17,7 +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/]. """Base class for Telegram InputMedia Objects.""" -from typing import Final, Optional, Sequence, Tuple, Union +from collections.abc import Sequence +from typing import Final, Optional, Union from telegram import constants from telegram._files.animation import Animation @@ -50,8 +51,8 @@ class InputMedia(TelegramObject): Args: media_type (:obj:`str`): Type of media that the instance represents. - media (:obj:`str` | :term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | \ - :class:`telegram.Animation` | :class:`telegram.Audio` | \ + media (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | \ + :class:`pathlib.Path` | :class:`telegram.Animation` | :class:`telegram.Audio` | \ :class:`telegram.Document` | :class:`telegram.PhotoSize` | \ :class:`telegram.Video`): File to send. |fileinputnopath| @@ -74,7 +75,7 @@ class InputMedia(TelegramObject): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -99,7 +100,7 @@ def __init__( self.type: str = enum.get_member(constants.InputMediaType, media_type, media_type) self.media: Union[str, InputFile, Animation, Audio, Document, PhotoSize, Video] = media self.caption: Optional[str] = caption - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + self.caption_entities: tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) self.parse_mode: ODVInput[str] = parse_mode self._freeze() @@ -128,8 +129,9 @@ class InputPaidMedia(TelegramObject): Args: type (:obj:`str`): Type of media that the instance represents. - media (:obj:`str` | :term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | \ - :class:`telegram.PhotoSize` | :class:`telegram.Video`): File to send. |fileinputnopath| + media (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | \ + :class:`pathlib.Path` | :class:`telegram.PhotoSize` | :class:`telegram.Video`): File + to send. |fileinputnopath| Lastly you can pass an existing telegram media object of the corresponding type to send. @@ -167,8 +169,8 @@ class InputPaidMediaPhoto(InputPaidMedia): .. versionadded:: 21.4 Args: - media (:obj:`str` | :term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | \ - :class:`telegram.PhotoSize`): File to send. |fileinputnopath| + media (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | \ + :class:`pathlib.Path` | :class:`telegram.PhotoSize`): File to send. |fileinputnopath| Lastly you can pass an existing :class:`telegram.PhotoSize` object to send. Attributes: @@ -207,8 +209,8 @@ class InputPaidMediaVideo(InputPaidMedia): changed by Telegram. Args: - media (:obj:`str` | :term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | \ - :class:`telegram.Video`): File to send. |fileinputnopath| + media (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | \ + :class:`pathlib.Path` | :class:`telegram.Video`): File to send. |fileinputnopath| Lastly you can pass an existing :class:`telegram.Video` object to send. thumbnail (:term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | :obj:`str`, \ optional): |thumbdocstringnopath| @@ -278,8 +280,8 @@ class InputMediaAnimation(InputMedia): |removed_thumb_note| Args: - media (:obj:`str` | :term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | \ - :class:`telegram.Animation`): File to send. |fileinputnopath| + media (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | \ + :class:`pathlib.Path` | :class:`telegram.Animation`): File to send. |fileinputnopath| Lastly you can pass an existing :class:`telegram.Animation` object to send. .. versionchanged:: 13.2 @@ -320,7 +322,7 @@ class InputMediaAnimation(InputMedia): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. The parse mode to use for text formatting. - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -401,8 +403,8 @@ class InputMediaPhoto(InputMedia): .. seealso:: :wiki:`Working with Files and Media ` Args: - media (:obj:`str` | :term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | \ - :class:`telegram.PhotoSize`): File to send. |fileinputnopath| + media (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | \ + :class:`pathlib.Path` | :class:`telegram.PhotoSize`): File to send. |fileinputnopath| Lastly you can pass an existing :class:`telegram.PhotoSize` object to send. .. versionchanged:: 13.2 @@ -435,7 +437,7 @@ class InputMediaPhoto(InputMedia): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -501,8 +503,8 @@ class InputMediaVideo(InputMedia): |removed_thumb_note| Args: - media (:obj:`str` | :term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | \ - :class:`telegram.Video`): File to send. |fileinputnopath| + media (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | \ + :class:`pathlib.Path` | :class:`telegram.Video`): File to send. |fileinputnopath| Lastly you can pass an existing :class:`telegram.Video` object to send. .. versionchanged:: 13.2 @@ -545,7 +547,7 @@ class InputMediaVideo(InputMedia): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -639,8 +641,8 @@ class InputMediaAudio(InputMedia): |removed_thumb_note| Args: - media (:obj:`str` | :term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | \ - :class:`telegram.Audio`): File to send. |fileinputnopath| + media (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` | \ + :class:`pathlib.Path` | :class:`telegram.Audio`): File to send. |fileinputnopath| Lastly you can pass an existing :class:`telegram.Audio` object to send. .. versionchanged:: 13.2 @@ -675,7 +677,7 @@ class InputMediaAudio(InputMedia): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -743,8 +745,8 @@ class InputMediaDocument(InputMedia): |removed_thumb_note| Args: - media (:obj:`str` | :term:`file object` | :obj:`bytes` | :class:`pathlib.Path` | \ - :class:`telegram.Document`): File to send. |fileinputnopath| + media (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` \ + | :class:`pathlib.Path` | :class:`telegram.Document`): File to send. |fileinputnopath| Lastly you can pass an existing :class:`telegram.Document` object to send. .. versionchanged:: 13.2 @@ -778,7 +780,7 @@ class InputMediaDocument(InputMedia): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 diff --git a/telegram/_files/inputsticker.py b/telegram/_files/inputsticker.py index 5539d610d83..59b8e8ba96d 100644 --- a/telegram/_files/inputsticker.py +++ b/telegram/_files/inputsticker.py @@ -18,7 +18,8 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram InputSticker.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple, Union +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional, Union from telegram._files.sticker import MaskPosition from telegram._telegramobject import TelegramObject @@ -41,14 +42,15 @@ class InputSticker(TelegramObject): order of the arguments has changed. Args: - sticker (:obj:`str` | :term:`file object` | :obj:`bytes` | :class:`pathlib.Path`): The + sticker (:obj:`str` | :term:`file object` | :class:`~telegram.InputFile` | :obj:`bytes` \ + | :class:`pathlib.Path`): The added sticker. |uploadinputnopath| Animated and video stickers can't be uploaded via HTTP URL. emoji_list (Sequence[:obj:`str`]): Sequence of :tg-const:`telegram.constants.StickerLimit.MIN_STICKER_EMOJI` - :tg-const:`telegram.constants.StickerLimit.MAX_STICKER_EMOJI` emoji associated with the sticker. - mask_position (:obj:`telegram.MaskPosition`, optional): Position where the mask should be + mask_position (:class:`telegram.MaskPosition`, optional): Position where the mask should be placed on faces. For ":tg-const:`telegram.constants.StickerType.MASK`" stickers only. keywords (Sequence[:obj:`str`], optional): Sequence of 0-:tg-const:`telegram.constants.StickerLimit.MAX_SEARCH_KEYWORDS` search keywords @@ -66,13 +68,13 @@ class InputSticker(TelegramObject): Attributes: sticker (:obj:`str` | :class:`telegram.InputFile`): The added sticker. - emoji_list (Tuple[:obj:`str`]): Tuple of + emoji_list (tuple[:obj:`str`]): Tuple of :tg-const:`telegram.constants.StickerLimit.MIN_STICKER_EMOJI` - :tg-const:`telegram.constants.StickerLimit.MAX_STICKER_EMOJI` emoji associated with the sticker. - mask_position (:obj:`telegram.MaskPosition`): Optional. Position where the mask should be + mask_position (:class:`telegram.MaskPosition`): Optional. Position where the mask should be placed on faces. For ":tg-const:`telegram.constants.StickerType.MASK`" stickers only. - keywords (Tuple[:obj:`str`]): Optional. Tuple of + keywords (tuple[:obj:`str`]): Optional. Tuple of 0-:tg-const:`telegram.constants.StickerLimit.MAX_SEARCH_KEYWORDS` search keywords for the sticker with the total length of up to :tg-const:`telegram.constants.StickerLimit.MAX_KEYWORD_LENGTH` characters. For @@ -109,9 +111,9 @@ def __init__( local_mode=True, attach=True, ) - self.emoji_list: Tuple[str, ...] = parse_sequence_arg(emoji_list) + self.emoji_list: tuple[str, ...] = parse_sequence_arg(emoji_list) self.format: str = format self.mask_position: Optional[MaskPosition] = mask_position - self.keywords: Tuple[str, ...] = parse_sequence_arg(keywords) + self.keywords: tuple[str, ...] = parse_sequence_arg(keywords) self._freeze() diff --git a/telegram/_files/sticker.py b/telegram/_files/sticker.py index 3c3c1cd7e72..01ebf37e6ff 100644 --- a/telegram/_files/sticker.py +++ b/telegram/_files/sticker.py @@ -17,7 +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/]. """This module contains objects that represent stickers.""" -from typing import TYPE_CHECKING, Final, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Final, Optional from telegram import constants from telegram._files._basethumbedmedium import _BaseThumbedMedium @@ -259,7 +260,7 @@ class StickerSet(TelegramObject): Attributes: name (:obj:`str`): Sticker set name. title (:obj:`str`): Sticker set title. - stickers (Tuple[:class:`telegram.Sticker`]): List of all set stickers. + stickers (tuple[:class:`telegram.Sticker`]): List of all set stickers. .. versionchanged:: 20.0 |tupleclassattrs| @@ -296,7 +297,7 @@ def __init__( super().__init__(api_kwargs=api_kwargs) self.name: str = name self.title: str = title - self.stickers: Tuple[Sticker, ...] = parse_sequence_arg(stickers) + self.stickers: tuple[Sticker, ...] = parse_sequence_arg(stickers) self.sticker_type: str = sticker_type # Optional self.thumbnail: Optional[PhotoSize] = thumbnail diff --git a/telegram/_games/game.py b/telegram/_games/game.py index 93b3f0161cc..efe30ea7f25 100644 --- a/telegram/_games/game.py +++ b/telegram/_games/game.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 Game.""" -from typing import TYPE_CHECKING, Dict, List, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._files.animation import Animation from telegram._files.photosize import PhotoSize from telegram._messageentity import MessageEntity from telegram._telegramobject import TelegramObject from telegram._utils.argumentparsing import parse_sequence_arg +from telegram._utils.strings import TextEncoding from telegram._utils.types import JSONDict if TYPE_CHECKING: @@ -64,7 +66,7 @@ class Game(TelegramObject): Attributes: title (:obj:`str`): Title of the game. description (:obj:`str`): Description of the game. - photo (Tuple[:class:`telegram.PhotoSize`]): Photo that will be displayed in the game + photo (tuple[:class:`telegram.PhotoSize`]): Photo that will be displayed in the game message in chats. .. versionchanged:: 20.0 @@ -75,7 +77,7 @@ class Game(TelegramObject): when the bot calls :meth:`telegram.Bot.set_game_score`, or manually edited using :meth:`telegram.Bot.edit_message_text`. 0-:tg-const:`telegram.constants.MessageLimit.MAX_TEXT_LENGTH` characters. - text_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. Special entities that + text_entities (tuple[:class:`telegram.MessageEntity`]): Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc. This tuple is empty if the message does not contain text entities. @@ -111,10 +113,10 @@ def __init__( # Required self.title: str = title self.description: str = description - self.photo: Tuple[PhotoSize, ...] = parse_sequence_arg(photo) + self.photo: tuple[PhotoSize, ...] = parse_sequence_arg(photo) # Optionals self.text: Optional[str] = text - self.text_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(text_entities) + self.text_entities: tuple[MessageEntity, ...] = parse_sequence_arg(text_entities) self.animation: Optional[Animation] = animation self._id_attrs = (self.title, self.description, self.photo) @@ -157,12 +159,12 @@ def parse_text_entity(self, entity: MessageEntity) -> str: if not self.text: raise RuntimeError("This Game has no 'text'.") - entity_text = self.text.encode("utf-16-le") + entity_text = self.text.encode(TextEncoding.UTF_16_LE) entity_text = entity_text[entity.offset * 2 : (entity.offset + entity.length) * 2] - return entity_text.decode("utf-16-le") + return entity_text.decode(TextEncoding.UTF_16_LE) - def parse_text_entities(self, types: Optional[List[str]] = None) -> Dict[MessageEntity, str]: + def parse_text_entities(self, types: Optional[list[str]] = None) -> dict[MessageEntity, str]: """ Returns a :obj:`dict` that maps :class:`telegram.MessageEntity` to :obj:`str`. It contains entities from this message filtered by their @@ -175,13 +177,13 @@ def parse_text_entities(self, types: Optional[List[str]] = None) -> Dict[Message See :attr:`parse_text_entity` for more info. Args: - types (List[:obj:`str`], optional): List of :class:`telegram.MessageEntity` types as + types (list[:obj:`str`], optional): List of :class:`telegram.MessageEntity` types as strings. If the :attr:`~telegram.MessageEntity.type` attribute of an entity is contained in this list, it will be returned. Defaults to :attr:`telegram.MessageEntity.ALL_TYPES`. Returns: - Dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to + dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to the text that belongs to them, calculated based on UTF-16 codepoints. """ diff --git a/telegram/_gifts.py b/telegram/_gifts.py new file mode 100644 index 00000000000..4aa5f5f604c --- /dev/null +++ b/telegram/_gifts.py @@ -0,0 +1,136 @@ +#!/usr/bin/env python +# pylint: disable=redefined-builtin +# +# A library that provides a Python interface to the Telegram Bot API +# Copyright (C) 2015-2024 +# Leandro Toledo de Souza +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser Public License for more details. +# +# You should have received a copy of the GNU Lesser Public License +# along with this program. If not, see [http://www.gnu.org/licenses/] +"""This module contains classes related to gifs sent by bots.""" +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional + +from telegram._files.sticker import Sticker +from telegram._telegramobject import TelegramObject +from telegram._utils.argumentparsing import parse_sequence_arg +from telegram._utils.types import JSONDict + +if TYPE_CHECKING: + from telegram import Bot + + +class Gift(TelegramObject): + """This object represents a gift that can be sent by the bot. + + Objects of this class are comparable in terms of equality. Two objects of this class are + considered equal if their :attr:`id` is equal. + + .. versionadded:: 21.8 + + Args: + id (:obj:`str`): Unique identifier of the gift + sticker (:class:`~telegram.Sticker`): The sticker that represents the gift + star_count (:obj:`int`): The number of Telegram Stars that must be paid to send the sticker + total_count (:obj:`int`, optional): The total number of the gifts of this type that can be + sent; for limited gifts only + remaining_count (:obj:`int`, optional): The number of remaining gifts of this type that can + be sent; for limited gifts only + + Attributes: + id (:obj:`str`): Unique identifier of the gift + sticker (:class:`~telegram.Sticker`): The sticker that represents the gift + star_count (:obj:`int`): The number of Telegram Stars that must be paid to send the sticker + total_count (:obj:`int`): Optional. The total number of the gifts of this type that can be + sent; for limited gifts only + remaining_count (:obj:`int`): Optional. The number of remaining gifts of this type that can + be sent; for limited gifts only + + """ + + __slots__ = ("id", "remaining_count", "star_count", "sticker", "total_count") + + def __init__( + self, + id: str, + sticker: Sticker, + star_count: int, + total_count: Optional[int] = None, + remaining_count: Optional[int] = None, + *, + api_kwargs: Optional[JSONDict] = None, + ): + super().__init__(api_kwargs=api_kwargs) + self.id: str = id + self.sticker: Sticker = sticker + self.star_count: int = star_count + self.total_count: Optional[int] = total_count + self.remaining_count: Optional[int] = remaining_count + + self._id_attrs = (self.id,) + + self._freeze() + + @classmethod + def de_json(cls, data: Optional[JSONDict], bot: Optional["Bot"] = None) -> Optional["Gift"]: + """See :meth:`telegram.TelegramObject.de_json`.""" + data = cls._parse_data(data) + + if not data: + return None + + data["sticker"] = Sticker.de_json(data.get("sticker"), bot) + return cls(**data) + + +class Gifts(TelegramObject): + """This object represent a list of gifts. + + Objects of this class are comparable in terms of equality. Two objects of this class are + considered equal if their :attr:`gifts` are equal. + + .. versionadded:: 21.8 + + Args: + gifts (Sequence[:class:`Gift`]): The sequence of gifts + + Attributes: + gifts (tuple[:class:`Gift`]): The sequence of gifts + + """ + + __slots__ = ("gifts",) + + def __init__( + self, + gifts: Sequence[Gift], + *, + api_kwargs: Optional[JSONDict] = None, + ): + super().__init__(api_kwargs=api_kwargs) + self.gifts: tuple[Gift, ...] = parse_sequence_arg(gifts) + + self._id_attrs = (self.gifts,) + + self._freeze() + + @classmethod + def de_json(cls, data: Optional[JSONDict], bot: Optional["Bot"] = None) -> Optional["Gifts"]: + """See :meth:`telegram.TelegramObject.de_json`.""" + data = cls._parse_data(data) + + if not data: + return None + + data["gifts"] = Gift.de_list(data.get("gifts"), bot) + return cls(**data) diff --git a/telegram/_giveaway.py b/telegram/_giveaway.py index 0008dc9dd4c..ad2e6e0a6b7 100644 --- a/telegram/_giveaway.py +++ b/telegram/_giveaway.py @@ -17,8 +17,9 @@ # 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 objects that are related to Telegram giveaways.""" -import datetime -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +import datetime as dtm +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._chat import Chat from telegram._telegramobject import TelegramObject @@ -41,7 +42,7 @@ class Giveaway(TelegramObject): .. versionadded:: 20.8 Args: - chats (Tuple[:class:`telegram.Chat`]): The list of chats which the user must join to + chats (tuple[:class:`telegram.Chat`]): The list of chats which the user must join to participate in the giveaway. winners_selection_date (:class:`datetime.datetime`): The date when the giveaway winner will be selected. |datetime_localization| @@ -56,8 +57,13 @@ class Giveaway(TelegramObject): country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways. + prize_star_count (:obj:`int`, optional): The number of Telegram Stars to be split between + giveaway winners; for Telegram Star giveaways only. + + .. versionadded:: 21.6 premium_subscription_month_count (:obj:`int`, optional): The number of months the Telegram - Premium subscription won from the giveaway will be active for. + Premium subscription won from the giveaway will be active for; for Telegram Premium + giveaways only. Attributes: chats (Sequence[:class:`telegram.Chat`]): The list of chats which the user must join to @@ -71,12 +77,17 @@ class Giveaway(TelegramObject): has_public_winners (:obj:`True`): Optional. :obj:`True`, if the list of giveaway winners will be visible to everyone prize_description (:obj:`str`): Optional. Description of additional giveaway prize - country_codes (Tuple[:obj:`str`]): Optional. A tuple of two-letter ISO 3166-1 alpha-2 + country_codes (tuple[:obj:`str`]): Optional. A tuple of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways. + prize_star_count (:obj:`int`): Optional. The number of Telegram Stars to be split between + giveaway winners; for Telegram Star giveaways only. + + .. versionadded:: 21.6 premium_subscription_month_count (:obj:`int`): Optional. The number of months the Telegram - Premium subscription won from the giveaway will be active for. + Premium subscription won from the giveaway will be active for; for Telegram Premium + giveaways only. """ __slots__ = ( @@ -86,6 +97,7 @@ class Giveaway(TelegramObject): "only_new_members", "premium_subscription_month_count", "prize_description", + "prize_star_count", "winner_count", "winners_selection_date", ) @@ -93,26 +105,28 @@ class Giveaway(TelegramObject): def __init__( self, chats: Sequence[Chat], - winners_selection_date: datetime.datetime, + winners_selection_date: dtm.datetime, winner_count: int, only_new_members: Optional[bool] = None, has_public_winners: Optional[bool] = None, prize_description: Optional[str] = None, country_codes: Optional[Sequence[str]] = None, premium_subscription_month_count: Optional[int] = None, + prize_star_count: Optional[int] = None, *, api_kwargs: Optional[JSONDict] = None, ): super().__init__(api_kwargs=api_kwargs) - self.chats: Tuple[Chat, ...] = tuple(chats) - self.winners_selection_date: datetime.datetime = winners_selection_date + self.chats: tuple[Chat, ...] = tuple(chats) + self.winners_selection_date: dtm.datetime = winners_selection_date self.winner_count: int = winner_count self.only_new_members: Optional[bool] = only_new_members self.has_public_winners: Optional[bool] = has_public_winners self.prize_description: Optional[str] = prize_description - self.country_codes: Tuple[str, ...] = parse_sequence_arg(country_codes) + self.country_codes: tuple[str, ...] = parse_sequence_arg(country_codes) self.premium_subscription_month_count: Optional[int] = premium_subscription_month_count + self.prize_star_count: Optional[int] = prize_star_count self._id_attrs = ( self.chats, @@ -126,7 +140,7 @@ def __init__( def de_json( cls, data: Optional[JSONDict], bot: Optional["Bot"] = None ) -> Optional["Giveaway"]: - """See :obj:`telegram.TelegramObject.de_json`.""" + """See :meth:`telegram.TelegramObject.de_json`.""" data = cls._parse_data(data) if data is None: @@ -145,13 +159,28 @@ def de_json( class GiveawayCreated(TelegramObject): """This object represents a service message about the creation of a scheduled giveaway. - Currently holds no information. + + Args: + prize_star_count (:obj:`int`, optional): The number of Telegram Stars to be + split between giveaway winners; for Telegram Star giveaways only. + + .. versionadded:: 21.6 + + Attributes: + prize_star_count (:obj:`int`): Optional. The number of Telegram Stars to be + split between giveaway winners; for Telegram Star giveaways only. + + .. versionadded:: 21.6 + """ - __slots__ = () + __slots__ = ("prize_star_count",) - def __init__(self, *, api_kwargs: Optional[JSONDict] = None): + def __init__( + self, prize_star_count: Optional[int] = None, *, api_kwargs: Optional[JSONDict] = None + ): super().__init__(api_kwargs=api_kwargs) + self.prize_star_count: Optional[int] = prize_star_count self._freeze() @@ -173,6 +202,10 @@ class GiveawayWinners(TelegramObject): winner_count (:obj:`int`): Total number of winners in the giveaway winners (Sequence[:class:`telegram.User`]): List of up to :tg-const:`telegram.constants.GiveawayLimit.MAX_WINNERS` winners of the giveaway + prize_star_count (:obj:`int`, optional): The number of Telegram Stars to be split between + giveaway winners; for Telegram Star giveaways only. + + .. versionadded:: 21.6 additional_chat_count (:obj:`int`, optional): The number of other chats the user had to join in order to be eligible for the giveaway premium_subscription_month_count (:obj:`int`, optional): The number of months the Telegram @@ -190,10 +223,14 @@ class GiveawayWinners(TelegramObject): winners_selection_date (:class:`datetime.datetime`): Point in time when winners of the giveaway were selected. |datetime_localization| winner_count (:obj:`int`): Total number of winners in the giveaway - winners (Tuple[:class:`telegram.User`]): tuple of up to + winners (tuple[:class:`telegram.User`]): tuple of up to :tg-const:`telegram.constants.GiveawayLimit.MAX_WINNERS` winners of the giveaway additional_chat_count (:obj:`int`): Optional. The number of other chats the user had to join in order to be eligible for the giveaway + prize_star_count (:obj:`int`): Optional. The number of Telegram Stars to be split between + giveaway winners; for Telegram Star giveaways only. + + .. versionadded:: 21.6 premium_subscription_month_count (:obj:`int`): Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for unclaimed_prize_count (:obj:`int`): Optional. Number of undistributed prizes @@ -211,6 +248,7 @@ class GiveawayWinners(TelegramObject): "only_new_members", "premium_subscription_month_count", "prize_description", + "prize_star_count", "unclaimed_prize_count", "was_refunded", "winner_count", @@ -222,7 +260,7 @@ def __init__( self, chat: Chat, giveaway_message_id: int, - winners_selection_date: datetime.datetime, + winners_selection_date: dtm.datetime, winner_count: int, winners: Sequence[User], additional_chat_count: Optional[int] = None, @@ -231,6 +269,7 @@ def __init__( only_new_members: Optional[bool] = None, was_refunded: Optional[bool] = None, prize_description: Optional[str] = None, + prize_star_count: Optional[int] = None, *, api_kwargs: Optional[JSONDict] = None, ): @@ -238,15 +277,16 @@ def __init__( self.chat: Chat = chat self.giveaway_message_id: int = giveaway_message_id - self.winners_selection_date: datetime.datetime = winners_selection_date + self.winners_selection_date: dtm.datetime = winners_selection_date self.winner_count: int = winner_count - self.winners: Tuple[User, ...] = tuple(winners) + self.winners: tuple[User, ...] = tuple(winners) self.additional_chat_count: Optional[int] = additional_chat_count self.premium_subscription_month_count: Optional[int] = premium_subscription_month_count self.unclaimed_prize_count: Optional[int] = unclaimed_prize_count self.only_new_members: Optional[bool] = only_new_members self.was_refunded: Optional[bool] = was_refunded self.prize_description: Optional[str] = prize_description + self.prize_star_count: Optional[int] = prize_star_count self._id_attrs = ( self.chat, @@ -262,7 +302,7 @@ def __init__( def de_json( cls, data: Optional[JSONDict], bot: Optional["Bot"] = None ) -> Optional["GiveawayWinners"]: - """See :obj:`telegram.TelegramObject.de_json`.""" + """See :meth:`telegram.TelegramObject.de_json`.""" data = cls._parse_data(data) if data is None: @@ -295,21 +335,29 @@ class GiveawayCompleted(TelegramObject): unclaimed_prize_count (:obj:`int`, optional): Number of undistributed prizes giveaway_message (:class:`telegram.Message`, optional): Message with the giveaway that was completed, if it wasn't deleted + is_star_giveaway (:obj:`bool`, optional): :obj:`True`, if the giveaway is a Telegram Star + giveaway. Otherwise, currently, the giveaway is a Telegram Premium giveaway. + .. versionadded:: 21.6 Attributes: winner_count (:obj:`int`): Number of winners in the giveaway unclaimed_prize_count (:obj:`int`): Optional. Number of undistributed prizes giveaway_message (:class:`telegram.Message`): Optional. Message with the giveaway that was completed, if it wasn't deleted + is_star_giveaway (:obj:`bool`): Optional. :obj:`True`, if the giveaway is a Telegram Star + giveaway. Otherwise, currently, the giveaway is a Telegram Premium giveaway. + + .. versionadded:: 21.6 """ - __slots__ = ("giveaway_message", "unclaimed_prize_count", "winner_count") + __slots__ = ("giveaway_message", "is_star_giveaway", "unclaimed_prize_count", "winner_count") def __init__( self, winner_count: int, unclaimed_prize_count: Optional[int] = None, giveaway_message: Optional["Message"] = None, + is_star_giveaway: Optional[bool] = None, *, api_kwargs: Optional[JSONDict] = None, ): @@ -318,6 +366,7 @@ def __init__( self.winner_count: int = winner_count self.unclaimed_prize_count: Optional[int] = unclaimed_prize_count self.giveaway_message: Optional[Message] = giveaway_message + self.is_star_giveaway: Optional[bool] = is_star_giveaway self._id_attrs = ( self.winner_count, @@ -330,7 +379,7 @@ def __init__( def de_json( cls, data: Optional[JSONDict], bot: Optional["Bot"] = None ) -> Optional["GiveawayCompleted"]: - """See :obj:`telegram.TelegramObject.de_json`.""" + """See :meth:`telegram.TelegramObject.de_json`.""" data = cls._parse_data(data) if data is None: diff --git a/telegram/_inline/inlinekeyboardbutton.py b/telegram/_inline/inlinekeyboardbutton.py index 6ceca1a311b..32edb655411 100644 --- a/telegram/_inline/inlinekeyboardbutton.py +++ b/telegram/_inline/inlinekeyboardbutton.py @@ -21,6 +21,7 @@ from typing import TYPE_CHECKING, Final, Optional, Union from telegram import constants +from telegram._copytextbutton import CopyTextButton from telegram._games.callbackgame import CallbackGame from telegram._loginurl import LoginUrl from telegram._switchinlinequerychosenchat import SwitchInlineQueryChosenChat @@ -99,7 +100,7 @@ class InlineKeyboardButton(TelegramObject): .. seealso:: :wiki:`Arbitrary callback_data ` - web_app (:obj:`telegram.WebAppInfo`, optional): Description of the `Web App + web_app (:class:`telegram.WebAppInfo`, optional): Description of the `Web App `_ that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method :meth:`~telegram.Bot.answer_web_app_query`. Available only in @@ -107,16 +108,14 @@ class InlineKeyboardButton(TelegramObject): a Telegram Business account. .. versionadded:: 20.0 - switch_inline_query (:obj:`str`, optional): If set, pressing the button will insert the - bot's username and the specified inline query in the current chat's input field. May be - empty, in which case only the bot's username will be inserted. - - This offers a quick way for the user to open your bot in inline mode in the same chat - - good for selecting something from multiple options. Not supported in channels and for - messages sent on behalf of a Telegram Business account. + switch_inline_query (:obj:`str`, optional): If set, pressing the button will prompt the + user to select one of their chats, open that chat and insert the bot's username and the + specified inline query in the input field. May be empty, in which case just the bot's + username will be inserted. Not supported for messages sent on behalf of a Telegram + Business account. Tip: - This is similar to the new parameter :paramref:`switch_inline_query_chosen_chat`, + This is similar to the parameter :paramref:`switch_inline_query_chosen_chat`, but gives no control over which chats can be selected. switch_inline_query_current_chat (:obj:`str`, optional): If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input @@ -125,6 +124,10 @@ class InlineKeyboardButton(TelegramObject): This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business account. + copy_text (:class:`telegram.CopyTextButton`, optional): Description of the button that + copies the specified text to the clipboard. + + .. versionadded:: 21.7 callback_game (:class:`telegram.CallbackGame`, optional): Description of the game that will be launched when the user presses the button @@ -137,7 +140,7 @@ class InlineKeyboardButton(TelegramObject): Note: This type of button **must** always be the first button in the first row and can only be used in invoice messages. - switch_inline_query_chosen_chat (:obj:`telegram.SwitchInlineQueryChosenChat`, optional): + switch_inline_query_chosen_chat (:class:`telegram.SwitchInlineQueryChosenChat`, optional): If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent on behalf of a Telegram @@ -170,7 +173,7 @@ class InlineKeyboardButton(TelegramObject): to the bot when the button is pressed, UTF-8 :tg-const:`telegram.InlineKeyboardButton.MIN_CALLBACK_DATA`- :tg-const:`telegram.InlineKeyboardButton.MAX_CALLBACK_DATA` bytes. - web_app (:obj:`telegram.WebAppInfo`): Optional. Description of the `Web App + web_app (:class:`telegram.WebAppInfo`): Optional. Description of the `Web App `_ that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method :meth:`~telegram.Bot.answer_web_app_query`. Available only in @@ -178,16 +181,14 @@ class InlineKeyboardButton(TelegramObject): a Telegram Business account. .. versionadded:: 20.0 - switch_inline_query (:obj:`str`): Optional. If set, pressing the button will insert the - bot's username and the specified inline query in the current chat's input field. May be - empty, in which case only the bot's username will be inserted. - - This offers a quick way for the user to open your bot in inline mode in the same chat - - good for selecting something from multiple options. Not supported in channels and for - messages sent on behalf of a Telegram Business account. + switch_inline_query (:obj:`str`): Optional. If set, pressing the button will prompt the + user to select one of their chats, open that chat and insert the bot's username and the + specified inline query in the input field. May be empty, in which case just the bot's + username will be inserted. Not supported for messages sent on behalf of a Telegram + Business account. Tip: - This is similar to the new parameter :paramref:`switch_inline_query_chosen_chat`, + This is similar to the parameter :paramref:`switch_inline_query_chosen_chat`, but gives no control over which chats can be selected. switch_inline_query_current_chat (:obj:`str`): Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input @@ -196,6 +197,10 @@ class InlineKeyboardButton(TelegramObject): This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business account. + copy_text (:class:`telegram.CopyTextButton`): Optional. Description of the button that + copies the specified text to the clipboard. + + .. versionadded:: 21.7 callback_game (:class:`telegram.CallbackGame`): Optional. Description of the game that will be launched when the user presses the button. @@ -208,7 +213,7 @@ class InlineKeyboardButton(TelegramObject): Note: This type of button **must** always be the first button in the first row and can only be used in invoice messages. - switch_inline_query_chosen_chat (:obj:`telegram.SwitchInlineQueryChosenChat`): Optional. + switch_inline_query_chosen_chat (:class:`telegram.SwitchInlineQueryChosenChat`): Optional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent on behalf of a Telegram @@ -228,6 +233,7 @@ class InlineKeyboardButton(TelegramObject): __slots__ = ( "callback_data", "callback_game", + "copy_text", "login_url", "pay", "switch_inline_query", @@ -250,6 +256,7 @@ def __init__( login_url: Optional[LoginUrl] = None, web_app: Optional[WebAppInfo] = None, switch_inline_query_chosen_chat: Optional[SwitchInlineQueryChosenChat] = None, + copy_text: Optional[CopyTextButton] = None, *, api_kwargs: Optional[JSONDict] = None, ): @@ -269,6 +276,7 @@ def __init__( self.switch_inline_query_chosen_chat: Optional[SwitchInlineQueryChosenChat] = ( switch_inline_query_chosen_chat ) + self.copy_text: Optional[CopyTextButton] = copy_text self._id_attrs = () self._set_id_attrs() @@ -303,6 +311,7 @@ def de_json( data["switch_inline_query_chosen_chat"] = SwitchInlineQueryChosenChat.de_json( data.get("switch_inline_query_chosen_chat"), bot ) + data["copy_text"] = CopyTextButton.de_json(data.get("copy_text"), bot) return super().de_json(data=data, bot=bot) diff --git a/telegram/_inline/inlinekeyboardmarkup.py b/telegram/_inline/inlinekeyboardmarkup.py index 6857e4d8e3a..406688f2d2f 100644 --- a/telegram/_inline/inlinekeyboardmarkup.py +++ b/telegram/_inline/inlinekeyboardmarkup.py @@ -17,7 +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/]. """This module contains an object that represents a Telegram InlineKeyboardMarkup.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardbutton import InlineKeyboardButton from telegram._telegramobject import TelegramObject @@ -57,7 +58,7 @@ class InlineKeyboardMarkup(TelegramObject): |sequenceclassargs| Attributes: - inline_keyboard (Tuple[Tuple[:class:`telegram.InlineKeyboardButton`]]): Tuple of + inline_keyboard (tuple[tuple[:class:`telegram.InlineKeyboardButton`]]): Tuple of button rows, each represented by a tuple of :class:`~telegram.InlineKeyboardButton` objects. @@ -81,7 +82,7 @@ def __init__( "InlineKeyboardButtons" ) # Required - self.inline_keyboard: Tuple[Tuple[InlineKeyboardButton, ...], ...] = tuple( + self.inline_keyboard: tuple[tuple[InlineKeyboardButton, ...], ...] = tuple( tuple(row) for row in inline_keyboard ) diff --git a/telegram/_inline/inlinequery.py b/telegram/_inline/inlinequery.py index ba29a8646fe..f6a94e8f47e 100644 --- a/telegram/_inline/inlinequery.py +++ b/telegram/_inline/inlinequery.py @@ -19,7 +19,8 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram InlineQuery.""" -from typing import TYPE_CHECKING, Callable, Final, Optional, Sequence, Union +from collections.abc import Sequence +from typing import TYPE_CHECKING, Callable, Final, Optional, Union from telegram import constants from telegram._files.location import Location diff --git a/telegram/_inline/inlinequeryresultaudio.py b/telegram/_inline/inlinequeryresultaudio.py index 69353967adc..0b2b822b60e 100644 --- a/telegram/_inline/inlinequeryresultaudio.py +++ b/telegram/_inline/inlinequeryresultaudio.py @@ -17,7 +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/]. """This module contains the classes that represent Telegram InlineQueryResultAudio.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -73,7 +74,7 @@ class InlineQueryResultAudio(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -124,6 +125,6 @@ def __init__( self.audio_duration: Optional[int] = 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.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 diff --git a/telegram/_inline/inlinequeryresultcachedaudio.py b/telegram/_inline/inlinequeryresultcachedaudio.py index 2fb7cdbb54d..933a2b85bce 100644 --- a/telegram/_inline/inlinequeryresultcachedaudio.py +++ b/telegram/_inline/inlinequeryresultcachedaudio.py @@ -17,7 +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/]. """This module contains the classes that represent Telegram InlineQueryResultCachedAudio.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -68,7 +69,7 @@ class InlineQueryResultCachedAudio(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -110,6 +111,6 @@ def __init__( # Optionals self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + 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 diff --git a/telegram/_inline/inlinequeryresultcacheddocument.py b/telegram/_inline/inlinequeryresultcacheddocument.py index b5416c2748c..0ef4e199338 100644 --- a/telegram/_inline/inlinequeryresultcacheddocument.py +++ b/telegram/_inline/inlinequeryresultcacheddocument.py @@ -17,7 +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/]. """This module contains the classes that represent Telegram InlineQueryResultCachedDocument.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -72,7 +73,7 @@ class InlineQueryResultCachedDocument(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -120,6 +121,6 @@ def __init__( self.description: Optional[str] = description self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + 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 diff --git a/telegram/_inline/inlinequeryresultcachedgif.py b/telegram/_inline/inlinequeryresultcachedgif.py index 9f52347a05c..c621a814e51 100644 --- a/telegram/_inline/inlinequeryresultcachedgif.py +++ b/telegram/_inline/inlinequeryresultcachedgif.py @@ -17,7 +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/]. """This module contains the classes that represent Telegram InlineQueryResultCachedGif.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -74,7 +75,7 @@ class InlineQueryResultCachedGif(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -124,7 +125,7 @@ def __init__( self.title: Optional[str] = title self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + 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 self.show_caption_above_media: Optional[bool] = show_caption_above_media diff --git a/telegram/_inline/inlinequeryresultcachedmpeg4gif.py b/telegram/_inline/inlinequeryresultcachedmpeg4gif.py index f750f4df8fd..fa5be748441 100644 --- a/telegram/_inline/inlinequeryresultcachedmpeg4gif.py +++ b/telegram/_inline/inlinequeryresultcachedmpeg4gif.py @@ -17,7 +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/]. """This module contains the classes that represent Telegram InlineQueryResultMpeg4Gif.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -74,7 +75,7 @@ class InlineQueryResultCachedMpeg4Gif(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -124,7 +125,7 @@ def __init__( self.title: Optional[str] = title self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + 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 self.show_caption_above_media: Optional[bool] = show_caption_above_media diff --git a/telegram/_inline/inlinequeryresultcachedphoto.py b/telegram/_inline/inlinequeryresultcachedphoto.py index 75f292d2e32..06914934ff7 100644 --- a/telegram/_inline/inlinequeryresultcachedphoto.py +++ b/telegram/_inline/inlinequeryresultcachedphoto.py @@ -17,7 +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/]. """This module contains the classes that represent Telegram InlineQueryResultPhoto""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -76,7 +77,7 @@ class InlineQueryResultCachedPhoto(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -129,7 +130,7 @@ def __init__( self.description: Optional[str] = description self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + 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 self.show_caption_above_media: Optional[bool] = show_caption_above_media diff --git a/telegram/_inline/inlinequeryresultcachedvideo.py b/telegram/_inline/inlinequeryresultcachedvideo.py index 99a58eebbe5..a341114d7a7 100644 --- a/telegram/_inline/inlinequeryresultcachedvideo.py +++ b/telegram/_inline/inlinequeryresultcachedvideo.py @@ -17,7 +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/]. """This module contains the classes that represent Telegram InlineQueryResultCachedVideo.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -72,7 +73,7 @@ class InlineQueryResultCachedVideo(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -125,7 +126,7 @@ def __init__( self.description: Optional[str] = description self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + 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 self.show_caption_above_media: Optional[bool] = show_caption_above_media diff --git a/telegram/_inline/inlinequeryresultcachedvoice.py b/telegram/_inline/inlinequeryresultcachedvoice.py index dc8bd2ad3a6..c830264edef 100644 --- a/telegram/_inline/inlinequeryresultcachedvoice.py +++ b/telegram/_inline/inlinequeryresultcachedvoice.py @@ -17,7 +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/]. """This module contains the classes that represent Telegram InlineQueryResultCachedVoice.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -70,7 +71,7 @@ class InlineQueryResultCachedVoice(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |caption_entities| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |caption_entities| .. versionchanged:: 20.0 @@ -115,6 +116,6 @@ def __init__( # Optionals self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + 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 diff --git a/telegram/_inline/inlinequeryresultdocument.py b/telegram/_inline/inlinequeryresultdocument.py index e0380440b20..aef409ca0c4 100644 --- a/telegram/_inline/inlinequeryresultdocument.py +++ b/telegram/_inline/inlinequeryresultdocument.py @@ -17,7 +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/]. """This module contains the classes that represent Telegram InlineQueryResultDocument""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -86,7 +87,7 @@ class InlineQueryResultDocument(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -155,7 +156,7 @@ def __init__( # Optionals self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + self.caption_entities: tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) self.description: Optional[str] = description self.reply_markup: Optional[InlineKeyboardMarkup] = reply_markup self.input_message_content: Optional[InputMessageContent] = input_message_content diff --git a/telegram/_inline/inlinequeryresultgif.py b/telegram/_inline/inlinequeryresultgif.py index 13e1f253b99..f95aec09cba 100644 --- a/telegram/_inline/inlinequeryresultgif.py +++ b/telegram/_inline/inlinequeryresultgif.py @@ -17,7 +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/]. """This module contains the classes that represent Telegram InlineQueryResultGif.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -50,16 +51,14 @@ class InlineQueryResultGif(InlineQueryResult): 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. - thumbnail_url (:obj:`str`, optional): URL of the static (JPEG or GIF) or animated (MPEG4) + thumbnail_url (:obj:`str`): URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result. - Warning: - The Bot API does **not** define this as an optional argument. It is formally - optional for backwards compatibility with the deprecated :paramref:`thumb_url`. - If you pass neither :paramref:`thumbnail_url` nor :paramref:`thumb_url`, - :class:`ValueError` will be raised. - .. versionadded:: 20.2 + + ..versionchanged:: 20.5 + |thumbnail_url_mandatory| + thumbnail_mime_type (:obj:`str`, optional): MIME type of the thumbnail, must be one of ``'image/jpeg'``, ``'image/gif'``, or ``'video/mp4'``. Defaults to ``'image/jpeg'``. @@ -82,10 +81,6 @@ class InlineQueryResultGif(InlineQueryResult): .. versionadded:: 21.3 - Raises: - :class:`ValueError`: If neither :paramref:`thumbnail_url` nor :paramref:`thumb_url` is - supplied or if both are supplied and are not equal. - Attributes: type (:obj:`str`): :tg-const:`telegram.constants.InlineQueryResultType.GIF`. id (:obj:`str`): Unique identifier for this result, @@ -108,7 +103,7 @@ class InlineQueryResultGif(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -172,7 +167,7 @@ def __init__( self.title: Optional[str] = title self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + 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 self.thumbnail_mime_type: Optional[str] = thumbnail_mime_type diff --git a/telegram/_inline/inlinequeryresultmpeg4gif.py b/telegram/_inline/inlinequeryresultmpeg4gif.py index 1fff848418d..43b8ae161a0 100644 --- a/telegram/_inline/inlinequeryresultmpeg4gif.py +++ b/telegram/_inline/inlinequeryresultmpeg4gif.py @@ -17,7 +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/]. """This module contains the classes that represent Telegram InlineQueryResultMpeg4Gif.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -51,16 +52,14 @@ class InlineQueryResultMpeg4Gif(InlineQueryResult): mpeg4_width (:obj:`int`, optional): Video width. mpeg4_height (:obj:`int`, optional): Video height. mpeg4_duration (:obj:`int`, optional): Video duration in seconds. - thumbnail_url (:obj:`str`, optional): URL of the static (JPEG or GIF) or animated (MPEG4) + thumbnail_url (:obj:`str`): URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result. - Warning: - The Bot API does **not** define this as an optional argument. It is formally - optional for backwards compatibility with the deprecated :paramref:`thumb_url`. - If you pass neither :paramref:`thumbnail_url` nor :paramref:`thumb_url`, - :class:`ValueError` will be raised. - .. versionadded:: 20.2 + + ..versionchanged:: 20.5 + |thumbnail_url_mandatory| + thumbnail_mime_type (:obj:`str`, optional): MIME type of the thumbnail, must be one of ``'image/jpeg'``, ``'image/gif'``, or ``'video/mp4'``. Defaults to ``'image/jpeg'``. @@ -83,9 +82,6 @@ class InlineQueryResultMpeg4Gif(InlineQueryResult): show_caption_above_media (:obj:`bool`, optional): Pass |show_cap_above_med| .. versionadded:: 21.3 - Raises: - :class:`ValueError`: If neither :paramref:`thumbnail_url` nor :paramref:`thumb_url` is - supplied or if both are supplied and are not equal. Attributes: type (:obj:`str`): :tg-const:`telegram.constants.InlineQueryResultType.MPEG4GIF`. @@ -109,7 +105,7 @@ class InlineQueryResultMpeg4Gif(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |caption_entities| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |caption_entities| .. versionchanged:: 20.0 @@ -173,7 +169,7 @@ def __init__( self.title: Optional[str] = title self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + 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 self.thumbnail_mime_type: Optional[str] = thumbnail_mime_type diff --git a/telegram/_inline/inlinequeryresultphoto.py b/telegram/_inline/inlinequeryresultphoto.py index 637e952d4d0..ce5a9ab867e 100644 --- a/telegram/_inline/inlinequeryresultphoto.py +++ b/telegram/_inline/inlinequeryresultphoto.py @@ -17,7 +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/]. """This module contains the classes that represent Telegram InlineQueryResultPhoto.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -48,15 +49,13 @@ class InlineQueryResultPhoto(InlineQueryResult): :tg-const:`telegram.InlineQueryResult.MAX_ID_LENGTH` Bytes. photo_url (:obj:`str`): A valid URL of the photo. Photo must be in JPEG format. Photo size must not exceed 5MB. - thumbnail_url (:obj:`str`, optional): URL of the thumbnail for the photo. - - Warning: - The Bot API does **not** define this as an optional argument. It is formally - optional for backwards compatibility with the deprecated :paramref:`thumb_url`. - If you pass neither :paramref:`thumbnail_url` nor :paramref:`thumb_url`, - :class:`ValueError` will be raised. + thumbnail_url (:obj:`str`): URL of the thumbnail for the photo. .. versionadded:: 20.2 + + ..versionchanged:: 20.5 + |thumbnail_url_mandatory| + photo_width (:obj:`int`, optional): Width of the photo. photo_height (:obj:`int`, optional): Height of the photo. title (:obj:`str`, optional): Title for the result. @@ -78,10 +77,6 @@ class InlineQueryResultPhoto(InlineQueryResult): .. versionadded:: 21.3 - Raises: - :class:`ValueError`: If neither :paramref:`thumbnail_url` nor :paramref:`thumb_url` is - supplied or if both are supplied and are not equal. - Attributes: type (:obj:`str`): :tg-const:`telegram.constants.InlineQueryResultType.PHOTO`. id (:obj:`str`): Unique identifier for this result, @@ -98,7 +93,7 @@ class InlineQueryResultPhoto(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -160,7 +155,7 @@ def __init__( self.description: Optional[str] = description self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + 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 self.show_caption_above_media: Optional[bool] = show_caption_above_media diff --git a/telegram/_inline/inlinequeryresultvideo.py b/telegram/_inline/inlinequeryresultvideo.py index 90bf4c86d3d..ce21da45549 100644 --- a/telegram/_inline/inlinequeryresultvideo.py +++ b/telegram/_inline/inlinequeryresultvideo.py @@ -17,7 +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/]. """This module contains the classes that represent Telegram InlineQueryResultVideo.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -55,20 +56,12 @@ class InlineQueryResultVideo(InlineQueryResult): mime_type (:obj:`str`): Mime type of the content of video url, "text/html" or "video/mp4". thumbnail_url (:obj:`str`, optional): URL of the thumbnail (JPEG only) for the video. - Warning: - The Bot API does **not** define this as an optional argument. It is formally - optional for backwards compatibility with the deprecated :paramref:`thumb_url`. - If you pass neither :paramref:`thumbnail_url` nor :paramref:`thumb_url`, - :class:`ValueError` will be raised. - .. versionadded:: 20.2 - title (:obj:`str`, optional): Title for the result. - Warning: - The Bot API does **not** define this as an optional argument. It is formally - optional to ensure backwards compatibility of :paramref:`thumbnail_url` with the - deprecated :paramref:`thumb_url`, which required that :paramref:`thumbnail_url` - become optional. :class:`TypeError` will be raised if no ``title`` is passed. + ..versionchanged:: 20.5 + |thumbnail_url_mandatory| + + title (:obj:`str`): Title for the result. caption (:obj:`str`, optional): Caption of the video to be sent, 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. @@ -92,11 +85,6 @@ class InlineQueryResultVideo(InlineQueryResult): .. versionadded:: 21.3 - Raises: - :class:`ValueError`: If neither :paramref:`thumbnail_url` nor :paramref:`thumb_url` is - supplied or if both are supplied and are not equal. - :class:`TypeError`: If no :paramref:`title` is passed. - Attributes: type (:obj:`str`): :tg-const:`telegram.constants.InlineQueryResultType.VIDEO`. id (:obj:`str`): Unique identifier for this result, @@ -112,7 +100,7 @@ class InlineQueryResultVideo(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -184,7 +172,7 @@ def __init__( # Optional self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + 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 diff --git a/telegram/_inline/inlinequeryresultvoice.py b/telegram/_inline/inlinequeryresultvoice.py index d33f31b34d8..de196498fb4 100644 --- a/telegram/_inline/inlinequeryresultvoice.py +++ b/telegram/_inline/inlinequeryresultvoice.py @@ -17,7 +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/]. """This module contains the classes that represent Telegram InlineQueryResultVoice.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -72,7 +73,7 @@ class InlineQueryResultVoice(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -121,6 +122,6 @@ def __init__( self.voice_duration: Optional[int] = 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.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 diff --git a/telegram/_inline/inputinvoicemessagecontent.py b/telegram/_inline/inputinvoicemessagecontent.py index e13642da562..2ab896c8a5c 100644 --- a/telegram/_inline/inputinvoicemessagecontent.py +++ b/telegram/_inline/inputinvoicemessagecontent.py @@ -17,7 +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/]. """This module contains a class that represents a Telegram InputInvoiceMessageContent.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inputmessagecontent import InputMessageContent from telegram._payment.labeledprice import LabeledPrice @@ -47,7 +48,7 @@ class InputInvoiceMessageContent(InputMessageContent): payload (:obj:`str`): Bot-defined invoice payload. :tg-const:`telegram.Invoice.MIN_PAYLOAD_LENGTH`- :tg-const:`telegram.Invoice.MAX_PAYLOAD_LENGTH` bytes. This will not be displayed - to the user, use for your internal processes. + to the user, use it for your internal processes. provider_token (:obj:`str`): Payment provider token, obtained via `@Botfather `_. Pass an empty string for payments in |tg_stars|. @@ -115,14 +116,14 @@ class InputInvoiceMessageContent(InputMessageContent): payload (:obj:`str`): Bot-defined invoice payload. :tg-const:`telegram.Invoice.MIN_PAYLOAD_LENGTH`- :tg-const:`telegram.Invoice.MAX_PAYLOAD_LENGTH` bytes. This will not be displayed - to the user, use for your internal processes. + to the user, use it for your internal processes. provider_token (:obj:`str`): Payment provider token, obtained via `@Botfather `_. Pass an empty string for payments in `Telegram Stars `_. currency (:obj:`str`): Three-letter ISO 4217 currency code, see more on `currencies `_. Pass ``XTR`` for payments in |tg_stars|. - prices (Tuple[:class:`telegram.LabeledPrice`]): Price breakdown, a list of + prices (tuple[:class:`telegram.LabeledPrice`]): Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in |tg_stars|. @@ -135,7 +136,7 @@ class InputInvoiceMessageContent(InputMessageContent): `currencies.json `_, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to ``0``. Not supported for payments in |tg_stars|. - suggested_tip_amounts (Tuple[:obj:`int`]): Optional. An array of suggested + suggested_tip_amounts (tuple[:obj:`int`]): Optional. An array of suggested amounts of tip in the *smallest units* of the currency (integer, **not** float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed @@ -226,10 +227,10 @@ def __init__( self.payload: str = payload self.provider_token: Optional[str] = provider_token self.currency: str = currency - self.prices: Tuple[LabeledPrice, ...] = parse_sequence_arg(prices) + self.prices: tuple[LabeledPrice, ...] = parse_sequence_arg(prices) # Optionals self.max_tip_amount: Optional[int] = max_tip_amount - self.suggested_tip_amounts: Tuple[int, ...] = parse_sequence_arg(suggested_tip_amounts) + self.suggested_tip_amounts: tuple[int, ...] = parse_sequence_arg(suggested_tip_amounts) self.provider_data: Optional[str] = provider_data self.photo_url: Optional[str] = photo_url self.photo_size: Optional[int] = photo_size diff --git a/telegram/_inline/inputtextmessagecontent.py b/telegram/_inline/inputtextmessagecontent.py index 475f9c5bb28..09d5e597b13 100644 --- a/telegram/_inline/inputtextmessagecontent.py +++ b/telegram/_inline/inputtextmessagecontent.py @@ -17,7 +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/]. """This module contains the classes that represent Telegram InputTextMessageContent.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inputmessagecontent import InputMessageContent from telegram._messageentity import MessageEntity @@ -75,7 +76,7 @@ class InputTextMessageContent(InputMessageContent): :tg-const:`telegram.constants.MessageLimit.MAX_TEXT_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -107,7 +108,7 @@ def __init__( self.message_text: str = message_text # Optionals self.parse_mode: ODVInput[str] = parse_mode - self.entities: Tuple[MessageEntity, ...] = parse_sequence_arg(entities) + self.entities: tuple[MessageEntity, ...] = parse_sequence_arg(entities) self.link_preview_options: ODVInput[LinkPreviewOptions] = parse_lpo_and_dwpp( disable_web_page_preview, link_preview_options ) diff --git a/telegram/_inline/preparedinlinemessage.py b/telegram/_inline/preparedinlinemessage.py new file mode 100644 index 00000000000..3f094d56bc8 --- /dev/null +++ b/telegram/_inline/preparedinlinemessage.py @@ -0,0 +1,83 @@ +#!/usr/bin/env python +# +# A library that provides a Python interface to the Telegram Bot API +# Copyright (C) 2015-2024 +# Leandro Toledo de Souza +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser Public License for more details. +# +# You should have received a copy of the GNU Lesser Public License +# along with this program. If not, see [http://www.gnu.org/licenses/]. +"""This module contains an object that represents a Telegram Prepared inline Message.""" +import datetime as dtm +from typing import TYPE_CHECKING, Optional + +from telegram._telegramobject import TelegramObject +from telegram._utils.datetime import extract_tzinfo_from_defaults, from_timestamp +from telegram._utils.types import JSONDict + +if TYPE_CHECKING: + from telegram import Bot + + +class PreparedInlineMessage(TelegramObject): + """Describes an inline message to be sent by a user of a Mini App. + + Objects of this class are comparable in terms of equality. Two objects of this class are + considered equal, if their :attr:`id` is equal. + + .. versionadded:: 21.8 + + Args: + id (:obj:`str`): Unique identifier of the prepared message + expiration_date (:class:`datetime.datetime`): Expiration date of the prepared message. + Expired prepared messages can no longer be used. + |datetime_localization| + + Attributes: + id (:obj:`str`): Unique identifier of the prepared message + expiration_date (:class:`datetime.datetime`): Expiration date of the prepared message. + Expired prepared messages can no longer be used. + |datetime_localization| + """ + + __slots__ = ("expiration_date", "id") + + def __init__( + self, + id: str, # pylint: disable=redefined-builtin + expiration_date: dtm.datetime, + *, + api_kwargs: Optional[JSONDict] = None, + ): + super().__init__(api_kwargs=api_kwargs) + self.id: str = id + self.expiration_date: dtm.datetime = expiration_date + + self._id_attrs = (self.id,) + + self._freeze() + + @classmethod + def de_json( + cls, data: Optional[JSONDict], bot: Optional["Bot"] = None + ) -> Optional["PreparedInlineMessage"]: + """See :meth:`telegram.TelegramObject.de_json`.""" + data = cls._parse_data(data) + + if data is None: + return None + + # Get the local timezone from the bot if it has defaults + loc_tzinfo = extract_tzinfo_from_defaults(bot) + data["expiration_date"] = from_timestamp(data.get("expiration_date"), tzinfo=loc_tzinfo) + + return super().de_json(data=data, bot=bot) diff --git a/telegram/_menubutton.py b/telegram/_menubutton.py index 50b6511b08d..3df50fd3f8b 100644 --- a/telegram/_menubutton.py +++ b/telegram/_menubutton.py @@ -17,7 +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/]. """This module contains objects related to Telegram menu buttons.""" -from typing import TYPE_CHECKING, Dict, Final, Optional, Type +from typing import TYPE_CHECKING, Final, Optional from telegram import constants from telegram._telegramobject import TelegramObject @@ -76,7 +76,7 @@ def de_json( care of selecting the correct subclass. Args: - data (Dict[:obj:`str`, ...]): The JSON data. + data (dict[:obj:`str`, ...]): The JSON data. bot (:class:`telegram.Bot`, optional): The bot associated with this object. Defaults to :obj:`None`, in which case shortcut methods will not be available. @@ -95,7 +95,7 @@ def de_json( if not data and cls is MenuButton: return None - _class_mapping: Dict[str, Type[MenuButton]] = { + _class_mapping: dict[str, type[MenuButton]] = { cls.COMMANDS: MenuButtonCommands, cls.WEB_APP: MenuButtonWebApp, cls.DEFAULT: MenuButtonDefault, diff --git a/telegram/_message.py b/telegram/_message.py index fceb8cb8768..f56acfeb134 100644 --- a/telegram/_message.py +++ b/telegram/_message.py @@ -19,10 +19,11 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram Message.""" -import datetime +import datetime as dtm import re +from collections.abc import Sequence from html import escape -from typing import TYPE_CHECKING, Dict, List, Optional, Sequence, Tuple, TypedDict, Union +from typing import TYPE_CHECKING, Optional, TypedDict, Union from telegram._chat import Chat from telegram._chatbackground import ChatBackground @@ -68,6 +69,7 @@ from telegram._utils.datetime import extract_tzinfo_from_defaults, from_timestamp from telegram._utils.defaultvalue import DEFAULT_NONE, DefaultValue from telegram._utils.entities import parse_message_entities, parse_message_entity +from telegram._utils.strings import TextEncoding from telegram._utils.types import ( CorrectOptionID, FileInput, @@ -103,6 +105,7 @@ InputMediaDocument, InputMediaPhoto, InputMediaVideo, + InputPaidMedia, InputPollOption, LabeledPrice, MessageId, @@ -155,14 +158,14 @@ def __init__( self, chat: Chat, message_id: int, - date: datetime.datetime, + date: dtm.datetime, *, api_kwargs: Optional[JSONDict] = None, ): super().__init__(api_kwargs=api_kwargs) self.chat: Chat = chat self.message_id: int = message_id - self.date: datetime.datetime = date + self.date: dtm.datetime = date self._id_attrs = (self.message_id, self.chat) @@ -278,16 +281,18 @@ class Message(MaybeInaccessibleMessage): and notice that some positional arguments changed position as a result. Args: - message_id (:obj:`int`): Unique message identifier inside this chat. - from_user (:class:`telegram.User`, optional): Sender of the message; empty for messages - sent to channels. For backward compatibility, this will contain a fake sender user in - non-channel chats, if the message was sent on behalf of a chat. - sender_chat (:class:`telegram.Chat`, optional): Sender of the message, sent on behalf of a - chat. For example, the channel itself for channel posts, the supergroup itself for - messages from anonymous group administrators, the linked channel for messages - automatically forwarded to the discussion group. For backward compatibility, - :attr:`from_user` contains a fake sender user in non-channel chats, if the message was - sent on behalf of a chat. + message_id (:obj:`int`): Unique message identifier inside this chat. In specific instances + (e.g., message containing a video sent to a big chat), the server might automatically + schedule a message instead of sending it immediately. In such cases, this field will be + ``0`` and the relevant message will be unusable until it is actually sent. + from_user (:class:`telegram.User`, optional): Sender of the message; may be empty for + messages sent to channels. For backward compatibility, if the message was sent on + behalf of a chat, the field contains a fake sender user in non-channel chats. + sender_chat (:class:`telegram.Chat`, optional): Sender of the message when sent on behalf + of a chat. For example, the supergroup itself for messages sent by its anonymous + administrators or a linked channel for messages automatically forwarded to the + channel's discussion group. For backward compatibility, if the message was sent on + behalf of a chat, the field from contains a fake sender user in non-channel chats. date (:class:`datetime.datetime`): Date the message was sent in Unix time. Converted to :class:`datetime.datetime`. @@ -358,7 +363,7 @@ class Message(MaybeInaccessibleMessage): about the animation. For backward compatibility, when this field is set, the document field will also be set. game (:class:`telegram.Game`, optional): Message is a game, information about the game. - `More about games >> `_. + :ref:`More about games >> `. photo (Sequence[:class:`telegram.PhotoSize`], optional): Message is a photo, available sizes of the photo. This list is empty if the message does not contain a photo. @@ -431,10 +436,10 @@ class Message(MaybeInaccessibleMessage): :class:`telegram.InaccessibleMessage`. invoice (:class:`telegram.Invoice`, optional): Message is an invoice for a payment, information about the invoice. - `More about payments >> `_. + :ref:`More about payments >> `. successful_payment (:class:`telegram.SuccessfulPayment`, optional): Message is a service message about a successful payment, information about the payment. - `More about payments >> `_. + :ref:`More about payments >> `. connected_website (:obj:`str`, optional): The domain name of the website on which the user has logged in. `More about Telegram Login >> `_. @@ -569,36 +574,38 @@ class Message(MaybeInaccessibleMessage): .. versionadded:: 21.1 - sender_business_bot (:obj:`telegram.User`, optional): The bot that actually sent the + sender_business_bot (:class:`telegram.User`, optional): The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account. .. versionadded:: 21.1 - chat_background_set (:obj:`telegram.ChatBackground`, optional): Service message: chat + chat_background_set (:class:`telegram.ChatBackground`, optional): Service message: chat background set. .. versionadded:: 21.2 - paid_media (:obj:`telegram.PaidMediaInfo`, optional): Message contains paid media; + paid_media (:class:`telegram.PaidMediaInfo`, optional): Message contains paid media; information about the paid media. .. versionadded:: 21.4 - refunded_payment (:obj:`telegram.RefundedPayment`, optional): Message is a service message - about a refunded payment, information about the payment. + refunded_payment (:class:`telegram.RefundedPayment`, optional): Message is a service + message about a refunded payment, information about the payment. .. versionadded:: 21.4 Attributes: - message_id (:obj:`int`): Unique message identifier inside this chat. - from_user (:class:`telegram.User`): Optional. Sender of the message; empty for messages - sent to channels. For backward compatibility, this will contain a fake sender user in - non-channel chats, if the message was sent on behalf of a chat. - sender_chat (:class:`telegram.Chat`): Optional. Sender of the message, sent on behalf of a - chat. For example, the channel itself for channel posts, the supergroup itself for - messages from anonymous group administrators, the linked channel for messages - automatically forwarded to the discussion group. For backward compatibility, - :attr:`from_user` contains a fake sender user in non-channel chats, if the message was - sent on behalf of a chat. + message_id (:obj:`int`): Unique message identifier inside this chat. In specific instances + (e.g., message containing a video sent to a big chat), the server might automatically + schedule a message instead of sending it immediately. In such cases, this field will be + ``0`` and the relevant message will be unusable until it is actually sent. + from_user (:class:`telegram.User`): Optional. Sender of the message; may be empty for + messages sent to channels. For backward compatibility, if the message was sent on + behalf of a chat, the field contains a fake sender user in non-channel chats. + sender_chat (:class:`telegram.Chat`): Optional. Sender of the message when sent on behalf + of a chat. For example, the supergroup itself for messages sent by its anonymous + administrators or a linked channel for messages automatically forwarded to the + channel's discussion group. For backward compatibility, if the message was sent on + behalf of a chat, the field from contains a fake sender user in non-channel chats. date (:class:`datetime.datetime`): Date the message was sent in Unix time. Converted to :class:`datetime.datetime`. @@ -630,7 +637,7 @@ class Message(MaybeInaccessibleMessage): message belongs to. text (:obj:`str`): Optional. For text messages, the actual UTF-8 text of the message, 0-:tg-const:`telegram.constants.MessageLimit.MAX_TEXT_LENGTH` characters. - entities (Tuple[:class:`telegram.MessageEntity`]): Optional. For text messages, special + entities (tuple[:class:`telegram.MessageEntity`]): Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text. See :attr:`parse_entity` and :attr:`parse_entities` methods for how to use properly. This list is empty if the message does not contain entities. @@ -649,7 +656,7 @@ class Message(MaybeInaccessibleMessage): ..versionadded:: 21.3 - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. For messages with a + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. For messages with a Caption. Special entities like usernames, URLs, bot commands, etc. that appear in the caption. See :attr:`Message.parse_caption_entity` and :attr:`parse_caption_entities` methods for how to use properly. This list is empty if the message does not contain @@ -675,8 +682,8 @@ class Message(MaybeInaccessibleMessage): .. seealso:: :wiki:`Working with Files and Media ` game (:class:`telegram.Game`): Optional. Message is a game, information about the game. - `More about games >> `_. - photo (Tuple[:class:`telegram.PhotoSize`]): Optional. Message is a photo, available + :ref:`More about games >> `. + photo (tuple[:class:`telegram.PhotoSize`]): Optional. Message is a photo, available sizes of the photo. This list is empty if the message does not contain a photo. .. seealso:: :wiki:`Working with Files and Media ` @@ -704,7 +711,7 @@ class Message(MaybeInaccessibleMessage): about the video message. .. seealso:: :wiki:`Working with Files and Media ` - new_chat_members (Tuple[:class:`telegram.User`]): Optional. New members that were added + new_chat_members (tuple[:class:`telegram.User`]): Optional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members). This list is empty if the message does not contain new chat members. @@ -723,7 +730,7 @@ class Message(MaybeInaccessibleMessage): left_chat_member (:class:`telegram.User`): Optional. A member was removed from the group, information about them (this member may be the bot itself). new_chat_title (:obj:`str`): Optional. A chat title was changed to this value. - new_chat_photo (Tuple[:class:`telegram.PhotoSize`]): A chat photo was changed to + new_chat_photo (tuple[:class:`telegram.PhotoSize`]): A chat photo was changed to this value. This list is empty if the message does not contain a new chat photo. .. versionchanged:: 20.0 @@ -757,10 +764,10 @@ class Message(MaybeInaccessibleMessage): :class:`telegram.InaccessibleMessage`. invoice (:class:`telegram.Invoice`): Optional. Message is an invoice for a payment, information about the invoice. - `More about payments >> `_. + :ref:`More about payments >> `. successful_payment (:class:`telegram.SuccessfulPayment`): Optional. Message is a service message about a successful payment, information about the payment. - `More about payments >> `_. + :ref:`More about payments >> `. connected_website (:obj:`str`): Optional. The domain name of the website on which the user has logged in. `More about Telegram Login >> `_. @@ -896,22 +903,22 @@ class Message(MaybeInaccessibleMessage): .. versionadded:: 21.1 - sender_business_bot (:obj:`telegram.User`): Optional. The bot that actually sent the + sender_business_bot (:class:`telegram.User`): Optional. The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account. .. versionadded:: 21.1 - chat_background_set (:obj:`telegram.ChatBackground`): Optional. Service message: chat + chat_background_set (:class:`telegram.ChatBackground`): Optional. Service message: chat background set .. versionadded:: 21.2 - paid_media (:obj:`telegram.PaidMediaInfo`): Optional. Message contains paid media; + paid_media (:class:`telegram.PaidMediaInfo`): Optional. Message contains paid media; information about the paid media. .. versionadded:: 21.4 - refunded_payment (:obj:`telegram.RefundedPayment`): Optional. Message is a service message - about a refunded payment, information about the payment. + refunded_payment (:class:`telegram.RefundedPayment`): Optional. Message is a service + message about a refunded payment, information about the payment. .. versionadded:: 21.4 @@ -1017,11 +1024,11 @@ class Message(MaybeInaccessibleMessage): def __init__( self, message_id: int, - date: datetime.datetime, + date: dtm.datetime, chat: Chat, from_user: Optional[User] = None, reply_to_message: Optional["Message"] = None, - edit_date: Optional[datetime.datetime] = None, + edit_date: Optional[dtm.datetime] = None, text: Optional[str] = None, entities: Optional[Sequence["MessageEntity"]] = None, caption_entities: Optional[Sequence["MessageEntity"]] = None, @@ -1112,19 +1119,19 @@ def __init__( # Optionals self.from_user: Optional[User] = from_user self.sender_chat: Optional[Chat] = sender_chat - self.date: datetime.datetime = date + self.date: dtm.datetime = date self.chat: Chat = chat self.is_automatic_forward: Optional[bool] = is_automatic_forward self.reply_to_message: Optional[Message] = reply_to_message - self.edit_date: Optional[datetime.datetime] = edit_date + self.edit_date: Optional[dtm.datetime] = edit_date self.has_protected_content: Optional[bool] = has_protected_content self.text: Optional[str] = text - self.entities: Tuple[MessageEntity, ...] = parse_sequence_arg(entities) - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + self.entities: tuple[MessageEntity, ...] = parse_sequence_arg(entities) + self.caption_entities: tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) self.audio: Optional[Audio] = audio self.game: Optional[Game] = game self.document: Optional[Document] = document - self.photo: Tuple[PhotoSize, ...] = parse_sequence_arg(photo) + self.photo: tuple[PhotoSize, ...] = parse_sequence_arg(photo) self.sticker: Optional[Sticker] = sticker self.video: Optional[Video] = video self.voice: Optional[Voice] = voice @@ -1133,10 +1140,10 @@ def __init__( self.contact: Optional[Contact] = contact self.location: Optional[Location] = location self.venue: Optional[Venue] = venue - self.new_chat_members: Tuple[User, ...] = parse_sequence_arg(new_chat_members) + self.new_chat_members: tuple[User, ...] = parse_sequence_arg(new_chat_members) self.left_chat_member: Optional[User] = left_chat_member self.new_chat_title: Optional[str] = new_chat_title - self.new_chat_photo: Tuple[PhotoSize, ...] = parse_sequence_arg(new_chat_photo) + self.new_chat_photo: tuple[PhotoSize, ...] = parse_sequence_arg(new_chat_photo) self.delete_chat_photo: Optional[bool] = bool(delete_chat_photo) self.group_chat_created: Optional[bool] = bool(group_chat_created) self.supergroup_chat_created: Optional[bool] = bool(supergroup_chat_created) @@ -1407,7 +1414,7 @@ def effective_attachment( * :class:`telegram.Invoice` * :class:`telegram.Location` * :class:`telegram.PassportData` - * List[:class:`telegram.PhotoSize`] + * list[:class:`telegram.PhotoSize`] * :class:`telegram.PaidMediaInfo` * :class:`telegram.Poll` * :class:`telegram.Sticker` @@ -1479,7 +1486,7 @@ def _quote( def compute_quote_position_and_entities( self, quote: str, index: Optional[int] = None - ) -> Tuple[int, Optional[Tuple[MessageEntity, ...]]]: + ) -> tuple[int, Optional[tuple[MessageEntity, ...]]]: """ Use this function to compute position and entities of a quote in the message text or caption. Useful for filling the parameters @@ -1505,7 +1512,7 @@ def compute_quote_position_and_entities( message. If not specified, the first occurrence is used. Returns: - Tuple[:obj:`int`, :obj:`None` | Tuple[:class:`~telegram.MessageEntity`, ...]]: On + tuple[:obj:`int`, :obj:`None` | tuple[:class:`~telegram.MessageEntity`, ...]]: On success, a tuple containing information about quote position and entities is returned. Raises: @@ -1516,8 +1523,8 @@ def compute_quote_position_and_entities( raise RuntimeError("This message has neither text nor caption.") # Telegram wants the position in UTF-16 code units, so we have to calculate in that space - utf16_text = text.encode("utf-16-le") - utf16_quote = quote.encode("utf-16-le") + utf16_text = text.encode(TextEncoding.UTF_16_LE) + utf16_quote = quote.encode(TextEncoding.UTF_16_LE) effective_index = index or 0 matches = list(re.finditer(re.escape(utf16_quote), utf16_text)) @@ -1648,7 +1655,7 @@ async def _parse_quote_arguments( quote: Optional[bool], reply_to_message_id: Optional[int], reply_parameters: Optional["ReplyParameters"], - ) -> Tuple[Union[str, int], ReplyParameters]: + ) -> tuple[Union[str, int], ReplyParameters]: if quote and do_quote: raise ValueError("The arguments `quote` and `do_quote` are mutually exclusive") @@ -1715,6 +1722,7 @@ async def reply_text( link_preview_options: ODVInput["LinkPreviewOptions"] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1780,6 +1788,7 @@ async def reply_text( api_kwargs=api_kwargs, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_markdown( @@ -1793,6 +1802,7 @@ async def reply_markdown( link_preview_options: ODVInput["LinkPreviewOptions"] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1864,6 +1874,7 @@ async def reply_markdown( api_kwargs=api_kwargs, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_markdown_v2( @@ -1877,6 +1888,7 @@ async def reply_markdown_v2( link_preview_options: ODVInput["LinkPreviewOptions"] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1944,6 +1956,7 @@ async def reply_markdown_v2( api_kwargs=api_kwargs, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_html( @@ -1957,6 +1970,7 @@ async def reply_html( link_preview_options: ODVInput["LinkPreviewOptions"] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2024,6 +2038,7 @@ async def reply_html( api_kwargs=api_kwargs, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_media_group( @@ -2036,6 +2051,7 @@ async def reply_media_group( message_thread_id: ODVInput[int] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2049,7 +2065,7 @@ async def reply_media_group( caption: Optional[str] = None, parse_mode: ODVInput[str] = DEFAULT_NONE, caption_entities: Optional[Sequence["MessageEntity"]] = None, - ) -> Tuple["Message", ...]: + ) -> tuple["Message", ...]: """Shortcut for:: await bot.send_media_group( @@ -2076,7 +2092,7 @@ async def reply_media_group( .. versionadded:: 20.8 Returns: - Tuple[:class:`telegram.Message`]: An array of the sent Messages. + tuple[:class:`telegram.Message`]: An array of the sent Messages. Raises: :class:`telegram.error.TelegramError` @@ -2103,6 +2119,7 @@ async def reply_media_group( caption_entities=caption_entities, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_photo( @@ -2118,6 +2135,7 @@ async def reply_photo( has_spoiler: Optional[bool] = None, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -2185,6 +2203,7 @@ async def reply_photo( has_spoiler=has_spoiler, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -2204,6 +2223,7 @@ async def reply_audio( thumbnail: Optional[FileInput] = None, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2273,6 +2293,7 @@ async def reply_audio( thumbnail=thumbnail, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_document( @@ -2289,6 +2310,7 @@ async def reply_document( thumbnail: Optional[FileInput] = None, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2356,6 +2378,7 @@ async def reply_document( thumbnail=thumbnail, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_animation( @@ -2375,6 +2398,7 @@ async def reply_animation( thumbnail: Optional[FileInput] = None, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -2446,6 +2470,7 @@ async def reply_animation( thumbnail=thumbnail, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -2459,6 +2484,7 @@ async def reply_sticker( emoji: Optional[str] = None, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2520,6 +2546,7 @@ async def reply_sticker( emoji=emoji, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_video( @@ -2540,6 +2567,7 @@ async def reply_video( thumbnail: Optional[FileInput] = None, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -2612,6 +2640,7 @@ async def reply_video( thumbnail=thumbnail, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -2627,6 +2656,7 @@ async def reply_video_note( thumbnail: Optional[FileInput] = None, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2692,6 +2722,7 @@ async def reply_video_note( thumbnail=thumbnail, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_voice( @@ -2707,6 +2738,7 @@ async def reply_voice( message_thread_id: ODVInput[int] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2773,6 +2805,7 @@ async def reply_voice( message_thread_id=message_thread_id, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_location( @@ -2789,6 +2822,7 @@ async def reply_location( message_thread_id: ODVInput[int] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2856,6 +2890,7 @@ async def reply_location( message_thread_id=message_thread_id, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_venue( @@ -2874,6 +2909,7 @@ async def reply_venue( message_thread_id: ODVInput[int] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2943,6 +2979,7 @@ async def reply_venue( message_thread_id=message_thread_id, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_contact( @@ -2957,6 +2994,7 @@ async def reply_contact( message_thread_id: ODVInput[int] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3022,6 +3060,7 @@ async def reply_contact( message_thread_id=message_thread_id, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_poll( @@ -3038,7 +3077,7 @@ async def reply_poll( explanation: Optional[str] = None, explanation_parse_mode: ODVInput[str] = DEFAULT_NONE, open_period: Optional[int] = None, - close_date: Optional[Union[int, datetime.datetime]] = None, + close_date: Optional[Union[int, dtm.datetime]] = None, explanation_entities: Optional[Sequence["MessageEntity"]] = None, protect_content: ODVInput[bool] = DEFAULT_NONE, message_thread_id: ODVInput[int] = DEFAULT_NONE, @@ -3046,6 +3085,7 @@ async def reply_poll( question_parse_mode: ODVInput[str] = DEFAULT_NONE, question_entities: Optional[Sequence["MessageEntity"]] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3119,6 +3159,7 @@ async def reply_poll( question_parse_mode=question_parse_mode, question_entities=question_entities, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_dice( @@ -3130,6 +3171,7 @@ async def reply_dice( message_thread_id: ODVInput[int] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3190,6 +3232,7 @@ async def reply_dice( message_thread_id=message_thread_id, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_chat_action( @@ -3245,6 +3288,7 @@ async def reply_game( message_thread_id: ODVInput[int] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3307,6 +3351,7 @@ async def reply_game( message_thread_id=message_thread_id, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_invoice( @@ -3338,6 +3383,7 @@ async def reply_invoice( message_thread_id: ODVInput[int] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3428,6 +3474,7 @@ async def reply_invoice( protect_content=protect_content, message_thread_id=message_thread_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def forward( @@ -3492,6 +3539,7 @@ async def copy( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, show_caption_above_media: Optional[bool] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3537,6 +3585,7 @@ async def copy( protect_content=protect_content, message_thread_id=message_thread_id, show_caption_above_media=show_caption_above_media, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_copy( @@ -3552,6 +3601,7 @@ async def reply_copy( message_thread_id: ODVInput[int] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, show_caption_above_media: Optional[bool] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3616,6 +3666,78 @@ async def reply_copy( protect_content=protect_content, message_thread_id=message_thread_id, show_caption_above_media=show_caption_above_media, + allow_paid_broadcast=allow_paid_broadcast, + ) + + async def reply_paid_media( + self, + star_count: int, + media: Sequence["InputPaidMedia"], + caption: Optional[str] = None, + parse_mode: ODVInput[str] = DEFAULT_NONE, + caption_entities: Optional[Sequence["MessageEntity"]] = None, + show_caption_above_media: Optional[bool] = None, + disable_notification: ODVInput[bool] = DEFAULT_NONE, + protect_content: ODVInput[bool] = DEFAULT_NONE, + reply_parameters: Optional["ReplyParameters"] = None, + reply_markup: Optional[ReplyMarkup] = None, + payload: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, + *, + reply_to_message_id: Optional[int] = None, + allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, + do_quote: Optional[Union[bool, _ReplyKwargs]] = None, + read_timeout: ODVInput[float] = DEFAULT_NONE, + write_timeout: ODVInput[float] = DEFAULT_NONE, + connect_timeout: ODVInput[float] = DEFAULT_NONE, + pool_timeout: ODVInput[float] = DEFAULT_NONE, + api_kwargs: Optional[JSONDict] = None, + ) -> "Message": + """Shortcut for:: + + await bot.send_paid_media( + chat_id=message.chat.id, + business_connection_id=message.business_connection_id, + *args, + **kwargs + ) + + For the documentation of the arguments, please see :meth:`telegram.Bot.send_paid_media`. + + .. versionadded:: 21.7 + + 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, None, reply_to_message_id, reply_parameters + ) + return await self.get_bot().send_paid_media( + chat_id=chat_id, + caption=caption, + star_count=star_count, + media=media, + payload=payload, + business_connection_id=self.business_connection_id, + parse_mode=parse_mode, + 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, + connect_timeout=connect_timeout, + pool_timeout=pool_timeout, + api_kwargs=api_kwargs, + protect_content=protect_content, + show_caption_above_media=show_caption_above_media, + allow_paid_broadcast=allow_paid_broadcast, ) async def edit_text( @@ -3990,7 +4112,7 @@ async def get_game_high_scores( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["GameHighScore", ...]: + ) -> tuple["GameHighScore", ...]: """Shortcut for:: await bot.get_game_high_scores( @@ -4006,7 +4128,7 @@ async def get_game_high_scores( behaviour is undocumented and might be changed by Telegram. Returns: - Tuple[:class:`telegram.GameHighScore`] + tuple[:class:`telegram.GameHighScore`] """ return await self.get_bot().get_game_high_scores( chat_id=self.chat_id, @@ -4105,11 +4227,18 @@ async def pin( """Shortcut for:: await bot.pin_chat_message( - chat_id=message.chat_id, message_id=message.message_id, *args, **kwargs + chat_id=message.chat_id, + message_id=message.message_id, + business_connection_id=message.business_connection_id, + *args, **kwargs ) For the documentation of the arguments, please see :meth:`telegram.Bot.pin_chat_message`. + .. versionchanged:: 21.5 + Now also passes :attr:`business_connection_id` to + :meth:`telegram.Bot.pin_chat_message`. + Returns: :obj:`bool`: On success, :obj:`True` is returned. @@ -4117,6 +4246,7 @@ async def pin( return await self.get_bot().pin_chat_message( chat_id=self.chat_id, message_id=self.message_id, + business_connection_id=self.business_connection_id, disable_notification=disable_notification, read_timeout=read_timeout, write_timeout=write_timeout, @@ -4137,11 +4267,18 @@ async def unpin( """Shortcut for:: await bot.unpin_chat_message( - chat_id=message.chat_id, message_id=message.message_id, *args, **kwargs + chat_id=message.chat_id, + message_id=message.message_id, + business_connection_id=message.business_connection_id, + *args, **kwargs ) For the documentation of the arguments, please see :meth:`telegram.Bot.unpin_chat_message`. + .. versionchanged:: 21.5 + Now also passes :attr:`business_connection_id` to + :meth:`telegram.Bot.pin_chat_message`. + Returns: :obj:`bool`: On success, :obj:`True` is returned. @@ -4149,6 +4286,7 @@ async def unpin( return await self.get_bot().unpin_chat_message( chat_id=self.chat_id, message_id=self.message_id, + business_connection_id=self.business_connection_id, read_timeout=read_timeout, write_timeout=write_timeout, connect_timeout=connect_timeout, @@ -4416,7 +4554,7 @@ def parse_caption_entity(self, entity: MessageEntity) -> str: return parse_message_entity(self.caption, entity) - def parse_entities(self, types: Optional[List[str]] = None) -> Dict[MessageEntity, str]: + def parse_entities(self, types: Optional[list[str]] = None) -> dict[MessageEntity, str]: """ Returns a :obj:`dict` that maps :class:`telegram.MessageEntity` to :obj:`str`. It contains entities from this message filtered by their @@ -4429,21 +4567,21 @@ def parse_entities(self, types: Optional[List[str]] = None) -> Dict[MessageEntit See :attr:`parse_entity` for more info. Args: - types (List[:obj:`str`], optional): List of :class:`telegram.MessageEntity` types as + types (list[:obj:`str`], optional): List of :class:`telegram.MessageEntity` types as strings. If the ``type`` attribute of an entity is contained in this list, it will be returned. Defaults to a list of all types. All types can be found as constants in :class:`telegram.MessageEntity`. Returns: - Dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to + dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to the text that belongs to them, calculated based on UTF-16 codepoints. """ return parse_message_entities(self.text, self.entities, types=types) def parse_caption_entities( - self, types: Optional[List[str]] = None - ) -> Dict[MessageEntity, str]: + self, types: Optional[list[str]] = None + ) -> dict[MessageEntity, str]: """ Returns a :obj:`dict` that maps :class:`telegram.MessageEntity` to :obj:`str`. It contains entities from this message's caption filtered by their @@ -4456,13 +4594,13 @@ def parse_caption_entities( codepoints. See :attr:`parse_entity` for more info. Args: - types (List[:obj:`str`], optional): List of :class:`telegram.MessageEntity` types as + types (list[:obj:`str`], optional): List of :class:`telegram.MessageEntity` types as strings. If the ``type`` attribute of an entity is contained in this list, it will be returned. Defaults to a list of all types. All types can be found as constants in :class:`telegram.MessageEntity`. Returns: - Dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to + dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to the text that belongs to them, calculated based on UTF-16 codepoints. """ @@ -4472,14 +4610,14 @@ def parse_caption_entities( def _parse_html( cls, message_text: Optional[str], - entities: Dict[MessageEntity, str], + entities: dict[MessageEntity, str], urled: bool = False, offset: int = 0, ) -> Optional[str]: if message_text is None: return None - utf_16_text = message_text.encode("utf-16-le") + utf_16_text = message_text.encode(TextEncoding.UTF_16_LE) html_text = "" last_offset = 0 @@ -4543,7 +4681,9 @@ def _parse_html( # text is part of the parent entity html_text += ( escape( - utf_16_text[last_offset * 2 : (entity.offset - offset) * 2].decode("utf-16-le") + utf_16_text[last_offset * 2 : (entity.offset - offset) * 2].decode( + TextEncoding.UTF_16_LE + ) ) + insert ) @@ -4551,7 +4691,7 @@ def _parse_html( last_offset = entity.offset - offset + entity.length # see comment above - html_text += escape(utf_16_text[last_offset * 2 :].decode("utf-16-le")) + html_text += escape(utf_16_text[last_offset * 2 :].decode(TextEncoding.UTF_16_LE)) return html_text @@ -4659,7 +4799,7 @@ def caption_html_urled(self) -> str: def _parse_markdown( cls, message_text: Optional[str], - entities: Dict[MessageEntity, str], + entities: dict[MessageEntity, str], urled: bool = False, version: MarkdownVersion = 1, offset: int = 0, @@ -4680,7 +4820,7 @@ def _parse_markdown( if message_text is None: return None - utf_16_text = message_text.encode("utf-16-le") + utf_16_text = message_text.encode(TextEncoding.UTF_16_LE) markdown_text = "" last_offset = 0 @@ -4773,7 +4913,7 @@ def _parse_markdown( markdown_text += ( escape_markdown( utf_16_text[last_offset * 2 : (entity.offset - offset) * 2].decode( - "utf-16-le" + TextEncoding.UTF_16_LE ), version=version, ) @@ -4784,7 +4924,7 @@ def _parse_markdown( # see comment above markdown_text += escape_markdown( - utf_16_text[last_offset * 2 :].decode("utf-16-le"), + utf_16_text[last_offset * 2 :].decode(TextEncoding.UTF_16_LE), version=version, ) diff --git a/telegram/_messageentity.py b/telegram/_messageentity.py index 302f3a1c080..2fa5953d56d 100644 --- a/telegram/_messageentity.py +++ b/telegram/_messageentity.py @@ -20,17 +20,21 @@ import copy import itertools -from typing import TYPE_CHECKING, Dict, Final, List, Optional, Sequence +from collections.abc import Sequence +from typing import TYPE_CHECKING, Final, Optional, Union from telegram import constants from telegram._telegramobject import TelegramObject from telegram._user import User from telegram._utils import enum +from telegram._utils.strings import TextEncoding from telegram._utils.types import JSONDict if TYPE_CHECKING: from telegram import Bot +_SEM = Sequence["MessageEntity"] + class MessageEntity(TelegramObject): """ @@ -41,10 +45,11 @@ class MessageEntity(TelegramObject): considered equal, if their :attr:`type`, :attr:`offset` and :attr:`length` are equal. Args: - type (:obj:`str`): Type of the entity. Can be :attr:`MENTION` (@username), - :attr:`HASHTAG` (#hashtag), :attr:`CASHTAG` ($USD), :attr:`BOT_COMMAND` - (/start@jobs_bot), :attr:`URL` (https://telegram.org), - :attr:`EMAIL` (do-not-reply@telegram.org), :attr:`PHONE_NUMBER` (+1-212-555-0123), + type (:obj:`str`): Type of the entity. Can be :attr:`MENTION` (``@username``), + :attr:`HASHTAG` (``#hashtag`` or ``#hashtag@chatusername``), :attr:`CASHTAG` (``$USD`` + or ``USD@chatusername``), :attr:`BOT_COMMAND` (``/start@jobs_bot``), :attr:`URL` + (``https://telegram.org``), :attr:`EMAIL` (``do-not-reply@telegram.org``), + :attr:`PHONE_NUMBER` (``+1-212-555-0123``), :attr:`BOLD` (**bold text**), :attr:`ITALIC` (*italic text*), :attr:`UNDERLINE` (underlined text), :attr:`STRIKETHROUGH`, :attr:`SPOILER` (spoiler message), :attr:`BLOCKQUOTE` (block quotation), :attr:`CODE` (monowidth string), :attr:`PRE` @@ -70,10 +75,11 @@ class MessageEntity(TelegramObject): .. versionadded:: 20.0 Attributes: - type (:obj:`str`): Type of the entity. Can be :attr:`MENTION` (@username), - :attr:`HASHTAG` (#hashtag), :attr:`CASHTAG` ($USD), :attr:`BOT_COMMAND` - (/start@jobs_bot), :attr:`URL` (https://telegram.org), - :attr:`EMAIL` (do-not-reply@telegram.org), :attr:`PHONE_NUMBER` (+1-212-555-0123), + type (:obj:`str`): Type of the entity. Can be :attr:`MENTION` (``@username``), + :attr:`HASHTAG` (``#hashtag`` or ``#hashtag@chatusername``), :attr:`CASHTAG` (``$USD`` + or ``USD@chatusername``), :attr:`BOT_COMMAND` (``/start@jobs_bot``), :attr:`URL` + (``https://telegram.org``), :attr:`EMAIL` (``do-not-reply@telegram.org``), + :attr:`PHONE_NUMBER` (``+1-212-555-0123``), :attr:`BOLD` (**bold text**), :attr:`ITALIC` (*italic text*), :attr:`UNDERLINE` (underlined text), :attr:`STRIKETHROUGH`, :attr:`SPOILER` (spoiler message), :attr:`BLOCKQUOTE` (block quotation), :attr:`CODE` (monowidth string), :attr:`PRE` @@ -145,9 +151,7 @@ def de_json( return super().de_json(data=data, bot=bot) @staticmethod - def adjust_message_entities_to_utf_16( - text: str, entities: Sequence["MessageEntity"] - ) -> Sequence["MessageEntity"]: + def adjust_message_entities_to_utf_16(text: str, entities: _SEM) -> _SEM: """Utility functionality for converting the offset and length of entities from Unicode (:obj:`str`) to UTF-16 (``utf-16-le`` encoded :obj:`bytes`). @@ -199,13 +203,13 @@ def adjust_message_entities_to_utf_16( accumulated_length = 0 # calculate the length of each slice text[:position] in utf-16 accordingly, # store the position translations - position_translation: Dict[int, int] = {} + position_translation: dict[int, int] = {} for i, position in enumerate(positions): last_position = positions[i - 1] if i > 0 else 0 text_slice = text[last_position:position] - accumulated_length += len(text_slice.encode("utf-16-le")) // 2 + accumulated_length += len(text_slice.encode(TextEncoding.UTF_16_LE)) // 2 position_translation[position] = accumulated_length - # get the final output entites + # get the final output entities out = [] for entity in entities: translated_positions = position_translation[entity.offset] @@ -219,8 +223,145 @@ def adjust_message_entities_to_utf_16( out.append(new_entity) return out - ALL_TYPES: Final[List[str]] = list(constants.MessageEntityType) - """List[:obj:`str`]: A list of all available message entity types.""" + @staticmethod + def shift_entities(by: Union[str, int], entities: _SEM) -> _SEM: + """Utility functionality for shifting the offset of entities by a given amount. + + Examples: + Shifting by an integer amount: + + .. code-block:: python + + text = "Hello, world!" + entities = [ + MessageEntity(offset=0, length=5, type=MessageEntity.BOLD), + MessageEntity(offset=7, length=5, type=MessageEntity.ITALIC), + ] + shifted_entities = MessageEntity.shift_entities(1, entities) + await bot.send_message( + chat_id=123, + text="!" + text, + entities=shifted_entities, + ) + + Shifting using a string: + + .. code-block:: python + + text = "Hello, world!" + prefix = "𝄢" + entities = [ + MessageEntity(offset=0, length=5, type=MessageEntity.BOLD), + MessageEntity(offset=7, length=5, type=MessageEntity.ITALIC), + ] + shifted_entities = MessageEntity.shift_entities(prefix, entities) + await bot.send_message( + chat_id=123, + text=prefix + text, + entities=shifted_entities, + ) + + Tip: + The :paramref:`entities` are *not* modified in place. The function returns a sequence + of new objects. + + .. versionadded:: 21.5 + + Args: + by (:obj:`str` | :obj:`int`): Either the amount to shift the offset by or + a string whose length will be used as the amount to shift the offset by. In this + case, UTF-16 encoding will be used to calculate the length. + entities (Sequence[:class:`telegram.MessageEntity`]): Sequence of entities + + Returns: + Sequence[:class:`telegram.MessageEntity`]: Sequence of entities with the offset shifted + """ + effective_shift = by if isinstance(by, int) else len(by.encode("utf-16-le")) // 2 + + out = [] + for entity in entities: + new_entity = copy.copy(entity) + with new_entity._unfrozen(): + new_entity.offset += effective_shift + out.append(new_entity) + return out + + @classmethod + def concatenate( + cls, + *args: Union[tuple[str, _SEM], tuple[str, _SEM, bool]], + ) -> tuple[str, _SEM]: + """Utility functionality for concatenating two text along with their formatting entities. + + Tip: + This function is useful for prefixing an already formatted text with a new text and its + formatting entities. In particular, it automatically correctly handles UTF-16 encoding. + + Examples: + This example shows a callback function that can be used to add a prefix and suffix to + the message in a :class:`~telegram.ext.CallbackQueryHandler`: + + .. code-block:: python + + async def prefix_message(update: Update, context: ContextTypes.DEFAULT_TYPE): + prefix = "𠌕 bold 𝄢 italic underlined: 𝛙𝌢𑁍 | " + prefix_entities = [ + MessageEntity(offset=2, length=4, type=MessageEntity.BOLD), + MessageEntity(offset=9, length=6, type=MessageEntity.ITALIC), + MessageEntity(offset=28, length=3, type=MessageEntity.UNDERLINE), + ] + suffix = " | 𠌕 bold 𝄢 italic underlined: 𝛙𝌢𑁍" + suffix_entities = [ + MessageEntity(offset=5, length=4, type=MessageEntity.BOLD), + MessageEntity(offset=12, length=6, type=MessageEntity.ITALIC), + MessageEntity(offset=31, length=3, type=MessageEntity.UNDERLINE), + ] + + message = update.effective_message + first = (prefix, prefix_entities, True) + second = (message.text, message.entities) + third = (suffix, suffix_entities, True) + + new_text, new_entities = MessageEntity.concatenate(first, second, third) + await update.callback_query.edit_message_text( + text=new_text, + entities=new_entities, + ) + + Hint: + The entities are *not* modified in place. The function returns a + new sequence of objects. + + .. versionadded:: 21.5 + + Args: + *args (tuple[:obj:`str`, Sequence[:class:`telegram.MessageEntity`]] | \ + tuple[:obj:`str`, Sequence[:class:`telegram.MessageEntity`], :obj:`bool`]): + Arbitrary number of tuples containing the text and its entities to concatenate. + If the last element of the tuple is a :obj:`bool`, it is used to determine whether + to adjust the entities to UTF-16 via + :meth:`adjust_message_entities_to_utf_16`. UTF-16 adjustment is disabled by + default. + + Returns: + tuple[:obj:`str`, Sequence[:class:`telegram.MessageEntity`]]: The concatenated text + and its entities + """ + output_text = "" + output_entities: list[MessageEntity] = [] + for arg in args: + text, entities = arg[0], arg[1] + + if len(arg) > 2 and arg[2] is True: + entities = cls.adjust_message_entities_to_utf_16(text, entities) + + output_entities.extend(cls.shift_entities(output_text, entities)) + output_text += text + + return output_text, output_entities + + ALL_TYPES: Final[list[str]] = list(constants.MessageEntityType) + """list[:obj:`str`]: A list of all available message entity types.""" BLOCKQUOTE: Final[str] = constants.MessageEntityType.BLOCKQUOTE """:const:`telegram.constants.MessageEntityType.BLOCKQUOTE` diff --git a/telegram/_messageid.py b/telegram/_messageid.py index bbfedf47037..b63fbe97dcc 100644 --- a/telegram/_messageid.py +++ b/telegram/_messageid.py @@ -31,10 +31,16 @@ class MessageId(TelegramObject): considered equal, if their :attr:`message_id` is equal. Args: - message_id (:obj:`int`): Unique message identifier. + message_id (:obj:`int`): Unique message identifier. In specific instances + (e.g., message containing a video sent to a big chat), the server might automatically + schedule a message instead of sending it immediately. In such cases, this field will be + ``0`` and the relevant message will be unusable until it is actually sent. Attributes: - message_id (:obj:`int`): Unique message identifier. + message_id (:obj:`int`): Unique message identifier. In specific instances + (e.g., message containing a video sent to a big chat), the server might automatically + schedule a message instead of sending it immediately. In such cases, this field will be + ``0`` and the relevant message will be unusable until it is actually sent. """ __slots__ = ("message_id",) diff --git a/telegram/_messageorigin.py b/telegram/_messageorigin.py index 534583adb8b..61f18f67cc6 100644 --- a/telegram/_messageorigin.py +++ b/telegram/_messageorigin.py @@ -17,8 +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/]. """This module contains the classes that represent Telegram MessageOigin.""" -import datetime -from typing import TYPE_CHECKING, Dict, Final, Optional, Type +import datetime as dtm +from typing import TYPE_CHECKING, Final, Optional from telegram import constants from telegram._chat import Chat @@ -78,14 +78,14 @@ class MessageOrigin(TelegramObject): def __init__( self, type: str, # pylint: disable=W0622 - date: datetime.datetime, + date: dtm.datetime, *, api_kwargs: Optional[JSONDict] = None, ): super().__init__(api_kwargs=api_kwargs) # Required by all subclasses self.type: str = enum.get_member(constants.MessageOriginType, type, type) - self.date: datetime.datetime = date + self.date: dtm.datetime = date self._id_attrs = ( self.type, @@ -105,7 +105,7 @@ def de_json( if not data: return None - _class_mapping: Dict[str, Type[MessageOrigin]] = { + _class_mapping: dict[str, type[MessageOrigin]] = { cls.USER: MessageOriginUser, cls.HIDDEN_USER: MessageOriginHiddenUser, cls.CHAT: MessageOriginChat, @@ -152,7 +152,7 @@ class MessageOriginUser(MessageOrigin): def __init__( self, - date: datetime.datetime, + date: dtm.datetime, sender_user: User, *, api_kwargs: Optional[JSONDict] = None, @@ -186,7 +186,7 @@ class MessageOriginHiddenUser(MessageOrigin): def __init__( self, - date: datetime.datetime, + date: dtm.datetime, sender_user_name: str, *, api_kwargs: Optional[JSONDict] = None, @@ -227,7 +227,7 @@ class MessageOriginChat(MessageOrigin): def __init__( self, - date: datetime.datetime, + date: dtm.datetime, sender_chat: Chat, author_signature: Optional[str] = None, *, @@ -271,7 +271,7 @@ class MessageOriginChannel(MessageOrigin): def __init__( self, - date: datetime.datetime, + date: dtm.datetime, chat: Chat, message_id: int, author_signature: Optional[str] = None, diff --git a/telegram/_messagereactionupdated.py b/telegram/_messagereactionupdated.py index d4d4033a647..1d4b7d4d29f 100644 --- a/telegram/_messagereactionupdated.py +++ b/telegram/_messagereactionupdated.py @@ -17,8 +17,9 @@ # 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 MessageReaction Update.""" -from datetime import datetime -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +import datetime as dtm +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._chat import Chat from telegram._reaction import ReactionCount, ReactionType @@ -54,7 +55,7 @@ class MessageReactionCountUpdated(TelegramObject): message_id (:obj:`int`): Unique message identifier inside the chat. date (:class:`datetime.datetime`): Date of the change in Unix time |datetime_localization| - reactions (Tuple[:class:`telegram.ReactionCount`]): List of reactions that are present on + reactions (tuple[:class:`telegram.ReactionCount`]): List of reactions that are present on the message """ @@ -69,7 +70,7 @@ def __init__( self, chat: Chat, message_id: int, - date: datetime, + date: dtm.datetime, reactions: Sequence[ReactionCount], *, api_kwargs: Optional[JSONDict] = None, @@ -78,8 +79,8 @@ def __init__( # Required self.chat: Chat = chat self.message_id: int = message_id - self.date: datetime = date - self.reactions: Tuple[ReactionCount, ...] = parse_sequence_arg(reactions) + self.date: dtm.datetime = date + self.reactions: tuple[ReactionCount, ...] = parse_sequence_arg(reactions) self._id_attrs = (self.chat, self.message_id, self.date, self.reactions) self._freeze() @@ -132,9 +133,9 @@ class MessageReactionUpdated(TelegramObject): message_id (:obj:`int`): Unique message identifier inside the chat. date (:class:`datetime.datetime`): Date of the change in Unix time. |datetime_localization| - old_reaction (Tuple[:class:`telegram.ReactionType`]): Previous list of reaction types + old_reaction (tuple[:class:`telegram.ReactionType`]): Previous list of reaction types that were set by the user. - new_reaction (Tuple[:class:`telegram.ReactionType`]): New list of reaction types that + new_reaction (tuple[:class:`telegram.ReactionType`]): New list of reaction types that were set by the user. user (:class:`telegram.User`): Optional. The user that changed the reaction, if the user isn't anonymous. @@ -156,7 +157,7 @@ def __init__( self, chat: Chat, message_id: int, - date: datetime, + date: dtm.datetime, old_reaction: Sequence[ReactionType], new_reaction: Sequence[ReactionType], user: Optional[User] = None, @@ -168,9 +169,9 @@ def __init__( # Required self.chat: Chat = chat self.message_id: int = message_id - self.date: datetime = date - self.old_reaction: Tuple[ReactionType, ...] = parse_sequence_arg(old_reaction) - self.new_reaction: Tuple[ReactionType, ...] = parse_sequence_arg(new_reaction) + self.date: dtm.datetime = date + self.old_reaction: tuple[ReactionType, ...] = parse_sequence_arg(old_reaction) + self.new_reaction: tuple[ReactionType, ...] = parse_sequence_arg(new_reaction) # Optional self.user: Optional[User] = user diff --git a/telegram/_paidmedia.py b/telegram/_paidmedia.py index fe78cca28e0..c3ab1e22eaf 100644 --- a/telegram/_paidmedia.py +++ b/telegram/_paidmedia.py @@ -18,12 +18,14 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains objects that represent paid media in Telegram.""" -from typing import TYPE_CHECKING, Dict, Final, Optional, Sequence, Tuple, Type +from collections.abc import Sequence +from typing import TYPE_CHECKING, Final, Optional from telegram import constants from telegram._files.photosize import PhotoSize from telegram._files.video import Video from telegram._telegramobject import TelegramObject +from telegram._user import User from telegram._utils import enum from telegram._utils.argumentparsing import parse_sequence_arg from telegram._utils.types import JSONDict @@ -80,7 +82,7 @@ def de_json( care of selecting the correct subclass. Args: - data (Dict[:obj:`str`, ...]): The JSON data. + data (dict[:obj:`str`, ...]): The JSON data. bot (:class:`telegram.Bot`, optional): The bot associated with this object. Returns: @@ -95,7 +97,7 @@ def de_json( if not data and cls is PaidMedia: return None - _class_mapping: Dict[str, Type[PaidMedia]] = { + _class_mapping: dict[str, type[PaidMedia]] = { cls.PREVIEW: PaidMediaPreview, cls.PHOTO: PaidMediaPhoto, cls.VIDEO: PaidMediaVideo, @@ -164,7 +166,7 @@ class PaidMediaPhoto(PaidMedia): Attributes: type (:obj:`str`): Type of the paid media, always :tg-const:`telegram.PaidMedia.PHOTO`. - photo (Tuple[:class:`telegram.PhotoSize`]): The photo. + photo (tuple[:class:`telegram.PhotoSize`]): The photo. """ __slots__ = ("photo",) @@ -178,7 +180,7 @@ def __init__( super().__init__(type=PaidMedia.PHOTO, api_kwargs=api_kwargs) with self._unfrozen(): - self.photo: Tuple[PhotoSize, ...] = parse_sequence_arg(photo) + self.photo: tuple[PhotoSize, ...] = parse_sequence_arg(photo) self._id_attrs = (self.type, self.photo) @@ -258,7 +260,7 @@ class PaidMediaInfo(TelegramObject): Attributes: star_count (:obj:`int`): The number of Telegram Stars that must be paid to buy access to the media. - paid_media (Tuple[:class:`telegram.PaidMedia`]): Information about the paid media. + paid_media (tuple[:class:`telegram.PaidMedia`]): Information about the paid media. """ __slots__ = ("paid_media", "star_count") @@ -272,7 +274,7 @@ def __init__( ) -> None: super().__init__(api_kwargs=api_kwargs) self.star_count: int = star_count - self.paid_media: Tuple[PaidMedia, ...] = parse_sequence_arg(paid_media) + self.paid_media: tuple[PaidMedia, ...] = parse_sequence_arg(paid_media) self._id_attrs = (self.star_count, self.paid_media) self._freeze() @@ -288,3 +290,52 @@ def de_json( data["paid_media"] = PaidMedia.de_list(data.get("paid_media"), bot=bot) return super().de_json(data=data, bot=bot) + + +class PaidMediaPurchased(TelegramObject): + """This object contains information about a paid media purchase. + + Objects of this class are comparable in terms of equality. Two objects of this class are + considered equal, if their :attr:`from_user` and :attr:`paid_media_payload` are equal. + + Note: + In Python :keyword:`from` is a reserved word. Use :paramref:`from_user` instead. + + .. versionadded:: 21.6 + + Args: + from_user (:class:`telegram.User`): User who purchased the media. + paid_media_payload (:obj:`str`): Bot-specified paid media payload. + + Attributes: + from_user (:class:`telegram.User`): User who purchased the media. + paid_media_payload (:obj:`str`): Bot-specified paid media payload. + """ + + __slots__ = ("from_user", "paid_media_payload") + + def __init__( + self, + from_user: "User", + paid_media_payload: str, + *, + api_kwargs: Optional[JSONDict] = None, + ) -> None: + super().__init__(api_kwargs=api_kwargs) + self.from_user: User = from_user + self.paid_media_payload: str = paid_media_payload + + self._id_attrs = (self.from_user, self.paid_media_payload) + self._freeze() + + @classmethod + def de_json( + cls, data: Optional[JSONDict], bot: Optional["Bot"] = None + ) -> Optional["PaidMediaPurchased"]: + data = cls._parse_data(data) + + if not data: + return None + + data["from_user"] = User.de_json(data=data.pop("from"), bot=bot) + return super().de_json(data=data, bot=bot) diff --git a/telegram/_passport/credentials.py b/telegram/_passport/credentials.py index 514f7fffb6c..17e44595abc 100644 --- a/telegram/_passport/credentials.py +++ b/telegram/_passport/credentials.py @@ -19,7 +19,8 @@ # pylint: disable=missing-module-docstring, redefined-builtin import json from base64 import b64decode -from typing import TYPE_CHECKING, Optional, Sequence, Tuple, no_type_check +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional, no_type_check try: from cryptography.hazmat.backends import default_backend @@ -39,6 +40,7 @@ from telegram._telegramobject import TelegramObject from telegram._utils.argumentparsing import parse_sequence_arg +from telegram._utils.strings import TextEncoding from telegram._utils.types import JSONDict from telegram.error import PassportDecryptionError @@ -98,7 +100,7 @@ def decrypt(secret, hash, data): @no_type_check def decrypt_json(secret, hash, data): """Decrypts data using secret and hash and then decodes utf-8 string and loads json""" - return json.loads(decrypt(secret, hash, data).decode("utf-8")) + return json.loads(decrypt(secret, hash, data).decode(TextEncoding.UTF_8)) class EncryptedCredentials(TelegramObject): @@ -111,7 +113,7 @@ class EncryptedCredentials(TelegramObject): Note: This object is decrypted only when originating from - :obj:`telegram.PassportData.decrypted_credentials`. + :attr:`telegram.PassportData.decrypted_credentials`. Args: data (:class:`telegram.Credentials` | :obj:`str`): Decrypted data with unique user's @@ -389,11 +391,11 @@ class SecureValue(TelegramObject): selfie (:class:`telegram.FileCredentials`, optional): Credentials for encrypted selfie of the user with a document. Can be available for "passport", "driver_license", "identity_card" and "internal_passport". - translation (List[:class:`telegram.FileCredentials`], optional): Credentials for an + translation (list[:class:`telegram.FileCredentials`], optional): Credentials for an encrypted translation of the document. Available for "passport", "driver_license", "identity_card", "internal_passport", "utility_bill", "bank_statement", "rental_agreement", "passport_registration" and "temporary_registration". - files (List[:class:`telegram.FileCredentials`], optional): Credentials for encrypted + files (list[:class:`telegram.FileCredentials`], optional): Credentials for encrypted files. Available for "utility_bill", "bank_statement", "rental_agreement", "passport_registration" and "temporary_registration" types. @@ -409,7 +411,7 @@ class SecureValue(TelegramObject): selfie (:class:`telegram.FileCredentials`): Optional. Credentials for encrypted selfie of the user with a document. Can be available for "passport", "driver_license", "identity_card" and "internal_passport". - translation (Tuple[:class:`telegram.FileCredentials`]): Optional. Credentials for an + translation (tuple[:class:`telegram.FileCredentials`]): Optional. Credentials for an encrypted translation of the document. Available for "passport", "driver_license", "identity_card", "internal_passport", "utility_bill", "bank_statement", "rental_agreement", "passport_registration" and "temporary_registration". @@ -417,7 +419,7 @@ class SecureValue(TelegramObject): .. versionchanged:: 20.0 |tupleclassattrs| - files (Tuple[:class:`telegram.FileCredentials`]): Optional. Credentials for encrypted + files (tuple[:class:`telegram.FileCredentials`]): Optional. Credentials for encrypted files. Available for "utility_bill", "bank_statement", "rental_agreement", "passport_registration" and "temporary_registration" types. @@ -446,8 +448,8 @@ def __init__( self.front_side: Optional[FileCredentials] = front_side self.reverse_side: Optional[FileCredentials] = reverse_side self.selfie: Optional[FileCredentials] = selfie - self.files: Tuple[FileCredentials, ...] = parse_sequence_arg(files) - self.translation: Tuple[FileCredentials, ...] = parse_sequence_arg(translation) + self.files: tuple[FileCredentials, ...] = parse_sequence_arg(files) + self.translation: tuple[FileCredentials, ...] = parse_sequence_arg(translation) self._freeze() diff --git a/telegram/_passport/encryptedpassportelement.py b/telegram/_passport/encryptedpassportelement.py index b05003f2cbd..5bb764c9fc1 100644 --- a/telegram/_passport/encryptedpassportelement.py +++ b/telegram/_passport/encryptedpassportelement.py @@ -18,7 +18,8 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram EncryptedPassportElement.""" from base64 import b64decode -from typing import TYPE_CHECKING, Optional, Sequence, Tuple, Union +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional, Union from telegram._passport.credentials import decrypt_json from telegram._passport.data import IdDocumentData, PersonalDetails, ResidentialAddress @@ -42,7 +43,7 @@ class EncryptedPassportElement(TelegramObject): Note: This object is decrypted only when originating from - :obj:`telegram.PassportData.decrypted_data`. + :attr:`telegram.PassportData.decrypted_data`. Args: type (:obj:`str`): Element type. One of "personal_details", "passport", "driver_license", @@ -100,7 +101,7 @@ class EncryptedPassportElement(TelegramObject): "phone_number" type. email (:obj:`str`): Optional. User's verified email address; available only for "email" type. - files (Tuple[:class:`telegram.PassportFile`]): Optional. Array of encrypted/decrypted + files (tuple[:class:`telegram.PassportFile`]): Optional. Array of encrypted/decrypted files with documents provided by the user; available only for "utility_bill", "bank_statement", "rental_agreement", "passport_registration" and "temporary_registration" types. @@ -119,7 +120,7 @@ class EncryptedPassportElement(TelegramObject): selfie (:class:`telegram.PassportFile`): Optional. Encrypted/decrypted file with the selfie of the user holding a document, provided by the user; available if requested for "passport", "driver_license", "identity_card" and "internal_passport". - translation (Tuple[:class:`telegram.PassportFile`]): Optional. Array of + translation (tuple[:class:`telegram.PassportFile`]): Optional. Array of encrypted/decrypted files with translated versions of documents provided by the user; available if requested for "passport", "driver_license", "identity_card", "internal_passport", "utility_bill", "bank_statement", "rental_agreement", @@ -172,11 +173,11 @@ def __init__( self.data: Optional[Union[PersonalDetails, IdDocumentData, ResidentialAddress]] = data self.phone_number: Optional[str] = phone_number self.email: Optional[str] = email - self.files: Tuple[PassportFile, ...] = parse_sequence_arg(files) + self.files: tuple[PassportFile, ...] = parse_sequence_arg(files) self.front_side: Optional[PassportFile] = front_side self.reverse_side: Optional[PassportFile] = reverse_side self.selfie: Optional[PassportFile] = selfie - self.translation: Tuple[PassportFile, ...] = parse_sequence_arg(translation) + self.translation: tuple[PassportFile, ...] = parse_sequence_arg(translation) self.hash: str = hash self._id_attrs = ( @@ -218,7 +219,7 @@ def de_json_decrypted( passport credentials. Args: - data (Dict[:obj:`str`, ...]): The JSON data. + data (dict[:obj:`str`, ...]): The JSON data. bot (:class:`telegram.Bot` | :obj:`None`): The bot associated with these object. May be :obj:`None`, in which case shortcut methods will not be available. diff --git a/telegram/_passport/passportdata.py b/telegram/_passport/passportdata.py index 32e3879bc4d..8b4db028a05 100644 --- a/telegram/_passport/passportdata.py +++ b/telegram/_passport/passportdata.py @@ -17,7 +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/]. """Contains information about Telegram Passport data shared with the bot by the user.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._passport.credentials import EncryptedCredentials from telegram._passport.encryptedpassportelement import EncryptedPassportElement @@ -49,7 +50,7 @@ class PassportData(TelegramObject): credentials (:class:`telegram.EncryptedCredentials`)): Encrypted credentials. Attributes: - data (Tuple[:class:`telegram.EncryptedPassportElement`]): Array with encrypted + data (tuple[:class:`telegram.EncryptedPassportElement`]): Array with encrypted information about documents and other Telegram Passport elements that was shared with the bot. @@ -72,10 +73,10 @@ def __init__( ): super().__init__(api_kwargs=api_kwargs) - self.data: Tuple[EncryptedPassportElement, ...] = parse_sequence_arg(data) + self.data: tuple[EncryptedPassportElement, ...] = parse_sequence_arg(data) self.credentials: EncryptedCredentials = credentials - self._decrypted_data: Optional[Tuple[EncryptedPassportElement]] = None + self._decrypted_data: Optional[tuple[EncryptedPassportElement]] = None self._id_attrs = tuple([x.type for x in data] + [credentials.hash]) self._freeze() @@ -96,9 +97,9 @@ def de_json( return super().de_json(data=data, bot=bot) @property - def decrypted_data(self) -> Tuple[EncryptedPassportElement, ...]: + def decrypted_data(self) -> tuple[EncryptedPassportElement, ...]: """ - Tuple[:class:`telegram.EncryptedPassportElement`]: Lazily decrypt and return information + tuple[:class:`telegram.EncryptedPassportElement`]: Lazily decrypt and return information about documents and other Telegram Passport elements which were shared with the bot. .. versionchanged:: 20.0 diff --git a/telegram/_passport/passportelementerrors.py b/telegram/_passport/passportelementerrors.py index 8d6911439c7..097d6085688 100644 --- a/telegram/_passport/passportelementerrors.py +++ b/telegram/_passport/passportelementerrors.py @@ -19,7 +19,7 @@ # pylint: disable=redefined-builtin """This module contains the classes that represent Telegram PassportElementError.""" -from typing import List, Optional +from typing import Optional from telegram._telegramobject import TelegramObject from telegram._utils.types import JSONDict @@ -168,7 +168,7 @@ class PassportElementErrorFiles(PassportElementError): type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of ``"utility_bill"``, ``"bank_statement"``, ``"rental_agreement"``, ``"passport_registration"``, ``"temporary_registration"``. - file_hashes (List[:obj:`str`]): List of base64-encoded file hashes. + file_hashes (list[:obj:`str`]): List of base64-encoded file hashes. message (:obj:`str`): Error message. Attributes: @@ -184,7 +184,7 @@ class PassportElementErrorFiles(PassportElementError): def __init__( self, type: str, - file_hashes: List[str], + file_hashes: list[str], message: str, *, api_kwargs: Optional[JSONDict] = None, @@ -192,7 +192,7 @@ def __init__( # Required super().__init__("files", type, message, api_kwargs=api_kwargs) with self._unfrozen(): - self._file_hashes: List[str] = file_hashes + self._file_hashes: list[str] = file_hashes self._id_attrs = (self.source, self.type, self.message, *tuple(file_hashes)) @@ -203,7 +203,7 @@ def to_dict(self, recursive: bool = True) -> JSONDict: return data @property - def file_hashes(self) -> List[str]: + def file_hashes(self) -> list[str]: """List of base64-encoded file hashes. .. deprecated:: 20.6 @@ -386,7 +386,7 @@ class PassportElementErrorTranslationFiles(PassportElementError): one of ``"passport"``, ``"driver_license"``, ``"identity_card"``, ``"internal_passport"``, ``"utility_bill"``, ``"bank_statement"``, ``"rental_agreement"``, ``"passport_registration"``, ``"temporary_registration"``. - file_hashes (List[:obj:`str`]): List of base64-encoded file hashes. + file_hashes (list[:obj:`str`]): List of base64-encoded file hashes. message (:obj:`str`): Error message. Attributes: @@ -403,7 +403,7 @@ class PassportElementErrorTranslationFiles(PassportElementError): def __init__( self, type: str, - file_hashes: List[str], + file_hashes: list[str], message: str, *, api_kwargs: Optional[JSONDict] = None, @@ -411,7 +411,7 @@ def __init__( # Required super().__init__("translation_files", type, message, api_kwargs=api_kwargs) with self._unfrozen(): - self._file_hashes: List[str] = file_hashes + self._file_hashes: list[str] = file_hashes self._id_attrs = (self.source, self.type, self.message, *tuple(file_hashes)) @@ -422,7 +422,7 @@ def to_dict(self, recursive: bool = True) -> JSONDict: return data @property - def file_hashes(self) -> List[str]: + def file_hashes(self) -> list[str]: """List of base64-encoded file hashes. .. deprecated:: 20.6 diff --git a/telegram/_passport/passportfile.py b/telegram/_passport/passportfile.py index 61b70486279..e023457f670 100644 --- a/telegram/_passport/passportfile.py +++ b/telegram/_passport/passportfile.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Encrypted PassportFile.""" -from typing import TYPE_CHECKING, List, Optional, Tuple +from typing import TYPE_CHECKING, Optional from telegram._telegramobject import TelegramObject from telegram._utils.defaultvalue import DEFAULT_NONE @@ -124,7 +124,7 @@ def de_json_decrypted( passport credentials. Args: - data (Dict[:obj:`str`, ...]): The JSON data. + data (dict[:obj:`str`, ...]): The JSON data. bot (:class:`telegram.Bot` | :obj:`None`): The bot associated with these object. May be :obj:`None`, in which case shortcut methods will not be available. @@ -151,10 +151,10 @@ def de_json_decrypted( @classmethod def de_list_decrypted( cls, - data: Optional[List[JSONDict]], + data: Optional[list[JSONDict]], bot: Optional["Bot"], - credentials: List["FileCredentials"], - ) -> Tuple[Optional["PassportFile"], ...]: + credentials: list["FileCredentials"], + ) -> tuple[Optional["PassportFile"], ...]: """Variant of :meth:`telegram.TelegramObject.de_list` that also takes into account passport credentials. @@ -164,7 +164,7 @@ def de_list_decrypted( * Filters out any :obj:`None` values Args: - data (List[Dict[:obj:`str`, ...]]): The JSON data. + data (list[dict[:obj:`str`, ...]]): The JSON data. bot (:class:`telegram.Bot` | :obj:`None`): The bot associated with these object. May be :obj:`None`, in which case shortcut methods will not be available. @@ -176,7 +176,7 @@ def de_list_decrypted( credentials (:class:`telegram.FileCredentials`): The credentials Returns: - Tuple[:class:`telegram.PassportFile`]: + tuple[:class:`telegram.PassportFile`]: """ if not data: @@ -203,7 +203,7 @@ async def get_file( """ Wrapper over :meth:`telegram.Bot.get_file`. Will automatically assign the correct credentials to the returned :class:`telegram.File` if originating from - :obj:`telegram.PassportData.decrypted_data`. + :attr:`telegram.PassportData.decrypted_data`. For the documentation of the arguments, please see :meth:`telegram.Bot.get_file`. diff --git a/telegram/_payment/refundedpayment.py b/telegram/_payment/refundedpayment.py index 19bdfe84649..28d52226205 100644 --- a/telegram/_payment/refundedpayment.py +++ b/telegram/_payment/refundedpayment.py @@ -30,6 +30,8 @@ class RefundedPayment(TelegramObject): Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their :attr:`telegram_payment_charge_id` is equal. + .. versionadded:: 21.4 + Args: currency (:obj:`str`): Three-letter ISO 4217 `currency `_ code, or ``XTR`` for diff --git a/telegram/_payment/shippingoption.py b/telegram/_payment/shippingoption.py index 15047a00b1f..b41af98793d 100644 --- a/telegram/_payment/shippingoption.py +++ b/telegram/_payment/shippingoption.py @@ -17,7 +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/]. """This module contains an object that represents a Telegram ShippingOption.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._telegramobject import TelegramObject from telegram._utils.argumentparsing import parse_sequence_arg @@ -47,7 +48,7 @@ class ShippingOption(TelegramObject): Attributes: id (:obj:`str`): Shipping option identifier. title (:obj:`str`): Option title. - prices (Tuple[:class:`telegram.LabeledPrice`]): List of price portions. + prices (tuple[:class:`telegram.LabeledPrice`]): List of price portions. .. versionchanged:: 20.0 |tupleclassattrs| @@ -68,7 +69,7 @@ def __init__( self.id: str = id self.title: str = title - self.prices: Tuple[LabeledPrice, ...] = parse_sequence_arg(prices) + self.prices: tuple[LabeledPrice, ...] = parse_sequence_arg(prices) self._id_attrs = (self.id,) diff --git a/telegram/_payment/shippingquery.py b/telegram/_payment/shippingquery.py index cf81b4ecfa6..24b4e0a662f 100644 --- a/telegram/_payment/shippingquery.py +++ b/telegram/_payment/shippingquery.py @@ -18,7 +18,8 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram ShippingQuery.""" -from typing import TYPE_CHECKING, Optional, Sequence +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._payment.shippingaddress import ShippingAddress from telegram._telegramobject import TelegramObject diff --git a/telegram/_payment/stars.py b/telegram/_payment/stars.py index b176f2315fe..7ce4cf2de86 100644 --- a/telegram/_payment/stars.py +++ b/telegram/_payment/stars.py @@ -19,10 +19,14 @@ # pylint: disable=redefined-builtin """This module contains the classes for Telegram Stars transactions.""" -from datetime import datetime -from typing import TYPE_CHECKING, Dict, Final, Optional, Sequence, Tuple, Type +import datetime as dtm +from collections.abc import Sequence +from typing import TYPE_CHECKING, Final, Optional from telegram import constants +from telegram._chat import Chat +from telegram._gifts import Gift +from telegram._paidmedia import PaidMedia from telegram._telegramobject import TelegramObject from telegram._user import User from telegram._utils import enum @@ -74,12 +78,23 @@ def __init__(self, type: str, *, api_kwargs: Optional[JSONDict] = None) -> None: def de_json( cls, data: Optional[JSONDict], bot: Optional["Bot"] = None ) -> Optional["RevenueWithdrawalState"]: + """Converts JSON data to the appropriate :class:`RevenueWithdrawalState` object, i.e. takes + care of selecting the correct subclass. + + Args: + data (dict[:obj:`str`, ...]): The JSON data. + bot (:class:`telegram.Bot`): The bot associated with this object. + + Returns: + The Telegram object. + + """ data = cls._parse_data(data) if not data: return None - _class_mapping: Dict[str, Type[RevenueWithdrawalState]] = { + _class_mapping: dict[str, type[RevenueWithdrawalState]] = { cls.PENDING: RevenueWithdrawalStatePending, cls.SUCCEEDED: RevenueWithdrawalStateSucceeded, cls.FAILED: RevenueWithdrawalStateFailed, @@ -131,7 +146,7 @@ class RevenueWithdrawalStateSucceeded(RevenueWithdrawalState): def __init__( self, - date: datetime, + date: dtm.datetime, url: str, *, api_kwargs: Optional[JSONDict] = None, @@ -139,7 +154,7 @@ def __init__( super().__init__(type=RevenueWithdrawalState.SUCCEEDED, api_kwargs=api_kwargs) with self._unfrozen(): - self.date: datetime = date + self.date: dtm.datetime = date self.url: str = url self._id_attrs = ( self.type, @@ -150,6 +165,7 @@ def __init__( def de_json( cls, data: Optional[JSONDict], bot: Optional["Bot"] = None ) -> Optional["RevenueWithdrawalStateSucceeded"]: + """See :meth:`telegram.RevenueWithdrawalState.de_json`.""" data = cls._parse_data(data) if not data: @@ -179,13 +195,107 @@ def __init__(self, *, api_kwargs: Optional[JSONDict] = None) -> None: self._freeze() +class AffiliateInfo(TelegramObject): + """Contains information about the affiliate that received a commission via this transaction. + + Objects of this class are comparable in terms of equality. Two objects of this class are + considered equal, if their :attr:`affiliate_user`, :attr:`affiliate_chat`, + :attr:`commission_per_mille`, :attr:`amount`, and :attr:`nanostar_amount` are equal. + + .. versionadded:: 21.9 + + Args: + affiliate_user (:class:`telegram.User`, optional): The bot or the user that received an + affiliate commission if it was received by a bot or a user + affiliate_chat (:class:`telegram.Chat`, optional): The chat that received an affiliate + commission if it was received by a chat + commission_per_mille (:obj:`int`): The number of Telegram Stars received by the affiliate + for each 1000 Telegram Stars received by the bot from referred users + amount (:obj:`int`): Integer amount of Telegram Stars received by the affiliate from the + transaction, rounded to 0; can be negative for refunds + nanostar_amount (:obj:`int`, optional): The number of + :tg-const:`~telegram.constants.StarTransactions.NANOSTAR_VALUE` shares of Telegram + Stars received by the affiliate; from + :tg-const:`~telegram.constants.StarTransactionsLimit.NANOSTAR_MIN_AMOUNT` to + :tg-const:`~telegram.constants.StarTransactionsLimit.NANOSTAR_MAX_AMOUNT`; + can be negative for refunds + + Attributes: + affiliate_user (:class:`telegram.User`): Optional. The bot or the user that received an + affiliate commission if it was received by a bot or a user + affiliate_chat (:class:`telegram.Chat`): Optional. The chat that received an affiliate + commission if it was received by a chat + commission_per_mille (:obj:`int`): The number of Telegram Stars received by the affiliate + for each 1000 Telegram Stars received by the bot from referred users + amount (:obj:`int`): Integer amount of Telegram Stars received by the affiliate from the + transaction, rounded to 0; can be negative for refunds + nanostar_amount (:obj:`int`): Optional. The number of + :tg-const:`~telegram.constants.StarTransactions.NANOSTAR_VALUE` shares of Telegram + Stars received by the affiliate; from + :tg-const:`~telegram.constants.StarTransactionsLimit.NANOSTAR_MIN_AMOUNT` to + :tg-const:`~telegram.constants.StarTransactionsLimit.NANOSTAR_MAX_AMOUNT`; + can be negative for refunds + """ + + __slots__ = ( + "affiliate_chat", + "affiliate_user", + "amount", + "commission_per_mille", + "nanostar_amount", + ) + + def __init__( + self, + commission_per_mille: int, + amount: int, + affiliate_user: Optional["User"] = None, + affiliate_chat: Optional["Chat"] = None, + nanostar_amount: Optional[int] = None, + *, + api_kwargs: Optional[JSONDict] = None, + ) -> None: + super().__init__(api_kwargs=api_kwargs) + self.affiliate_user: Optional[User] = affiliate_user + self.affiliate_chat: Optional[Chat] = affiliate_chat + self.commission_per_mille: int = commission_per_mille + self.amount: int = amount + self.nanostar_amount: Optional[int] = nanostar_amount + + self._id_attrs = ( + self.affiliate_user, + self.affiliate_chat, + self.commission_per_mille, + self.amount, + self.nanostar_amount, + ) + self._freeze() + + @classmethod + def de_json( + cls, data: Optional[JSONDict], bot: Optional["Bot"] = None + ) -> Optional["AffiliateInfo"]: + """See :meth:`telegram.TelegramObject.de_json`.""" + data = cls._parse_data(data) + + if not data: + return None + + data["affiliate_user"] = User.de_json(data.get("affiliate_user"), bot) + data["affiliate_chat"] = Chat.de_json(data.get("affiliate_chat"), bot) + + return super().de_json(data=data, bot=bot) + + class TransactionPartner(TelegramObject): """This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of: * :class:`TransactionPartnerUser` + * :class:`TransactionPartnerAffiliateProgram` * :class:`TransactionPartnerFragment` * :class:`TransactionPartnerTelegramAds` + * :class:`TransactionPartnerTelegramApi` * :class:`TransactionPartnerOther` Objects of this class are comparable in terms of equality. Two objects of this class are @@ -202,14 +312,21 @@ class TransactionPartner(TelegramObject): __slots__ = ("type",) + AFFILIATE_PROGRAM: Final[str] = constants.TransactionPartnerType.AFFILIATE_PROGRAM + """:const:`telegram.constants.TransactionPartnerType.AFFILIATE_PROGRAM` + + .. versionadded:: 21.9 + """ FRAGMENT: Final[str] = constants.TransactionPartnerType.FRAGMENT """:const:`telegram.constants.TransactionPartnerType.FRAGMENT`""" - USER: Final[str] = constants.TransactionPartnerType.USER - """:const:`telegram.constants.TransactionPartnerType.USER`""" OTHER: Final[str] = constants.TransactionPartnerType.OTHER """:const:`telegram.constants.TransactionPartnerType.OTHER`""" TELEGRAM_ADS: Final[str] = constants.TransactionPartnerType.TELEGRAM_ADS """:const:`telegram.constants.TransactionPartnerType.TELEGRAM_ADS`""" + TELEGRAM_API: Final[str] = constants.TransactionPartnerType.TELEGRAM_API + """:const:`telegram.constants.TransactionPartnerType.TELEGRAM_API`""" + USER: Final[str] = constants.TransactionPartnerType.USER + """:const:`telegram.constants.TransactionPartnerType.USER`""" def __init__(self, type: str, *, api_kwargs: Optional[JSONDict] = None) -> None: super().__init__(api_kwargs=api_kwargs) @@ -226,7 +343,7 @@ def de_json( care of selecting the correct subclass. Args: - data (Dict[:obj:`str`, ...]): The JSON data. + data (dict[:obj:`str`, ...]): The JSON data. bot (:class:`telegram.Bot`): The bot associated with this object. Returns: @@ -241,11 +358,13 @@ def de_json( if not data and cls is TransactionPartner: return None - _class_mapping: Dict[str, Type[TransactionPartner]] = { + _class_mapping: dict[str, type[TransactionPartner]] = { + cls.AFFILIATE_PROGRAM: TransactionPartnerAffiliateProgram, cls.FRAGMENT: TransactionPartnerFragment, cls.USER: TransactionPartnerUser, - cls.OTHER: TransactionPartnerOther, cls.TELEGRAM_ADS: TransactionPartnerTelegramAds, + cls.TELEGRAM_API: TransactionPartnerTelegramApi, + cls.OTHER: TransactionPartnerOther, } if cls is TransactionPartner and data.get("type") in _class_mapping: @@ -254,19 +373,77 @@ def de_json( return super().de_json(data=data, bot=bot) +class TransactionPartnerAffiliateProgram(TransactionPartner): + """Describes the affiliate program that issued the affiliate commission received via this + transaction. + + This object is comparable in terms of equality. Two objects of this class are considered equal, + if their :attr:`commission_per_mille` are equal. + + .. versionadded:: 21.9 + + Args: + sponsor_user (:class:`telegram.User`, optional): Information about the bot that sponsored + the affiliate program + commission_per_mille (:obj:`int`): The number of Telegram Stars received by the bot for + each 1000 Telegram Stars received by the affiliate program sponsor from referred users. + + Attributes: + type (:obj:`str`): The type of the transaction partner, + always :tg-const:`telegram.TransactionPartner.AFFILIATE_PROGRAM`. + sponsor_user (:class:`telegram.User`): Optional. Information about the bot that sponsored + the affiliate program + commission_per_mille (:obj:`int`): The number of Telegram Stars received by the bot for + each 1000 Telegram Stars received by the affiliate program sponsor from referred users. + """ + + __slots__ = ("commission_per_mille", "sponsor_user") + + def __init__( + self, + commission_per_mille: int, + sponsor_user: Optional["User"] = None, + *, + api_kwargs: Optional[JSONDict] = None, + ) -> None: + super().__init__(type=TransactionPartner.AFFILIATE_PROGRAM, api_kwargs=api_kwargs) + + with self._unfrozen(): + self.sponsor_user: Optional[User] = sponsor_user + self.commission_per_mille: int = commission_per_mille + self._id_attrs = ( + self.type, + self.commission_per_mille, + ) + + @classmethod + def de_json( + cls, data: Optional[JSONDict], bot: Optional["Bot"] = None + ) -> Optional["TransactionPartnerAffiliateProgram"]: + """See :meth:`telegram.TransactionPartner.de_json`.""" + data = cls._parse_data(data) + + if not data: + return None + + data["sponsor_user"] = User.de_json(data.get("sponsor_user"), bot) + + return super().de_json(data=data, bot=bot) # type: ignore[return-value] + + class TransactionPartnerFragment(TransactionPartner): """Describes a withdrawal transaction with Fragment. .. versionadded:: 21.4 Args: - withdrawal_state (:obj:`telegram.RevenueWithdrawalState`, optional): State of the + withdrawal_state (:class:`telegram.RevenueWithdrawalState`, optional): State of the transaction if the transaction is outgoing. Attributes: type (:obj:`str`): The type of the transaction partner, always :tg-const:`telegram.TransactionPartner.FRAGMENT`. - withdrawal_state (:obj:`telegram.RevenueWithdrawalState`): Optional. State of the + withdrawal_state (:class:`telegram.RevenueWithdrawalState`): Optional. State of the transaction if the transaction is outgoing. """ @@ -287,6 +464,7 @@ def __init__( def de_json( cls, data: Optional[JSONDict], bot: Optional["Bot"] = None ) -> Optional["TransactionPartnerFragment"]: + """See :meth:`telegram.TransactionPartner.de_json`.""" data = cls._parse_data(data) if not data: @@ -309,21 +487,71 @@ class TransactionPartnerUser(TransactionPartner): Args: user (:class:`telegram.User`): Information about the user. + affiliate (:class:`telegram.AffiliateInfo`, optional): Information about the affiliate that + received a commission via this transaction + + .. versionadded:: 21.9 invoice_payload (:obj:`str`, optional): Bot-specified invoice payload. + subscription_period (:class:`datetime.timedelta`, optional): The duration of the paid + subscription + + .. versionadded:: 21.8 + paid_media (Sequence[:class:`telegram.PaidMedia`], optional): Information about the paid + media bought by the user. + + .. versionadded:: 21.5 + paid_media_payload (:obj:`str`, optional): Bot-specified paid media payload. + + .. versionadded:: 21.6 + gift (:class:`telegram.Gift`, optional): The gift sent to the user by the bot + + .. versionadded:: 21.8 Attributes: type (:obj:`str`): The type of the transaction partner, always :tg-const:`telegram.TransactionPartner.USER`. user (:class:`telegram.User`): Information about the user. + affiliate (:class:`telegram.AffiliateInfo`): Optional. Information about the affiliate that + received a commission via this transaction + + .. versionadded:: 21.9 invoice_payload (:obj:`str`): Optional. Bot-specified invoice payload. + subscription_period (:class:`datetime.timedelta`): Optional. The duration of the paid + subscription + + .. versionadded:: 21.8 + paid_media (tuple[:class:`telegram.PaidMedia`]): Optional. Information about the paid + media bought by the user. + + .. versionadded:: 21.5 + paid_media_payload (:obj:`str`): Optional. Bot-specified paid media payload. + + .. versionadded:: 21.6 + gift (:class:`telegram.Gift`): Optional. The gift sent to the user by the bot + + .. versionadded:: 21.8 + """ - __slots__ = ("invoice_payload", "user") + __slots__ = ( + "affiliate", + "gift", + "invoice_payload", + "paid_media", + "paid_media_payload", + "subscription_period", + "user", + ) def __init__( self, user: "User", invoice_payload: Optional[str] = None, + paid_media: Optional[Sequence[PaidMedia]] = None, + paid_media_payload: Optional[str] = None, + subscription_period: Optional[dtm.timedelta] = None, + gift: Optional[Gift] = None, + affiliate: Optional[AffiliateInfo] = None, *, api_kwargs: Optional[JSONDict] = None, ) -> None: @@ -331,7 +559,13 @@ def __init__( with self._unfrozen(): self.user: User = user + self.affiliate: Optional[AffiliateInfo] = affiliate 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.gift: Optional[Gift] = gift + self._id_attrs = ( self.type, self.user, @@ -341,12 +575,21 @@ def __init__( def de_json( cls, data: Optional[JSONDict], bot: Optional["Bot"] = None ) -> Optional["TransactionPartnerUser"]: + """See :meth:`telegram.TransactionPartner.de_json`.""" data = cls._parse_data(data) if not data: return None data["user"] = User.de_json(data.get("user"), bot) + data["affiliate"] = AffiliateInfo.de_json(data.get("affiliate"), bot) + data["paid_media"] = PaidMedia.de_list(data.get("paid_media"), bot=bot) + data["subscription_period"] = ( + dtm.timedelta(seconds=sp) + if (sp := data.get("subscription_period")) is not None + else None + ) + data["gift"] = Gift.de_json(data.get("gift"), bot) return super().de_json(data=data, bot=bot) # type: ignore[return-value] @@ -385,6 +628,35 @@ def __init__(self, *, api_kwargs: Optional[JSONDict] = None) -> None: self._freeze() +class TransactionPartnerTelegramApi(TransactionPartner): + """Describes a transaction with payment for + `paid broadcasting `_. + + Objects of this class are comparable in terms of equality. Two objects of this class are + considered equal, if their :attr:`request_count` is equal. + + .. versionadded:: 21.7 + + Args: + request_count (:obj:`int`): The number of successful requests that exceeded regular limits + and were therefore billed. + + Attributes: + type (:obj:`str`): The type of the transaction partner, + always :tg-const:`telegram.TransactionPartner.TELEGRAM_API`. + request_count (:obj:`int`): The number of successful requests that exceeded regular limits + and were therefore billed. + """ + + __slots__ = ("request_count",) + + def __init__(self, request_count: int, *, api_kwargs: Optional[JSONDict] = None) -> None: + super().__init__(type=TransactionPartner.TELEGRAM_API, api_kwargs=api_kwargs) + with self._unfrozen(): + self.request_count: int = request_count + self._id_attrs = (self.request_count,) + + class StarTransaction(TelegramObject): """Describes a Telegram Star transaction. @@ -398,7 +670,13 @@ class StarTransaction(TelegramObject): of the original transaction for refund transactions. Coincides with :attr:`SuccessfulPayment.telegram_payment_charge_id` for successful incoming payments from users. - amount (:obj:`int`): Number of Telegram Stars transferred by the transaction. + amount (:obj:`int`): Integer amount of Telegram Stars transferred by the transaction. + nanostar_amount (:obj:`int`, optional): The number of + :tg-const:`~telegram.constants.StarTransactions.NANOSTAR_VALUE` shares of Telegram + Stars transferred by the transaction; from 0 to + :tg-const:`~telegram.constants.StarTransactionsLimit.NANOSTAR_MAX_AMOUNT` + + .. versionadded:: 21.9 date (:obj:`datetime.datetime`): Date the transaction was created as a datetime object. source (:class:`telegram.TransactionPartner`, optional): Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal). @@ -412,7 +690,13 @@ class StarTransaction(TelegramObject): of the original transaction for refund transactions. Coincides with :attr:`SuccessfulPayment.telegram_payment_charge_id` for successful incoming payments from users. - amount (:obj:`int`): Number of Telegram Stars transferred by the transaction. + amount (:obj:`int`): Integer amount of Telegram Stars transferred by the transaction. + nanostar_amount (:obj:`int`): Optional. The number of + :tg-const:`~telegram.constants.StarTransactions.NANOSTAR_VALUE` shares of Telegram + Stars transferred by the transaction; from 0 to + :tg-const:`~telegram.constants.StarTransactionsLimit.NANOSTAR_MAX_AMOUNT` + + .. versionadded:: 21.9 date (:obj:`datetime.datetime`): Date the transaction was created as a datetime object. source (:class:`telegram.TransactionPartner`): Optional. Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal). @@ -422,24 +706,26 @@ class StarTransaction(TelegramObject): outgoing transactions. """ - __slots__ = ("amount", "date", "id", "receiver", "source") + __slots__ = ("amount", "date", "id", "nanostar_amount", "receiver", "source") def __init__( self, id: str, amount: int, - date: datetime, + date: dtm.datetime, source: Optional[TransactionPartner] = None, receiver: Optional[TransactionPartner] = None, + nanostar_amount: Optional[int] = None, *, api_kwargs: Optional[JSONDict] = None, ) -> None: super().__init__(api_kwargs=api_kwargs) self.id: str = id self.amount: int = amount - self.date: datetime = date + self.date: dtm.datetime = date self.source: Optional[TransactionPartner] = source self.receiver: Optional[TransactionPartner] = receiver + self.nanostar_amount: Optional[int] = nanostar_amount self._id_attrs = ( self.id, @@ -452,6 +738,7 @@ def __init__( def de_json( cls, data: Optional[JSONDict], bot: Optional["Bot"] = None ) -> Optional["StarTransaction"]: + """See :meth:`telegram.TelegramObject.de_json`.""" data = cls._parse_data(data) if not data: @@ -480,7 +767,7 @@ class StarTransactions(TelegramObject): transactions (Sequence[:class:`telegram.StarTransaction`]): The list of transactions. Attributes: - transactions (Tuple[:class:`telegram.StarTransaction`]): The list of transactions. + transactions (tuple[:class:`telegram.StarTransaction`]): The list of transactions. """ __slots__ = ("transactions",) @@ -489,7 +776,7 @@ def __init__( self, transactions: Sequence[StarTransaction], *, api_kwargs: Optional[JSONDict] = None ): super().__init__(api_kwargs=api_kwargs) - self.transactions: Tuple[StarTransaction, ...] = parse_sequence_arg(transactions) + self.transactions: tuple[StarTransaction, ...] = parse_sequence_arg(transactions) self._id_attrs = (self.transactions,) self._freeze() @@ -498,6 +785,7 @@ def __init__( def de_json( cls, data: Optional[JSONDict], bot: Optional["Bot"] = None ) -> Optional["StarTransactions"]: + """See :meth:`telegram.TelegramObject.de_json`.""" data = cls._parse_data(data) if data is None: diff --git a/telegram/_payment/successfulpayment.py b/telegram/_payment/successfulpayment.py index 34bce29142e..5a947a8f434 100644 --- a/telegram/_payment/successfulpayment.py +++ b/telegram/_payment/successfulpayment.py @@ -18,10 +18,12 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram SuccessfulPayment.""" +import datetime as dtm from typing import TYPE_CHECKING, Optional from telegram._payment.orderinfo import OrderInfo from telegram._telegramobject import TelegramObject +from telegram._utils.datetime import extract_tzinfo_from_defaults, from_timestamp from telegram._utils.types import JSONDict if TYPE_CHECKING: @@ -45,6 +47,17 @@ class SuccessfulPayment(TelegramObject): it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). invoice_payload (:obj:`str`): Bot-specified invoice payload. + subscription_expiration_date (:class:`datetime.datetime`, optional): Expiration date of the + subscription; for recurring payments only. + + .. versionadded:: 21.8 + is_recurring (:obj:`bool`, optional): True, if the payment is for a subscription. + + .. versionadded:: 21.8 + is_first_recurring (:obj:`bool`, optional): True, if the payment is the first payment of a + subscription. + + .. versionadded:: 21.8 shipping_option_id (:obj:`str`, optional): Identifier of the shipping option chosen by the user. order_info (:class:`telegram.OrderInfo`, optional): Order info provided by the user. @@ -61,6 +74,17 @@ class SuccessfulPayment(TelegramObject): it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). invoice_payload (:obj:`str`): Bot-specified invoice payload. + subscription_expiration_date (:class:`datetime.datetime`): Optional. Expiration + date of the subscription; for recurring payments only. + + .. versionadded:: 21.8 + is_recurring (:obj:`bool`): Optional. True, if the payment is for a subscription. + + .. versionadded:: 21.8 + is_first_recurring (:obj:`bool`): Optional. True, if the payment is the first payment of a + subscription. + + .. versionadded:: 21.8 shipping_option_id (:obj:`str`): Optional. Identifier of the shipping option chosen by the user. order_info (:class:`telegram.OrderInfo`): Optional. Order info provided by the user. @@ -72,9 +96,12 @@ class SuccessfulPayment(TelegramObject): __slots__ = ( "currency", "invoice_payload", + "is_first_recurring", + "is_recurring", "order_info", "provider_payment_charge_id", "shipping_option_id", + "subscription_expiration_date", "telegram_payment_charge_id", "total_amount", ) @@ -88,6 +115,9 @@ def __init__( provider_payment_charge_id: str, shipping_option_id: Optional[str] = None, order_info: Optional[OrderInfo] = None, + subscription_expiration_date: Optional[dtm.datetime] = None, + is_recurring: Optional[bool] = None, + is_first_recurring: Optional[bool] = None, *, api_kwargs: Optional[JSONDict] = None, ): @@ -99,6 +129,9 @@ def __init__( self.order_info: Optional[OrderInfo] = order_info self.telegram_payment_charge_id: str = telegram_payment_charge_id self.provider_payment_charge_id: str = provider_payment_charge_id + self.subscription_expiration_date: Optional[dtm.datetime] = subscription_expiration_date + self.is_recurring: Optional[bool] = is_recurring + self.is_first_recurring: Optional[bool] = is_first_recurring self._id_attrs = (self.telegram_payment_charge_id, self.provider_payment_charge_id) @@ -116,4 +149,11 @@ def de_json( data["order_info"] = OrderInfo.de_json(data.get("order_info"), bot) + # Get the local timezone from the bot if it has defaults + loc_tzinfo = extract_tzinfo_from_defaults(bot) + + data["subscription_expiration_date"] = from_timestamp( + data.get("subscription_expiration_date"), tzinfo=loc_tzinfo + ) + return super().de_json(data=data, bot=bot) diff --git a/telegram/_poll.py b/telegram/_poll.py index 8ea387a0950..4fcbd8f8ca5 100644 --- a/telegram/_poll.py +++ b/telegram/_poll.py @@ -17,8 +17,9 @@ # 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 Poll.""" -import datetime -from typing import TYPE_CHECKING, Dict, Final, List, Optional, Sequence, Tuple +import datetime as dtm +from collections.abc import Sequence +from typing import TYPE_CHECKING, Final, Optional from telegram import constants from telegram._chat import Chat @@ -83,7 +84,7 @@ def __init__( super().__init__(api_kwargs=api_kwargs) self.text: str = text self.text_parse_mode: ODVInput[str] = text_parse_mode - self.text_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(text_entities) + self.text_entities: tuple[MessageEntity, ...] = parse_sequence_arg(text_entities) self._id_attrs = (self.text,) @@ -127,7 +128,7 @@ class PollOption(TelegramObject): :tg-const:`telegram.PollOption.MIN_LENGTH`-:tg-const:`telegram.PollOption.MAX_LENGTH` characters. voter_count (:obj:`int`): Number of users that voted for this option. - text_entities (Tuple[:class:`telegram.MessageEntity`]): Special entities + text_entities (tuple[:class:`telegram.MessageEntity`]): Special entities that appear in the option text. Currently, only custom emoji entities are allowed in poll option texts. This list is empty if the question does not contain entities. @@ -149,7 +150,7 @@ def __init__( super().__init__(api_kwargs=api_kwargs) self.text: str = text self.voter_count: int = voter_count - self.text_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(text_entities) + self.text_entities: tuple[MessageEntity, ...] = parse_sequence_arg(text_entities) self._id_attrs = (self.text, self.voter_count) @@ -189,7 +190,7 @@ def parse_entity(self, entity: MessageEntity) -> str: """ return parse_message_entity(self.text, entity) - def parse_entities(self, types: Optional[List[str]] = None) -> Dict[MessageEntity, str]: + def parse_entities(self, types: Optional[list[str]] = None) -> dict[MessageEntity, str]: """ Returns a :obj:`dict` that maps :class:`telegram.MessageEntity` to :obj:`str`. It contains entities from this polls question filtered by their ``type`` attribute as @@ -203,12 +204,12 @@ def parse_entities(self, types: Optional[List[str]] = None) -> Dict[MessageEntit .. versionadded:: 21.2 Args: - types (List[:obj:`str`], optional): List of ``MessageEntity`` types as strings. If the + types (list[:obj:`str`], optional): List of ``MessageEntity`` types as strings. If the ``type`` attribute of an entity is contained in this list, it will be returned. Defaults to :attr:`telegram.MessageEntity.ALL_TYPES`. Returns: - Dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to + dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to the text that belongs to them, calculated based on UTF-16 codepoints. """ return parse_message_entities(self.text, self.text_entities, types) @@ -260,7 +261,7 @@ class PollAnswer(TelegramObject): Attributes: poll_id (:obj:`str`): Unique poll identifier. - option_ids (Tuple[:obj:`int`]): Identifiers of answer options, chosen by the user. May + option_ids (tuple[:obj:`int`]): Identifiers of answer options, chosen by the user. May be empty if the user retracted their vote. .. versionchanged:: 20.0 @@ -292,7 +293,7 @@ def __init__( super().__init__(api_kwargs=api_kwargs) self.poll_id: str = poll_id self.voter_chat: Optional[Chat] = voter_chat - self.option_ids: Tuple[int, ...] = parse_sequence_arg(option_ids) + self.option_ids: tuple[int, ...] = parse_sequence_arg(option_ids) self.user: Optional[User] = user self._id_attrs = ( @@ -374,7 +375,7 @@ class Poll(TelegramObject): id (:obj:`str`): Unique poll identifier. question (:obj:`str`): Poll question, :tg-const:`telegram.Poll.MIN_QUESTION_LENGTH`- :tg-const:`telegram.Poll.MAX_QUESTION_LENGTH` characters. - options (Tuple[:class:`~telegram.PollOption`]): List of poll options. + options (tuple[:class:`~telegram.PollOption`]): List of poll options. .. versionchanged:: 20.0 |tupleclassattrs| @@ -389,7 +390,7 @@ class Poll(TelegramObject): explanation (:obj:`str`): Optional. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-:tg-const:`telegram.Poll.MAX_EXPLANATION_LENGTH` characters. - explanation_entities (Tuple[:class:`telegram.MessageEntity`]): Special entities + explanation_entities (tuple[:class:`telegram.MessageEntity`]): Special entities like usernames, URLs, bot commands, etc. that appear in the :attr:`explanation`. This list is empty if the message does not contain explanation entities. @@ -405,7 +406,7 @@ class Poll(TelegramObject): .. versionchanged:: 20.3 |datetime_localization| - question_entities (Tuple[:class:`telegram.MessageEntity`]): Special entities + question_entities (tuple[:class:`telegram.MessageEntity`]): Special entities that appear in the :attr:`question`. Currently, only custom emoji entities are allowed in poll questions. This list is empty if the question does not contain entities. @@ -445,7 +446,7 @@ def __init__( explanation: Optional[str] = None, explanation_entities: Optional[Sequence[MessageEntity]] = None, open_period: Optional[int] = None, - close_date: Optional[datetime.datetime] = None, + close_date: Optional[dtm.datetime] = None, question_entities: Optional[Sequence[MessageEntity]] = None, *, api_kwargs: Optional[JSONDict] = None, @@ -453,7 +454,7 @@ def __init__( super().__init__(api_kwargs=api_kwargs) self.id: str = id self.question: str = question - self.options: Tuple[PollOption, ...] = parse_sequence_arg(options) + self.options: tuple[PollOption, ...] = parse_sequence_arg(options) self.total_voter_count: int = total_voter_count self.is_closed: bool = is_closed self.is_anonymous: bool = is_anonymous @@ -461,12 +462,12 @@ def __init__( self.allows_multiple_answers: bool = allows_multiple_answers self.correct_option_id: Optional[int] = correct_option_id self.explanation: Optional[str] = explanation - self.explanation_entities: Tuple[MessageEntity, ...] = parse_sequence_arg( + self.explanation_entities: tuple[MessageEntity, ...] = parse_sequence_arg( explanation_entities ) self.open_period: Optional[int] = open_period - self.close_date: Optional[datetime.datetime] = close_date - self.question_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(question_entities) + self.close_date: Optional[dtm.datetime] = close_date + self.question_entities: tuple[MessageEntity, ...] = parse_sequence_arg(question_entities) self._id_attrs = (self.id,) @@ -516,8 +517,8 @@ def parse_explanation_entity(self, entity: MessageEntity) -> str: return parse_message_entity(self.explanation, entity) def parse_explanation_entities( - self, types: Optional[List[str]] = None - ) -> Dict[MessageEntity, str]: + self, types: Optional[list[str]] = None + ) -> dict[MessageEntity, str]: """ Returns a :obj:`dict` that maps :class:`telegram.MessageEntity` to :obj:`str`. It contains entities from this polls explanation filtered by their ``type`` attribute as @@ -529,12 +530,12 @@ def parse_explanation_entities( UTF-16 codepoints. See :attr:`parse_explanation_entity` for more info. Args: - types (List[:obj:`str`], optional): List of ``MessageEntity`` types as strings. If the + types (list[:obj:`str`], optional): List of ``MessageEntity`` types as strings. If the ``type`` attribute of an entity is contained in this list, it will be returned. Defaults to :attr:`telegram.MessageEntity.ALL_TYPES`. Returns: - Dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to + dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to the text that belongs to them, calculated based on UTF-16 codepoints. Raises: @@ -567,8 +568,8 @@ def parse_question_entity(self, entity: MessageEntity) -> str: return parse_message_entity(self.question, entity) def parse_question_entities( - self, types: Optional[List[str]] = None - ) -> Dict[MessageEntity, str]: + self, types: Optional[list[str]] = None + ) -> dict[MessageEntity, str]: """ Returns a :obj:`dict` that maps :class:`telegram.MessageEntity` to :obj:`str`. It contains entities from this polls question filtered by their ``type`` attribute as @@ -582,12 +583,12 @@ def parse_question_entities( UTF-16 codepoints. See :attr:`parse_question_entity` for more info. Args: - types (List[:obj:`str`], optional): List of ``MessageEntity`` types as strings. If the + types (list[:obj:`str`], optional): List of ``MessageEntity`` types as strings. If the ``type`` attribute of an entity is contained in this list, it will be returned. Defaults to :attr:`telegram.MessageEntity.ALL_TYPES`. Returns: - Dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to + dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to the text that belongs to them, calculated based on UTF-16 codepoints. """ diff --git a/telegram/_reaction.py b/telegram/_reaction.py index d1ba718f0d6..ca0f37fb0cc 100644 --- a/telegram/_reaction.py +++ b/telegram/_reaction.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/]. """This module contains objects that represents a Telegram ReactionType.""" + from typing import TYPE_CHECKING, Final, Literal, Optional, Union from telegram import constants @@ -30,16 +31,22 @@ class ReactionType(TelegramObject): """Base class for Telegram ReactionType Objects. - There exist :class:`telegram.ReactionTypeEmoji` and :class:`telegram.ReactionTypeCustomEmoji`. + There exist :class:`telegram.ReactionTypeEmoji`, :class:`telegram.ReactionTypeCustomEmoji` + and :class:`telegram.ReactionTypePaid`. .. versionadded:: 20.8 + .. versionchanged:: 21.5 + + Added paid reaction. Args: type (:obj:`str`): Type of the reaction. Can be - :attr:`~telegram.ReactionType.EMOJI` or :attr:`~telegram.ReactionType.CUSTOM_EMOJI`. + :attr:`~telegram.ReactionType.EMOJI`, :attr:`~telegram.ReactionType.CUSTOM_EMOJI` or + :attr:`~telegram.ReactionType.PAID`. Attributes: type (:obj:`str`): Type of the reaction. Can be - :attr:`~telegram.ReactionType.EMOJI` or :attr:`~telegram.ReactionType.CUSTOM_EMOJI`. + :attr:`~telegram.ReactionType.EMOJI`, :attr:`~telegram.ReactionType.CUSTOM_EMOJI` or + :attr:`~telegram.ReactionType.PAID`. """ @@ -49,11 +56,16 @@ class ReactionType(TelegramObject): """:const:`telegram.constants.ReactionType.EMOJI`""" CUSTOM_EMOJI: Final[constants.ReactionType] = constants.ReactionType.CUSTOM_EMOJI """:const:`telegram.constants.ReactionType.CUSTOM_EMOJI`""" + PAID: Final[constants.ReactionType] = constants.ReactionType.PAID + """:const:`telegram.constants.ReactionType.PAID` + + .. versionadded:: 21.5 + """ def __init__( self, type: Union[ # pylint: disable=redefined-builtin - Literal["emoji", "custom_emoji"], constants.ReactionType + Literal["emoji", "custom_emoji", "paid"], constants.ReactionType ], *, api_kwargs: Optional[JSONDict] = None, @@ -71,14 +83,20 @@ def de_json( """See :meth:`telegram.TelegramObject.de_json`.""" data = cls._parse_data(data) - if not data: + if data is None: return None - if cls is ReactionType and data.get("type") in [cls.EMOJI, cls.CUSTOM_EMOJI]: - reaction_type = data.pop("type") - if reaction_type == cls.EMOJI: - return ReactionTypeEmoji.de_json(data=data, bot=bot) - return ReactionTypeCustomEmoji.de_json(data=data, bot=bot) + if not data and cls is ReactionType: + return None + + _class_mapping: dict[str, type[ReactionType]] = { + cls.EMOJI: ReactionTypeEmoji, + cls.CUSTOM_EMOJI: ReactionTypeCustomEmoji, + cls.PAID: ReactionTypePaid, + } + + if cls is ReactionType and data.get("type") in _class_mapping: + return _class_mapping[data.pop("type")].de_json(data, bot) return super().de_json(data=data, bot=bot) @@ -152,6 +170,24 @@ def __init__( self._id_attrs = (self.custom_emoji_id,) +class ReactionTypePaid(ReactionType): + """ + The reaction is paid. + + .. versionadded:: 21.5 + + Attributes: + type (:obj:`str`): Type of the reaction, + always :tg-const:`telegram.ReactionType.PAID`. + """ + + __slots__ = () + + def __init__(self, *, api_kwargs: Optional[JSONDict] = None): + super().__init__(type=ReactionType.PAID, api_kwargs=api_kwargs) + self._freeze() + + class ReactionCount(TelegramObject): """This class represents a reaction added to a message along with the number of times it was added. diff --git a/telegram/_reply.py b/telegram/_reply.py index 0c15844c8d5..afaa379ca38 100644 --- a/telegram/_reply.py +++ b/telegram/_reply.py @@ -17,7 +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/]. """This modules contains objects that represents Telegram Replies""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple, Union +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional, Union from telegram._chat import Chat from telegram._dice import Dice @@ -92,14 +93,13 @@ class ExternalReplyInfo(TelegramObject): about the contact. dice (:class:`telegram.Dice`, optional): Message is a dice with random value. game (:Class:`telegram.Game`. optional): Message is a game, information about the game. - `More about games >> `_. + :ref:`More about games >> `. giveaway (:class:`telegram.Giveaway`, optional): Message is a scheduled giveaway, information about the giveaway. giveaway_winners (:class:`telegram.GiveawayWinners`, optional): A giveaway with public winners was completed. invoice (:class:`telegram.Invoice`, optional): Message is an invoice for a payment, - information about the invoice. `More about payments >> - `_. + information about the invoice. :ref:`More about payments >> `. location (:class:`telegram.Location`, optional): Message is a shared location, information about the location. poll (:class:`telegram.Poll`, optional): Message is a native poll, information about the @@ -125,7 +125,7 @@ class ExternalReplyInfo(TelegramObject): file. document (:class:`telegram.Document`): Optional. Message is a general file, information about the file. - photo (Tuple[:class:`telegram.PhotoSize`]): Optional. Message is a photo, available sizes + photo (tuple[:class:`telegram.PhotoSize`]): Optional. Message is a photo, available sizes of the photo. sticker (:class:`telegram.Sticker`): Optional. Message is a sticker, information about the sticker. @@ -142,14 +142,13 @@ class ExternalReplyInfo(TelegramObject): about the contact. dice (:class:`telegram.Dice`): Optional. Message is a dice with random value. game (:Class:`telegram.Game`): Optional. Message is a game, information about the game. - `More about games >> `_. + :ref:`More about games >> `. giveaway (:class:`telegram.Giveaway`): Optional. Message is a scheduled giveaway, information about the giveaway. giveaway_winners (:class:`telegram.GiveawayWinners`): Optional. A giveaway with public winners was completed. invoice (:class:`telegram.Invoice`): Optional. Message is an invoice for a payment, - information about the invoice. `More about payments >> - `_. + information about the invoice. :ref:`More about payments >> `. location (:class:`telegram.Location`): Optional. Message is a shared location, information about the location. poll (:class:`telegram.Poll`): Optional. Message is a native poll, information about the @@ -226,7 +225,7 @@ def __init__( self.animation: Optional[Animation] = animation self.audio: Optional[Audio] = audio self.document: Optional[Document] = document - self.photo: Optional[Tuple[PhotoSize, ...]] = parse_sequence_arg(photo) + self.photo: Optional[tuple[PhotoSize, ...]] = parse_sequence_arg(photo) self.sticker: Optional[Sticker] = sticker self.story: Optional[Story] = story self.video: Optional[Video] = video @@ -252,7 +251,7 @@ def __init__( def de_json( cls, data: Optional[JSONDict], bot: Optional["Bot"] = None ) -> Optional["ExternalReplyInfo"]: - """See :obj:`telegram.TelegramObject.de_json`.""" + """See :meth:`telegram.TelegramObject.de_json`.""" data = cls._parse_data(data) if data is None: @@ -301,7 +300,8 @@ class TextQuote(TelegramObject): message. position (:obj:`int`): Approximate quote position in the original message in UTF-16 code units as specified by the sender. - entities (Sequence[:obj:`telegram.MessageEntity`], optional): Special entities that appear + entities (Sequence[:class:`telegram.MessageEntity`], optional): Special entities that + appear in the quote. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are kept in quotes. is_manual (:obj:`bool`, optional): :obj:`True`, if the quote was chosen manually by the @@ -312,7 +312,7 @@ class TextQuote(TelegramObject): message. position (:obj:`int`): Approximate quote position in the original message in UTF-16 code units as specified by the sender. - entities (Tuple[:obj:`telegram.MessageEntity`]): Optional. Special entities that appear + entities (tuple[:class:`telegram.MessageEntity`]): Optional. Special entities that appear in the quote. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are kept in quotes. is_manual (:obj:`bool`): Optional. :obj:`True`, if the quote was chosen manually by the @@ -339,7 +339,7 @@ def __init__( self.text: str = text self.position: int = position - self.entities: Optional[Tuple[MessageEntity, ...]] = parse_sequence_arg(entities) + self.entities: Optional[tuple[MessageEntity, ...]] = parse_sequence_arg(entities) self.is_manual: Optional[bool] = is_manual self._id_attrs = ( @@ -353,7 +353,7 @@ def __init__( def de_json( cls, data: Optional[JSONDict], bot: Optional["Bot"] = None ) -> Optional["TextQuote"]: - """See :obj:`telegram.TelegramObject.de_json`.""" + """See :meth:`telegram.TelegramObject.de_json`.""" data = cls._parse_data(data) if data is None: @@ -389,7 +389,8 @@ class ReplyParameters(TelegramObject): quote_parse_mode (:obj:`str`, optional): Mode for parsing entities in the quote. See :wiki:`formatting options ` for more details. - quote_entities (Sequence[:obj:`telegram.MessageEntity`], optional): A JSON-serialized list + quote_entities (Sequence[:class:`telegram.MessageEntity`], optional): A JSON-serialized + list of special entities that appear in the quote. It can be specified instead of :paramref:`quote_parse_mode`. quote_position (:obj:`int`, optional): Position of the quote in the original message in @@ -411,8 +412,8 @@ class ReplyParameters(TelegramObject): quote_parse_mode (:obj:`str`): Optional. Mode for parsing entities in the quote. See :wiki:`formatting options ` for more details. - quote_entities (Tuple[:obj:`telegram.MessageEntity`]): Optional. A JSON-serialized list of - special entities that appear in the quote. It can be specified instead of + quote_entities (tuple[:class:`telegram.MessageEntity`]): Optional. A JSON-serialized list + of special entities that appear in the quote. It can be specified instead of :paramref:`quote_parse_mode`. quote_position (:obj:`int`): Optional. Position of the quote in the original message in UTF-16 code units. @@ -447,7 +448,7 @@ def __init__( self.allow_sending_without_reply: ODVInput[bool] = allow_sending_without_reply self.quote: Optional[str] = quote self.quote_parse_mode: ODVInput[str] = quote_parse_mode - self.quote_entities: Optional[Tuple[MessageEntity, ...]] = parse_sequence_arg( + self.quote_entities: Optional[tuple[MessageEntity, ...]] = parse_sequence_arg( quote_entities ) self.quote_position: Optional[int] = quote_position @@ -460,7 +461,7 @@ def __init__( def de_json( cls, data: Optional[JSONDict], bot: Optional["Bot"] = None ) -> Optional["ReplyParameters"]: - """See :obj:`telegram.TelegramObject.de_json`.""" + """See :meth:`telegram.TelegramObject.de_json`.""" data = cls._parse_data(data) if data is None: diff --git a/telegram/_replykeyboardmarkup.py b/telegram/_replykeyboardmarkup.py index 1b410ebc709..3abecc5863c 100644 --- a/telegram/_replykeyboardmarkup.py +++ b/telegram/_replykeyboardmarkup.py @@ -18,7 +18,8 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram ReplyKeyboardMarkup.""" -from typing import Final, Optional, Sequence, Tuple, Union +from collections.abc import Sequence +from typing import Final, Optional, Union from telegram import constants from telegram._keyboardbutton import KeyboardButton @@ -85,7 +86,7 @@ class ReplyKeyboardMarkup(TelegramObject): .. versionadded:: 20.0 Attributes: - keyboard (Tuple[Tuple[:class:`telegram.KeyboardButton`]]): Array of button rows, + keyboard (tuple[tuple[:class:`telegram.KeyboardButton`]]): Array of button rows, each represented by an Array of :class:`telegram.KeyboardButton` objects. resize_keyboard (:obj:`bool`): Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of @@ -148,7 +149,7 @@ def __init__( ) # Required - self.keyboard: Tuple[Tuple[KeyboardButton, ...], ...] = tuple( + self.keyboard: tuple[tuple[KeyboardButton, ...], ...] = tuple( tuple(KeyboardButton(button) if isinstance(button, str) else button for button in row) for row in keyboard ) diff --git a/telegram/_shared.py b/telegram/_shared.py index b4ce2c4d5a0..60d8ef3b961 100644 --- a/telegram/_shared.py +++ b/telegram/_shared.py @@ -17,7 +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/]. """This module contains two objects used for request chats/users service messages.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._files.photosize import PhotoSize from telegram._telegramobject import TelegramObject @@ -59,7 +60,7 @@ class UsersShared(TelegramObject): Attributes: request_id (:obj:`int`): Identifier of the request. - users (Tuple[:class:`telegram.SharedUser`]): Information about users shared with the + users (tuple[:class:`telegram.SharedUser`]): Information about users shared with the bot. .. versionadded:: 21.1 @@ -76,7 +77,7 @@ def __init__( ): super().__init__(api_kwargs=api_kwargs) self.request_id: int = request_id - self.users: Tuple[SharedUser, ...] = parse_sequence_arg(users) + self.users: tuple[SharedUser, ...] = parse_sequence_arg(users) self._id_attrs = (self.request_id, self.users) @@ -144,7 +145,7 @@ class ChatShared(TelegramObject): the bot and available. .. versionadded:: 21.1 - photo (Tuple[:class:`telegram.PhotoSize`]): Optional. Available sizes of the chat photo, + photo (tuple[:class:`telegram.PhotoSize`]): Optional. Available sizes of the chat photo, if the photo was requested by the bot .. versionadded:: 21.1 @@ -167,7 +168,7 @@ def __init__( self.chat_id: int = chat_id self.title: Optional[str] = title self.username: Optional[str] = username - self.photo: Optional[Tuple[PhotoSize, ...]] = parse_sequence_arg(photo) + self.photo: Optional[tuple[PhotoSize, ...]] = parse_sequence_arg(photo) self._id_attrs = (self.request_id, self.chat_id) @@ -226,7 +227,7 @@ class SharedUser(TelegramObject): bot. username (:obj:`str`): Optional. Username of the user, if the username was requested by the bot. - photo (Tuple[:class:`telegram.PhotoSize`]): Available sizes of the chat photo, if + photo (tuple[:class:`telegram.PhotoSize`]): Available sizes of the chat photo, if the photo was requested by the bot. This list is empty if the photo was not requsted. """ @@ -247,7 +248,7 @@ def __init__( self.first_name: Optional[str] = first_name self.last_name: Optional[str] = last_name self.username: Optional[str] = username - self.photo: Optional[Tuple[PhotoSize, ...]] = parse_sequence_arg(photo) + self.photo: Optional[tuple[PhotoSize, ...]] = parse_sequence_arg(photo) self._id_attrs = (self.user_id,) diff --git a/telegram/_telegramobject.py b/telegram/_telegramobject.py index 4f7ba92d602..2e4116b9675 100644 --- a/telegram/_telegramobject.py +++ b/telegram/_telegramobject.py @@ -18,30 +18,15 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """Base class for Telegram Objects.""" import contextlib -import datetime +import datetime as dtm import inspect import json -from collections.abc import Sized +from collections.abc import Iterator, Mapping, Sized from contextlib import contextmanager from copy import deepcopy from itertools import chain from types import MappingProxyType -from typing import ( - TYPE_CHECKING, - Any, - ClassVar, - Dict, - Iterator, - List, - Mapping, - Optional, - Set, - Tuple, - Type, - TypeVar, - Union, - cast, -) +from typing import TYPE_CHECKING, Any, ClassVar, Optional, TypeVar, Union, cast from telegram._utils.datetime import to_timestamp from telegram._utils.defaultvalue import DefaultValue @@ -80,7 +65,7 @@ class TelegramObject: :obj:`list` are now of type :obj:`tuple`. Arguments: - api_kwargs (Dict[:obj:`str`, any], optional): |toapikwargsarg| + api_kwargs (dict[:obj:`str`, any], optional): |toapikwargsarg| .. versionadded:: 20.0 @@ -95,11 +80,11 @@ class TelegramObject: # Used to cache the names of the parameters of the __init__ method of the class # Must be a private attribute to avoid name clashes between subclasses - __INIT_PARAMS: ClassVar[Set[str]] = set() + __INIT_PARAMS: ClassVar[set[str]] = set() # Used to check if __INIT_PARAMS has been set for the current class. Unfortunately, we can't # just check if `__INIT_PARAMS is None`, since subclasses use the parent class' __INIT_PARAMS # unless it's overridden - __INIT_PARAMS_CHECK: Optional[Type["TelegramObject"]] = None + __INIT_PARAMS_CHECK: Optional[type["TelegramObject"]] = None def __init__(self, *, api_kwargs: Optional[JSONDict] = None) -> None: # Setting _frozen to `False` here means that classes without arguments still need to @@ -107,7 +92,7 @@ def __init__(self, *, api_kwargs: Optional[JSONDict] = None) -> None: # `with self._unfrozen()` in the `__init__` of subclasses and we have fewer empty # classes than classes with arguments. self._frozen: bool = False - self._id_attrs: Tuple[object, ...] = () + self._id_attrs: tuple[object, ...] = () self._bot: Optional[Bot] = None # We don't do anything with api_kwargs here - see docstring of _apply_api_kwargs self.api_kwargs: Mapping[str, Any] = MappingProxyType(api_kwargs or {}) @@ -263,7 +248,7 @@ def __getitem__(self, item: str) -> object: f"`{item}`." ) from exc - def __getstate__(self) -> Dict[str, Union[str, object]]: + def __getstate__(self) -> dict[str, Union[str, object]]: """ Overrides :meth:`object.__getstate__` to customize the pickling process of objects of this type. @@ -271,7 +256,7 @@ def __getstate__(self) -> Dict[str, Union[str, object]]: :meth:`set_bot` (if any), as it can't be pickled. Returns: - state (Dict[:obj:`str`, :obj:`object`]): The state of the 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 @@ -281,7 +266,7 @@ def __getstate__(self) -> Dict[str, Union[str, object]]: out["api_kwargs"] = dict(self.api_kwargs) return out - def __setstate__(self, state: Dict[str, object]) -> None: + def __setstate__(self, state: dict[str, object]) -> None: """ Overrides :meth:`object.__setstate__` to customize the unpickling process of objects of this type. Modifies the object in-place. @@ -305,7 +290,7 @@ def __setstate__(self, state: Dict[str, object]) -> None: self._bot = None # get api_kwargs first because we may need to add entries to it (see try-except below) - api_kwargs = cast(Dict[str, object], state.pop("api_kwargs", {})) + api_kwargs = cast(dict[str, object], state.pop("api_kwargs", {})) # get _frozen before the loop to avoid setting it to True in the loop frozen = state.pop("_frozen", False) @@ -341,7 +326,7 @@ def __setstate__(self, state: Dict[str, object]) -> None: if frozen: self._freeze() - def __deepcopy__(self: Tele_co, memodict: Dict[int, object]) -> Tele_co: + def __deepcopy__(self: Tele_co, memodict: dict[int, object]) -> Tele_co: """ Customizes how :func:`copy.deepcopy` processes objects of this type. The only difference to the default implementation is that the :class:`telegram.Bot` @@ -354,7 +339,7 @@ def __deepcopy__(self: Tele_co, memodict: Dict[int, object]) -> Tele_co: memodict (:obj:`dict`): A dictionary that maps objects to their copies. Returns: - :obj:`telegram.TelegramObject`: The copied object. + :class:`telegram.TelegramObject`: The copied object. """ bot = self._bot # Save bot so we can set it after copying self.set_bot(None) # set to None so it is not deepcopied @@ -401,7 +386,7 @@ def _parse_data(data: Optional[JSONDict]) -> Optional[JSONDict]: @classmethod def _de_json( - cls: Type[Tele_co], + cls: type[Tele_co], data: Optional[JSONDict], bot: Optional["Bot"], api_kwargs: Optional[JSONDict] = None, @@ -414,7 +399,7 @@ def _de_json( obj = cls(**data, api_kwargs=api_kwargs) except TypeError as exc: if "__init__() got an unexpected keyword argument" not in str(exc): - raise exc + raise if cls.__INIT_PARAMS_CHECK is not cls: signature = inspect.signature(cls) @@ -433,12 +418,12 @@ def _de_json( @classmethod def de_json( - cls: Type[Tele_co], data: Optional[JSONDict], bot: Optional["Bot"] = None + cls: type[Tele_co], data: Optional[JSONDict], bot: Optional["Bot"] = None ) -> Optional[Tele_co]: """Converts JSON data to a Telegram object. Args: - data (Dict[:obj:`str`, ...]): The JSON data. + data (dict[:obj:`str`, ...]): The JSON data. bot (:class:`telegram.Bot`, optional): The bot associated with this object. Defaults to :obj:`None`, in which case shortcut methods will not be available. @@ -453,8 +438,8 @@ def de_json( @classmethod def de_list( - cls: Type[Tele_co], data: Optional[List[JSONDict]], bot: Optional["Bot"] = None - ) -> Tuple[Tele_co, ...]: + cls: type[Tele_co], data: Optional[list[JSONDict]], bot: Optional["Bot"] = None + ) -> tuple[Tele_co, ...]: """Converts a list of JSON objects to a tuple of Telegram objects. .. versionchanged:: 20.0 @@ -463,7 +448,7 @@ def de_list( * Filters out any :obj:`None` values. Args: - data (List[Dict[:obj:`str`, ...]]): The JSON data. + data (list[dict[:obj:`str`, ...]]): The JSON data. bot (:class:`telegram.Bot`, optional): The bot associated with these object. Defaults to :obj:`None`, in which case shortcut methods will not be available. @@ -552,7 +537,7 @@ def _get_attrs( recursive: bool = False, remove_bot: bool = False, convert_default_vault: bool = True, - ) -> Dict[str, Union[str, object]]: + ) -> dict[str, Union[str, object]]: """This method is used for obtaining the attributes of the object. Args: @@ -625,7 +610,7 @@ def to_dict(self, recursive: bool = True) -> JSONDict: # Now we should convert TGObjects to dicts inside objects such as sequences, and convert # datetimes to timestamps. This mostly eliminates the need for subclasses to override # `to_dict` - pop_keys: Set[str] = set() + pop_keys: set[str] = set() for key, value in out.items(): if isinstance(value, (tuple, list)): if not value: @@ -637,7 +622,7 @@ def to_dict(self, recursive: bool = True) -> JSONDict: for item in value: if hasattr(item, "to_dict"): val.append(item.to_dict(recursive=recursive)) - # This branch is useful for e.g. Tuple[Tuple[PhotoSize|KeyboardButton]] + # This branch is useful for e.g. tuple[tuple[PhotoSize|KeyboardButton]] elif isinstance(item, (tuple, list)): val.append( [ @@ -649,8 +634,10 @@ def to_dict(self, recursive: bool = True) -> JSONDict: val.append(item) out[key] = val - elif isinstance(value, datetime.datetime): + elif isinstance(value, dtm.datetime): out[key] = to_timestamp(value) + elif isinstance(value, dtm.timedelta): + out[key] = value.total_seconds() for key in pop_keys: out.pop(key) diff --git a/telegram/_update.py b/telegram/_update.py index 579cb008580..abacce72c5f 100644 --- a/telegram/_update.py +++ b/telegram/_update.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram Update.""" -from typing import TYPE_CHECKING, Final, List, Optional, Union +from typing import TYPE_CHECKING, Final, Optional, Union from telegram import constants from telegram._business import BusinessConnection, BusinessMessagesDeleted @@ -30,6 +30,7 @@ from telegram._inline.inlinequery import InlineQuery from telegram._message import Message from telegram._messagereactionupdated import MessageReactionCountUpdated, MessageReactionUpdated +from telegram._paidmedia import PaidMediaPurchased from telegram._payment.precheckoutquery import PreCheckoutQuery from telegram._payment.shippingquery import ShippingQuery from telegram._poll import Poll, PollAnswer @@ -156,6 +157,11 @@ class Update(TelegramObject): .. versionadded:: 21.1 + purchased_paid_media (:class:`telegram.PaidMediaPurchased`, optional): A user purchased + paid media with a non-empty payload sent by the bot in a non-channel chat. + + .. versionadded:: 21.6 + Attributes: update_id (:obj:`int`): The update's unique identifier. Update identifiers start from a @@ -263,6 +269,11 @@ class Update(TelegramObject): were deleted from a connected business account. .. versionadded:: 21.1 + + purchased_paid_media (:class:`telegram.PaidMediaPurchased`): Optional. A user purchased + paid media with a non-empty payload sent by the bot in a non-channel chat. + + .. versionadded:: 21.6 """ __slots__ = ( @@ -290,6 +301,7 @@ class Update(TelegramObject): "poll", "poll_answer", "pre_checkout_query", + "purchased_paid_media", "removed_chat_boost", "shipping_query", "update_id", @@ -383,8 +395,15 @@ class Update(TelegramObject): """:const:`telegram.constants.UpdateType.DELETED_BUSINESS_MESSAGES` .. versionadded:: 21.1""" - ALL_TYPES: Final[List[str]] = list(constants.UpdateType) - """List[:obj:`str`]: A list of all available update types. + + PURCHASED_PAID_MEDIA: Final[str] = constants.UpdateType.PURCHASED_PAID_MEDIA + """:const:`telegram.constants.UpdateType.PURCHASED_PAID_MEDIA` + + .. versionadded:: 21.6 + """ + + ALL_TYPES: Final[list[str]] = list(constants.UpdateType) + """list[:obj:`str`]: A list of all available update types. .. versionadded:: 13.5""" @@ -413,6 +432,7 @@ def __init__( business_message: Optional[Message] = None, edited_business_message: Optional[Message] = None, deleted_business_messages: Optional[BusinessMessagesDeleted] = None, + purchased_paid_media: Optional[PaidMediaPurchased] = None, *, api_kwargs: Optional[JSONDict] = None, ): @@ -444,6 +464,7 @@ def __init__( self.deleted_business_messages: Optional[BusinessMessagesDeleted] = ( deleted_business_messages ) + self.purchased_paid_media: Optional[PaidMediaPurchased] = purchased_paid_media self._effective_user: Optional[User] = None self._effective_sender: Optional[Union[User, Chat]] = None @@ -475,6 +496,9 @@ def effective_user(self) -> Optional["User"]: This property now also considers :attr:`business_connection`, :attr:`business_message` and :attr:`edited_business_message`. + .. versionchanged:: 21.6 + This property now also considers :attr:`purchased_paid_media`. + Example: * If :attr:`message` is present, this will give :attr:`telegram.Message.from_user`. @@ -531,6 +555,9 @@ def effective_user(self) -> Optional["User"]: elif self.business_connection: user = self.business_connection.user + elif self.purchased_paid_media: + user = self.purchased_paid_media.from_user + self._effective_user = user return user @@ -601,7 +628,8 @@ def effective_chat(self) -> Optional["Chat"]: This is the case, if :attr:`inline_query`, :attr:`chosen_inline_result`, :attr:`callback_query` from inline messages, :attr:`shipping_query`, :attr:`pre_checkout_query`, :attr:`poll`, - :attr:`poll_answer`, or :attr:`business_connection` is present. + :attr:`poll_answer`, :attr:`business_connection`, or :attr:`purchased_paid_media` + is present. .. versionchanged:: 21.1 This property now also considers :attr:`business_message`, @@ -768,5 +796,8 @@ def de_json(cls, data: Optional[JSONDict], bot: Optional["Bot"] = None) -> Optio data["deleted_business_messages"] = BusinessMessagesDeleted.de_json( data.get("deleted_business_messages"), bot ) + data["purchased_paid_media"] = PaidMediaPurchased.de_json( + data.get("purchased_paid_media"), bot + ) return super().de_json(data=data, bot=bot) diff --git a/telegram/_user.py b/telegram/_user.py index 7ea769f28b6..f70decde82c 100644 --- a/telegram/_user.py +++ b/telegram/_user.py @@ -18,8 +18,9 @@ # 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 User.""" -from datetime import datetime -from typing import TYPE_CHECKING, Optional, Sequence, Tuple, Union +import datetime as dtm +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional, Union from telegram._inline.inlinekeyboardbutton import InlineKeyboardButton from telegram._menubutton import MenuButton @@ -35,6 +36,7 @@ Audio, Contact, Document, + Gift, InlineKeyboardMarkup, InputMediaAudio, InputMediaDocument, @@ -97,6 +99,10 @@ class User(TelegramObject): :meth:`telegram.Bot.get_me`. .. versionadded:: 21.1 + has_main_web_app (:obj:`bool`, optional): :obj:`True`, if the bot has the main Web App. + Returned only in :meth:`telegram.Bot.get_me`. + + .. versionadded:: 21.5 Attributes: id (:obj:`int`): Unique identifier for this user or bot. @@ -124,6 +130,11 @@ class User(TelegramObject): :meth:`telegram.Bot.get_me`. .. versionadded:: 21.1 + has_main_web_app (:obj:`bool`) Optional. :obj:`True`, if the bot has the main Web App. + Returned only in :meth:`telegram.Bot.get_me`. + + .. versionadded:: 21.5 + .. |user_chat_id_note| replace:: This shortcuts build on the assumption that :attr:`User.id` coincides with the :attr:`Chat.id` of the private chat with the user. This has been the case so far, but Telegram does not guarantee that this stays this way. @@ -135,6 +146,7 @@ class User(TelegramObject): "can_join_groups", "can_read_all_group_messages", "first_name", + "has_main_web_app", "id", "is_bot", "is_premium", @@ -158,6 +170,7 @@ def __init__( is_premium: Optional[bool] = None, added_to_attachment_menu: Optional[bool] = None, can_connect_to_business: Optional[bool] = None, + has_main_web_app: Optional[bool] = None, *, api_kwargs: Optional[JSONDict] = None, ): @@ -176,6 +189,7 @@ def __init__( self.is_premium: Optional[bool] = is_premium self.added_to_attachment_menu: Optional[bool] = added_to_attachment_menu self.can_connect_to_business: Optional[bool] = can_connect_to_business + self.has_main_web_app: Optional[bool] = has_main_web_app self._id_attrs = (self.id,) @@ -301,6 +315,7 @@ async def pin_message( self, message_id: int, disable_notification: ODVInput[bool] = DEFAULT_NONE, + business_connection_id: Optional[str] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, write_timeout: ODVInput[float] = DEFAULT_NONE, @@ -329,12 +344,14 @@ async def pin_message( write_timeout=write_timeout, connect_timeout=connect_timeout, pool_timeout=pool_timeout, + business_connection_id=business_connection_id, api_kwargs=api_kwargs, ) async def unpin_message( self, message_id: Optional[int] = None, + business_connection_id: Optional[str] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, write_timeout: ODVInput[float] = DEFAULT_NONE, @@ -363,6 +380,7 @@ async def unpin_message( pool_timeout=pool_timeout, api_kwargs=api_kwargs, message_id=message_id, + business_connection_id=business_connection_id, ) async def unpin_all_messages( @@ -410,6 +428,7 @@ async def send_message( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, disable_web_page_preview: Optional[bool] = None, @@ -454,6 +473,7 @@ async def send_message( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def delete_message( @@ -534,6 +554,7 @@ async def send_photo( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -580,6 +601,7 @@ async def send_photo( has_spoiler=has_spoiler, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -594,6 +616,7 @@ async def send_media_group( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -605,7 +628,7 @@ async def send_media_group( caption: Optional[str] = None, parse_mode: ODVInput[str] = DEFAULT_NONE, caption_entities: Optional[Sequence["MessageEntity"]] = None, - ) -> Tuple["Message", ...]: + ) -> tuple["Message", ...]: """Shortcut for:: await bot.send_media_group(update.effective_user.id, *args, **kwargs) @@ -616,7 +639,7 @@ async def send_media_group( |user_chat_id_note| Returns: - Tuple[:class:`telegram.Message`:] On success, a tuple of :class:`~telegram.Message` + tuple[:class:`telegram.Message`:] On success, a tuple of :class:`~telegram.Message` instances that were sent is returned. """ @@ -639,6 +662,7 @@ async def send_media_group( caption_entities=caption_entities, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_audio( @@ -658,6 +682,7 @@ async def send_audio( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -706,6 +731,7 @@ async def send_audio( thumbnail=thumbnail, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_chat_action( @@ -761,6 +787,7 @@ async def send_contact( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -805,6 +832,7 @@ async def send_contact( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_dice( @@ -817,6 +845,7 @@ async def send_dice( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -856,6 +885,7 @@ async def send_dice( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_document( @@ -873,6 +903,7 @@ async def send_document( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -919,6 +950,7 @@ async def send_document( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_game( @@ -931,6 +963,7 @@ async def send_game( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -970,6 +1003,7 @@ async def send_game( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_invoice( @@ -1001,6 +1035,7 @@ async def send_invoice( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1069,6 +1104,7 @@ async def send_invoice( protect_content=protect_content, message_thread_id=message_thread_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_location( @@ -1086,6 +1122,7 @@ async def send_location( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1132,6 +1169,7 @@ async def send_location( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_animation( @@ -1152,6 +1190,7 @@ async def send_animation( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -1202,6 +1241,7 @@ async def send_animation( thumbnail=thumbnail, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -1216,6 +1256,7 @@ async def send_sticker( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1256,6 +1297,7 @@ async def send_sticker( emoji=emoji, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_video( @@ -1277,6 +1319,7 @@ async def send_video( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -1328,6 +1371,7 @@ async def send_video( has_spoiler=has_spoiler, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -1348,6 +1392,7 @@ async def send_venue( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1396,6 +1441,7 @@ async def send_venue( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_video_note( @@ -1411,6 +1457,7 @@ async def send_video_note( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1455,6 +1502,7 @@ async def send_video_note( thumbnail=thumbnail, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_voice( @@ -1471,6 +1519,7 @@ async def send_voice( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1516,6 +1565,7 @@ async def send_voice( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_poll( @@ -1532,7 +1582,7 @@ async def send_poll( explanation: Optional[str] = None, explanation_parse_mode: ODVInput[str] = DEFAULT_NONE, open_period: Optional[int] = None, - close_date: Optional[Union[int, datetime]] = None, + close_date: Optional[Union[int, dtm.datetime]] = None, explanation_entities: Optional[Sequence["MessageEntity"]] = None, protect_content: ODVInput[bool] = DEFAULT_NONE, message_thread_id: Optional[int] = None, @@ -1541,6 +1591,7 @@ async def send_poll( question_parse_mode: ODVInput[str] = DEFAULT_NONE, question_entities: Optional[Sequence["MessageEntity"]] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1593,6 +1644,44 @@ async def send_poll( question_parse_mode=question_parse_mode, question_entities=question_entities, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, + ) + + async def send_gift( + self, + gift_id: Union[str, "Gift"], + text: Optional[str] = None, + text_parse_mode: ODVInput[str] = DEFAULT_NONE, + text_entities: Optional[Sequence["MessageEntity"]] = None, + *, + read_timeout: ODVInput[float] = DEFAULT_NONE, + write_timeout: ODVInput[float] = DEFAULT_NONE, + connect_timeout: ODVInput[float] = DEFAULT_NONE, + pool_timeout: ODVInput[float] = DEFAULT_NONE, + api_kwargs: Optional[JSONDict] = None, + ) -> bool: + """Shortcut for:: + + await bot.send_gift( user_id=update.effective_user.id, *args, **kwargs ) + + For the documentation of the arguments, please see :meth:`telegram.Bot.send_gift`. + + .. versionadded:: 21.8 + + Returns: + :obj:`bool`: On success, :obj:`True` is returned. + """ + return await self.get_bot().send_gift( + user_id=self.id, + gift_id=gift_id, + text=text, + text_parse_mode=text_parse_mode, + text_entities=text_entities, + read_timeout=read_timeout, + write_timeout=write_timeout, + connect_timeout=connect_timeout, + pool_timeout=pool_timeout, + api_kwargs=api_kwargs, ) async def send_copy( @@ -1608,6 +1697,7 @@ async def send_copy( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, show_caption_above_media: Optional[bool] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1650,6 +1740,7 @@ async def send_copy( protect_content=protect_content, message_thread_id=message_thread_id, show_caption_above_media=show_caption_above_media, + allow_paid_broadcast=allow_paid_broadcast, ) async def copy_message( @@ -1665,6 +1756,7 @@ async def copy_message( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, show_caption_above_media: Optional[bool] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1707,6 +1799,7 @@ async def copy_message( protect_content=protect_content, message_thread_id=message_thread_id, show_caption_above_media=show_caption_above_media, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_copies( @@ -1723,7 +1816,7 @@ async def send_copies( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["MessageId", ...]: + ) -> tuple["MessageId", ...]: """Shortcut for:: await bot.copy_messages(chat_id=update.effective_user.id, *argss, **kwargs) @@ -1735,7 +1828,7 @@ async def send_copies( .. versionadded:: 20.8 Returns: - Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` + tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` of the sent messages is returned. """ @@ -1768,7 +1861,7 @@ async def copy_messages( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["MessageId", ...]: + ) -> tuple["MessageId", ...]: """Shortcut for:: await bot.copy_messages(from_chat_id=update.effective_user.id, *argss, **kwargs) @@ -1780,7 +1873,7 @@ async def copy_messages( .. versionadded:: 20.8 Returns: - Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` + tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` of the sent messages is returned. """ @@ -1897,7 +1990,7 @@ async def forward_messages_from( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["MessageId", ...]: + ) -> tuple["MessageId", ...]: """Shortcut for:: await bot.forward_messages(chat_id=update.effective_user.id, *argss, **kwargs) @@ -1909,7 +2002,7 @@ async def forward_messages_from( .. versionadded:: 20.8 Returns: - Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` + tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` of sent messages is returned. """ @@ -1940,7 +2033,7 @@ async def forward_messages_to( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["MessageId", ...]: + ) -> tuple["MessageId", ...]: """Shortcut for:: await bot.forward_messages(from_chat_id=update.effective_user.id, *argss, **kwargs) @@ -1952,7 +2045,7 @@ async def forward_messages_to( .. versionadded:: 20.8 Returns: - Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` + tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` of sent messages is returned. """ diff --git a/telegram/_userprofilephotos.py b/telegram/_userprofilephotos.py index 9a5e4a066ef..c7355bb8723 100644 --- a/telegram/_userprofilephotos.py +++ b/telegram/_userprofilephotos.py @@ -17,7 +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/]. """This module contains an object that represents a Telegram UserProfilePhotos.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._files.photosize import PhotoSize from telegram._telegramobject import TelegramObject @@ -43,7 +44,7 @@ class UserProfilePhotos(TelegramObject): Attributes: total_count (:obj:`int`): Total number of profile pictures. - photos (Tuple[Tuple[:class:`telegram.PhotoSize`]]): Requested profile pictures (in up to 4 + photos (tuple[tuple[:class:`telegram.PhotoSize`]]): Requested profile pictures (in up to 4 sizes each). .. versionchanged:: 20.0 @@ -63,7 +64,7 @@ def __init__( super().__init__(api_kwargs=api_kwargs) # Required self.total_count: int = total_count - self.photos: Tuple[Tuple[PhotoSize, ...], ...] = tuple(tuple(sizes) for sizes in photos) + self.photos: tuple[tuple[PhotoSize, ...], ...] = tuple(tuple(sizes) for sizes in photos) self._id_attrs = (self.total_count, self.photos) diff --git a/telegram/_utils/argumentparsing.py b/telegram/_utils/argumentparsing.py index c3613ecdd9c..22485512ff4 100644 --- a/telegram/_utils/argumentparsing.py +++ b/telegram/_utils/argumentparsing.py @@ -23,7 +23,8 @@ user. Changes to this module are not considered breaking changes and may not be documented in the changelog. """ -from typing import Optional, Sequence, Tuple, TypeVar +from collections.abc import Sequence +from typing import Optional, TypeVar from telegram._linkpreviewoptions import LinkPreviewOptions from telegram._utils.types import ODVInput @@ -31,7 +32,7 @@ T = TypeVar("T") -def parse_sequence_arg(arg: Optional[Sequence[T]]) -> Tuple[T, ...]: +def parse_sequence_arg(arg: Optional[Sequence[T]]) -> tuple[T, ...]: """Parses an optional sequence into a tuple Args: diff --git a/telegram/_utils/entities.py b/telegram/_utils/entities.py index a3994cd0426..c97560e8f5a 100644 --- a/telegram/_utils/entities.py +++ b/telegram/_utils/entities.py @@ -23,9 +23,11 @@ user. Changes to this module are not considered breaking changes and may not be documented in the changelog. """ -from typing import Dict, Optional, Sequence +from collections.abc import Sequence +from typing import Optional from telegram._messageentity import MessageEntity +from telegram._utils.strings import TextEncoding def parse_message_entity(text: str, entity: MessageEntity) -> str: @@ -38,15 +40,15 @@ def parse_message_entity(text: str, entity: MessageEntity) -> str: Returns: :obj:`str`: The text of the given entity. """ - entity_text = text.encode("utf-16-le") + entity_text = text.encode(TextEncoding.UTF_16_LE) entity_text = entity_text[entity.offset * 2 : (entity.offset + entity.length) * 2] - return entity_text.decode("utf-16-le") + return entity_text.decode(TextEncoding.UTF_16_LE) def parse_message_entities( text: str, entities: Sequence[MessageEntity], types: Optional[Sequence[str]] = None -) -> Dict[MessageEntity, str]: +) -> dict[MessageEntity, str]: """ Returns a :obj:`dict` that maps :class:`telegram.MessageEntity` to :obj:`str`. It contains entities filtered by their ``type`` attribute as @@ -54,13 +56,13 @@ def parse_message_entities( Args: text (:obj:`str`): The text to extract the entity from. - entities (List[:class:`telegram.MessageEntity`]): The entities to extract the text from. - types (List[:obj:`str`], optional): List of ``MessageEntity`` types as strings. If the + entities (list[:class:`telegram.MessageEntity`]): The entities to extract the text from. + types (list[:obj:`str`], optional): List of ``MessageEntity`` types as strings. If the ``type`` attribute of an entity is contained in this list, it will be returned. Defaults to :attr:`telegram.MessageEntity.ALL_TYPES`. Returns: - Dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to + dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to the text that belongs to them, calculated based on UTF-16 codepoints. """ if types is None: diff --git a/telegram/_utils/enum.py b/telegram/_utils/enum.py index 20a045c02fe..2f0e77b9b2c 100644 --- a/telegram/_utils/enum.py +++ b/telegram/_utils/enum.py @@ -25,14 +25,14 @@ """ import enum as _enum import sys -from typing import Type, TypeVar, Union +from typing import TypeVar, Union _A = TypeVar("_A") _B = TypeVar("_B") _Enum = TypeVar("_Enum", bound=_enum.Enum) -def get_member(enum_cls: Type[_Enum], value: _A, default: _B) -> Union[_Enum, _A, _B]: +def get_member(enum_cls: type[_Enum], value: _A, default: _B) -> Union[_Enum, _A, _B]: """Tries to call ``enum_cls(value)`` to convert the value into an enumeration member. If that fails, the ``default`` is returned. """ @@ -74,3 +74,17 @@ def __repr__(self) -> str: def __str__(self) -> str: return str(self.value) + + +class FloatEnum(float, _enum.Enum): + """Helper class for float enums where ``str(member)`` prints the value, but ``repr(member)`` + gives ``EnumName.MEMBER_NAME``. + """ + + __slots__ = () + + def __repr__(self) -> str: + return f"<{self.__class__.__name__}.{self.name}>" + + def __str__(self) -> str: + return str(self.value) diff --git a/telegram/_utils/files.py b/telegram/_utils/files.py index 387743025ee..7f7e29fc15c 100644 --- a/telegram/_utils/files.py +++ b/telegram/_utils/files.py @@ -29,7 +29,7 @@ """ from pathlib import Path -from typing import IO, TYPE_CHECKING, Any, Optional, Tuple, Type, TypeVar, Union, cast, overload +from typing import IO, TYPE_CHECKING, Any, Optional, TypeVar, Union, cast, overload from telegram._utils.types import FileInput, FilePathInput @@ -40,16 +40,16 @@ @overload -def load_file(obj: IO[bytes]) -> Tuple[Optional[str], bytes]: ... +def load_file(obj: IO[bytes]) -> tuple[Optional[str], bytes]: ... @overload -def load_file(obj: _T) -> Tuple[None, _T]: ... +def load_file(obj: _T) -> tuple[None, _T]: ... def load_file( obj: Optional[FileInput], -) -> Tuple[Optional[str], Union[bytes, "InputFile", str, Path, None]]: +) -> tuple[Optional[str], Union[bytes, "InputFile", str, Path, None]]: """If the input is a file handle, read the data and name and return it. Otherwise, return the input unchanged. """ @@ -61,14 +61,21 @@ def load_file( except AttributeError: return None, cast(Union[bytes, "InputFile", str, Path], obj) - if hasattr(obj, "name") and not isinstance(obj.name, int): - filename = Path(obj.name).name - else: - filename = None + filename = guess_file_name(obj) return filename, contents +def guess_file_name(obj: FileInput) -> Optional[str]: + """If the input is a file handle, read name and return it. Otherwise, return + the input unchanged. + """ + if hasattr(obj, "name") and not isinstance(obj.name, int): + return Path(obj.name).name + + return None + + def is_local_file(obj: Optional[FilePathInput]) -> bool: """ Checks if a given string is a file on local system. @@ -88,7 +95,7 @@ def is_local_file(obj: Optional[FilePathInput]) -> bool: def parse_file_input( # pylint: disable=too-many-return-statements file_input: Union[FileInput, "TelegramObject"], - tg_type: Optional[Type["TelegramObject"]] = None, + tg_type: Optional[type["TelegramObject"]] = None, filename: Optional[str] = None, attach: bool = False, local_mode: bool = False, @@ -110,8 +117,8 @@ def parse_file_input( # pylint: disable=too-many-return-statements attribute. Args: - file_input (:obj:`str` | :obj:`bytes` | :term:`file object` | Telegram media object): The - input to parse. + file_input (:obj:`str` | :obj:`bytes` | :term:`file object` | :class:`~telegram.InputFile`\ + | Telegram media object): The input to parse. tg_type (:obj:`type`, optional): The Telegram media type the input can be. E.g. :class:`telegram.Animation`. filename (:obj:`str`, optional): The filename. Only relevant in case an diff --git a/telegram/_utils/strings.py b/telegram/_utils/strings.py index dc044e86420..9c386247eca 100644 --- a/telegram/_utils/strings.py +++ b/telegram/_utils/strings.py @@ -24,6 +24,23 @@ the changelog. """ +from telegram._utils.enum import StringEnum + +# TODO: Remove this when https://github.com/PyCQA/pylint/issues/6887 is resolved. +# pylint: disable=invalid-enum-extension,invalid-slots + + +class TextEncoding(StringEnum): + """This enum contains encoding schemes for text. + + .. versionadded:: 21.5 + """ + + __slots__ = () + + UTF_8 = "utf-8" + UTF_16_LE = "utf-16-le" + def to_camel_case(snake_str: str) -> str: """Converts a snake_case string to camelCase. diff --git a/telegram/_utils/types.py b/telegram/_utils/types.py index efde2807f2b..f9748773222 100644 --- a/telegram/_utils/types.py +++ b/telegram/_utils/types.py @@ -23,19 +23,9 @@ user. Changes to this module are not considered breaking changes and may not be documented in the changelog. """ +from collections.abc import Collection from pathlib import Path -from typing import ( - IO, - TYPE_CHECKING, - Any, - Collection, - Dict, - Literal, - Optional, - Tuple, - TypeVar, - Union, -) +from typing import IO, TYPE_CHECKING, Any, Literal, Optional, TypeVar, Union if TYPE_CHECKING: from telegram import ( @@ -57,7 +47,7 @@ """Valid input for passing files to Telegram. Either a file id as string, a file like object, a local file path as string, :class:`pathlib.Path` or the file contents as :obj:`bytes`.""" -JSONDict = Dict[str, Any] +JSONDict = dict[str, Any] """Dictionary containing response from Telegram or data to send to the API.""" DVValueType = TypeVar("DVValueType") # pylint: disable=invalid-name @@ -82,9 +72,9 @@ .. versionadded:: 20.0 """ -FieldTuple = Tuple[str, bytes, str] +FieldTuple = tuple[str, Union[bytes, IO[bytes]], str] """Alias for return type of `InputFile.field_tuple`.""" -UploadFileDict = Dict[str, FieldTuple] +UploadFileDict = dict[str, FieldTuple] """Dictionary containing file data to be uploaded to the API.""" HTTPVersion = Literal["1.1", "2.0", "2"] @@ -97,7 +87,7 @@ MarkdownVersion = Literal[1, 2] SocketOpt = Union[ - Tuple[int, int, int], - Tuple[int, int, Union[bytes, bytearray]], - Tuple[int, int, None, int], + tuple[int, int, int], + tuple[int, int, Union[bytes, bytearray]], + tuple[int, int, None, int], ] diff --git a/telegram/_utils/warnings.py b/telegram/_utils/warnings.py index dcc3fc150d9..2ddb2317d79 100644 --- a/telegram/_utils/warnings.py +++ b/telegram/_utils/warnings.py @@ -26,14 +26,14 @@ the changelog. """ import warnings -from typing import Type, Union +from typing import Union from telegram.warnings import PTBUserWarning def warn( message: Union[str, PTBUserWarning], - category: Type[Warning] = PTBUserWarning, + category: type[Warning] = PTBUserWarning, stacklevel: int = 0, ) -> None: """ @@ -48,7 +48,7 @@ def warn( .. versionchanged:: 21.2 Now also accepts a :obj:`PTBUserWarning` instance. - category (:obj:`Type[Warning]`, optional): Specify the Warning class to pass to + category (:obj:`type[Warning]`, optional): Specify the Warning class to pass to ``warnings.warn()``. Defaults to :class:`telegram.warnings.PTBUserWarning`. stacklevel (:obj:`int`, optional): Specify the stacklevel to pass to ``warnings.warn()``. Pass the same value as you'd pass directly to ``warnings.warn()``. Defaults to ``0``. diff --git a/telegram/_utils/warnings_transition.py b/telegram/_utils/warnings_transition.py index a135ee5e648..43bb6c225aa 100644 --- a/telegram/_utils/warnings_transition.py +++ b/telegram/_utils/warnings_transition.py @@ -23,7 +23,7 @@ .. versionadded:: 20.2 """ -from typing import Any, Callable, Type, Union +from typing import Any, Callable, Union from telegram._utils.warnings import warn from telegram.warnings import PTBDeprecationWarning, PTBUserWarning @@ -56,7 +56,7 @@ def warn_about_deprecated_arg_return_new_arg( bot_api_version: str, ptb_version: str, stacklevel: int = 2, - warn_callback: Callable[[Union[str, PTBUserWarning], Type[Warning], int], None] = warn, + warn_callback: Callable[[Union[str, PTBUserWarning], type[Warning], int], None] = warn, ) -> Any: """A helper function for the transition in API when argument is renamed. diff --git a/telegram/_version.py b/telegram/_version.py index ec3f5618c21..4b7502703ca 100644 --- a/telegram/_version.py +++ b/telegram/_version.py @@ -51,6 +51,6 @@ def __str__(self) -> str: __version_info__: Final[Version] = Version( - major=21, minor=4, micro=0, releaselevel="final", serial=0 + major=21, minor=9, micro=0, releaselevel="final", serial=0 ) __version__: Final[str] = str(__version_info__) diff --git a/telegram/_videochat.py b/telegram/_videochat.py index b392fa6d65b..916d8f9ef9c 100644 --- a/telegram/_videochat.py +++ b/telegram/_videochat.py @@ -18,7 +18,8 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains objects related to Telegram video chats.""" import datetime as dtm -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._telegramobject import TelegramObject from telegram._user import User @@ -102,7 +103,7 @@ class VideoChatParticipantsInvited(TelegramObject): |sequenceclassargs| Attributes: - users (Tuple[:class:`telegram.User`]): New members that were invited to the video chat. + users (tuple[:class:`telegram.User`]): New members that were invited to the video chat. .. versionchanged:: 20.0 |tupleclassattrs| @@ -118,7 +119,7 @@ def __init__( api_kwargs: Optional[JSONDict] = None, ) -> None: super().__init__(api_kwargs=api_kwargs) - self.users: Tuple[User, ...] = parse_sequence_arg(users) + self.users: tuple[User, ...] = parse_sequence_arg(users) self._id_attrs = (self.users,) self._freeze() diff --git a/telegram/_webhookinfo.py b/telegram/_webhookinfo.py index a6f309a930d..95ae31e510f 100644 --- a/telegram/_webhookinfo.py +++ b/telegram/_webhookinfo.py @@ -17,8 +17,10 @@ # 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 WebhookInfo.""" -from datetime import datetime -from typing import TYPE_CHECKING, Optional, Sequence, Tuple + +import datetime as dtm +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._telegramobject import TelegramObject from telegram._utils.argumentparsing import parse_sequence_arg @@ -59,7 +61,7 @@ class WebhookInfo(TelegramObject): most recent error that happened when trying to deliver an update via webhook. max_connections (:obj:`int`, optional): Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery. - allowed_updates (Sequence[:obj:`str`], optional): A list of update types the bot is + allowed_updates (Sequence[:obj:`str`], optional): A sequence of update types the bot is subscribed to. Defaults to all update types, except :attr:`telegram.Update.chat_member`. @@ -89,7 +91,7 @@ class WebhookInfo(TelegramObject): most recent error that happened when trying to deliver an update via webhook. max_connections (:obj:`int`): Optional. Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery. - allowed_updates (Tuple[:obj:`str`]): Optional. A list of update types the bot is + allowed_updates (tuple[:obj:`str`]): Optional. A tuple of update types the bot is subscribed to. Defaults to all update types, except :attr:`telegram.Update.chat_member`. @@ -124,12 +126,12 @@ def __init__( url: str, has_custom_certificate: bool, pending_update_count: int, - last_error_date: Optional[datetime] = None, + last_error_date: Optional[dtm.datetime] = None, last_error_message: Optional[str] = None, max_connections: Optional[int] = None, allowed_updates: Optional[Sequence[str]] = None, ip_address: Optional[str] = None, - last_synchronization_error_date: Optional[datetime] = None, + last_synchronization_error_date: Optional[dtm.datetime] = None, *, api_kwargs: Optional[JSONDict] = None, ): @@ -141,11 +143,13 @@ def __init__( # Optional self.ip_address: Optional[str] = ip_address - self.last_error_date: Optional[datetime] = last_error_date + self.last_error_date: Optional[dtm.datetime] = last_error_date self.last_error_message: Optional[str] = last_error_message self.max_connections: Optional[int] = max_connections - self.allowed_updates: Tuple[str, ...] = parse_sequence_arg(allowed_updates) - self.last_synchronization_error_date: Optional[datetime] = last_synchronization_error_date + self.allowed_updates: tuple[str, ...] = parse_sequence_arg(allowed_updates) + self.last_synchronization_error_date: Optional[dtm.datetime] = ( + last_synchronization_error_date + ) self._id_attrs = ( self.url, diff --git a/telegram/constants.py b/telegram/constants.py index fb4bc9a19a9..6453cf55d4e 100644 --- a/telegram/constants.py +++ b/telegram/constants.py @@ -54,6 +54,7 @@ "ChatLimit", "ChatMemberStatus", "ChatPhotoSize", + "ChatSubscriptionLimit", "ChatType", "ContactLimit", "CustomEmojiStickerLimit", @@ -63,6 +64,7 @@ "FloodLimit", "ForumIconColor", "ForumTopicLimit", + "GiftLimit", "GiveawayLimit", "InlineKeyboardButtonLimit", "InlineKeyboardMarkupLimit", @@ -93,6 +95,7 @@ "ReactionType", "ReplyLimit", "RevenueWithdrawalStateType", + "StarTransactions", "StarTransactionsLimit", "StickerFormat", "StickerLimit", @@ -104,13 +107,13 @@ "WebhookLimit", ] -import datetime +import datetime as dtm import sys from enum import Enum -from typing import Final, List, NamedTuple, Optional, Tuple +from typing import Final, NamedTuple, Optional from telegram._utils.datetime import UTC -from telegram._utils.enum import IntEnum, StringEnum +from telegram._utils.enum import FloatEnum, IntEnum, StringEnum class _BotAPIVersion(NamedTuple): @@ -140,8 +143,8 @@ class _AccentColor(NamedTuple): identifier: int name: Optional[str] = None - light_colors: Tuple[int, ...] = () - dark_colors: Tuple[int, ...] = () + light_colors: tuple[int, ...] = () + dark_colors: tuple[int, ...] = () #: :class:`typing.NamedTuple`: A tuple containing the two components of the version number: @@ -151,7 +154,7 @@ class _AccentColor(NamedTuple): #: :data:`telegram.__bot_api_version_info__`. #: #: .. versionadded:: 20.0 -BOT_API_VERSION_INFO: Final[_BotAPIVersion] = _BotAPIVersion(major=7, minor=7) +BOT_API_VERSION_INFO: Final[_BotAPIVersion] = _BotAPIVersion(major=8, minor=1) #: :obj:`str`: Telegram Bot API #: version supported by this version of `python-telegram-bot`. Also available as #: :data:`telegram.__bot_api_version__`. @@ -161,15 +164,15 @@ class _AccentColor(NamedTuple): # constants above this line are tested -#: List[:obj:`int`]: Ports supported by +#: list[:obj:`int`]: Ports supported by #: :paramref:`telegram.Bot.set_webhook.url`. -SUPPORTED_WEBHOOK_PORTS: Final[List[int]] = [443, 80, 88, 8443] +SUPPORTED_WEBHOOK_PORTS: Final[list[int]] = [443, 80, 88, 8443] #: :obj:`datetime.datetime`, value of unix 0. #: This date literal is used in :class:`telegram.InaccessibleMessage` #: #: .. versionadded:: 20.8 -ZERO_DATE: Final[datetime.datetime] = datetime.datetime(1970, 1, 1, tzinfo=UTC) +ZERO_DATE: Final[dtm.datetime] = dtm.datetime(1970, 1, 1, tzinfo=UTC) class AccentColor(Enum): @@ -179,9 +182,9 @@ class AccentColor(Enum): - ``identifier`` (:obj:`int`): The identifier of the accent color. - ``name`` (:obj:`str`): Optional. The name of the accent color. - - ``light_colors`` (Tuple[:obj:`str`]): Optional. The light colors of the accent color as HEX + - ``light_colors`` (tuple[:obj:`str`]): Optional. The light colors of the accent color as HEX value. - - ``dark_colors`` (Tuple[:obj:`str`]): Optional. The dark colors of the accent color as HEX + - ``dark_colors`` (tuple[:obj:`str`]): Optional. The dark colors of the accent color as HEX value. Since Telegram gives no exact specification for the accent colors, future accent colors might @@ -551,6 +554,42 @@ class AccentColor(Enum): """ +class BackgroundTypeType(StringEnum): + """This enum contains the available types of :class:`telegram.BackgroundType`. The enum + members of this enumeration are instances of :class:`str` and can be treated as such. + + .. versionadded:: 21.2 + """ + + __slots__ = () + + FILL = "fill" + """:obj:`str`: A :class:`telegram.BackgroundType` with fill background.""" + WALLPAPER = "wallpaper" + """:obj:`str`: A :class:`telegram.BackgroundType` with wallpaper background.""" + PATTERN = "pattern" + """:obj:`str`: A :class:`telegram.BackgroundType` with pattern background.""" + CHAT_THEME = "chat_theme" + """:obj:`str`: A :class:`telegram.BackgroundType` with chat_theme background.""" + + +class BackgroundFillType(StringEnum): + """This enum contains the available types of :class:`telegram.BackgroundFill`. The enum + members of this enumeration are instances of :class:`str` and can be treated as such. + + .. versionadded:: 21.2 + """ + + __slots__ = () + + SOLID = "solid" + """:obj:`str`: A :class:`telegram.BackgroundFill` with solid fill.""" + GRADIENT = "gradient" + """:obj:`str`: A :class:`telegram.BackgroundFill` with gradient fill.""" + FREEFORM_GRADIENT = "freeform_gradient" + """:obj:`str`: A :class:`telegram.BackgroundFill` with freeform_gradient fill.""" + + class BotCommandLimit(IntEnum): """This enum contains limitations for :class:`telegram.BotCommand` and :meth:`telegram.Bot.set_my_commands`. @@ -832,6 +871,25 @@ class ChatLimit(IntEnum): """ +class ChatSubscriptionLimit(IntEnum): + """This enum contains limitations for + :paramref:`telegram.Bot.create_chat_subscription_invite_link.subscription_period` and + :paramref:`telegram.Bot.create_chat_subscription_invite_link.subscription_price`. + The enum members of this enumeration are instances of :class:`int` and can be treated as such. + + .. versionadded:: 21.5 + """ + + __slots__ = () + + SUBSCRIPTION_PERIOD = 2592000 + """:obj:`int`: The number of seconds the subscription will be active.""" + MIN_PRICE = 1 + """:obj:`int`: Amount of stars a user pays, minimum amount the subscription can be set to.""" + MAX_PRICE = 2500 + """:obj:`int`: Amount of stars a user pays, maximum amount the subscription can be set to.""" + + class BackgroundTypeLimit(IntEnum): """This enum contains limitations for :class:`telegram.BackgroundTypeFill`, :class:`telegram.BackgroundTypeWallpaper` and :class:`telegram.BackgroundTypePattern`. @@ -1098,6 +1156,14 @@ class FloodLimit(IntEnum): """:obj:`int`: The number of messages that can roughly be sent to a particular group within one minute. """ + PAID_MESSAGES_PER_SECOND = 1000 + """:obj:`int`: The number of messages that can be sent per second when paying with the bot's + Telegram Star balance. See e.g. parameter + :paramref:`~telegram.Bot.send_message.allow_paid_broadcast` of + :meth:`~telegram.Bot.send_message`. + + .. versionadded:: 21.7 + """ class ForumIconColor(IntEnum): @@ -1160,6 +1226,21 @@ class ForumIconColor(IntEnum): """ +class GiftLimit(IntEnum): + """This enum contains limitations for :meth:`~telegram.Bot.send_gift`. + The enum members of this enumeration are instances of :class:`int` and can be treated as such. + + .. versionadded:: 21.8 + """ + + __slots__ = () + + MAX_TEXT_LENGTH = 255 + """:obj:`int`: Maximum number of characters in a :obj:`str` passed as the + :paramref:`~telegram.Bot.send_gift.text` parameter of :meth:`~telegram.Bot.send_gift`. + """ + + class GiveawayLimit(IntEnum): """This enum contains limitations for :class:`telegram.Giveaway` and related classes. The enum members of this enumeration are instances of :class:`int` and can be treated as such. @@ -1205,15 +1286,23 @@ class InlineKeyboardButtonLimit(IntEnum): __slots__ = () MIN_CALLBACK_DATA = 1 - """:obj:`int`: Minimum value allowed for + """:obj:`int`: Minimum length allowed for :paramref:`~telegram.InlineKeyboardButton.callback_data` parameter of :class:`telegram.InlineKeyboardButton` """ MAX_CALLBACK_DATA = 64 - """:obj:`int`: Maximum value allowed for + """:obj:`int`: Maximum length allowed for :paramref:`~telegram.InlineKeyboardButton.callback_data` parameter of :class:`telegram.InlineKeyboardButton` """ + MIN_COPY_TEXT = 1 + """:obj:`int`: Minimum length allowed for + :paramref:`~telegram.CopyTextButton.text` parameter of :class:`telegram.CopyTextButton` + """ + MAX_COPY_TEXT = 256 + """:obj:`int`: Maximum length allowed for + :paramref:`~telegram.CopyTextButton.text` parameter of :class:`telegram.CopyTextButton` + """ class InlineKeyboardMarkupLimit(IntEnum): @@ -1747,7 +1836,6 @@ class MessageLimit(IntEnum): :paramref:`~telegram.Bot.edit_message_text.text` parameter of :meth:`telegram.Bot.edit_message_text`. """ - # TODO this constant is not used. helpers.py contains 64 as a number DEEP_LINK_LENGTH = 64 """:obj:`int`: Maximum number of characters for a deep link.""" # TODO this constant is not used anywhere @@ -2027,9 +2115,9 @@ class ProfileAccentColor(Enum): - ``identifier`` (:obj:`int`): The identifier of the accent color. - ``name`` (:obj:`str`): Optional. The name of the accent color. - - ``light_colors`` (Tuple[:obj:`str`]): Optional. The light colors of the accent color as HEX + - ``light_colors`` (tuple[:obj:`str`]): Optional. The light colors of the accent color as HEX value. - - ``dark_colors`` (Tuple[:obj:`str`]): Optional. The dark colors of the accent color as HEX + - ``dark_colors`` (tuple[:obj:`str`]): Optional. The dark colors of the accent color as HEX value. Since Telegram gives no exact specification for the accent colors, future accent colors might @@ -2373,8 +2461,25 @@ class RevenueWithdrawalStateType(StringEnum): """:obj:`str`: A withdrawal failed and the transaction was refunded.""" +class StarTransactions(FloatEnum): + """This enum contains constants for :class:`telegram.StarTransaction`. + The enum members of this enumeration are instances of :class:`float` and can be treated as + such. + + .. versionadded:: 21.9 + """ + + __slots__ = () + + NANOSTAR_VALUE = 1 / 1000000000 + """:obj:`float`: The value of one nanostar as used in + :attr:`telegram.StarTransaction.nanostar_amount`. + """ + + class StarTransactionsLimit(IntEnum): - """This enum contains limitations for :class:`telegram.Bot.get_star_transactions`. + """This enum contains limitations for :class:`telegram.Bot.get_star_transactions` and + :class:`telegram.StarTransaction`. The enum members of this enumeration are instances of :class:`int` and can be treated as such. .. versionadded:: 21.4 @@ -2390,6 +2495,20 @@ class StarTransactionsLimit(IntEnum): """:obj:`int`: Maximum value allowed for the :paramref:`~telegram.Bot.get_star_transactions.limit` parameter of :meth:`telegram.Bot.get_star_transactions`.""" + NANOSTAR_MIN_AMOUNT = -999999999 + """:obj:`int`: Minimum value allowed for :paramref:`~telegram.AffiliateInfo.nanostar_amount` + parameter of :class:`telegram.AffiliateInfo`. + + .. versionadded:: 21.9 + """ + NANOSTAR_MAX_AMOUNT = 999999999 + """:obj:`int`: Maximum value allowed for :paramref:`~telegram.StarTransaction.nanostar_amount` + parameter of :class:`telegram.StarTransaction` and + :paramref:`~telegram.AffiliateInfo.nanostar_amount` parameter of + :class:`telegram.AffiliateInfo`. + + .. versionadded:: 21.9 + """ class StickerFormat(StringEnum): @@ -2534,14 +2653,25 @@ class TransactionPartnerType(StringEnum): __slots__ = () + AFFILIATE_PROGRAM = "affiliate_program" + """:obj:`str`: Transaction with Affiliate Program. + + .. versionadded:: 21.9 + """ FRAGMENT = "fragment" """:obj:`str`: Withdrawal transaction with Fragment.""" - USER = "user" - """:obj:`str`: Transaction with a user.""" OTHER = "other" """:obj:`str`: Transaction with unknown source or recipient.""" TELEGRAM_ADS = "telegram_ads" """:obj:`str`: Transaction with Telegram Ads.""" + TELEGRAM_API = "telegram_api" + """:obj:`str`: Transaction with with payment for + `paid broadcasting `_. + + ..versionadded:: 21.7 + """ + USER = "user" + """:obj:`str`: Transaction with a user.""" class ParseMode(StringEnum): @@ -2723,6 +2853,11 @@ class UpdateType(StringEnum): .. versionadded:: 21.1 """ + PURCHASED_PAID_MEDIA = "purchased_paid_media" + """:obj:`str`: Updates with :attr:`telegram.Update.purchased_paid_media`. + + .. versionadded:: 21.6 + """ class InvoiceLimit(IntEnum): @@ -2794,6 +2929,8 @@ class InvoiceLimit(IntEnum): :meth:`telegram.Bot.send_invoice`. * :paramref:`~telegram.Bot.create_invoice_link.payload` parameter of :meth:`telegram.Bot.create_invoice_link`. + * :paramref:`~telegram.Bot.send_paid_media.payload` parameter of + :meth:`telegram.Bot.send_paid_media`. """ MAX_TIP_AMOUNTS = 4 """:obj:`int`: Maximum length of a :obj:`Sequence` passed as: @@ -2803,6 +2940,33 @@ class InvoiceLimit(IntEnum): * :paramref:`~telegram.Bot.create_invoice_link.suggested_tip_amounts` parameter of :meth:`telegram.Bot.create_invoice_link`. """ + MIN_STAR_COUNT = 1 + """:obj:`int`: Minimum amount of starts that must be paid to buy access to a paid media + passed as :paramref:`~telegram.Bot.send_paid_media.star_count` parameter of + :meth:`telegram.Bot.send_paid_media`. + + .. versionadded:: 21.6 + """ + MAX_STAR_COUNT = 2500 + """:obj:`int`: Maximum amount of starts that must be paid to buy access to a paid media + passed as :paramref:`~telegram.Bot.send_paid_media.star_count` parameter of + :meth:`telegram.Bot.send_paid_media`. + + .. versionadded:: 21.6 + """ + SUBSCRIPTION_PERIOD = dtm.timedelta(days=30).total_seconds() + """:obj:`int`: The period of time for which the subscription is active before + the next payment, passed as :paramref:`~telegram.Bot.create_invoice_link.subscription_period` + parameter of :meth:`telegram.Bot.create_invoice_link`. + + .. versionadded:: 21.8 + """ + SUBSCRIPTION_MAX_PRICE = 2500 + """:obj:`int`: The maximum price of a subscription created wtih + :meth:`telegram.Bot.create_invoice_link`. + + .. versionadded:: 21.9 + """ class UserProfilePhotosLimit(IntEnum): @@ -2903,6 +3067,11 @@ class ReactionType(StringEnum): """:obj:`str`: A :class:`telegram.ReactionType` with a normal emoji.""" CUSTOM_EMOJI = "custom_emoji" """:obj:`str`: A :class:`telegram.ReactionType` with a custom emoji.""" + PAID = "paid" + """:obj:`str`: A :class:`telegram.ReactionType` with a paid reaction. + + .. versionadded:: 21.5 + """ class ReactionEmoji(StringEnum): @@ -3060,39 +3229,3 @@ class ReactionEmoji(StringEnum): """:obj:`str`: Woman Shrugging""" POUTING_FACE = "😡" """:obj:`str`: Pouting face""" - - -class BackgroundTypeType(StringEnum): - """This enum contains the available types of :class:`telegram.BackgroundType`. The enum - members of this enumeration are instances of :class:`str` and can be treated as such. - - .. versionadded:: 21.2 - """ - - __slots__ = () - - FILL = "fill" - """:obj:`str`: A :class:`telegram.BackgroundType` with fill background.""" - WALLPAPER = "wallpaper" - """:obj:`str`: A :class:`telegram.BackgroundType` with wallpaper background.""" - PATTERN = "pattern" - """:obj:`str`: A :class:`telegram.BackgroundType` with pattern background.""" - CHAT_THEME = "chat_theme" - """:obj:`str`: A :class:`telegram.BackgroundType` with chat_theme background.""" - - -class BackgroundFillType(StringEnum): - """This enum contains the available types of :class:`telegram.BackgroundFill`. The enum - members of this enumeration are instances of :class:`str` and can be treated as such. - - .. versionadded:: 21.2 - """ - - __slots__ = () - - SOLID = "solid" - """:obj:`str`: A :class:`telegram.BackgroundFill` with solid fill.""" - GRADIENT = "gradient" - """:obj:`str`: A :class:`telegram.BackgroundFill` with gradient fill.""" - FREEFORM_GRADIENT = "freeform_gradient" - """:obj:`str`: A :class:`telegram.BackgroundFill` with freeform_gradient fill.""" diff --git a/telegram/error.py b/telegram/error.py index 6dcc509a8d4..6dae43d0577 100644 --- a/telegram/error.py +++ b/telegram/error.py @@ -36,20 +36,7 @@ "TimedOut", ) -from typing import Optional, Tuple, Union - - -def _lstrip_str(in_s: str, lstr: str) -> str: - """ - Args: - in_s (:obj:`str`): in string - lstr (:obj:`str`): substr to strip from left side - - Returns: - :obj:`str`: The stripped string. - - """ - return in_s[len(lstr) :] if in_s.startswith(lstr) else in_s +from typing import Optional, Union class TelegramError(Exception): @@ -70,9 +57,9 @@ class TelegramError(Exception): def __init__(self, message: str): super().__init__() - msg = _lstrip_str(message, "Error: ") - msg = _lstrip_str(msg, "[Error]: ") - msg = _lstrip_str(msg, "Bad Request: ") + msg = message.removeprefix("Error: ") + msg = msg.removeprefix("[Error]: ") + msg = msg.removeprefix("Bad Request: ") if msg != message: # api_error - capitalize the msg... msg = msg.capitalize() @@ -94,7 +81,7 @@ def __repr__(self) -> str: """ return f"{self.__class__.__name__}('{self.message}')" - def __reduce__(self) -> Tuple[type, Tuple[str]]: + def __reduce__(self) -> tuple[type, tuple[str]]: """Defines how to serialize the exception for pickle. .. seealso:: @@ -209,7 +196,7 @@ def __init__(self, new_chat_id: int): super().__init__(f"Group migrated to supergroup. New chat id: {new_chat_id}") self.new_chat_id: int = new_chat_id - def __reduce__(self) -> Tuple[type, Tuple[int]]: # type: ignore[override] + def __reduce__(self) -> tuple[type, tuple[int]]: # type: ignore[override] return self.__class__, (self.new_chat_id,) @@ -234,7 +221,7 @@ def __init__(self, retry_after: int): super().__init__(f"Flood control exceeded. Retry in {retry_after} seconds") self.retry_after: int = retry_after - def __reduce__(self) -> Tuple[type, Tuple[float]]: # type: ignore[override] + def __reduce__(self) -> tuple[type, tuple[float]]: # type: ignore[override] return self.__class__, (self.retry_after,) @@ -243,7 +230,7 @@ class Conflict(TelegramError): __slots__ = () - def __reduce__(self) -> Tuple[type, Tuple[str]]: + def __reduce__(self) -> tuple[type, tuple[str]]: return self.__class__, (self.message,) @@ -261,5 +248,5 @@ def __init__(self, message: Union[str, Exception]): super().__init__(f"PassportDecryptionError: {message}") self._msg = str(message) - def __reduce__(self) -> Tuple[type, Tuple[str]]: + def __reduce__(self) -> tuple[type, tuple[str]]: return self.__class__, (self._msg,) diff --git a/telegram/ext/__init__.py b/telegram/ext/__init__.py index 82dbd1c19ad..432f742abf2 100644 --- a/telegram/ext/__init__.py +++ b/telegram/ext/__init__.py @@ -48,6 +48,7 @@ "JobQueue", "MessageHandler", "MessageReactionHandler", + "PaidMediaPurchasedHandler", "PersistenceInput", "PicklePersistence", "PollAnswerHandler", @@ -89,6 +90,7 @@ from ._handlers.inlinequeryhandler import InlineQueryHandler from ._handlers.messagehandler import MessageHandler from ._handlers.messagereactionhandler import MessageReactionHandler +from ._handlers.paidmediapurchasedhandler import PaidMediaPurchasedHandler from ._handlers.pollanswerhandler import PollAnswerHandler from ._handlers.pollhandler import PollHandler from ._handlers.precheckoutqueryhandler import PreCheckoutQueryHandler diff --git a/telegram/ext/_aioratelimiter.py b/telegram/ext/_aioratelimiter.py index 714bbc63f61..e619819eac8 100644 --- a/telegram/ext/_aioratelimiter.py +++ b/telegram/ext/_aioratelimiter.py @@ -22,7 +22,8 @@ import asyncio import contextlib import sys -from typing import Any, AsyncIterator, Callable, Coroutine, Dict, List, Optional, Union +from collections.abc import AsyncIterator, Coroutine +from typing import Any, Callable, Optional, Union try: from aiolimiter import AsyncLimiter @@ -87,6 +88,19 @@ class AIORateLimiter(BaseRateLimiter[int]): necessary in some cases, e.g. the bot may hit a rate limit in one group but might still be allowed to send messages in another group. + Tip: + With `Bot API 7.1 `_ + (PTB v27.1), Telegram introduced the parameter + :paramref:`~telegram.Bot.send_message.allow_paid_broadcast`. + This allows bots to send up to + :tg-const:`telegram.constants.FloodLimit.PAID_MESSAGES_PER_SECOND` messages per second by + paying a fee in Telegram Stars. + + .. caution:: + This class currently doesn't take the + :paramref:`~telegram.Bot.send_message.allow_paid_broadcast` parameter into account. + This means that the rate limiting is applied just like for any other message. + Note: This class is to be understood as minimal effort reference implementation. If you would like to handle rate limiting in a more sophisticated, fine-tuned way, we @@ -152,7 +166,7 @@ def __init__( self._group_max_rate = 0 self._group_time_period = 0 - self._group_limiters: Dict[Union[str, int], AsyncLimiter] = {} + self._group_limiters: dict[Union[str, int], AsyncLimiter] = {} self._max_retries: int = max_retries self._retry_after_event = asyncio.Event() self._retry_after_event.set() @@ -187,10 +201,10 @@ async def _run_request( self, chat: bool, group: Union[str, int, bool], - callback: Callable[..., Coroutine[Any, Any, Union[bool, JSONDict, List[JSONDict]]]], + callback: Callable[..., Coroutine[Any, Any, Union[bool, JSONDict, list[JSONDict]]]], args: Any, - kwargs: Dict[str, Any], - ) -> Union[bool, JSONDict, List[JSONDict]]: + kwargs: dict[str, Any], + ) -> Union[bool, JSONDict, list[JSONDict]]: base_context = self._base_limiter if (chat and self._base_limiter) else null_context() group_context = ( self._get_group_limiter(group) if group and self._group_max_rate else null_context() @@ -205,13 +219,13 @@ async def _run_request( # mypy doesn't understand that the last run of the for loop raises an exception async def process_request( self, - callback: Callable[..., Coroutine[Any, Any, Union[bool, JSONDict, List[JSONDict]]]], + callback: Callable[..., Coroutine[Any, Any, Union[bool, JSONDict, list[JSONDict]]]], args: Any, - kwargs: Dict[str, Any], + kwargs: dict[str, Any], endpoint: str, # noqa: ARG002 - data: Dict[str, Any], + data: dict[str, Any], rate_limit_args: Optional[int], - ) -> Union[bool, JSONDict, List[JSONDict]]: + ) -> Union[bool, JSONDict, list[JSONDict]]: """ Processes a request by applying rate limiting. @@ -250,7 +264,7 @@ async def process_request( _LOGGER.exception( "Rate limit hit after maximum of %d retries", max_retries, exc_info=exc ) - raise exc + raise sleep = exc.retry_after + 0.1 _LOGGER.info("Rate limit hit. Retrying after %f seconds", sleep) diff --git a/telegram/ext/_application.py b/telegram/ext/_application.py index 670793c9909..eab3e5f1e2d 100644 --- a/telegram/ext/_application.py +++ b/telegram/ext/_application.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/]. """This module contains the Application class.""" + import asyncio import contextlib import inspect @@ -25,31 +26,11 @@ import signal import sys from collections import defaultdict +from collections.abc import Awaitable, Coroutine, Generator, Mapping, Sequence from copy import deepcopy from pathlib import Path from types import MappingProxyType, TracebackType -from typing import ( - TYPE_CHECKING, - Any, - AsyncContextManager, - Awaitable, - Callable, - Coroutine, - DefaultDict, - Dict, - Generator, - Generic, - List, - Mapping, - NoReturn, - Optional, - Sequence, - Set, - Tuple, - Type, - TypeVar, - Union, -) +from typing import TYPE_CHECKING, Any, Callable, Generic, NoReturn, Optional, TypeVar, Union from telegram._update import Update from telegram._utils.defaultvalue import ( @@ -132,7 +113,10 @@ def __init__(self, state: Optional[object] = None) -> None: self.state: Optional[object] = state -class Application(Generic[BT, CCT, UD, CD, BD, JQ], AsyncContextManager["Application"]): +class Application( + Generic[BT, CCT, UD, CD, BD, JQ], + contextlib.AbstractAsyncContextManager["Application"], +): """This class dispatches all kinds of updates to its registered handlers, and is the entry point to a PTB application. @@ -224,12 +208,12 @@ class Application(Generic[BT, CCT, UD, CD, BD, JQ], AsyncContextManager["Applica bot_data (:obj:`dict`): A dictionary handlers can use to store data for the bot. persistence (:class:`telegram.ext.BasePersistence`): The persistence class to store data that should be persistent over restarts. - handlers (Dict[:obj:`int`, List[:class:`telegram.ext.BaseHandler`]]): A dictionary mapping + handlers (dict[:obj:`int`, list[:class:`telegram.ext.BaseHandler`]]): A dictionary mapping each handler group to the list of handlers registered to that group. .. seealso:: :meth:`add_handler`, :meth:`add_handlers`. - error_handlers (Dict[:term:`coroutine function`, :obj:`bool`]): A dictionary where the keys + error_handlers (dict[:term:`coroutine function`, :obj:`bool`]): A dictionary where the keys are error handlers and the values indicate whether they are to be run blocking. .. seealso:: @@ -323,8 +307,8 @@ def __init__( self.update_queue: asyncio.Queue[object] = update_queue self.context_types: ContextTypes[CCT, UD, CD, BD] = context_types self.updater: Optional[Updater] = updater - self.handlers: Dict[int, List[BaseHandler[Any, CCT]]] = {} - self.error_handlers: Dict[ + self.handlers: dict[int, list[BaseHandler[Any, CCT, Any]]] = {} + self.error_handlers: dict[ HandlerCallback[object, CCT, None], Union[bool, DefaultValue[bool]] ] = {} self.post_init: Optional[ @@ -338,8 +322,8 @@ def __init__( ] = post_stop self._update_processor = update_processor self.bot_data: BD = self.context_types.bot_data() - self._user_data: DefaultDict[int, UD] = defaultdict(self.context_types.user_data) - self._chat_data: DefaultDict[int, CD] = defaultdict(self.context_types.chat_data) + self._user_data: defaultdict[int, UD] = defaultdict(self.context_types.user_data) + self._chat_data: defaultdict[int, CD] = defaultdict(self.context_types.chat_data) # Read only mapping self.user_data: Mapping[int, UD] = MappingProxyType(self._user_data) self.chat_data: Mapping[int, CD] = MappingProxyType(self._chat_data) @@ -350,14 +334,14 @@ def __init__( self.persistence = persistence # Some bookkeeping for persistence logic - self._chat_ids_to_be_updated_in_persistence: Set[int] = set() - self._user_ids_to_be_updated_in_persistence: Set[int] = set() - self._chat_ids_to_be_deleted_in_persistence: Set[int] = set() - self._user_ids_to_be_deleted_in_persistence: Set[int] = set() + self._chat_ids_to_be_updated_in_persistence: set[int] = set() + self._user_ids_to_be_updated_in_persistence: set[int] = set() + self._chat_ids_to_be_deleted_in_persistence: set[int] = set() + self._user_ids_to_be_deleted_in_persistence: set[int] = set() # This attribute will hold references to the conversation dicts of all conversation # handlers so that we can extract the changed states during `update_persistence` - self._conversation_handler_conversations: Dict[ + self._conversation_handler_conversations: dict[ str, TrackingDict[ConversationKey, object] ] = {} @@ -369,7 +353,7 @@ def __init__( self.__update_persistence_task: Optional[asyncio.Task] = None self.__update_persistence_event = asyncio.Event() self.__update_persistence_lock = asyncio.Lock() - self.__create_task_tasks: Set[asyncio.Task] = set() # Used for awaiting tasks upon exit + self.__create_task_tasks: set[asyncio.Task] = set() # Used for awaiting tasks upon exit self.__stop_running_marker = asyncio.Event() async def __aenter__(self: _AppType) -> _AppType: # noqa: PYI019 @@ -384,14 +368,14 @@ async def __aenter__(self: _AppType) -> _AppType: # noqa: PYI019 """ try: await self.initialize() - return self - except Exception as exc: + except Exception: await self.shutdown() - raise exc + raise + return self async def __aexit__( self, - exc_type: Optional[Type[BaseException]], + exc_type: Optional[type[BaseException]], exc_val: Optional[BaseException], exc_tb: Optional[TracebackType], ) -> None: @@ -646,9 +630,9 @@ async def start(self) -> None: ) _LOGGER.info("Application started") - except Exception as exc: + except Exception: self._running = False - raise exc + raise async def stop(self) -> None: """Stops the process after processing any pending updates or tasks created by @@ -762,7 +746,7 @@ def run_polling( write_timeout: ODVInput[float] = DEFAULT_NONE, connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, - allowed_updates: Optional[List[str]] = None, + allowed_updates: Optional[Sequence[str]] = None, drop_pending_updates: Optional[bool] = None, close_loop: bool = True, stop_signals: ODVInput[Sequence[int]] = DEFAULT_NONE, @@ -839,8 +823,11 @@ def run_polling( :meth:`telegram.ext.ApplicationBuilder.get_updates_pool_timeout`. drop_pending_updates (:obj:`bool`, optional): Whether to clean any pending updates on Telegram servers before actually starting to poll. Default is :obj:`False`. - allowed_updates (List[:obj:`str`], optional): Passed to + allowed_updates (Sequence[:obj:`str`], optional): Passed to :meth:`telegram.Bot.get_updates`. + + .. versionchanged:: 21.9 + Accepts any :class:`collections.abc.Sequence` as input instead of just a list close_loop (:obj:`bool`, optional): If :obj:`True`, the current event loop will be closed upon shutdown. Defaults to :obj:`True`. @@ -904,7 +891,7 @@ def run_webhook( key: Optional[Union[str, Path]] = None, bootstrap_retries: int = 0, webhook_url: Optional[str] = None, - allowed_updates: Optional[List[str]] = None, + allowed_updates: Optional[Sequence[str]] = None, drop_pending_updates: Optional[bool] = None, ip_address: Optional[str] = None, max_connections: int = 40, @@ -970,8 +957,11 @@ def run_webhook( webhook_url (:obj:`str`, optional): Explicitly specify the webhook url. Useful behind NAT, reverse proxy, etc. Default is derived from :paramref:`listen`, :paramref:`port`, :paramref:`url_path`, :paramref:`cert`, and :paramref:`key`. - allowed_updates (List[:obj:`str`], optional): Passed to + allowed_updates (Sequence[:obj:`str`], optional): Passed to :meth:`telegram.Bot.set_webhook`. + + .. versionchanged:: 21.9 + Accepts any :class:`collections.abc.Sequence` as input instead of just a list drop_pending_updates (:obj:`bool`, optional): Whether to clean any pending updates on Telegram servers before actually starting to poll. Default is :obj:`False`. ip_address (:obj:`str`, optional): Passed to :meth:`telegram.Bot.set_webhook`. @@ -1227,7 +1217,7 @@ async def __create_task_callback( await self.process_error(update=update, error=exception, coroutine=coroutine) # Raise exception so that it can be set on the task and retrieved by task.exception() - raise exception + raise finally: self._mark_for_persistence_update(update=update) @@ -1352,7 +1342,7 @@ async def process_update(self, update: object) -> None: # (in __create_task_callback) self._mark_for_persistence_update(update=update) - def add_handler(self, handler: BaseHandler[Any, CCT], group: int = DEFAULT_GROUP) -> None: + def add_handler(self, handler: BaseHandler[Any, CCT, Any], group: int = DEFAULT_GROUP) -> None: """Register a handler. TL;DR: Order and priority counts. 0 or 1 handlers per group will be used. End handling of @@ -1420,8 +1410,8 @@ def add_handler(self, handler: BaseHandler[Any, CCT], group: int = DEFAULT_GROUP def add_handlers( self, handlers: Union[ - Union[List[BaseHandler[Any, CCT]], Tuple[BaseHandler[Any, CCT]]], - Dict[int, Union[List[BaseHandler[Any, CCT]], Tuple[BaseHandler[Any, CCT]]]], + Sequence[BaseHandler[Any, CCT, Any]], + dict[int, Sequence[BaseHandler[Any, CCT, Any]]], ], group: Union[int, DefaultValue[int]] = _DEFAULT_0, ) -> None: @@ -1431,10 +1421,15 @@ def add_handlers( .. versionadded:: 20.0 Args: - handlers (List[:class:`telegram.ext.BaseHandler`] | \ - Dict[int, List[:class:`telegram.ext.BaseHandler`]]): \ + handlers (Sequence[:class:`telegram.ext.BaseHandler`] | \ + dict[int, Sequence[:class:`telegram.ext.BaseHandler`]]): Specify a sequence of handlers *or* a dictionary where the keys are groups and values are handlers. + + .. versionchanged:: 21.7 + Accepts any :class:`collections.abc.Sequence` as input instead of just a list + or tuple. + group (:obj:`int`, optional): Specify which group the sequence of :paramref:`handlers` should be added to. Defaults to ``0``. @@ -1445,29 +1440,35 @@ def add_handlers( 1: [CallbackQueryHandler(...), CommandHandler(...)] } + Raises: + :exc:`TypeError`: If the combination of arguments is invalid. """ if isinstance(handlers, dict) and not isinstance(group, DefaultValue): - raise ValueError("The `group` argument can only be used with a sequence of handlers.") + raise TypeError("The `group` argument can only be used with a sequence of handlers.") if isinstance(handlers, dict): for handler_group, grp_handlers in handlers.items(): - if not isinstance(grp_handlers, (list, tuple)): - raise ValueError(f"Handlers for group {handler_group} must be a list or tuple") + if not isinstance(grp_handlers, Sequence): + raise TypeError( + f"Handlers for group {handler_group} must be a sequence of handlers." + ) for handler in grp_handlers: self.add_handler(handler, handler_group) - elif isinstance(handlers, (list, tuple)): + elif isinstance(handlers, Sequence): for handler in handlers: self.add_handler(handler, DefaultValue.get_value(group)) else: - raise ValueError( + raise TypeError( "The `handlers` argument must be a sequence of handlers or a " "dictionary where the keys are groups and values are sequences of handlers." ) - def remove_handler(self, handler: BaseHandler[Any, CCT], group: int = DEFAULT_GROUP) -> None: + def remove_handler( + self, handler: BaseHandler[Any, CCT, Any], group: int = DEFAULT_GROUP + ) -> None: """Remove a handler from the specified group. Args: @@ -1644,9 +1645,10 @@ async def _persistence_updater(self) -> None: self.__update_persistence_event.wait(), timeout=self.persistence.update_interval, ) - return except asyncio.TimeoutError: pass + else: + return # putting this *after* the wait_for so we don't immediately update on startup as # that would make little sense @@ -1681,7 +1683,7 @@ async def __update_persistence(self) -> None: _LOGGER.debug("Starting next run of updating the persistence.") - coroutines: Set[Coroutine] = set() + coroutines: set[Coroutine] = set() # Mypy doesn't know that persistence.set_bot (see above) already checks that # self.bot is an instance of ExtBot if callback_data should be stored ... diff --git a/telegram/ext/_applicationbuilder.py b/telegram/ext/_applicationbuilder.py index a54d491614b..f4bfee761e1 100644 --- a/telegram/ext/_applicationbuilder.py +++ b/telegram/ext/_applicationbuilder.py @@ -18,20 +18,9 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the Builder classes for the telegram.ext module.""" from asyncio import Queue +from collections.abc import Collection, Coroutine from pathlib import Path -from typing import ( - TYPE_CHECKING, - Any, - Callable, - Collection, - Coroutine, - Dict, - Generic, - Optional, - Type, - TypeVar, - Union, -) +from typing import TYPE_CHECKING, Any, Callable, Generic, Optional, TypeVar, Union import httpx @@ -207,13 +196,13 @@ def __init__(self: "InitApplicationBuilder"): self._job_queue: ODVInput[JobQueue] = DefaultValue(JobQueue()) except RuntimeError as exc: if "PTB must be installed via" not in str(exc): - raise exc + raise self._job_queue = DEFAULT_NONE self._persistence: ODVInput[BasePersistence] = DEFAULT_NONE self._context_types: DVType[ContextTypes] = DefaultValue(ContextTypes()) - self._application_class: DVType[Type[Application]] = DefaultValue(Application) - self._application_kwargs: Dict[str, object] = {} + self._application_class: DVType[type[Application]] = DefaultValue(Application) + self._application_kwargs: dict[str, object] = {} self._update_processor: BaseUpdateProcessor = SimpleUpdateProcessor( max_concurrent_updates=1 ) @@ -350,8 +339,8 @@ def build( def application_class( self: BuilderType, - application_class: Type[Application[Any, Any, Any, Any, Any, Any]], - kwargs: Optional[Dict[str, object]] = None, + application_class: type[Application[Any, Any, Any, Any, Any, Any]], + kwargs: Optional[dict[str, object]] = None, ) -> BuilderType: """Sets a custom subclass instead of :class:`telegram.ext.Application`. The subclass's ``__init__`` should look like this @@ -365,7 +354,7 @@ def __init__(self, custom_arg_1, custom_arg_2, ..., **kwargs): Args: application_class (:obj:`type`): A subclass of :class:`telegram.ext.Application` - kwargs (Dict[:obj:`str`, :obj:`object`], optional): Keyword arguments for the + kwargs (dict[:obj:`str`, :obj:`object`], optional): Keyword arguments for the initialization. Defaults to an empty dict. Returns: @@ -1397,9 +1386,9 @@ def rate_limiter( ApplicationBuilder[ # by Pylance correctly. ExtBot[None], ContextTypes.DEFAULT_TYPE, - Dict[Any, Any], - Dict[Any, Any], - Dict[Any, Any], + dict[Any, Any], + dict[Any, Any], + dict[Any, Any], JobQueue[ContextTypes.DEFAULT_TYPE], ] ) diff --git a/telegram/ext/_basepersistence.py b/telegram/ext/_basepersistence.py index 126437a0a48..9f919b14a79 100644 --- a/telegram/ext/_basepersistence.py +++ b/telegram/ext/_basepersistence.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the BasePersistence class.""" from abc import ABC, abstractmethod -from typing import Dict, Generic, NamedTuple, NoReturn, Optional +from typing import Generic, NamedTuple, NoReturn, Optional from telegram._bot import Bot from telegram.ext._extbot import ExtBot @@ -184,7 +184,7 @@ def set_bot(self, bot: Bot) -> None: self.bot = bot @abstractmethod - async def get_user_data(self) -> Dict[int, UD]: + async def get_user_data(self) -> dict[int, UD]: """Will be called by :class:`telegram.ext.Application` upon creation with a persistence object. It should return the ``user_data`` if stored, or an empty :obj:`dict`. In the latter case, the dictionary should produce values @@ -198,12 +198,12 @@ async def get_user_data(self) -> Dict[int, UD]: This method may now return a :obj:`dict` instead of a :obj:`collections.defaultdict` Returns: - Dict[:obj:`int`, :obj:`dict` | :attr:`telegram.ext.ContextTypes.user_data`]: + dict[:obj:`int`, :obj:`dict` | :attr:`telegram.ext.ContextTypes.user_data`]: The restored user data. """ @abstractmethod - async def get_chat_data(self) -> Dict[int, CD]: + async def get_chat_data(self) -> dict[int, CD]: """Will be called by :class:`telegram.ext.Application` upon creation with a persistence object. It should return the ``chat_data`` if stored, or an empty :obj:`dict`. In the latter case, the dictionary should produce values @@ -217,7 +217,7 @@ async def get_chat_data(self) -> Dict[int, CD]: This method may now return a :obj:`dict` instead of a :obj:`collections.defaultdict` Returns: - Dict[:obj:`int`, :obj:`dict` | :attr:`telegram.ext.ContextTypes.chat_data`]: + dict[:obj:`int`, :obj:`dict` | :attr:`telegram.ext.ContextTypes.chat_data`]: The restored chat data. """ @@ -233,7 +233,7 @@ async def get_bot_data(self) -> BD: if :class:`telegram.ext.ContextTypes` are used. Returns: - Dict[:obj:`int`, :obj:`dict` | :attr:`telegram.ext.ContextTypes.bot_data`]: + dict[:obj:`int`, :obj:`dict` | :attr:`telegram.ext.ContextTypes.bot_data`]: The restored bot data. """ @@ -248,8 +248,8 @@ async def get_callback_data(self) -> Optional[CDCData]: Changed this method into an :external:func:`~abc.abstractmethod`. Returns: - Tuple[List[Tuple[:obj:`str`, :obj:`float`, Dict[:obj:`str`, :class:`object`]]], - Dict[:obj:`str`, :obj:`str`]] | :obj:`None`: The restored metadata or :obj:`None`, + tuple[list[tuple[:obj:`str`, :obj:`float`, dict[:obj:`str`, :class:`object`]]], + dict[:obj:`str`, :obj:`str`]] | :obj:`None`: The restored metadata or :obj:`None`, if no data was stored. """ @@ -324,8 +324,8 @@ async def update_callback_data(self, data: CDCData) -> None: Changed this method into an :external:func:`~abc.abstractmethod`. Args: - data (Tuple[List[Tuple[:obj:`str`, :obj:`float`, \ - Dict[:obj:`str`, :obj:`Any`]]], Dict[:obj:`str`, :obj:`str`]] | :obj:`None`): + data (tuple[list[tuple[:obj:`str`, :obj:`float`, \ + dict[:obj:`str`, :obj:`Any`]]], dict[:obj:`str`, :obj:`str`]] | :obj:`None`): The relevant data to restore :class:`telegram.ext.CallbackDataCache`. """ diff --git a/telegram/ext/_baseratelimiter.py b/telegram/ext/_baseratelimiter.py index 3d7a6afb1e5..df2478f2bc9 100644 --- a/telegram/ext/_baseratelimiter.py +++ b/telegram/ext/_baseratelimiter.py @@ -18,7 +18,8 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains a class that allows to rate limit requests to the Bot API.""" from abc import ABC, abstractmethod -from typing import Any, Callable, Coroutine, Dict, Generic, List, Optional, Union +from collections.abc import Coroutine +from typing import Any, Callable, Generic, Optional, Union from telegram._utils.types import JSONDict from telegram.ext._utils.types import RLARGS @@ -56,13 +57,13 @@ async def shutdown(self) -> None: @abstractmethod async def process_request( self, - callback: Callable[..., Coroutine[Any, Any, Union[bool, JSONDict, List[JSONDict]]]], + callback: Callable[..., Coroutine[Any, Any, Union[bool, JSONDict, list[JSONDict]]]], args: Any, - kwargs: Dict[str, Any], + kwargs: dict[str, Any], endpoint: str, - data: Dict[str, Any], + data: dict[str, Any], rate_limit_args: Optional[RLARGS], - ) -> Union[bool, JSONDict, List[JSONDict]]: + ) -> Union[bool, JSONDict, list[JSONDict]]: """ Process a request. Must be implemented by a subclass. @@ -107,13 +108,13 @@ async def process_request( Args: callback (Callable[..., :term:`coroutine`]): The coroutine function that must be called to make the request. - args (Tuple[:obj:`object`]): The positional arguments for the :paramref:`callback` + args (tuple[:obj:`object`]): The positional arguments for the :paramref:`callback` function. - kwargs (Dict[:obj:`str`, :obj:`object`]): The keyword arguments for the + kwargs (dict[:obj:`str`, :obj:`object`]): The keyword arguments for the :paramref:`callback` function. endpoint (:obj:`str`): The endpoint that the request is made for, e.g. ``"sendMessage"``. - data (Dict[:obj:`str`, :obj:`object`]): The parameters that were passed to the method + data (dict[:obj:`str`, :obj:`object`]): The parameters that were passed to the method of :class:`~telegram.ext.ExtBot`. Any ``api_kwargs`` are included in this and any :paramref:`~telegram.ext.ExtBot.defaults` are already applied. @@ -136,6 +137,6 @@ async def process_request( the request. Returns: - :obj:`bool` | Dict[:obj:`str`, :obj:`object`] | :obj:`None`: The result of the + :obj:`bool` | dict[:obj:`str`, :obj:`object`] | :obj:`None`: The result of the callback function. """ diff --git a/telegram/ext/_baseupdateprocessor.py b/telegram/ext/_baseupdateprocessor.py index 89d51d96fc2..38228b6c81e 100644 --- a/telegram/ext/_baseupdateprocessor.py +++ b/telegram/ext/_baseupdateprocessor.py @@ -19,13 +19,17 @@ """This module contains the BaseProcessor class.""" from abc import ABC, abstractmethod from asyncio import BoundedSemaphore +from contextlib import AbstractAsyncContextManager from types import TracebackType -from typing import Any, AsyncContextManager, Awaitable, Optional, Type, TypeVar, final +from typing import TYPE_CHECKING, Any, Optional, TypeVar, final + +if TYPE_CHECKING: + from collections.abc import Awaitable _BUPT = TypeVar("_BUPT", bound="BaseUpdateProcessor") -class BaseUpdateProcessor(AsyncContextManager["BaseUpdateProcessor"], ABC): +class BaseUpdateProcessor(AbstractAsyncContextManager["BaseUpdateProcessor"], ABC): """An abstract base class for update processors. You can use this class to implement your own update processor. @@ -81,14 +85,14 @@ async def __aenter__(self: _BUPT) -> _BUPT: # noqa: PYI019 """ try: await self.initialize() - return self - except Exception as exc: + except Exception: await self.shutdown() - raise exc + raise + return self async def __aexit__( self, - exc_type: Optional[Type[BaseException]], + exc_type: Optional[type[BaseException]], exc_val: Optional[BaseException], exc_tb: Optional[TracebackType], ) -> None: diff --git a/telegram/ext/_callbackcontext.py b/telegram/ext/_callbackcontext.py index 92113bae9a4..4a2bc6eb6f0 100644 --- a/telegram/ext/_callbackcontext.py +++ b/telegram/ext/_callbackcontext.py @@ -17,20 +17,10 @@ # 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 CallbackContext class.""" -from typing import ( - TYPE_CHECKING, - Any, - Awaitable, - Dict, - Generator, - Generic, - List, - Match, - NoReturn, - Optional, - Type, - Union, -) + +from collections.abc import Awaitable, Generator +from re import Match +from typing import TYPE_CHECKING, Any, Generic, NoReturn, Optional, TypeVar, Union from telegram._callbackquery import CallbackQuery from telegram._update import Update @@ -49,6 +39,9 @@ "/wiki/Storing-bot%2C-user-and-chat-related-data" ) +# something like poor mans "typing.Self" for py<3.11 +ST = TypeVar("ST", bound="CallbackContext[Any, Any, Any, Any]") + class CallbackContext(Generic[BT, UD, CD, BD]): """ @@ -101,11 +94,11 @@ class CallbackContext(Generic[BT, UD, CD, BD]): coroutine (:term:`awaitable`): Optional. Only present in error handlers if the error was caused by an awaitable run with :meth:`Application.create_task` or a handler callback with :attr:`block=False `. - matches (List[:meth:`re.Match `]): Optional. If the associated update + matches (list[:meth:`re.Match `]): Optional. If the associated update originated from a :class:`filters.Regex`, this will contain a list of match objects for every pattern where ``re.search(pattern, string)`` returned a match. Note that filters short circuit, so combined regex filters will not always be evaluated. - args (List[:obj:`str`]): Optional. Arguments passed to a command if the associated update + args (list[:obj:`str`]): Optional. Arguments passed to a command if the associated update is handled by :class:`telegram.ext.CommandHandler`, :class:`telegram.ext.PrefixHandler` or :class:`telegram.ext.StringCommandHandler`. It contains a list of the words in the text after the command, using any whitespace string as a delimiter. @@ -133,24 +126,24 @@ class CallbackContext(Generic[BT, UD, CD, BD]): ) def __init__( - self: "CCT", - application: "Application[BT, CCT, UD, CD, BD, Any]", + self: ST, + application: "Application[BT, ST, UD, CD, BD, Any]", chat_id: Optional[int] = None, user_id: Optional[int] = None, ): - self._application: Application[BT, CCT, UD, CD, BD, Any] = application + self._application: Application[BT, ST, UD, CD, BD, Any] = application self._chat_id: Optional[int] = chat_id self._user_id: Optional[int] = user_id - self.args: Optional[List[str]] = None - self.matches: Optional[List[Match[str]]] = None + self.args: Optional[list[str]] = None + self.matches: Optional[list[Match[str]]] = None self.error: Optional[Exception] = None - self.job: Optional[Job[CCT]] = None + self.job: Optional[Job[Any]] = None self.coroutine: Optional[ Union[Generator[Optional[Future[object]], None, Any], Awaitable[Any]] ] = None @property - def application(self) -> "Application[BT, CCT, UD, CD, BD, Any]": + def application(self) -> "Application[BT, ST, UD, CD, BD, Any]": """:class:`telegram.ext.Application`: The application associated with this context.""" return self._application @@ -272,11 +265,13 @@ def drop_callback_data(self, callback_query: CallbackQuery) -> None: ) self.bot.callback_data_cache.drop_data(callback_query) else: - raise RuntimeError("telegram.Bot does not allow for arbitrary callback data.") + raise RuntimeError( # noqa: TRY004 + "telegram.Bot does not allow for arbitrary callback data." + ) @classmethod def from_error( - cls: Type["CCT"], + cls: type["CCT"], update: object, error: Exception, application: "Application[BT, CCT, UD, CD, BD, Any]", @@ -329,7 +324,7 @@ def from_error( @classmethod def from_update( - cls: Type["CCT"], + cls: type["CCT"], update: object, application: "Application[Any, CCT, Any, Any, Any, Any]", ) -> "CCT": @@ -359,7 +354,7 @@ def from_update( @classmethod def from_job( - cls: Type["CCT"], + cls: type["CCT"], job: "Job[CCT]", application: "Application[Any, CCT, Any, Any, Any, Any]", ) -> "CCT": @@ -381,11 +376,11 @@ def from_job( self.job = job return self - def update(self, data: Dict[str, object]) -> None: + def update(self, data: dict[str, object]) -> None: """Updates ``self.__slots__`` with the passed data. Args: - data (Dict[:obj:`str`, :obj:`object`]): The data. + data (dict[:obj:`str`, :obj:`object`]): The data. """ for key, value in data.items(): setattr(self, key, value) @@ -396,7 +391,7 @@ def bot(self) -> BT: return self._application.bot @property - def job_queue(self) -> Optional["JobQueue[CCT]"]: + def job_queue(self) -> Optional["JobQueue[ST]"]: """ :class:`telegram.ext.JobQueue`: The :class:`JobQueue` used by the :class:`telegram.ext.Application`. diff --git a/telegram/ext/_callbackdatacache.py b/telegram/ext/_callbackdatacache.py index 150f3f055b0..c639dfe71bb 100644 --- a/telegram/ext/_callbackdatacache.py +++ b/telegram/ext/_callbackdatacache.py @@ -17,9 +17,10 @@ # 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 CallbackDataCache class.""" +import datetime as dtm import time -from datetime import datetime -from typing import TYPE_CHECKING, Any, Dict, MutableMapping, Optional, Tuple, Union, cast +from collections.abc import MutableMapping +from typing import TYPE_CHECKING, Any, Optional, Union, cast from uuid import uuid4 try: @@ -70,7 +71,7 @@ def __init__(self, callback_data: Optional[str] = None) -> None: ) self.callback_data: Optional[str] = callback_data - def __reduce__(self) -> Tuple[type, Tuple[Optional[str]]]: # type: ignore[override] + def __reduce__(self) -> tuple[type, tuple[Optional[str]]]: # type: ignore[override] """Defines how to serialize the exception for pickle. See :py:meth:`object.__reduce__` for more info. @@ -87,7 +88,7 @@ def __init__( self, keyboard_uuid: str, access_time: Optional[float] = None, - button_data: Optional[Dict[str, object]] = None, + button_data: Optional[dict[str, object]] = None, ): self.keyboard_uuid = keyboard_uuid self.button_data = button_data or {} @@ -97,7 +98,7 @@ def update_access_time(self) -> None: """Updates the access time with the current time.""" self.access_time = time.time() - def to_tuple(self) -> Tuple[str, float, Dict[str, object]]: + def to_tuple(self) -> tuple[str, float, dict[str, object]]: """Gives a tuple representation consisting of the keyboard uuid, the access time and the button data. """ @@ -140,8 +141,8 @@ class CallbackDataCache: maxsize (:obj:`int`, optional): Maximum number of items in each of the internal mappings. Defaults to ``1024``. - persistent_data (Tuple[List[Tuple[:obj:`str`, :obj:`float`, \ - Dict[:obj:`str`, :class:`object`]]], Dict[:obj:`str`, :obj:`str`]], optional): \ + persistent_data (tuple[list[tuple[:obj:`str`, :obj:`float`, \ + dict[:obj:`str`, :class:`object`]]], dict[:obj:`str`, :obj:`str`]], optional): \ Data to initialize the cache with, as returned by \ :meth:`telegram.ext.BasePersistence.get_callback_data`. @@ -181,8 +182,8 @@ def load_persistence_data(self, persistent_data: CDCData) -> None: .. versionadded:: 20.0 Args: - persistent_data (Tuple[List[Tuple[:obj:`str`, :obj:`float`, \ - Dict[:obj:`str`, :class:`object`]]], Dict[:obj:`str`, :obj:`str`]], optional): \ + persistent_data (tuple[list[tuple[:obj:`str`, :obj:`float`, \ + dict[:obj:`str`, :class:`object`]]], dict[:obj:`str`, :obj:`str`]], optional): \ Data to load, as returned by \ :meth:`telegram.ext.BasePersistence.get_callback_data`. """ @@ -205,8 +206,8 @@ def maxsize(self) -> int: @property def persistence_data(self) -> CDCData: - """Tuple[List[Tuple[:obj:`str`, :obj:`float`, Dict[:obj:`str`, :class:`object`]]], - Dict[:obj:`str`, :obj:`str`]]: The data that needs to be persisted to allow + """tuple[list[tuple[:obj:`str`, :obj:`float`, dict[:obj:`str`, :class:`object`]]], + dict[:obj:`str`, :obj:`str`]]: The data that needs to be persisted to allow caching callback data across bot reboots. """ # While building a list/dict from the LRUCaches has linear runtime (in the number of @@ -269,7 +270,7 @@ def __put_button(callback_data: object, keyboard_data: _KeyboardData) -> str: def __get_keyboard_uuid_and_button_data( self, callback_data: str - ) -> Union[Tuple[str, object], Tuple[None, InvalidCallbackData]]: + ) -> Union[tuple[str, object], tuple[None, InvalidCallbackData]]: keyboard, button = self.extract_uuids(callback_data) try: # we get the values before calling update() in case KeyErrors are raised @@ -278,12 +279,12 @@ def __get_keyboard_uuid_and_button_data( button_data = keyboard_data.button_data[button] # Update the timestamp for the LRU keyboard_data.update_access_time() - return keyboard, button_data except KeyError: return None, InvalidCallbackData(callback_data) + return keyboard, button_data @staticmethod - def extract_uuids(callback_data: str) -> Tuple[str, str]: + def extract_uuids(callback_data: str) -> tuple[str, str]: """Extracts the keyboard uuid and the button uuid from the given :paramref:`callback_data`. Args: @@ -430,15 +431,15 @@ def __drop_keyboard(self, keyboard_uuid: str) -> None: with contextlib.suppress(KeyError): self._keyboard_data.pop(keyboard_uuid) - def clear_callback_data(self, time_cutoff: Optional[Union[float, datetime]] = None) -> None: + def clear_callback_data( + self, time_cutoff: Optional[Union[float, dtm.datetime]] = None + ) -> None: """Clears the stored callback data. Args: time_cutoff (:obj:`float` | :obj:`datetime.datetime`, optional): Pass a UNIX timestamp or a :obj:`datetime.datetime` to clear only entries which are older. - For timezone naive :obj:`datetime.datetime` objects, the default timezone of the - bot will be used, which is UTC unless :attr:`telegram.ext.Defaults.tzinfo` is - used. + |tz-naive-dtms| """ self.__clear(self._keyboard_data, time_cutoff=time_cutoff) @@ -448,13 +449,13 @@ def clear_callback_queries(self) -> None: self.__clear(self._callback_queries) def __clear( - self, mapping: MutableMapping, time_cutoff: Optional[Union[float, datetime]] = None + self, mapping: MutableMapping, time_cutoff: Optional[Union[float, dtm.datetime]] = None ) -> None: if not time_cutoff: mapping.clear() return - if isinstance(time_cutoff, datetime): + if isinstance(time_cutoff, dtm.datetime): effective_cutoff = to_float_timestamp( time_cutoff, tzinfo=self.bot.defaults.tzinfo if self.bot.defaults else None ) diff --git a/telegram/ext/_contexttypes.py b/telegram/ext/_contexttypes.py index ea1065112cb..03495531d24 100644 --- a/telegram/ext/_contexttypes.py +++ b/telegram/ext/_contexttypes.py @@ -17,13 +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 the auxiliary class ContextTypes.""" -from typing import Any, Dict, Generic, Type, overload +from typing import Any, Generic, overload from telegram.ext._callbackcontext import CallbackContext from telegram.ext._extbot import ExtBot from telegram.ext._utils.types import BD, CCT, CD, UD -ADict = Dict[Any, Any] +ADict = dict[Any, Any] class ContextTypes(Generic[CCT, UD, CD, BD]): @@ -83,112 +83,112 @@ def __init__( ): ... @overload - def __init__(self: "ContextTypes[CCT, ADict, ADict, ADict]", context: Type[CCT]): ... + def __init__(self: "ContextTypes[CCT, ADict, ADict, ADict]", context: type[CCT]): ... @overload def __init__( self: "ContextTypes[CallbackContext[ExtBot[Any], UD, ADict, ADict], UD, ADict, ADict]", - user_data: Type[UD], + user_data: type[UD], ): ... @overload def __init__( self: "ContextTypes[CallbackContext[ExtBot[Any], ADict, CD, ADict], ADict, CD, ADict]", - chat_data: Type[CD], + chat_data: type[CD], ): ... @overload def __init__( self: "ContextTypes[CallbackContext[ExtBot[Any], ADict, ADict, BD], ADict, ADict, BD]", - bot_data: Type[BD], + bot_data: type[BD], ): ... @overload def __init__( - self: "ContextTypes[CCT, UD, ADict, ADict]", context: Type[CCT], user_data: Type[UD] + self: "ContextTypes[CCT, UD, ADict, ADict]", context: type[CCT], user_data: type[UD] ): ... @overload def __init__( - self: "ContextTypes[CCT, ADict, CD, ADict]", context: Type[CCT], chat_data: Type[CD] + self: "ContextTypes[CCT, ADict, CD, ADict]", context: type[CCT], chat_data: type[CD] ): ... @overload def __init__( - self: "ContextTypes[CCT, ADict, ADict, BD]", context: Type[CCT], bot_data: Type[BD] + self: "ContextTypes[CCT, ADict, ADict, BD]", context: type[CCT], bot_data: type[BD] ): ... @overload def __init__( self: "ContextTypes[CallbackContext[ExtBot[Any], UD, CD, ADict], UD, CD, ADict]", - user_data: Type[UD], - chat_data: Type[CD], + user_data: type[UD], + chat_data: type[CD], ): ... @overload def __init__( self: "ContextTypes[CallbackContext[ExtBot[Any], UD, ADict, BD], UD, ADict, BD]", - user_data: Type[UD], - bot_data: Type[BD], + user_data: type[UD], + bot_data: type[BD], ): ... @overload def __init__( self: "ContextTypes[CallbackContext[ExtBot[Any], ADict, CD, BD], ADict, CD, BD]", - chat_data: Type[CD], - bot_data: Type[BD], + chat_data: type[CD], + bot_data: type[BD], ): ... @overload def __init__( self: "ContextTypes[CCT, UD, CD, ADict]", - context: Type[CCT], - user_data: Type[UD], - chat_data: Type[CD], + context: type[CCT], + user_data: type[UD], + chat_data: type[CD], ): ... @overload def __init__( self: "ContextTypes[CCT, UD, ADict, BD]", - context: Type[CCT], - user_data: Type[UD], - bot_data: Type[BD], + context: type[CCT], + user_data: type[UD], + bot_data: type[BD], ): ... @overload def __init__( self: "ContextTypes[CCT, ADict, CD, BD]", - context: Type[CCT], - chat_data: Type[CD], - bot_data: Type[BD], + context: type[CCT], + chat_data: type[CD], + bot_data: type[BD], ): ... @overload def __init__( self: "ContextTypes[CallbackContext[ExtBot[Any], UD, CD, BD], UD, CD, BD]", - user_data: Type[UD], - chat_data: Type[CD], - bot_data: Type[BD], + user_data: type[UD], + chat_data: type[CD], + bot_data: type[BD], ): ... @overload def __init__( self: "ContextTypes[CCT, UD, CD, BD]", - context: Type[CCT], - user_data: Type[UD], - chat_data: Type[CD], - bot_data: Type[BD], + context: type[CCT], + user_data: type[UD], + chat_data: type[CD], + bot_data: type[BD], ): ... def __init__( # type: ignore[misc] self, - context: "Type[CallbackContext[ExtBot[Any], ADict, ADict, ADict]]" = CallbackContext, - bot_data: Type[ADict] = dict, - chat_data: Type[ADict] = dict, - user_data: Type[ADict] = dict, + context: "type[CallbackContext[ExtBot[Any], ADict, ADict, ADict]]" = CallbackContext, + bot_data: type[ADict] = dict, + chat_data: type[ADict] = dict, + user_data: type[ADict] = dict, ): if not issubclass(context, CallbackContext): - raise ValueError("context must be a subclass of CallbackContext.") + raise TypeError("context must be a subclass of CallbackContext.") # We make all those only accessible via properties because we don't currently support # changing this at runtime, so overriding the attributes doesn't make sense @@ -198,28 +198,28 @@ def __init__( # type: ignore[misc] self._user_data = user_data @property - def context(self) -> Type[CCT]: + def context(self) -> type[CCT]: """The type of the ``context`` argument of all (error-)handler callbacks and job callbacks. """ return self._context # type: ignore[return-value] @property - def bot_data(self) -> Type[BD]: + def bot_data(self) -> type[BD]: """The type of :attr:`context.bot_data ` of all (error-)handler callbacks and job callbacks. """ return self._bot_data # type: ignore[return-value] @property - def chat_data(self) -> Type[CD]: + def chat_data(self) -> type[CD]: """The type of :attr:`context.chat_data ` of all (error-)handler callbacks and job callbacks. """ return self._chat_data # type: ignore[return-value] @property - def user_data(self) -> Type[UD]: + def user_data(self) -> type[UD]: """The type of :attr:`context.user_data ` of all (error-)handler callbacks and job callbacks. """ diff --git a/telegram/ext/_defaults.py b/telegram/ext/_defaults.py index 100d54e6ef0..886b6383594 100644 --- a/telegram/ext/_defaults.py +++ b/telegram/ext/_defaults.py @@ -17,8 +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/]. """This module contains the class Defaults, which allows passing default values to Application.""" -import datetime -from typing import Any, Dict, NoReturn, Optional, final +import datetime as dtm +from typing import Any, NoReturn, Optional, final from telegram import LinkPreviewOptions from telegram._utils.datetime import UTC @@ -134,7 +134,7 @@ def __init__( disable_notification: Optional[bool] = None, disable_web_page_preview: Optional[bool] = None, quote: Optional[bool] = None, - tzinfo: datetime.tzinfo = UTC, + tzinfo: dtm.tzinfo = UTC, block: bool = True, allow_sending_without_reply: Optional[bool] = None, protect_content: Optional[bool] = None, @@ -144,7 +144,7 @@ def __init__( self._parse_mode: Optional[str] = parse_mode self._disable_notification: Optional[bool] = disable_notification self._allow_sending_without_reply: Optional[bool] = allow_sending_without_reply - self._tzinfo: datetime.tzinfo = tzinfo + self._tzinfo: dtm.tzinfo = tzinfo self._block: bool = block self._protect_content: Optional[bool] = protect_content @@ -188,6 +188,7 @@ def __init__( "explanation_parse_mode", "link_preview_options", "parse_mode", + "text_parse_mode", "protect_content", "question_parse_mode", ): @@ -228,7 +229,7 @@ def __eq__(self, other: object) -> bool: return False @property - def api_defaults(self) -> Dict[str, Any]: # skip-cq: PY-D0003 + def api_defaults(self) -> dict[str, Any]: # skip-cq: PY-D0003 return self._api_defaults @property @@ -271,7 +272,8 @@ def quote_parse_mode(self, _: object) -> NoReturn: @property def text_parse_mode(self) -> Optional[str]: """:obj:`str`: Optional. Alias for :attr:`parse_mode`, used for - the corresponding parameter of :class:`telegram.InputPollOption`. + the corresponding parameter of :class:`telegram.InputPollOption` and + :meth:`telegram.Bot.send_gift`. .. versionadded:: 21.2 """ @@ -356,7 +358,7 @@ def quote(self, _: object) -> NoReturn: raise AttributeError("You can not assign a new value to quote after initialization.") @property - def tzinfo(self) -> datetime.tzinfo: + def tzinfo(self) -> dtm.tzinfo: """:obj:`tzinfo`: A timezone to be used for all date(time) objects appearing throughout PTB. """ diff --git a/telegram/ext/_dictpersistence.py b/telegram/ext/_dictpersistence.py index d046561a253..1efce417e30 100644 --- a/telegram/ext/_dictpersistence.py +++ b/telegram/ext/_dictpersistence.py @@ -19,7 +19,7 @@ """This module contains the DictPersistence class.""" import json from copy import deepcopy -from typing import TYPE_CHECKING, Any, Dict, Optional, cast +from typing import TYPE_CHECKING, Any, Optional, cast from telegram.ext import BasePersistence, PersistenceInput from telegram.ext._utils.types import CDCData, ConversationDict, ConversationKey @@ -28,7 +28,7 @@ from telegram._utils.types import JSONDict -class DictPersistence(BasePersistence[Dict[Any, Any], Dict[Any, Any], Dict[Any, Any]]): +class DictPersistence(BasePersistence[dict[Any, Any], dict[Any, Any], dict[Any, Any]]): """Using Python's :obj:`dict` and :mod:`json` for making your bot persistent. Attention: @@ -170,7 +170,7 @@ def __init__( ) from exc @property - def user_data(self) -> Optional[Dict[int, Dict[Any, Any]]]: + def user_data(self) -> Optional[dict[int, dict[Any, Any]]]: """:obj:`dict`: The user_data as a dict.""" return self._user_data @@ -182,7 +182,7 @@ def user_data_json(self) -> str: return json.dumps(self.user_data) @property - def chat_data(self) -> Optional[Dict[int, Dict[Any, Any]]]: + def chat_data(self) -> Optional[dict[int, dict[Any, Any]]]: """:obj:`dict`: The chat_data as a dict.""" return self._chat_data @@ -194,7 +194,7 @@ def chat_data_json(self) -> str: return json.dumps(self.chat_data) @property - def bot_data(self) -> Optional[Dict[Any, Any]]: + def bot_data(self) -> Optional[dict[Any, Any]]: """:obj:`dict`: The bot_data as a dict.""" return self._bot_data @@ -207,8 +207,8 @@ def bot_data_json(self) -> str: @property def callback_data(self) -> Optional[CDCData]: - """Tuple[List[Tuple[:obj:`str`, :obj:`float`, Dict[:obj:`str`, :class:`object`]]], \ - Dict[:obj:`str`, :obj:`str`]]: The metadata on the stored callback data. + """tuple[list[tuple[:obj:`str`, :obj:`float`, dict[:obj:`str`, :class:`object`]]], \ + dict[:obj:`str`, :obj:`str`]]: The metadata on the stored callback data. .. versionadded:: 13.6 """ @@ -225,7 +225,7 @@ def callback_data_json(self) -> str: return json.dumps(self.callback_data) @property - def conversations(self) -> Optional[Dict[str, ConversationDict]]: + def conversations(self) -> Optional[dict[str, ConversationDict]]: """:obj:`dict`: The conversations as a dict.""" return self._conversations @@ -238,7 +238,7 @@ def conversations_json(self) -> str: return self._encode_conversations_to_json(self.conversations) return json.dumps(self.conversations) - async def get_user_data(self) -> Dict[int, Dict[object, object]]: + async def get_user_data(self) -> dict[int, dict[object, object]]: """Returns the user_data created from the ``user_data_json`` or an empty :obj:`dict`. Returns: @@ -248,7 +248,7 @@ async def get_user_data(self) -> Dict[int, Dict[object, object]]: self._user_data = {} return deepcopy(self.user_data) # type: ignore[arg-type] - async def get_chat_data(self) -> Dict[int, Dict[object, object]]: + async def get_chat_data(self) -> dict[int, dict[object, object]]: """Returns the chat_data created from the ``chat_data_json`` or an empty :obj:`dict`. Returns: @@ -258,7 +258,7 @@ async def get_chat_data(self) -> Dict[int, Dict[object, object]]: self._chat_data = {} return deepcopy(self.chat_data) # type: ignore[arg-type] - async def get_bot_data(self) -> Dict[object, object]: + async def get_bot_data(self) -> dict[object, object]: """Returns the bot_data created from the ``bot_data_json`` or an empty :obj:`dict`. Returns: @@ -274,8 +274,8 @@ async def get_callback_data(self) -> Optional[CDCData]: .. versionadded:: 13.6 Returns: - Tuple[List[Tuple[:obj:`str`, :obj:`float`, Dict[:obj:`str`, :class:`object`]]], \ - Dict[:obj:`str`, :obj:`str`]]: The restored metadata or :obj:`None`, \ + tuple[list[tuple[:obj:`str`, :obj:`float`, dict[:obj:`str`, :class:`object`]]], \ + dict[:obj:`str`, :obj:`str`]]: The restored metadata or :obj:`None`, \ if no data was stored. """ if self.callback_data is None: @@ -311,7 +311,7 @@ async def update_conversation( self._conversations[name][key] = new_state self._conversations_json = None - async def update_user_data(self, user_id: int, data: Dict[Any, Any]) -> None: + async def update_user_data(self, user_id: int, data: dict[Any, Any]) -> None: """Will update the user_data (if changed). Args: @@ -325,7 +325,7 @@ async def update_user_data(self, user_id: int, data: Dict[Any, Any]) -> None: self._user_data[user_id] = data self._user_data_json = None - async def update_chat_data(self, chat_id: int, data: Dict[Any, Any]) -> None: + async def update_chat_data(self, chat_id: int, data: dict[Any, Any]) -> None: """Will update the chat_data (if changed). Args: @@ -339,7 +339,7 @@ async def update_chat_data(self, chat_id: int, data: Dict[Any, Any]) -> None: self._chat_data[chat_id] = data self._chat_data_json = None - async def update_bot_data(self, data: Dict[Any, Any]) -> None: + async def update_bot_data(self, data: dict[Any, Any]) -> None: """Will update the bot_data (if changed). Args: @@ -356,8 +356,8 @@ async def update_callback_data(self, data: CDCData) -> None: .. versionadded:: 13.6 Args: - data (Tuple[List[Tuple[:obj:`str`, :obj:`float`, Dict[:obj:`str`, :class:`object`]]], \ - Dict[:obj:`str`, :obj:`str`]]): The relevant data to restore + data (tuple[list[tuple[:obj:`str`, :obj:`float`, dict[:obj:`str`, :class:`object`]]], \ + dict[:obj:`str`, :obj:`str`]]): The relevant data to restore :class:`telegram.ext.CallbackDataCache`. """ if self._callback_data == data: @@ -391,21 +391,21 @@ async def drop_user_data(self, user_id: int) -> None: self._user_data.pop(user_id, None) self._user_data_json = None - async def refresh_user_data(self, user_id: int, user_data: Dict[Any, Any]) -> None: + async def refresh_user_data(self, user_id: int, user_data: dict[Any, Any]) -> None: """Does nothing. .. versionadded:: 13.6 .. seealso:: :meth:`telegram.ext.BasePersistence.refresh_user_data` """ - async def refresh_chat_data(self, chat_id: int, chat_data: Dict[Any, Any]) -> None: + async def refresh_chat_data(self, chat_id: int, chat_data: dict[Any, Any]) -> None: """Does nothing. .. versionadded:: 13.6 .. seealso:: :meth:`telegram.ext.BasePersistence.refresh_chat_data` """ - async def refresh_bot_data(self, bot_data: Dict[Any, Any]) -> None: + async def refresh_bot_data(self, bot_data: dict[Any, Any]) -> None: """Does nothing. .. versionadded:: 13.6 @@ -420,7 +420,7 @@ async def flush(self) -> None: """ @staticmethod - def _encode_conversations_to_json(conversations: Dict[str, ConversationDict]) -> str: + def _encode_conversations_to_json(conversations: dict[str, ConversationDict]) -> str: """Helper method to encode a conversations dict (that uses tuples as keys) to a JSON-serializable way. Use :meth:`self._decode_conversations_from_json` to decode. @@ -430,7 +430,7 @@ def _encode_conversations_to_json(conversations: Dict[str, ConversationDict]) -> Returns: :obj:`str`: The JSON-serialized conversations dict """ - tmp: Dict[str, JSONDict] = {} + tmp: dict[str, JSONDict] = {} for handler, states in conversations.items(): tmp[handler] = {} for key, state in states.items(): @@ -438,7 +438,7 @@ def _encode_conversations_to_json(conversations: Dict[str, ConversationDict]) -> return json.dumps(tmp) @staticmethod - def _decode_conversations_from_json(json_string: str) -> Dict[str, ConversationDict]: + def _decode_conversations_from_json(json_string: str) -> dict[str, ConversationDict]: """Helper method to decode a conversations dict (that uses tuples as keys) from a JSON-string created with :meth:`self._encode_conversations_to_json`. @@ -449,7 +449,7 @@ def _decode_conversations_from_json(json_string: str) -> Dict[str, ConversationD :obj:`dict`: The conversations dict after decoding """ tmp = json.loads(json_string) - conversations: Dict[str, ConversationDict] = {} + conversations: dict[str, ConversationDict] = {} for handler, states in tmp.items(): conversations[handler] = {} for key, state in states.items(): @@ -457,7 +457,7 @@ def _decode_conversations_from_json(json_string: str) -> Dict[str, ConversationD return conversations @staticmethod - def _decode_user_chat_data_from_json(data: str) -> Dict[int, Dict[object, object]]: + def _decode_user_chat_data_from_json(data: str) -> dict[int, dict[object, object]]: """Helper method to decode chat or user data (that uses ints as keys) from a JSON-string. @@ -467,7 +467,7 @@ def _decode_user_chat_data_from_json(data: str) -> Dict[int, Dict[object, object Returns: :obj:`dict`: The user/chat_data defaultdict after decoding """ - tmp: Dict[int, Dict[object, object]] = {} + tmp: dict[int, dict[object, object]] = {} decoded_data = json.loads(data) for user, user_data in decoded_data.items(): int_user_id = int(user) diff --git a/telegram/ext/_extbot.py b/telegram/ext/_extbot.py index 7d8d10e4902..66ec43c49f6 100644 --- a/telegram/ext/_extbot.py +++ b/telegram/ext/_extbot.py @@ -18,19 +18,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 Bot with convenience extensions.""" +import datetime as dtm +from collections.abc import Sequence from copy import copy -from datetime import datetime from typing import ( TYPE_CHECKING, Any, Callable, - Dict, Generic, - List, Optional, - Sequence, - Tuple, - Type, TypeVar, Union, cast, @@ -61,6 +57,8 @@ File, ForumTopic, GameHighScore, + Gift, + Gifts, InlineKeyboardMarkup, InlineQueryResultsButton, InputMedia, @@ -73,6 +71,7 @@ MessageId, PhotoSize, Poll, + PreparedInlineMessage, ReactionType, ReplyParameters, SentWebAppMessage, @@ -267,7 +266,7 @@ def __repr__(self) -> str: def _warn( cls, message: Union[str, PTBUserWarning], - category: Type[Warning] = PTBUserWarning, + category: type[Warning] = PTBUserWarning, stacklevel: int = 0, ) -> None: """We override this method to add one more level to the stacklevel, so that the warning @@ -340,7 +339,7 @@ async def _do_post( write_timeout: ODVInput[float] = DEFAULT_NONE, connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, - ) -> Union[bool, JSONDict, List[JSONDict]]: + ) -> Union[bool, JSONDict, list[JSONDict]]: """Order of method calls is: Bot.some_method -> Bot._post -> Bot._do_post. So we can override Bot._do_post to add rate limiting. """ @@ -421,7 +420,7 @@ def _merge_lpo_defaults( } ) - def _insert_defaults(self, data: Dict[str, object]) -> None: + def _insert_defaults(self, data: dict[str, object]) -> None: """Inserts the defaults values for optional kwargs for which tg.ext.Defaults provides convenience functionality, i.e. the kwargs with a tg.utils.helpers.DefaultValue default @@ -449,7 +448,7 @@ def _insert_defaults(self, data: Dict[str, object]) -> None: data[key] = self.defaults.api_defaults.get(key, val.value) # 2) - elif isinstance(val, datetime): + elif isinstance(val, dtm.datetime): data[key] = to_timestamp(val, tzinfo=self.defaults.tzinfo) # 3) @@ -596,6 +595,7 @@ async def _send_message( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -628,6 +628,7 @@ async def _send_message( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) if isinstance(result, Message): self._insert_callback_data(result) @@ -637,7 +638,7 @@ async def get_updates( self, offset: Optional[int] = None, limit: Optional[int] = None, - timeout: Optional[int] = None, + timeout: Optional[int] = None, # noqa: ASYNC109 allowed_updates: Optional[Sequence[str]] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, @@ -645,7 +646,7 @@ async def get_updates( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple[Update, ...]: + ) -> tuple[Update, ...]: updates = await super().get_updates( offset=offset, limit=limit, @@ -670,7 +671,7 @@ def _effective_inline_results( ], next_offset: Optional[str] = None, current_offset: Optional[str] = None, - ) -> Tuple[Sequence["InlineQueryResult"], Optional[str]]: + ) -> tuple[Sequence["InlineQueryResult"], Optional[str]]: """This method is called by Bot.answer_inline_query to build the actual results list. Overriding this to call self._replace_keyboard suffices """ @@ -746,7 +747,7 @@ async def do_api_request( self, endpoint: str, api_kwargs: Optional[JSONDict] = None, - return_type: Optional[Type[TelegramObject]] = None, + return_type: Optional[type[TelegramObject]] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, write_timeout: ODVInput[float] = DEFAULT_NONE, @@ -805,6 +806,7 @@ async def copy_message( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, show_caption_above_media: Optional[bool] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -836,6 +838,7 @@ async def copy_message( pool_timeout=pool_timeout, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), show_caption_above_media=show_caption_above_media, + allow_paid_broadcast=allow_paid_broadcast, ) async def copy_messages( @@ -854,7 +857,7 @@ async def copy_messages( pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, rate_limit_args: Optional[RLARGS] = None, - ) -> Tuple["MessageId", ...]: + ) -> tuple["MessageId", ...]: # We override this method to call self._replace_keyboard return await super().copy_messages( chat_id=chat_id, @@ -979,6 +982,36 @@ async def answer_inline_query( api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), ) + async def save_prepared_inline_message( + self, + user_id: int, + result: "InlineQueryResult", + allow_user_chats: Optional[bool] = None, + allow_bot_chats: Optional[bool] = None, + allow_group_chats: Optional[bool] = None, + allow_channel_chats: Optional[bool] = None, + *, + read_timeout: ODVInput[float] = DEFAULT_NONE, + write_timeout: ODVInput[float] = DEFAULT_NONE, + connect_timeout: ODVInput[float] = DEFAULT_NONE, + pool_timeout: ODVInput[float] = DEFAULT_NONE, + api_kwargs: Optional[JSONDict] = None, + rate_limit_args: Optional[RLARGS] = None, + ) -> PreparedInlineMessage: + return await super().save_prepared_inline_message( + user_id=user_id, + result=result, + allow_user_chats=allow_user_chats, + allow_bot_chats=allow_bot_chats, + allow_group_chats=allow_group_chats, + allow_channel_chats=allow_channel_chats, + read_timeout=read_timeout, + write_timeout=write_timeout, + connect_timeout=connect_timeout, + pool_timeout=pool_timeout, + api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), + ) + async def answer_pre_checkout_query( self, pre_checkout_query_id: str, @@ -1077,7 +1110,7 @@ async def ban_chat_member( self, chat_id: Union[str, int], user_id: int, - until_date: Optional[Union[int, datetime]] = None, + until_date: Optional[Union[int, dtm.datetime]] = None, revoke_messages: Optional[bool] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, @@ -1124,7 +1157,7 @@ async def ban_chat_sender_chat( async def create_chat_invite_link( self, chat_id: Union[str, int], - expire_date: Optional[Union[int, datetime]] = None, + expire_date: Optional[Union[int, dtm.datetime]] = None, member_limit: Optional[int] = None, name: Optional[str] = None, creates_join_request: Optional[bool] = None, @@ -1171,6 +1204,8 @@ async def create_invoice_link( send_phone_number_to_provider: Optional[bool] = None, send_email_to_provider: Optional[bool] = None, is_flexible: Optional[bool] = None, + subscription_period: Optional[Union[int, dtm.timedelta]] = None, + business_connection_id: Optional[str] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, write_timeout: ODVInput[float] = DEFAULT_NONE, @@ -1204,6 +1239,8 @@ async def create_invoice_link( write_timeout=write_timeout, connect_timeout=connect_timeout, pool_timeout=pool_timeout, + subscription_period=subscription_period, + business_connection_id=business_connection_id, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), ) @@ -1431,7 +1468,7 @@ async def edit_chat_invite_link( self, chat_id: Union[str, int], invite_link: Union[str, "ChatInviteLink"], - expire_date: Optional[Union[int, datetime]] = None, + expire_date: Optional[Union[int, dtm.datetime]] = None, member_limit: Optional[int] = None, name: Optional[str] = None, creates_join_request: Optional[bool] = None, @@ -1744,7 +1781,7 @@ async def forward_messages( pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, rate_limit_args: Optional[RLARGS] = None, - ) -> Tuple[MessageId, ...]: + ) -> tuple[MessageId, ...]: return await super().forward_messages( chat_id=chat_id, from_chat_id=from_chat_id, @@ -1769,7 +1806,7 @@ async def get_chat_administrators( pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, rate_limit_args: Optional[RLARGS] = None, - ) -> Tuple[ChatMember, ...]: + ) -> tuple[ChatMember, ...]: return await super().get_chat_administrators( chat_id=chat_id, read_timeout=read_timeout, @@ -1872,7 +1909,7 @@ async def get_forum_topic_icon_stickers( pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, rate_limit_args: Optional[RLARGS] = None, - ) -> Tuple[Sticker, ...]: + ) -> tuple[Sticker, ...]: return await super().get_forum_topic_icon_stickers( read_timeout=read_timeout, write_timeout=write_timeout, @@ -1894,7 +1931,7 @@ async def get_game_high_scores( pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, rate_limit_args: Optional[RLARGS] = None, - ) -> Tuple[GameHighScore, ...]: + ) -> tuple[GameHighScore, ...]: return await super().get_game_high_scores( user_id=user_id, chat_id=chat_id, @@ -1936,7 +1973,7 @@ async def get_my_commands( pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, rate_limit_args: Optional[RLARGS] = None, - ) -> Tuple[BotCommand, ...]: + ) -> tuple[BotCommand, ...]: return await super().get_my_commands( scope=scope, language_code=language_code, @@ -1997,7 +2034,7 @@ async def get_custom_emoji_stickers( pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, rate_limit_args: Optional[RLARGS] = None, - ) -> Tuple[Sticker, ...]: + ) -> tuple[Sticker, ...]: return await super().get_custom_emoji_stickers( custom_emoji_ids=custom_emoji_ids, read_timeout=read_timeout, @@ -2238,6 +2275,7 @@ async def pin_chat_message( chat_id: Union[str, int], message_id: int, disable_notification: ODVInput[bool] = DEFAULT_NONE, + business_connection_id: Optional[str] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, write_timeout: ODVInput[float] = DEFAULT_NONE, @@ -2254,6 +2292,7 @@ async def pin_chat_message( write_timeout=write_timeout, connect_timeout=connect_timeout, pool_timeout=pool_timeout, + business_connection_id=business_connection_id, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), ) @@ -2336,7 +2375,7 @@ async def restrict_chat_member( chat_id: Union[str, int], user_id: int, permissions: ChatPermissions, - until_date: Optional[Union[int, datetime]] = None, + until_date: Optional[Union[int, dtm.datetime]] = None, use_independent_chat_permissions: Optional[bool] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, @@ -2400,6 +2439,7 @@ async def send_animation( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -2438,6 +2478,7 @@ async def send_animation( pool_timeout=pool_timeout, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -2459,6 +2500,7 @@ async def send_audio( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2495,6 +2537,7 @@ async def send_audio( pool_timeout=pool_timeout, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_chat_action( @@ -2537,6 +2580,7 @@ async def send_contact( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2569,6 +2613,7 @@ async def send_contact( business_connection_id=business_connection_id, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_dice( @@ -2582,6 +2627,7 @@ async def send_dice( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2609,6 +2655,7 @@ async def send_dice( pool_timeout=pool_timeout, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_document( @@ -2627,6 +2674,7 @@ async def send_document( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2661,6 +2709,7 @@ async def send_document( pool_timeout=pool_timeout, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_game( @@ -2674,6 +2723,7 @@ async def send_game( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2701,6 +2751,7 @@ async def send_game( pool_timeout=pool_timeout, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_invoice( @@ -2733,6 +2784,7 @@ async def send_invoice( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2779,6 +2831,7 @@ async def send_invoice( pool_timeout=pool_timeout, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_location( @@ -2797,6 +2850,7 @@ async def send_location( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2831,6 +2885,7 @@ async def send_location( pool_timeout=pool_timeout, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_media_group( @@ -2845,6 +2900,7 @@ async def send_media_group( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2857,7 +2913,7 @@ async def send_media_group( caption: Optional[str] = None, parse_mode: ODVInput[str] = DEFAULT_NONE, caption_entities: Optional[Sequence["MessageEntity"]] = None, - ) -> Tuple[Message, ...]: + ) -> tuple[Message, ...]: return await super().send_media_group( chat_id=chat_id, media=media, @@ -2877,6 +2933,7 @@ async def send_media_group( parse_mode=parse_mode, caption_entities=caption_entities, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_message( @@ -2893,6 +2950,7 @@ async def send_message( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, disable_web_page_preview: Optional[bool] = None, reply_to_message_id: Optional[int] = None, @@ -2925,6 +2983,7 @@ async def send_message( api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), link_preview_options=link_preview_options, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_photo( @@ -2942,6 +3001,7 @@ async def send_photo( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -2976,6 +3036,7 @@ async def send_photo( pool_timeout=pool_timeout, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -2994,7 +3055,7 @@ async def send_poll( explanation: Optional[str] = None, explanation_parse_mode: ODVInput[str] = DEFAULT_NONE, open_period: Optional[int] = None, - close_date: Optional[Union[int, datetime]] = None, + close_date: Optional[Union[int, dtm.datetime]] = None, explanation_entities: Optional[Sequence["MessageEntity"]] = None, protect_content: ODVInput[bool] = DEFAULT_NONE, message_thread_id: Optional[int] = None, @@ -3003,6 +3064,7 @@ async def send_poll( question_parse_mode: ODVInput[str] = DEFAULT_NONE, question_entities: Optional[Sequence["MessageEntity"]] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3043,6 +3105,7 @@ async def send_poll( question_parse_mode=question_parse_mode, question_entities=question_entities, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_sticker( @@ -3057,6 +3120,7 @@ async def send_sticker( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3085,6 +3149,7 @@ async def send_sticker( emoji=emoji, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_venue( @@ -3105,6 +3170,7 @@ async def send_venue( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3141,6 +3207,7 @@ async def send_venue( pool_timeout=pool_timeout, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_video( @@ -3163,6 +3230,7 @@ async def send_video( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -3202,6 +3270,7 @@ async def send_video( pool_timeout=pool_timeout, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -3219,6 +3288,7 @@ async def send_video_note( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3251,6 +3321,7 @@ async def send_video_note( api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_voice( @@ -3268,6 +3339,7 @@ async def send_voice( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3301,6 +3373,7 @@ async def send_voice( api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def set_chat_administrator_custom_title( @@ -3349,6 +3422,30 @@ async def set_chat_description( api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), ) + async def set_user_emoji_status( + self, + user_id: int, + emoji_status_custom_emoji_id: Optional[str] = None, + emoji_status_expiration_date: Optional[Union[int, dtm.datetime]] = None, + *, + read_timeout: ODVInput[float] = DEFAULT_NONE, + write_timeout: ODVInput[float] = DEFAULT_NONE, + connect_timeout: ODVInput[float] = DEFAULT_NONE, + pool_timeout: ODVInput[float] = DEFAULT_NONE, + api_kwargs: Optional[JSONDict] = None, + rate_limit_args: Optional[RLARGS] = None, + ) -> bool: + return await super().set_user_emoji_status( + user_id=user_id, + emoji_status_custom_emoji_id=emoji_status_custom_emoji_id, + emoji_status_expiration_date=emoji_status_expiration_date, + read_timeout=read_timeout, + write_timeout=write_timeout, + connect_timeout=connect_timeout, + pool_timeout=pool_timeout, + api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), + ) + async def set_chat_menu_button( self, chat_id: Optional[int] = None, @@ -3495,7 +3592,7 @@ async def set_game_score( async def set_my_commands( self, - commands: Sequence[Union[BotCommand, Tuple[str, str]]], + commands: Sequence[Union[BotCommand, tuple[str, str]]], scope: Optional[BotCommandScope] = None, language_code: Optional[str] = None, *, @@ -3739,6 +3836,7 @@ async def unpin_chat_message( self, chat_id: Union[str, int], message_id: Optional[int] = None, + business_connection_id: Optional[str] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, write_timeout: ODVInput[float] = DEFAULT_NONE, @@ -3754,6 +3852,7 @@ async def unpin_chat_message( write_timeout=write_timeout, connect_timeout=connect_timeout, pool_timeout=pool_timeout, + business_connection_id=business_connection_id, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), ) @@ -4217,6 +4316,30 @@ async def get_star_transactions( api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), ) + async def edit_user_star_subscription( + self, + user_id: int, + telegram_payment_charge_id: str, + is_canceled: bool, + *, + read_timeout: ODVInput[float] = DEFAULT_NONE, + write_timeout: ODVInput[float] = DEFAULT_NONE, + connect_timeout: ODVInput[float] = DEFAULT_NONE, + pool_timeout: ODVInput[float] = DEFAULT_NONE, + api_kwargs: Optional[JSONDict] = None, + rate_limit_args: Optional[RLARGS] = None, + ) -> bool: + return await super().edit_user_star_subscription( + user_id=user_id, + telegram_payment_charge_id=telegram_payment_charge_id, + is_canceled=is_canceled, + read_timeout=read_timeout, + write_timeout=write_timeout, + connect_timeout=connect_timeout, + pool_timeout=pool_timeout, + api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), + ) + async def send_paid_media( self, chat_id: Union[str, int], @@ -4230,6 +4353,9 @@ async def send_paid_media( protect_content: ODVInput[bool] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, reply_markup: Optional[ReplyMarkup] = None, + business_connection_id: Optional[str] = None, + payload: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -4259,6 +4385,105 @@ async def send_paid_media( connect_timeout=connect_timeout, pool_timeout=pool_timeout, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), + business_connection_id=business_connection_id, + payload=payload, + allow_paid_broadcast=allow_paid_broadcast, + ) + + async def create_chat_subscription_invite_link( + self, + chat_id: Union[str, int], + subscription_period: int, + subscription_price: int, + name: Optional[str] = None, + *, + read_timeout: ODVInput[float] = DEFAULT_NONE, + write_timeout: ODVInput[float] = DEFAULT_NONE, + connect_timeout: ODVInput[float] = DEFAULT_NONE, + pool_timeout: ODVInput[float] = DEFAULT_NONE, + api_kwargs: Optional[JSONDict] = None, + rate_limit_args: Optional[RLARGS] = None, + ) -> ChatInviteLink: + return await super().create_chat_subscription_invite_link( + chat_id=chat_id, + subscription_period=subscription_period, + subscription_price=subscription_price, + name=name, + read_timeout=read_timeout, + write_timeout=write_timeout, + connect_timeout=connect_timeout, + pool_timeout=pool_timeout, + api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), + ) + + async def edit_chat_subscription_invite_link( + self, + chat_id: Union[str, int], + invite_link: Union[str, "ChatInviteLink"], + name: Optional[str] = None, + *, + read_timeout: ODVInput[float] = DEFAULT_NONE, + write_timeout: ODVInput[float] = DEFAULT_NONE, + connect_timeout: ODVInput[float] = DEFAULT_NONE, + pool_timeout: ODVInput[float] = DEFAULT_NONE, + api_kwargs: Optional[JSONDict] = None, + rate_limit_args: Optional[RLARGS] = None, + ) -> ChatInviteLink: + return await super().edit_chat_subscription_invite_link( + chat_id=chat_id, + invite_link=invite_link, + name=name, + read_timeout=read_timeout, + write_timeout=write_timeout, + connect_timeout=connect_timeout, + pool_timeout=pool_timeout, + api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), + ) + + async def get_available_gifts( + self, + *, + read_timeout: ODVInput[float] = DEFAULT_NONE, + write_timeout: ODVInput[float] = DEFAULT_NONE, + connect_timeout: ODVInput[float] = DEFAULT_NONE, + pool_timeout: ODVInput[float] = DEFAULT_NONE, + api_kwargs: Optional[JSONDict] = None, + rate_limit_args: Optional[RLARGS] = None, + ) -> Gifts: + return await super().get_available_gifts( + read_timeout=read_timeout, + write_timeout=write_timeout, + connect_timeout=connect_timeout, + pool_timeout=pool_timeout, + api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), + ) + + async def send_gift( + self, + user_id: int, + gift_id: Union[str, Gift], + text: Optional[str] = None, + text_parse_mode: ODVInput[str] = DEFAULT_NONE, + text_entities: Optional[Sequence["MessageEntity"]] = None, + *, + read_timeout: ODVInput[float] = DEFAULT_NONE, + write_timeout: ODVInput[float] = DEFAULT_NONE, + connect_timeout: ODVInput[float] = DEFAULT_NONE, + pool_timeout: ODVInput[float] = DEFAULT_NONE, + api_kwargs: Optional[JSONDict] = None, + rate_limit_args: Optional[RLARGS] = None, + ) -> bool: + return await super().send_gift( + user_id=user_id, + gift_id=gift_id, + text=text, + text_parse_mode=text_parse_mode, + text_entities=text_entities, + read_timeout=read_timeout, + write_timeout=write_timeout, + connect_timeout=connect_timeout, + pool_timeout=pool_timeout, + api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), ) # updated camelCase aliases @@ -4285,6 +4510,7 @@ async def send_paid_media( sendGame = send_game sendChatAction = send_chat_action answerInlineQuery = answer_inline_query + savePreparedInlineMessage = save_prepared_inline_message getUserProfilePhotos = get_user_profile_photos getFile = get_file banChatMember = ban_chat_member @@ -4327,6 +4553,7 @@ async def send_paid_media( deleteChatPhoto = delete_chat_photo setChatTitle = set_chat_title setChatDescription = set_chat_description + setUserEmojiStatus = set_user_emoji_status pinChatMessage = pin_chat_message unpinChatMessage = unpin_chat_message unpinAllChatMessages = unpin_all_chat_messages @@ -4384,4 +4611,9 @@ async def send_paid_media( replaceStickerInSet = replace_sticker_in_set refundStarPayment = refund_star_payment getStarTransactions = get_star_transactions + editUserStarSubscription = edit_user_star_subscription + createChatSubscriptionInviteLink = create_chat_subscription_invite_link + editChatSubscriptionInviteLink = edit_chat_subscription_invite_link sendPaidMedia = send_paid_media + getAvailableGifts = get_available_gifts + sendGift = send_gift diff --git a/telegram/ext/_handlers/basehandler.py b/telegram/ext/_handlers/basehandler.py index ea0d9b1640f..bf6f5f155df 100644 --- a/telegram/ext/_handlers/basehandler.py +++ b/telegram/ext/_handlers/basehandler.py @@ -32,14 +32,14 @@ UT = TypeVar("UT") -class BaseHandler(Generic[UT, CCT], ABC): +class BaseHandler(Generic[UT, CCT, RT], ABC): """The base class for all update handlers. Create custom handlers by inheriting from it. Warning: When setting :paramref:`block` to :obj:`False`, you cannot rely on adding custom attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info. - This class is a :class:`~typing.Generic` class and accepts two type variables: + This class is a :class:`~typing.Generic` class and accepts three type variables: 1. The type of the updates that this handler will handle. Must coincide with the type of the first argument of :paramref:`callback`. :meth:`check_update` must only accept @@ -54,6 +54,7 @@ class BaseHandler(Generic[UT, CCT], ABC): For this type variable, one should usually provide a :class:`~typing.TypeVar` that is also used for the mentioned method arguments. That way, a type checker can check whether this handler fits the definition of the :class:`~Application`. + 3. The return type of the :paramref:`callback` function accepted by this handler. .. seealso:: :wiki:`Types of Handlers ` @@ -89,7 +90,7 @@ async def callback(update: Update, context: CallbackContext) ) def __init__( - self, + self: "BaseHandler[UT, CCT, RT]", callback: HandlerCallback[UT, CCT, RT], block: DVType[bool] = DEFAULT_TRUE, ): diff --git a/telegram/ext/_handlers/businessconnectionhandler.py b/telegram/ext/_handlers/businessconnectionhandler.py index c8cb3e843d0..e5d09c77cf1 100644 --- a/telegram/ext/_handlers/businessconnectionhandler.py +++ b/telegram/ext/_handlers/businessconnectionhandler.py @@ -29,7 +29,7 @@ RT = TypeVar("RT") -class BusinessConnectionHandler(BaseHandler[Update, CCT]): +class BusinessConnectionHandler(BaseHandler[Update, CCT, RT]): """Handler class to handle Telegram :attr:`Business Connections `. @@ -65,7 +65,7 @@ async def callback(update: Update, context: CallbackContext) ) def __init__( - self, + self: "BusinessConnectionHandler[CCT, RT]", callback: HandlerCallback[Update, CCT, RT], user_id: Optional[SCT[int]] = None, username: Optional[SCT[str]] = None, diff --git a/telegram/ext/_handlers/businessmessagesdeletedhandler.py b/telegram/ext/_handlers/businessmessagesdeletedhandler.py index 0ceb58fe05c..c041bb0adc0 100644 --- a/telegram/ext/_handlers/businessmessagesdeletedhandler.py +++ b/telegram/ext/_handlers/businessmessagesdeletedhandler.py @@ -29,7 +29,7 @@ RT = TypeVar("RT") -class BusinessMessagesDeletedHandler(BaseHandler[Update, CCT]): +class BusinessMessagesDeletedHandler(BaseHandler[Update, CCT, RT]): """Handler class to handle :attr:`deleted Telegram Business messages `. @@ -65,7 +65,7 @@ async def callback(update: Update, context: CallbackContext) ) def __init__( - self, + self: "BusinessMessagesDeletedHandler[CCT, RT]", callback: HandlerCallback[Update, CCT, RT], chat_id: Optional[SCT[int]] = None, username: Optional[SCT[str]] = None, diff --git a/telegram/ext/_handlers/callbackqueryhandler.py b/telegram/ext/_handlers/callbackqueryhandler.py index c8fb0e7b3f0..4aa36c28769 100644 --- a/telegram/ext/_handlers/callbackqueryhandler.py +++ b/telegram/ext/_handlers/callbackqueryhandler.py @@ -19,7 +19,8 @@ """This module contains the CallbackQueryHandler class.""" import asyncio import re -from typing import TYPE_CHECKING, Any, Callable, Match, Optional, Pattern, TypeVar, Union, cast +from re import Match, Pattern +from typing import TYPE_CHECKING, Any, Callable, Optional, TypeVar, Union, cast from telegram import Update from telegram._utils.defaultvalue import DEFAULT_TRUE @@ -33,7 +34,7 @@ RT = TypeVar("RT") -class CallbackQueryHandler(BaseHandler[Update, CCT]): +class CallbackQueryHandler(BaseHandler[Update, CCT, RT]): """Handler class to handle Telegram :attr:`callback queries `. Optionally based on a regex. @@ -58,7 +59,7 @@ class CallbackQueryHandler(BaseHandler[Update, CCT]): `~telegram.CallbackQuery.game_short_name` or :attr:`~telegram.CallbackQuery.data` matching the defined pattern will be handled - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.5 Warning: When setting :paramref:`block` to :obj:`False`, you cannot rely on adding custom @@ -100,7 +101,7 @@ async def callback(update: Update, context: CallbackContext) :attr:`telegram.CallbackQuery.game_short_name` to determine if an update should be handled by this handler. - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.5 block (:obj:`bool`, optional): Determines whether the return value of the callback should be awaited before processing the next handler in :meth:`telegram.ext.Application.process_update`. Defaults to :obj:`True`. @@ -125,7 +126,7 @@ async def callback(update: Update, context: CallbackContext) __slots__ = ("game_pattern", "pattern") def __init__( - self, + self: "CallbackQueryHandler[CCT, RT]", callback: HandlerCallback[Update, CCT, RT], pattern: Optional[ Union[str, Pattern[str], type, Callable[[object], Optional[bool]]] diff --git a/telegram/ext/_handlers/chatboosthandler.py b/telegram/ext/_handlers/chatboosthandler.py index 9d7219632a1..7a2dd1be6a6 100644 --- a/telegram/ext/_handlers/chatboosthandler.py +++ b/telegram/ext/_handlers/chatboosthandler.py @@ -23,10 +23,10 @@ from telegram import Update from telegram.ext._handlers.basehandler import BaseHandler from telegram.ext._utils._update_parsing import parse_chat_id, parse_username -from telegram.ext._utils.types import CCT, HandlerCallback +from telegram.ext._utils.types import CCT, RT, HandlerCallback -class ChatBoostHandler(BaseHandler[Update, CCT]): +class ChatBoostHandler(BaseHandler[Update, CCT, RT]): """ Handler class to handle Telegram updates that contain a chat boost. @@ -84,8 +84,8 @@ async def callback(update: Update, context: CallbackContext) and :attr:`telegram.Update.removed_chat_boost`.""" def __init__( - self, - callback: HandlerCallback[Update, CCT, None], + self: "ChatBoostHandler[CCT, RT]", + callback: HandlerCallback[Update, CCT, RT], chat_boost_types: int = CHAT_BOOST, chat_id: Optional[int] = None, chat_username: Optional[str] = None, diff --git a/telegram/ext/_handlers/chatjoinrequesthandler.py b/telegram/ext/_handlers/chatjoinrequesthandler.py index 7007f61ab03..04576e63c32 100644 --- a/telegram/ext/_handlers/chatjoinrequesthandler.py +++ b/telegram/ext/_handlers/chatjoinrequesthandler.py @@ -28,7 +28,7 @@ from telegram.ext._utils.types import CCT, HandlerCallback -class ChatJoinRequestHandler(BaseHandler[Update, CCT]): +class ChatJoinRequestHandler(BaseHandler[Update, CCT, RT]): """Handler class to handle Telegram updates that contain :attr:`telegram.Update.chat_join_request`. @@ -81,7 +81,7 @@ async def callback(update: Update, context: CallbackContext) ) def __init__( - self, + self: "ChatJoinRequestHandler[CCT, RT]", callback: HandlerCallback[Update, CCT, RT], chat_id: Optional[SCT[int]] = None, username: Optional[SCT[str]] = None, diff --git a/telegram/ext/_handlers/chatmemberhandler.py b/telegram/ext/_handlers/chatmemberhandler.py index 592361b64c5..cf8bb28db10 100644 --- a/telegram/ext/_handlers/chatmemberhandler.py +++ b/telegram/ext/_handlers/chatmemberhandler.py @@ -29,7 +29,7 @@ RT = TypeVar("RT") -class ChatMemberHandler(BaseHandler[Update, CCT]): +class ChatMemberHandler(BaseHandler[Update, CCT, RT]): """Handler class to handle Telegram updates that contain a chat member update. Warning: @@ -87,7 +87,7 @@ async def callback(update: Update, context: CallbackContext) and :attr:`telegram.Update.chat_member`.""" def __init__( - self, + self: "ChatMemberHandler[CCT, RT]", callback: HandlerCallback[Update, CCT, RT], chat_member_types: int = MY_CHAT_MEMBER, block: DVType[bool] = DEFAULT_TRUE, diff --git a/telegram/ext/_handlers/choseninlineresulthandler.py b/telegram/ext/_handlers/choseninlineresulthandler.py index db7a8721448..538bc430852 100644 --- a/telegram/ext/_handlers/choseninlineresulthandler.py +++ b/telegram/ext/_handlers/choseninlineresulthandler.py @@ -18,7 +18,8 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the ChosenInlineResultHandler class.""" import re -from typing import TYPE_CHECKING, Any, Match, Optional, Pattern, TypeVar, Union, cast +from re import Match, Pattern +from typing import TYPE_CHECKING, Any, Optional, TypeVar, Union, cast from telegram import Update from telegram._utils.defaultvalue import DEFAULT_TRUE @@ -32,7 +33,7 @@ from telegram.ext import Application -class ChosenInlineResultHandler(BaseHandler[Update, CCT]): +class ChosenInlineResultHandler(BaseHandler[Update, CCT, RT]): """Handler class to handle Telegram updates that contain :attr:`telegram.Update.chosen_inline_result`. @@ -76,7 +77,7 @@ async def callback(update: Update, context: CallbackContext) __slots__ = ("pattern",) def __init__( - self, + self: "ChosenInlineResultHandler[CCT, RT]", callback: HandlerCallback[Update, CCT, RT], block: DVType[bool] = DEFAULT_TRUE, pattern: Optional[Union[str, Pattern[str]]] = None, diff --git a/telegram/ext/_handlers/commandhandler.py b/telegram/ext/_handlers/commandhandler.py index edad3963aad..cbf198484f9 100644 --- a/telegram/ext/_handlers/commandhandler.py +++ b/telegram/ext/_handlers/commandhandler.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the CommandHandler class.""" import re -from typing import TYPE_CHECKING, Any, FrozenSet, List, Optional, Tuple, TypeVar, Union +from typing import TYPE_CHECKING, Any, Optional, TypeVar, Union from telegram import MessageEntity, Update from telegram._utils.defaultvalue import DEFAULT_TRUE @@ -33,13 +33,14 @@ RT = TypeVar("RT") -class CommandHandler(BaseHandler[Update, CCT]): +class CommandHandler(BaseHandler[Update, CCT, RT]): """Handler class to handle Telegram commands. - Commands are Telegram messages that start with ``/``, optionally followed by an ``@`` and the - bot's name and/or some additional text. The handler will add a :obj:`list` to the - :class:`CallbackContext` named :attr:`CallbackContext.args`. It will contain a list of strings, - which is the text following the command split on single or consecutive whitespace characters. + Commands are Telegram messages that start with a :attr:`telegram.MessageEntity.BOT_COMMAND` + (so with ``/``, optionally followed by an ``@`` and the bot's name and/or some additional + text). The handler will add a :obj:`list` to the :class:`CallbackContext` named + :attr:`CallbackContext.args`. It will contain a list of strings, which is the text following + the command split on single or consecutive whitespace characters. By default, the handler listens to messages as well as edited messages. To change this behavior use :attr:`~filters.UpdateType.EDITED_MESSAGE ` @@ -53,6 +54,11 @@ class CommandHandler(BaseHandler[Update, CCT]): :attr:`telegram.ext.filters.CAPTION` and :class:`telegram.ext.filters.Regex`) to handle those messages. + Note: + If you want to support a different entity in the beginning, e.g. if a command message is + wrapped in a :attr:`telegram.MessageEntity.CODE`, use the + :class:`telegram.ext.PrefixHandler`. + Warning: When setting :paramref:`block` to :obj:`False`, you cannot rely on adding custom attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info. @@ -101,7 +107,7 @@ async def callback(update: Update, context: CallbackContext) :exc:`ValueError`: When the command is too long or has illegal chars. Attributes: - commands (FrozenSet[:obj:`str`]): The set of commands this handler should listen for. + commands (frozenset[:obj:`str`]): The set of commands this handler should listen for. callback (:term:`coroutine function`): The callback function for this handler. filters (:class:`telegram.ext.filters.BaseFilter`): Optional. Only allow updates with these filters. @@ -118,7 +124,7 @@ async def callback(update: Update, context: CallbackContext) __slots__ = ("commands", "filters", "has_args") def __init__( - self, + self: "CommandHandler[CCT, RT]", command: SCT[str], callback: HandlerCallback[Update, CCT, RT], filters: Optional[filters_module.BaseFilter] = None, @@ -134,7 +140,7 @@ def __init__( for comm in commands: if not re.match(r"^[\da-z_]{1,32}$", comm): raise ValueError(f"Command `{comm}` is not a valid bot command") - self.commands: FrozenSet[str] = commands + self.commands: frozenset[str] = commands self.filters: filters_module.BaseFilter = ( filters if filters is not None else filters_module.UpdateType.MESSAGES @@ -145,7 +151,7 @@ def __init__( if (isinstance(self.has_args, int)) and (self.has_args < 0): raise ValueError("CommandHandler argument has_args cannot be a negative integer") - def _check_correct_args(self, args: List[str]) -> Optional[bool]: + def _check_correct_args(self, args: list[str]) -> Optional[bool]: """Determines whether the args are correct for this handler. Implemented in check_update(). Args: args (:obj:`list`): The args for the handler. @@ -161,7 +167,7 @@ def _check_correct_args(self, args: List[str]) -> Optional[bool]: def check_update( self, update: object - ) -> Optional[Union[bool, Tuple[List[str], Optional[Union[bool, FilterDataDict]]]]]: + ) -> Optional[Union[bool, tuple[list[str], Optional[Union[bool, FilterDataDict]]]]]: """Determines whether an update should be passed to this handler's :attr:`callback`. Args: @@ -206,7 +212,7 @@ def collect_additional_context( context: CCT, update: Update, # noqa: ARG002 application: "Application[Any, CCT, Any, Any, Any, Any]", # noqa: ARG002 - check_result: Optional[Union[bool, Tuple[List[str], Optional[bool]]]], + check_result: Optional[Union[bool, tuple[list[str], Optional[bool]]]], ) -> None: """Add text after the command to :attr:`CallbackContext.args` as list, split on single whitespaces and add output of data filters to :attr:`CallbackContext` as well. diff --git a/telegram/ext/_handlers/conversationhandler.py b/telegram/ext/_handlers/conversationhandler.py index f3fad9f8324..63513644052 100644 --- a/telegram/ext/_handlers/conversationhandler.py +++ b/telegram/ext/_handlers/conversationhandler.py @@ -18,22 +18,9 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the ConversationHandler.""" import asyncio -import datetime +import datetime as dtm from dataclasses import dataclass -from typing import ( - TYPE_CHECKING, - Any, - Dict, - Final, - Generic, - List, - NoReturn, - Optional, - Set, - Tuple, - Union, - cast, -) +from typing import TYPE_CHECKING, Any, Final, Generic, NoReturn, Optional, Union, cast from telegram import Update from telegram._utils.defaultvalue import DEFAULT_TRUE, DefaultValue @@ -55,7 +42,7 @@ if TYPE_CHECKING: from telegram.ext import Application, Job, JobQueue -_CheckUpdateType = Tuple[object, ConversationKey, BaseHandler[Update, CCT], object] +_CheckUpdateType = tuple[object, ConversationKey, BaseHandler[Update, CCT, object], object] _LOGGER = get_logger(__name__, class_name="ConversationHandler") @@ -119,7 +106,7 @@ def resolve(self) -> object: return res -class ConversationHandler(BaseHandler[Update, CCT]): +class ConversationHandler(BaseHandler[Update, CCT, object]): """ A handler to hold a conversation with a single or multiple users through Telegram updates by managing three collections of other handlers. @@ -192,16 +179,16 @@ class ConversationHandler(BaseHandler[Update, CCT]): * :any:`Persistent Conversation Bot ` Args: - entry_points (List[:class:`telegram.ext.BaseHandler`]): A list of :obj:`BaseHandler` + entry_points (list[:class:`telegram.ext.BaseHandler`]): A list of :obj:`BaseHandler` objects that can trigger the start of the conversation. The first handler whose :meth:`check_update` method returns :obj:`True` will be used. If all return :obj:`False`, the update is not handled. - states (Dict[:obj:`object`, List[:class:`telegram.ext.BaseHandler`]]): A :obj:`dict` that + states (dict[:obj:`object`, list[:class:`telegram.ext.BaseHandler`]]): A :obj:`dict` that defines the different states of conversation a user can be in and one or more associated :obj:`BaseHandler` objects that should be used in that state. The first handler whose :meth:`check_update` method returns :obj:`True` will be used. - fallbacks (List[:class:`telegram.ext.BaseHandler`]): A list of handlers that might be used + fallbacks (list[:class:`telegram.ext.BaseHandler`]): A list of handlers that might be used if the user is in a conversation, but every handler for their current state returned :obj:`False` on :meth:`check_update`. The first handler which :meth:`check_update` method returns :obj:`True` will be used. If all return :obj:`False`, the update is not @@ -238,7 +225,7 @@ class ConversationHandler(BaseHandler[Update, CCT]): .. versionchanged:: 20.0 Was previously named as ``persistence``. - map_to_parent (Dict[:obj:`object`, :obj:`object`], optional): A :obj:`dict` that can be + map_to_parent (dict[:obj:`object`, :obj:`object`], optional): A :obj:`dict` that can be used to instruct a child conversation handler to transition into a mapped state on its parent conversation handler in place of a specified nested state. block (:obj:`bool`, optional): Pass :obj:`False` or :obj:`True` to set a default value for @@ -296,18 +283,18 @@ class ConversationHandler(BaseHandler[Update, CCT]): # pylint: disable=super-init-not-called def __init__( - self, - entry_points: List[BaseHandler[Update, CCT]], - states: Dict[object, List[BaseHandler[Update, CCT]]], - fallbacks: List[BaseHandler[Update, CCT]], + self: "ConversationHandler[CCT]", + entry_points: list[BaseHandler[Update, CCT, object]], + states: dict[object, list[BaseHandler[Update, CCT, object]]], + fallbacks: list[BaseHandler[Update, CCT, object]], allow_reentry: bool = False, per_chat: bool = True, per_user: bool = True, per_message: bool = False, - conversation_timeout: Optional[Union[float, datetime.timedelta]] = None, + conversation_timeout: Optional[Union[float, dtm.timedelta]] = None, name: Optional[str] = None, persistent: bool = False, - map_to_parent: Optional[Dict[object, object]] = None, + map_to_parent: Optional[dict[object, object]] = None, block: DVType[bool] = DEFAULT_TRUE, ): # these imports need to be here because of circular import error otherwise @@ -324,26 +311,24 @@ def __init__( # Store the actual setting in a protected variable instead self._block: DVType[bool] = block - self._entry_points: List[BaseHandler[Update, CCT]] = entry_points - self._states: Dict[object, List[BaseHandler[Update, CCT]]] = states - self._fallbacks: List[BaseHandler[Update, CCT]] = fallbacks + self._entry_points: list[BaseHandler[Update, CCT, object]] = entry_points + self._states: dict[object, list[BaseHandler[Update, CCT, object]]] = states + self._fallbacks: list[BaseHandler[Update, CCT, object]] = fallbacks self._allow_reentry: bool = allow_reentry self._per_user: bool = per_user self._per_chat: bool = per_chat self._per_message: bool = per_message - self._conversation_timeout: Optional[Union[float, datetime.timedelta]] = ( - conversation_timeout - ) + self._conversation_timeout: Optional[Union[float, dtm.timedelta]] = conversation_timeout self._name: Optional[str] = name - self._map_to_parent: Optional[Dict[object, object]] = map_to_parent + self._map_to_parent: Optional[dict[object, object]] = map_to_parent # if conversation_timeout is used, this dict is used to schedule a job which runs when the # conv has timed out. - self.timeout_jobs: Dict[ConversationKey, Job[Any]] = {} + self.timeout_jobs: dict[ConversationKey, Job[Any]] = {} self._timeout_jobs_lock = asyncio.Lock() self._conversations: ConversationDict = {} - self._child_conversations: Set[ConversationHandler] = set() + self._child_conversations: set[ConversationHandler] = set() if persistent and not self.name: raise ValueError("Conversations can't be persistent when handler is unnamed.") @@ -359,7 +344,7 @@ def __init__( stacklevel=2, ) - all_handlers: List[BaseHandler[Update, CCT]] = [] + all_handlers: list[BaseHandler[Update, CCT, object]] = [] all_handlers.extend(entry_points) all_handlers.extend(fallbacks) @@ -466,8 +451,8 @@ def __repr__(self) -> str: ) @property - def entry_points(self) -> List[BaseHandler[Update, CCT]]: - """List[:class:`telegram.ext.BaseHandler`]: A list of :obj:`BaseHandler` objects that can + def entry_points(self) -> list[BaseHandler[Update, CCT, object]]: + """list[:class:`telegram.ext.BaseHandler`]: A list of :obj:`BaseHandler` objects that can trigger the start of the conversation. """ return self._entry_points @@ -479,8 +464,8 @@ def entry_points(self, _: object) -> NoReturn: ) @property - def states(self) -> Dict[object, List[BaseHandler[Update, CCT]]]: - """Dict[:obj:`object`, List[:class:`telegram.ext.BaseHandler`]]: A :obj:`dict` that + def states(self) -> dict[object, list[BaseHandler[Update, CCT, object]]]: + """dict[:obj:`object`, list[:class:`telegram.ext.BaseHandler`]]: A :obj:`dict` that defines the different states of conversation a user can be in and one or more associated :obj:`BaseHandler` objects that should be used in that state. """ @@ -491,8 +476,8 @@ def states(self, _: object) -> NoReturn: raise AttributeError("You can not assign a new value to states after initialization.") @property - def fallbacks(self) -> List[BaseHandler[Update, CCT]]: - """List[:class:`telegram.ext.BaseHandler`]: A list of handlers that might be used if + def fallbacks(self) -> list[BaseHandler[Update, CCT, object]]: + """list[:class:`telegram.ext.BaseHandler`]: A list of handlers that might be used if the user is in a conversation, but every handler for their current state returned :obj:`False` on :meth:`check_update`. """ @@ -543,7 +528,7 @@ def per_message(self, _: object) -> NoReturn: @property def conversation_timeout( self, - ) -> Optional[Union[float, datetime.timedelta]]: + ) -> Optional[Union[float, dtm.timedelta]]: """:obj:`float` | :obj:`datetime.timedelta`: Optional. When this handler is inactive more than this timeout (in seconds), it will be automatically ended. @@ -578,8 +563,8 @@ def persistent(self, _: object) -> NoReturn: raise AttributeError("You can not assign a new value to persistent after initialization.") @property - def map_to_parent(self) -> Optional[Dict[object, object]]: - """Dict[:obj:`object`, :obj:`object`]: Optional. A :obj:`dict` that can be + def map_to_parent(self) -> Optional[dict[object, object]]: + """dict[:obj:`object`, :obj:`object`]: Optional. A :obj:`dict` that can be used to instruct a nested :class:`ConversationHandler` to transition into a mapped state on its parent :class:`ConversationHandler` in place of a specified nested state. """ @@ -593,7 +578,7 @@ def map_to_parent(self, _: object) -> NoReturn: async def _initialize_persistence( self, application: "Application" - ) -> Dict[str, TrackingDict[ConversationKey, object]]: + ) -> dict[str, TrackingDict[ConversationKey, object]]: """Initializes the persistence for this handler and its child conversations. While this method is marked as protected, we expect it to be called by the Application/parent conversations. It's just protected to hide it from users. @@ -648,7 +633,7 @@ def _get_key(self, update: Update) -> ConversationKey: chat = update.effective_chat user = update.effective_user - key: List[Union[int, str]] = [] + key: list[Union[int, str]] = [] if self.per_chat: if chat is None: diff --git a/telegram/ext/_handlers/inlinequeryhandler.py b/telegram/ext/_handlers/inlinequeryhandler.py index 21a5925cb1d..4c52417f601 100644 --- a/telegram/ext/_handlers/inlinequeryhandler.py +++ b/telegram/ext/_handlers/inlinequeryhandler.py @@ -18,7 +18,8 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the InlineQueryHandler class.""" import re -from typing import TYPE_CHECKING, Any, List, Match, Optional, Pattern, TypeVar, Union, cast +from re import Match, Pattern +from typing import TYPE_CHECKING, Any, Optional, TypeVar, Union, cast from telegram import Update from telegram._utils.defaultvalue import DEFAULT_TRUE @@ -32,7 +33,7 @@ RT = TypeVar("RT") -class InlineQueryHandler(BaseHandler[Update, CCT]): +class InlineQueryHandler(BaseHandler[Update, CCT, RT]): """ BaseHandler class to handle Telegram updates that contain a :attr:`telegram.Update.inline_query`. @@ -67,7 +68,7 @@ async def callback(update: Update, context: CallbackContext) :meth:`telegram.ext.Application.process_update`. Defaults to :obj:`True`. .. seealso:: :wiki:`Concurrency` - chat_types (List[:obj:`str`], optional): List of allowed chat types. If passed, will only + chat_types (list[:obj:`str`], optional): List of allowed chat types. If passed, will only handle inline queries with the appropriate :attr:`telegram.InlineQuery.chat_type`. .. versionadded:: 13.5 @@ -75,7 +76,7 @@ async def callback(update: Update, context: CallbackContext) callback (:term:`coroutine function`): The callback function for this handler. pattern (:obj:`str` | :func:`re.Pattern `): Optional. Regex pattern to test :attr:`telegram.InlineQuery.query` against. - chat_types (List[:obj:`str`]): Optional. List of allowed chat types. + chat_types (list[:obj:`str`]): Optional. List of allowed chat types. .. versionadded:: 13.5 block (:obj:`bool`): Determines whether the return value of the callback should be @@ -87,11 +88,11 @@ async def callback(update: Update, context: CallbackContext) __slots__ = ("chat_types", "pattern") def __init__( - self, + self: "InlineQueryHandler[CCT, RT]", callback: HandlerCallback[Update, CCT, RT], pattern: Optional[Union[str, Pattern[str]]] = None, block: DVType[bool] = DEFAULT_TRUE, - chat_types: Optional[List[str]] = None, + chat_types: Optional[list[str]] = None, ): super().__init__(callback, block=block) @@ -99,7 +100,7 @@ def __init__( pattern = re.compile(pattern) self.pattern: Optional[Union[str, Pattern[str]]] = pattern - self.chat_types: Optional[List[str]] = chat_types + self.chat_types: Optional[list[str]] = chat_types def check_update(self, update: object) -> Optional[Union[bool, Match[str]]]: """ diff --git a/telegram/ext/_handlers/messagehandler.py b/telegram/ext/_handlers/messagehandler.py index 0cd42884ba6..e613f4d3638 100644 --- a/telegram/ext/_handlers/messagehandler.py +++ b/telegram/ext/_handlers/messagehandler.py @@ -17,7 +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/]. """This module contains the MessageHandler class.""" -from typing import TYPE_CHECKING, Any, Dict, List, Optional, TypeVar, Union +from typing import TYPE_CHECKING, Any, Optional, TypeVar, Union from telegram import Update from telegram._utils.defaultvalue import DEFAULT_TRUE @@ -32,7 +32,7 @@ RT = TypeVar("RT") -class MessageHandler(BaseHandler[Update, CCT]): +class MessageHandler(BaseHandler[Update, CCT, RT]): """Handler class to handle Telegram messages. They might contain text, media or status updates. @@ -75,7 +75,7 @@ async def callback(update: Update, context: CallbackContext) __slots__ = ("filters",) def __init__( - self, + self: "MessageHandler[CCT, RT]", filters: Optional[filters_module.BaseFilter], callback: HandlerCallback[Update, CCT, RT], block: DVType[bool] = DEFAULT_TRUE, @@ -85,7 +85,7 @@ def __init__( filters if filters is not None else filters_module.ALL ) - def check_update(self, update: object) -> Optional[Union[bool, Dict[str, List[Any]]]]: + def check_update(self, update: object) -> Optional[Union[bool, dict[str, list[Any]]]]: """Determines whether an update should be passed to this handler's :attr:`callback`. Args: @@ -104,7 +104,7 @@ def collect_additional_context( context: CCT, update: Update, # noqa: ARG002 application: "Application[Any, CCT, Any, Any, Any, Any]", # noqa: ARG002 - check_result: Optional[Union[bool, Dict[str, object]]], + check_result: Optional[Union[bool, dict[str, object]]], ) -> None: """Adds possible output of data filters to the :class:`CallbackContext`.""" if isinstance(check_result, dict): diff --git a/telegram/ext/_handlers/messagereactionhandler.py b/telegram/ext/_handlers/messagereactionhandler.py index 4b52a17a8ab..34a5292be96 100644 --- a/telegram/ext/_handlers/messagereactionhandler.py +++ b/telegram/ext/_handlers/messagereactionhandler.py @@ -28,7 +28,7 @@ from telegram.ext._utils.types import CCT, HandlerCallback -class MessageReactionHandler(BaseHandler[Update, CCT]): +class MessageReactionHandler(BaseHandler[Update, CCT, RT]): """Handler class to handle Telegram updates that contain a message reaction. Note: @@ -110,7 +110,7 @@ async def callback(update: Update, context: CallbackContext) and :attr:`telegram.Update.message_reaction_count`.""" def __init__( - self, + self: "MessageReactionHandler[CCT, RT]", callback: HandlerCallback[Update, CCT, RT], chat_id: Optional[SCT[int]] = None, chat_username: Optional[SCT[str]] = None, diff --git a/telegram/ext/_handlers/paidmediapurchasedhandler.py b/telegram/ext/_handlers/paidmediapurchasedhandler.py new file mode 100644 index 00000000000..f74e0dae076 --- /dev/null +++ b/telegram/ext/_handlers/paidmediapurchasedhandler.py @@ -0,0 +1,95 @@ +#!/usr/bin/env python +# +# A library that provides a Python interface to the Telegram Bot API +# Copyright (C) 2015-2024 +# Leandro Toledo de Souza +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser Public License for more details. +# +# You should have received a copy of the GNU Lesser Public License +# along with this program. If not, see [http://www.gnu.org/licenses/]. +"""This module contains the PaidMediaPurchased class.""" + +from typing import Optional + +from telegram import Update +from telegram._utils.defaultvalue import DEFAULT_TRUE +from telegram._utils.types import SCT, DVType +from telegram.ext._handlers.basehandler import BaseHandler +from telegram.ext._utils._update_parsing import parse_chat_id, parse_username +from telegram.ext._utils.types import CCT, RT, HandlerCallback + + +class PaidMediaPurchasedHandler(BaseHandler[Update, CCT, RT]): + """Handler class to handle Telegram + :attr:`purchased paid media `. + + .. versionadded:: 21.6 + + Args: + callback (:term:`coroutine function`): The callback function for this handler. Will be + called when :meth:`check_update` has determined that an update should be processed by + this handler. Callback signature:: + + async def callback(update: Update, context: CallbackContext) + user_id (:obj:`int` | Collection[:obj:`int`], optional): Filters requests to allow only + those which are from the specified user ID(s). + + username (:obj:`str` | Collection[:obj:`str`], optional): Filters requests to allow only + those which are from the specified username(s). + + block (:obj:`bool`, optional): Determines whether the return value of the callback should + be awaited before processing the next handler in + :meth:`telegram.ext.Application.process_update`. Defaults to :obj:`True`. + + .. seealso:: :wiki:`Concurrency` + Attributes: + callback (:term:`coroutine function`): The callback function for this handler. + block (:obj:`bool`): Determines whether the return value of the callback should be + awaited before processing the next handler in + :meth:`telegram.ext.Application.process_update`. + """ + + __slots__ = ( + "_user_ids", + "_usernames", + ) + + def __init__( + self: "PaidMediaPurchasedHandler[CCT, RT]", + callback: HandlerCallback[Update, CCT, RT], + user_id: Optional[SCT[int]] = None, + username: Optional[SCT[str]] = None, + block: DVType[bool] = DEFAULT_TRUE, + ): + super().__init__(callback, block=block) + + self._user_ids = parse_chat_id(user_id) + self._usernames = parse_username(username) + + def check_update(self, update: object) -> bool: + """Determines whether an update should be passed to this handler's :attr:`callback`. + + Args: + update (:class:`telegram.Update` | :obj:`object`): Incoming update. + + Returns: + :obj:`bool` + + """ + if not isinstance(update, Update) or not update.purchased_paid_media: + return False + + if not self._user_ids and not self._usernames: + return True + if update.purchased_paid_media.from_user.id in self._user_ids: + return True + return update.purchased_paid_media.from_user.username in self._usernames diff --git a/telegram/ext/_handlers/pollanswerhandler.py b/telegram/ext/_handlers/pollanswerhandler.py index 91e8df82b70..5e0bb34dbea 100644 --- a/telegram/ext/_handlers/pollanswerhandler.py +++ b/telegram/ext/_handlers/pollanswerhandler.py @@ -21,10 +21,10 @@ from telegram import Update from telegram.ext._handlers.basehandler import BaseHandler -from telegram.ext._utils.types import CCT +from telegram.ext._utils.types import CCT, RT -class PollAnswerHandler(BaseHandler[Update, CCT]): +class PollAnswerHandler(BaseHandler[Update, CCT, RT]): """Handler class to handle Telegram updates that contain a :attr:`poll answer `. diff --git a/telegram/ext/_handlers/pollhandler.py b/telegram/ext/_handlers/pollhandler.py index fb183c53805..6bb41c3237e 100644 --- a/telegram/ext/_handlers/pollhandler.py +++ b/telegram/ext/_handlers/pollhandler.py @@ -21,10 +21,10 @@ from telegram import Update from telegram.ext._handlers.basehandler import BaseHandler -from telegram.ext._utils.types import CCT +from telegram.ext._utils.types import CCT, RT -class PollHandler(BaseHandler[Update, CCT]): +class PollHandler(BaseHandler[Update, CCT, RT]): """Handler class to handle Telegram updates that contain a :attr:`poll `. diff --git a/telegram/ext/_handlers/precheckoutqueryhandler.py b/telegram/ext/_handlers/precheckoutqueryhandler.py index 3c6f3f186df..265351ed339 100644 --- a/telegram/ext/_handlers/precheckoutqueryhandler.py +++ b/telegram/ext/_handlers/precheckoutqueryhandler.py @@ -20,7 +20,8 @@ import re -from typing import Optional, Pattern, TypeVar, Union +from re import Pattern +from typing import Optional, TypeVar, Union from telegram import Update from telegram._utils.defaultvalue import DEFAULT_TRUE @@ -31,7 +32,7 @@ RT = TypeVar("RT") -class PreCheckoutQueryHandler(BaseHandler[Update, CCT]): +class PreCheckoutQueryHandler(BaseHandler[Update, CCT, RT]): """Handler class to handle Telegram :attr:`telegram.Update.pre_checkout_query`. Warning: @@ -73,7 +74,7 @@ async def callback(update: Update, context: CallbackContext) __slots__ = ("pattern",) def __init__( - self, + self: "PreCheckoutQueryHandler[CCT, RT]", callback: HandlerCallback[Update, CCT, RT], block: DVType[bool] = DEFAULT_TRUE, pattern: Optional[Union[str, Pattern[str]]] = None, diff --git a/telegram/ext/_handlers/prefixhandler.py b/telegram/ext/_handlers/prefixhandler.py index 3b10a0a1caf..c68c6fd8c05 100644 --- a/telegram/ext/_handlers/prefixhandler.py +++ b/telegram/ext/_handlers/prefixhandler.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the PrefixHandler class.""" import itertools -from typing import TYPE_CHECKING, Any, Dict, FrozenSet, List, Optional, Tuple, TypeVar, Union +from typing import TYPE_CHECKING, Any, Optional, TypeVar, Union from telegram import Update from telegram._utils.defaultvalue import DEFAULT_TRUE @@ -33,7 +33,7 @@ RT = TypeVar("RT") -class PrefixHandler(BaseHandler[Update, CCT]): +class PrefixHandler(BaseHandler[Update, CCT, RT]): """Handler class to handle custom prefix commands. This is an intermediate handler between :class:`MessageHandler` and :class:`CommandHandler`. @@ -108,7 +108,7 @@ async def callback(update: Update, context: CallbackContext) .. seealso:: :wiki:`Concurrency` Attributes: - commands (FrozenSet[:obj:`str`]): The commands that this handler will listen for, i.e. the + commands (frozenset[:obj:`str`]): The commands that this handler will listen for, i.e. the combinations of :paramref:`prefix` and :paramref:`command`. callback (:term:`coroutine function`): The callback function for this handler. filters (:class:`telegram.ext.filters.BaseFilter`): Optional. Only allow updates with these @@ -123,7 +123,7 @@ async def callback(update: Update, context: CallbackContext) __slots__ = ("commands", "filters") def __init__( - self, + self: "PrefixHandler[CCT, RT]", prefix: SCT[str], command: SCT[str], callback: HandlerCallback[Update, CCT, RT], @@ -136,7 +136,7 @@ def __init__( commands = {command.lower()} if isinstance(command, str) else {x.lower() for x in command} - self.commands: FrozenSet[str] = frozenset( + self.commands: frozenset[str] = frozenset( p + c for p, c in itertools.product(prefixes, commands) ) self.filters: filters_module.BaseFilter = ( @@ -145,7 +145,7 @@ def __init__( def check_update( self, update: object - ) -> Optional[Union[bool, Tuple[List[str], Optional[Union[bool, Dict[Any, Any]]]]]]: + ) -> Optional[Union[bool, tuple[list[str], Optional[Union[bool, dict[Any, Any]]]]]]: """Determines whether an update should be passed to this handler's :attr:`callback`. Args: @@ -173,7 +173,7 @@ def collect_additional_context( context: CCT, update: Update, # noqa: ARG002 application: "Application[Any, CCT, Any, Any, Any, Any]", # noqa: ARG002 - check_result: Optional[Union[bool, Tuple[List[str], Optional[bool]]]], + check_result: Optional[Union[bool, tuple[list[str], Optional[bool]]]], ) -> None: """Add text after the command to :attr:`CallbackContext.args` as list, split on single whitespaces and add output of data filters to :attr:`CallbackContext` as well. diff --git a/telegram/ext/_handlers/shippingqueryhandler.py b/telegram/ext/_handlers/shippingqueryhandler.py index f0234c2a962..c186513093a 100644 --- a/telegram/ext/_handlers/shippingqueryhandler.py +++ b/telegram/ext/_handlers/shippingqueryhandler.py @@ -21,10 +21,10 @@ from telegram import Update from telegram.ext._handlers.basehandler import BaseHandler -from telegram.ext._utils.types import CCT +from telegram.ext._utils.types import CCT, RT -class ShippingQueryHandler(BaseHandler[Update, CCT]): +class ShippingQueryHandler(BaseHandler[Update, CCT, RT]): """Handler class to handle Telegram :attr:`telegram.Update.shipping_query`. Warning: diff --git a/telegram/ext/_handlers/stringcommandhandler.py b/telegram/ext/_handlers/stringcommandhandler.py index d5c29bf6639..22d34c555f2 100644 --- a/telegram/ext/_handlers/stringcommandhandler.py +++ b/telegram/ext/_handlers/stringcommandhandler.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the StringCommandHandler class.""" -from typing import TYPE_CHECKING, Any, List, Optional +from typing import TYPE_CHECKING, Any, Optional from telegram._utils.defaultvalue import DEFAULT_TRUE from telegram._utils.types import DVType @@ -29,7 +29,7 @@ from telegram.ext import Application -class StringCommandHandler(BaseHandler[str, CCT]): +class StringCommandHandler(BaseHandler[str, CCT, RT]): """Handler class to handle string commands. Commands are string updates that start with ``/``. The handler will add a :obj:`list` to the :class:`CallbackContext` named :attr:`CallbackContext.args`. It will contain a list of strings, @@ -71,7 +71,7 @@ async def callback(update: str, context: CallbackContext) __slots__ = ("command",) def __init__( - self, + self: "StringCommandHandler[CCT, RT]", command: str, callback: HandlerCallback[str, CCT, RT], block: DVType[bool] = DEFAULT_TRUE, @@ -79,14 +79,14 @@ def __init__( super().__init__(callback, block=block) self.command: str = command - def check_update(self, update: object) -> Optional[List[str]]: + def check_update(self, update: object) -> Optional[list[str]]: """Determines whether an update should be passed to this handler's :attr:`callback`. Args: update (:obj:`object`): The incoming update. Returns: - List[:obj:`str`]: List containing the text command split on whitespace. + list[:obj:`str`]: List containing the text command split on whitespace. """ if isinstance(update, str) and update.startswith("/"): @@ -100,7 +100,7 @@ def collect_additional_context( context: CCT, update: str, # noqa: ARG002 application: "Application[Any, CCT, Any, Any, Any, Any]", # noqa: ARG002 - check_result: Optional[List[str]], + check_result: Optional[list[str]], ) -> None: """Add text after the command to :attr:`CallbackContext.args` as list, split on single whitespaces. diff --git a/telegram/ext/_handlers/stringregexhandler.py b/telegram/ext/_handlers/stringregexhandler.py index c2e22c10655..f5c0c64a862 100644 --- a/telegram/ext/_handlers/stringregexhandler.py +++ b/telegram/ext/_handlers/stringregexhandler.py @@ -19,7 +19,8 @@ """This module contains the StringRegexHandler class.""" import re -from typing import TYPE_CHECKING, Any, Match, Optional, Pattern, TypeVar, Union +from re import Match, Pattern +from typing import TYPE_CHECKING, Any, Optional, TypeVar, Union from telegram._utils.defaultvalue import DEFAULT_TRUE from telegram._utils.types import DVType @@ -32,7 +33,7 @@ RT = TypeVar("RT") -class StringRegexHandler(BaseHandler[str, CCT]): +class StringRegexHandler(BaseHandler[str, CCT, RT]): """Handler class to handle string updates based on a regex which checks the update content. Read the documentation of the :mod:`re` module for more information. The :func:`re.match` @@ -74,7 +75,7 @@ async def callback(update: str, context: CallbackContext) __slots__ = ("pattern",) def __init__( - self, + self: "StringRegexHandler[CCT, RT]", pattern: Union[str, Pattern[str]], callback: HandlerCallback[str, CCT, RT], block: DVType[bool] = DEFAULT_TRUE, diff --git a/telegram/ext/_handlers/typehandler.py b/telegram/ext/_handlers/typehandler.py index 151a7fbf137..f473f2a5f3b 100644 --- a/telegram/ext/_handlers/typehandler.py +++ b/telegram/ext/_handlers/typehandler.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the TypeHandler class.""" -from typing import Optional, Type, TypeVar +from typing import Optional, TypeVar from telegram._utils.defaultvalue import DEFAULT_TRUE from telegram._utils.types import DVType @@ -27,9 +27,12 @@ RT = TypeVar("RT") UT = TypeVar("UT") +# If this is written directly next to the type variable mypy gets confused with [valid-type]. This +# could be reported to them, but I doubt they would change this since we override a builtin type +GenericUT = type[UT] -class TypeHandler(BaseHandler[UT, CCT]): +class TypeHandler(BaseHandler[UT, CCT, RT]): """Handler class to handle updates of custom types. Warning: @@ -70,14 +73,14 @@ async def callback(update: object, context: CallbackContext) __slots__ = ("strict", "type") def __init__( - self, - type: Type[UT], # pylint: disable=redefined-builtin + self: "TypeHandler[UT, CCT, RT]", + type: GenericUT[UT], # pylint: disable=redefined-builtin callback: HandlerCallback[UT, CCT, RT], strict: bool = False, block: DVType[bool] = DEFAULT_TRUE, ): super().__init__(callback, block=block) - self.type: Type[UT] = type + self.type: GenericUT[UT] = type self.strict: Optional[bool] = strict def check_update(self, update: object) -> bool: diff --git a/telegram/ext/_jobqueue.py b/telegram/ext/_jobqueue.py index db84841d5be..acc752b5f51 100644 --- a/telegram/ext/_jobqueue.py +++ b/telegram/ext/_jobqueue.py @@ -18,9 +18,9 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes JobQueue and Job.""" import asyncio -import datetime +import datetime as dtm import weakref -from typing import TYPE_CHECKING, Any, Generic, Optional, Tuple, Union, cast, overload +from typing import TYPE_CHECKING, Any, Generic, Optional, Union, cast, overload try: import pytz @@ -152,7 +152,7 @@ def scheduler_configuration(self) -> JSONDict: .. versionadded:: 20.7 Returns: - Dict[:obj:`str`, :obj:`object`]: The configuration values as dictionary. + dict[:obj:`str`, :obj:`object`]: The configuration values as dictionary. """ timezone: object = pytz.utc @@ -168,8 +168,8 @@ def scheduler_configuration(self) -> JSONDict: "executors": {"default": self._executor}, } - def _tz_now(self) -> datetime.datetime: - return datetime.datetime.now(self.scheduler.timezone) + def _tz_now(self) -> dtm.datetime: + return dtm.datetime.now(self.scheduler.timezone) @overload def _parse_time_input(self, time: None, shift_day: bool = False) -> None: ... @@ -177,29 +177,29 @@ def _parse_time_input(self, time: None, shift_day: bool = False) -> None: ... @overload def _parse_time_input( self, - time: Union[float, datetime.timedelta, datetime.datetime, datetime.time], + time: Union[float, dtm.timedelta, dtm.datetime, dtm.time], shift_day: bool = False, - ) -> datetime.datetime: ... + ) -> dtm.datetime: ... def _parse_time_input( self, - time: Union[float, datetime.timedelta, datetime.datetime, datetime.time, None], + time: Union[float, dtm.timedelta, dtm.datetime, dtm.time, None], shift_day: bool = False, - ) -> Optional[datetime.datetime]: + ) -> Optional[dtm.datetime]: if time is None: return None if isinstance(time, (int, float)): - return self._tz_now() + datetime.timedelta(seconds=time) - if isinstance(time, datetime.timedelta): + return self._tz_now() + dtm.timedelta(seconds=time) + if isinstance(time, dtm.timedelta): return self._tz_now() + time - if isinstance(time, datetime.time): - date_time = datetime.datetime.combine( - datetime.datetime.now(tz=time.tzinfo or self.scheduler.timezone).date(), time + if isinstance(time, dtm.time): + date_time = dtm.datetime.combine( + dtm.datetime.now(tz=time.tzinfo or self.scheduler.timezone).date(), time ) if date_time.tzinfo is None: date_time = self.scheduler.timezone.localize(date_time) - if shift_day and date_time <= datetime.datetime.now(pytz.utc): - date_time += datetime.timedelta(days=1) + if shift_day and date_time <= dtm.datetime.now(pytz.utc): + date_time += dtm.timedelta(days=1) return date_time return time @@ -242,7 +242,7 @@ async def job_callback(job_queue: "JobQueue[CCT]", job: "Job[CCT]") -> None: def run_once( self, callback: JobCallback[CCT], - when: Union[float, datetime.timedelta, datetime.datetime, datetime.time], + when: Union[float, dtm.timedelta, dtm.datetime, dtm.time], data: Optional[object] = None, name: Optional[str] = None, chat_id: Optional[int] = None, @@ -326,9 +326,9 @@ async def callback(context: CallbackContext) def run_repeating( self, callback: JobCallback[CCT], - interval: Union[float, datetime.timedelta], - first: Optional[Union[float, datetime.timedelta, datetime.datetime, datetime.time]] = None, - last: Optional[Union[float, datetime.timedelta, datetime.datetime, datetime.time]] = None, + interval: Union[float, dtm.timedelta], + first: Optional[Union[float, dtm.timedelta, dtm.datetime, dtm.time]] = None, + last: Optional[Union[float, dtm.timedelta, dtm.datetime, dtm.time]] = None, data: Optional[object] = None, name: Optional[str] = None, chat_id: Optional[int] = None, @@ -433,7 +433,7 @@ async def callback(context: CallbackContext) if dt_last and dt_first and dt_last < dt_first: raise ValueError("'last' must not be before 'first'!") - if isinstance(interval, datetime.timedelta): + if isinstance(interval, dtm.timedelta): interval = interval.total_seconds() j = self.scheduler.add_job( @@ -453,7 +453,7 @@ async def callback(context: CallbackContext) def run_monthly( self, callback: JobCallback[CCT], - when: datetime.time, + when: dtm.time, day: int, data: Optional[object] = None, name: Optional[str] = None, @@ -531,8 +531,8 @@ async def callback(context: CallbackContext) def run_daily( self, callback: JobCallback[CCT], - time: datetime.time, - days: Tuple[int, ...] = _ALL_DAYS, + time: dtm.time, + days: tuple[int, ...] = _ALL_DAYS, data: Optional[object] = None, name: Optional[str] = None, chat_id: Optional[int] = None, @@ -556,7 +556,7 @@ async def callback(context: CallbackContext) time (:obj:`datetime.time`): Time of day at which the job should run. If the timezone (:obj:`datetime.time.tzinfo`) is :obj:`None`, the default timezone of the bot will be used, which is UTC unless :attr:`telegram.ext.Defaults.tzinfo` is used. - days (Tuple[:obj:`int`], optional): Defines on which days of the week the job should + days (tuple[:obj:`int`], optional): Defines on which days of the week the job should run (where ``0-6`` correspond to sunday - saturday). By default, the job will run every day. @@ -693,20 +693,20 @@ async def stop(self, wait: bool = True) -> None: # so give it a tiny bit of time to actually shut down. await asyncio.sleep(0.01) - def jobs(self) -> Tuple["Job[CCT]", ...]: + def jobs(self) -> tuple["Job[CCT]", ...]: """Returns a tuple of all *scheduled* jobs that are currently in the :class:`JobQueue`. Returns: - Tuple[:class:`Job`]: Tuple of all *scheduled* jobs. + tuple[:class:`Job`]: Tuple of all *scheduled* jobs. """ return tuple(Job.from_aps_job(job) for job in self.scheduler.get_jobs()) - def get_jobs_by_name(self, name: str) -> Tuple["Job[CCT]", ...]: + def get_jobs_by_name(self, name: str) -> tuple["Job[CCT]", ...]: """Returns a tuple of all *pending/scheduled* jobs with the given name that are currently in the :class:`JobQueue`. Returns: - Tuple[:class:`Job`]: Tuple of all *pending* or *scheduled* jobs matching the name. + tuple[:class:`Job`]: Tuple of all *pending* or *scheduled* jobs matching the name. """ return tuple(job for job in self.jobs() if job.name == name) @@ -904,7 +904,7 @@ def enabled(self, status: bool) -> None: self._enabled = status @property - def next_t(self) -> Optional[datetime.datetime]: + def next_t(self) -> Optional[dtm.datetime]: """ :class:`datetime.datetime`: Datetime for the next job execution. Datetime is localized according to :attr:`datetime.datetime.tzinfo`. diff --git a/telegram/ext/_picklepersistence.py b/telegram/ext/_picklepersistence.py index adc8220af48..a0d96ce84fd 100644 --- a/telegram/ext/_picklepersistence.py +++ b/telegram/ext/_picklepersistence.py @@ -20,7 +20,7 @@ import pickle from copy import deepcopy from pathlib import Path -from typing import Any, Callable, Dict, Optional, Set, Tuple, Type, TypeVar, Union, cast, overload +from typing import Any, Callable, Optional, TypeVar, Union, cast, overload from telegram import Bot, TelegramObject from telegram._utils.types import FilePathInput @@ -35,7 +35,7 @@ TelegramObj = TypeVar("TelegramObj", bound=TelegramObject) -def _all_subclasses(cls: Type[TelegramObj]) -> Set[Type[TelegramObj]]: +def _all_subclasses(cls: type[TelegramObj]) -> set[type[TelegramObj]]: """Gets all subclasses of the specified object, recursively. from https://stackoverflow.com/a/3862957/9706202 """ @@ -43,7 +43,7 @@ def _all_subclasses(cls: Type[TelegramObj]) -> Set[Type[TelegramObj]]: return set(subclasses).union([s for c in subclasses for s in _all_subclasses(c)]) -def _reconstruct_to(cls: Type[TelegramObj], kwargs: dict) -> TelegramObj: +def _reconstruct_to(cls: type[TelegramObj], kwargs: dict) -> TelegramObj: """ This method is used for unpickling. The data, which is in the form a dictionary, is converted back into a class. Works mostly the same as :meth:`TelegramObject.__setstate__`. @@ -55,7 +55,7 @@ def _reconstruct_to(cls: Type[TelegramObj], kwargs: dict) -> TelegramObj: return obj -def _custom_reduction(cls: TelegramObj) -> Tuple[Callable, Tuple[Type[TelegramObj], dict]]: +def _custom_reduction(cls: TelegramObj) -> tuple[Callable, tuple[type[TelegramObj], dict]]: """ This method is used for pickling. The bot attribute is preserved so _BotPickler().persistent_id works as intended. @@ -76,7 +76,7 @@ def __init__(self, bot: Bot, *args: Any, **kwargs: Any): def reducer_override( self, obj: TelegramObj - ) -> Tuple[Callable, Tuple[Type[TelegramObj], dict]]: + ) -> tuple[Callable, tuple[type[TelegramObj], dict]]: """ This method is used for pickling. The bot attribute is preserved so _BotPickler().persistent_id works as intended. @@ -199,7 +199,7 @@ class PicklePersistence(BasePersistence[UD, CD, BD]): @overload def __init__( - self: "PicklePersistence[Dict[Any, Any], Dict[Any, Any], Dict[Any, Any]]", + self: "PicklePersistence[dict[Any, Any], dict[Any, Any], dict[Any, Any]]", filepath: FilePathInput, store_data: Optional[PersistenceInput] = None, single_file: bool = True, @@ -231,11 +231,11 @@ def __init__( self.filepath: Path = Path(filepath) self.single_file: Optional[bool] = single_file self.on_flush: Optional[bool] = on_flush - self.user_data: Optional[Dict[int, UD]] = None - self.chat_data: Optional[Dict[int, CD]] = None + self.user_data: Optional[dict[int, UD]] = None + self.chat_data: Optional[dict[int, CD]] = None self.bot_data: Optional[BD] = None self.callback_data: Optional[CDCData] = None - self.conversations: Optional[Dict[str, Dict[Tuple[Union[int, str], ...], object]]] = None + self.conversations: Optional[dict[str, dict[tuple[Union[int, str], ...], object]]] = None self.context_types: ContextTypes[Any, UD, CD, BD] = cast( ContextTypes[Any, UD, CD, BD], context_types or ContextTypes() ) @@ -290,11 +290,11 @@ def _dump_file(self, filepath: Path, data: object) -> None: with filepath.open("wb") as file: _BotPickler(self.bot, file, protocol=pickle.HIGHEST_PROTOCOL).dump(data) - async def get_user_data(self) -> Dict[int, UD]: + async def get_user_data(self) -> dict[int, UD]: """Returns the user_data from the pickle file if it exists or an empty :obj:`dict`. Returns: - Dict[:obj:`int`, :obj:`dict`]: The restored user data. + dict[:obj:`int`, :obj:`dict`]: The restored user data. """ if self.user_data: pass @@ -307,11 +307,11 @@ async def get_user_data(self) -> Dict[int, UD]: self._load_singlefile() return deepcopy(self.user_data) # type: ignore[arg-type] - async def get_chat_data(self) -> Dict[int, CD]: + async def get_chat_data(self) -> dict[int, CD]: """Returns the chat_data from the pickle file if it exists or an empty :obj:`dict`. Returns: - Dict[:obj:`int`, :obj:`dict`]: The restored chat data. + dict[:obj:`int`, :obj:`dict`]: The restored chat data. """ if self.chat_data: pass @@ -348,8 +348,8 @@ async def get_callback_data(self) -> Optional[CDCData]: .. versionadded:: 13.6 Returns: - Tuple[List[Tuple[:obj:`str`, :obj:`float`, Dict[:obj:`str`, :class:`object`]]], - Dict[:obj:`str`, :obj:`str`]] | :obj:`None`: The restored metadata or :obj:`None`, + tuple[list[tuple[:obj:`str`, :obj:`float`, dict[:obj:`str`, :class:`object`]]], + dict[:obj:`str`, :obj:`str`]] | :obj:`None`: The restored metadata or :obj:`None`, if no data was stored. """ if self.callback_data: @@ -466,8 +466,8 @@ async def update_callback_data(self, data: CDCData) -> None: .. versionadded:: 13.6 Args: - data (Tuple[List[Tuple[:obj:`str`, :obj:`float`, \ - Dict[:obj:`str`, :class:`object`]]], Dict[:obj:`str`, :obj:`str`]]): + data (tuple[list[tuple[:obj:`str`, :obj:`float`, \ + dict[:obj:`str`, :class:`object`]]], dict[:obj:`str`, :obj:`str`]]): The relevant data to restore :class:`telegram.ext.CallbackDataCache`. """ if self.callback_data == data: diff --git a/telegram/ext/_updater.py b/telegram/ext/_updater.py index 04d01a83eae..0c9cf5150ac 100644 --- a/telegram/ext/_updater.py +++ b/telegram/ext/_updater.py @@ -17,23 +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 the class Updater, which tries to make creating Telegram bots intuitive.""" + import asyncio import contextlib import ssl +from collections.abc import Coroutine, Sequence from pathlib import Path from types import TracebackType -from typing import ( - TYPE_CHECKING, - Any, - AsyncContextManager, - Callable, - Coroutine, - List, - Optional, - Type, - TypeVar, - Union, -) +from typing import TYPE_CHECKING, Any, Callable, Optional, TypeVar, Union from telegram._utils.defaultvalue import DEFAULT_80, DEFAULT_IP, DEFAULT_NONE, DefaultValue from telegram._utils.logging import get_logger @@ -58,7 +49,7 @@ _LOGGER = get_logger(__name__) -class Updater(AsyncContextManager["Updater"]): +class Updater(contextlib.AbstractAsyncContextManager["Updater"]): """This class fetches updates for the bot either via long polling or by starting a webhook server. Received updates are enqueued into the :attr:`update_queue` and may be fetched from there to handle them appropriately. @@ -145,14 +136,14 @@ async def __aenter__(self: _UpdaterType) -> _UpdaterType: # noqa: PYI019 """ try: await self.initialize() - return self - except Exception as exc: + except Exception: await self.shutdown() - raise exc + raise + return self async def __aexit__( self, - exc_type: Optional[Type[BaseException]], + exc_type: Optional[type[BaseException]], exc_val: Optional[BaseException], exc_tb: Optional[TracebackType], ) -> None: @@ -214,13 +205,13 @@ async def shutdown(self) -> None: async def start_polling( self, poll_interval: float = 0.0, - timeout: int = 10, + timeout: int = 10, # noqa: ASYNC109 bootstrap_retries: int = -1, read_timeout: ODVInput[float] = DEFAULT_NONE, write_timeout: ODVInput[float] = DEFAULT_NONE, connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, - allowed_updates: Optional[List[str]] = None, + allowed_updates: Optional[Sequence[str]] = None, drop_pending_updates: Optional[bool] = None, error_callback: Optional[Callable[[TelegramError], None]] = None, ) -> "asyncio.Queue[object]": @@ -275,8 +266,11 @@ async def start_polling( Deprecated in favor of setting the timeout via :meth:`telegram.ext.ApplicationBuilder.get_updates_pool_timeout` or :paramref:`telegram.Bot.get_updates_request`. - allowed_updates (List[:obj:`str`], optional): Passed to + allowed_updates (Sequence[:obj:`str`], optional): Passed to :meth:`telegram.Bot.get_updates`. + + .. versionchanged:: 21.9 + Accepts any :class:`collections.abc.Sequence` as input instead of just a list drop_pending_updates (:obj:`bool`, optional): Whether to clean any pending updates on Telegram servers before actually starting to poll. Default is :obj:`False`. @@ -339,23 +333,22 @@ def callback(error: telegram.error.TelegramError) _LOGGER.debug("Waiting for polling to start") await polling_ready.wait() _LOGGER.debug("Polling updates from Telegram started") - - return self.update_queue - except Exception as exc: + except Exception: self._running = False - raise exc + raise + return self.update_queue async def _start_polling( self, poll_interval: float, - timeout: int, + timeout: int, # noqa: ASYNC109 read_timeout: ODVInput[float], write_timeout: ODVInput[float], connect_timeout: ODVInput[float], pool_timeout: ODVInput[float], bootstrap_retries: int, drop_pending_updates: Optional[bool], - allowed_updates: Optional[List[str]], + allowed_updates: Optional[Sequence[str]], ready: asyncio.Event, error_callback: Optional[Callable[[TelegramError], None]], ) -> None: @@ -384,9 +377,9 @@ async def polling_action_cb() -> bool: pool_timeout=pool_timeout, allowed_updates=allowed_updates, ) - except TelegramError as exc: + except TelegramError: # TelegramErrors should be processed by the network retry loop - raise exc + raise except Exception as exc: # Other exceptions should not. Let's log them for now. _LOGGER.critical( @@ -446,13 +439,12 @@ async def _get_updates_cleanup() -> None: pool_timeout=pool_timeout, allowed_updates=allowed_updates, ) - except TelegramError as exc: - _LOGGER.error( + except TelegramError: + _LOGGER.exception( "Error while calling `get_updates` one more time to mark all fetched updates " "as read: %s. Suppressing error to ensure graceful shutdown. When polling for " "updates is restarted, updates may be fetched again. Please adjust timeouts " "via `ApplicationBuilder` or the parameter `get_updates_request` of `Bot`.", - exc_info=exc, ) self.__polling_cleanup_cb = _get_updates_cleanup @@ -469,7 +461,7 @@ async def start_webhook( key: Optional[Union[str, Path]] = None, bootstrap_retries: int = 0, webhook_url: Optional[str] = None, - allowed_updates: Optional[List[str]] = None, + allowed_updates: Optional[Sequence[str]] = None, drop_pending_updates: Optional[bool] = None, ip_address: Optional[str] = None, max_connections: int = 40, @@ -528,8 +520,11 @@ async def start_webhook( Defaults to :obj:`None`. .. versionadded :: 13.4 - allowed_updates (List[:obj:`str`], optional): Passed to + allowed_updates (Sequence[:obj:`str`], optional): Passed to :meth:`telegram.Bot.set_webhook`. Defaults to :obj:`None`. + + .. versionchanged:: 21.9 + Accepts any :class:`collections.abc.Sequence` as input instead of just a list max_connections (:obj:`int`, optional): Passed to :meth:`telegram.Bot.set_webhook`. Defaults to ``40``. @@ -623,9 +618,9 @@ async def start_webhook( _LOGGER.debug("Waiting for webhook server to start") await webhook_ready.wait() _LOGGER.debug("Webhook server started") - except Exception as exc: + except Exception: self._running = False - raise exc + raise # Return the update queue so the main thread can insert updates return self.update_queue @@ -636,7 +631,7 @@ async def _start_webhook( port: int, url_path: str, bootstrap_retries: int, - allowed_updates: Optional[List[str]], + allowed_updates: Optional[Sequence[str]], cert: Optional[Union[str, Path]] = None, key: Optional[Union[str, Path]] = None, drop_pending_updates: Optional[bool] = None, @@ -761,11 +756,10 @@ async def do_action() -> bool: _LOGGER.debug("Timed out %s: %s", description, toe) # If failure is due to timeout, we should retry asap. cur_interval = 0 - except InvalidToken as pex: - _LOGGER.error("Invalid token; aborting") - raise pex + except InvalidToken: + _LOGGER.exception("Invalid token; aborting") + raise except TelegramError as telegram_exc: - _LOGGER.error("Error while %s: %s", description, telegram_exc) on_err_cb(telegram_exc) # increase waiting times on subsequent errors up to 30secs @@ -780,7 +774,7 @@ async def _bootstrap( self, max_retries: int, webhook_url: Optional[str], - allowed_updates: Optional[List[str]], + allowed_updates: Optional[Sequence[str]], drop_pending_updates: Optional[bool] = None, cert: Optional[bytes] = None, bootstrap_interval: float = 1, diff --git a/telegram/ext/_utils/_update_parsing.py b/telegram/ext/_utils/_update_parsing.py index f74c35e8c45..7bc4c498956 100644 --- a/telegram/ext/_utils/_update_parsing.py +++ b/telegram/ext/_utils/_update_parsing.py @@ -25,12 +25,12 @@ user. Changes to this module are not considered breaking changes and may not be documented in the changelog. """ -from typing import FrozenSet, Optional +from typing import Optional from telegram._utils.types import SCT -def parse_chat_id(chat_id: Optional[SCT[int]]) -> FrozenSet[int]: +def parse_chat_id(chat_id: Optional[SCT[int]]) -> frozenset[int]: """Accepts a chat id or collection of chat ids and returns a frozenset of chat ids.""" if chat_id is None: return frozenset() @@ -39,12 +39,12 @@ def parse_chat_id(chat_id: Optional[SCT[int]]) -> FrozenSet[int]: return frozenset(chat_id) -def parse_username(username: Optional[SCT[str]]) -> FrozenSet[str]: +def parse_username(username: Optional[SCT[str]]) -> frozenset[str]: """Accepts a username or collection of usernames and returns a frozenset of usernames. Strips the leading ``@`` if present. """ if username is None: return frozenset() if isinstance(username, str): - return frozenset({username[1:] if username.startswith("@") else username}) - return frozenset({usr[1:] if usr.startswith("@") else usr for usr in username}) + return frozenset({username.removeprefix("@")}) + return frozenset(usr.removeprefix("@") for usr in username) diff --git a/telegram/ext/_utils/trackingdict.py b/telegram/ext/_utils/trackingdict.py index 682cd648613..05ca5122bce 100644 --- a/telegram/ext/_utils/trackingdict.py +++ b/telegram/ext/_utils/trackingdict.py @@ -26,7 +26,8 @@ the changelog. """ from collections import UserDict -from typing import Final, Generic, List, Mapping, Optional, Set, Tuple, TypeVar, Union +from collections.abc import Mapping +from typing import Final, Generic, Optional, TypeVar, Union from telegram._utils.defaultvalue import DEFAULT_NONE, DefaultValue @@ -52,7 +53,7 @@ class TrackingDict(UserDict, Generic[_KT, _VT]): def __init__(self) -> None: super().__init__() - self._write_access_keys: Set[_KT] = set() + self._write_access_keys: set[_KT] = set() def __setitem__(self, key: _KT, value: _VT) -> None: self.__track_write(key) @@ -62,19 +63,19 @@ def __delitem__(self, key: _KT) -> None: self.__track_write(key) super().__delitem__(key) - def __track_write(self, key: Union[_KT, Set[_KT]]) -> None: + def __track_write(self, key: Union[_KT, set[_KT]]) -> None: if isinstance(key, set): self._write_access_keys |= key else: self._write_access_keys.add(key) - def pop_accessed_keys(self) -> Set[_KT]: + def pop_accessed_keys(self) -> set[_KT]: """Returns all keys that were write-accessed since the last time this method was called.""" out = self._write_access_keys self._write_access_keys = set() return out - def pop_accessed_write_items(self) -> List[Tuple[_KT, _VT]]: + def pop_accessed_write_items(self) -> list[tuple[_KT, _VT]]: """ Returns all keys & corresponding values as set of tuples that were write-accessed since the last time this method was called. If a key was deleted, the value will be diff --git a/telegram/ext/_utils/types.py b/telegram/ext/_utils/types.py index 5f9fc083218..62393355f5a 100644 --- a/telegram/ext/_utils/types.py +++ b/telegram/ext/_utils/types.py @@ -25,18 +25,8 @@ user. Changes to this module are not considered breaking changes and may not be documented in the changelog. """ -from typing import ( - TYPE_CHECKING, - Any, - Callable, - Coroutine, - Dict, - List, - MutableMapping, - Tuple, - TypeVar, - Union, -) +from collections.abc import Coroutine, MutableMapping +from typing import TYPE_CHECKING, Any, Callable, TypeVar, Union if TYPE_CHECKING: from typing import Optional @@ -63,17 +53,17 @@ .. versionadded:: 20.0 """ -ConversationKey = Tuple[Union[int, str], ...] +ConversationKey = tuple[Union[int, str], ...] ConversationDict = MutableMapping[ConversationKey, object] -"""Dict[Tuple[:obj:`int` | :obj:`str`, ...], Optional[:obj:`object`]]: +"""dict[tuple[:obj:`int` | :obj:`str`, ...], Optional[:obj:`object`]]: Dicts as maintained by the :class:`telegram.ext.ConversationHandler`. .. versionadded:: 13.6 """ -CDCData = Tuple[List[Tuple[str, float, Dict[str, Any]]], Dict[str, str]] -"""Tuple[List[Tuple[:obj:`str`, :obj:`float`, Dict[:obj:`str`, :class:`object`]]], \ - Dict[:obj:`str`, :obj:`str`]]: Data returned by +CDCData = tuple[list[tuple[str, float, dict[str, Any]]], dict[str, str]] +"""tuple[list[tuple[:obj:`str`, :obj:`float`, dict[:obj:`str`, :class:`object`]]], \ + dict[:obj:`str`, :obj:`str`]]: Data returned by :attr:`telegram.ext.CallbackDataCache.persistence_data`. .. versionadded:: 13.6 @@ -113,4 +103,4 @@ """Type of the rate limiter arguments. .. versionadded:: 20.0""" -FilterDataDict = Dict[str, List[Any]] +FilterDataDict = dict[str, list[Any]] diff --git a/telegram/ext/_utils/webhookhandler.py b/telegram/ext/_utils/webhookhandler.py index a174fbaa476..d707f9f45c9 100644 --- a/telegram/ext/_utils/webhookhandler.py +++ b/telegram/ext/_utils/webhookhandler.py @@ -24,7 +24,7 @@ from socket import socket from ssl import SSLContext from types import TracebackType -from typing import TYPE_CHECKING, Optional, Type, Union +from typing import TYPE_CHECKING, Optional, Union # Instead of checking for ImportError here, we do that in `updater.py`, where we import from # this module. Doing it here would be tricky, as the classes below subclass tornado classes @@ -210,7 +210,7 @@ def _validate_post(self) -> None: def log_exception( self, - typ: Optional[Type[BaseException]], + typ: Optional[type[BaseException]], value: Optional[BaseException], tb: Optional[TracebackType], ) -> None: diff --git a/telegram/ext/filters.py b/telegram/ext/filters.py index de105e28b6a..7b1f5a45b7f 100644 --- a/telegram/ext/filters.py +++ b/telegram/ext/filters.py @@ -104,22 +104,9 @@ import mimetypes import re from abc import ABC, abstractmethod -from typing import ( - Collection, - Dict, - FrozenSet, - Iterable, - List, - Match, - NoReturn, - Optional, - Pattern, - Sequence, - Set, - Tuple, - Union, - cast, -) +from collections.abc import Collection, Iterable, Sequence +from re import Match, Pattern +from typing import NoReturn, Optional, Union, cast from telegram import Chat as TGChat from telegram import ( @@ -302,7 +289,7 @@ def check_update(self, update: Update) -> Optional[Union[bool, FilterDataDict]]: class MessageFilter(BaseFilter): """Base class for all Message Filters. In contrast to :class:`UpdateFilter`, the object passed - to :meth:`filter` is :obj:`telegram.Update.effective_message`. + to :meth:`filter` is :attr:`telegram.Update.effective_message`. Please see :class:`BaseFilter` for details on how to create custom filters. @@ -320,7 +307,7 @@ def check_update(self, update: Update) -> Optional[Union[bool, FilterDataDict]]: update (:class:`telegram.Update`): The update to check. Returns: - :obj:`bool` | Dict[:obj:`str`, :obj:`list`] | :obj:`None`: If the update should be + :obj:`bool` | dict[:obj:`str`, :obj:`list`] | :obj:`None`: If the update should be handled by this filter, returns :obj:`True` or a dict with lists, in case the filter is a data filter. If the update should not be handled by this filter, :obj:`False` or :obj:`None`. @@ -361,7 +348,7 @@ def check_update(self, update: Update) -> Optional[Union[bool, FilterDataDict]]: update (:class:`telegram.Update`): The update to check. Returns: - :obj:`bool` | Dict[:obj:`str`, :obj:`list`] | :obj:`None`: If the update should be + :obj:`bool` | dict[:obj:`str`, :obj:`list`] | :obj:`None`: If the update should be handled by this filter, returns :obj:`True` or a dict with lists, in case the filter is a data filter. If the update should not be handled by this filter, :obj:`False` or :obj:`None`. @@ -441,7 +428,7 @@ def __init__( self.data_filter = True @staticmethod - def _merge(base_output: Union[bool, Dict], comp_output: Union[bool, Dict]) -> FilterDataDict: + def _merge(base_output: Union[bool, dict], comp_output: Union[bool, dict]) -> FilterDataDict: base = base_output if isinstance(base_output, dict) else {} comp = comp_output if isinstance(comp_output, dict) else {} for k in comp: @@ -585,13 +572,13 @@ class Caption(MessageFilter): :attr:`telegram.ext.filters.CAPTION` Args: - strings (List[:obj:`str`] | Tuple[:obj:`str`], optional): Which captions to allow. Only + strings (list[:obj:`str`] | tuple[:obj:`str`], optional): Which captions to allow. Only exact matches are allowed. If not specified, will allow any message with a caption. """ __slots__ = ("strings",) - def __init__(self, strings: Optional[Union[List[str], Tuple[str, ...]]] = None): + def __init__(self, strings: Optional[Union[list[str], tuple[str, ...]]] = None): self.strings: Optional[Sequence[str]] = strings super().__init__(name=f"filters.Caption({strings})" if strings else "filters.CAPTION") @@ -660,7 +647,7 @@ def __init__(self, pattern: Union[str, Pattern[str]]): self.pattern: Pattern[str] = pattern super().__init__(name=f"filters.CaptionRegex({self.pattern})", data_filter=True) - def filter(self, message: Message) -> Optional[Dict[str, List[Match[str]]]]: + def filter(self, message: Message) -> Optional[dict[str, list[Match[str]]]]: if message.caption and (match := self.pattern.search(message.caption)): return {"matches": [match]} return {} @@ -686,8 +673,8 @@ def __init__( self._username_name: str = "username" self.allow_empty: bool = allow_empty - self._chat_ids: Set[int] = set() - self._usernames: Set[str] = set() + self._chat_ids: set[int] = set() + self._usernames: set[str] = set() self._set_chat_ids(chat_id) self._set_usernames(username) @@ -712,7 +699,7 @@ def _set_usernames(self, username: Optional[SCT[str]]) -> None: self._usernames = set(parse_username(username)) @property - def chat_ids(self) -> FrozenSet[int]: + def chat_ids(self) -> frozenset[int]: return frozenset(self._chat_ids) @chat_ids.setter @@ -720,7 +707,7 @@ def chat_ids(self, chat_id: SCT[int]) -> None: self._set_chat_ids(chat_id) @property - def usernames(self) -> FrozenSet[str]: + def usernames(self) -> frozenset[str]: """Which username(s) to allow through. Warning: @@ -1617,7 +1604,7 @@ def __init__(self, lang: SCT[str]): lang = cast(str, lang) self.lang: Sequence[str] = [lang] else: - lang = cast(List[str], lang) + lang = cast(list[str], lang) self.lang = lang super().__init__(name=f"filters.Language({self.lang})") @@ -1795,7 +1782,7 @@ def __init__(self, pattern: Union[str, Pattern[str]]): self.pattern: Pattern[str] = pattern super().__init__(name=f"filters.Regex({self.pattern})", data_filter=True) - def filter(self, message: Message) -> Optional[Dict[str, List[Match[str]]]]: + def filter(self, message: Message) -> Optional[dict[str, list[Match[str]]]]: if message.text and (match := self.pattern.search(message.text)): return {"matches": [match]} return {} @@ -2440,7 +2427,7 @@ class SuccessfulPayment(MessageFilter): :attr:`telegram.ext.filters.SUCCESSFUL_PAYMENT` Args: - invoice_payloads (List[:obj:`str`] | Tuple[:obj:`str`], optional): Which + invoice_payloads (list[:obj:`str`] | tuple[:obj:`str`], optional): Which invoice payloads to allow. Only exact matches are allowed. If not specified, will allow any invoice payload. @@ -2449,7 +2436,7 @@ class SuccessfulPayment(MessageFilter): __slots__ = ("invoice_payloads",) - def __init__(self, invoice_payloads: Optional[Union[List[str], Tuple[str, ...]]] = None): + def __init__(self, invoice_payloads: Optional[Union[list[str], tuple[str, ...]]] = None): self.invoice_payloads: Optional[Sequence[str]] = invoice_payloads super().__init__( name=( @@ -2498,13 +2485,13 @@ class Text(MessageFilter): commands. Args: - strings (List[:obj:`str`] | Tuple[:obj:`str`], optional): Which messages to allow. Only + strings (list[:obj:`str`] | tuple[:obj:`str`], optional): Which messages to allow. Only exact matches are allowed. If not specified, will allow any text message. """ __slots__ = ("strings",) - def __init__(self, strings: Optional[Union[List[str], Tuple[str, ...]]] = None): + def __init__(self, strings: Optional[Union[list[str], tuple[str, ...]]] = None): self.strings: Optional[Sequence[str]] = strings super().__init__(name=f"filters.Text({strings})" if strings else "filters.TEXT") @@ -2694,7 +2681,7 @@ def _get_chat_or_user(self, message: Message) -> Optional[TGUser]: return message.from_user @property - def user_ids(self) -> FrozenSet[int]: + def user_ids(self) -> frozenset[int]: """ Which user ID(s) to allow through. @@ -2832,7 +2819,7 @@ def _get_chat_or_user(self, message: Message) -> Optional[TGUser]: return message.via_bot @property - def bot_ids(self) -> FrozenSet[int]: + def bot_ids(self) -> frozenset[int]: """ Which bot ID(s) to allow through. diff --git a/telegram/helpers.py b/telegram/helpers.py index d303b64a78b..7d15fed84d5 100644 --- a/telegram/helpers.py +++ b/telegram/helpers.py @@ -36,7 +36,7 @@ from typing import TYPE_CHECKING, Optional, Union from telegram._utils.types import MarkdownVersion -from telegram.constants import MessageType +from telegram.constants import MessageLimit, MessageType if TYPE_CHECKING: from telegram import Message, Update @@ -173,7 +173,8 @@ def create_deep_linked_url( :obj:`str`: An URL to start the bot with specific parameters. Raises: - :exc:`ValueError`: If the length of the :paramref:`payload` exceeds 64 characters, + :exc:`ValueError`: If the length of the :paramref:`payload` exceeds \ + :tg-const:`telegram.constants.MessageLimit.DEEP_LINK_LENGTH` characters, contains invalid characters, or if the :paramref:`bot_username` is less than 4 characters. """ @@ -184,8 +185,10 @@ def create_deep_linked_url( if not payload: return base_url - if len(payload) > 64: - raise ValueError("The deep-linking payload must not exceed 64 characters.") + if len(payload) > MessageLimit.DEEP_LINK_LENGTH: + raise ValueError( + f"The deep-linking payload must not exceed {MessageLimit.DEEP_LINK_LENGTH} characters." + ) if not re.match(r"^[A-Za-z0-9_-]+$", payload): raise ValueError( diff --git a/telegram/request/_baserequest.py b/telegram/request/_baserequest.py index 93024d6c4d0..446315a5b47 100644 --- a/telegram/request/_baserequest.py +++ b/telegram/request/_baserequest.py @@ -19,13 +19,15 @@ """This module contains an abstract class to make POST and GET requests.""" import abc import json +from contextlib import AbstractAsyncContextManager from http import HTTPStatus from types import TracebackType -from typing import AsyncContextManager, Final, List, Optional, Tuple, Type, TypeVar, Union, final +from typing import Final, Optional, TypeVar, Union, final from telegram._utils.defaultvalue import DEFAULT_NONE as _DEFAULT_NONE from telegram._utils.defaultvalue import DefaultValue from telegram._utils.logging import get_logger +from telegram._utils.strings import TextEncoding from telegram._utils.types import JSONDict, ODVInput from telegram._utils.warnings import warn from telegram._version import __version__ as ptb_ver @@ -48,7 +50,7 @@ class BaseRequest( - AsyncContextManager["BaseRequest"], + AbstractAsyncContextManager["BaseRequest"], abc.ABC, ): """Abstract interface class that allows python-telegram-bot to make requests to the Bot API. @@ -114,14 +116,14 @@ async def __aenter__(self: RT) -> RT: """ try: await self.initialize() - return self - except Exception as exc: + except Exception: await self.shutdown() - raise exc + raise + return self async def __aexit__( self, - exc_type: Optional[Type[BaseException]], + exc_type: Optional[type[BaseException]], exc_val: Optional[BaseException], exc_tb: Optional[TracebackType], ) -> None: @@ -165,7 +167,7 @@ async def post( write_timeout: ODVInput[float] = DEFAULT_NONE, connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, - ) -> Union[JSONDict, List[JSONDict], bool]: + ) -> Union[JSONDict, list[JSONDict], bool]: """Makes a request to the Bot API handles the return code and parses the answer. Warning: @@ -338,8 +340,8 @@ async def _request_wrapper( connect_timeout=connect_timeout, pool_timeout=pool_timeout, ) - except TelegramError as exc: - raise exc + except TelegramError: + raise except Exception as exc: raise NetworkError(f"Unknown error in HTTP implementation: {exc!r}") from exc @@ -403,11 +405,11 @@ def parse_json_payload(payload: bytes) -> JSONDict: Raises: TelegramError: If loading the JSON data failed """ - decoded_s = payload.decode("utf-8", "replace") + decoded_s = payload.decode(TextEncoding.UTF_8, "replace") try: return json.loads(decoded_s) except ValueError as exc: - _LOGGER.error('Can not load invalid JSON data: "%s"', decoded_s) + _LOGGER.exception('Can not load invalid JSON data: "%s"', decoded_s) raise TelegramError("Invalid server response") from exc @abc.abstractmethod @@ -420,7 +422,7 @@ async def do_request( write_timeout: ODVInput[float] = DEFAULT_NONE, connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, - ) -> Tuple[int, bytes]: + ) -> tuple[int, bytes]: """Makes a request to the Bot API. Must be implemented by a subclass. Warning: @@ -450,6 +452,6 @@ async def do_request( :attr:`DEFAULT_NONE`. Returns: - Tuple[:obj:`int`, :obj:`bytes`]: The HTTP return code & the payload part of the server + tuple[:obj:`int`, :obj:`bytes`]: The HTTP return code & the payload part of the server response. """ diff --git a/telegram/request/_httpxrequest.py b/telegram/request/_httpxrequest.py index e9861539234..08c2bfcc511 100644 --- a/telegram/request/_httpxrequest.py +++ b/telegram/request/_httpxrequest.py @@ -17,7 +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/]. """This module contains methods to make POST and GET requests using the httpx library.""" -from typing import Collection, Optional, Tuple, Union +from collections.abc import Collection +from typing import Any, Optional, Union import httpx @@ -122,6 +123,20 @@ class HTTPXRequest(BaseRequest): :meth:`do_request`. Defaults to ``20`` seconds. .. versionadded:: 21.0 + httpx_kwargs (dict[:obj:`str`, Any], optional): Additional keyword arguments to be passed + to the `httpx.AsyncClient `_ + constructor. + + Warning: + This parameter is intended for advanced users that want to fine-tune the behavior + of the underlying ``httpx`` client. The values passed here will override all the + defaults set by ``python-telegram-bot`` and all other parameters passed to + :class:`HTTPXRequest`. The only exception is the :paramref:`media_write_timeout` + parameter, which is not passed to the client constructor. + No runtime warnings will be issued about parameters that are overridden in this + way. + + .. versionadded:: 21.6 """ @@ -139,6 +154,7 @@ def __init__( socket_options: Optional[Collection[SocketOpt]] = None, proxy: Optional[Union[str, httpx.Proxy, httpx.URL]] = None, media_write_timeout: Optional[float] = 20.0, + httpx_kwargs: Optional[dict[str, Any]] = None, ): if proxy_url is not None and proxy is not None: raise ValueError("The parameters `proxy_url` and `proxy` are mutually exclusive.") @@ -183,13 +199,14 @@ def __init__( "limits": limits, "transport": transport, **http_kwargs, + **(httpx_kwargs or {}), } try: self._client = self._build_client() except ImportError as exc: if "httpx[http2]" not in str(exc) and "httpx[socks]" not in str(exc): - raise exc + raise if "httpx[socks]" in str(exc): raise RuntimeError( @@ -221,7 +238,7 @@ def read_timeout(self) -> Optional[float]: return self._client.timeout.read def _build_client(self) -> httpx.AsyncClient: - return httpx.AsyncClient(**self._client_kwargs) # type: ignore[arg-type] + return httpx.AsyncClient(**self._client_kwargs) async def initialize(self) -> None: """See :meth:`BaseRequest.initialize`.""" @@ -245,7 +262,7 @@ async def do_request( write_timeout: ODVInput[float] = BaseRequest.DEFAULT_NONE, connect_timeout: ODVInput[float] = BaseRequest.DEFAULT_NONE, pool_timeout: ODVInput[float] = BaseRequest.DEFAULT_NONE, - ) -> Tuple[int, bytes]: + ) -> tuple[int, bytes]: """See :meth:`BaseRequest.do_request`.""" if self._client.is_closed: raise RuntimeError("This HTTPXRequest is not initialized!") diff --git a/telegram/request/_requestdata.py b/telegram/request/_requestdata.py index 658a445649d..9e89f0090bf 100644 --- a/telegram/request/_requestdata.py +++ b/telegram/request/_requestdata.py @@ -18,9 +18,10 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains a class that holds the parameters of a request to the Bot API.""" import json -from typing import Any, Dict, List, Optional, Union, final +from typing import Any, Optional, Union, final from urllib.parse import urlencode +from telegram._utils.strings import TextEncoding from telegram._utils.types import UploadFileDict from telegram.request._requestparameter import RequestParameter @@ -44,16 +45,19 @@ class RequestData: __slots__ = ("_parameters", "contains_files") - def __init__(self, parameters: Optional[List[RequestParameter]] = None): - self._parameters: List[RequestParameter] = parameters or [] + def __init__(self, parameters: Optional[list[RequestParameter]] = None): + self._parameters: list[RequestParameter] = parameters or [] self.contains_files: bool = any(param.input_files for param in self._parameters) @property - def parameters(self) -> Dict[str, Union[str, int, List[Any], Dict[Any, Any]]]: + def parameters(self) -> dict[str, Union[str, int, list[Any], dict[Any, Any]]]: """Gives the parameters as mapping of parameter name to the parameter value, which can be a single object of type :obj:`int`, :obj:`float`, :obj:`str` or :obj:`bool` or any (possibly nested) composition of lists, tuples and dictionaries, where each entry, key and value is of one of the mentioned types. + + Returns: + dict[:obj:`str`, Union[:obj:`str`, :obj:`int`, list[any], dict[any, any]]] """ return { param.name: param.value # type: ignore[misc] @@ -62,7 +66,7 @@ def parameters(self) -> Dict[str, Union[str, int, List[Any], Dict[Any, Any]]]: } @property - def json_parameters(self) -> Dict[str, str]: + def json_parameters(self) -> dict[str, str]: """Gives the parameters as mapping of parameter name to the respective JSON encoded value. @@ -70,6 +74,9 @@ def json_parameters(self) -> Dict[str, str]: By default, this property uses the standard library's :func:`json.dumps`. To use a custom library for JSON encoding, you can directly encode the keys of :attr:`parameters` - note that string valued keys should not be JSON encoded. + + Returns: + dict[:obj:`str`, :obj:`str`] """ return { param.name: param.json_value @@ -77,25 +84,31 @@ def json_parameters(self) -> Dict[str, str]: if param.json_value is not None } - def url_encoded_parameters(self, encode_kwargs: Optional[Dict[str, Any]] = None) -> str: + def url_encoded_parameters(self, encode_kwargs: Optional[dict[str, Any]] = None) -> str: """Encodes the parameters with :func:`urllib.parse.urlencode`. Args: - encode_kwargs (Dict[:obj:`str`, any], optional): Additional keyword arguments to pass + encode_kwargs (dict[:obj:`str`, any], optional): Additional keyword arguments to pass along to :func:`urllib.parse.urlencode`. + + Returns: + :obj:`str` """ if encode_kwargs: return urlencode(self.json_parameters, **encode_kwargs) return urlencode(self.json_parameters) - def parametrized_url(self, url: str, encode_kwargs: Optional[Dict[str, Any]] = None) -> str: + def parametrized_url(self, url: str, encode_kwargs: Optional[dict[str, Any]] = None) -> str: """Shortcut for attaching the return value of :meth:`url_encoded_parameters` to the :paramref:`url`. Args: url (:obj:`str`): The URL the parameters will be attached to. - encode_kwargs (Dict[:obj:`str`, any], optional): Additional keyword arguments to pass + encode_kwargs (dict[:obj:`str`, any], optional): Additional keyword arguments to pass along to :func:`urllib.parse.urlencode`. + + Returns: + :obj:`str` """ url_parameters = self.url_encoded_parameters(encode_kwargs=encode_kwargs) return f"{url}?{url_parameters}" @@ -108,12 +121,19 @@ def json_payload(self) -> bytes: By default, this property uses the standard library's :func:`json.dumps`. To use a custom library for JSON encoding, you can directly encode the keys of :attr:`parameters` - note that string valued keys should not be JSON encoded. + + Returns: + :obj:`bytes` """ - return json.dumps(self.json_parameters).encode("utf-8") + return json.dumps(self.json_parameters).encode(TextEncoding.UTF_8) @property def multipart_data(self) -> UploadFileDict: - """Gives the files contained in this object as mapping of part name to encoded content.""" + """Gives the files contained in this object as mapping of part name to encoded content. + + .. versionchanged:: 21.5 + Content may now be a file handle. + """ multipart_data: UploadFileDict = {} for param in self._parameters: m_data = param.multipart_data diff --git a/telegram/request/_requestparameter.py b/telegram/request/_requestparameter.py index ab11cbce793..996574c7d46 100644 --- a/telegram/request/_requestparameter.py +++ b/telegram/request/_requestparameter.py @@ -17,10 +17,11 @@ # 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 a class that describes a single parameter of a request to the Bot API.""" +import datetime as dtm import json +from collections.abc import Sequence from dataclasses import dataclass -from datetime import datetime -from typing import List, Optional, Sequence, Tuple, final +from typing import Optional, final from telegram._files.inputfile import InputFile from telegram._files.inputmedia import InputMedia, InputPaidMedia @@ -47,13 +48,13 @@ class RequestParameter: Args: name (:obj:`str`): The name of the parameter. value (:obj:`object` | :obj:`None`): The value of the parameter. Must be JSON-dumpable. - input_files (List[:class:`telegram.InputFile`], optional): A list of files that should be + input_files (list[:class:`telegram.InputFile`], optional): A list of files that should be uploaded along with this parameter. Attributes: name (:obj:`str`): The name of the parameter. value (:obj:`object` | :obj:`None`): The value of the parameter. - input_files (List[:class:`telegram.InputFile` | :obj:`None`): A list of files that should + input_files (list[:class:`telegram.InputFile` | :obj:`None`): A list of files that should be uploaded along with this parameter. """ @@ -61,7 +62,7 @@ class RequestParameter: name: str value: object - input_files: Optional[List[InputFile]] + input_files: Optional[list[InputFile]] @property def json_value(self) -> Optional[str]: @@ -77,7 +78,11 @@ def json_value(self) -> Optional[str]: @property def multipart_data(self) -> Optional[UploadFileDict]: - """A dict with the file data to upload, if any.""" + """A dict with the file data to upload, if any. + + .. versionchanged:: 21.5 + Content may now be a file handle. + """ if not self.input_files: return None return { @@ -88,7 +93,7 @@ def multipart_data(self) -> Optional[UploadFileDict]: @staticmethod def _value_and_input_files_from_input( # pylint: disable=too-many-return-statements value: object, - ) -> Tuple[object, List[InputFile]]: + ) -> tuple[object, list[InputFile]]: """Converts `value` into something that we can json-dump. Returns two values: 1. the JSON-dumpable value. May be `None` in case the value is an InputFile which must not be uploaded via an attach:// URI @@ -108,7 +113,7 @@ def _value_and_input_files_from_input( # pylint: disable=too-many-return-statem * if a user passes a custom enum, it's unlikely that we can actually properly handle it even with some special casing. """ - if isinstance(value, datetime): + if isinstance(value, dtm.datetime): return to_timestamp(value), [] if isinstance(value, StringEnum): return value.value, [] diff --git a/tests/README.rst b/tests/README.rst index 69591953bc3..a6724558041 100644 --- a/tests/README.rst +++ b/tests/README.rst @@ -72,7 +72,7 @@ complete and correct. To run it, export an environment variable first: $ export TEST_OFFICIAL=true -and then run ``pytest tests/test_official.py``. Note: You need py 3.10+ to run this test. +and then run ``pytest tests/test_official/test_official.py``. Note: You need py 3.10+ to run this test. We also have another marker, ``@pytest.mark.dev``, which you can add to tests that you want to run selectively. Use as follows: @@ -98,7 +98,7 @@ Bots used in tests If you run the tests locally, the test setup will use one of the two public bots available. Which bot of the two gets chosen for the test session is random. Whereas when the tests on the -Github Actions CI are run, the test setup allocates a different, but same bot is for every combination of Python version and +Github Actions CI are run, the test setup allocates a different, but the same bot is allocated for every combination of Python version and OS. The operating systems and Python versions the CI runs the tests on can be viewed in the `corresponding workflow`_. diff --git a/tests/_files/conftest.py b/tests/_files/conftest.py new file mode 100644 index 00000000000..f2ae1d3abd5 --- /dev/null +++ b/tests/_files/conftest.py @@ -0,0 +1,189 @@ +#!/usr/bin/env python +# +# A library that provides a Python interface to the Telegram Bot API +# Copyright (C) 2015-2024 +# Leandro Toledo de Souza +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser Public License for more details. +# +# You should have received a copy of the GNU Lesser Public License +# along with this program. If not, see [http://www.gnu.org/licenses/]. +"""Module to provide fixtures most of which are used in test_inputmedia.py.""" +import pytest + +from telegram.error import BadRequest +from tests.auxil.files import data_file +from tests.auxil.networking import expect_bad_request + + +@pytest.fixture(scope="session") +async def animation(bot, chat_id): + with data_file("game.gif").open("rb") as f, data_file("thumb.jpg").open("rb") as thumb: + return ( + await bot.send_animation(chat_id, animation=f, read_timeout=50, thumbnail=thumb) + ).animation + + +@pytest.fixture +def animation_file(): + with data_file("game.gif").open("rb") as f: + yield f + + +@pytest.fixture(scope="module") +async def animated_sticker(bot, chat_id): + with data_file("telegram_animated_sticker.tgs").open("rb") as f: + return (await bot.send_sticker(chat_id, sticker=f, read_timeout=50)).sticker + + +@pytest.fixture +def animated_sticker_file(): + with data_file("telegram_animated_sticker.tgs").open("rb") as f: + yield f + + +@pytest.fixture +async def animated_sticker_set(bot): + ss = await bot.get_sticker_set(f"animated_test_by_{bot.username}") + if len(ss.stickers) > 100: + try: + for i in range(1, 50): + await bot.delete_sticker_from_set(ss.stickers[-i].file_id) + except BadRequest as e: + if e.message == "Stickerset_not_modified": + return ss + raise Exception("stickerset is growing too large.") from None + return ss + + +@pytest.fixture(scope="session") +async def audio(bot, chat_id): + with data_file("telegram.mp3").open("rb") as f, data_file("thumb.jpg").open("rb") as thumb: + return (await bot.send_audio(chat_id, audio=f, read_timeout=50, thumbnail=thumb)).audio + + +@pytest.fixture +def audio_file(): + with data_file("telegram.mp3").open("rb") as f: + yield f + + +@pytest.fixture(scope="session") +async def document(bot, chat_id): + with data_file("telegram.png").open("rb") as f: + return (await bot.send_document(chat_id, document=f, read_timeout=50)).document + + +@pytest.fixture +def document_file(): + with data_file("telegram.png").open("rb") as f: + yield f + + +@pytest.fixture(scope="session") +def photo(photolist): + return photolist[-1] + + +@pytest.fixture +def photo_file(): + with data_file("telegram.jpg").open("rb") as f: + yield f + + +@pytest.fixture(scope="session") +async def photolist(bot, chat_id): + async def func(): + with data_file("telegram.jpg").open("rb") as f: + return (await bot.send_photo(chat_id, photo=f, read_timeout=50)).photo + + return await expect_bad_request( + func, "Type of file mismatch", "Telegram did not accept the file." + ) + + +@pytest.fixture(scope="module") +async def sticker(bot, chat_id): + with data_file("telegram.webp").open("rb") as f: + sticker = (await bot.send_sticker(chat_id, sticker=f, read_timeout=50)).sticker + # necessary to properly test needs_repainting + with sticker._unfrozen(): + sticker.needs_repainting = True + return sticker + + +@pytest.fixture +def sticker_file(): + with data_file("telegram.webp").open("rb") as file: + yield file + + +@pytest.fixture +async def sticker_set(bot): + ss = await bot.get_sticker_set(f"test_by_{bot.username}") + if len(ss.stickers) > 100: + try: + for i in range(1, 50): + await bot.delete_sticker_from_set(ss.stickers[-i].file_id) + except BadRequest as e: + if e.message == "Stickerset_not_modified": + return ss + raise Exception("stickerset is growing too large.") from None + return ss + + +@pytest.fixture +def sticker_set_thumb_file(): + with data_file("sticker_set_thumb.png").open("rb") as file: + yield file + + +@pytest.fixture(scope="session") +def thumb(photolist): + return photolist[0] + + +@pytest.fixture(scope="session") +async def video(bot, chat_id): + with data_file("telegram.mp4").open("rb") as f: + return (await bot.send_video(chat_id, video=f, read_timeout=50)).video + + +@pytest.fixture +def video_file(): + with data_file("telegram.mp4").open("rb") as f: + yield f + + +@pytest.fixture +def video_sticker_file(): + with data_file("telegram_video_sticker.webm").open("rb") as f: + yield f + + +@pytest.fixture(scope="module") +def video_sticker(bot, chat_id): + with data_file("telegram_video_sticker.webm").open("rb") as f: + return bot.send_sticker(chat_id, sticker=f, timeout=50).sticker + + +@pytest.fixture +async def video_sticker_set(bot): + ss = await bot.get_sticker_set(f"video_test_by_{bot.username}") + if len(ss.stickers) > 100: + try: + for i in range(1, 50): + await bot.delete_sticker_from_set(ss.stickers[-i].file_id) + except BadRequest as e: + if e.message == "Stickerset_not_modified": + return ss + raise Exception("stickerset is growing too large.") from None + return ss diff --git a/tests/_files/test_animation.py b/tests/_files/test_animation.py index 74a17fca48a..0f581259db9 100644 --- a/tests/_files/test_animation.py +++ b/tests/_files/test_animation.py @@ -37,21 +37,7 @@ from tests.auxil.slots import mro_slots -@pytest.fixture() -def animation_file(): - with data_file("game.gif").open("rb") as f: - yield f - - -@pytest.fixture(scope="module") -async def animation(bot, chat_id): - with data_file("game.gif").open("rb") as f, data_file("thumb.jpg").open("rb") as thumb: - return ( - await bot.send_animation(chat_id, animation=f, read_timeout=50, thumbnail=thumb) - ).animation - - -class TestAnimationBase: +class AnimationTestBase: animation_file_id = "CgADAQADngIAAuyVeEez0xRovKi9VAI" animation_file_unique_id = "adc3145fd2e84d95b64d68eaa22aa33e" width = 320 @@ -66,7 +52,7 @@ class TestAnimationBase: caption = "Test *animation*" -class TestAnimationWithoutRequest(TestAnimationBase): +class TestAnimationWithoutRequest(AnimationTestBase): def test_slot_behaviour(self, animation): for attr in animation.__slots__: assert getattr(animation, attr, "err") != "err", f"got extra slot '{attr}'" @@ -84,7 +70,7 @@ def test_expected_values(self, animation): assert animation.file_name.startswith("game.gif") == self.file_name.startswith("game.gif") assert isinstance(animation.thumbnail, PhotoSize) - def test_de_json(self, bot, animation): + def test_de_json(self, offline_bot, animation): json_dict = { "file_id": self.animation_file_id, "file_unique_id": self.animation_file_unique_id, @@ -96,7 +82,7 @@ def test_de_json(self, bot, animation): "mime_type": self.mime_type, "file_size": self.file_size, } - animation = Animation.de_json(json_dict, bot) + animation = Animation.de_json(json_dict, offline_bot) assert animation.api_kwargs == {} assert animation.file_id == self.animation_file_id assert animation.file_unique_id == self.animation_file_unique_id @@ -140,18 +126,22 @@ def test_equality(self): assert a != e assert hash(a) != hash(e) - async def test_send_animation_custom_filename(self, bot, chat_id, animation_file, monkeypatch): + async def test_send_animation_custom_filename( + self, offline_bot, chat_id, animation_file, monkeypatch + ): async def make_assertion(url, request_data: RequestData, *args, **kwargs): return next(iter(request_data.multipart_data.values()))[0] == "custom_filename" - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.send_animation(chat_id, animation_file, filename="custom_filename") + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.send_animation( + chat_id, animation_file, filename="custom_filename" + ) @pytest.mark.parametrize("local_mode", [True, False]) - async def test_send_animation_local_files(self, monkeypatch, bot, chat_id, local_mode): + async def test_send_animation_local_files(self, monkeypatch, offline_bot, chat_id, local_mode): try: - bot._local_mode = local_mode - # For just test that the correct paths are passed as we have no local bot API set up + offline_bot._local_mode = local_mode + # For just test that the correct paths are passed as we have no local Bot API set up test_flag = False file = data_file("telegram.jpg") expected = file.as_uri() @@ -167,18 +157,18 @@ async def make_assertion(_, data, *args, **kwargs): data.get("thumbnail"), InputFile ) - monkeypatch.setattr(bot, "_post", make_assertion) - await bot.send_animation(chat_id, file, thumbnail=file) + monkeypatch.setattr(offline_bot, "_post", make_assertion) + await offline_bot.send_animation(chat_id, file, thumbnail=file) assert test_flag finally: - bot._local_mode = False + offline_bot._local_mode = False - async def test_send_with_animation(self, monkeypatch, bot, chat_id, animation): + async def test_send_with_animation(self, monkeypatch, offline_bot, chat_id, animation): async def make_assertion(url, request_data: RequestData, *args, **kwargs): return request_data.json_parameters["animation"] == animation.file_id - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.send_animation(animation=animation, chat_id=chat_id) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.send_animation(animation=animation, chat_id=chat_id) async def test_get_file_instance_method(self, monkeypatch, animation): async def make_assertion(*_, **kwargs): @@ -219,7 +209,7 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): ) -class TestAnimationWithRequest(TestAnimationBase): +class TestAnimationWithRequest(AnimationTestBase): async def test_send_all_args(self, bot, chat_id, animation_file, animation, thumb_file): message = await bot.send_animation( chat_id, @@ -243,7 +233,8 @@ async def test_send_all_args(self, bot, chat_id, animation_file, animation, thum assert message.animation.file_unique_id assert message.animation.file_name == animation.file_name assert message.animation.mime_type == animation.mime_type - assert message.animation.file_size == animation.file_size + # TGs reported file size is not reliable + assert isinstance(message.animation.file_size, int) assert message.animation.thumbnail.width == self.width assert message.animation.thumbnail.height == self.height assert message.has_protected_content diff --git a/tests/_files/test_audio.py b/tests/_files/test_audio.py index 12857ddc6e9..08e598cb267 100644 --- a/tests/_files/test_audio.py +++ b/tests/_files/test_audio.py @@ -37,19 +37,7 @@ from tests.auxil.slots import mro_slots -@pytest.fixture() -def audio_file(): - with data_file("telegram.mp3").open("rb") as f: - yield f - - -@pytest.fixture(scope="module") -async def audio(bot, chat_id): - with data_file("telegram.mp3").open("rb") as f, data_file("thumb.jpg").open("rb") as thumb: - return (await bot.send_audio(chat_id, audio=f, read_timeout=50, thumbnail=thumb)).audio - - -class TestAudioBase: +class AudioTestBase: caption = "Test *audio*" performer = "Leandro Toledo" title = "Teste" @@ -67,7 +55,7 @@ class TestAudioBase: audio_file_unique_id = "adc3145fd2e84d95b64d68eaa22aa33e" -class TestAudioWithoutRequest(TestAudioBase): +class TestAudioWithoutRequest(AudioTestBase): def test_slot_behaviour(self, audio): for attr in audio.__slots__: assert getattr(audio, attr, "err") != "err", f"got extra slot '{attr}'" @@ -91,7 +79,7 @@ def test_expected_values(self, audio): assert audio.thumbnail.width == self.thumb_width assert audio.thumbnail.height == self.thumb_height - def test_de_json(self, bot, audio): + def test_de_json(self, offline_bot, audio): json_dict = { "file_id": self.audio_file_id, "file_unique_id": self.audio_file_unique_id, @@ -103,7 +91,7 @@ def test_de_json(self, bot, audio): "file_size": self.file_size, "thumbnail": audio.thumbnail.to_dict(), } - json_audio = Audio.de_json(json_dict, bot) + json_audio = Audio.de_json(json_dict, offline_bot) assert json_audio.api_kwargs == {} assert json_audio.file_id == self.audio_file_id @@ -147,25 +135,25 @@ def test_equality(self, audio): assert a != e assert hash(a) != hash(e) - async def test_send_with_audio(self, monkeypatch, bot, chat_id, audio): + async def test_send_with_audio(self, monkeypatch, offline_bot, chat_id, audio): async def make_assertion(url, request_data: RequestData, *args, **kwargs): return request_data.json_parameters["audio"] == audio.file_id - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.send_audio(audio=audio, chat_id=chat_id) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.send_audio(audio=audio, chat_id=chat_id) - async def test_send_audio_custom_filename(self, bot, chat_id, audio_file, monkeypatch): + async def test_send_audio_custom_filename(self, offline_bot, chat_id, audio_file, monkeypatch): async def make_assertion(url, request_data: RequestData, *args, **kwargs): return next(iter(request_data.multipart_data.values()))[0] == "custom_filename" - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.send_audio(chat_id, audio_file, filename="custom_filename") + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.send_audio(chat_id, audio_file, filename="custom_filename") @pytest.mark.parametrize("local_mode", [True, False]) - async def test_send_audio_local_files(self, monkeypatch, bot, chat_id, local_mode): + async def test_send_audio_local_files(self, monkeypatch, offline_bot, chat_id, local_mode): try: - bot._local_mode = local_mode - # For just test that the correct paths are passed as we have no local bot API set up + offline_bot._local_mode = local_mode + # For just test that the correct paths are passed as we have no local Bot API set up test_flag = False file = data_file("telegram.jpg") expected = file.as_uri() @@ -179,11 +167,11 @@ async def make_assertion(_, data, *args, **kwargs): data.get("thumbnail"), InputFile ) - monkeypatch.setattr(bot, "_post", make_assertion) - await bot.send_audio(chat_id, file, thumbnail=file) + monkeypatch.setattr(offline_bot, "_post", make_assertion) + await offline_bot.send_audio(chat_id, file, thumbnail=file) assert test_flag finally: - bot._local_mode = False + offline_bot._local_mode = False async def test_get_file_instance_method(self, monkeypatch, audio): async def make_assertion(*_, **kwargs): @@ -222,7 +210,7 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): await default_bot.send_audio(chat_id, audio, reply_parameters=ReplyParameters(**kwargs)) -class TestAudioWithRequest(TestAudioBase): +class TestAudioWithRequest(AudioTestBase): async def test_send_all_args(self, bot, chat_id, audio_file, thumb_file): message = await bot.send_audio( chat_id, diff --git a/tests/_files/test_chatphoto.py b/tests/_files/test_chatphoto.py index ea853fd6b4f..5bbb6a8f71e 100644 --- a/tests/_files/test_chatphoto.py +++ b/tests/_files/test_chatphoto.py @@ -36,7 +36,7 @@ from tests.auxil.slots import mro_slots -@pytest.fixture() +@pytest.fixture def chatphoto_file(): with data_file("telegram.jpg").open("rb") as f: yield f @@ -52,7 +52,7 @@ async def func(): ) -class TestChatPhotoBase: +class ChatPhotoTestBase: chatphoto_small_file_id = "smallCgADAQADngIAAuyVeEez0xRovKi9VAI" chatphoto_big_file_id = "bigCgADAQADngIAAuyVeEez0xRovKi9VAI" chatphoto_small_file_unique_id = "smalladc3145fd2e84d95b64d68eaa22aa33e" @@ -60,20 +60,20 @@ class TestChatPhotoBase: chatphoto_file_url = "https://python-telegram-bot.org/static/testfiles/telegram.jpg" -class TestChatPhotoWithoutRequest(TestChatPhotoBase): +class TestChatPhotoWithoutRequest(ChatPhotoTestBase): def test_slot_behaviour(self, chat_photo): for attr in chat_photo.__slots__: assert getattr(chat_photo, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(chat_photo)) == len(set(mro_slots(chat_photo))), "duplicate slot" - def test_de_json(self, bot, chat_photo): + def test_de_json(self, offline_bot, chat_photo): json_dict = { "small_file_id": self.chatphoto_small_file_id, "big_file_id": self.chatphoto_big_file_id, "small_file_unique_id": self.chatphoto_small_file_unique_id, "big_file_unique_id": self.chatphoto_big_file_unique_id, } - chat_photo = ChatPhoto.de_json(json_dict, bot) + chat_photo = ChatPhoto.de_json(json_dict, offline_bot) assert chat_photo.api_kwargs == {} assert chat_photo.small_file_id == self.chatphoto_small_file_id assert chat_photo.big_file_id == self.chatphoto_big_file_id @@ -121,12 +121,14 @@ def test_equality(self): assert a != e assert hash(a) != hash(e) - async def test_send_with_chat_photo(self, monkeypatch, bot, super_group_id, chat_photo): + async def test_send_with_chat_photo( + self, monkeypatch, offline_bot, super_group_id, chat_photo + ): async def make_assertion(url, request_data: RequestData, *args, **kwargs): return request_data.parameters["photo"] == chat_photo.to_dict() - monkeypatch.setattr(bot.request, "post", make_assertion) - message = await bot.set_chat_photo(photo=chat_photo, chat_id=super_group_id) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + message = await offline_bot.set_chat_photo(photo=chat_photo, chat_id=super_group_id) assert message async def test_get_small_file_instance_method(self, monkeypatch, chat_photo): diff --git a/tests/_files/test_contact.py b/tests/_files/test_contact.py index a4793c3faf5..0869d7ff33e 100644 --- a/tests/_files/test_contact.py +++ b/tests/_files/test_contact.py @@ -32,42 +32,42 @@ @pytest.fixture(scope="module") def contact(): return Contact( - TestContactBase.phone_number, - TestContactBase.first_name, - TestContactBase.last_name, - TestContactBase.user_id, + ContactTestBase.phone_number, + ContactTestBase.first_name, + ContactTestBase.last_name, + ContactTestBase.user_id, ) -class TestContactBase: +class ContactTestBase: phone_number = "+11234567890" first_name = "Leandro" last_name = "Toledo" user_id = 23 -class TestContactWithoutRequest(TestContactBase): +class TestContactWithoutRequest(ContactTestBase): def test_slot_behaviour(self, contact): for attr in contact.__slots__: assert getattr(contact, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(contact)) == len(set(mro_slots(contact))), "duplicate slot" - def test_de_json_required(self, bot): + def test_de_json_required(self, offline_bot): json_dict = {"phone_number": self.phone_number, "first_name": self.first_name} - contact = Contact.de_json(json_dict, bot) + contact = Contact.de_json(json_dict, offline_bot) assert contact.api_kwargs == {} assert contact.phone_number == self.phone_number assert contact.first_name == self.first_name - def test_de_json_all(self, bot): + def test_de_json_all(self, offline_bot): json_dict = { "phone_number": self.phone_number, "first_name": self.first_name, "last_name": self.last_name, "user_id": self.user_id, } - contact = Contact.de_json(json_dict, bot) + contact = Contact.de_json(json_dict, offline_bot) assert contact.api_kwargs == {} assert contact.phone_number == self.phone_number @@ -104,20 +104,20 @@ def test_equality(self): assert a != e assert hash(a) != hash(e) - async def test_send_contact_without_required(self, bot, chat_id): + async def test_send_contact_without_required(self, offline_bot, chat_id): with pytest.raises(ValueError, match="Either contact or phone_number and first_name"): - await bot.send_contact(chat_id=chat_id) + await offline_bot.send_contact(chat_id=chat_id) - async def test_send_mutually_exclusive(self, bot, chat_id, contact): + async def test_send_mutually_exclusive(self, offline_bot, chat_id, contact): with pytest.raises(ValueError, match="Not both"): - await bot.send_contact( + await offline_bot.send_contact( chat_id=chat_id, contact=contact, phone_number=contact.phone_number, first_name=contact.first_name, ) - async def test_send_with_contact(self, monkeypatch, bot, chat_id, contact): + async def test_send_with_contact(self, monkeypatch, offline_bot, chat_id, contact): async def make_assertion(url, request_data: RequestData, *args, **kwargs): data = request_data.json_parameters phone = data["phone_number"] == contact.phone_number @@ -125,8 +125,8 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): last = data["last_name"] == contact.last_name return phone and first and last - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.send_contact(contact=contact, chat_id=chat_id) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.send_contact(contact=contact, chat_id=chat_id) @pytest.mark.parametrize( ("default_bot", "custom"), @@ -156,7 +156,7 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): ) -class TestContactWithRequest(TestContactBase): +class TestContactWithRequest(ContactTestBase): @pytest.mark.parametrize( ("default_bot", "custom"), [ diff --git a/tests/_files/test_document.py b/tests/_files/test_document.py index 5d078fced20..e6037403408 100644 --- a/tests/_files/test_document.py +++ b/tests/_files/test_document.py @@ -37,19 +37,7 @@ from tests.auxil.slots import mro_slots -@pytest.fixture() -def document_file(): - with data_file("telegram.png").open("rb") as f: - yield f - - -@pytest.fixture(scope="module") -async def document(bot, chat_id): - with data_file("telegram.png").open("rb") as f: - return (await bot.send_document(chat_id, document=f, read_timeout=50)).document - - -class TestDocumentBase: +class DocumentTestBase: caption = "DocumentTest - *Caption*" document_file_url = "https://python-telegram-bot.org/static/testfiles/telegram.gif" file_size = 12948 @@ -62,7 +50,7 @@ class TestDocumentBase: document_file_unique_id = "adc3145fd2e84d95b64d68eaa22aa33e" -class TestDocumentWithoutRequest(TestDocumentBase): +class TestDocumentWithoutRequest(DocumentTestBase): def test_slot_behaviour(self, document): for attr in document.__slots__: assert getattr(document, attr, "err") != "err", f"got extra slot '{attr}'" @@ -83,7 +71,7 @@ def test_expected_values(self, document): assert document.thumbnail.width == self.thumb_width assert document.thumbnail.height == self.thumb_height - def test_de_json(self, bot, document): + def test_de_json(self, offline_bot, document): json_dict = { "file_id": self.document_file_id, "file_unique_id": self.document_file_unique_id, @@ -92,7 +80,7 @@ def test_de_json(self, bot, document): "mime_type": self.mime_type, "file_size": self.file_size, } - test_document = Document.de_json(json_dict, bot) + test_document = Document.de_json(json_dict, offline_bot) assert test_document.api_kwargs == {} assert test_document.file_id == self.document_file_id @@ -128,13 +116,13 @@ def test_equality(self, document): assert a != e assert hash(a) != hash(e) - async def test_error_send_without_required_args(self, bot, chat_id): + async def test_error_send_without_required_args(self, offline_bot, chat_id): with pytest.raises(TypeError): - await bot.send_document(chat_id=chat_id) + await offline_bot.send_document(chat_id=chat_id) @pytest.mark.parametrize("disable_content_type_detection", [True, False, None]) async def test_send_with_document( - self, monkeypatch, bot, chat_id, document, disable_content_type_detection + self, monkeypatch, offline_bot, chat_id, document, disable_content_type_detection ): async def make_assertion(url, request_data: RequestData, *args, **kwargs): data = request_data.parameters @@ -143,9 +131,9 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): ) return data["document"] == document.file_id and type_detection - monkeypatch.setattr(bot.request, "post", make_assertion) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) - message = await bot.send_document( + message = await offline_bot.send_document( document=document, chat_id=chat_id, disable_content_type_detection=disable_content_type_detection, @@ -181,10 +169,10 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): ) @pytest.mark.parametrize("local_mode", [True, False]) - async def test_send_document_local_files(self, monkeypatch, bot, chat_id, local_mode): + async def test_send_document_local_files(self, monkeypatch, offline_bot, chat_id, local_mode): try: - bot._local_mode = local_mode - # For just test that the correct paths are passed as we have no local bot API set up + offline_bot._local_mode = local_mode + # For just test that the correct paths are passed as we have no local Bot API set up test_flag = False file = data_file("telegram.jpg") expected = file.as_uri() @@ -200,11 +188,11 @@ async def make_assertion(_, data, *args, **kwargs): data.get("thumbnail"), InputFile ) - monkeypatch.setattr(bot, "_post", make_assertion) - await bot.send_document(chat_id, file, thumbnail=file) + monkeypatch.setattr(offline_bot, "_post", make_assertion) + await offline_bot.send_document(chat_id, file, thumbnail=file) assert test_flag finally: - bot._local_mode = False + offline_bot._local_mode = False async def test_get_file_instance_method(self, monkeypatch, document): async def make_assertion(*_, **kwargs): @@ -218,7 +206,7 @@ async def make_assertion(*_, **kwargs): assert await document.get_file() -class TestDocumentWithRequest(TestDocumentBase): +class TestDocumentWithRequest(DocumentTestBase): async def test_error_send_empty_file(self, bot, chat_id): with Path(os.devnull).open("rb") as f, pytest.raises(TelegramError): await bot.send_document(chat_id=chat_id, document=f) diff --git a/tests/_files/test_file.py b/tests/_files/test_file.py index 86979e4181c..fbf71dc70ba 100644 --- a/tests/_files/test_file.py +++ b/tests/_files/test_file.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 os +from io import BytesIO from pathlib import Path from tempfile import TemporaryFile, mkstemp @@ -31,10 +32,10 @@ @pytest.fixture(scope="module") def file(bot): file = File( - TestFileBase.file_id, - TestFileBase.file_unique_id, - file_path=TestFileBase.file_path, - file_size=TestFileBase.file_size, + FileTestBase.file_id, + FileTestBase.file_unique_id, + file_path=FileTestBase.file_path, + file_size=FileTestBase.file_size, ) file.set_bot(bot) file._unfreeze() @@ -51,10 +52,10 @@ def encrypted_file(bot): "Pt7fKPgYWKA/7a8E64Ea1X8C+Wf7Ky1tF4ANBl63vl4=", ) ef = File( - TestFileBase.file_id, - TestFileBase.file_unique_id, - TestFileBase.file_size, - TestFileBase.file_path, + FileTestBase.file_id, + FileTestBase.file_unique_id, + FileTestBase.file_size, + FileTestBase.file_path, ) ef.set_bot(bot) ef.set_credentials(fc) @@ -69,9 +70,9 @@ def encrypted_local_file(bot): "Pt7fKPgYWKA/7a8E64Ea1X8C+Wf7Ky1tF4ANBl63vl4=", ) ef = File( - TestFileBase.file_id, - TestFileBase.file_unique_id, - TestFileBase.file_size, + FileTestBase.file_id, + FileTestBase.file_unique_id, + FileTestBase.file_size, file_path=str(data_file("image_encrypted.jpg")), ) ef.set_bot(bot) @@ -82,16 +83,16 @@ def encrypted_local_file(bot): @pytest.fixture(scope="module") def local_file(bot): file = File( - TestFileBase.file_id, - TestFileBase.file_unique_id, + FileTestBase.file_id, + FileTestBase.file_unique_id, file_path=str(data_file("local_file.txt")), - file_size=TestFileBase.file_size, + file_size=FileTestBase.file_size, ) file.set_bot(bot) return file -class TestFileBase: +class FileTestBase: file_id = "NOTVALIDDOESNOTMATTER" file_unique_id = "adc3145fd2e84d95b64d68eaa22aa33e" file_path = ( @@ -101,20 +102,20 @@ class TestFileBase: file_content = "Saint-Saëns".encode() # Intentionally contains unicode chars. -class TestFileWithoutRequest(TestFileBase): +class TestFileWithoutRequest(FileTestBase): def test_slot_behaviour(self, file): for attr in file.__slots__: assert getattr(file, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(file)) == len(set(mro_slots(file))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "file_id": self.file_id, "file_unique_id": self.file_unique_id, "file_path": self.file_path, "file_size": self.file_size, } - new_file = File.de_json(json_dict, bot) + new_file = File.de_json(json_dict, offline_bot) assert new_file.api_kwargs == {} assert new_file.file_id == self.file_id @@ -131,11 +132,11 @@ def test_to_dict(self, file): assert file_dict["file_path"] == file.file_path assert file_dict["file_size"] == file.file_size - def test_equality(self, bot): - a = File(self.file_id, self.file_unique_id, bot) - b = File("", self.file_unique_id, bot) + def test_equality(self, offline_bot): + a = File(self.file_id, self.file_unique_id, offline_bot) + b = File("", self.file_unique_id, offline_bot) c = File(self.file_id, self.file_unique_id, None) - d = File("", "", bot) + d = File("", "", offline_bot) e = Voice(self.file_id, self.file_unique_id, 0) assert a == b @@ -181,21 +182,6 @@ async def test(*args, **kwargs): os.close(file_handle) custom_path.unlink(missing_ok=True) - async def test_download_no_filename(self, monkeypatch, file): - async def test(*args, **kwargs): - return self.file_content - - file.file_path = None - - monkeypatch.setattr(file.get_bot().request, "retrieve", test) - out_file = await file.download_to_drive() - - assert str(out_file)[-len(file.file_id) :] == file.file_id - try: - assert out_file.read_bytes() == self.file_content - finally: - out_file.unlink(missing_ok=True) - async def test_download_file_obj(self, monkeypatch, file): async def test(*args, **kwargs): return self.file_content @@ -223,7 +209,7 @@ async def test(*args, **kwargs): assert buf2[len(buf) :] == buf assert buf2[: len(buf)] == buf - async def test_download_encrypted(self, monkeypatch, bot, encrypted_file): + async def test_download_encrypted(self, monkeypatch, offline_bot, encrypted_file): async def test(*args, **kwargs): return data_file("image_encrypted.jpg").read_bytes() @@ -272,8 +258,16 @@ async def test(*args, **kwargs): assert buf2[len(buf) :] == buf assert buf2[: len(buf)] == buf + async def test_download_no_file_path(self): + with pytest.raises(RuntimeError, match="No `file_path` available"): + await File(self.file_id, self.file_unique_id).download_to_drive() + with pytest.raises(RuntimeError, match="No `file_path` available"): + await File(self.file_id, self.file_unique_id).download_to_memory(BytesIO()) + with pytest.raises(RuntimeError, match="No `file_path` available"): + await File(self.file_id, self.file_unique_id).download_as_bytearray() + -class TestFileWithRequest(TestFileBase): +class TestFileWithRequest(FileTestBase): async def test_error_get_empty_file_id(self, bot): with pytest.raises(TelegramError): await bot.get_file(file_id="") diff --git a/tests/_files/test_inputfile.py b/tests/_files/test_inputfile.py index 2a2a3b60734..b7235497b92 100644 --- a/tests/_files/test_inputfile.py +++ b/tests/_files/test_inputfile.py @@ -19,11 +19,12 @@ import contextlib import subprocess import sys -from io import BytesIO +from io import BufferedReader, BytesIO import pytest from telegram import InputFile +from telegram._utils.strings import TextEncoding from tests.auxil.files import data_file from tests.auxil.slots import mro_slots @@ -65,21 +66,45 @@ def test_attach(self, attach): assert input_file.attach_name is None assert input_file.attach_uri is None - def test_mimetypes(self): + @pytest.mark.parametrize("read_file_handle", [True, False]) + def test_mimetypes_file_handle(self, read_file_handle): # Only test a few to make sure logic works okay - assert InputFile(data_file("telegram.jpg").open("rb")).mimetype == "image/jpeg" + assert ( + InputFile( + data_file("telegram.jpg").open("rb"), read_file_handle=read_file_handle + ).mimetype + == "image/jpeg" + ) # For some reason python can guess the type on macOS - assert InputFile(data_file("telegram.webp").open("rb")).mimetype in [ + assert InputFile( + data_file("telegram.webp").open("rb"), read_file_handle=read_file_handle + ).mimetype in [ "application/octet-stream", "image/webp", ] - assert InputFile(data_file("telegram.mp3").open("rb")).mimetype == "audio/mpeg" + assert ( + InputFile( + data_file("telegram.mp3").open("rb"), read_file_handle=read_file_handle + ).mimetype + == "audio/mpeg" + ) # For some reason windows drops the trailing i - assert InputFile(data_file("telegram.midi").open("rb")).mimetype in [ + assert InputFile( + data_file("telegram.midi").open("rb"), read_file_handle=read_file_handle + ).mimetype in [ "audio/mid", "audio/midi", ] + # Test string file + assert ( + InputFile( + data_file("text_file.txt").open("rb"), read_file_handle=read_file_handle + ).mimetype + == "text/plain" + ) + + def test_mimetypes_other(self): # Test guess from file assert InputFile(BytesIO(b"blah"), filename="tg.jpg").mimetype == "image/jpeg" assert InputFile(BytesIO(b"blah"), filename="tg.mp3").mimetype == "audio/mpeg" @@ -91,20 +116,49 @@ def test_mimetypes(self): ) assert InputFile(BytesIO(b"blah")).mimetype == "application/octet-stream" - # Test string file - assert InputFile(data_file("text_file.txt").open()).mimetype == "text/plain" - - def test_filenames(self): - assert InputFile(data_file("telegram.jpg").open("rb")).filename == "telegram.jpg" - assert InputFile(data_file("telegram.jpg").open("rb"), filename="blah").filename == "blah" + @pytest.mark.parametrize("read_file_handle", [True, False]) + def test_filenames(self, read_file_handle): + assert ( + InputFile( + data_file("telegram.jpg").open("rb"), read_file_handle=read_file_handle + ).filename + == "telegram.jpg" + ) assert ( - InputFile(data_file("telegram.jpg").open("rb"), filename="blah.jpg").filename + InputFile( + data_file("telegram.jpg").open("rb"), + filename="blah", + read_file_handle=read_file_handle, + ).filename + == "blah" + ) + assert ( + InputFile( + data_file("telegram.jpg").open("rb"), + filename="blah.jpg", + read_file_handle=read_file_handle, + ).filename == "blah.jpg" ) - assert InputFile(data_file("telegram").open("rb")).filename == "telegram" - assert InputFile(data_file("telegram").open("rb"), filename="blah").filename == "blah" assert ( - InputFile(data_file("telegram").open("rb"), filename="blah.jpg").filename == "blah.jpg" + InputFile(data_file("telegram").open("rb"), read_file_handle=read_file_handle).filename + == "telegram" + ) + assert ( + InputFile( + data_file("telegram").open("rb"), + filename="blah", + read_file_handle=read_file_handle, + ).filename + == "blah" + ) + assert ( + InputFile( + data_file("telegram").open("rb"), + filename="blah.jpg", + read_file_handle=read_file_handle, + ).filename + == "blah.jpg" ) class MockedFileobject: @@ -139,6 +193,19 @@ def read(self): == "blah.jpg" ) + @pytest.mark.parametrize("read_file_handle", [True, False]) + def test_read_file_handle(self, read_file_handle): + input_file = InputFile( + data_file("telegram.jpg").open("rb"), read_file_handle=read_file_handle + ) + content = input_file.field_tuple[1] + if read_file_handle: + assert isinstance(content, bytes) + assert content == data_file("telegram.jpg").read_bytes() + else: + assert isinstance(content, BufferedReader) + assert content.read() == data_file("telegram.jpg").read_bytes() + class TestInputFileWithRequest: async def test_send_bytes(self, bot, chat_id): @@ -150,17 +217,17 @@ async def test_send_bytes(self, bot, chat_id): await (await message.document.get_file()).download_to_memory(out=out) out.seek(0) - assert out.read().decode("utf-8") == "PTB Rocks! ⅞" + assert out.read().decode(TextEncoding.UTF_8) == "PTB Rocks! ⅞" async def test_send_string(self, bot, chat_id): # We test this here and not at the respective test modules because it's not worth # duplicating the test for the different methods message = await bot.send_document( - chat_id, InputFile(data_file("text_file.txt").read_text(encoding="utf-8")) + chat_id, InputFile(data_file("text_file.txt").read_text(encoding=TextEncoding.UTF_8)) ) out = BytesIO() await (await message.document.get_file()).download_to_memory(out=out) out.seek(0) - assert out.read().decode("utf-8") == "PTB Rocks! ⅞" + assert out.read().decode(TextEncoding.UTF_8) == "PTB Rocks! ⅞" diff --git a/tests/_files/test_inputmedia.py b/tests/_files/test_inputmedia.py index d25a679ffc4..e75a5adb60f 100644 --- a/tests/_files/test_inputmedia.py +++ b/tests/_files/test_inputmedia.py @@ -38,124 +38,106 @@ ReplyParameters, ) from telegram.constants import InputMediaType, ParseMode - -# noinspection PyUnresolvedReferences from telegram.error import BadRequest from telegram.request import RequestData -from tests._files.test_animation import animation, animation_file # noqa: F401 from tests.auxil.files import data_file from tests.auxil.networking import expect_bad_request from tests.auxil.slots import mro_slots -# noinspection PyUnresolvedReferences -from tests.test_forum import emoji_id, real_topic # noqa: F401 - from ..auxil.build_messages import make_message -# noinspection PyUnresolvedReferences -from .test_audio import audio, audio_file # noqa: F401 - -# noinspection PyUnresolvedReferences -from .test_document import document, document_file # noqa: F401 - -# noinspection PyUnresolvedReferences -from .test_photo import photo, photo_file, photolist, thumb # noqa: F401 - -# noinspection PyUnresolvedReferences -from .test_video import video, video_file # noqa: F401 - @pytest.fixture(scope="module") def input_media_video(class_thumb_file): return InputMediaVideo( - media=TestInputMediaVideoBase.media, - caption=TestInputMediaVideoBase.caption, - width=TestInputMediaVideoBase.width, - height=TestInputMediaVideoBase.height, - duration=TestInputMediaVideoBase.duration, - parse_mode=TestInputMediaVideoBase.parse_mode, - caption_entities=TestInputMediaVideoBase.caption_entities, + media=InputMediaVideoTestBase.media, + caption=InputMediaVideoTestBase.caption, + width=InputMediaVideoTestBase.width, + height=InputMediaVideoTestBase.height, + duration=InputMediaVideoTestBase.duration, + parse_mode=InputMediaVideoTestBase.parse_mode, + caption_entities=InputMediaVideoTestBase.caption_entities, thumbnail=class_thumb_file, - supports_streaming=TestInputMediaVideoBase.supports_streaming, - has_spoiler=TestInputMediaVideoBase.has_spoiler, - show_caption_above_media=TestInputMediaVideoBase.show_caption_above_media, + supports_streaming=InputMediaVideoTestBase.supports_streaming, + has_spoiler=InputMediaVideoTestBase.has_spoiler, + show_caption_above_media=InputMediaVideoTestBase.show_caption_above_media, ) @pytest.fixture(scope="module") def input_media_photo(): return InputMediaPhoto( - media=TestInputMediaPhotoBase.media, - caption=TestInputMediaPhotoBase.caption, - parse_mode=TestInputMediaPhotoBase.parse_mode, - caption_entities=TestInputMediaPhotoBase.caption_entities, - has_spoiler=TestInputMediaPhotoBase.has_spoiler, - show_caption_above_media=TestInputMediaPhotoBase.show_caption_above_media, + media=InputMediaPhotoTestBase.media, + caption=InputMediaPhotoTestBase.caption, + parse_mode=InputMediaPhotoTestBase.parse_mode, + caption_entities=InputMediaPhotoTestBase.caption_entities, + has_spoiler=InputMediaPhotoTestBase.has_spoiler, + show_caption_above_media=InputMediaPhotoTestBase.show_caption_above_media, ) @pytest.fixture(scope="module") def input_media_animation(class_thumb_file): return InputMediaAnimation( - media=TestInputMediaAnimationBase.media, - caption=TestInputMediaAnimationBase.caption, - parse_mode=TestInputMediaAnimationBase.parse_mode, - caption_entities=TestInputMediaAnimationBase.caption_entities, - width=TestInputMediaAnimationBase.width, - height=TestInputMediaAnimationBase.height, + media=InputMediaAnimationTestBase.media, + caption=InputMediaAnimationTestBase.caption, + parse_mode=InputMediaAnimationTestBase.parse_mode, + caption_entities=InputMediaAnimationTestBase.caption_entities, + width=InputMediaAnimationTestBase.width, + height=InputMediaAnimationTestBase.height, thumbnail=class_thumb_file, - duration=TestInputMediaAnimationBase.duration, - has_spoiler=TestInputMediaAnimationBase.has_spoiler, - show_caption_above_media=TestInputMediaAnimationBase.show_caption_above_media, + duration=InputMediaAnimationTestBase.duration, + has_spoiler=InputMediaAnimationTestBase.has_spoiler, + show_caption_above_media=InputMediaAnimationTestBase.show_caption_above_media, ) @pytest.fixture(scope="module") def input_media_audio(class_thumb_file): return InputMediaAudio( - media=TestInputMediaAudioBase.media, - caption=TestInputMediaAudioBase.caption, - duration=TestInputMediaAudioBase.duration, - performer=TestInputMediaAudioBase.performer, - title=TestInputMediaAudioBase.title, + media=InputMediaAudioTestBase.media, + caption=InputMediaAudioTestBase.caption, + duration=InputMediaAudioTestBase.duration, + performer=InputMediaAudioTestBase.performer, + title=InputMediaAudioTestBase.title, thumbnail=class_thumb_file, - parse_mode=TestInputMediaAudioBase.parse_mode, - caption_entities=TestInputMediaAudioBase.caption_entities, + parse_mode=InputMediaAudioTestBase.parse_mode, + caption_entities=InputMediaAudioTestBase.caption_entities, ) @pytest.fixture(scope="module") def input_media_document(class_thumb_file): return InputMediaDocument( - media=TestInputMediaDocumentBase.media, - caption=TestInputMediaDocumentBase.caption, + media=InputMediaDocumentTestBase.media, + caption=InputMediaDocumentTestBase.caption, thumbnail=class_thumb_file, - parse_mode=TestInputMediaDocumentBase.parse_mode, - caption_entities=TestInputMediaDocumentBase.caption_entities, - disable_content_type_detection=TestInputMediaDocumentBase.disable_content_type_detection, + parse_mode=InputMediaDocumentTestBase.parse_mode, + caption_entities=InputMediaDocumentTestBase.caption_entities, + disable_content_type_detection=InputMediaDocumentTestBase.disable_content_type_detection, ) @pytest.fixture(scope="module") def input_paid_media_photo(): return InputPaidMediaPhoto( - media=TestInputMediaPhotoBase.media, + media=InputMediaPhotoTestBase.media, ) @pytest.fixture(scope="module") def input_paid_media_video(class_thumb_file): return InputPaidMediaVideo( - media=TestInputMediaVideoBase.media, + media=InputMediaVideoTestBase.media, thumbnail=class_thumb_file, - width=TestInputMediaVideoBase.width, - height=TestInputMediaVideoBase.height, - duration=TestInputMediaVideoBase.duration, - supports_streaming=TestInputMediaVideoBase.supports_streaming, + width=InputMediaVideoTestBase.width, + height=InputMediaVideoTestBase.height, + duration=InputMediaVideoTestBase.duration, + supports_streaming=InputMediaVideoTestBase.supports_streaming, ) -class TestInputMediaVideoBase: +class InputMediaVideoTestBase: type_ = "video" media = "NOTAREALFILEID" caption = "My Caption" @@ -169,7 +151,7 @@ class TestInputMediaVideoBase: show_caption_above_media = True -class TestInputMediaVideoWithoutRequest(TestInputMediaVideoBase): +class TestInputMediaVideoWithoutRequest(InputMediaVideoTestBase): def test_slot_behaviour(self, input_media_video): inst = input_media_video for attr in inst.__slots__: @@ -213,7 +195,7 @@ def test_to_dict(self, input_media_video): == input_media_video.show_caption_above_media ) - def test_with_video(self, video): # noqa: F811 + def test_with_video(self, video): # fixture found in test_video input_media_video = InputMediaVideo(video, caption="test 3") assert input_media_video.type == self.type_ @@ -223,7 +205,7 @@ def test_with_video(self, video): # noqa: F811 assert input_media_video.duration == video.duration assert input_media_video.caption == "test 3" - def test_with_video_file(self, video_file): # noqa: F811 + def test_with_video_file(self, video_file): # fixture found in test_video input_media_video = InputMediaVideo(video_file, caption="test 3") assert input_media_video.type == self.type_ @@ -258,7 +240,7 @@ def test_type_enum_conversion(self): ) -class TestInputMediaPhotoBase: +class InputMediaPhotoTestBase: type_ = "photo" media = "NOTAREALFILEID" caption = "My Caption" @@ -268,7 +250,7 @@ class TestInputMediaPhotoBase: show_caption_above_media = True -class TestInputMediaPhotoWithoutRequest(TestInputMediaPhotoBase): +class TestInputMediaPhotoWithoutRequest(InputMediaPhotoTestBase): def test_slot_behaviour(self, input_media_photo): inst = input_media_photo for attr in inst.__slots__: @@ -303,14 +285,14 @@ def test_to_dict(self, input_media_photo): == input_media_photo.show_caption_above_media ) - def test_with_photo(self, photo): # noqa: F811 + def test_with_photo(self, photo): # fixture found in test_photo input_media_photo = InputMediaPhoto(photo, caption="test 2") assert input_media_photo.type == self.type_ assert input_media_photo.media == photo.file_id assert input_media_photo.caption == "test 2" - def test_with_photo_file(self, photo_file): # noqa: F811 + def test_with_photo_file(self, photo_file): # fixture found in test_photo input_media_photo = InputMediaPhoto(photo_file, caption="test 2") assert input_media_photo.type == self.type_ @@ -322,7 +304,7 @@ def test_with_local_files(self): assert input_media_photo.media == data_file("telegram.mp4").as_uri() -class TestInputMediaAnimationBase: +class InputMediaAnimationTestBase: type_ = "animation" media = "NOTAREALFILEID" caption = "My Caption" @@ -335,7 +317,7 @@ class TestInputMediaAnimationBase: show_caption_above_media = True -class TestInputMediaAnimationWithoutRequest(TestInputMediaAnimationBase): +class TestInputMediaAnimationWithoutRequest(InputMediaAnimationTestBase): def test_slot_behaviour(self, input_media_animation): inst = input_media_animation for attr in inst.__slots__: @@ -374,14 +356,14 @@ def test_to_dict(self, input_media_animation): == input_media_animation.show_caption_above_media ) - def test_with_animation(self, animation): # noqa: F811 + def test_with_animation(self, animation): # fixture found in test_animation input_media_animation = InputMediaAnimation(animation, caption="test 2") assert input_media_animation.type == self.type_ assert input_media_animation.media == animation.file_id assert input_media_animation.caption == "test 2" - def test_with_animation_file(self, animation_file): # noqa: F811 + def test_with_animation_file(self, animation_file): # fixture found in test_animation input_media_animation = InputMediaAnimation(animation_file, caption="test 2") assert input_media_animation.type == self.type_ @@ -396,7 +378,7 @@ def test_with_local_files(self): assert input_media_animation.thumbnail == data_file("telegram.jpg").as_uri() -class TestInputMediaAudioBase: +class InputMediaAudioTestBase: type_ = "audio" media = "NOTAREALFILEID" caption = "My Caption" @@ -407,7 +389,7 @@ class TestInputMediaAudioBase: caption_entities = [MessageEntity(MessageEntity.BOLD, 0, 2)] -class TestInputMediaAudioWithoutRequest(TestInputMediaAudioBase): +class TestInputMediaAudioWithoutRequest(InputMediaAudioTestBase): def test_slot_behaviour(self, input_media_audio): inst = input_media_audio for attr in inst.__slots__: @@ -442,7 +424,7 @@ def test_to_dict(self, input_media_audio): ce.to_dict() for ce in input_media_audio.caption_entities ] - def test_with_audio(self, audio): # noqa: F811 + def test_with_audio(self, audio): # fixture found in test_audio input_media_audio = InputMediaAudio(audio, caption="test 3") assert input_media_audio.type == self.type_ @@ -452,7 +434,7 @@ def test_with_audio(self, audio): # noqa: F811 assert input_media_audio.title == audio.title assert input_media_audio.caption == "test 3" - def test_with_audio_file(self, audio_file): # noqa: F811 + def test_with_audio_file(self, audio_file): # fixture found in test_audio input_media_audio = InputMediaAudio(audio_file, caption="test 3") assert input_media_audio.type == self.type_ @@ -467,7 +449,7 @@ def test_with_local_files(self): assert input_media_audio.thumbnail == data_file("telegram.jpg").as_uri() -class TestInputMediaDocumentBase: +class InputMediaDocumentTestBase: type_ = "document" media = "NOTAREALFILEID" caption = "My Caption" @@ -476,7 +458,7 @@ class TestInputMediaDocumentBase: disable_content_type_detection = True -class TestInputMediaDocumentWithoutRequest(TestInputMediaDocumentBase): +class TestInputMediaDocumentWithoutRequest(InputMediaDocumentTestBase): def test_slot_behaviour(self, input_media_document): inst = input_media_document for attr in inst.__slots__: @@ -513,14 +495,14 @@ def test_to_dict(self, input_media_document): == input_media_document.disable_content_type_detection ) - def test_with_document(self, document): # noqa: F811 + def test_with_document(self, document): # fixture found in test_document input_media_document = InputMediaDocument(document, caption="test 3") assert input_media_document.type == self.type_ assert input_media_document.media == document.file_id assert input_media_document.caption == "test 3" - def test_with_document_file(self, document_file): # noqa: F811 + def test_with_document_file(self, document_file): # fixture found in test_document input_media_document = InputMediaDocument(document_file, caption="test 3") assert input_media_document.type == self.type_ @@ -535,7 +517,7 @@ def test_with_local_files(self): assert input_media_document.thumbnail == data_file("telegram.jpg").as_uri() -class TestInputPaidMediaPhotoWithoutRequest(TestInputMediaPhotoBase): +class TestInputPaidMediaPhotoWithoutRequest(InputMediaPhotoTestBase): def test_slot_behaviour(self, input_paid_media_photo): inst = input_paid_media_photo for attr in inst.__slots__: @@ -551,13 +533,13 @@ def test_to_dict(self, input_paid_media_photo): assert input_paid_media_photo_dict["type"] == input_paid_media_photo.type assert input_paid_media_photo_dict["media"] == input_paid_media_photo.media - def test_with_photo(self, photo): # noqa: F811 + def test_with_photo(self, photo): # fixture found in test_photo input_paid_media_photo = InputPaidMediaPhoto(photo) assert input_paid_media_photo.type == self.type_ assert input_paid_media_photo.media == photo.file_id - def test_with_photo_file(self, photo_file): # noqa: F811 + def test_with_photo_file(self, photo_file): # fixture found in test_photo input_paid_media_photo = InputPaidMediaPhoto(photo_file) assert input_paid_media_photo.type == self.type_ @@ -568,7 +550,7 @@ def test_with_local_files(self): assert input_paid_media_photo.media == data_file("telegram.jpg").as_uri() -class TestInputPaidMediaVideoWithoutRequest(TestInputMediaVideoBase): +class TestInputPaidMediaVideoWithoutRequest(InputMediaVideoTestBase): def test_slot_behaviour(self, input_paid_media_video): inst = input_paid_media_video for attr in inst.__slots__: @@ -597,7 +579,7 @@ def test_to_dict(self, input_paid_media_video): ) assert input_paid_media_video_dict["thumbnail"] == input_paid_media_video.thumbnail - def test_with_video(self, video): # noqa: F811 + def test_with_video(self, video): # fixture found in test_video input_paid_media_video = InputPaidMediaVideo(video) assert input_paid_media_video.type == self.type_ @@ -606,7 +588,7 @@ def test_with_video(self, video): # noqa: F811 assert input_paid_media_video.height == video.height assert input_paid_media_video.duration == video.duration - def test_with_video_file(self, video_file): # noqa: F811 + def test_with_video_file(self, video_file): # fixture found in test_video input_paid_media_video = InputPaidMediaVideo(video_file) assert input_paid_media_video.type == self.type_ @@ -621,7 +603,7 @@ def test_with_local_files(self): @pytest.fixture(scope="module") -def media_group(photo, thumb): # noqa: F811 +def media_group(photo, thumb): return [ InputMediaPhoto(photo, caption="*photo* 1", parse_mode="Markdown"), InputMediaPhoto(thumb, caption="photo 2", parse_mode="HTML"), @@ -632,12 +614,12 @@ def media_group(photo, thumb): # noqa: F811 @pytest.fixture(scope="module") -def media_group_no_caption_args(photo, thumb): # noqa: F811 +def media_group_no_caption_args(photo, thumb): return [InputMediaPhoto(photo), InputMediaPhoto(thumb), InputMediaPhoto(photo)] @pytest.fixture(scope="module") -def media_group_no_caption_only_caption_entities(photo, thumb): # noqa: F811 +def media_group_no_caption_only_caption_entities(photo, thumb): return [ InputMediaPhoto(photo, caption_entities=[MessageEntity(MessageEntity.BOLD, 0, 5)]), InputMediaPhoto(photo, caption_entities=[MessageEntity(MessageEntity.BOLD, 0, 5)]), @@ -645,7 +627,7 @@ def media_group_no_caption_only_caption_entities(photo, thumb): # noqa: F811 @pytest.fixture(scope="module") -def media_group_no_caption_only_parse_mode(photo, thumb): # noqa: F811 +def media_group_no_caption_only_parse_mode(photo, thumb): return [ InputMediaPhoto(photo, parse_mode="Markdown"), InputMediaPhoto(thumb, parse_mode="HTML"), @@ -655,7 +637,7 @@ def media_group_no_caption_only_parse_mode(photo, thumb): # noqa: F811 class TestSendMediaGroupWithoutRequest: async def test_send_media_group_throws_error_with_group_caption_and_individual_captions( self, - bot, + offline_bot, chat_id, media_group, media_group_no_caption_only_caption_entities, @@ -670,16 +652,16 @@ async def test_send_media_group_throws_error_with_group_caption_and_individual_c ValueError, match="You can only supply either group caption or media with captions.", ): - await bot.send_media_group(chat_id, group, caption="foo") + await offline_bot.send_media_group(chat_id, group, caption="foo") async def test_send_media_group_custom_filename( self, - bot, + offline_bot, chat_id, - photo_file, # noqa: F811 - animation_file, # noqa: F811 - audio_file, # noqa: F811 - video_file, # noqa: F811 + photo_file, + animation_file, + audio_file, + video_file, monkeypatch, ): async def make_assertion(url, request_data: RequestData, *args, **kwargs): @@ -690,7 +672,7 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): if result is True: raise Exception("Test was successful") - monkeypatch.setattr(bot.request, "post", make_assertion) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) media = [ InputMediaAnimation(animation_file, filename="custom_filename"), @@ -700,10 +682,10 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): ] with pytest.raises(Exception, match="Test was successful"): - await bot.send_media_group(chat_id, media) + await offline_bot.send_media_group(chat_id, media) async def test_send_media_group_with_thumbs( - self, bot, chat_id, video_file, photo_file, monkeypatch # noqa: F811 + self, offline_bot, chat_id, video_file, photo_file, monkeypatch ): async def make_assertion(method, url, request_data: RequestData, *args, **kwargs): nonlocal input_video @@ -715,13 +697,13 @@ async def make_assertion(method, url, request_data: RequestData, *args, **kwargs result = video_check and thumb_check raise Exception(f"Test was {'successful' if result else 'failing'}") - monkeypatch.setattr(bot.request, "_request_wrapper", make_assertion) + monkeypatch.setattr(offline_bot.request, "_request_wrapper", make_assertion) input_video = InputMediaVideo(video_file, thumbnail=photo_file) with pytest.raises(Exception, match="Test was successful"): - await bot.send_media_group(chat_id, [input_video, input_video]) + await offline_bot.send_media_group(chat_id, [input_video, input_video]) async def test_edit_message_media_with_thumb( - self, bot, chat_id, video_file, photo_file, monkeypatch # noqa: F811 + self, offline_bot, chat_id, video_file, photo_file, monkeypatch ): async def make_assertion( method: str, url: str, request_data: Optional[RequestData] = None, *args, **kwargs @@ -734,10 +716,12 @@ async def make_assertion( result = video_check and thumb_check raise Exception(f"Test was {'successful' if result else 'failing'}") - monkeypatch.setattr(bot.request, "_request_wrapper", make_assertion) + monkeypatch.setattr(offline_bot.request, "_request_wrapper", make_assertion) input_video = InputMediaVideo(video_file, thumbnail=photo_file) with pytest.raises(Exception, match="Test was successful"): - await bot.edit_message_media(chat_id=chat_id, message_id=123, media=input_video) + await offline_bot.edit_message_media( + chat_id=chat_id, message_id=123, media=input_video + ) @pytest.mark.parametrize( ("default_bot", "custom"), @@ -790,9 +774,7 @@ async def test_send_media_group_photo(self, bot, chat_id, media_group): mes.caption_entities == (MessageEntity(MessageEntity.BOLD, 0, 5),) for mes in messages ) - async def test_send_media_group_new_files( - self, bot, chat_id, video_file, photo_file # noqa: F811 - ): + async def test_send_media_group_new_files(self, bot, chat_id, video_file, photo_file): async def func(): return await bot.send_media_group( chat_id, @@ -828,7 +810,7 @@ async def test_send_media_group_different_sequences( assert all(mes.media_group_id == messages[0].media_group_id for mes in messages) async def test_send_media_group_with_message_thread_id( - self, bot, real_topic, forum_group_id, media_group # noqa: F811 + self, bot, real_topic, forum_group_id, media_group ): messages = await bot.send_media_group( forum_group_id, @@ -927,9 +909,7 @@ async def test_send_media_group_all_args(self, bot, raw_bot, chat_id, media_grou ) assert all(mes.has_protected_content for mes in messages) - async def test_send_media_group_with_spoiler( - self, bot, chat_id, photo_file, video_file # noqa: F811 - ): + async def test_send_media_group_with_spoiler(self, bot, chat_id, photo_file, video_file): # Media groups can't contain Animations, so that is tested in test_animation.py media = [ InputMediaPhoto(photo_file, has_spoiler=True), @@ -1072,11 +1052,11 @@ async def test_edit_message_media_default_parse_mode( chat_id, default_bot, media_type, - animation, # noqa: F811 - document, # noqa: F811 - audio, # noqa: F811 - photo, # noqa: F811 - video, # noqa: F811 + animation, + document, + audio, + photo, + video, ): html_caption = "bold italic code" markdown_caption = "*bold* _italic_ `code`" @@ -1151,7 +1131,7 @@ def build_media(parse_mode, med_type): # make sure that the media was not modified assert media.parse_mode == copied_media.parse_mode - async def test_send_paid_media(self, bot, channel_id, photo_file, video_file): # noqa: F811 + async def test_send_paid_media(self, bot, channel_id, photo_file, video_file): msg = await bot.send_paid_media( chat_id=channel_id, star_count=20, diff --git a/tests/_files/test_inputsticker.py b/tests/_files/test_inputsticker.py index 680a0167099..cfbe20560ef 100644 --- a/tests/_files/test_inputsticker.py +++ b/tests/_files/test_inputsticker.py @@ -21,7 +21,6 @@ from telegram import InputSticker, MaskPosition from telegram._files.inputfile import InputFile -from tests._files.test_sticker import video_sticker_file # noqa: F401 from tests.auxil.files import data_file from tests.auxil.slots import mro_slots @@ -29,15 +28,15 @@ @pytest.fixture(scope="module") def input_sticker(): return InputSticker( - sticker=TestInputStickerBase.sticker, - emoji_list=TestInputStickerBase.emoji_list, - mask_position=TestInputStickerBase.mask_position, - keywords=TestInputStickerBase.keywords, - format=TestInputStickerBase.format, + sticker=InputStickerTestBase.sticker, + emoji_list=InputStickerTestBase.emoji_list, + mask_position=InputStickerTestBase.mask_position, + keywords=InputStickerTestBase.keywords, + format=InputStickerTestBase.format, ) -class TestInputStickerBase: +class InputStickerTestBase: sticker = "fake_file_id" emoji_list = ("👍", "👎") mask_position = MaskPosition("forehead", 0.5, 0.5, 0.5) @@ -45,7 +44,7 @@ class TestInputStickerBase: format = "static" -class TestInputStickerWithoutRequest(TestInputStickerBase): +class TestInputStickerWithoutRequest(InputStickerTestBase): def test_slot_behaviour(self, input_sticker): inst = input_sticker for attr in inst.__slots__: @@ -77,7 +76,7 @@ def test_to_dict(self, input_sticker): assert input_sticker_dict["keywords"] == list(input_sticker.keywords) assert input_sticker_dict["format"] == input_sticker.format - def test_with_sticker_input_types(self, video_sticker_file): # noqa: F811 + def test_with_sticker_input_types(self, video_sticker_file): sticker = InputSticker(sticker=video_sticker_file, emoji_list=["👍"], format="video") assert isinstance(sticker.sticker, InputFile) sticker = InputSticker(data_file("telegram_video_sticker.webm"), ["👍"], "video") diff --git a/tests/_files/test_location.py b/tests/_files/test_location.py index 5b94df4916b..402f0ba7b11 100644 --- a/tests/_files/test_location.py +++ b/tests/_files/test_location.py @@ -31,16 +31,16 @@ @pytest.fixture(scope="module") def location(): return Location( - latitude=TestLocationBase.latitude, - longitude=TestLocationBase.longitude, - horizontal_accuracy=TestLocationBase.horizontal_accuracy, - live_period=TestLocationBase.live_period, - heading=TestLocationBase.live_period, - proximity_alert_radius=TestLocationBase.proximity_alert_radius, + latitude=LocationTestBase.latitude, + longitude=LocationTestBase.longitude, + horizontal_accuracy=LocationTestBase.horizontal_accuracy, + live_period=LocationTestBase.live_period, + heading=LocationTestBase.live_period, + proximity_alert_radius=LocationTestBase.proximity_alert_radius, ) -class TestLocationBase: +class LocationTestBase: latitude = -23.691288 longitude = -46.788279 horizontal_accuracy = 999 @@ -49,13 +49,13 @@ class TestLocationBase: proximity_alert_radius = 50 -class TestLocationWithoutRequest(TestLocationBase): +class TestLocationWithoutRequest(LocationTestBase): def test_slot_behaviour(self, location): for attr in location.__slots__: assert getattr(location, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(location)) == len(set(mro_slots(location))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "latitude": self.latitude, "longitude": self.longitude, @@ -64,7 +64,7 @@ def test_de_json(self, bot): "heading": self.heading, "proximity_alert_radius": self.proximity_alert_radius, } - location = Location.de_json(json_dict, bot) + location = Location.de_json(json_dict, offline_bot) assert location.api_kwargs == {} assert location.latitude == self.latitude @@ -96,26 +96,28 @@ def test_equality(self): assert a != d assert hash(a) != hash(d) - async def test_send_location_without_required(self, bot, chat_id): + async def test_send_location_without_required(self, offline_bot, chat_id): with pytest.raises(ValueError, match="Either location or latitude and longitude"): - await bot.send_location(chat_id=chat_id) + await offline_bot.send_location(chat_id=chat_id) - async def test_edit_location_without_required(self, bot): + async def test_edit_location_without_required(self, offline_bot): with pytest.raises(ValueError, match="Either location or latitude and longitude"): - await bot.edit_message_live_location(chat_id=2, message_id=3) + await offline_bot.edit_message_live_location(chat_id=2, message_id=3) - async def test_send_location_with_all_args(self, bot, location): + async def test_send_location_with_all_args(self, offline_bot, location): with pytest.raises(ValueError, match="Not both"): - await bot.send_location(chat_id=1, latitude=2.5, longitude=4.6, location=location) + await offline_bot.send_location( + chat_id=1, latitude=2.5, longitude=4.6, location=location + ) - async def test_edit_location_with_all_args(self, bot, location): + async def test_edit_location_with_all_args(self, offline_bot, location): with pytest.raises(ValueError, match="Not both"): - await bot.edit_message_live_location( + await offline_bot.edit_message_live_location( chat_id=1, message_id=7, latitude=2.5, longitude=4.6, location=location ) # TODO: Needs improvement with in inline sent live location. - async def test_edit_live_inline_message(self, monkeypatch, bot, location): + async def test_edit_live_inline_message(self, monkeypatch, offline_bot, location): async def make_assertion(url, request_data: RequestData, *args, **kwargs): data = request_data.json_parameters lat = data["latitude"] == str(location.latitude) @@ -127,8 +129,8 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): live = data["live_period"] == "900" return lat and lon and id_ and ha and heading and prox_alert and live - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.edit_message_live_location( + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.edit_message_live_location( inline_message_id=1234, location=location, horizontal_accuracy=50, @@ -138,30 +140,30 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): ) # TODO: Needs improvement with in inline sent live location. - async def test_stop_live_inline_message(self, monkeypatch, bot): + async def test_stop_live_inline_message(self, monkeypatch, offline_bot): async def make_assertion(url, request_data: RequestData, *args, **kwargs): return request_data.json_parameters["inline_message_id"] == "1234" - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.stop_message_live_location(inline_message_id=1234) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.stop_message_live_location(inline_message_id=1234) - async def test_send_with_location(self, monkeypatch, bot, chat_id, location): + async def test_send_with_location(self, monkeypatch, offline_bot, chat_id, location): async def make_assertion(url, request_data: RequestData, *args, **kwargs): lat = request_data.json_parameters["latitude"] == str(location.latitude) lon = request_data.json_parameters["longitude"] == str(location.longitude) return lat and lon - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.send_location(location=location, chat_id=chat_id) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.send_location(location=location, chat_id=chat_id) - async def test_edit_live_location_with_location(self, monkeypatch, bot, location): + async def test_edit_live_location_with_location(self, monkeypatch, offline_bot, location): async def make_assertion(url, request_data: RequestData, *args, **kwargs): lat = request_data.json_parameters["latitude"] == str(location.latitude) lon = request_data.json_parameters["longitude"] == str(location.longitude) return lat and lon - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.edit_message_live_location(None, None, location=location) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.edit_message_live_location(None, None, location=location) @pytest.mark.parametrize( ("default_bot", "custom"), @@ -235,7 +237,7 @@ async def test_send_location_default_protect_content(self, chat_id, default_bot, assert protected.has_protected_content assert not unprotected.has_protected_content - @pytest.mark.xfail() + @pytest.mark.xfail async def test_send_live_location(self, bot, chat_id): message = await bot.send_location( chat_id=chat_id, diff --git a/tests/_files/test_photo.py b/tests/_files/test_photo.py index ac53a048c27..bdf34f72b4a 100644 --- a/tests/_files/test_photo.py +++ b/tests/_files/test_photo.py @@ -34,38 +34,10 @@ ) from tests.auxil.build_messages import make_message from tests.auxil.files import data_file -from tests.auxil.networking import expect_bad_request from tests.auxil.slots import mro_slots -@pytest.fixture() -def photo_file(): - with data_file("telegram.jpg").open("rb") as f: - yield f - - -@pytest.fixture(scope="module") -async def photolist(bot, chat_id): - async def func(): - with data_file("telegram.jpg").open("rb") as f: - return (await bot.send_photo(chat_id, photo=f, read_timeout=50)).photo - - return await expect_bad_request( - func, "Type of file mismatch", "Telegram did not accept the file." - ) - - -@pytest.fixture(scope="module") -def thumb(photolist): - return photolist[0] - - -@pytest.fixture(scope="module") -def photo(photolist): - return photolist[-1] - - -class TestPhotoBase: +class PhotoTestBase: width = 800 height = 800 caption = "PhotoTest - *Caption*" @@ -75,7 +47,7 @@ class TestPhotoBase: file_size = [29176, 27662] -class TestPhotoWithoutRequest(TestPhotoBase): +class TestPhotoWithoutRequest(PhotoTestBase): def test_slot_behaviour(self, photo): for attr in photo.__slots__: assert getattr(photo, attr, "err") != "err", f"got extra slot '{attr}'" @@ -105,7 +77,7 @@ def test_expected_values(self, photo, thumb): # so far assert thumb.file_size in [1475, 1477] - def test_de_json(self, bot, photo): + def test_de_json(self, offline_bot, photo): json_dict = { "file_id": photo.file_id, "file_unique_id": photo.file_unique_id, @@ -113,7 +85,7 @@ def test_de_json(self, bot, photo): "height": self.height, "file_size": self.file_size, } - json_photo = PhotoSize.de_json(json_dict, bot) + json_photo = PhotoSize.de_json(json_dict, offline_bot) assert json_photo.api_kwargs == {} assert json_photo.file_id == photo.file_id @@ -160,22 +132,22 @@ def test_equality(self, photo): assert a != e assert hash(a) != hash(e) - async def test_error_without_required_args(self, bot, chat_id): + async def test_error_without_required_args(self, offline_bot, chat_id): with pytest.raises(TypeError): - await bot.send_photo(chat_id=chat_id) + await offline_bot.send_photo(chat_id=chat_id) - async def test_send_photo_custom_filename(self, bot, chat_id, photo_file, monkeypatch): + async def test_send_photo_custom_filename(self, offline_bot, chat_id, photo_file, monkeypatch): async def make_assertion(url, request_data: RequestData, *args, **kwargs): return next(iter(request_data.multipart_data.values()))[0] == "custom_filename" - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.send_photo(chat_id, photo_file, filename="custom_filename") + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.send_photo(chat_id, photo_file, filename="custom_filename") @pytest.mark.parametrize("local_mode", [True, False]) - async def test_send_photo_local_files(self, monkeypatch, bot, chat_id, local_mode): + async def test_send_photo_local_files(self, monkeypatch, offline_bot, chat_id, local_mode): try: - bot._local_mode = local_mode - # For just test that the correct paths are passed as we have no local bot API set up + offline_bot._local_mode = local_mode + # For just test that the correct paths are passed as we have no local Bot API set up test_flag = False file = data_file("telegram.jpg") expected = file.as_uri() @@ -187,18 +159,18 @@ async def make_assertion(_, data, *args, **kwargs): else: test_flag = isinstance(data.get("photo"), InputFile) - monkeypatch.setattr(bot, "_post", make_assertion) - await bot.send_photo(chat_id, file) + monkeypatch.setattr(offline_bot, "_post", make_assertion) + await offline_bot.send_photo(chat_id, file) assert test_flag finally: - bot._local_mode = False + offline_bot._local_mode = False - async def test_send_with_photosize(self, monkeypatch, bot, chat_id, photo): + async def test_send_with_photosize(self, monkeypatch, offline_bot, chat_id, photo): async def make_assertion(url, request_data: RequestData, *args, **kwargs): return request_data.json_parameters["photo"] == photo.file_id - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.send_photo(photo=photo, chat_id=chat_id) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.send_photo(photo=photo, chat_id=chat_id) async def test_get_file_instance_method(self, monkeypatch, photo): async def make_assertion(*_, **kwargs): @@ -237,7 +209,7 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): await default_bot.send_photo(chat_id, photo, reply_parameters=ReplyParameters(**kwargs)) -class TestPhotoWithRequest(TestPhotoBase): +class TestPhotoWithRequest(PhotoTestBase): async def test_send_photo_all_args(self, bot, chat_id, photo_file): message = await bot.send_photo( chat_id, diff --git a/tests/_files/test_sticker.py b/tests/_files/test_sticker.py index bf60272ba04..d77f93ac776 100644 --- a/tests/_files/test_sticker.py +++ b/tests/_files/test_sticker.py @@ -49,47 +49,7 @@ from tests.auxil.slots import mro_slots -@pytest.fixture() -def sticker_file(): - with data_file("telegram.webp").open("rb") as file: - yield file - - -@pytest.fixture(scope="module") -async def sticker(bot, chat_id): - with data_file("telegram.webp").open("rb") as f: - sticker = (await bot.send_sticker(chat_id, sticker=f, read_timeout=50)).sticker - # necessary to properly test needs_repainting - with sticker._unfrozen(): - sticker.needs_repainting = TestStickerBase.needs_repainting - return sticker - - -@pytest.fixture() -def animated_sticker_file(): - with data_file("telegram_animated_sticker.tgs").open("rb") as f: - yield f - - -@pytest.fixture(scope="module") -async def animated_sticker(bot, chat_id): - with data_file("telegram_animated_sticker.tgs").open("rb") as f: - return (await bot.send_sticker(chat_id, sticker=f, read_timeout=50)).sticker - - -@pytest.fixture() -def video_sticker_file(): - with data_file("telegram_video_sticker.webm").open("rb") as f: - yield f - - -@pytest.fixture(scope="module") -def video_sticker(bot, chat_id): - with data_file("telegram_video_sticker.webm").open("rb") as f: - return bot.send_sticker(chat_id, sticker=f, timeout=50).sticker - - -class TestStickerBase: +class StickerTestBase: # sticker_file_url = 'https://python-telegram-bot.org/static/testfiles/telegram.webp' # Serving sticker from gh since our server sends wrong content_type sticker_file_url = ( @@ -116,7 +76,7 @@ class TestStickerBase: premium_animation = File("this_is_an_id", "this_is_an_unique_id") -class TestStickerWithoutRequest(TestStickerBase): +class TestStickerWithoutRequest(StickerTestBase): def test_slot_behaviour(self, sticker): for attr in sticker.__slots__: assert getattr(sticker, attr, "err") != "err", f"got extra slot '{attr}'" @@ -165,7 +125,7 @@ def test_to_dict(self, sticker): assert sticker_dict["type"] == sticker.type assert sticker_dict["needs_repainting"] == sticker.needs_repainting - def test_de_json(self, bot, sticker): + def test_de_json(self, offline_bot, sticker): json_dict = { "file_id": self.sticker_file_id, "file_unique_id": self.sticker_file_unique_id, @@ -181,7 +141,7 @@ def test_de_json(self, bot, sticker): "custom_emoji_id": self.custom_emoji_id, "needs_repainting": self.needs_repainting, } - json_sticker = Sticker.de_json(json_dict, bot) + json_sticker = Sticker.de_json(json_dict, offline_bot) assert json_sticker.api_kwargs == {} assert json_sticker.file_id == self.sticker_file_id @@ -284,22 +244,22 @@ def test_equality(self, sticker): assert a != e assert hash(a) != hash(e) - async def test_error_without_required_args(self, bot, chat_id): + async def test_error_without_required_args(self, offline_bot, chat_id): with pytest.raises(TypeError): - await bot.send_sticker(chat_id) + await offline_bot.send_sticker(chat_id) - async def test_send_with_sticker(self, monkeypatch, bot, chat_id, sticker): + async def test_send_with_sticker(self, monkeypatch, offline_bot, chat_id, sticker): async def make_assertion(url, request_data: RequestData, *args, **kwargs): return request_data.json_parameters["sticker"] == sticker.file_id - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.send_sticker(sticker=sticker, chat_id=chat_id) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.send_sticker(sticker=sticker, chat_id=chat_id) @pytest.mark.parametrize("local_mode", [True, False]) - async def test_send_sticker_local_files(self, monkeypatch, bot, chat_id, local_mode): + async def test_send_sticker_local_files(self, monkeypatch, offline_bot, chat_id, local_mode): try: - bot._local_mode = local_mode - # For just test that the correct paths are passed as we have no local bot API set up + offline_bot._local_mode = local_mode + # For just test that the correct paths are passed as we have no local Bot API set up test_flag = False file = data_file("telegram.jpg") expected = file.as_uri() @@ -311,11 +271,11 @@ async def make_assertion(_, data, *args, **kwargs): else: test_flag = isinstance(data.get("sticker"), InputFile) - monkeypatch.setattr(bot, "_post", make_assertion) - await bot.send_sticker(chat_id, file) + monkeypatch.setattr(offline_bot, "_post", make_assertion) + await offline_bot.send_sticker(chat_id, file) assert test_flag finally: - bot._local_mode = False + offline_bot._local_mode = False @pytest.mark.parametrize( ("default_bot", "custom"), @@ -345,7 +305,7 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): ) -class TestStickerWithRequest(TestStickerBase): +class TestStickerWithRequest(StickerTestBase): async def test_send_all_args(self, bot, chat_id, sticker_file, sticker): message = await bot.send_sticker( chat_id, sticker=sticker_file, disable_notification=False, protect_content=True @@ -524,55 +484,7 @@ async def test_error_send_empty_file_id(self, bot, chat_id): await bot.send_sticker(chat_id, "") -@pytest.fixture() -async def sticker_set(bot): - ss = await bot.get_sticker_set(f"test_by_{bot.username}") - if len(ss.stickers) > 100: - try: - for i in range(1, 50): - await bot.delete_sticker_from_set(ss.stickers[-i].file_id) - except BadRequest as e: - if e.message == "Stickerset_not_modified": - return ss - raise Exception("stickerset is growing too large.") from None - return ss - - -@pytest.fixture() -async def animated_sticker_set(bot): - ss = await bot.get_sticker_set(f"animated_test_by_{bot.username}") - if len(ss.stickers) > 100: - try: - for i in range(1, 50): - await bot.delete_sticker_from_set(ss.stickers[-i].file_id) - except BadRequest as e: - if e.message == "Stickerset_not_modified": - return ss - raise Exception("stickerset is growing too large.") from None - return ss - - -@pytest.fixture() -async def video_sticker_set(bot): - ss = await bot.get_sticker_set(f"video_test_by_{bot.username}") - if len(ss.stickers) > 100: - try: - for i in range(1, 50): - await bot.delete_sticker_from_set(ss.stickers[-i].file_id) - except BadRequest as e: - if e.message == "Stickerset_not_modified": - return ss - raise Exception("stickerset is growing too large.") from None - return ss - - -@pytest.fixture() -def sticker_set_thumb_file(): - with data_file("sticker_set_thumb.png").open("rb") as file: - yield file - - -class TestStickerSetBase: +class StickerSetTestBase: title = "Test stickers" stickers = [Sticker("file_id", "file_un_id", 512, 512, True, True, Sticker.REGULAR)] name = "NOTAREALNAME" @@ -580,15 +492,15 @@ class TestStickerSetBase: contains_masks = True -class TestStickerSetWithoutRequest(TestStickerSetBase): +class TestStickerSetWithoutRequest(StickerSetTestBase): def test_slot_behaviour(self): inst = StickerSet("this", "is", self.stickers, "not") for attr in inst.__slots__: assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json(self, bot, sticker): - name = f"test_by_{bot.username}" + def test_de_json(self, offline_bot, sticker): + name = f"test_by_{offline_bot.username}" json_dict = { "name": name, "title": self.title, @@ -597,7 +509,7 @@ def test_de_json(self, bot, sticker): "sticker_type": self.sticker_type, "contains_masks": self.contains_masks, } - sticker_set = StickerSet.de_json(json_dict, bot) + sticker_set = StickerSet.de_json(json_dict, offline_bot) assert sticker_set.name == name assert sticker_set.title == self.title @@ -653,11 +565,11 @@ def test_equality(self): @pytest.mark.parametrize("local_mode", [True, False]) async def test_upload_sticker_file_local_files( - self, monkeypatch, bot, chat_id, local_mode, recwarn + self, monkeypatch, offline_bot, chat_id, local_mode, recwarn ): try: - bot._local_mode = local_mode - # For just test that the correct paths are passed as we have no local bot API set up + offline_bot._local_mode = local_mode + # For just test that the correct paths are passed as we have no local Bot API set up test_flag = False file = data_file("telegram.jpg") expected = file.as_uri() @@ -670,24 +582,24 @@ async def make_assertion(_, data, *args, **kwargs): else isinstance(data.get("sticker"), InputFile) ) - monkeypatch.setattr(bot, "_post", make_assertion) - await bot.upload_sticker_file( + monkeypatch.setattr(offline_bot, "_post", make_assertion) + await offline_bot.upload_sticker_file( chat_id, sticker=file, sticker_format=StickerFormat.STATIC ) assert test_flag finally: - bot._local_mode = False + offline_bot._local_mode = False @pytest.mark.parametrize("local_mode", [True, False]) async def test_create_new_sticker_set_local_files( self, monkeypatch, - bot, + offline_bot, chat_id, local_mode, ): - monkeypatch.setattr(bot, "_local_mode", local_mode) - # For just test that the correct paths are passed as we have no local bot API set up + monkeypatch.setattr(offline_bot, "_local_mode", local_mode) + # For just test that the correct paths are passed as we have no local Bot API set up test_flag = False file = data_file("telegram.jpg") # always assumed to be local mode because we don't have access to local_mode setting @@ -698,8 +610,8 @@ async def make_assertion(_, data, *args, **kwargs): nonlocal test_flag test_flag = data.get("stickers")[0].sticker == expected - monkeypatch.setattr(bot, "_post", make_assertion) - await bot.create_new_sticker_set( + monkeypatch.setattr(offline_bot, "_post", make_assertion) + await offline_bot.create_new_sticker_set( chat_id, "name", "title", @@ -707,7 +619,9 @@ async def make_assertion(_, data, *args, **kwargs): ) assert test_flag - async def test_create_new_sticker_all_params(self, monkeypatch, bot, chat_id, mask_position): + async def test_create_new_sticker_all_params( + self, monkeypatch, offline_bot, chat_id, mask_position + ): async def make_assertion(_, data, *args, **kwargs): assert data["user_id"] == chat_id assert data["name"] == "name" @@ -715,8 +629,8 @@ async def make_assertion(_, data, *args, **kwargs): assert data["stickers"] == ["wow.png", "wow.tgs", "wow.webp"] assert data["needs_repainting"] is True - monkeypatch.setattr(bot, "_post", make_assertion) - await bot.create_new_sticker_set( + monkeypatch.setattr(offline_bot, "_post", make_assertion) + await offline_bot.create_new_sticker_set( chat_id, "name", "title", @@ -725,9 +639,11 @@ async def make_assertion(_, data, *args, **kwargs): ) @pytest.mark.parametrize("local_mode", [True, False]) - async def test_add_sticker_to_set_local_files(self, monkeypatch, bot, chat_id, local_mode): - monkeypatch.setattr(bot, "_local_mode", local_mode) - # For just test that the correct paths are passed as we have no local bot API set up + async def test_add_sticker_to_set_local_files( + self, monkeypatch, offline_bot, chat_id, local_mode + ): + monkeypatch.setattr(offline_bot, "_local_mode", local_mode) + # For just test that the correct paths are passed as we have no local Bot API set up test_flag = False file = data_file("telegram.jpg") # always assumed to be local mode because we don't have access to local_mode setting @@ -738,8 +654,8 @@ async def make_assertion(_, data, *args, **kwargs): nonlocal test_flag test_flag = data.get("sticker").sticker == expected - monkeypatch.setattr(bot, "_post", make_assertion) - await bot.add_sticker_to_set( + monkeypatch.setattr(offline_bot, "_post", make_assertion) + await offline_bot.add_sticker_to_set( chat_id, "name", sticker=InputSticker(sticker=file, emoji_list=["this"], format="static"), @@ -748,11 +664,11 @@ async def make_assertion(_, data, *args, **kwargs): @pytest.mark.parametrize("local_mode", [True, False]) async def test_set_sticker_set_thumbnail_local_files( - self, monkeypatch, bot, chat_id, local_mode + self, monkeypatch, offline_bot, chat_id, local_mode ): try: - bot._local_mode = local_mode - # For just test that the correct paths are passed as we have no local bot API set up + offline_bot._local_mode = local_mode + # For just test that the correct paths are passed as we have no local Bot API set up test_flag = False file = data_file("telegram.jpg") expected = file.as_uri() @@ -764,11 +680,13 @@ async def make_assertion(_, data, *args, **kwargs): else: test_flag = isinstance(data.get("thumbnail"), InputFile) - monkeypatch.setattr(bot, "_post", make_assertion) - await bot.set_sticker_set_thumbnail("name", chat_id, thumbnail=file, format="static") + monkeypatch.setattr(offline_bot, "_post", make_assertion) + await offline_bot.set_sticker_set_thumbnail( + "name", chat_id, thumbnail=file, format="static" + ) assert test_flag finally: - bot._local_mode = False + offline_bot._local_mode = False async def test_get_file_instance_method(self, monkeypatch, sticker): async def make_assertion(*_, **kwargs): @@ -1061,38 +979,38 @@ async def test_bot_methods_8_png(self, bot, sticker_set, sticker_file): ) -@pytest.fixture(scope="module") -def mask_position(): - return MaskPosition( - TestMaskPositionBase.point, - TestMaskPositionBase.x_shift, - TestMaskPositionBase.y_shift, - TestMaskPositionBase.scale, - ) - - -class TestMaskPositionBase: +class MaskPositionTestBase: point = MaskPosition.EYES x_shift = -1 y_shift = 1 scale = 2 -class TestMaskPositionWithoutRequest(TestMaskPositionBase): +@pytest.fixture(scope="module") +def mask_position(): + return MaskPosition( + MaskPositionTestBase.point, + MaskPositionTestBase.x_shift, + MaskPositionTestBase.y_shift, + MaskPositionTestBase.scale, + ) + + +class TestMaskPositionWithoutRequest(MaskPositionTestBase): def test_slot_behaviour(self, mask_position): inst = mask_position for attr in inst.__slots__: assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_mask_position_de_json(self, bot): + def test_mask_position_de_json(self, offline_bot): json_dict = { "point": self.point, "x_shift": self.x_shift, "y_shift": self.y_shift, "scale": self.scale, } - mask_position = MaskPosition.de_json(json_dict, bot) + mask_position = MaskPosition.de_json(json_dict, offline_bot) assert mask_position.api_kwargs == {} assert mask_position.point == self.point @@ -1130,7 +1048,7 @@ def test_equality(self): assert hash(a) != hash(e) -class TestMaskPositionWithRequest(TestMaskPositionBase): +class TestMaskPositionWithRequest(MaskPositionTestBase): async def test_create_new_mask_sticker_set(self, bot, chat_id, sticker_file, mask_position): name = f"masks_by_{bot.username}" try: diff --git a/tests/_files/test_venue.py b/tests/_files/test_venue.py index 0cb8f500b50..31883591e2a 100644 --- a/tests/_files/test_venue.py +++ b/tests/_files/test_venue.py @@ -31,17 +31,17 @@ @pytest.fixture(scope="module") def venue(): return Venue( - TestVenueBase.location, - TestVenueBase.title, - TestVenueBase.address, - foursquare_id=TestVenueBase.foursquare_id, - foursquare_type=TestVenueBase.foursquare_type, - google_place_id=TestVenueBase.google_place_id, - google_place_type=TestVenueBase.google_place_type, + VenueTestBase.location, + VenueTestBase.title, + VenueTestBase.address, + foursquare_id=VenueTestBase.foursquare_id, + foursquare_type=VenueTestBase.foursquare_type, + google_place_id=VenueTestBase.google_place_id, + google_place_type=VenueTestBase.google_place_type, ) -class TestVenueBase: +class VenueTestBase: location = Location(longitude=-46.788279, latitude=-23.691288) title = "title" address = "address" @@ -51,13 +51,13 @@ class TestVenueBase: google_place_type = "google place type" -class TestVenueWithoutRequest(TestVenueBase): +class TestVenueWithoutRequest(VenueTestBase): def test_slot_behaviour(self, venue): for attr in venue.__slots__: assert getattr(venue, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(venue)) == len(set(mro_slots(venue))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "location": self.location.to_dict(), "title": self.title, @@ -67,7 +67,7 @@ def test_de_json(self, bot): "google_place_id": self.google_place_id, "google_place_type": self.google_place_type, } - venue = Venue.de_json(json_dict, bot) + venue = Venue.de_json(json_dict, offline_bot) assert venue.api_kwargs == {} assert venue.location == self.location @@ -110,13 +110,13 @@ def test_equality(self): assert a != d2 assert hash(a) != hash(d2) - async def test_send_venue_without_required(self, bot, chat_id): + async def test_send_venue_without_required(self, offline_bot, chat_id): with pytest.raises(ValueError, match="Either venue or latitude, longitude, address and"): - await bot.send_venue(chat_id=chat_id) + await offline_bot.send_venue(chat_id=chat_id) - async def test_send_venue_mutually_exclusive(self, bot, chat_id, venue): + async def test_send_venue_mutually_exclusive(self, offline_bot, chat_id, venue): with pytest.raises(ValueError, match="Not both"): - await bot.send_venue( + await offline_bot.send_venue( chat_id=chat_id, latitude=1, longitude=1, @@ -125,7 +125,7 @@ async def test_send_venue_mutually_exclusive(self, bot, chat_id, venue): venue=venue, ) - async def test_send_with_venue(self, monkeypatch, bot, chat_id, venue): + async def test_send_with_venue(self, monkeypatch, offline_bot, chat_id, venue): async def make_assertion(url, request_data: RequestData, *args, **kwargs): data = request_data.json_parameters return ( @@ -139,8 +139,8 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): and data["google_place_type"] == self.google_place_type ) - monkeypatch.setattr(bot.request, "post", make_assertion) - message = await bot.send_venue(chat_id, venue=venue) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + message = await offline_bot.send_venue(chat_id, venue=venue) assert message @pytest.mark.parametrize( @@ -171,7 +171,7 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): ) -class TestVenueWithRequest(TestVenueBase): +class TestVenueWithRequest(VenueTestBase): @pytest.mark.parametrize( ("default_bot", "custom"), [ diff --git a/tests/_files/test_video.py b/tests/_files/test_video.py index 7f31f9f6e4d..66230389f7e 100644 --- a/tests/_files/test_video.py +++ b/tests/_files/test_video.py @@ -37,19 +37,7 @@ from tests.auxil.slots import mro_slots -@pytest.fixture() -def video_file(): - with data_file("telegram.mp4").open("rb") as f: - yield f - - -@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, read_timeout=50)).video - - -class TestVideoBase: +class VideoTestBase: width = 360 height = 640 duration = 5 @@ -66,7 +54,7 @@ class TestVideoBase: video_file_unique_id = "adc3145fd2e84d95b64d68eaa22aa33e" -class TestVideoWithoutRequest(TestVideoBase): +class TestVideoWithoutRequest(VideoTestBase): def test_slot_behaviour(self, video): for attr in video.__slots__: assert getattr(video, attr, "err") != "err", f"got extra slot '{attr}'" @@ -93,7 +81,7 @@ def test_expected_values(self, video): assert video.file_size == self.file_size assert video.mime_type == self.mime_type - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "file_id": self.video_file_id, "file_unique_id": self.video_file_unique_id, @@ -104,7 +92,7 @@ def test_de_json(self, bot): "file_size": self.file_size, "file_name": self.file_name, } - json_video = Video.de_json(json_dict, bot) + json_video = Video.de_json(json_dict, offline_bot) assert json_video.api_kwargs == {} assert json_video.file_id == self.video_file_id @@ -149,30 +137,30 @@ def test_equality(self, video): assert a != e assert hash(a) != hash(e) - async def test_error_without_required_args(self, bot, chat_id): + async def test_error_without_required_args(self, offline_bot, chat_id): with pytest.raises(TypeError): - await bot.send_video(chat_id=chat_id) + await offline_bot.send_video(chat_id=chat_id) - async def test_send_with_video(self, monkeypatch, bot, chat_id, video): + async def test_send_with_video(self, monkeypatch, offline_bot, chat_id, video): async def make_assertion(url, request_data: RequestData, *args, **kwargs): return request_data.json_parameters["video"] == video.file_id - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.send_video(chat_id, video=video) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.send_video(chat_id, video=video) - async def test_send_video_custom_filename(self, bot, chat_id, video_file, monkeypatch): + async def test_send_video_custom_filename(self, offline_bot, chat_id, video_file, monkeypatch): async def make_assertion(url, request_data: RequestData, *args, **kwargs): return next(iter(request_data.multipart_data.values()))[0] == "custom_filename" - monkeypatch.setattr(bot.request, "post", make_assertion) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) - assert await bot.send_video(chat_id, video_file, filename="custom_filename") + assert await offline_bot.send_video(chat_id, video_file, filename="custom_filename") @pytest.mark.parametrize("local_mode", [True, False]) - async def test_send_video_local_files(self, monkeypatch, bot, chat_id, local_mode): + async def test_send_video_local_files(self, monkeypatch, offline_bot, chat_id, local_mode): try: - bot._local_mode = local_mode - # For just test that the correct paths are passed as we have no local bot API set up + offline_bot._local_mode = local_mode + # For just test that the correct paths are passed as we have no local Bot API set up test_flag = False file = data_file("telegram.jpg") expected = file.as_uri() @@ -186,11 +174,11 @@ async def make_assertion(_, data, *args, **kwargs): data.get("thumbnail"), InputFile ) - monkeypatch.setattr(bot, "_post", make_assertion) - await bot.send_video(chat_id, file, thumbnail=file) + monkeypatch.setattr(offline_bot, "_post", make_assertion) + await offline_bot.send_video(chat_id, file, thumbnail=file) assert test_flag finally: - bot._local_mode = False + offline_bot._local_mode = False async def test_get_file_instance_method(self, monkeypatch, video): async def make_assertion(*_, **kwargs): @@ -229,7 +217,7 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): await default_bot.send_video(chat_id, video, reply_parameters=ReplyParameters(**kwargs)) -class TestVideoWithRequest(TestVideoBase): +class TestVideoWithRequest(VideoTestBase): async def test_send_all_args(self, bot, chat_id, video_file, video, thumb_file): message = await bot.send_video( chat_id, diff --git a/tests/_files/test_videonote.py b/tests/_files/test_videonote.py index 625e85eba87..ce69fa8f850 100644 --- a/tests/_files/test_videonote.py +++ b/tests/_files/test_videonote.py @@ -36,7 +36,7 @@ from tests.auxil.slots import mro_slots -@pytest.fixture() +@pytest.fixture def video_note_file(): with data_file("telegram2.mp4").open("rb") as f: yield f @@ -48,7 +48,7 @@ async def video_note(bot, chat_id): return (await bot.send_video_note(chat_id, video_note=f, read_timeout=50)).video_note -class TestVideoNoteBase: +class VideoNoteTestBase: length = 240 duration = 3 file_size = 132084 @@ -60,7 +60,7 @@ class TestVideoNoteBase: videonote_file_unique_id = "adc3145fd2e84d95b64d68eaa22aa33e" -class TestVideoNoteWithoutRequest(TestVideoNoteBase): +class TestVideoNoteWithoutRequest(VideoNoteTestBase): def test_slot_behaviour(self, video_note): for attr in video_note.__slots__: assert getattr(video_note, attr, "err") != "err", f"got extra slot '{attr}'" @@ -85,7 +85,7 @@ def test_expected_values(self, video_note): assert video_note.duration == self.duration assert video_note.file_size == self.file_size - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "file_id": self.videonote_file_id, "file_unique_id": self.videonote_file_unique_id, @@ -93,7 +93,7 @@ def test_de_json(self, bot): "duration": self.duration, "file_size": self.file_size, } - json_video_note = VideoNote.de_json(json_dict, bot) + json_video_note = VideoNote.de_json(json_dict, offline_bot) assert json_video_note.api_kwargs == {} assert json_video_note.file_id == self.videonote_file_id @@ -132,32 +132,36 @@ def test_equality(self, video_note): assert a != e assert hash(a) != hash(e) - async def test_error_without_required_args(self, bot, chat_id): + async def test_error_without_required_args(self, offline_bot, chat_id): with pytest.raises(TypeError): - await bot.send_video_note(chat_id=chat_id) + await offline_bot.send_video_note(chat_id=chat_id) - async def test_send_with_video_note(self, monkeypatch, bot, chat_id, video_note): + async def test_send_with_video_note(self, monkeypatch, offline_bot, chat_id, video_note): async def make_assertion(url, request_data: RequestData, *args, **kwargs): return request_data.json_parameters["video_note"] == video_note.file_id - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.send_video_note(chat_id, video_note=video_note) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.send_video_note(chat_id, video_note=video_note) async def test_send_video_note_custom_filename( - self, bot, chat_id, video_note_file, monkeypatch + self, offline_bot, chat_id, video_note_file, monkeypatch ): async def make_assertion(url, request_data: RequestData, *args, **kwargs): return next(iter(request_data.multipart_data.values()))[0] == "custom_filename" - monkeypatch.setattr(bot.request, "post", make_assertion) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) - assert await bot.send_video_note(chat_id, video_note_file, filename="custom_filename") + assert await offline_bot.send_video_note( + chat_id, video_note_file, filename="custom_filename" + ) @pytest.mark.parametrize("local_mode", [True, False]) - async def test_send_video_note_local_files(self, monkeypatch, bot, chat_id, local_mode): + async def test_send_video_note_local_files( + self, monkeypatch, offline_bot, chat_id, local_mode + ): try: - bot._local_mode = local_mode - # For just test that the correct paths are passed as we have no local bot API set up + offline_bot._local_mode = local_mode + # For just test that the correct paths are passed as we have no local Bot API set up test_flag = False file = data_file("telegram.jpg") expected = file.as_uri() @@ -173,11 +177,11 @@ async def make_assertion(_, data, *args, **kwargs): data.get("thumbnail"), InputFile ) - monkeypatch.setattr(bot, "_post", make_assertion) - await bot.send_video_note(chat_id, file, thumbnail=file) + monkeypatch.setattr(offline_bot, "_post", make_assertion) + await offline_bot.send_video_note(chat_id, file, thumbnail=file) assert test_flag finally: - bot._local_mode = False + offline_bot._local_mode = False async def test_get_file_instance_method(self, monkeypatch, video_note): async def make_assertion(*_, **kwargs): @@ -218,7 +222,7 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): ) -class TestVideoNoteWithRequest(TestVideoNoteBase): +class TestVideoNoteWithRequest(VideoNoteTestBase): async def test_send_all_args(self, bot, chat_id, video_note_file, video_note, thumb_file): message = await bot.send_video_note( chat_id, @@ -244,7 +248,7 @@ async def test_send_all_args(self, bot, chat_id, video_note_file, video_note, th assert message.video_note.thumbnail.height == self.thumb_height assert message.has_protected_content - async def test_get_and_download(self, bot, video_note, chat_id, tmp_file): + async def test_get_and_download(self, bot, video_note, tmp_file): new_file = await bot.get_file(video_note.file_id) assert new_file.file_size == self.file_size diff --git a/tests/_files/test_voice.py b/tests/_files/test_voice.py index 8060221c724..e32bb195c8e 100644 --- a/tests/_files/test_voice.py +++ b/tests/_files/test_voice.py @@ -37,7 +37,7 @@ from tests.auxil.slots import mro_slots -@pytest.fixture() +@pytest.fixture def voice_file(): with data_file("telegram.ogg").open("rb") as f: yield f @@ -49,7 +49,7 @@ async def voice(bot, chat_id): return (await bot.send_voice(chat_id, voice=f, read_timeout=50)).voice -class TestVoiceBase: +class VoiceTestBase: duration = 3 mime_type = "audio/ogg" file_size = 9199 @@ -59,7 +59,7 @@ class TestVoiceBase: voice_file_unique_id = "adc3145fd2e84d95b64d68eaa22aa33e" -class TestVoiceWithoutRequest(TestVoiceBase): +class TestVoiceWithoutRequest(VoiceTestBase): def test_slot_behaviour(self, voice): for attr in voice.__slots__: assert getattr(voice, attr, "err") != "err", f"got extra slot '{attr}'" @@ -78,7 +78,7 @@ def test_expected_values(self, voice): assert voice.mime_type == self.mime_type assert voice.file_size == self.file_size - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "file_id": self.voice_file_id, "file_unique_id": self.voice_file_unique_id, @@ -86,7 +86,7 @@ def test_de_json(self, bot): "mime_type": self.mime_type, "file_size": self.file_size, } - json_voice = Voice.de_json(json_dict, bot) + json_voice = Voice.de_json(json_dict, offline_bot) assert json_voice.api_kwargs == {} assert json_voice.file_id == self.voice_file_id @@ -125,30 +125,30 @@ def test_equality(self, voice): assert a != e assert hash(a) != hash(e) - async def test_error_without_required_args(self, bot, chat_id): + async def test_error_without_required_args(self, offline_bot, chat_id): with pytest.raises(TypeError): - await bot.sendVoice(chat_id) + await offline_bot.sendVoice(chat_id) - async def test_send_voice_custom_filename(self, bot, chat_id, voice_file, monkeypatch): + async def test_send_voice_custom_filename(self, offline_bot, chat_id, voice_file, monkeypatch): async def make_assertion(url, request_data: RequestData, *args, **kwargs): return next(iter(request_data.multipart_data.values()))[0] == "custom_filename" - monkeypatch.setattr(bot.request, "post", make_assertion) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) - assert await bot.send_voice(chat_id, voice_file, filename="custom_filename") + assert await offline_bot.send_voice(chat_id, voice_file, filename="custom_filename") - async def test_send_with_voice(self, monkeypatch, bot, chat_id, voice): + async def test_send_with_voice(self, monkeypatch, offline_bot, chat_id, voice): async def make_assertion(url, request_data: RequestData, *args, **kwargs): return request_data.json_parameters["voice"] == voice.file_id - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.send_voice(chat_id, voice=voice) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.send_voice(chat_id, voice=voice) @pytest.mark.parametrize("local_mode", [True, False]) - async def test_send_voice_local_files(self, monkeypatch, bot, chat_id, local_mode): + async def test_send_voice_local_files(self, monkeypatch, offline_bot, chat_id, local_mode): try: - bot._local_mode = local_mode - # For just test that the correct paths are passed as we have no local bot API set up + offline_bot._local_mode = local_mode + # For just test that the correct paths are passed as we have no local Bot API set up test_flag = False file = data_file("telegram.jpg") expected = file.as_uri() @@ -160,11 +160,11 @@ async def make_assertion(_, data, *args, **kwargs): else: test_flag = isinstance(data.get("voice"), InputFile) - monkeypatch.setattr(bot, "_post", make_assertion) - await bot.send_voice(chat_id, file) + monkeypatch.setattr(offline_bot, "_post", make_assertion) + await offline_bot.send_voice(chat_id, file) assert test_flag finally: - bot._local_mode = False + offline_bot._local_mode = False async def test_get_file_instance_method(self, monkeypatch, voice): async def make_assertion(*_, **kwargs): @@ -203,7 +203,7 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): await default_bot.send_voice(chat_id, voice, reply_parameters=ReplyParameters(**kwargs)) -class TestVoiceWithRequest(TestVoiceBase): +class TestVoiceWithRequest(VoiceTestBase): async def test_send_all_args(self, bot, chat_id, voice_file, voice): message = await bot.send_voice( chat_id, diff --git a/tests/_games/test_game.py b/tests/_games/test_game.py index 49067a8009a..89a6013211d 100644 --- a/tests/_games/test_game.py +++ b/tests/_games/test_game.py @@ -26,18 +26,18 @@ @pytest.fixture(scope="module") def game(): game = Game( - TestGameBase.title, - TestGameBase.description, - TestGameBase.photo, - text=TestGameBase.text, - text_entities=TestGameBase.text_entities, - animation=TestGameBase.animation, + GameTestBase.title, + GameTestBase.description, + GameTestBase.photo, + text=GameTestBase.text, + text_entities=GameTestBase.text_entities, + animation=GameTestBase.animation, ) game._unfreeze() return game -class TestGameBase: +class GameTestBase: title = "Python-telegram-bot Test Game" description = "description" photo = [PhotoSize("Blah", "ElseBlah", 640, 360, file_size=0)] @@ -49,26 +49,26 @@ class TestGameBase: animation = Animation("blah", "unique_id", 320, 180, 1) -class TestGameWithoutRequest(TestGameBase): +class TestGameWithoutRequest(GameTestBase): def test_slot_behaviour(self, game): for attr in game.__slots__: assert getattr(game, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(game)) == len(set(mro_slots(game))), "duplicate slot" - def test_de_json_required(self, bot): + def test_de_json_required(self, offline_bot): json_dict = { "title": self.title, "description": self.description, "photo": [self.photo[0].to_dict()], } - game = Game.de_json(json_dict, bot) + game = Game.de_json(json_dict, offline_bot) assert game.api_kwargs == {} assert game.title == self.title assert game.description == self.description assert game.photo == tuple(self.photo) - def test_de_json_all(self, bot): + def test_de_json_all(self, offline_bot): json_dict = { "title": self.title, "description": self.description, @@ -77,7 +77,7 @@ def test_de_json_all(self, bot): "text_entities": [self.text_entities[0].to_dict()], "animation": self.animation.to_dict(), } - game = Game.de_json(json_dict, bot) + game = Game.de_json(json_dict, offline_bot) assert game.api_kwargs == {} assert game.title == self.title diff --git a/tests/_games/test_gamehighscore.py b/tests/_games/test_gamehighscore.py index 02738be2123..c07488c80fc 100644 --- a/tests/_games/test_gamehighscore.py +++ b/tests/_games/test_gamehighscore.py @@ -26,36 +26,36 @@ @pytest.fixture(scope="module") def game_highscore(): return GameHighScore( - TestGameHighScoreBase.position, TestGameHighScoreBase.user, TestGameHighScoreBase.score + GameHighScoreTestBase.position, GameHighScoreTestBase.user, GameHighScoreTestBase.score ) -class TestGameHighScoreBase: +class GameHighScoreTestBase: position = 12 user = User(2, "test user", False) score = 42 -class TestGameHighScoreWithoutRequest(TestGameHighScoreBase): +class TestGameHighScoreWithoutRequest(GameHighScoreTestBase): def test_slot_behaviour(self, game_highscore): for attr in game_highscore.__slots__: assert getattr(game_highscore, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(game_highscore)) == len(set(mro_slots(game_highscore))), "same slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "position": self.position, "user": self.user.to_dict(), "score": self.score, } - highscore = GameHighScore.de_json(json_dict, bot) + highscore = GameHighScore.de_json(json_dict, offline_bot) assert highscore.api_kwargs == {} assert highscore.position == self.position assert highscore.user == self.user assert highscore.score == self.score - assert GameHighScore.de_json(None, bot) is None + assert GameHighScore.de_json(None, offline_bot) is None def test_to_dict(self, game_highscore): game_highscore_dict = game_highscore.to_dict() diff --git a/tests/_inline/test_inlinekeyboardbutton.py b/tests/_inline/test_inlinekeyboardbutton.py index 9eb1eff49cf..a71e774898d 100644 --- a/tests/_inline/test_inlinekeyboardbutton.py +++ b/tests/_inline/test_inlinekeyboardbutton.py @@ -21,6 +21,7 @@ from telegram import ( CallbackGame, + CopyTextButton, InlineKeyboardButton, LoginUrl, SwitchInlineQueryChosenChat, @@ -32,24 +33,25 @@ @pytest.fixture(scope="module") def inline_keyboard_button(): return InlineKeyboardButton( - TestInlineKeyboardButtonBase.text, - url=TestInlineKeyboardButtonBase.url, - callback_data=TestInlineKeyboardButtonBase.callback_data, - switch_inline_query=TestInlineKeyboardButtonBase.switch_inline_query, + InlineKeyboardButtonTestBase.text, + url=InlineKeyboardButtonTestBase.url, + callback_data=InlineKeyboardButtonTestBase.callback_data, + switch_inline_query=InlineKeyboardButtonTestBase.switch_inline_query, switch_inline_query_current_chat=( - TestInlineKeyboardButtonBase.switch_inline_query_current_chat + InlineKeyboardButtonTestBase.switch_inline_query_current_chat ), - callback_game=TestInlineKeyboardButtonBase.callback_game, - pay=TestInlineKeyboardButtonBase.pay, - login_url=TestInlineKeyboardButtonBase.login_url, - web_app=TestInlineKeyboardButtonBase.web_app, + callback_game=InlineKeyboardButtonTestBase.callback_game, + pay=InlineKeyboardButtonTestBase.pay, + login_url=InlineKeyboardButtonTestBase.login_url, + web_app=InlineKeyboardButtonTestBase.web_app, switch_inline_query_chosen_chat=( - TestInlineKeyboardButtonBase.switch_inline_query_chosen_chat + InlineKeyboardButtonTestBase.switch_inline_query_chosen_chat ), + copy_text=InlineKeyboardButtonTestBase.copy_text, ) -class TestInlineKeyboardButtonBase: +class InlineKeyboardButtonTestBase: text = "text" url = "url" callback_data = "callback data" @@ -60,9 +62,10 @@ class TestInlineKeyboardButtonBase: login_url = LoginUrl("http://google.com") web_app = WebAppInfo(url="https://example.com") switch_inline_query_chosen_chat = SwitchInlineQueryChosenChat("a_bot", True, False, True, True) + copy_text = CopyTextButton("python-telegram-bot") -class TestInlineKeyboardButtonWithoutRequest(TestInlineKeyboardButtonBase): +class TestInlineKeyboardButtonWithoutRequest(InlineKeyboardButtonTestBase): def test_slot_behaviour(self, inline_keyboard_button): inst = inline_keyboard_button for attr in inst.__slots__: @@ -86,6 +89,7 @@ def test_expected_values(self, inline_keyboard_button): inline_keyboard_button.switch_inline_query_chosen_chat == self.switch_inline_query_chosen_chat ) + assert inline_keyboard_button.copy_text == self.copy_text def test_to_dict(self, inline_keyboard_button): inline_keyboard_button_dict = inline_keyboard_button.to_dict() @@ -115,8 +119,11 @@ def test_to_dict(self, inline_keyboard_button): inline_keyboard_button_dict["switch_inline_query_chosen_chat"] == inline_keyboard_button.switch_inline_query_chosen_chat.to_dict() ) + assert ( + inline_keyboard_button_dict["copy_text"] == inline_keyboard_button.copy_text.to_dict() + ) - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "text": self.text, "url": self.url, @@ -128,6 +135,7 @@ def test_de_json(self, bot): "login_url": self.login_url.to_dict(), "pay": self.pay, "switch_inline_query_chosen_chat": self.switch_inline_query_chosen_chat.to_dict(), + "copy_text": self.copy_text.to_dict(), } inline_keyboard_button = InlineKeyboardButton.de_json(json_dict, None) @@ -149,8 +157,9 @@ def test_de_json(self, bot): inline_keyboard_button.switch_inline_query_chosen_chat == self.switch_inline_query_chosen_chat ) + assert inline_keyboard_button.copy_text == self.copy_text - none = InlineKeyboardButton.de_json({}, bot) + none = InlineKeyboardButton.de_json({}, offline_bot) assert none is None def test_equality(self): diff --git a/tests/_inline/test_inlinekeyboardmarkup.py b/tests/_inline/test_inlinekeyboardmarkup.py index d7e8700dd6d..461379436b9 100644 --- a/tests/_inline/test_inlinekeyboardmarkup.py +++ b/tests/_inline/test_inlinekeyboardmarkup.py @@ -31,10 +31,10 @@ @pytest.fixture(scope="module") def inline_keyboard_markup(): - return InlineKeyboardMarkup(TestInlineKeyboardMarkupBase.inline_keyboard) + return InlineKeyboardMarkup(InlineKeyboardMarkupTestBase.inline_keyboard) -class TestInlineKeyboardMarkupBase: +class InlineKeyboardMarkupTestBase: inline_keyboard = [ [ InlineKeyboardButton(text="button1", callback_data="data1"), @@ -43,7 +43,7 @@ class TestInlineKeyboardMarkupBase: ] -class TestInlineKeyboardMarkupWithoutRequest(TestInlineKeyboardMarkupBase): +class TestInlineKeyboardMarkupWithoutRequest(InlineKeyboardMarkupTestBase): def test_slot_behaviour(self, inline_keyboard_markup): inst = inline_keyboard_markup for attr in inst.__slots__: @@ -192,7 +192,9 @@ def test_wrong_keyboard_inputs(self): with pytest.raises(ValueError, match="should be a sequence of sequences"): InlineKeyboardMarkup([[[InlineKeyboardButton("only_2d_array_is_allowed", "1")]]]) - async def test_expected_values_empty_switch(self, inline_keyboard_markup, bot, monkeypatch): + async def test_expected_values_empty_switch( + self, inline_keyboard_markup, offline_bot, monkeypatch + ): async def make_assertion( url, data, @@ -224,11 +226,11 @@ async def make_assertion( inline_keyboard_markup.inline_keyboard[0][1].callback_data = None inline_keyboard_markup.inline_keyboard[0][1].switch_inline_query_current_chat = "" - monkeypatch.setattr(bot, "_send_message", make_assertion) - await bot.send_message(123, "test", reply_markup=inline_keyboard_markup) + monkeypatch.setattr(offline_bot, "_send_message", make_assertion) + await offline_bot.send_message(123, "test", reply_markup=inline_keyboard_markup) -class TestInlineKeyborardMarkupWithRequest(TestInlineKeyboardMarkupBase): +class TestInlineKeyborardMarkupWithRequest(InlineKeyboardMarkupTestBase): async def test_send_message_with_inline_keyboard_markup( self, bot, chat_id, inline_keyboard_markup ): diff --git a/tests/_inline/test_inlinequery.py b/tests/_inline/test_inlinequery.py index e5c8562c528..7ff22c445c5 100644 --- a/tests/_inline/test_inlinequery.py +++ b/tests/_inline/test_inlinequery.py @@ -31,17 +31,17 @@ @pytest.fixture(scope="module") def inline_query(bot): ilq = InlineQuery( - TestInlineQueryBase.id_, - TestInlineQueryBase.from_user, - TestInlineQueryBase.query, - TestInlineQueryBase.offset, - location=TestInlineQueryBase.location, + InlineQueryTestBase.id_, + InlineQueryTestBase.from_user, + InlineQueryTestBase.query, + InlineQueryTestBase.offset, + location=InlineQueryTestBase.location, ) ilq.set_bot(bot) return ilq -class TestInlineQueryBase: +class InlineQueryTestBase: id_ = 1234 from_user = User(1, "First name", False) query = "query text" @@ -49,13 +49,13 @@ class TestInlineQueryBase: location = Location(8.8, 53.1) -class TestInlineQueryWithoutRequest(TestInlineQueryBase): +class TestInlineQueryWithoutRequest(InlineQueryTestBase): def test_slot_behaviour(self, inline_query): for attr in inline_query.__slots__: assert getattr(inline_query, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inline_query)) == len(set(mro_slots(inline_query))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "id": self.id_, "from": self.from_user.to_dict(), @@ -63,7 +63,7 @@ def test_de_json(self, bot): "offset": self.offset, "location": self.location.to_dict(), } - inline_query_json = InlineQuery.de_json(json_dict, bot) + inline_query_json = InlineQuery.de_json(json_dict, offline_bot) assert inline_query_json.api_kwargs == {} assert inline_query_json.id == self.id_ diff --git a/tests/_inline/test_inlinequeryresultarticle.py b/tests/_inline/test_inlinequeryresultarticle.py index 4bc56c92d80..0692c425d0a 100644 --- a/tests/_inline/test_inlinequeryresultarticle.py +++ b/tests/_inline/test_inlinequeryresultarticle.py @@ -34,20 +34,20 @@ @pytest.fixture(scope="module") def inline_query_result_article(): return InlineQueryResultArticle( - TestInlineQueryResultArticleBase.id_, - TestInlineQueryResultArticleBase.title, - input_message_content=TestInlineQueryResultArticleBase.input_message_content, - reply_markup=TestInlineQueryResultArticleBase.reply_markup, - url=TestInlineQueryResultArticleBase.url, - hide_url=TestInlineQueryResultArticleBase.hide_url, - description=TestInlineQueryResultArticleBase.description, - thumbnail_url=TestInlineQueryResultArticleBase.thumbnail_url, - thumbnail_height=TestInlineQueryResultArticleBase.thumbnail_height, - thumbnail_width=TestInlineQueryResultArticleBase.thumbnail_width, + InlineQueryResultArticleTestBase.id_, + InlineQueryResultArticleTestBase.title, + input_message_content=InlineQueryResultArticleTestBase.input_message_content, + reply_markup=InlineQueryResultArticleTestBase.reply_markup, + url=InlineQueryResultArticleTestBase.url, + hide_url=InlineQueryResultArticleTestBase.hide_url, + description=InlineQueryResultArticleTestBase.description, + thumbnail_url=InlineQueryResultArticleTestBase.thumbnail_url, + thumbnail_height=InlineQueryResultArticleTestBase.thumbnail_height, + thumbnail_width=InlineQueryResultArticleTestBase.thumbnail_width, ) -class TestInlineQueryResultArticleBase: +class InlineQueryResultArticleTestBase: id_ = "id" type_ = "article" title = "title" @@ -61,7 +61,7 @@ class TestInlineQueryResultArticleBase: thumbnail_width = 15 -class TestInlineQueryResultArticleWithoutRequest(TestInlineQueryResultArticleBase): +class TestInlineQueryResultArticleWithoutRequest(InlineQueryResultArticleTestBase): def test_slot_behaviour(self, inline_query_result_article): inst = inline_query_result_article for attr in inst.__slots__: diff --git a/tests/_inline/test_inlinequeryresultaudio.py b/tests/_inline/test_inlinequeryresultaudio.py index 33542787ed8..251b3f6a41e 100644 --- a/tests/_inline/test_inlinequeryresultaudio.py +++ b/tests/_inline/test_inlinequeryresultaudio.py @@ -33,20 +33,20 @@ @pytest.fixture(scope="module") def inline_query_result_audio(): return InlineQueryResultAudio( - TestInlineQueryResultAudioBase.id_, - TestInlineQueryResultAudioBase.audio_url, - TestInlineQueryResultAudioBase.title, - performer=TestInlineQueryResultAudioBase.performer, - audio_duration=TestInlineQueryResultAudioBase.audio_duration, - caption=TestInlineQueryResultAudioBase.caption, - parse_mode=TestInlineQueryResultAudioBase.parse_mode, - caption_entities=TestInlineQueryResultAudioBase.caption_entities, - input_message_content=TestInlineQueryResultAudioBase.input_message_content, - reply_markup=TestInlineQueryResultAudioBase.reply_markup, + InlineQueryResultAudioTestBase.id_, + InlineQueryResultAudioTestBase.audio_url, + InlineQueryResultAudioTestBase.title, + performer=InlineQueryResultAudioTestBase.performer, + audio_duration=InlineQueryResultAudioTestBase.audio_duration, + caption=InlineQueryResultAudioTestBase.caption, + parse_mode=InlineQueryResultAudioTestBase.parse_mode, + caption_entities=InlineQueryResultAudioTestBase.caption_entities, + input_message_content=InlineQueryResultAudioTestBase.input_message_content, + reply_markup=InlineQueryResultAudioTestBase.reply_markup, ) -class TestInlineQueryResultAudioBase: +class InlineQueryResultAudioTestBase: id_ = "id" type_ = "audio" audio_url = "audio url" @@ -60,7 +60,7 @@ class TestInlineQueryResultAudioBase: reply_markup = InlineKeyboardMarkup([[InlineKeyboardButton("reply_markup")]]) -class TestInlineQueryResultAudioWithoutRequest(TestInlineQueryResultAudioBase): +class TestInlineQueryResultAudioWithoutRequest(InlineQueryResultAudioTestBase): def test_slot_behaviour(self, inline_query_result_audio): inst = inline_query_result_audio for attr in inst.__slots__: diff --git a/tests/_inline/test_inlinequeryresultcachedaudio.py b/tests/_inline/test_inlinequeryresultcachedaudio.py index efa0cb06e27..363580bd615 100644 --- a/tests/_inline/test_inlinequeryresultcachedaudio.py +++ b/tests/_inline/test_inlinequeryresultcachedaudio.py @@ -33,17 +33,17 @@ @pytest.fixture(scope="module") def inline_query_result_cached_audio(): return InlineQueryResultCachedAudio( - TestInlineQueryResultCachedAudioBase.id_, - TestInlineQueryResultCachedAudioBase.audio_file_id, - caption=TestInlineQueryResultCachedAudioBase.caption, - parse_mode=TestInlineQueryResultCachedAudioBase.parse_mode, - caption_entities=TestInlineQueryResultCachedAudioBase.caption_entities, - input_message_content=TestInlineQueryResultCachedAudioBase.input_message_content, - reply_markup=TestInlineQueryResultCachedAudioBase.reply_markup, + InlineQueryResultCachedAudioTestBase.id_, + InlineQueryResultCachedAudioTestBase.audio_file_id, + caption=InlineQueryResultCachedAudioTestBase.caption, + parse_mode=InlineQueryResultCachedAudioTestBase.parse_mode, + caption_entities=InlineQueryResultCachedAudioTestBase.caption_entities, + input_message_content=InlineQueryResultCachedAudioTestBase.input_message_content, + reply_markup=InlineQueryResultCachedAudioTestBase.reply_markup, ) -class TestInlineQueryResultCachedAudioBase: +class InlineQueryResultCachedAudioTestBase: id_ = "id" type_ = "audio" audio_file_id = "audio file id" @@ -54,7 +54,7 @@ class TestInlineQueryResultCachedAudioBase: reply_markup = InlineKeyboardMarkup([[InlineKeyboardButton("reply_markup")]]) -class TestInlineQueryResultCachedAudioWithoutRequest(TestInlineQueryResultCachedAudioBase): +class TestInlineQueryResultCachedAudioWithoutRequest(InlineQueryResultCachedAudioTestBase): def test_slot_behaviour(self, inline_query_result_cached_audio): inst = inline_query_result_cached_audio for attr in inst.__slots__: diff --git a/tests/_inline/test_inlinequeryresultcacheddocument.py b/tests/_inline/test_inlinequeryresultcacheddocument.py index 48c9eef252b..c3d6a19ac3f 100644 --- a/tests/_inline/test_inlinequeryresultcacheddocument.py +++ b/tests/_inline/test_inlinequeryresultcacheddocument.py @@ -33,19 +33,19 @@ @pytest.fixture(scope="module") def inline_query_result_cached_document(): return InlineQueryResultCachedDocument( - TestInlineQueryResultCachedDocumentBase.id_, - TestInlineQueryResultCachedDocumentBase.title, - TestInlineQueryResultCachedDocumentBase.document_file_id, - caption=TestInlineQueryResultCachedDocumentBase.caption, - parse_mode=TestInlineQueryResultCachedDocumentBase.parse_mode, - caption_entities=TestInlineQueryResultCachedDocumentBase.caption_entities, - description=TestInlineQueryResultCachedDocumentBase.description, - input_message_content=TestInlineQueryResultCachedDocumentBase.input_message_content, - reply_markup=TestInlineQueryResultCachedDocumentBase.reply_markup, + InlineQueryResultCachedDocumentTestBase.id_, + InlineQueryResultCachedDocumentTestBase.title, + InlineQueryResultCachedDocumentTestBase.document_file_id, + caption=InlineQueryResultCachedDocumentTestBase.caption, + parse_mode=InlineQueryResultCachedDocumentTestBase.parse_mode, + caption_entities=InlineQueryResultCachedDocumentTestBase.caption_entities, + description=InlineQueryResultCachedDocumentTestBase.description, + input_message_content=InlineQueryResultCachedDocumentTestBase.input_message_content, + reply_markup=InlineQueryResultCachedDocumentTestBase.reply_markup, ) -class TestInlineQueryResultCachedDocumentBase: +class InlineQueryResultCachedDocumentTestBase: id_ = "id" type_ = "document" document_file_id = "document file id" @@ -58,7 +58,7 @@ class TestInlineQueryResultCachedDocumentBase: reply_markup = InlineKeyboardMarkup([[InlineKeyboardButton("reply_markup")]]) -class TestInlineQueryResultCachedDocumentWithoutRequest(TestInlineQueryResultCachedDocumentBase): +class TestInlineQueryResultCachedDocumentWithoutRequest(InlineQueryResultCachedDocumentTestBase): def test_slot_behaviour(self, inline_query_result_cached_document): inst = inline_query_result_cached_document for attr in inst.__slots__: diff --git a/tests/_inline/test_inlinequeryresultcachedgif.py b/tests/_inline/test_inlinequeryresultcachedgif.py index 62b908a631f..8128dc7b6b0 100644 --- a/tests/_inline/test_inlinequeryresultcachedgif.py +++ b/tests/_inline/test_inlinequeryresultcachedgif.py @@ -32,19 +32,19 @@ @pytest.fixture(scope="module") def inline_query_result_cached_gif(): return InlineQueryResultCachedGif( - TestInlineQueryResultCachedGifBase.id_, - TestInlineQueryResultCachedGifBase.gif_file_id, - title=TestInlineQueryResultCachedGifBase.title, - caption=TestInlineQueryResultCachedGifBase.caption, - parse_mode=TestInlineQueryResultCachedGifBase.parse_mode, - caption_entities=TestInlineQueryResultCachedGifBase.caption_entities, - input_message_content=TestInlineQueryResultCachedGifBase.input_message_content, - reply_markup=TestInlineQueryResultCachedGifBase.reply_markup, - show_caption_above_media=TestInlineQueryResultCachedGifBase.show_caption_above_media, + InlineQueryResultCachedGifTestBase.id_, + InlineQueryResultCachedGifTestBase.gif_file_id, + title=InlineQueryResultCachedGifTestBase.title, + caption=InlineQueryResultCachedGifTestBase.caption, + parse_mode=InlineQueryResultCachedGifTestBase.parse_mode, + caption_entities=InlineQueryResultCachedGifTestBase.caption_entities, + input_message_content=InlineQueryResultCachedGifTestBase.input_message_content, + reply_markup=InlineQueryResultCachedGifTestBase.reply_markup, + show_caption_above_media=InlineQueryResultCachedGifTestBase.show_caption_above_media, ) -class TestInlineQueryResultCachedGifBase: +class InlineQueryResultCachedGifTestBase: id_ = "id" type_ = "gif" gif_file_id = "gif file id" @@ -57,7 +57,7 @@ class TestInlineQueryResultCachedGifBase: show_caption_above_media = True -class TestInlineQueryResultCachedGifWithoutRequest(TestInlineQueryResultCachedGifBase): +class TestInlineQueryResultCachedGifWithoutRequest(InlineQueryResultCachedGifTestBase): def test_slot_behaviour(self, inline_query_result_cached_gif): inst = inline_query_result_cached_gif for attr in inst.__slots__: diff --git a/tests/_inline/test_inlinequeryresultcachedmpeg4gif.py b/tests/_inline/test_inlinequeryresultcachedmpeg4gif.py index 3d4b5d3ca5b..fb1db70ceae 100644 --- a/tests/_inline/test_inlinequeryresultcachedmpeg4gif.py +++ b/tests/_inline/test_inlinequeryresultcachedmpeg4gif.py @@ -32,19 +32,19 @@ @pytest.fixture(scope="module") def inline_query_result_cached_mpeg4_gif(): return InlineQueryResultCachedMpeg4Gif( - TestInlineQueryResultCachedMpeg4GifBase.id_, - TestInlineQueryResultCachedMpeg4GifBase.mpeg4_file_id, - title=TestInlineQueryResultCachedMpeg4GifBase.title, - caption=TestInlineQueryResultCachedMpeg4GifBase.caption, - parse_mode=TestInlineQueryResultCachedMpeg4GifBase.parse_mode, - caption_entities=TestInlineQueryResultCachedMpeg4GifBase.caption_entities, - input_message_content=TestInlineQueryResultCachedMpeg4GifBase.input_message_content, - reply_markup=TestInlineQueryResultCachedMpeg4GifBase.reply_markup, - show_caption_above_media=TestInlineQueryResultCachedMpeg4GifBase.show_caption_above_media, + InlineQueryResultCachedMpeg4GifTestBase.id_, + InlineQueryResultCachedMpeg4GifTestBase.mpeg4_file_id, + title=InlineQueryResultCachedMpeg4GifTestBase.title, + caption=InlineQueryResultCachedMpeg4GifTestBase.caption, + parse_mode=InlineQueryResultCachedMpeg4GifTestBase.parse_mode, + caption_entities=InlineQueryResultCachedMpeg4GifTestBase.caption_entities, + input_message_content=InlineQueryResultCachedMpeg4GifTestBase.input_message_content, + reply_markup=InlineQueryResultCachedMpeg4GifTestBase.reply_markup, + show_caption_above_media=InlineQueryResultCachedMpeg4GifTestBase.show_caption_above_media, ) -class TestInlineQueryResultCachedMpeg4GifBase: +class InlineQueryResultCachedMpeg4GifTestBase: id_ = "id" type_ = "mpeg4_gif" mpeg4_file_id = "mpeg4 file id" @@ -57,7 +57,7 @@ class TestInlineQueryResultCachedMpeg4GifBase: show_caption_above_media = True -class TestInlineQueryResultCachedMpeg4GifWithoutRequest(TestInlineQueryResultCachedMpeg4GifBase): +class TestInlineQueryResultCachedMpeg4GifWithoutRequest(InlineQueryResultCachedMpeg4GifTestBase): def test_slot_behaviour(self, inline_query_result_cached_mpeg4_gif): inst = inline_query_result_cached_mpeg4_gif for attr in inst.__slots__: diff --git a/tests/_inline/test_inlinequeryresultcachedphoto.py b/tests/_inline/test_inlinequeryresultcachedphoto.py index b5ed6153b91..e3159acf3aa 100644 --- a/tests/_inline/test_inlinequeryresultcachedphoto.py +++ b/tests/_inline/test_inlinequeryresultcachedphoto.py @@ -32,20 +32,20 @@ @pytest.fixture(scope="module") def inline_query_result_cached_photo(): return InlineQueryResultCachedPhoto( - TestInlineQueryResultCachedPhotoBase.id_, - TestInlineQueryResultCachedPhotoBase.photo_file_id, - title=TestInlineQueryResultCachedPhotoBase.title, - description=TestInlineQueryResultCachedPhotoBase.description, - caption=TestInlineQueryResultCachedPhotoBase.caption, - parse_mode=TestInlineQueryResultCachedPhotoBase.parse_mode, - caption_entities=TestInlineQueryResultCachedPhotoBase.caption_entities, - input_message_content=TestInlineQueryResultCachedPhotoBase.input_message_content, - reply_markup=TestInlineQueryResultCachedPhotoBase.reply_markup, - show_caption_above_media=TestInlineQueryResultCachedPhotoBase.show_caption_above_media, + InlineQueryResultCachedPhotoTestBase.id_, + InlineQueryResultCachedPhotoTestBase.photo_file_id, + title=InlineQueryResultCachedPhotoTestBase.title, + description=InlineQueryResultCachedPhotoTestBase.description, + caption=InlineQueryResultCachedPhotoTestBase.caption, + parse_mode=InlineQueryResultCachedPhotoTestBase.parse_mode, + caption_entities=InlineQueryResultCachedPhotoTestBase.caption_entities, + input_message_content=InlineQueryResultCachedPhotoTestBase.input_message_content, + reply_markup=InlineQueryResultCachedPhotoTestBase.reply_markup, + show_caption_above_media=InlineQueryResultCachedPhotoTestBase.show_caption_above_media, ) -class TestInlineQueryResultCachedPhotoBase: +class InlineQueryResultCachedPhotoTestBase: id_ = "id" type_ = "photo" photo_file_id = "photo file id" @@ -59,7 +59,7 @@ class TestInlineQueryResultCachedPhotoBase: show_caption_above_media = True -class TestInlineQueryResultCachedPhotoWithoutRequest(TestInlineQueryResultCachedPhotoBase): +class TestInlineQueryResultCachedPhotoWithoutRequest(InlineQueryResultCachedPhotoTestBase): def test_slot_behaviour(self, inline_query_result_cached_photo): inst = inline_query_result_cached_photo for attr in inst.__slots__: diff --git a/tests/_inline/test_inlinequeryresultcachedsticker.py b/tests/_inline/test_inlinequeryresultcachedsticker.py index 63b7f2425fd..ee4d5e3e8d1 100644 --- a/tests/_inline/test_inlinequeryresultcachedsticker.py +++ b/tests/_inline/test_inlinequeryresultcachedsticker.py @@ -31,14 +31,14 @@ @pytest.fixture(scope="module") def inline_query_result_cached_sticker(): return InlineQueryResultCachedSticker( - TestInlineQueryResultCachedStickerBase.id_, - TestInlineQueryResultCachedStickerBase.sticker_file_id, - input_message_content=TestInlineQueryResultCachedStickerBase.input_message_content, - reply_markup=TestInlineQueryResultCachedStickerBase.reply_markup, + InlineQueryResultCachedStickerTestBase.id_, + InlineQueryResultCachedStickerTestBase.sticker_file_id, + input_message_content=InlineQueryResultCachedStickerTestBase.input_message_content, + reply_markup=InlineQueryResultCachedStickerTestBase.reply_markup, ) -class TestInlineQueryResultCachedStickerBase: +class InlineQueryResultCachedStickerTestBase: id_ = "id" type_ = "sticker" sticker_file_id = "sticker file id" @@ -46,7 +46,7 @@ class TestInlineQueryResultCachedStickerBase: reply_markup = InlineKeyboardMarkup([[InlineKeyboardButton("reply_markup")]]) -class TestInlineQueryResultCachedStickerWithoutRequest(TestInlineQueryResultCachedStickerBase): +class TestInlineQueryResultCachedStickerWithoutRequest(InlineQueryResultCachedStickerTestBase): def test_slot_behaviour(self, inline_query_result_cached_sticker): inst = inline_query_result_cached_sticker for attr in inst.__slots__: diff --git a/tests/_inline/test_inlinequeryresultcachedvideo.py b/tests/_inline/test_inlinequeryresultcachedvideo.py index d520b3c7c10..efd0f624de3 100644 --- a/tests/_inline/test_inlinequeryresultcachedvideo.py +++ b/tests/_inline/test_inlinequeryresultcachedvideo.py @@ -32,20 +32,20 @@ @pytest.fixture(scope="module") def inline_query_result_cached_video(): return InlineQueryResultCachedVideo( - TestInlineQueryResultCachedVideoBase.id_, - TestInlineQueryResultCachedVideoBase.video_file_id, - TestInlineQueryResultCachedVideoBase.title, - caption=TestInlineQueryResultCachedVideoBase.caption, - parse_mode=TestInlineQueryResultCachedVideoBase.parse_mode, - caption_entities=TestInlineQueryResultCachedVideoBase.caption_entities, - description=TestInlineQueryResultCachedVideoBase.description, - input_message_content=TestInlineQueryResultCachedVideoBase.input_message_content, - reply_markup=TestInlineQueryResultCachedVideoBase.reply_markup, - show_caption_above_media=TestInlineQueryResultCachedVideoBase.show_caption_above_media, + InlineQueryResultCachedVideoTestBase.id_, + InlineQueryResultCachedVideoTestBase.video_file_id, + InlineQueryResultCachedVideoTestBase.title, + caption=InlineQueryResultCachedVideoTestBase.caption, + parse_mode=InlineQueryResultCachedVideoTestBase.parse_mode, + caption_entities=InlineQueryResultCachedVideoTestBase.caption_entities, + description=InlineQueryResultCachedVideoTestBase.description, + input_message_content=InlineQueryResultCachedVideoTestBase.input_message_content, + reply_markup=InlineQueryResultCachedVideoTestBase.reply_markup, + show_caption_above_media=InlineQueryResultCachedVideoTestBase.show_caption_above_media, ) -class TestInlineQueryResultCachedVideoBase: +class InlineQueryResultCachedVideoTestBase: id_ = "id" type_ = "video" video_file_id = "video file id" @@ -59,7 +59,7 @@ class TestInlineQueryResultCachedVideoBase: show_caption_above_media = True -class TestInlineQueryResultCachedVideoWithoutRequest(TestInlineQueryResultCachedVideoBase): +class TestInlineQueryResultCachedVideoWithoutRequest(InlineQueryResultCachedVideoTestBase): def test_slot_behaviour(self, inline_query_result_cached_video): inst = inline_query_result_cached_video for attr in inst.__slots__: diff --git a/tests/_inline/test_inlinequeryresultcachedvoice.py b/tests/_inline/test_inlinequeryresultcachedvoice.py index de6810b2b58..916364ab987 100644 --- a/tests/_inline/test_inlinequeryresultcachedvoice.py +++ b/tests/_inline/test_inlinequeryresultcachedvoice.py @@ -32,18 +32,18 @@ @pytest.fixture(scope="module") def inline_query_result_cached_voice(): return InlineQueryResultCachedVoice( - TestInlineQueryResultCachedVoiceBase.id_, - TestInlineQueryResultCachedVoiceBase.voice_file_id, - TestInlineQueryResultCachedVoiceBase.title, - caption=TestInlineQueryResultCachedVoiceBase.caption, - parse_mode=TestInlineQueryResultCachedVoiceBase.parse_mode, - caption_entities=TestInlineQueryResultCachedVoiceBase.caption_entities, - input_message_content=TestInlineQueryResultCachedVoiceBase.input_message_content, - reply_markup=TestInlineQueryResultCachedVoiceBase.reply_markup, + InlineQueryResultCachedVoiceTestBase.id_, + InlineQueryResultCachedVoiceTestBase.voice_file_id, + InlineQueryResultCachedVoiceTestBase.title, + caption=InlineQueryResultCachedVoiceTestBase.caption, + parse_mode=InlineQueryResultCachedVoiceTestBase.parse_mode, + caption_entities=InlineQueryResultCachedVoiceTestBase.caption_entities, + input_message_content=InlineQueryResultCachedVoiceTestBase.input_message_content, + reply_markup=InlineQueryResultCachedVoiceTestBase.reply_markup, ) -class TestInlineQueryResultCachedVoiceBase: +class InlineQueryResultCachedVoiceTestBase: id_ = "id" type_ = "voice" voice_file_id = "voice file id" @@ -55,7 +55,7 @@ class TestInlineQueryResultCachedVoiceBase: reply_markup = InlineKeyboardMarkup([[InlineKeyboardButton("reply_markup")]]) -class TestInlineQueryResultCachedVoiceWithoutRequest(TestInlineQueryResultCachedVoiceBase): +class TestInlineQueryResultCachedVoiceWithoutRequest(InlineQueryResultCachedVoiceTestBase): def test_slot_behaviour(self, inline_query_result_cached_voice): inst = inline_query_result_cached_voice for attr in inst.__slots__: diff --git a/tests/_inline/test_inlinequeryresultcontact.py b/tests/_inline/test_inlinequeryresultcontact.py index 4b691f3801b..bb8c8c18147 100644 --- a/tests/_inline/test_inlinequeryresultcontact.py +++ b/tests/_inline/test_inlinequeryresultcontact.py @@ -31,19 +31,19 @@ @pytest.fixture(scope="module") def inline_query_result_contact(): return InlineQueryResultContact( - TestInlineQueryResultContactBase.id_, - TestInlineQueryResultContactBase.phone_number, - TestInlineQueryResultContactBase.first_name, - last_name=TestInlineQueryResultContactBase.last_name, - thumbnail_url=TestInlineQueryResultContactBase.thumbnail_url, - thumbnail_width=TestInlineQueryResultContactBase.thumbnail_width, - thumbnail_height=TestInlineQueryResultContactBase.thumbnail_height, - input_message_content=TestInlineQueryResultContactBase.input_message_content, - reply_markup=TestInlineQueryResultContactBase.reply_markup, + InlineQueryResultContactTestBase.id_, + InlineQueryResultContactTestBase.phone_number, + InlineQueryResultContactTestBase.first_name, + last_name=InlineQueryResultContactTestBase.last_name, + thumbnail_url=InlineQueryResultContactTestBase.thumbnail_url, + thumbnail_width=InlineQueryResultContactTestBase.thumbnail_width, + thumbnail_height=InlineQueryResultContactTestBase.thumbnail_height, + input_message_content=InlineQueryResultContactTestBase.input_message_content, + reply_markup=InlineQueryResultContactTestBase.reply_markup, ) -class TestInlineQueryResultContactBase: +class InlineQueryResultContactTestBase: id_ = "id" type_ = "contact" phone_number = "phone_number" @@ -56,7 +56,7 @@ class TestInlineQueryResultContactBase: reply_markup = InlineKeyboardMarkup([[InlineKeyboardButton("reply_markup")]]) -class TestInlineQueryResultContactWithoutRequest(TestInlineQueryResultContactBase): +class TestInlineQueryResultContactWithoutRequest(InlineQueryResultContactTestBase): def test_slot_behaviour(self, inline_query_result_contact): inst = inline_query_result_contact for attr in inst.__slots__: diff --git a/tests/_inline/test_inlinequeryresultdocument.py b/tests/_inline/test_inlinequeryresultdocument.py index aacf9d85860..024d714c7a1 100644 --- a/tests/_inline/test_inlinequeryresultdocument.py +++ b/tests/_inline/test_inlinequeryresultdocument.py @@ -32,23 +32,23 @@ @pytest.fixture(scope="module") def inline_query_result_document(): return InlineQueryResultDocument( - TestInlineQueryResultDocumentBase.id_, - TestInlineQueryResultDocumentBase.document_url, - TestInlineQueryResultDocumentBase.title, - TestInlineQueryResultDocumentBase.mime_type, - caption=TestInlineQueryResultDocumentBase.caption, - parse_mode=TestInlineQueryResultDocumentBase.parse_mode, - caption_entities=TestInlineQueryResultDocumentBase.caption_entities, - description=TestInlineQueryResultDocumentBase.description, - thumbnail_url=TestInlineQueryResultDocumentBase.thumbnail_url, - thumbnail_width=TestInlineQueryResultDocumentBase.thumbnail_width, - thumbnail_height=TestInlineQueryResultDocumentBase.thumbnail_height, - input_message_content=TestInlineQueryResultDocumentBase.input_message_content, - reply_markup=TestInlineQueryResultDocumentBase.reply_markup, + InlineQueryResultDocumentTestBase.id_, + InlineQueryResultDocumentTestBase.document_url, + InlineQueryResultDocumentTestBase.title, + InlineQueryResultDocumentTestBase.mime_type, + caption=InlineQueryResultDocumentTestBase.caption, + parse_mode=InlineQueryResultDocumentTestBase.parse_mode, + caption_entities=InlineQueryResultDocumentTestBase.caption_entities, + description=InlineQueryResultDocumentTestBase.description, + thumbnail_url=InlineQueryResultDocumentTestBase.thumbnail_url, + thumbnail_width=InlineQueryResultDocumentTestBase.thumbnail_width, + thumbnail_height=InlineQueryResultDocumentTestBase.thumbnail_height, + input_message_content=InlineQueryResultDocumentTestBase.input_message_content, + reply_markup=InlineQueryResultDocumentTestBase.reply_markup, ) -class TestInlineQueryResultDocumentBase: +class InlineQueryResultDocumentTestBase: id_ = "id" type_ = "document" document_url = "document url" @@ -65,7 +65,7 @@ class TestInlineQueryResultDocumentBase: reply_markup = InlineKeyboardMarkup([[InlineKeyboardButton("reply_markup")]]) -class TestInlineQueryResultDocumentWithoutRequest(TestInlineQueryResultDocumentBase): +class TestInlineQueryResultDocumentWithoutRequest(InlineQueryResultDocumentTestBase): def test_slot_behaviour(self, inline_query_result_document): inst = inline_query_result_document for attr in inst.__slots__: diff --git a/tests/_inline/test_inlinequeryresultgame.py b/tests/_inline/test_inlinequeryresultgame.py index 8a72ae401e5..2efb7ead89f 100644 --- a/tests/_inline/test_inlinequeryresultgame.py +++ b/tests/_inline/test_inlinequeryresultgame.py @@ -30,20 +30,20 @@ @pytest.fixture(scope="module") def inline_query_result_game(): return InlineQueryResultGame( - TestInlineQueryResultGameBase.id_, - TestInlineQueryResultGameBase.game_short_name, - reply_markup=TestInlineQueryResultGameBase.reply_markup, + InlineQueryResultGameTestBase.id_, + InlineQueryResultGameTestBase.game_short_name, + reply_markup=InlineQueryResultGameTestBase.reply_markup, ) -class TestInlineQueryResultGameBase: +class InlineQueryResultGameTestBase: id_ = "id" type_ = "game" game_short_name = "game short name" reply_markup = InlineKeyboardMarkup([[InlineKeyboardButton("reply_markup")]]) -class TestInlineQueryResultGameWithoutRequest(TestInlineQueryResultGameBase): +class TestInlineQueryResultGameWithoutRequest(InlineQueryResultGameTestBase): def test_slot_behaviour(self, inline_query_result_game): inst = inline_query_result_game for attr in inst.__slots__: diff --git a/tests/_inline/test_inlinequeryresultgif.py b/tests/_inline/test_inlinequeryresultgif.py index 86ac8574a8e..efd995ac335 100644 --- a/tests/_inline/test_inlinequeryresultgif.py +++ b/tests/_inline/test_inlinequeryresultgif.py @@ -32,24 +32,24 @@ @pytest.fixture(scope="module") def inline_query_result_gif(): return InlineQueryResultGif( - TestInlineQueryResultGifBase.id_, - TestInlineQueryResultGifBase.gif_url, - TestInlineQueryResultGifBase.thumbnail_url, - gif_width=TestInlineQueryResultGifBase.gif_width, - gif_height=TestInlineQueryResultGifBase.gif_height, - gif_duration=TestInlineQueryResultGifBase.gif_duration, - title=TestInlineQueryResultGifBase.title, - caption=TestInlineQueryResultGifBase.caption, - parse_mode=TestInlineQueryResultGifBase.parse_mode, - caption_entities=TestInlineQueryResultGifBase.caption_entities, - input_message_content=TestInlineQueryResultGifBase.input_message_content, - reply_markup=TestInlineQueryResultGifBase.reply_markup, - thumbnail_mime_type=TestInlineQueryResultGifBase.thumbnail_mime_type, - show_caption_above_media=TestInlineQueryResultGifBase.show_caption_above_media, + InlineQueryResultGifTestBase.id_, + InlineQueryResultGifTestBase.gif_url, + InlineQueryResultGifTestBase.thumbnail_url, + gif_width=InlineQueryResultGifTestBase.gif_width, + gif_height=InlineQueryResultGifTestBase.gif_height, + gif_duration=InlineQueryResultGifTestBase.gif_duration, + title=InlineQueryResultGifTestBase.title, + caption=InlineQueryResultGifTestBase.caption, + parse_mode=InlineQueryResultGifTestBase.parse_mode, + caption_entities=InlineQueryResultGifTestBase.caption_entities, + input_message_content=InlineQueryResultGifTestBase.input_message_content, + reply_markup=InlineQueryResultGifTestBase.reply_markup, + thumbnail_mime_type=InlineQueryResultGifTestBase.thumbnail_mime_type, + show_caption_above_media=InlineQueryResultGifTestBase.show_caption_above_media, ) -class TestInlineQueryResultGifBase: +class InlineQueryResultGifTestBase: id_ = "id" type_ = "gif" gif_url = "gif url" @@ -67,7 +67,7 @@ class TestInlineQueryResultGifBase: show_caption_above_media = True -class TestInlineQueryResultGifWithoutRequest(TestInlineQueryResultGifBase): +class TestInlineQueryResultGifWithoutRequest(InlineQueryResultGifTestBase): def test_slot_behaviour(self, inline_query_result_gif): inst = inline_query_result_gif for attr in inst.__slots__: diff --git a/tests/_inline/test_inlinequeryresultlocation.py b/tests/_inline/test_inlinequeryresultlocation.py index 2f5023d5144..76320dddaee 100644 --- a/tests/_inline/test_inlinequeryresultlocation.py +++ b/tests/_inline/test_inlinequeryresultlocation.py @@ -31,23 +31,23 @@ @pytest.fixture(scope="module") def inline_query_result_location(): return InlineQueryResultLocation( - TestInlineQueryResultLocationBase.id_, - TestInlineQueryResultLocationBase.latitude, - TestInlineQueryResultLocationBase.longitude, - TestInlineQueryResultLocationBase.title, - live_period=TestInlineQueryResultLocationBase.live_period, - thumbnail_url=TestInlineQueryResultLocationBase.thumbnail_url, - thumbnail_width=TestInlineQueryResultLocationBase.thumbnail_width, - thumbnail_height=TestInlineQueryResultLocationBase.thumbnail_height, - input_message_content=TestInlineQueryResultLocationBase.input_message_content, - reply_markup=TestInlineQueryResultLocationBase.reply_markup, - horizontal_accuracy=TestInlineQueryResultLocationBase.horizontal_accuracy, - heading=TestInlineQueryResultLocationBase.heading, - proximity_alert_radius=TestInlineQueryResultLocationBase.proximity_alert_radius, + InlineQueryResultLocationTestBase.id_, + InlineQueryResultLocationTestBase.latitude, + InlineQueryResultLocationTestBase.longitude, + InlineQueryResultLocationTestBase.title, + live_period=InlineQueryResultLocationTestBase.live_period, + thumbnail_url=InlineQueryResultLocationTestBase.thumbnail_url, + thumbnail_width=InlineQueryResultLocationTestBase.thumbnail_width, + thumbnail_height=InlineQueryResultLocationTestBase.thumbnail_height, + input_message_content=InlineQueryResultLocationTestBase.input_message_content, + reply_markup=InlineQueryResultLocationTestBase.reply_markup, + horizontal_accuracy=InlineQueryResultLocationTestBase.horizontal_accuracy, + heading=InlineQueryResultLocationTestBase.heading, + proximity_alert_radius=InlineQueryResultLocationTestBase.proximity_alert_radius, ) -class TestInlineQueryResultLocationBase: +class InlineQueryResultLocationTestBase: id_ = "id" type_ = "location" latitude = 0.0 @@ -64,7 +64,7 @@ class TestInlineQueryResultLocationBase: reply_markup = InlineKeyboardMarkup([[InlineKeyboardButton("reply_markup")]]) -class TestInlineQueryResultLocationWithoutRequest(TestInlineQueryResultLocationBase): +class TestInlineQueryResultLocationWithoutRequest(InlineQueryResultLocationTestBase): def test_slot_behaviour(self, inline_query_result_location): inst = inline_query_result_location for attr in inst.__slots__: diff --git a/tests/_inline/test_inlinequeryresultmpeg4gif.py b/tests/_inline/test_inlinequeryresultmpeg4gif.py index 2a1bfc2cf93..4c0f0f1d3d3 100644 --- a/tests/_inline/test_inlinequeryresultmpeg4gif.py +++ b/tests/_inline/test_inlinequeryresultmpeg4gif.py @@ -32,24 +32,24 @@ @pytest.fixture(scope="module") def inline_query_result_mpeg4_gif(): return InlineQueryResultMpeg4Gif( - TestInlineQueryResultMpeg4GifBase.id_, - TestInlineQueryResultMpeg4GifBase.mpeg4_url, - TestInlineQueryResultMpeg4GifBase.thumbnail_url, - mpeg4_width=TestInlineQueryResultMpeg4GifBase.mpeg4_width, - mpeg4_height=TestInlineQueryResultMpeg4GifBase.mpeg4_height, - mpeg4_duration=TestInlineQueryResultMpeg4GifBase.mpeg4_duration, - title=TestInlineQueryResultMpeg4GifBase.title, - caption=TestInlineQueryResultMpeg4GifBase.caption, - parse_mode=TestInlineQueryResultMpeg4GifBase.parse_mode, - caption_entities=TestInlineQueryResultMpeg4GifBase.caption_entities, - input_message_content=TestInlineQueryResultMpeg4GifBase.input_message_content, - reply_markup=TestInlineQueryResultMpeg4GifBase.reply_markup, - thumbnail_mime_type=TestInlineQueryResultMpeg4GifBase.thumbnail_mime_type, - show_caption_above_media=TestInlineQueryResultMpeg4GifBase.show_caption_above_media, + InlineQueryResultMpeg4GifTestBase.id_, + InlineQueryResultMpeg4GifTestBase.mpeg4_url, + InlineQueryResultMpeg4GifTestBase.thumbnail_url, + mpeg4_width=InlineQueryResultMpeg4GifTestBase.mpeg4_width, + mpeg4_height=InlineQueryResultMpeg4GifTestBase.mpeg4_height, + mpeg4_duration=InlineQueryResultMpeg4GifTestBase.mpeg4_duration, + title=InlineQueryResultMpeg4GifTestBase.title, + caption=InlineQueryResultMpeg4GifTestBase.caption, + parse_mode=InlineQueryResultMpeg4GifTestBase.parse_mode, + caption_entities=InlineQueryResultMpeg4GifTestBase.caption_entities, + input_message_content=InlineQueryResultMpeg4GifTestBase.input_message_content, + reply_markup=InlineQueryResultMpeg4GifTestBase.reply_markup, + thumbnail_mime_type=InlineQueryResultMpeg4GifTestBase.thumbnail_mime_type, + show_caption_above_media=InlineQueryResultMpeg4GifTestBase.show_caption_above_media, ) -class TestInlineQueryResultMpeg4GifBase: +class InlineQueryResultMpeg4GifTestBase: id_ = "id" type_ = "mpeg4_gif" mpeg4_url = "mpeg4 url" @@ -67,7 +67,7 @@ class TestInlineQueryResultMpeg4GifBase: show_caption_above_media = True -class TestInlineQueryResultMpeg4GifWithoutRequest(TestInlineQueryResultMpeg4GifBase): +class TestInlineQueryResultMpeg4GifWithoutRequest(InlineQueryResultMpeg4GifTestBase): def test_slot_behaviour(self, inline_query_result_mpeg4_gif): inst = inline_query_result_mpeg4_gif for attr in inst.__slots__: diff --git a/tests/_inline/test_inlinequeryresultphoto.py b/tests/_inline/test_inlinequeryresultphoto.py index 323cf7b71ed..2abec4a3b7e 100644 --- a/tests/_inline/test_inlinequeryresultphoto.py +++ b/tests/_inline/test_inlinequeryresultphoto.py @@ -32,23 +32,23 @@ @pytest.fixture(scope="module") def inline_query_result_photo(): return InlineQueryResultPhoto( - TestInlineQueryResultPhotoBase.id_, - TestInlineQueryResultPhotoBase.photo_url, - TestInlineQueryResultPhotoBase.thumbnail_url, - photo_width=TestInlineQueryResultPhotoBase.photo_width, - photo_height=TestInlineQueryResultPhotoBase.photo_height, - title=TestInlineQueryResultPhotoBase.title, - description=TestInlineQueryResultPhotoBase.description, - caption=TestInlineQueryResultPhotoBase.caption, - parse_mode=TestInlineQueryResultPhotoBase.parse_mode, - caption_entities=TestInlineQueryResultPhotoBase.caption_entities, - input_message_content=TestInlineQueryResultPhotoBase.input_message_content, - reply_markup=TestInlineQueryResultPhotoBase.reply_markup, - show_caption_above_media=TestInlineQueryResultPhotoBase.show_caption_above_media, + InlineQueryResultPhotoTestBase.id_, + InlineQueryResultPhotoTestBase.photo_url, + InlineQueryResultPhotoTestBase.thumbnail_url, + photo_width=InlineQueryResultPhotoTestBase.photo_width, + photo_height=InlineQueryResultPhotoTestBase.photo_height, + title=InlineQueryResultPhotoTestBase.title, + description=InlineQueryResultPhotoTestBase.description, + caption=InlineQueryResultPhotoTestBase.caption, + parse_mode=InlineQueryResultPhotoTestBase.parse_mode, + caption_entities=InlineQueryResultPhotoTestBase.caption_entities, + input_message_content=InlineQueryResultPhotoTestBase.input_message_content, + reply_markup=InlineQueryResultPhotoTestBase.reply_markup, + show_caption_above_media=InlineQueryResultPhotoTestBase.show_caption_above_media, ) -class TestInlineQueryResultPhotoBase: +class InlineQueryResultPhotoTestBase: id_ = "id" type_ = "photo" photo_url = "photo url" @@ -66,7 +66,7 @@ class TestInlineQueryResultPhotoBase: show_caption_above_media = True -class TestInlineQueryResultPhotoWithoutRequest(TestInlineQueryResultPhotoBase): +class TestInlineQueryResultPhotoWithoutRequest(InlineQueryResultPhotoTestBase): def test_slot_behaviour(self, inline_query_result_photo): inst = inline_query_result_photo for attr in inst.__slots__: diff --git a/tests/_inline/test_inlinequeryresultvenue.py b/tests/_inline/test_inlinequeryresultvenue.py index ba09ad7d180..cb5ad760a58 100644 --- a/tests/_inline/test_inlinequeryresultvenue.py +++ b/tests/_inline/test_inlinequeryresultvenue.py @@ -31,24 +31,24 @@ @pytest.fixture(scope="module") def inline_query_result_venue(): return InlineQueryResultVenue( - TestInlineQueryResultVenueBase.id_, - TestInlineQueryResultVenueBase.latitude, - TestInlineQueryResultVenueBase.longitude, - TestInlineQueryResultVenueBase.title, - TestInlineQueryResultVenueBase.address, - foursquare_id=TestInlineQueryResultVenueBase.foursquare_id, - foursquare_type=TestInlineQueryResultVenueBase.foursquare_type, - thumbnail_url=TestInlineQueryResultVenueBase.thumbnail_url, - thumbnail_width=TestInlineQueryResultVenueBase.thumbnail_width, - thumbnail_height=TestInlineQueryResultVenueBase.thumbnail_height, - input_message_content=TestInlineQueryResultVenueBase.input_message_content, - reply_markup=TestInlineQueryResultVenueBase.reply_markup, - google_place_id=TestInlineQueryResultVenueBase.google_place_id, - google_place_type=TestInlineQueryResultVenueBase.google_place_type, + InlineQueryResultVenueTestBase.id_, + InlineQueryResultVenueTestBase.latitude, + InlineQueryResultVenueTestBase.longitude, + InlineQueryResultVenueTestBase.title, + InlineQueryResultVenueTestBase.address, + foursquare_id=InlineQueryResultVenueTestBase.foursquare_id, + foursquare_type=InlineQueryResultVenueTestBase.foursquare_type, + thumbnail_url=InlineQueryResultVenueTestBase.thumbnail_url, + thumbnail_width=InlineQueryResultVenueTestBase.thumbnail_width, + thumbnail_height=InlineQueryResultVenueTestBase.thumbnail_height, + input_message_content=InlineQueryResultVenueTestBase.input_message_content, + reply_markup=InlineQueryResultVenueTestBase.reply_markup, + google_place_id=InlineQueryResultVenueTestBase.google_place_id, + google_place_type=InlineQueryResultVenueTestBase.google_place_type, ) -class TestInlineQueryResultVenueBase: +class InlineQueryResultVenueTestBase: id_ = "id" type_ = "venue" latitude = "latitude" @@ -66,7 +66,7 @@ class TestInlineQueryResultVenueBase: reply_markup = InlineKeyboardMarkup([[InlineKeyboardButton("reply_markup")]]) -class TestInlineQueryResultVenueWithoutRequest(TestInlineQueryResultVenueBase): +class TestInlineQueryResultVenueWithoutRequest(InlineQueryResultVenueTestBase): def test_slot_behaviour(self, inline_query_result_venue): inst = inline_query_result_venue for attr in inst.__slots__: diff --git a/tests/_inline/test_inlinequeryresultvideo.py b/tests/_inline/test_inlinequeryresultvideo.py index 68709e396e3..7534ad0433d 100644 --- a/tests/_inline/test_inlinequeryresultvideo.py +++ b/tests/_inline/test_inlinequeryresultvideo.py @@ -32,25 +32,25 @@ @pytest.fixture(scope="module") def inline_query_result_video(): return InlineQueryResultVideo( - TestInlineQueryResultVideoBase.id_, - TestInlineQueryResultVideoBase.video_url, - TestInlineQueryResultVideoBase.mime_type, - TestInlineQueryResultVideoBase.thumbnail_url, - TestInlineQueryResultVideoBase.title, - video_width=TestInlineQueryResultVideoBase.video_width, - video_height=TestInlineQueryResultVideoBase.video_height, - video_duration=TestInlineQueryResultVideoBase.video_duration, - caption=TestInlineQueryResultVideoBase.caption, - parse_mode=TestInlineQueryResultVideoBase.parse_mode, - caption_entities=TestInlineQueryResultVideoBase.caption_entities, - description=TestInlineQueryResultVideoBase.description, - input_message_content=TestInlineQueryResultVideoBase.input_message_content, - reply_markup=TestInlineQueryResultVideoBase.reply_markup, - show_caption_above_media=TestInlineQueryResultVideoBase.show_caption_above_media, + InlineQueryResultVideoTestBase.id_, + InlineQueryResultVideoTestBase.video_url, + InlineQueryResultVideoTestBase.mime_type, + InlineQueryResultVideoTestBase.thumbnail_url, + InlineQueryResultVideoTestBase.title, + video_width=InlineQueryResultVideoTestBase.video_width, + video_height=InlineQueryResultVideoTestBase.video_height, + video_duration=InlineQueryResultVideoTestBase.video_duration, + caption=InlineQueryResultVideoTestBase.caption, + parse_mode=InlineQueryResultVideoTestBase.parse_mode, + caption_entities=InlineQueryResultVideoTestBase.caption_entities, + description=InlineQueryResultVideoTestBase.description, + input_message_content=InlineQueryResultVideoTestBase.input_message_content, + reply_markup=InlineQueryResultVideoTestBase.reply_markup, + show_caption_above_media=InlineQueryResultVideoTestBase.show_caption_above_media, ) -class TestInlineQueryResultVideoBase: +class InlineQueryResultVideoTestBase: id_ = "id" type_ = "video" video_url = "video url" @@ -69,7 +69,7 @@ class TestInlineQueryResultVideoBase: show_caption_above_media = True -class TestInlineQueryResultVideoWithoutRequest(TestInlineQueryResultVideoBase): +class TestInlineQueryResultVideoWithoutRequest(InlineQueryResultVideoTestBase): def test_slot_behaviour(self, inline_query_result_video): inst = inline_query_result_video for attr in inst.__slots__: diff --git a/tests/_inline/test_inlinequeryresultvoice.py b/tests/_inline/test_inlinequeryresultvoice.py index 34ea013cb60..cddbc9d7efa 100644 --- a/tests/_inline/test_inlinequeryresultvoice.py +++ b/tests/_inline/test_inlinequeryresultvoice.py @@ -32,19 +32,19 @@ @pytest.fixture(scope="module") def inline_query_result_voice(): return InlineQueryResultVoice( - id=TestInlineQueryResultVoiceBase.id_, - voice_url=TestInlineQueryResultVoiceBase.voice_url, - title=TestInlineQueryResultVoiceBase.title, - voice_duration=TestInlineQueryResultVoiceBase.voice_duration, - caption=TestInlineQueryResultVoiceBase.caption, - parse_mode=TestInlineQueryResultVoiceBase.parse_mode, - caption_entities=TestInlineQueryResultVoiceBase.caption_entities, - input_message_content=TestInlineQueryResultVoiceBase.input_message_content, - reply_markup=TestInlineQueryResultVoiceBase.reply_markup, + id=InlineQueryResultVoiceTestBase.id_, + voice_url=InlineQueryResultVoiceTestBase.voice_url, + title=InlineQueryResultVoiceTestBase.title, + voice_duration=InlineQueryResultVoiceTestBase.voice_duration, + caption=InlineQueryResultVoiceTestBase.caption, + parse_mode=InlineQueryResultVoiceTestBase.parse_mode, + caption_entities=InlineQueryResultVoiceTestBase.caption_entities, + input_message_content=InlineQueryResultVoiceTestBase.input_message_content, + reply_markup=InlineQueryResultVoiceTestBase.reply_markup, ) -class TestInlineQueryResultVoiceBase: +class InlineQueryResultVoiceTestBase: id_ = "id" type_ = "voice" voice_url = "voice url" @@ -57,7 +57,7 @@ class TestInlineQueryResultVoiceBase: reply_markup = InlineKeyboardMarkup([[InlineKeyboardButton("reply_markup")]]) -class TestInlineQueryResultVoiceWithoutRequest(TestInlineQueryResultVoiceBase): +class TestInlineQueryResultVoiceWithoutRequest(InlineQueryResultVoiceTestBase): def test_slot_behaviour(self, inline_query_result_voice): inst = inline_query_result_voice for attr in inst.__slots__: diff --git a/tests/_inline/test_inputcontactmessagecontent.py b/tests/_inline/test_inputcontactmessagecontent.py index 5a48f7dc5cc..afd1b15f035 100644 --- a/tests/_inline/test_inputcontactmessagecontent.py +++ b/tests/_inline/test_inputcontactmessagecontent.py @@ -25,19 +25,19 @@ @pytest.fixture(scope="module") def input_contact_message_content(): return InputContactMessageContent( - TestInputContactMessageContentBase.phone_number, - TestInputContactMessageContentBase.first_name, - TestInputContactMessageContentBase.last_name, + InputContactMessageContentTestBase.phone_number, + InputContactMessageContentTestBase.first_name, + InputContactMessageContentTestBase.last_name, ) -class TestInputContactMessageContentBase: +class InputContactMessageContentTestBase: phone_number = "phone number" first_name = "first name" last_name = "last name" -class TestInputContactMessageContentWithoutRequest(TestInputContactMessageContentBase): +class TestInputContactMessageContentWithoutRequest(InputContactMessageContentTestBase): def test_slot_behaviour(self, input_contact_message_content): inst = input_contact_message_content for attr in inst.__slots__: diff --git a/tests/_inline/test_inputinvoicemessagecontent.py b/tests/_inline/test_inputinvoicemessagecontent.py index 577ba677599..4e35e9f6f43 100644 --- a/tests/_inline/test_inputinvoicemessagecontent.py +++ b/tests/_inline/test_inputinvoicemessagecontent.py @@ -26,32 +26,32 @@ @pytest.fixture(scope="module") def input_invoice_message_content(): return InputInvoiceMessageContent( - title=TestInputInvoiceMessageContentBase.title, - description=TestInputInvoiceMessageContentBase.description, - payload=TestInputInvoiceMessageContentBase.payload, - provider_token=TestInputInvoiceMessageContentBase.provider_token, - currency=TestInputInvoiceMessageContentBase.currency, - prices=TestInputInvoiceMessageContentBase.prices, - max_tip_amount=TestInputInvoiceMessageContentBase.max_tip_amount, - suggested_tip_amounts=TestInputInvoiceMessageContentBase.suggested_tip_amounts, - provider_data=TestInputInvoiceMessageContentBase.provider_data, - photo_url=TestInputInvoiceMessageContentBase.photo_url, - photo_size=TestInputInvoiceMessageContentBase.photo_size, - photo_width=TestInputInvoiceMessageContentBase.photo_width, - photo_height=TestInputInvoiceMessageContentBase.photo_height, - need_name=TestInputInvoiceMessageContentBase.need_name, - need_phone_number=TestInputInvoiceMessageContentBase.need_phone_number, - need_email=TestInputInvoiceMessageContentBase.need_email, - need_shipping_address=TestInputInvoiceMessageContentBase.need_shipping_address, + title=InputInvoiceMessageContentTestBase.title, + description=InputInvoiceMessageContentTestBase.description, + payload=InputInvoiceMessageContentTestBase.payload, + provider_token=InputInvoiceMessageContentTestBase.provider_token, + currency=InputInvoiceMessageContentTestBase.currency, + prices=InputInvoiceMessageContentTestBase.prices, + max_tip_amount=InputInvoiceMessageContentTestBase.max_tip_amount, + suggested_tip_amounts=InputInvoiceMessageContentTestBase.suggested_tip_amounts, + provider_data=InputInvoiceMessageContentTestBase.provider_data, + photo_url=InputInvoiceMessageContentTestBase.photo_url, + photo_size=InputInvoiceMessageContentTestBase.photo_size, + photo_width=InputInvoiceMessageContentTestBase.photo_width, + photo_height=InputInvoiceMessageContentTestBase.photo_height, + need_name=InputInvoiceMessageContentTestBase.need_name, + need_phone_number=InputInvoiceMessageContentTestBase.need_phone_number, + need_email=InputInvoiceMessageContentTestBase.need_email, + need_shipping_address=InputInvoiceMessageContentTestBase.need_shipping_address, send_phone_number_to_provider=( - TestInputInvoiceMessageContentBase.send_phone_number_to_provider + InputInvoiceMessageContentTestBase.send_phone_number_to_provider ), - send_email_to_provider=TestInputInvoiceMessageContentBase.send_email_to_provider, - is_flexible=TestInputInvoiceMessageContentBase.is_flexible, + send_email_to_provider=InputInvoiceMessageContentTestBase.send_email_to_provider, + is_flexible=InputInvoiceMessageContentTestBase.is_flexible, ) -class TestInputInvoiceMessageContentBase: +class InputInvoiceMessageContentTestBase: title = "invoice title" description = "invoice description" payload = "invoice payload" @@ -74,7 +74,7 @@ class TestInputInvoiceMessageContentBase: is_flexible = True -class TestInputInvoiceMessageContentWithoutRequest(TestInputInvoiceMessageContentBase): +class TestInputInvoiceMessageContentWithoutRequest(InputInvoiceMessageContentTestBase): def test_slot_behaviour(self, input_invoice_message_content): inst = input_invoice_message_content for attr in inst.__slots__: @@ -203,8 +203,8 @@ def test_to_dict(self, input_invoice_message_content): == input_invoice_message_content.is_flexible ) - def test_de_json(self, bot): - assert InputInvoiceMessageContent.de_json({}, bot=bot) is None + def test_de_json(self, offline_bot): + assert InputInvoiceMessageContent.de_json({}, bot=offline_bot) is None json_dict = { "title": self.title, @@ -229,7 +229,9 @@ def test_de_json(self, bot): "is_flexible": self.is_flexible, } - input_invoice_message_content = InputInvoiceMessageContent.de_json(json_dict, bot=bot) + input_invoice_message_content = InputInvoiceMessageContent.de_json( + json_dict, bot=offline_bot + ) assert input_invoice_message_content.api_kwargs == {} assert input_invoice_message_content.title == self.title diff --git a/tests/_inline/test_inputlocationmessagecontent.py b/tests/_inline/test_inputlocationmessagecontent.py index 61d311cae38..f2101fca27b 100644 --- a/tests/_inline/test_inputlocationmessagecontent.py +++ b/tests/_inline/test_inputlocationmessagecontent.py @@ -25,16 +25,16 @@ @pytest.fixture(scope="module") def input_location_message_content(): return InputLocationMessageContent( - TestInputLocationMessageContentBase.latitude, - TestInputLocationMessageContentBase.longitude, - live_period=TestInputLocationMessageContentBase.live_period, - horizontal_accuracy=TestInputLocationMessageContentBase.horizontal_accuracy, - heading=TestInputLocationMessageContentBase.heading, - proximity_alert_radius=TestInputLocationMessageContentBase.proximity_alert_radius, + InputLocationMessageContentTestBase.latitude, + InputLocationMessageContentTestBase.longitude, + live_period=InputLocationMessageContentTestBase.live_period, + horizontal_accuracy=InputLocationMessageContentTestBase.horizontal_accuracy, + heading=InputLocationMessageContentTestBase.heading, + proximity_alert_radius=InputLocationMessageContentTestBase.proximity_alert_radius, ) -class TestInputLocationMessageContentBase: +class InputLocationMessageContentTestBase: latitude = -23.691288 longitude = -46.788279 live_period = 80 @@ -43,7 +43,7 @@ class TestInputLocationMessageContentBase: proximity_alert_radius = 999 -class TestInputLocationMessageContentWithoutRequest(TestInputLocationMessageContentBase): +class TestInputLocationMessageContentWithoutRequest(InputLocationMessageContentTestBase): def test_slot_behaviour(self, input_location_message_content): inst = input_location_message_content for attr in inst.__slots__: diff --git a/tests/_inline/test_inputtextmessagecontent.py b/tests/_inline/test_inputtextmessagecontent.py index 632a29db189..227e0737dce 100644 --- a/tests/_inline/test_inputtextmessagecontent.py +++ b/tests/_inline/test_inputtextmessagecontent.py @@ -26,14 +26,14 @@ @pytest.fixture(scope="module") def input_text_message_content(): return InputTextMessageContent( - TestInputTextMessageContentBase.message_text, - parse_mode=TestInputTextMessageContentBase.parse_mode, - entities=TestInputTextMessageContentBase.entities, - link_preview_options=TestInputTextMessageContentBase.link_preview_options, + InputTextMessageContentTestBase.message_text, + parse_mode=InputTextMessageContentTestBase.parse_mode, + entities=InputTextMessageContentTestBase.entities, + link_preview_options=InputTextMessageContentTestBase.link_preview_options, ) -class TestInputTextMessageContentBase: +class InputTextMessageContentTestBase: message_text = "*message text*" parse_mode = ParseMode.MARKDOWN entities = [MessageEntity(MessageEntity.ITALIC, 0, 7)] @@ -41,7 +41,7 @@ class TestInputTextMessageContentBase: link_preview_options = LinkPreviewOptions(False, url="https://python-telegram-bot.org") -class TestInputTextMessageContentWithoutRequest(TestInputTextMessageContentBase): +class TestInputTextMessageContentWithoutRequest(InputTextMessageContentTestBase): def test_slot_behaviour(self, input_text_message_content): inst = input_text_message_content for attr in inst.__slots__: diff --git a/tests/_inline/test_inputvenuemessagecontent.py b/tests/_inline/test_inputvenuemessagecontent.py index 8c9d4c62d10..d88f9714ff9 100644 --- a/tests/_inline/test_inputvenuemessagecontent.py +++ b/tests/_inline/test_inputvenuemessagecontent.py @@ -25,18 +25,18 @@ @pytest.fixture(scope="module") def input_venue_message_content(): return InputVenueMessageContent( - TestInputVenueMessageContentBase.latitude, - TestInputVenueMessageContentBase.longitude, - TestInputVenueMessageContentBase.title, - TestInputVenueMessageContentBase.address, - foursquare_id=TestInputVenueMessageContentBase.foursquare_id, - foursquare_type=TestInputVenueMessageContentBase.foursquare_type, - google_place_id=TestInputVenueMessageContentBase.google_place_id, - google_place_type=TestInputVenueMessageContentBase.google_place_type, + InputVenueMessageContentTestBase.latitude, + InputVenueMessageContentTestBase.longitude, + InputVenueMessageContentTestBase.title, + InputVenueMessageContentTestBase.address, + foursquare_id=InputVenueMessageContentTestBase.foursquare_id, + foursquare_type=InputVenueMessageContentTestBase.foursquare_type, + google_place_id=InputVenueMessageContentTestBase.google_place_id, + google_place_type=InputVenueMessageContentTestBase.google_place_type, ) -class TestInputVenueMessageContentBase: +class InputVenueMessageContentTestBase: latitude = 1.0 longitude = 2.0 title = "title" @@ -47,7 +47,7 @@ class TestInputVenueMessageContentBase: google_place_type = "google place type" -class TestInputVenueMessageContentWithoutRequest(TestInputVenueMessageContentBase): +class TestInputVenueMessageContentWithoutRequest(InputVenueMessageContentTestBase): def test_slot_behaviour(self, input_venue_message_content): inst = input_venue_message_content for attr in inst.__slots__: diff --git a/tests/_inline/test_preparedinlinemessage.py b/tests/_inline/test_preparedinlinemessage.py new file mode 100644 index 00000000000..c20a3135cce --- /dev/null +++ b/tests/_inline/test_preparedinlinemessage.py @@ -0,0 +1,108 @@ +#!/usr/bin/env python +# +# A library that provides a Python interface to the Telegram Bot API +# Copyright (C) 2015-2024 +# Leandro Toledo de Souza +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser Public License for more details. +# +# You should have received a copy of the GNU Lesser Public License +# along with this program. If not, see [http://www.gnu.org/licenses/]. +import datetime as dtm + +import pytest + +from telegram import Location, PreparedInlineMessage +from telegram._utils.datetime import UTC, to_timestamp +from tests.auxil.slots import mro_slots + + +@pytest.fixture(scope="module") +def prepared_inline_message(): + return PreparedInlineMessage( + PreparedInlineMessageTestBase.id, + PreparedInlineMessageTestBase.expiration_date, + ) + + +class PreparedInlineMessageTestBase: + id = "some_uid" + expiration_date = dtm.datetime.now(tz=UTC).replace(microsecond=0) + + +class TestPreparedInlineMessageWithoutRequest(PreparedInlineMessageTestBase): + def test_slot_behaviour(self, prepared_inline_message): + inst = prepared_inline_message + for attr in inst.__slots__: + assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" + assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" + + def test_expected_values(self, prepared_inline_message): + assert prepared_inline_message.id == self.id + assert prepared_inline_message.expiration_date == self.expiration_date + + def test_de_json(self, prepared_inline_message): + json_dict = { + "id": self.id, + "expiration_date": to_timestamp(self.expiration_date), + } + new_prepared_inline_message = PreparedInlineMessage.de_json(json_dict, None) + + assert isinstance(new_prepared_inline_message, PreparedInlineMessage) + assert new_prepared_inline_message.id == prepared_inline_message.id + assert ( + new_prepared_inline_message.expiration_date == prepared_inline_message.expiration_date + ) + + def test_de_json_localization(self, offline_bot, raw_bot, tz_bot): + json_dict = { + "id": "some_uid", + "expiration_date": to_timestamp(self.expiration_date), + } + pim = PreparedInlineMessage.de_json(json_dict, offline_bot) + pim_raw = PreparedInlineMessage.de_json(json_dict, raw_bot) + pim_tz = PreparedInlineMessage.de_json(json_dict, tz_bot) + + # comparing utcoffset because comparing tzinfo objects is not reliable + offset = pim_tz.expiration_date.utcoffset() + offset_tz = tz_bot.defaults.tzinfo.utcoffset(pim_tz.expiration_date.replace(tzinfo=None)) + + assert pim.expiration_date.tzinfo == UTC + assert pim_raw.expiration_date.tzinfo == UTC + assert offset_tz == offset + + def test_to_dict(self, prepared_inline_message): + prepared_inline_message_dict = prepared_inline_message.to_dict() + + assert isinstance(prepared_inline_message_dict, dict) + assert prepared_inline_message_dict["id"] == prepared_inline_message.id + assert prepared_inline_message_dict["expiration_date"] == to_timestamp( + self.expiration_date + ) + + def test_equality(self, prepared_inline_message): + a = prepared_inline_message + b = PreparedInlineMessage(self.id, self.expiration_date) + c = PreparedInlineMessage(self.id, self.expiration_date + dtm.timedelta(seconds=1)) + d = PreparedInlineMessage("other_uid", self.expiration_date) + e = Location(123, 456) + + assert a == b + assert hash(a) == hash(b) + + assert a == c + assert hash(a) == hash(c) + + assert a != d + assert hash(a) != hash(d) + + assert a != e + assert hash(a) != hash(e) diff --git a/tests/_passport/test_encryptedcredentials.py b/tests/_passport/test_encryptedcredentials.py index 3b45ee157c3..8af9c2cff92 100644 --- a/tests/_passport/test_encryptedcredentials.py +++ b/tests/_passport/test_encryptedcredentials.py @@ -26,19 +26,19 @@ @pytest.fixture(scope="module") def encrypted_credentials(): return EncryptedCredentials( - TestEncryptedCredentialsBase.data, - TestEncryptedCredentialsBase.hash, - TestEncryptedCredentialsBase.secret, + EncryptedCredentialsTestBase.data, + EncryptedCredentialsTestBase.hash, + EncryptedCredentialsTestBase.secret, ) -class TestEncryptedCredentialsBase: +class EncryptedCredentialsTestBase: data = "data" hash = "hash" secret = "secret" -class TestEncryptedCredentialsWithoutRequest(TestEncryptedCredentialsBase): +class TestEncryptedCredentialsWithoutRequest(EncryptedCredentialsTestBase): def test_slot_behaviour(self, encrypted_credentials): inst = encrypted_credentials for attr in inst.__slots__: diff --git a/tests/_passport/test_encryptedpassportelement.py b/tests/_passport/test_encryptedpassportelement.py index f1299029017..fa79846b6e6 100644 --- a/tests/_passport/test_encryptedpassportelement.py +++ b/tests/_passport/test_encryptedpassportelement.py @@ -26,19 +26,19 @@ @pytest.fixture(scope="module") def encrypted_passport_element(): return EncryptedPassportElement( - TestEncryptedPassportElementBase.type_, + EncryptedPassportElementTestBase.type_, "this is a hash", - data=TestEncryptedPassportElementBase.data, - phone_number=TestEncryptedPassportElementBase.phone_number, - email=TestEncryptedPassportElementBase.email, - files=TestEncryptedPassportElementBase.files, - front_side=TestEncryptedPassportElementBase.front_side, - reverse_side=TestEncryptedPassportElementBase.reverse_side, - selfie=TestEncryptedPassportElementBase.selfie, + data=EncryptedPassportElementTestBase.data, + phone_number=EncryptedPassportElementTestBase.phone_number, + email=EncryptedPassportElementTestBase.email, + files=EncryptedPassportElementTestBase.files, + front_side=EncryptedPassportElementTestBase.front_side, + reverse_side=EncryptedPassportElementTestBase.reverse_side, + selfie=EncryptedPassportElementTestBase.selfie, ) -class TestEncryptedPassportElementBase: +class EncryptedPassportElementTestBase: type_ = "type" hash = "this is a hash" data = "data" @@ -50,7 +50,7 @@ class TestEncryptedPassportElementBase: selfie = PassportFile("file_id", 50, 0, 25) -class TestEncryptedPassportElementWithoutRequest(TestEncryptedPassportElementBase): +class TestEncryptedPassportElementWithoutRequest(EncryptedPassportElementTestBase): def test_slot_behaviour(self, encrypted_passport_element): inst = encrypted_passport_element for attr in inst.__slots__: diff --git a/tests/_passport/test_no_passport.py b/tests/_passport/test_no_passport.py index 8b1af252cb3..ff3ce0a439c 100644 --- a/tests/_passport/test_no_passport.py +++ b/tests/_passport/test_no_passport.py @@ -28,7 +28,7 @@ """ import pytest -from telegram import _bot as bot +import telegram from telegram._passport import credentials from tests.auxil.envvars import TEST_WITH_OPT_DEPS @@ -39,7 +39,7 @@ class TestNoPassportWithoutRequest: def test_bot_init(self, bot_info): with pytest.raises(RuntimeError, match="passport"): - bot.Bot(bot_info["token"], private_key=1, private_key_password=2) + telegram.Bot(bot_info["token"], private_key=1, private_key_password=2) def test_credentials_decrypt(self): with pytest.raises(RuntimeError, match="passport"): diff --git a/tests/_passport/test_passport.py b/tests/_passport/test_passport.py index c35eeaf1761..b094f808f81 100644 --- a/tests/_passport/test_passport.py +++ b/tests/_passport/test_passport.py @@ -220,7 +220,7 @@ def passport_data(bot): return PassportData.de_json(RAW_PASSPORT_DATA, bot=bot) -class TestPassportBase: +class PassportTestBase: driver_license_selfie_file_id = "DgADBAADEQQAAkopgFNr6oi-wISRtAI" driver_license_selfie_file_unique_id = "d4e390cca57b4da5a65322b304762a12" driver_license_front_side_file_id = "DgADBAADxwMAApnQgVPK2-ckL2eXVAI" @@ -243,7 +243,7 @@ class TestPassportBase: driver_license_selfie_credentials_secret = "tivdId6RNYNsvXYPppdzrbxOBuBOr9wXRPDcCvnXU7E=" -class TestPassportWithoutRequest(TestPassportBase): +class TestPassportWithoutRequest(PassportTestBase): def test_slot_behaviour(self, passport_data): inst = passport_data for attr in inst.__slots__: @@ -390,8 +390,8 @@ def test_expected_decrypted_values(self, passport_data): assert email.type == "email" assert email.email == "fb3e3i47zt@dispostable.com" - def test_de_json_and_to_dict(self, bot): - passport_data = PassportData.de_json(RAW_PASSPORT_DATA, bot) + def test_de_json_and_to_dict(self, offline_bot): + passport_data = PassportData.de_json(RAW_PASSPORT_DATA, offline_bot) assert passport_data.api_kwargs == {} assert passport_data.to_dict() == RAW_PASSPORT_DATA @@ -414,14 +414,14 @@ def test_equality(self, passport_data): assert a != c assert hash(a) != hash(c) - def test_bot_init_invalid_key(self, bot): + def test_bot_init_invalid_key(self, offline_bot): with pytest.raises(TypeError): - Bot(bot.token, private_key="Invalid key!") + Bot(offline_bot.token, private_key="Invalid key!") with pytest.raises(ValueError, match="Could not deserialize key data"): - Bot(bot.token, private_key=b"Invalid key!") + Bot(offline_bot.token, private_key=b"Invalid key!") - def test_all_types(self, passport_data, bot, all_passport_data): + def test_all_types(self, passport_data, offline_bot, all_passport_data): credentials = passport_data.decrypted_credentials.to_dict() # Copy credentials from other types to all types so we can decrypt everything @@ -446,46 +446,46 @@ def test_all_types(self, passport_data, bot, all_passport_data): # Replaced below "credentials": {"data": "data", "hash": "hash", "secret": "secret"}, }, - bot=bot, + bot=offline_bot, ) assert new.api_kwargs == {} - new.credentials._decrypted_data = Credentials.de_json(credentials, bot) + new.credentials._decrypted_data = Credentials.de_json(credentials, offline_bot) assert new.credentials.api_kwargs == {} assert isinstance(new, PassportData) assert new.decrypted_data - async def test_passport_data_okay_with_non_crypto_bot(self, bot): - async with make_bot(token=bot.token) as b: + async def test_passport_data_okay_with_non_crypto_bot(self, offline_bot): + async with make_bot(token=offline_bot.token) as b: assert PassportData.de_json(RAW_PASSPORT_DATA, bot=b) - def test_wrong_hash(self, bot): + def test_wrong_hash(self, offline_bot): data = deepcopy(RAW_PASSPORT_DATA) data["credentials"]["hash"] = "bm90Y29ycmVjdGhhc2g=" # Not correct hash - passport_data = PassportData.de_json(data, bot=bot) + passport_data = PassportData.de_json(data, bot=offline_bot) with pytest.raises(PassportDecryptionError): assert passport_data.decrypted_data - async def test_wrong_key(self, bot): + async def test_wrong_key(self, offline_bot): short_key = ( b"-----BEGIN RSA PRIVATE" b" KEY-----\r\nMIIBOQIBAAJBAKU+OZ2jJm7sCA/ec4gngNZhXYPu+DZ/TAwSMl0W7vAPXAsLplBk\r\nO8l6IBHx8N0ZC4Bc65mO3b2G8YAzqndyqH8CAwEAAQJAWOx3jQFzeVXDsOaBPdAk\r\nYTncXVeIc6tlfUl9mOLyinSbRNCy1XicOiOZFgH1rRKOGIC1235QmqxFvdecySoY\r\nwQIhAOFeGgeX9CrEPuSsd9+kqUcA2avCwqdQgSdy2qggRFyJAiEAu7QHT8JQSkHU\r\nDELfzrzc24AhjyG0z1DpGZArM8COascCIDK42SboXj3Z2UXiQ0CEcMzYNiVgOisq\r\nBUd5pBi+2mPxAiAM5Z7G/Sv1HjbKrOGh29o0/sXPhtpckEuj5QMC6E0gywIgFY6S\r\nNjwrAA+cMmsgY0O2fAzEKkDc5YiFsiXaGaSS4eA=\r\n-----END" b" RSA PRIVATE KEY-----" ) - async with make_bot(token=bot.token, private_key=short_key) as b: + async with make_bot(token=offline_bot.token, private_key=short_key) as b: passport_data = PassportData.de_json(RAW_PASSPORT_DATA, bot=b) with pytest.raises(PassportDecryptionError): assert passport_data.decrypted_data - async with make_bot(token=bot.token, private_key=short_key) as b: + async with make_bot(token=offline_bot.token, private_key=short_key) as b: passport_data = PassportData.de_json(RAW_PASSPORT_DATA, bot=b) with pytest.raises(PassportDecryptionError): assert passport_data.decrypted_data async def test_mocked_download_passport_file(self, passport_data, monkeypatch): - # The files are not coming from our test bot, therefore the file id is invalid/wrong - # when coming from this bot, so we monkeypatch the call, to make sure that Bot.get_file + # The files are not coming from our test offline_bot, therefore the file id is invalid/wrong + # when coming from this offline_bot, so we monkeypatch the call, to make sure that Bot.get_file # at least gets called # TODO: Actually download a passport file in a test selfie = passport_data.decrypted_data[1].selfie @@ -501,7 +501,9 @@ async def get_file(*_, **kwargs): assert file._credentials.file_hash == self.driver_license_selfie_credentials_file_hash assert file._credentials.secret == self.driver_license_selfie_credentials_secret - async def test_mocked_set_passport_data_errors(self, monkeypatch, bot, chat_id, passport_data): + async def test_mocked_set_passport_data_errors( + self, monkeypatch, offline_bot, chat_id, passport_data + ): async def make_assertion(url, request_data: RequestData, *args, **kwargs): data = request_data.parameters return ( @@ -514,8 +516,8 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): == passport_data.decrypted_credentials.secure_data.driver_license.data.data_hash ) - monkeypatch.setattr(bot.request, "post", make_assertion) - message = await bot.set_passport_data_errors( + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + message = await offline_bot.set_passport_data_errors( chat_id, [ PassportElementErrorSelfie( diff --git a/tests/_passport/test_passportelementerrordatafield.py b/tests/_passport/test_passportelementerrordatafield.py index 0d49359a3fa..5bbf1e7a4fd 100644 --- a/tests/_passport/test_passportelementerrordatafield.py +++ b/tests/_passport/test_passportelementerrordatafield.py @@ -25,14 +25,14 @@ @pytest.fixture(scope="module") def passport_element_error_data_field(): return PassportElementErrorDataField( - TestPassportElementErrorDataFieldBase.type_, - TestPassportElementErrorDataFieldBase.field_name, - TestPassportElementErrorDataFieldBase.data_hash, - TestPassportElementErrorDataFieldBase.message, + PassportElementErrorDataFieldTestBase.type_, + PassportElementErrorDataFieldTestBase.field_name, + PassportElementErrorDataFieldTestBase.data_hash, + PassportElementErrorDataFieldTestBase.message, ) -class TestPassportElementErrorDataFieldBase: +class PassportElementErrorDataFieldTestBase: source = "data" type_ = "test_type" field_name = "test_field" @@ -40,7 +40,7 @@ class TestPassportElementErrorDataFieldBase: message = "Error message" -class TestPassportElementErrorDataFieldWithoutRequest(TestPassportElementErrorDataFieldBase): +class TestPassportElementErrorDataFieldWithoutRequest(PassportElementErrorDataFieldTestBase): def test_slot_behaviour(self, passport_element_error_data_field): inst = passport_element_error_data_field for attr in inst.__slots__: diff --git a/tests/_passport/test_passportelementerrorfile.py b/tests/_passport/test_passportelementerrorfile.py index ef892b183ff..39d4b044975 100644 --- a/tests/_passport/test_passportelementerrorfile.py +++ b/tests/_passport/test_passportelementerrorfile.py @@ -25,20 +25,20 @@ @pytest.fixture(scope="module") def passport_element_error_file(): return PassportElementErrorFile( - TestPassportElementErrorFileBase.type_, - TestPassportElementErrorFileBase.file_hash, - TestPassportElementErrorFileBase.message, + PassportElementErrorFileTestBase.type_, + PassportElementErrorFileTestBase.file_hash, + PassportElementErrorFileTestBase.message, ) -class TestPassportElementErrorFileBase: +class PassportElementErrorFileTestBase: source = "file" type_ = "test_type" file_hash = "file_hash" message = "Error message" -class TestPassportElementErrorFileWithoutRequest(TestPassportElementErrorFileBase): +class TestPassportElementErrorFileWithoutRequest(PassportElementErrorFileTestBase): def test_slot_behaviour(self, passport_element_error_file): inst = passport_element_error_file for attr in inst.__slots__: diff --git a/tests/_passport/test_passportelementerrorfiles.py b/tests/_passport/test_passportelementerrorfiles.py index 43ee7cb5da8..97bb059cad8 100644 --- a/tests/_passport/test_passportelementerrorfiles.py +++ b/tests/_passport/test_passportelementerrorfiles.py @@ -26,20 +26,20 @@ @pytest.fixture(scope="module") def passport_element_error_files(): return PassportElementErrorFiles( - TestPassportElementErrorFilesBase.type_, - TestPassportElementErrorFilesBase.file_hashes, - TestPassportElementErrorFilesBase.message, + PassportElementErrorFilesTestBase.type_, + PassportElementErrorFilesTestBase.file_hashes, + PassportElementErrorFilesTestBase.message, ) -class TestPassportElementErrorFilesBase: +class PassportElementErrorFilesTestBase: source = "files" type_ = "test_type" file_hashes = ["hash1", "hash2"] message = "Error message" -class TestPassportElementErrorFilesWithoutRequest(TestPassportElementErrorFilesBase): +class TestPassportElementErrorFilesWithoutRequest(PassportElementErrorFilesTestBase): def test_slot_behaviour(self, passport_element_error_files): inst = passport_element_error_files for attr in inst.__slots__: diff --git a/tests/_passport/test_passportelementerrorfrontside.py b/tests/_passport/test_passportelementerrorfrontside.py index 6a29052d319..3a5694fc847 100644 --- a/tests/_passport/test_passportelementerrorfrontside.py +++ b/tests/_passport/test_passportelementerrorfrontside.py @@ -25,20 +25,20 @@ @pytest.fixture(scope="module") def passport_element_error_front_side(): return PassportElementErrorFrontSide( - TestPassportElementErrorFrontSideBase.type_, - TestPassportElementErrorFrontSideBase.file_hash, - TestPassportElementErrorFrontSideBase.message, + PassportElementErrorFrontSideTestBase.type_, + PassportElementErrorFrontSideTestBase.file_hash, + PassportElementErrorFrontSideTestBase.message, ) -class TestPassportElementErrorFrontSideBase: +class PassportElementErrorFrontSideTestBase: source = "front_side" type_ = "test_type" file_hash = "file_hash" message = "Error message" -class TestPassportElementErrorFrontSideWithoutRequest(TestPassportElementErrorFrontSideBase): +class TestPassportElementErrorFrontSideWithoutRequest(PassportElementErrorFrontSideTestBase): def test_slot_behaviour(self, passport_element_error_front_side): inst = passport_element_error_front_side for attr in inst.__slots__: diff --git a/tests/_passport/test_passportelementerrorreverseside.py b/tests/_passport/test_passportelementerrorreverseside.py index bda4cd73167..e6b1bae9e45 100644 --- a/tests/_passport/test_passportelementerrorreverseside.py +++ b/tests/_passport/test_passportelementerrorreverseside.py @@ -25,20 +25,20 @@ @pytest.fixture(scope="module") def passport_element_error_reverse_side(): return PassportElementErrorReverseSide( - TestPassportElementErrorReverseSideBase.type_, - TestPassportElementErrorReverseSideBase.file_hash, - TestPassportElementErrorReverseSideBase.message, + PassportElementErrorReverseSideTestBase.type_, + PassportElementErrorReverseSideTestBase.file_hash, + PassportElementErrorReverseSideTestBase.message, ) -class TestPassportElementErrorReverseSideBase: +class PassportElementErrorReverseSideTestBase: source = "reverse_side" type_ = "test_type" file_hash = "file_hash" message = "Error message" -class TestPassportElementErrorReverseSideWithoutRequest(TestPassportElementErrorReverseSideBase): +class TestPassportElementErrorReverseSideWithoutRequest(PassportElementErrorReverseSideTestBase): def test_slot_behaviour(self, passport_element_error_reverse_side): inst = passport_element_error_reverse_side for attr in inst.__slots__: diff --git a/tests/_passport/test_passportelementerrorselfie.py b/tests/_passport/test_passportelementerrorselfie.py index 9580e24ae74..a7af4ecdc7c 100644 --- a/tests/_passport/test_passportelementerrorselfie.py +++ b/tests/_passport/test_passportelementerrorselfie.py @@ -25,20 +25,20 @@ @pytest.fixture(scope="module") def passport_element_error_selfie(): return PassportElementErrorSelfie( - TestPassportElementErrorSelfieBase.type_, - TestPassportElementErrorSelfieBase.file_hash, - TestPassportElementErrorSelfieBase.message, + PassportElementErrorSelfieTestBase.type_, + PassportElementErrorSelfieTestBase.file_hash, + PassportElementErrorSelfieTestBase.message, ) -class TestPassportElementErrorSelfieBase: +class PassportElementErrorSelfieTestBase: source = "selfie" type_ = "test_type" file_hash = "file_hash" message = "Error message" -class TestPassportElementErrorSelfieWithoutRequest(TestPassportElementErrorSelfieBase): +class TestPassportElementErrorSelfieWithoutRequest(PassportElementErrorSelfieTestBase): def test_slot_behaviour(self, passport_element_error_selfie): inst = passport_element_error_selfie for attr in inst.__slots__: diff --git a/tests/_passport/test_passportelementerrortranslationfile.py b/tests/_passport/test_passportelementerrortranslationfile.py index f55a8ad7017..0493f7e3fb3 100644 --- a/tests/_passport/test_passportelementerrortranslationfile.py +++ b/tests/_passport/test_passportelementerrortranslationfile.py @@ -25,13 +25,13 @@ @pytest.fixture(scope="module") def passport_element_error_translation_file(): return PassportElementErrorTranslationFile( - TestPassportElementErrorTranslationFileBase.type_, - TestPassportElementErrorTranslationFileBase.file_hash, - TestPassportElementErrorTranslationFileBase.message, + PassportElementErrorTranslationFileTestBase.type_, + PassportElementErrorTranslationFileTestBase.file_hash, + PassportElementErrorTranslationFileTestBase.message, ) -class TestPassportElementErrorTranslationFileBase: +class PassportElementErrorTranslationFileTestBase: source = "translation_file" type_ = "test_type" file_hash = "file_hash" @@ -39,7 +39,7 @@ class TestPassportElementErrorTranslationFileBase: class TestPassportElementErrorTranslationFileWithoutRequest( - TestPassportElementErrorTranslationFileBase + PassportElementErrorTranslationFileTestBase ): def test_slot_behaviour(self, passport_element_error_translation_file): inst = passport_element_error_translation_file diff --git a/tests/_passport/test_passportelementerrortranslationfiles.py b/tests/_passport/test_passportelementerrortranslationfiles.py index eb62aa5d1d7..8412ef30050 100644 --- a/tests/_passport/test_passportelementerrortranslationfiles.py +++ b/tests/_passport/test_passportelementerrortranslationfiles.py @@ -26,13 +26,13 @@ @pytest.fixture(scope="module") def passport_element_error_translation_files(): return PassportElementErrorTranslationFiles( - TestPassportElementErrorTranslationFilesBase.type_, - TestPassportElementErrorTranslationFilesBase.file_hashes, - TestPassportElementErrorTranslationFilesBase.message, + PassportElementErrorTranslationFilesTestBase.type_, + PassportElementErrorTranslationFilesTestBase.file_hashes, + PassportElementErrorTranslationFilesTestBase.message, ) -class TestPassportElementErrorTranslationFilesBase: +class PassportElementErrorTranslationFilesTestBase: source = "translation_files" type_ = "test_type" file_hashes = ["hash1", "hash2"] @@ -40,7 +40,7 @@ class TestPassportElementErrorTranslationFilesBase: class TestPassportElementErrorTranslationFilesWithoutRequest( - TestPassportElementErrorTranslationFilesBase + PassportElementErrorTranslationFilesTestBase ): def test_slot_behaviour(self, passport_element_error_translation_files): inst = passport_element_error_translation_files diff --git a/tests/_passport/test_passportelementerrorunspecified.py b/tests/_passport/test_passportelementerrorunspecified.py index 260192e18c6..d3b6105b2de 100644 --- a/tests/_passport/test_passportelementerrorunspecified.py +++ b/tests/_passport/test_passportelementerrorunspecified.py @@ -25,20 +25,20 @@ @pytest.fixture(scope="module") def passport_element_error_unspecified(): return PassportElementErrorUnspecified( - TestPassportElementErrorUnspecifiedBase.type_, - TestPassportElementErrorUnspecifiedBase.element_hash, - TestPassportElementErrorUnspecifiedBase.message, + PassportElementErrorUnspecifiedTestBase.type_, + PassportElementErrorUnspecifiedTestBase.element_hash, + PassportElementErrorUnspecifiedTestBase.message, ) -class TestPassportElementErrorUnspecifiedBase: +class PassportElementErrorUnspecifiedTestBase: source = "unspecified" type_ = "test_type" element_hash = "element_hash" message = "Error message" -class TestPassportElementErrorUnspecifiedWithoutRequest(TestPassportElementErrorUnspecifiedBase): +class TestPassportElementErrorUnspecifiedWithoutRequest(PassportElementErrorUnspecifiedTestBase): def test_slot_behaviour(self, passport_element_error_unspecified): inst = passport_element_error_unspecified for attr in inst.__slots__: diff --git a/tests/_passport/test_passportfile.py b/tests/_passport/test_passportfile.py index d12e0ce9f11..8fef970be71 100644 --- a/tests/_passport/test_passportfile.py +++ b/tests/_passport/test_passportfile.py @@ -31,23 +31,23 @@ @pytest.fixture(scope="class") def passport_file(bot): pf = PassportFile( - file_id=TestPassportFileBase.file_id, - file_unique_id=TestPassportFileBase.file_unique_id, - file_size=TestPassportFileBase.file_size, - file_date=TestPassportFileBase.file_date, + file_id=PassportFileTestBase.file_id, + file_unique_id=PassportFileTestBase.file_unique_id, + file_size=PassportFileTestBase.file_size, + file_date=PassportFileTestBase.file_date, ) pf.set_bot(bot) return pf -class TestPassportFileBase: +class PassportFileTestBase: file_id = "data" file_unique_id = "adc3145fd2e84d95b64d68eaa22aa33e" file_size = 50 file_date = 1532879128 -class TestPassportFileWithoutRequest(TestPassportFileBase): +class TestPassportFileWithoutRequest(PassportFileTestBase): def test_slot_behaviour(self, passport_file): inst = passport_file for attr in inst.__slots__: diff --git a/tests/_payment/test_invoice.py b/tests/_payment/test_invoice.py index 65a39aeb3f7..a28aedc43b8 100644 --- a/tests/_payment/test_invoice.py +++ b/tests/_payment/test_invoice.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 pytest @@ -31,15 +32,15 @@ @pytest.fixture(scope="module") def invoice(): return Invoice( - TestInvoiceBase.title, - TestInvoiceBase.description, - TestInvoiceBase.start_parameter, - TestInvoiceBase.currency, - TestInvoiceBase.total_amount, + InvoiceTestBase.title, + InvoiceTestBase.description, + InvoiceTestBase.start_parameter, + InvoiceTestBase.currency, + InvoiceTestBase.total_amount, ) -class TestInvoiceBase: +class InvoiceTestBase: payload = "payload" prices = [LabeledPrice("Fish", 100), LabeledPrice("Fish Tax", 1000)] provider_data = """{"test":"test"}""" @@ -52,13 +53,13 @@ class TestInvoiceBase: suggested_tip_amounts = [13, 42] -class TestInvoiceWithoutRequest(TestInvoiceBase): +class TestInvoiceWithoutRequest(InvoiceTestBase): def test_slot_behaviour(self, invoice): for attr in invoice.__slots__: assert getattr(invoice, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(invoice)) == len(set(mro_slots(invoice))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): invoice_json = Invoice.de_json( { "title": self.title, @@ -67,7 +68,7 @@ def test_de_json(self, bot): "currency": self.currency, "total_amount": self.total_amount, }, - bot, + offline_bot, ) assert invoice_json.api_kwargs == {} @@ -87,15 +88,15 @@ def test_to_dict(self, invoice): assert invoice_dict["currency"] == invoice.currency assert invoice_dict["total_amount"] == invoice.total_amount - async def test_send_invoice_all_args_mock(self, bot, monkeypatch): + async def test_send_invoice_all_args_mock(self, offline_bot, monkeypatch): # We do this one as safety guard to make sure that we pass all of the optional # parameters correctly because #2526 went unnoticed for 3 years … async def make_assertion(*args, **_): kwargs = args[1] return all(kwargs[key] == key for key in kwargs) - monkeypatch.setattr(bot, "_send_message", make_assertion) - assert await bot.send_invoice( + monkeypatch.setattr(offline_bot, "_send_message", make_assertion) + assert await offline_bot.send_invoice( chat_id="chat_id", title="title", description="description", @@ -122,13 +123,17 @@ async def make_assertion(*args, **_): protect_content=True, ) - async def test_send_all_args_create_invoice_link(self, bot, monkeypatch): + @pytest.mark.parametrize("subscription_period", [42, dtm.timedelta(seconds=42)]) + async def test_send_all_args_create_invoice_link( + self, offline_bot, monkeypatch, subscription_period + ): async def make_assertion(*args, **_): kwargs = args[1] - return all(kwargs[i] == i for i in kwargs) + sp = kwargs.pop("subscription_period") == 42 + return all(kwargs[i] == i for i in kwargs) and sp - monkeypatch.setattr(bot, "_post", make_assertion) - assert await bot.create_invoice_link( + monkeypatch.setattr(offline_bot, "_post", make_assertion) + assert await offline_bot.create_invoice_link( title="title", description="description", payload="payload", @@ -149,15 +154,19 @@ async def make_assertion(*args, **_): send_phone_number_to_provider="send_phone_number_to_provider", send_email_to_provider="send_email_to_provider", is_flexible="is_flexible", + business_connection_id="business_connection_id", + subscription_period=subscription_period, ) - async def test_send_object_as_provider_data(self, monkeypatch, bot, chat_id, provider_token): + async def test_send_object_as_provider_data( + self, monkeypatch, offline_bot, chat_id, provider_token + ): async def make_assertion(url, request_data: RequestData, *args, **kwargs): return request_data.json_parameters["provider_data"] == '{"test_data": 123456789}' - monkeypatch.setattr(bot.request, "post", make_assertion) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) - assert await bot.send_invoice( + assert await offline_bot.send_invoice( chat_id, self.title, self.description, @@ -219,7 +228,7 @@ def test_equality(self): assert hash(a) != hash(d) -class TestInvoiceWithRequest(TestInvoiceBase): +class TestInvoiceWithRequest(InvoiceTestBase): async def test_send_required_args_only(self, bot, chat_id, provider_token): message = await bot.send_invoice( chat_id=chat_id, diff --git a/tests/_payment/test_labeledprice.py b/tests/_payment/test_labeledprice.py index c05672de3c5..7647a704c75 100644 --- a/tests/_payment/test_labeledprice.py +++ b/tests/_payment/test_labeledprice.py @@ -24,15 +24,15 @@ @pytest.fixture(scope="module") def labeled_price(): - return LabeledPrice(TestLabeledPriceBase.label, TestLabeledPriceBase.amount) + return LabeledPrice(LabeledPriceTestBase.label, LabeledPriceTestBase.amount) -class TestLabeledPriceBase: +class LabeledPriceTestBase: label = "label" amount = 100 -class TestLabeledPriceWithoutRequest(TestLabeledPriceBase): +class TestLabeledPriceWithoutRequest(LabeledPriceTestBase): def test_slot_behaviour(self, labeled_price): inst = labeled_price for attr in inst.__slots__: diff --git a/tests/_payment/test_orderinfo.py b/tests/_payment/test_orderinfo.py index a8a01fb5e27..4f6317222da 100644 --- a/tests/_payment/test_orderinfo.py +++ b/tests/_payment/test_orderinfo.py @@ -25,34 +25,34 @@ @pytest.fixture(scope="module") def order_info(): return OrderInfo( - TestOrderInfoBase.name, - TestOrderInfoBase.phone_number, - TestOrderInfoBase.email, - TestOrderInfoBase.shipping_address, + OrderInfoTestBase.name, + OrderInfoTestBase.phone_number, + OrderInfoTestBase.email, + OrderInfoTestBase.shipping_address, ) -class TestOrderInfoBase: +class OrderInfoTestBase: name = "name" phone_number = "phone_number" email = "email" shipping_address = ShippingAddress("GB", "", "London", "12 Grimmauld Place", "", "WC1") -class TestOrderInfoWithoutRequest(TestOrderInfoBase): +class TestOrderInfoWithoutRequest(OrderInfoTestBase): def test_slot_behaviour(self, order_info): for attr in order_info.__slots__: assert getattr(order_info, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(order_info)) == len(set(mro_slots(order_info))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "name": self.name, "phone_number": self.phone_number, "email": self.email, "shipping_address": self.shipping_address.to_dict(), } - order_info = OrderInfo.de_json(json_dict, bot) + order_info = OrderInfo.de_json(json_dict, offline_bot) assert order_info.api_kwargs == {} assert order_info.name == self.name diff --git a/tests/_payment/test_precheckoutquery.py b/tests/_payment/test_precheckoutquery.py index 57637187df5..e61adbcf9c3 100644 --- a/tests/_payment/test_precheckoutquery.py +++ b/tests/_payment/test_precheckoutquery.py @@ -31,19 +31,19 @@ @pytest.fixture(scope="module") def pre_checkout_query(bot): pcq = PreCheckoutQuery( - TestPreCheckoutQueryBase.id_, - TestPreCheckoutQueryBase.from_user, - TestPreCheckoutQueryBase.currency, - TestPreCheckoutQueryBase.total_amount, - TestPreCheckoutQueryBase.invoice_payload, - shipping_option_id=TestPreCheckoutQueryBase.shipping_option_id, - order_info=TestPreCheckoutQueryBase.order_info, + PreCheckoutQueryTestBase.id_, + PreCheckoutQueryTestBase.from_user, + PreCheckoutQueryTestBase.currency, + PreCheckoutQueryTestBase.total_amount, + PreCheckoutQueryTestBase.invoice_payload, + shipping_option_id=PreCheckoutQueryTestBase.shipping_option_id, + order_info=PreCheckoutQueryTestBase.order_info, ) pcq.set_bot(bot) return pcq -class TestPreCheckoutQueryBase: +class PreCheckoutQueryTestBase: id_ = 5 invoice_payload = "invoice_payload" shipping_option_id = "shipping_option_id" @@ -53,14 +53,14 @@ class TestPreCheckoutQueryBase: order_info = OrderInfo() -class TestPreCheckoutQueryWithoutRequest(TestPreCheckoutQueryBase): +class TestPreCheckoutQueryWithoutRequest(PreCheckoutQueryTestBase): def test_slot_behaviour(self, pre_checkout_query): inst = pre_checkout_query for attr in inst.__slots__: assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "id": self.id_, "invoice_payload": self.invoice_payload, @@ -70,10 +70,10 @@ def test_de_json(self, bot): "from": self.from_user.to_dict(), "order_info": self.order_info.to_dict(), } - pre_checkout_query = PreCheckoutQuery.de_json(json_dict, bot) + pre_checkout_query = PreCheckoutQuery.de_json(json_dict, offline_bot) assert pre_checkout_query.api_kwargs == {} - assert pre_checkout_query.get_bot() is bot + assert pre_checkout_query.get_bot() is offline_bot assert pre_checkout_query.id == self.id_ assert pre_checkout_query.invoice_payload == self.invoice_payload assert pre_checkout_query.shipping_option_id == self.shipping_option_id diff --git a/tests/_payment/test_refundedpayment.py b/tests/_payment/test_refundedpayment.py index 75e252660da..32581f785f8 100644 --- a/tests/_payment/test_refundedpayment.py +++ b/tests/_payment/test_refundedpayment.py @@ -25,15 +25,15 @@ @pytest.fixture(scope="module") def refunded_payment(): return RefundedPayment( - TestRefundedPaymentBase.currency, - TestRefundedPaymentBase.total_amount, - TestRefundedPaymentBase.invoice_payload, - TestRefundedPaymentBase.telegram_payment_charge_id, - TestRefundedPaymentBase.provider_payment_charge_id, + RefundedPaymentTestBase.currency, + RefundedPaymentTestBase.total_amount, + RefundedPaymentTestBase.invoice_payload, + RefundedPaymentTestBase.telegram_payment_charge_id, + RefundedPaymentTestBase.provider_payment_charge_id, ) -class TestRefundedPaymentBase: +class RefundedPaymentTestBase: invoice_payload = "invoice_payload" currency = "EUR" total_amount = 100 @@ -41,14 +41,14 @@ class TestRefundedPaymentBase: provider_payment_charge_id = "provider_payment_charge_id" -class TestRefundedPaymentWithoutRequest(TestRefundedPaymentBase): +class TestRefundedPaymentWithoutRequest(RefundedPaymentTestBase): def test_slot_behaviour(self, refunded_payment): inst = refunded_payment for attr in inst.__slots__: assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "invoice_payload": self.invoice_payload, "currency": self.currency, @@ -56,7 +56,7 @@ def test_de_json(self, bot): "telegram_payment_charge_id": self.telegram_payment_charge_id, "provider_payment_charge_id": self.provider_payment_charge_id, } - refunded_payment = RefundedPayment.de_json(json_dict, bot) + refunded_payment = RefundedPayment.de_json(json_dict, offline_bot) assert refunded_payment.api_kwargs == {} assert refunded_payment.invoice_payload == self.invoice_payload diff --git a/tests/_payment/test_shippingaddress.py b/tests/_payment/test_shippingaddress.py index ee69fded956..371c8d2fc0c 100644 --- a/tests/_payment/test_shippingaddress.py +++ b/tests/_payment/test_shippingaddress.py @@ -25,16 +25,16 @@ @pytest.fixture(scope="module") def shipping_address(): return ShippingAddress( - TestShippingAddressBase.country_code, - TestShippingAddressBase.state, - TestShippingAddressBase.city, - TestShippingAddressBase.street_line1, - TestShippingAddressBase.street_line2, - TestShippingAddressBase.post_code, + ShippingAddressTestBase.country_code, + ShippingAddressTestBase.state, + ShippingAddressTestBase.city, + ShippingAddressTestBase.street_line1, + ShippingAddressTestBase.street_line2, + ShippingAddressTestBase.post_code, ) -class TestShippingAddressBase: +class ShippingAddressTestBase: country_code = "GB" state = "state" city = "London" @@ -43,14 +43,14 @@ class TestShippingAddressBase: post_code = "WC1" -class TestShippingAddressWithoutRequest(TestShippingAddressBase): +class TestShippingAddressWithoutRequest(ShippingAddressTestBase): def test_slot_behaviour(self, shipping_address): inst = shipping_address for attr in inst.__slots__: assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "country_code": self.country_code, "state": self.state, @@ -59,7 +59,7 @@ def test_de_json(self, bot): "street_line2": self.street_line2, "post_code": self.post_code, } - shipping_address = ShippingAddress.de_json(json_dict, bot) + shipping_address = ShippingAddress.de_json(json_dict, offline_bot) assert shipping_address.api_kwargs == {} assert shipping_address.country_code == self.country_code diff --git a/tests/_payment/test_shippingoption.py b/tests/_payment/test_shippingoption.py index cc969879056..5ce619488e7 100644 --- a/tests/_payment/test_shippingoption.py +++ b/tests/_payment/test_shippingoption.py @@ -25,17 +25,17 @@ @pytest.fixture(scope="module") def shipping_option(): return ShippingOption( - TestShippingOptionBase.id_, TestShippingOptionBase.title, TestShippingOptionBase.prices + ShippingOptionTestBase.id_, ShippingOptionTestBase.title, ShippingOptionTestBase.prices ) -class TestShippingOptionBase: +class ShippingOptionTestBase: id_ = "id" title = "title" prices = [LabeledPrice("Fish Container", 100), LabeledPrice("Premium Fish Container", 1000)] -class TestShippingOptionWithoutRequest(TestShippingOptionBase): +class TestShippingOptionWithoutRequest(ShippingOptionTestBase): def test_slot_behaviour(self, shipping_option): inst = shipping_option for attr in inst.__slots__: diff --git a/tests/_payment/test_shippingquery.py b/tests/_payment/test_shippingquery.py index bf8fc820d17..da99c1fd177 100644 --- a/tests/_payment/test_shippingquery.py +++ b/tests/_payment/test_shippingquery.py @@ -31,44 +31,44 @@ @pytest.fixture(scope="module") def shipping_query(bot): sq = ShippingQuery( - TestShippingQueryBase.id_, - TestShippingQueryBase.from_user, - TestShippingQueryBase.invoice_payload, - TestShippingQueryBase.shipping_address, + ShippingQueryTestBase.id_, + ShippingQueryTestBase.from_user, + ShippingQueryTestBase.invoice_payload, + ShippingQueryTestBase.shipping_address, ) sq.set_bot(bot) return sq -class TestShippingQueryBase: +class ShippingQueryTestBase: id_ = "5" invoice_payload = "invoice_payload" from_user = User(0, "", False) shipping_address = ShippingAddress("GB", "", "London", "12 Grimmauld Place", "", "WC1") -class TestShippingQueryWithoutRequest(TestShippingQueryBase): +class TestShippingQueryWithoutRequest(ShippingQueryTestBase): def test_slot_behaviour(self, shipping_query): inst = shipping_query for attr in inst.__slots__: assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "id": self.id_, "invoice_payload": self.invoice_payload, "from": self.from_user.to_dict(), "shipping_address": self.shipping_address.to_dict(), } - shipping_query = ShippingQuery.de_json(json_dict, bot) + shipping_query = ShippingQuery.de_json(json_dict, offline_bot) assert shipping_query.api_kwargs == {} assert shipping_query.id == self.id_ assert shipping_query.invoice_payload == self.invoice_payload assert shipping_query.from_user == self.from_user assert shipping_query.shipping_address == self.shipping_address - assert shipping_query.get_bot() is bot + assert shipping_query.get_bot() is offline_bot def test_to_dict(self, shipping_query): shipping_query_dict = shipping_query.to_dict() diff --git a/tests/_payment/test_successfulpayment.py b/tests/_payment/test_successfulpayment.py index a93238c537a..04a455673b2 100644 --- a/tests/_payment/test_successfulpayment.py +++ b/tests/_payment/test_successfulpayment.py @@ -16,26 +16,32 @@ # # 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 OrderInfo, SuccessfulPayment +from telegram._utils.datetime import UTC, to_timestamp from tests.auxil.slots import mro_slots @pytest.fixture(scope="module") def successful_payment(): return SuccessfulPayment( - TestSuccessfulPaymentBase.currency, - TestSuccessfulPaymentBase.total_amount, - TestSuccessfulPaymentBase.invoice_payload, - TestSuccessfulPaymentBase.telegram_payment_charge_id, - TestSuccessfulPaymentBase.provider_payment_charge_id, - shipping_option_id=TestSuccessfulPaymentBase.shipping_option_id, - order_info=TestSuccessfulPaymentBase.order_info, + SuccessfulPaymentTestBase.currency, + SuccessfulPaymentTestBase.total_amount, + SuccessfulPaymentTestBase.invoice_payload, + SuccessfulPaymentTestBase.telegram_payment_charge_id, + SuccessfulPaymentTestBase.provider_payment_charge_id, + shipping_option_id=SuccessfulPaymentTestBase.shipping_option_id, + order_info=SuccessfulPaymentTestBase.order_info, + subscription_expiration_date=SuccessfulPaymentTestBase.subscription_expiration_date, + is_recurring=SuccessfulPaymentTestBase.is_recurring, + is_first_recurring=SuccessfulPaymentTestBase.is_first_recurring, ) -class TestSuccessfulPaymentBase: +class SuccessfulPaymentTestBase: invoice_payload = "invoice_payload" shipping_option_id = "shipping_option_id" currency = "EUR" @@ -43,16 +49,19 @@ class TestSuccessfulPaymentBase: order_info = OrderInfo() telegram_payment_charge_id = "telegram_payment_charge_id" provider_payment_charge_id = "provider_payment_charge_id" + subscription_expiration_date = dtm.datetime.now(tz=UTC).replace(microsecond=0) + is_recurring = True + is_first_recurring = True -class TestSuccessfulPaymentWithoutRequest(TestSuccessfulPaymentBase): +class TestSuccessfulPaymentWithoutRequest(SuccessfulPaymentTestBase): def test_slot_behaviour(self, successful_payment): inst = successful_payment for attr in inst.__slots__: assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "invoice_payload": self.invoice_payload, "shipping_option_id": self.shipping_option_id, @@ -61,8 +70,11 @@ def test_de_json(self, bot): "order_info": self.order_info.to_dict(), "telegram_payment_charge_id": self.telegram_payment_charge_id, "provider_payment_charge_id": self.provider_payment_charge_id, + "subscription_expiration_date": to_timestamp(self.subscription_expiration_date), + "is_recurring": self.is_recurring, + "is_first_recurring": self.is_first_recurring, } - successful_payment = SuccessfulPayment.de_json(json_dict, bot) + successful_payment = SuccessfulPayment.de_json(json_dict, offline_bot) assert successful_payment.api_kwargs == {} assert successful_payment.invoice_payload == self.invoice_payload @@ -72,6 +84,32 @@ def test_de_json(self, bot): assert successful_payment.order_info == self.order_info assert successful_payment.telegram_payment_charge_id == self.telegram_payment_charge_id assert successful_payment.provider_payment_charge_id == self.provider_payment_charge_id + assert successful_payment.subscription_expiration_date == self.subscription_expiration_date + assert successful_payment.is_recurring == self.is_recurring + assert successful_payment.is_first_recurring == self.is_first_recurring + + def test_de_json_localization(self, offline_bot, raw_bot, tz_bot): + json_dict = { + "invoice_payload": self.invoice_payload, + "currency": self.currency, + "total_amount": self.total_amount, + "telegram_payment_charge_id": self.telegram_payment_charge_id, + "provider_payment_charge_id": self.provider_payment_charge_id, + "subscription_expiration_date": to_timestamp(self.subscription_expiration_date), + } + successful_payment = SuccessfulPayment.de_json(json_dict, offline_bot) + successful_payment_raw = SuccessfulPayment.de_json(json_dict, raw_bot) + successful_payment_tz = SuccessfulPayment.de_json(json_dict, tz_bot) + + # comparing utcoffsets because comparing timezones is unpredicatable + date_offset = successful_payment_tz.subscription_expiration_date.utcoffset() + tz_bot_offset = tz_bot.defaults.tzinfo.utcoffset( + successful_payment_tz.subscription_expiration_date.replace(tzinfo=None) + ) + + assert successful_payment_raw.subscription_expiration_date.tzinfo == UTC + assert successful_payment.subscription_expiration_date.tzinfo == UTC + assert date_offset == tz_bot_offset def test_to_dict(self, successful_payment): successful_payment_dict = successful_payment.to_dict() @@ -92,6 +130,13 @@ def test_to_dict(self, successful_payment): successful_payment_dict["provider_payment_charge_id"] == successful_payment.provider_payment_charge_id ) + assert successful_payment_dict["subscription_expiration_date"] == to_timestamp( + successful_payment.subscription_expiration_date + ) + assert successful_payment_dict["is_recurring"] == successful_payment.is_recurring + assert ( + successful_payment_dict["is_first_recurring"] == successful_payment.is_first_recurring + ) def test_equality(self): a = SuccessfulPayment( diff --git a/tests/auxil/bot_method_checks.py b/tests/auxil/bot_method_checks.py index 7b69863b1c3..9a0751dae5a 100644 --- a/tests/auxil/bot_method_checks.py +++ b/tests/auxil/bot_method_checks.py @@ -17,11 +17,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/]. """Provides functions to test both methods.""" -import datetime +import datetime as dtm import functools import inspect import re -from typing import Any, Callable, Collection, Dict, Iterable, List, Optional, Tuple +from collections.abc import Collection, Iterable +from typing import Any, Callable, Optional import pytest @@ -57,9 +58,9 @@ def check_shortcut_signature( shortcut: Callable, bot_method: Callable, - shortcut_kwargs: List[str], - additional_kwargs: List[str], - annotation_overrides: Optional[Dict[str, Tuple[Any, Any]]] = None, + shortcut_kwargs: list[str], + additional_kwargs: list[str], + annotation_overrides: Optional[dict[str, tuple[Any, Any]]] = None, ) -> bool: """ Checks that the signature of a shortcut matches the signature of the underlying bot method. @@ -335,12 +336,10 @@ def build_kwargs( elif name == "until_date": if manually_passed_value not in [None, DEFAULT_NONE]: # Europe/Berlin - kws[name] = pytz.timezone("Europe/Berlin").localize( - datetime.datetime(2000, 1, 1, 0) - ) + kws[name] = pytz.timezone("Europe/Berlin").localize(dtm.datetime(2000, 1, 1, 0)) else: # naive UTC - kws[name] = datetime.datetime(2000, 1, 1, 0) + kws[name] = dtm.datetime(2000, 1, 1, 0) elif name == "reply_parameters": kws[name] = telegram.ReplyParameters( message_id=1, @@ -389,7 +388,7 @@ async def make_assertion( url, request_data: RequestData, method_name: str, - kwargs_need_default: List[str], + kwargs_need_default: list[str], return_value, manually_passed_value: Any = DEFAULT_NONE, expected_defaults_value: Any = DEFAULT_NONE, @@ -451,7 +450,7 @@ async def make_assertion( ) # Check InputMedia (parse_mode can have a default) - def check_input_media(m: Dict): + def check_input_media(m: dict): parse_mode = m.get("parse_mode") if no_value_expected and parse_mode is not None: pytest.fail("InputMedia has non-None parse_mode, expected it to be absent") diff --git a/tests/auxil/build_messages.py b/tests/auxil/build_messages.py index 69370977efb..7a51eb36596 100644 --- a/tests/auxil/build_messages.py +++ b/tests/auxil/build_messages.py @@ -16,7 +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 +import datetime as dtm import re from telegram import Chat, Message, MessageEntity, Update, User @@ -24,19 +24,20 @@ from tests.auxil.pytest_classes import make_bot CMD_PATTERN = re.compile(r"/[\da-z_]{1,32}(?:@\w{1,32})?") -DATE = datetime.datetime.now() +DATE = dtm.datetime.now() -def make_message(text, **kwargs): +def make_message(text: str, offline: bool = True, **kwargs): """ Testing utility factory to create a fake ``telegram.Message`` with reasonable defaults for mimicking a real message. :param text: (str) message text + :param offline: (bool) whether the bot should be offline :return: a (fake) ``telegram.Message`` """ bot = kwargs.pop("bot", None) if bot is None: - bot = make_bot(BOT_INFO_PROVIDER.get_info()) + bot = make_bot(BOT_INFO_PROVIDER.get_info(), offline=offline) message = Message( message_id=1, from_user=kwargs.pop("user", User(id=1, first_name="", is_bot=False)), diff --git a/tests/auxil/ci_bots.py b/tests/auxil/ci_bots.py index bfad962b811..069a65ccec9 100644 --- a/tests/auxil/ci_bots.py +++ b/tests/auxil/ci_bots.py @@ -22,30 +22,35 @@ import os import random +from telegram._utils.strings import TextEncoding + # Provide some public fallbacks so it's easy for contributors to run tests on their local machine # These bots are only able to talk in our test chats, so they are quite useless for other # purposes than testing. FALLBACKS = ( "W3sidG9rZW4iOiAiNTc5Njk0NzE0OkFBRnBLOHc2emtrVXJENHhTZVl3RjNNTzhlLTRHcm1jeTdjIiwgInBheW1lbnRfc" - "HJvdmlkZXJfdG9rZW4iOiAiMjg0Njg1MDYzOlRFU1Q6TmpRME5qWmxOekk1WWpKaSIsICJjaGF0X2 lkIjogIjY3NTY2N" - "jIyNCIsICJzdXBlcl9ncm91cF9pZCI6ICItMTAwMTMxMDkxMTEzNSIsICJmb3J1bV9ncm91cF9pZCI6ICItMTAwMTgzOD" - "AwNDU3NyIsICJjaGFubmVsX2lkIjogIkBweXRob250ZWxlZ3JhbWJvdHRlc3RzIi wgIm5hbWUiOiAiUFRCIHRlc3RzIG" - "ZhbGxiYWNrIDEiLCAidXNlcm5hbWUiOiAiQHB0Yl9mYWxsYmFja18xX2JvdCJ9LCB7InRva2VuIjogIjU1ODE5NDA2Njp" - "BQUZ3RFBJRmx6R1VsQ2FXSHRUT0VYNFJGclg4dTlETXFmbyIsIC JwYXltZW50X3Byb3ZpZGVyX3Rva2VuIjogIjI4NDY" - "4NTA2MzpURVNUOllqRXdPRFF3TVRGbU5EY3kiLCAiY2hhdF9pZCI6ICI2NzU2NjYyMjQiLCAic3VwZXJfZ3JvdXBfaWQi" - "OiAiLTEwMDEyMjEyMTY4MzAiLCAiZm9ydW1fZ3 JvdXBfaWQiOiAiLTEwMDE4NTc4NDgzMTQiLCAiY2hhbm5lbF9pZCI6" - "ICJAcHl0aG9udGVsZWdyYW1ib3R0ZXN0cyIsICJuYW1lIjogIlBUQiB0ZXN0cyBmYWxsYmFjayAyIiwgInVzZXJuYW1lI" - "jogIkBwdGJfZmFsbGJhY2tfMl9ib3QifV0=" + "HJvdmlkZXJfdG9rZW4iOiAiMjg0Njg1MDYzOlRFU1Q6TmpRME5qWmxOekk1WWpKaSIsICJjaGF0X2lkIjogIjY3NTY2Nj" + "IyNCIsICJzdXBlcl9ncm91cF9pZCI6ICItMTAwMTMxMDkxMTEzNSIsICJmb3J1bV9ncm91cF9pZCI6ICItMTAwMTgzODA" + "wNDU3NyIsICJjaGFubmVsX2lkIjogIkBweXRob250ZWxlZ3JhbWJvdHRlc3RzIiwgIm5hbWUiOiAiUFRCIHRlc3RzIGZh" + "bGxiYWNrIDEiLCAidXNlcm5hbWUiOiAiQHB0Yl9mYWxsYmFja18xX2JvdCIsICJzdWJzY3JpcHRpb25fY2hhbm5lbF9pZ" + "CI6IC0xMDAyMjI5NjQ5MzAzfSwgeyJ0b2tlbiI6ICI1NTgxOTQwNjY6QUFGd0RQSUZsekdVbENhV0h0VE9FWDRSRnJYOH" + "U5RE1xZm8iLCAicGF5bWVudF9wcm92aWRlcl90b2tlbiI6ICIyODQ2ODUwNjM6VEVTVDpZakV3T0RRd01URm1ORGN5Iiw" + "gImNoYXRfaWQiOiAiNjc1NjY2MjI0IiwgInN1cGVyX2dyb3VwX2lkIjogIi0xMDAxMjIxMjE2ODMwIiwgImZvcnVtX2dy" + "b3VwX2lkIjogIi0xMDAxODU3ODQ4MzE0IiwgImNoYW5uZWxfaWQiOiAiQHB5dGhvbnRlbGVncmFtYm90dGVzdHMiLCAib" + "mFtZSI6ICJQVEIgdGVzdHMgZmFsbGJhY2sgMiIsICJ1c2VybmFtZSI6ICJAcHRiX2ZhbGxiYWNrXzJfYm90IiwgInN1Yn" + "NjcmlwdGlvbl9jaGFubmVsX2lkIjogLTEwMDIyMjk2NDkzMDN9XQ==" ) GITHUB_ACTION = os.getenv("GITHUB_ACTION", None) BOTS = os.getenv("BOTS", None) JOB_INDEX = os.getenv("JOB_INDEX", None) if GITHUB_ACTION is not None and BOTS is not None and JOB_INDEX is not None: - BOTS = json.loads(base64.b64decode(BOTS).decode("utf-8")) + BOTS = json.loads(base64.b64decode(BOTS).decode(TextEncoding.UTF_8)) JOB_INDEX = int(JOB_INDEX) -FALLBACKS = json.loads(base64.b64decode(FALLBACKS).decode("utf-8")) # type: list[dict[str, str]] +FALLBACKS = json.loads( + base64.b64decode(FALLBACKS).decode(TextEncoding.UTF_8) +) # type: list[dict[str, str]] class BotInfoProvider: diff --git a/tests/auxil/constants.py b/tests/auxil/constants.py index 8ec314bfbe5..5c90824ba4c 100644 --- a/tests/auxil/constants.py +++ b/tests/auxil/constants.py @@ -20,3 +20,7 @@ # THIS KEY IS OBVIOUSLY COMPROMISED # DO NOT USE IN PRODUCTION! PRIVATE_KEY = b"-----BEGIN RSA PRIVATE KEY-----\r\nMIIEowIBAAKCAQEA0AvEbNaOnfIL3GjB8VI4M5IaWe+GcK8eSPHkLkXREIsaddum\r\nwPBm/+w8lFYdnY+O06OEJrsaDtwGdU//8cbGJ/H/9cJH3dh0tNbfszP7nTrQD+88\r\nydlcYHzClaG8G+oTe9uEZSVdDXj5IUqR0y6rDXXb9tC9l+oSz+ShYg6+C4grAb3E\r\nSTv5khZ9Zsi/JEPWStqNdpoNuRh7qEYc3t4B/a5BH7bsQENyJSc8AWrfv+drPAEe\r\njQ8xm1ygzWvJp8yZPwOIYuL+obtANcoVT2G2150Wy6qLC0bD88Bm40GqLbSazueC\r\nRHZRug0B9rMUKvKc4FhG4AlNzBCaKgIcCWEqKwIDAQABAoIBACcIjin9d3Sa3S7V\r\nWM32JyVF3DvTfN3XfU8iUzV7U+ZOswA53eeFM04A/Ly4C4ZsUNfUbg72O8Vd8rg/\r\n8j1ilfsYpHVvphwxaHQlfIMa1bKCPlc/A6C7b2GLBtccKTbzjARJA2YWxIaqk9Nz\r\nMjj1IJK98i80qt29xRnMQ5sqOO3gn2SxTErvNchtBiwOH8NirqERXig8VCY6fr3n\r\nz7ZImPU3G/4qpD0+9ULrt9x/VkjqVvNdK1l7CyAuve3D7ha3jPMfVHFtVH5gqbyp\r\nKotyIHAyD+Ex3FQ1JV+H7DkP0cPctQiss7OiO9Zd9C1G2OrfQz9el7ewAPqOmZtC\r\nKjB3hUECgYEA/4MfKa1cvaCqzd3yUprp1JhvssVkhM1HyucIxB5xmBcVLX2/Kdhn\r\nhiDApZXARK0O9IRpFF6QVeMEX7TzFwB6dfkyIePsGxputA5SPbtBlHOvjZa8omMl\r\nEYfNa8x/mJkvSEpzvkWPascuHJWv1cEypqphu/70DxubWB5UKo/8o6cCgYEA0HFy\r\ncgwPMB//nltHGrmaQZPFT7/Qgl9ErZT3G9S8teWY4o4CXnkdU75tBoKAaJnpSfX3\r\nq8VuRerF45AFhqCKhlG4l51oW7TUH50qE3GM+4ivaH5YZB3biwQ9Wqw+QyNLAh/Q\r\nnS4/Wwb8qC9QuyEgcCju5lsCaPEXZiZqtPVxZd0CgYEAshBG31yZjO0zG1TZUwfy\r\nfN3euc8mRgZpSdXIHiS5NSyg7Zr8ZcUSID8jAkJiQ3n3OiAsuq1MGQ6kNa582kLT\r\nFPQdI9Ea8ahyDbkNR0gAY9xbM2kg/Gnro1PorH9PTKE0ekSodKk1UUyNrg4DBAwn\r\nqE6E3ebHXt/2WmqIbUD653ECgYBQCC8EAQNX3AFegPd1GGxU33Lz4tchJ4kMCNU0\r\nN2NZh9VCr3nTYjdTbxsXU8YP44CCKFG2/zAO4kymyiaFAWEOn5P7irGF/JExrjt4\r\nibGy5lFLEq/HiPtBjhgsl1O0nXlwUFzd7OLghXc+8CPUJaz5w42unqT3PBJa40c3\r\nQcIPdQKBgBnSb7BcDAAQ/Qx9juo/RKpvhyeqlnp0GzPSQjvtWi9dQRIu9Pe7luHc\r\nm1Img1EO1OyE3dis/rLaDsAa2AKu1Yx6h85EmNjavBqP9wqmFa0NIQQH8fvzKY3/\r\nP8IHY6009aoamLqYaexvrkHVq7fFKiI6k8myMJ6qblVNFv14+KXU\r\n-----END RSA PRIVATE KEY-----" # noqa: E501 + +TEST_MSG_TEXT = "Topics are forever" +TEST_TOPIC_ICON_COLOR = 0x6FB9F0 +TEST_TOPIC_NAME = "Sad bot true: real stories" diff --git a/tests/auxil/monkeypatch.py b/tests/auxil/monkeypatch.py new file mode 100644 index 00000000000..087ea80232d --- /dev/null +++ b/tests/auxil/monkeypatch.py @@ -0,0 +1,29 @@ +#!/usr/bin/env python +# +# A library that provides a Python interface to the Telegram Bot API +# Copyright (C) 2015-2024 +# Leandro Toledo de Souza +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser Public License for more details. +# +# You should have received a copy of the GNU Lesser Public License +# along with this program. If not, see [http://www.gnu.org/licenses/]. +import asyncio + + +async def return_true(*args, **kwargs): + return True + + +async def empty_get_updates(*args, **kwargs): + # The `await` gives the event loop a chance to run other tasks + await asyncio.sleep(0) + return [] diff --git a/tests/auxil/networking.py b/tests/auxil/networking.py index 2284f31fc50..d103154f93b 100644 --- a/tests/auxil/networking.py +++ b/tests/auxil/networking.py @@ -23,9 +23,10 @@ from httpx import AsyncClient, AsyncHTTPTransport, Response from telegram._utils.defaultvalue import DEFAULT_NONE +from telegram._utils.strings import TextEncoding from telegram._utils.types import ODVInput from telegram.error import BadRequest, RetryAfter, TimedOut -from telegram.request import HTTPXRequest, RequestData +from telegram.request import BaseRequest, HTTPXRequest, RequestData class NonchalantHttpxRequest(HTTPXRequest): @@ -59,6 +60,33 @@ async def _request_wrapper( pytest.xfail(f"Ignoring TimedOut error: {e}") +class OfflineRequest(BaseRequest): + """This Request class disallows making requests to Telegram's servers. + Use this in tests that should not depend on the network. + """ + + async def initialize(self) -> None: + pass + + async def shutdown(self) -> None: + pass + + def __init__(self, *args, **kwargs): + pass + + async def do_request( + self, + url: str, + method: str, + request_data: Optional[RequestData] = None, + read_timeout: ODVInput[float] = BaseRequest.DEFAULT_NONE, + write_timeout: ODVInput[float] = BaseRequest.DEFAULT_NONE, + connect_timeout: ODVInput[float] = BaseRequest.DEFAULT_NONE, + pool_timeout: ODVInput[float] = BaseRequest.DEFAULT_NONE, + ) -> tuple[int, bytes]: + pytest.fail("OfflineRequest: Network access disallowed in this test") + + async def expect_bad_request(func, message, reason): """ Wrapper for testing bot functions expected to result in an :class:`telegram.error.BadRequest`. @@ -103,7 +131,7 @@ async def send_webhook_message( content_len = None payload = None else: - payload = bytes(payload_str, encoding="utf-8") + payload = bytes(payload_str, encoding=TextEncoding.UTF_8) if content_len == -1: content_len = len(payload) diff --git a/tests/auxil/pytest_classes.py b/tests/auxil/pytest_classes.py index 1b976b02e6c..f85e12ac23c 100644 --- a/tests/auxil/pytest_classes.py +++ b/tests/auxil/pytest_classes.py @@ -25,7 +25,7 @@ from tests.auxil.ci_bots import BOT_INFO_PROVIDER from tests.auxil.constants import PRIVATE_KEY from tests.auxil.envvars import TEST_WITH_OPT_DEPS -from tests.auxil.networking import NonchalantHttpxRequest +from tests.auxil.networking import NonchalantHttpxRequest, OfflineRequest def _get_bot_user(token: str) -> User: @@ -93,17 +93,20 @@ class PytestUpdater(Updater): pass -def make_bot(bot_info=None, **kwargs): +def make_bot(bot_info=None, offline: bool = True, **kwargs): """ Tests are executed on tg.ext.ExtBot, as that class only extends the functionality of tg.bot """ token = kwargs.pop("token", (bot_info or {}).get("token")) private_key = kwargs.pop("private_key", PRIVATE_KEY) kwargs.pop("token", None) + + request_class = OfflineRequest if offline else NonchalantHttpxRequest + return PytestExtBot( token=token, private_key=private_key if TEST_WITH_OPT_DEPS else None, - request=NonchalantHttpxRequest(8), - get_updates_request=NonchalantHttpxRequest(1), + request=request_class(8), + get_updates_request=request_class(1), **kwargs, ) diff --git a/tests/auxil/timezones.py b/tests/auxil/timezones.py index 2b87dd89499..15fcdccb4d3 100644 --- a/tests/auxil/timezones.py +++ b/tests/auxil/timezones.py @@ -16,10 +16,10 @@ # # 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 +import datetime as dtm -class BasicTimezone(datetime.tzinfo): +class BasicTimezone(dtm.tzinfo): def __init__(self, offset, name): self.offset = offset self.name = name @@ -28,4 +28,4 @@ def utcoffset(self, dt): return self.offset def dst(self, dt): - return datetime.timedelta(0) + return dtm.timedelta(0) diff --git a/tests/conftest.py b/tests/conftest.py index a9ef3e68641..7147fa8f765 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -17,11 +17,10 @@ # 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 +import datetime as dtm import logging import sys from pathlib import Path -from typing import Dict, List from uuid import uuid4 import pytest @@ -37,15 +36,14 @@ Update, User, ) -from telegram.ext import ApplicationBuilder, Defaults, Updater -from telegram.ext.filters import MessageFilter, UpdateFilter +from telegram.ext import Defaults from tests.auxil.build_messages import DATE -from tests.auxil.ci_bots import BOT_INFO_PROVIDER -from tests.auxil.constants import PRIVATE_KEY -from tests.auxil.envvars import RUN_TEST_OFFICIAL, TEST_WITH_OPT_DEPS +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_ACTION, RUN_TEST_OFFICIAL, TEST_WITH_OPT_DEPS from tests.auxil.files import data_file from tests.auxil.networking import NonchalantHttpxRequest -from tests.auxil.pytest_classes import PytestApplication, PytestBot, make_bot +from tests.auxil.pytest_classes import PytestBot, make_bot from tests.auxil.timezones import BasicTimezone if TEST_WITH_OPT_DEPS: @@ -77,7 +75,7 @@ def no_rerun_after_xfail_or_flood(error, name, test: pytest.Function, plugin): return not (xfail_present or did_we_flood) -def pytest_collection_modifyitems(items: List[pytest.Item]): +def pytest_collection_modifyitems(items: list[pytest.Item]): """Here we add a flaky marker to all request making tests and a (no_)req marker to the rest.""" for item in items: # items are the test methods parent = item.parent # Get the parent of the item (class, or module if defined outside) @@ -99,6 +97,39 @@ def pytest_collection_modifyitems(items: List[pytest.Item]): parent.add_marker(pytest.mark.no_req) +if GITHUB_ACTION and JOB_INDEX == 0: + # let's not slow down the tests too much with these additional checks + # that's why we run them only in GitHub actions and only on *one* of the several test + # matrix entries + @pytest.fixture(autouse=True) + def _disallow_requests_in_without_request_tests(request): + """This fixture prevents tests that don't require requests from using the online-bot. + This is a sane-effort approach on trying to prevent requests from being made in the + *WithoutRequest classes. Note that we can not prevent all requests, as one can still + manually build a `Bot` object or use `httpx` directly. See #4317 and #4465 for some + discussion. + """ + + if type(request).__name__ == "SubRequest": + # Some fixtures used in the *WithoutRequests test classes do use requests, e.g. + # `animation`. Separating that would be too much effort, hence we allow that. + # Unfortunately the `SubRequest` class is not public, so we check only the name for + # less dependency on pytest's internal structure. + return + + if not request.cls: + return + name = request.cls.__name__ + if not name.endswith("WithoutRequest") or not request.fixturenames: + return + + if "bot" in request.fixturenames: + pytest.fail( + f"Test function {request.function} in test class {name} should not have a `bot` " + f"fixture. Use `offline_bot` instead." + ) + + # 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") @@ -113,27 +144,36 @@ def event_loop(request): @pytest.fixture(scope="session") -def bot_info() -> Dict[str, str]: +def bot_info() -> dict[str, str]: return BOT_INFO_PROVIDER.get_info() @pytest.fixture(scope="session") async def bot(bot_info): """Makes an ExtBot instance with the given bot_info""" - async with make_bot(bot_info) as _bot: + async with make_bot(bot_info, offline=False) as _bot: yield _bot -@pytest.fixture() +@pytest.fixture(scope="session") +async def offline_bot(bot_info): + """Makes an offline Bot instance with the given bot_info + Note that in tests/ext we also override the `bot` fixture to return the offline bot instead. + """ + async with make_bot(bot_info, offline=True) as _bot: + yield _bot + + +@pytest.fixture def one_time_bot(bot_info): """A function scoped bot since the session bot would shutdown when `async with app` finishes""" - return make_bot(bot_info) + return make_bot(bot_info, offline=False) @pytest.fixture(scope="session") async def cdc_bot(bot_info): """Makes an ExtBot instance with the given bot_info that uses arbitrary callback_data""" - async with make_bot(bot_info, arbitrary_callback_data=True) as _bot: + async with make_bot(bot_info, arbitrary_callback_data=True, offline=False) as _bot: yield _bot @@ -163,7 +203,7 @@ async def default_bot(request, bot_info): # If the bot is already created, return it. Else make a new one. default_bot = _default_bots.get(defaults) if default_bot is None: - default_bot = make_bot(bot_info, defaults=defaults) + default_bot = make_bot(bot_info, defaults=defaults, offline=False) await default_bot.initialize() _default_bots[defaults] = default_bot # Defaults object is hashable return default_bot @@ -175,7 +215,7 @@ async def tz_bot(timezone, bot_info): try: # If the bot is already created, return it. Saves time since get_me is not called again. return _default_bots[defaults] except KeyError: - default_bot = make_bot(bot_info, defaults=defaults) + default_bot = make_bot(bot_info, defaults=defaults, offline=False) await default_bot.initialize() _default_bots[defaults] = default_bot return default_bot @@ -206,29 +246,12 @@ def provider_token(bot_info): return bot_info["payment_provider_token"] -@pytest.fixture() -async def app(bot_info): - # We build a new bot each time so that we use `app` in a context manager without problems - application = ( - ApplicationBuilder().bot(make_bot(bot_info)).application_class(PytestApplication).build() - ) - yield application - if application.running: - await application.stop() - await application.shutdown() - - -@pytest.fixture() -async def updater(bot_info): - # We build a new bot each time so that we use `updater` in a context manager without problems - up = Updater(bot=make_bot(bot_info), update_queue=asyncio.Queue()) - yield up - if up.running: - await up.stop() - await up.shutdown() +@pytest.fixture(scope="session") +def subscription_channel_id(bot_info): + return bot_info["subscription_channel_id"] -@pytest.fixture() +@pytest.fixture def thumb_file(): with data_file("thumb.jpg").open("rb") as f: yield f @@ -240,21 +263,28 @@ def class_thumb_file(): yield f -@pytest.fixture( - scope="class", - params=[{"class": MessageFilter}, {"class": UpdateFilter}], - ids=["MessageFilter", "UpdateFilter"], -) -def mock_filter(request): - class MockFilter(request.param["class"]): - def __init__(self): - super().__init__() - self.tested = False +@pytest.fixture(scope="session") +async def emoji_id(bot): + emoji_sticker_list = await bot.get_forum_topic_icon_stickers() + first_sticker = emoji_sticker_list[0] + return first_sticker.custom_emoji_id + + +@pytest.fixture +async def real_topic(bot, emoji_id, forum_group_id): + result = await bot.create_forum_topic( + chat_id=forum_group_id, + name=TEST_TOPIC_NAME, + icon_color=TEST_TOPIC_ICON_COLOR, + icon_custom_emoji_id=emoji_id, + ) - def filter(self, _): - self.tested = True + yield result - return MockFilter() + result = await bot.delete_forum_topic( + chat_id=forum_group_id, message_thread_id=result.message_thread_id + ) + assert result is True, "Topic was not deleted" def _get_false_update_fixture_decorator_params(): @@ -283,7 +313,7 @@ def tzinfo(request): if TEST_WITH_OPT_DEPS: return pytz.timezone(request.param) hours_offset = {"Europe/Berlin": 2, "Asia/Singapore": 8, "UTC": 0}[request.param] - return BasicTimezone(offset=datetime.timedelta(hours=hours_offset), name=request.param) + return BasicTimezone(offset=dtm.timedelta(hours=hours_offset), name=request.param) @pytest.fixture(scope="session") @@ -291,6 +321,6 @@ def timezone(tzinfo): return tzinfo -@pytest.fixture() +@pytest.fixture def tmp_file(tmp_path) -> Path: return tmp_path / uuid4().hex diff --git a/tests/docs/admonition_inserter.py b/tests/docs/admonition_inserter.py index fa19d9a0f9d..bc03c7a10f6 100644 --- a/tests/docs/admonition_inserter.py +++ b/tests/docs/admonition_inserter.py @@ -96,7 +96,7 @@ def test_admonitions_dict(self, admonition_inserter): ( "available_in", telegram.Sticker, - ":attr:`telegram.StickerSet.stickers`", # Tuple[telegram.Sticker] + ":attr:`telegram.StickerSet.stickers`", # tuple[telegram.Sticker] ), ( "available_in", diff --git a/tests/ext/_utils/test_trackingdict.py b/tests/ext/_utils/test_trackingdict.py index 5ddf3d371b3..5fa21467e82 100644 --- a/tests/ext/_utils/test_trackingdict.py +++ b/tests/ext/_utils/test_trackingdict.py @@ -23,14 +23,14 @@ from tests.auxil.slots import mro_slots -@pytest.fixture() +@pytest.fixture def td() -> TrackingDict: td = TrackingDict() td.update_no_track({1: 1}) return td -@pytest.fixture() +@pytest.fixture def data() -> dict: return {1: 1} diff --git a/tests/ext/conftest.py b/tests/ext/conftest.py new file mode 100644 index 00000000000..f1a877b6e27 --- /dev/null +++ b/tests/ext/conftest.py @@ -0,0 +1,102 @@ +import asyncio + +import pytest + +from telegram.ext import ApplicationBuilder, Updater +from telegram.ext.filters import MessageFilter, UpdateFilter +from tests.auxil.constants import PRIVATE_KEY +from tests.auxil.envvars import TEST_WITH_OPT_DEPS +from tests.auxil.monkeypatch import return_true +from tests.auxil.networking import OfflineRequest +from tests.auxil.pytest_classes import PytestApplication, PytestBot, make_bot + +# This module overrides the bot fixtures defined in the global conftest.py to use the offline bot. +# We don't want the tests on telegram.ext to depend on the network, so we use the offline bot +# instead. + + +@pytest.fixture(scope="session") +async def bot(bot_info, offline_bot): + return offline_bot + + +@pytest.fixture +async def app(bot_info, monkeypatch): + # We build a new bot each time so that we use `app` in a context manager without problems + application = ( + ApplicationBuilder() + .bot(make_bot(bot_info, offline=True)) + .application_class(PytestApplication) + .build() + ) + monkeypatch.setattr(application.bot, "delete_webhook", return_true) + monkeypatch.setattr(application.bot, "set_webhook", return_true) + yield application + if application.running: + await application.stop() + await application.shutdown() + + +@pytest.fixture +async def updater(bot_info, monkeypatch): + # We build a new bot each time so that we use `updater` in a context manager without problems + up = Updater(bot=make_bot(bot_info, offline=True), update_queue=asyncio.Queue()) + monkeypatch.setattr(up.bot, "delete_webhook", return_true) + monkeypatch.setattr(up.bot, "set_webhook", return_true) + yield up + if up.running: + await up.stop() + await up.shutdown() + + +@pytest.fixture +def one_time_bot(bot_info): + """A function scoped bot since the session bot would shutdown when `async with app` finishes""" + return make_bot(bot_info, offline=True) + + +@pytest.fixture(scope="session") +async def cdc_bot(bot_info): + """Makes an ExtBot instance with the given bot_info that uses arbitrary callback_data""" + async with make_bot(bot_info, arbitrary_callback_data=True, offline=True) as _bot: + yield _bot + + +@pytest.fixture(scope="session") +async def raw_bot(bot_info): + """Makes an regular Bot instance with the given bot_info""" + async with PytestBot( + bot_info["token"], + private_key=PRIVATE_KEY if TEST_WITH_OPT_DEPS else None, + request=OfflineRequest(), + get_updates_request=OfflineRequest(), + ) as _bot: + yield _bot + + +@pytest.fixture +async def one_time_raw_bot(bot_info): + """Makes an regular Bot instance with the given bot_info""" + return PytestBot( + bot_info["token"], + private_key=PRIVATE_KEY if TEST_WITH_OPT_DEPS else None, + request=OfflineRequest(), + get_updates_request=OfflineRequest(), + ) + + +@pytest.fixture( + scope="class", + params=[{"class": MessageFilter}, {"class": UpdateFilter}], + ids=["MessageFilter", "UpdateFilter"], +) +def mock_filter(request): + class MockFilter(request.param["class"]): + def __init__(self): + super().__init__() + self.tested = False + + def filter(self, _): + self.tested = True + + return MockFilter() diff --git a/tests/ext/test_application.py b/tests/ext/test_application.py index a74f3c739bf..ec6da310c42 100644 --- a/tests/ext/test_application.py +++ b/tests/ext/test_application.py @@ -60,6 +60,7 @@ 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.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 from tests.auxil.slots import mro_slots @@ -301,15 +302,19 @@ def after_updater_shutdown(*args, **kwargs): ) if updater: - async with ApplicationBuilder().bot(one_time_bot).concurrent_updates( - update_processor - ).build(): + async with ( + ApplicationBuilder().bot(one_time_bot).concurrent_updates(update_processor).build() + ): pass assert self.test_flag == {"bot", "update_processor", "updater"} else: - async with ApplicationBuilder().bot(one_time_bot).updater(None).concurrent_updates( - update_processor - ).build(): + async with ( + ApplicationBuilder() + .bot(one_time_bot) + .updater(None) + .concurrent_updates(update_processor) + .build() + ): pass assert self.test_flag == {"bot", "update_processor"} @@ -432,7 +437,7 @@ def test_builder(self, app): @pytest.mark.parametrize("job_queue", [True, False]) @pytest.mark.filterwarnings("ignore::telegram.warnings.PTBUserWarning") - async def test_start_stop_processing_updates(self, one_time_bot, job_queue): + async def test_start_stop_processing_updates(self, one_time_bot, job_queue, monkeypatch): # TODO: repeat a similar test for create_task, persistence processing and job queue if job_queue: app = ApplicationBuilder().bot(one_time_bot).build() @@ -442,6 +447,9 @@ async def test_start_stop_processing_updates(self, one_time_bot, job_queue): async def callback(u, c): self.received = u + monkeypatch.setattr(app.bot, "get_updates", empty_get_updates) + monkeypatch.setattr(app.bot, "delete_webhook", return_true) + assert not app.running assert not app.updater.running if job_queue: @@ -639,11 +647,11 @@ async def test_add_handlers(self, app): assert len(app.handlers[-1]) == 1 # Now lets test the errors which can be produced- - with pytest.raises(ValueError, match="The `group` argument"): + with pytest.raises(TypeError, match="The `group` argument"): app.add_handlers({2: [msg_handler_set_count]}, group=0) - with pytest.raises(ValueError, match="Handlers for group 3"): + with pytest.raises(TypeError, match="Handlers for group 3"): app.add_handlers({3: msg_handler_set_count}) - with pytest.raises(ValueError, match="The `handlers` argument must be a sequence"): + with pytest.raises(TypeError, match="The `handlers` argument must be a sequence"): app.add_handlers({msg_handler_set_count}) await app.stop() @@ -1519,11 +1527,6 @@ def thread_target(): def test_run_polling_timeout_deprecation_warnings( self, timeout_name, monkeypatch, recwarn, app ): - async def get_updates(*args, **kwargs): - # This makes sure that other coroutines have a chance of running as well - await asyncio.sleep(0) - return [] - def thread_target(): waited = 0 while not app.running: @@ -1536,7 +1539,7 @@ def thread_target(): os.kill(os.getpid(), signal.SIGINT) - monkeypatch.setattr(app.bot, "get_updates", get_updates) + monkeypatch.setattr(app.bot, "get_updates", empty_get_updates) thread = Thread(target=thread_target) thread.start() @@ -1563,11 +1566,6 @@ def thread_target(): def test_run_polling_post_init(self, one_time_bot, monkeypatch): events = [] - async def get_updates(*args, **kwargs): - # This makes sure that other coroutines have a chance of running as well - await asyncio.sleep(0) - return [] - def thread_target(): waited = 0 while not app.running: @@ -1589,7 +1587,7 @@ async def post_init(app: Application) -> None: .build() ) app.bot._unfreeze() - monkeypatch.setattr(app.bot, "get_updates", get_updates) + monkeypatch.setattr(app.bot, "get_updates", empty_get_updates) monkeypatch.setattr( app, "initialize", call_after(app.initialize, lambda _: events.append("init")) ) @@ -1598,6 +1596,7 @@ async def post_init(app: Application) -> None: "start_polling", call_after(app.updater.start_polling, lambda _: events.append("start_polling")), ) + monkeypatch.setattr(app.bot, "delete_webhook", return_true) thread = Thread(target=thread_target) thread.start() @@ -1612,11 +1611,6 @@ async def post_init(app: Application) -> None: def test_run_polling_post_shutdown(self, one_time_bot, monkeypatch): events = [] - async def get_updates(*args, **kwargs): - # This makes sure that other coroutines have a chance of running as well - await asyncio.sleep(0) - return [] - def thread_target(): waited = 0 while not app.running: @@ -1638,7 +1632,7 @@ async def post_shutdown(app: Application) -> None: .build() ) app.bot._unfreeze() - monkeypatch.setattr(app.bot, "get_updates", get_updates) + monkeypatch.setattr(app.bot, "get_updates", empty_get_updates) monkeypatch.setattr( app, "shutdown", call_after(app.shutdown, lambda _: events.append("shutdown")) ) @@ -1647,6 +1641,7 @@ async def post_shutdown(app: Application) -> None: "shutdown", call_after(app.updater.shutdown, lambda _: events.append("updater.shutdown")), ) + monkeypatch.setattr(app.bot, "delete_webhook", return_true) thread = Thread(target=thread_target) thread.start() @@ -1665,11 +1660,6 @@ async def post_shutdown(app: Application) -> None: def test_run_polling_post_stop(self, one_time_bot, monkeypatch): events = [] - async def get_updates(*args, **kwargs): - # This makes sure that other coroutines have a chance of running as well - await asyncio.sleep(0) - return [] - def thread_target(): waited = 0 while not app.running: @@ -1691,7 +1681,7 @@ async def post_stop(app: Application) -> None: .build() ) app.bot._unfreeze() - monkeypatch.setattr(app.bot, "get_updates", get_updates) + monkeypatch.setattr(app.bot, "get_updates", empty_get_updates) monkeypatch.setattr(app, "stop", call_after(app.stop, lambda _: events.append("stop"))) monkeypatch.setattr( app.updater, @@ -1703,6 +1693,7 @@ async def post_stop(app: Application) -> None: "shutdown", call_after(app.updater.shutdown, lambda _: events.append("updater.shutdown")), ) + monkeypatch.setattr(app.bot, "delete_webhook", return_true) thread = Thread(target=thread_target) thread.start() @@ -1784,12 +1775,6 @@ def thread_target(): def test_run_webhook_basic(self, app, monkeypatch, caplog): assertions = {} - async def delete_webhook(*args, **kwargs): - return True - - async def set_webhook(*args, **kwargs): - return True - def thread_target(): waited = 0 while not app.running: @@ -1820,8 +1805,6 @@ def thread_target(): assertions["updater_not_running"] = not app.updater.running assertions["job_queue_not_running"] = not app.job_queue.scheduler.running - monkeypatch.setattr(app.bot, "set_webhook", set_webhook) - monkeypatch.setattr(app.bot, "delete_webhook", delete_webhook) app.add_handler(TypeHandler(object, self.callback_set_count(42))) thread = Thread(target=thread_target) @@ -1857,17 +1840,6 @@ def thread_target(): def test_run_webhook_post_init(self, one_time_bot, monkeypatch): events = [] - async def delete_webhook(*args, **kwargs): - return True - - async def set_webhook(*args, **kwargs): - return True - - async def get_updates(*args, **kwargs): - # This makes sure that other coroutines have a chance of running as well - await asyncio.sleep(0) - return [] - def thread_target(): waited = 0 while not app.running: @@ -1889,8 +1861,7 @@ async def post_init(app: Application) -> None: .build() ) app.bot._unfreeze() - monkeypatch.setattr(app.bot, "set_webhook", set_webhook) - monkeypatch.setattr(app.bot, "delete_webhook", delete_webhook) + monkeypatch.setattr( app, "initialize", call_after(app.initialize, lambda _: events.append("init")) ) @@ -1899,6 +1870,8 @@ async def post_init(app: Application) -> None: "start_webhook", call_after(app.updater.start_webhook, lambda _: events.append("start_webhook")), ) + monkeypatch.setattr(app.bot, "delete_webhook", return_true) + monkeypatch.setattr(app.bot, "set_webhook", return_true) thread = Thread(target=thread_target) thread.start() @@ -1923,17 +1896,6 @@ async def post_init(app: Application) -> None: def test_run_webhook_post_shutdown(self, one_time_bot, monkeypatch): events = [] - async def delete_webhook(*args, **kwargs): - return True - - async def set_webhook(*args, **kwargs): - return True - - async def get_updates(*args, **kwargs): - # This makes sure that other coroutines have a chance of running as well - await asyncio.sleep(0) - return [] - def thread_target(): waited = 0 while not app.running: @@ -1955,8 +1917,7 @@ async def post_shutdown(app: Application) -> None: .build() ) app.bot._unfreeze() - monkeypatch.setattr(app.bot, "set_webhook", set_webhook) - monkeypatch.setattr(app.bot, "delete_webhook", delete_webhook) + monkeypatch.setattr( app, "shutdown", call_after(app.shutdown, lambda _: events.append("shutdown")) ) @@ -1965,6 +1926,8 @@ async def post_shutdown(app: Application) -> None: "shutdown", call_after(app.updater.shutdown, lambda _: events.append("updater.shutdown")), ) + monkeypatch.setattr(app.bot, "delete_webhook", return_true) + monkeypatch.setattr(app.bot, "set_webhook", return_true) thread = Thread(target=thread_target) thread.start() @@ -1993,17 +1956,6 @@ async def post_shutdown(app: Application) -> None: def test_run_webhook_post_stop(self, one_time_bot, monkeypatch): events = [] - async def delete_webhook(*args, **kwargs): - return True - - async def set_webhook(*args, **kwargs): - return True - - async def get_updates(*args, **kwargs): - # This makes sure that other coroutines have a chance of running as well - await asyncio.sleep(0) - return [] - def thread_target(): waited = 0 while not app.running: @@ -2025,8 +1977,7 @@ async def post_stop(app: Application) -> None: .build() ) app.bot._unfreeze() - monkeypatch.setattr(app.bot, "set_webhook", set_webhook) - monkeypatch.setattr(app.bot, "delete_webhook", delete_webhook) + monkeypatch.setattr(app, "stop", call_after(app.stop, lambda _: events.append("stop"))) monkeypatch.setattr( app.updater, @@ -2038,6 +1989,8 @@ async def post_stop(app: Application) -> None: "shutdown", call_after(app.updater.shutdown, lambda _: events.append("updater.shutdown")), ) + monkeypatch.setattr(app.bot, "delete_webhook", return_true) + monkeypatch.setattr(app.bot, "set_webhook", return_true) thread = Thread(target=thread_target) thread.start() @@ -2217,10 +2170,6 @@ async def update_logger_callback(update, context): async def callback(*args, **kwargs): called_callbacks.add(kwargs["name"]) - async def get_updates(*args, **kwargs): - await asyncio.sleep(0) - return [] - for cls, method, entry in [ (Application, "initialize", "app_initialize"), (Application, "start", "app_start"), @@ -2249,7 +2198,8 @@ def after(_, name): .post_shutdown(functools.partial(callback, name="post_shutdown")) .build() ) - monkeypatch.setattr(app.bot, "get_updates", get_updates) + monkeypatch.setattr(app.bot, "get_updates", empty_get_updates) + monkeypatch.setattr(app.bot, "delete_webhook", return_true) app.add_handler(TypeHandler(object, update_logger_callback), group=-10) app.add_handler(TypeHandler(object, handler_callback)) @@ -2322,6 +2272,9 @@ def _after_shutdown(*args, **kwargs): Updater, "shutdown", call_after(Updater.shutdown, after_shutdown("updater")) ) app = ApplicationBuilder().bot(one_time_bot).build() + monkeypatch.setattr(app.bot, "delete_webhook", return_true) + monkeypatch.setattr(app.bot, "get_updates", empty_get_updates) + with pytest.raises(RuntimeError, match="Test Exception"): app.run_polling(close_loop=False) @@ -2418,7 +2371,9 @@ def signal_handler_test(*args, **kwargs): received_signals.append(args[0]) loop = asyncio.get_event_loop() + monkeypatch.setattr(loop, "add_signal_handler", signal_handler_test) + monkeypatch.setattr(app.bot, "get_updates", empty_get_updates) def abort_app(): raise SystemExit @@ -2496,16 +2451,6 @@ def test_stop_running(self, one_time_bot, monkeypatch, method): called_stop_running = threading.Event() assertions = {} - async def get_updates(*args, **kwargs): - await asyncio.sleep(0) - return [] - - async def delete_webhook(*args, **kwargs): - return True - - async def set_webhook(*args, **kwargs): - return True - async def post_init(app): # Simply calling app.update_queue.put_nowait(method) in the thread_target doesn't work # for some reason (probably threading magic), so we use an event from the thread_target @@ -2523,9 +2468,7 @@ async def task(app): .post_init(post_init) .build() ) - monkeypatch.setattr(app.bot, "get_updates", get_updates) - monkeypatch.setattr(app.bot, "set_webhook", set_webhook) - monkeypatch.setattr(app.bot, "delete_webhook", delete_webhook) + monkeypatch.setattr(app.bot, "get_updates", empty_get_updates) events = [] monkeypatch.setattr( @@ -2543,6 +2486,8 @@ async def task(app): "shutdown", call_after(app.shutdown, lambda _: events.append("app.shutdown")), ) + monkeypatch.setattr(app.bot, "set_webhook", return_true) + monkeypatch.setattr(app.bot, "delete_webhook", return_true) def thread_target(): waited = 0 diff --git a/tests/ext/test_applicationbuilder.py b/tests/ext/test_applicationbuilder.py index 9fcbc140141..235a80f682d 100644 --- a/tests/ext/test_applicationbuilder.py +++ b/tests/ext/test_applicationbuilder.py @@ -48,7 +48,7 @@ from tests.auxil.slots import mro_slots -@pytest.fixture() +@pytest.fixture def builder(): return ApplicationBuilder() @@ -74,7 +74,7 @@ def test_all_methods_request(self, builder, get_updates): arguments = inspect.signature(HTTPXRequest.__init__).parameters.keys() prefix = "get_updates_" if get_updates else "" for argument in arguments: - if argument == "self": + if argument in ("self", "httpx_kwargs"): continue if argument == "media_write_timeout" and get_updates: # get_updates never makes media requests diff --git a/tests/ext/test_basepersistence.py b/tests/ext/test_basepersistence.py index fb61e79bb55..c04a5d16826 100644 --- a/tests/ext/test_basepersistence.py +++ b/tests/ext/test_basepersistence.py @@ -24,6 +24,7 @@ import logging import sys import time +from http import HTTPStatus from pathlib import Path from typing import NamedTuple, Optional @@ -43,8 +44,9 @@ PersistenceInput, filters, ) +from telegram.request import HTTPXRequest from telegram.warnings import PTBUserWarning -from tests.auxil.build_messages import make_message_update +from tests.auxil.build_messages import make_message, make_message_update from tests.auxil.pytest_classes import PytestApplication, make_bot from tests.auxil.slots import mro_slots @@ -245,9 +247,9 @@ def build_papp( persistence = TrackingPersistence(store_data=store_data, fill_data=fill_data) if bot_info is not None: - bot = make_bot(bot_info, arbitrary_callback_data=True) + bot = make_bot(bot_info, arbitrary_callback_data=True, offline=False) else: - bot = make_bot(token=token, arbitrary_callback_data=True) + bot = make_bot(token=token, arbitrary_callback_data=True, offline=False) return ( ApplicationBuilder() .bot(bot) @@ -261,8 +263,8 @@ def build_conversation_handler(name: str, persistent: bool = True) -> BaseHandle return TrackingConversationHandler(name=name, persistent=persistent) -@pytest.fixture() -def papp(request, bot_info) -> Application: +@pytest.fixture +def papp(request, bot_info, monkeypatch) -> Application: papp_input = request.param store_data = {} if papp_input.bot_data is not None: @@ -274,6 +276,11 @@ def papp(request, bot_info) -> Application: if papp_input.callback_data is not None: store_data["callback_data"] = papp_input.callback_data + async def do_request(*args, **kwargs): + return HTTPStatus.OK, make_message(text="text") + + monkeypatch.setattr(HTTPXRequest, "do_request", do_request) + app = build_papp( bot_info=bot_info, store_data=store_data, diff --git a/tests/ext/test_baseupdateprocessor.py b/tests/ext/test_baseupdateprocessor.py index de36ea4aa38..c30e6417cad 100644 --- a/tests/ext/test_baseupdateprocessor.py +++ b/tests/ext/test_baseupdateprocessor.py @@ -28,7 +28,7 @@ from tests.auxil.slots import mro_slots -@pytest.fixture() +@pytest.fixture def mock_processor(): class MockProcessor(SimpleUpdateProcessor): test_flag = False diff --git a/tests/ext/test_businessconnectionhandler.py b/tests/ext/test_businessconnectionhandler.py index c8d741332a4..ec0c0e09cf5 100644 --- a/tests/ext/test_businessconnectionhandler.py +++ b/tests/ext/test_businessconnectionhandler.py @@ -17,7 +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 +import datetime as dtm import pytest @@ -71,7 +71,7 @@ def false_update(request): @pytest.fixture(scope="class") def time(): - return datetime.datetime.now(tz=UTC) + return dtm.datetime.now(tz=UTC) @pytest.fixture(scope="class") @@ -80,7 +80,7 @@ def business_connection(bot): id="1", user_chat_id=1, user=User(1, "name", username="user_a", is_bot=False), - date=datetime.datetime.now(tz=UTC), + date=dtm.datetime.now(tz=UTC), can_reply=True, is_enabled=True, ) @@ -88,7 +88,7 @@ def business_connection(bot): return bc -@pytest.fixture() +@pytest.fixture def business_connection_update(bot, business_connection): return Update(0, business_connection=business_connection) diff --git a/tests/ext/test_businessmessagesdeletedhandler.py b/tests/ext/test_businessmessagesdeletedhandler.py index a15a0a0c2b4..60501365780 100644 --- a/tests/ext/test_businessmessagesdeletedhandler.py +++ b/tests/ext/test_businessmessagesdeletedhandler.py @@ -17,7 +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 +import datetime as dtm import pytest @@ -71,7 +71,7 @@ def false_update(request): @pytest.fixture(scope="class") def time(): - return datetime.datetime.now(tz=UTC) + return dtm.datetime.now(tz=UTC) @pytest.fixture(scope="class") @@ -85,7 +85,7 @@ def business_messages_deleted(bot): return bmd -@pytest.fixture() +@pytest.fixture def business_messages_deleted_update(bot, business_messages_deleted): return Update(0, deleted_business_messages=business_messages_deleted) diff --git a/tests/ext/test_callbackcontext.py b/tests/ext/test_callbackcontext.py index 0a099f64f15..429d28a6ff6 100644 --- a/tests/ext/test_callbackcontext.py +++ b/tests/ext/test_callbackcontext.py @@ -20,7 +20,6 @@ import pytest from telegram import ( - Bot, CallbackQuery, Chat, InlineKeyboardButton, @@ -194,8 +193,7 @@ def test_application_attribute(self, app): callback_context = CallbackContext(app) assert callback_context.application is app - def test_drop_callback_data_exception(self, bot, app): - non_ext_bot = Bot(bot.token) + def test_drop_callback_data_exception(self, bot, app, raw_bot): update = Update( 0, message=Message(0, None, Chat(1, "chat"), from_user=User(1, "user", False)) ) @@ -206,14 +204,14 @@ def test_drop_callback_data_exception(self, bot, app): callback_context.drop_callback_data(None) try: - app.bot = non_ext_bot + app.bot = raw_bot with pytest.raises(RuntimeError, match="telegram.Bot does not allow for"): callback_context.drop_callback_data(None) finally: app.bot = bot async def test_drop_callback_data(self, bot, chat_id): - new_bot = make_bot(token=bot.token, arbitrary_callback_data=True) + new_bot = make_bot(token=bot.token, arbitrary_callback_data=True, offline=False) app = ApplicationBuilder().bot(new_bot).build() update = Update( diff --git a/tests/ext/test_callbackdatacache.py b/tests/ext/test_callbackdatacache.py index be7fbace0a5..811d7091d60 100644 --- a/tests/ext/test_callbackdatacache.py +++ b/tests/ext/test_callbackdatacache.py @@ -16,9 +16,9 @@ # # 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 time from copy import deepcopy -from datetime import datetime from uuid import uuid4 import pytest @@ -31,7 +31,7 @@ from tests.auxil.slots import mro_slots -@pytest.fixture() +@pytest.fixture def callback_data_cache(bot): return CallbackDataCache(bot) @@ -181,7 +181,9 @@ def test_process_callback_query(self, callback_data_cache, data, message, invali callback_data_cache.clear_callback_data() chat = Chat(1, "private") - effective_message = Message(message_id=1, date=datetime.now(), chat=chat, reply_markup=out) + effective_message = Message( + message_id=1, date=dtm.datetime.now(), chat=chat, reply_markup=out + ) effective_message._unfreeze() effective_message.reply_to_message = deepcopy(effective_message) effective_message.pinned_message = deepcopy(effective_message) @@ -374,9 +376,9 @@ def test_clear_cutoff(self, callback_data_cache, time_method, tz_bot): if time_method == "time": cutoff = time.time() elif time_method == "datetime": - cutoff = datetime.now(UTC) + cutoff = dtm.datetime.now(UTC) else: - cutoff = datetime.now(tz_bot.defaults.tzinfo).replace(tzinfo=None) + cutoff = dtm.datetime.now(tz_bot.defaults.tzinfo).replace(tzinfo=None) callback_data_cache.bot = tz_bot time.sleep(0.1) diff --git a/tests/ext/test_callbackqueryhandler.py b/tests/ext/test_callbackqueryhandler.py index f96c074d2d1..c1dccd8df6b 100644 --- a/tests/ext/test_callbackqueryhandler.py +++ b/tests/ext/test_callbackqueryhandler.py @@ -65,7 +65,7 @@ def false_update(request): return Update(update_id=2, **request.param) -@pytest.fixture() +@pytest.fixture def callback_query(bot): update = Update(0, callback_query=CallbackQuery(2, User(1, "", False), None, data="test data")) update._unfreeze() diff --git a/tests/ext/test_chatjoinrequesthandler.py b/tests/ext/test_chatjoinrequesthandler.py index 3d2e38f4483..bba016a335a 100644 --- a/tests/ext/test_chatjoinrequesthandler.py +++ b/tests/ext/test_chatjoinrequesthandler.py @@ -17,7 +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 +import datetime as dtm import pytest @@ -72,7 +72,7 @@ def false_update(request): @pytest.fixture(scope="class") def time(): - return datetime.datetime.now(tz=UTC) + return dtm.datetime.now(tz=UTC) @pytest.fixture(scope="class") @@ -96,7 +96,7 @@ def chat_join_request(time, bot): return cjr -@pytest.fixture() +@pytest.fixture def chat_join_request_update(bot, chat_join_request): return Update(0, chat_join_request=chat_join_request) diff --git a/tests/ext/test_chatmemberhandler.py b/tests/ext/test_chatmemberhandler.py index ada95288cfc..9f4705b594f 100644 --- a/tests/ext/test_chatmemberhandler.py +++ b/tests/ext/test_chatmemberhandler.py @@ -81,7 +81,7 @@ def chat_member_updated(): ) -@pytest.fixture() +@pytest.fixture def chat_member(bot, chat_member_updated): update = Update(0, my_chat_member=chat_member_updated) update._unfreeze() diff --git a/tests/ext/test_contexttypes.py b/tests/ext/test_contexttypes.py index afe73bb21d4..c1d488076ab 100644 --- a/tests/ext/test_contexttypes.py +++ b/tests/ext/test_contexttypes.py @@ -40,7 +40,7 @@ def test_data_init(self): assert ct.chat_data is float assert ct.user_data is bool - with pytest.raises(ValueError, match="subclass of CallbackContext"): + with pytest.raises(TypeError, match="subclass of CallbackContext"): ContextTypes(context=bool) def test_data_assignment(self): diff --git a/tests/ext/test_dictpersistence.py b/tests/ext/test_dictpersistence.py index ecd004858a4..0b725826c08 100644 --- a/tests/ext/test_dictpersistence.py +++ b/tests/ext/test_dictpersistence.py @@ -31,27 +31,27 @@ def _reset_callback_data_cache(cdc_bot): cdc_bot.callback_data_cache.clear_callback_queries() -@pytest.fixture() +@pytest.fixture def bot_data(): return {"test1": "test2", "test3": {"test4": "test5"}} -@pytest.fixture() +@pytest.fixture def chat_data(): return {-12345: {"test1": "test2", "test3": {"test4": "test5"}}, -67890: {3: "test4"}} -@pytest.fixture() +@pytest.fixture def user_data(): return {12345: {"test1": "test2", "test3": {"test4": "test5"}}, 67890: {3: "test4"}} -@pytest.fixture() +@pytest.fixture def callback_data(): return [("test1", 1000, {"button1": "test0", "button2": "test1"})], {"test1": "test2"} -@pytest.fixture() +@pytest.fixture def conversations(): return { "name1": {(123, 123): 3, (456, 654): 4}, @@ -60,27 +60,27 @@ def conversations(): } -@pytest.fixture() +@pytest.fixture def user_data_json(user_data): return json.dumps(user_data) -@pytest.fixture() +@pytest.fixture def chat_data_json(chat_data): return json.dumps(chat_data) -@pytest.fixture() +@pytest.fixture def bot_data_json(bot_data): return json.dumps(bot_data) -@pytest.fixture() +@pytest.fixture def callback_data_json(callback_data): return json.dumps(callback_data) -@pytest.fixture() +@pytest.fixture def conversations_json(conversations): return """{"name1": {"[123, 123]": 3, "[456, 654]": 4}, "name2": {"[123, 321]": 1, "[890, 890]": 2}, "name3": diff --git a/tests/ext/test_filters.py b/tests/ext/test_filters.py index 9cf47dc47fa..8206c6c8e2f 100644 --- a/tests/ext/test_filters.py +++ b/tests/ext/test_filters.py @@ -16,7 +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 +import datetime as dtm import inspect import re @@ -43,20 +43,18 @@ from tests.auxil.slots import mro_slots -@pytest.fixture() +@pytest.fixture def update(): update = Update( 0, Message( 0, - datetime.datetime.utcnow(), + dtm.datetime.utcnow(), Chat(0, "private"), from_user=User(0, "Testuser", False), via_bot=User(0, "Testbot", True), sender_chat=Chat(0, "Channel"), - forward_origin=MessageOriginUser( - datetime.datetime.utcnow(), User(0, "Testuser", False) - ), + forward_origin=MessageOriginUser(dtm.datetime.utcnow(), User(0, "Testuser", False)), ), ) update._unfreeze() @@ -86,7 +84,7 @@ def base_class(request): @pytest.fixture(scope="class") def message_origin_user(): - return MessageOriginUser(datetime.datetime.utcnow(), User(1, "TestOther", False)) + return MessageOriginUser(dtm.datetime.utcnow(), User(1, "TestOther", False)) class TestFilters: @@ -103,7 +101,7 @@ def filter_class(obj): # The total no. of filters is about 72 as of 31/10/21. # Gather all the filters to test using DFS- visited = [] - classes = inspect.getmembers(filters, predicate=filter_class) # List[Tuple[str, type]] + classes = inspect.getmembers(filters, predicate=filter_class) # list[tuple[str, type]] stack = classes.copy() while stack: cls = stack[-1][-1] # get last element and its class @@ -155,7 +153,7 @@ def test__all__(self): not key.startswith("_") # exclude imported stuff and getattr(member, "__module__", "unknown module") == "telegram.ext.filters" - and key != "sys" + and key not in ("sys", "dtm") ) } actual = set(filters.__all__) @@ -616,7 +614,7 @@ def test_caption_regex_inverted(self, update): def test_filters_reply(self, update): another_message = Message( 1, - datetime.datetime.utcnow(), + dtm.datetime.utcnow(), Chat(0, "private"), from_user=User(1, "TestOther", False), ) @@ -1107,7 +1105,7 @@ def test_filters_status_update(self, update): def test_filters_forwarded(self, update, message_origin_user): assert filters.FORWARDED.check_update(update) - update.message.forward_origin = MessageOriginHiddenUser(datetime.datetime.utcnow(), 1) + update.message.forward_origin = MessageOriginHiddenUser(dtm.datetime.utcnow(), 1) assert filters.FORWARDED.check_update(update) update.message.forward_origin = None assert not filters.FORWARDED.check_update(update) @@ -2681,7 +2679,7 @@ def test_filters_attachment(self, update): 0, Message( 0, - datetime.datetime.utcnow(), + dtm.datetime.utcnow(), Chat(0, "private"), document=Document("str", "other_str"), ), diff --git a/tests/_inline/test_inlinequeryhandler.py b/tests/ext/test_inlinequeryhandler.py similarity index 99% rename from tests/_inline/test_inlinequeryhandler.py rename to tests/ext/test_inlinequeryhandler.py index 556cea46492..58431e59ebb 100644 --- a/tests/_inline/test_inlinequeryhandler.py +++ b/tests/ext/test_inlinequeryhandler.py @@ -68,7 +68,7 @@ def false_update(request): return Update(update_id=2, **request.param) -@pytest.fixture() +@pytest.fixture def inline_query(bot): update = Update( 0, diff --git a/tests/ext/test_jobqueue.py b/tests/ext/test_jobqueue.py index 929591d38b9..5ca908d4a02 100644 --- a/tests/ext/test_jobqueue.py +++ b/tests/ext/test_jobqueue.py @@ -35,16 +35,14 @@ UTC = pytz.utc else: - import datetime - - UTC = datetime.timezone.utc + UTC = dtm.timezone.utc class CustomContext(CallbackContext): pass -@pytest.fixture() +@pytest.fixture async def job_queue(app): jq = JobQueue() jq.set_application(app) diff --git a/tests/ext/test_messagereactionhandler.py b/tests/ext/test_messagereactionhandler.py index 8f4172c9e34..aaaecf55164 100644 --- a/tests/ext/test_messagereactionhandler.py +++ b/tests/ext/test_messagereactionhandler.py @@ -17,7 +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 +import datetime as dtm import pytest @@ -74,7 +74,7 @@ def false_update(request): @pytest.fixture(scope="class") def time(): - return datetime.datetime.now(tz=UTC) + return dtm.datetime.now(tz=UTC) @pytest.fixture(scope="class") @@ -112,12 +112,12 @@ def message_reaction_count_updated(time, bot): return mr -@pytest.fixture() +@pytest.fixture def message_reaction_update(bot, message_reaction_updated): return Update(0, message_reaction=message_reaction_updated) -@pytest.fixture() +@pytest.fixture def message_reaction_count_update(bot, message_reaction_count_updated): return Update(0, message_reaction_count=message_reaction_count_updated) diff --git a/tests/ext/test_paidmediapurchasedhandler.py b/tests/ext/test_paidmediapurchasedhandler.py new file mode 100644 index 00000000000..7ac62a74e3e --- /dev/null +++ b/tests/ext/test_paidmediapurchasedhandler.py @@ -0,0 +1,169 @@ +#!/usr/bin/env python +# +# A library that provides a Python interface to the Telegram Bot API +# Copyright (C) 2015-2024 +# Leandro Toledo de Souza +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser Public License for more details. +# +# You should have received a copy of the GNU Lesser Public License +# along with this program. If not, see [http://www.gnu.org/licenses/]. +import asyncio +import datetime as dtm + +import pytest + +from telegram import ( + Bot, + CallbackQuery, + Chat, + ChosenInlineResult, + Message, + PaidMediaPurchased, + PreCheckoutQuery, + ShippingQuery, + Update, + User, +) +from telegram._utils.datetime import UTC +from telegram.ext import CallbackContext, JobQueue, PaidMediaPurchasedHandler +from tests.auxil.slots import mro_slots + +message = Message(1, None, Chat(1, ""), from_user=User(1, "", False), text="Text") + +params = [ + {"message": message}, + {"edited_message": message}, + {"callback_query": CallbackQuery(1, User(1, "", False), "chat", message=message)}, + {"channel_post": message}, + {"edited_channel_post": message}, + {"chosen_inline_result": ChosenInlineResult("id", User(1, "", False), "")}, + {"shipping_query": ShippingQuery("id", User(1, "", False), "", None)}, + {"pre_checkout_query": PreCheckoutQuery("id", User(1, "", False), "", 0, "")}, + {"callback_query": CallbackQuery(1, User(1, "", False), "chat")}, +] + +ids = ( + "message", + "edited_message", + "callback_query", + "channel_post", + "edited_channel_post", + "chosen_inline_result", + "shipping_query", + "pre_checkout_query", + "callback_query_without_message", +) + + +@pytest.fixture(scope="class", params=params, ids=ids) +def false_update(request): + return Update(update_id=2, **request.param) + + +@pytest.fixture(scope="class") +def time(): + return dtm.datetime.now(tz=UTC) + + +@pytest.fixture(scope="class") +def purchased_paid_media(bot): + bc = PaidMediaPurchased( + from_user=User(1, "name", username="user_a", is_bot=False), + paid_media_payload="payload", + ) + bc.set_bot(bot) + return bc + + +@pytest.fixture +def purchased_paid_media_update(bot, purchased_paid_media): + return Update(0, purchased_paid_media=purchased_paid_media) + + +class TestPaidMediaPurchasedHandler: + test_flag = False + + def test_slot_behaviour(self): + action = PaidMediaPurchasedHandler(self.callback) + for attr in action.__slots__: + assert getattr(action, attr, "err") != "err", f"got extra slot '{attr}'" + assert len(mro_slots(action)) == len(set(mro_slots(action))), "duplicate slot" + + @pytest.fixture(autouse=True) + def _reset(self): + self.test_flag = False + + async def callback(self, update, context): + self.test_flag = ( + isinstance(context, CallbackContext) + and isinstance(context.bot, Bot) + and isinstance(update, Update) + and isinstance(context.update_queue, asyncio.Queue) + and isinstance(context.job_queue, JobQueue) + and isinstance(context.user_data, dict) + and isinstance(context.bot_data, dict) + and isinstance( + update.purchased_paid_media, + PaidMediaPurchased, + ) + ) + + def test_with_user_id(self, purchased_paid_media_update): + handler = PaidMediaPurchasedHandler(self.callback, user_id=1) + assert handler.check_update(purchased_paid_media_update) + handler = PaidMediaPurchasedHandler(self.callback, user_id=[1]) + assert handler.check_update(purchased_paid_media_update) + handler = PaidMediaPurchasedHandler(self.callback, user_id=2, username="@user_a") + assert handler.check_update(purchased_paid_media_update) + + handler = PaidMediaPurchasedHandler(self.callback, user_id=2) + assert not handler.check_update(purchased_paid_media_update) + handler = PaidMediaPurchasedHandler(self.callback, user_id=[2]) + assert not handler.check_update(purchased_paid_media_update) + + def test_with_username(self, purchased_paid_media_update): + handler = PaidMediaPurchasedHandler(self.callback, username="user_a") + assert handler.check_update(purchased_paid_media_update) + handler = PaidMediaPurchasedHandler(self.callback, username="@user_a") + assert handler.check_update(purchased_paid_media_update) + handler = PaidMediaPurchasedHandler(self.callback, username=["user_a"]) + assert handler.check_update(purchased_paid_media_update) + handler = PaidMediaPurchasedHandler(self.callback, username=["@user_a"]) + assert handler.check_update(purchased_paid_media_update) + handler = PaidMediaPurchasedHandler(self.callback, user_id=1, username="@user_b") + assert handler.check_update(purchased_paid_media_update) + + handler = PaidMediaPurchasedHandler(self.callback, username="user_b") + assert not handler.check_update(purchased_paid_media_update) + handler = PaidMediaPurchasedHandler(self.callback, username="@user_b") + assert not handler.check_update(purchased_paid_media_update) + handler = PaidMediaPurchasedHandler(self.callback, username=["user_b"]) + assert not handler.check_update(purchased_paid_media_update) + handler = PaidMediaPurchasedHandler(self.callback, username=["@user_b"]) + assert not handler.check_update(purchased_paid_media_update) + + purchased_paid_media_update.purchased_paid_media.from_user._unfreeze() + purchased_paid_media_update.purchased_paid_media.from_user.username = None + assert not handler.check_update(purchased_paid_media_update) + + def test_other_update_types(self, false_update): + handler = PaidMediaPurchasedHandler(self.callback) + assert not handler.check_update(false_update) + assert not handler.check_update(True) + + async def test_context(self, app, purchased_paid_media_update): + handler = PaidMediaPurchasedHandler(callback=self.callback) + app.add_handler(handler) + + async with app: + await app.process_update(purchased_paid_media_update) + assert self.test_flag diff --git a/tests/ext/test_picklepersistence.py b/tests/ext/test_picklepersistence.py index 86a26eeb3ba..83477753de8 100644 --- a/tests/ext/test_picklepersistence.py +++ b/tests/ext/test_picklepersistence.py @@ -16,7 +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 +import datetime as dtm import gzip import os import pickle @@ -50,27 +50,27 @@ def _reset_callback_data_cache(cdc_bot): cdc_bot.callback_data_cache.clear_callback_queries() -@pytest.fixture() +@pytest.fixture def bot_data(): return {"test1": "test2", "test3": {"test4": "test5"}} -@pytest.fixture() +@pytest.fixture def chat_data(): return {-12345: {"test1": "test2", "test3": {"test4": "test5"}}, -67890: {3: "test4"}} -@pytest.fixture() +@pytest.fixture def user_data(): return {12345: {"test1": "test2", "test3": {"test4": "test5"}}, 67890: {3: "test4"}} -@pytest.fixture() +@pytest.fixture def callback_data(): return [("test1", 1000, {"button1": "test0", "button2": "test1"})], {"test1": "test2"} -@pytest.fixture() +@pytest.fixture def conversations(): return { "name1": {(123, 123): 3, (456, 654): 4}, @@ -79,7 +79,7 @@ def conversations(): } -@pytest.fixture() +@pytest.fixture def pickle_persistence(): return PicklePersistence( filepath="pickletest", @@ -88,7 +88,7 @@ def pickle_persistence(): ) -@pytest.fixture() +@pytest.fixture def pickle_persistence_only_bot(): return PicklePersistence( filepath="pickletest", @@ -98,7 +98,7 @@ def pickle_persistence_only_bot(): ) -@pytest.fixture() +@pytest.fixture def pickle_persistence_only_chat(): return PicklePersistence( filepath="pickletest", @@ -108,7 +108,7 @@ def pickle_persistence_only_chat(): ) -@pytest.fixture() +@pytest.fixture def pickle_persistence_only_user(): return PicklePersistence( filepath="pickletest", @@ -118,7 +118,7 @@ def pickle_persistence_only_user(): ) -@pytest.fixture() +@pytest.fixture def pickle_persistence_only_callback(): return PicklePersistence( filepath="pickletest", @@ -128,7 +128,7 @@ def pickle_persistence_only_callback(): ) -@pytest.fixture() +@pytest.fixture def bad_pickle_files(): for name in [ "pickletest_user_data", @@ -142,7 +142,7 @@ def bad_pickle_files(): return True -@pytest.fixture() +@pytest.fixture def invalid_pickle_files(): for name in [ "pickletest_user_data", @@ -159,7 +159,7 @@ def invalid_pickle_files(): return True -@pytest.fixture() +@pytest.fixture def good_pickle_files(user_data, chat_data, bot_data, callback_data, conversations): data = { "user_data": user_data, @@ -183,7 +183,7 @@ def good_pickle_files(user_data, chat_data, bot_data, callback_data, conversatio return True -@pytest.fixture() +@pytest.fixture def pickle_files_wo_bot_data(user_data, chat_data, callback_data, conversations): data = { "user_data": user_data, @@ -204,7 +204,7 @@ def pickle_files_wo_bot_data(user_data, chat_data, callback_data, conversations) return True -@pytest.fixture() +@pytest.fixture def pickle_files_wo_callback_data(user_data, chat_data, bot_data, conversations): data = { "user_data": user_data, @@ -225,11 +225,11 @@ def pickle_files_wo_callback_data(user_data, chat_data, bot_data, conversations) return True -@pytest.fixture() +@pytest.fixture def update(bot): user = User(id=321, first_name="test_user", is_bot=False) chat = Chat(id=123, type="group") - message = Message(1, datetime.datetime.now(), chat, from_user=user, text="Hi there") + message = Message(1, dtm.datetime.now(), chat, from_user=user, text="Hi there") message.set_bot(bot) return Update(0, message=message) @@ -289,7 +289,7 @@ async def test_on_flush(self, pickle_persistence, on_flush): async def test_pickle_behaviour_with_slots(self, pickle_persistence): bot_data = await pickle_persistence.get_bot_data() - bot_data["message"] = Message(3, datetime.datetime.now(), Chat(2, type="supergroup")) + bot_data["message"] = Message(3, dtm.datetime.now(), Chat(2, type="supergroup")) await pickle_persistence.update_bot_data(bot_data) retrieved = await pickle_persistence.get_bot_data() assert retrieved == bot_data @@ -872,9 +872,12 @@ async def test_custom_pickler_unpickler_simple( "A load persistent id instruction was encountered,\nbut no persistent_load " "function was specified." ) - with Path("pickletest_chat_data").open("rb") as f, pytest.raises( - pickle.UnpicklingError, - match=err_msg if sys.version_info < (3, 12) else err_msg.replace("\n", " "), + with ( + Path("pickletest_chat_data").open("rb") as f, + pytest.raises( + pickle.UnpicklingError, + match=err_msg if sys.version_info < (3, 12) else err_msg.replace("\n", " "), + ), ): pickle.load(f) diff --git a/tests/ext/test_pollanswerhandler.py b/tests/ext/test_pollanswerhandler.py index d36b38d226e..d86b90ff1cc 100644 --- a/tests/ext/test_pollanswerhandler.py +++ b/tests/ext/test_pollanswerhandler.py @@ -67,7 +67,7 @@ def false_update(request): return Update(update_id=2, **request.param) -@pytest.fixture() +@pytest.fixture def poll_answer(bot): return Update(0, poll_answer=PollAnswer(1, [0, 1], User(2, "test user", False), Chat(1, ""))) diff --git a/tests/test_pollhandler.py b/tests/ext/test_pollhandler.py similarity index 99% rename from tests/test_pollhandler.py rename to tests/ext/test_pollhandler.py index 52b0675e15d..a87c45b28c0 100644 --- a/tests/test_pollhandler.py +++ b/tests/ext/test_pollhandler.py @@ -68,7 +68,7 @@ def false_update(request): return Update(update_id=2, **request.param) -@pytest.fixture() +@pytest.fixture def poll(bot): return Update( 0, diff --git a/tests/ext/test_prefixhandler.py b/tests/ext/test_prefixhandler.py index a42ec4e058e..f858e005228 100644 --- a/tests/ext/test_prefixhandler.py +++ b/tests/ext/test_prefixhandler.py @@ -56,15 +56,15 @@ def command(self, request): def commands(self, request): return TestPrefixHandler.COMMANDS[: request.param] - @pytest.fixture() + @pytest.fixture def prefix_message_text(self, prefix, command): return prefix + command - @pytest.fixture() + @pytest.fixture def prefix_message(self, prefix_message_text): return make_message(prefix_message_text) - @pytest.fixture() + @pytest.fixture def prefix_message_update(self, prefix_message): return make_message_update(prefix_message) diff --git a/tests/ext/test_ratelimiter.py b/tests/ext/test_ratelimiter.py index 4b0e9ed4d3f..8af1e541118 100644 --- a/tests/ext/test_ratelimiter.py +++ b/tests/ext/test_ratelimiter.py @@ -22,10 +22,10 @@ notable """ import asyncio +import datetime as dtm import json import platform import time -from datetime import datetime from http import HTTPStatus import pytest @@ -181,7 +181,7 @@ async def do_request(self, *args, **kwargs): { "ok": True, "result": Message( - message_id=1, date=datetime.now(), chat=Chat(1, "chat") + message_id=1, date=dtm.datetime.now(), chat=Chat(1, "chat") ).to_dict(), } ).encode(), diff --git a/tests/ext/test_updater.py b/tests/ext/test_updater.py index 1fd8985dea1..b2b218cc137 100644 --- a/tests/ext/test_updater.py +++ b/tests/ext/test_updater.py @@ -30,12 +30,12 @@ from telegram._utils.defaultvalue import DEFAULT_NONE from telegram.error import InvalidToken, RetryAfter, TelegramError, TimedOut from telegram.ext import ExtBot, InvalidCallbackData, Updater -from telegram.request import HTTPXRequest from tests.auxil.build_messages import make_message, make_message_update from tests.auxil.envvars import TEST_WITH_OPT_DEPS from tests.auxil.files import TEST_DATA_PATH, data_file +from tests.auxil.monkeypatch import empty_get_updates, return_true from tests.auxil.networking import send_webhook_message -from tests.auxil.pytest_classes import PytestBot, make_bot +from tests.auxil.pytest_classes import make_bot from tests.auxil.slots import mro_slots UNIX_AVAILABLE = False @@ -86,7 +86,7 @@ def _reset(self): # This is needed instead of pytest's temp_path because the file path gets too long on macOS # otherwise - @pytest.fixture() + @pytest.fixture def file_path(self) -> str: path = TEST_DATA_PATH / "test.sock" yield str(path) @@ -179,14 +179,11 @@ async def test_start_without_initialize(self, updater, method): @pytest.mark.parametrize("method", ["start_polling", "start_webhook"]) async def test_shutdown_while_running(self, updater, method, monkeypatch): - async def set_webhook(*args, **kwargs): - return True - - monkeypatch.setattr(updater.bot, "set_webhook", set_webhook) - ip = "127.0.0.1" port = randrange(1024, 49152) # Select random port + monkeypatch.setattr(updater.bot, "get_updates", empty_get_updates) + async with updater: if "webhook" in method: await getattr(updater, method)( @@ -246,13 +243,12 @@ async def get_updates(*args, **kwargs): await asyncio.sleep(0.1) return [] - orig_del_webhook = updater.bot.delete_webhook - async def delete_webhook(*args, **kwargs): # Dropping pending updates is done by passing the parameter to delete_webhook if kwargs.get("drop_pending_updates"): self.message_count += 1 - return await orig_del_webhook(*args, **kwargs) + await asyncio.sleep(0) + return True monkeypatch.setattr(updater.bot, "get_updates", get_updates) monkeypatch.setattr(updater.bot, "delete_webhook", delete_webhook) @@ -264,7 +260,6 @@ async def delete_webhook(*args, **kwargs): await updates.join() await updater.stop() assert not updater.running - assert not (await updater.bot.get_webhook_info()).url if drop_pending_updates: assert self.message_count == 1 else: @@ -281,7 +276,6 @@ async def delete_webhook(*args, **kwargs): await updates.join() await updater.stop() assert not updater.running - assert not (await updater.bot.get_webhook_info()).url self.received = [] self.message_count = 0 @@ -384,11 +378,8 @@ async def get_updates(*args, **kwargs): assert log_found async def test_polling_mark_updates_as_read_failure(self, monkeypatch, updater, caplog): - async def get_updates(*args, **kwargs): - await asyncio.sleep(0) - return [] - monkeypatch.setattr(updater.bot, "get_updates", get_updates) + monkeypatch.setattr(updater.bot, "get_updates", empty_get_updates) async with updater: await updater.start_polling() @@ -411,7 +402,10 @@ async def get_updates(*args, **kwargs): assert log_found - async def test_start_polling_already_running(self, updater): + async def test_start_polling_already_running(self, updater, monkeypatch): + + monkeypatch.setattr(updater.bot, "get_updates", empty_get_updates) + async with updater: await updater.start_polling() task = asyncio.create_task(updater.start_polling()) @@ -498,15 +492,13 @@ async def get_updates(*args, **kwargs): async def test_start_polling_bootstrap_retries( self, updater, monkeypatch, exception_class, retries ): - async def do_request(*args, **kwargs): + async def delete_webhook(*args, **kwargs): self.message_count += 1 raise exception_class(str(self.message_count)) - async with updater: - # Patch within the context so that updater.bot.initialize can still be called - # by the context manager - monkeypatch.setattr(HTTPXRequest, "do_request", do_request) + monkeypatch.setattr(updater.bot, "delete_webhook", delete_webhook) + async with updater: if exception_class == InvalidToken: with pytest.raises(InvalidToken, match="1"): await updater.start_polling(bootstrap_retries=retries) @@ -571,7 +563,7 @@ async def get_updates(*args, **kwargs): else: assert len(caplog.records) > 0 assert any( - "Error while getting Updates: TestMessage" in record.getMessage() + "Exception happened while polling for updates." in record.getMessage() and record.name == "telegram.ext.Updater" for record in caplog.records ) @@ -593,7 +585,7 @@ async def get_updates(*args, **kwargs): else: assert len(caplog.records) > 0 assert any( - "Error while getting Updates: TestMessage" in record.getMessage() + "Exception happened while polling for updates." in record.getMessage() and record.name == "telegram.ext.Updater" for record in caplog.records ) @@ -705,14 +697,23 @@ async def delete_webhook(*args, **kwargs): "unix", [None, "file_path", "socket_object"] if UNIX_AVAILABLE else [None] ) async def test_webhook_basic( - self, monkeypatch, updater, drop_pending_updates, ext_bot, secret_token, unix, file_path + self, + monkeypatch, + updater, + drop_pending_updates, + ext_bot, + secret_token, + unix, + file_path, + one_time_bot, + one_time_raw_bot, ): # Testing with both ExtBot and Bot to make sure any logic in WebhookHandler # that depends on this distinction works if ext_bot and not isinstance(updater.bot, ExtBot): - updater.bot = ExtBot(updater.bot.token) + updater.bot = one_time_bot if not ext_bot and type(updater.bot) is not Bot: - updater.bot = PytestBot(updater.bot.token) + updater.bot = one_time_raw_bot async def delete_webhook(*args, **kwargs): # Dropping pending updates is done by passing the parameter to delete_webhook @@ -720,10 +721,7 @@ async def delete_webhook(*args, **kwargs): self.message_count += 1 return True - async def set_webhook(*args, **kwargs): - return True - - monkeypatch.setattr(updater.bot, "set_webhook", set_webhook) + monkeypatch.setattr(updater.bot, "set_webhook", return_true) monkeypatch.setattr(updater.bot, "delete_webhook", delete_webhook) ip = "127.0.0.1" @@ -873,12 +871,6 @@ async def test_no_unix(self, updater): await updater.start_webhook(unix="DoesntMatter", webhook_url="TOKEN") async def test_start_webhook_already_running(self, updater, monkeypatch): - async def return_true(*args, **kwargs): - return True - - monkeypatch.setattr(updater.bot, "set_webhook", return_true) - monkeypatch.setattr(updater.bot, "delete_webhook", return_true) - ip = "127.0.0.1" port = randrange(1024, 49152) # Select random port async with updater: @@ -977,12 +969,9 @@ async def test_webhook_arbitrary_callback_data( extensively in test_bot.py in conjunction with get_updates.""" updater = Updater(bot=cdc_bot, update_queue=asyncio.Queue()) - async def return_true(*args, **kwargs): - return True + monkeypatch.setattr(updater.bot, "set_webhook", return_true) try: - monkeypatch.setattr(updater.bot, "set_webhook", return_true) - monkeypatch.setattr(updater.bot, "delete_webhook", return_true) ip = "127.0.0.1" port = randrange(1024, 49152) # Select random port @@ -1025,11 +1014,6 @@ async def return_true(*args, **kwargs): updater.bot.callback_data_cache.clear_callback_queries() async def test_webhook_invalid_ssl(self, monkeypatch, updater): - async def return_true(*args, **kwargs): - return True - - monkeypatch.setattr(updater.bot, "set_webhook", return_true) - monkeypatch.setattr(updater.bot, "delete_webhook", return_true) ip = "127.0.0.1" port = randrange(1024, 49152) # Select random port @@ -1056,9 +1040,6 @@ async def set_webhook(**kwargs): self.test_flag.append(bool(kwargs.get("certificate"))) return True - async def return_true(*args, **kwargs): - return True - orig_wh_server_init = WebhookServer.__init__ def webhook_server_init(*args, **kwargs): @@ -1066,7 +1047,7 @@ def webhook_server_init(*args, **kwargs): orig_wh_server_init(*args, **kwargs) monkeypatch.setattr(updater.bot, "set_webhook", set_webhook) - monkeypatch.setattr(updater.bot, "delete_webhook", return_true) + monkeypatch.setattr( "telegram.ext._utils.webhookhandler.WebhookServer.__init__", webhook_server_init ) @@ -1088,15 +1069,13 @@ def webhook_server_init(*args, **kwargs): async def test_start_webhook_bootstrap_retries( self, updater, monkeypatch, exception_class, retries ): - async def do_request(*args, **kwargs): + async def set_webhook(*args, **kwargs): self.message_count += 1 raise exception_class(str(self.message_count)) - async with updater: - # Patch within the context so that updater.bot.initialize can still be called - # by the context manager - monkeypatch.setattr(HTTPXRequest, "do_request", do_request) + monkeypatch.setattr(updater.bot, "set_webhook", set_webhook) + async with updater: if exception_class == InvalidToken: with pytest.raises(InvalidToken, match="1"): await updater.start_webhook(bootstrap_retries=retries) @@ -1107,11 +1086,6 @@ async def do_request(*args, **kwargs): ) async def test_webhook_invalid_posts(self, updater, monkeypatch): - async def return_true(*args, **kwargs): - return True - - monkeypatch.setattr(updater.bot, "set_webhook", return_true) - monkeypatch.setattr(updater.bot, "delete_webhook", return_true) ip = "127.0.0.1" port = randrange(1024, 49152) @@ -1146,17 +1120,9 @@ async def return_true(*args, **kwargs): await updater.stop() async def test_webhook_update_de_json_fails(self, monkeypatch, updater, caplog): - async def delete_webhook(*args, **kwargs): - return True - - async def set_webhook(*args, **kwargs): - return True - def de_json_fails(*args, **kwargs): raise TypeError("Invalid input") - monkeypatch.setattr(updater.bot, "set_webhook", set_webhook) - monkeypatch.setattr(updater.bot, "delete_webhook", delete_webhook) orig_de_json = Update.de_json monkeypatch.setattr(Update, "de_json", de_json_fails) diff --git a/tests/request/test_request.py b/tests/request/test_request.py index 0f664cbdbcf..cbb51344079 100644 --- a/tests/request/test_request.py +++ b/tests/request/test_request.py @@ -22,15 +22,18 @@ import json import logging from collections import defaultdict +from collections.abc import Coroutine from dataclasses import dataclass from http import HTTPStatus -from typing import Any, Callable, Coroutine, Tuple +from typing import Any, Callable import httpx import pytest from httpx import AsyncHTTPTransport +from telegram import InputFile from telegram._utils.defaultvalue import DEFAULT_NONE +from telegram._utils.strings import TextEncoding from telegram.error import ( BadRequest, ChatMigrated, @@ -47,6 +50,7 @@ from telegram.request._requestparameter import RequestParameter from telegram.warnings import PTBDeprecationWarning from tests.auxil.envvars import TEST_WITH_OPT_DEPS +from tests.auxil.files import data_file from tests.auxil.networking import NonchalantHttpxRequest from tests.auxil.slots import mro_slots @@ -64,14 +68,14 @@ def mocker_factory( response: bytes, return_code: int = HTTPStatus.OK -) -> Callable[[Tuple[Any]], Coroutine[Any, Any, Tuple[int, bytes]]]: +) -> Callable[[tuple[Any]], Coroutine[Any, Any, tuple[int, bytes]]]: async def make_assertion(*args, **kwargs): return return_code, response return make_assertion -@pytest.fixture() +@pytest.fixture async def httpx_request(): async with NonchalantHttpxRequest() as rq: yield rq @@ -81,7 +85,7 @@ async def httpx_request(): TEST_WITH_OPT_DEPS, reason="Only relevant if the optional dependency is not installed" ) class TestNoSocksHTTP2WithoutRequest: - async def test_init(self, bot): + async def test_init(self, offline_bot): with pytest.raises(RuntimeError, match=r"python-telegram-bot\[socks\]"): HTTPXRequest(proxy="socks5://foo") with pytest.raises(RuntimeError, match=r"python-telegram-bot\[http2\]"): @@ -131,6 +135,37 @@ def test_slot_behaviour(self): assert getattr(inst, at, "err") != "err", f"got extra slot '{at}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" + def test_httpx_kwargs(self, monkeypatch): + self.test_flag = {} + + orig_init = httpx.AsyncClient.__init__ + + class Client(httpx.AsyncClient): + def __init__(*args, **kwargs): + orig_init(*args, **kwargs) + self.test_flag["args"] = args + self.test_flag["kwargs"] = kwargs + + monkeypatch.setattr(httpx, "AsyncClient", Client) + + HTTPXRequest( + connect_timeout=1, + connection_pool_size=42, + http_version="2", + httpx_kwargs={ + "timeout": httpx.Timeout(7), + "limits": httpx.Limits(max_connections=7), + "http1": True, + "verify": False, + }, + ) + kwargs = self.test_flag["kwargs"] + + assert kwargs["timeout"].connect == 7 + assert kwargs["limits"].max_connections == 7 + assert kwargs["http1"] is True + assert kwargs["verify"] is False + async def test_context_manager(self, monkeypatch): async def initialize(): self.test_flag = ["initialize"] @@ -185,8 +220,9 @@ async def test_illegal_json_response(self, monkeypatch, httpx_request: HTTPXRequ monkeypatch.setattr(httpx_request, "do_request", mocker_factory(response=server_response)) - with pytest.raises(TelegramError, match="Invalid server response"), caplog.at_level( - logging.ERROR + with ( + pytest.raises(TelegramError, match="Invalid server response"), + caplog.at_level(logging.ERROR), ): await httpx_request.post(None, None, None) @@ -247,7 +283,7 @@ async def test_error_description(self, monkeypatch, httpx_request: HTTPXRequest, else: match = "Unknown HTTPError" - server_response = json.dumps(response_data).encode("utf-8") + server_response = json.dumps(response_data).encode(TextEncoding.UTF_8) monkeypatch.setattr( httpx_request, @@ -379,7 +415,7 @@ async def initialize(self_) -> None: async def shutdown(self_) -> None: pass - async def do_request(self_, *args, **kwargs) -> Tuple[int, bytes]: + async def do_request(self_, *args, **kwargs) -> tuple[int, bytes]: self.test_flag = ( kwargs.get("read_timeout"), kwargs.get("connect_timeout"), @@ -512,28 +548,10 @@ async def aclose(*args, **kwargs): assert self.test_flag["init"] == 1 assert self.test_flag["shutdown"] == 1 - async def test_multiple_init_cycles(self): - # nothing really to assert - this should just not fail - httpx_request = HTTPXRequest() - async with httpx_request: - await httpx_request.do_request(url="https://python-telegram-bot.org", method="GET") - async with httpx_request: - await httpx_request.do_request(url="https://python-telegram-bot.org", method="GET") - async def test_http_version_error(self): with pytest.raises(ValueError, match="`http_version` must be either"): HTTPXRequest(http_version="1.0") - async def test_http_1_response(self): - httpx_request = HTTPXRequest(http_version="1.1") - async with httpx_request: - resp = await httpx_request._client.request( - url="https://python-telegram-bot.org", - method="GET", - headers={"User-Agent": httpx_request.USER_AGENT}, - ) - assert resp.http_version == "HTTP/1.1" - async def test_do_request_after_shutdown(self, httpx_request): await httpx_request.shutdown() with pytest.raises(RuntimeError, match="not initialized"): @@ -797,6 +815,24 @@ async def test_read_timeout_property(self, read_timeout): @pytest.mark.skipif(not TEST_WITH_OPT_DEPS, reason="No need to run this twice") class TestHTTPXRequestWithRequest: + async def test_multiple_init_cycles(self): + # nothing really to assert - this should just not fail + httpx_request = HTTPXRequest() + async with httpx_request: + await httpx_request.do_request(url="https://python-telegram-bot.org", method="GET") + async with httpx_request: + await httpx_request.do_request(url="https://python-telegram-bot.org", method="GET") + + async def test_http_1_response(self): + httpx_request = HTTPXRequest(http_version="1.1") + async with httpx_request: + resp = await httpx_request._client.request( + url="https://python-telegram-bot.org", + method="GET", + headers={"User-Agent": httpx_request.USER_AGENT}, + ) + assert resp.http_version == "HTTP/1.1" + async def test_do_request_wait_for_pool(self, httpx_request): """The pool logic is buried rather deeply in httpxcore, so we make actual requests here instead of mocking""" @@ -820,3 +856,15 @@ async def test_do_request_wait_for_pool(self, httpx_request): task_2.exception() except (asyncio.CancelledError, asyncio.InvalidStateError): pass + + async def test_input_file_postponed_read(self, bot, chat_id): + """Here we test that `read_file_handle=False` is correctly handled by HTTPXRequest. + Since manually building the RequestData object has no real benefit, we simply use the Bot + for that. + """ + message = await bot.send_document( + document=InputFile(data_file("telegram.jpg").open("rb"), read_file_handle=False), + chat_id=chat_id, + ) + assert message.document + assert message.document.file_name == "telegram.jpg" diff --git a/tests/request/test_requestdata.py b/tests/request/test_requestdata.py index 3dc8ca1af97..9fa3480c1d7 100644 --- a/tests/request/test_requestdata.py +++ b/tests/request/test_requestdata.py @@ -17,7 +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 json -from typing import Any, Dict +from typing import Any from urllib.parse import quote import pytest @@ -30,7 +30,7 @@ @pytest.fixture(scope="module") -def inputfiles() -> Dict[bool, InputFile]: +def inputfiles() -> dict[bool, InputFile]: return {True: InputFile(obj="data", attach=True), False: InputFile(obj="data", attach=False)} @@ -52,7 +52,7 @@ def input_media_photo() -> InputMediaPhoto: @pytest.fixture(scope="module") -def simple_params() -> Dict[str, Any]: +def simple_params() -> dict[str, Any]: return { "string": "string", "integer": 1, @@ -62,7 +62,7 @@ def simple_params() -> Dict[str, Any]: @pytest.fixture(scope="module") -def simple_jsons() -> Dict[str, Any]: +def simple_jsons() -> dict[str, Any]: return { "string": "string", "integer": json.dumps(1), @@ -79,7 +79,7 @@ def simple_rqs(simple_params) -> RequestData: @pytest.fixture(scope="module") -def file_params(inputfiles, input_media_video, input_media_photo) -> Dict[str, Any]: +def file_params(inputfiles, input_media_video, input_media_photo) -> dict[str, Any]: return { "inputfile_attach": inputfiles[True], "inputfile_no_attach": inputfiles[False], @@ -89,7 +89,7 @@ def file_params(inputfiles, input_media_video, input_media_photo) -> Dict[str, A @pytest.fixture(scope="module") -def file_jsons(inputfiles, input_media_video, input_media_photo) -> Dict[str, Any]: +def file_jsons(inputfiles, input_media_video, input_media_photo) -> dict[str, Any]: input_media_video_dict = input_media_video.to_dict() input_media_video_dict["media"] = input_media_video.media.attach_uri input_media_video_dict["thumbnail"] = input_media_video.thumbnail.attach_uri @@ -110,14 +110,14 @@ def file_rqs(file_params) -> RequestData: @pytest.fixture(scope="module") -def mixed_params(file_params, simple_params) -> Dict[str, Any]: +def mixed_params(file_params, simple_params) -> dict[str, Any]: both = file_params.copy() both.update(simple_params) return both @pytest.fixture(scope="module") -def mixed_jsons(file_jsons, simple_jsons) -> Dict[str, Any]: +def mixed_jsons(file_jsons, simple_jsons) -> dict[str, Any]: both = file_jsons.copy() both.update(simple_jsons) return both diff --git a/tests/request/test_requestparameter.py b/tests/request/test_requestparameter.py index d7ad2088a73..bef6834bb90 100644 --- a/tests/request/test_requestparameter.py +++ b/tests/request/test_requestparameter.py @@ -16,8 +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 -from typing import Sequence +import datetime as dtm +from collections.abc import Sequence import pytest @@ -82,14 +82,14 @@ def test_multiple_multipart_data(self): ({1: 1.0}, {1: 1.0}), (ChatType.PRIVATE, "private"), (MessageEntity("type", 1, 1), {"type": "type", "offset": 1, "length": 1}), - (datetime.datetime(2019, 11, 11, 0, 26, 16, 10**5), 1573431976), + (dtm.datetime(2019, 11, 11, 0, 26, 16, 10**5), 1573431976), ( [ True, "str", MessageEntity("type", 1, 1), ChatType.PRIVATE, - datetime.datetime(2019, 11, 11, 0, 26, 16, 10**5), + dtm.datetime(2019, 11, 11, 0, 26, 16, 10**5), ], [True, "str", {"type": "type", "offset": 1, "length": 1}, "private", 1573431976], ), diff --git a/tests/test_birthdate.py b/tests/test_birthdate.py index a5e90d413f8..5dfb1e95a38 100644 --- a/tests/test_birthdate.py +++ b/tests/test_birthdate.py @@ -16,7 +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/]. -from datetime import date +import datetime as dtm import pytest @@ -24,7 +24,7 @@ from tests.auxil.slots import mro_slots -class TestBirthdateBase: +class BirthdateTestBase: day = 1 month = 1 year = 2022 @@ -32,10 +32,10 @@ class TestBirthdateBase: @pytest.fixture(scope="module") def birthdate(): - return Birthdate(TestBirthdateBase.day, TestBirthdateBase.month, TestBirthdateBase.year) + return Birthdate(BirthdateTestBase.day, BirthdateTestBase.month, BirthdateTestBase.year) -class TestBirthdateWithoutRequest(TestBirthdateBase): +class TestBirthdateWithoutRequest(BirthdateTestBase): def test_slot_behaviour(self, birthdate): for attr in birthdate.__slots__: assert getattr(birthdate, attr, "err") != "err", f"got extra slot '{attr}'" @@ -48,9 +48,9 @@ def test_to_dict(self, birthdate): assert bd_dict["month"] == self.month assert bd_dict["year"] == self.year - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = {"day": self.day, "month": self.month, "year": self.year} - bd = Birthdate.de_json(json_dict, bot) + bd = Birthdate.de_json(json_dict, offline_bot) assert isinstance(bd, Birthdate) assert bd.day == self.day assert bd.month == self.month @@ -72,10 +72,10 @@ def test_equality(self): assert hash(bd1) != hash(bd4) def test_to_date(self, birthdate): - assert isinstance(birthdate.to_date(), date) - assert birthdate.to_date() == date(self.year, self.month, self.day) + assert isinstance(birthdate.to_date(), dtm.date) + assert birthdate.to_date() == dtm.date(self.year, self.month, self.day) new_bd = birthdate.to_date(2023) - assert new_bd == date(2023, self.month, self.day) + assert new_bd == dtm.date(2023, self.month, self.day) def test_to_date_no_year(self): bd = Birthdate(1, 1) diff --git a/tests/test_bot.py b/tests/test_bot.py index 85232a8c708..7977efec36c 100644 --- a/tests/test_bot.py +++ b/tests/test_bot.py @@ -27,7 +27,6 @@ from collections import defaultdict from http import HTTPStatus from io import BytesIO -from typing import Tuple import httpx import pytest @@ -68,6 +67,7 @@ MessageEntity, Poll, PollOption, + PreparedInlineMessage, ReactionTypeCustomEmoji, ReactionTypeEmoji, ReplyParameters, @@ -90,7 +90,7 @@ ParseMode, ReactionEmoji, ) -from telegram.error import BadRequest, EndPointNotFound, InvalidToken, NetworkError +from telegram.error import BadRequest, EndPointNotFound, InvalidToken from telegram.ext import ExtBot, InvalidCallbackData from telegram.helpers import escape_markdown from telegram.request import BaseRequest, HTTPXRequest, RequestData @@ -99,25 +99,33 @@ from tests.auxil.ci_bots import FALLBACKS from tests.auxil.envvars import GITHUB_ACTION, TEST_WITH_OPT_DEPS from tests.auxil.files import data_file -from tests.auxil.networking import NonchalantHttpxRequest, expect_bad_request +from tests.auxil.networking import OfflineRequest, expect_bad_request from tests.auxil.pytest_classes import PytestBot, PytestExtBot, make_bot from tests.auxil.slots import mro_slots -from ._files.test_photo import photo_file from .auxil.build_messages import make_message -@pytest.fixture() -async def message(bot, chat_id): # mostly used in tests for edit_message - out = await bot.send_message( +@pytest.fixture +async def one_time_message(bot, chat_id): + # mostly used in tests for edit_message and hence can't be reused + return await bot.send_message( chat_id, "Text", disable_web_page_preview=True, disable_notification=True ) - out._unfreeze() - return out @pytest.fixture(scope="module") +async def static_message(bot, chat_id): + # must not be edited to keep tests independent! We only use bot.send_message so that + # we have a valid message_id to e.g. reply to + return await bot.send_message( + chat_id, "Text", disable_web_page_preview=True, disable_notification=True + ) + + +@pytest.fixture async def media_message(bot, chat_id): + # mostly used in tests for edit_message and hence can't be reused with data_file("telegram.ogg").open("rb") as f: return await bot.send_voice(chat_id, voice=f, caption="my caption", read_timeout=10) @@ -224,8 +232,8 @@ def _reset(self): self.test_flag = None @pytest.mark.parametrize("bot_class", [Bot, ExtBot]) - def test_slot_behaviour(self, bot_class, bot): - inst = bot_class(bot.token) + def test_slot_behaviour(self, bot_class, offline_bot): + inst = bot_class(offline_bot.token) for attr in inst.__slots__: assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" @@ -235,27 +243,27 @@ async def test_no_token_passed(self): Bot("") async def test_repr(self): - bot = Bot(token="some_token", base_file_url="") - assert repr(bot) == "Bot[token=some_token]" + offline_bot = Bot(token="some_token", base_file_url="") + assert repr(offline_bot) == "Bot[token=some_token]" - async def test_to_dict(self, bot): - to_dict_bot = bot.to_dict() + async def test_to_dict(self, offline_bot): + to_dict_bot = offline_bot.to_dict() assert isinstance(to_dict_bot, dict) - assert to_dict_bot["id"] == bot.id - assert to_dict_bot["username"] == bot.username - assert to_dict_bot["first_name"] == bot.first_name - if bot.last_name: - assert to_dict_bot["last_name"] == bot.last_name + assert to_dict_bot["id"] == offline_bot.id + assert to_dict_bot["username"] == offline_bot.username + assert to_dict_bot["first_name"] == offline_bot.first_name + if offline_bot.last_name: + assert to_dict_bot["last_name"] == offline_bot.last_name - async def test_initialize_and_shutdown(self, bot: PytestExtBot, monkeypatch): + async def test_initialize_and_shutdown(self, offline_bot: PytestExtBot, monkeypatch): async def initialize(*args, **kwargs): self.test_flag = ["initialize"] async def stop(*args, **kwargs): self.test_flag.append("stop") - temp_bot = PytestBot(token=bot.token, request=NonchalantHttpxRequest()) + temp_bot = PytestBot(token=offline_bot.token, request=OfflineRequest()) orig_stop = temp_bot.request.shutdown try: @@ -263,14 +271,14 @@ async def stop(*args, **kwargs): monkeypatch.setattr(temp_bot.request, "shutdown", stop) await temp_bot.initialize() assert self.test_flag == ["initialize"] - assert temp_bot.bot == bot.bot + assert temp_bot.bot == offline_bot.bot await temp_bot.shutdown() assert self.test_flag == ["initialize", "stop"] finally: await orig_stop() - async def test_multiple_inits_and_shutdowns(self, bot, monkeypatch): + async def test_multiple_inits_and_shutdowns(self, offline_bot, monkeypatch): self.received = defaultdict(int) async def initialize(*args, **kwargs): @@ -282,7 +290,7 @@ async def shutdown(*args, **kwargs): monkeypatch.setattr(HTTPXRequest, "initialize", initialize) monkeypatch.setattr(HTTPXRequest, "shutdown", shutdown) - test_bot = PytestBot(bot.token) + test_bot = PytestBot(offline_bot.token) await test_bot.initialize() await test_bot.initialize() await test_bot.initialize() @@ -290,45 +298,48 @@ async def shutdown(*args, **kwargs): await test_bot.shutdown() await test_bot.shutdown() - # 2 instead of 1 since we have to request objects for each bot + # 2 instead of 1 since we have to request objects for each offline_bot assert self.received["init"] == 2 assert self.received["shutdown"] == 2 - async def test_context_manager(self, monkeypatch, bot): + async def test_context_manager(self, monkeypatch, offline_bot): async def initialize(): self.test_flag = ["initialize"] async def shutdown(*args): self.test_flag.append("stop") - monkeypatch.setattr(bot, "initialize", initialize) - monkeypatch.setattr(bot, "shutdown", shutdown) + monkeypatch.setattr(offline_bot, "initialize", initialize) + monkeypatch.setattr(offline_bot, "shutdown", shutdown) - async with bot: + async with offline_bot: pass assert self.test_flag == ["initialize", "stop"] - async def test_context_manager_exception_on_init(self, monkeypatch, bot): + async def test_context_manager_exception_on_init(self, monkeypatch, offline_bot): async def initialize(): raise RuntimeError("initialize") async def shutdown(): self.test_flag = "stop" - monkeypatch.setattr(bot, "initialize", initialize) - monkeypatch.setattr(bot, "shutdown", shutdown) + monkeypatch.setattr(offline_bot, "initialize", initialize) + monkeypatch.setattr(offline_bot, "shutdown", shutdown) with pytest.raises(RuntimeError, match="initialize"): - async with bot: + async with offline_bot: pass assert self.test_flag == "stop" async def test_equality(self): - async with make_bot(token=FALLBACKS[0]["token"]) as a, make_bot( - token=FALLBACKS[0]["token"] - ) as b, Bot(token=FALLBACKS[0]["token"]) as c, make_bot(token=FALLBACKS[1]["token"]) as d: + async with ( + make_bot(token=FALLBACKS[0]["token"]) as a, + make_bot(token=FALLBACKS[0]["token"]) as b, + Bot(token=FALLBACKS[0]["token"]) as c, + make_bot(token=FALLBACKS[1]["token"]) as d, + ): e = Update(123456789) f = Bot(token=FALLBACKS[0]["token"]) @@ -362,43 +373,43 @@ async def test_equality(self): "link", ], ) - async def test_get_me_and_properties_not_initialized(self, bot: Bot, attribute): - bot = Bot(token=bot.token) + async def test_get_me_and_properties_not_initialized(self, attribute): + bot = make_bot(offline=True, token="randomtoken") try: with pytest.raises(RuntimeError, match="not properly initialized"): bot[attribute] finally: await bot.shutdown() - async def test_get_me_and_properties(self, bot): - get_me_bot = await ExtBot(bot.token).get_me() + async def test_get_me_and_properties(self, offline_bot): + get_me_bot = await ExtBot(offline_bot.token).get_me() assert isinstance(get_me_bot, User) - assert get_me_bot.id == bot.id - assert get_me_bot.username == bot.username - assert get_me_bot.first_name == bot.first_name - assert get_me_bot.last_name == bot.last_name - assert get_me_bot.name == bot.name - assert get_me_bot.can_join_groups == bot.can_join_groups - assert get_me_bot.can_read_all_group_messages == bot.can_read_all_group_messages - assert get_me_bot.supports_inline_queries == bot.supports_inline_queries - assert f"https://t.me/{get_me_bot.username}" == bot.link - - def test_bot_pickling_error(self, bot): + assert get_me_bot.id == offline_bot.id + assert get_me_bot.username == offline_bot.username + assert get_me_bot.first_name == offline_bot.first_name + assert get_me_bot.last_name == offline_bot.last_name + assert get_me_bot.name == offline_bot.name + assert get_me_bot.can_join_groups == offline_bot.can_join_groups + assert get_me_bot.can_read_all_group_messages == offline_bot.can_read_all_group_messages + assert get_me_bot.supports_inline_queries == offline_bot.supports_inline_queries + assert f"https://t.me/{get_me_bot.username}" == offline_bot.link + + def test_bot_pickling_error(self, offline_bot): with pytest.raises(pickle.PicklingError, match="Bot objects cannot be pickled"): - pickle.dumps(bot) + pickle.dumps(offline_bot) - def test_bot_deepcopy_error(self, bot): + def test_bot_deepcopy_error(self, offline_bot): with pytest.raises(TypeError, match="Bot objects cannot be deepcopied"): - copy.deepcopy(bot) + copy.deepcopy(offline_bot) @pytest.mark.parametrize( ("cls", "logger_name"), [(Bot, "telegram.Bot"), (ExtBot, "telegram.ext.ExtBot")] ) - async def test_bot_method_logging(self, bot: PytestExtBot, cls, logger_name, caplog): + async def test_bot_method_logging(self, offline_bot: PytestExtBot, cls, logger_name, caplog): # Second argument makes sure that we ignore logs from e.g. httpx with caplog.at_level(logging.DEBUG, logger="telegram"): - await cls(bot.token).get_me() + await cls(offline_bot.token).get_me() # Only for stabilizing this test- if len(caplog.records) == 4: for idx, record in enumerate(caplog.records): @@ -430,13 +441,13 @@ def test_camel_case_aliases(self, bot_class, bot_method_name, bot_method): @bot_methods(include_do_api_request=True) def test_coroutine_functions(self, bot_class, bot_method_name, bot_method): - """Check that all bot methods are defined as async def ...""" + """Check that all offline_bot methods are defined as async def ...""" meth = getattr(bot_method, "__wrapped__", bot_method) # to unwrap the @_log decorator assert inspect.iscoroutinefunction(meth), f"{bot_method_name} must be a coroutine function" @bot_methods(include_do_api_request=True) def test_api_kwargs_and_timeouts_present(self, bot_class, bot_method_name, bot_method): - """Check that all bot methods have `api_kwargs` and timeout params.""" + """Check that all offline_bot methods have `api_kwargs` and timeout params.""" param_names = inspect.signature(bot_method).parameters.keys() params = ("pool_timeout", "read_timeout", "connect_timeout", "write_timeout", "api_kwargs") @@ -453,11 +464,12 @@ async def test_defaults_handling( bot_class, bot_method_name: str, bot_method, - bot: PytestExtBot, + offline_bot: PytestExtBot, raw_bot: PytestBot, ): """ - Here we check that the bot methods handle tg.ext.Defaults correctly. This has two parts: + Here we check that the offline_bot methods handle tg.ext.Defaults correctly. This has two + parts: 1. Check that ExtBot actually inserts the defaults values correctly 2. Check that tg.Bot just replaces `DefaultValue(obj)` with `obj`, i.e. that it doesn't @@ -466,8 +478,8 @@ async def test_defaults_handling( As for most defaults, we can't really check the effect, we just check if we're passing the correct kwargs to - Request.post. As bot method tests a scattered across the different test files, we do - this here in one place. + Request.post. As offline_bot method tests a scattered across the different test files, we + do this here in one place. The same test is also run for all the shortcuts (Message.reply_text) etc in the corresponding tests. @@ -477,12 +489,14 @@ async def test_defaults_handling( """ # Mocking get_me within check_defaults_handling messes with the cached values like # Bot.{bot, username, id, …}` unless we return the expected User object. - return_value = bot.bot if bot_method_name.lower().replace("_", "") == "getme" else None + return_value = ( + offline_bot.bot if bot_method_name.lower().replace("_", "") == "getme" else None + ) # Check that ExtBot does the right thing - bot_method = getattr(bot, bot_method_name) + bot_method = getattr(offline_bot, bot_method_name) raw_bot_method = getattr(raw_bot, bot_method_name) - assert await check_defaults_handling(bot_method, bot, return_value=return_value) + assert await check_defaults_handling(bot_method, offline_bot, return_value=return_value) assert await check_defaults_handling(raw_bot_method, raw_bot, return_value=return_value) @pytest.mark.parametrize( @@ -523,19 +537,19 @@ def test_ext_bot_signature(self, name, method): param.kind == ext_signature.parameters[param_name].kind ), f"Wrong parameter kind for parameter {param_name} of method {name}" - async def test_unknown_kwargs(self, bot, monkeypatch): + async def test_unknown_kwargs(self, offline_bot, monkeypatch): async def post(url, request_data: RequestData, *args, **kwargs): data = request_data.json_parameters if not all([data["unknown_kwarg_1"] == "7", data["unknown_kwarg_2"] == "5"]): pytest.fail("got wrong parameters") return True - monkeypatch.setattr(bot.request, "post", post) - await bot.send_message( + monkeypatch.setattr(offline_bot.request, "post", post) + await offline_bot.send_message( 123, "text", api_kwargs={"unknown_kwarg_1": 7, "unknown_kwarg_2": 5} ) - async def test_get_updates_deserialization_error(self, bot, monkeypatch, caplog): + async def test_get_updates_deserialization_error(self, offline_bot, monkeypatch, caplog): async def faulty_do_request(*args, **kwargs): return ( HTTPStatus.OK, @@ -544,10 +558,10 @@ async def faulty_do_request(*args, **kwargs): monkeypatch.setattr(HTTPXRequest, "do_request", faulty_do_request) - bot = PytestExtBot(get_updates_request=HTTPXRequest(), token=bot.token) + offline_bot = PytestExtBot(get_updates_request=HTTPXRequest(), token=offline_bot.token) with caplog.at_level(logging.CRITICAL), pytest.raises(AttributeError): - await bot.get_updates() + await offline_bot.get_updates() assert len(caplog.records) == 1 assert caplog.records[0].name == "telegram.ext.ExtBot" @@ -558,7 +572,7 @@ async def faulty_do_request(*args, **kwargs): ) assert caplog.records[0].exc_info[0] is AttributeError - async def test_answer_web_app_query(self, bot, raw_bot, monkeypatch): + async def test_answer_web_app_query(self, offline_bot, raw_bot, monkeypatch): params = False # For now just test that our internals pass the correct data @@ -583,9 +597,9 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): result = InlineQueryResultArticle("1", "title", InputTextMessageContent("text")) copied_result = copy.copy(result) - ext_bot = bot + ext_bot = offline_bot for bot_type in (ext_bot, raw_bot): - # We need to test 1) below both the bot and raw_bot and setting this up with + # We need to test 1) below both the offline_bot and raw_bot and setting this up with # pytest.parametrize appears to be difficult ... monkeypatch.setattr(bot_type.request, "post", make_assertion) web_app_msg = await bot_type.answer_web_app_query("12345", result) @@ -679,7 +693,7 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): async def test_answer_web_app_query_defaults( self, default_bot, ilq_result, expected_params, monkeypatch ): - bot = default_bot + offline_bot = default_bot params = False # For now just test that our internals pass the correct data @@ -689,13 +703,13 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): params = request_data.parameters == expected_params return SentWebAppMessage("321").to_dict() - monkeypatch.setattr(bot.request, "post", make_assertion) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) # We test different result types more thoroughly for answer_inline_query, so we just # use the one type here copied_result = copy.copy(ilq_result) - web_app_msg = await bot.answer_web_app_query("12345", ilq_result) + web_app_msg = await offline_bot.answer_web_app_query("12345", ilq_result) assert params, "something went wrong with passing arguments to the request" assert isinstance(web_app_msg, SentWebAppMessage) assert web_app_msg.inline_message_id == "321" @@ -709,7 +723,7 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): # TODO: Needs improvement. We need incoming inline query to test answer. @pytest.mark.parametrize("button_type", ["start", "web_app"]) - async def test_answer_inline_query(self, monkeypatch, bot, raw_bot, button_type): + async def test_answer_inline_query(self, monkeypatch, offline_bot, raw_bot, button_type): # For now just test that our internals pass the correct data async def make_assertion(url, request_data: RequestData, *args, **kwargs): expected = { @@ -785,9 +799,9 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): button = None copied_results = copy.copy(results) - ext_bot = bot + ext_bot = offline_bot for bot_type in (ext_bot, raw_bot): - # We need to test 1) below both the bot and raw_bot and setting this up with + # We need to test 1) below both the offline_bot and raw_bot and setting this up with # pytest.parametrize appears to be difficult ... monkeypatch.setattr(bot_type.request, "post", make_assertion) assert await bot_type.answer_inline_query( @@ -817,7 +831,7 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): monkeypatch.delattr(bot_type.request, "post") - async def test_answer_inline_query_no_default_parse_mode(self, monkeypatch, bot): + async def test_answer_inline_query_no_default_parse_mode(self, monkeypatch, offline_bot): async def make_assertion(url, request_data: RequestData, *args, **kwargs): return request_data.parameters == { "cache_time": 300, @@ -853,7 +867,7 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): "is_personal": True, } - monkeypatch.setattr(bot.request, "post", make_assertion) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) results = [ InlineQueryResultArticle("11", "first", InputTextMessageContent("first")), InlineQueryResultArticle("12", "second", InputMessageContentLPO("second")), @@ -871,7 +885,7 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): ] copied_results = copy.copy(results) - assert await bot.answer_inline_query( + assert await offline_bot.answer_inline_query( 1234, results=results, cache_time=300, @@ -1003,7 +1017,7 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): async def test_answer_inline_query_current_offset_1( self, monkeypatch, - bot, + offline_bot, inline_results, current_offset, num_results, @@ -1019,13 +1033,15 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): next_offset_matches = data["next_offset"] == str(expected_next_offset) return length_matches and ids_match and next_offset_matches - monkeypatch.setattr(bot.request, "post", make_assertion) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) - assert await bot.answer_inline_query( + assert await offline_bot.answer_inline_query( 1234, results=inline_results, current_offset=current_offset ) - async def test_answer_inline_query_current_offset_2(self, monkeypatch, bot, inline_results): + async def test_answer_inline_query_current_offset_2( + self, monkeypatch, offline_bot, inline_results + ): # For now just test that our internals pass the correct data async def make_assertion(url, request_data: RequestData, *args, **kwargs): data = request_data.parameters @@ -1035,9 +1051,11 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): next_offset_matches = data["next_offset"] == "1" return length_matches and ids_match and next_offset_matches - monkeypatch.setattr(bot.request, "post", make_assertion) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) - assert await bot.answer_inline_query(1234, results=inline_results, current_offset=0) + assert await offline_bot.answer_inline_query( + 1234, results=inline_results, current_offset=0 + ) inline_results = inline_results[:30] @@ -1049,11 +1067,13 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): next_offset_matches = not data["next_offset"] return length_matches and ids_match and next_offset_matches - monkeypatch.setattr(bot.request, "post", make_assertion) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) - assert await bot.answer_inline_query(1234, results=inline_results, current_offset=0) + assert await offline_bot.answer_inline_query( + 1234, results=inline_results, current_offset=0 + ) - async def test_answer_inline_query_current_offset_callback(self, monkeypatch, bot): + async def test_answer_inline_query_current_offset_callback(self, monkeypatch, offline_bot): # For now just test that our internals pass the correct data async def make_assertion(url, request_data: RequestData, *args, **kwargs): data = request_data.parameters @@ -1063,9 +1083,9 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): next_offset = data["next_offset"] == "2" return length and ids and next_offset - monkeypatch.setattr(bot.request, "post", make_assertion) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) - assert await bot.answer_inline_query( + assert await offline_bot.answer_inline_query( 1234, results=inline_results_callback, current_offset=1 ) @@ -1076,61 +1096,63 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): next_offset = not data["next_offset"] return length and next_offset - monkeypatch.setattr(bot.request, "post", make_assertion) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) - assert await bot.answer_inline_query( + assert await offline_bot.answer_inline_query( 1234, results=inline_results_callback, current_offset=6 ) - async def test_send_edit_message_mutually_exclusive_link_preview(self, bot, chat_id): + async def test_send_edit_message_mutually_exclusive_link_preview(self, offline_bot, chat_id): """Test that link_preview is mutually exclusive with disable_web_page_preview.""" with pytest.raises(ValueError, match="`link_preview_options` are mutually exclusive"): - await bot.send_message( + await offline_bot.send_message( chat_id, "text", disable_web_page_preview=True, link_preview_options="something" ) with pytest.raises(ValueError, match="`link_preview_options` are mutually exclusive"): - await bot.edit_message_text( + await offline_bot.edit_message_text( "text", chat_id, 1, disable_web_page_preview=True, link_preview_options="something" ) - async def test_rtm_aswr_mutually_exclusive_reply_parameters(self, bot, chat_id): + async def test_rtm_aswr_mutually_exclusive_reply_parameters(self, offline_bot, chat_id): """Test that reply_to_message_id and allow_sending_without_reply are mutually exclusive with reply_parameters.""" with pytest.raises(ValueError, match="`reply_to_message_id` and"): - await bot.send_message(chat_id, "text", reply_to_message_id=1, reply_parameters=True) + await offline_bot.send_message( + chat_id, "text", reply_to_message_id=1, reply_parameters=True + ) with pytest.raises(ValueError, match="`allow_sending_without_reply` and"): - await bot.send_message( + await offline_bot.send_message( chat_id, "text", allow_sending_without_reply=True, reply_parameters=True ) # Test with copy message with pytest.raises(ValueError, match="`reply_to_message_id` and"): - await bot.copy_message( + await offline_bot.copy_message( chat_id, chat_id, 1, reply_to_message_id=1, reply_parameters=True ) with pytest.raises(ValueError, match="`allow_sending_without_reply` and"): - await bot.copy_message( + await offline_bot.copy_message( chat_id, chat_id, 1, allow_sending_without_reply=True, reply_parameters=True ) # Test with send media group - media = InputMediaPhoto(photo_file) + media = InputMediaPhoto("") with pytest.raises(ValueError, match="`reply_to_message_id` and"): - await bot.send_media_group( + await offline_bot.send_media_group( chat_id, media, reply_to_message_id=1, reply_parameters=True ) with pytest.raises(ValueError, match="`allow_sending_without_reply` and"): - await bot.send_media_group( + await offline_bot.send_media_group( chat_id, media, allow_sending_without_reply=True, reply_parameters=True ) # get_file is tested multiple times in the test_*media* modules. - # Here we only test the behaviour for bot apis in local mode - async def test_get_file_local_mode(self, bot, monkeypatch): + # Here we only test the behaviour for offline_bot apis in local mode + async def test_get_file_local_mode(self, offline_bot, monkeypatch): path = str(data_file("game.gif")) async def make_assertion(*args, **kwargs): @@ -1141,14 +1163,14 @@ async def make_assertion(*args, **kwargs): "file_path": path, } - monkeypatch.setattr(bot, "_post", make_assertion) + monkeypatch.setattr(offline_bot, "_post", make_assertion) - resulting_path = (await bot.get_file("file_id")).file_path - assert bot.token not in resulting_path + resulting_path = (await offline_bot.get_file("file_id")).file_path + assert offline_bot.token not in resulting_path assert resulting_path == path # TODO: Needs improvement. No feasible way to test until bots can add members. - async def test_ban_chat_member(self, monkeypatch, bot): + async def test_ban_chat_member(self, monkeypatch, offline_bot): async def make_assertion(url, request_data: RequestData, *args, **kwargs): data = request_data.json_parameters chat_id = data["chat_id"] == "2" @@ -1157,13 +1179,13 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): revoke_msgs = data.get("revoke_messages", "true") == "true" return chat_id and user_id and until_date and revoke_msgs - monkeypatch.setattr(bot.request, "post", make_assertion) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) until = from_timestamp(1577887200) - assert await bot.ban_chat_member(2, 32) - assert await bot.ban_chat_member(2, 32, until_date=until) - assert await bot.ban_chat_member(2, 32, until_date=1577887200) - assert await bot.ban_chat_member(2, 32, revoke_messages=True) + assert await offline_bot.ban_chat_member(2, 32) + assert await offline_bot.ban_chat_member(2, 32, until_date=until) + assert await offline_bot.ban_chat_member(2, 32, until_date=1577887200) + assert await offline_bot.ban_chat_member(2, 32, revoke_messages=True) async def test_ban_chat_member_default_tz(self, monkeypatch, tz_bot): until = dtm.datetime(2020, 1, 11, 16, 13) @@ -1182,7 +1204,7 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): assert await tz_bot.ban_chat_member(2, 32, until_date=until) assert await tz_bot.ban_chat_member(2, 32, until_date=until_timestamp) - async def test_ban_chat_sender_chat(self, monkeypatch, bot): + async def test_ban_chat_sender_chat(self, monkeypatch, offline_bot): # For now, we just test that we pass the correct data to TG async def make_assertion(url, request_data: RequestData, *args, **kwargs): data = request_data.parameters @@ -1190,12 +1212,12 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): sender_chat_id = data["sender_chat_id"] == 32 return chat_id and sender_chat_id - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.ban_chat_sender_chat(2, 32) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.ban_chat_sender_chat(2, 32) # TODO: Needs improvement. @pytest.mark.parametrize("only_if_banned", [True, False, None]) - async def test_unban_chat_member(self, monkeypatch, bot, only_if_banned): + async def test_unban_chat_member(self, monkeypatch, offline_bot, only_if_banned): async def make_assertion(url, request_data: RequestData, *args, **kwargs): data = request_data.parameters chat_id = data["chat_id"] == 2 @@ -1203,21 +1225,21 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): o_i_b = data.get("only_if_banned", None) == only_if_banned return chat_id and user_id and o_i_b - monkeypatch.setattr(bot.request, "post", make_assertion) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) - assert await bot.unban_chat_member(2, 32, only_if_banned=only_if_banned) + assert await offline_bot.unban_chat_member(2, 32, only_if_banned=only_if_banned) - async def test_unban_chat_sender_chat(self, monkeypatch, bot): + async def test_unban_chat_sender_chat(self, monkeypatch, offline_bot): async def make_assertion(url, request_data: RequestData, *args, **kwargs): data = request_data.json_parameters chat_id = data["chat_id"] == "2" sender_chat_id = data["sender_chat_id"] == "32" return chat_id and sender_chat_id - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.unban_chat_sender_chat(2, 32) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.unban_chat_sender_chat(2, 32) - async def test_set_chat_permissions(self, monkeypatch, bot, chat_permissions): + async def test_set_chat_permissions(self, monkeypatch, offline_bot, chat_permissions): async def make_assertion(url, request_data: RequestData, *args, **kwargs): data = request_data.json_parameters chat_id = data["chat_id"] == "2" @@ -1225,11 +1247,11 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): use_independent_chat_permissions = data["use_independent_chat_permissions"] return chat_id and permissions and use_independent_chat_permissions - monkeypatch.setattr(bot.request, "post", make_assertion) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) - assert await bot.set_chat_permissions(2, chat_permissions, True) + assert await offline_bot.set_chat_permissions(2, chat_permissions, True) - async def test_set_chat_administrator_custom_title(self, monkeypatch, bot): + async def test_set_chat_administrator_custom_title(self, monkeypatch, offline_bot): async def make_assertion(url, request_data: RequestData, *args, **kwargs): data = request_data.parameters chat_id = data["chat_id"] == 2 @@ -1237,11 +1259,11 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): custom_title = data["custom_title"] == "custom_title" return chat_id and user_id and custom_title - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.set_chat_administrator_custom_title(2, 32, "custom_title") + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.set_chat_administrator_custom_title(2, 32, "custom_title") # TODO: Needs improvement. Need an incoming callbackquery to test - async def test_answer_callback_query(self, monkeypatch, bot): + async def test_answer_callback_query(self, monkeypatch, offline_bot): # For now just test that our internals pass the correct data async def make_assertion(url, request_data: RequestData, *args, **kwargs): return request_data.parameters == { @@ -1252,27 +1274,27 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): "text": "answer", } - monkeypatch.setattr(bot.request, "post", make_assertion) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) - assert await bot.answer_callback_query( + assert await offline_bot.answer_callback_query( 23, text="answer", show_alert=True, url="no_url", cache_time=1 ) @pytest.mark.parametrize("drop_pending_updates", [True, False]) async def test_set_webhook_delete_webhook_drop_pending_updates( - self, bot, drop_pending_updates, monkeypatch + self, offline_bot, drop_pending_updates, monkeypatch ): async def make_assertion(url, request_data: RequestData, *args, **kwargs): data = request_data.parameters return data.get("drop_pending_updates") == drop_pending_updates - monkeypatch.setattr(bot.request, "post", make_assertion) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) - assert await bot.set_webhook("", drop_pending_updates=drop_pending_updates) - assert await bot.delete_webhook(drop_pending_updates=drop_pending_updates) + assert await offline_bot.set_webhook("", drop_pending_updates=drop_pending_updates) + assert await offline_bot.delete_webhook(drop_pending_updates=drop_pending_updates) @pytest.mark.parametrize("local_file", ["str", "Path", False]) - async def test_set_webhook_params(self, bot, monkeypatch, local_file): + async def test_set_webhook_params(self, offline_bot, monkeypatch, local_file): # actually making calls to TG is done in # test_set_webhook_get_webhook_info_and_delete_webhook. Sadly secret_token can't be tested # there so we have this function \o/ @@ -1297,7 +1319,7 @@ async def make_assertion(*args, **_): and kwargs["secret_token"] == "SoSecretToken" ) - monkeypatch.setattr(bot, "_post", make_assertion) + monkeypatch.setattr(offline_bot, "_post", make_assertion) cert_path = data_file("sslcert.pem") if local_file == "str": @@ -1307,7 +1329,7 @@ async def make_assertion(*args, **_): else: certificate = cert_path.read_bytes() - assert await bot.set_webhook( + assert await offline_bot.set_webhook( "example.com", certificate, 7, @@ -1318,7 +1340,7 @@ async def make_assertion(*args, **_): ) # TODO: Needs improvement. Need incoming shipping queries to test - async def test_answer_shipping_query_ok(self, monkeypatch, bot): + async def test_answer_shipping_query_ok(self, monkeypatch, offline_bot): # For now just test that our internals pass the correct data async def make_assertion(url, request_data: RequestData, *args, **kwargs): return request_data.parameters == { @@ -1329,11 +1351,13 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): ], } - monkeypatch.setattr(bot.request, "post", make_assertion) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) shipping_options = ShippingOption(1, "option1", [LabeledPrice("price", 100)]) - assert await bot.answer_shipping_query(1, True, shipping_options=[shipping_options]) + assert await offline_bot.answer_shipping_query( + 1, True, shipping_options=[shipping_options] + ) - async def test_answer_shipping_query_error_message(self, monkeypatch, bot): + async def test_answer_shipping_query_error_message(self, monkeypatch, offline_bot): # For now just test that our internals pass the correct data async def make_assertion(url, request_data: RequestData, *args, **kwargs): return request_data.parameters == { @@ -1342,19 +1366,19 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): "ok": False, } - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.answer_shipping_query(1, False, error_message="Not enough fish") + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.answer_shipping_query(1, False, error_message="Not enough fish") # TODO: Needs improvement. Need incoming pre checkout queries to test - async def test_answer_pre_checkout_query_ok(self, monkeypatch, bot): + async def test_answer_pre_checkout_query_ok(self, monkeypatch, offline_bot): # For now just test that our internals pass the correct data async def make_assertion(url, request_data: RequestData, *args, **kwargs): return request_data.parameters == {"pre_checkout_query_id": 1, "ok": True} - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.answer_pre_checkout_query(1, True) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.answer_pre_checkout_query(1, True) - async def test_answer_pre_checkout_query_error_message(self, monkeypatch, bot): + async def test_answer_pre_checkout_query_error_message(self, monkeypatch, offline_bot): # For now just test that our internals pass the correct data async def make_assertion(url, request_data: RequestData, *args, **kwargs): return request_data.parameters == { @@ -1363,10 +1387,12 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): "ok": False, } - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.answer_pre_checkout_query(1, False, error_message="Not enough fish") + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.answer_pre_checkout_query( + 1, False, error_message="Not enough fish" + ) - async def test_restrict_chat_member(self, bot, chat_permissions, monkeypatch): + async def test_restrict_chat_member(self, offline_bot, chat_permissions, monkeypatch): async def make_assertion(url, request_data: RequestData, *args, **kwargs): data = request_data.json_parameters chat_id = data["chat_id"] == "@chat" @@ -1382,9 +1408,9 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): and use_independent_chat_permissions ) - monkeypatch.setattr(bot.request, "post", make_assertion) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) - assert await bot.restrict_chat_member("@chat", 2, chat_permissions, 200, True) + assert await offline_bot.restrict_chat_member("@chat", 2, chat_permissions, 200, True) async def test_restrict_chat_member_default_tz( self, monkeypatch, tz_bot, channel_id, chat_permissions @@ -1406,10 +1432,10 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): ) @pytest.mark.parametrize("local_mode", [True, False]) - async def test_set_chat_photo_local_files(self, monkeypatch, bot, chat_id, local_mode): + async def test_set_chat_photo_local_files(self, monkeypatch, offline_bot, chat_id, local_mode): try: - bot._local_mode = local_mode - # For just test that the correct paths are passed as we have no local bot API set up + offline_bot._local_mode = local_mode + # For just test that the correct paths are passed as we have no local Bot API set up self.test_flag = False file = data_file("telegram.jpg") expected = file.as_uri() @@ -1420,13 +1446,13 @@ async def make_assertion(_, data, *args, **kwargs): else: self.test_flag = isinstance(data.get("photo"), InputFile) - monkeypatch.setattr(bot, "_post", make_assertion) - await bot.set_chat_photo(chat_id, file) + monkeypatch.setattr(offline_bot, "_post", make_assertion) + await offline_bot.set_chat_photo(chat_id, file) assert self.test_flag finally: - bot._local_mode = False + offline_bot._local_mode = False - async def test_timeout_propagation_explicit(self, monkeypatch, bot, chat_id): + async def test_timeout_propagation_explicit(self, monkeypatch, offline_bot, chat_id): # Use BaseException that's not a subclass of Exception such that # OkException should not be caught anywhere class OkException(BaseException): @@ -1441,19 +1467,19 @@ async def do_request(*args, **kwargs): return 200, b'{"ok": true, "result": []}' - monkeypatch.setattr(bot.request, "do_request", do_request) + monkeypatch.setattr(offline_bot.request, "do_request", do_request) # Test file uploading with pytest.raises(OkException): - await bot.send_photo( + await offline_bot.send_photo( chat_id, data_file("telegram.jpg").open("rb"), read_timeout=timeout ) # Test JSON submission with pytest.raises(OkException): - await bot.get_chat_administrators(chat_id, read_timeout=timeout) + await offline_bot.get_chat_administrators(chat_id, read_timeout=timeout) - async def test_timeout_propagation_implicit(self, monkeypatch, bot, chat_id): + async def test_timeout_propagation_implicit(self, monkeypatch, offline_bot, chat_id): # Use BaseException that's not a subclass of Exception such that # OkException should not be caught anywhere class OkException(BaseException): @@ -1467,33 +1493,34 @@ async def request(*args, **kwargs): return 200, b'{"ok": true, "result": []}' monkeypatch.setattr(httpx.AsyncClient, "request", request) + monkeypatch.setattr(offline_bot, "_request", (object(), HTTPXRequest())) # Test file uploading with pytest.raises(OkException): - await bot.send_photo(chat_id, data_file("telegram.jpg").open("rb")) + await offline_bot.send_photo(chat_id, data_file("telegram.jpg").open("rb")) - async def test_log_out(self, monkeypatch, bot): + async def test_log_out(self, monkeypatch, offline_bot): # We don't actually make a request as to not break the test setup async def assertion(url, request_data: RequestData, *args, **kwargs): return request_data.json_parameters == {} and url.split("/")[-1] == "logOut" - monkeypatch.setattr(bot.request, "post", assertion) + monkeypatch.setattr(offline_bot.request, "post", assertion) - assert await bot.log_out() + assert await offline_bot.log_out() - async def test_close(self, monkeypatch, bot): + async def test_close(self, monkeypatch, offline_bot): # We don't actually make a request as to not break the test setup async def assertion(url, request_data: RequestData, *args, **kwargs): return request_data.json_parameters == {} and url.split("/")[-1] == "close" - monkeypatch.setattr(bot.request, "post", assertion) + monkeypatch.setattr(offline_bot.request, "post", assertion) - assert await bot.close() + assert await offline_bot.close() @pytest.mark.parametrize("json_keyboard", [True, False]) @pytest.mark.parametrize("caption", ["Test", "", None]) async def test_copy_message( - self, monkeypatch, bot, chat_id, media_message, json_keyboard, caption + self, monkeypatch, offline_bot, chat_id, media_message, json_keyboard, caption ): keyboard = InlineKeyboardMarkup( [[InlineKeyboardButton(text="test", callback_data="test2")]] @@ -1525,8 +1552,8 @@ async def post(url, request_data: RequestData, *args, **kwargs): pytest.fail("I got wrong parameters in post") return data - monkeypatch.setattr(bot.request, "post", post) - await bot.copy_message( + monkeypatch.setattr(offline_bot.request, "post", post) + await offline_bot.copy_message( chat_id, from_chat_id=chat_id, message_id=media_message.message_id, @@ -1549,7 +1576,7 @@ async def post(url, request_data: RequestData, *args, **kwargs): [(True, 1024), (False, 1024), (0, 0), (None, None)], ) async def test_callback_data_maxsize(self, bot_info, acd_in, maxsize): - async with make_bot(bot_info, arbitrary_callback_data=acd_in) as acd_bot: + async with make_bot(bot_info, arbitrary_callback_data=acd_in, offline=True) as acd_bot: if acd_in is not False: assert acd_bot.callback_data_cache.maxsize == maxsize else: @@ -1557,7 +1584,7 @@ async def test_callback_data_maxsize(self, bot_info, acd_in, maxsize): async def test_arbitrary_callback_data_no_insert(self, monkeypatch, cdc_bot): """Updates that don't need insertion shouldn't fail obviously""" - bot = cdc_bot + offline_bot = cdc_bot async def post(*args, **kwargs): update = Update( @@ -1577,14 +1604,14 @@ async def post(*args, **kwargs): try: monkeypatch.setattr(BaseRequest, "post", post) - updates = await bot.get_updates(timeout=1) + updates = await offline_bot.get_updates(timeout=1) assert len(updates) == 1 assert updates[0].update_id == 17 assert updates[0].poll.id == "42" finally: - bot.callback_data_cache.clear_callback_data() - bot.callback_data_cache.clear_callback_queries() + offline_bot.callback_data_cache.clear_callback_data() + offline_bot.callback_data_cache.clear_callback_queries() @pytest.mark.parametrize( "message_type", ["channel_post", "edited_channel_post", "message", "edited_message"] @@ -1592,7 +1619,7 @@ async def post(*args, **kwargs): async def test_arbitrary_callback_data_pinned_message_reply_to_message( self, cdc_bot, monkeypatch, message_type ): - bot = cdc_bot + offline_bot = cdc_bot reply_markup = InlineKeyboardMarkup.from_button( InlineKeyboardButton(text="text", callback_data="callback_data") @@ -1602,11 +1629,11 @@ async def test_arbitrary_callback_data_pinned_message_reply_to_message( 1, dtm.datetime.utcnow(), None, - reply_markup=bot.callback_data_cache.process_keyboard(reply_markup), + reply_markup=offline_bot.callback_data_cache.process_keyboard(reply_markup), ) message._unfreeze() # We do to_dict -> de_json to make sure those aren't the same objects - message.pinned_message = Message.de_json(message.to_dict(), bot) + message.pinned_message = Message.de_json(message.to_dict(), offline_bot) async def post(*args, **kwargs): update = Update( @@ -1617,7 +1644,7 @@ async def post(*args, **kwargs): dtm.datetime.utcnow(), None, pinned_message=message, - reply_to_message=Message.de_json(message.to_dict(), bot), + reply_to_message=Message.de_json(message.to_dict(), offline_bot), ) }, ) @@ -1625,7 +1652,7 @@ async def post(*args, **kwargs): try: monkeypatch.setattr(BaseRequest, "post", post) - updates = await bot.get_updates(timeout=1) + updates = await offline_bot.get_updates(timeout=1) assert isinstance(updates, tuple) assert len(updates) == 1 @@ -1646,11 +1673,11 @@ async def post(*args, **kwargs): ) finally: - bot.callback_data_cache.clear_callback_data() - bot.callback_data_cache.clear_callback_queries() + offline_bot.callback_data_cache.clear_callback_data() + offline_bot.callback_data_cache.clear_callback_queries() async def test_get_updates_invalid_callback_data(self, cdc_bot, monkeypatch): - bot = cdc_bot + offline_bot = cdc_bot async def post(*args, **kwargs): return [ @@ -1674,7 +1701,7 @@ async def post(*args, **kwargs): try: monkeypatch.setattr(BaseRequest, "post", post) - updates = await bot.get_updates(timeout=1) + updates = await offline_bot.get_updates(timeout=1) assert isinstance(updates, tuple) assert len(updates) == 1 @@ -1682,12 +1709,12 @@ async def post(*args, **kwargs): finally: # Reset b/c bots scope is session - bot.callback_data_cache.clear_callback_data() - bot.callback_data_cache.clear_callback_queries() + offline_bot.callback_data_cache.clear_callback_data() + offline_bot.callback_data_cache.clear_callback_queries() # TODO: Needs improvement. We need incoming inline query to test answer. async def test_replace_callback_data_answer_inline_query(self, monkeypatch, cdc_bot, chat_id): - bot = cdc_bot + offline_bot = cdc_bot # For now just test that our internals pass the correct data async def make_assertion( @@ -1704,7 +1731,7 @@ async def make_assertion( inline_keyboard[0][0].callback_data[32:], ) assertion_3 = ( - bot.callback_data_cache._keyboard_data[keyboard].button_data[button] + offline_bot.callback_data_cache._keyboard_data[keyboard].button_data[button] == "replace_test" ) assertion_4 = data["results"][1].reply_markup is None @@ -1722,8 +1749,9 @@ async def make_assertion( ] ) - bot.username # call this here so `bot.get_me()` won't be called after mocking - monkeypatch.setattr(bot, "_post", make_assertion) + # call this here so `offline_bot.get_me()` won't be called after mocking + offline_bot.username + monkeypatch.setattr(offline_bot, "_post", make_assertion) results = [ InlineQueryResultArticle( "11", "first", InputTextMessageContent("first"), reply_markup=reply_markup @@ -1735,11 +1763,11 @@ async def make_assertion( ), ] - assert await bot.answer_inline_query(chat_id, results=results) + assert await offline_bot.answer_inline_query(chat_id, results=results) finally: - bot.callback_data_cache.clear_callback_data() - bot.callback_data_cache.clear_callback_queries() + offline_bot.callback_data_cache.clear_callback_data() + offline_bot.callback_data_cache.clear_callback_queries() @pytest.mark.parametrize( "message_type", ["channel_post", "edited_channel_post", "message", "edited_message"] @@ -1813,7 +1841,7 @@ async def test_http2_runtime_error(self, recwarn, bot_class): assert warning.filename == __file__, "wrong stacklevel!" assert warning.category is PTBUserWarning - async def test_set_get_my_name(self, bot, monkeypatch): + async def test_set_get_my_name(self, offline_bot, monkeypatch): """We only test that we pass the correct values to TG since this endpoint is heavily rate limited which makes automated tests rather infeasible.""" default_name = "default_bot_name" @@ -1853,20 +1881,20 @@ async def post(url, request_data: RequestData, *args, **kwargs): get_stack.task_done() return bot_name - monkeypatch.setattr(bot.request, "post", post) + monkeypatch.setattr(offline_bot.request, "post", post) # Set the names assert all( await asyncio.gather( - bot.set_my_name(default_name), - bot.set_my_name(en_name, language_code="en"), - bot.set_my_name(de_name, language_code="de"), + offline_bot.set_my_name(default_name), + offline_bot.set_my_name(en_name, language_code="en"), + offline_bot.set_my_name(de_name, language_code="de"), ) ) # Check that they were set correctly assert await asyncio.gather( - bot.get_my_name(), bot.get_my_name("en"), bot.get_my_name("de") + offline_bot.get_my_name(), offline_bot.get_my_name("en"), offline_bot.get_my_name("de") ) == [ BotName(default_name), BotName(en_name), @@ -1876,18 +1904,18 @@ async def post(url, request_data: RequestData, *args, **kwargs): # Delete the names assert all( await asyncio.gather( - bot.set_my_name(default_name), - bot.set_my_name(None, language_code="en"), - bot.set_my_name(None, language_code="de"), + offline_bot.set_my_name(default_name), + offline_bot.set_my_name(None, language_code="en"), + offline_bot.set_my_name(None, language_code="de"), ) ) # Check that they were deleted correctly assert await asyncio.gather( - bot.get_my_name(), bot.get_my_name("en"), bot.get_my_name("de") + offline_bot.get_my_name(), offline_bot.get_my_name("en"), offline_bot.get_my_name("de") ) == 3 * [BotName(default_name)] - async def test_set_message_reaction(self, bot, monkeypatch): + async def test_set_message_reaction(self, offline_bot, monkeypatch): """This is here so we can test the convenient conversion we do in the function without having to do multiple requests to Telegram""" @@ -1918,14 +1946,22 @@ async def post(url, request_data: RequestData, *args, **kwargs): assert request_data.parameters["reaction"] == expected_param[amount] amount += 1 - monkeypatch.setattr(bot.request, "post", post) - await bot.set_message_reaction(1, 2, [ReactionTypeEmoji(ReactionEmoji.THUMBS_UP)], True) - await bot.set_message_reaction(1, 2, ReactionTypeEmoji(ReactionEmoji.RED_HEART), True) - await bot.set_message_reaction(1, 2, [ReactionTypeCustomEmoji("custom_emoji_1")], True) - await bot.set_message_reaction(1, 2, ReactionTypeCustomEmoji("custom_emoji_2"), True) - await bot.set_message_reaction(1, 2, ReactionEmoji.THUMBS_DOWN, True) - await bot.set_message_reaction(1, 2, "custom_emoji_3", True) - await bot.set_message_reaction( + monkeypatch.setattr(offline_bot.request, "post", post) + await offline_bot.set_message_reaction( + 1, 2, [ReactionTypeEmoji(ReactionEmoji.THUMBS_UP)], True + ) + await offline_bot.set_message_reaction( + 1, 2, ReactionTypeEmoji(ReactionEmoji.RED_HEART), True + ) + await offline_bot.set_message_reaction( + 1, 2, [ReactionTypeCustomEmoji("custom_emoji_1")], True + ) + await offline_bot.set_message_reaction( + 1, 2, ReactionTypeCustomEmoji("custom_emoji_2"), True + ) + await offline_bot.set_message_reaction(1, 2, ReactionEmoji.THUMBS_DOWN, True) + await offline_bot.set_message_reaction(1, 2, "custom_emoji_3", True) + await offline_bot.set_message_reaction( 1, 2, [ @@ -1947,7 +1983,7 @@ async def post(url, request_data: RequestData, *args, **kwargs): indirect=["default_bot"], ) async def test_send_message_default_quote_parse_mode( - self, default_bot, chat_id, message, custom, monkeypatch + self, default_bot, chat_id, custom, monkeypatch ): async def make_assertion(url, request_data: RequestData, *args, **kwargs): assert request_data.parameters["reply_parameters"].get("quote_parse_mode") == ( @@ -1960,9 +1996,7 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): kwargs["quote_parse_mode"] = custom monkeypatch.setattr(default_bot.request, "post", make_assertion) - await default_bot.send_message( - chat_id, message, reply_parameters=ReplyParameters(**kwargs) - ) + await default_bot.send_message(chat_id, "test", reply_parameters=ReplyParameters(**kwargs)) @pytest.mark.parametrize( ("default_bot", "custom"), @@ -2047,7 +2081,7 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): reply_parameters=ReplyParameters(**kwargs), ) - async def test_send_poll_question_parse_mode_entities(self, bot, monkeypatch): + async def test_send_poll_question_parse_mode_entities(self, offline_bot, monkeypatch): # Currently only custom emoji are supported as entities which we can't test # We just test that the correct data is passed for now @@ -2059,8 +2093,8 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): assert request_data.parameters["question_parse_mode"] == ParseMode.MARKDOWN_V2 return make_message("dummy reply").to_dict() - monkeypatch.setattr(bot.request, "post", make_assertion) - await bot.send_poll( + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + await offline_bot.send_poll( 1, question="😀😃", options=["option1", "option2"], @@ -2123,15 +2157,15 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): monkeypatch.setattr(default_bot.request, "post", make_assertion) await default_bot.copy_message(chat_id, 1, 1, reply_parameters=ReplyParameters(**kwargs)) - async def test_do_api_request_camel_case_conversion(self, bot, monkeypatch): + async def test_do_api_request_camel_case_conversion(self, offline_bot, monkeypatch): async def make_assertion(url, request_data: RequestData, *args, **kwargs): return url.endswith("camelCase") - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.do_api_request("camel_case") + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.do_api_request("camel_case") @pytest.mark.filterwarnings("ignore::telegram.warnings.PTBUserWarning") - async def test_do_api_request_media_write_timeout(self, bot, chat_id, monkeypatch): + async def test_do_api_request_media_write_timeout(self, offline_bot, chat_id, monkeypatch): test_flag = None class CustomRequest(BaseRequest): @@ -2141,7 +2175,7 @@ async def initialize(self_) -> None: async def shutdown(self_) -> None: pass - async def do_request(self_, *args, **kwargs) -> Tuple[int, bytes]: + async def do_request(self_, *args, **kwargs) -> tuple[int, bytes]: nonlocal test_flag test_flag = ( kwargs.get("read_timeout"), @@ -2153,8 +2187,8 @@ async def do_request(self_, *args, **kwargs) -> Tuple[int, bytes]: custom_request = CustomRequest() - bot = Bot(bot.token, request=custom_request) - await bot.do_api_request( + offline_bot = Bot(offline_bot.token, request=custom_request) + await offline_bot.do_api_request( "send_document", api_kwargs={ "chat_id": chat_id, @@ -2194,7 +2228,7 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): api_kwargs={"chat_id": 2, "user_id": 32, "until_date": until_timestamp}, ) - async def test_business_connection_id_argument(self, bot, monkeypatch): + async def test_business_connection_id_argument(self, offline_bot, monkeypatch): """We can't connect to a business acc, so we just test that the correct data is passed. We also can't test every single method easily, so we just test a few. Our linting will catch any unused args with the others.""" @@ -2203,22 +2237,34 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): assert request_data.parameters.get("business_connection_id") == 42 return {} - monkeypatch.setattr(bot.request, "post", make_assertion) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) - await bot.send_message(2, "text", business_connection_id=42) - await bot.stop_poll(chat_id=1, message_id=2, business_connection_id=42) + await offline_bot.send_message(2, "text", business_connection_id=42) + await offline_bot.stop_poll(chat_id=1, message_id=2, business_connection_id=42) + await offline_bot.pin_chat_message(chat_id=1, message_id=2, business_connection_id=42) + await offline_bot.unpin_chat_message(chat_id=1, business_connection_id=42) - async def test_message_effect_id_argument(self, bot, monkeypatch): + async def test_message_effect_id_argument(self, offline_bot, monkeypatch): """We can't test every single method easily, so we just test one. Our linting will catch any unused args with the others.""" async def make_assertion(url, request_data: RequestData, *args, **kwargs): return request_data.parameters.get("message_effect_id") == 42 - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.send_message(2, "text", message_effect_id=42) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.send_message(2, "text", message_effect_id=42) + + async def test_allow_paid_broadcast_argument(self, offline_bot, monkeypatch): + """We can't test every single method easily, so we just test one. Our linting will catch + any unused args with the others.""" - async def test_get_business_connection(self, bot, monkeypatch): + async def make_assertion(url, request_data: RequestData, *args, **kwargs): + return request_data.parameters.get("allow_paid_broadcast") == 42 + + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.send_message(2, "text", allow_paid_broadcast=42) + + async def test_get_business_connection(self, offline_bot, monkeypatch): bci = "42" user = User(1, "first", False) user_chat_id = 1 @@ -2234,11 +2280,24 @@ async def do_request(*args, **kwargs): return 200, f'{{"ok": true, "result": {bc}}}'.encode() return 400, b'{"ok": false, "result": []}' - monkeypatch.setattr(bot.request, "do_request", do_request) - obj = await bot.get_business_connection(business_connection_id=bci) + monkeypatch.setattr(offline_bot.request, "do_request", do_request) + obj = await offline_bot.get_business_connection(business_connection_id=bci) assert isinstance(obj, BusinessConnection) - async def test_refund_star_payment(self, bot, monkeypatch): + async def test_send_chat_action_all_args(self, bot, chat_id, monkeypatch): + async def make_assertion(*args, **_): + kwargs = args[1] + return ( + kwargs["chat_id"] == chat_id + and kwargs["action"] == "action" + and kwargs["message_thread_id"] == 1 + and kwargs["business_connection_id"] == 3 + ) + + monkeypatch.setattr(bot, "_post", make_assertion) + assert await bot.send_chat_action(chat_id, "action", 1, 3) + + async def test_refund_star_payment(self, offline_bot, monkeypatch): # can't make actual request so we just test that the correct data is passed async def make_assertion(url, request_data: RequestData, *args, **kwargs): return ( @@ -2246,10 +2305,10 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): and request_data.parameters.get("telegram_payment_charge_id") == "37" ) - monkeypatch.setattr(bot.request, "post", make_assertion) - assert await bot.refund_star_payment(42, "37") + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.refund_star_payment(42, "37") - async def test_get_star_transactions(self, bot, monkeypatch): + async def test_get_star_transactions(self, offline_bot, monkeypatch): # we just want to test the offset parameter st = StarTransactions([StarTransaction("1", 1, dtm.datetime.now())]).to_json() @@ -2259,10 +2318,74 @@ async def do_request(url, request_data: RequestData, *args, **kwargs): return 200, f'{{"ok": true, "result": {st}}}'.encode() return 400, b'{"ok": false, "result": []}' - monkeypatch.setattr(bot.request, "do_request", do_request) - obj = await bot.get_star_transactions(offset=3) + monkeypatch.setattr(offline_bot.request, "do_request", do_request) + obj = await offline_bot.get_star_transactions(offset=3) assert isinstance(obj, StarTransactions) + async def test_edit_user_star_subscription(self, offline_bot, monkeypatch): + """Can't properly test, so we only check that the correct values are passed""" + + async def make_assertion(url, request_data: RequestData, *args, **kwargs): + return ( + request_data.parameters.get("user_id") == 42 + and request_data.parameters.get("telegram_payment_charge_id") + == "telegram_payment_charge_id" + and request_data.parameters.get("is_canceled") is False + ) + + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.edit_user_star_subscription( + 42, "telegram_payment_charge_id", False + ) + + async def test_create_chat_subscription_invite_link( + self, + monkeypatch, + offline_bot, + ): + # Since the chat invite link object does not say if the sub args are passed we can + # only check here + async def make_assertion(url, request_data: RequestData, *args, **kwargs): + assert request_data.parameters.get("subscription_period") == 2592000 + assert request_data.parameters.get("subscription_price") == 6 + + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + + await offline_bot.create_chat_subscription_invite_link(1234, 2592000, 6) + + @pytest.mark.parametrize( + "expiration_date", [dtm.datetime(2024, 1, 1), 1704067200], ids=["datetime", "timestamp"] + ) + async def test_set_user_emoji_status_basic(self, offline_bot, monkeypatch, expiration_date): + async def make_assertion(url, request_data: RequestData, *args, **kwargs): + assert request_data.parameters.get("user_id") == 4242 + assert ( + request_data.parameters.get("emoji_status_custom_emoji_id") + == "emoji_status_custom_emoji_id" + ) + assert request_data.parameters.get("emoji_status_expiration_date") == 1704067200 + + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + await offline_bot.set_user_emoji_status( + 4242, "emoji_status_custom_emoji_id", expiration_date + ) + + async def test_set_user_emoji_status_default_timezone(self, tz_bot, monkeypatch): + async def make_assertion(url, request_data: RequestData, *args, **kwargs): + assert request_data.parameters.get("user_id") == 4242 + assert ( + request_data.parameters.get("emoji_status_custom_emoji_id") + == "emoji_status_custom_emoji_id" + ) + assert request_data.parameters.get("emoji_status_expiration_date") == to_timestamp( + dtm.datetime(2024, 1, 1), tzinfo=tz_bot.defaults.tzinfo + ) + + monkeypatch.setattr(tz_bot.request, "post", make_assertion) + await tz_bot.set_user_emoji_status( + 4242, "emoji_status_custom_emoji_id", dtm.datetime(2024, 1, 1) + ) + class TestBotWithRequest: """ @@ -2272,6 +2395,9 @@ class TestBotWithRequest: is tested in `test_callbackdatacache` """ + # get_available_gifts, send_gift are tested in `test_gift`. + # No need to duplicate here. + async def test_invalid_token_server_response(self): with pytest.raises(InvalidToken, match="The token `12` was rejected by the server."): async with ExtBot(token="12"): @@ -2285,13 +2411,13 @@ async def test_multiple_init_cycles(self, bot): async with test_bot: await test_bot.get_me() - async def test_forward_message(self, bot, chat_id, message): + async def test_forward_message(self, bot, chat_id, static_message): forward_message = await bot.forward_message( - chat_id, from_chat_id=chat_id, message_id=message.message_id + chat_id, from_chat_id=chat_id, message_id=static_message.message_id ) - assert forward_message.text == message.text - assert forward_message.forward_origin.sender_user == message.from_user + assert forward_message.text == static_message.text + assert forward_message.forward_origin.sender_user == static_message.from_user assert isinstance(forward_message.forward_origin.date, dtm.datetime) async def test_forward_protected_message(self, bot, chat_id): @@ -2318,15 +2444,12 @@ async def test_forward_protected_message(self, bot, chat_id): assert all("can't be forwarded" in str(exc) for exc in result) async def test_forward_messages(self, bot, chat_id): - tasks = asyncio.gather( - bot.send_message(chat_id, text="will be forwarded"), - bot.send_message(chat_id, text="will be forwarded"), - ) - - msg1, msg2 = await tasks + # not using gather here to have deteriminically ordered message_ids + msg1 = await bot.send_message(chat_id, text="will be forwarded") + msg2 = await bot.send_message(chat_id, text="will be forwarded") forward_messages = await bot.forward_messages( - chat_id, from_chat_id=chat_id, message_ids=sorted((msg1.message_id, msg2.message_id)) + chat_id, from_chat_id=chat_id, message_ids=(msg1.message_id, msg2.message_id) ) assert isinstance(forward_messages, tuple) @@ -2354,8 +2477,6 @@ async def test_forward_messages(self, bot, chat_id): async def test_delete_message(self, bot, chat_id): message = await bot.send_message(chat_id, text="will be deleted") - await asyncio.sleep(2) - assert await bot.delete_message(chat_id=chat_id, message_id=message.message_id) is True async def test_delete_message_old_message(self, bot, chat_id): @@ -2447,18 +2568,6 @@ async def test_send_contact(self, bot, chat_id): assert message.contact.last_name == last_name assert message.has_protected_content - async def test_send_chat_action_all_args(self, bot, chat_id, monkeypatch): - async def make_assertion(*args, **_): - kwargs = args[1] - return ( - kwargs["chat_id"] == chat_id - and kwargs["action"] == "action" - and kwargs["message_thread_id"] == 1 - ) - - monkeypatch.setattr(bot, "_post", make_assertion) - assert await bot.send_chat_action(chat_id, "action", 1) - # TODO: Add bot to group to test polls too @pytest.mark.parametrize( "reply_markup", @@ -2785,6 +2894,15 @@ async def test_answer_inline_query_current_offset_error(self, bot, inline_result 1234, results=inline_results, next_offset=42, current_offset=51 ) + async def test_save_prepared_inline_message(self, bot, chat_id): + # We can't really check that the result is stored correctly, we just ensur ethat we get + # a proper return value + result = InlineQueryResultArticle( + id="some_id", title="title", input_message_content=InputTextMessageContent("text") + ) + out = await bot.save_prepared_inline_message(chat_id, result, True, False, True, False) + assert isinstance(out, PreparedInlineMessage) + async def test_get_user_profile_photos(self, bot, chat_id): user_profile_photos = await bot.get_user_profile_photos(chat_id) assert user_profile_photos.photos[0][0].file_size == 5403 @@ -2794,18 +2912,18 @@ async def test_get_one_user_profile_photo(self, bot, chat_id): assert user_profile_photos.total_count == 1 assert user_profile_photos.photos[0][0].file_size == 5403 - async def test_edit_message_text(self, bot, message): + async def test_edit_message_text(self, bot, one_time_message): message = await bot.edit_message_text( text="new_text", - chat_id=message.chat_id, - message_id=message.message_id, + chat_id=one_time_message.chat_id, + message_id=one_time_message.message_id, parse_mode="HTML", disable_web_page_preview=True, ) assert message.text == "new_text" - async def test_edit_message_text_entities(self, bot, message): + async def test_edit_message_text_entities(self, bot, one_time_message): test_string = "Italic Bold Code" entities = [ MessageEntity(MessageEntity.ITALIC, 0, 6), @@ -2814,8 +2932,8 @@ async def test_edit_message_text_entities(self, bot, message): ] message = await bot.edit_message_text( text=test_string, - chat_id=message.chat_id, - message_id=message.message_id, + chat_id=one_time_message.chat_id, + message_id=one_time_message.message_id, entities=entities, ) @@ -2823,14 +2941,16 @@ async def test_edit_message_text_entities(self, bot, message): assert message.entities == tuple(entities) @pytest.mark.parametrize("default_bot", [{"parse_mode": "Markdown"}], indirect=True) - async def test_edit_message_text_default_parse_mode(self, default_bot, message): + async def test_edit_message_text_default_parse_mode( + self, default_bot, chat_id, one_time_message + ): test_string = "Italic Bold Code" test_markdown_string = "_Italic_ *Bold* `Code`" message = await default_bot.edit_message_text( text=test_markdown_string, - chat_id=message.chat_id, - message_id=message.message_id, + chat_id=one_time_message.chat_id, + message_id=one_time_message.message_id, disable_web_page_preview=True, ) assert message.text_markdown == test_markdown_string @@ -2846,21 +2966,16 @@ async def test_edit_message_text_default_parse_mode(self, default_bot, message): assert message.text == test_markdown_string assert message.text_markdown == escape_markdown(test_markdown_string) + suffix = " edited" message = await default_bot.edit_message_text( - text=test_markdown_string, - chat_id=message.chat_id, - message_id=message.message_id, - disable_web_page_preview=True, - ) - message = await default_bot.edit_message_text( - text=test_markdown_string, + text=test_markdown_string + suffix, chat_id=message.chat_id, message_id=message.message_id, parse_mode="HTML", disable_web_page_preview=True, ) - assert message.text == test_markdown_string - assert message.text_markdown == escape_markdown(test_markdown_string) + assert message.text == test_markdown_string + suffix + assert message.text_markdown == escape_markdown(test_markdown_string) + suffix @pytest.mark.skip(reason="need reference to an inline message") async def test_edit_message_text_inline(self): @@ -2946,10 +3061,12 @@ async def test_edit_message_caption_with_parse_mode(self, bot, media_message): async def test_edit_message_caption_inline(self): pass - async def test_edit_reply_markup(self, bot, message): + async def test_edit_reply_markup(self, bot, one_time_message): new_markup = InlineKeyboardMarkup([[InlineKeyboardButton(text="test", callback_data="1")]]) message = await bot.edit_message_reply_markup( - chat_id=message.chat_id, message_id=message.message_id, reply_markup=new_markup + chat_id=one_time_message.chat_id, + message_id=one_time_message.message_id, + reply_markup=new_markup, ) assert message is not True @@ -2958,7 +3075,6 @@ async def test_edit_reply_markup(self, bot, message): async def test_edit_reply_markup_inline(self): pass - @pytest.mark.xdist_group("getUpdates_and_webhook") # TODO: Actually send updates to the test bot so this can be tested properly async def test_get_updates(self, bot): await bot.delete_webhook() # make sure there is no webhook set if webhook tests failed @@ -3025,7 +3141,6 @@ async def catch_timeouts(*args, **kwargs): await bot.get_updates(read_timeout=read_timeout, timeout=timeout) assert caught_read_timeout == expected - @pytest.mark.xdist_group("getUpdates_and_webhook") @pytest.mark.parametrize("use_ip", [True, False]) # local file path as file_input is tested below in test_set_webhook_params @pytest.mark.parametrize("file_input", ["bytes", "file_handle"]) @@ -3067,9 +3182,6 @@ async def test_leave_chat(self, bot): with pytest.raises(BadRequest, match="Chat not found"): await bot.leave_chat(-123456) - with pytest.raises(NetworkError, match="Chat not found"): - await bot.leave_chat(-123456) - async def test_get_chat(self, bot, super_group_id): cfi = await bot.get_chat(super_group_id) assert cfi.type == "supergroup" @@ -3091,7 +3203,7 @@ async def test_get_chat_member_count(self, bot, channel_id): async def test_get_chat_member(self, bot, channel_id, chat_id): chat_member = await bot.get_chat_member(channel_id, chat_id) - assert chat_member.status == "administrator" + assert chat_member.status == "creator" assert chat_member.user.first_name == "PTB" assert chat_member.user.last_name == "Test user" @@ -3163,10 +3275,8 @@ async def test_send_game_default_protect_content(self, default_bot, chat_id, val protected = await default_bot.send_game(chat_id, "test_game", protect_content=val) assert protected.has_protected_content is val - @pytest.mark.xdist_group("game") @xfail - async def test_set_game_score_1(self, bot, chat_id): - # NOTE: numbering of methods assures proper order between test_set_game_scoreX methods + async def test_set_game_score_and_high_scores(self, bot, chat_id): # First, test setting a score. game_short_name = "test_game" game = await bot.send_game(chat_id, game_short_name) @@ -3183,10 +3293,6 @@ async def test_set_game_score_1(self, bot, chat_id): assert message.game.animation.file_unique_id == game.game.animation.file_unique_id assert message.game.text != game.game.text - @pytest.mark.xdist_group("game") - @xfail - async def test_set_game_score_2(self, bot, chat_id): - # NOTE: numbering of methods assures proper order between test_set_game_scoreX methods # Test setting a score higher than previous game_short_name = "test_game" game = await bot.send_game(chat_id, game_short_name) @@ -3206,10 +3312,6 @@ async def test_set_game_score_2(self, bot, chat_id): assert message.game.animation.file_unique_id == game.game.animation.file_unique_id assert message.game.text == game.game.text - @pytest.mark.xdist_group("game") - @xfail - async def test_set_game_score_3(self, bot, chat_id): - # NOTE: numbering of methods assures proper order between test_set_game_scoreX methods # Test setting a score lower than previous (should raise error) game_short_name = "test_game" game = await bot.send_game(chat_id, game_short_name) @@ -3221,10 +3323,6 @@ async def test_set_game_score_3(self, bot, chat_id): user_id=chat_id, score=score, chat_id=game.chat_id, message_id=game.message_id ) - @pytest.mark.xdist_group("game") - @xfail - async def test_set_game_score_4(self, bot, chat_id): - # NOTE: numbering of methods assures proper order between test_set_game_scoreX methods # Test force setting a lower score game_short_name = "test_game" game = await bot.send_game(chat_id, game_short_name) @@ -3249,9 +3347,6 @@ async def test_set_game_score_4(self, bot, chat_id): game2 = await bot.send_game(chat_id, game_short_name) assert str(score) in game2.game.text - @pytest.mark.xdist_group("game") - @xfail - async def test_get_game_high_scores(self, bot, chat_id): # We need a game to get the scores for game_short_name = "test_game" game = await bot.send_game(chat_id, game_short_name) @@ -3265,7 +3360,7 @@ async def test_promote_chat_member(self, bot, channel_id, monkeypatch): with pytest.raises(BadRequest, match="Not enough rights"): assert await bot.promote_chat_member( channel_id, - 95205500, + 1325859552, is_anonymous=True, can_change_info=True, can_post_messages=True, @@ -3288,7 +3383,7 @@ async def make_assertion(*args, **_): data = args[1] return ( data.get("chat_id") == channel_id - and data.get("user_id") == 95205500 + and data.get("user_id") == 1325859552 and data.get("is_anonymous") == 1 and data.get("can_change_info") == 2 and data.get("can_post_messages") == 3 @@ -3309,7 +3404,7 @@ async def make_assertion(*args, **_): monkeypatch.setattr(bot, "_post", make_assertion) assert await bot.promote_chat_member( channel_id, - 95205500, + 1325859552, is_anonymous=1, can_change_info=2, can_post_messages=3, @@ -3912,14 +4007,12 @@ async def test_copy_message_with_default(self, default_bot, chat_id, media_messa assert len(message.caption_entities) == 0 async def test_copy_messages(self, bot, chat_id): - tasks = asyncio.gather( - bot.send_message(chat_id, text="will be copied 1"), - bot.send_message(chat_id, text="will be copied 2"), - ) - msg1, msg2 = await tasks + # not using gather here to have deterministically ordered message_ids + msg1 = await bot.send_message(chat_id, text="will be copied 1") + msg2 = await bot.send_message(chat_id, text="will be copied 2") copy_messages = await bot.copy_messages( - chat_id, from_chat_id=chat_id, message_ids=sorted((msg1.message_id, msg2.message_id)) + chat_id, from_chat_id=chat_id, message_ids=(msg1.message_id, msg2.message_id) ) assert isinstance(copy_messages, tuple) @@ -4032,7 +4125,7 @@ async def test_replace_callback_data_copy_message(self, cdc_bot, chat_id): bot.callback_data_cache.clear_callback_data() bot.callback_data_cache.clear_callback_queries() - async def test_get_chat_arbitrary_callback_data(self, channel_id, cdc_bot): + async def test_get_chat_arbitrary_callback_data(self, chat_id, cdc_bot): bot = cdc_bot try: @@ -4041,7 +4134,7 @@ async def test_get_chat_arbitrary_callback_data(self, channel_id, cdc_bot): ) message = await bot.send_message( - channel_id, text="get_chat_arbitrary_callback_data", reply_markup=reply_markup + chat_id, text="get_chat_arbitrary_callback_data", reply_markup=reply_markup ) await message.pin() @@ -4051,7 +4144,11 @@ async def test_get_chat_arbitrary_callback_data(self, channel_id, cdc_bot): ) assert data == "callback_data" - cfi = await bot.get_chat(channel_id) + cfi = await bot.get_chat(chat_id) + + if not cfi.pinned_message: + pytest.xfail("Pinning messages is not always reliable on TG") + assert cfi.pinned_message == message assert cfi.pinned_message.reply_markup == reply_markup assert await message.unpin() # (not placed in finally block since msg can be unbound) @@ -4155,9 +4252,9 @@ async def test_set_get_my_short_description(self, bot): bot.get_my_short_description("de"), ) == 3 * [BotShortDescription("")] - async def test_set_message_reaction(self, bot, chat_id, message): + async def test_set_message_reaction(self, bot, chat_id, static_message): assert await bot.set_message_reaction( - chat_id, message.message_id, ReactionEmoji.THUMBS_DOWN, True + chat_id, static_message.message_id, ReactionEmoji.THUMBS_DOWN, True ) @pytest.mark.parametrize("bot_class", [Bot, ExtBot]) @@ -4259,3 +4356,23 @@ async def test_get_star_transactions(self, bot): transactions = await bot.get_star_transactions(limit=1) assert isinstance(transactions, StarTransactions) assert len(transactions.transactions) == 0 + + async def test_create_edit_chat_subscription_link( + self, bot, subscription_channel_id, channel_id + ): + sub_link = await bot.create_chat_subscription_invite_link( + subscription_channel_id, + name="sub_name", + subscription_period=2592000, + subscription_price=13, + ) + assert sub_link.name == "sub_name" + assert sub_link.subscription_period == 2592000 + assert sub_link.subscription_price == 13 + + edited_link = await bot.edit_chat_subscription_invite_link( + chat_id=subscription_channel_id, invite_link=sub_link, name="sub_name_2" + ) + assert edited_link.name == "sub_name_2" + assert sub_link.subscription_period == 2592000 + assert sub_link.subscription_price == 13 diff --git a/tests/test_botcommand.py b/tests/test_botcommand.py index 1e4a360e065..f38abb320ab 100644 --- a/tests/test_botcommand.py +++ b/tests/test_botcommand.py @@ -37,15 +37,15 @@ def test_slot_behaviour(self, bot_command): assert getattr(bot_command, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(bot_command)) == len(set(mro_slots(bot_command))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = {"command": self.command, "description": self.description} - bot_command = BotCommand.de_json(json_dict, bot) + bot_command = BotCommand.de_json(json_dict, offline_bot) assert bot_command.api_kwargs == {} assert bot_command.command == self.command assert bot_command.description == self.description - assert BotCommand.de_json(None, bot) is None + assert BotCommand.de_json(None, offline_bot) is None def test_to_dict(self, bot_command): bot_command_dict = bot_command.to_dict() diff --git a/tests/test_botcommandscope.py b/tests/test_botcommandscope.py index 63766b95e17..a4bddfc8f69 100644 --- a/tests/test_botcommandscope.py +++ b/tests/test_botcommandscope.py @@ -125,14 +125,14 @@ def test_slot_behaviour(self, bot_command_scope): set(mro_slots(bot_command_scope)) ), "duplicate slot" - def test_de_json(self, bot, scope_class_and_type, chat_id): + def test_de_json(self, offline_bot, scope_class_and_type, chat_id): cls = scope_class_and_type[0] type_ = scope_class_and_type[1] - assert cls.de_json({}, bot) is None + assert cls.de_json({}, offline_bot) is None json_dict = {"type": type_, "chat_id": chat_id, "user_id": 42} - bot_command_scope = BotCommandScope.de_json(json_dict, bot) + bot_command_scope = BotCommandScope.de_json(json_dict, offline_bot) assert set(bot_command_scope.api_kwargs.keys()) == {"chat_id", "user_id"} - set( cls.__slots__ ) @@ -145,18 +145,18 @@ def test_de_json(self, bot, scope_class_and_type, chat_id): if "user_id" in cls.__slots__: assert bot_command_scope.user_id == 42 - def test_de_json_invalid_type(self, bot): + def test_de_json_invalid_type(self, offline_bot): json_dict = {"type": "invalid", "chat_id": chat_id, "user_id": 42} - bot_command_scope = BotCommandScope.de_json(json_dict, bot) + bot_command_scope = BotCommandScope.de_json(json_dict, offline_bot) assert type(bot_command_scope) is BotCommandScope assert bot_command_scope.type == "invalid" - def test_de_json_subclass(self, scope_class, bot, chat_id): + def test_de_json_subclass(self, scope_class, offline_bot, chat_id): """This makes sure that e.g. BotCommandScopeDefault(data) never returns a BotCommandScopeChat instance.""" json_dict = {"type": "invalid", "chat_id": chat_id, "user_id": 42} - assert type(scope_class.de_json(json_dict, bot)) is scope_class + assert type(scope_class.de_json(json_dict, offline_bot)) is scope_class def test_to_dict(self, bot_command_scope): bot_command_scope_dict = bot_command_scope.to_dict() @@ -172,7 +172,7 @@ def test_type_enum_conversion(self): assert type(BotCommandScope("default").type) is BotCommandScopeType assert BotCommandScope("unknown").type == "unknown" - def test_equality(self, bot_command_scope, bot): + def test_equality(self, bot_command_scope, offline_bot): a = BotCommandScope("base_type") b = BotCommandScope("base_type") c = bot_command_scope @@ -200,7 +200,7 @@ def test_equality(self, bot_command_scope, bot): if hasattr(c, "chat_id"): json_dict = c.to_dict() json_dict["chat_id"] = 0 - f = c.__class__.de_json(json_dict, bot) + f = c.__class__.de_json(json_dict, offline_bot) assert c != f assert hash(c) != hash(f) @@ -208,7 +208,7 @@ def test_equality(self, bot_command_scope, bot): if hasattr(c, "user_id"): json_dict = c.to_dict() json_dict["user_id"] = 0 - g = c.__class__.de_json(json_dict, bot) + g = c.__class__.de_json(json_dict, offline_bot) assert c != g assert hash(c) != hash(g) diff --git a/tests/test_botdescription.py b/tests/test_botdescription.py index 4e84eb558c3..a75a88cb1a7 100644 --- a/tests/test_botdescription.py +++ b/tests/test_botdescription.py @@ -24,20 +24,20 @@ @pytest.fixture(scope="module") def bot_description(bot): - return BotDescription(TestBotDescriptionBase.description) + return BotDescription(BotDescriptionTestBase.description) @pytest.fixture(scope="module") def bot_short_description(bot): - return BotShortDescription(TestBotDescriptionBase.short_description) + return BotShortDescription(BotDescriptionTestBase.short_description) -class TestBotDescriptionBase: +class BotDescriptionTestBase: description = "This is a test description" short_description = "This is a test short description" -class TestBotDescriptionWithoutRequest(TestBotDescriptionBase): +class TestBotDescriptionWithoutRequest(BotDescriptionTestBase): def test_slot_behaviour(self, bot_description): for attr in bot_description.__slots__: assert getattr(bot_description, attr, "err") != "err", f"got extra slot '{attr}'" @@ -64,7 +64,7 @@ def test_equality(self): assert hash(a) != hash(c) -class TestBotShortDescriptionWithoutRequest(TestBotDescriptionBase): +class TestBotShortDescriptionWithoutRequest(BotDescriptionTestBase): def test_slot_behaviour(self, bot_short_description): for attr in bot_short_description.__slots__: assert getattr(bot_short_description, attr, "err") != "err", f"got extra slot '{attr}'" diff --git a/tests/test_botname.py b/tests/test_botname.py index 3fadfa76b4b..4edefae3943 100644 --- a/tests/test_botname.py +++ b/tests/test_botname.py @@ -24,14 +24,14 @@ @pytest.fixture(scope="module") def bot_name(bot): - return BotName(TestBotNameBase.name) + return BotName(BotNameTestBase.name) -class TestBotNameBase: +class BotNameTestBase: name = "This is a test name" -class TestBotNameWithoutRequest(TestBotNameBase): +class TestBotNameWithoutRequest(BotNameTestBase): def test_slot_behaviour(self, bot_name): for attr in bot_name.__slots__: assert getattr(bot_name, attr, "err") != "err", f"got extra slot '{attr}'" diff --git a/tests/test_business.py b/tests/test_business.py index da6838d6d47..3d24c1fa449 100644 --- a/tests/test_business.py +++ b/tests/test_business.py @@ -16,7 +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/]. -from datetime import datetime +import datetime as dtm import pytest @@ -36,11 +36,11 @@ from tests.auxil.slots import mro_slots -class TestBusinessBase: +class BusinessTestBase: id_ = "123" user = User(123, "test_user", False) user_chat_id = 123 - date = datetime.now(tz=UTC).replace(microsecond=0) + date = dtm.datetime.now(tz=UTC).replace(microsecond=0) can_reply = True is_enabled = True message_ids = (123, 321) @@ -62,58 +62,58 @@ class TestBusinessBase: @pytest.fixture(scope="module") def business_connection(): return BusinessConnection( - TestBusinessBase.id_, - TestBusinessBase.user, - TestBusinessBase.user_chat_id, - TestBusinessBase.date, - TestBusinessBase.can_reply, - TestBusinessBase.is_enabled, + BusinessTestBase.id_, + BusinessTestBase.user, + BusinessTestBase.user_chat_id, + BusinessTestBase.date, + BusinessTestBase.can_reply, + BusinessTestBase.is_enabled, ) @pytest.fixture(scope="module") def business_messages_deleted(): return BusinessMessagesDeleted( - TestBusinessBase.business_connection_id, - TestBusinessBase.chat, - TestBusinessBase.message_ids, + BusinessTestBase.business_connection_id, + BusinessTestBase.chat, + BusinessTestBase.message_ids, ) @pytest.fixture(scope="module") def business_intro(): return BusinessIntro( - TestBusinessBase.title, - TestBusinessBase.message, - TestBusinessBase.sticker, + BusinessTestBase.title, + BusinessTestBase.message, + BusinessTestBase.sticker, ) @pytest.fixture(scope="module") def business_location(): return BusinessLocation( - TestBusinessBase.address, - TestBusinessBase.location, + BusinessTestBase.address, + BusinessTestBase.location, ) @pytest.fixture(scope="module") def business_opening_hours_interval(): return BusinessOpeningHoursInterval( - TestBusinessBase.opening_minute, - TestBusinessBase.closing_minute, + BusinessTestBase.opening_minute, + BusinessTestBase.closing_minute, ) @pytest.fixture(scope="module") def business_opening_hours(): return BusinessOpeningHours( - TestBusinessBase.time_zone_name, - TestBusinessBase.opening_hours, + BusinessTestBase.time_zone_name, + BusinessTestBase.opening_hours, ) -class TestBusinessConnectionWithoutRequest(TestBusinessBase): +class TestBusinessConnectionWithoutRequest(BusinessTestBase): def test_slots(self, business_connection): bc = business_connection for attr in bc.__slots__: @@ -139,7 +139,7 @@ def test_de_json(self): assert bc.api_kwargs == {} assert isinstance(bc, BusinessConnection) - def test_de_json_localization(self, bot, raw_bot, tz_bot): + def test_de_json_localization(self, offline_bot, raw_bot, tz_bot): json_dict = { "id": self.id_, "user": self.user.to_dict(), @@ -148,7 +148,7 @@ def test_de_json_localization(self, bot, raw_bot, tz_bot): "can_reply": self.can_reply, "is_enabled": self.is_enabled, } - chat_bot = BusinessConnection.de_json(json_dict, bot) + chat_bot = BusinessConnection.de_json(json_dict, offline_bot) chat_bot_raw = BusinessConnection.de_json(json_dict, raw_bot) chat_bot_tz = BusinessConnection.de_json(json_dict, tz_bot) @@ -188,7 +188,7 @@ def test_equality(self): assert hash(bc1) != hash(bc3) -class TestBusinessMessagesDeleted(TestBusinessBase): +class TestBusinessMessagesDeleted(BusinessTestBase): def test_slots(self, business_messages_deleted): bmd = business_messages_deleted for attr in bmd.__slots__: @@ -227,7 +227,7 @@ def test_equality(self): assert hash(bmd1) != hash(bmd3) -class TestBusinessIntroWithoutRequest(TestBusinessBase): +class TestBusinessIntroWithoutRequest(BusinessTestBase): def test_slot_behaviour(self, business_intro): intro = business_intro for attr in intro.__slots__: @@ -267,7 +267,7 @@ def test_equality(self): assert hash(intro1) != hash(intro3) -class TestBusinessLocationWithoutRequest(TestBusinessBase): +class TestBusinessLocationWithoutRequest(BusinessTestBase): def test_slot_behaviour(self, business_location): inst = business_location for attr in inst.__slots__: @@ -304,7 +304,7 @@ def test_equality(self): assert hash(blc1) != hash(blc3) -class TestBusinessOpeningHoursIntervalWithoutRequest(TestBusinessBase): +class TestBusinessOpeningHoursIntervalWithoutRequest(BusinessTestBase): def test_slot_behaviour(self, business_opening_hours_interval): inst = business_opening_hours_interval for attr in inst.__slots__: @@ -375,7 +375,7 @@ def test_closing_time(self, closing_minute, expected): assert cached is closing_time -class TestBusinessOpeningHoursWithoutRequest(TestBusinessBase): +class TestBusinessOpeningHoursWithoutRequest(BusinessTestBase): def test_slot_behaviour(self, business_opening_hours): inst = business_opening_hours for attr in inst.__slots__: diff --git a/tests/test_callbackquery.py b/tests/test_callbackquery.py index 5e41b5993cf..c4fd3d204b7 100644 --- a/tests/test_callbackquery.py +++ b/tests/test_callbackquery.py @@ -17,7 +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/]. -from datetime import datetime +import datetime as dtm import pytest @@ -33,38 +33,40 @@ @pytest.fixture(params=["message", "inline", "inaccessible_message"]) def callback_query(bot, request): cbq = CallbackQuery( - TestCallbackQueryBase.id_, - TestCallbackQueryBase.from_user, - TestCallbackQueryBase.chat_instance, - data=TestCallbackQueryBase.data, - game_short_name=TestCallbackQueryBase.game_short_name, + CallbackQueryTestBase.id_, + CallbackQueryTestBase.from_user, + CallbackQueryTestBase.chat_instance, + data=CallbackQueryTestBase.data, + game_short_name=CallbackQueryTestBase.game_short_name, ) cbq.set_bot(bot) cbq._unfreeze() if request.param == "message": - cbq.message = TestCallbackQueryBase.message + cbq.message = CallbackQueryTestBase.message cbq.message.set_bot(bot) elif request.param == "inline": - cbq.inline_message_id = TestCallbackQueryBase.inline_message_id + cbq.inline_message_id = CallbackQueryTestBase.inline_message_id elif request.param == "inaccessible_message": cbq.message = InaccessibleMessage( - chat=TestCallbackQueryBase.message.chat, - message_id=TestCallbackQueryBase.message.message_id, + chat=CallbackQueryTestBase.message.chat, + message_id=CallbackQueryTestBase.message.message_id, ) return cbq -class TestCallbackQueryBase: +class CallbackQueryTestBase: id_ = "id" from_user = User(1, "test_user", False) chat_instance = "chat_instance" - message = Message(3, datetime.utcnow(), Chat(4, "private"), from_user=User(5, "bot", False)) + message = Message( + 3, dtm.datetime.utcnow(), Chat(4, "private"), from_user=User(5, "bot", False) + ) data = "data" inline_message_id = "inline_message_id" game_short_name = "the_game" -class TestCallbackQueryWithoutRequest(TestCallbackQueryBase): +class TestCallbackQueryWithoutRequest(CallbackQueryTestBase): @staticmethod def skip_params(callback_query: CallbackQuery): if callback_query.inline_message_id: @@ -94,7 +96,7 @@ def test_slot_behaviour(self, callback_query): assert getattr(callback_query, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(callback_query)) == len(set(mro_slots(callback_query))), "same slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "id": self.id_, "from": self.from_user.to_dict(), @@ -104,7 +106,7 @@ def test_de_json(self, bot): "inline_message_id": self.inline_message_id, "game_short_name": self.game_short_name, } - callback_query = CallbackQuery.de_json(json_dict, bot) + callback_query = CallbackQuery.de_json(json_dict, offline_bot) assert callback_query.api_kwargs == {} assert callback_query.id == self.id_ @@ -465,11 +467,14 @@ async def make_assertion(*args, **kwargs): assert check_shortcut_signature( CallbackQuery.pin_message, Bot.pin_chat_message, - ["message_id", "chat_id"], + ["message_id", "chat_id", "business_connection_id"], [], ) assert await check_shortcut_call( - callback_query.pin_message, callback_query.get_bot(), "pin_chat_message" + callback_query.pin_message, + callback_query.get_bot(), + "pin_chat_message", + ["business_connection_id"], ) assert await check_defaults_handling(callback_query.pin_message, callback_query.get_bot()) @@ -490,14 +495,15 @@ async def make_assertion(*args, **kwargs): assert check_shortcut_signature( CallbackQuery.unpin_message, Bot.unpin_chat_message, - ["message_id", "chat_id"], + ["message_id", "chat_id", "business_connection_id"], [], ) assert await check_shortcut_call( callback_query.unpin_message, callback_query.get_bot(), "unpin_chat_message", - shortcut_kwargs=["message_id", "chat_id"], + shortcut_kwargs=["message_id"], + skip_params=["business_connection_id"], ) assert await check_defaults_handling( callback_query.unpin_message, callback_query.get_bot() diff --git a/tests/test_chat.py b/tests/test_chat.py index 682bdbe514a..b2db4e36f76 100644 --- a/tests/test_chat.py +++ b/tests/test_chat.py @@ -34,20 +34,20 @@ @pytest.fixture(scope="module") def chat(bot): chat = Chat( - TestChatBase.id_, - title=TestChatBase.title, - type=TestChatBase.type_, - username=TestChatBase.username, + ChatTestBase.id_, + title=ChatTestBase.title, + type=ChatTestBase.type_, + username=ChatTestBase.username, is_forum=True, - first_name=TestChatBase.first_name, - last_name=TestChatBase.last_name, + first_name=ChatTestBase.first_name, + last_name=ChatTestBase.last_name, ) chat.set_bot(bot) chat._unfreeze() return chat -class TestChatBase: +class ChatTestBase: id_ = -28767330 title = "ToledosPalaceBot - Group" type_ = "group" @@ -57,13 +57,13 @@ class TestChatBase: last_name = "last" -class TestChatWithoutRequest(TestChatBase): +class TestChatWithoutRequest(ChatTestBase): def test_slot_behaviour(self, chat): for attr in chat.__slots__: assert getattr(chat, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(chat)) == len(set(mro_slots(chat))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "id": self.id_, "title": self.title, @@ -73,7 +73,7 @@ def test_de_json(self, bot): "first_name": self.first_name, "last_name": self.last_name, } - chat = Chat.de_json(json_dict, bot) + chat = Chat.de_json(json_dict, offline_bot) assert chat.id == self.id_ assert chat.title == self.title @@ -889,6 +889,54 @@ async def make_assertion(*_, **kwargs): monkeypatch.setattr(chat.get_bot(), "revoke_chat_invite_link", make_assertion) assert await chat.revoke_invite_link(invite_link=link) + async def test_create_subscription_invite_link(self, monkeypatch, chat): + async def make_assertion(*_, **kwargs): + return ( + kwargs["chat_id"] == chat.id + and kwargs["subscription_price"] == 42 + and kwargs["subscription_period"] == 42 + ) + + assert check_shortcut_signature( + Chat.create_subscription_invite_link, + Bot.create_chat_subscription_invite_link, + ["chat_id"], + [], + ) + assert await check_shortcut_call( + chat.create_subscription_invite_link, + chat.get_bot(), + "create_chat_subscription_invite_link", + ) + assert await check_defaults_handling(chat.create_subscription_invite_link, chat.get_bot()) + + monkeypatch.setattr(chat.get_bot(), "create_chat_subscription_invite_link", make_assertion) + assert await chat.create_subscription_invite_link( + subscription_price=42, subscription_period=42 + ) + + async def test_edit_subscription_invite_link(self, monkeypatch, chat): + link = "ThisIsALink" + + async def make_assertion(*_, **kwargs): + return kwargs["chat_id"] == chat.id and kwargs["invite_link"] == link + + assert check_shortcut_signature( + Chat.edit_subscription_invite_link, + Bot.edit_chat_subscription_invite_link, + ["chat_id"], + [], + ) + assert await check_shortcut_call( + chat.edit_subscription_invite_link, + chat.get_bot(), + "edit_chat_subscription_invite_link", + ) + assert await check_defaults_handling(chat.edit_subscription_invite_link, chat.get_bot()) + + monkeypatch.setattr(chat.get_bot(), "edit_chat_subscription_invite_link", make_assertion) + assert await chat.edit_subscription_invite_link(invite_link=link) + async def test_instance_method_get_menu_button(self, monkeypatch, chat): async def make_assertion(*_, **kwargs): return kwargs["chat_id"] == chat.id @@ -1251,6 +1299,7 @@ async def make_assertion(*_, **kwargs): and kwargs["media"] == "media" and kwargs["star_count"] == 42 and kwargs["caption"] == "stars" + and kwargs["payload"] == "payload" ) assert check_shortcut_signature(Chat.send_paid_media, Bot.send_paid_media, ["chat_id"], []) @@ -1258,7 +1307,31 @@ async def make_assertion(*_, **kwargs): assert await check_defaults_handling(chat.send_paid_media, chat.get_bot()) monkeypatch.setattr(chat.get_bot(), "send_paid_media", make_assertion) - assert await chat.send_paid_media(media="media", star_count=42, caption="stars") + assert await chat.send_paid_media( + media="media", star_count=42, caption="stars", payload="payload" + ) + + async def test_instance_method_send_gift(self, monkeypatch, chat): + async def make_assertion(*_, **kwargs): + return ( + kwargs["user_id"] == chat.id + and kwargs["gift_id"] == "gift_id" + and kwargs["text"] == "text" + and kwargs["text_parse_mode"] == "text_parse_mode" + and kwargs["text_entities"] == "text_entities" + ) + + assert check_shortcut_signature(Chat.send_gift, Bot.send_gift, ["user_id"], []) + assert await check_shortcut_call(chat.send_gift, chat.get_bot(), "send_gift") + assert await check_defaults_handling(chat.send_gift, chat.get_bot()) + + monkeypatch.setattr(chat.get_bot(), "send_gift", make_assertion) + assert await chat.send_gift( + gift_id="gift_id", + text="text", + text_parse_mode="text_parse_mode", + text_entities="text_entities", + ) def test_mention_html(self): chat = Chat(id=1, type="foo") diff --git a/tests/test_chatadministratorrights.py b/tests/test_chatadministratorrights.py index e630693c2d7..e15de43c730 100644 --- a/tests/test_chatadministratorrights.py +++ b/tests/test_chatadministratorrights.py @@ -50,7 +50,7 @@ def test_slot_behaviour(self, chat_admin_rights): assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json(self, bot, chat_admin_rights): + def test_de_json(self, offline_bot, chat_admin_rights): json_dict = { "can_change_info": True, "can_delete_messages": True, @@ -68,7 +68,7 @@ def test_de_json(self, bot, chat_admin_rights): "can_edit_stories": True, "can_delete_stories": True, } - chat_administrator_rights_de = ChatAdministratorRights.de_json(json_dict, bot) + chat_administrator_rights_de = ChatAdministratorRights.de_json(json_dict, offline_bot) assert chat_administrator_rights_de.api_kwargs == {} assert chat_admin_rights == chat_administrator_rights_de diff --git a/tests/test_chatbackground.py b/tests/test_chatbackground.py index 1f8be1eb451..ccf90d41147 100644 --- a/tests/test_chatbackground.py +++ b/tests/test_chatbackground.py @@ -146,7 +146,7 @@ def iter_args( yield inst_at, json_at -@pytest.fixture() +@pytest.fixture def background_type(request): return request.param() @@ -168,12 +168,12 @@ def test_slot_behaviour(self, background_type): assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json_required_args(self, bot, background_type): + def test_de_json_required_args(self, offline_bot, background_type): cls = background_type.__class__ - assert cls.de_json({}, bot) is None + assert cls.de_json({}, offline_bot) is None json_dict = make_json_dict(background_type) - const_background_type = BackgroundType.de_json(json_dict, bot) + const_background_type = BackgroundType.de_json(json_dict, offline_bot) assert const_background_type.api_kwargs == {} assert isinstance(const_background_type, BackgroundType) @@ -181,9 +181,9 @@ def test_de_json_required_args(self, bot, background_type): for bg_type_at, const_bg_type_at in iter_args(background_type, const_background_type): assert bg_type_at == const_bg_type_at - def test_de_json_all_args(self, bot, background_type): + def test_de_json_all_args(self, offline_bot, background_type): json_dict = make_json_dict(background_type, include_optional_args=True) - const_background_type = BackgroundType.de_json(json_dict, bot) + const_background_type = BackgroundType.de_json(json_dict, offline_bot) assert const_background_type.api_kwargs == {} @@ -194,19 +194,19 @@ def test_de_json_all_args(self, bot, background_type): ): assert bg_type_at == const_bg_type_at - def test_de_json_invalid_type(self, background_type, bot): + def test_de_json_invalid_type(self, background_type, offline_bot): json_dict = {"type": "invalid", "theme_name": BTDefaults.theme_name} - background_type = BackgroundType.de_json(json_dict, bot) + background_type = BackgroundType.de_json(json_dict, offline_bot) assert type(background_type) is BackgroundType assert background_type.type == "invalid" - def test_de_json_subclass(self, background_type, bot, chat_id): - """This makes sure that e.g. BackgroundTypeFill(data, bot) never returns a + def test_de_json_subclass(self, background_type, offline_bot, chat_id): + """This makes sure that e.g. BackgroundTypeFill(data, offline_bot) never returns a BackgroundTypeWallpaper instance.""" cls = background_type.__class__ json_dict = make_json_dict(background_type, True) - assert type(cls.de_json(json_dict, bot)) is cls + assert type(cls.de_json(json_dict, offline_bot)) is cls def test_to_dict(self, background_type): bg_type_dict = background_type.to_dict() @@ -254,7 +254,7 @@ def test_equality(self, background_type): assert hash(f) != hash(c) -@pytest.fixture() +@pytest.fixture def background_fill(request): return request.param() @@ -275,12 +275,12 @@ def test_slot_behaviour(self, background_fill): assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json_required_args(self, bot, background_fill): + def test_de_json_required_args(self, offline_bot, background_fill): cls = background_fill.__class__ - assert cls.de_json({}, bot) is None + assert cls.de_json({}, offline_bot) is None json_dict = make_json_dict(background_fill) - const_background_fill = BackgroundFill.de_json(json_dict, bot) + const_background_fill = BackgroundFill.de_json(json_dict, offline_bot) assert const_background_fill.api_kwargs == {} assert isinstance(const_background_fill, BackgroundFill) @@ -288,9 +288,9 @@ def test_de_json_required_args(self, bot, background_fill): for bg_fill_at, const_bg_fill_at in iter_args(background_fill, const_background_fill): assert bg_fill_at == const_bg_fill_at - def test_de_json_all_args(self, bot, background_fill): + def test_de_json_all_args(self, offline_bot, background_fill): json_dict = make_json_dict(background_fill, include_optional_args=True) - const_background_fill = BackgroundFill.de_json(json_dict, bot) + const_background_fill = BackgroundFill.de_json(json_dict, offline_bot) assert const_background_fill.api_kwargs == {} @@ -301,19 +301,19 @@ def test_de_json_all_args(self, bot, background_fill): ): assert bg_fill_at == const_bg_fill_at - def test_de_json_invalid_type(self, background_fill, bot): + def test_de_json_invalid_type(self, background_fill, offline_bot): json_dict = {"type": "invalid", "theme_name": BTDefaults.theme_name} - background_fill = BackgroundFill.de_json(json_dict, bot) + background_fill = BackgroundFill.de_json(json_dict, offline_bot) assert type(background_fill) is BackgroundFill assert background_fill.type == "invalid" - def test_de_json_subclass(self, background_fill, bot): - """This makes sure that e.g. BackgroundFillSolid(data, bot) never returns a + def test_de_json_subclass(self, background_fill, offline_bot): + """This makes sure that e.g. BackgroundFillSolid(data, offline_bot) never returns a BackgroundFillGradient instance.""" cls = background_fill.__class__ json_dict = make_json_dict(background_fill, True) - assert type(cls.de_json(json_dict, bot)) is cls + assert type(cls.de_json(json_dict, offline_bot)) is cls def test_to_dict(self, background_fill): bg_fill_dict = background_fill.to_dict() diff --git a/tests/test_chatboost.py b/tests/test_chatboost.py index bc33e1fe21e..1f1d71ad56b 100644 --- a/tests/test_chatboost.py +++ b/tests/test_chatboost.py @@ -15,7 +15,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 +import datetime as dtm import inspect from copy import deepcopy @@ -48,8 +48,9 @@ class ChatBoostDefaults: is_unclaimed = False chat = Chat(1, "group") user = User(1, "user", False) - date = to_timestamp(datetime.datetime.utcnow()) + date = to_timestamp(dtm.datetime.utcnow()) default_source = ChatBoostSourcePremium(user) + prize_star_count = 99 @pytest.fixture(scope="module") @@ -91,6 +92,7 @@ def chat_boost_source_giveaway(): user=ChatBoostDefaults.user, giveaway_message_id=ChatBoostDefaults.giveaway_message_id, is_unclaimed=ChatBoostDefaults.is_unclaimed, + prize_star_count=ChatBoostDefaults.prize_star_count, ) @@ -107,7 +109,7 @@ def user_chat_boosts(chat_boost): ) -@pytest.fixture() +@pytest.fixture def chat_boost_source(request): return request.param() @@ -146,7 +148,7 @@ def iter_args( if param.name in ignored: continue inst_at, json_at = getattr(instance, param.name), getattr(de_json_inst, param.name) - if isinstance(json_at, datetime.datetime): # Convert datetime to int + if isinstance(json_at, dtm.datetime): # Convert dtm to int json_at = to_timestamp(json_at) if ( param.default is not inspect.Parameter.empty and include_optional @@ -170,13 +172,13 @@ def test_slot_behaviour(self, chat_boost_source): assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json_required_args(self, bot, chat_boost_source): + def test_de_json_required_args(self, offline_bot, chat_boost_source): cls = chat_boost_source.__class__ - assert cls.de_json({}, bot) is None - assert ChatBoost.de_json({}, bot) is None + assert cls.de_json({}, offline_bot) is None + assert ChatBoost.de_json({}, offline_bot) is None json_dict = make_json_dict(chat_boost_source) - const_boost_source = ChatBoostSource.de_json(json_dict, bot) + const_boost_source = ChatBoostSource.de_json(json_dict, offline_bot) assert const_boost_source.api_kwargs == {} assert isinstance(const_boost_source, ChatBoostSource) @@ -186,9 +188,9 @@ def test_de_json_required_args(self, bot, chat_boost_source): ): assert chat_mem_type_at == const_chat_mem_at - def test_de_json_all_args(self, bot, chat_boost_source): + def test_de_json_all_args(self, offline_bot, chat_boost_source): json_dict = make_json_dict(chat_boost_source, include_optional_args=True) - const_boost_source = ChatBoostSource.de_json(json_dict, bot) + const_boost_source = ChatBoostSource.de_json(json_dict, offline_bot) assert const_boost_source.api_kwargs == {} assert isinstance(const_boost_source, ChatBoostSource) @@ -198,19 +200,19 @@ def test_de_json_all_args(self, bot, chat_boost_source): ): assert c_mem_type_at == const_c_mem_at - def test_de_json_invalid_source(self, chat_boost_source, bot): + def test_de_json_invalid_source(self, chat_boost_source, offline_bot): json_dict = {"source": "invalid"} - chat_boost_source = ChatBoostSource.de_json(json_dict, bot) + chat_boost_source = ChatBoostSource.de_json(json_dict, offline_bot) assert type(chat_boost_source) is ChatBoostSource assert chat_boost_source.source == "invalid" - def test_de_json_subclass(self, chat_boost_source, bot): - """This makes sure that e.g. ChatBoostSourcePremium(data, bot) never returns a + def test_de_json_subclass(self, chat_boost_source, offline_bot): + """This makes sure that e.g. ChatBoostSourcePremium(data, offline_bot) never returns a ChatBoostSourceGiftCode instance.""" cls = chat_boost_source.__class__ json_dict = make_json_dict(chat_boost_source, True) - assert type(cls.de_json(json_dict, bot)) is cls + assert type(cls.de_json(json_dict, offline_bot)) is cls def test_to_dict(self, chat_boost_source): chat_boost_dict = chat_boost_source.to_dict() @@ -263,18 +265,18 @@ def test_slot_behaviour(self, chat_boost): assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json(self, bot, chat_boost): + def test_de_json(self, offline_bot, chat_boost): json_dict = { "boost_id": "2", "add_date": self.date, "expiration_date": self.date, "source": self.default_source.to_dict(), } - cb = ChatBoost.de_json(json_dict, bot) + cb = ChatBoost.de_json(json_dict, offline_bot) assert isinstance(cb, ChatBoost) - assert isinstance(cb.add_date, datetime.datetime) - assert isinstance(cb.expiration_date, datetime.datetime) + assert isinstance(cb.add_date, dtm.datetime) + assert isinstance(cb.expiration_date, dtm.datetime) assert isinstance(cb.source, ChatBoostSource) with cb._unfrozen(): cb.add_date = to_timestamp(cb.add_date) @@ -284,7 +286,7 @@ def test_de_json(self, bot, chat_boost): for slot in cb.__slots__: assert getattr(cb, slot) == getattr(chat_boost, slot), f"attribute {slot} differs" - def test_de_json_localization(self, bot, raw_bot, tz_bot): + def test_de_json_localization(self, offline_bot, raw_bot, tz_bot): json_dict = { "boost_id": "2", "add_date": self.date, @@ -292,7 +294,7 @@ def test_de_json_localization(self, bot, raw_bot, tz_bot): "source": self.default_source.to_dict(), } - cb_bot = ChatBoost.de_json(json_dict, bot) + cb_bot = ChatBoost.de_json(json_dict, offline_bot) cb_raw = ChatBoost.de_json(json_dict, raw_bot) cb_tz = ChatBoost.de_json(json_dict, tz_bot) @@ -347,7 +349,7 @@ def test_slot_behaviour(self, chat_boost_updated): assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json(self, bot, chat_boost): + def test_de_json(self, offline_bot, chat_boost): json_dict = { "chat": self.chat.to_dict(), "boost": { @@ -357,7 +359,7 @@ def test_de_json(self, bot, chat_boost): "source": self.default_source.to_dict(), }, } - cbu = ChatBoostUpdated.de_json(json_dict, bot) + cbu = ChatBoostUpdated.de_json(json_dict, offline_bot) assert isinstance(cbu, ChatBoostUpdated) assert cbu.chat == self.chat @@ -420,14 +422,14 @@ def test_slot_behaviour(self, chat_boost_removed): assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json(self, bot, chat_boost_removed): + def test_de_json(self, offline_bot, chat_boost_removed): json_dict = { "chat": self.chat.to_dict(), "boost_id": "2", "remove_date": self.date, "source": self.default_source.to_dict(), } - cbr = ChatBoostRemoved.de_json(json_dict, bot) + cbr = ChatBoostRemoved.de_json(json_dict, offline_bot) assert isinstance(cbr, ChatBoostRemoved) assert cbr.chat == self.chat @@ -435,7 +437,7 @@ def test_de_json(self, bot, chat_boost_removed): assert to_timestamp(cbr.remove_date) == self.date assert cbr.source == self.default_source - def test_de_json_localization(self, bot, raw_bot, tz_bot): + def test_de_json_localization(self, offline_bot, raw_bot, tz_bot): json_dict = { "chat": self.chat.to_dict(), "boost_id": "2", @@ -443,7 +445,7 @@ def test_de_json_localization(self, bot, raw_bot, tz_bot): "source": self.default_source.to_dict(), } - cbr_bot = ChatBoostRemoved.de_json(json_dict, bot) + cbr_bot = ChatBoostRemoved.de_json(json_dict, offline_bot) cbr_raw = ChatBoostRemoved.de_json(json_dict, raw_bot) cbr_tz = ChatBoostRemoved.de_json(json_dict, tz_bot) @@ -498,7 +500,7 @@ def test_slot_behaviour(self, user_chat_boosts): assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json(self, bot, user_chat_boosts): + def test_de_json(self, offline_bot, user_chat_boosts): json_dict = { "boosts": [ { @@ -509,7 +511,7 @@ def test_de_json(self, bot, user_chat_boosts): } ] } - ucb = UserChatBoosts.de_json(json_dict, bot) + ucb = UserChatBoosts.de_json(json_dict, offline_bot) assert isinstance(ucb, UserChatBoosts) assert isinstance(ucb.boosts[0], ChatBoost) @@ -525,7 +527,7 @@ def test_to_dict(self, user_chat_boosts): assert isinstance(user_chat_boosts_dict["boosts"], list) assert user_chat_boosts_dict["boosts"][0] == user_chat_boosts.boosts[0].to_dict() - async def test_get_user_chat_boosts(self, monkeypatch, bot): + async def test_get_user_chat_boosts(self, monkeypatch, offline_bot): async def make_assertion(url, request_data: RequestData, *args, **kwargs): data = request_data.json_parameters chat_id = data["chat_id"] == "3" @@ -534,9 +536,9 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): pytest.fail("I got wrong parameters in post") return data - monkeypatch.setattr(bot.request, "post", make_assertion) + monkeypatch.setattr(offline_bot.request, "post", make_assertion) - assert await bot.get_user_chat_boosts("3", 2) + assert await offline_bot.get_user_chat_boosts("3", 2) class TestUserChatBoostsWithRequest(ChatBoostDefaults): diff --git a/tests/test_chatfullinfo.py b/tests/test_chatfullinfo.py index ee9d697ca71..bf9880d1b4f 100644 --- a/tests/test_chatfullinfo.py +++ b/tests/test_chatfullinfo.py @@ -16,7 +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 +import datetime as dtm import pytest @@ -42,47 +42,47 @@ @pytest.fixture(scope="module") def chat_full_info(bot): chat = ChatFullInfo( - TestChatFullInfoBase.id_, - type=TestChatFullInfoBase.type_, - accent_color_id=TestChatFullInfoBase.accent_color_id, - max_reaction_count=TestChatFullInfoBase.max_reaction_count, - title=TestChatFullInfoBase.title, - username=TestChatFullInfoBase.username, - sticker_set_name=TestChatFullInfoBase.sticker_set_name, - can_set_sticker_set=TestChatFullInfoBase.can_set_sticker_set, - permissions=TestChatFullInfoBase.permissions, - slow_mode_delay=TestChatFullInfoBase.slow_mode_delay, - bio=TestChatFullInfoBase.bio, - linked_chat_id=TestChatFullInfoBase.linked_chat_id, - location=TestChatFullInfoBase.location, - has_private_forwards=TestChatFullInfoBase.has_private_forwards, - has_protected_content=TestChatFullInfoBase.has_protected_content, - has_visible_history=TestChatFullInfoBase.has_visible_history, - join_to_send_messages=TestChatFullInfoBase.join_to_send_messages, - join_by_request=TestChatFullInfoBase.join_by_request, + ChatFullInfoTestBase.id_, + type=ChatFullInfoTestBase.type_, + accent_color_id=ChatFullInfoTestBase.accent_color_id, + max_reaction_count=ChatFullInfoTestBase.max_reaction_count, + title=ChatFullInfoTestBase.title, + username=ChatFullInfoTestBase.username, + sticker_set_name=ChatFullInfoTestBase.sticker_set_name, + can_set_sticker_set=ChatFullInfoTestBase.can_set_sticker_set, + permissions=ChatFullInfoTestBase.permissions, + slow_mode_delay=ChatFullInfoTestBase.slow_mode_delay, + bio=ChatFullInfoTestBase.bio, + linked_chat_id=ChatFullInfoTestBase.linked_chat_id, + location=ChatFullInfoTestBase.location, + has_private_forwards=ChatFullInfoTestBase.has_private_forwards, + has_protected_content=ChatFullInfoTestBase.has_protected_content, + has_visible_history=ChatFullInfoTestBase.has_visible_history, + join_to_send_messages=ChatFullInfoTestBase.join_to_send_messages, + join_by_request=ChatFullInfoTestBase.join_by_request, has_restricted_voice_and_video_messages=( - TestChatFullInfoBase.has_restricted_voice_and_video_messages + ChatFullInfoTestBase.has_restricted_voice_and_video_messages ), - is_forum=TestChatFullInfoBase.is_forum, - active_usernames=TestChatFullInfoBase.active_usernames, - emoji_status_custom_emoji_id=TestChatFullInfoBase.emoji_status_custom_emoji_id, - emoji_status_expiration_date=TestChatFullInfoBase.emoji_status_expiration_date, - has_aggressive_anti_spam_enabled=TestChatFullInfoBase.has_aggressive_anti_spam_enabled, - has_hidden_members=TestChatFullInfoBase.has_hidden_members, - available_reactions=TestChatFullInfoBase.available_reactions, - background_custom_emoji_id=TestChatFullInfoBase.background_custom_emoji_id, - profile_accent_color_id=TestChatFullInfoBase.profile_accent_color_id, - profile_background_custom_emoji_id=TestChatFullInfoBase.profile_background_custom_emoji_id, - unrestrict_boost_count=TestChatFullInfoBase.unrestrict_boost_count, - custom_emoji_sticker_set_name=TestChatFullInfoBase.custom_emoji_sticker_set_name, - business_intro=TestChatFullInfoBase.business_intro, - business_location=TestChatFullInfoBase.business_location, - business_opening_hours=TestChatFullInfoBase.business_opening_hours, - birthdate=TestChatFullInfoBase.birthdate, - personal_chat=TestChatFullInfoBase.personal_chat, - first_name=TestChatFullInfoBase.first_name, - last_name=TestChatFullInfoBase.last_name, - can_send_paid_media=TestChatFullInfoBase.can_send_paid_media, + is_forum=ChatFullInfoTestBase.is_forum, + active_usernames=ChatFullInfoTestBase.active_usernames, + emoji_status_custom_emoji_id=ChatFullInfoTestBase.emoji_status_custom_emoji_id, + emoji_status_expiration_date=ChatFullInfoTestBase.emoji_status_expiration_date, + has_aggressive_anti_spam_enabled=ChatFullInfoTestBase.has_aggressive_anti_spam_enabled, + has_hidden_members=ChatFullInfoTestBase.has_hidden_members, + available_reactions=ChatFullInfoTestBase.available_reactions, + background_custom_emoji_id=ChatFullInfoTestBase.background_custom_emoji_id, + profile_accent_color_id=ChatFullInfoTestBase.profile_accent_color_id, + profile_background_custom_emoji_id=ChatFullInfoTestBase.profile_background_custom_emoji_id, + unrestrict_boost_count=ChatFullInfoTestBase.unrestrict_boost_count, + custom_emoji_sticker_set_name=ChatFullInfoTestBase.custom_emoji_sticker_set_name, + business_intro=ChatFullInfoTestBase.business_intro, + business_location=ChatFullInfoTestBase.business_location, + business_opening_hours=ChatFullInfoTestBase.business_opening_hours, + birthdate=ChatFullInfoTestBase.birthdate, + personal_chat=ChatFullInfoTestBase.personal_chat, + first_name=ChatFullInfoTestBase.first_name, + last_name=ChatFullInfoTestBase.last_name, + can_send_paid_media=ChatFullInfoTestBase.can_send_paid_media, ) chat.set_bot(bot) chat._unfreeze() @@ -90,7 +90,7 @@ def chat_full_info(bot): # Shortcut methods are tested in test_chat.py. -class TestChatFullInfoBase: +class ChatFullInfoTestBase: id_ = -28767330 max_reaction_count = 2 title = "ToledosPalaceBot - Group" @@ -116,7 +116,7 @@ class TestChatFullInfoBase: is_forum = True active_usernames = ["These", "Are", "Usernames!"] emoji_status_custom_emoji_id = "VeryUniqueCustomEmojiID" - emoji_status_expiration_date = datetime.datetime.now(tz=UTC).replace(microsecond=0) + emoji_status_expiration_date = dtm.datetime.now(tz=UTC).replace(microsecond=0) has_aggressive_anti_spam_enabled = True has_hidden_members = True available_reactions = [ @@ -142,7 +142,7 @@ class TestChatFullInfoBase: can_send_paid_media = True -class TestChatFullInfoWithoutRequest(TestChatFullInfoBase): +class TestChatFullInfoWithoutRequest(ChatFullInfoTestBase): def test_slot_behaviour(self, chat_full_info): cfi = chat_full_info for attr in cfi.__slots__: @@ -150,7 +150,7 @@ def test_slot_behaviour(self, chat_full_info): assert len(mro_slots(cfi)) == len(set(mro_slots(cfi))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "id": self.id_, "title": self.title, @@ -194,7 +194,7 @@ def test_de_json(self, bot): "last_name": self.last_name, "can_send_paid_media": self.can_send_paid_media, } - cfi = ChatFullInfo.de_json(json_dict, bot) + cfi = ChatFullInfo.de_json(json_dict, offline_bot) assert cfi.id == self.id_ assert cfi.title == self.title assert cfi.type == self.type_ @@ -239,7 +239,7 @@ def test_de_json(self, bot): assert cfi.max_reaction_count == self.max_reaction_count assert cfi.can_send_paid_media == self.can_send_paid_media - def test_de_json_localization(self, bot, raw_bot, tz_bot): + def test_de_json_localization(self, offline_bot, raw_bot, tz_bot): json_dict = { "id": self.id_, "type": self.type_, @@ -247,7 +247,7 @@ def test_de_json_localization(self, bot, raw_bot, tz_bot): "max_reaction_count": self.max_reaction_count, "emoji_status_expiration_date": to_timestamp(self.emoji_status_expiration_date), } - cfi_bot = ChatFullInfo.de_json(json_dict, bot) + cfi_bot = ChatFullInfo.de_json(json_dict, offline_bot) cfi_bot_raw = ChatFullInfo.de_json(json_dict, raw_bot) cfi_bot_tz = ChatFullInfo.de_json(json_dict, tz_bot) diff --git a/tests/test_chatinvitelink.py b/tests/test_chatinvitelink.py index 1b95177d9d5..4f5a04128e7 100644 --- a/tests/test_chatinvitelink.py +++ b/tests/test_chatinvitelink.py @@ -16,7 +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 +import datetime as dtm import pytest @@ -33,36 +33,40 @@ def creator(): @pytest.fixture(scope="module") def invite_link(creator): return ChatInviteLink( - TestChatInviteLinkBase.link, + ChatInviteLinkTestBase.link, creator, - TestChatInviteLinkBase.creates_join_request, - TestChatInviteLinkBase.primary, - TestChatInviteLinkBase.revoked, - expire_date=TestChatInviteLinkBase.expire_date, - member_limit=TestChatInviteLinkBase.member_limit, - name=TestChatInviteLinkBase.name, - pending_join_request_count=TestChatInviteLinkBase.pending_join_request_count, + ChatInviteLinkTestBase.creates_join_request, + ChatInviteLinkTestBase.primary, + ChatInviteLinkTestBase.revoked, + expire_date=ChatInviteLinkTestBase.expire_date, + member_limit=ChatInviteLinkTestBase.member_limit, + name=ChatInviteLinkTestBase.name, + pending_join_request_count=ChatInviteLinkTestBase.pending_join_request_count, + subscription_period=ChatInviteLinkTestBase.subscription_period, + subscription_price=ChatInviteLinkTestBase.subscription_price, ) -class TestChatInviteLinkBase: +class ChatInviteLinkTestBase: link = "thisialink" creates_join_request = False primary = True revoked = False - expire_date = datetime.datetime.now(datetime.timezone.utc) + expire_date = dtm.datetime.now(dtm.timezone.utc) member_limit = 42 name = "LinkName" pending_join_request_count = 42 + subscription_period = 43 + subscription_price = 44 -class TestChatInviteLinkWithoutRequest(TestChatInviteLinkBase): +class TestChatInviteLinkWithoutRequest(ChatInviteLinkTestBase): def test_slot_behaviour(self, invite_link): for attr in invite_link.__slots__: assert getattr(invite_link, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(invite_link)) == len(set(mro_slots(invite_link))), "duplicate slot" - def test_de_json_required_args(self, bot, creator): + def test_de_json_required_args(self, offline_bot, creator): json_dict = { "invite_link": self.link, "creator": creator.to_dict(), @@ -71,7 +75,7 @@ def test_de_json_required_args(self, bot, creator): "is_revoked": self.revoked, } - invite_link = ChatInviteLink.de_json(json_dict, bot) + invite_link = ChatInviteLink.de_json(json_dict, offline_bot) assert invite_link.api_kwargs == {} assert invite_link.invite_link == self.link @@ -80,7 +84,7 @@ def test_de_json_required_args(self, bot, creator): assert invite_link.is_primary == self.primary assert invite_link.is_revoked == self.revoked - def test_de_json_all_args(self, bot, creator): + def test_de_json_all_args(self, offline_bot, creator): json_dict = { "invite_link": self.link, "creator": creator.to_dict(), @@ -91,9 +95,11 @@ def test_de_json_all_args(self, 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_price": self.subscription_price, } - invite_link = ChatInviteLink.de_json(json_dict, bot) + invite_link = ChatInviteLink.de_json(json_dict, offline_bot) assert invite_link.api_kwargs == {} assert invite_link.invite_link == self.link @@ -101,13 +107,15 @@ def test_de_json_all_args(self, bot, creator): assert invite_link.creates_join_request == self.creates_join_request assert invite_link.is_primary == self.primary assert invite_link.is_revoked == self.revoked - assert abs(invite_link.expire_date - self.expire_date) < datetime.timedelta(seconds=1) + assert abs(invite_link.expire_date - self.expire_date) < dtm.timedelta(seconds=1) assert to_timestamp(invite_link.expire_date) == to_timestamp(self.expire_date) 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_price == self.subscription_price - def test_de_json_localization(self, tz_bot, bot, raw_bot, creator): + def test_de_json_localization(self, tz_bot, offline_bot, raw_bot, creator): json_dict = { "invite_link": self.link, "creator": creator.to_dict(), @@ -121,7 +129,7 @@ def test_de_json_localization(self, tz_bot, bot, raw_bot, creator): } invite_link_raw = ChatInviteLink.de_json(json_dict, raw_bot) - invite_link_bot = ChatInviteLink.de_json(json_dict, bot) + invite_link_bot = ChatInviteLink.de_json(json_dict, offline_bot) invite_link_tz = ChatInviteLink.de_json(json_dict, tz_bot) # comparing utcoffsets because comparing timezones is unpredicatable @@ -146,6 +154,8 @@ 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_price"] == self.subscription_price def test_equality(self): a = ChatInviteLink("link", User(1, "", False), True, True, True) diff --git a/tests/test_chatjoinrequest.py b/tests/test_chatjoinrequest.py index 3d8b19386de..2533f705b7c 100644 --- a/tests/test_chatjoinrequest.py +++ b/tests/test_chatjoinrequest.py @@ -16,7 +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 +import datetime as dtm import pytest @@ -32,24 +32,24 @@ @pytest.fixture(scope="module") def time(): - return datetime.datetime.now(tz=UTC) + return dtm.datetime.now(tz=UTC) @pytest.fixture(scope="module") def chat_join_request(bot, time): cjr = ChatJoinRequest( - chat=TestChatJoinRequestBase.chat, - from_user=TestChatJoinRequestBase.from_user, + chat=ChatJoinRequestTestBase.chat, + from_user=ChatJoinRequestTestBase.from_user, date=time, - bio=TestChatJoinRequestBase.bio, - invite_link=TestChatJoinRequestBase.invite_link, - user_chat_id=TestChatJoinRequestBase.from_user.id, + bio=ChatJoinRequestTestBase.bio, + invite_link=ChatJoinRequestTestBase.invite_link, + user_chat_id=ChatJoinRequestTestBase.from_user.id, ) cjr.set_bot(bot) return cjr -class TestChatJoinRequestBase: +class ChatJoinRequestTestBase: chat = Chat(1, Chat.SUPERGROUP) from_user = User(2, "first_name", False) bio = "bio" @@ -63,42 +63,42 @@ class TestChatJoinRequestBase: ) -class TestChatJoinRequestWithoutRequest(TestChatJoinRequestBase): +class TestChatJoinRequestWithoutRequest(ChatJoinRequestTestBase): def test_slot_behaviour(self, chat_join_request): inst = chat_join_request for attr in inst.__slots__: assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json(self, bot, time): + def test_de_json(self, offline_bot, time): json_dict = { "chat": self.chat.to_dict(), "from": self.from_user.to_dict(), "date": to_timestamp(time), "user_chat_id": self.from_user.id, } - chat_join_request = ChatJoinRequest.de_json(json_dict, bot) + chat_join_request = ChatJoinRequest.de_json(json_dict, offline_bot) assert chat_join_request.api_kwargs == {} assert chat_join_request.chat == self.chat assert chat_join_request.from_user == self.from_user - assert abs(chat_join_request.date - time) < datetime.timedelta(seconds=1) + assert abs(chat_join_request.date - time) < dtm.timedelta(seconds=1) assert to_timestamp(chat_join_request.date) == to_timestamp(time) assert chat_join_request.user_chat_id == self.from_user.id json_dict.update({"bio": self.bio, "invite_link": self.invite_link.to_dict()}) - chat_join_request = ChatJoinRequest.de_json(json_dict, bot) + chat_join_request = ChatJoinRequest.de_json(json_dict, offline_bot) assert chat_join_request.api_kwargs == {} assert chat_join_request.chat == self.chat assert chat_join_request.from_user == self.from_user - assert abs(chat_join_request.date - time) < datetime.timedelta(seconds=1) + assert abs(chat_join_request.date - time) < dtm.timedelta(seconds=1) assert to_timestamp(chat_join_request.date) == to_timestamp(time) assert chat_join_request.user_chat_id == self.from_user.id assert chat_join_request.bio == self.bio assert chat_join_request.invite_link == self.invite_link - def test_de_json_localization(self, tz_bot, bot, raw_bot, time): + def test_de_json_localization(self, tz_bot, offline_bot, raw_bot, time): json_dict = { "chat": self.chat.to_dict(), "from": self.from_user.to_dict(), @@ -107,7 +107,7 @@ def test_de_json_localization(self, tz_bot, bot, raw_bot, time): } chatjoin_req_raw = ChatJoinRequest.de_json(json_dict, raw_bot) - chatjoin_req_bot = ChatJoinRequest.de_json(json_dict, bot) + chatjoin_req_bot = ChatJoinRequest.de_json(json_dict, offline_bot) chatjoin_req_tz = ChatJoinRequest.de_json(json_dict, tz_bot) # comparing utcoffsets because comparing timezones is unpredicatable @@ -133,9 +133,7 @@ def test_equality(self, chat_join_request, time): a = chat_join_request b = ChatJoinRequest(self.chat, self.from_user, time, self.from_user.id) c = ChatJoinRequest(self.chat, self.from_user, time, self.from_user.id, bio="bio") - d = ChatJoinRequest( - self.chat, self.from_user, time + datetime.timedelta(1), self.from_user.id - ) + d = ChatJoinRequest(self.chat, self.from_user, time + dtm.timedelta(1), self.from_user.id) e = ChatJoinRequest(self.chat, User(-1, "last_name", True), time, -1) f = User(456, "", False) diff --git a/tests/test_chatlocation.py b/tests/test_chatlocation.py index a57d157cce1..b83306308be 100644 --- a/tests/test_chatlocation.py +++ b/tests/test_chatlocation.py @@ -25,27 +25,27 @@ @pytest.fixture(scope="module") def chat_location(): - return ChatLocation(TestChatLocationBase.location, TestChatLocationBase.address) + return ChatLocation(ChatLocationTestBase.location, ChatLocationTestBase.address) -class TestChatLocationBase: +class ChatLocationTestBase: location = Location(123, 456) address = "The Shire" -class TestChatLocationWithoutRequest(TestChatLocationBase): +class TestChatLocationWithoutRequest(ChatLocationTestBase): def test_slot_behaviour(self, chat_location): inst = chat_location for attr in inst.__slots__: assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "location": self.location.to_dict(), "address": self.address, } - chat_location = ChatLocation.de_json(json_dict, bot) + chat_location = ChatLocation.de_json(json_dict, offline_bot) assert chat_location.api_kwargs == {} assert chat_location.location == self.location diff --git a/tests/test_chatmember.py b/tests/test_chatmember.py index 28293a6cc80..a9f3ebabe73 100644 --- a/tests/test_chatmember.py +++ b/tests/test_chatmember.py @@ -16,7 +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 +import datetime as dtm import inspect from copy import deepcopy @@ -43,7 +43,7 @@ class CMDefaults: user = User(1, "First name", False) custom_title: str = "PTB" is_anonymous: bool = True - until_date: datetime.datetime = to_timestamp(datetime.datetime.utcnow()) + until_date: dtm.datetime = to_timestamp(dtm.datetime.utcnow()) can_be_edited: bool = False can_change_info: bool = True can_post_messages: bool = True @@ -101,7 +101,7 @@ def chat_member_administrator(): def chat_member_member(): - return ChatMemberMember(CMDefaults.user) + return ChatMemberMember(CMDefaults.user, until_date=CMDefaults.until_date) def chat_member_restricted(): @@ -173,7 +173,7 @@ def iter_args(instance: ChatMember, de_json_inst: ChatMember, include_optional: if param.name in ignored: continue inst_at, json_at = getattr(instance, param.name), getattr(de_json_inst, param.name) - if isinstance(json_at, datetime.datetime): # Convert datetime to int + if isinstance(json_at, dtm.datetime): # Convert dtm to int json_at = to_timestamp(json_at) if ( param.default is not inspect.Parameter.empty and include_optional @@ -181,7 +181,7 @@ def iter_args(instance: ChatMember, de_json_inst: ChatMember, include_optional: yield inst_at, json_at -@pytest.fixture() +@pytest.fixture def chat_member_type(request): return request.param() @@ -205,12 +205,12 @@ def test_slot_behaviour(self, chat_member_type): assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json_required_args(self, bot, chat_member_type): + def test_de_json_required_args(self, offline_bot, chat_member_type): cls = chat_member_type.__class__ - assert cls.de_json({}, bot) is None + assert cls.de_json({}, offline_bot) is None json_dict = make_json_dict(chat_member_type) - const_chat_member = ChatMember.de_json(json_dict, bot) + const_chat_member = ChatMember.de_json(json_dict, offline_bot) assert const_chat_member.api_kwargs == {} assert isinstance(const_chat_member, ChatMember) @@ -218,9 +218,9 @@ def test_de_json_required_args(self, bot, chat_member_type): for chat_mem_type_at, const_chat_mem_at in iter_args(chat_member_type, const_chat_member): assert chat_mem_type_at == const_chat_mem_at - def test_de_json_all_args(self, bot, chat_member_type): + def test_de_json_all_args(self, offline_bot, chat_member_type): json_dict = make_json_dict(chat_member_type, include_optional_args=True) - const_chat_member = ChatMember.de_json(json_dict, bot) + const_chat_member = ChatMember.de_json(json_dict, offline_bot) assert const_chat_member.api_kwargs == {} assert isinstance(const_chat_member, ChatMember) @@ -228,12 +228,16 @@ def test_de_json_all_args(self, bot, chat_member_type): for c_mem_type_at, const_c_mem_at in iter_args(chat_member_type, const_chat_member, True): assert c_mem_type_at == const_c_mem_at - def test_de_json_chatmemberbanned_localization(self, chat_member_type, tz_bot, bot, raw_bot): + def test_de_json_chatmemberbanned_localization( + self, chat_member_type, tz_bot, offline_bot, raw_bot + ): # We only test two classes because the other three don't have datetimes in them. - if isinstance(chat_member_type, (ChatMemberBanned, ChatMemberRestricted)): + if isinstance( + chat_member_type, (ChatMemberBanned, ChatMemberRestricted, ChatMemberMember) + ): json_dict = make_json_dict(chat_member_type, include_optional_args=True) chatmember_raw = ChatMember.de_json(json_dict, raw_bot) - chatmember_bot = ChatMember.de_json(json_dict, bot) + chatmember_bot = ChatMember.de_json(json_dict, offline_bot) chatmember_tz = ChatMember.de_json(json_dict, tz_bot) # comparing utcoffsets because comparing timezones is unpredicatable @@ -246,19 +250,19 @@ def test_de_json_chatmemberbanned_localization(self, chat_member_type, tz_bot, b assert chatmember_bot.until_date.tzinfo == UTC assert chatmember_offset == tz_bot_offset - def test_de_json_invalid_status(self, chat_member_type, bot): + def test_de_json_invalid_status(self, chat_member_type, offline_bot): json_dict = {"status": "invalid", "user": CMDefaults.user.to_dict()} - chat_member_type = ChatMember.de_json(json_dict, bot) + chat_member_type = ChatMember.de_json(json_dict, offline_bot) assert type(chat_member_type) is ChatMember assert chat_member_type.status == "invalid" - def test_de_json_subclass(self, chat_member_type, bot, chat_id): - """This makes sure that e.g. ChatMemberAdministrator(data, bot) never returns a + def test_de_json_subclass(self, chat_member_type, offline_bot, chat_id): + """This makes sure that e.g. ChatMemberAdministrator(data, offline_bot) never returns a ChatMemberBanned instance.""" cls = chat_member_type.__class__ json_dict = make_json_dict(chat_member_type, True) - assert type(cls.de_json(json_dict, bot)) is cls + assert type(cls.de_json(json_dict, offline_bot)) is cls def test_to_dict(self, chat_member_type): chat_member_dict = chat_member_type.to_dict() diff --git a/tests/test_chatmemberupdated.py b/tests/test_chatmemberupdated.py index 0efbcd8d0ab..8267ebf5e1c 100644 --- a/tests/test_chatmemberupdated.py +++ b/tests/test_chatmemberupdated.py @@ -16,7 +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 +import datetime as dtm import inspect import pytest @@ -47,7 +47,7 @@ def chat(): @pytest.fixture(scope="module") def old_chat_member(user): - return ChatMember(user, TestChatMemberUpdatedBase.old_status) + return ChatMember(user, ChatMemberUpdatedTestBase.old_status) @pytest.fixture(scope="module") @@ -66,13 +66,13 @@ def new_chat_member(user): True, True, True, - custom_title=TestChatMemberUpdatedBase.new_status, + custom_title=ChatMemberUpdatedTestBase.new_status, ) @pytest.fixture(scope="module") def time(): - return datetime.datetime.now(tz=UTC) + return dtm.datetime.now(tz=UTC) @pytest.fixture(scope="module") @@ -87,19 +87,21 @@ def chat_member_updated(user, chat, old_chat_member, new_chat_member, invite_lin ) -class TestChatMemberUpdatedBase: +class ChatMemberUpdatedTestBase: old_status = ChatMember.MEMBER new_status = ChatMember.ADMINISTRATOR -class TestChatMemberUpdatedWithoutRequest(TestChatMemberUpdatedBase): +class TestChatMemberUpdatedWithoutRequest(ChatMemberUpdatedTestBase): def test_slot_behaviour(self, chat_member_updated): action = chat_member_updated for attr in action.__slots__: assert getattr(action, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(action)) == len(set(mro_slots(action))), "duplicate slot" - def test_de_json_required_args(self, bot, user, chat, old_chat_member, new_chat_member, time): + def test_de_json_required_args( + self, offline_bot, user, chat, old_chat_member, new_chat_member, time + ): json_dict = { "chat": chat.to_dict(), "from": user.to_dict(), @@ -108,12 +110,12 @@ def test_de_json_required_args(self, bot, user, chat, old_chat_member, new_chat_ "new_chat_member": new_chat_member.to_dict(), } - chat_member_updated = ChatMemberUpdated.de_json(json_dict, bot) + chat_member_updated = ChatMemberUpdated.de_json(json_dict, offline_bot) assert chat_member_updated.api_kwargs == {} assert chat_member_updated.chat == chat assert chat_member_updated.from_user == user - assert abs(chat_member_updated.date - time) < datetime.timedelta(seconds=1) + assert abs(chat_member_updated.date - time) < dtm.timedelta(seconds=1) assert to_timestamp(chat_member_updated.date) == to_timestamp(time) assert chat_member_updated.old_chat_member == old_chat_member assert chat_member_updated.new_chat_member == new_chat_member @@ -121,7 +123,7 @@ def test_de_json_required_args(self, bot, user, chat, old_chat_member, new_chat_ assert chat_member_updated.via_chat_folder_invite_link is None def test_de_json_all_args( - self, bot, user, time, invite_link, chat, old_chat_member, new_chat_member + self, offline_bot, user, time, invite_link, chat, old_chat_member, new_chat_member ): json_dict = { "chat": chat.to_dict(), @@ -134,12 +136,12 @@ def test_de_json_all_args( "via_join_request": True, } - chat_member_updated = ChatMemberUpdated.de_json(json_dict, bot) + chat_member_updated = ChatMemberUpdated.de_json(json_dict, offline_bot) assert chat_member_updated.api_kwargs == {} assert chat_member_updated.chat == chat assert chat_member_updated.from_user == user - assert abs(chat_member_updated.date - time) < datetime.timedelta(seconds=1) + assert abs(chat_member_updated.date - time) < dtm.timedelta(seconds=1) assert to_timestamp(chat_member_updated.date) == to_timestamp(time) assert chat_member_updated.old_chat_member == old_chat_member assert chat_member_updated.new_chat_member == new_chat_member @@ -148,7 +150,16 @@ def test_de_json_all_args( assert chat_member_updated.via_join_request is True def test_de_json_localization( - self, bot, raw_bot, tz_bot, user, chat, old_chat_member, new_chat_member, time, invite_link + self, + offline_bot, + raw_bot, + tz_bot, + user, + chat, + old_chat_member, + new_chat_member, + time, + invite_link, ): json_dict = { "chat": chat.to_dict(), @@ -159,7 +170,7 @@ def test_de_json_localization( "invite_link": invite_link.to_dict(), } - chat_member_updated_bot = ChatMemberUpdated.de_json(json_dict, bot) + chat_member_updated_bot = ChatMemberUpdated.de_json(json_dict, offline_bot) chat_member_updated_raw = ChatMemberUpdated.de_json(json_dict, raw_bot) chat_member_updated_tz = ChatMemberUpdated.de_json(json_dict, tz_bot) @@ -210,7 +221,7 @@ def test_equality(self, time, old_chat_member, new_chat_member, invite_link): c = ChatMemberUpdated( Chat(1, "chat"), User(1, "", False), - time + datetime.timedelta(hours=1), + time + dtm.timedelta(hours=1), old_chat_member, new_chat_member, ) @@ -253,7 +264,7 @@ def test_difference_required(self, user, chat): old_chat_member = ChatMember(user, "old_status") new_chat_member = ChatMember(user, "new_status") chat_member_updated = ChatMemberUpdated( - chat, user, datetime.datetime.utcnow(), old_chat_member, new_chat_member + chat, user, dtm.datetime.utcnow(), old_chat_member, new_chat_member ) assert chat_member_updated.difference() == {"status": ("old_status", "new_status")} @@ -262,7 +273,7 @@ def test_difference_required(self, user, chat): new_user = User(1, "First name", False, last_name="last name") new_chat_member = ChatMember(new_user, "new_status") chat_member_updated = ChatMemberUpdated( - chat, user, datetime.datetime.utcnow(), old_chat_member, new_chat_member + chat, user, dtm.datetime.utcnow(), old_chat_member, new_chat_member ) assert chat_member_updated.difference() == { "status": ("old_status", "new_status"), @@ -310,22 +321,22 @@ def test_difference_optionals(self, optional_attribute, user, chat): can_post_stories=True, ) chat_member_updated = ChatMemberUpdated( - chat, user, datetime.datetime.utcnow(), old_chat_member, new_chat_member + chat, user, dtm.datetime.utcnow(), old_chat_member, new_chat_member ) assert chat_member_updated.difference() == {optional_attribute: (old_value, new_value)} def test_difference_different_classes(self, user, chat): old_chat_member = ChatMemberOwner(user=user, is_anonymous=False) - new_chat_member = ChatMemberBanned(user=user, until_date=datetime.datetime(2021, 1, 1)) + new_chat_member = ChatMemberBanned(user=user, until_date=dtm.datetime(2021, 1, 1)) chat_member_updated = ChatMemberUpdated( chat=chat, from_user=user, - date=datetime.datetime.utcnow(), + date=dtm.datetime.utcnow(), old_chat_member=old_chat_member, new_chat_member=new_chat_member, ) diff = chat_member_updated.difference() assert diff.pop("is_anonymous") == (False, None) - assert diff.pop("until_date") == (None, datetime.datetime(2021, 1, 1)) + assert diff.pop("until_date") == (None, dtm.datetime(2021, 1, 1)) assert diff.pop("status") == (ChatMember.OWNER, ChatMember.BANNED) assert diff == {} diff --git a/tests/test_chatpermissions.py b/tests/test_chatpermissions.py index 9317de22769..fcb93840f10 100644 --- a/tests/test_chatpermissions.py +++ b/tests/test_chatpermissions.py @@ -43,7 +43,7 @@ def chat_permissions(): ) -class TestChatPermissionsBase: +class ChatPermissionsTestBase: can_send_messages = True can_send_polls = True can_send_other_messages = False @@ -60,14 +60,14 @@ class TestChatPermissionsBase: can_send_voice_notes = None -class TestChatPermissionsWithoutRequest(TestChatPermissionsBase): +class TestChatPermissionsWithoutRequest(ChatPermissionsTestBase): def test_slot_behaviour(self, chat_permissions): inst = chat_permissions for attr in inst.__slots__: assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "can_send_messages": self.can_send_messages, "can_send_media_messages": "can_send_media_messages", @@ -84,7 +84,7 @@ def test_de_json(self, bot): "can_send_video_notes": self.can_send_video_notes, "can_send_voice_notes": self.can_send_voice_notes, } - permissions = ChatPermissions.de_json(json_dict, bot) + permissions = ChatPermissions.de_json(json_dict, offline_bot) assert permissions.api_kwargs == {"can_send_media_messages": "can_send_media_messages"} assert permissions.can_send_messages == self.can_send_messages diff --git a/tests/test_choseninlineresult.py b/tests/test_choseninlineresult.py index d1cb3622649..8d6529c103c 100644 --- a/tests/test_choseninlineresult.py +++ b/tests/test_choseninlineresult.py @@ -33,32 +33,32 @@ def user(): @pytest.fixture(scope="module") def chosen_inline_result(user): return ChosenInlineResult( - TestChosenInlineResultBase.result_id, user, TestChosenInlineResultBase.query + ChosenInlineResultTestBase.result_id, user, ChosenInlineResultTestBase.query ) -class TestChosenInlineResultBase: +class ChosenInlineResultTestBase: result_id = "result id" query = "query text" -class TestChosenInlineResultWithoutRequest(TestChosenInlineResultBase): +class TestChosenInlineResultWithoutRequest(ChosenInlineResultTestBase): def test_slot_behaviour(self, chosen_inline_result): inst = chosen_inline_result for attr in inst.__slots__: assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json_required(self, bot, user): + def test_de_json_required(self, offline_bot, user): json_dict = {"result_id": self.result_id, "from": user.to_dict(), "query": self.query} - result = ChosenInlineResult.de_json(json_dict, bot) + result = ChosenInlineResult.de_json(json_dict, offline_bot) assert result.api_kwargs == {} assert result.result_id == self.result_id assert result.from_user == user assert result.query == self.query - def test_de_json_all(self, bot, user): + def test_de_json_all(self, offline_bot, user): loc = Location(-42.003, 34.004) json_dict = { "result_id": self.result_id, @@ -67,7 +67,7 @@ def test_de_json_all(self, bot, user): "location": loc.to_dict(), "inline_message_id": "a random id", } - result = ChosenInlineResult.de_json(json_dict, bot) + result = ChosenInlineResult.de_json(json_dict, offline_bot) assert result.api_kwargs == {} assert result.result_id == self.result_id diff --git a/tests/test_constants.py b/tests/test_constants.py index dc76bea3aef..f85e09624a9 100644 --- a/tests/test_constants.py +++ b/tests/test_constants.py @@ -24,7 +24,7 @@ import pytest from telegram import Message, constants -from telegram._utils.enum import IntEnum, StringEnum +from telegram._utils.enum import FloatEnum, IntEnum, StringEnum from telegram.error import BadRequest from tests.auxil.build_messages import make_message from tests.auxil.files import data_file @@ -41,6 +41,11 @@ class IntEnumTest(IntEnum): BAR = 2 +class FloatEnumTest(FloatEnum): + FOO = 1.1 + BAR = 2.1 + + class TestConstantsWithoutRequest: """Also test _utils.enum.StringEnum on the fly because tg.constants is currently the only place where that class is used.""" @@ -53,7 +58,7 @@ def test__all__(self): not key.startswith("_") # exclude imported stuff and getattr(member, "__module__", "telegram.constants") == "telegram.constants" - and key not in ("sys", "datetime") + and key not in ("sys", "dtm") ) } actual = set(constants.__all__) @@ -69,6 +74,7 @@ def test_message_attachment_type(self): def test_to_json(self): assert json.dumps(StrEnumTest.FOO) == json.dumps("foo") assert json.dumps(IntEnumTest.FOO) == json.dumps(1) + assert json.dumps(FloatEnumTest.FOO) == json.dumps(1.1) def test_string_representation(self): # test __repr__ @@ -90,6 +96,15 @@ def test_int_representation(self): # test __str__ assert str(IntEnumTest.FOO) == "1" + def test_float_representation(self): + # test __repr__ + assert repr(FloatEnumTest.FOO) == "" + # test __format__ + assert f"{FloatEnumTest.FOO}/0 is undefined!" == "1.1/0 is undefined!" + assert f"{FloatEnumTest.FOO:*^10}" == "***1.1****" + # test __str__ + assert str(FloatEnumTest.FOO) == "1.1" + def test_string_inheritance(self): assert isinstance(StrEnumTest.FOO, str) assert StrEnumTest.FOO + StrEnumTest.BAR == "foobar" @@ -115,6 +130,18 @@ def test_int_inheritance(self): assert hash(IntEnumTest.FOO) == hash(1) + def test_float_inheritance(self): + assert isinstance(FloatEnumTest.FOO, float) + assert FloatEnumTest.FOO + FloatEnumTest.BAR == 3.2 + + assert FloatEnumTest.FOO == FloatEnumTest.FOO + assert FloatEnumTest.FOO == 1.1 + assert FloatEnumTest.FOO != FloatEnumTest.BAR + assert FloatEnumTest.FOO != 2.1 + assert object() != FloatEnumTest.FOO + + assert hash(FloatEnumTest.FOO) == hash(1.1) + def test_bot_api_version_and_info(self): assert str(constants.BOT_API_VERSION_INFO) == constants.BOT_API_VERSION assert ( diff --git a/tests/test_copytextbutton.py b/tests/test_copytextbutton.py new file mode 100644 index 00000000000..7092456d490 --- /dev/null +++ b/tests/test_copytextbutton.py @@ -0,0 +1,70 @@ +#!/usr/bin/env python +# +# A library that provides a Python interface to the Telegram Bot API +# Copyright (C) 2015-2024 +# Leandro Toledo de Souza +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser Public License for more details. +# +# You should have received a copy of the GNU Lesser Public License +# along with this program. If not, see [http://www.gnu.org/licenses/]. + +import pytest + +from telegram import BotCommand, CopyTextButton +from tests.auxil.slots import mro_slots + + +@pytest.fixture(scope="module") +def copy_text_button(): + return CopyTextButton(text=CopyTextButtonTestBase.text) + + +class CopyTextButtonTestBase: + text = "This is some text" + + +class TestCopyTextButtonWithoutRequest(CopyTextButtonTestBase): + def test_slot_behaviour(self, copy_text_button): + for attr in copy_text_button.__slots__: + assert getattr(copy_text_button, attr, "err") != "err", f"got extra slot '{attr}'" + assert len(mro_slots(copy_text_button)) == len( + set(mro_slots(copy_text_button)) + ), "duplicate slot" + + def test_de_json(self, offline_bot): + json_dict = {"text": self.text} + copy_text_button = CopyTextButton.de_json(json_dict, offline_bot) + assert copy_text_button.api_kwargs == {} + + assert copy_text_button.text == self.text + assert CopyTextButton.de_json(None, offline_bot) is None + + def test_to_dict(self, copy_text_button): + copy_text_button_dict = copy_text_button.to_dict() + + assert isinstance(copy_text_button_dict, dict) + assert copy_text_button_dict["text"] == copy_text_button.text + + def test_equality(self): + a = CopyTextButton(self.text) + b = CopyTextButton(self.text) + c = CopyTextButton("text") + d = BotCommand("start", "description") + + assert a == b + assert hash(a) == hash(b) + + assert a != c + assert hash(a) != hash(c) + + assert a != d + assert hash(a) != hash(d) diff --git a/tests/test_dice.py b/tests/test_dice.py index 53242efa770..de82d29aef0 100644 --- a/tests/test_dice.py +++ b/tests/test_dice.py @@ -28,25 +28,25 @@ def dice(request): return Dice(value=5, emoji=request.param) -class TestDiceBase: +class DiceTestBase: value = 4 -class TestDiceWithoutRequest(TestDiceBase): +class TestDiceWithoutRequest(DiceTestBase): def test_slot_behaviour(self, dice): for attr in dice.__slots__: assert getattr(dice, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(dice)) == len(set(mro_slots(dice))), "duplicate slot" @pytest.mark.parametrize("emoji", Dice.ALL_EMOJI) - def test_de_json(self, bot, emoji): + def test_de_json(self, offline_bot, emoji): json_dict = {"value": self.value, "emoji": emoji} - dice = Dice.de_json(json_dict, bot) + dice = Dice.de_json(json_dict, offline_bot) assert dice.api_kwargs == {} assert dice.value == self.value assert dice.emoji == emoji - assert Dice.de_json(None, bot) is None + assert Dice.de_json(None, offline_bot) is None def test_to_dict(self, dice): dice_dict = dice.to_dict() diff --git a/tests/test_enum_types.py b/tests/test_enum_types.py index b16002c6642..947d5fd0655 100644 --- a/tests/test_enum_types.py +++ b/tests/test_enum_types.py @@ -19,6 +19,8 @@ import re from pathlib import Path +from telegram._utils.strings import TextEncoding + telegram_root = Path(__file__).parent.parent / "telegram" telegram_ext_root = telegram_root / "ext" exclude_dirs = { @@ -46,7 +48,7 @@ def test_types_are_converted_to_enum(): # We don't check tg.ext. continue - text = path.read_text(encoding="utf-8") + text = path.read_text(encoding=TextEncoding.UTF_8) for match in re.finditer(pattern, text): if any(exclude_pattern.match(match.group(0)) for exclude_pattern in exclude_patterns): continue diff --git a/tests/test_forcereply.py b/tests/test_forcereply.py index ca9d7cae5ed..e4e2b5b5dda 100644 --- a/tests/test_forcereply.py +++ b/tests/test_forcereply.py @@ -25,16 +25,16 @@ @pytest.fixture(scope="module") def force_reply(): - return ForceReply(TestForceReplyBase.selective, TestForceReplyBase.input_field_placeholder) + return ForceReply(ForceReplyTestBase.selective, ForceReplyTestBase.input_field_placeholder) -class TestForceReplyBase: +class ForceReplyTestBase: force_reply = True selective = True input_field_placeholder = "force replies can be annoying if not used properly" -class TestForceReplyWithoutRequest(TestForceReplyBase): +class TestForceReplyWithoutRequest(ForceReplyTestBase): def test_slot_behaviour(self, force_reply): for attr in force_reply.__slots__: assert getattr(force_reply, attr, "err") != "err", f"got extra slot '{attr}'" @@ -69,7 +69,7 @@ def test_equality(self): assert hash(a) != hash(d) -class TestForceReplyWithRequest(TestForceReplyBase): +class TestForceReplyWithRequest(ForceReplyTestBase): async def test_send_message_with_force_reply(self, bot, chat_id, force_reply): message = await bot.send_message(chat_id, "text", reply_markup=force_reply) assert message.text == "text" diff --git a/tests/test_forum.py b/tests/test_forum.py index 55419a3854f..2237742a40a 100644 --- a/tests/test_forum.py +++ b/tests/test_forum.py @@ -17,7 +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 +import datetime as dtm import pytest @@ -32,19 +32,9 @@ Sticker, ) from telegram.error import BadRequest +from tests.auxil.constants import TEST_MSG_TEXT, TEST_TOPIC_ICON_COLOR, TEST_TOPIC_NAME from tests.auxil.slots import mro_slots -TEST_MSG_TEXT = "Topics are forever" -TEST_TOPIC_ICON_COLOR = 0x6FB9F0 -TEST_TOPIC_NAME = "Sad bot true: real stories" - - -@pytest.fixture(scope="module") -async def emoji_id(bot): - emoji_sticker_list = await bot.get_forum_topic_icon_stickers() - first_sticker = emoji_sticker_list[0] - return first_sticker.custom_emoji_id - @pytest.fixture(scope="module") async def forum_topic_object(forum_group_id, emoji_id): @@ -56,23 +46,6 @@ async def forum_topic_object(forum_group_id, emoji_id): ) -@pytest.fixture() -async def real_topic(bot, emoji_id, forum_group_id): - result = await bot.create_forum_topic( - chat_id=forum_group_id, - name=TEST_TOPIC_NAME, - icon_color=TEST_TOPIC_ICON_COLOR, - icon_custom_emoji_id=emoji_id, - ) - - yield result - - result = await bot.delete_forum_topic( - chat_id=forum_group_id, message_thread_id=result.message_thread_id - ) - assert result is True, "Topic was not deleted" - - class TestForumTopicWithoutRequest: def test_slot_behaviour(self, forum_topic_object): inst = forum_topic_object @@ -86,8 +59,8 @@ async def test_expected_values(self, emoji_id, forum_group_id, forum_topic_objec assert forum_topic_object.name == TEST_TOPIC_NAME assert forum_topic_object.icon_custom_emoji_id == emoji_id - def test_de_json(self, bot, emoji_id, forum_group_id): - assert ForumTopic.de_json(None, bot=bot) is None + def test_de_json(self, offline_bot, emoji_id, forum_group_id): + assert ForumTopic.de_json(None, bot=offline_bot) is None json_dict = { "message_thread_id": forum_group_id, @@ -95,7 +68,7 @@ def test_de_json(self, bot, emoji_id, forum_group_id): "icon_color": TEST_TOPIC_ICON_COLOR, "icon_custom_emoji_id": emoji_id, } - topic = ForumTopic.de_json(json_dict, bot) + topic = ForumTopic.de_json(json_dict, offline_bot) assert topic.api_kwargs == {} assert topic.message_thread_id == forum_group_id @@ -270,7 +243,7 @@ async def test_unpin_all_general_forum_topic_messages(self, bot, forum_group_id) async def test_edit_general_forum_topic(self, bot, forum_group_id): result = await bot.edit_general_forum_topic( chat_id=forum_group_id, - name=f"GENERAL_{datetime.datetime.now().timestamp()}", + name=f"GENERAL_{dtm.datetime.now().timestamp()}", ) assert result is True, "Failed to edit general forum topic" # no way of checking the edited name, just the boolean result @@ -333,11 +306,11 @@ def test_expected_values(self, topic_created): assert topic_created.icon_color == TEST_TOPIC_ICON_COLOR assert topic_created.name == TEST_TOPIC_NAME - def test_de_json(self, bot): - assert ForumTopicCreated.de_json(None, bot=bot) is None + def test_de_json(self, offline_bot): + assert ForumTopicCreated.de_json(None, bot=offline_bot) is None json_dict = {"icon_color": TEST_TOPIC_ICON_COLOR, "name": TEST_TOPIC_NAME} - action = ForumTopicCreated.de_json(json_dict, bot) + action = ForumTopicCreated.de_json(json_dict, offline_bot) assert action.api_kwargs == {} assert action.icon_color == TEST_TOPIC_ICON_COLOR diff --git a/tests/test_gifts.py b/tests/test_gifts.py new file mode 100644 index 00000000000..e7e13c75cef --- /dev/null +++ b/tests/test_gifts.py @@ -0,0 +1,267 @@ +#!/usr/bin/env python +# +# A library that provides a Python interface to the Telegram Bot API +# Copyright (C) 2015-2024 +# Leandro Toledo de Souza +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser Public License for more details. +# +# You should have received a copy of the GNU Lesser Public License +# along with this program. If not, see [http://www.gnu.org/licenses/]. +from collections.abc import Sequence + +import pytest + +from telegram import BotCommand, Gift, Gifts, MessageEntity, Sticker +from telegram._utils.defaultvalue import DEFAULT_NONE +from telegram.request import RequestData +from tests.auxil.slots import mro_slots + + +@pytest.fixture +def gift(request): + return Gift( + id=GiftTestBase.id, + sticker=GiftTestBase.sticker, + star_count=GiftTestBase.star_count, + total_count=GiftTestBase.total_count, + remaining_count=GiftTestBase.remaining_count, + ) + + +class GiftTestBase: + id = "some_id" + sticker = Sticker( + file_id="file_id", + file_unique_id="file_unique_id", + width=512, + height=512, + is_animated=False, + is_video=False, + type="regular", + ) + star_count = 5 + total_count = 10 + remaining_count = 5 + + +class TestGiftWithoutRequest(GiftTestBase): + def test_slot_behaviour(self, gift): + for attr in gift.__slots__: + assert getattr(gift, attr, "err") != "err", f"got extra slot '{attr}'" + assert len(mro_slots(gift)) == len(set(mro_slots(gift))), "duplicate slot" + + def test_de_json(self, offline_bot, gift): + json_dict = { + "id": self.id, + "sticker": self.sticker.to_dict(), + "star_count": self.star_count, + "total_count": self.total_count, + "remaining_count": self.remaining_count, + } + gift = Gift.de_json(json_dict, offline_bot) + assert gift.api_kwargs == {} + + assert gift.id == self.id + assert gift.sticker == self.sticker + assert gift.star_count == self.star_count + assert gift.total_count == self.total_count + assert gift.remaining_count == self.remaining_count + + assert Gift.de_json(None, offline_bot) is None + + def test_to_dict(self, gift): + gift_dict = gift.to_dict() + + assert isinstance(gift_dict, dict) + assert gift_dict["id"] == self.id + assert gift_dict["sticker"] == self.sticker.to_dict() + assert gift_dict["star_count"] == self.star_count + assert gift_dict["total_count"] == self.total_count + assert gift_dict["remaining_count"] == self.remaining_count + + def test_equality(self, gift): + a = gift + b = Gift(self.id, self.sticker, self.star_count, self.total_count, self.remaining_count) + c = Gift( + "other_uid", self.sticker, self.star_count, self.total_count, self.remaining_count + ) + d = BotCommand("start", "description") + + assert a == b + assert hash(a) == hash(b) + + assert a != c + assert hash(a) != hash(c) + + assert a != d + assert hash(a) != hash(d) + + @pytest.mark.parametrize( + "gift", + [ + "gift_id", + Gift( + "gift_id", + Sticker("file_id", "file_unique_id", 512, 512, False, False, "regular"), + 5, + 10, + 5, + ), + ], + ids=["string", "Gift"], + ) + async def test_send_gift(self, offline_bot, gift, monkeypatch): + # We can't send actual gifts, so we just check that the correct parameters are passed + text_entities = [ + MessageEntity(MessageEntity.TEXT_LINK, 0, 4, "url"), + MessageEntity(MessageEntity.BOLD, 5, 9), + ] + + async def make_assertion(url, request_data: RequestData, *args, **kwargs): + user_id = request_data.parameters["user_id"] == "user_id" + gift_id = request_data.parameters["gift_id"] == "gift_id" + text = request_data.parameters["text"] == "text" + text_parse_mode = request_data.parameters["text_parse_mode"] == "text_parse_mode" + tes = request_data.parameters["text_entities"] == [ + me.to_dict() for me in text_entities + ] + return user_id and gift_id and text and text_parse_mode and tes + + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.send_gift( + "user_id", gift, "text", text_parse_mode="text_parse_mode", text_entities=text_entities + ) + + @pytest.mark.parametrize("default_bot", [{"parse_mode": "Markdown"}], indirect=True) + @pytest.mark.parametrize( + ("passed_value", "expected_value"), + [(DEFAULT_NONE, "Markdown"), ("HTML", "HTML"), (None, None)], + ) + async def test_send_gift_default_parse_mode( + self, default_bot, monkeypatch, passed_value, expected_value + ): + async def make_assertion(url, request_data: RequestData, *args, **kwargs): + return request_data.parameters.get("text_parse_mode") == expected_value + + monkeypatch.setattr(default_bot.request, "post", make_assertion) + kwargs = { + "user_id": "user_id", + "gift_id": "gift_id", + } + if passed_value is not DEFAULT_NONE: + kwargs["text_parse_mode"] = passed_value + + assert await default_bot.send_gift(**kwargs) + + +@pytest.fixture +def gifts(request): + return Gifts(gifts=GiftsTestBase.gifts) + + +class GiftsTestBase: + gifts: Sequence[Gift] = [ + Gift( + id="id1", + sticker=Sticker( + file_id="file_id", + file_unique_id="file_unique_id", + width=512, + height=512, + is_animated=False, + is_video=False, + type="regular", + ), + star_count=5, + total_count=5, + remaining_count=5, + ), + Gift( + id="id2", + sticker=Sticker( + file_id="file_id", + file_unique_id="file_unique_id", + width=512, + height=512, + is_animated=False, + is_video=False, + type="regular", + ), + star_count=6, + total_count=6, + remaining_count=6, + ), + Gift( + id="id3", + sticker=Sticker( + file_id="file_id", + file_unique_id="file_unique_id", + width=512, + height=512, + is_animated=False, + is_video=False, + type="regular", + ), + star_count=7, + total_count=7, + remaining_count=7, + ), + ] + + +class TestGiftsWithoutRequest(GiftsTestBase): + def test_slot_behaviour(self, gifts): + for attr in gifts.__slots__: + assert getattr(gifts, attr, "err") != "err", f"got extra slot '{attr}'" + assert len(mro_slots(gifts)) == len(set(mro_slots(gifts))), "duplicate slot" + + def test_de_json(self, offline_bot, gifts): + json_dict = {"gifts": [gift.to_dict() for gift in self.gifts]} + gifts = Gifts.de_json(json_dict, offline_bot) + assert gifts.api_kwargs == {} + + assert gifts.gifts == tuple(self.gifts) + for de_json_gift, original_gift in zip(gifts.gifts, self.gifts): + assert de_json_gift.id == original_gift.id + assert de_json_gift.sticker == original_gift.sticker + assert de_json_gift.star_count == original_gift.star_count + assert de_json_gift.total_count == original_gift.total_count + assert de_json_gift.remaining_count == original_gift.remaining_count + + assert Gifts.de_json(None, offline_bot) is None + + def test_to_dict(self, gifts): + gifts_dict = gifts.to_dict() + + assert isinstance(gifts_dict, dict) + assert gifts_dict["gifts"] == [gift.to_dict() for gift in self.gifts] + + def test_equality(self, gifts): + a = gifts + b = Gifts(self.gifts) + c = Gifts(self.gifts[:2]) + d = BotCommand("start", "description") + + assert a == b + assert hash(a) == hash(b) + + assert a != c + assert hash(a) != hash(c) + + assert a != d + assert hash(a) != hash(d) + + +class TestGiftsWithRequest(GiftTestBase): + async def test_get_available_gifts(self, bot, chat_id): + # We don't control the available gifts, so we can not make any better assertions + assert isinstance(await bot.get_available_gifts(), Gifts) diff --git a/tests/test_giveaway.py b/tests/test_giveaway.py index 35945118363..3ef8bb7a1df 100644 --- a/tests/test_giveaway.py +++ b/tests/test_giveaway.py @@ -48,6 +48,7 @@ def giveaway(): premium_subscription_month_count=( TestGiveawayWithoutRequest.premium_subscription_month_count ), + prize_star_count=TestGiveawayWithoutRequest.prize_star_count, ) @@ -60,13 +61,14 @@ class TestGiveawayWithoutRequest: prize_description = "prize_description" country_codes = ["DE", "US"] premium_subscription_month_count = 3 + prize_star_count = 99 def test_slot_behaviour(self, giveaway): for attr in giveaway.__slots__: assert getattr(giveaway, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(giveaway)) == len(set(mro_slots(giveaway))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "chats": [chat.to_dict() for chat in self.chats], "winners_selection_date": to_timestamp(self.winners_selection_date), @@ -76,9 +78,10 @@ def test_de_json(self, bot): "prize_description": self.prize_description, "country_codes": self.country_codes, "premium_subscription_month_count": self.premium_subscription_month_count, + "prize_star_count": self.prize_star_count, } - giveaway = Giveaway.de_json(json_dict, bot) + giveaway = Giveaway.de_json(json_dict, offline_bot) assert giveaway.api_kwargs == {} assert giveaway.chats == tuple(self.chats) @@ -89,10 +92,11 @@ def test_de_json(self, bot): assert giveaway.prize_description == self.prize_description assert giveaway.country_codes == tuple(self.country_codes) assert giveaway.premium_subscription_month_count == self.premium_subscription_month_count + assert giveaway.prize_star_count == self.prize_star_count - assert Giveaway.de_json(None, bot) is None + assert Giveaway.de_json(None, offline_bot) is None - def test_de_json_localization(self, tz_bot, bot, raw_bot): + def test_de_json_localization(self, tz_bot, offline_bot, raw_bot): json_dict = { "chats": [chat.to_dict() for chat in self.chats], "winners_selection_date": to_timestamp(self.winners_selection_date), @@ -102,10 +106,11 @@ def test_de_json_localization(self, tz_bot, bot, raw_bot): "prize_description": self.prize_description, "country_codes": self.country_codes, "premium_subscription_month_count": self.premium_subscription_month_count, + "prize_star_count": self.prize_star_count, } giveaway_raw = Giveaway.de_json(json_dict, raw_bot) - giveaway_bot = Giveaway.de_json(json_dict, bot) + giveaway_bot = Giveaway.de_json(json_dict, offline_bot) giveaway_bot_tz = Giveaway.de_json(json_dict, tz_bot) # comparing utcoffsets because comparing timezones is unpredicatable @@ -133,6 +138,7 @@ def test_to_dict(self, giveaway): giveaway_dict["premium_subscription_month_count"] == self.premium_subscription_month_count ) + assert giveaway_dict["prize_star_count"] == self.prize_star_count def test_equality(self, giveaway): a = giveaway @@ -164,15 +170,40 @@ def test_equality(self, giveaway): assert hash(a) != hash(e) +@pytest.fixture(scope="module") +def giveaway_created(): + return GiveawayCreated( + prize_star_count=TestGiveawayCreatedWithoutRequest.prize_star_count, + ) + + class TestGiveawayCreatedWithoutRequest: - def test_slot_behaviour(self): - giveaway_created = GiveawayCreated() + prize_star_count = 99 + + def test_slot_behaviour(self, giveaway_created): for attr in giveaway_created.__slots__: assert getattr(giveaway_created, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(giveaway_created)) == len( set(mro_slots(giveaway_created)) ), "duplicate slot" + def test_de_json(self, bot): + json_dict = { + "prize_star_count": self.prize_star_count, + } + + gac = GiveawayCreated.de_json(json_dict, bot) + assert gac.api_kwargs == {} + assert gac.prize_star_count == self.prize_star_count + + assert Giveaway.de_json(None, bot) is None + + def test_to_dict(self, giveaway_created): + gac_dict = giveaway_created.to_dict() + + assert isinstance(gac_dict, dict) + assert gac_dict["prize_star_count"] == self.prize_star_count + @pytest.fixture(scope="module") def giveaway_winners(): @@ -190,6 +221,7 @@ def giveaway_winners(): additional_chat_count=TestGiveawayWinnersWithoutRequest.additional_chat_count, unclaimed_prize_count=TestGiveawayWinnersWithoutRequest.unclaimed_prize_count, was_refunded=TestGiveawayWinnersWithoutRequest.was_refunded, + prize_star_count=TestGiveawayWinnersWithoutRequest.prize_star_count, ) @@ -205,6 +237,7 @@ class TestGiveawayWinnersWithoutRequest: only_new_members = True was_refunded = True prize_description = "prize_description" + prize_star_count = 99 def test_slot_behaviour(self, giveaway_winners): for attr in giveaway_winners.__slots__: @@ -213,7 +246,7 @@ def test_slot_behaviour(self, giveaway_winners): set(mro_slots(giveaway_winners)) ), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "chat": self.chat.to_dict(), "giveaway_message_id": self.giveaway_message_id, @@ -226,9 +259,10 @@ def test_de_json(self, bot): "only_new_members": self.only_new_members, "was_refunded": self.was_refunded, "prize_description": self.prize_description, + "prize_star_count": self.prize_star_count, } - giveaway_winners = GiveawayWinners.de_json(json_dict, bot) + giveaway_winners = GiveawayWinners.de_json(json_dict, offline_bot) assert giveaway_winners.api_kwargs == {} assert giveaway_winners.chat == self.chat @@ -245,10 +279,11 @@ def test_de_json(self, bot): assert giveaway_winners.only_new_members == self.only_new_members assert giveaway_winners.was_refunded == self.was_refunded assert giveaway_winners.prize_description == self.prize_description + assert giveaway_winners.prize_star_count == self.prize_star_count - assert GiveawayWinners.de_json(None, bot) is None + assert GiveawayWinners.de_json(None, offline_bot) is None - def test_de_json_localization(self, tz_bot, bot, raw_bot): + def test_de_json_localization(self, tz_bot, offline_bot, raw_bot): json_dict = { "chat": self.chat.to_dict(), "giveaway_message_id": self.giveaway_message_id, @@ -258,7 +293,7 @@ def test_de_json_localization(self, tz_bot, bot, raw_bot): } giveaway_winners_raw = GiveawayWinners.de_json(json_dict, raw_bot) - giveaway_winners_bot = GiveawayWinners.de_json(json_dict, bot) + giveaway_winners_bot = GiveawayWinners.de_json(json_dict, offline_bot) giveaway_winners_bot_tz = GiveawayWinners.de_json(json_dict, tz_bot) # comparing utcoffsets because comparing timezones is unpredicatable @@ -291,6 +326,7 @@ def test_to_dict(self, giveaway_winners): assert giveaway_winners_dict["only_new_members"] == self.only_new_members assert giveaway_winners_dict["was_refunded"] == self.was_refunded assert giveaway_winners_dict["prize_description"] == self.prize_description + assert giveaway_winners_dict["prize_star_count"] == self.prize_star_count def test_equality(self, giveaway_winners): a = giveaway_winners @@ -336,12 +372,14 @@ def giveaway_completed(): winner_count=TestGiveawayCompletedWithoutRequest.winner_count, unclaimed_prize_count=TestGiveawayCompletedWithoutRequest.unclaimed_prize_count, giveaway_message=TestGiveawayCompletedWithoutRequest.giveaway_message, + is_star_giveaway=TestGiveawayCompletedWithoutRequest.is_star_giveaway, ) class TestGiveawayCompletedWithoutRequest: winner_count = 42 unclaimed_prize_count = 4 + is_star_giveaway = True giveaway_message = Message( message_id=1, date=dtm.datetime.now(dtm.timezone.utc), @@ -357,21 +395,23 @@ def test_slot_behaviour(self, giveaway_completed): set(mro_slots(giveaway_completed)) ), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "winner_count": self.winner_count, "unclaimed_prize_count": self.unclaimed_prize_count, "giveaway_message": self.giveaway_message.to_dict(), + "is_star_giveaway": self.is_star_giveaway, } - giveaway_completed = GiveawayCompleted.de_json(json_dict, bot) + giveaway_completed = GiveawayCompleted.de_json(json_dict, offline_bot) assert giveaway_completed.api_kwargs == {} assert giveaway_completed.winner_count == self.winner_count assert giveaway_completed.unclaimed_prize_count == self.unclaimed_prize_count assert giveaway_completed.giveaway_message == self.giveaway_message + assert giveaway_completed.is_star_giveaway == self.is_star_giveaway - assert GiveawayCompleted.de_json(None, bot) is None + assert GiveawayCompleted.de_json(None, offline_bot) is None def test_to_dict(self, giveaway_completed): giveaway_completed_dict = giveaway_completed.to_dict() @@ -380,6 +420,7 @@ def test_to_dict(self, giveaway_completed): assert giveaway_completed_dict["winner_count"] == self.winner_count assert giveaway_completed_dict["unclaimed_prize_count"] == self.unclaimed_prize_count assert giveaway_completed_dict["giveaway_message"] == self.giveaway_message.to_dict() + assert giveaway_completed_dict["is_star_giveaway"] == self.is_star_giveaway def test_equality(self, giveaway_completed): a = giveaway_completed @@ -387,6 +428,7 @@ def test_equality(self, giveaway_completed): winner_count=self.winner_count, unclaimed_prize_count=self.unclaimed_prize_count, giveaway_message=self.giveaway_message, + is_star_giveaway=self.is_star_giveaway, ) c = GiveawayCompleted( winner_count=self.winner_count + 30, diff --git a/tests/test_inlinequeryresultsbutton.py b/tests/test_inlinequeryresultsbutton.py index 2c6ad4336c2..1ec59573a3b 100644 --- a/tests/test_inlinequeryresultsbutton.py +++ b/tests/test_inlinequeryresultsbutton.py @@ -25,19 +25,19 @@ @pytest.fixture(scope="module") def inline_query_results_button(): return InlineQueryResultsButton( - text=TestInlineQueryResultsButtonBase.text, - start_parameter=TestInlineQueryResultsButtonBase.start_parameter, - web_app=TestInlineQueryResultsButtonBase.web_app, + text=InlineQueryResultsButtonTestBase.text, + start_parameter=InlineQueryResultsButtonTestBase.start_parameter, + web_app=InlineQueryResultsButtonTestBase.web_app, ) -class TestInlineQueryResultsButtonBase: +class InlineQueryResultsButtonTestBase: text = "text" start_parameter = "start_parameter" web_app = WebAppInfo(url="https://python-telegram-bot.org") -class TestInlineQueryResultsButtonWithoutRequest(TestInlineQueryResultsButtonBase): +class TestInlineQueryResultsButtonWithoutRequest(InlineQueryResultsButtonTestBase): def test_slot_behaviour(self, inline_query_results_button): inst = inline_query_results_button for attr in inst.__slots__: @@ -51,16 +51,16 @@ def test_to_dict(self, inline_query_results_button): assert inline_query_results_button_dict["start_parameter"] == self.start_parameter assert inline_query_results_button_dict["web_app"] == self.web_app.to_dict() - def test_de_json(self, bot): - assert InlineQueryResultsButton.de_json(None, bot) is None - assert InlineQueryResultsButton.de_json({}, bot) is None + def test_de_json(self, offline_bot): + assert InlineQueryResultsButton.de_json(None, offline_bot) is None + assert InlineQueryResultsButton.de_json({}, offline_bot) is None json_dict = { "text": self.text, "start_parameter": self.start_parameter, "web_app": self.web_app.to_dict(), } - inline_query_results_button = InlineQueryResultsButton.de_json(json_dict, bot) + inline_query_results_button = InlineQueryResultsButton.de_json(json_dict, offline_bot) assert inline_query_results_button.text == self.text assert inline_query_results_button.start_parameter == self.start_parameter diff --git a/tests/test_keyboardbutton.py b/tests/test_keyboardbutton.py index edd45cc9a8b..91f5ccab71f 100644 --- a/tests/test_keyboardbutton.py +++ b/tests/test_keyboardbutton.py @@ -32,17 +32,17 @@ @pytest.fixture(scope="module") def keyboard_button(): return KeyboardButton( - TestKeyboardButtonBase.text, - request_location=TestKeyboardButtonBase.request_location, - request_contact=TestKeyboardButtonBase.request_contact, - request_poll=TestKeyboardButtonBase.request_poll, - web_app=TestKeyboardButtonBase.web_app, - request_chat=TestKeyboardButtonBase.request_chat, - request_users=TestKeyboardButtonBase.request_users, + KeyboardButtonTestBase.text, + request_location=KeyboardButtonTestBase.request_location, + request_contact=KeyboardButtonTestBase.request_contact, + request_poll=KeyboardButtonTestBase.request_poll, + web_app=KeyboardButtonTestBase.web_app, + request_chat=KeyboardButtonTestBase.request_chat, + request_users=KeyboardButtonTestBase.request_users, ) -class TestKeyboardButtonBase: +class KeyboardButtonTestBase: text = "text" request_location = True request_contact = True @@ -52,7 +52,7 @@ class TestKeyboardButtonBase: request_users = KeyboardButtonRequestUsers(2) -class TestKeyboardButtonWithoutRequest(TestKeyboardButtonBase): +class TestKeyboardButtonWithoutRequest(KeyboardButtonTestBase): def test_slot_behaviour(self, keyboard_button): inst = keyboard_button for attr in inst.__slots__: @@ -81,7 +81,7 @@ def test_to_dict(self, keyboard_button): assert keyboard_button_dict["request_users"] == keyboard_button.request_users.to_dict() @pytest.mark.parametrize("request_user", [True, False]) - def test_de_json(self, bot, request_user): + def test_de_json(self, request_user): json_dict = { "text": self.text, "request_location": self.request_location, diff --git a/tests/test_keyboardbuttonpolltype.py b/tests/test_keyboardbuttonpolltype.py index 2d4f0dd5b17..6c4e92bf2ca 100644 --- a/tests/test_keyboardbuttonpolltype.py +++ b/tests/test_keyboardbuttonpolltype.py @@ -25,14 +25,14 @@ @pytest.fixture(scope="module") def keyboard_button_poll_type(): - return KeyboardButtonPollType(TestKeyboardButtonPollTypeBase.type) + return KeyboardButtonPollType(KeyboardButtonPollTypeTestBase.type) -class TestKeyboardButtonPollTypeBase: +class KeyboardButtonPollTypeTestBase: type = Poll.QUIZ -class TestKeyboardButtonPollTypeWithoutRequest(TestKeyboardButtonPollTypeBase): +class TestKeyboardButtonPollTypeWithoutRequest(KeyboardButtonPollTypeTestBase): def test_slot_behaviour(self, keyboard_button_poll_type): inst = keyboard_button_poll_type for attr in inst.__slots__: diff --git a/tests/test_keyboardbuttonrequest.py b/tests/test_keyboardbuttonrequest.py index 8678fd08d8e..9d9a0295206 100644 --- a/tests/test_keyboardbuttonrequest.py +++ b/tests/test_keyboardbuttonrequest.py @@ -26,21 +26,21 @@ @pytest.fixture(scope="class") def request_users(): return KeyboardButtonRequestUsers( - TestKeyboardButtonRequestUsersBase.request_id, - TestKeyboardButtonRequestUsersBase.user_is_bot, - TestKeyboardButtonRequestUsersBase.user_is_premium, - TestKeyboardButtonRequestUsersBase.max_quantity, + KeyboardButtonRequestUsersTestBase.request_id, + KeyboardButtonRequestUsersTestBase.user_is_bot, + KeyboardButtonRequestUsersTestBase.user_is_premium, + KeyboardButtonRequestUsersTestBase.max_quantity, ) -class TestKeyboardButtonRequestUsersBase: +class KeyboardButtonRequestUsersTestBase: request_id = 123 user_is_bot = True user_is_premium = False max_quantity = 10 -class TestKeyboardButtonRequestUsersWithoutRequest(TestKeyboardButtonRequestUsersBase): +class TestKeyboardButtonRequestUsersWithoutRequest(KeyboardButtonRequestUsersTestBase): def test_slot_behaviour(self, request_users): for attr in request_users.__slots__: assert getattr(request_users, attr, "err") != "err", f"got extra slot '{attr}'" @@ -57,14 +57,14 @@ def test_to_dict(self, request_users): assert request_users_dict["user_is_premium"] == self.user_is_premium assert request_users_dict["max_quantity"] == self.max_quantity - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "request_id": self.request_id, "user_is_bot": self.user_is_bot, "user_is_premium": self.user_is_premium, "max_quantity": self.max_quantity, } - request_users = KeyboardButtonRequestUsers.de_json(json_dict, bot) + request_users = KeyboardButtonRequestUsers.de_json(json_dict, offline_bot) assert request_users.api_kwargs == {} assert request_users.request_id == self.request_id @@ -88,18 +88,18 @@ def test_equality(self): @pytest.fixture(scope="class") def request_chat(): return KeyboardButtonRequestChat( - TestKeyboardButtonRequestChatBase.request_id, - TestKeyboardButtonRequestChatBase.chat_is_channel, - TestKeyboardButtonRequestChatBase.chat_is_forum, - TestKeyboardButtonRequestChatBase.chat_has_username, - TestKeyboardButtonRequestChatBase.chat_is_created, - TestKeyboardButtonRequestChatBase.user_administrator_rights, - TestKeyboardButtonRequestChatBase.bot_administrator_rights, - TestKeyboardButtonRequestChatBase.bot_is_member, + KeyboardButtonRequestChatTestBase.request_id, + KeyboardButtonRequestChatTestBase.chat_is_channel, + KeyboardButtonRequestChatTestBase.chat_is_forum, + KeyboardButtonRequestChatTestBase.chat_has_username, + KeyboardButtonRequestChatTestBase.chat_is_created, + KeyboardButtonRequestChatTestBase.user_administrator_rights, + KeyboardButtonRequestChatTestBase.bot_administrator_rights, + KeyboardButtonRequestChatTestBase.bot_is_member, ) -class TestKeyboardButtonRequestChatBase: +class KeyboardButtonRequestChatTestBase: request_id = 456 chat_is_channel = True chat_is_forum = False @@ -134,7 +134,7 @@ class TestKeyboardButtonRequestChatBase: bot_is_member = True -class TestKeyboardButtonRequestChatWithoutRequest(TestKeyboardButtonRequestChatBase): +class TestKeyboardButtonRequestChatWithoutRequest(KeyboardButtonRequestChatTestBase): def test_slot_behaviour(self, request_chat): for attr in request_chat.__slots__: assert getattr(request_chat, attr, "err") != "err", f"got extra slot '{attr}'" @@ -158,7 +158,7 @@ def test_to_dict(self, request_chat): ) assert request_chat_dict["bot_is_member"] == self.bot_is_member - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "request_id": self.request_id, "chat_is_channel": self.chat_is_channel, @@ -168,7 +168,7 @@ def test_de_json(self, bot): "bot_administrator_rights": self.bot_administrator_rights.to_dict(), "bot_is_member": self.bot_is_member, } - request_chat = KeyboardButtonRequestChat.de_json(json_dict, bot) + request_chat = KeyboardButtonRequestChat.de_json(json_dict, offline_bot) assert request_chat.api_kwargs == {} assert request_chat.request_id == self.request_id @@ -179,7 +179,7 @@ def test_de_json(self, bot): assert request_chat.bot_administrator_rights == self.bot_administrator_rights assert request_chat.bot_is_member == self.bot_is_member - empty_chat = KeyboardButtonRequestChat.de_json({}, bot) + empty_chat = KeyboardButtonRequestChat.de_json({}, offline_bot) assert empty_chat is None def test_equality(self): diff --git a/tests/test_linkpreviewoptions.py b/tests/test_linkpreviewoptions.py index 7b5bc7beb8b..a4fa5aea455 100644 --- a/tests/test_linkpreviewoptions.py +++ b/tests/test_linkpreviewoptions.py @@ -25,15 +25,15 @@ @pytest.fixture(scope="module") def link_preview_options(): return LinkPreviewOptions( - is_disabled=TestLinkPreviewOptionsBase.is_disabled, - url=TestLinkPreviewOptionsBase.url, - prefer_small_media=TestLinkPreviewOptionsBase.prefer_small_media, - prefer_large_media=TestLinkPreviewOptionsBase.prefer_large_media, - show_above_text=TestLinkPreviewOptionsBase.show_above_text, + is_disabled=LinkPreviewOptionsTestBase.is_disabled, + url=LinkPreviewOptionsTestBase.url, + prefer_small_media=LinkPreviewOptionsTestBase.prefer_small_media, + prefer_large_media=LinkPreviewOptionsTestBase.prefer_large_media, + show_above_text=LinkPreviewOptionsTestBase.show_above_text, ) -class TestLinkPreviewOptionsBase: +class LinkPreviewOptionsTestBase: is_disabled = True url = "https://www.example.com" prefer_small_media = True @@ -41,7 +41,7 @@ class TestLinkPreviewOptionsBase: show_above_text = True -class TestLinkPreviewOptionsWithoutRequest(TestLinkPreviewOptionsBase): +class TestLinkPreviewOptionsWithoutRequest(LinkPreviewOptionsTestBase): def test_slot_behaviour(self, link_preview_options): a = link_preview_options for attr in a.__slots__: diff --git a/tests/test_loginurl.py b/tests/test_loginurl.py index a9f69699b5f..2fd84e97e23 100644 --- a/tests/test_loginurl.py +++ b/tests/test_loginurl.py @@ -25,21 +25,21 @@ @pytest.fixture(scope="module") def login_url(): return LoginUrl( - url=TestLoginUrlBase.url, - forward_text=TestLoginUrlBase.forward_text, - bot_username=TestLoginUrlBase.bot_username, - request_write_access=TestLoginUrlBase.request_write_access, + url=LoginUrlTestBase.url, + forward_text=LoginUrlTestBase.forward_text, + bot_username=LoginUrlTestBase.bot_username, + request_write_access=LoginUrlTestBase.request_write_access, ) -class TestLoginUrlBase: +class LoginUrlTestBase: url = "http://www.google.com" forward_text = "Send me forward!" bot_username = "botname" request_write_access = True -class TestLoginUrlWithoutRequest(TestLoginUrlBase): +class TestLoginUrlWithoutRequest(LoginUrlTestBase): def test_slot_behaviour(self, login_url): for attr in login_url.__slots__: assert getattr(login_url, attr, "err") != "err", f"got extra slot '{attr}'" diff --git a/tests/test_maybeinaccessiblemessage.py b/tests/test_maybeinaccessiblemessage.py index 2c6617af8f4..8cad89e884c 100644 --- a/tests/test_maybeinaccessiblemessage.py +++ b/tests/test_maybeinaccessiblemessage.py @@ -29,19 +29,19 @@ @pytest.fixture(scope="class") def maybe_inaccessible_message(): return MaybeInaccessibleMessage( - TestMaybeInaccessibleMessageBase.chat, - TestMaybeInaccessibleMessageBase.message_id, - TestMaybeInaccessibleMessageBase.date, + MaybeInaccessibleMessageTestBase.chat, + MaybeInaccessibleMessageTestBase.message_id, + MaybeInaccessibleMessageTestBase.date, ) -class TestMaybeInaccessibleMessageBase: +class MaybeInaccessibleMessageTestBase: chat = Chat(1, "title") message_id = 123 date = dtm.datetime.now(dtm.timezone.utc).replace(microsecond=0) -class TestMaybeInaccessibleMessageWithoutRequest(TestMaybeInaccessibleMessageBase): +class TestMaybeInaccessibleMessageWithoutRequest(MaybeInaccessibleMessageTestBase): def test_slot_behaviour(self, maybe_inaccessible_message): for attr in maybe_inaccessible_message.__slots__: assert ( @@ -59,20 +59,20 @@ def test_to_dict(self, maybe_inaccessible_message): assert maybe_inaccessible_message_dict["message_id"] == self.message_id assert maybe_inaccessible_message_dict["date"] == to_timestamp(self.date) - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "chat": self.chat.to_dict(), "message_id": self.message_id, "date": to_timestamp(self.date), } - maybe_inaccessible_message = MaybeInaccessibleMessage.de_json(json_dict, bot) + maybe_inaccessible_message = MaybeInaccessibleMessage.de_json(json_dict, offline_bot) assert maybe_inaccessible_message.api_kwargs == {} assert maybe_inaccessible_message.chat == self.chat assert maybe_inaccessible_message.message_id == self.message_id assert maybe_inaccessible_message.date == self.date - def test_de_json_localization(self, tz_bot, bot, raw_bot): + def test_de_json_localization(self, tz_bot, offline_bot, raw_bot): json_dict = { "chat": self.chat.to_dict(), "message_id": self.message_id, @@ -80,7 +80,7 @@ def test_de_json_localization(self, tz_bot, bot, raw_bot): } maybe_inaccessible_message_raw = MaybeInaccessibleMessage.de_json(json_dict, raw_bot) - maybe_inaccessible_message_bot = MaybeInaccessibleMessage.de_json(json_dict, bot) + maybe_inaccessible_message_bot = MaybeInaccessibleMessage.de_json(json_dict, offline_bot) maybe_inaccessible_message_bot_tz = MaybeInaccessibleMessage.de_json(json_dict, tz_bot) # comparing utcoffsets because comparing timezones is unpredicatable @@ -95,14 +95,14 @@ def test_de_json_localization(self, tz_bot, bot, raw_bot): assert maybe_inaccessible_message_bot.date.tzinfo == UTC assert maybe_inaccessible_message_bot_tz_offset == tz_bot_offset - def test_de_json_zero_date(self, bot): + def test_de_json_zero_date(self, offline_bot): json_dict = { "chat": self.chat.to_dict(), "message_id": self.message_id, "date": 0, } - maybe_inaccessible_message = MaybeInaccessibleMessage.de_json(json_dict, bot) + maybe_inaccessible_message = MaybeInaccessibleMessage.de_json(json_dict, offline_bot) assert maybe_inaccessible_message.date == ZERO_DATE assert maybe_inaccessible_message.date is ZERO_DATE diff --git a/tests/test_menubutton.py b/tests/test_menubutton.py index 48c9c30c9f2..d9ae7c1ef12 100644 --- a/tests/test_menubutton.py +++ b/tests/test_menubutton.py @@ -84,31 +84,31 @@ def menu_button(scope_class_and_type): return scope_class_and_type[0].de_json( { "type": scope_class_and_type[1], - "text": TestMenuButtonselfBase.text, - "web_app": TestMenuButtonselfBase.web_app.to_dict(), + "text": MenuButtonTestBase.text, + "web_app": MenuButtonTestBase.web_app.to_dict(), }, bot=None, ) -class TestMenuButtonselfBase: +class MenuButtonTestBase: text = "button_text" web_app = WebAppInfo(url="https://python-telegram-bot.org/web_app") # All the scope types are very similar, so we test everything via parametrization -class TestMenuButtonWithoutRequest(TestMenuButtonselfBase): +class TestMenuButtonWithoutRequest(MenuButtonTestBase): def test_slot_behaviour(self, menu_button): for attr in menu_button.__slots__: assert getattr(menu_button, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(menu_button)) == len(set(mro_slots(menu_button))), "duplicate slot" - def test_de_json(self, bot, scope_class_and_type): + def test_de_json(self, offline_bot, scope_class_and_type): cls = scope_class_and_type[0] type_ = scope_class_and_type[1] json_dict = {"type": type_, "text": self.text, "web_app": self.web_app.to_dict()} - menu_button = MenuButton.de_json(json_dict, bot) + menu_button = MenuButton.de_json(json_dict, offline_bot) assert set(menu_button.api_kwargs.keys()) == {"text", "web_app"} - set(cls.__slots__) assert isinstance(menu_button, MenuButton) @@ -119,22 +119,22 @@ def test_de_json(self, bot, scope_class_and_type): if "text" in cls.__slots__: assert menu_button.text == self.text - assert cls.de_json(None, bot) is None - assert MenuButton.de_json({}, bot) is None + assert cls.de_json(None, offline_bot) is None + assert MenuButton.de_json({}, offline_bot) is None - def test_de_json_invalid_type(self, bot): + def test_de_json_invalid_type(self, offline_bot): json_dict = {"type": "invalid", "text": self.text, "web_app": self.web_app.to_dict()} - menu_button = MenuButton.de_json(json_dict, bot) + menu_button = MenuButton.de_json(json_dict, offline_bot) assert menu_button.api_kwargs == {"text": self.text, "web_app": self.web_app.to_dict()} assert type(menu_button) is MenuButton assert menu_button.type == "invalid" - def test_de_json_subclass(self, scope_class, bot): + def test_de_json_subclass(self, scope_class, offline_bot): """This makes sure that e.g. MenuButtonDefault(data) never returns a MenuButtonChat instance.""" json_dict = {"type": "invalid", "text": self.text, "web_app": self.web_app.to_dict()} - assert type(scope_class.de_json(json_dict, bot)) is scope_class + assert type(scope_class.de_json(json_dict, offline_bot)) is scope_class def test_de_json_empty_data(self, scope_class): if scope_class in (MenuButtonWebApp,): @@ -157,7 +157,7 @@ def test_type_enum_conversion(self): assert type(MenuButton("commands").type) is MenuButtonType assert MenuButton("unknown").type == "unknown" - def test_equality(self, menu_button, bot): + def test_equality(self, menu_button, offline_bot): a = MenuButton("base_type") b = MenuButton("base_type") c = menu_button @@ -185,7 +185,7 @@ def test_equality(self, menu_button, bot): if hasattr(c, "web_app"): json_dict = c.to_dict() json_dict["web_app"] = WebAppInfo("https://foo.bar/web_app").to_dict() - f = c.__class__.de_json(json_dict, bot) + f = c.__class__.de_json(json_dict, offline_bot) assert c != f assert hash(c) != hash(f) @@ -193,7 +193,7 @@ def test_equality(self, menu_button, bot): if hasattr(c, "text"): json_dict = c.to_dict() json_dict["text"] = "other text" - g = c.__class__.de_json(json_dict, bot) + g = c.__class__.de_json(json_dict, offline_bot) assert c != g assert hash(c) != hash(g) diff --git a/tests/test_message.py b/tests/test_message.py index 9e575a99f45..8fc9a32f8ec 100644 --- a/tests/test_message.py +++ b/tests/test_message.py @@ -16,8 +16,10 @@ # # 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 contextlib +import datetime as dtm from copy import copy -from datetime import datetime import pytest @@ -39,6 +41,7 @@ GiveawayCompleted, GiveawayCreated, GiveawayWinners, + InputPaidMediaPhoto, Invoice, LinkPreviewOptions, Location, @@ -90,13 +93,13 @@ from tests.auxil.slots import mro_slots -@pytest.fixture(scope="module") +@pytest.fixture def message(bot): message = PytestMessage( - message_id=TestMessageBase.id_, - date=TestMessageBase.date, - chat=copy(TestMessageBase.chat), - from_user=copy(TestMessageBase.from_user), + message_id=MessageTestBase.id_, + date=MessageTestBase.date, + chat=copy(MessageTestBase.chat), + from_user=copy(MessageTestBase.from_user), business_connection_id="123456789", ) message.set_bot(bot) @@ -110,10 +113,10 @@ def message(bot): params=[ { "reply_to_message": Message( - 50, datetime.utcnow(), Chat(13, "channel"), User(9, "i", False) + 50, dtm.datetime.utcnow(), Chat(13, "channel"), User(9, "i", False) ) }, - {"edit_date": datetime.utcnow()}, + {"edit_date": dtm.datetime.utcnow()}, { "text": "a text message", "entities": [MessageEntity("bold", 10, 4), MessageEntity("italic", 16, 7)], @@ -159,7 +162,7 @@ def message(bot): {"migrate_from_chat_id": -54321}, { "pinned_message": Message( - 7, datetime.utcnow(), Chat(13, "channel"), User(9, "i", False) + 7, dtm.datetime.utcnow(), Chat(13, "channel"), User(9, "i", False) ) }, {"invoice": Invoice("my invoice", "invoice", "start", "EUR", 243)}, @@ -208,7 +211,7 @@ def message(bot): User(1, "John", False), User(2, "Doe", False), 42 ) }, - {"video_chat_scheduled": VideoChatScheduled(datetime.utcnow())}, + {"video_chat_scheduled": VideoChatScheduled(dtm.datetime.utcnow())}, {"video_chat_started": VideoChatStarted()}, {"video_chat_ended": VideoChatEnded(100)}, { @@ -232,16 +235,16 @@ def message(bot): { "giveaway": Giveaway( chats=[Chat(1, Chat.SUPERGROUP)], - winners_selection_date=datetime.utcnow().replace(microsecond=0), + winners_selection_date=dtm.datetime.utcnow().replace(microsecond=0), winner_count=5, ) }, - {"giveaway_created": GiveawayCreated()}, + {"giveaway_created": GiveawayCreated(prize_star_count=99)}, { "giveaway_winners": GiveawayWinners( chat=Chat(1, Chat.CHANNEL), giveaway_message_id=123456789, - winners_selection_date=datetime.utcnow().replace(microsecond=0), + winners_selection_date=dtm.datetime.utcnow().replace(microsecond=0), winner_count=42, winners=[User(1, "user1", False), User(2, "user2", False)], ) @@ -264,11 +267,11 @@ def message(bot): }, { "external_reply": ExternalReplyInfo( - MessageOriginChat(datetime.utcnow(), Chat(1, Chat.PRIVATE)) + MessageOriginChat(dtm.datetime.utcnow(), Chat(1, Chat.PRIVATE)) ) }, {"quote": TextQuote("a text quote", 1)}, - {"forward_origin": MessageOriginChat(datetime.utcnow(), Chat(1, Chat.PRIVATE))}, + {"forward_origin": MessageOriginChat(dtm.datetime.utcnow(), Chat(1, Chat.PRIVATE))}, {"reply_to_story": Story(Chat(1, Chat.PRIVATE), 0)}, {"boost_added": ChatBoostAdded(100)}, {"sender_boost_count": 1}, @@ -357,20 +360,20 @@ def message(bot): ) def message_params(bot, request): message = Message( - message_id=TestMessageBase.id_, - from_user=TestMessageBase.from_user, - date=TestMessageBase.date, - chat=TestMessageBase.chat, + message_id=MessageTestBase.id_, + from_user=MessageTestBase.from_user, + date=MessageTestBase.date, + chat=MessageTestBase.chat, **request.param, ) message.set_bot(bot) return message -class TestMessageBase: +class MessageTestBase: id_ = 1 from_user = User(2, "testuser", False) - date = datetime.utcnow() + date = dtm.datetime.utcnow() chat = Chat(3, "private") test_entities = [ {"length": 4, "offset": 10, "type": "bold"}, @@ -439,7 +442,7 @@ class TestMessageBase: ) -class TestMessageWithoutRequest(TestMessageBase): +class TestMessageWithoutRequest(MessageTestBase): @staticmethod async def check_quote_parsing( message: Message, method, bot_method_name: str, args, monkeypatch @@ -447,11 +450,14 @@ async def check_quote_parsing( """Used in testing reply_* below. Makes sure that quote and do_quote are handled correctly """ - with pytest.raises(ValueError, match="`quote` and `do_quote` are mutually exclusive"): - await method(*args, quote=True, do_quote=True) + with contextlib.suppress(TypeError): + # for newer methods that don't have the deprecated argument + with pytest.raises(ValueError, match="`quote` and `do_quote` are mutually exclusive"): + await method(*args, quote=True, do_quote=True) - with pytest.warns(PTBDeprecationWarning, match="`quote` parameter is deprecated"): - await method(*args, quote=True) + # for newer methods that don't have the deprecated argument + with pytest.warns(PTBDeprecationWarning, match="`quote` parameter is deprecated"): + await method(*args, quote=True) with pytest.raises( ValueError, @@ -465,13 +471,16 @@ async def make_assertion(*args, **kwargs): monkeypatch.setattr(message.get_bot(), bot_method_name, make_assertion) for param in ("quote", "do_quote"): - chat_id, reply_parameters = await method(*args, **{param: True}) - 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 != message.message_id: - pytest.fail( - f"reply_parameters is {reply_parameters} but should be {message.message_id}" - ) + with contextlib.suppress(TypeError): + # for newer methods that don't have the deprecated argument + chat_id, reply_parameters = await method(*args, **{param: True}) + 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 != message.message_id: + pytest.fail( + f"reply_parameters is {reply_parameters} " + "but should be {message.message_id}" + ) input_chat_id = object() input_reply_parameters = ReplyParameters(message_id=1, chat_id=42) @@ -559,17 +568,17 @@ async def extract_message_thread_id(*args, **kwargs): def test_slot_behaviour(self): message = Message( - message_id=TestMessageBase.id_, - date=TestMessageBase.date, - chat=copy(TestMessageBase.chat), - from_user=copy(TestMessageBase.from_user), + message_id=MessageTestBase.id_, + date=MessageTestBase.date, + chat=copy(MessageTestBase.chat), + from_user=copy(MessageTestBase.from_user), ) for attr in message.__slots__: assert getattr(message, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(message)) == len(set(mro_slots(message))), "duplicate slot" - def test_all_possibilities_de_json_and_to_dict(self, bot, message_params): - new = Message.de_json(message_params.to_dict(), bot) + def test_all_possibilities_de_json_and_to_dict(self, offline_bot, message_params): + new = Message.de_json(message_params.to_dict(), offline_bot) assert new.api_kwargs == {} assert new.to_dict() == message_params.to_dict() @@ -579,17 +588,17 @@ def test_all_possibilities_de_json_and_to_dict(self, bot, message_params): for slot in new.__slots__: assert not isinstance(new[slot], dict) - def test_de_json_localization(self, bot, raw_bot, tz_bot): + def test_de_json_localization(self, offline_bot, raw_bot, tz_bot): json_dict = { "message_id": 12, "from_user": None, - "date": int(datetime.now().timestamp()), + "date": int(dtm.datetime.now().timestamp()), "chat": None, - "edit_date": int(datetime.now().timestamp()), + "edit_date": int(dtm.datetime.now().timestamp()), } message_raw = Message.de_json(json_dict, raw_bot) - message_bot = Message.de_json(json_dict, bot) + message_bot = Message.de_json(json_dict, offline_bot) message_tz = Message.de_json(json_dict, tz_bot) # comparing utcoffsets because comparing timezones is unpredicatable @@ -609,7 +618,7 @@ def test_de_json_localization(self, bot, raw_bot, tz_bot): assert message_bot.edit_date.tzinfo == UTC assert edit_date_offset == edit_date_tz_bot_offset - def test_de_json_api_kwargs_backward_compatibility(self, bot, message_params): + def test_de_json_api_kwargs_backward_compatibility(self, offline_bot, message_params): message_dict = message_params.to_dict() keys = ( "user_shared", @@ -622,7 +631,7 @@ def test_de_json_api_kwargs_backward_compatibility(self, bot, message_params): ) for key in keys: message_dict[key] = key - message = Message.de_json(message_dict, bot) + message = Message.de_json(message_dict, offline_bot) assert message.api_kwargs == {key: key for key in keys} def test_equality(self): @@ -1193,16 +1202,20 @@ def test_link_with_id(self, message, type_, id_): # The leading - for group ids/ -100 for supergroup ids isn't supposed to be in the link assert message.link == f"https://t.me/c/{3}/{message.message_id}" - def test_link_with_topics(self, message): + @pytest.mark.parametrize("type_", argvalues=[Chat.SUPERGROUP, Chat.CHANNEL]) + def test_link_with_topics(self, message, type_): message.chat.username = None message.chat.id = -1003 + message.chat.type = type_ message.is_topic_message = True message.message_thread_id = 123 assert message.link == f"https://t.me/c/3/{message.message_id}?thread=123" - def test_link_with_reply(self, message): + @pytest.mark.parametrize("type_", argvalues=[Chat.SUPERGROUP, Chat.CHANNEL]) + def test_link_with_reply(self, message, type_): message.chat.username = None message.chat.id = -1003 + message.chat.type = type_ message.reply_to_message = Message(7, self.from_user, self.date, self.chat, text="Reply") message.message_thread_id = 123 assert message.link == f"https://t.me/c/3/{message.message_id}?thread=123" @@ -2345,6 +2358,42 @@ async def make_assertion(*_, **kwargs): monkeypatch, ) + async def test_reply_paid_media(self, monkeypatch, message): + async def make_assertion(*_, **kwargs): + id_ = kwargs["chat_id"] == message.chat_id + media = kwargs["media"][0].media == "media" + star_count = kwargs["star_count"] == 5 + return id_ and media and star_count + + assert check_shortcut_signature( + Message.reply_paid_media, + Bot.send_paid_media, + ["chat_id", "reply_to_message_id", "business_connection_id"], + ["do_quote", "reply_to_message_id"], + ) + assert await check_shortcut_call( + message.reply_paid_media, + message.get_bot(), + "send_paid_media", + skip_params=["reply_to_message_id"], + shortcut_kwargs=["business_connection_id"], + ) + assert await check_defaults_handling( + message.reply_paid_media, message.get_bot(), no_default_kwargs={"message_thread_id"} + ) + + monkeypatch.setattr(message.get_bot(), "send_paid_media", make_assertion) + assert await message.reply_paid_media( + star_count=5, media=[InputPaidMediaPhoto(media="media")] + ) + await self.check_quote_parsing( + message, + message.reply_paid_media, + "send_paid_media", + ["test", [InputPaidMediaPhoto(media="media")]], + monkeypatch, + ) + async def test_edit_text(self, monkeypatch, message): async def make_assertion(*_, **kwargs): chat_id = kwargs["chat_id"] == message.chat_id @@ -2592,9 +2641,17 @@ async def make_assertion(*args, **kwargs): return chat_id and message_id assert check_shortcut_signature( - Message.pin, Bot.pin_chat_message, ["chat_id", "message_id"], [] + Message.pin, + Bot.pin_chat_message, + ["chat_id", "message_id", "business_connection_id"], + [], + ) + assert await check_shortcut_call( + message.pin, + message.get_bot(), + "pin_chat_message", + shortcut_kwargs=["chat_id", "message_id", "business_connection_id"], ) - assert await check_shortcut_call(message.pin, message.get_bot(), "pin_chat_message") assert await check_defaults_handling(message.pin, message.get_bot()) monkeypatch.setattr(message.get_bot(), "pin_chat_message", make_assertion) @@ -2607,13 +2664,16 @@ async def make_assertion(*args, **kwargs): return chat_id and message_id assert check_shortcut_signature( - Message.unpin, Bot.unpin_chat_message, ["chat_id", "message_id"], [] + Message.unpin, + Bot.unpin_chat_message, + ["chat_id", "message_id", "business_connection_id"], + [], ) assert await check_shortcut_call( message.unpin, message.get_bot(), "unpin_chat_message", - shortcut_kwargs=["chat_id", "message_id"], + shortcut_kwargs=["chat_id", "message_id", "business_connection_id"], ) assert await check_defaults_handling(message.unpin, message.get_bot()) @@ -2638,10 +2698,10 @@ async def make_assertion(*args, **kwargs): ], ) async def test_default_do_quote( - self, bot, message, default_quote, chat_type, expected, monkeypatch + self, offline_bot, message, default_quote, chat_type, expected, monkeypatch ): original_bot = message.get_bot() - temp_bot = PytestExtBot(token=bot.token, defaults=Defaults(do_quote=default_quote)) + temp_bot = PytestExtBot(token=offline_bot.token, defaults=Defaults(do_quote=default_quote)) message.set_bot(temp_bot) async def make_assertion(*_, **kwargs): diff --git a/tests/test_messageentity.py b/tests/test_messageentity.py index 8bab9fec7b9..b65ccf418f5 100644 --- a/tests/test_messageentity.py +++ b/tests/test_messageentity.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/]. import random -from typing import List, Tuple import pytest @@ -41,23 +40,23 @@ def message_entity(request): return MessageEntity(type_, 1, 3, url=url, user=user, language=language) -class TestMessageEntityBase: +class MessageEntityTestBase: type_ = "url" offset = 1 length = 2 url = "url" -class TestMessageEntityWithoutRequest(TestMessageEntityBase): +class TestMessageEntityWithoutRequest(MessageEntityTestBase): def test_slot_behaviour(self, message_entity): inst = message_entity for attr in inst.__slots__: assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = {"type": self.type_, "offset": self.offset, "length": self.length} - entity = MessageEntity.de_json(json_dict, bot) + entity = MessageEntity.de_json(json_dict, offline_bot) assert entity.api_kwargs == {} assert entity.type == self.type_ @@ -86,7 +85,7 @@ def test_enum_init(self): def test_fix_utf16(self): text = "𠌕 bold 𝄢 italic underlined: 𝛙𝌢𑁍" - inputs_outputs: List[Tuple[Tuple[int, int, str], Tuple[int, int]]] = [ + inputs_outputs: list[tuple[tuple[int, int, str], tuple[int, int]]] = [ ((2, 4, MessageEntity.BOLD), (3, 4)), ((9, 6, MessageEntity.ITALIC), (11, 6)), ((28, 3, MessageEntity.UNDERLINE), (30, 6)), @@ -103,6 +102,54 @@ def test_fix_utf16(self): assert out_entity.offset == offset assert out_entity.length == length + @pytest.mark.parametrize("by", [6, "prefix", "𝛙𝌢𑁍"]) + def test_shift_entities(self, by): + kwargs = { + "url": "url", + "user": 42, + "language": "python", + "custom_emoji_id": "custom_emoji_id", + } + entities = [ + MessageEntity(MessageEntity.BOLD, 2, 3, **kwargs), + MessageEntity(MessageEntity.BOLD, 5, 6, **kwargs), + ] + shifted = MessageEntity.shift_entities(by, entities) + assert shifted[0].offset == 8 + assert shifted[1].offset == 11 + + assert shifted[0] is not entities[0] + assert shifted[1] is not entities[1] + + for entity in shifted: + for key, value in kwargs.items(): + assert getattr(entity, key) == value + + def test_concatenate(self): + kwargs = { + "url": "url", + "user": 42, + "language": "python", + "custom_emoji_id": "custom_emoji_id", + } + first_entity = MessageEntity(MessageEntity.BOLD, 0, 6, **kwargs) + second_entity = MessageEntity(MessageEntity.ITALIC, 0, 4, **kwargs) + third_entity = MessageEntity(MessageEntity.UNDERLINE, 3, 6, **kwargs) + + first = ("prefix 𝛙𝌢𑁍 | ", [first_entity], True) + second = ("text 𝛙𝌢𑁍", [second_entity], False) + third = (" | suffix 𝛙𝌢𑁍", [third_entity]) + + new_text, new_entities = MessageEntity.concatenate(first, second, third) + + assert new_text == "prefix 𝛙𝌢𑁍 | text 𝛙𝌢𑁍 | suffix 𝛙𝌢𑁍" + assert [entity.offset for entity in new_entities] == [0, 16, 30] + for old, new in zip([first_entity, second_entity, third_entity], new_entities): + assert new is not old + assert new.type == old.type + for key, value in kwargs.items(): + assert getattr(new, key) == value + def test_equality(self): a = MessageEntity(MessageEntity.BOLD, 2, 3) b = MessageEntity(MessageEntity.BOLD, 2, 3) diff --git a/tests/test_messageorigin.py b/tests/test_messageorigin.py index 1e46fc53c9a..be85d73b391 100644 --- a/tests/test_messageorigin.py +++ b/tests/test_messageorigin.py @@ -16,7 +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 +import datetime as dtm import inspect from copy import deepcopy @@ -39,7 +39,7 @@ class MODefaults: - date: datetime.datetime = to_timestamp(datetime.datetime.utcnow()) + date: dtm.datetime = to_timestamp(dtm.datetime.utcnow()) chat = Chat(1, Chat.CHANNEL) message_id = 123 author_signautre = "PTB" @@ -106,7 +106,7 @@ def iter_args( if param.name in ignored: continue inst_at, json_at = getattr(instance, param.name), getattr(de_json_inst, param.name) - if isinstance(json_at, datetime.datetime): # Convert datetime to int + if isinstance(json_at, dtm.datetime): # Convert datetime to int json_at = to_timestamp(json_at) if ( param.default is not inspect.Parameter.empty and include_optional @@ -114,7 +114,7 @@ def iter_args( yield inst_at, json_at -@pytest.fixture() +@pytest.fixture def message_origin_type(request): return request.param() @@ -136,12 +136,12 @@ def test_slot_behaviour(self, message_origin_type): assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json_required_args(self, bot, message_origin_type): + def test_de_json_required_args(self, offline_bot, message_origin_type): cls = message_origin_type.__class__ - assert cls.de_json({}, bot) is None + assert cls.de_json({}, offline_bot) is None json_dict = make_json_dict(message_origin_type) - const_message_origin = MessageOrigin.de_json(json_dict, bot) + const_message_origin = MessageOrigin.de_json(json_dict, offline_bot) assert const_message_origin.api_kwargs == {} assert isinstance(const_message_origin, MessageOrigin) @@ -151,9 +151,9 @@ def test_de_json_required_args(self, bot, message_origin_type): ): assert msg_origin_type_at == const_msg_origin_at - def test_de_json_all_args(self, bot, message_origin_type): + def test_de_json_all_args(self, offline_bot, message_origin_type): json_dict = make_json_dict(message_origin_type, include_optional_args=True) - const_message_origin = MessageOrigin.de_json(json_dict, bot) + const_message_origin = MessageOrigin.de_json(json_dict, offline_bot) assert const_message_origin.api_kwargs == {} @@ -164,10 +164,12 @@ def test_de_json_all_args(self, bot, message_origin_type): ): assert msg_origin_type_at == const_msg_origin_at - def test_de_json_messageorigin_localization(self, message_origin_type, tz_bot, bot, raw_bot): + def test_de_json_messageorigin_localization( + self, message_origin_type, tz_bot, offline_bot, raw_bot + ): json_dict = make_json_dict(message_origin_type, include_optional_args=True) msgorigin_raw = MessageOrigin.de_json(json_dict, raw_bot) - msgorigin_bot = MessageOrigin.de_json(json_dict, bot) + msgorigin_bot = MessageOrigin.de_json(json_dict, offline_bot) msgorigin_tz = MessageOrigin.de_json(json_dict, tz_bot) # comparing utcoffsets because comparing timezones is unpredicatable @@ -178,19 +180,19 @@ def test_de_json_messageorigin_localization(self, message_origin_type, tz_bot, b assert msgorigin_bot.date.tzinfo == UTC assert msgorigin_offset == tz_bot_offset - def test_de_json_invalid_type(self, message_origin_type, bot): + def test_de_json_invalid_type(self, message_origin_type, offline_bot): json_dict = {"type": "invalid", "date": MODefaults.date} - message_origin_type = MessageOrigin.de_json(json_dict, bot) + message_origin_type = MessageOrigin.de_json(json_dict, offline_bot) assert type(message_origin_type) is MessageOrigin assert message_origin_type.type == "invalid" - def test_de_json_subclass(self, message_origin_type, bot, chat_id): - """This makes sure that e.g. MessageOriginChat(data, bot) never returns a + def test_de_json_subclass(self, message_origin_type, offline_bot, chat_id): + """This makes sure that e.g. MessageOriginChat(data, offline_bot) never returns a MessageOriginUser instance.""" cls = message_origin_type.__class__ json_dict = make_json_dict(message_origin_type, True) - assert type(cls.de_json(json_dict, bot)) is cls + assert type(cls.de_json(json_dict, offline_bot)) is cls def test_to_dict(self, message_origin_type): message_origin_dict = message_origin_type.to_dict() diff --git a/tests/test_official/arg_type_checker.py b/tests/test_official/arg_type_checker.py index 24ef867ba70..5f90abc00b5 100644 --- a/tests/test_official/arg_type_checker.py +++ b/tests/test_official/arg_type_checker.py @@ -20,12 +20,13 @@ match the official API. It also checks if the type annotations are correct and if the parameters are required or not.""" +import datetime as dtm import inspect import logging import re -from datetime import datetime +from collections.abc import Sequence from types import FunctionType -from typing import Any, Sequence +from typing import Any from telegram._utils.defaultvalue import DefaultValue from telegram._utils.types import FileInput, ODVInput @@ -66,6 +67,7 @@ """, re.VERBOSE, ) +TIMEDELTA_REGEX = re.compile(r"\w+_period$") # Parameter names ending with "_period" log = logging.debug @@ -188,9 +190,20 @@ def check_param_type( if ptb_param.name in PTCE.DATETIME_EXCEPTIONS: return True, mapped_type # If it's a class, we only accept datetime as the parameter - mapped_type = datetime if is_class else mapped_type | datetime + mapped_type = dtm.datetime if is_class else mapped_type | dtm.datetime - # 4) COMPLEX TYPES: + # 4) HANDLING TIMEDELTA: + elif re.search(TIMEDELTA_REGEX, ptb_param.name) and obj.__name__ in ( + "TransactionPartnerUser", + "create_invoice_link", + ): + # 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 + + # 5) COMPLEX TYPES: # Some types are too complicated, so we replace our annotation with a simpler type: elif any(ptb_param.name in key for key in PTCE.COMPLEX_TYPES): log("Converting `%s` to a simpler type!\n", ptb_param.name) @@ -198,7 +211,7 @@ def check_param_type( if ptb_param.name == param_name and is_class is is_expected_class: ptb_annotation = wrap_with_none(tg_parameter, exception_type, obj) - # 5) HANDLING DEFAULTS PARAMETERS: + # 6) HANDLING DEFAULTS PARAMETERS: # Classes whose parameters are all ODVInput should be converted and checked. elif obj.__name__ in PTCE.IGNORED_DEFAULTS_CLASSES: log("Checking that `%s`'s param is ODVInput:\n", obj.__name__) diff --git a/tests/test_official/exceptions.py b/tests/test_official/exceptions.py index c9e3b4e4650..d6eb421e8ba 100644 --- a/tests/test_official/exceptions.py +++ b/tests/test_official/exceptions.py @@ -18,8 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains exceptions to our API compared to the official API.""" - -from telegram import Animation, Audio, Document, PhotoSize, Sticker, Video, VideoNote, Voice +from telegram import Animation, Audio, Document, Gift, PhotoSize, Sticker, Video, VideoNote, Voice from tests.test_official.helpers import _get_params_base IGNORED_OBJECTS = ("ResponseParameters",) @@ -45,6 +44,7 @@ class ParamTypeCheckingExceptions: "animation": Animation, "voice": Voice, "sticker": Sticker, + "gift_id": Gift, } # TODO: Look into merging this with COMPLEX_TYPES @@ -57,7 +57,7 @@ class ParamTypeCheckingExceptions: ("reaction", False): "ReactionType", # + str ("options", False): "InputPollOption", # + str # TODO: Deprecated and will be corrected (and removed) in next major PTB version: - ("file_hashes", True): "List[str]", + ("file_hashes", True): "list[str]", } # Special cases for other parameters that accept more types than the official API, and are @@ -117,7 +117,7 @@ class ParamTypeCheckingExceptions: "PassportElementError": {"source", "type", "message"}, "InputMedia": {"caption", "caption_entities", "media", "media_type", "parse_mode"}, "InputMedia(Animation|Audio|Document|Photo|Video|VideoNote|Voice)": {"filename"}, - "InputFile": {"attach", "filename", "obj"}, + "InputFile": {"attach", "filename", "obj", "read_file_handle"}, "MaybeInaccessibleMessage": {"date", "message_id", "chat"}, # attributes common to all subcls "ChatBoostSource": {"source"}, # attributes common to all subclasses "MessageOrigin": {"type", "date"}, # attributes common to all subclasses diff --git a/tests/test_official/helpers.py b/tests/test_official/helpers.py index 6851bf85fa2..68ffffa09e3 100644 --- a/tests/test_official/helpers.py +++ b/tests/test_official/helpers.py @@ -20,7 +20,8 @@ import functools import re -from typing import TYPE_CHECKING, Any, Sequence, _eval_type, get_type_hints +from collections.abc import Sequence +from typing import TYPE_CHECKING, Any, _eval_type, get_type_hints from bs4 import PageElement, Tag diff --git a/tests/test_paidmedia.py b/tests/test_paidmedia.py index f76bcf6310f..ee2ea9f9636 100644 --- a/tests/test_paidmedia.py +++ b/tests/test_paidmedia.py @@ -27,8 +27,10 @@ PaidMediaInfo, PaidMediaPhoto, PaidMediaPreview, + PaidMediaPurchased, PaidMediaVideo, PhotoSize, + User, Video, ) from telegram.constants import PaidMediaType @@ -96,33 +98,41 @@ def paid_media(pm_scope_class_and_type): return pm_scope_class_and_type[0].de_json( { "type": pm_scope_class_and_type[1], - "width": TestPaidMediaBase.width, - "height": TestPaidMediaBase.height, - "duration": TestPaidMediaBase.duration, - "video": TestPaidMediaBase.video.to_dict(), - "photo": [p.to_dict() for p in TestPaidMediaBase.photo], + "width": PaidMediaTestBase.width, + "height": PaidMediaTestBase.height, + "duration": PaidMediaTestBase.duration, + "video": PaidMediaTestBase.video.to_dict(), + "photo": [p.to_dict() for p in PaidMediaTestBase.photo], }, bot=None, ) def paid_media_video(): - return PaidMediaVideo(video=TestPaidMediaBase.video) + return PaidMediaVideo(video=PaidMediaTestBase.video) def paid_media_photo(): - return PaidMediaPhoto(photo=TestPaidMediaBase.photo) + return PaidMediaPhoto(photo=PaidMediaTestBase.photo) @pytest.fixture(scope="module") def paid_media_info(): return PaidMediaInfo( - star_count=TestPaidMediaInfoBase.star_count, + star_count=PaidMediaInfoTestBase.star_count, paid_media=[paid_media_video(), paid_media_photo()], ) -class TestPaidMediaBase: +@pytest.fixture(scope="module") +def paid_media_purchased(): + return PaidMediaPurchased( + from_user=PaidMediaPurchasedTestBase.from_user, + paid_media_payload=PaidMediaPurchasedTestBase.paid_media_payload, + ) + + +class PaidMediaTestBase: width = 640 height = 480 duration = 60 @@ -143,14 +153,14 @@ class TestPaidMediaBase: ) -class TestPaidMediaWithoutRequest(TestPaidMediaBase): +class TestPaidMediaWithoutRequest(PaidMediaTestBase): def test_slot_behaviour(self, paid_media): inst = paid_media for attr in inst.__slots__: assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json(self, bot, pm_scope_class_and_type): + def test_de_json(self, offline_bot, pm_scope_class_and_type): cls = pm_scope_class_and_type[0] type_ = pm_scope_class_and_type[1] @@ -162,7 +172,7 @@ def test_de_json(self, bot, pm_scope_class_and_type): "video": self.video.to_dict(), "photo": [p.to_dict() for p in self.photo], } - pm = PaidMedia.de_json(json_dict, bot) + pm = PaidMedia.de_json(json_dict, offline_bot) assert set(pm.api_kwargs.keys()) == { "width", "height", @@ -183,10 +193,10 @@ def test_de_json(self, bot, pm_scope_class_and_type): if "photo" in cls.__slots__: assert pm.photo == self.photo - assert cls.de_json(None, bot) is None - assert PaidMedia.de_json({}, bot) is None + assert cls.de_json(None, offline_bot) is None + assert PaidMedia.de_json({}, offline_bot) is None - def test_de_json_invalid_type(self, bot): + def test_de_json_invalid_type(self, offline_bot): json_dict = { "type": "invalid", "width": self.width, @@ -195,7 +205,7 @@ def test_de_json_invalid_type(self, bot): "video": self.video.to_dict(), "photo": [p.to_dict() for p in self.photo], } - pm = PaidMedia.de_json(json_dict, bot) + pm = PaidMedia.de_json(json_dict, offline_bot) assert pm.api_kwargs == { "width": self.width, "height": self.height, @@ -207,7 +217,7 @@ def test_de_json_invalid_type(self, bot): assert type(pm) is PaidMedia assert pm.type == "invalid" - def test_de_json_subclass(self, pm_scope_class, bot): + def test_de_json_subclass(self, pm_scope_class, offline_bot): """This makes sure that e.g. PaidMediaPreivew(data) never returns a TransactionPartnerPhoto instance.""" json_dict = { @@ -218,7 +228,7 @@ def test_de_json_subclass(self, pm_scope_class, bot): "video": self.video.to_dict(), "photo": [p.to_dict() for p in self.photo], } - assert type(pm_scope_class.de_json(json_dict, bot)) is pm_scope_class + assert type(pm_scope_class.de_json(json_dict, offline_bot)) is pm_scope_class def test_to_dict(self, paid_media): pm_dict = paid_media.to_dict() @@ -238,7 +248,7 @@ def test_type_enum_conversion(self): assert type(PaidMedia("video").type) is PaidMediaType assert PaidMedia("unknown").type == "unknown" - def test_equality(self, paid_media, bot): + def test_equality(self, paid_media, offline_bot): a = PaidMedia("base_type") b = PaidMedia("base_type") c = paid_media @@ -266,7 +276,7 @@ def test_equality(self, paid_media, bot): if hasattr(c, "video"): json_dict = c.to_dict() json_dict["video"] = Video("different", "d2", 1, 1, 1).to_dict() - f = c.__class__.de_json(json_dict, bot) + f = c.__class__.de_json(json_dict, offline_bot) assert c != f assert hash(c) != hash(f) @@ -274,31 +284,31 @@ def test_equality(self, paid_media, bot): if hasattr(c, "photo"): json_dict = c.to_dict() json_dict["photo"] = [PhotoSize("different", "d2", 1, 1, 1).to_dict()] - f = c.__class__.de_json(json_dict, bot) + f = c.__class__.de_json(json_dict, offline_bot) assert c != f assert hash(c) != hash(f) -class TestPaidMediaInfoBase: +class PaidMediaInfoTestBase: star_count = 200 paid_media = [paid_media_video(), paid_media_photo()] -class TestPaidMediaInfoWithoutRequest(TestPaidMediaInfoBase): +class TestPaidMediaInfoWithoutRequest(PaidMediaInfoTestBase): def test_slot_behaviour(self, paid_media_info): inst = paid_media_info for attr in inst.__slots__: assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "star_count": self.star_count, "paid_media": [t.to_dict() for t in self.paid_media], } - pmi = PaidMediaInfo.de_json(json_dict, bot) - pmi_none = PaidMediaInfo.de_json(None, bot) + pmi = PaidMediaInfo.de_json(json_dict, offline_bot) + pmi_none = PaidMediaInfo.de_json(None, offline_bot) assert pmi.paid_media == tuple(self.paid_media) assert pmi.star_count == self.star_count assert pmi_none is None @@ -323,3 +333,54 @@ def test_equality(self): assert pmi1 != pmi3 assert hash(pmi1) != hash(pmi3) + + +class PaidMediaPurchasedTestBase: + from_user = User(1, "user", False) + paid_media_payload = "payload" + + +class TestPaidMediaPurchasedWithoutRequest(PaidMediaPurchasedTestBase): + def test_slot_behaviour(self, paid_media_purchased): + inst = paid_media_purchased + for attr in inst.__slots__: + assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" + assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" + + def test_de_json(self, bot): + json_dict = { + "from": self.from_user.to_dict(), + "paid_media_payload": self.paid_media_payload, + } + pmp = PaidMediaPurchased.de_json(json_dict, bot) + pmp_none = PaidMediaPurchased.de_json(None, bot) + assert pmp.from_user == self.from_user + assert pmp.paid_media_payload == self.paid_media_payload + assert pmp.api_kwargs == {} + assert pmp_none is None + + def test_to_dict(self, paid_media_purchased): + assert paid_media_purchased.to_dict() == { + "from": self.from_user.to_dict(), + "paid_media_payload": self.paid_media_payload, + } + + def test_equality(self): + pmp1 = PaidMediaPurchased( + from_user=self.from_user, + paid_media_payload=self.paid_media_payload, + ) + pmp2 = PaidMediaPurchased( + from_user=self.from_user, + paid_media_payload=self.paid_media_payload, + ) + pmp3 = PaidMediaPurchased( + from_user=User(2, "user", False), + paid_media_payload="other", + ) + + assert pmp1 == pmp2 + assert hash(pmp1) == hash(pmp2) + + assert pmp1 != pmp3 + assert hash(pmp1) != hash(pmp3) diff --git a/tests/test_poll.py b/tests/test_poll.py index 92c58339daf..4d5304fdca5 100644 --- a/tests/test_poll.py +++ b/tests/test_poll.py @@ -15,7 +15,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/]. -from datetime import datetime, timedelta, timezone +import datetime as dtm import pytest @@ -28,15 +28,15 @@ @pytest.fixture(scope="module") def input_poll_option(): out = InputPollOption( - text=TestInputPollOptionBase.text, - text_parse_mode=TestInputPollOptionBase.text_parse_mode, - text_entities=TestInputPollOptionBase.text_entities, + text=InputPollOptionTestBase.text, + text_parse_mode=InputPollOptionTestBase.text_parse_mode, + text_entities=InputPollOptionTestBase.text_entities, ) out._unfreeze() return out -class TestInputPollOptionBase: +class InputPollOptionTestBase: text = "test option" text_parse_mode = "MarkdownV2" text_entities = [ @@ -45,7 +45,7 @@ class TestInputPollOptionBase: ] -class TestInputPollOptionWithoutRequest(TestInputPollOptionBase): +class TestInputPollOptionWithoutRequest(InputPollOptionTestBase): def test_slot_behaviour(self, input_poll_option): for attr in input_poll_option.__slots__: assert getattr(input_poll_option, attr, "err") != "err", f"got extra slot '{attr}'" @@ -106,15 +106,15 @@ def test_equality(self): @pytest.fixture(scope="module") def poll_option(): out = PollOption( - text=TestPollOptionBase.text, - voter_count=TestPollOptionBase.voter_count, - text_entities=TestPollOptionBase.text_entities, + text=PollOptionTestBase.text, + voter_count=PollOptionTestBase.voter_count, + text_entities=PollOptionTestBase.text_entities, ) out._unfreeze() return out -class TestPollOptionBase: +class PollOptionTestBase: text = "test option" voter_count = 3 text_entities = [ @@ -123,7 +123,7 @@ class TestPollOptionBase: ] -class TestPollOptionWithoutRequest(TestPollOptionBase): +class TestPollOptionWithoutRequest(PollOptionTestBase): def test_slot_behaviour(self, poll_option): for attr in poll_option.__slots__: assert getattr(poll_option, attr, "err") != "err", f"got extra slot '{attr}'" @@ -198,21 +198,21 @@ def test_equality(self): @pytest.fixture(scope="module") def poll_answer(): return PollAnswer( - TestPollAnswerBase.poll_id, - TestPollAnswerBase.option_ids, - TestPollAnswerBase.user, - TestPollAnswerBase.voter_chat, + PollAnswerTestBase.poll_id, + PollAnswerTestBase.option_ids, + PollAnswerTestBase.user, + PollAnswerTestBase.voter_chat, ) -class TestPollAnswerBase: +class PollAnswerTestBase: poll_id = "id" option_ids = [2] user = User(1, "", False) voter_chat = Chat(1, "") -class TestPollAnswerWithoutRequest(TestPollAnswerBase): +class TestPollAnswerWithoutRequest(PollAnswerTestBase): def test_de_json(self): json_dict = { "poll_id": self.poll_id, @@ -264,25 +264,25 @@ def test_equality(self): @pytest.fixture(scope="module") def poll(): poll = Poll( - TestPollBase.id_, - TestPollBase.question, - TestPollBase.options, - TestPollBase.total_voter_count, - TestPollBase.is_closed, - TestPollBase.is_anonymous, - TestPollBase.type, - TestPollBase.allows_multiple_answers, - explanation=TestPollBase.explanation, - explanation_entities=TestPollBase.explanation_entities, - open_period=TestPollBase.open_period, - close_date=TestPollBase.close_date, - question_entities=TestPollBase.question_entities, + PollTestBase.id_, + PollTestBase.question, + PollTestBase.options, + PollTestBase.total_voter_count, + PollTestBase.is_closed, + PollTestBase.is_anonymous, + PollTestBase.type, + PollTestBase.allows_multiple_answers, + explanation=PollTestBase.explanation, + explanation_entities=PollTestBase.explanation_entities, + open_period=PollTestBase.open_period, + close_date=PollTestBase.close_date, + question_entities=PollTestBase.question_entities, ) poll._unfreeze() return poll -class TestPollBase: +class PollTestBase: id_ = "id" question = "Test Question?" options = [PollOption("test", 10), PollOption("test2", 11)] @@ -297,15 +297,15 @@ class TestPollBase: ).decode("unicode-escape") explanation_entities = [MessageEntity(13, 17, MessageEntity.URL)] open_period = 42 - close_date = datetime.now(timezone.utc) + close_date = dtm.datetime.now(dtm.timezone.utc) question_entities = [ MessageEntity(MessageEntity.BOLD, 0, 4), MessageEntity(MessageEntity.ITALIC, 5, 8), ] -class TestPollWithoutRequest(TestPollBase): - def test_de_json(self, bot): +class TestPollWithoutRequest(PollTestBase): + def test_de_json(self, offline_bot): json_dict = { "id": self.id_, "question": self.question, @@ -321,7 +321,7 @@ def test_de_json(self, bot): "close_date": to_timestamp(self.close_date), "question_entities": [e.to_dict() for e in self.question_entities], } - poll = Poll.de_json(json_dict, bot) + poll = Poll.de_json(json_dict, offline_bot) assert poll.api_kwargs == {} assert poll.id == self.id_ @@ -339,11 +339,11 @@ def test_de_json(self, bot): assert poll.explanation == self.explanation assert poll.explanation_entities == tuple(self.explanation_entities) assert poll.open_period == self.open_period - assert abs(poll.close_date - self.close_date) < timedelta(seconds=1) + 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) - def test_de_json_localization(self, tz_bot, bot, raw_bot): + def test_de_json_localization(self, tz_bot, offline_bot, raw_bot): json_dict = { "id": self.id_, "question": self.question, @@ -361,7 +361,7 @@ def test_de_json_localization(self, tz_bot, bot, raw_bot): } poll_raw = Poll.de_json(json_dict, raw_bot) - poll_bot = Poll.de_json(json_dict, bot) + poll_bot = Poll.de_json(json_dict, offline_bot) poll_bot_tz = Poll.de_json(json_dict, tz_bot) # comparing utcoffsets because comparing timezones is unpredicatable diff --git a/tests/test_proximityalerttriggered.py b/tests/test_proximityalerttriggered.py index 3db91ffbe0b..6367af9d383 100644 --- a/tests/test_proximityalerttriggered.py +++ b/tests/test_proximityalerttriggered.py @@ -25,32 +25,32 @@ @pytest.fixture(scope="module") def proximity_alert_triggered(): return ProximityAlertTriggered( - TestProximityAlertTriggeredBase.traveler, - TestProximityAlertTriggeredBase.watcher, - TestProximityAlertTriggeredBase.distance, + ProximityAlertTriggeredTestBase.traveler, + ProximityAlertTriggeredTestBase.watcher, + ProximityAlertTriggeredTestBase.distance, ) -class TestProximityAlertTriggeredBase: +class ProximityAlertTriggeredTestBase: traveler = User(1, "foo", False) watcher = User(2, "bar", False) distance = 42 -class TestProximityAlertTriggeredWithoutRequest(TestProximityAlertTriggeredBase): +class TestProximityAlertTriggeredWithoutRequest(ProximityAlertTriggeredTestBase): def test_slot_behaviour(self, proximity_alert_triggered): inst = proximity_alert_triggered for attr in inst.__slots__: assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "traveler": self.traveler.to_dict(), "watcher": self.watcher.to_dict(), "distance": self.distance, } - proximity_alert_triggered = ProximityAlertTriggered.de_json(json_dict, bot) + proximity_alert_triggered = ProximityAlertTriggered.de_json(json_dict, offline_bot) assert proximity_alert_triggered.api_kwargs == {} assert proximity_alert_triggered.traveler == self.traveler diff --git a/tests/test_reaction.py b/tests/test_reaction.py index 30e287ca5e5..79f3e2c40be 100644 --- a/tests/test_reaction.py +++ b/tests/test_reaction.py @@ -28,6 +28,7 @@ ReactionType, ReactionTypeCustomEmoji, ReactionTypeEmoji, + ReactionTypePaid, ) from telegram.constants import ReactionEmoji from tests.auxil.slots import mro_slots @@ -48,6 +49,10 @@ def reaction_type_emoji(): return ReactionTypeEmoji(RTDefaults.normal_emoji) +def reaction_type_paid(): + return ReactionTypePaid() + + def make_json_dict(instance: ReactionType, include_optional_args: bool = False) -> dict: """Used to make the json dict which we use for testing de_json. Similar to iter_args()""" json_dict = {"type": instance.type} @@ -89,7 +94,7 @@ def iter_args(instance: ReactionType, de_json_inst: ReactionType, include_option yield inst_at, json_at -@pytest.fixture() +@pytest.fixture def reaction_type(request): return request.param() @@ -99,6 +104,7 @@ def reaction_type(request): [ reaction_type_custom_emoji, reaction_type_emoji, + reaction_type_paid, ], indirect=True, ) @@ -109,12 +115,13 @@ def test_slot_behaviour(self, reaction_type): assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json_required_args(self, bot, reaction_type): + def test_de_json_required_args(self, offline_bot, reaction_type): cls = reaction_type.__class__ - assert cls.de_json(None, bot) is None + assert cls.de_json(None, offline_bot) is None + assert ReactionType.de_json({}, offline_bot) is None json_dict = make_json_dict(reaction_type) - const_reaction_type = ReactionType.de_json(json_dict, bot) + const_reaction_type = ReactionType.de_json(json_dict, offline_bot) assert const_reaction_type.api_kwargs == {} assert isinstance(const_reaction_type, ReactionType) @@ -124,9 +131,9 @@ def test_de_json_required_args(self, bot, reaction_type): ): assert reaction_type_at == const_reaction_type_at - def test_de_json_all_args(self, bot, reaction_type): + def test_de_json_all_args(self, offline_bot, reaction_type): json_dict = make_json_dict(reaction_type, include_optional_args=True) - const_reaction_type = ReactionType.de_json(json_dict, bot) + const_reaction_type = ReactionType.de_json(json_dict, offline_bot) assert const_reaction_type.api_kwargs == {} assert isinstance(const_reaction_type, ReactionType) @@ -134,19 +141,19 @@ def test_de_json_all_args(self, bot, reaction_type): for c_mem_type_at, const_c_mem_at in iter_args(reaction_type, const_reaction_type, True): assert c_mem_type_at == const_c_mem_at - def test_de_json_invalid_type(self, bot, reaction_type): + def test_de_json_invalid_type(self, offline_bot, reaction_type): json_dict = {"type": "invalid"} - reaction_type = ReactionType.de_json(json_dict, bot) + reaction_type = ReactionType.de_json(json_dict, offline_bot) assert type(reaction_type) is ReactionType assert reaction_type.type == "invalid" - def test_de_json_subclass(self, reaction_type, bot, chat_id): - """This makes sure that e.g. ReactionTypeEmoji(data, bot) never returns a + def test_de_json_subclass(self, reaction_type, offline_bot, chat_id): + """This makes sure that e.g. ReactionTypeEmoji(data, offline_bot) never returns a ReactionTypeCustomEmoji instance.""" cls = reaction_type.__class__ json_dict = make_json_dict(reaction_type, True) - assert type(cls.de_json(json_dict, bot)) is cls + assert type(cls.de_json(json_dict, offline_bot)) is cls def test_to_dict(self, reaction_type): reaction_type_dict = reaction_type.to_dict() @@ -155,7 +162,7 @@ def test_to_dict(self, reaction_type): assert reaction_type_dict["type"] == reaction_type.type if reaction_type.type == ReactionType.EMOJI: assert reaction_type_dict["emoji"] == reaction_type.emoji - else: + elif reaction_type.type == ReactionType.CUSTOM_EMOJI: assert reaction_type_dict["custom_emoji_id"] == reaction_type.custom_emoji_id for slot in reaction_type.__slots__: # additional verification for the optional args @@ -230,13 +237,13 @@ def test_slot_behaviour(self, reaction_count): set(mro_slots(reaction_count)) ), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "type": self.type.to_dict(), "total_count": self.total_count, } - reaction_count = ReactionCount.de_json(json_dict, bot) + reaction_count = ReactionCount.de_json(json_dict, offline_bot) assert reaction_count.api_kwargs == {} assert isinstance(reaction_count, ReactionCount) @@ -245,7 +252,7 @@ def test_de_json(self, bot): assert reaction_count.type.emoji == self.type.emoji assert reaction_count.total_count == self.total_count - assert ReactionCount.de_json(None, bot) is None + assert ReactionCount.de_json(None, offline_bot) is None def test_to_dict(self, reaction_count): reaction_count_dict = reaction_count.to_dict() diff --git a/tests/test_reply.py b/tests/test_reply.py index f41ed01eb59..a450a721d7d 100644 --- a/tests/test_reply.py +++ b/tests/test_reply.py @@ -41,16 +41,16 @@ @pytest.fixture(scope="module") def external_reply_info(): return ExternalReplyInfo( - origin=TestExternalReplyInfoBase.origin, - chat=TestExternalReplyInfoBase.chat, - message_id=TestExternalReplyInfoBase.message_id, - link_preview_options=TestExternalReplyInfoBase.link_preview_options, - giveaway=TestExternalReplyInfoBase.giveaway, - paid_media=TestExternalReplyInfoBase.paid_media, + origin=ExternalReplyInfoTestBase.origin, + chat=ExternalReplyInfoTestBase.chat, + message_id=ExternalReplyInfoTestBase.message_id, + link_preview_options=ExternalReplyInfoTestBase.link_preview_options, + giveaway=ExternalReplyInfoTestBase.giveaway, + paid_media=ExternalReplyInfoTestBase.paid_media, ) -class TestExternalReplyInfoBase: +class ExternalReplyInfoTestBase: origin = MessageOriginUser( dtm.datetime.now(dtm.timezone.utc).replace(microsecond=0), User(1, "user", False) ) @@ -65,7 +65,7 @@ class TestExternalReplyInfoBase: paid_media = PaidMediaInfo(5, [PaidMediaPreview(10, 10, 10)]) -class TestExternalReplyInfoWithoutRequest(TestExternalReplyInfoBase): +class TestExternalReplyInfoWithoutRequest(ExternalReplyInfoTestBase): def test_slot_behaviour(self, external_reply_info): for attr in external_reply_info.__slots__: assert getattr(external_reply_info, attr, "err") != "err", f"got extra slot '{attr}'" @@ -73,7 +73,7 @@ def test_slot_behaviour(self, external_reply_info): set(mro_slots(external_reply_info)) ), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "origin": self.origin.to_dict(), "chat": self.chat.to_dict(), @@ -83,7 +83,7 @@ def test_de_json(self, bot): "paid_media": self.paid_media.to_dict(), } - external_reply_info = ExternalReplyInfo.de_json(json_dict, bot) + external_reply_info = ExternalReplyInfo.de_json(json_dict, offline_bot) assert external_reply_info.api_kwargs == {} assert external_reply_info.origin == self.origin @@ -93,7 +93,7 @@ def test_de_json(self, bot): assert external_reply_info.giveaway == self.giveaway assert external_reply_info.paid_media == self.paid_media - assert ExternalReplyInfo.de_json(None, bot) is None + assert ExternalReplyInfo.de_json(None, offline_bot) is None def test_to_dict(self, external_reply_info): ext_reply_info_dict = external_reply_info.to_dict() @@ -128,14 +128,14 @@ def test_equality(self, external_reply_info): @pytest.fixture(scope="module") def text_quote(): return TextQuote( - text=TestTextQuoteBase.text, - position=TestTextQuoteBase.position, - entities=TestTextQuoteBase.entities, - is_manual=TestTextQuoteBase.is_manual, + text=TextQuoteTestBase.text, + position=TextQuoteTestBase.position, + entities=TextQuoteTestBase.entities, + is_manual=TextQuoteTestBase.is_manual, ) -class TestTextQuoteBase: +class TextQuoteTestBase: text = "text" position = 1 entities = [ @@ -145,13 +145,13 @@ class TestTextQuoteBase: is_manual = True -class TestTextQuoteWithoutRequest(TestTextQuoteBase): +class TestTextQuoteWithoutRequest(TextQuoteTestBase): def test_slot_behaviour(self, text_quote): for attr in text_quote.__slots__: assert getattr(text_quote, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(text_quote)) == len(set(mro_slots(text_quote))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "text": self.text, "position": self.position, @@ -159,7 +159,7 @@ def test_de_json(self, bot): "is_manual": self.is_manual, } - text_quote = TextQuote.de_json(json_dict, bot) + text_quote = TextQuote.de_json(json_dict, offline_bot) assert text_quote.api_kwargs == {} assert text_quote.text == self.text @@ -167,7 +167,7 @@ def test_de_json(self, bot): assert text_quote.entities == tuple(self.entities) assert text_quote.is_manual == self.is_manual - assert TextQuote.de_json(None, bot) is None + assert TextQuote.de_json(None, offline_bot) is None def test_to_dict(self, text_quote): text_quote_dict = text_quote.to_dict() @@ -202,17 +202,17 @@ def test_equality(self, text_quote): @pytest.fixture(scope="module") def reply_parameters(): return ReplyParameters( - message_id=TestReplyParametersBase.message_id, - chat_id=TestReplyParametersBase.chat_id, - allow_sending_without_reply=TestReplyParametersBase.allow_sending_without_reply, - quote=TestReplyParametersBase.quote, - quote_parse_mode=TestReplyParametersBase.quote_parse_mode, - quote_entities=TestReplyParametersBase.quote_entities, - quote_position=TestReplyParametersBase.quote_position, + message_id=ReplyParametersTestBase.message_id, + chat_id=ReplyParametersTestBase.chat_id, + allow_sending_without_reply=ReplyParametersTestBase.allow_sending_without_reply, + quote=ReplyParametersTestBase.quote, + quote_parse_mode=ReplyParametersTestBase.quote_parse_mode, + quote_entities=ReplyParametersTestBase.quote_entities, + quote_position=ReplyParametersTestBase.quote_position, ) -class TestReplyParametersBase: +class ReplyParametersTestBase: message_id = 123 chat_id = 456 allow_sending_without_reply = True @@ -225,7 +225,7 @@ class TestReplyParametersBase: quote_position = 5 -class TestReplyParametersWithoutRequest(TestReplyParametersBase): +class TestReplyParametersWithoutRequest(ReplyParametersTestBase): def test_slot_behaviour(self, reply_parameters): for attr in reply_parameters.__slots__: assert getattr(reply_parameters, attr, "err") != "err", f"got extra slot '{attr}'" @@ -233,7 +233,7 @@ def test_slot_behaviour(self, reply_parameters): set(mro_slots(reply_parameters)) ), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "message_id": self.message_id, "chat_id": self.chat_id, @@ -244,7 +244,7 @@ def test_de_json(self, bot): "quote_position": self.quote_position, } - reply_parameters = ReplyParameters.de_json(json_dict, bot) + reply_parameters = ReplyParameters.de_json(json_dict, offline_bot) assert reply_parameters.api_kwargs == {} assert reply_parameters.message_id == self.message_id @@ -255,7 +255,7 @@ def test_de_json(self, bot): assert reply_parameters.quote_entities == tuple(self.quote_entities) assert reply_parameters.quote_position == self.quote_position - assert ReplyParameters.de_json(None, bot) is None + assert ReplyParameters.de_json(None, offline_bot) is None def test_to_dict(self, reply_parameters): reply_parameters_dict = reply_parameters.to_dict() diff --git a/tests/test_replykeyboardmarkup.py b/tests/test_replykeyboardmarkup.py index 15654208d2f..68996a246f5 100644 --- a/tests/test_replykeyboardmarkup.py +++ b/tests/test_replykeyboardmarkup.py @@ -26,15 +26,15 @@ @pytest.fixture(scope="module") def reply_keyboard_markup(): return ReplyKeyboardMarkup( - TestReplyKeyboardMarkupBase.keyboard, - resize_keyboard=TestReplyKeyboardMarkupBase.resize_keyboard, - one_time_keyboard=TestReplyKeyboardMarkupBase.one_time_keyboard, - selective=TestReplyKeyboardMarkupBase.selective, - is_persistent=TestReplyKeyboardMarkupBase.is_persistent, + ReplyKeyboardMarkupTestBase.keyboard, + resize_keyboard=ReplyKeyboardMarkupTestBase.resize_keyboard, + one_time_keyboard=ReplyKeyboardMarkupTestBase.one_time_keyboard, + selective=ReplyKeyboardMarkupTestBase.selective, + is_persistent=ReplyKeyboardMarkupTestBase.is_persistent, ) -class TestReplyKeyboardMarkupBase: +class ReplyKeyboardMarkupTestBase: keyboard = [[KeyboardButton("button1"), KeyboardButton("button2")]] resize_keyboard = True one_time_keyboard = True @@ -42,7 +42,7 @@ class TestReplyKeyboardMarkupBase: is_persistent = True -class TestReplyKeyboardMarkupWithoutRequest(TestReplyKeyboardMarkupBase): +class TestReplyKeyboardMarkupWithoutRequest(ReplyKeyboardMarkupTestBase): def test_slot_behaviour(self, reply_keyboard_markup): inst = reply_keyboard_markup for attr in inst.__slots__: @@ -154,7 +154,7 @@ def test_from_column(self): assert len(reply_keyboard_markup[1]) == 1 -class TestReplyKeyboardMarkupWithRequest(TestReplyKeyboardMarkupBase): +class TestReplyKeyboardMarkupWithRequest(ReplyKeyboardMarkupTestBase): async def test_send_message_with_reply_keyboard_markup( self, bot, chat_id, reply_keyboard_markup ): diff --git a/tests/test_replykeyboardremove.py b/tests/test_replykeyboardremove.py index f1a771e7f4c..f0054588168 100644 --- a/tests/test_replykeyboardremove.py +++ b/tests/test_replykeyboardremove.py @@ -24,15 +24,15 @@ @pytest.fixture(scope="module") def reply_keyboard_remove(): - return ReplyKeyboardRemove(selective=TestReplyKeyboardRemoveBase.selective) + return ReplyKeyboardRemove(selective=ReplyKeyboardRemoveTestBase.selective) -class TestReplyKeyboardRemoveBase: +class ReplyKeyboardRemoveTestBase: remove_keyboard = True selective = True -class TestReplyKeyboardRemoveWithoutRequest(TestReplyKeyboardRemoveBase): +class TestReplyKeyboardRemoveWithoutRequest(ReplyKeyboardRemoveTestBase): def test_slot_behaviour(self, reply_keyboard_remove): inst = reply_keyboard_remove for attr in inst.__slots__: @@ -52,7 +52,7 @@ def test_to_dict(self, reply_keyboard_remove): assert reply_keyboard_remove_dict["selective"] == reply_keyboard_remove.selective -class TestReplyKeyboardRemoveWithRequest(TestReplyKeyboardRemoveBase): +class TestReplyKeyboardRemoveWithRequest(ReplyKeyboardRemoveTestBase): async def test_send_message_with_reply_keyboard_remove( self, bot, chat_id, reply_keyboard_remove ): diff --git a/tests/test_sentwebappmessage.py b/tests/test_sentwebappmessage.py index c523ea09f75..bd206eedef1 100644 --- a/tests/test_sentwebappmessage.py +++ b/tests/test_sentwebappmessage.py @@ -25,14 +25,14 @@ @pytest.fixture(scope="module") def sent_web_app_message(): - return SentWebAppMessage(inline_message_id=TestSentWebAppMessageBase.inline_message_id) + return SentWebAppMessage(inline_message_id=SentWebAppMessageTestBase.inline_message_id) -class TestSentWebAppMessageBase: +class SentWebAppMessageTestBase: inline_message_id = "123" -class TestSentWebAppMessageWithoutRequest(TestSentWebAppMessageBase): +class TestSentWebAppMessageWithoutRequest(SentWebAppMessageTestBase): def test_slot_behaviour(self, sent_web_app_message): inst = sent_web_app_message for attr in inst.__slots__: @@ -45,7 +45,7 @@ def test_to_dict(self, sent_web_app_message): assert isinstance(sent_web_app_message_dict, dict) assert sent_web_app_message_dict["inline_message_id"] == self.inline_message_id - def test_de_json(self, bot): + def test_de_json(self, offline_bot): data = {"inline_message_id": self.inline_message_id} m = SentWebAppMessage.de_json(data, None) assert m.api_kwargs == {} diff --git a/tests/test_shared.py b/tests/test_shared.py index 53e5fe4d882..9cc8d4bcaa8 100644 --- a/tests/test_shared.py +++ b/tests/test_shared.py @@ -25,16 +25,16 @@ @pytest.fixture(scope="class") def users_shared(): - return UsersShared(TestUsersSharedBase.request_id, users=TestUsersSharedBase.users) + return UsersShared(UsersSharedTestBase.request_id, users=UsersSharedTestBase.users) -class TestUsersSharedBase: +class UsersSharedTestBase: request_id = 789 user_ids = (101112, 101113) users = (SharedUser(101112, "user1"), SharedUser(101113, "user2")) -class TestUsersSharedWithoutRequest(TestUsersSharedBase): +class TestUsersSharedWithoutRequest(UsersSharedTestBase): def test_slot_behaviour(self, users_shared): for attr in users_shared.__slots__: assert getattr(users_shared, attr, "err") != "err", f"got extra slot '{attr}'" @@ -47,19 +47,19 @@ def test_to_dict(self, users_shared): assert users_shared_dict["request_id"] == self.request_id assert users_shared_dict["users"] == [user.to_dict() for user in self.users] - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "request_id": self.request_id, "users": [user.to_dict() for user in self.users], "user_ids": self.user_ids, } - users_shared = UsersShared.de_json(json_dict, bot) + users_shared = UsersShared.de_json(json_dict, offline_bot) assert users_shared.api_kwargs == {"user_ids": self.user_ids} assert users_shared.request_id == self.request_id assert users_shared.users == self.users - assert UsersShared.de_json({}, bot) is None + assert UsersShared.de_json({}, offline_bot) is None def test_equality(self): a = UsersShared(self.request_id, users=self.users) @@ -85,17 +85,17 @@ def test_equality(self): @pytest.fixture(scope="class") def chat_shared(): return ChatShared( - TestChatSharedBase.request_id, - TestChatSharedBase.chat_id, + ChatSharedTestBase.request_id, + ChatSharedTestBase.chat_id, ) -class TestChatSharedBase: +class ChatSharedTestBase: request_id = 131415 chat_id = 161718 -class TestChatSharedWithoutRequest(TestChatSharedBase): +class TestChatSharedWithoutRequest(ChatSharedTestBase): def test_slot_behaviour(self, chat_shared): for attr in chat_shared.__slots__: assert getattr(chat_shared, attr, "err") != "err", f"got extra slot '{attr}'" @@ -108,12 +108,12 @@ def test_to_dict(self, chat_shared): assert chat_shared_dict["request_id"] == self.request_id assert chat_shared_dict["chat_id"] == self.chat_id - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "request_id": self.request_id, "chat_id": self.chat_id, } - chat_shared = ChatShared.de_json(json_dict, bot) + chat_shared = ChatShared.de_json(json_dict, offline_bot) assert chat_shared.api_kwargs == {} assert chat_shared.request_id == self.request_id @@ -143,15 +143,15 @@ def test_equality(self, users_shared): @pytest.fixture(scope="class") def shared_user(): return SharedUser( - TestSharedUserBase.user_id, - TestSharedUserBase.first_name, - last_name=TestSharedUserBase.last_name, - username=TestSharedUserBase.username, - photo=TestSharedUserBase.photo, + SharedUserTestBase.user_id, + SharedUserTestBase.first_name, + last_name=SharedUserTestBase.last_name, + username=SharedUserTestBase.username, + photo=SharedUserTestBase.photo, ) -class TestSharedUserBase: +class SharedUserTestBase: user_id = 101112 first_name = "first" last_name = "last" @@ -162,7 +162,7 @@ class TestSharedUserBase: ) -class TestSharedUserWithoutRequest(TestSharedUserBase): +class TestSharedUserWithoutRequest(SharedUserTestBase): def test_slot_behaviour(self, shared_user): for attr in shared_user.__slots__: assert getattr(shared_user, attr, "err") != "err", f"got extra slot '{attr}'" @@ -178,12 +178,12 @@ def test_to_dict(self, shared_user): assert shared_user_dict["username"] == self.username assert shared_user_dict["photo"] == [photo.to_dict() for photo in self.photo] - def test_de_json_required(self, bot): + def test_de_json_required(self, offline_bot): json_dict = { "user_id": self.user_id, "first_name": self.first_name, } - shared_user = SharedUser.de_json(json_dict, bot) + shared_user = SharedUser.de_json(json_dict, offline_bot) assert shared_user.api_kwargs == {} assert shared_user.user_id == self.user_id @@ -192,7 +192,7 @@ def test_de_json_required(self, bot): assert shared_user.username is None assert shared_user.photo == () - def test_de_json_all(self, bot): + def test_de_json_all(self, offline_bot): json_dict = { "user_id": self.user_id, "first_name": self.first_name, @@ -200,7 +200,7 @@ def test_de_json_all(self, bot): "username": self.username, "photo": [photo.to_dict() for photo in self.photo], } - shared_user = SharedUser.de_json(json_dict, bot) + shared_user = SharedUser.de_json(json_dict, offline_bot) assert shared_user.api_kwargs == {} assert shared_user.user_id == self.user_id @@ -209,7 +209,7 @@ def test_de_json_all(self, bot): assert shared_user.username == self.username assert shared_user.photo == self.photo - assert SharedUser.de_json({}, bot) is None + assert SharedUser.de_json({}, offline_bot) is None def test_equality(self, chat_shared): a = SharedUser( diff --git a/tests/test_stars.py b/tests/test_stars.py index fb1339a7217..4a02c52b94e 100644 --- a/tests/test_stars.py +++ b/tests/test_stars.py @@ -17,26 +17,35 @@ # 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 +import datetime as dtm +from collections.abc import Sequence from copy import deepcopy import pytest from telegram import ( + Chat, Dice, + Gift, + PaidMediaPhoto, + PhotoSize, RevenueWithdrawalState, RevenueWithdrawalStateFailed, RevenueWithdrawalStatePending, RevenueWithdrawalStateSucceeded, StarTransaction, StarTransactions, + Sticker, + TelegramObject, TransactionPartner, TransactionPartnerFragment, TransactionPartnerOther, TransactionPartnerTelegramAds, + TransactionPartnerTelegramApi, TransactionPartnerUser, User, ) +from telegram._payment.stars import AffiliateInfo, TransactionPartnerAffiliateProgram from telegram._utils.datetime import UTC, from_timestamp, to_timestamp from telegram.constants import RevenueWithdrawalStateType, TransactionPartnerType from tests.auxil.slots import mro_slots @@ -44,17 +53,17 @@ def withdrawal_state_succeeded(): return RevenueWithdrawalStateSucceeded( - date=datetime.datetime(2024, 1, 1, 0, 0, 0, 0, tzinfo=UTC), + date=dtm.datetime(2024, 1, 1, 0, 0, 0, 0, tzinfo=UTC), url="url", ) -@pytest.fixture() +@pytest.fixture def withdrawal_state_failed(): return RevenueWithdrawalStateFailed() -@pytest.fixture() +@pytest.fixture def withdrawal_state_pending(): return RevenueWithdrawalStatePending() @@ -62,12 +71,48 @@ def withdrawal_state_pending(): def transaction_partner_user(): return TransactionPartnerUser( user=User(id=1, is_bot=False, first_name="first_name", username="username"), + affiliate=AffiliateInfo( + affiliate_user=User(id=2, is_bot=True, first_name="first_name", username="username"), + affiliate_chat=Chat(id=3, type="private", title="title"), + commission_per_mille=1, + amount=2, + nanostar_amount=3, + ), + invoice_payload="payload", + paid_media=[ + PaidMediaPhoto( + photo=[ + PhotoSize( + file_id="file_id", width=1, height=1, file_unique_id="file_unique_id" + ) + ] + ) + ], + paid_media_payload="payload", + subscription_period=dtm.timedelta(days=1), + gift=Gift( + id="some_id", + sticker=Sticker( + file_id="file_id", + file_unique_id="file_unique_id", + width=512, + height=512, + is_animated=False, + is_video=False, + type="regular", + ), + star_count=5, + total_count=10, + remaining_count=5, + ), ) -@pytest.fixture() -def transaction_partner_other(): - return TransactionPartnerOther() +def transaction_partner_affiliate_program(): + return TransactionPartnerAffiliateProgram( + sponsor_user=User(id=1, is_bot=True, first_name="first_name", username="username"), + commission_per_mille=42, + ) def transaction_partner_fragment(): @@ -80,13 +125,14 @@ def star_transaction(): return StarTransaction( id="1", amount=1, - date=to_timestamp(datetime.datetime(2024, 1, 1, 0, 0, 0, 0, tzinfo=UTC)), + nanostar_amount=365, + date=to_timestamp(dtm.datetime(2024, 1, 1, 0, 0, 0, 0, tzinfo=UTC)), source=transaction_partner_user(), receiver=transaction_partner_fragment(), ) -@pytest.fixture() +@pytest.fixture def star_transactions(): return StarTransactions( transactions=[ @@ -99,10 +145,12 @@ def star_transactions(): @pytest.fixture( scope="module", params=[ + TransactionPartner.AFFILIATE_PROGRAM, TransactionPartner.FRAGMENT, TransactionPartner.OTHER, - TransactionPartner.USER, TransactionPartner.TELEGRAM_ADS, + TransactionPartner.TELEGRAM_API, + TransactionPartner.USER, ], ) def tp_scope_type(request): @@ -112,16 +160,20 @@ def tp_scope_type(request): @pytest.fixture( scope="module", params=[ + TransactionPartnerAffiliateProgram, TransactionPartnerFragment, TransactionPartnerOther, - TransactionPartnerUser, TransactionPartnerTelegramAds, + TransactionPartnerTelegramApi, + TransactionPartnerUser, ], ids=[ + TransactionPartner.AFFILIATE_PROGRAM, TransactionPartner.FRAGMENT, TransactionPartner.OTHER, - TransactionPartner.USER, TransactionPartner.TELEGRAM_ADS, + TransactionPartner.TELEGRAM_API, + TransactionPartner.USER, ], ) def tp_scope_class(request): @@ -131,16 +183,20 @@ def tp_scope_class(request): @pytest.fixture( scope="module", params=[ + (TransactionPartnerAffiliateProgram, TransactionPartner.AFFILIATE_PROGRAM), (TransactionPartnerFragment, TransactionPartner.FRAGMENT), (TransactionPartnerOther, TransactionPartner.OTHER), - (TransactionPartnerUser, TransactionPartner.USER), (TransactionPartnerTelegramAds, TransactionPartner.TELEGRAM_ADS), + (TransactionPartnerTelegramApi, TransactionPartner.TELEGRAM_API), + (TransactionPartnerUser, TransactionPartner.USER), ], ids=[ + TransactionPartner.AFFILIATE_PROGRAM, TransactionPartner.FRAGMENT, TransactionPartner.OTHER, - TransactionPartner.USER, TransactionPartner.TELEGRAM_ADS, + TransactionPartner.TELEGRAM_API, + TransactionPartner.USER, ], ) def tp_scope_class_and_type(request): @@ -153,9 +209,17 @@ def transaction_partner(tp_scope_class_and_type): return tp_scope_class_and_type[0].de_json( { "type": tp_scope_class_and_type[1], - "invoice_payload": TestTransactionPartnerBase.invoice_payload, - "withdrawal_state": TestTransactionPartnerBase.withdrawal_state.to_dict(), - "user": TestTransactionPartnerBase.user.to_dict(), + "invoice_payload": TransactionPartnerTestBase.invoice_payload, + "withdrawal_state": TransactionPartnerTestBase.withdrawal_state.to_dict(), + "user": TransactionPartnerTestBase.user.to_dict(), + "affiliate": TransactionPartnerTestBase.affiliate.to_dict(), + "request_count": TransactionPartnerTestBase.request_count, + "sponsor_user": TransactionPartnerTestBase.sponsor_user.to_dict(), + "commission_per_mille": TransactionPartnerTestBase.commission_per_mille, + "gift": TransactionPartnerTestBase.gift.to_dict(), + "paid_media": [m.to_dict() for m in TransactionPartnerTestBase.paid_media], + "paid_media_payload": TransactionPartnerTestBase.paid_media_payload, + "subscription_period": TransactionPartnerTestBase.subscription_period.total_seconds(), }, bot=None, ) @@ -213,17 +277,18 @@ def revenue_withdrawal_state(rws_scope_class_and_type): return rws_scope_class_and_type[0].de_json( { "type": rws_scope_class_and_type[1], - "date": to_timestamp(TestRevenueWithdrawalStateBase.date), - "url": TestRevenueWithdrawalStateBase.url, + "date": to_timestamp(RevenueWithdrawalStateTestBase.date), + "url": RevenueWithdrawalStateTestBase.url, }, bot=None, ) -class TestStarTransactionBase: +class StarTransactionTestBase: id = "2" amount = 2 - date = to_timestamp(datetime.datetime(2024, 1, 1, 0, 0, 0, 0, tzinfo=UTC)) + nanostar_amount = 365 + date = to_timestamp(dtm.datetime(2024, 1, 1, 0, 0, 0, 0, tzinfo=UTC)) source = TransactionPartnerUser( user=User( id=2, @@ -234,35 +299,37 @@ class TestStarTransactionBase: receiver = TransactionPartnerOther() -class TestStarTransactionWithoutRequest(TestStarTransactionBase): +class TestStarTransactionWithoutRequest(StarTransactionTestBase): def test_slot_behaviour(self): inst = star_transaction() for attr in inst.__slots__: assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "id": self.id, "amount": self.amount, + "nanostar_amount": self.nanostar_amount, "date": self.date, "source": self.source.to_dict(), "receiver": self.receiver.to_dict(), } - st = StarTransaction.de_json(json_dict, bot) - st_none = StarTransaction.de_json(None, bot) + st = StarTransaction.de_json(json_dict, offline_bot) + st_none = StarTransaction.de_json(None, offline_bot) assert st.api_kwargs == {} assert st.id == self.id assert st.amount == self.amount + assert st.nanostar_amount == self.nanostar_amount assert st.date == from_timestamp(self.date) assert st.source == self.source assert st.receiver == self.receiver assert st_none is None - def test_de_json_star_transaction_localization(self, tz_bot, bot, raw_bot): + def test_de_json_star_transaction_localization(self, tz_bot, offline_bot, raw_bot): json_dict = star_transaction().to_dict() st_raw = StarTransaction.de_json(json_dict, raw_bot) - st_bot = StarTransaction.de_json(json_dict, bot) + st_bot = StarTransaction.de_json(json_dict, offline_bot) st_tz = StarTransaction.de_json(json_dict, tz_bot) # comparing utcoffsets because comparing timezones is unpredicatable @@ -278,6 +345,7 @@ def test_to_dict(self): expected_dict = { "id": "1", "amount": 1, + "nanostar_amount": 365, "date": st.date, "source": st.source.to_dict(), "receiver": st.receiver.to_dict(), @@ -302,7 +370,7 @@ def test_equality(self): c = StarTransaction( id="3", amount=3, - date=to_timestamp(datetime.datetime.utcnow()), + date=to_timestamp(dtm.datetime.utcnow()), source=TransactionPartnerUser( user=User( id=3, @@ -320,23 +388,23 @@ def test_equality(self): assert hash(a) != hash(c) -class TestStarTransactionsBase: +class StarTransactionsTestBase: transactions = [star_transaction(), star_transaction()] -class TestStarTransactionsWithoutRequest(TestStarTransactionsBase): +class TestStarTransactionsWithoutRequest(StarTransactionsTestBase): def test_slot_behaviour(self, star_transactions): inst = star_transactions for attr in inst.__slots__: assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "transactions": [t.to_dict() for t in self.transactions], } - st = StarTransactions.de_json(json_dict, bot) - st_none = StarTransactions.de_json(None, bot) + st = StarTransactions.de_json(json_dict, offline_bot) + st_none = StarTransactions.de_json(None, offline_bot) assert st.api_kwargs == {} assert st.transactions == tuple(self.transactions) assert st_none is None @@ -365,20 +433,28 @@ def test_equality(self): assert hash(a) != hash(c) -class TestTransactionPartnerBase: +class TransactionPartnerTestBase: withdrawal_state = withdrawal_state_succeeded() user = transaction_partner_user().user + affiliate = transaction_partner_user().affiliate invoice_payload = "payload" + request_count = 42 + sponsor_user = transaction_partner_affiliate_program().sponsor_user + commission_per_mille = transaction_partner_affiliate_program().commission_per_mille + gift = transaction_partner_user().gift + paid_media = transaction_partner_user().paid_media + paid_media_payload = transaction_partner_user().paid_media_payload + subscription_period = transaction_partner_user().subscription_period -class TestTransactionPartnerWithoutRequest(TestTransactionPartnerBase): +class TestTransactionPartnerWithoutRequest(TransactionPartnerTestBase): def test_slot_behaviour(self, transaction_partner): inst = transaction_partner for attr in inst.__slots__: assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json(self, bot, tp_scope_class_and_type): + def test_de_json(self, offline_bot, tp_scope_class_and_type): cls = tp_scope_class_and_type[0] type_ = tp_scope_class_and_type[1] @@ -387,42 +463,58 @@ def test_de_json(self, bot, tp_scope_class_and_type): "invoice_payload": self.invoice_payload, "withdrawal_state": self.withdrawal_state.to_dict(), "user": self.user.to_dict(), + "affiliate": self.affiliate.to_dict(), + "request_count": self.request_count, + "sponsor_user": self.sponsor_user.to_dict(), + "commission_per_mille": self.commission_per_mille, } - tp = TransactionPartner.de_json(json_dict, bot) - assert set(tp.api_kwargs.keys()) == {"user", "withdrawal_state", "invoice_payload"} - set( - cls.__slots__ - ) + tp = TransactionPartner.de_json(json_dict, offline_bot) + assert set(tp.api_kwargs.keys()) == { + "user", + "affiliate", + "withdrawal_state", + "invoice_payload", + "request_count", + "sponsor_user", + "commission_per_mille", + } - set(cls.__slots__) assert isinstance(tp, TransactionPartner) assert type(tp) is cls assert tp.type == type_ - if "withdrawal_state" in cls.__slots__: - assert tp.withdrawal_state == self.withdrawal_state - if "user" in cls.__slots__: - assert tp.user == self.user - assert tp.invoice_payload == self.invoice_payload + for key in json_dict: + if key in cls.__slots__: + assert getattr(tp, key) == getattr(self, key) - assert cls.de_json(None, bot) is None - assert TransactionPartner.de_json({}, bot) is None + assert cls.de_json(None, offline_bot) is None + assert TransactionPartner.de_json({}, offline_bot) is None - def test_de_json_invalid_type(self, bot): + def test_de_json_invalid_type(self, offline_bot): json_dict = { "type": "invalid", "invoice_payload": self.invoice_payload, "withdrawal_state": self.withdrawal_state.to_dict(), "user": self.user.to_dict(), + "affiliate": self.affiliate.to_dict(), + "request_count": self.request_count, + "sponsor_user": self.sponsor_user.to_dict(), + "commission_per_mille": self.commission_per_mille, } - tp = TransactionPartner.de_json(json_dict, bot) + tp = TransactionPartner.de_json(json_dict, offline_bot) assert tp.api_kwargs == { "withdrawal_state": self.withdrawal_state.to_dict(), "user": self.user.to_dict(), + "affiliate": self.affiliate.to_dict(), "invoice_payload": self.invoice_payload, + "request_count": self.request_count, + "sponsor_user": self.sponsor_user.to_dict(), + "commission_per_mille": self.commission_per_mille, } assert type(tp) is TransactionPartner assert tp.type == "invalid" - def test_de_json_subclass(self, tp_scope_class, bot): + def test_de_json_subclass(self, tp_scope_class, offline_bot): """This makes sure that e.g. TransactionPartnerUser(data) never returns a TransactionPartnerFragment instance.""" json_dict = { @@ -430,25 +522,33 @@ def test_de_json_subclass(self, tp_scope_class, bot): "invoice_payload": self.invoice_payload, "withdrawal_state": self.withdrawal_state.to_dict(), "user": self.user.to_dict(), + "affiliate": self.affiliate.to_dict(), + "request_count": self.request_count, + "commission_per_mille": self.commission_per_mille, } - assert type(tp_scope_class.de_json(json_dict, bot)) is tp_scope_class + assert type(tp_scope_class.de_json(json_dict, offline_bot)) is tp_scope_class def test_to_dict(self, transaction_partner): tp_dict = transaction_partner.to_dict() assert isinstance(tp_dict, dict) assert tp_dict["type"] == transaction_partner.type - if hasattr(transaction_partner, "user"): - assert tp_dict["user"] == transaction_partner.user.to_dict() - assert tp_dict["invoice_payload"] == transaction_partner.invoice_payload - if hasattr(transaction_partner, "withdrawal_state"): - assert tp_dict["withdrawal_state"] == transaction_partner.withdrawal_state.to_dict() + for attr in transaction_partner.__slots__: + attribute = getattr(transaction_partner, attr) + if isinstance(attribute, TelegramObject): + assert tp_dict[attr] == attribute.to_dict() + elif not isinstance(attribute, str) and isinstance(attribute, Sequence): + assert tp_dict[attr] == [a.to_dict() for a in attribute] + elif isinstance(attribute, dtm.timedelta): + assert tp_dict[attr] == attribute.total_seconds() + else: + assert tp_dict[attr] == attribute def test_type_enum_conversion(self): assert type(TransactionPartner("other").type) is TransactionPartnerType assert TransactionPartner("unknown").type == "unknown" - def test_equality(self, transaction_partner, bot): + def test_equality(self, transaction_partner, offline_bot): a = TransactionPartner("base_type") b = TransactionPartner("base_type") c = transaction_partner @@ -476,25 +576,47 @@ def test_equality(self, transaction_partner, bot): if hasattr(c, "user"): json_dict = c.to_dict() json_dict["user"] = User(2, "something", True).to_dict() - f = c.__class__.de_json(json_dict, bot) + f = c.__class__.de_json(json_dict, offline_bot) + + assert c != f + assert hash(c) != hash(f) + + if hasattr(c, "request_count"): + json_dict = c.to_dict() + json_dict["request_count"] = 1 + f = c.__class__.de_json(json_dict, offline_bot) assert c != f assert hash(c) != hash(f) -class TestRevenueWithdrawalStateBase: - date = datetime.datetime(2024, 1, 1, 0, 0, 0, 0, tzinfo=UTC) +class TestTransactionPartnerUserWithoutRequest(TransactionPartnerTestBase): + def test_de_json_required(self, offline_bot): + json_dict = { + "user": transaction_partner_user().user.to_dict(), + } + tp = TransactionPartnerUser.de_json(json_dict, offline_bot) + assert tp.api_kwargs == {} + assert tp.user == transaction_partner_user().user + + # This test is here mainly to check that the below cases work + assert tp.subscription_period is None + assert tp.gift is None + + +class RevenueWithdrawalStateTestBase: + date = dtm.datetime(2024, 1, 1, 0, 0, 0, 0, tzinfo=UTC) url = "url" -class TestRevenueWithdrawalStateWithoutRequest(TestRevenueWithdrawalStateBase): +class TestRevenueWithdrawalStateWithoutRequest(RevenueWithdrawalStateTestBase): def test_slot_behaviour(self, revenue_withdrawal_state): inst = revenue_withdrawal_state for attr in inst.__slots__: assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json(self, bot, rws_scope_class_and_type): + def test_de_json(self, offline_bot, rws_scope_class_and_type): cls = rws_scope_class_and_type[0] type_ = rws_scope_class_and_type[1] @@ -503,7 +625,7 @@ def test_de_json(self, bot, rws_scope_class_and_type): "date": to_timestamp(self.date), "url": self.url, } - rws = RevenueWithdrawalState.de_json(json_dict, bot) + rws = RevenueWithdrawalState.de_json(json_dict, offline_bot) assert set(rws.api_kwargs.keys()) == {"date", "url"} - set(cls.__slots__) assert isinstance(rws, RevenueWithdrawalState) @@ -514,16 +636,16 @@ def test_de_json(self, bot, rws_scope_class_and_type): if "url" in cls.__slots__: assert rws.url == self.url - assert cls.de_json(None, bot) is None - assert RevenueWithdrawalState.de_json({}, bot) is None + assert cls.de_json(None, offline_bot) is None + assert RevenueWithdrawalState.de_json({}, offline_bot) is None - def test_de_json_invalid_type(self, bot): + def test_de_json_invalid_type(self, offline_bot): json_dict = { "type": "invalid", "date": to_timestamp(self.date), "url": self.url, } - rws = RevenueWithdrawalState.de_json(json_dict, bot) + rws = RevenueWithdrawalState.de_json(json_dict, offline_bot) assert rws.api_kwargs == { "date": to_timestamp(self.date), "url": self.url, @@ -532,7 +654,7 @@ def test_de_json_invalid_type(self, bot): assert type(rws) is RevenueWithdrawalState assert rws.type == "invalid" - def test_de_json_subclass(self, rws_scope_class, bot): + def test_de_json_subclass(self, rws_scope_class, offline_bot): """This makes sure that e.g. RevenueWithdrawalState(data) never returns a RevenueWithdrawalStateFailed instance.""" json_dict = { @@ -540,7 +662,7 @@ def test_de_json_subclass(self, rws_scope_class, bot): "date": to_timestamp(self.date), "url": self.url, } - assert type(rws_scope_class.de_json(json_dict, bot)) is rws_scope_class + assert type(rws_scope_class.de_json(json_dict, offline_bot)) is rws_scope_class def test_to_dict(self, revenue_withdrawal_state): rws_dict = revenue_withdrawal_state.to_dict() @@ -556,7 +678,7 @@ def test_type_enum_conversion(self): assert type(RevenueWithdrawalState("failed").type) is RevenueWithdrawalStateType assert RevenueWithdrawalState("unknown").type == "unknown" - def test_equality(self, revenue_withdrawal_state, bot): + def test_equality(self, revenue_withdrawal_state, offline_bot): a = RevenueWithdrawalState("base_type") b = RevenueWithdrawalState("base_type") c = revenue_withdrawal_state @@ -584,15 +706,144 @@ def test_equality(self, revenue_withdrawal_state, bot): if hasattr(c, "url"): json_dict = c.to_dict() json_dict["url"] = "something" - f = c.__class__.de_json(json_dict, bot) + f = c.__class__.de_json(json_dict, offline_bot) assert c == f assert hash(c) == hash(f) if hasattr(c, "date"): json_dict = c.to_dict() - json_dict["date"] = to_timestamp(datetime.datetime.utcnow()) - f = c.__class__.de_json(json_dict, bot) + json_dict["date"] = to_timestamp(dtm.datetime.utcnow()) + f = c.__class__.de_json(json_dict, offline_bot) assert c != f assert hash(c) != hash(f) + + +@pytest.fixture +def affiliate_info(): + return AffiliateInfo( + affiliate_user=AffiliateInfoTestBase.affiliate_user, + affiliate_chat=AffiliateInfoTestBase.affiliate_chat, + commission_per_mille=AffiliateInfoTestBase.commission_per_mille, + amount=AffiliateInfoTestBase.amount, + nanostar_amount=AffiliateInfoTestBase.nanostar_amount, + ) + + +class AffiliateInfoTestBase: + affiliate_user = User(id=1, is_bot=True, first_name="affiliate_user", username="username") + affiliate_chat = Chat(id=2, type="private", title="affiliate_chat") + commission_per_mille = 13 + amount = 14 + nanostar_amount = -42 + + +class TestAffiliateInfoWithoutRequest(AffiliateInfoTestBase): + def test_slot_behaviour(self, affiliate_info): + inst = affiliate_info + for attr in inst.__slots__: + assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" + assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" + + def test_de_json(self, offline_bot): + json_dict = { + "affiliate_user": self.affiliate_user.to_dict(), + "affiliate_chat": self.affiliate_chat.to_dict(), + "commission_per_mille": self.commission_per_mille, + "amount": self.amount, + "nanostar_amount": self.nanostar_amount, + } + ai = AffiliateInfo.de_json(json_dict, offline_bot) + assert ai.api_kwargs == {} + assert ai.affiliate_user == self.affiliate_user + assert ai.affiliate_chat == self.affiliate_chat + assert ai.commission_per_mille == self.commission_per_mille + assert ai.amount == self.amount + assert ai.nanostar_amount == self.nanostar_amount + + assert AffiliateInfo.de_json(None, offline_bot) is None + assert AffiliateInfo.de_json({}, offline_bot) is None + + def test_to_dict(self, affiliate_info): + ai_dict = affiliate_info.to_dict() + + assert isinstance(ai_dict, dict) + assert ai_dict["affiliate_user"] == affiliate_info.affiliate_user.to_dict() + assert ai_dict["affiliate_chat"] == affiliate_info.affiliate_chat.to_dict() + assert ai_dict["commission_per_mille"] == affiliate_info.commission_per_mille + assert ai_dict["amount"] == affiliate_info.amount + assert ai_dict["nanostar_amount"] == affiliate_info.nanostar_amount + + def test_equality(self, affiliate_info, offline_bot): + a = AffiliateInfo( + affiliate_user=self.affiliate_user, + affiliate_chat=self.affiliate_chat, + commission_per_mille=self.commission_per_mille, + amount=self.amount, + nanostar_amount=self.nanostar_amount, + ) + b = AffiliateInfo( + affiliate_user=self.affiliate_user, + affiliate_chat=self.affiliate_chat, + commission_per_mille=self.commission_per_mille, + amount=self.amount, + nanostar_amount=self.nanostar_amount, + ) + c = AffiliateInfo( + affiliate_user=User(id=3, is_bot=True, first_name="first_name", username="username"), + affiliate_chat=self.affiliate_chat, + commission_per_mille=self.commission_per_mille, + amount=self.amount, + nanostar_amount=self.nanostar_amount, + ) + d = AffiliateInfo( + affiliate_user=self.affiliate_user, + affiliate_chat=Chat(id=3, type="private", title="title"), + commission_per_mille=self.commission_per_mille, + amount=self.amount, + nanostar_amount=self.nanostar_amount, + ) + e = AffiliateInfo( + affiliate_user=self.affiliate_user, + affiliate_chat=self.affiliate_chat, + commission_per_mille=1, + amount=self.amount, + nanostar_amount=self.nanostar_amount, + ) + f = AffiliateInfo( + affiliate_user=self.affiliate_user, + affiliate_chat=self.affiliate_chat, + commission_per_mille=self.commission_per_mille, + amount=1, + nanostar_amount=self.nanostar_amount, + ) + g = AffiliateInfo( + affiliate_user=self.affiliate_user, + affiliate_chat=self.affiliate_chat, + commission_per_mille=self.commission_per_mille, + amount=self.amount, + nanostar_amount=1, + ) + h = Dice(4, "emoji") + + assert a == b + assert hash(a) == hash(b) + + assert a != c + assert hash(a) != hash(c) + + assert a != d + assert hash(a) != hash(d) + + assert a != e + assert hash(a) != hash(e) + + assert a != f + assert hash(a) != hash(f) + + assert a != g + assert hash(a) != hash(g) + + assert a != h + assert hash(a) != hash(h) diff --git a/tests/test_story.py b/tests/test_story.py index b521bebc5c5..190c4ec133c 100644 --- a/tests/test_story.py +++ b/tests/test_story.py @@ -24,28 +24,28 @@ @pytest.fixture(scope="module") def story(): - return Story(TestStoryBase.chat, TestStoryBase.id) + return Story(StoryTestBase.chat, StoryTestBase.id) -class TestStoryBase: +class StoryTestBase: chat = Chat(1, "") id = 0 -class TestStoryWithoutRequest(TestStoryBase): +class TestStoryWithoutRequest(StoryTestBase): def test_slot_behaviour(self, story): for attr in story.__slots__: assert getattr(story, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(story)) == len(set(mro_slots(story))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = {"chat": self.chat.to_dict(), "id": self.id} - story = Story.de_json(json_dict, bot) + story = Story.de_json(json_dict, offline_bot) assert story.api_kwargs == {} assert story.chat == self.chat assert story.id == self.id assert isinstance(story, Story) - assert Story.de_json(None, bot) is None + assert Story.de_json(None, offline_bot) is None def test_to_dict(self, story): story_dict = story.to_dict() diff --git a/tests/test_switchinlinequerychosenchat.py b/tests/test_switchinlinequerychosenchat.py index 8a55398606f..e522c164418 100644 --- a/tests/test_switchinlinequerychosenchat.py +++ b/tests/test_switchinlinequerychosenchat.py @@ -26,15 +26,15 @@ @pytest.fixture(scope="module") def switch_inline_query_chosen_chat(): return SwitchInlineQueryChosenChat( - query=TestSwitchInlineQueryChosenChatBase.query, - allow_user_chats=TestSwitchInlineQueryChosenChatBase.allow_user_chats, - allow_bot_chats=TestSwitchInlineQueryChosenChatBase.allow_bot_chats, - allow_channel_chats=TestSwitchInlineQueryChosenChatBase.allow_channel_chats, - allow_group_chats=TestSwitchInlineQueryChosenChatBase.allow_group_chats, + query=SwitchInlineQueryChosenChatTestBase.query, + allow_user_chats=SwitchInlineQueryChosenChatTestBase.allow_user_chats, + allow_bot_chats=SwitchInlineQueryChosenChatTestBase.allow_bot_chats, + allow_channel_chats=SwitchInlineQueryChosenChatTestBase.allow_channel_chats, + allow_group_chats=SwitchInlineQueryChosenChatTestBase.allow_group_chats, ) -class TestSwitchInlineQueryChosenChatBase: +class SwitchInlineQueryChosenChatTestBase: query = "query" allow_user_chats = True allow_bot_chats = True @@ -42,7 +42,7 @@ class TestSwitchInlineQueryChosenChatBase: allow_group_chats = True -class TestSwitchInlineQueryChosenChat(TestSwitchInlineQueryChosenChatBase): +class TestSwitchInlineQueryChosenChat(SwitchInlineQueryChosenChatTestBase): def test_slot_behaviour(self, switch_inline_query_chosen_chat): inst = switch_inline_query_chosen_chat for attr in inst.__slots__: diff --git a/tests/test_telegramobject.py b/tests/test_telegramobject.py index ca893dec4d8..73d1e62e52c 100644 --- a/tests/test_telegramobject.py +++ b/tests/test_telegramobject.py @@ -16,7 +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 +import datetime as dtm import inspect import pickle import re @@ -176,9 +176,7 @@ def test_to_dict_api_kwargs(self): assert to.to_dict() == {"foo": "bar"} def test_to_dict_missing_attribute(self): - message = Message( - 1, datetime.datetime.now(), Chat(1, "private"), from_user=User(1, "", False) - ) + message = Message(1, dtm.datetime.now(), Chat(1, "private"), from_user=User(1, "", False)) message._unfreeze() del message.chat @@ -288,7 +286,7 @@ def test_subscription(self): def test_pickle(self, bot): chat = Chat(2, Chat.PRIVATE) user = User(3, "first_name", False) - date = datetime.datetime.now() + date = dtm.datetime.now() photo = PhotoSize("file_id", "unique", 21, 21) photo.set_bot(bot) msg = Message( @@ -432,7 +430,7 @@ def __init__(self, api_kwargs=None): def test_deepcopy_telegram_obj(self, bot): chat = Chat(2, Chat.PRIVATE) user = User(3, "first_name", False) - date = datetime.datetime.now() + date = dtm.datetime.now() photo = PhotoSize("file_id", "unique", 21, 21) photo.set_bot(bot) msg = Message( diff --git a/tests/test_update.py b/tests/test_update.py index b314c98e819..0e91efcc998 100644 --- a/tests/test_update.py +++ b/tests/test_update.py @@ -16,9 +16,9 @@ # # 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 time from copy import deepcopy -from datetime import datetime import pytest @@ -40,6 +40,7 @@ Message, MessageReactionCountUpdated, MessageReactionUpdated, + PaidMediaPurchased, Poll, PollAnswer, PollOption, @@ -56,7 +57,7 @@ message = Message( 1, - datetime.utcnow(), + dtm.datetime.utcnow(), Chat(1, ""), from_user=User(1, "", False), text="Text", @@ -64,7 +65,7 @@ ) channel_post = Message( 1, - datetime.utcnow(), + dtm.datetime.utcnow(), Chat(1, ""), text="Text", sender_chat=Chat(1, ""), @@ -138,11 +139,16 @@ business_message = Message( 1, - datetime.utcnow(), + dtm.datetime.utcnow(), Chat(1, ""), User(1, "", False), ) +purchased_paid_media = PaidMediaPurchased( + from_user=User(1, "", False), + paid_media_payload="payload", +) + params = [ {"message": message}, @@ -178,6 +184,7 @@ {"deleted_business_messages": deleted_business_messages}, {"business_message": business_message}, {"edited_business_message": business_message}, + {"purchased_paid_media": purchased_paid_media}, # Must be last to conform with `ids` below! {"callback_query": CallbackQuery(1, User(1, "", False), "chat")}, ] @@ -205,6 +212,7 @@ "deleted_business_messages", "business_message", "edited_business_message", + "purchased_paid_media", ) ids = (*all_types, "callback_query_without_message") @@ -212,14 +220,14 @@ @pytest.fixture(scope="module", params=params, ids=ids) def update(request): - return Update(update_id=TestUpdateBase.update_id, **request.param) + return Update(update_id=UpdateTestBase.update_id, **request.param) -class TestUpdateBase: +class UpdateTestBase: update_id = 868573637 -class TestUpdateWithoutRequest(TestUpdateBase): +class TestUpdateWithoutRequest(UpdateTestBase): def test_slot_behaviour(self): update = Update(self.update_id) for attr in update.__slots__: @@ -227,11 +235,11 @@ def test_slot_behaviour(self): assert len(mro_slots(update)) == len(set(mro_slots(update))), "duplicate slot" @pytest.mark.parametrize("paramdict", argvalues=params, ids=ids) - def test_de_json(self, bot, paramdict): + def test_de_json(self, offline_bot, paramdict): json_dict = {"update_id": self.update_id} # Convert the single update 'item' to a dict of that item and apply it to the json_dict json_dict.update({k: v.to_dict() for k, v in paramdict.items()}) - update = Update.de_json(json_dict, bot) + update = Update.de_json(json_dict, offline_bot) assert update.api_kwargs == {} assert update.update_id == self.update_id @@ -244,8 +252,8 @@ def test_de_json(self, bot, paramdict): assert getattr(update, _type) == paramdict[_type] assert i == 1 - def test_update_de_json_empty(self, bot): - update = Update.de_json(None, bot) + def test_update_de_json_empty(self, offline_bot): + update = Update.de_json(None, offline_bot) assert update is None @@ -290,6 +298,7 @@ def test_effective_chat(self, update): or update.poll is not None or update.poll_answer is not None or update.business_connection is not None + or update.purchased_paid_media is not None ): assert chat.id == 1 else: @@ -403,6 +412,7 @@ def test_effective_message(self, update): or update.message_reaction_count is not None or update.deleted_business_messages is not None or update.business_connection is not None + or update.purchased_paid_media is not None ): assert eff_message.message_id == message.message_id else: diff --git a/tests/test_user.py b/tests/test_user.py index 06936532860..ede518f6f8f 100644 --- a/tests/test_user.py +++ b/tests/test_user.py @@ -31,43 +31,45 @@ @pytest.fixture(scope="module") def json_dict(): return { - "id": TestUserBase.id_, - "is_bot": TestUserBase.is_bot, - "first_name": TestUserBase.first_name, - "last_name": TestUserBase.last_name, - "username": TestUserBase.username, - "language_code": TestUserBase.language_code, - "can_join_groups": TestUserBase.can_join_groups, - "can_read_all_group_messages": TestUserBase.can_read_all_group_messages, - "supports_inline_queries": TestUserBase.supports_inline_queries, - "is_premium": TestUserBase.is_premium, - "added_to_attachment_menu": TestUserBase.added_to_attachment_menu, - "can_connect_to_business": TestUserBase.can_connect_to_business, + "id": UserTestBase.id_, + "is_bot": UserTestBase.is_bot, + "first_name": UserTestBase.first_name, + "last_name": UserTestBase.last_name, + "username": UserTestBase.username, + "language_code": UserTestBase.language_code, + "can_join_groups": UserTestBase.can_join_groups, + "can_read_all_group_messages": UserTestBase.can_read_all_group_messages, + "supports_inline_queries": UserTestBase.supports_inline_queries, + "is_premium": UserTestBase.is_premium, + "added_to_attachment_menu": UserTestBase.added_to_attachment_menu, + "can_connect_to_business": UserTestBase.can_connect_to_business, + "has_main_web_app": UserTestBase.has_main_web_app, } -@pytest.fixture() +@pytest.fixture def user(bot): user = User( - id=TestUserBase.id_, - first_name=TestUserBase.first_name, - is_bot=TestUserBase.is_bot, - last_name=TestUserBase.last_name, - username=TestUserBase.username, - language_code=TestUserBase.language_code, - can_join_groups=TestUserBase.can_join_groups, - can_read_all_group_messages=TestUserBase.can_read_all_group_messages, - supports_inline_queries=TestUserBase.supports_inline_queries, - is_premium=TestUserBase.is_premium, - added_to_attachment_menu=TestUserBase.added_to_attachment_menu, - can_connect_to_business=TestUserBase.can_connect_to_business, + id=UserTestBase.id_, + first_name=UserTestBase.first_name, + is_bot=UserTestBase.is_bot, + last_name=UserTestBase.last_name, + username=UserTestBase.username, + language_code=UserTestBase.language_code, + can_join_groups=UserTestBase.can_join_groups, + can_read_all_group_messages=UserTestBase.can_read_all_group_messages, + supports_inline_queries=UserTestBase.supports_inline_queries, + is_premium=UserTestBase.is_premium, + added_to_attachment_menu=UserTestBase.added_to_attachment_menu, + can_connect_to_business=UserTestBase.can_connect_to_business, + has_main_web_app=UserTestBase.has_main_web_app, ) user.set_bot(bot) user._unfreeze() return user -class TestUserBase: +class UserTestBase: id_ = 1 is_bot = True first_name = "first\u2022name" @@ -80,16 +82,17 @@ class TestUserBase: is_premium = True added_to_attachment_menu = False can_connect_to_business = True + has_main_web_app = False -class TestUserWithoutRequest(TestUserBase): +class TestUserWithoutRequest(UserTestBase): def test_slot_behaviour(self, user): for attr in user.__slots__: assert getattr(user, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(user)) == len(set(mro_slots(user))), "duplicate slot" - def test_de_json(self, json_dict, bot): - user = User.de_json(json_dict, bot) + def test_de_json(self, json_dict, offline_bot): + user = User.de_json(json_dict, offline_bot) assert user.api_kwargs == {} assert user.id == self.id_ @@ -104,6 +107,7 @@ def test_de_json(self, json_dict, bot): assert user.is_premium == self.is_premium assert user.added_to_attachment_menu == self.added_to_attachment_menu assert user.can_connect_to_business == self.can_connect_to_business + assert user.has_main_web_app == self.has_main_web_app def test_to_dict(self, user): user_dict = user.to_dict() @@ -121,6 +125,7 @@ def test_to_dict(self, user): assert user_dict["is_premium"] == user.is_premium assert user_dict["added_to_attachment_menu"] == user.added_to_attachment_menu assert user_dict["can_connect_to_business"] == user.can_connect_to_business + assert user_dict["has_main_web_app"] == user.has_main_web_app def test_equality(self): a = User(self.id_, self.first_name, self.is_bot, self.last_name) @@ -715,3 +720,25 @@ async def make_assertion(*_, **kwargs): monkeypatch.setattr(user.get_bot(), "refund_star_payment", make_assertion) assert await user.refund_star_payment(telegram_payment_charge_id=42) + + async def test_instance_method_send_gift(self, monkeypatch, user): + async def make_assertion(*_, **kwargs): + return ( + kwargs["user_id"] == user.id + and kwargs["gift_id"] == "gift_id" + and kwargs["text"] == "text" + and kwargs["text_parse_mode"] == "text_parse_mode" + and kwargs["text_entities"] == "text_entities" + ) + + assert check_shortcut_signature(user.send_gift, Bot.send_gift, ["user_id"], []) + assert await check_shortcut_call(user.send_gift, user.get_bot(), "send_gift") + assert await check_defaults_handling(user.send_gift, user.get_bot()) + + monkeypatch.setattr(user.get_bot(), "send_gift", make_assertion) + assert await user.send_gift( + gift_id="gift_id", + text="text", + text_parse_mode="text_parse_mode", + text_entities="text_entities", + ) diff --git a/tests/test_userprofilephotos.py b/tests/test_userprofilephotos.py index caff6a2a5a8..5ae686fad01 100644 --- a/tests/test_userprofilephotos.py +++ b/tests/test_userprofilephotos.py @@ -20,7 +20,7 @@ from tests.auxil.slots import mro_slots -class TestUserProfilePhotosBase: +class UserProfilePhotosTestBase: total_count = 2 photos = [ [ @@ -34,16 +34,16 @@ class TestUserProfilePhotosBase: ] -class TestUserProfilePhotosWithoutRequest(TestUserProfilePhotosBase): +class TestUserProfilePhotosWithoutRequest(UserProfilePhotosTestBase): def test_slot_behaviour(self): inst = UserProfilePhotos(self.total_count, self.photos) for attr in inst.__slots__: assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot" - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = {"total_count": 2, "photos": [[y.to_dict() for y in x] for x in self.photos]} - user_profile_photos = UserProfilePhotos.de_json(json_dict, bot) + user_profile_photos = UserProfilePhotos.de_json(json_dict, offline_bot) assert user_profile_photos.api_kwargs == {} assert user_profile_photos.total_count == self.total_count assert user_profile_photos.photos == tuple(tuple(p) for p in self.photos) diff --git a/tests/test_videochat.py b/tests/test_videochat.py index 5fbdf8ba8eb..e5de669c672 100644 --- a/tests/test_videochat.py +++ b/tests/test_videochat.py @@ -105,9 +105,9 @@ def test_slot_behaviour(self, user1): assert getattr(action, attr, "err") != "err", f"got extra slot '{attr}'" assert len(mro_slots(action)) == len(set(mro_slots(action))), "duplicate slot" - def test_de_json(self, user1, user2, bot): + def test_de_json(self, user1, user2, offline_bot): json_data = {"users": [user1.to_dict(), user2.to_dict()]} - video_chat_participants = VideoChatParticipantsInvited.de_json(json_data, bot) + video_chat_participants = VideoChatParticipantsInvited.de_json(json_data, offline_bot) assert video_chat_participants.api_kwargs == {} assert isinstance(video_chat_participants.users, tuple) @@ -161,20 +161,20 @@ def test_slot_behaviour(self): def test_expected_values(self): assert VideoChatScheduled(self.start_date).start_date == self.start_date - def test_de_json(self, bot): - assert VideoChatScheduled.de_json({}, bot=bot) is None + def test_de_json(self, offline_bot): + assert VideoChatScheduled.de_json({}, bot=offline_bot) is None json_dict = {"start_date": to_timestamp(self.start_date)} - video_chat_scheduled = VideoChatScheduled.de_json(json_dict, bot) + video_chat_scheduled = VideoChatScheduled.de_json(json_dict, offline_bot) assert video_chat_scheduled.api_kwargs == {} assert abs(video_chat_scheduled.start_date - self.start_date) < dtm.timedelta(seconds=1) - def test_de_json_localization(self, tz_bot, bot, raw_bot): + def test_de_json_localization(self, tz_bot, offline_bot, raw_bot): json_dict = {"start_date": to_timestamp(self.start_date)} videochat_raw = VideoChatScheduled.de_json(json_dict, raw_bot) - videochat_bot = VideoChatScheduled.de_json(json_dict, bot) + videochat_bot = VideoChatScheduled.de_json(json_dict, offline_bot) videochat_tz = VideoChatScheduled.de_json(json_dict, tz_bot) # comparing utcoffsets because comparing timezones is unpredicatable diff --git a/tests/test_webappdata.py b/tests/test_webappdata.py index 5a1a5c3fc02..ba8d4360831 100644 --- a/tests/test_webappdata.py +++ b/tests/test_webappdata.py @@ -25,15 +25,15 @@ @pytest.fixture(scope="module") def web_app_data(): - return WebAppData(data=TestWebAppDataBase.data, button_text=TestWebAppDataBase.button_text) + return WebAppData(data=WebAppDataTestBase.data, button_text=WebAppDataTestBase.button_text) -class TestWebAppDataBase: +class WebAppDataTestBase: data = "data" button_text = "button_text" -class TestWebAppDataWithoutRequest(TestWebAppDataBase): +class TestWebAppDataWithoutRequest(WebAppDataTestBase): def test_slot_behaviour(self, web_app_data): for attr in web_app_data.__slots__: assert getattr(web_app_data, attr, "err") != "err", f"got extra slot '{attr}'" @@ -46,9 +46,9 @@ def test_to_dict(self, web_app_data): assert web_app_data_dict["data"] == self.data assert web_app_data_dict["button_text"] == self.button_text - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = {"data": self.data, "button_text": self.button_text} - web_app_data = WebAppData.de_json(json_dict, bot) + web_app_data = WebAppData.de_json(json_dict, offline_bot) assert web_app_data.api_kwargs == {} assert web_app_data.data == self.data diff --git a/tests/test_webappinfo.py b/tests/test_webappinfo.py index b0c8db81704..76dd018d59f 100644 --- a/tests/test_webappinfo.py +++ b/tests/test_webappinfo.py @@ -25,14 +25,14 @@ @pytest.fixture(scope="module") def web_app_info(): - return WebAppInfo(url=TestWebAppInfoBase.url) + return WebAppInfo(url=WebAppInfoTestBase.url) -class TestWebAppInfoBase: +class WebAppInfoTestBase: url = "https://www.example.com" -class TestWebAppInfoWithoutRequest(TestWebAppInfoBase): +class TestWebAppInfoWithoutRequest(WebAppInfoTestBase): def test_slot_behaviour(self, web_app_info): for attr in web_app_info.__slots__: assert getattr(web_app_info, attr, "err") != "err", f"got extra slot '{attr}'" @@ -44,9 +44,9 @@ def test_to_dict(self, web_app_info): assert isinstance(web_app_info_dict, dict) assert web_app_info_dict["url"] == self.url - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = {"url": self.url} - web_app_info = WebAppInfo.de_json(json_dict, bot) + web_app_info = WebAppInfo.de_json(json_dict, offline_bot) assert web_app_info.api_kwargs == {} assert web_app_info.url == self.url diff --git a/tests/test_webhookinfo.py b/tests/test_webhookinfo.py index 8075095342a..4b6ab2ebb6c 100644 --- a/tests/test_webhookinfo.py +++ b/tests/test_webhookinfo.py @@ -16,8 +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 time -from datetime import datetime import pytest @@ -29,18 +29,18 @@ @pytest.fixture(scope="module") def webhook_info(): return WebhookInfo( - url=TestWebhookInfoBase.url, - has_custom_certificate=TestWebhookInfoBase.has_custom_certificate, - pending_update_count=TestWebhookInfoBase.pending_update_count, - ip_address=TestWebhookInfoBase.ip_address, - last_error_date=TestWebhookInfoBase.last_error_date, - max_connections=TestWebhookInfoBase.max_connections, - allowed_updates=TestWebhookInfoBase.allowed_updates, - last_synchronization_error_date=TestWebhookInfoBase.last_synchronization_error_date, + url=WebhookInfoTestBase.url, + has_custom_certificate=WebhookInfoTestBase.has_custom_certificate, + pending_update_count=WebhookInfoTestBase.pending_update_count, + ip_address=WebhookInfoTestBase.ip_address, + last_error_date=WebhookInfoTestBase.last_error_date, + max_connections=WebhookInfoTestBase.max_connections, + allowed_updates=WebhookInfoTestBase.allowed_updates, + last_synchronization_error_date=WebhookInfoTestBase.last_synchronization_error_date, ) -class TestWebhookInfoBase: +class WebhookInfoTestBase: url = "http://www.google.com" has_custom_certificate = False pending_update_count = 5 @@ -51,7 +51,7 @@ class TestWebhookInfoBase: last_synchronization_error_date = time.time() -class TestWebhookInfoWithoutRequest(TestWebhookInfoBase): +class TestWebhookInfoWithoutRequest(WebhookInfoTestBase): def test_slot_behaviour(self, webhook_info): for attr in webhook_info.__slots__: assert getattr(webhook_info, attr, "err") != "err", f"got extra slot '{attr}'" @@ -72,7 +72,7 @@ def test_to_dict(self, webhook_info): == self.last_synchronization_error_date ) - def test_de_json(self, bot): + def test_de_json(self, offline_bot): json_dict = { "url": self.url, "has_custom_certificate": self.has_custom_certificate, @@ -83,26 +83,26 @@ def test_de_json(self, bot): "ip_address": self.ip_address, "last_synchronization_error_date": self.last_synchronization_error_date, } - webhook_info = WebhookInfo.de_json(json_dict, bot) + webhook_info = WebhookInfo.de_json(json_dict, offline_bot) assert webhook_info.api_kwargs == {} assert webhook_info.url == self.url assert webhook_info.has_custom_certificate == self.has_custom_certificate assert webhook_info.pending_update_count == self.pending_update_count - assert isinstance(webhook_info.last_error_date, datetime) + assert isinstance(webhook_info.last_error_date, dtm.datetime) assert webhook_info.last_error_date == from_timestamp(self.last_error_date) assert webhook_info.max_connections == self.max_connections assert webhook_info.allowed_updates == tuple(self.allowed_updates) assert webhook_info.ip_address == self.ip_address - assert isinstance(webhook_info.last_synchronization_error_date, datetime) + assert isinstance(webhook_info.last_synchronization_error_date, dtm.datetime) assert webhook_info.last_synchronization_error_date == from_timestamp( self.last_synchronization_error_date ) - none = WebhookInfo.de_json(None, bot) + none = WebhookInfo.de_json(None, offline_bot) assert none is None - def test_de_json_localization(self, bot, raw_bot, tz_bot): + def test_de_json_localization(self, offline_bot, raw_bot, tz_bot): json_dict = { "url": self.url, "has_custom_certificate": self.has_custom_certificate, @@ -113,7 +113,7 @@ def test_de_json_localization(self, bot, raw_bot, tz_bot): "ip_address": self.ip_address, "last_synchronization_error_date": self.last_synchronization_error_date, } - webhook_info_bot = WebhookInfo.de_json(json_dict, bot) + webhook_info_bot = WebhookInfo.de_json(json_dict, offline_bot) webhook_info_raw = WebhookInfo.de_json(json_dict, raw_bot) webhook_info_tz = WebhookInfo.de_json(json_dict, tz_bot)