Comment on ruff rules

Author: cclauss

Diff for: data_structures/heap/heap_generic.py

@@ -166,7 +166,6 @@ def test_heap() -> None:
     >>> h.get_top()
     [9, -40]
     """
-    pass
 
 
 if __name__ == "__main__":

Diff for: maths/eulers_totient.py

@@ -1,5 +1,20 @@
 # Eulers Totient function finds the number of relative primes of a number n from 1 to n
 def totient(n: int) -> list:
+    """
+    >>> n = 10
+    >>> totient_calculation = totient(n)
+    >>> for i in range(1, n):
+    ...     print(f"{i} has {totient_calculation[i]} relative primes.")
+    1 has 0 relative primes.
+    2 has 1 relative primes.
+    3 has 2 relative primes.
+    4 has 2 relative primes.
+    5 has 4 relative primes.
+    6 has 2 relative primes.
+    7 has 6 relative primes.
+    8 has 4 relative primes.
+    9 has 6 relative primes.
+    """
     is_prime = [True for i in range(n + 1)]
     totients = [i - 1 for i in range(n + 1)]
     primes = []
@@ -20,25 +35,6 @@ def totient(n: int) -> list:
     return totients
 
 
-def test_totient() -> None:
-    """
-    >>> n = 10
-    >>> totient_calculation = totient(n)
-    >>> for i in range(1, n):
-    ...     print(f"{i} has {totient_calculation[i]} relative primes.")
-    1 has 0 relative primes.
-    2 has 1 relative primes.
-    3 has 2 relative primes.
-    4 has 2 relative primes.
-    5 has 4 relative primes.
-    6 has 2 relative primes.
-    7 has 6 relative primes.
-    8 has 4 relative primes.
-    9 has 6 relative primes.
-    """
-    pass
-
-
 if __name__ == "__main__":
     import doctest
 

Diff for: maths/pythagoras.py

@@ -14,17 +14,13 @@ def __repr__(self) -> str:
 
 
 def distance(a: Point, b: Point) -> float:
-    return math.sqrt(abs((b.x - a.x) ** 2 + (b.y - a.y) ** 2 + (b.z - a.z) ** 2))
-
-
-def test_distance() -> None:
     """
     >>> point1 = Point(2, -1, 7)
     >>> point2 = Point(1, -3, 5)
     >>> print(f"Distance from {point1} to {point2} is {distance(point1, point2)}")
     Distance from Point(2, -1, 7) to Point(1, -3, 5) is 3.0
     """
-    pass
+    return math.sqrt(abs((b.x - a.x) ** 2 + (b.y - a.y) ** 2 + (b.z - a.z) ** 2))
 
 
 if __name__ == "__main__":

Diff for: pyproject.toml

@@ -17,49 +17,51 @@ ignore-words-list = "3rt,ans,crate,damon,fo,followings,hist,iff,kwanza,mater,sec
 skip = "./.*,*.json,ciphers/prehistoric_men.txt,project_euler/problem_022/p022_names.txt,pyproject.toml,strings/dictionary.txt,strings/words.txt"
 
 [tool.ruff]
-ignore = [
-    "B904",
-    "B905",
-    "E741",
-    "N999",
-    "PLC1901",
-    "PLR2004",
-    "PLR5501",
-    "PLW0120",
-    "PLW060",
-    "PLW2901",
-    "RUF00",
-    "RUF100",
-    "S101",
-    "S105",
-    "S113",
-    "UP038",
+ignore = [      # `ruff rule S101` for a description of that rule
+    "B904",     # B904: Within an `except` clause, raise exceptions with `raise ... from err`
+    "B905",     # B905: `zip()` without an explicit `strict=` parameter
+    "E741",     # E741: Ambiguous variable name 'l'
+    "G004",     # G004 Logging statement uses f-string
+    "N999",     # N999: Invalid module name
+    "PLC1901",  # PLC1901: `{}` can be simplified to `{}` as an empty string is falsey
+    "PLR2004",  # PLR2004: Magic value used in comparison
+    "PLR5501",  # PLR5501: Consider using `elif` instead of `else`
+    "PLW0120",  # PLW0120: `else` clause on loop without a `break` statement
+    "PLW060",   # PLW060: Using global for `{name}` but no assignment is done -- DO NOT FIX
+    "PLW2901",  # PLW2901: Redefined loop variable
+    "RUF00",    # RUF00: Ambiguous unicode character -- DO NOT FIX
+    "RUF100",   # RUF100: Unused `noqa` directive
+    "S101",     # S101: Use of `assert` detected -- DO NOT FIX
+    "S105",     # S105: Possible hardcoded password: 'password'
+    "S113",     # S113: Probable use of requests call without timeout
+    "UP038",    # UP038: Use `X | Y` in `{}` call instead of `(X, Y)` -- DO NOT FIX
 ]
-select = [
-    "A",
-    "B",
-    "C40",
-    "C9",
-    "E",
-    "F",
-    "I",
-    "N",
-    "PLC",
-    "PLE",
-    "PLR",
-    "PLW",
-    "RUF",
-    "S",
-    "UP",
-    "W",
-    "YTT",
+select = [      # https://beta.ruff.rs/docs/rules
+    "A",        # A: builtins
+    "B",        # B: bugbear
+    "C40",      # C40: comprehensions
+    "C90",      # C90: mccabe code complexity
+    "E",        # E: pycodestyle errors
+    "F",        # F: pyflakes
+    "G",        # G: logging format
+    "I",        # I: isort
+    "N",        # N: pep8 naming
+    "PL",       # PL: pylint
+    "PIE",      # PIE: pie
+    "PYI",      # PYI: type hinting stub files
+    "RUF",      # RUF: ruff
+    "S",        # S: bandit
+    "TID",      # TID: tidy imports
+    "UP",       # UP: pyupgrade
+    "W",        # W: pycodestyle warnings
+    "YTT",      # YTT: Year Two Thousand
 ]
 target-version = "py311"
 
-[tool.ruff.mccabe]
+[tool.ruff.mccabe]   # DO NOT INCREASE THIS VALUE
 max-complexity = 20  # default: 10
 
-[tool.ruff.pylint]
+[tool.ruff.pylint]   # DO NOT INCREASE THESE VALUES
 max-args = 10  # default: 5
 max-branches = 20  # default: 12
 max-returns = 8  # default: 6