Complete some argument default values/type hints in _pygit2

jorio · jorio · commit c572905a8a68 · 2022-03-03T20:15:44.000+01:00
diff --git a/pygit2/_pygit2.pyi b/pygit2/_pygit2.pyi
@@ -278,7 +278,7 @@ class Diff:
     @staticmethod
     def from_c(diff, repo) -> Diff: ...
     @staticmethod
-    def parse_diff(git_diff: str) -> Diff: ...
+    def parse_diff(git_diff: str | bytes) -> Diff: ...
     def __getitem__(self, index: int) -> Patch: ...  # Diff_getitem
     def __iter__(self) -> Iterator[Patch]: ...  # -> DiffIter
     def __len__(self) -> int: ...
@@ -332,7 +332,7 @@ class Mailmap:
     def __init__(self, *args) -> None: ...
     def add_entry(self, real_name: str = ..., real_email: str = ..., replace_name: str = ..., replace_email: str = ...) -> None: ...
     @staticmethod
-    def from_buffer(buffer: str) -> Mailmap: ...
+    def from_buffer(buffer: str | bytes) -> Mailmap: ...
     @staticmethod
     def from_repository(repository: Repository) -> Mailmap: ...
     def resolve(self, name: str, email: str) -> tuple[str,str]: ...
@@ -342,7 +342,7 @@ class Note:
     annotated_id: Oid
     id: Oid
     message: str
-    def remove(self, author: Signature, committer: Signature, ref: str = ...) -> None: ...
+    def remove(self, author: Signature, committer: Signature, ref: str = "refs/notes/commits") -> None: ...
 
 class Odb:
     backends: Iterator[OdbBackend] = ...
@@ -449,8 +449,8 @@ class Repository:
     def _disown(self, *args, **kwargs) -> None: ...
     def _from_c(self, *args, **kwargs) -> None: ...
     def add_worktree(self, name: str, path: str, ref: Reference = ...) -> Worktree: ...
-    def applies(self, diff: Diff, location: int = ...) -> bool: ...
-    def apply(self, diff: Diff, location: int = ...) -> None: ...
+    def applies(self, diff: Diff, location: int = GIT_APPLY_LOCATION_INDEX) -> bool: ...
+    def apply(self, diff: Diff, location: int = GIT_APPLY_LOCATION_WORKDIR) -> None: ...
     def cherrypick(self, id: _OidArg) -> None: ...
     def compress_references(self) -> None: ...
     def create_blob(self, data: bytes) -> Oid: ...
@@ -459,7 +459,7 @@ class Repository:
     def create_blob_fromworkdir(self, path: str) -> Oid: ...
     def create_branch(self, name: str, commit: Commit, force = ...) -> Branch: ...
     def create_commit(self, reference_name: str, author: Signature, committer: Signature, message: str, tree: _OidArg, parents: list[_OidArg], encoding: str = ...) -> Oid: ...
-    def create_note(self, message: str, author: Signature, committer: Signature, annotated_id: str, ref: str = ..., force: bool = ...) -> Oid: ...
+    def create_note(self, message: str, author: Signature, committer: Signature, annotated_id: str, ref: str = "refs/notes/commits", force: bool = False) -> Oid: ...
     def create_reference_direct(self, name: str, target, force = ..., message: str = ...) -> Reference: ...
     def create_reference_symbolic(self, name, source, force, message = ...) -> Reference: ...
     def create_tag(self, name: str, oid: _OidArg, type: int, tagger: Signature, message: str) -> Oid: ...
@@ -469,13 +469,13 @@ class Repository:
     def git_object_lookup_prefix(self, oid: _OidArg) -> Object: ...
     def init_submodules(self, submodules: list[pygit2.Submodule] = ..., overwrite = ...) -> None: ...
     def list_worktrees(self) -> list[str]: ...
-    def listall_branches(self, flag: int = ...) -> list[str]: ...
+    def listall_branches(self, flag: int = GIT_BRANCH_LOCAL) -> list[str]: ...
     def listall_reference_objects(self) -> list[Reference]: ...
     def listall_references(self) -> list[str]: ...
     def listall_stashes(self) -> list[Stash]: ...
     def listall_submodules(self) -> list[str]: ...
-    def lookup_branch(self, branch_name: str, branch_type: int = ...) -> Branch: ...
-    def lookup_note(self, annotated_id: str, ref: str = ...) -> Note: ...
+    def lookup_branch(self, branch_name: str, branch_type: int = GIT_BRANCH_LOCAL) -> Branch: ...
+    def lookup_note(self, annotated_id: str, ref: str = "refs/notes/commits") -> Note: ...
     def lookup_reference(self, name: str) -> Reference: ...
     def lookup_reference_dwim(self, name: str) -> Reference: ...
     def lookup_worktree(self, name: str) -> Worktree: ...
@@ -486,7 +486,7 @@ class Repository:
     def merge_base_octopus(self, oids: list[_OidArg]) -> Oid: ...
     def notes(self) -> Iterator[Note]: ...
     def path_is_ignored(self, path: str) -> bool: ...
-    def raw_listall_branches(self, flag: int = ...) -> list[bytes]: ...
+    def raw_listall_branches(self, flag: int = GIT_BRANCH_LOCAL) -> list[bytes]: ...
     def raw_listall_references(self) -> list[bytes]: ...
     def reset(self, oid: _OidArg, reset_type: int) -> None: ...
     def revparse(self, revspec: str) -> RevSpec: ...
@@ -496,7 +496,7 @@ class Repository:
     def set_refdb(self, refdb: Refdb) -> None: ...
     def status(self) -> dict[str,int]: ...
     def status_file(self, path: str) -> int: ...
-    def walk(self, oid: _OidArg | None, sort_mode: int = ...) -> Walker: ...
+    def walk(self, oid: _OidArg | None, sort_mode: int = GIT_SORT_NONE) -> Walker: ...
 
 class RevSpec:
     flags: int
@@ -574,13 +574,12 @@ class Worktree:
     path: str
     def prune(self, force = ...) -> None: ...
 
-def discover_repository(path: str, across_fs: bool = ..., ceiling_dirs: str = ...) -> str: ...
+def discover_repository(path: str, across_fs: bool = False, ceiling_dirs: str = ...) -> str: ...
 def hash(data: bytes) -> Oid: ...
 def hashfile(path: str) -> Oid: ...
-def init_file_backend(path: str, flags: int = ...) -> object: ...
+def init_file_backend(path: str, flags: int = 0) -> object: ...
 def option(*args, **kwargs) -> None: ...
 def reference_is_valid_name(refname: str) -> bool: ...
 def tree_entry_cmp(a: Object, b: Object) -> int: ...
 
 _OidArg = str | Oid
-
diff --git a/src/diff.c b/src/diff.c
@@ -1009,7 +1009,7 @@ Diff_stats__get__(Diff *self)
 }
 
 PyDoc_STRVAR(Diff_parse_diff__doc__,
-    "parse_diff(git_diff: str) -> Diff\n"
+    "parse_diff(git_diff: str | bytes) -> Diff\n"
     "\n"
     "Parses a git unified diff into a diff object without a repository");
 
diff --git a/src/note.c b/src/note.c
@@ -37,7 +37,7 @@
 extern PyTypeObject SignatureType;
 
 PyDoc_STRVAR(Note_remove__doc__,
-    "remove(author: Signature, committer: Signature, ref: str = ...)\n"
+    "remove(author: Signature, committer: Signature, ref: str = \"refs/notes/commits\")\n"
     "\n"
     "Removes a note for an annotated object");
 
diff --git a/src/pygit2.c b/src/pygit2.c
@@ -82,7 +82,7 @@ extern PyTypeObject StashType;
 
 
 PyDoc_STRVAR(discover_repository__doc__,
-  "discover_repository(path: str, across_fs: bool = ..., ceiling_dirs: str = ...) -> str\n"
+  "discover_repository(path: str, across_fs: bool = False, ceiling_dirs: str = ...) -> str\n"
   "\n"
   "Look for a git repository and return its path. If not found returns None.");
 
@@ -177,7 +177,7 @@ hash(PyObject *self, PyObject *args)
 
 
 PyDoc_STRVAR(init_file_backend__doc__,
-  "init_file_backend(path: str, flags: int = ...) -> object\n"
+  "init_file_backend(path: str, flags: int = 0) -> object\n"
   "\n"
   "Open repo backend given path.");
 PyObject *
diff --git a/src/repository.c b/src/repository.c
@@ -307,7 +307,7 @@ Repository_git_object_lookup_prefix(Repository *self, PyObject *key)
 
 
 PyDoc_STRVAR(Repository_lookup_branch__doc__,
-  "lookup_branch(branch_name: str, branch_type: int = ...) -> Branch\n"
+  "lookup_branch(branch_name: str, branch_type: int = GIT_BRANCH_LOCAL) -> Branch\n"
   "\n"
   "Returns the Git reference for the given branch name (local or remote).\n"
   "If branch_type is GIT_BRANCH_REMOTE, you must include the remote name\n"
@@ -792,7 +792,7 @@ Repository_cherrypick(Repository *self, PyObject *py_oid)
 }
 
 PyDoc_STRVAR(Repository_walk__doc__,
-    "walk(oid: Oid | None, sort_mode: int = ...) -> Walker\n"
+    "walk(oid: Oid | None, sort_mode: int = GIT_SORT_NONE) -> Walker\n"
     "\n"
     "Start traversing the history from the given commit.\n"
     "The following types of sorting could be used to control traversing\n"
@@ -1350,7 +1350,7 @@ Repository_listall_branches_impl(Repository *self, PyObject *args, PyObject *(*i
 }
 
 PyDoc_STRVAR(Repository_listall_branches__doc__,
-  "listall_branches(flag: int = ...) -> list[str]\n"
+  "listall_branches(flag: int = GIT_BRANCH_LOCAL) -> list[str]\n"
   "\n"
   "Return a list with all the branches in the repository.\n"
   "\n"
@@ -1367,7 +1367,7 @@ Repository_listall_branches(Repository *self, PyObject *args)
 }
 
 PyDoc_STRVAR(Repository_raw_listall_branches__doc__,
-  "raw_listall_branches(flag: int = ...) -> list[bytes]\n"
+  "raw_listall_branches(flag: int = GIT_BRANCH_LOCAL) -> list[bytes]\n"
   "\n"
   "Return a list with all the branches in the repository.\n"
   "\n"
@@ -1881,7 +1881,7 @@ Repository_notes(Repository *self, PyObject *args)
 
 
 PyDoc_STRVAR(Repository_create_note__doc__,
-  "create_note(message: str, author: Signature, committer: Signature, annotated_id: str, ref: str = ..., force: bool = ...) -> Oid\n"
+  "create_note(message: str, author: Signature, committer: Signature, annotated_id: str, ref: str = \"refs/notes/commits\", force: bool = False) -> Oid\n"
   "\n"
   "Create a new note for an object, return its SHA-ID."
   "If no ref is given 'refs/notes/commits' will be used.");
@@ -1917,7 +1917,7 @@ Repository_create_note(Repository *self, PyObject* args)
 
 
 PyDoc_STRVAR(Repository_lookup_note__doc__,
-  "lookup_note(annotated_id: str, ref: str = ...) -> Note\n"
+  "lookup_note(annotated_id: str, ref: str = \"refs/notes/commits\") -> Note\n"
   "\n"
   "Lookup a note for an annotated object in a repository.");
 
@@ -2109,7 +2109,7 @@ Repository_list_worktrees(Repository *self, PyObject *args)
 }
 
 PyDoc_STRVAR(Repository_apply__doc__,
-  "apply(diff: Diff, location: int = ...)\n"
+  "apply(diff: Diff, location: int = GIT_APPLY_LOCATION_WORKDIR)\n"
   "\n"
   "Applies the given Diff object to HEAD, writing the results into the\n"
   "working directory, the index, or both.\n"
@@ -2146,7 +2146,7 @@ Repository_apply(Repository *self, PyObject *args, PyObject *kwds)
 }
 
 PyDoc_STRVAR(Repository_applies__doc__,
-  "applies(diff: Diff, location: int = ...) -> bool\n"
+  "applies(diff: Diff, location: int = GIT_APPLY_LOCATION_INDEX) -> bool\n"
   "\n"
   "Tests if the given patch will apply to HEAD, without writing it.\n"
   "\n"

Original file line number	Diff line number	Diff line change
`@@ -1009,7 +1009,7 @@ Diff_stats__get__(Diff *self)`
`1009`	`1009`	`}`
`1010`	`1010`
`1011`	`1011`	`PyDoc_STRVAR(Diff_parse_diff__doc__,`
`1012`		`- "parse_diff(git_diff: str) -> Diff\n"`
	`1012`	`+ "parse_diff(git_diff: str \| bytes) -> Diff\n"`
`1013`	`1013`	`"\n"`
`1014`	`1014`	`"Parses a git unified diff into a diff object without a repository");`
`1015`	`1015`