nc-gcode-interpreter 0.1.5__tar.gz → 0.1.8__tar.gz

{nc_gcode_interpreter-0.1.5 → nc_gcode_interpreter-0.1.8}/.github/workflows/build-and-release.yml

@@ -13,44 +13,116 @@ name: Build and Release
 
 on:
   push:
+    branches:
+      - main
     tags:
       - 'v*'
+  pull_request:
   workflow_dispatch:
 
+
 permissions:
   contents: write
 
 env:
   PROJECT_NAME: "nc-gcode-interpreter"
-
 jobs:
-  linux:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+      - name: Install Python linter
+        run: pip install ruff
+      - name: Lint Python code with ruff
+        run: ruff check .
+
+  linux-x64:
+    needs: [lint]
     runs-on: ${{ matrix.platform.runner }}
     strategy:
       matrix:
         platform:
           - runner: ubuntu-latest
             target: x86_64
-        #   - runner: ubuntu-latest
-        #     target: x86
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+      - name: Update Cargo.toml Version
+        if: startsWith(github.ref, 'refs/tags/')
+        run: |
+          VERSION=${GITHUB_REF#refs/tags/v}
+          echo "Setting version to $VERSION"
+          sed -i "s/^version = \".*\"/version = \"$VERSION\"/" Cargo.toml
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.platform.target }}
+          args: --release --out dist --find-interpreter
+          sccache: 'true'
+          manylinux: auto
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-linux-${{ matrix.platform.target }}
+          path: dist
+
+  test:
+    needs: [linux-x64]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          name: wheels-linux-x86_64
+          path: dist
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+      - name: Install py_opw_kinematics
+        run: |
+          WHL_FILE=$(ls dist/*cp312*.whl)
+          pip install "${WHL_FILE}[test]"
+      - name: Run tests with pytest
+        run: pytest
+      - name: Type checking with mypy
+        run: mypy python
+  linux:
+    if: startsWith(github.ref, 'refs/tags/') || github.event_name == 'workflow_dispatch'
+    needs: [lint, test]
+    runs-on: ${{ matrix.platform.runner }}
+    strategy:
+      matrix:
+        platform:
+          # - runner: ubuntu-latest
+          #   target: x86
           - runner: ubuntu-latest
             target: aarch64
-        #   - runner: ubuntu-latest
-        #     target: armv7
-        #   - runner: ubuntu-latest
-        #     target: s390x
-        #   - runner: ubuntu-latest
-        #     target: ppc64le
+          # - runner: ubuntu-latest
+          #   target: armv7
+          # - runner: ubuntu-latest
+          #   target: s390x
+          # - runner: ubuntu-latest
+          #   target: ppc64le
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
           python-version: 3.12
+      - name: Update Cargo.toml Version
+        if: startsWith(github.ref, 'refs/tags/')
+        run: |
+          VERSION=${GITHUB_REF#refs/tags/v}
+          echo "Setting version to $VERSION"
+          sed -i "s/^version = \".*\"/version = \"$VERSION\"/" Cargo.toml          
       - name: Build wheels
         uses: PyO3/maturin-action@v1
         with:
           target: ${{ matrix.platform.target }}
-          # args: --release --out dist --find-interpreter -b bin
           args: --release --out dist --find-interpreter
           sccache: 'true'
           manylinux: auto
@@ -60,58 +132,67 @@ jobs:
           name: wheels-linux-${{ matrix.platform.target }}
           path: dist
 
-#   musllinux:
-#     runs-on: ${{ matrix.platform.runner }}
-#     strategy:
-#       matrix:
-#         platform:
-#           - runner: ubuntu-latest
-#             target: x86_64
-#           - runner: ubuntu-latest
-#             target: x86
-#           - runner: ubuntu-latest
-#             target: aarch64
-#           - runner: ubuntu-latest
-#             target: armv7
-#     steps:
-#       - uses: actions/checkout@v4
-#       - uses: actions/setup-python@v5
-#         with:
-#           python-version: 3.12
-#       - name: Build wheels
-#         uses: PyO3/maturin-action@v1
-#         with:
-#           target: ${{ matrix.platform.target }}
-#         # args: --release --out dist --find-interpreter -b bin
-#           args: --release --out dist --find-interpreter
-#           sccache: 'true'
-#           manylinux: musllinux_1_2
-#       - name: Upload wheels
-#         uses: actions/upload-artifact@v4
-#         with:
-#           name: wheels-musllinux-${{ matrix.platform.target }}
-#           path: dist
+
+  # musllinux:
+  #   needs: [lint, test]
+  #   runs-on: ${{ matrix.platform.runner }}
+  #   strategy:
+  #     matrix:
+  #       platform:
+  #         - runner: ubuntu-latest
+  #           target: x86_64
+  #         # - runner: ubuntu-latest
+  #         #   target: x86
+  #         # - runner: ubuntu-latest
+  #         #   target: aarch64
+  #         # - runner: ubuntu-latest
+  #         #   target: armv7
+  #   steps:
+  #     - uses: actions/checkout@v4
+  #     - uses: actions/setup-python@v5
+  #       with:
+  #         python-version: '>=3.12'
+  #     - name: Build wheels
+  #       uses: PyO3/maturin-action@v1
+  #       with:
+  #         target: ${{ matrix.platform.target }}
+  #         args: --release --out dist --find-interpreter
+  #         sccache: 'true'
+  #         manylinux: musllinux_1_2
+  #     - name: Upload wheels
+  #       uses: actions/upload-artifact@v4
+  #       with:
+  #         name: wheels-musllinux-${{ matrix.platform.target }}
+  #         path: dist
 
   windows:
+    if: startsWith(github.ref, 'refs/tags/') || github.event_name == 'workflow_dispatch'
+    needs: [lint, test]
     runs-on: ${{ matrix.platform.runner }}
     strategy:
       matrix:
         platform:
           - runner: windows-latest
             target: x64
-        #   - runner: windows-latest
-        #     target: x86
+          # - runner: windows-latest
+          #   target: x86
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
           python-version: 3.12
           architecture: ${{ matrix.platform.target }}
+      - name: Update Cargo.toml Version
+        if: startsWith(github.ref, 'refs/tags/')
+        shell: pwsh
+        run: |
+          $VERSION = $env:GITHUB_REF -replace 'refs/tags/v',''
+          Write-Host "Setting version to $VERSION"
+          (Get-Content Cargo.toml) -replace '^version = ".*"', ('version = "' + $VERSION + '"') | Set-Content Cargo.toml
       - name: Build wheels
         uses: PyO3/maturin-action@v1
         with:
           target: ${{ matrix.platform.target }}
-          # args: --release --out dist --find-interpreter -b bin
           args: --release --out dist --find-interpreter
           sccache: 'true'
       - name: Upload wheels
@@ -121,6 +202,8 @@ jobs:
           path: dist
 
   macos:
+    if: startsWith(github.ref, 'refs/tags/') || github.event_name == 'workflow_dispatch'
+    needs: [lint, test]
     runs-on: ${{ matrix.platform.runner }}
     strategy:
       matrix:
@@ -134,11 +217,15 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: 3.12
+      - name: Update Cargo.toml Version
+        run: |
+          VERSION=${GITHUB_REF#refs/tags/v}
+          echo "Setting version to $VERSION"
+          sed -i '' "s/^version = \".*\"/version = \"$VERSION\"/" Cargo.toml
       - name: Build wheels
         uses: PyO3/maturin-action@v1
         with:
           target: ${{ matrix.platform.target }}
-          # args: --release --out dist --find-interpreter -b bin
           args: --release --out dist --find-interpreter
           sccache: 'true'
       - name: Upload wheels
@@ -147,51 +234,21 @@ jobs:
           name: wheels-macos-${{ matrix.platform.target }}
           path: dist
 
-  # emscripten:
-  #   runs-on: ${{ matrix.platform.runner }}
-  #   strategy:
-  #     matrix:
-  #       platform:
-  #         - runner: ubuntu-latest
-  #           target: wasm32-unknown-emscripten
-  #   steps:
-  #     - uses: actions/checkout@v4
-  #     - uses: actions/setup-python@v5
-  #       with:
-  #         python-version: 3.12
-  #     - run: pip install pyodide-build
-  #     - name: Get Emscripten and Python version info
-  #       shell: bash
-  #       run: |
-  #         echo EMSCRIPTEN_VERSION=$(pyodide config get emscripten_version) >> $GITHUB_ENV
-  #         echo PYTHON_VERSION=$(pyodide config get python_version | cut -d '.' -f 1-2) >> $GITHUB_ENV
-  #         pip uninstall -y pyodide-build
-  #     - uses: mymindstorm/setup-emsdk@v12
-  #       with:
-  #         version: ${{ env.EMSCRIPTEN_VERSION }}
-  #         actions-cache-folder: emsdk-cache
-  #     - uses: actions/setup-python@v5
-  #       with:
-  #         python-version: ${{ env.PYTHON_VERSION }}
-  #     - run: pip install pyodide-build
-  #     - name: Build wheels
-  #       uses: PyO3/maturin-action@v1
-  #       with:
-  #         target: ${{ matrix.platform.target }}
-  #       #  args: --release --out dist -i ${{ env.PYTHON_VERSION }} -b bin
-  #         args: --release --out dist -i ${{ env.PYTHON_VERSION }}
-  #         sccache: 'true'
-  #         rust-toolchain: nightly
-  #     - name: Upload wheels
-  #       uses: actions/upload-artifact@v4
-  #       with:
-  #         name: wheels-wasm
-  #         path: dist
-
   sdist:
+    if: startsWith(github.ref, 'refs/tags/') || github.event_name == 'workflow_dispatch'
+    needs: [lint, test]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+      - name: Update Cargo.toml Version
+        if: startsWith(github.ref, 'refs/tags/')
+        run: |
+          VERSION=${GITHUB_REF#refs/tags/v}
+          echo "Setting version to $VERSION"
+            sed -i "s/^version = \".*\"/version = \"$VERSION\"/" Cargo.toml              
       - name: Build sdist
         uses: PyO3/maturin-action@v1
         with:
@@ -206,10 +263,8 @@ jobs:
   release:
     name: Release
     runs-on: ubuntu-latest
-    environment: release
     if: ${{ startsWith(github.ref, 'refs/tags/') || github.event_name == 'workflow_dispatch' }}
-    # needs: [linux, musllinux, windows, macos, emscripten, sdist]
-    needs: [linux, windows, macos, sdist]
+    needs: [linux, linux-x64, windows, macos, sdist]
     permissions:
       # Use to sign the release artifacts
       id-token: write
@@ -219,12 +274,15 @@ jobs:
       attestations: write
     steps:
       - uses: actions/download-artifact@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
       - name: Generate artifact attestation
         uses: actions/attest-build-provenance@v1
         with:
           subject-path: 'wheels-*/*'
       - name: Publish to PyPI
-        if: "startsWith(github.ref, 'refs/tags/')"
+        if: startsWith(github.ref, 'refs/tags/')
         uses: PyO3/maturin-action@v1
         with:
           command: upload
@@ -238,39 +296,3 @@ jobs:
             wheels-linux-*/*.whl
             wheels-macos-*/*.whl
           prerelease: ${{ contains(github.ref, 'alpha') || contains(github.ref, 'beta') }}
-      # - name: Extract binary and rename
-      #   env:
-      #     PROJECT_NAME: ${{ env.PROJECT_NAME }}
-      #   run: |
-      #     for wheel_dir in wheels-windows-* wheels-linux-* wheels-macos-*; do
-      #       arch=$(echo $wheel_dir | cut -d'-' -f3)
-      #       os=$(echo $wheel_dir | cut -d'-' -f2)
-      #       find ./$wheel_dir -name "*.whl" -exec sh -c '
-      #         wheel_name=$(basename "$1")
-      #         version=$(echo $wheel_name | sed -E "s/.*-([0-9]+\.[0-9]+\.[0-9]+)-.*/\1/")
-      #         unzip -d "$(dirname "$1")" "$1"
-      #         if [ "$2" = "windows" ]; then
-      #           binary_path=$(find "$(dirname "$1")" -name "*.exe")
-      #           if [ -n "$binary_path" ]; then
-      #             mv "$binary_path" "$(dirname "$binary_path")/${PROJECT_NAME}_${version}_${2}_${3}.exe"
-      #           fi
-      #         else
-      #           binary_path=$(find "$(dirname "$1")" -type f -executable)
-      #           if [ -n "$binary_path" ]; then
-      #             mv "$binary_path" "$(dirname "$binary_path")/${PROJECT_NAME}_${version}_${2}_${3}"
-      #           fi
-      #         fi
-      #       ' _ {} "$os" "$arch" \;
-      #     done
-      # - name: Upload to GitHub Release
-      #   uses: softprops/action-gh-release@v2
-      #   with:
-      #     files: |
-      #       wheels-sdist/*.tar.gz
-      #       wheels-windows-*/*.whl
-      #       wheels-windows-*/*.data/scripts/${{ env.PROJECT_NAME }}_*_windows_*.exe
-      #       wheels-linux-*/*.whl
-      #       wheels-linux-*/*.data/scripts/${{ env.PROJECT_NAME }}_*_linux_*
-      #       wheels-macos-*/*.whl
-      #       wheels-macos-*/*.data/scripts/${{ env.PROJECT_NAME }}_*_macos_*
-      #     prerelease: ${{ contains(github.ref, 'alpha') || contains(github.ref, 'beta') }}

{nc_gcode_interpreter-0.1.5 → nc_gcode_interpreter-0.1.8}/Cargo.lock

@@ -724,7 +724,7 @@ dependencies = [
 
 [[package]]
 name = "nc-gcode-interpreter"
-version = "0.1.5"
+version = "0.1.8"
 dependencies = [
  "clap",
  "csv",

{nc_gcode_interpreter-0.1.5 → nc_gcode_interpreter-0.1.8}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "nc-gcode-interpreter"
-version = "0.1.5"
+version = "0.1.8"
 edition = "2021"
 
 [lib]

{nc_gcode_interpreter-0.1.5 → nc_gcode_interpreter-0.1.8}/Development.md

@@ -42,5 +42,5 @@ rm **/*.csv && cargo build --release && find examples -name "*.mpf" -type f -pri
 ## python test
     
 ```bash
-maturin develop --release && pytest
+maturin develop --release --uv && pytest
 ```

{nc_gcode_interpreter-0.1.5 → nc_gcode_interpreter-0.1.8}/PKG-INFO

@@ -1,18 +1,24 @@
 Metadata-Version: 2.3
 Name: nc-gcode-interpreter
-Version: 0.1.5
+Version: 0.1.8
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Dist: maturin >=1.7.4
 Requires-Dist: polars >=1.9.0
+Requires-Dist: jupyter >=1.1.1 ; extra == 'dev'
+Requires-Dist: pytest >=8.3.3 ; extra == 'test'
+Requires-Dist: mypy ; extra == 'test'
+Provides-Extra: dev
+Provides-Extra: test
 License-File: LICENSE
-Summary: A interpreter for NC (Numerical Control) code
+Summary: A interpreter for NC (Numerical Control) GCode
 Author-email: CEAD Group <software@ceadgroup.com>
-Requires-Python: >=3.12
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
 Project-URL: Homepage, https://github.com/CEAD-group/nc-gcode-interpreter
 Project-URL: Repository, https://github.com/CEAD-group/nc-gcode-interpreter.git

nc_gcode_interpreter-0.1.8/examples/function_calls.csv

@@ -0,0 +1,3 @@
+X,function_call,gg01_motion
+,SETAL(12345),
+1.000,,G1

nc_gcode_interpreter-0.1.8/examples/function_calls.mpf

@@ -0,0 +1,2 @@
+SETAL(12345)
+G1 X1

nc_gcode_interpreter-0.1.8/examples/tool.csv

@@ -0,0 +1,2 @@
+M,T
+M6,BALL_MILL_8MM_SHORT

nc_gcode_interpreter-0.1.8/examples/tool.mpf

@@ -0,0 +1 @@
+T="BALL_MILL_8MM_SHORT" M6

{nc_gcode_interpreter-0.1.5 → nc_gcode_interpreter-0.1.8}/ggroups/generate_pest.py

@@ -2,7 +2,7 @@
 from pathlib import Path
 import json
 
-json_file = Path(__file__).parent / "ggroups.json"
+json_file = Path(__file__).parent.parent / "python/nc_gcode_interpreter/ggroups.json"
 with open(json_file, "r") as file:
     g_groups = json.load(file)
 # %%

{nc_gcode_interpreter-0.1.5 → nc_gcode_interpreter-0.1.8}/pyproject.toml

@@ -1,16 +1,17 @@
 [build-system]
-requires = ["maturin>=1.0,<2.0"]
+requires = ["maturin>=1.7,<2.0"]
 build-backend = "maturin"
 
 [project]
 name = "nc-gcode-interpreter"
-version = "0.1.5"
-description = "A interpreter for NC (Numerical Control) code"
+dynamic = ["version"]
+description = "A interpreter for NC (Numerical Control) GCode"
 authors = [{ name = "CEAD Group", email = "software@ceadgroup.com" }]
-requires-python = ">=3.12"
+requires-python = ">=3.11"
 classifiers = [
     "Programming Language :: Rust",
     "Programming Language :: Python :: Implementation :: CPython",
+    "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
@@ -21,11 +22,22 @@ dependencies = [
     "polars>=1.9.0"
 ]
 
-[project.urls]
-Homepage = "https://github.com/CEAD-group/nc-gcode-interpreter"
-Repository = "https://github.com/CEAD-group/nc-gcode-interpreter.git"
-Documentation = "https://github.com/CEAD-group/nc-gcode-interpreter/blob/main/README.md"
+[project.optional-dependencies]
+dev = [
+    "jupyter>=1.1.1"
+]
+test = [
+    "pytest>=8.3.3",
+    "mypy"
+]
 
 [tool.maturin]
 features = ["pyo3/extension-module"]
+module-name = "nc_gcode_interpreter._internal"
 python-source = "python"
+include = ["python/nc_gcode_interpreter/py.typed", "python/nc_gcode_interpreter/ggroups.json"]
+
+[project.urls]
+Homepage = "https://github.com/CEAD-group/nc-gcode-interpreter"
+Repository = "https://github.com/CEAD-group/nc-gcode-interpreter.git"
+Documentation = "https://github.com/CEAD-group/nc-gcode-interpreter/blob/main/README.md"

nc_gcode_interpreter-0.1.8/python/nc_gcode_interpreter/__init__.py

@@ -0,0 +1,127 @@
+from typing import Protocol
+import polars as pl
+from ._internal import nc_to_dataframe as _nc_to_dataframe
+from ._internal import __doc__  # noqa: F401
+import json
+from pathlib import Path
+from typing import TypedDict, TypeVar, Any, Type, Callable, Generic
+
+
+# Define TextFileLike Protocol
+class TextFileLike(Protocol):
+    def read(self) -> str: ...
+
+
+__all__ = ["nc_to_dataframe"]
+
+
+def nc_to_dataframe(
+    input: "TextFileLike | str",
+    initial_state: "TextFileLike | str | None" = None,
+    axis_identifiers: "list[str] | None" = None,
+    extra_axes: "list[str] | None" = None,
+    iteration_limit: int = 10000,
+    disable_forward_fill: bool = False,
+) -> tuple[pl.DataFrame, dict]:
+    """
+    Convert G-code to a DataFrame representation along with the state information.
+
+    Parameters:
+    -----------
+    input: TextFileLike | str
+        The G-code input as a string or a file-like object.
+    initial_state: TextFileLike | str | None
+        An optional initial state string or a file-like object.
+    axis_identifiers: list[str] | None
+        A list of axis identifiers.
+    extra_axes: list[str] | None
+        A list of extra axes to be included.
+    iteration_limit: int
+        The maximum number of iterations to process.
+    disable_forward_fill: bool
+        Whether to disable forward-filling of values.
+
+    Returns:
+    --------
+    tuple[pl.DataFrame, dict]
+        A tuple containing the resulting DataFrame and a nested dictionary representing the state.
+    """
+    if input is None:
+        raise ValueError("input cannot be None")
+    if not isinstance(input, str):
+        input = input.read()
+    if initial_state is not None and not isinstance(initial_state, str):
+        initial_state = initial_state.read()
+
+    df, state = _nc_to_dataframe(
+        input,
+        initial_state,
+        axis_identifiers,
+        extra_axes,
+        iteration_limit,
+        disable_forward_fill,
+    )
+    return df, state
+
+
+_T = TypeVar("_T")
+
+
+class _classproperty(Generic[_T]):
+    def __init__(self, fget: Callable[[Any], _T]) -> None:
+        self.fget = fget
+
+    def __get__(self, instance: Any, owner: Type[Any]) -> _T:
+        return self.fget(owner)
+
+
+class _GGroupEntry(TypedDict):
+    id: str
+    nr: int
+    description: str
+
+
+class _GGroup(TypedDict):
+    nr: int
+    title: str
+    effectiveness: str
+    short_name: str
+    entries: list[_GGroupEntry]
+
+
+class GGroups:
+    _g_groups: list[_GGroup] | None = None
+    _g_group_short_names: set[str] | None = None
+    _g_groups_by_short_name: dict[str, _GGroup] | None = None
+
+    @_classproperty
+    def g_groups(cls) -> list[_GGroup]:
+        if cls._g_groups is None:
+            cls._load_data()
+        assert cls._g_groups is not None
+        return cls._g_groups
+
+    @classmethod
+    def _load_data(cls) -> None:
+        json_file = Path(__file__).parent / "ggroups.json"
+        with open(json_file, "r") as file:
+            g_groups = json.load(file)
+            cls._g_groups = g_groups
+            cls._g_group_short_names = {group["short_name"] for group in g_groups}
+            cls._g_groups_by_short_name = {
+                group["short_name"]: group for group in g_groups
+            }
+
+    @classmethod
+    def is_g_group(cls, name: str) -> bool:
+        if cls._g_group_short_names is None:
+            cls._load_data()
+        assert cls._g_group_short_names is not None
+        return name in cls._g_group_short_names
+
+    @classmethod
+    def is_modal_g_group(cls, name: str) -> bool:
+        if cls._g_groups_by_short_name is None:
+            cls._load_data()
+        assert cls._g_groups_by_short_name is not None
+        return cls._g_groups_by_short_name[name]["effectiveness"] == "modal"