chore: linting improvements

Author: mvanwyk

pyproject.toml

@@ -14,6 +14,7 @@ matplotlib = "^3.9.1"
 numpy = "^1.26.3"
 loguru = "^0.7.2"
 tqdm = "^4.66.1"
+great-expectations = "^0.18.19"
 scipy = "^1.13.0"
 scikit-learn = "^1.4.2"
 matplotlib-set-diagrams = "~0.0.2"
@@ -53,4 +54,97 @@ show_missing = true
 skip_covered = true
 
 [tool.ruff]
+target-version = "py310"
 line-length=120
+show-fixes = true
+
+[tool.ruff.lint]
+ignore = [
+    "ANN101",
+    "ANN102",
+    "EM101",
+    "TRY003", # Disable until we start creating proper exception classes
+    "PT011",  # Disable until we start creating proper exception classes
+    "PTH123", # Not using open() to open files
+]
+select = [
+    "A",    # Builtins
+    "ANN",  # Annotations
+    "ARG",  # Unused arguments
+    "B",    # Bugbear
+    "BLE",  # Blind except
+    "C4",   # Comprehensions
+    "C90",  # mccabe
+    "COM",  # Commas
+    "D",
+    "D1",   # Undocumented public elements
+    "D2",   # Docstring conventions
+    "D3",   # Triple double quotes
+    "D4",   # Docstring text format
+    "DTZ",  # Datetimes
+    "EM",   # Error messages
+    "ERA",  # Commented-out code
+    "EXE",  # Executable
+    "F",    # Pyflakes
+    "FA",   # __future__ annotations
+    "FLY",  # F-strings
+    # "FURB", # Refurb
+    "G",    # Logging format
+    "I",    # Isort
+    "ICN",  # Import conventions
+    "INP",  # Disallow PEP-420 (Implicit namespace packages)
+    "INT",  # gettext
+    "ISC",  # Implicit str concat
+    # "LOG",  # Logging
+    "N",    # PEP-8 Naming
+    "NPY",  # Numpy
+    "PERF", # Unnecessary performance costs
+    "PGH",  # Pygrep hooks
+    "PIE",  # Unnecessary code
+    "PL",   # Pylint
+    "PT",   # Pytest
+    "PTH",  # Use Pathlib
+    "PYI",  # Stub files
+    "Q",    # Quotes
+    "RET",  # Return
+    "RUF",  # Ruff
+    "RSE",  # Raise
+    "S",    # Bandit
+    "SIM",  # Code simplification
+    "SLF",  # Private member access
+    "SLOT", # __slots__
+    "T10",  # Debugger
+    "T20",  # Print
+    "TCH",  # Type checking
+    "TID",  # Tidy imports
+    "TRY",  # Exception handling
+    "UP",   # Pyupgrade
+    "W",    # Warnings
+    "YTT",  # sys.version
+]
+
+
+[tool.ruff.lint.per-file-ignores]
+# https://beta.ruff.rs/docs/rules/
+"__init__.py" = ["F401","F403","F405","D104"]
+"tests/*" = ["ANN", "ARG", "INP001", "S101", "SLF001"]
+"*.ipynb" = ["T201"]
+
+[tool.ruff.lint.pylint]
+max-args = 15
+max-branches = 20
+max-returns = 10
+max-statements = 80
+
+[tool.ruff.lint.flake8-tidy-imports]
+ban-relative-imports = "all"
+
+[tool.ruff.lint.flake8-quotes]
+docstring-quotes = "double"
+multiline-quotes = "double"
+
+[tool.ruff.lint.mccabe]
+max-complexity = 10
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"

tests/test_gain_loss.py

@@ -1,9 +1,12 @@
+"""Tests for the GainLoss class in the gain_loss module."""
+
 import pytest
+
 from pyretailscience.gain_loss import GainLoss
 
 
 @pytest.mark.parametrize(
-    "focus_p1, comparison_p1, focus_p2, comparison_p2, focus_diff, comparison_diff, expected",
+    ("focus_p1", "comparison_p1", "focus_p2", "comparison_p2", "focus_diff", "comparison_diff", "expected"),
     [
         # Test when a new customer is added (focus_p1 and comparison_p1 are 0)
         (0, 0, 100, 0, 100, 0, (100, 0, 0, 0, 0, 0)),
@@ -52,8 +55,15 @@
     ],
 )
 def test_process_customer_group(
-    focus_p1, comparison_p1, focus_p2, comparison_p2, focus_diff, comparison_diff, expected
+    focus_p1,
+    comparison_p1,
+    focus_p2,
+    comparison_p2,
+    focus_diff,
+    comparison_diff,
+    expected,
 ):
+    """Test the process_customer_group method of the GainLoss class."""
     result = GainLoss.process_customer_group(
         focus_p1=focus_p1,
         comparison_p1=comparison_p1,