Improve types of diff.py

Yobmod · Yobmod · commit fb09bfacd449 · 2021-07-06T14:39:28.000+01:00
diff --git a/git/diff.py b/git/diff.py
@@ -16,7 +16,7 @@
 # typing ------------------------------------------------------------------
 
 from typing import Any, Iterator, List, Match, Optional, Tuple, Type, Union, TYPE_CHECKING
-from git.types import PathLike, TBD, Literal
+from git.types import PathLike, TBD, Literal, TypeGuard
 
 if TYPE_CHECKING:
 from .objects.tree import Tree
@@ -200,7 +200,8 @@ def iter_change_type(self, change_type: Lit_change_type) -> Iterator['Diff']:
 if change_type not in self.change_type:
 raise ValueError("Invalid change type: %s" % change_type)
 
- for diff in self: # type: 'Diff'
+ # diff: 'Diff'
+ for diff in self:
 if diff.change_type == change_type:
 yield diff
 elif change_type == "A" and diff.new_file:
@@ -281,7 +282,8 @@ def __init__(self, repo: 'Repo',
 a_mode: Union[bytes, str, None], b_mode: Union[bytes, str, None],
 new_file: bool, deleted_file: bool, copied_file: bool,
 raw_rename_from: Optional[bytes], raw_rename_to: Optional[bytes],
- diff: Union[str, bytes, None], change_type: Optional[str], score: Optional[int]) -> None:
+ diff: Union[str, bytes, None], change_type: Union[Lit_change_type, None],
+ score: Optional[int]) -> None:
 
 assert a_rawpath is None or isinstance(a_rawpath, bytes)
 assert b_rawpath is None or isinstance(b_rawpath, bytes)
@@ -498,12 +500,18 @@ def _handle_diff_line(lines_bytes: bytes, repo: 'Repo', index: DiffIndex) -> Non
 for line in lines.split(':')[1:]:
 meta, _, path = line.partition('\x00')
 path = path.rstrip('\x00')
- a_blob_id, b_blob_id = None, None # Type: Optional[str]
+ a_blob_id: Union[str, None]
+ b_blob_id: Union[str, None]
 old_mode, new_mode, a_blob_id, b_blob_id, _change_type = meta.split(None, 4)
 # Change type can be R100
 # R: status letter
 # 100: score (in case of copy and rename)
- change_type = _change_type[0]
+
+ def is_change_type(inp: str) -> TypeGuard[Lit_change_type]:
+ return inp in Lit_change_type.__args__ # type: ignore
+
+ assert is_change_type(_change_type[0])
+ change_type: Lit_change_type = _change_type[0]
 score_str = ''.join(_change_type[1:])
 score = int(score_str) if score_str.isdigit() else None
 path = path.strip()
@@ -518,7 +526,7 @@ def _handle_diff_line(lines_bytes: bytes, repo: 'Repo', index: DiffIndex) -> Non
 # NOTE: We cannot conclude from the existence of a blob to change type
 # as diffs with the working do not have blobs yet
 if change_type == 'D':
- b_blob_id = None # Optional[str]
+ b_blob_id = None
 deleted_file = True
 elif change_type == 'A':
 a_blob_id = None

-Original file line number
+Diff line change
 # typing ------------------------------------------------------------------
 fromtypingimportAny, Iterator, List, Match, Optional, Tuple, Type, Union, TYPE_CHECKING
 -fromgit.typesimportPathLike, TBD, Literal
 +fromgit.typesimportPathLike, TBD, Literal, TypeGuard
 ifTYPE_CHECKING:
 from .objects.treeimportTree
 ifchange_typenotinself.change_type:
 raiseValueError("Invalid change type: %s"%change_type)
 -fordiffinself: # type: 'Diff'
 +# diff: 'Diff'
 +fordiffinself:
 ifdiff.change_type==change_type:
 yielddiff
 elifchange_type=="A"anddiff.new_file:
 a_mode: Union[bytes, str, None], b_mode: Union[bytes, str, None],
 new_file: bool, deleted_file: bool, copied_file: bool,
 raw_rename_from: Optional[bytes], raw_rename_to: Optional[bytes],
 -diff: Union[str, bytes, None], change_type: Optional[str], score: Optional[int]) ->None:
 +diff: Union[str, bytes, None], change_type: Union[Lit_change_type, None],
 +score: Optional[int]) ->None:
 asserta_rawpathisNoneorisinstance(a_rawpath, bytes)
 assertb_rawpathisNoneorisinstance(b_rawpath, bytes)
 forlineinlines.split(':')[1:]:
 meta, _, path=line.partition('\x00')
 path=path.rstrip('\x00')
 -a_blob_id, b_blob_id=None, None# Type: Optional[str]
 +a_blob_id: Union[str, None]
 +b_blob_id: Union[str, None]
 old_mode, new_mode, a_blob_id, b_blob_id, _change_type=meta.split(None, 4)
 # Change type can be R100
 # R: status letter
 # 100: score (in case of copy and rename)
 -change_type=_change_type[0]
++
 +defis_change_type(inp: str) ->TypeGuard[Lit_change_type]:
 +returninpinLit_change_type.__args__# type: ignore
++
 +assertis_change_type(_change_type[0])
 +change_type: Lit_change_type=_change_type[0]
 score_str=''.join(_change_type[1:])
 score=int(score_str) ifscore_str.isdigit() elseNone
 path=path.strip()
 # NOTE: We cannot conclude from the existence of a blob to change type
 # as diffs with the working do not have blobs yet
 ifchange_type=='D':
 -b_blob_id=None# Optional[str]
 +b_blob_id=None
 deleted_file=True
 elifchange_type=='A':
 a_blob_id=None