dbrownell-parserlib 0.9.0__tar.gz → 0.10.0__tar.gz

{dbrownell_parserlib-0.9.0 → dbrownell_parserlib-0.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dbrownell-parserlib
-Version: 0.9.0
+Version: 0.10.0
 Summary: Functionality useful when creating parsers.
 Author: Dave Brownell
 Author-email: Dave Brownell <github@DavidBrownell.com>
@@ -85,7 +85,7 @@ Use `BuildAntlrGrammar` to generate the lexer and parser:
 ```python
 from pathlib import Path
 
-from dbrownell_ParserLib import BuildAntlrGrammar
+from dbrownell_ParserLib.antlr.build_antlr_grammar import BuildAntlrGrammar
 
 
 BuildAntlrGrammar(
@@ -101,11 +101,9 @@ Implement a visitor that converts ANTLR parse trees to Expression objects:
 ```python
 from dataclasses import dataclass
 
-from dbrownell_ParserLib import (
-    Expression,
-    InsignificantWhitespaceAntlrVisitorMixin,
-    TerminalExpression,
-)
+from dbrownell_ParserLib.antlr.antlr_visitor_mixins import InsignificantWhitespaceAntlrVisitorMixin
+from dbrownell_ParserLib.expression import Expression
+from dbrownell_ParserLib.terminal_expression import TerminalExpression
 
 from CalculatorVisitor import CalculatorVisitor as GeneratedVisitor
 
@@ -147,7 +145,7 @@ class CalculatorVisitor(InsignificantWhitespaceAntlrVisitorMixin, GeneratedVisit
 Use `CreateAntlrParser` to build a callable parser:
 
 ```python
-from dbrownell_ParserLib import CreateAntlrParser
+from dbrownell_ParserLib.antlr.antlr_parser import CreateAntlrParser
 
 
 parser = CreateAntlrParser(
@@ -162,7 +160,7 @@ parser = CreateAntlrParser(
 Parse single files, multiple files, or entire workspaces:
 
 ```python
-from dbrownell_ParserLib import Error
+from dbrownell_ParserLib.errors import Error
 
 
 # Parse a single file
@@ -187,7 +185,7 @@ Use the visitor pattern to process your AST:
 ```python
 from contextlib import contextmanager
 
-from dbrownell_ParserLib import ExpressionVisitorHelper, VisitResult
+from dbrownell_ParserLib.visitors import ExpressionVisitorHelper, VisitResult
 
 
 class EvaluatorVisitor(ExpressionVisitorHelper):

{dbrownell_parserlib-0.9.0 → dbrownell_parserlib-0.10.0}/README.md

@@ -63,7 +63,7 @@ Use `BuildAntlrGrammar` to generate the lexer and parser:
 ```python
 from pathlib import Path
 
-from dbrownell_ParserLib import BuildAntlrGrammar
+from dbrownell_ParserLib.antlr.build_antlr_grammar import BuildAntlrGrammar
 
 
 BuildAntlrGrammar(
@@ -79,11 +79,9 @@ Implement a visitor that converts ANTLR parse trees to Expression objects:
 ```python
 from dataclasses import dataclass
 
-from dbrownell_ParserLib import (
-    Expression,
-    InsignificantWhitespaceAntlrVisitorMixin,
-    TerminalExpression,
-)
+from dbrownell_ParserLib.antlr.antlr_visitor_mixins import InsignificantWhitespaceAntlrVisitorMixin
+from dbrownell_ParserLib.expression import Expression
+from dbrownell_ParserLib.terminal_expression import TerminalExpression
 
 from CalculatorVisitor import CalculatorVisitor as GeneratedVisitor
 
@@ -125,7 +123,7 @@ class CalculatorVisitor(InsignificantWhitespaceAntlrVisitorMixin, GeneratedVisit
 Use `CreateAntlrParser` to build a callable parser:
 
 ```python
-from dbrownell_ParserLib import CreateAntlrParser
+from dbrownell_ParserLib.antlr.antlr_parser import CreateAntlrParser
 
 
 parser = CreateAntlrParser(
@@ -140,7 +138,7 @@ parser = CreateAntlrParser(
 Parse single files, multiple files, or entire workspaces:
 
 ```python
-from dbrownell_ParserLib import Error
+from dbrownell_ParserLib.errors import Error
 
 
 # Parse a single file
@@ -165,7 +163,7 @@ Use the visitor pattern to process your AST:
 ```python
 from contextlib import contextmanager
 
-from dbrownell_ParserLib import ExpressionVisitorHelper, VisitResult
+from dbrownell_ParserLib.visitors import ExpressionVisitorHelper, VisitResult
 
 
 class EvaluatorVisitor(ExpressionVisitorHelper):

{dbrownell_parserlib-0.9.0 → dbrownell_parserlib-0.10.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dbrownell-parserlib"
-version = "0.9.0"
+version = "0.10.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.10.0/src/dbrownell_ParserLib/__init__.py

@@ -0,0 +1,6 @@
+# noqa: D104
+
+from importlib.metadata import version
+
+
+__version__ = version("dbrownell_ParserLib")

dbrownell_parserlib-0.10.0/src/dbrownell_ParserLib/antlr/__init__.py

@@ -0,0 +1 @@
+# noqa: D104

dbrownell_parserlib-0.10.0/src/dbrownell_ParserLib/multiline_strings.py

@@ -0,0 +1,124 @@
+"""Functionality used when parsing multiline strings."""
+
+from dataclasses import dataclass
+
+from dbrownell_ParserLib.errors import CreateErrorType
+from dbrownell_ParserLib.region import Location, Region
+
+
+# ----------------------------------------------------------------------
+MisalignedMultilineStringError = CreateErrorType(
+    "All lines in a multiline string must be vertically aligned with the opening token."
+)
+
+
+# ----------------------------------------------------------------------
+def ExtractMultilineString(
+    content: str,
+    opening_token_region: Region,
+    opening_token: str = '"""',  # noqa: S107
+    closing_token: str = '"""',  # noqa: S107
+    tab_size: int = 4,
+) -> str:
+    """Extract a multiline string from the given content, ensuring that all lines are vertically aligned with the opening token."""
+
+    assert content.startswith(opening_token), content
+    content = content[len(opening_token) :]
+
+    assert content.endswith(closing_token), content
+    content = content[: -len(closing_token)]
+
+    lines = content.splitlines()
+
+    # Handle the special case where the multiline string begins at column 1. In this case, the content
+    # should end with a newline.
+    if content.endswith("\n") and opening_token_region.begin.column == 1:
+        lines.append("")
+
+    # Ensure that there is a newline immediately following the opening token
+    if lines[0]:
+        # This means that there was content immediately following the opening token when a newline was expected.
+        location = Location(
+            opening_token_region.begin.line,
+            opening_token_region.begin.column + len(opening_token),
+        )
+
+        raise MisalignedMultilineStringError.CreateAsException(
+            Region(opening_token_region.filename, location, location)
+        )
+
+    lines = lines[1:]
+    assert lines
+
+    # Ensure that the closing token is on its own line
+    result = _CalcPrefixColumn(lines[-1], tab_size, None)
+
+    if result.column != opening_token_region.begin.column:
+        location = Location(opening_token_region.begin.line + len(lines) + 1, result.column)
+
+        raise MisalignedMultilineStringError.CreateAsException(
+            Region(opening_token_region.filename, location, location)
+        )
+
+    lines = lines[:-1]
+
+    # Process the content
+    acceptable_prefix_column_values = {1, opening_token_region.begin.column}
+    escaped_closing_token = "".join(f"\\{c}" for c in closing_token)
+
+    # Ensure that all lines are vertically aligned with the opening token
+    for line_index, line in enumerate(lines):
+        result = _CalcPrefixColumn(line, tab_size, opening_token_region.begin.column)
+
+        if result.column not in acceptable_prefix_column_values:
+            location = Location(opening_token_region.begin.line + line_index + 1, result.column)
+
+            raise MisalignedMultilineStringError.CreateAsException(
+                Region(opening_token_region.filename, location, location)
+            )
+
+        normalized_line = line[result.num_chars :]
+
+        if normalized_line.isspace():
+            normalized_line = ""
+        else:
+            normalized_line = normalized_line.replace(escaped_closing_token, closing_token)
+
+        lines[line_index] = normalized_line
+
+    # Handle the special case where the multiline string consists of all newlines
+    if lines and all(not line for line in lines):
+        return "".join("\n" * len(lines))
+
+    return "\n".join(lines)
+
+
+# ----------------------------------------------------------------------
+# ----------------------------------------------------------------------
+# ----------------------------------------------------------------------
+@dataclass(frozen=True)
+class _CalcPrefixColumnResult:
+    column: int
+    num_chars: int
+
+
+def _CalcPrefixColumn(line: str, tab_size: int, max_column: int | None) -> _CalcPrefixColumnResult:
+    max_column = max_column or 99999999
+
+    column = 1
+    num_chars = 0
+
+    for char in line:
+        if column >= max_column:
+            break
+
+        if char == " ":
+            column += 1
+        elif char == "\t":
+            column += tab_size
+        else:
+            break
+
+        num_chars += 1
+
+    return _CalcPrefixColumnResult(column, num_chars)

dbrownell_parserlib-0.9.0/src/dbrownell_ParserLib/__init__.py

@@ -1,44 +0,0 @@
-# noqa: D104
-
-from importlib.metadata import version
-
-from dbrownell_ParserLib.antlr import (
-    AntlrParser,
-    AntlrVisitorMixinBase,
-    BuildAntlrGrammar,
-    CreateAntlrParser,
-    InsignificantWhitespaceAntlrVisitorMixin,
-    SignificantWhitespaceAntlrVisitorMixin,
-)
-from dbrownell_ParserLib.errors import CreateErrorType, Error, ErrorException, PythonError
-from dbrownell_ParserLib.expression import Expression
-from dbrownell_ParserLib.location import Location
-from dbrownell_ParserLib.region import Region
-from dbrownell_ParserLib.terminal_expression import TerminalExpression
-from dbrownell_ParserLib.visitors import ExpressionVisitor, ExpressionVisitorHelper, VisitResult
-
-
-# ----------------------------------------------------------------------
-__all__ = [
-    "AntlrParser",
-    "AntlrVisitorMixinBase",
-    "BuildAntlrGrammar",
-    "CreateAntlrParser",
-    "CreateErrorType",
-    "Error",
-    "ErrorException",
-    "Expression",
-    "ExpressionVisitor",
-    "ExpressionVisitorHelper",
-    "InsignificantWhitespaceAntlrVisitorMixin",
-    "Location",
-    "PythonError",
-    "Region",
-    "SignificantWhitespaceAntlrVisitorMixin",
-    "TerminalExpression",
-    "VisitResult",
-    "__version__",
-]
-
-
-__version__ = version("dbrownell_ParserLib")

dbrownell_parserlib-0.9.0/src/dbrownell_ParserLib/antlr/__init__.py

@@ -1,19 +0,0 @@
-# noqa: D104
-from dbrownell_ParserLib.antlr.build_antlr_grammar import BuildAntlrGrammar
-from dbrownell_ParserLib.antlr.antlr_parser import AntlrParser, CreateAntlrParser
-from dbrownell_ParserLib.antlr.antlr_visitor_mixins import (
-    AntlrVisitorMixinBase,
-    InsignificantWhitespaceAntlrVisitorMixin,
-    SignificantWhitespaceAntlrVisitorMixin,
-)
-
-
-# ----------------------------------------------------------------------
-__all__ = [
-    "AntlrParser",
-    "AntlrVisitorMixinBase",
-    "BuildAntlrGrammar",
-    "CreateAntlrParser",
-    "InsignificantWhitespaceAntlrVisitorMixin",
-    "SignificantWhitespaceAntlrVisitorMixin",
-]