Merge pull request #11 from brian-team/cleanup

Cleanup

Author: mstimberg

.github/workflows/pytest-ubuntu.yaml

@@ -20,6 +20,10 @@ jobs:
       run: |
         pdm install -G test
 
+    # Update output format to enable automatic inline annotations.
+    - name: Run Ruff
+      run: pdm run ruff check --output-format=github .
+
     - name: Run tests
       run: |
         pdm run -v pytest --cov=QuantSI --cov-report lcov --doctest-modules

.gitignore

@@ -152,12 +152,11 @@ dmypy.json
 # Cython debug symbols
 cython_debug/
 
-# PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+# VS Code
+.vscode/
+
+# coverage
+coverage.*
 
 # version
 _version.py

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.11.6
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format

README.md

@@ -1,2 +1,6 @@
 # QuantSI
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Tests](https://github.com/brian-team/QuantSI/actions/workflows/pytest-ubuntu.yaml/badge.svg)](https://github.com/brian-team/QuantSI/actions/workflows/pytest-ubuntu.yaml)
+[![Coverage Status](https://coveralls.io/repos/github/brian-team/QuantSI/badge.svg?branch=main)](https://coveralls.io/github/brian-team/QuantSI?branch=main)
+
 Work in progress: unit system as used by the Brian2 simulator

docs_sphinx/conf.py

@@ -12,17 +12,18 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('.'))
+
+sys.path.insert(0, os.path.abspath("."))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'QuantSI'
-copyright = '2024, Sorin Birchi'
-author = 'Sorin Birchi'
+project = "QuantSI"
+copyright = "2024, Sorin Birchi"
+author = "Sorin Birchi"
 
 # The full version, including alpha/beta/rc tags
-release = '2024'
+release = "2024"
 
 
 # -- General configuration ---------------------------------------------------
@@ -35,22 +36,22 @@
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]

pyproject.toml

@@ -30,6 +30,8 @@ test = [
     "pytest-xdist>=1.22.3",
     "pdm-backend>=2.4.3",
     "pytest-cov>=6.1.1",
+    "ruff>=0.11.6",
+    "pre-commit>=4.2.0",
 ]
 docs = [
     "sphinx>=7",
@@ -51,4 +53,11 @@ write_to = "QuantSI/_version.py"
 write_template = "__version__ = '{}'"
 
 [tool.pytest.ini_options]
-addopts = "-ra"
+addopts = "-ra"
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.format]
+docstring-code-format = true

src/QuantSI/allunits.py

@@ -2088,7 +2088,6 @@
     "Mlitre",
     "klitre",
     "Ylitre",
-    "celsius"  # Dummy object raising an error
     ]
 
 
@@ -7911,45 +7910,6 @@
     ]
 
 
-class _Celsius:
-    """
-    A dummy object to raise errors when ``celsius`` is used. The use of
-    `celsius` can lead to ambiguities when mixed with temperatures in `kelvin`,
-    so its use is no longer supported. See github issue #817 for details.
-    """
-    error_text = (
-        "The unit 'celsius' is no longer supported to avoid"
-        "ambiguities when mixed with absolute temperatures defined"
-        "in Kelvin. Directly use 'kelvin' when you are only"
-        "interested in temperature differences, and add the"
-        "'zero_celsius' constant from the QuantSI.constants"
-        "module if you want to convert a temperature from Celsius to"
-        "Kelvin."
-    )
-
-    def __mul__(self, other):
-        raise TypeError(_Celsius.error_text)
-
-    def __rmul__(self, other):
-        raise TypeError(_Celsius.error_text)
-
-    def __div__(self, other):
-        raise TypeError(_Celsius.error_text)
-
-    def __rdiv__(self, other):
-        raise TypeError(_Celsius.error_text)
-
-    def __pow__(self, other):
-        raise TypeError(_Celsius.error_text)
-
-    def __eq__(self, other):
-        raise TypeError(_Celsius.error_text)
-
-    def __neq__(self, other):
-        raise TypeError(_Celsius.error_text)
-
-celsius = _Celsius()
-
 Unit.automatically_register_units = True
 
 for unit in itertools.chain(powered_units, scaled_units, base_units):

src/QuantSI/conftest.py

@@ -1,5 +1,6 @@
 import pytest
 
+
 def pytest_collection_modifyitems(config, items):
     # List of function names whose doctests should be skipped
     functions_to_skip = {
@@ -11,5 +12,8 @@ def pytest_collection_modifyitems(config, items):
         function_name = item.location[2]  # The third element often contains the name in doctests
         # Skip specific functions' doctests
         if any(fn in function_name for fn in functions_to_skip):
-            item.add_marker(pytest.mark.skip(reason="Skipping doctest for specific function due to known documentation issues"))
-
+            item.add_marker(
+                pytest.mark.skip(
+                    reason="Skipping doctest for specific function due to known documentation issues"
+                )
+            )