Reorganize classes

Author: woojiahao

src/difflib_parser/__init__.py

@@ -0,0 +1,4 @@
+__all__ = ["DifflibParser", "DiffCode", "Diff"]
+
+from .diff_code import DiffCode
+from .difflib_parser import DifflibParser, Diff

src/difflib_parser/diff.py

@@ -0,0 +1,13 @@
+from dataclasses import dataclass
+from typing import List, Optional
+
+from difflib_parser.diff_code import DiffCode
+
+
+@dataclass
+class Diff:
+    code: DiffCode
+    line: str
+    left_changes: Optional[List[int]] = None
+    right_changes: Optional[List[int]] = None
+    newline: Optional[str] = None

src/difflib_parser/diff_change.py

@@ -0,0 +1,10 @@
+from dataclasses import dataclass
+from typing import List
+
+
+@dataclass
+class DiffChange:
+    left: List[int]
+    right: List[int]
+    newline: str
+    skip_lines: int

src/difflib_parser/diff_code.py

@@ -0,0 +1,8 @@
+from enum import Enum
+
+
+class DiffCode(Enum):
+    SAME = 0
+    RIGHT_ONLY = 1
+    LEFT_ONLY = 2
+    CHANGED = 3

src/difflib_parser/diff_line.py

@@ -1,11 +1,4 @@
-from enum import Enum
-
-
-class DiffLineCode(Enum):
-    ADDED = 0
-    REMOVED = 1
-    COMMON = 2
-    MISSING = 3
+from difflib_parser.diff_line_code import DiffLineCode
 
 
 class DiffLine:

src/difflib_parser/diff_line_code.py

@@ -0,0 +1,8 @@
+from enum import Enum
+
+
+class DiffLineCode(Enum):
+    ADDED = 0
+    REMOVED = 1
+    COMMON = 2
+    MISSING = 3

src/difflib_parser/difflib_parser.py

@@ -1,67 +1,45 @@
 import difflib
-from dataclasses import dataclass
-from enum import Enum
 from typing import Iterator, List
 
-from difflib_parser.diff_line import DiffLine, DiffLineCode
-
-
-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
-
-
-@dataclass
-class Diff:
-    code: DiffCode
-    line: str
-    left_changes: List[int] | None = None
-    right_changes: List[int] | None = None
-    newline: str | None = None
+from difflib_parser.diff import Diff
+from difflib_parser.diff_change import DiffChange
+from difflib_parser.diff_code import DiffCode
+from difflib_parser.diff_line import DiffLine
+from difflib_parser.diff_line_code import DiffLineCode
 
 
 # Parser inspired by https://github.com/yebrahim/difflibparser/blob/master/difflibparser.py
-class DiffParser:
+class DifflibParser:
     def __init__(self, left_text: List[str], right_text: List[str]):
         self.__left_text = left_text
         self.__right_text = right_text
         self.__diff = list(difflib.ndiff(self.__left_text, self.__right_text))
-        self.__line_no = 0
 
     def iter_diffs(self) -> Iterator[Diff]:
-        while self.__line_no < len(self.__diff):
-            current_line = self.__diff[self.__line_no]
+        line_no = 0
+        while line_no < len(self.__diff):
+            current_line = self.__diff[line_no]
             diff_line = DiffLine.parse(current_line)
             if diff_line.line is None:
-                self.__line_no += 1
+                line_no += 1
                 continue
             code = diff_line.code
             diff = Diff(code=DiffCode.SAME, line=diff_line.line)
 
             if code == DiffLineCode.ADDED:
                 diff.code = DiffCode.RIGHT_ONLY
             elif code == DiffLineCode.REMOVED:
-                change = self.__get_incremental_change(self.__line_no)
+                change = self.__get_incremental_change(line_no)
                 if change is None:
                     diff.code = DiffCode.LEFT_ONLY
                 else:
                     diff.code = DiffCode.CHANGED
                     diff.left_changes = change.left
                     diff.right_changes = change.right
                     diff.newline = change.newline
-                    self.__line_no = change.skip_lines
+                    line_no = change.skip_lines
 
-            self.__line_no += 1
+            line_no += 1
             yield diff
 
     def __get_incremental_change(self, line_no: int) -> DiffChange | None:

test/test_difflib_parser.py

@@ -2,26 +2,26 @@
 
 
 def test_diff_parser_same_lines():
-    parser = difflib_parser.DiffParser(["Hello world"], ["Hello world"])
+    parser = difflib_parser.DifflibParser(["Hello world"], ["Hello world"])
     for diff in parser.iter_diffs():
         assert diff.code == difflib_parser.DiffCode.SAME
 
 
 def test_diff_parser_added_line():
-    parser = difflib_parser.DiffParser([], ["Hello world"])
+    parser = difflib_parser.DifflibParser([], ["Hello world"])
     for diff in parser.iter_diffs():
         assert diff.code == difflib_parser.DiffCode.RIGHT_ONLY
 
 
 def test_diff_parser_removed_line():
-    parser = difflib_parser.DiffParser(["Hello world"], [])
+    parser = difflib_parser.DifflibParser(["Hello world"], [])
     for diff in parser.iter_diffs():
         assert diff.code == difflib_parser.DiffCode.LEFT_ONLY
 
 
 def test_diff_parser_changed_line_pattern_a():
     # Pattern a essentially looks at the case where existing characters were added/removed
-    parser = difflib_parser.DiffParser(["Hello world"], ["Hola world"])
+    parser = difflib_parser.DifflibParser(["Hello world"], ["Hola world"])
     for diff in parser.iter_diffs():
         assert diff.code == difflib_parser.DiffCode.CHANGED
         assert diff.line == "Hello world"
@@ -32,7 +32,7 @@ def test_diff_parser_changed_line_pattern_a():
 
 def test_diff_parser_changed_line_pattern_b():
     # Pattern b essentially looks at the case where only additions were included
-    parser = difflib_parser.DiffParser(["Hello world"], ["Hello world!"])
+    parser = difflib_parser.DifflibParser(["Hello world"], ["Hello world!"])
     for diff in parser.iter_diffs():
         assert diff.code == difflib_parser.DiffCode.CHANGED
         assert diff.line == "Hello world"
@@ -43,7 +43,7 @@ def test_diff_parser_changed_line_pattern_b():
 
 def test_diff_parser_changed_line_pattern_c():
     # Pattern c essentially looks at the case where only removals were included
-    parser = difflib_parser.DiffParser(["Hello world"], ["Hello worl"])
+    parser = difflib_parser.DifflibParser(["Hello world"], ["Hello worl"])
     for diff in parser.iter_diffs():
         assert diff.code == difflib_parser.DiffCode.CHANGED
         assert diff.line == "Hello world"