varphi-devkit 1.0.0__tar.gz → 1.1.4__tar.gz

{varphi_devkit-1.0.0 → varphi_devkit-1.1.4}/LICENSE

@@ -1,28 +1,28 @@
-BSD 3-Clause License
-
-Copyright (c) 2025, Hassan El-Sheikha
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its
-   contributors may be used to endorse or promote products derived from
-   this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+BSD 3-Clause License
+
+Copyright (c) 2025, Hassan El-Sheikha
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

{varphi_devkit-1.0.0 → varphi_devkit-1.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: varphi-devkit
-Version: 1.0.0
+Version: 1.1.4
 Summary: A Python framework for creating compilers that target the Varphi language
 License: BSD-3-Clause
 Keywords: compiler,turing-machine,dsl,antlr,parser

{varphi_devkit-1.0.0 → varphi_devkit-1.1.4}/README.md

@@ -1,178 +1,178 @@
-# Varphi Development Kit
-
-A Python framework for creating compilers that target the Varphi language - a domain-specific language for describing Turing machine transition rules.
-
-## Overview
-
-Varphi is a minimalist language designed to represent Turing machine programs using simple transition rules. The Varphi Development Kit provides a flexible compiler framework that allows you to build custom compilers to transform Varphi programs into any target format.
-
-## Installation
-
-```bash
-pip install varphi-devkit
-```
-
-**Requirements:**
-- Python ≥ 3.10
-
-## Varphi Language Syntax
-
-Varphi programs consist of transition rules with the following syntax:
-
-```
-STATE TAPE_CHARACTER STATE TAPE_CHARACTER HEAD_DIRECTION
-```
-
-Where:
-- **STATE**: Current/target state (format: `q` followed by alphanumeric characters, e.g., `q0`, `q_start`, `q1_accept`)
-- **TAPE_CHARACTER**: Tape symbol (`0` for blank, `1` for marked)
-- **HEAD_DIRECTION**: Head movement (`L` for left, `R` for right)
-
-### Example Varphi Program
-
-```varphi
-// Simple addition-by-one program
-q0 1 q0 1 R
-q0 0 qHalt 1 R
-```
-
-### Language Features
-
-- **Comments**: Single-line (`//`) and multi-line (`/* */`) comments are supported
-- **Whitespace**: Flexible whitespace handling (spaces, tabs, newlines)
-- **States**: Flexible state naming with `q` prefix
-
-## Core Architecture
-
-The framework is built around these key components:
-
-### Data Model
-
-- **`VarphiTapeCharacter`**: Enum for tape symbols (`BLANK="0"`, `ONE="1"`)
-- **`VarphiHeadDirection`**: Enum for head movement (`LEFT="L"`, `RIGHT="R"`)
-- **`VarphiLine`**: Dataclass representing a transition rule with fields:
-  - `if_state`: Current state
-  - `if_condition`: Current tape character
-  - `then_state`: Next state  
-  - `then_character`: Character to write
-  - `then_direction`: Direction to move
-
-### Compiler Framework
-
-- **`VarphiCompiler`**: Abstract base class for implementing custom compilers
-- **`compile_varphi()`**: Function to parse and compile Varphi programs
-- **`VarphiSyntaxError`**: Exception for syntax errors
-
-## Usage
-
-### Creating a Custom Compiler
-
-To create a Varphi compiler, subclass `VarphiCompiler` and implement three methods:
-
-```python
-from varphi_devkit import VarphiCompiler, VarphiLine, compile_varphi
-
-class MyCompiler(VarphiCompiler):
-    def __init__(self):
-        # Initialize your compiler's state
-        self.output = []
-    
-    def handle_line(self, line: VarphiLine):
-        # Process each transition rule
-        self.output.append(f"Transition: {line.if_state} -> {line.then_state}")
-    
-    def generate_compiled_program(self) -> str:
-        # Return the final compiled output
-        return "\n".join(self.output)
-
-# Use your compiler
-program = """
-q0 0 q1 1 R
-q1 1 q_halt 0 L
-"""
-
-compiler = MyCompiler()
-result = compile_varphi(program, compiler)
-print(result)
-```
-
-## Example Toy Compilers
-
-The framework's test suite includes several [example compilers](/tests/toy_compilers) that demonstrate different use cases.
-
-## Error Handling
-
-The framework provides comprehensive syntax error reporting out of the box:
-
-```python
-from varphi_devkit import VarphiSyntaxError, compile_varphi
-from your_compiler import YourCompiler
-
-try:
-    result = compile_varphi("invalid syntax here", YourCompiler())
-except VarphiSyntaxError as e:
-    print(f"Syntax error at line {e.line}, column {e.column}: {e.message}")
-```
-
-## API Reference
-
-### Core Functions
-
-#### `compile_varphi(program: str, compiler: VarphiCompiler) -> str`
-
-Parses and compiles a Varphi program using the provided compiler.
-
-- **Parameters:**
-  - `program`: Varphi source code as a string
-  - `compiler`: VarphiCompiler instance to process the program
-- **Returns:** Compiled program output from the compiler
-- **Raises:** `VarphiSyntaxError` for invalid syntax
-
-### Abstract Base Class
-
-#### `VarphiCompiler`
-
-Abstract base class for implementing custom Varphi compilers.
-
-**Abstract Methods:**
-- `__init__(self) -> None`: Initialize compiler state
-- `handle_line(self, line: VarphiLine) -> None`: Process a transition rule (line in the Varphi program)
-- `generate_compiled_program(self) -> str`: Return final compiled output
-
-### Data Classes
-
-#### `VarphiLine`
-
-Represents a single transition rule with attributes:
-- `if_state: str` - Current state
-- `if_condition: VarphiTapeCharacter` - Current tape character
-- `then_state: str` - Next state
-- `then_character: VarphiTapeCharacter` - Character to write
-- `then_direction: VarphiHeadDirection` - Head movement direction
-
-#### `VarphiTapeCharacter`
-
-Enum for tape characters:
-- `BLANK = "0"` - Empty tape cell
-- `ONE = "1"` - Marked tape cell
-
-#### `VarphiHeadDirection`
-
-Enum for head movement:
-- `LEFT = "L"` - Move head left
-- `RIGHT = "R"` - Move head right
-
-### Exceptions
-
-#### `VarphiSyntaxError`
-
-Exception raised for syntax errors in Varphi programs.
-
-**Attributes:**
-- `message: str` - Error description
-- `line: int` - Line number where error occurred
-- `column: int` - Column position of error
-
-## License
-
-This project is available under the BSD-3-Clause License (see [LICENSE](LICENSE)).
+# Varphi Development Kit
+
+A Python framework for creating compilers that target the Varphi language - a domain-specific language for describing Turing machine transition rules.
+
+## Overview
+
+Varphi is a minimalist language designed to represent Turing machine programs using simple transition rules. The Varphi Development Kit provides a flexible compiler framework that allows you to build custom compilers to transform Varphi programs into any target format.
+
+## Installation
+
+```bash
+pip install varphi-devkit
+```
+
+**Requirements:**
+- Python ≥ 3.10
+
+## Varphi Language Syntax
+
+Varphi programs consist of transition rules with the following syntax:
+
+```
+STATE TAPE_CHARACTER STATE TAPE_CHARACTER HEAD_DIRECTION
+```
+
+Where:
+- **STATE**: Current/target state (format: `q` followed by alphanumeric characters, e.g., `q0`, `q_start`, `q1_accept`)
+- **TAPE_CHARACTER**: Tape symbol (`0` for blank, `1` for marked)
+- **HEAD_DIRECTION**: Head movement (`L` for left, `R` for right)
+
+### Example Varphi Program
+
+```varphi
+// Simple addition-by-one program
+q0 1 q0 1 R
+q0 0 qHalt 1 R
+```
+
+### Language Features
+
+- **Comments**: Single-line (`//`) and multi-line (`/* */`) comments are supported
+- **Whitespace**: Flexible whitespace handling (spaces, tabs, newlines)
+- **States**: Flexible state naming with `q` prefix
+
+## Core Architecture
+
+The framework is built around these key components:
+
+### Data Model
+
+- **`VarphiTapeCharacter`**: Enum for tape symbols (`BLANK="0"`, `ONE="1"`)
+- **`VarphiHeadDirection`**: Enum for head movement (`LEFT="L"`, `RIGHT="R"`)
+- **`VarphiLine`**: Dataclass representing a transition rule with fields:
+  - `if_state`: Current state
+  - `if_condition`: Current tape character
+  - `then_state`: Next state  
+  - `then_character`: Character to write
+  - `then_direction`: Direction to move
+
+### Compiler Framework
+
+- **`VarphiCompiler`**: Abstract base class for implementing custom compilers
+- **`compile_varphi()`**: Function to parse and compile Varphi programs
+- **`VarphiSyntaxError`**: Exception for syntax errors
+
+## Usage
+
+### Creating a Custom Compiler
+
+To create a Varphi compiler, subclass `VarphiCompiler` and implement three methods:
+
+```python
+from varphi_devkit import VarphiCompiler, VarphiLine, compile_varphi
+
+class MyCompiler(VarphiCompiler):
+    def __init__(self):
+        # Initialize your compiler's state
+        self.output = []
+    
+    def handle_line(self, line: VarphiLine):
+        # Process each transition rule
+        self.output.append(f"Transition: {line.if_state} -> {line.then_state}")
+    
+    def generate_compiled_program(self) -> str:
+        # Return the final compiled output
+        return "\n".join(self.output)
+
+# Use your compiler
+program = """
+q0 0 q1 1 R
+q1 1 q_halt 0 L
+"""
+
+compiler = MyCompiler()
+result = compile_varphi(program, compiler)
+print(result)
+```
+
+## Example Toy Compilers
+
+The framework's test suite includes several [example compilers](/tests/toy_compilers) that demonstrate different use cases.
+
+## Error Handling
+
+The framework provides comprehensive syntax error reporting out of the box:
+
+```python
+from varphi_devkit import VarphiSyntaxError, compile_varphi
+from your_compiler import YourCompiler
+
+try:
+    result = compile_varphi("invalid syntax here", YourCompiler())
+except VarphiSyntaxError as e:
+    print(f"Syntax error at line {e.line}, column {e.column}: {e.message}")
+```
+
+## API Reference
+
+### Core Functions
+
+#### `compile_varphi(program: str, compiler: VarphiCompiler) -> str`
+
+Parses and compiles a Varphi program using the provided compiler.
+
+- **Parameters:**
+  - `program`: Varphi source code as a string
+  - `compiler`: VarphiCompiler instance to process the program
+- **Returns:** Compiled program output from the compiler
+- **Raises:** `VarphiSyntaxError` for invalid syntax
+
+### Abstract Base Class
+
+#### `VarphiCompiler`
+
+Abstract base class for implementing custom Varphi compilers.
+
+**Abstract Methods:**
+- `__init__(self) -> None`: Initialize compiler state
+- `handle_line(self, line: VarphiLine) -> None`: Process a transition rule (line in the Varphi program)
+- `generate_compiled_program(self) -> str`: Return final compiled output
+
+### Data Classes
+
+#### `VarphiLine`
+
+Represents a single transition rule with attributes:
+- `if_state: str` - Current state
+- `if_condition: VarphiTapeCharacter` - Current tape character
+- `then_state: str` - Next state
+- `then_character: VarphiTapeCharacter` - Character to write
+- `then_direction: VarphiHeadDirection` - Head movement direction
+
+#### `VarphiTapeCharacter`
+
+Enum for tape characters:
+- `BLANK = "0"` - Empty tape cell
+- `ONE = "1"` - Marked tape cell
+
+#### `VarphiHeadDirection`
+
+Enum for head movement:
+- `LEFT = "L"` - Move head left
+- `RIGHT = "R"` - Move head right
+
+### Exceptions
+
+#### `VarphiSyntaxError`
+
+Exception raised for syntax errors in Varphi programs.
+
+**Attributes:**
+- `message: str` - Error description
+- `line: int` - Line number where error occurred
+- `column: int` - Column position of error
+
+## License
+
+This project is available under the BSD-3-Clause License (see [LICENSE](LICENSE)).

{varphi_devkit-1.0.0 → varphi_devkit-1.1.4}/pyproject.toml

@@ -1,110 +1,110 @@
-[project]
-name = "varphi-devkit"
-version = "1.0.0"
-description = "A Python framework for creating compilers that target the Varphi language"
-authors = [
-    {name = "Hassan El-Sheikha",email = "hmelsheikha@gmail.com"}
-]
-readme = "README.md"
-requires-python = ">=3.10"
-keywords = ["compiler", "turing-machine", "dsl", "antlr", "parser"]
-license = {text = "BSD-3-Clause"}
-homepage = "https://github.com/varphi-lang/varphi-devkit"
-repository = "https://github.com/varphi-lang/varphi-devkit"
-classifiers = [
-    "Development Status :: 3 - Alpha",
-    "Intended Audience :: Developers",
-    "License :: OSI Approved :: MIT License",
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.10",
-    "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.12",
-    "Topic :: Software Development :: Compilers",
-    "Topic :: Software Development :: Libraries :: Python Modules",
-]
-dependencies = [
-    "antlr4-python3-runtime (>=4.13.2,<5.0.0)",
-]
-
-[tool.poetry]
-packages = [{include = "varphi_devkit", from = "src"}]
-
-
-[tool.poetry.group.dev.dependencies]
-pytest = "^8.4.1"
-pylint = "^3.3.7"
-antlr4-tools = "^0.2.2"
-python-semantic-release = "^10.2.0"
-build = "^1.3.0"
-twine = "^6.1.0"
-
-[build-system]
-requires = ["poetry-core>=2.0.0,<3.0.0"]
-build-backend = "poetry.core.masonry.api"
-
-[semantic_release]
-assets = []
-build_command_env = []
-commit_message = "{version}\n\nAutomatically generated by python-semantic-release"
-commit_parser = "conventional"
-logging_use_named_masks = false
-major_on_zero = true
-allow_zero_version = false
-repo_dir = "."
-no_git_verify = false
-tag_format = "v{version}"
-version_toml = ["pyproject.toml:project.version"]
-
-[semantic_release.branches.main]
-match = "(main|master)"
-prerelease_token = "rc"
-prerelease = false
-
-[semantic_release.changelog]
-exclude_commit_patterns = []
-mode = "update"
-insertion_flag = "<!-- version list -->"
-template_dir = "templates"
-
-[semantic_release.changelog.default_templates]
-changelog_file = "CHANGELOG.md"
-output_format = "md"
-mask_initial_release = true
-
-[semantic_release.changelog.environment]
-block_start_string = "{%"
-block_end_string = "%}"
-variable_start_string = "{{"
-variable_end_string = "}}"
-comment_start_string = "{#"
-comment_end_string = "#}"
-trim_blocks = false
-lstrip_blocks = false
-newline_sequence = "\n"
-keep_trailing_newline = false
-extensions = []
-autoescape = false
-
-[semantic_release.commit_author]
-env = "GIT_COMMIT_AUTHOR"
-default = "semantic-release <semantic-release>"
-
-[semantic_release.commit_parser_options]
-minor_tags = ["feat"]
-patch_tags = ["fix", "perf"]
-other_allowed_tags = ["build", "chore", "ci", "docs", "style", "refactor", "test"]
-allowed_tags = ["feat", "fix", "perf", "build", "chore", "ci", "docs", "style", "refactor", "test"]
-default_bump_level = 0
-parse_squash_commits = true
-ignore_merge_commits = true
-
-[semantic_release.remote]
-name = "origin"
-type = "github"
-ignore_token_for_push = false
-insecure = false
-
-[semantic_release.publish]
-dist_glob_patterns = ["dist/*"]
-upload_to_vcs_release = true
-
+[project]
+name = "varphi-devkit"
+version = "1.1.4"
+description = "A Python framework for creating compilers that target the Varphi language"
+authors = [
+    {name = "Hassan El-Sheikha",email = "hmelsheikha@gmail.com"}
+]
+readme = "README.md"
+requires-python = ">=3.10"
+keywords = ["compiler", "turing-machine", "dsl", "antlr", "parser"]
+license = {text = "BSD-3-Clause"}
+homepage = "https://github.com/varphi-lang/varphi-devkit"
+repository = "https://github.com/varphi-lang/varphi-devkit"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Compilers",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "antlr4-python3-runtime (>=4.13.2,<5.0.0)",
+]
+
+[tool.poetry]
+packages = [{include = "varphi_devkit", from = "src"}]
+
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.4.1"
+pylint = "^3.3.7"
+antlr4-tools = "^0.2.2"
+python-semantic-release = "^10.2.0"
+build = "^1.3.0"
+twine = "^6.1.0"
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[semantic_release]
+assets = []
+build_command_env = []
+commit_message = "{version}\n\nAutomatically generated by python-semantic-release"
+commit_parser = "conventional"
+logging_use_named_masks = false
+major_on_zero = true
+allow_zero_version = false
+repo_dir = "."
+no_git_verify = false
+tag_format = "v{version}"
+version_toml = ["pyproject.toml:project.version"]
+
+[semantic_release.branches.main]
+match = "(main|master)"
+prerelease_token = "rc"
+prerelease = false
+
+[semantic_release.changelog]
+exclude_commit_patterns = []
+mode = "update"
+insertion_flag = "<!-- version list -->"
+template_dir = "templates"
+
+[semantic_release.changelog.default_templates]
+changelog_file = "CHANGELOG.md"
+output_format = "md"
+mask_initial_release = true
+
+[semantic_release.changelog.environment]
+block_start_string = "{%"
+block_end_string = "%}"
+variable_start_string = "{{"
+variable_end_string = "}}"
+comment_start_string = "{#"
+comment_end_string = "#}"
+trim_blocks = false
+lstrip_blocks = false
+newline_sequence = "\n"
+keep_trailing_newline = false
+extensions = []
+autoescape = false
+
+[semantic_release.commit_author]
+env = "GIT_COMMIT_AUTHOR"
+default = "semantic-release <semantic-release>"
+
+[semantic_release.commit_parser_options]
+minor_tags = ["feat"]
+patch_tags = ["fix", "perf"]
+other_allowed_tags = ["build", "chore", "ci", "docs", "style", "refactor", "test"]
+allowed_tags = ["feat", "fix", "perf", "build", "chore", "ci", "docs", "style", "refactor", "test"]
+default_bump_level = 0
+parse_squash_commits = true
+ignore_merge_commits = true
+
+[semantic_release.remote]
+name = "origin"
+type = "github"
+ignore_token_for_push = false
+insecure = false
+
+[semantic_release.publish]
+dist_glob_patterns = ["dist/*"]
+upload_to_vcs_release = true
+