GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Fix type hint for `SymbolicReference.reference` property by emmanuel-ferdman · Pull Request #2074 · gitpython-developers/GitPython

Conversation

@emmanuel-ferdman

@emmanuel-ferdman emmanuel-ferdman commented Sep 30, 2025

Copy link
Copy Markdown
Contributor

PR Summary

This PR fixes mypy errors introduced in v3.1.45 where code like repo.head.ref.checkout() fails type checking even though it works at runtime. The issue is that SymbolicReference.reference was typed to return SymbolicReference, but it actually returns Reference subclasses that have methods like checkout() and tracking_branch(). Changed the return type annotation from SymbolicReference to Reference and added an explicit cast in _get_reference() to match what actually happens at runtime. This is a type-only change with no behavioral impact.

Fixes #2066.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@emmanuel-ferdman
Fix type hint for SymbolicReference.reference property
7c55a2b 
Signed-off-by: Emmanuel Ferdman <[email protected]>
@Byron

Byron commented Sep 30, 2025

Copy link
Copy Markdown
Member

Thanks a lot, looks good to me!

Besides that, we do have mypi type checks, but it seems like they are advisory only and can't fail CI.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@Byron
Byron merged commit 963b6f8 into gitpython-developers:main Sep 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Incorrect return type hint in SymbolicReference.reference leads to mypy errors

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@emmanuel-ferdman @Byron
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.