python-linters 0.1.6__tar.gz → 0.1.7__tar.gz

{python_linters-0.1.6 → python_linters-0.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-linters
-Version: 0.1.6
+Version: 0.1.7
 Summary: bundling config files for linters like ruff and pyright
 Project-URL: repository, https://github.com/dertilo/python-linters
 Author-email: Tilo Himmelsbach <dertilo@gmail.com>

{python_linters-0.1.6 → python_linters-0.1.7}/python_linters/extending_ruff_toml.py

@@ -6,15 +6,20 @@ from python_linters.config_files import RUFF_CONFIG_FILE
 
 def create_extended_ruff_toml(package_root:str) -> str:
     ruff_extension_file = Path(f"{package_root}/ruff_extension.toml")
+    ruff_toml_file = Path(f"{package_root}/ruff.toml")
+    if ruff_toml_file.is_file():
+        ruff_config_file = str(ruff_toml_file)
+    else:
+        ruff_config_file = RUFF_CONFIG_FILE
 
+    print(f"using {ruff_config_file=}")
     if ruff_extension_file.is_file():
-        fingerprint = f"{ruff_extension_file.stat().st_size}-{ruff_extension_file.stat().st_mtime}"
-        extended_ruff_toml_file = f"{package_root}/extended_ruff-{fingerprint}.toml"
+        extended_ruff_toml_file = f"{package_root}/extended_ruff.toml"
         if not Path(extended_ruff_toml_file).is_file():
-            print(f"extending {RUFF_CONFIG_FILE} with {ruff_extension_file=}")
+            print(f"extending {ruff_config_file} with {ruff_extension_file=}")
             with Path(extended_ruff_toml_file).open("w", encoding="locale") as f:
                 lines = [
-                    f'extend = "{RUFF_CONFIG_FILE}"',
+                    f'extend = "{ruff_config_file}"',
                     *list(_read_lines(ruff_extension_file)),
                 ]
                 for l in lines:
@@ -22,7 +27,7 @@ def create_extended_ruff_toml(package_root:str) -> str:
         else:
             print(f"using {extended_ruff_toml_file}")
     else:
-        extended_ruff_toml_file = RUFF_CONFIG_FILE
+        extended_ruff_toml_file = ruff_config_file
     return extended_ruff_toml_file
 
 

{python_linters-0.1.6 → python_linters-0.1.7}/python_linters/ruff.toml

@@ -1,4 +1,4 @@
-target-version = "py310"
+target-version = "py312" 
 # Exclude a variety of commonly ignored directories. see https://beta.ruff.rs/docs/configuration/#using-pyprojecttoml
 [lint]
 preview = true
@@ -33,76 +33,77 @@ exclude = [
     "venv",
 ]
 select = [
-    "F",	# Pyflakes
-    "W",	# pycodestyle Warning
-    "E",	# pycodestyle Error
-    "C90",	# mccabe
-    "I",	# isort
-    "N",	# pep8-naming
-# excluded   "D",	# pydocstyle -> tilo: docstrings are almost always bad-practice! if function/class needs explanation it is not self-explanatory, should be refactored+renamed and/or split up into smaller pieces
-    "UP",	# pyupgrade
-    "YTT",	# flake8-2020
-    "ANN",	# flake8-annotations
-    "ASYNC",	# flake8-async
-    "S",	# flake8-bandit
-    "BLE",	# flake8-blind-except
+# excluded    "AIR",	# Airflow -> we are not using airflow!
+# excluded   "ERA",	# eradicate commented-out-code tilo: better having it committed than uncommitted/unstaged only locally!
+    "FAST", # FastAPI 
+    "ANN",  # flake8-annotations 
+    "ASYNC",        # flake8-async 
+    "S",    # flake8-bandit 
+    "BLE",  # flake8-blind-except 
 # excluded   "FBT",	# flake8-boolean-trap -> tilo: this one might be too strict/hard to refactor
-    "B",	# flake8-bugbear
-    "A",	# flake8-builtins
+    "B",    # flake8-bugbear 
+    "A",    # flake8-builtins 
 #    "COM",	# flake8-commas # may cause conflicts when used with the formatter: `COM812` -> recommended to be disabled
+    "C4",   # flake8-comprehensions 
 # excluded   "CPY",	# flake8-copyright -> tilo: who cares about copyright? chatGPT does not care!
-    "C4",	# flake8-comprehensions
-    "DTZ",	# flake8-datetimez
-    "T10",	# flake8-debugger#
+    "DTZ",  # flake8-datetimez 
+    "T10",  # flake8-debugger 
 # excluded   "DJ",	# flake8-django -> tilo: we are not using django
-    "EM",	# flake8-errmsg
-    "EXE",	# flake8-executable
-    "FA",	# flake8-future-annotations
-    "ISC",	# flake8-implicit-str-concat
-    "ICN",	# flake8-import-conventions
-    "LOG",	# flake8-logging
-    "G",	# flake8-logging-format
-    "INP",	# flake8-no-pep420
-    "PIE",	# flake8-pie
-    "T20",	# flake8-print
-    "PYI",	# flake8-pyi
-    "PT",	# flake8-pytest-style
-    "Q",	# flake8-quotes
-    "RSE",	# flake8-raise
-    "RET",	# flake8-return
-    "SLF",	# flake8-self
-    "SLOT",	# flake8-slots
-    "SIM",	# flake8-simplify
-    "TID",	# flake8-tidy-imports
-    "TC",	# flake8-type-checking
-    "INT",	# flake8-gettext
-    "ARG",	# flake8-unused-arguments
-    "PTH",	# flake8-use-pathlib
+    "EM",   # flake8-errmsg 
+    "EXE",  # flake8-executable 
+# excluded   "FIX",	# flake8-fixme -> this is debatable
+    "FA",   # flake8-future-annotations 
+    "INT",  # flake8-gettext 
+    "ISC",  # flake8-implicit-str-concat 
+    "ICN",  # flake8-import-conventions 
+    "LOG",  # flake8-logging 
+    "G",    # flake8-logging-format 
+    "INP",  # flake8-no-pep420 
+    "PIE",  # flake8-pie
+# excluded    "T20",	# flake8-print # -> adults know when not to print
+    "PYI",  # flake8-pyi 
+    "PT",   # flake8-pytest-style 
+    "Q",    # flake8-quotes 
+    "RSE",  # flake8-raise 
+    "RET",  # flake8-return 
+    "SLF",  # flake8-self 
+    "SIM",  # flake8-simplify 
+    "SLOT", # flake8-slots 
+    "TID",  # flake8-tidy-imports 
 #    "TD",	# flake8-todos
-#    "FIX",	# flake8-fixme
-# excluded   "ERA",	# eradicate commented-out-code tilo: better having it commit than uncommitted/unstaged only locally!
-    "PD",	# pandas-vet
-    "PGH",	# pygrep-hooks
-    "PL",	# Pylint
-    "C",	# Convention
-    "E",	# Error
-    "R",	# Refactor
-    "W",	# Warning
-    "TRY",	# tryceratops
-    "FLY",	# flynt
-    "NPY",	# NumPy-specific rules
-    "FAST",	# FastAPI
-# excluded    "AIR",	# Airflow -> we are not using airflow!
-    "PERF",	# Perflint
-    "FURB",	# refurb
+    "TC",   # flake8-type-checking 
+    "ARG",  # flake8-unused-arguments 
+    "PTH",  # flake8-use-pathlib 
+    "FLY",  # flynt 
+    "I",    # isort 
+    "C90",  # mccabe 
+    "NPY",  # NumPy-specific rules 
+    "PD",   # pandas-vet 
+    "N",    # pep8-naming 
+    "PERF", # Perflint 
+    "E",    #     Error 
+    "W",    #     Warning 
 #    "DOC",	# pydoclint # tilo: maybe somewhen!
-    "RUF",	# Ruff-specific rules
+# excluded   "D",	# pydocstyle -> tilo: docstrings are almost always bad-practice! if function/class needs explanation it is not self-explanatory, should be refactored+renamed and/or split up into smaller pieces
+    "F",    # Pyflakes 
+    "PGH",  # pygrep-hooks 
+    "PL",   # Pylint 
+    "PLC",  #     Convention 
+    "PLE",  #     Error 
+    "PLR",  #     Refactor 
+    "PLW",  #     Warning 
+    "UP",   # pyupgrade 
+    "FURB", # refurb 
+    "RUF",  # Ruff-specific rules 
+    "TRY",  # tryceratops 
 ]
 # ---------------       IGNORING specific rules       --------------------------------------------------------
 ignore = [
+    "T20",
     "TC001","TC002","TC003",   # typing-import-only-first-party-import -> tilo: I need those types for runtime-type-validation! (beartype
     "E501",     # E501 	line-too-long
     "S101",     # prohibits using any assert! -> TODO!
+    "S104",     # prohibits binding to "0.0.0.0"
     "W605",     #  Invalid escape sequence: `\ ` tilo: looks like false-positive to me! but not sure -> TODO!
     "ANN401",   # ANN401 disallows "Any"
     "ANN204",   # missing-return-type-special-method (ANN204) is very annoying especially for __enter__, __exit__ etc
@@ -134,25 +135,25 @@ ignore = [
 # PyCQA default seems to be 7: https://github.com/PyCQA/mccabe/blob/60cf21c21f8e5880f9907561c53732e80d1be400/mccabe.py#L273
 # flake8's default is 10: https://flake8.pycqa.org/en/2.5.5/
 # radon: cc<=5 is A ; 5<cc<=10 is B ; see: https://radon.readthedocs.io/en/latest/commandline.html#the-cc-command
-max-complexity = 7 # seven is a "magical" number!
+# max-complexity = 10 # seven is a "magical" number!
 
 [lint.pylint]
 # ---------------       PLR0913 	too-many-arguments       --------------------------------------------------------
 # Default value: 5
-max-args = 5
+# max-args = 5
 # ---------------       PLR0912 	too-many-branches       --------------------------------------------------------
 # By default, this rule allows up to 12 branches
-max-branches = 7
+# max-branches = 12
 # ---------------       PLR0911       too-many-return-statements        ------------------------------------------------
 # "max-returns": ruff has default of 6, but recommends only 1; "wemake" has default of 5
 # tilo would like to set this to 1! but no need to be so strict, cause "max-complexity" is getting triggered, so basically it is impossible to have 5 returns!
-max-returns = 3
+# max-returns = 3
 # ---------------       PLR0911       too-many-statements       --------------------------------------------------------
 #"TooManyExpressionsViolation" is it really referring to "expressions" not "statements"?
 # see https://wemake-python-styleguide.readthedocs.io/en/latest/pages/usage/violations/complexity.html#wemake_python_styleguide.violations.complexity.TooManyExpressionsViolation
 # wemake: --max-expressions. Default: 9
 # PLR0915 default is 50! -> can you ever reach this limit? max-complexity would catch those code-blocks first!
-max-statements = 25
+# max-statements = 50
 # ---------------       PLR0904 	too-many-public-methods       --------------------------------------------------------
 # Default value: 20, wemake's TooManyMethodsViolation (WPS214) has default of 7
 max-public-methods = 20 # is not only counting public but all methods!