iqm-exa-common 25.31__tar.gz → 25.33__tar.gz

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/CHANGELOG.rst

@@ -2,6 +2,24 @@
 Changelog
 =========
 
+Version 25.33 (2025-02-04)
+--------------------------
+
+Features
+--------
+
+- Refactor codebase to new lint rules. No functional changes. :issue:`SW-467`
+
+
+Version 25.32 (2025-02-04)
+--------------------------
+
+Features
+--------
+
+- Refactor codebase to new lint rules. No functional changes. :issue:`SW-467`
+
+
 Version 25.31 (2025-01-28)
 --------------------------
 

{iqm_exa_common-25.31/src/iqm_exa_common.egg-info → iqm_exa_common-25.33}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-exa-common
-Version: 25.31
+Version: 25.33
 Summary: Framework for control and measurement of superconducting qubits: common library
 Author-email: IQM Finland Oy <info@meetiqm.com>
 License:                                  Apache License

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/pyproject.toml

@@ -21,24 +21,11 @@ file = "LICENSE.txt"
 Documentation = "https://iqm-finland.github.io/docs/iqm-exa-common/"
 Homepage = "https://pypi.org/project/iqm-exa-common/"
 
-[tool.black]
+[tool.ruff]
+exclude = [ "*.ipynb", "*.rst",]
+extend-include = [ "sub-setup-py.template",]
 line-length = 120
 
-[tool.isort]
-balanced_wrapping = true
-force_sort_within_sections = true
-group_by_package = true
-known_first_party = [ "exa.common", "tests",]
-known_third_party = [ "exa",]
-line_length = 120
-order_by_type = true
-profile = "black"
-reverse_relative = true
-use_parentheses = true
-
-[tool.mypy]
-ignore_missing_imports = true
-
 [tool.setuptools_scm]
 fallback_version = "0.1"
 
@@ -52,35 +39,34 @@ exclude_lines = [ "pragma: no cover", "def __repr__", "if self\\.debug", "raise
 branch = true
 source = [ "exa.common",]
 
-[tool.pylint.basic]
-good-names = [ "i", "j", "k", "ex", "Run", "_", "pk", "x", "y", "z", "g", "T1", "T2", "ax", "cz", "vz", "rz",]
-
-[tool.pylint.design]
-max-args = 15
-max-locals = 50
-max-public-methods = 30
-
-[tool.pylint.format]
-max-line-length = 120
-
-[tool.pylint.main]
-init-hook = "import sys; sys.path.append('.')"
-
-[tool.pylint."message control"]
-disable = [ "ungrouped-imports", "wrong-import-order", "fixme", "arguments-differ", "arguments-renamed",]
-
-[tool.pylint.miscellaneous]
-notes = [ "TODO",]
-
-[tool.pylint.similarities]
-ignore-imports = true
-min-similarity-lines = 20
-
-[tool.pylint.string]
-check-quote-consistency = true
-
 [tool.pytest.ini_options]
 nb_diff_ignore = [ "/metadata/language_info", "/metadata/widgets", "/cells/*/execution_count", "/cells/*/outputs",]
 
+[tool.ruff.lint]
+ignore = [ "D203", "D213",]
+select = [ "E4", "E7", "E9", "E5", "F", "Q", "PL", "I", "D",]
+unfixable = [ "F401",]
+
+[tool.ruff.lint.isort]
+force-sort-within-sections = true
+known-first-party = [ "exa.experiments", "exa.core", "exa.common", "cocos", "gbc", "calibration_graphs", "iqm.pulse", "iqm.cpc", "iqm.pulla", "iqm.station_control", "tests",]
+known-local-folder = [ "src",]
+known-third-party = [ "exa", "iqm",]
+relative-imports-order = "closest-to-furthest"
+
+[tool.ruff.lint.per-file-ignores]
+"**/__init__.py" = [ "F401", "PLR0402",]
+"**/docs/*" = [ "E402", "D100",]
+"**/setup.py" = [ "D100", "D103", "I001",]
+"**/src/*" = [ "PLR2004", "D400", "D415", "D205", "D401", "D417", "D100", "D101", "D107", "D102", "D105", "D103", "D404", "D104",]
+"**/tests/*" = [ "F632", "PLR2004", "PLR0402", "PLC0414", "D",]
+
+[tool.ruff.lint.pylint]
+max-args = 8
+max-branches = 16
+max-locals = 21
+max-returns = 9
+max-statements = 60
+
 [tool.setuptools.dynamic.dependencies]
 file = "requirements/base.txt"

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/setup.py

@@ -5,16 +5,21 @@
 #  Distribution or reproduction of any information contained herein
 #  is prohibited without IQM Finland Oy’s prior written permission.
 #  ********************************************************************************
+"""Common setup for subdirectories."""
 
-from setuptools import setup
 from pathlib import Path
 
+from setuptools import setup
+
+
 def get_version():
+    """Get version from the file version.txt."""
     build_version_fpath = Path("version.txt")
     if build_version_fpath.exists():
         # Assume there's only one line specifying the version in the file
         return build_version_fpath.read_text().strip()
     return "0.1dev0"
 
+
 if __name__ == "__main__":
     setup(version=get_version())

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/__init__.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 """Shared errors, helpers, control structures, settings, API models etc."""
+
 from importlib.metadata import PackageNotFoundError, version
 
 try:

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/api/model/parameter_model.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 """Pydantic model for Parameter."""
+
 from __future__ import annotations
 
 from typing import Optional, Tuple
@@ -23,9 +24,7 @@ from exa.common.data.parameter import CollectionType, DataType, Parameter
 
 
 class ParameterModel(BaseModel):
-    """
-    Pydantic parameter model
-    """
+    """Pydantic parameter model"""  # noqa: D200
 
     name: str
     parent_name: Optional[str] = None

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/api/model/setting_model.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 """Pydantic model for Setting."""
+
 from __future__ import annotations
 
 from typing import Any
@@ -26,9 +27,7 @@ from exa.common.helpers.numpy_helper import coerce_numpy_type_to_native
 
 
 class SettingModel(BaseModel):
-    """
-    Pydantic setting model
-    """
+    """Pydantic setting model"""  # noqa: D200
 
     parameter: ParameterModel
     value: Any = None

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/api/model/setting_node_model.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 """Pydantic model for SettingNode."""
+
 from __future__ import annotations
 
 from typing import Any, Dict
@@ -24,9 +25,7 @@ from exa.common.data.setting_node import SettingNode
 
 
 class SettingNodeModel(BaseModel):
-    """
-    Pydantic setting node model
-    """
+    """Pydantic setting node model"""  # noqa: D200
 
     name: str
     settings: Dict[str, SettingModel]

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/api/model/sweep_model.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 """Pydantic model for Sweep."""
+
 from __future__ import annotations
 
 from typing import Any

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/api/proto_serialization/_parameter.py

@@ -13,13 +13,11 @@
 # limitations under the License.
 
 """Pack and unpack parameters to protos and back."""
+
 import iqm.data_definitions.common.v1.parameter_pb2 as ppb
 
 from exa.common.data.parameter import CollectionType, DataType, Parameter
 
-# pylint: disable=no-member
-
-
 _COLLECTION_TYPES = {
     CollectionType.SCALAR: ppb.Parameter.CollectionType.COLLECTION_TYPE_SCALAR,
     CollectionType.LIST: ppb.Parameter.CollectionType.COLLECTION_TYPE_SEQUENCE,

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/api/proto_serialization/array.py

@@ -14,7 +14,6 @@
 
 """Convert numpy arrays to protos and back."""
 
-# pylint: disable=no-member
 import iqm.data_definitions.common.v1.data_types_pb2 as dpb
 import numpy as np
 
@@ -27,6 +26,7 @@ def pack(array: np.ndarray) -> dpb.Array:
 
     Returns:
         A protobuf instance that encapsulates `array`.
+
     """
     target = dpb.Array()
     target.shape.MergeFrom(array.shape)
@@ -65,6 +65,7 @@ def unpack(source: dpb.Array) -> np.ndarray:
 
     Raises:
         ValueError or google.protobuf.message.DecodeError in case of invalid buffer
+
     """
     kind = source.WhichOneof("kind")
     if kind is None:

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/api/proto_serialization/datum.py

@@ -16,12 +16,10 @@
 
 from typing import Optional, Sequence, Union
 
-# pylint: disable=no-member
 import iqm.data_definitions.common.v1.data_types_pb2 as dpb
 import numpy as np
 
-import exa.common.api.proto_serialization.array as array
-import exa.common.api.proto_serialization.sequence as sequence
+from exa.common.api.proto_serialization import array, sequence
 
 
 def pack(value: Union[None, bool, str, int, float, complex, np.ndarray, Sequence]) -> dpb.Datum:
@@ -43,6 +41,7 @@ def pack(value: Union[None, bool, str, int, float, complex, np.ndarray, Sequence
 
     Raises:
         TypeError in case of unsupported type.
+
     """
     if isinstance(value, np.number):
         raise TypeError(
@@ -78,6 +77,7 @@ def unpack(source: dpb.Datum) -> Union[None, str, bool, int, float, complex, np.
 
     Raises:
         TypeError or google.protobuf.message.DecodeError in case of invalid buffer
+
     """
     field_name = source.WhichOneof("kind")
     if field_name == "null_value":
@@ -107,6 +107,7 @@ def serialize(value: Union[None, bool, str, int, float, complex, np.ndarray, Seq
 
     Returns:
           Bitstring that encodes `value`.
+
     """
     return pack(value).SerializeToString()
 
@@ -119,6 +120,7 @@ def deserialize(source: bytes) -> Union[None, str, bool, int, float, complex, np
 
     Returns:
           Deserialized data.
+
     """
     proto = dpb.Datum()
     proto.ParseFromString(source)

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/api/proto_serialization/nd_sweep.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 """Convert NdSweeps to protos and back."""
-# pylint: disable=no-member
+
 import iqm.data_definitions.common.v1.sweep_pb2 as spb
 
 from exa.common.api.proto_serialization import sequence
@@ -45,7 +45,6 @@ def unpack(proto: spb.CartesianSweep) -> NdSweep:
 
     Note: All sweeps will be of type :class:`.FixedSweep`.
     """
-
     nd_sweep = []
     for parallel_proto in reversed(proto.parallel_sweeps):
         parallel = tuple(_unpack_single_sweep(sweep) for sweep in parallel_proto.single_parameter_sweeps)

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/api/proto_serialization/sequence.py

@@ -16,7 +16,6 @@
 
 from typing import Sequence
 
-# pylint: disable=no-member
 import iqm.data_definitions.common.v1.data_types_pb2 as dpb
 import numpy as np
 
@@ -32,23 +31,24 @@ def pack(values: Sequence) -> dpb.Sequence:
 
     Raises:
         ValueError in case of unsupported value.
+
     """
     target = dpb.Sequence()
     if not values:
         return target
     dtype = type(values[0])
-    if dtype == complex:
+    if dtype == complex:  # noqa: E721
         target_field = target.complex128_array
         target_field.real.MergeFrom(np.real(values))
         target_field.imag.MergeFrom(np.imag(values))
         return target
-    if dtype == bool:
+    if dtype == bool:  # noqa: E721
         target_field = target.bool_array
-    elif dtype == int:
+    elif dtype == int:  # noqa: E721
         target_field = target.int64_array
-    elif dtype == float:
+    elif dtype == float:  # noqa: E721
         target_field = target.float64_array
-    elif dtype == str:
+    elif dtype == str:  # noqa: E721
         target_field = target.string_array
     else:
         raise TypeError(f"Unsupported numpy array type {dtype} for a sequence.")
@@ -68,6 +68,7 @@ def unpack(source: dpb.Sequence) -> list:
 
     Raises:
         ValueError or google.protobuf.message.DecodeError in case of invalid buffer
+
     """
     kind = source.WhichOneof("kind")
     if kind is None:

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/api/proto_serialization/setting_node.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 """Convert SettingNodes to protos and back."""
+
 import iqm.data_definitions.common.v1.setting_pb2 as spb
 
 from exa.common.api.proto_serialization import datum
@@ -21,8 +22,6 @@ from exa.common.data.parameter import DataType, Parameter
 from exa.common.data.setting_node import Setting, SettingNode
 from exa.common.helpers.numpy_helper import coerce_numpy_type_to_native
 
-# pylint: disable=no-member
-
 
 def _pack_setting(setting: Setting, optimize: bool) -> spb.SettingNode.Setting:
     """Convert a Setting into protobuf representation."""
@@ -66,6 +65,7 @@ def pack(node: SettingNode, minimal: bool) -> spb.SettingNode:
 
     Returns:
         Protobuf instance that represents `node`.
+
     """
     settings = {key: _pack_setting(item, minimal) for key, item in node.child_settings}
     nodes = {key: pack(item, minimal) for key, item in node.child_nodes}
@@ -81,6 +81,7 @@ def unpack(proto: spb.SettingNode) -> SettingNode:
     Returns:
         Unpacked SettingNode. In case `proto` only contains the parameter names (see ``optimize`` in
         :func:`.pack`), dummy Parameters are generated.
+
     """
     settings = {key: _unpack_setting(content) for key, content in proto.settings.items()}
     nodes = {key: unpack(content) for key, content in proto.subnodes.items()}

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/control/sweep/exponential_sweep.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 """Sweep specification with exponentially spaced values."""
+
 from dataclasses import dataclass, field
 import logging
 import math
@@ -37,6 +38,7 @@ class ExponentialSweep(Sweep):
 
     Raises:
         ValueError: Error is raised if `options` is inconsistent.
+
     """
 
     logger: logging.Logger = field(init=False)

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/control/sweep/fixed_sweep.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 """Sweep specification with arbitrary values."""
+
 from dataclasses import dataclass
 
 import numpy as np

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/control/sweep/function_sweep.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 """Sweep specification with generated parameter values based on callable object."""
+
 from dataclasses import dataclass
 
 from exa.common.control.sweep.option import FunctionOptions

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/control/sweep/linear_sweep.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 """Sweep specification with linearly spaced values."""
+
 from dataclasses import dataclass
 import math
 from typing import Union
@@ -34,6 +35,7 @@ class LinearSweep(Sweep):
 
     Raises:
         ValueError: Error is raised if `options` is inconsistent.
+
     """
 
     def __post_init__(self):

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/control/sweep/option/center_span_base_options.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 """Range specification used with ExponentialSweep."""
+
 from dataclasses import dataclass
 from typing import Union
 

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/control/sweep/option/center_span_options.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 """Range specification to define a range around a center value."""
+
 from dataclasses import dataclass
 from typing import Union
 

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/control/sweep/option/constants.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 """Helper constants for SweepOptions classes."""
+
 from typing import Any, Dict
 
 #: Default value for `count` value in options.

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/control/sweep/option/fixed_options.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 """Range specification for arbitrary set of values."""
+
 from dataclasses import dataclass
 from typing import List, Union
 

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/control/sweep/option/option_converter.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 """Helper to create a SweepOptions instance from a dict."""
+
 import ast
 from typing import Any, Dict, List
 
@@ -45,6 +46,7 @@ def convert_to_options(config: Dict[str, Any]) -> SweepOptions:
 
     Raises:
         ValueError: Error is raised if config has unsupported structure
+
     """
     config = {k.lower(): v for k, v in config.items()}
     if {OPTIONS_TYPE.get("start"), OPTIONS_TYPE.get("stop")}.issubset(set(config)):

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/control/sweep/option/start_stop_base_options.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 """Range specification used with ExponentialSweep."""
+
 from dataclasses import dataclass
 from typing import Union
 

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/control/sweep/option/start_stop_options.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 """Range specification to define a linearly spaced interval."""
+
 from dataclasses import dataclass
 from typing import Union
 

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/control/sweep/sweep.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 """Base immutable class for sweeps specifications."""
+
 from dataclasses import dataclass, field
 from typing import Any, List, Union
 

{iqm_exa_common-25.31 → iqm_exa_common-25.33}/src/exa/common/data/parameter.py

@@ -54,6 +54,7 @@ parameter.
     True
 
 """
+
 from __future__ import annotations
 
 import ast
@@ -250,11 +251,12 @@ class Parameter:
         ``variables = [(par_x: [1,2,3])], extra_variables=[('y', 2)]`` yields the same 3-by-2 data. ``'y'`` will then be
         a "dimension without coordinate" in xarray terms.
 
-         Args:
+        Args:
              variables: Coordinates of the set.
              data: Data Parameter and associated data as a possible nested list.
              attributes: metadata to attach to the whole Dataset.
              extra_variables: Valueless dimensions and their sizes.
+
         """
         variable_names = []
         variable_sizes = []
@@ -321,6 +323,7 @@ class Parameter:
 
         Returns:
             corresponding DataArray
+
         """
         if dimensions is None:
             if len(data.shape) == 1:
@@ -356,6 +359,7 @@ class Parameter:
 
         Raises:
             InvalidParameterValueError: If ``self`` is not collection-valued.
+
         """
         if self.collection_type is CollectionType.SCALAR:
             raise InvalidParameterValueError(
@@ -458,6 +462,7 @@ class Setting:
         Returns:
             A new set of Settings whose parameters are only found in `first`, and Settings in `first` whose
             values differ from their counterparts in `second`.
+
         """
         diff = first.difference(second)
         for s in first.intersection(second):
@@ -492,6 +497,7 @@ class Setting:
 
         Raises:
             ValueError: If ``self`` is not collection-valued.
+
         """
         return self.parameter.create_element_parameter_for(indices)