8000 Improve typing of config_levels, add assert_never() · gitpython-developers/GitPython@16f0607 · GitHub
[go: up one dir, main page]
Skip to content

Commit 16f0607

Browse files
YobmodYobmod
committed
Improve typing of config_levels, add assert_never()
1 parent d4a9eab commit 16f0607

File tree

7 files changed

+79
-18730
lines changed

7 files changed

+79
-18730
lines changed

‎git/config.py

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,10 @@
3131

3232
# typing-------------------------------------------------------
3333

34-
from typing import Any, Callable, IO, List, Dict, Sequence, TYPE_CHECKING, Tuple, Union, cast, overload
34+
from typing import (Any, Callable, IO, List, Dict, Sequence,
35+
TYPE_CHECKING, Tuple, Union, cast, overload)
3536

36-
from git.types import Literal, Lit_config_levels, PathLike, TBD
37+
from git.types import Lit_config_levels, ConfigLevels_Tup, ConfigLevels_NT, PathLike, TBD, assert_never
3738

3839
if TYPE_CHECKING:
3940
from git.repo.base import Repo
@@ -48,8 +49,9 @@
4849

4950
# invariants
5051
# represents the configuration level of a configuration file
51-
CONFIG_LEVELS = ("system", "user", "global", "repository"
52-
) # type: Tuple[Literal['system'], Literal['user'], Literal['global'], Literal['repository']]
52+
53+
54+
CONFIG_LEVELS: ConfigLevels_Tup = ConfigLevels_NT("system", "user", "global", "repository")
5355

5456
# Section pattern to detect conditional includes.
5557
# https://git-scm.com/docs/git-config#_conditional_includes
@@ -229,8 +231,9 @@ def get_config_path(config_level: Lit_config_levels) -> str:
229231
return osp.normpath(osp.expanduser("~/.gitconfig"))
230232
elif config_level == "repository":
231233
raise ValueError("No repo to get repository configuration from. Use Repo._get_config_path")
232-
233-
raise ValueError("Invalid configuration level: %r" % config_level)
234+
else:
235+
# Should not reach here. Will raise ValueError if does. Static typing will warn about extra and missing elifs
236+
assert_never(config_level, ValueError("Invalid configuration level: %r" % config_level))
234237

235238

236239
class GitConfigParser(with_metaclass(MetaParserBuilder, cp.RawConfigParser, object)): # type: ignore ## mypy does not understand dynamic class creation # noqa: E501
@@ -300,12 +303,12 @@ def __init__(self, file_or_files: Union[None, PathLike, IO, Sequence[Union[PathL
300303
self._proxies = self._dict()
301304

302305
if file_or_files is not None:
303-
self._file_or_files = file_or_files # type: Union[PathLike, IO, Sequence[Union[PathLike, IO]]]
306+
self._file_or_files: Union[PathLike, IO, Sequence[Union[PathLike, IO]]] = file_or_files
304307
else:
305308
if config_level is None:
306309
if read_only:
307-
self._file_or_files = [get_config_path(f) # type: ignore
308-
for f in CONFIG_LEVELS # Can type f properly when 3.5 dropped
310+
self._file_or_files = [get_config_path(f)
311+
for f in CONFIG_LEVELS
309312
if f != 'repository']
310313
else:
311314
raise ValueError("No configuration level or configuration files specified")
@@ -323,15 +326,13 @@ def __init__(self, file_or_files: Union[None, PathLike, IO, Sequence[Union[PathL
323326
def _acquire_lock(self) -> None:
324327
if not self._read_only:
325328
if not self._lock:
326-
if isinstance(self._file_or_files, (tuple, list)):
327-
raise ValueError(
328-
"Write-ConfigParsers can operate on a single file only, multiple files have been passed")
329-
# END single file check
330-
331329
if isinstance(self._file_or_files, (str, os.PathLike)):
332330
file_or_files = self._file_or_files
331+
elif isinstance(self._file_or_files, (tuple, list, Sequence)):
332+
raise ValueError(
333+
"Write-ConfigParsers can operate on a single file only, multiple files have been passed")
333334
else:
334-
file_or_files = cast(IO, self._file_or_files).name
335+
file_or_files = self._file_or_files.name
335336

336337
# END get filename from handle/stream
337338
# initialize lock base - we want to write

‎git/objects/submodule/base.py

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
from unittest import SkipTest
88
import uuid
99

10+
from git import IndexFile
11+
1012
import git
1113
from git.cmd import Git
1214
from git.compat import (
@@ -49,7 +51,7 @@
4951

5052

5153
# typing ----------------------------------------------------------------------
52-
from typing import Dict, TYPE_CHECKING
54+
from typing import Callable, Dict, TYPE_CHECKING
5355
from typing import Any, Iterator, Union
5456

5557
from git.types import Commit_ish, PathLike
@@ -131,14 +133,14 @@ def __init__(self, repo: 'Repo', binsha: bytes,
131133
if url is not None:
132134
self._url = url
133135
if branch_path is not None:
134-
assert isinstance(branch_path, str)
136+
# assert isinstance(branch_path, str)
135137
self._branch_path = branch_path
136138
if name is not None:
137139
self._name = name
138140

139141
def _set_cache_(self, attr: str) -> None:
140142
if attr in ('path', '_url', '_branch_path'):
141-
reader = self.config_reader()
143+
reader: SectionConstraint = self.config_reader()
142144
# default submodule values
143145
try:
144146
self.path = reader.get('path')
@@ -807,7 +809,8 @@ def move(self, module_path, configuration=True, module=True):
807809
return self
808810

809811
@unbare_repo
810-
def remove(self, module=True, force=False, configuration=True, dry_run=False):
812+
def remove(self, module: bool = True, force: bool = False,
813+
configuration: bool = True, dry_run: bool = False) -> 'Submodule':
811814
"""Remove this submodule from the repository. This will remove our entry
812815
from the .gitmodules file and the entry in the .git / config file.
813816
@@ -861,7 +864,7 @@ def remove(self, module=True, force=False, configuration=True, dry_run=False):
861864
# TODO: If we run into permission problems, we have a highly inconsistent
862865
# state. Delete the .git folders last, start with the submodules first
863866
mp = self.abspath
864-
method = None
867+
method: Union[None, Callable[[PathLike], None]] = None
865868
if osp.islink(mp):
866869
method = os.remove
867870
elif osp.isdir(mp):
@@ -928,7 +931,7 @@ def remove(self, module=True, force=False, configuration=True, dry_run=False):
928931
rmtree(git_dir)
929932
except Exception as ex:
930933
if HIDE_WINDOWS_KNOWN_ERRORS:
931-
raise SkipTest("FIXME: fails with: PermissionError\n %s", ex) from ex
934+
raise SkipTest(f"FIXME: fails with: PermissionError\n {ex}") from ex
932935
else:
933936
raise
934937
# end handle separate bare repository
@@ -961,7 +964,7 @@ def remove(self, module=True, force=False, configuration=True, dry_run=False):
961964

962965
return self
963966

964-
def set_parent_commit(self, commit: Union[Commit_ish, None], check=True):
967+
def set_parent_commit(self, commit: Union[Commit_ish, None], check: bool = True) -> 'Submodule':
965968
"""Set this instance to use the given commit whose tree is supposed to
966969
contain the .gitmodules blob.
967970
@@ -1009,7 +1012,7 @@ def set_parent_commit(self, commit: Union[Commit_ish, None], check=True):
 10000
10091012
return self
10101013

10111014
@unbare_repo
1012-
def config_writer(self, index=None, write=True):
1015+
def config_writer(self, index: Union[IndexFile, None] = None, write: bool = True) -> SectionConstraint:
10131016
""":return: a config writer instance allowing you to read and write the data
10141017
belonging to this submodule into the .gitmodules file.
10151018
@@ -1030,7 +1033,7 @@ def config_writer(self, index=None, write=True):
10301033
return writer
10311034

10321035
@unbare_repo
1033-
def rename(self, new_name):
1036+
def rename(self, new_name: str) -> 'Submodule':
10341037
"""Rename this submodule
10351038
:note: This method takes care of renaming the submodule in various places, such as
10361039
@@ -1081,7 +1084,7 @@ def rename(self, new_name):
10811084
#{ Query Interface
10821085

10831086
@unbare_repo
1084-
def module(self):
1087+
def module(self) -> 'Repo':
10851088
""":return: Repo instance initialized from the repository at our submodule path
10861089
:raise InvalidGitRepositoryError: if a repository was not available. This could
10871090
also mean that it was not yet initialized"""
@@ -1098,7 +1101,7 @@ def module(self):
10981101
raise InvalidGitRepositoryError("Repository at %r was not yet checked out" % module_checkout_abspath)
10991102
# END handle exceptions
11001103

1101-
def module_exists(self):
1104+
def module_exists(self) -> bool:
11021105
""":return: True if our module exists and is a valid git repository. See module() method"""
11031106
try:
11041107
self.module()
@@ -1107,7 +1110,7 @@ def module_exists(self):
11071110
return False
11081111
# END handle exception
11091112

1110-
def exists(self):
1113+
def exists(self) -> bool:
11111114
"""
11121115
:return: True if the submodule exists, False otherwise. Please note that
11131116
a submodule may exist ( in the .gitmodules file) even though its module

‎git/objects/submodule/util.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,18 @@
55
import weakref
66

77

8+
# typing -----------------------------------------------------------------------
9+
810
from typing import Any, TYPE_CHECKING, Union
911

12+
from git.types import PathLike
13+
1014
if TYPE_CHECKING:
1115
from .base import Submodule
1216
from weakref import ReferenceType
17+
from git.repo import Repo
18+
from git.refs import Head
19+
1320

1421
__all__ = ('sm_section', 'sm_name', 'mkhead', 'find_first_remote_branch',
1522
'SubmoduleConfigParser')
@@ -28,7 +35,7 @@ def sm_name(section):
2835
return section[11:-1]
2936

3037

31-
def mkhead(repo, path):
38+
def mkhead(repo: 'Repo', path: PathLike) -> 'Head':
3239
""":return: New branch/head instance"""
3340
return git.Head(repo, git.Head.to_full_path(path))
3441

‎git/refs/symbolic.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
from git.types import PathLike
12
import os
23

34
from git.compat import defenc
@@ -408,7 +409,7 @@ def log_entry(self, index):
408409
return RefLog.entry_at(RefLog.path(self), index)
409410

410411
@classmethod
411-
def to_full_path(cls, path):
412+
def to_full_path(cls, path) -> PathLike:
412413
"""
413414
:return: string with a full repository-relative path which can be used to initialize
414415
a Reference instance, for instance by using ``Reference.from_path``"""

‎git/repo/base.py

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,15 @@
3636

3737
# typing ------------------------------------------------------
3838

39-
from git.types import TBD, PathLike, Lit_config_levels, Commit_ish, Tree_ish
39+
from git.types import ConfigLevels_NT, TBD, PathLike, Lit_config_levels, Commit_ish, Tree_ish
4040
from typing import (Any, BinaryIO, Callable, Dict,
4141
Iterator, List, Mapping, Optional, Sequence,
4242
TextIO, Tuple, Type, Union,
4343
NamedTuple, cast, TYPE_CHECKING)
4444

45-
if TYPE_CHECKING: # only needed for types
45+
from git.types import ConfigLevels_Tup
46+
47+
if TYPE_CHECKING:
4648
from git.util import IterableList
4749
from git.refs.symbolic import SymbolicReference
4850
from git.objects import Tree
@@ -55,12 +57,11 @@
5557
__all__ = ('Repo',)
5658

5759

58-
BlameEntry = NamedTuple('BlameEntry', [
59-
('commit', Dict[str, TBD]),
60-
('linenos', range),
61-
('orig_path', Optional[str]),
62-
('orig_linenos', range)]
63-
)
60+
class BlameEntry(NamedTuple):
61+
commit: Dict[str, TBD]
62+
linenos: range
63+
orig_path: Optional[str]
64+
orig_linenos: range
6465

6566

6667
class Repo(object):
@@ -95,7 +96,7 @@ class Repo(object):
9596

9697
# invariants
9798
# represents the configuration level of a configuration file
98-
config_level = ("system", "user", "global", "repository") # type: Tuple[Lit_config_levels, ...]
99+
config_level: ConfigLevels_Tup = ConfigLevels_NT("system", "user", "global", "repository")
99100

100101
# Subclass configuration
101102
# Subclasses may easily bring in their own custom types by placing a constructor or type here

‎git/types.py

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44

55
import os
66
import sys
7-
from typing import Dict, Union, Any, TYPE_CHECKING
7+
from typing import (Callable, Dict, NoReturn, Tuple, Union, Any, Iterator, # noqa: F401
8+
NamedTuple, TYPE_CHECKING, get_args, TypeVar) # noqa: F401
89

910

1011
if sys.version_info[:2] >= (3, 8):
@@ -35,6 +36,32 @@
3536

3637
Lit_config_levels = Literal['system', 'global', 'user', 'repository']
3738

39+
T = TypeVar('T', bound=Literal['system', 'global', 'user', 'repository'], covariant=True)
40+
41+
42+
class ConfigLevels_NT(NamedTuple):
43+
"""NamedTuple of allowed CONFIG_LEVELS"""
44+
# works for pylance, but not mypy
45+
system: Literal['system']
46+
user: Literal['user']
47+
global_: Literal['global']
48+
repository: Literal['repository']
49+
50+
51+
ConfigLevels_Tup = Tuple[Lit_config_levels, Lit_config_levels, Lit_config_levels, Lit_config_levels]
52+
# Typing this as specific literals breaks for mypy
53+
54+
55+
def is_config_level(inp: str) -> TypeGuard[Lit_config_levels]:
56+
return inp in get_args(Lit_config_levels)
57+
58+
59+
def assert_never(inp: NoReturn, exc: Union[Exception, None] = None) -> NoReturn:
60+
if exc is None:
61+
assert False, f"An unhandled Literal ({inp}) in an if else chain was found"
62+
else:
63+
raise exc
64+
3865

3966
class Files_TD(TypedDict):
4067
insertions: int

0 commit comments

Comments
 (0)
0