Enable ARG linting rule

Author: henrikjacobsenfys

pixi.lock

@@ -216,7 +216,7 @@ select = [
   # flake8 rules
   #'A',     # https://docs.astral.sh/ruff/rules/#flake8-builtins-a
   'ANN', # https://docs.astral.sh/ruff/rules/#flake8-annotations-ann
-  #'ARG',   # https://docs.astral.sh/ruff/rules/#flake8-unused-arguments-arg
+  'ARG', # https://docs.astral.sh/ruff/rules/#flake8-unused-arguments-arg
   #'ASYNC', # https://docs.astral.sh/ruff/rules/#flake8-async-async
   'B', # https://docs.astral.sh/ruff/rules/#flake8-bugbear-b
   #'BLE',   # https://docs.astral.sh/ruff/rules/#flake8-blind-except-ble

pyproject.toml

@@ -99,14 +99,14 @@ def analysis_list(self) -> list[Analysis1d]:
         return self._analysis_list
 
     @analysis_list.setter
-    def analysis_list(self, value: list[Analysis1d]) -> None:
+    def analysis_list(self, _value: list[Analysis1d]) -> None:
         """analysis_list is read-only.
 
         To change the analysis list, modify the experiment, sample
         model, or instrument model.
 
         Args:
-            value (list[Analysis1d]): The new list of Analysis1d objects. This
+            _value (list[Analysis1d]): The new list of Analysis1d objects. This
                 argument is ignored, as analysis_list is read-only.
 
         Raises:

src/easydynamics/analysis/analysis.py

@@ -184,7 +184,9 @@ def fit(self) -> FitResults:
         return fit_result
 
     def as_fit_function(
-        self, x: np.ndarray | sc.Variable | None = None, **kwargs: dict[str, Any]
+        self,
+        _x: np.ndarray | sc.Variable | None = None,
+        **kwargs: dict[str, Any],  # noqa: ARG002
     ) -> callable:
         """Return self._calculate as a fit function.
 
@@ -194,7 +196,7 @@ def as_fit_function(
         calculated model.
 
         Args:
-            x (np.ndarray | sc.Variable | None, default=None): Ignored.
+            _x (np.ndarray | sc.Variable | None, default=None): Ignored.
                 The energy grid is taken from the experiment.
             **kwargs (dict[str, Any]): Ignored. Included for compatibility with the
                 EasyScience fitter.
@@ -205,8 +207,8 @@ def as_fit_function(
         """
 
         def fit_function(
-            x: np.ndarray | sc.Variable | None = None,
-            **kwargs: dict[str, Any],
+            _x: np.ndarray | sc.Variable | None = None,
+            **kwargs: dict[str, Any],  # noqa: ARG001
         ) -> np.ndarray:
             return self._calculate()
 

src/easydynamics/analysis/analysis1d.py

@@ -188,12 +188,12 @@ def Q(self) -> sc.Variable | None:
         return self.experiment.Q
 
     @Q.setter
-    def Q(self, value: sc.Variable) -> None:
+    def Q(self, _value: sc.Variable) -> None:
         """Q cannot be set, as it is a read-only property derived from
         the Experiment.
 
         Args:
-            value (sc.Variable): The Q values to set. This argument is
+            _value (sc.Variable): The Q values to set. This argument is
                 ignored, as Q is a read-only property.
 
         Raises:
@@ -214,12 +214,12 @@ def energy(self) -> sc.Variable | None:
         return self.experiment.energy
 
     @energy.setter
-    def energy(self, value: sc.Variable) -> None:
+    def energy(self, _value: sc.Variable) -> None:
         """Energy cannot be set, as it is a read-only property derived
         from the Experiment.
 
         Args:
-            value (sc.Variable): The energy values to set. This argument is
+            _value (sc.Variable): The energy values to set. This argument is
                 ignored, as energy is a read-only property.
 
         Raises:
@@ -241,13 +241,14 @@ def temperature(self) -> Parameter | None:
         return self.sample_model.temperature
 
     @temperature.setter
-    def temperature(self, value: np.ndarray | Parameter) -> None:
+    def temperature(self, _value: np.ndarray | Parameter) -> None:
         """Temperature cannot be set, as it is a read-only property
         derived from the SampleModel.
 
         Args:
-            value (np.ndarray | Parameter): The temperature to set. This argument is
-                ignored, as temperature is a read-only property.
+            _value (np.ndarray | Parameter): The temperature to set.
+                This argument is ignored, as temperature is a read-only
+                property.
 
         Raises:
             AttributeError: If trying to set temperature.

src/easydynamics/analysis/analysis_base.py

@@ -130,12 +130,12 @@ def energy_with_offset(self) -> sc.Variable:
         return energy_with_offset
 
     @energy_with_offset.setter
-    def energy_with_offset(self, value: sc.Variable) -> None:
+    def energy_with_offset(self, _value: sc.Variable) -> None:
         """Energy with offset is a read-only property derived from
         energy and energy_offset.
 
         Args:
-            value (sc.Variable): The value to set (ignored).
+            _value (sc.Variable): The value to set (ignored).
 
         Raises:
             AttributeError: Always raised since energy_with_offset is
@@ -192,7 +192,7 @@ def energy_unit(self) -> str:
         return self._energy_unit
 
     @energy_unit.setter
-    def energy_unit(self, unit_str: str) -> None:
+    def energy_unit(self, _unit_str: str) -> None:
         raise AttributeError(
             f'Unit is read-only. Use convert_unit to change the unit between allowed types '
             f'or create a new {self.__class__.__name__} with the desired unit.'

src/easydynamics/convolution/convolution_base.py

@@ -106,12 +106,12 @@ def binned_data(self) -> sc.DataArray | None:
         return self._binned_data
 
     @binned_data.setter
-    def binned_data(self, value: sc.DataArray) -> None:
+    def binned_data(self, _value: sc.DataArray) -> None:
         """Set the binned dataset associated with this experiment. Read-
         only property. Use rebin() to rebin the data instead.
 
         Args:
-            value (sc.DataArray): The new binned dataset to associate
+            _value (sc.DataArray): The new binned dataset to associate
                 with this experiment (ignored)
 
         Raises:
@@ -132,12 +132,12 @@ def Q(self) -> sc.Variable | None:
         return self._binned_data.coords['Q']
 
     @Q.setter
-    def Q(self, value: sc.Variable) -> None:
+    def Q(self, _value: sc.Variable) -> None:
         """Set the Q values for the dataset. Q is a read-only property
         derived from the data, so this setter raises an error.
 
         Args:
-            value (sc.Variable): The new Q values to set (ignored)
+            _value (sc.Variable): The new Q values to set (ignored)
 
         Raises:
             AttributeError: Always, since Q is read-only.
@@ -157,12 +157,12 @@ def energy(self) -> sc.Variable | None:
         return self._binned_data.coords['energy']
 
     @energy.setter
-    def energy(self, value: sc.Variable) -> None:
+    def energy(self, _value: sc.Variable) -> None:
         """Set the energy values for the dataset. Energy is a read-only
         property derived from the data, so this setter raises an error.
 
         Args:
-            value (sc.Variable): The new energy values to set (ignored)
+            _value (sc.Variable): The new energy values to set (ignored)
 
         Raises:
             AttributeError: Always, since energy is read-only.

src/easydynamics/experiment/experiment.py

@@ -108,12 +108,12 @@ def is_empty(self) -> bool:
         return not self._components
 
     @is_empty.setter
-    def is_empty(self, value: bool) -> None:
+    def is_empty(self, _value: bool) -> None:
         """is_empty is a read-only property that indicates whether the
         collection has components.
 
         Args:
-            value (bool): The value to set (ignored).
+            _value (bool): The value to set (ignored).
 
         Raises:
             AttributeError: Always raised since is_empty is read-only.
@@ -134,11 +134,11 @@ def unit(self) -> str | sc.Unit | None:
         return self._unit
 
     @unit.setter
-    def unit(self, unit_str: str) -> None:
+    def unit(self, _unit_str: str) -> None:
         """Unit is read-only and cannot be set directly.
 
         Args:
-            unit_str (str): The unit to set (ignored).
+            _unit_str (str): The unit to set (ignored).
 
         Raises:
             AttributeError: Always raised since unit is read-only.
@@ -285,11 +285,11 @@ def is_empty(self) -> bool:
         return not self._components
 
     @is_empty.setter
-    def is_empty(self, value: bool) -> None:
+    def is_empty(self, _value: bool) -> None:
         """is_empty is read-only.
 
         Args:
-            value (bool): ignored.
+            _value (bool): ignored.
 
         Raises:
             AttributeError: Always raised since is_empty is read-only

src/easydynamics/sample_model/component_collection.py

@@ -46,13 +46,13 @@ def unit(self) -> str:
         return str(self._unit)
 
     @unit.setter
-    def unit(self, unit_str: str) -> None:
+    def unit(self, _unit_str: str) -> None:
         """Unit is read-only. Use convert_unit to change the unit
         between allowed types or create a new ModelComponent with the
         desired unit.
 
         Args:
-            unit_str (str): The new unit to set.
+            _unit_str (str): The new unit to set.
 
         Raises:
             AttributeError: Always raised since unit is read-only.

src/easydynamics/sample_model/components/model_component.py

@@ -176,20 +176,20 @@ def degree(self) -> int:
         return len(self._coefficients) - 1
 
     @degree.setter
-    def degree(self, value: int) -> None:
+    def degree(self, _value: int) -> None:
         """The degree is determined by the number of coefficients and
         cannot be set directly.
 
         Args:
-            value (int): The new degree of the polynomial.
+            _value (int): The new degree of the polynomial.
 
         Raises:
             AttributeError: Always raised since degree cannot be set
                 directly.
         """
         raise AttributeError(
-            'The degree of the polynomial is determined by the number of coefficients \
-                and cannot be set directly.'
+            'The degree of the polynomial is determined by the number of coefficients '
+            'and cannot be set directly.'
         )
 
     def get_all_variables(self) -> list[DescriptorBase]:
@@ -233,8 +233,10 @@ def __repr__(self) -> str:
         """
 
         coeffs_str = ', '.join(f'{param.name}={param.value}' for param in self._coefficients)
-        return f'Polynomial(unique_name = {self.unique_name}, \
-            unit = {self._unit},\n coefficients = [{coeffs_str}])'
+        return (
+            f'Polynomial(unique_name = {self.unique_name}, '
+            f'unit = {self._unit},\n coefficients = [{coeffs_str}])'
+        )
 
 
 # from typing import Callable, Dict