Add mypy types

Author: woojiahao

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "difflib-parser"
-version = "1.0.0"
+version = "1.2.0"
 authors = [{ name = "Jiahao, Woo", email = "woojiahao1234@gmail.com" }]
 description = "Lightweight Python package for parsing Python difflib's diff results"
 readme = "README.md"

requirements.txt

@@ -1 +1,4 @@
-pytest
+pytest
+twine
+build
+mypy

src/difflib_parser/diff_line.py

@@ -11,7 +11,6 @@ class DiffLineCode(Enum):
 class DiffLine:
     def __init__(self, line: str | None):
         self.__line = line
-        print(self.__line)
 
     @staticmethod
     def parse(line: str | None) -> "DiffLine":
@@ -32,6 +31,8 @@ def code(self) -> DiffLineCode | None:
             case "? ":
                 return DiffLineCode.MISSING
 
+        return None
+
     @property
     def line(self) -> str | None:
         if self.__line is None:

src/difflib_parser/diff_line.pyi

@@ -0,0 +1,16 @@
+from enum import Enum
+
+class DiffLineCode(Enum):
+    ADDED = 0
+    REMOVED = 1
+    COMMON = 2
+    MISSING = 3
+
+class DiffLine:
+    def __init__(self, line: str | None) -> None: ...
+    @staticmethod
+    def parse(line: str | None) -> DiffLine: ...
+    @property
+    def code(self) -> DiffLineCode | None: ...
+    @property
+    def line(self) -> str | None: ...

src/difflib_parser/difflib_parser.py

@@ -1,7 +1,7 @@
-from typing import List, Generator, Any
 import difflib
-from enum import Enum
 from dataclasses import dataclass
+from enum import Enum
+from typing import Iterator, List
 
 from difflib_parser.diff_line import DiffLine, DiffLineCode
 
@@ -38,10 +38,13 @@ def __init__(self, left_text: List[str], right_text: List[str]):
         self.__diff = list(difflib.ndiff(self.__left_text, self.__right_text))
         self.__line_no = 0
 
-    def iter_diffs(self) -> Generator[Diff, Any, Any]:
+    def iter_diffs(self) -> Iterator[Diff]:
+        current_line = self.__diff[self.__line_no]
         while self.__line_no < len(self.__diff):
-            current_line = self.__diff[self.__line_no]
             diff_line = DiffLine.parse(current_line)
+            if diff_line.line is None:
+                self.__line_no += 1
+                continue
             code = diff_line.code
             diff = Diff(code=DiffCode.SAME, line=diff_line.line)
 
@@ -78,11 +81,13 @@ def __get_incremental_change(self, line_no: int) -> DiffChange | None:
             DiffLineCode.ADDED,
             DiffLineCode.MISSING,
         ]
+        # We can ignore all of these lines because we know that a None line would have
+        # been skipped
         if self.__match_pattern(lines, pattern_a):
             return DiffChange(
-                left=[i for (i, c) in enumerate(b.line) if c in ["-", "^"]],
-                right=[i for (i, c) in enumerate(d.line) if c in ["+", "^"]],
-                newline=c.line,
+                left=[i for (i, c) in enumerate(b.line) if c in ["-", "^"]],  # type: ignore
+                right=[i for (i, c) in enumerate(d.line) if c in ["+", "^"]],  # type: ignore
+                newline=c.line,  # type: ignore
                 skip_lines=3,
             )
 
@@ -91,18 +96,18 @@ def __get_incremental_change(self, line_no: int) -> DiffChange | None:
         if self.__match_pattern(lines, pattern_b):
             return DiffChange(
                 left=[],
-                right=[i for (i, c) in enumerate(c.line) if c in ["+", "^"]],
-                newline=b.line,
+                right=[i for (i, c) in enumerate(c.line) if c in ["+", "^"]],  # type: ignore
+                newline=b.line,  # type: ignore
                 skip_lines=2,
             )
 
         # This represents the case where only removals are present in the edit
         pattern_c = [DiffLineCode.REMOVED, DiffLineCode.MISSING, DiffLineCode.ADDED]
         if self.__match_pattern(lines, pattern_c):
             return DiffChange(
-                left=[i for (i, c) in enumerate(b.line) if c in ["-", "^"]],
+                left=[i for (i, c) in enumerate(b.line) if c in ["-", "^"]],  # type: ignore
                 right=[],
-                newline=c.line,
+                newline=c.line,  # type: ignore
                 skip_lines=2,
             )
 

src/difflib_parser/difflib_parser.pyi

@@ -0,0 +1,31 @@
+from dataclasses import dataclass
+from difflib_parser.diff_line import DiffLine as DiffLine, DiffLineCode as DiffLineCode
+from enum import Enum
+from typing import Iterator
+
+class DiffCode(Enum):
+    SAME = 0
+    RIGHT_ONLY = 1
+    LEFT_ONLY = 2
+    CHANGED = 3
+
+@dataclass
+class DiffChange:
+    left: list[int]
+    right: list[int]
+    newline: str
+    skip_lines: int
+    def __init__(self, left, right, newline, skip_lines) -> None: ...
+
+@dataclass
+class Diff:
+    code: DiffCode
+    line: str
+    left_changes: list[int] | None = ...
+    right_changes: list[int] | None = ...
+    newline: str | None = ...
+    def __init__(self, code, line, left_changes=..., right_changes=..., newline=...) -> None: ...
+
+class DiffParser:
+    def __init__(self, left_text: list[str], right_text: list[str]) -> None: ...
+    def iter_diffs(self) -> Iterator[Diff]: ...