`Repository.__init__` (possibly others) missing `os.PathLike` typing

Open
#1,307 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
developer-experience

Research direction

Start in pygit2/repository.py around lines 1523–1528 and review the typing for Repository.init. Compare the affected methods with the PathLike support added in pull request 990, then inspect related annotations for omissions. Done means all affected method signatures accept os.PathLike consistently.

Written by the indexing model from the issue text.

Description

Support for PathLikes was added in https://github.com/libgit2/pygit2/pull/990. However, it doesn't appear the typing for some of the affected methods were updated. Repository.__init__ was the one I caught, but there may be more (which is why this isn't just a PR, I didn't want to make this one change and end up missing others).

https://github.com/libgit2/pygit2/blob/5b27dee1162124a4021d6aa81f4d6ba78dee9f04/pygit2/repository.py#L1523-L1528

Dominant language
Python
Stars
1.7k
Forks
408
Avg merge
2d 57m
Merged PRs (30d)
7

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from libgit2/pygit2

All issues in libgit2/pygit2

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.