cyberark-tpc-plugin-parser 0.4.0__tar.gz → 0.4.2__tar.gz

{cyberark_tpc_plugin_parser-0.4.0 → cyberark_tpc_plugin_parser-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cyberark-tpc-plugin-parser
-Version: 0.4.0
+Version: 0.4.2
 Summary: A package to help parse CyberArk TPC plugin prompts and process files.
 Author-email: Peter McDonald <git@petermcdonald.co.uk>
 License: MIT License
@@ -31,14 +31,14 @@ Project-URL: issues, https://github.com/petermcd/CyberArk-TPC-Plugin-Parser/issu
 Keywords: cyberark,parser,tpc
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: 3.15
+Classifier: Programming Language :: Python :: 3.16
 Classifier: Topic :: Software Development :: Testing
 Classifier: Typing :: Typed
-Requires-Python: >=3.11
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Dynamic: license-file
@@ -67,10 +67,10 @@ files as arguments:
 ```python
 from tpc_plugin_parser.parser import Parser
 
-with open('/path/to/files/process.ini') as process_fh:
+with open("/path/to/files/process.ini") as process_fh:
     process_content: str = process_fh.read()
-    
-with open('/path/to/files/prompts.ini') as prompts_fh:
+
+with open("/path/to/files/prompts.ini") as prompts_fh:
     prompts_content: str = prompts_fh.read()
 
 parser: Parser = Parser(process_file=process_content, prompts_file=prompts_content)

{cyberark_tpc_plugin_parser-0.4.0 → cyberark_tpc_plugin_parser-0.4.2}/README.md

@@ -22,10 +22,10 @@ files as arguments:
 ```python
 from tpc_plugin_parser.parser import Parser
 
-with open('/path/to/files/process.ini') as process_fh:
+with open("/path/to/files/process.ini") as process_fh:
     process_content: str = process_fh.read()
-    
-with open('/path/to/files/prompts.ini') as prompts_fh:
+
+with open("/path/to/files/prompts.ini") as prompts_fh:
     prompts_content: str = prompts_fh.read()
 
 parser: Parser = Parser(process_file=process_content, prompts_file=prompts_content)

{cyberark_tpc_plugin_parser-0.4.0 → cyberark_tpc_plugin_parser-0.4.2}/cyberark_tpc_plugin_parser.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cyberark-tpc-plugin-parser
-Version: 0.4.0
+Version: 0.4.2
 Summary: A package to help parse CyberArk TPC plugin prompts and process files.
 Author-email: Peter McDonald <git@petermcdonald.co.uk>
 License: MIT License
@@ -31,14 +31,14 @@ Project-URL: issues, https://github.com/petermcd/CyberArk-TPC-Plugin-Parser/issu
 Keywords: cyberark,parser,tpc
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: 3.15
+Classifier: Programming Language :: Python :: 3.16
 Classifier: Topic :: Software Development :: Testing
 Classifier: Typing :: Typed
-Requires-Python: >=3.11
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Dynamic: license-file
@@ -67,10 +67,10 @@ files as arguments:
 ```python
 from tpc_plugin_parser.parser import Parser
 
-with open('/path/to/files/process.ini') as process_fh:
+with open("/path/to/files/process.ini") as process_fh:
     process_content: str = process_fh.read()
-    
-with open('/path/to/files/prompts.ini') as prompts_fh:
+
+with open("/path/to/files/prompts.ini") as prompts_fh:
     prompts_content: str = prompts_fh.read()
 
 parser: Parser = Parser(process_file=process_content, prompts_file=prompts_content)

{cyberark_tpc_plugin_parser-0.4.0 → cyberark_tpc_plugin_parser-0.4.2}/cyberark_tpc_plugin_parser.egg-info/SOURCES.txt

@@ -7,7 +7,7 @@ cyberark_tpc_plugin_parser.egg-info/dependency_links.txt
 cyberark_tpc_plugin_parser.egg-info/top_level.txt
 tests/test_lexer.py
 tests/test_parser.py
-tpc_plugin_parser/__init__..py
+tpc_plugin_parser/__init__.py
 tpc_plugin_parser/parser.py
 tpc_plugin_parser/lexer/__init__.py
 tpc_plugin_parser/lexer/lexer.py

{cyberark_tpc_plugin_parser-0.4.0 → cyberark_tpc_plugin_parser-0.4.2}/pyproject.toml

@@ -1,21 +1,21 @@
 [project]
 name = "cyberark-tpc-plugin-parser"
-version = "0.4.0"
+version = "0.4.2"
 description = "A package to help parse CyberArk TPC plugin prompts and process files."
 keywords = ["cyberark", "parser", "tpc"]
 authors = [{ name = "Peter McDonald", email = "git@petermcdonald.co.uk"}]
 readme = "README.md"
 license = { file = "LICENSE" }
-requires-python = ">=3.11"
+requires-python = ">=3.12"
 
 classifiers = [
     "Intended Audience :: Developers",
     "Programming Language :: Python",
-    "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3.14",
     "Programming Language :: Python :: 3.15",
+    "Programming Language :: Python :: 3.16",
     "Topic :: Software Development :: Testing",
     "Typing :: Typed",
 ]
@@ -29,13 +29,9 @@ issues = "https://github.com/petermcd/CyberArk-TPC-Plugin-Parser/issues"
 
 [dependency-groups]
 dev = [
-    "pip-audit>=2.9.0",
-    "pygments>=2.20.0",
-    "pytest>=9.0.3",
-    "pytest-cov>=7.0.0",
-    "ruff>=0.13.0",
-    "troml>=0.4.1",
-    "ty>=0.0.1a20",
+    "pygments>=2.21.0",
+    "pytest>=9.1.1",
+    "pytest-cov>=7.1.0",
 ]
 
 [tool.pytest.ini_options]
@@ -43,3 +39,12 @@ addopts = "--cov=tpc_plugin_parser --cov-report term-missing --cov-report xml:co
 
 [tool.ruff]
 line-length = 120
+
+[cosmic-ray]
+module-path = "tpc_plugin_parser"
+timeout = 10.0
+excluded-modules = []
+test-command = "uv run pytest"
+
+[cosmic-ray.distributor]
+name = "local"

{cyberark_tpc_plugin_parser-0.4.0 → cyberark_tpc_plugin_parser-0.4.2}/tests/test_lexer.py

@@ -1,7 +1,8 @@
 """Test the lexer."""
 
 import pytest
-from tpc_plugin_parser.lexer.lexer import Lexer, _MAX_SOURCE_BYTES
+
+from tpc_plugin_parser.lexer.lexer import _MAX_SOURCE_BYTES, Lexer
 from tpc_plugin_parser.lexer.tokens.assignment import Assignment
 from tpc_plugin_parser.lexer.tokens.comment import Comment
 from tpc_plugin_parser.lexer.tokens.cpm_parameter_validation import CPMParameterValidation
@@ -10,9 +11,10 @@ from tpc_plugin_parser.lexer.tokens.parse_error import ParseError
 from tpc_plugin_parser.lexer.tokens.section_header import SectionHeader
 from tpc_plugin_parser.lexer.tokens.transition import Transition
 from tpc_plugin_parser.lexer.utilities.token_name import TokenName
+from tpc_plugin_parser.lexer.utilities.types import ALL_TOKEN_TYPES
 
 
-class TestLexer(object):
+class TestLexer:
     """Test the lexer."""
 
     @pytest.mark.parametrize(
@@ -257,8 +259,9 @@ class TestLexer(object):
         """
         lex: Lexer = Lexer(source=line)
         lex.process()
-        found_tokens = lex.tokens
+        found_tokens: list[tuple[TokenName, ALL_TOKEN_TYPES]] = lex.tokens
         assert len(found_tokens) == len(expected_tokens)
+        assert isinstance(found_tokens[0][1], ParseError)
         assert found_tokens[0][1].content == expected_tokens[0].content
         assert found_tokens[0][1].line_number == expected_tokens[0].line_number
 
@@ -271,4 +274,4 @@ class TestLexer(object):
     def test_fail_state_code_out_of_range_raises(self) -> None:
         """Test that a fail-state error code outside 0–65535 raises ValueError."""
         with pytest.raises(ValueError, match="valid range"):
-            Lexer(source="state=fail(message, 65536)").tokens
+            _ = Lexer(source="state=fail(message, 65536)").tokens

{cyberark_tpc_plugin_parser-0.4.0 → cyberark_tpc_plugin_parser-0.4.2}/tests/test_parser.py

@@ -1,10 +1,11 @@
 """Test the parser."""
 
 import pytest
+
 from tpc_plugin_parser.parser import Parser
 
 
-class TestParser(object):
+class TestParser:
     """Test the lexer."""
 
     @pytest.mark.parametrize(

{cyberark_tpc_plugin_parser-0.4.0 → cyberark_tpc_plugin_parser-0.4.2}/tpc_plugin_parser/lexer/lexer.py

@@ -26,14 +26,21 @@ from tpc_plugin_parser.lexer.utilities.types import ALL_TOKEN_TYPES, TokenSpecs
 _MAX_SOURCE_BYTES: int = 1 * 1024 * 1024  # 1 MiB
 _log = logging.getLogger(__name__)
 
+_ASSIGNMENT_RE = re.compile(ASSIGNMENT, re.IGNORECASE)
+_COMMENT_RE = re.compile(COMMENT, re.IGNORECASE)
+_CPM_PARAMETER_VALIDATION_RE = re.compile(CPM_PARAMETER_VALIDATION, re.IGNORECASE)
+_FAIL_STATE_RE = re.compile(FAIL_STATE, re.IGNORECASE)
+_SECTION_HEADER_RE = re.compile(SECTION_HEADER, re.IGNORECASE)
+_TRANSITION_RE = re.compile(TRANSITION, re.IGNORECASE)
 
-class Lexer(object):
+
+class Lexer:
     """Object to handle processing the ini files."""
 
     __slots__ = (
-        "_tokens",
         "_source",
         "_token_specs",
+        "_tokens",
     )
 
     def __init__(self, source: str) -> None:
@@ -51,35 +58,37 @@ class Lexer(object):
         self._source: str = source
         self._token_specs: list[TokenSpecs] = [
             {
-                "pattern": re.compile(COMMENT, re.IGNORECASE),
+                # Must precede ASSIGNMENT: "name = fail(...)" also matches the
+                # more general assignment pattern.
+                "pattern": _FAIL_STATE_RE,
+                "token_name": TokenName.FAIL_STATE,
+                "processor": self._process_fail_state,
+            },
+            {
+                "pattern": _ASSIGNMENT_RE,
+                "token_name": TokenName.ASSIGNMENT,
+                "processor": self._process_assignment,
+            },
+            {
+                "pattern": _COMMENT_RE,
                 "token_name": TokenName.COMMENT,
                 "processor": self._process_comment,
             },
             {
-                "pattern": re.compile(CPM_PARAMETER_VALIDATION, re.IGNORECASE),
+                "pattern": _CPM_PARAMETER_VALIDATION_RE,
                 "token_name": TokenName.CPM_PARAMETER_VALIDATION,
                 "processor": self._process_cpm_parameter_validation,
             },
             {
-                "pattern": re.compile(FAIL_STATE, re.IGNORECASE),
-                "token_name": TokenName.FAIL_STATE,
-                "processor": self._process_fail_state,
-            },
-            {
-                "pattern": re.compile(SECTION_HEADER, re.IGNORECASE),
+                "pattern": _SECTION_HEADER_RE,
                 "token_name": TokenName.SECTION_HEADER,
                 "processor": self._process_section_header,
             },
             {
-                "pattern": re.compile(TRANSITION, re.IGNORECASE),
+                "pattern": _TRANSITION_RE,
                 "token_name": TokenName.TRANSITION,
                 "processor": self._process_transitions,
             },
-            {
-                "pattern": re.compile(ASSIGNMENT, re.IGNORECASE),
-                "token_name": TokenName.ASSIGNMENT,
-                "processor": self._process_assignment,
-            },
         ]
 
     def process(self) -> None:
@@ -94,7 +103,7 @@ class Lexer(object):
         for line_number, line in enumerate(self._source.splitlines(), start=1):
             for token_spec in self._token_specs:
                 if match := token_spec["pattern"].match(line):
-                    token_spec["processor"](match=match, line_number=line_number)
+                    token_spec["processor"](match, line_number)
                     break
             else:
                 if line.strip():
@@ -104,11 +113,11 @@ class Lexer(object):
         """
         Process a variable assignment line
 
-        :param match: Regex match of the assignment.
+        :param match: Regex matches of the assignment.
         """
-        name: str = str(match.group("name")).strip()
-        equals = str(match.group("equals")).strip() if match.groupdict().get("equals", None) else None
-        assigned_stripped = str(match.group("value")).strip() if match.groupdict().get("value", None) else None
+        name: str = str(match["name"]).strip()
+        equals = str(match["equals"]).strip() if match.groupdict().get("equals", None) else None
+        assigned_stripped = str(match["value"]).strip() if match.groupdict().get("value", None) else None
         assigned = assigned_stripped or None
         self._tokens.append(
             (
@@ -126,7 +135,7 @@ class Lexer(object):
         """
         Process the provided comment.
 
-        :param match: Regex match of the comment.
+        :param match: Regex matches of the comment.
         """
         self._tokens.append(
             (
@@ -137,21 +146,21 @@ class Lexer(object):
 
     def _process_cpm_parameter_validation(self, match: re.Match, line_number: int) -> None:
         """
-        Process the provided parameter validation.
+        Process provided parameter validation.
 
-        :param match: Regex match of the parameter validation.
+        :param match: Regex matches of the parameter validation.
         """
         allow_characters: str | None = None
-        if match.group("allowcharacters"):
-            allow_characters = str(match.group("allowcharacters")).strip()
+        if match["allowcharacters"]:
+            allow_characters = str(match["allowcharacters"]).strip()
 
         self._tokens.append(
             (
                 TokenName.CPM_PARAMETER_VALIDATION,
                 CPMParameterValidation(
-                    name=str(match.group("name")),
-                    source=str(match.group("source")),
-                    mandatory=str(match.group("mandatory")),
+                    name=str(match["name"]),
+                    source=str(match["source"]),
+                    mandatory=str(match["mandatory"]),
                     allow_characters=allow_characters,
                     line_number=line_number,
                 ),
@@ -160,19 +169,20 @@ class Lexer(object):
 
     def _process_fail_state(self, match: re.Match, line_number: int) -> None:
         """
-        Process the provided fail state .
+        Process the provided fail state.
 
         :param match: Regex match of the fail state.
         """
-        code = int(match.group("code"))
+        code = int(match["code"])
         if not (0 <= code <= 65535):
+            _log.warning("Fail-state error code %d at line %d", code, line_number)
             raise ValueError(f"Fail-state error code {code} is outside the valid range 0–65535")
         self._tokens.append(
             (
                 TokenName.FAIL_STATE,
                 FailState(
-                    name=str(match.group("name")).strip(),
-                    message=str(match.group("message")).strip(),
+                    name=str(match["name"]).strip(),
+                    message=str(match["message"]).strip(),
                     code=code,
                     line_number=line_number,
                 ),
@@ -201,13 +211,13 @@ class Lexer(object):
         """
         Process the provided section header.
 
-        :param match: Regex match of the section header.
+        :param match: Regex matches of the section header.
         """
         self._tokens.append(
             (
                 TokenName.SECTION_HEADER,
                 SectionHeader(
-                    name=str(match.group("name").strip()),
+                    name=str(match["name"].strip()),
                     line_number=line_number,
                 ),
             )
@@ -217,15 +227,15 @@ class Lexer(object):
         """
         Process the provided transitions.
 
-        :param match: Regex match of the transitions.
+        :param match: Regex matches of the transitions.
         """
         self._tokens.append(
             (
                 TokenName.TRANSITION,
                 Transition(
-                    current_state=str(match.group("current")).strip(),
-                    condition=str(match.group("condition")).strip(),
-                    next_state=str(match.group("next")).strip(),
+                    current_state=str(match["current"]).strip(),
+                    condition=str(match["condition"]).strip(),
+                    next_state=str(match["next"]).strip(),
                     line_number=line_number,
                 ),
             )

{cyberark_tpc_plugin_parser-0.4.0 → cyberark_tpc_plugin_parser-0.4.2}/tpc_plugin_parser/lexer/tokens/assignment.py

@@ -6,7 +6,7 @@ from tpc_plugin_parser.lexer.utilities.token_name import TokenName
 
 
 @dataclass(frozen=True)
-class Assignment(object):
+class Assignment:
     """Dataclass to hold variable assignment details."""
 
     line_number: int

{cyberark_tpc_plugin_parser-0.4.0 → cyberark_tpc_plugin_parser-0.4.2}/tpc_plugin_parser/lexer/tokens/comment.py

@@ -6,7 +6,7 @@ from tpc_plugin_parser.lexer.utilities.token_name import TokenName
 
 
 @dataclass(frozen=True)
-class Comment(object):
+class Comment:
     """Dataclass to hold a comment."""
 
     line_number: int

{cyberark_tpc_plugin_parser-0.4.0 → cyberark_tpc_plugin_parser-0.4.2}/tpc_plugin_parser/lexer/tokens/cpm_parameter_validation.py

@@ -6,7 +6,7 @@ from tpc_plugin_parser.lexer.utilities.token_name import TokenName
 
 
 @dataclass(frozen=True)
-class CPMParameterValidation(object):
+class CPMParameterValidation:
     """Dataclass to hold variable cpm parameter validation details."""
 
     line_number: int

{cyberark_tpc_plugin_parser-0.4.0 → cyberark_tpc_plugin_parser-0.4.2}/tpc_plugin_parser/lexer/tokens/fail_state.py

@@ -6,7 +6,7 @@ from tpc_plugin_parser.lexer.utilities.token_name import TokenName
 
 
 @dataclass(frozen=True)
-class FailState(object):
+class FailState:
     """Dataclass to hold a fail state."""
 
     line_number: int

{cyberark_tpc_plugin_parser-0.4.0 → cyberark_tpc_plugin_parser-0.4.2}/tpc_plugin_parser/lexer/tokens/parse_error.py

@@ -6,7 +6,7 @@ from tpc_plugin_parser.lexer.utilities.token_name import TokenName
 
 
 @dataclass(frozen=True)
-class ParseError(object):
+class ParseError:
     """Dataclass to hold sparse errors."""
 
     line_number: int

{cyberark_tpc_plugin_parser-0.4.0 → cyberark_tpc_plugin_parser-0.4.2}/tpc_plugin_parser/lexer/tokens/section_header.py

@@ -6,7 +6,7 @@ from tpc_plugin_parser.lexer.utilities.token_name import TokenName
 
 
 @dataclass(frozen=True)
-class SectionHeader(object):
+class SectionHeader:
     """Dataclass to hold a section header name."""
 
     line_number: int

{cyberark_tpc_plugin_parser-0.4.0 → cyberark_tpc_plugin_parser-0.4.2}/tpc_plugin_parser/lexer/tokens/transition.py

@@ -6,7 +6,7 @@ from tpc_plugin_parser.lexer.utilities.token_name import TokenName
 
 
 @dataclass(frozen=True)
-class Transition(object):
+class Transition:
     """Dataclass to hold state transitions."""
 
     line_number: int

cyberark_tpc_plugin_parser-0.4.2/tpc_plugin_parser/lexer/utilities/regex.py

@@ -0,0 +1,12 @@
+"""List of regex the lexer uses."""
+
+ASSIGNMENT: str = r"^\s*(?P<name>\w+)(?:\s*(?P<equals>=)(?:\s*(?P<value>[^\r\n]*))?)?\s*$"
+COMMENT: str = r"^\s*(?P<comment>[#;]+.*)\s*$"
+CPM_PARAMETER_VALIDATION: str = (
+    r"^\s*(?P<name>[\w\\]+)(?:\s*,\s*source\s*=\s*(?P<source>[^, ]*))"
+    r"(?:\s*,\s*mandatory\s*=\s*(?P<mandatory>[^,]*))?"
+    r"(?:\s*,\s*allowcharacters\s*=\s*(?P<allowcharacters>.*))?$"
+)
+FAIL_STATE: str = r"^\s*(?P<name>\w+)\s*=\s*fail\s*\(\s*(?P<message>.*),\s*(?P<code>[0-9]+)\)\s*$"
+SECTION_HEADER: str = r"^\s*\[(?P<name>\w+(?:\s+\w+)*)]\s*$"
+TRANSITION: str = r"^\s*(?P<current>\w+)\s*,\s*(?P<condition>\w+)\s*,\s*(?P<next>\w+)\s*$"

{cyberark_tpc_plugin_parser-0.4.0 → cyberark_tpc_plugin_parser-0.4.2}/tpc_plugin_parser/lexer/utilities/types.py

@@ -1,7 +1,8 @@
 """Module for aggregating all token types used in the lexer."""
 
-from typing import Callable, TypedDict
 import re
+from collections.abc import Callable
+from typing import TypedDict
 
 from tpc_plugin_parser.lexer.tokens.assignment import Assignment
 from tpc_plugin_parser.lexer.tokens.comment import Comment

{cyberark_tpc_plugin_parser-0.4.0 → cyberark_tpc_plugin_parser-0.4.2}/tpc_plugin_parser/parser.py

@@ -6,7 +6,7 @@ from tpc_plugin_parser.lexer.utilities.token_name import TokenName
 from tpc_plugin_parser.lexer.utilities.types import ALL_TOKEN_TYPES
 
 
-class Parser(object):
+class Parser:
     """Object to handle parsing ini files."""
 
     __slots__ = ("_file",)

cyberark_tpc_plugin_parser-0.4.0/tpc_plugin_parser/lexer/utilities/regex.py

@@ -1,17 +0,0 @@
-"""List of regex the lexer uses."""
-
-ASSIGNMENT: str = r"^(?:[\s]*)(?P<name>[\w]+)(?:(?:[\s]*)(?P<equals>=)(?:(?:[\s]*)(?P<value>[^\r\n]*))?)?(?:[\s]*)$"
-COMMENT: str = r"^(?:[\s]*)(?P<comment>(?:[#;]+)(?:.*))(?:[\s]*)$"
-CPM_PARAMETER_VALIDATION: str = (
-    r"^(?:[\s]*)(?P<name>[\w\\]+)(?:(?:[\s]*,[\s]*)(?:source)(?:[\s]*)=(?:[\s]*)"
-    r"(?P<source>[^, ]*))(?:(?:[\s]*,[\s]*)(?:mandatory)(?:[\s]*)=(?:[\s]*)"
-    r"(?P<mandatory>[^,]*))?(?:(?:[\s]*,[\s]*)(?:allowcharacters)(?:[\s]*)=(?:[\s]*)(?P<allowcharacters>.*))?$"
-)
-FAIL_STATE: str = (
-    r"^(?:[\s]*)(?P<name>[\w]+)(?:[\s]*)=(?:[\s]*)(?:fail)(?:[\s]*)\((?:[\s]*)"
-    r"(?P<message>.*),(?:[\s]*)(?P<code>[0-9]+)\)(?:[\s]*)$"
-)
-SECTION_HEADER: str = r"^(?:[\s]*)\[(?P<name>[\w]+(?:[\s]+[\w]+)*)](?:[\s]*)$"
-TRANSITION: str = (
-    r"^(?:[\s]*)(?P<current>[\w]+)(?:[\s]*,[\s]*)(?P<condition>[\w]+)(?:[\s]*,[\s]*)(?P<next>[\w]+)(?:[\s]*)$"
-)