dbrownell-parserlib 0.2.0__tar.gz → 0.4.0__tar.gz

{dbrownell_parserlib-0.2.0 → dbrownell_parserlib-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dbrownell-parserlib
-Version: 0.2.0
+Version: 0.4.0
 Summary: Functionality useful when creating parsers.
 Author: Dave Brownell
 Author-email: Dave Brownell <github@DavidBrownell.com>

{dbrownell_parserlib-0.2.0 → dbrownell_parserlib-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dbrownell-parserlib"
-version = "0.2.0"
+version = "0.4.0"
 #          ^^^^^
 # Wheel names will be generated according to this value. Do not manually modify this value; instead
 # update it according to committed changes by running this command from the root of the repository:

{dbrownell_parserlib-0.2.0 → dbrownell_parserlib-0.4.0}/src/dbrownell_ParserLib/__init__.py

@@ -2,12 +2,16 @@
 
 from importlib.metadata import version
 
+from dbrownell_ParserLib.errors import Error, PythonError
 from dbrownell_ParserLib.location import Location
-
+from dbrownell_ParserLib.region import Region
 
 # ----------------------------------------------------------------------
 __all__ = [
+    "Error",
     "Location",
+    "PythonError",
+    "Region",
     "__version__",
 ]
 

dbrownell_parserlib-0.4.0/src/dbrownell_ParserLib/errors.py

@@ -0,0 +1,112 @@
+"""Contains functionality associated with errors and exceptions."""
+
+import re
+import textwrap
+import traceback
+
+from dataclasses import dataclass, field, InitVar
+from functools import cached_property
+from io import StringIO
+from pathlib import Path
+from typing import Self
+
+from dbrownell_ParserLib.region import Location, Region
+
+
+# ----------------------------------------------------------------------
+@dataclass(frozen=True)
+class Error:
+    """Base class for all errors generated by this library."""
+
+    # ----------------------------------------------------------------------
+    message: str
+
+    region_or_regions: InitVar[Region | list[Region]]
+    regions: list[Region] = field(init=False)
+
+    # ----------------------------------------------------------------------
+    def __post_init__(self, region_or_regions: Region | list[Region]) -> None:
+        regions = [region_or_regions] if isinstance(region_or_regions, Region) else region_or_regions
+
+        if not regions:
+            msg = "At least one region must be provided"
+            raise ValueError(msg)
+
+        object.__setattr__(self, "regions", regions)
+
+    # ----------------------------------------------------------------------
+    def __str__(self) -> str:
+        return self._string
+
+    # ----------------------------------------------------------------------
+    # ----------------------------------------------------------------------
+    # ----------------------------------------------------------------------
+    @cached_property
+    def _string(self) -> str:
+        if len(self.regions) == 1 and "\n" not in self.message:
+            return f"{self.message} ({self.regions[0]})"
+
+        return textwrap.dedent(
+            """\
+            {}
+
+            {}
+            """,
+        ).format(self.message.rstrip(), "\n".join(f"    - {region}" for region in self.regions))
+
+
+# ----------------------------------------------------------------------
+@dataclass(frozen=True)
+class PythonError(Error):
+    """An `Error` based on a Python exception."""
+
+    # ----------------------------------------------------------------------
+    ex: Exception
+
+    # ----------------------------------------------------------------------
+    @classmethod
+    def Create(
+        cls,
+        ex: Exception,
+    ) -> Self:
+        """Create a `PythonError` from a Python exception."""
+
+        regions: list[Region] = []
+
+        # I haven't been able to find a reliable way to get the exception's callstack so it is being
+        # parsed manually here. There has got to be a better way to do this.
+        sink = StringIO()
+
+        traceback.print_exception(ex, file=sink)
+        sink_str = sink.getvalue()
+
+        regex = re.compile(r"^\s*File \"(?P<filename>.+?)\", line (?P<line>\d+),.+$", re.MULTILINE)
+
+        for line in sink_str.splitlines():
+            match = regex.match(line)
+            if not match:
+                continue
+
+            line_number = int(match.group("line"))
+
+            regions.append(
+                Region(
+                    Path(match.group("filename")),
+                    Location(line_number, 1),
+                    Location(line_number, 1),
+                ),
+            )
+
+        regions.reverse()
+
+        return cls(
+            textwrap.dedent(
+                """\
+                Python Exception
+                ----------------
+                {}
+                """,
+            ).format(str(ex)),
+            regions,
+            ex,
+        )

dbrownell_parserlib-0.4.0/src/dbrownell_ParserLib/region.py

@@ -0,0 +1,112 @@
+# noqa: D100
+import inspect
+
+from dataclasses import dataclass
+from functools import cached_property
+from pathlib import Path
+from typing import Self
+
+from dbrownell_ParserLib.location import Location
+
+
+# ----------------------------------------------------------------------
+@dataclass(frozen=True)
+class Region:
+    """A region within a source file."""
+
+    # ----------------------------------------------------------------------
+    filename: Path
+    begin: Location
+    end: Location
+
+    # ----------------------------------------------------------------------
+    @classmethod
+    def CreateFromCode(
+        cls,
+        *,
+        callstack_offset: int = 0,
+    ) -> Self:
+        """Create a `Region` from the current code location."""
+
+        frame = inspect.stack()[callstack_offset + 1][0]
+        location = Location(frame.f_lineno, frame.f_lineno)
+
+        return cls(Path(frame.f_code.co_filename), location, location)
+
+    # ----------------------------------------------------------------------
+    def __post_init__(self) -> None:
+        if self.end < self.begin:
+            msg = "Invalid region"
+            raise ValueError(msg)
+
+    # ----------------------------------------------------------------------
+    def __str__(self) -> str:
+        return self._string
+
+    # ----------------------------------------------------------------------
+    @staticmethod
+    def Compare(
+        this: Region,
+        that: Region,
+    ) -> int:
+        """Compare two `Region` instances."""
+
+        if this.filename != that.filename:
+            return -1 if this.filename < that.filename else 1
+
+        result = Location.Compare(this.begin, that.begin)
+        if result != 0:
+            return result
+
+        result = Location.Compare(this.end, that.end)
+        if result != 0:
+            return result
+
+        return 0
+
+    # ----------------------------------------------------------------------
+    def __hash__(self) -> int:
+        return hash((self.filename, self.begin, self.end))
+
+    def __eq__(self, other: object) -> bool:
+        return isinstance(other, Region) and self.__class__.Compare(self, other) == 0
+
+    def __ne__(self, other: object) -> bool:
+        return not isinstance(other, Region) or self.__class__.Compare(self, other) != 0
+
+    def __lt__(self, other: object) -> bool:
+        return isinstance(other, Region) and self.__class__.Compare(self, other) < 0
+
+    def __le__(self, other: object) -> bool:
+        return isinstance(other, Region) and self.__class__.Compare(self, other) <= 0
+
+    def __gt__(self, other: object) -> bool:
+        return isinstance(other, Region) and self.__class__.Compare(self, other) > 0
+
+    def __ge__(self, other: object) -> bool:
+        return isinstance(other, Region) and self.__class__.Compare(self, other) >= 0
+
+    # ----------------------------------------------------------------------
+    def __contains__(
+        self,
+        location_or_region: Location | Region,
+    ) -> bool:
+        if isinstance(location_or_region, Location):
+            return self.begin <= location_or_region <= self.end
+
+        region = location_or_region
+
+        if self.filename != region.filename:
+            return False
+
+        return self.begin <= region.begin and region.end <= self.end
+
+    # ----------------------------------------------------------------------
+    # ----------------------------------------------------------------------
+    # ----------------------------------------------------------------------
+    @cached_property
+    def _string(self) -> str:
+        if self.end == self.begin:
+            return f"{self.filename.as_posix()}, {self.begin}"
+
+        return f"{self.filename.as_posix()}, {self.begin} - {self.end}"