Type Hints

[mdantonio]

Hello,

I was looking for any type hints for GitPython, but I found nothing neither in the code nor in independent stub repositories.

Is there any plan to introduce type hinting?

[Byron]

I am absolutely open to receiving PRs adding type hints, and GitPython would be happy to host them directly in source.

Any amount of types would help and is appreciated, thus there is no need to add type hints everywhere at once.

[Yobmod]

I looked at starting to contribute type hints, but wanted to ask would it be feasible to drop support for python 3.4 (EOL 2 years ago)?

With 3.5+ type hints can be added directly to the code, but for 3.4 they would need to be in .pyi files, doubling the number of files and requiring they are kept in sync (AFAIK, 3.4 will give errors rather than ignore most inline type hints even though annotation syntax is possible)

[Byron]

@Yobmod Thanks for bringing this to my attention, and I would be glad to see type hints in code. Please feel free to submit a draft PR that starts out by dropping PY3.4 support to allow adding the first type hints in code. That one wouldn't have to be complete at all, but could lay the foundation for more PRs adding types in future.

[Yobmod]

I've put in a PR to drop python 3.4.
Planning to use Monkeytype to add initial types to the most user-facing files and see how that goes.

[Yobmod]

A plan:

• Drop 3.4 (add 3.9)
• Final 3.4 release
• Monkeytype using test suite
• Add monkeytype.sqlite3 and mypy.ini to .gitignore
• Apply initial types to Repo/base & Repo/fun
• Add mypy.ini
• Add py.typed
• Appy initial types to git/*
• First typed release
• Appy initial types to index/*
• Appy initial types to refs/*
• Appy initial types to objects/*
• Increase mypy strictness
• Expand/Refine types (use overloads, Literals, TypedDicts etc)
• Make IterableList Generic & update throughout
• second typed release
• Drop 3.5 (add 3.10)
• Fix blocking issues caused by 3.5 compat

[mdantonio]

Thank for all the effort towards type hints! I am sorry I have not been able to contribute so far, I hope to be able to put some effort after the great initial start of @Yobmod

[Yobmod]

Thank for all the effort towards type hints! I am sorry I have not been able to contribute so far, I hope to be able to put some effort after the great initial start of @Yobmod

Thanks, Any help is always good :)

Branch for adding types is here: https://github.com/Yobmod/GitPython/tree/addtypes

Mypy-stubgen just typed everythin as Any, and Monkeytype has not been as useful as i hoped. If any wants to run it, commands are:

• monkeytype run test/tstrunner.py
• monkeytype list > mtype_filelist.txt
• monkeytype stub git.cmd > git/cmd.pyi

But i'm mostly doing them by hand.

[kasium]

Hey, it seems that most of the code is typed, right? Would it be possible to include a "py.typed" file into the repo so that mypy can pick the types up?

[Yobmod]

Hey, it seems that most of the code is typed, right? Would it be possible to include a "py.typed" file into the repo so that mypy can pick the types up?

Hi, there already is one. Are you on the newest version?
Annotations showing up for me.

[kasium]

Yes I use the latest version. The py.typed file is not present in the tar.gz nor in the wheel - maybe that's the issue.
Mypy (also latest version) complains that no stub could be found

[Yobmod]

I've read up on some setuptools options, it seems that the package_data and include_package_data arguments are mutually exclusive. So setup.py is picking up the package_data only from the MANIFEST.INI and not from within the setup.include_package_data list.

I'll add py.typed to the manifest and hopefully that fixes it.

[kasium]

Great. thanks a lot