Add ruff rules to repository (#28)

* Refactor madp_strings.py and improve test readability

- Simplified conditional checks in create_mad_string function in madp_strings.py.
- Enhanced readability of test_communication.py by formatting long strings and improving spacing.
- Updated test_debug.py to use Path for file handling and improved readability.
- Refactored test_io_and_loading.py to utilize Path for file operations and improved code clarity.
- Cleaned up test_misc_types.py by removing unnecessary imports and improving formatting.
- Enhanced test_numeric_types.py for better readability and consistency in variable naming.
- Updated test_object_wrapping.py to use new MadRef and MadLastRef classes for better clarity.

* Refactor class names and update documentation for consistency

* Update MAD binaries to version 1.1.6 and adjust tests to use py_name parameter in MAD context manager

* Update GitHub Actions workflows to use latest actions versions and adjust Python versions

* Update CHANGELOG for MAD-NG 1.1.6 release with new features and improvements

* Remove Python 3.14 from test matrix in workflows

* Bump version to 0.8.0 in __init__.py

Author: jgray-19

.github/workflows/python-publish.yml

@@ -25,9 +25,9 @@ jobs:
       id-token: write
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     - name: Set up Python
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: '3.x'
     - name: Install dependencies
@@ -36,9 +36,9 @@ jobs:
         pip install build
     - name: Get MAD Binaries
       run: |
-        mkdir src/pymadng/bin 
-        curl https://madx.web.cern.ch/releases/madng/1.1/mad-linux-1.1.5 -o src/pymadng/bin/mad_Linux
-        curl https://madx.web.cern.ch/releases/madng/1.1/mad-macos-1.1.5 -o src/pymadng/bin/mad_Darwin
+        mkdir src/pymadng/bin
+        curl https://madx.web.cern.ch/releases/madng/1.1/mad-linux-1.1.6 -o src/pymadng/bin/mad_Linux
+        curl https://madx.web.cern.ch/releases/madng/1.1/mad-macos-1.1.6 -o src/pymadng/bin/mad_Darwin
         chmod +x src/pymadng/bin/mad_Linux src/pymadng/bin/mad_Darwin
     - name: Build package
       run: python -m build

.github/workflows/test-publish.yaml

@@ -12,19 +12,19 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     - name: Set up Python ${{ matrix.python-version }} on ${{ matrix.os }}
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         python -m pip install pymadng[tfs]
-        
+
     - name: Test with python
       run: |
         python -m unittest tests/*.py

.github/workflows/test-pymadng.yml

@@ -3,7 +3,7 @@
 
 name: Test pymadng
 
-on: 
+on:
   push:
     branches:
       - main
@@ -22,19 +22,19 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     - name: Set up Python ${{ matrix.python-version }} on ${{ matrix.os }}
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
     - name: Get MAD Binaries
       run: |
-        mkdir ./src/pymadng/bin 
-        curl https://madx.web.cern.ch/releases/madng/1.1/mad-linux-1.1.5 -o ./src/pymadng/bin/mad_Linux
-        curl https://madx.web.cern.ch/releases/madng/1.1/mad-macos-1.1.5 -o ./src/pymadng/bin/mad_Darwin
+        mkdir ./src/pymadng/bin
+        curl https://madx.web.cern.ch/releases/madng/1.1/mad-linux-1.1.6 -o ./src/pymadng/bin/mad_Linux
+        curl https://madx.web.cern.ch/releases/madng/1.1/mad-macos-1.1.6 -o ./src/pymadng/bin/mad_Darwin
         chmod +x ./src/pymadng/bin/mad_Linux ./src/pymadng/bin/mad_Darwin
     - name: Install dependencies
       run: |

.readthedocs.yaml

@@ -16,10 +16,10 @@ sphinx:
   configuration: docs/source/conf.py
 
 
-# Specify dependancy 
-# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html 
+# Specify dependancy
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
 python:
   install:
     - method: pip
       path: .
-    - requirements: docs/requirements.txt      
+    - requirements: docs/requirements.txt

CHANGELOG.md

@@ -1,3 +1,14 @@
+0.8.0 (2025/09/30)
+Update to MAD-NG 1.1.6 \
+Added comprehensive ruff configuration in pyproject.toml with various linting rules \
+Renamed classes and functions to follow PascalCase and snake_case conventions \
+Updated imports to use pathlib.Path instead of os.path \
+Improved code formatting and removed redundant constructs \
+BUG: Fixed used of `py` instead of `py_name`, resulting in py_name being unuable. \
+Removed compatibility for Python versions below 3.10, now only supporting Python 3.10 and above. \
+Updated GitHub Actions workflows to test against Python 3.10 to 3.14 \
+Updated documentation to reflect changes in code style and conventions. \
+
 0.7.1 (2025/08/04)
 Update to MAD-NG 1.1.5
 

docs/source/advanced_features.md

@@ -46,7 +46,7 @@ In PyMAD-NG, accessing or calling any MAD-NG function or object returns a Python
 ### Example:
 ```python
 r = mad.math.exp(1)
-print(type(r))  # high_level_mad_ref
+print(type(r))  # MadRef
 print(r.eval())  # 2.718...
 ```
 
@@ -201,4 +201,3 @@ This ensures the MAD process is correctly shut down when finished.
 These tools are designed to give you complete control over your simulations while staying fast and maintainable.
 
 Next: head over to **Debugging & Troubleshooting** to diagnose and resolve common issues in real-world workflows.
-

docs/source/architecture.md

@@ -4,7 +4,7 @@
 
 # PyMAD-NG Architecture Overview
 
-This section explains the internal architecture of PyMAD-NG, outlining how Python interacts with MAD-NG. 
+This section explains the internal architecture of PyMAD-NG, outlining how Python interacts with MAD-NG.
 
 ```{note}
 Understanding the architecture will help advanced users contribute to development, extend functionality, and debug issues more effectively.
@@ -62,7 +62,7 @@ This is implemented using `os.pipe()` and `select.select()` to manage reads and
 - Handles naming of Python process in MAD-NG via `py_name`
 - Configures subprocess behavior (debug mode, stdout redirection)
 
-### {class}`madp_pymad.mad_process`
+### {class}`madp_pymad.MadProcess`
 
 - Manages low-level pipe setup and subprocess launch
 - Provides `send`, `recv`, and `close` methods
@@ -111,7 +111,7 @@ Because MAD-NG entities are only known at runtime, PyMAD-NG uses dynamic attribu
 
 - Tab completion (`dir(mad)`) only works for preloaded or cached attributes
 - Use {func}`MAD.globals()` to list current MAD-NG global variables
-- {class}`madp_classes.high_level_mad_ref` objects will not show introspectable properties until evaluated
+- {class}`madp_classes.high_level_MadRef` objects will not show introspectable properties until evaluated
 
 ---
 
@@ -130,8 +130,8 @@ All sends are "protected" by default:
 | Component                                      | Role                                                       |
 | ---------------------------------------------- | ---------------------------------------------------------- |
 | {class}`MAD` class                      | Main interface and environment for interacting with MAD-NG |
-| {class}`madp_pymad.mad_process`         | Launches and communicates with MAD-NG subprocess           |
-| {class}`madp_classes.high_level_mad_ref` | Wraps MAD objects for Pythonic access                      |
+| {class}`madp_pymad.MadProcess`         | Launches and communicates with MAD-NG subprocess           |
+| {class}`madp_classes.high_level_MadRef` | Wraps MAD objects for Pythonic access                      |
 | {class}`madp_last`                       | Tracks temporary intermediate results from MAD-NG          |
 | Type dispatch                                  | Maps Python objects to MAD-NG-compatible messages          |
 

docs/source/contributing.md

@@ -10,7 +10,7 @@ This guide is for developers who want to contribute to PyMAD-NG or extend its ca
 |--------------------------------------|--------------------------------------------------------|
 | `src/pymadng/madp_object.py`         | Contains the main {class}`pymadng.MAD` class and high-level interface |
 | `src/pymadng/madp_pymad.py`          | Manages subprocess communication and type handling     |
-| `src/pymadng/madp_classes.py`        | Defines reference object wrappers (`mad_ref`, etc.)    |
+| `src/pymadng/madp_classes.py`        | Defines reference object wrappers (`MadRef`, etc.)    |
 | `src/pymadng/madp_last.py`           | Manages temporary variables like `_last[]`             |
 | `src/pymadng/madp_strings.py`        | Utility for quoting and formatting MAD-compatible text |
 | `examples/`                          | Contains working scripts and tutorials                 |
@@ -50,7 +50,7 @@ git checkout -b your-feature-name
 3. **Test Code**
    - All tests are located in the `tests/` directory, currently `unittests` are used.
 
-4. **Run Tests** 
+4. **Run Tests**
 ```bash
 python -m unittest tests/*.py
 ```
@@ -85,4 +85,3 @@ python -m unittest tests/*.py
 - See the [Debugging Guide] or [Architecture Overview] for internals
 
 Thanks for contributing to PyMAD-NG!
-

docs/source/reference.rst

@@ -12,8 +12,8 @@ PyMAD-NG Module contents
 Useful functions for MAD References
 -----------------------------------
 
-.. autofunction:: pymadng.madp_classes.high_level_mad_object.convert_to_dataframe
-   :no-index: 
+.. autofunction:: pymadng.madp_classes.MadObject.convert_to_dataframe
+   :no-index:
 
-.. autofunction:: pymadng.madp_classes.high_level_mad_object.to_df
+.. autofunction:: pymadng.madp_classes.MadObject.to_df
    :no-index:

examples/ex-LowLevel/ex-send-multypes.py

@@ -18,22 +18,14 @@
 mad.send("cm1 = (MAD.cmatrix(10000, 1000) + 1i)")
 
 # Create a string the manipulates the complex matrix in MAD and sends the result it to Python
-cmatrixString = """
+cmatrix_str = """
     {0} = cm1 {1} {2}
     py:send({0})"""
 
-mad.send(
-    cmatrixString.format("cm4", "*", 1)
-)  ## Set cm4 to cm1 * 1 and send it to Python
-mad.send(
-    cmatrixString.format("cm1", "*", 2)
-)  ## Set cm1 to cm1 * 2 and send it to Python
-mad.send(
-    cmatrixString.format("cm2", "*", 2)
-)  ## Set cm2 to cm1 * 2 and send it to Python
-mad.send(
-    cmatrixString.format("cm3", "/", 3)
-)  ## Set cm3 to cm1 / 3 and send it to Python
+mad.send(cmatrix_str.format("cm4", "*", 1))  ## Set cm4 to cm1 * 1 and send it to Python
+mad.send(cmatrix_str.format("cm1", "*", 2))  ## Set cm1 to cm1 * 2 and send it to Python
+mad.send(cmatrix_str.format("cm2", "*", 2))  ## Set cm2 to cm1 * 2 and send it to Python
+mad.send(cmatrix_str.format("cm3", "/", 3))  ## Set cm3 to cm1 / 3 and send it to Python
 
 ## Create a vector in MAD and send it to Python
 mad.send("""
@@ -72,41 +64,39 @@
 mad_list = mad.recv("list")
 for i, inner_list in enumerate(mad_list):
     for j, val in enumerate(inner_list):
-        print(
-            f"List value at [{i}][{j}]: {val} == {my_list[i][j]}", val == my_list[i][j]
-        )
+        print(f"List value at [{i}][{j}]: {val} == {my_list[i][j]}", val == my_list[i][j])
 
 # Send an integer to MAD and receive a changed version back
-myInt = 4
+an_int = 4
 mad.send("""
-local myInt = py:recv()
-py:send(myInt+2)
+local an_int = py:recv()
+py:send(an_int+2)
 """)
-mad.send(myInt)
+mad.send(an_int)
 print("Integers", mad.recv() == 6)
 
 # Send a float to MAD and receive a changed version back
-myFloat = 6.612
+a_float = 6.612
 mad.send("""
-local myFloat = py:recv()
-py:send(myFloat + 0.56)
+local a_float = py:recv()
+py:send(a_float + 0.56)
 """)
-mad.send(myFloat)
+mad.send(a_float)
 print("Floats", mad.recv() == 6.612 + 0.56)
 
 # Send a complex number to MAD and receive a changed version back
-myCpx = 6.612 + 4j
+a_cpx = 6.612 + 4j
 mad.send("""
-local myCpx = py:recv()
-py:send(myCpx + 0.5i)
+local a_cpx = py:recv()
+py:send(a_cpx + 0.5i)
 """)
-mad.send(myCpx)
+mad.send(a_cpx)
 print("Complex", mad.recv() == 6.612 + 4.5j)
 
 # Send None to MAD and it back
 mad.send("""
-local myNil = py:recv()
-py:send(myNil)
+local a_nil = py:recv()
+py:send(a_nil)
 """)
 mad.send(None)
 print("Nil/None", mad.recv() is None)