Add return-type annotation on __init__ methods · gitpython-developers/GitPython@5d7e55b · GitHub

gitpython-developers / GitPython Public

• Notifications You must be signed in to change notification settings
• Fork 989
• Star 5.2k

• Code
• Issues 8
• Pull requests 2
• Discussions
• Actions
• Security and quality 34
• Insights

Additional navigation options

Commit 5d7e55b

Browse filesBrowse the repository at this point in the historyBrowse files

EliahKagan

committed

Add return-type annotation on __init__ methods

Although sometimes found unintuitive, the reutrn type of a class's __init__ method is best annotated as None, as in other functions that return implicitly or by operand-less return statements. Note that this is only a minor improvement, effectively just a style fix, because mypy treats __init__ specially and, *when at least one parameter is annotated*, its return type is implicitly None rather than implicitly Any like other functions. All the __init__ methods modified here did already have one or more annotated parameters. However, having __init__ methods without the return type makes it easier to introduce a bug where an __init__ method with no parameters besides self -- which itself should almost always be unannotated and is properly inferred -- is written and the return annotation needed to get mypy to regard it as statically typed, so it checks it at all, is omitted. (It is also inelegant when one considers the meaning of __init__ and the distinction between it and __new__.) This commit does not add any return type annotations to functions in the test suite, since the test suite doesn't currently use static typing. Further reading: - https://peps.python.org/pep-0484/#the-meaning-of-annotations - python/mypy#604 - #1755 (comment)

1 parent e984bfe commit 5d7e55b
Copy full SHA for 5d7e55b

7 files changed

+7-7Lines changed: 7 additions & 7 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• git
  • cmd.py
  • objects
    • base.py
    • submodule
      • root.py
  • refs
    • head.py
    • log.py
    • symbolic.py
  • util.py

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎git/cmd.py‎

Copy file name to clipboardExpand all lines: git/cmd.py

+1-1Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -846,7 +846,7 @@ def __del__(self) -> None:
846	846	self._stream.read(bytes_left + 1)
847	847	# END handle incomplete read
848	848
849		- def __init__(self, working_dir: Union[None, PathLike] = None):
	849	+ def __init__(self, working_dir: Union[None, PathLike] = None) -> None:
850	850	"""Initialize this instance with:
851	851
852	852	:param working_dir:

Collapse file

‎git/objects/base.py‎

Copy file name to clipboardExpand all lines: git/objects/base.py

+1-1Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -55,7 +55,7 @@ class Object(LazyMixin):
55	55
56	56	type: Union[Lit_commit_ish, None] = None
57	57
58		- def __init__(self, repo: "Repo", binsha: bytes):
	58	+ def __init__(self, repo: "Repo", binsha: bytes) -> None:
59	59	"""Initialize an object by identifying it by its binary sha.
60	60
61	61	All keyword arguments will be set on demand if ``None``.

Collapse file

‎git/objects/submodule/root.py‎

Copy file name to clipboardExpand all lines: git/objects/submodule/root.py

+1-1Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -56,7 +56,7 @@ class RootModule(Submodule):
56	56
57	57	k_root_name = "__ROOT__"
58	58
59		- def __init__(self, repo: "Repo"):
	59	+ def __init__(self, repo: "Repo") -> None:
60	60	# repo, binsha, mode=None, path=None, name = None, parent_commit=None, url=None, ref=None)
61	61	super().__init__(
62	62	repo,

Collapse file

‎git/refs/head.py‎

Copy file name to clipboardExpand all lines: git/refs/head.py

+1-1Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -44,7 +44,7 @@ class HEAD(SymbolicReference):
44	44
45	45	__slots__ = ()
46	46
47		- def __init__(self, repo: "Repo", path: PathLike = _HEAD_NAME):
	47	+ def __init__(self, repo: "Repo", path: PathLike = _HEAD_NAME) -> None:
48	48	if path != self._HEAD_NAME:
49	49	raise ValueError("HEAD instance must point to %r, got %r" % (self._HEAD_NAME, path))
50	50	super().__init__(repo, path)

Collapse file

‎git/refs/log.py‎

Copy file name to clipboardExpand all lines: git/refs/log.py

+1-1Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -164,7 +164,7 @@ def __new__(cls, filepath: Union[PathLike, None] = None) -> "RefLog":
164	164	inst = super().__new__(cls)
165	165	return inst
166	166
167		- def __init__(self, filepath: Union[PathLike, None] = None):
	167	+ def __init__(self, filepath: Union[PathLike, None] = None) -> None:
168	168	"""Initialize this instance with an optional filepath, from which we will
169	169	initialize our data. The path is also used to write changes back using the
170	170	:meth:`write` method."""

Collapse file

‎git/refs/symbolic.py‎

Copy file name to clipboardExpand all lines: git/refs/symbolic.py

+1-1Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -74,7 +74,7 @@ class SymbolicReference:
74	74	_remote_common_path_default = "refs/remotes"
75	75	_id_attribute_ = "name"
76	76
77		- def __init__(self, repo: "Repo", path: PathLike, check_path: bool = False):
	77	+ def __init__(self, repo: "Repo", path: PathLike, check_path: bool = False) -> None:
78	78	self.repo = repo
79	79	self.path = path
80	80

Collapse file

‎git/util.py‎

Copy file name to clipboardExpand all lines: git/util.py

+1-1Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -917,7 +917,7 @@ class Stats:
917	917
918	918	__slots__ = ("total", "files")
919	919
920		- def __init__(self, total: Total_TD, files: Dict[PathLike, Files_TD]):
	920	+ def __init__(self, total: Total_TD, files: Dict[PathLike, Files_TD]) -> None:
921	921	self.total = total
922	922	self.files = files
923	923

0 commit comments

Comments

0 (0)