PyGithub 2.7.0__tar.gz → 2.8.1__tar.gz

pygithub-2.8.1/.github/actions/mypy/action.yml

@@ -0,0 +1,22 @@
+name: 'MyPy'
+author: 'EnricoMi'
+description: 'A GitHub Action that runs mypy'
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.x"
+    - run: |
+        python -m pip install --upgrade pip
+        pip install -e .
+        pip install -r requirements/types.txt
+      shell: bash
+    - uses: liskin/gh-problem-matcher-wrap@v2
+      with:
+        action: add
+        linters: mypy
+    - run: mypy --show-column-numbers github tests
+      shell: bash

pygithub-2.8.1/.github/actions/pre-commit/action.yml

@@ -0,0 +1,24 @@
+name: 'Pre-commit'
+author: 'EnricoMi'
+description: 'A GitHub Action that runs pre-commit'
+
+runs:
+  using: 'composite'
+  steps:
+    - uses: actions/setup-python@v4
+      with:
+        python-version: "3.x"
+    # FIXME: pin pre-commit<4 pending PyCQA/docformatter#287
+    - name: install pre-commit
+      run: python -m pip install 'pre-commit<4'
+      shell: bash
+    - name: show environment
+      run: python -m pip freeze --local
+      shell: bash
+    - uses: actions/cache@v4
+      with:
+        path: ~/.cache/pre-commit
+        key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
+    - name: run pre-commit
+      run: pre-commit run --show-diff-on-failure --color=always --all-files
+      shell: bash

pygithub-2.8.1/.github/actions/sort-classes/action.yml

@@ -0,0 +1,25 @@
+name: 'Sort classes'
+author: 'EnricoMi'
+description: 'A GitHub Action that sorts classes'
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.12"
+    - name: Set up dependencies
+      run: |
+        pip install -r requirements/scripts.txt
+      shell: bash
+    - name: Sort classes
+      shell: bash
+      run: |
+        # Sort classes
+        set -euo pipefail
+
+        echo "::group::Sort classes"
+        python scripts/openapi.py index github openapi.index
+        python scripts/sort_class.py openapi.index $(jq -r ".indices.class_to_descendants.GithubObject | @tsv" < openapi.index)
+        echo "::endgroup::"

pygithub-2.8.1/.github/release.yml

@@ -0,0 +1,19 @@
+changelog:
+  exclude:
+    labels: []
+    authors: []
+  categories:
+    - title: Breaking Changes
+      labels: ['breaking']
+    - title: New Features
+      labels: ['feature']
+    - title: Improvements
+      labels: ['improvement']
+    - title: Bug Fixes
+      labels: ['bugfix']
+    - title: Dependencies
+      labels: ['dependencies']
+    - title: Maintenance
+      labels: ['ci', 'documentation', 'maintenance', 'OpenAPI', 'github_actions']
+    - title: Others
+      labels: ['*']

pygithub-2.8.1/.github/workflows/_build-pkg.yml

@@ -0,0 +1,32 @@
+name: Build package
+
+on:
+  workflow_call:
+    inputs:
+      artifact-name:
+        description: "Name of an artifact"
+        type: "string"
+        required: false
+        default: "package"
+
+jobs:
+  build-pkg:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies
+        run: pip install -U build twine
+      - name: Build 📦 package
+        run: python -m build
+      - name: Check 📦 package
+        run: twine check dist/*
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: ${{ inputs.artifact-name }}
+          path: dist

pygithub-2.8.1/.github/workflows/auto-fix.yml

@@ -0,0 +1,60 @@
+name: Auto Fix
+on:
+  workflow_dispatch:
+permissions: {}
+
+jobs:
+  sort:
+    name: "sort classes"
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v5
+      - uses: ./.github/actions/sort-classes
+        continue-on-error: true
+      - name: Commit and push changes
+        run: |
+          # Commit and push changes
+          git config --local user.name "${{ github.actor }}"
+          git config --local user.email "github-action-${{ github.actor }}@users.noreply.github.com"
+          git commit -a -m "Sorting classes" || true
+          git fetch origin $GITHUB_REF_NAME
+          git rebase origin/$GITHUB_REF_NAME
+          git push origin HEAD:$GITHUB_REF_NAME
+
+  mypy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v5
+      - uses: ./.github/actions/mypy
+        continue-on-error: true
+      - name: Commit and push changes
+        run: |
+          # Commit and push changes
+          git config --local user.name "${{ github.actor }}"
+          git config --local user.email "github-action-${{ github.actor }}@users.noreply.github.com"
+          git commit -a -m "Fixing MyPy" || true
+          git fetch origin $GITHUB_REF_NAME
+          git rebase origin/$GITHUB_REF_NAME
+          git push origin HEAD:$GITHUB_REF_NAME
+
+  pre-commit-fix:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v5
+      - uses: ./.github/actions/pre-commit
+        continue-on-error: true
+      - name: Commit and push changes
+        run: |
+          # Commit and push changes
+          git config --local user.name "${{ github.actor }}"
+          git config --local user.email "github-action-${{ github.actor }}@users.noreply.github.com"
+          git commit -a -m "Fixing pre-compile" || true
+          git fetch origin $GITHUB_REF_NAME
+          git rebase origin/$GITHUB_REF_NAME
+          git push origin HEAD:$GITHUB_REF_NAME

pygithub-2.8.1/.github/workflows/ci.yml

@@ -0,0 +1,297 @@
+name: CI
+on:
+  push:
+    branches:
+      - main
+      - release-v*
+  pull_request:
+  merge_group:
+env:
+  openapi_api: api.github.com
+  openapi_version: 2022-11-28
+permissions: {}
+
+jobs:
+  build:
+    uses: "./.github/workflows/_build-pkg.yml"
+    with:
+      artifact-name: package
+
+  test:
+    runs-on: ${{ matrix.os }}
+    name: test (Python ${{ matrix.python-version }} on ${{ matrix.os-label }})
+    strategy:
+      fail-fast: false
+      matrix:
+        # keep in sync with tox.ini [gh-actions] section
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+        os: ["ubuntu-latest"]
+        os-label: ["Ubuntu"]
+        include:
+          - {python-version: "3.8", os: "windows-latest", os-label: "Windows"}
+          - {python-version: "3.8", os: "macos-latest", os-label: "macOS"}
+    steps:
+      - uses: actions/checkout@v5
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "${{ matrix.python-version }}"
+      - name: Install tox
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox tox-gh-actions
+      - name: Run tests
+        run: tox
+      - name: Upload Test Results
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: Test Results (Python ${{ matrix.python-version }} on ${{ matrix.os-label }})
+          path: pytest.xml
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+
+  test_success:
+    # this aggregates success state of all jobs listed in `needs`
+    # this is the only required check to pass CI
+    name: "Test success"
+    if: always()
+    runs-on: ubuntu-latest
+    needs: [test]
+    steps:
+      - name: "Success"
+        if: needs.test.result == 'success'
+        run: true
+        shell: bash
+      - name: "Failure"
+        if: needs.test.result != 'success'
+        run: false
+        shell: bash
+
+  index:
+    name: "Check verbs"
+    needs: "test_success"
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          path: head
+      - uses: actions/checkout@v5
+        with:
+          ref: ${{ github.event.pull_request.base.sha }}
+          path: base
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Set up dependencies
+        run: |
+          pip install -r head/requirements/scripts.txt
+      - name: Check verbs
+        shell: bash
+        run: |
+          # Check verbs
+          set -euo pipefail
+
+          echo "::group::Head verb checking:"
+          python head/scripts/openapi.py --verbose index --check-verbs head/github openapi.head.index | tee verbs.head.txt
+          echo "::endgroup::"
+
+          echo "::group::Base verb checking:"
+          python head/scripts/openapi.py --verbose index --check-verbs base/github openapi.base.index | tee verbs.base.txt
+          echo "::endgroup::"
+
+          if ! (diff <(grep -v -E -e "^Index(ing|ed) " verbs.base.txt) <(grep -v -E -e "^Index(ing|ed) " verbs.head.txt) > diff.txt)
+          then
+            echo ""
+            echo "Difference:"
+            cat diff.txt
+            echo ""
+            echo "To fix this revisit the verbs in :calls: doc-string line of the respective method."
+            echo ""
+            echo "Fix warnings like 'Not found any … call in …' by adding the method name "
+            echo "and verb to the 'known method verbs' section in github/openapi.index.json."
+            echo ""
+            echo "Fix warnings like 'Method … is known to call …' by fixing "
+            echo "the doc-string or github/openapi.index.json."
+            false
+          fi
+
+  schemas:
+    name: "Add schemas"
+    needs: "test_success"
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          path: head
+      - uses: actions/checkout@v5
+        with:
+          ref: ${{ github.event.pull_request.base.sha }}
+          path: base
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Set up dependencies
+        run: |
+          pip install -r head/requirements/scripts.txt
+      - name: Add schemas
+        shell: bash
+        run: |
+          # Add schemas
+          set -euo pipefail
+
+          python head/scripts/openapi.py --verbose fetch ${{ env.openapi_api }} ${{ env.openapi_version }} openapi.json
+
+          echo "::group::Head schema suggestions:"
+          python head/scripts/openapi.py --verbose index head/github openapi.json openapi.head.index
+          python head/scripts/openapi.py --verbose suggest schemas openapi.json openapi.head.index | tee schemas.head.txt
+          echo "::endgroup::"
+
+          echo "::group::Base schema suggestions:"
+          python head/scripts/openapi.py --verbose index base/github openapi.json openapi.base.index
+          python head/scripts/openapi.py --verbose suggest schemas openapi.json openapi.base.index | tee schemas.base.txt
+          echo "::endgroup::"
+
+          if ! (diff <(grep -v -E -e "^Index(ing|ed) " schemas.base.txt) <(grep -v -E -e "^Index(ing|ed) " schemas.head.txt) > diff.txt)
+          then
+            echo ""
+            echo "Difference:"
+            cat diff.txt
+            echo ""
+            (grep -E -e "^> Class \w+:$" diff.txt | sed -E -e "s/^> Class (\w+):$/\1/" || true) | while read class
+            do
+              echo "::group::Add schema to $class:"
+              python head/scripts/openapi.py --verbose suggest schemas --add openapi.json openapi.head.index "$class" > /dev/null
+              (cd head; git diff; git reset --hard --quiet HEAD)
+              echo "::endgroup::"
+            done
+            echo ""
+            echo "Run the following commands to add the suggested schemas:"
+            echo "python3 -m venv venv"
+            echo "source venv/bin/activate"
+            echo "pip install -r requirements/scripts.txt"
+            echo python scripts/openapi.py fetch api.github.com 2022-11-28 openapi.json
+            echo python scripts/openapi.py index github openapi.json openapi.index
+            echo python scripts/openapi.py suggest schemas --add openapi.json openapi.index $(grep -E -e "^> Class \w+:$" diff.txt | sed -E -e "s/^> Class (\w+):$/\1/")
+            false
+          fi
+
+  implementations:
+    name: "Implement schemas"
+    needs: "test_success"
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          path: head
+      - uses: actions/checkout@v5
+        with:
+          ref: ${{ github.event.pull_request.base.sha }}
+          path: base
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Set up dependencies
+        run: |
+          pip install -r head/requirements/scripts.txt
+      - name: Add implementations
+        shell: bash
+        run: |
+          # Add implementations
+          set -euo pipefail
+
+          python head/scripts/openapi.py --verbose fetch ${{ env.openapi_api }} ${{ env.openapi_version }} openapi.json
+
+          echo "::group::Head implementations:"
+          python head/scripts/openapi.py --verbose index head/github openapi.json openapi.head.index
+          python head/scripts/openapi.py --verbose --dry-run apply --tests head/github openapi.json openapi.head.index | tee implementation.head.txt
+          echo "::endgroup::"
+
+          echo "::group::Base implementations:"
+          python head/scripts/openapi.py --verbose index base/github openapi.json openapi.base.index
+          python head/scripts/openapi.py --verbose --dry-run apply --tests base/github openapi.json openapi.base.index | tee implementation.base.txt
+          echo "::endgroup::"
+
+          if ! (diff <(sed -E -e "s/^[@]{2} .+ [@]{2}$/…/" -e "s%[(]base/github/%(github/%" -e "s%Test base/%Test %" implementation.base.txt) <(sed -E -e "s/^[@]{2} .+ [@]{2}$/…/" -e "s%[(]head/github/%(github/%" -e "s%Test head/%Test %" implementation.head.txt) > diff.txt)
+          then
+            echo ""
+            echo "Difference:"
+            cat diff.txt
+            echo ""
+            (grep -E -e "^> Class \w+ changed$" diff.txt | sed -E -e "s/^> Class (\w+) changed$/\1/" || true) | while read class
+            do
+              echo "::group::Apply schema to $class:"
+              python head/scripts/openapi.py --verbose apply --tests --new-schemas create-class head/github openapi.json openapi.head.index "$class" > /dev/null
+              (cd head; git diff; git reset --hard --quiet HEAD)
+              echo "::endgroup::"
+            done
+            echo ""
+            echo "Run the following commands to apply the schemas:"
+            echo "python3 -m venv venv"
+            echo "source venv/bin/activate"
+            echo "pip install -r requirements/scripts.txt"
+            echo python scripts/openapi.py fetch api.github.com 2022-11-28 openapi.json
+            echo python scripts/openapi.py index github openapi.index
+            echo python scripts/openapi.py apply --tests --new-schemas create-class github openapi.json openapi.index $(grep -E -e "^> Class \w+:$" diff.txt | sed -E -e "s/^> Class (\w+):$/\1/")
+            (grep -E -e "^> Test .+ changed$" diff.txt | sed -E -e "s/^> Test (.+) changed$/\1/" || true) | while read test
+            do
+              echo python scripts/prepare-for-update-assertions.py "$test" testAttributes
+              echo bash scripts/update-assertions.sh "$test" testAttributes
+            done
+            echo pre-commit run --all-files
+            echo ""
+            echo "You may need to fix the tests afterwards:"
+            echo pip install . -r requirements/test.txt
+            echo pytest tests
+            echo
+            false
+          fi
+
+  sort:
+    name: "Sort classes"
+    needs: "test_success"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: ./.github/actions/sort-classes
+      - name: changes
+        run: |
+          if ! (git diff --exit-code > diff.txt)
+          then
+            echo ""
+            echo "Changes:"
+            cat diff.txt
+            git reset --hard --quiet HEAD
+            echo ""
+            echo "To fix this, run the following commands:"
+            echo "python3 -m venv venv"
+            echo "source venv/bin/activate"
+            echo "pip install -r requirements/scripts.txt"
+            echo python scripts/openapi.py index github openapi.index
+            for class in $(jq -r ".indices.class_to_descendants.GithubObject | @tsv" < openapi.index)
+            do
+              python scripts/sort_class.py openapi.index $class > /dev/null
+              if ! git diff --quiet --exit-code
+              then
+                echo python scripts/sort_class.py openapi.index $class
+                git reset --hard --quiet HEAD
+              fi
+            done
+            false
+          fi
+
+  event_file:
+    name: "Event File"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Upload
+        uses: actions/upload-artifact@v4
+        with:
+          name: Event File
+          path: ${{ github.event_path }}

pygithub-2.8.1/.github/workflows/codeql.yml

@@ -0,0 +1,100 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL Advanced"
+
+on:
+  push:
+    branches: [ "main", "openapi/main" ]
+  pull_request:
+    branches: [ "main", "openapi/main" ]
+  schedule:
+    - cron: '17 14 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze (${{ matrix.language }})
+    # Runner size impacts CodeQL analysis time. To learn more, please see:
+    #   - https://gh.io/recommended-hardware-resources-for-running-codeql
+    #   - https://gh.io/supported-runners-and-hardware-resources
+    #   - https://gh.io/using-larger-runners (GitHub.com only)
+    # Consider using larger runners or machines with greater resources for possible analysis time improvements.
+    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+    permissions:
+      # required for all workflows
+      security-events: write
+
+      # required to fetch internal or private CodeQL packs
+      packages: read
+
+      # only required for workflows in private repositories
+      actions: read
+      contents: read
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - language: actions
+          build-mode: none
+        - language: python
+          build-mode: none
+        # CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift'
+        # Use `c-cpp` to analyze code written in C, C++ or both
+        # Use 'java-kotlin' to analyze code written in Java, Kotlin or both
+        # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
+        # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
+        # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
+        # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
+        # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v5
+
+    # Add any setup steps before running the `github/codeql-action/init` action.
+    # This includes steps like installing compilers or runtimes (`actions/setup-node`
+    # or others). This is typically only required for manual builds.
+    # - name: Setup runtime (example)
+    #   uses: actions/setup-example@v1
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: ${{ matrix.language }}
+        build-mode: ${{ matrix.build-mode }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+    # If the analyze step fails for one of the languages you are analyzing with
+    # "We were unable to automatically build your code", modify the matrix above
+    # to set the build mode to "manual" for that language. Then modify this step
+    # to build your code.
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+    - if: matrix.build-mode == 'manual'
+      shell: bash
+      run: |
+        echo 'If you are using a "manual" build mode for one or more of the' \
+          'languages you are analyzing, replace this with the commands to build' \
+          'your code, for example:'
+        echo '  make bootstrap'
+        echo '  make release'
+        exit 1
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3
+      with:
+        category: "/language:${{matrix.language}}"

pygithub-2.8.1/.github/workflows/lint.yml

@@ -0,0 +1,34 @@
+name: Lint
+on:
+  push:
+    branches:
+      - main
+      - release-v*
+  pull_request:
+  merge_group:
+permissions: {}
+
+jobs:
+  mypy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: ./.github/actions/mypy
+
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: ./.github/actions/pre-commit
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - run: pip install -r requirements/docs.txt
+      - run: pip install -e .
+      - run: sphinx-build doc build