René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"mypy is confused by property aliases","articleBody":"Thank you very much for this very useful python package. Unfortunately mypy is very confused by property aliases such as \r\n\r\n```python\r\n    @property\r\n    def references(self) -\u003e \"IterableList[Reference]\":\r\n        \"\"\"A list of :class:`~git.refs.reference.Reference` objects representing tags,\r\n        heads and remote references.\r\n\r\n        :return:\r\n            ``git.IterableList(Reference, ...)``\r\n        \"\"\"\r\n        return Reference.list_items(self)\r\n\r\n    # Alias for references.\r\n    refs = references\r\n```\r\n\r\nthat can be found in [`git/repo/base.py`](https://github.com/gitpython-developers/GitPython/blob/4c21e514cd9b5acdc34891fc4b52e9b599810b3e/git/repo/base.py#L405C1-L416C22) or the analogous alias `branches` for `heads`. See https://github.com/python/mypy/issues/6700\r\n\r\nYou can reproduce the issue with the following `test.py`:\r\n```python\r\nfrom git.repo import Repo\r\n\r\nrepo = Repo()\r\nfor branch in repo.branches:\r\n    print(branch)\r\n```\r\nabout which `mypy` says:\r\n```\r\ntest.py:4: error: \"Callable[[], IterableList[Head]]\" has no attribute \"__iter__\" (not iterable)  [attr-defined]\r\nFound 1 error in 1 file (checked 1 source file)\r\n```\r\n\r\nI am not aware of any fix that would not uglify the code here, and that mypy issue doesn’t seem likely to see improvement in the near future. This is sad, but doing all the work to add type annotations and still having users facing incomprehensible error messages in perfectly legitimate code is also sad. \r\n\r\nCould you please tell me whether you would welcome a PR “fixing” this?","author":{"url":"https://github.com/PatrickMassot","@type":"Person","name":"PatrickMassot"},"datePublished":"2024-06-24T13:38:25.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":2},"url":"https://github.com/1934/GitPython/issues/1934"}