Remove unnecessary function and lots of linting

doc/conf.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # TFS-Pandas documentation build configuration file, created by
 # sphinx-quickstart on Tue Feb  6 12:10:18 2018.
@@ -54,7 +53,7 @@ def about_package(init_posixpath: pathlib.Path) -> dict:
     "sphinx.ext.coverage",  # Collect doc coverage stats
     "sphinx.ext.doctest",  # Test snippets in the documentation
     "sphinx.ext.githubpages",  # Publish HTML docs in GitHub Pages
-    "sphinx.ext.intersphinx",  # Link to other projects’ documentation
+    "sphinx.ext.intersphinx",  # Link to other projects' documentation
     "sphinx.ext.mathjax",  # Render math via JavaScript
     "sphinx.ext.napoleon",  # Support for NumPy and Google style docstrings
     "sphinx.ext.todo",  # Support for todo items
@@ -244,4 +243,4 @@ def about_package(init_posixpath: pathlib.Path) -> dict:
     "matplotlib": ("https://matplotlib.org/stable/", None),
     "scipy": ("https://docs.scipy.org/doc/scipy/", None),
     "cpymad": ("https://hibtc.github.io/cpymad/", None),
-}
+}

pyproject.toml

@@ -86,3 +86,9 @@ homepage = "https://github.com/pylhc/tfs"
 repository = "https://github.com/pylhc/tfs"
 documentation = "https://pylhc.github.io/tfs/ "
 changelog = "https://github.com/pylhc/tfs/blob/master/CHANGELOG.md"
+
+
+[tool.ruff]
+
+# Assume Python 3.9+
+target-version = "py39"

tests/test_collection.py

@@ -1,5 +1,5 @@
-import os
 import pathlib
+
 import pytest
 from pandas.testing import assert_frame_equal
 
@@ -143,8 +143,8 @@ def test_buffer_flush_nowrite(self, _input_dir_str: str, _tfs_x: TfsDataFrame, _
         assert_frame_equal(tfs_y, read_tfs(c.get_path("nofile_y"), index=c.INDEX))
 
         c.allow_write = False
-        with pytest.raises(IOError):
-            c.flush()
+        with pytest.raises(OSError, match="Cannot flush TfsCollection"):
+            c.flush()  # because allow_write is set to False
 
         tfs_x_after_flush = read_tfs(c.get_path("file_x"), index=c.INDEX)
         tfs_y_after_flush = read_tfs(c.get_path("nofile_y"), index=c.INDEX)
@@ -156,7 +156,7 @@ class TestFilenames:
 
     def test_tfscollection_getfilename_not_implemented(self):
         with pytest.raises(NotImplementedError):
-            TfsCollection._get_filename("doesnt matter")
+            TfsCollection._get_filename("doesnt matter")  # noqa: SLF001
 
     def test_get_filename(self, _input_dir_pathlib: pathlib.Path):
         c = CollectionTest(_input_dir_pathlib, allow_write=False)
@@ -186,13 +186,13 @@ def test_filenames(self, _input_dir_pathlib: pathlib.Path):
         assert c.filenames()["file_x"] == "file_x.tfs"
         assert c.filenames()["nofile_y"] == "nofile_y.tfs"
 
-        assert all(f in c.filenames().keys() for f in exist_properties)
-        assert all(f in c.filenames().keys() for f in not_exist_properties)
+        assert all(f in c.filenames() for f in exist_properties)
+        assert all(f in c.filenames() for f in not_exist_properties)
         assert all(f in c.filenames().values() for f in exist_files)
         assert all(f in c.filenames().values() for f in not_exist_files)
 
-        assert all(f in c.filenames(exist=True).keys() for f in exist_properties)
-        assert all(f not in c.filenames(exist=True).keys() for f in not_exist_properties)
+        assert all(f in c.filenames(exist=True) for f in exist_properties)
+        assert all(f not in c.filenames(exist=True) for f in not_exist_properties)
         assert all(f in c.filenames(exist=True).values() for f in exist_files)
         assert all(f not in c.filenames(exist=True).values() for f in not_exist_files)
 
@@ -254,10 +254,10 @@ def _test_fun(df, a, b):
         assert res_file[1] == 13
 
     def test_buffer_clear(self, _dummy_collection):
-        _dummy_collection._buffer["some_key"] = 5
-        assert _dummy_collection._buffer["some_key"]
+        _dummy_collection._buffer["some_key"] = 5  # noqa: SLF001
+        assert _dummy_collection._buffer["some_key"]  # noqa: SLF001
         _dummy_collection.clear()
-        assert not _dummy_collection._buffer
+        assert not _dummy_collection._buffer  # noqa: SLF001
 
     def test_no_attribute(self, _dummy_collection):
         with pytest.raises(AttributeError):
@@ -269,26 +269,26 @@ def _read_tfs(path):
     return read_tfs(path).set_index("NAME", drop=False)
 
 
-@pytest.fixture()
+@pytest.fixture
 def _tfs_x() -> TfsDataFrame:
     return _read_tfs(INPUT_DIR / "file_x.tfs")
 
 
-@pytest.fixture()
+@pytest.fixture
 def _tfs_y() -> TfsDataFrame:
     return _read_tfs(INPUT_DIR / "file_y.tfs")
 
 
-@pytest.fixture()
+@pytest.fixture
 def _input_dir_pathlib() -> pathlib.Path:
     return INPUT_DIR
 
 
-@pytest.fixture()
+@pytest.fixture
 def _input_dir_str() -> str:
     return str(INPUT_DIR)
 
 
-@pytest.fixture()
+@pytest.fixture
 def _dummy_collection() -> TfsCollection:
     return TfsCollection("")

tests/test_compression.py

@@ -14,11 +14,6 @@
 CURRENT_DIR = pathlib.Path(__file__).parent
 
 
-# TODO: remove the skipif once Python 3.7 is EoL and we drop support for it
-@pytest.mark.skipif(
-    sys.version_info < (3, 8),
-    reason="Not run on Python 3.7 for format protocol incompatibility reasons",
-)
 @pytest.mark.parametrize("extension", ["gz", "bz2", "zip", "xz", "zst", "tar", "tar.gz"])
 def test_read_compressed_is_same_data(_tfs_filex, _tfs_compressed_filex_no_suffix, extension):
     """Compare the data from a compressed file with the original one."""
@@ -33,11 +28,6 @@ def test_read_compressed_is_same_data(_tfs_filex, _tfs_compressed_filex_no_suffi
     assert_frame_equal(ref_df, test_df)
 
 
-# TODO: remove the skipif once Python 3.7 is EoL and we drop support for it
-@pytest.mark.skipif(
-    sys.version_info < (3, 8),
-    reason="Not run on Python 3.7 for format protocol incompatibility reasons",
-)
 @pytest.mark.parametrize("extension", ["gz", "bz2", "zip", "xz", "zst", "tar", "tar.gz"])
 def test_write_read_compressed(_tfs_filey, tmp_path, extension):
     """Ensure that writing in compressed format preserves data."""
@@ -57,11 +47,6 @@ def test_write_read_compressed(_tfs_filey, tmp_path, extension):
     assert_frame_equal(ref_df, test_df)
 
 
-# TODO: remove the skipif once Python 3.7 is EoL and we drop support for it
-@pytest.mark.skipif(
-    sys.version_info < (3, 8),
-    reason="Not run on Python 3.7 for format protocol incompatibility reasons",
-)
 @pytest.mark.parametrize("extension", ["gz", "bz2", "zip", "xz", "zst", "tar", "tar.gz"])
 def test_read_headers_compressed(_tfs_compressed_filex_no_suffix, extension):
     compressed_file = _path_with_added_extension(_tfs_compressed_filex_no_suffix, extension)
@@ -70,7 +55,7 @@ def test_read_headers_compressed(_tfs_compressed_filex_no_suffix, extension):
     assert len(headers) > 0
     assert len(str(headers)) > 0
     assert all(
-        key in headers.keys()
+        key in headers
         for key in ["TITLE", "DPP", "Q1", "Q1RMS", "NATQ1", "NATQ1RMS", "BPMCOUNT"]
     )
 
@@ -86,23 +71,23 @@ def _path_with_added_extension(path: pathlib.Path, extension: str) -> pathlib.Pa
 # ------ Fixtures ------ #
 
 
-@pytest.fixture()
+@pytest.fixture
 def _tfs_filex() -> pathlib.Path:
     return CURRENT_DIR / "inputs" / "file_x.tfs"
 
 
-@pytest.fixture()
+@pytest.fixture
 def _tfs_filey() -> pathlib.Path:
     return CURRENT_DIR / "inputs" / "file_y.tfs"
 
 
-@pytest.fixture()
+@pytest.fixture
 def _tfs_compressed_filex_no_suffix() -> pathlib.Path:
     """Add the wanted compression suffix to this."""
     return CURRENT_DIR / "inputs" / "compressed" / "file_x.tfs"
 
 
-@pytest.fixture()
+@pytest.fixture
 def _tfs_compressed_filey_no_suffix() -> pathlib.Path:
     """Add the wanted compression suffix to this."""
     return CURRENT_DIR / "inputs" / "compressed" / "file_y.tfs"

tests/test_frame.py

@@ -14,29 +14,29 @@
 
 
 class TestFailures:
-    def test_validate_raises_on_wrong_unique_behavior(self, caplog):
+    def test_validate_raises_on_wrong_unique_behavior(self):
         df = TfsDataFrame(index=["A", "B", "A"], columns=["A", "B", "A"])
         with pytest.raises(KeyError):
             validate(df, "", non_unique_behavior="invalid")
 
     @pytest.mark.parametrize("how", ["invalid", "not_left", "not_right"])
-    def test_merge_headers_raises_on_invalid_how_key(self, caplog, how):
+    def test_merge_headers_raises_on_invalid_how_key(self, how):
         headers_left = OrderedDict()
         headers_right = OrderedDict()
 
-        with pytest.raises(ValueError):
+        with pytest.raises(ValueError, match="Invalid 'how' argument"):
             merge_headers(headers_left, headers_right, how=how)
 
     def test_access_errors(self):
         df = TfsDataFrame(index=["A", "B", "A"], columns=["A", "B", "A"], headers={"HEADER": 10})
         with pytest.raises(AttributeError):
-            df.does_not_exist
+            _ = df.does_not_exist
 
         with pytest.raises(KeyError):
-            df["does also not exist"]
+            _ = df["does also not exist"]
 
         with pytest.raises(KeyError):  # raises KeyError in pandas, TypeError in dict
-            df[[1, 2, 3]]
+            _ = df[[1, 2, 3]]
 
 
 class TestTfsDataFrameMerging:
@@ -79,7 +79,8 @@ def test_headers_merging_left(self, _tfs_file_x_pathlib, _tfs_file_y_pathlib, ho
         result = merge_headers(headers_left, headers_right, how=how)
 
         assert isinstance(result, OrderedDict)
-        assert len(result) >= len(headers_left) and len(result) >= len(headers_right)  # no key disappeared
+        assert len(result) >= len(headers_left)  # no key disappeared
+        assert len(result) >= len(headers_right)  # no key disappeared
         for key in result:  # check that we prioritized headers_left's contents
             if key in headers_left and key in headers_right:
                 assert result[key] == headers_left[key]
@@ -91,7 +92,8 @@ def test_headers_merging_right(self, _tfs_file_x_pathlib, _tfs_file_y_pathlib, h
         result = merge_headers(headers_left, headers_right, how=how)
 
         assert isinstance(result, OrderedDict)
-        assert len(result) >= len(headers_left) and len(result) >= len(headers_right)  # no key disappeared
+        assert len(result) >= len(headers_left)  # no key disappeared
+        assert len(result) >= len(headers_right)  # no key disappeared
         for key in result:  # check that we prioritized headers_right's contents
             if key in headers_left and key in headers_right:
                 assert result[key] == headers_right[key]
@@ -132,7 +134,7 @@ def test_long_headers_print(self):
         assert "Headers" in print_out
 
         # Check that the ellipsis worked
-        assert not all(key in print_out for key in headers.keys())
+        assert not all(key in print_out for key in headers)
         assert not all(str(val) in print_out for val in headers.values())
         assert "..." in print_out
 
@@ -185,11 +187,11 @@ def test_concatenating_accepts_pandas_dataframes(
 # ------ Fixtures ------ #
 
 
-@pytest.fixture()
+@pytest.fixture
 def _tfs_file_x_pathlib() -> pathlib.Path:
     return CURRENT_DIR / "inputs" / "file_x.tfs"
 
 
-@pytest.fixture()
+@pytest.fixture
 def _tfs_file_y_pathlib() -> pathlib.Path:
     return CURRENT_DIR / "inputs" / "file_x.tfs"

tests/test_hdf.py

@@ -1,12 +1,12 @@
-import sys
 
-import numpy as np
-import pytest
 from pathlib import Path
 
-from tfs import TfsDataFrame, write_hdf, read_hdf
-from pandas.testing import assert_frame_equal
+import numpy as np
+import pytest
 from pandas._testing import assert_dict_equal
+from pandas.testing import assert_frame_equal
+
+from tfs import TfsDataFrame, read_hdf, write_hdf
 
 
 class TestHDF: