Adjusted Ruff settings and re-linted code

Author: avdstaaij

docs/source/conf.py

@@ -8,6 +8,7 @@
 import re
 import shutil
 
+
 SCRIPT_DIR = os.path.abspath(os.path.dirname(__file__))
 
 

pyproject.toml

@@ -39,51 +39,54 @@ select = ["ALL"]
 ignore = [
     # Reason for ignoring:
     # DI: Disagree         - I disagree with this rule in nearly all cases.
-    # AL: Alternative      - The rule is incompatible with an alternative rule.
+    # HI: Hint             - The rule would be useful at hint-severity, if ruff supported that.
     # TB: Too broad        - The rule is sometimes useful, but gives too many false positives.
+    # AL: Alternative      - The rule is incompatible with an alternative rule.
     # PA: Public API       - The fix may require changing a public API, making this rule unusable in many cases.
-    # HI: Hint             - The rule would be useful at hint-severity, if ruff supported that.
+    # NA: Not applicable   - The rule is not applicable in this particular situation / project type / directory.
     # PR: Project-specific - There is a project-specific reason to not use this rule.
 
     # Mainly DI
+    "D203",    # incorrect-blank-line-before-class - DI, AL - Disabled in favor of D211.
     "RUF010",  # explicit-f-string-type-conversion - DI - Explicit conversion is more readable. See also https://peps.python.org/pep-0498/#s-r-and-a-are-redundant
 
-    # Mainly AL
-    "D203",    # incorrect-blank-line-before-class - AL - Disabled in favor of D211.
-    "D213",    # multi-line-summary-second-line - AL - Disabled in favor of D212.
+    # Mainly HI
+    "FIX",     # flake8-fixme - HI
+    "TD",      # flake8-todos - HI
 
     # Mainly TB
     "ANN401",  # any-type - TB - Any can be useful for very generic interfaces or as an acceptable temporary solution.
     "B007",    # unused-loop-control-variable - TB - The loop variable may be used after the loop; it might count something. Redundant with F841.
     "C90",     # mccabe - TB - May be hard to fix, and real issues can be spotted manually.
-    "D1",      # undocumented-* - TB - Documenting everything is not necessary in scripts.
     "D105",    # undocumented-magic-method - TB - Many magic methods are self-explanatory.
     "D202",    # blank-line-after-function - TB - Adding a blank line can improve readability when the docstring is short.
     "D204",    # incorrect-blank-line-after-class - TB - The blank line can be unnecessary for very short classes.
     "D205",    # missing-blank-line-after-summary - TB - A single line is sometimes too limiting, and most tools can handle multiple lines.
     "D209",    # new-line-after-last-paragraph - TB - It's a bit nasty, but breaking this rule can help compactify short docstrings.
     "D301",    # escape-sequence-in-docstring - TB - It's a bit nasty, but breaking this rule with "\n" can help compactify short docstrings.
-    "D400",    # missing-trailing-period - TB - Other punctuation is also acceptable. We use D415 instead.
+    "D400",    # missing-trailing-period - TB, AL - Other punctuation is also acceptable. Disabled in favor of D415.
     "D401",    # non-imperative-mood - TB - This is very controversial. I personally prefer the descriptive mood in most cases.
     "D404",    # docstring-starts-with-this - TB - There are valid usages of "this", such as when referring to a method's object.
     "E501",    # line-too-long - TB - Lines occasionally need to be longer, such as when a comment contains a long link.
     "E701",    # multiple-statements - TB - Single-line if-statements can be more readable in certain scenarios.
     "E741",    # ambiguous-variable-name - TB - "l" is often fine, and the others may occasionally be fine as well.
     "ERA001",  # commented-out-code - TB - Commenting out code is sometimes useful, and this also triggers on intentional code examples.
-    "FBT001",  # boolean-type-hint-positional-argument - TB, PA - Mostly redundant with FBT003.
-    "FBT002",  # boolean-default-value-positional-argument - TB, PA - Mostly redundant with FBT003.
+    "FBT001",  # boolean-type-hint-positional-argument - TB, PA, and mostly redundant with FBT003.
+    "FBT002",  # boolean-default-value-positional-argument - TB, PA, and mostly redundant with FBT003.
     "INP001",  # implicit-namespace-package - TB - The namespace package may be intentional. Also triggers on Sphinx' conf.py.
     "ISC003",  # explicit-string-concatenation - TB - In cases where some lines are literals and some expressions, it is clearer to use + everywhere.
     "PERF203", # try-except-in-loop - TB - The try-except can often not be taken out of the loop.
     "PLR091",  # too-many-* - TB, PA - Real issues can be spotted manually.
     "PLR2004", # magic-value-comparison - TB - Although this rule is often right, there are also many cases where a constant is overkill.
     "PLW2901", # redefined-loop-name - TB - Reuse of the loop variable can help keep names simple. This rule does have a strong case, though.
     "PTH",     # flake8-use-pathlib - TB, HI - Old-style path manipulation is acceptable, and occasionally even more readable.
+    "S101",    # assert - TB - Assertions can be useful, such as for telling type checkers that a value cannot be None.
     "S311",    # suspicious-non-cryptographic-random-usage - TB - Not all random usages are cryptographic.
+    "S603",    # subprocess-without-shell-equals-true - TB - (Rule name is misleading.) This triggers so easily that it is practically unusable.
+    "SIM108",  # if-else-block-instead-of-if-exp - TB - A regular if-statement is sometimes more readable or consistent.
 
-    # Mainly HI
-    "FIX",     # flake8-fixme - HI
-    "TD",      # flake8-todos - HI
+    # Mainly NA
+    "D213",    # multi-line-summary-second-line - NA, AL - GDPC uses D212 instead.
 
     # Mainly PR
     "N802",    # invalid-function-name - PR, PA - For historical reasons, GDPC uses camelCase.
@@ -96,13 +99,24 @@ ignore = [
 
 [tool.ruff.lint.per-file-ignores]
 "**.pyi" = [
-    # These rules are inappropriate for stub files.
     "A",       # flake8-builtins - Stub files must use the same names as the original code.
     "N",       # pep8-naming - Stub files must use the same names as the original code.
 ]
+"!src/gdpc/**.py" = [
+    "D1",      # undocumented-* - NA, TB - We only enforce documentation in the main library.
+    "T20",     # flake-8-print - NA, TB - Prints are fine in many cases, but not in the main library.
+]
 
 [tool.ruff.lint.flake8-builtins]
 ignorelist = [
     "id", # Very generic name that is often useful.
     "copyright", # The builtin is very unimportant, and this gets used by Sphinx' conf.py.
 ]
+
+[tool.ruff.lint.isort]
+# When set to the default value `-1`, Ruff determines the number of lines automatically, and its
+# algorithm seems quite strange. Most notably, it places only one line if the imports are
+# followed by a constant, which is a fairly common occurance. We override this value with 2 to
+# avoid this issue. An unfortunate side effect is that TYPE_CHECKING blocks also become separated
+# by 2 lines, but we consider that the lesser evil.
+lines-after-imports = 2

setup.py

@@ -2,6 +2,7 @@
 
 from setuptools import setup
 
+
 SCRIPT_DIR         = os.path.abspath(os.path.dirname(__file__))
 METADATA_FILE_PATH = os.path.join(SCRIPT_DIR, "src/gdpc/__init__.py")
 

src/gdpc/block.py

@@ -13,6 +13,7 @@
 from .block_state_tools import transformAxis, transformFacing, transformHalf, transformRotation
 from .nbt_tools import nbtToSnbt
 
+
 if TYPE_CHECKING:
     from .vector_tools import Vec3bLike
 

src/gdpc/block_state_tools.py

@@ -11,6 +11,7 @@
 
 from pyglm.glm import bvec3, ivec3
 
+
 if TYPE_CHECKING:
     from .vector_tools import Vec3bLike, Vec3iLike
 

src/gdpc/editor.py

@@ -25,6 +25,7 @@
 from .vector_tools import Box, Rect, Vec3iLike, dropY
 from .world_slice import WorldSlice
 
+
 logger = logging.getLogger(__name__)
 
 

src/gdpc/editor_tools.py

@@ -14,6 +14,7 @@
 from .minecraft_tools import getObtrusiveness, lecternBlock, positionToInventoryIndex, signBlock
 from .vector_tools import Box, Vec2iLike, Vec3iLike, neighbors3D
 
+
 if TYPE_CHECKING:
     from .editor import Editor
 

src/gdpc/geometry.py

@@ -24,6 +24,7 @@
     lineSequence3D,
 )
 
+
 if TYPE_CHECKING:
     from .editor import Editor
 

src/gdpc/interface.py

@@ -29,6 +29,7 @@
 from .utils import isIterable, withRetries
 from .vector_tools import Box, Vec2iLike, Vec3iLike
 
+
 DEFAULT_HOST = "http://localhost:9000"
 """Default host"""
 

src/gdpc/minecraft_tools.py

@@ -11,6 +11,7 @@
 from .block import Block
 from .vector_tools import Rect, Vec2iLike
 
+
 # ==================================================================================================
 # Constants
 # ==================================================================================================