Contribution to pyperf

[u/DxNovaNT]

I am recently came across the library pyperf because I have to benchmark my changes in a certain open source project to add metrics to the PR I was creating for the changes, but one thing I feel off is types, I don't know why but pyperf has lot of unknown types which is kind of weird so I was planning to contribute to it to make it a little bit better typed.

So I am wondering do projects like pyperf which comes under pdf accept contribution in generally? If there are any maintainers/contributors of pyperf here then then could answer my question.

Thanks in advance.

My Dev Environment

OS: Windows

Type Checker: Pyrefly

[u/Financial-Grass6753]

> which is kind of weird so I was planning to contribute to it to make it a little bit better typed

Not a contributor, but I can say it won't be easy and quick. None of current type checkers we have (mypy / ty / pyrefly / ..) has complete support for all intricacies of python type system, so `dict[any, any]` or similar junk is not completely avoidable.

[u/DxNovaNT → u/Financial-Grass6753]

Well, I don't know how far the support are in current versions but in pyperf even simple function parameters have Union Unknown type so I thought this library might need some good types.

I have similar experience with google's oauth library whose type system even worse like auto completion is not working.

[u/BeamMeUpBiscotti]

You could file an issue asking if they are open to adding types to the public API. Tho I will note that because this is a library the type annotations need to play nice with all type checkers, not just the one you're using.

If you want to contribute more generally, you could just look at open issues on the issue tracker

[u/DxNovaNT → u/BeamMeUpBiscotti]

Well I could check with different typecheckers . I guess there 3 widely used checker, Pyrefly, Ty, Mypy.

Do pyperf have a separate issue tracker?

[u/BeamMeUpBiscotti → u/DxNovaNT]

pyright also has significant usage

i mean the issue tracker on github

[u/KaffeeKiffer → u/DxNovaNT]

Go to https://pypi.org/project/pyperf/

That one lists the maintainers but it most importantly links to https://github.com/psf/pyperf

The GitHub page of the project is the best place to engage: Raise an Issue for missing/incomplete type hints and offer to (what you think you can) contribute.

[u/WaterDiligentq]

Using Pyrefly on Windows to fix pyperf types is peak 'I’m here to suffer and help' energy. Respect

[u/11krish11]

Yes, PSF-managed projects generally welcome community contributions, but for type annotations, the best approach is to open an issue or discussion on their GitHub repo first.

A few tips before submitting a PR:

• Scope it incrementally: Instead of typing the entire codebase in one massive PR, propose adding types module-by-module. Large typing PRs are hard to review and often stall.
• Align on tooling: Make sure your annotations pass their existing CI checks (typically mypy or pyright in strict mode) and support the project's minimum Python version.
• Check prior discussions: Look through their closed PRs/issues to see if typing has been discussed or requested before so you can follow their preferred style conventions.

[u/DxNovaNT → u/11krish11]

Yeah I also want that way, as I am ok with long running task.

[u/11krish11 → u/DxNovaNT]

That's a great mindset to have for open source!

A good way to start is by picking a small, self-contained utility module first (something without too many circular imports) and submitting a draft PR. That gives the maintainers an easy first review and lets you establish the exact typing rules/patterns they prefer before tackling the core benchmark modules.

Good luck with the contribution!

[u/DxNovaNT → u/11krish11]

Well I raised an Issue for this, if I get a green light then I will start working.

[u/11krish11 → u/DxNovaNT]

Perfect, that's the best way to do it. Fingers crossed you get a quick response from the maintainers. Hope to see the PR merged soon!