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

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

@@ -13,44 +13,115 @@ 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
+
+  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 +131,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 +201,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 +216,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 +233,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 +262,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 +273,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 +295,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.7}/Cargo.lock

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

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

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nc-gcode-interpreter
-Version: 0.1.5
+Version: 0.1.7
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: 3.12
@@ -9,10 +9,14 @@ 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'
+Provides-Extra: dev
+Provides-Extra: test
 License-File: LICENSE
 Summary: A interpreter for NC (Numerical Control) code
 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.7/examples/tool.csv

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

nc_gcode_interpreter-0.1.7/examples/tool.mpf

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

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

@@ -4,10 +4,10 @@ build-backend = "maturin"
 
 [project]
 name = "nc-gcode-interpreter"
-version = "0.1.5"
+dynamic = ["version"]
 description = "A interpreter for NC (Numerical Control) code"
 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",
@@ -21,6 +21,14 @@ dependencies = [
     "polars>=1.9.0"
 ]
 
+[project.optional-dependencies]
+dev = [
+    "jupyter>=1.1.1"
+]
+test = [
+    "pytest>=8.3.3"
+]
+
 [project.urls]
 Homepage = "https://github.com/CEAD-group/nc-gcode-interpreter"
 Repository = "https://github.com/CEAD-group/nc-gcode-interpreter.git"

{nc_gcode_interpreter-0.1.5 → nc_gcode_interpreter-0.1.7}/python/tests/test_expected_output.py

@@ -1,7 +1,6 @@
 import pathlib
 import pytest
 from nc_gcode_interpreter import nc_to_dataframe
-from polars import DataFrame
 
 
 @pytest.fixture(
@@ -33,7 +32,7 @@ def test_mpf_file_to_csv(mpf_file, initial_state):
     """
     Test the nc_to_dataframe function with each .mpf file, using the default initial state.
     """
-    df: DataFrame = nc_to_dataframe(
+    nc_to_dataframe(
         mpf_file.read_text(),
         initial_state=initial_state,
         iteration_limit=10000,

{nc_gcode_interpreter-0.1.5 → nc_gcode_interpreter-0.1.7}/src/grammar.pest

@@ -2,6 +2,7 @@ file                =  { SOI ~ blocks ~ newline? ~ EOI }
 blocks              =  { block ~ (newline ~ block)* }
 newline             = _{ "\n" | "\r\n" }
 WHITESPACE          = _{ " " | "\t" }
+QUOTE               = _{ "\"" }
 comment             =  { ";" ~ (!newline ~ ANY)* }
 block               =  { block_number_set? ~ (definition | frame_op | control | statement*) ~ comment? }
 block_number_set    = _{ "N" ~ block_number }
@@ -33,11 +34,11 @@ relational_operator =  { "<=" | ">=" | "<" | ">" | "==" | "<>" }
 statement           =  {
     g_command_numbered
   | m_command
+  | tool_selection
   | assignment_multi
   | assignment
   | g_command
   | function_call
-  | tool_selection
 }
 
 // local variable definitions
@@ -103,7 +104,7 @@ primary          =  { value | variable_array | variable | "(" ~ expression ~ ")"
 float            = @{ "-"? ~ ASCII_DIGIT+ ~ "." ~ ASCII_DIGIT* }
 integer          = @{ "-"? ~ ASCII_DIGIT+ }
 
-tool_selection = { "T" ~ "=" ~ string }
+tool_selection = { ^"T" ~ "=" ~ quoted_string }
 
 // frame instructions
 frame_op     = { frame_trans | frame_scale | frame_atrans | frame_ascale }
@@ -113,14 +114,15 @@ frame_atrans = { ^"ATRANS" ~ assignment+ }
 frame_ascale = { ^"ASCALE" ~ assignment+ }
 
 // function call parser
-function_call      = { identifier ~ ("(" ~ function_arguments? ~ ")")? }
-function_arguments = { ((expression | string)? ~ ",")* ~ (expression | string) }
-string             = { "\"" ~ (!"\"" ~ ANY)* ~ "\"" }
+function_call      =  { identifier ~ ("(" ~ function_arguments? ~ ")")? }
+function_arguments =  { ((expression | quoted_string)? ~ ",")* ~ (expression | quoted_string) }
+quoted_string      = _{ QUOTE ~ (string)* ~ QUOTE }
+string             =  { (!"\"" ~ ANY)+ }
 
 // builtins, globally available names
 nc_variable = { "$" ~ identifier }
 
-m_command = { "M" ~ ASCII_DIGIT+ }
+m_command = { ^"M" ~ ASCII_DIGIT+ }
 
 // G-Code ggroups
 // This Pest grammar file is auto-generated from G-Code definitions.

{nc_gcode_interpreter-0.1.5 → nc_gcode_interpreter-0.1.7}/src/interpret_rules.rs

@@ -116,6 +116,39 @@ fn interpret_m_command(m_command: Pair<Rule>) -> (String, String) {
     // Return the tuple with the rule name as the column header and the specific M command as the value
     ("M".to_string(), command_str)
 }
+fn interpret_tool_selection(
+    tool_selection: Pair<Rule>,
+    output: &mut Output,
+    _state: &mut State,
+) -> Result<(), ParsingError> {
+    // Get the last HashMap from the output vector to insert the tool selection.
+    let last = output.last_mut().expect("Output vector should not be empty");
+
+    // Since `tool_selection` = { ^"T" ~ "=" ~ quoted_string }
+    // and `quoted_string` is silent, the `tool_selection` pair will directly contain the `string` pairs.
+    let mut tool_name = String::new();
+
+    // Iterate over the inner pairs to collect the strings.
+    for pair in tool_selection.into_inner() {
+        match pair.as_rule() {
+            Rule::string => {
+                tool_name.push_str(pair.as_str());
+            }
+            _ => {
+                // Handle unexpected rules.
+                return Err(ParsingError::UnexpectedRule {
+                    rule: pair.as_rule(),
+                    context: "interpret_tool_selection".to_string(),
+                });
+            }
+        }
+    }
+
+    // Insert the tool name into the output.
+    last.insert("T".to_string(), Value::Str(tool_name));
+
+    Ok(())
+}
 fn interpret_function_call(function_call: Pair<Rule>) -> (String, String) {
     // Log the interpretd function call for debugging
     //println!("Parsed function call: {:?}", function_call);
@@ -489,7 +522,6 @@ fn interpret_control(element: Pair<Rule>, output: &mut Output, state: &mut State
         _ => panic!("Unexpected rule: {:?}", pair.as_rule()),
     }
 }
-
 fn insert_m_key(last: &mut HashMap<String, Value>, value: &str) -> Result<(), ParsingError> {
     let m_key = "M";
     for _i in 1..=5 {
@@ -509,7 +541,6 @@ fn insert_m_key(last: &mut HashMap<String, Value>, value: &str) -> Result<(), Pa
     }
     Err(ParsingError::TooManyMCommands) // Return error if all keys are full
 }
-
 fn interpret_statement(element: Pair<Rule>, output: &mut Output, state: &mut State) -> Result<(), ParsingError> {
     // Grammar:
     // statement           =  {
@@ -550,7 +581,7 @@ fn interpret_statement(element: Pair<Rule>, output: &mut Output, state: &mut Sta
                     last.insert(key, Value::Float(_updated_value));
                 }
             }
-            Rule::tool_selection => println!("Tool selection: {:?}", statement),
+            Rule::tool_selection => interpret_tool_selection(statement, output, state)?,
             _ => Err(ParsingError::UnexpectedRule {
                 rule: statement.as_rule(),
                 context: "interpret_statement".to_string(),