ruff for linting & formatting

* remove defunct imports
* change developer docs
* ruff format & ruff check --fix

Author: Teque5

docs/source/conf.py

@@ -67,5 +67,5 @@
     "specversion",
 ]
 frozen_locals = dict(locals())
-rst_epilog = '\n'.join(map(lambda x: f".. |{x}| replace:: {frozen_locals[x]}", variables_to_export))
-del frozen_locals
+rst_epilog = "\n".join(map(lambda x: f".. |{x}| replace:: {frozen_locals[x]}", variables_to_export))
+del frozen_locals

docs/source/developers.rst

@@ -42,14 +42,13 @@ To lint the entire project and get suggested changes:
 
 .. code-block:: console
 
-   $ pylint sigmf tests
+   $ ruff check
 
 To autoformat the entire project according to our coding standard:
 
 .. code-block:: console
 
-   $ black sigmf tests # autoformat entire project
-   $ isort sigmf tests # format imports for entire project
+   $ ruff format
 
 ----
 Docs

pyproject.toml

@@ -39,7 +39,7 @@ dependencies = [
     sigmf_convert = "sigmf.convert.__main__:main"
     [project.optional-dependencies]
     test = [
-        "pylint",
+        "ruff",
         "pytest",
         "pytest-cov",
         "hypothesis",   # next-gen testing framework
@@ -99,6 +99,9 @@ line-length = 120
 [tool.isort]
 profile = "black"
 
+[tool.ruff]
+line-length = 120
+
 [tool.tox]
 legacy_tox_ini = '''
     [tox]

sigmf/archivereader.py

@@ -11,9 +11,7 @@
 import zipfile
 from pathlib import Path
 
-from . import __version__
 from .archive import (
-    SIGMF_ARCHIVE_EXT,
     SIGMF_ARCHIVE_EXTS,
     SIGMF_DATASET_EXT,
     SIGMF_METADATA_EXT,

sigmf/convert/wav.py

@@ -17,7 +17,6 @@
 import numpy as np
 
 from .. import SigMFFile
-from .. import __version__ as toolversion
 from .. import fromfile
 from ..error import SigMFFileExistsError
 from ..sigmffile import get_sigmf_filenames

sigmf/siggen.py

@@ -589,7 +589,7 @@ def _build_metadata(self, samples: np.ndarray) -> dict:
             self._description = desc
 
         # build generator info
-        generator_info = f"SigMFGenerator"
+        generator_info = "SigMFGenerator"
         if self._seed is not None:
             generator_info += f"(seed={self._seed:#x})"
 

sigmf/sigmffile.py

@@ -15,7 +15,7 @@
 
 import numpy as np
 
-from . import __specification__, __version__, hashing, schema, validate
+from . import __specification__, hashing, schema, validate
 from .archive import (
     SIGMF_ARCHIVE_EXT,
     SIGMF_COLLECTION_EXT,
@@ -24,7 +24,6 @@
     SIGMF_METADATA_EXT,
     SigMFArchive,
     _detect_compression,
-    _get_archive_basename,
 )
 from .error import (
     SigMFAccessError,

sigmf/utils.py

@@ -10,11 +10,10 @@
 import sys
 from copy import deepcopy
 from datetime import datetime, timezone
-from pathlib import Path
 
 import numpy as np
 
-from .error import SigMFConversionError, SigMFError
+from .error import SigMFError
 
 SIGMF_DATETIME_ISO8601_FMT = "%Y-%m-%dT%H:%M:%S.%fZ"
 

tests/test_archive.py

@@ -18,7 +18,7 @@
 import jsonschema
 import numpy as np
 
-from sigmf import SigMFFile, __specification__, error, fromfile
+from sigmf import SigMFFile, error, fromfile
 from sigmf.archive import SIGMF_DATASET_EXT, SIGMF_METADATA_EXT
 from sigmf.archivereader import SigMFArchiveReader
 

tests/test_archivereader.py

@@ -12,7 +12,7 @@
 import numpy as np
 
 import sigmf
-from sigmf import SigMFArchiveReader, SigMFFile, __specification__
+from sigmf import SigMFArchiveReader, SigMFFile
 
 
 class TestArchiveReader(unittest.TestCase):