René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"`Repo()` fails in Git Worktree when `GIT_DIR` environment variable is set","articleBody":"The `git.Repo()` constructor in GitPython fails to correctly initialize a repository when called without a path from within a Git *worktree* and the `GIT_DIR` environment variable is set to that worktree. This variable is often automatically set by Git when executing an alias to point to the current repo or worktree git_dir. While `Repo(os.getcwd())` finds the worktree correctly, calling `Repo()` with `GIT_DIR` set to `Repo(os.getcwd()).git_dir` raises an `InvalidGitRepositoryError`.\n\n\n**Minimal Reproducing Example:**\n\n1.  **Set up a main Git repository:**\n\n    ```bash\n    mkdir main_repo\n    cd main_repo\n    git init\n    touch initial_file.txt\n    git add initial_file.txt\n    git commit -m \"Initial commit\"\n    ```\n\n2.  **Create a Git worktree:**\n\n    ```bash\n    git worktree add worktree_a\n    cd worktree_a\n    ```\n\n3.  **Create a simple Python script (e.g., `test_repo.py`) to initialize a Repo object:**\n\n```python\nimport os\nfrom git import Repo, InvalidGitRepositoryError\n\nprint(f\"Current working directory: {os.getcwd()}\")\nprint(f\"GIT_DIR environment variable: {os.getenv('GIT_DIR')}\")\n\ntry:\n    repo = Repo()\n    print(f\"Repo initialized successfully: {repo.working_dir}\")\nexcept InvalidGitRepositoryError as e:\n    print(f\"Error initializing Repo(): {e}\")\n\ntry:\n    repo_with_cwd = Repo(os.getcwd())\n    print(f\"Repo initialized with cwd successfully: {repo_with_cwd.working_dir}\")\n    print(f\"Repo(os.getcwd()).git_dir: {Repo(os.getcwd()).git_dir}\")\nexcept InvalidGitRepositoryError as e:\n    print(f\"Error initializing Repo(os.getcwd()): {e}\")\n```\n\n4.  **Create a Git alias to run the Python script (e.g., in `.git/config` or using `git config --local alias.test-repo '!python /path/to/test_repo.py'`):**\n\n    Replace `/path/to/test_repo.py` with the actual path to your script.\n\n5.  **Run the Git alias from within the worktree:**\n\n    ```bash\n    git test-repo\n    ```\n\n**Expected Behavior:**\n\n`Repo()` should successfully initialize the repository, recognizing the worktree's context and linking back to the main repository's `.git` directory.\n\n**Observed Behavior:**\n\nRaises an `InvalidGitRepositoryError` when `Repo()` is called without a path, while `Repo(os.getcwd())` succeeds. The output will also show that the `GIT_DIR` environment variable is set within the worktree's context.\n\n**Additional Information:**\n\n* **GitPython Version:** 3.1.44\n* **Python Version:** 3.10.14\n* **Operating System:** Linux\n\nMaybe one should also check if such happens for submodules since they also have the repo dir in a different place than the normal .git dir.\n\n**Workaround:**\n\nExplicitly passing `os.getcwd()` to the `Repo()` constructor or unsetting the `GIT_DIR` environment variable before calling `Repo()` seems to work.\n","author":{"url":"https://github.com/Leokap","@type":"Person","name":"Leokap"},"datePublished":"2025-04-08T14:26:11.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":2},"url":"https://github.com/2022/GitPython/issues/2022"}