STY: Apply ruff rule RUF012

RUF012 Mutable class attributes should be annotated with `typing.ClassVar`

Author: DimitriPapadopoulos

doc/tools/apigen.py

@@ -32,7 +32,7 @@ class ApiDocWriter:
     to Sphinx-parsable reST format"""
 
     # only separating first two levels
-    rst_section_levels = ['*', '=', '-', '~', '^']
+    rst_section_levels = ('*', '=', '-', '~', '^')
 
     def __init__(
         self,

nibabel/analyze.py

@@ -185,7 +185,7 @@ class AnalyzeHeader(LabeledWrapStruct, SpatialHeader):
     template_dtype = header_dtype
     _data_type_codes = data_type_codes
     # fields with recoders for their values
-    _field_recoders = {'datatype': data_type_codes}
+    _field_recoders = {'datatype': data_type_codes}  # noqa: RUF012
     # default x flip
     default_x_flip = True
 

nibabel/cifti2/cifti2.py

@@ -1045,7 +1045,7 @@ class Cifti2MatrixIndicesMap(xml.XmlSerializable, MutableSequence):
         If it is a series, units
     """
 
-    _valid_type_mappings_ = {
+    _valid_type_mappings_ = {  # noqa: RUF012
         Cifti2BrainModel: ('CIFTI_INDEX_TYPE_BRAIN_MODELS',),
         Cifti2Parcel: ('CIFTI_INDEX_TYPE_PARCELS',),
         Cifti2NamedMap: ('CIFTI_INDEX_TYPE_LABELS',),

nibabel/nifti1.py

@@ -811,7 +811,7 @@ class Nifti1Header(SpmAnalyzeHeader):
     _data_type_codes = data_type_codes
 
     # fields with recoders for their values
-    _field_recoders = {
+    _field_recoders = {  # noqa: RUF012
         'datatype': data_type_codes,
         'qform_code': xform_codes,
         'sform_code': xform_codes,

nibabel/openers.py

@@ -131,7 +131,7 @@ class Opener:
     gz_def = (_gzip_open, ('mode', 'compresslevel', 'mtime', 'keep_open'))
     bz2_def = (BZ2File, ('mode', 'buffering', 'compresslevel'))
     zstd_def = (_zstd_open, ('mode', 'level_or_option', 'zstd_dict'))
-    compress_ext_map: dict[str | None, OpenerDef] = {
+    compress_ext_map: dict[str | None, OpenerDef] = {  # noqa: RUF012
         '.gz': gz_def,
         '.bz2': bz2_def,
         '.zst': zstd_def,
@@ -141,7 +141,7 @@ class Opener:
     default_compresslevel = 1
     #: default option for zst files
     default_zst_compresslevel = 3
-    default_level_or_option = {
+    default_level_or_option = {  # noqa: RUF012
         'rb': None,
         'r': None,
         'wb': default_zst_compresslevel,

nibabel/tests/test_analyze.py

@@ -58,7 +58,7 @@ class TestAnalyzeHeader(tws._TestLabeledWrapStruct):
     header_class = AnalyzeHeader
     example_file = header_file
     sizeof_hdr = AnalyzeHeader.sizeof_hdr
-    supported_np_types = {np.uint8, np.int16, np.int32, np.float32, np.float64, np.complex64}
+    supported_np_types = frozenset((np.uint8, np.int16, np.int32, np.float32, np.float64, np.complex64))
     add_duplicate_types(supported_np_types)
 
     def test_supported_types(self):

nibabel/tests/test_brikhead.py

@@ -136,10 +136,10 @@ def test_brikheadfile(self):
 
 class TestBadVars:
     module = brikhead
-    vars = [
+    vars = (
         'type = badtype-attribute\nname = BRICK_TYPES\ncount = 1\n1\n',
         'type = integer-attribute\ncount = 1\n1\n',
-    ]
+    )
 
     def test_unpack_var(self):
         for var in self.vars:

nibabel/tests/test_minc2_data.py

@@ -35,11 +35,11 @@ def _make_affine(coses, zooms, starts):
 
 class TestEPIFrame:
     opener = staticmethod(top_load)
-    x_cos = [1, 0, 0]
-    y_cos = [0.0, 1, 0]
-    z_cos = [0, 0, 1]
-    zooms = [-0.8984375, -0.8984375, 3.0]
-    starts = [117.25609125, 138.89861125, -54.442028]
+    x_cos = (1, 0, 0)
+    y_cos = (0.0, 1, 0)
+    z_cos = (0, 0, 1)
+    zooms = (-0.8984375, -0.8984375, 3.0)
+    starts = (117.25609125, 138.89861125, -54.442028)
     example_params = dict(
         fname=os.path.join(MINC2_PATH, 'mincex_EPI-frame.mnc'),
         shape=(40, 256, 256),
@@ -74,11 +74,11 @@ def test_load(self):
 
 
 class TestB0(TestEPIFrame):
-    x_cos = [0.9970527523765, 0.0, 0.0767190261828617]
-    y_cos = [0.0, 1.0, -6.9388939e-18]
-    z_cos = [-0.0767190261828617, 6.9184432614435e-18, 0.9970527523765]
-    zooms = [-0.8984375, -0.8984375, 6.49999990444107]
-    starts = [105.473101260826, 151.74885125, -61.8714747993248]
+    x_cos = (0.9970527523765, 0.0, 0.0767190261828617)
+    y_cos = (0.0, 1.0, -6.9388939e-18)
+    z_cos = (-0.0767190261828617, 6.9184432614435e-18, 0.9970527523765)
+    zooms = (-0.8984375, -0.8984375, 6.49999990444107)
+    starts = (105.473101260826, 151.74885125, -61.8714747993248)
     example_params = dict(
         fname=os.path.join(MINC2_PATH, 'mincex_diff-B0.mnc'),
         shape=(19, 256, 256),
@@ -105,11 +105,11 @@ class TestFA(TestEPIFrame):
 
 
 class TestGado(TestEPIFrame):
-    x_cos = [0.999695413509548, -0.0174524064372835, 0.0174497483512505]
-    y_cos = [0.0174497483512505, 0.999847695156391, 0.000304586490452135]
-    z_cos = [-0.0174524064372835, 0.0, 0.999847695156391]
-    zooms = [1, -1, -1]
-    starts = [-75.76775, 115.80462, 81.38605]
+    x_cos = (0.999695413509548, -0.0174524064372835, 0.0174497483512505)
+    y_cos = (0.0174497483512505, 0.999847695156391, 0.000304586490452135)
+    z_cos = (-0.0174524064372835, 0.0, 0.999847695156391)
+    zooms = (1, -1, -1)
+    starts = (-75.76775, 115.80462, 81.38605)
     example_params = dict(
         fname=os.path.join(MINC2_PATH, 'mincex_gado-contrast.mnc'),
         shape=(100, 170, 146),
@@ -124,11 +124,11 @@ class TestGado(TestEPIFrame):
 
 
 class TestT1(TestEPIFrame):
-    x_cos = [1, 0, 0]
-    y_cos = [0, 1, 0]
-    z_cos = [0, 0, 1]
-    zooms = [1, 1, 1]
-    starts = [-90, -126, -12]
+    x_cos = (1, 0, 0)
+    y_cos = (0, 1, 0)
+    z_cos = (0, 0, 1)
+    zooms = (1, 1, 1)
+    starts = (-90, -126, -12)
     example_params = dict(
         fname=os.path.join(MINC2_PATH, 'mincex_t1.mnc'),
         shape=(110, 217, 181),

nibabel/wrapstruct.py

@@ -112,6 +112,8 @@
 
 from __future__ import annotations
 
+from typing import ClassVar
+
 import numpy as np
 
 from . import imageglobals as imageglobals
@@ -485,7 +487,7 @@ def _get_checks(klass):
 class LabeledWrapStruct(WrapStruct):
     """A WrapStruct with some fields having value labels for printing etc"""
 
-    _field_recoders: dict[str, Recoder] = {}  # for recoding values for str
+    _field_recoders: ClassVar[dict[str, Recoder]] = {}  # for recoding values for str
 
     def get_value_label(self, fieldname):
         """Returns label for coded field

nibabel/xmlutils.py

@@ -49,7 +49,7 @@ class XmlParser:
         CharacterDataHandler
     """
 
-    HANDLER_NAMES = ['StartElementHandler', 'EndElementHandler', 'CharacterDataHandler']
+    HANDLER_NAMES = ('StartElementHandler', 'EndElementHandler', 'CharacterDataHandler')
 
     def __init__(self, encoding='utf-8', buffer_size=35000000, verbose=0):
         """