Git3 Compat + gix speedup for GitPython

.basedpyright/baseline.json

@@ -8,75 +8,9 @@
           "endColumn": 45,
           "lineCount": 1
         }
-      },
-      {
-        "code": "reportArgumentType",
-        "range": {
-          "startColumn": 41,
-          "endColumn": 48,
-          "lineCount": 1
-        }
-      },
-      {
-        "code": "reportArgumentType",
-        "range": {
-          "startColumn": 32,
-          "endColumn": 39,
-          "lineCount": 1
-        }
-      },
-      {
-        "code": "reportCallIssue",
-        "range": {
-          "startColumn": 25,
-          "endColumn": 46,
-          "lineCount": 1
-        }
-      },
-      {
-        "code": "reportArgumentType",
-        "range": {
-          "startColumn": 30,
-          "endColumn": 39,
-          "lineCount": 1
-        }
-      }
-    ],
-    "./git/db.py": [
-      {
-        "code": "reportIncompatibleMethodOverride",
-        "range": {
-          "startColumn": 8,
-          "endColumn": 12,
-          "lineCount": 1
-        }
-      },
-      {
-        "code": "reportIncompatibleMethodOverride",
-        "range": {
-          "startColumn": 8,
-          "endColumn": 14,
-          "lineCount": 1
-        }
       }
     ],
     "./git/index/base.py": [
-      {
-        "code": "reportArgumentType",
-        "range": {
-          "startColumn": 30,
-          "endColumn": 36,
-          "lineCount": 1
-        }
-      },
-      {
-        "code": "reportArgumentType",
-        "range": {
-          "startColumn": 28,
-          "endColumn": 34,
-          "lineCount": 1
-        }
-      },
       {
         "code": "reportArgumentType",
         "range": {
@@ -186,14 +120,6 @@
           "endColumn": 25,
           "lineCount": 1
         }
-      },
-      {
-        "code": "reportArgumentType",
-        "range": {
-          "startColumn": 52,
-          "endColumn": 84,
-          "lineCount": 1
-        }
       }
     ],
     "./git/objects/tag.py": [
@@ -274,32 +200,6 @@
         }
       }
     ],
-    "./git/refs/log.py": [
-      {
-        "code": "reportArgumentType",
-        "range": {
-          "startColumn": 30,
-          "endColumn": 34,
-          "lineCount": 1
-        }
-      },
-      {
-        "code": "reportAttributeAccessIssue",
-        "range": {
-          "startColumn": 17,
-          "endColumn": 22,
-          "lineCount": 1
-        }
-      },
-      {
-        "code": "reportArgumentType",
-        "range": {
-          "startColumn": 28,
-          "endColumn": 30,
-          "lineCount": 1
-        }
-      }
-    ],
     "./git/refs/reference.py": [
       {
         "code": "reportIncompatibleVariableOverride",
@@ -310,16 +210,6 @@
         }
       }
     ],
-    "./git/refs/symbolic.py": [
-      {
-        "code": "reportAttributeAccessIssue",
-        "range": {
-          "startColumn": 15,
-          "endColumn": 20,
-          "lineCount": 1
-        }
-      }
-    ],
     "./git/refs/tag.py": [
       {
         "code": "reportIncompatibleMethodOverride",
@@ -339,22 +229,6 @@
       }
     ],
     "./git/remote.py": [
-      {
-        "code": "reportAttributeAccessIssue",
-        "range": {
-          "startColumn": 26,
-          "endColumn": 38,
-          "lineCount": 1
-        }
-      },
-      {
-        "code": "reportAttributeAccessIssue",
-        "range": {
-          "startColumn": 26,
-          "endColumn": 38,
-          "lineCount": 1
-        }
-      },
       {
         "code": "reportAttributeAccessIssue",
         "range": {
@@ -373,14 +247,6 @@
       }
     ],
     "./git/repo/base.py": [
-      {
-        "code": "reportReturnType",
-        "range": {
-          "startColumn": 15,
-          "endColumn": 28,
-          "lineCount": 1
-        }
-      },
       {
         "code": "reportTypedDictNotRequiredAccess",
         "range": {
@@ -446,16 +312,6 @@
         }
       }
     ],
-    "./git/repo/fun.py": [
-      {
-        "code": "reportReturnType",
-        "range": {
-          "startColumn": 11,
-          "endColumn": 20,
-          "lineCount": 1
-        }
-      }
-    ],
     "./test/deprecation/test_basic.py": [
       {
         "code": "reportUnusedExpression",

.github/workflows/backend-benchmark.yml

@@ -0,0 +1,78 @@
+name: Backend benchmark
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  compare-backends:
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.12"
+      - name: Ensure Git 2.52 or newer
+        run: |
+          if ! dpkg --compare-versions "$(git version | awk '{print $3}')" ge 2.52; then
+            sudo add-apt-repository --yes ppa:git-core/ppa
+            sudo apt-get update
+            sudo apt-get install --yes git
+          fi
+      - name: Install separate backends with the same interpreter
+        run: |
+          python -m venv .bench-cli
+          python -m venv .bench-gix
+          .bench-cli/bin/python -m pip install . -r test/performance/benchmark-requirements.txt
+          .bench-gix/bin/python -m pip install '.[gix]' -r test/performance/benchmark-requirements.txt
+      - name: Prepare an existing repository outside the timed operations
+        env:
+          BENCH_REPO: ${{ runner.temp }}/benchmark-repo
+          GIT_CONFIG_NOSYSTEM: "1"
+          GIT_CONFIG_GLOBAL: /dev/null
+        run: |
+          git init --object-format=sha1 --ref-format=files "$BENCH_REPO"
+          git -C "$BENCH_REPO" fetch --no-tags "$GITHUB_WORKSPACE" 6ba2c0a2f9ee7feffd7e079621c4845820180c9a
+          git -C "$BENCH_REPO" checkout -b benchmark FETCH_HEAD
+          git -C "$BENCH_REPO" config core.excludesFile /dev/null
+          git -C "$BENCH_REPO" config core.attributesFile /dev/null
+          git -C "$BENCH_REPO" config core.fsmonitor false
+          git -C "$BENCH_REPO" config core.untrackedCache false
+          git -C "$BENCH_REPO" config gc.auto 0
+          git -C "$BENCH_REPO" config maintenance.auto false
+          mkdir "$BENCH_REPO/.benchmark-cache"
+          touch "$BENCH_REPO/.benchmark-cache/probe" "$BENCH_REPO/benchmark-untracked.txt"
+          echo '.benchmark-cache/' >> "$BENCH_REPO/.git/info/exclude"
+          mkdir benchmark-results
+      - name: Measure GixPython operations, opening and discovery first
+        run: |
+          .bench-gix/bin/python -m test.performance.bench_repository \
+            --repo "$RUNNER_TEMP/benchmark-repo" --expect-backend gix -o benchmark-results/gix.json
+      - name: Measure CLI operations, opening and discovery
+        run: |
+          .bench-cli/bin/python -m test.performance.bench_repository \
+            --repo "$RUNNER_TEMP/benchmark-repo" --expect-backend cli -o benchmark-results/cli.json
+      - name: Check parity and publish comparison
+        run: |
+          .bench-gix/bin/python -m test.performance.compare_backends \
+            benchmark-results/cli.json benchmark-results/gix.json \
+            --cli-budget test/performance/cli-budget.json > benchmark-results/comparison.md
+          cat benchmark-results/comparison.md >> "$GITHUB_STEP_SUMMARY"
+          .bench-gix/bin/python -m pyperf compare_to \
+            benchmark-results/cli.json benchmark-results/gix.json --table --table-format md \
+            >> "$GITHUB_STEP_SUMMARY"
+      - name: Retain raw timings and comparison
+        if: always()
+        uses: actions/upload-artifact@v7
+        with:
+          name: backend-benchmark
+          path: benchmark-results/

.github/workflows/cygwin-test.yml

@@ -45,14 +45,25 @@ jobs:
     - name: Install Cygwin
       uses: cygwin/cygwin-install-action@v6
       with:
-        packages: curl git python39 python-setuptools-wheel
+        packages: >-
+          curl gcc-core git libcurl-devel libexpat-devel libiconv-devel
+          libssl-devel make python39 python-setuptools-wheel zlib-devel
         add-to-path: false  # No need to change $PATH outside the Cygwin environment.
 
     - name: Arrange for verbose output
       run: |
         # Arrange for verbose output but without shell environment setup details.
         echo 'set -x' >~/.bash_profile
 
+    - name: Build minimum supported Cygwin Git
+      run: |
+        # Cygwin's packaged Git is older than our minimum supported version.
+        git clone --depth 1 --branch v2.52.0 -- https://github.com/git/git.git /tmp/git-source
+        # Use Cygwin's normal prefix: GitPython checks for uname next to git.
+        make -C /tmp/git-source -j2 prefix=/usr NO_GETTEXT=YesPlease NO_TCLTK=YesPlease NO_PERL=YesPlease install
+        hash -r
+        test "$(git version)" = 'git version 2.52.0'
+
     - name: Special configuration for Cygwin git
       run: |
         git config --global --add safe.directory "$(pwd)"
@@ -87,6 +98,9 @@ jobs:
       run: |
         pip install ./smmap ./gitdb '.[test]'
 
+    - name: Verify Cygwin Git detection
+      run: python -c 'from git import Git; assert Git.is_cygwin()'
+
     - name: Show POSIX file ownership
       # Cygwin's `ls -ld` reports the NTFS Owner SID via Cygwin's SID-to-uid
       # mapping (well-known SIDs by their RID, machine-local accounts by

.github/workflows/downstream.yml

@@ -0,0 +1,38 @@
+name: Downstream compatibility
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    strategy:
+      fail-fast: false
+      matrix:
+        project: [langchain, mlflow, bandit, swebench, datahub]
+        backend: [gix, cli]
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          persist-credentials: false
+      - name: Ensure Git 2.52 or newer
+        run: |
+          if ! dpkg --compare-versions "$(git version | awk '{print $3}')" ge 2.52; then
+            sudo add-apt-repository --yes ppa:git-core/ppa
+            sudo apt-get update
+            sudo apt-get install --yes git
+          fi
+      - name: Install uv
+        uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          version: '0.12.13'
+          enable-cache: false
+      - name: Test latest release against this checkout
+        run: uv run test/downstream/run.py "${{ matrix.project }}" --backend "${{ matrix.backend }}"

.github/workflows/git-cli.yml

@@ -0,0 +1,42 @@
+name: Minimum Git CLI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  git-2-52:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/checkout@v7
+        with:
+          repository: git/git
+          ref: v2.52.0
+          path: .git-source
+      - uses: actions/setup-python@v7
+        with:
+          python-version: '3.12'
+      - name: Build minimum supported Git
+        working-directory: .git-source
+        run: |
+          make -j2 prefix="$RUNNER_TEMP/git" NO_GETTEXT=YesPlease NO_TCLTK=YesPlease NO_PERL=YesPlease NO_CURL=YesPlease install
+          echo "$RUNNER_TEMP/git/bin" >> "$GITHUB_PATH"
+      - name: Install GitPython and test dependencies
+        run: python -m pip install ./smmap ./gitdb '.[test]'
+      - name: Verify native format and safety contracts
+        env:
+          GIT_CONFIG_NOSYSTEM: '1'
+          GIT_CONFIG_GLOBAL: /dev/null
+          GIT_AUTHOR_NAME: GitPython Tests
+          GIT_AUTHOR_EMAIL: tests@example.invalid
+          GIT_COMMITTER_NAME: GitPython Tests
+          GIT_COMMITTER_EMAIL: tests@example.invalid
+        run: |
+          git version
+          python -m pytest --no-cov --tb=short test/test_cli_objects_index.py test/test_cli_safety.py test/test_reflog.py test/test_config.py test/test_remote_cli.py test/test_submodule.py::test_submodule_cli_lifecycle