python-linters 0.1.3__tar.gz → 0.1.4__tar.gz

{python_linters-0.1.3 → python_linters-0.1.4}/PKG-INFO

@@ -1,15 +1,18 @@
 Metadata-Version: 2.1
 Name: python-linters
-Version: 0.1.3
+Version: 0.1.4
 Summary: bundling config files for linters like ruff and flake8
 Home-page: https://github.com/dertilo/python-linters
+License: MIT
 Author: Tilo Himmelsbach
 Author-email: dertilo@gmail.com
 Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: basedpyright (>=1.12.5,<2.0.0)
 Requires-Dist: black (>=23.9.1,<24.0.0)
 Requires-Dist: flake8 (>=6.1.0,<7.0.0)
 Requires-Dist: flake8-newspaper-style (>=0.4.3,<0.5.0)
@@ -23,7 +26,7 @@ Description-Content-Type: text/markdown
 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
 [![bear-ified](https://raw.githubusercontent.com/beartype/beartype-assets/main/badge/bear-ified.svg)](https://beartype.readthedocs.io)
 # python-linters
-- bundles flake8, black, isort, ruff into a single poetry-script
+- bundles flake8, ruff and basedpyright into a single poetry-script
 - project independent linter configuration (via `ruff.toml`,`.flake8`) -> one config to rule them all
 ### use-cases:
 1. interactively learning python code quality standards via ruff+flake8, see [local development workflow](#2-local-development-workflow-before-pushing-to-ci-pipeline)

{python_linters-0.1.3 → python_linters-0.1.4}/README.md

@@ -2,7 +2,7 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
 [![bear-ified](https://raw.githubusercontent.com/beartype/beartype-assets/main/badge/bear-ified.svg)](https://beartype.readthedocs.io)
 # python-linters
-- bundles flake8, black, isort, ruff into a single poetry-script
+- bundles flake8, ruff and basedpyright into a single poetry-script
 - project independent linter configuration (via `ruff.toml`,`.flake8`) -> one config to rule them all
 ### use-cases:
 1. interactively learning python code quality standards via ruff+flake8, see [local development workflow](#2-local-development-workflow-before-pushing-to-ci-pipeline)

{python_linters-0.1.3 → python_linters-0.1.4}/pyproject.toml

@@ -1,13 +1,12 @@
 [tool.poetry]
 name = "python-linters"
-version = "0.1.3"
+version = "0.1.4"
 description = "bundling config files for linters like ruff and flake8"
 authors = ["Tilo Himmelsbach <dertilo@gmail.com>"]
 readme = "README.md"
 repository = "https://github.com/dertilo/python-linters"
 packages = [{ include = "python_linters" }]
-
-include=["python_linters/.flake8","python_linters/ruff.toml"]
+license = "MIT"
 
 [tool.poetry.scripts]
 pythonlinter = 'python_linters.run_linters:main'
@@ -22,6 +21,7 @@ wemake-python-styleguide = "^0.18.0"
 ruff = ">=0.0.291"
 black = "^23.9.1"
 flake8-newspaper-style = "^0.4.3"
+basedpyright = "^1.12.5"
 
 [tool.poetry.group.dev.dependencies]
 setuptools-scm = "^7.1.0"

{python_linters-0.1.3 → python_linters-0.1.4}/python_linters/.flake8

@@ -2,16 +2,12 @@
 per-file-ignores=
 exclude=
 ignore = B
-select = WPS200,WPS202,WPS204,WPS214,WPS219,WPS227,WPS228,WPS229,WPS230,WPS231,WPS232,WPS233,WPS236,WPS425,WPS449, NEW
+select = WPS204,WPS236, NEW
 
 # --- WPS: Complexity Violations by "wemake-python-styleguide" ---
 # see https://wemake-python-styleguide.readthedocs.io/en/latest/pages/usage/violations/complexity.html#complexity
 
-# WPS200: JonesScoreViolation -> this is a median of "LineComplexity", default is 12
-max-jones-score= 12
 # EXCLUDED WPS201: TooManyImportsViolation, default is 12, make no sense for heavy type-annotation usage, many types need to be imported
-# WPS202: TooManyModuleMembersViolation default is 7
-max-module-members=9
 # EXCLUDED WPS203: TooManyImportedNamesViolation, excluded because its not super necessary!
 # WPS204: OverusedExpressionViolation
 # EXCLUDED WPS210: TooManyLocalsViolation, has default of 5 which is too low, it encourages complex lines and is bad for readability!
@@ -19,30 +15,13 @@ max-module-members=9
 # EXCLUDED WPS211: TooManyArgumentsViolation -> this one is already covered by "PLR0913"
 # EXCLUDED WPS212: TooManyReturnsViolation -> this one is already covered by "PLR0911"
 ### WPS213: TooManyExpressionsViolation -> this one is already covered by "PLR0915"
-# WPS214: TooManyMethodsViolation, "wemake-default" is 7!
-max-methods=9
-# WPS219: TooDeepAccessViolation, Default: 4, tilo: even 3 is a lot!
-max-access-level=3
 #  EXCLUDED WPS221: LineComplexityViolation, "wemake-default" is 14 -> this is not properly working for annotations!
 ##max-line-complexity=14
 #  EXCLUDED WPS226: OverusedStringViolation -> sure that this isn't already in ruff? -> eigenverantwortung here?
-# WPS227: TooLongOutputTupleViolation
-# WPS228: TooLongCompareViolation -> already covered by WPS221?
-# WPS229: TooLongTryBodyViolation: default is at 1!!
-max-try-body-length=3
-# WPS230: TooManyPublicAttributesViolation, default is 6!
-max-attributes=6
-# WPS231: CognitiveComplexityViolation, wemake-default is 12, melevir's is 7
-max-cognitive-score=12
-# WPS232: CognitiveModuleComplexityViolation, default is 8
-max-cognitive-average=8
-# WPS233: TooLongCallChainViolation
 # WPS236: TooLongTupleUnpackViolation: "If you have more than 2 values in a tuple, consider using typing.NamedTuple or a dataclass instead." rather than unpacking third-party returns you should directly "pipe" into a dataclass
 max-tuple-unpack-length=4
-# WPS425 — Forbid booleans as non-keyword parameters.
-# WPS449 — Forbid float keys.
 # NEW https://github.com/mobility-university/flake8-newspaper-style
-# TMN002: TODO(tilo): maybe incorporate some of this packages logic into the linter?: essentially prohibiting tuples, see: flake8-too-many
+# TMN002: TODO(tilo): maybe incorporate some of this packages logic into the linter?: essentially prohibiting tuples, see: https://gitlab.cc-asp.fraunhofer.de/iais.nm.audio/sandbox/nmaudio-flake8-too-many
 # max-function-return-values=3
 
 

python_linters-0.1.4/python_linters/add_noqa.py

@@ -0,0 +1,30 @@
+import os
+
+from python_linters.extending_ruff_toml import create_extended_ruff_toml
+from python_linters.getting_to_be_linted_folders import get_folders_to_be_linted
+from python_linters.run_linters import run_cmd
+
+
+def main() -> None:
+    """
+    expects to run from $ContentRoot$
+    """
+    folders_tobelinted = get_folders_to_be_linted("pyproject.toml")
+    BIG_NUMBER = 9
+    for k in range(
+        BIG_NUMBER,
+    ):  # theoretically could be necessary to run this loop as long as code changes!
+        print(f"addnoqa iteration: {k}")
+        run_cmd(
+            f"ruff check {' '.join(folders_tobelinted)} --config={create_extended_ruff_toml()} --add-noqa",
+        )
+        try:
+            run_cmd(f"ruff format --check {' '.join(folders_tobelinted)}")
+            break
+        except Exception:
+            run_cmd(f"ruff format {' '.join(folders_tobelinted)}")
+            run_cmd(f"fixcode {os.getcwd()}")
+
+
+if __name__ == "__main__":
+    main()

python_linters-0.1.4/python_linters/config_files.py

@@ -0,0 +1,11 @@
+import pathlib
+
+package_dir = str(pathlib.Path(__file__).parent.resolve())
+
+FLAKE8_CONFIG_FILE = f"{package_dir}/.flake8"
+RUFF_CONFIG_FILE = f"{package_dir}/ruff.toml"
+PYRIGHT_CONFIG_FILE = f"{package_dir}/pyrightconfig.json"
+
+assert pathlib.Path(FLAKE8_CONFIG_FILE).is_file()
+assert pathlib.Path(RUFF_CONFIG_FILE).is_file()
+assert pathlib.Path(PYRIGHT_CONFIG_FILE).is_file()

python_linters-0.1.4/python_linters/extending_ruff_toml.py

@@ -0,0 +1,37 @@
+from collections.abc import Iterator
+from pathlib import Path
+
+from python_linters.config_files import RUFF_CONFIG_FILE
+
+
+def create_extended_ruff_toml() -> str:
+    ruff_extension_file = Path("ruff_extension.toml")
+
+    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"extended_ruff-{fingerprint}.toml"
+        if not Path(extended_ruff_toml_file).is_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}"',
+                    *list(_read_lines(ruff_extension_file)),
+                ]
+                for l in lines:
+                    f.write(f"{l}\n")
+        else:
+            print(f"using {extended_ruff_toml_file}")
+    else:
+        extended_ruff_toml_file = RUFF_CONFIG_FILE
+    return extended_ruff_toml_file
+
+
+def _read_lines(
+    file: Path,
+    encoding: str = "utf-8",
+) -> Iterator[str]:
+    with file.open(mode="rb") as f:
+        for raw_line in f:
+            line = raw_line.decode(encoding)
+            line = line.replace("\n", "").replace("\r", "")
+            yield line

{python_linters-0.1.3 → python_linters-0.1.4}/python_linters/fix_code.py

@@ -2,27 +2,27 @@ import subprocess
 import sys
 from pathlib import Path
 
-from python_linters.run_linters import RUFF_CONFIG_FILE, get_folders_to_be_linted
+from python_linters.extending_ruff_toml import create_extended_ruff_toml
+from python_linters.getting_to_be_linted_folders import get_folders_to_be_linted
 
 
-def run_cmd(cmd):
+def run_cmd(cmd) -> None:
     subprocess.check_call(cmd, stdout=sys.stdout, stderr=sys.stdout, shell=True)
 
 
-def run_cmd_ignore_errors(cmd):
+def run_cmd_ignore_errors(cmd) -> None:
     subprocess.call(cmd, stdout=sys.stdout, stderr=sys.stdout, shell=True)
 
 
-def main():
+def main() -> None:
     dirr = Path.cwd()
     folders_to_be_linted = get_folders_to_be_linted("pyproject.toml")
     folders = " ".join(folders_to_be_linted)
 
-    run_cmd(f"cd {dirr} && isort --profile black {folders}")
     run_cmd_ignore_errors(
-        f"cd {dirr} && ruff check {folders} --config={RUFF_CONFIG_FILE} --fix",
+        f"cd {dirr} && ruff check {folders} --config={create_extended_ruff_toml()} --fix",
     )
-    run_cmd(f"cd {dirr} && black {folders}")
+    run_cmd(f"cd {dirr} && ruff format {folders}")
 
 
 if __name__ == "__main__":

python_linters-0.1.4/python_linters/getting_to_be_linted_folders.py

@@ -0,0 +1,51 @@
+import pathlib
+import sys
+
+import toml
+
+
+class PackagesOrFoldersToBeLintedAreNotProperlyDefined(Exception):  # noqa: N818
+    def __init__(self) -> None:
+        sys.tracebacklimit = -1
+        msg = """in your pyproject.toml specify the directories that you want to be linted
+a. via packages
+
+packages = [
+    { include = \"my_package_name\" },
+]
+
+b. or via tool.python-linters
+
+[tool.python-linters]
+folders_to_be_linted=["my_directory","another_dir/my_sub_package"]"""
+        super().__init__(msg)
+
+
+def get_folders_to_be_linted(pyproject_toml: str) -> list[str]:
+    if not pathlib.Path(pyproject_toml).is_file():
+        msg = f"pyproject.toml not found in {pathlib.Path.cwd()}\nplease run this script from the root of your project"
+        raise FileNotFoundError(
+            msg,
+        )
+
+    with open(pyproject_toml, encoding="locale") as f:
+        t = toml.load(f)
+        folders = (
+            t.get("tool", {})
+            .get("python-linters", {})
+            .get("folders_to_be_linted", None)
+        )
+        if (
+            folders is None
+            and (packages := t.get("tool", {}).get("poetry", {}).get("packages", None))
+            is not None
+        ):
+            folders = [p["include"] for p in packages]
+            if pathlib.Path(f"{pathlib.Path(pyproject_toml).parent}/tests").is_dir():
+                folders += ["tests"]
+
+        if folders is None:
+            raise PackagesOrFoldersToBeLintedAreNotProperlyDefined
+    assert len(folders) > 0
+    print(f"found following {folders=}")
+    return folders

{python_linters-0.1.3 → python_linters-0.1.4}/python_linters/parse_rules.py

@@ -10,9 +10,7 @@ if __name__ == "__main__":
         )
         return code, f"{short_expl}: {long_expl}"
 
-    with open("python_linter_configs/ruff_rules.txt") as f:
-        code_desc = (
-            parse_line(l) for l in f.readlines() if pattern.match(l) is not None
-        )
+    with open("python_linter_configs/ruff_rules.txt", encoding="locale") as f:
+        code_desc = (parse_line(l) for l in f if pattern.match(l) is not None)
         code2desc = dict(code_desc)
     print(code2desc)

python_linters-0.1.4/python_linters/pyrightconfig.json

@@ -0,0 +1,21 @@
+{
+  "typeCheckingMode": "basic", // basic to ease transition, this entire config is (automatically copypasted and) to be adapted to each project
+  "reportAny": false,
+  "reportImplicitOverride": false,
+  // cause typing.override leads to false positives
+  "reportMissingSuperCall": false,
+  "reportMissingParameterType": false, // already done by ruff
+  "reportUnusedCallResult": false, // gibt schlimmeres!
+  "reportPrivateUsage": false, // underscore convention is enough!
+  "reportIncompatibleMethodOverride": false,
+  "reportMissingTypeStubs": false,
+  "reportUnknownLambdaType": false, // seems to affect all lambdas
+
+
+  "reportUnknownVariableType": "warning",
+  "reportUnknownMemberType": "warning",
+  "reportUnknownArgumentType": "warning",
+  "reportMissingTypeArgument": "warning",
+  "reportUnknownParameterType": "warning",
+  "reportUnusedVariable": "warning"
+}

{python_linters-0.1.3 → python_linters-0.1.4}/python_linters/ruff.toml

@@ -1,6 +1,14 @@
 target-version = "py310"
 # Exclude a variety of commonly ignored directories. see https://beta.ruff.rs/docs/configuration/#using-pyprojecttoml
 [lint]
+preview = true
+extend-safe-fixes = ["ALL"] # yolo
+extend-unsafe-fixes=[
+    "T20", # don't remove prints
+    "FURB140" # starmap slower than comprehension in 3.12
+]
+
+
 exclude = [
     ".bzr",
     ".direnv",
@@ -36,6 +44,7 @@ select = [
     "YTT",	# flake8-2020
     "ANN",	# flake8-annotations
     "ASYNC",	# flake8-async
+    "TRIO",	# flake8-trio
     "S",	# flake8-bandit
     "BLE",	# flake8-blind-except
 # excluded   "FBT",	# flake8-boolean-trap -> tilo: this one might be too strict/hard to refactor
@@ -52,6 +61,7 @@ select = [
     "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
@@ -75,13 +85,16 @@ select = [
     "PD",	# pandas-vet
     "PGH",	# pygrep-hooks
     "PL",	# Pylint
+    "C",	# Convention
+    "E",	# Error
+    "R",	# Refactor
+    "W",	# Warning
     "TRY",	# tryceratops
     "FLY",	# flynt
     "NPY",	# NumPy-specific rules
 # excluded    "AIR",	# Airflow -> we are not using airflow!
     "PERF",	# Perflint
-# excluded  "FURB",	# refurb -> not yet stable?
-# excluded   "LOG",	# flake8-logging -> not yet stabel?
+    "FURB",	# refurb
     "RUF",	# Ruff-specific rules
 ]
 # ---------------       IGNORING specific rules       --------------------------------------------------------
@@ -112,6 +125,7 @@ ignore = [
     "UP008", # see: https://stackoverflow.com/questions/73268995/typeerror-when-calling-super-in-dataclassslots-true-subclass
     "RET506", # looks like a false-positive
     "SLF001", # everybody knows about the _-conventin, if one still accesses "protected" attributes one has their reasons!
+    "FURB140",  # starmap slower than comprehension in 3.12
 ]
 
 [lint.mccabe]
@@ -140,6 +154,5 @@ max-returns = 3
 # PLR0915 default is 50! -> can you ever reach this limit? max-complexity would catch those code-blocks first!
 max-statements = 25
 # ---------------       PLR0904 	too-many-public-methods       --------------------------------------------------------
-# TODO: seems to have no effect, not working at all! ruff bug?
-# Default value: 20, TODO: this rule is "shadowed" by wemake's TooManyMethodsViolation (WPS214) which has default of 7, I set it to 9 and is counting all methods, also @properties?
-max-public-methods = 0
+# Default value: 20, wemake's TooManyMethodsViolation (WPS214) has default of 7
+max-public-methods = 20 # is not only counting public but all methods!

{python_linters-0.1.3 → python_linters-0.1.4}/python_linters/ruff_rule_categories.py

@@ -11,6 +11,7 @@ pyupgrade (UP)
 flake8-2020 (YTT)
 flake8-annotations (ANN)
 flake8-async (ASYNC)
+flake8-trio (TRIO)
 flake8-bandit (S)
 flake8-blind-except (BLE)
 flake8-boolean-trap (FBT)
@@ -27,6 +28,7 @@ flake8-executable (EXE)
 flake8-future-annotations (FA)
 flake8-implicit-str-concat (ISC)
 flake8-import-conventions (ICN)
+flake8-logging (LOG)
 flake8-logging-format (G)
 flake8-no-pep420 (INP)
 flake8-pie (PIE)
@@ -50,18 +52,21 @@ eradicate (ERA)
 pandas-vet (PD)
 pygrep-hooks (PGH)
 Pylint (PL)
+Convention (C)
+Error (E)
+Refactor (R)
+Warning (W)
 tryceratops (TRY)
 flynt (FLY)
 NumPy-specific rules (NPY)
 Airflow (AIR)
 Perflint (PERF)
 refurb (FURB)
-flake8-logging (LOG)
 Ruff-specific rules (RUF)
 """
 
 
-def copypaste_this_into_ruff_tomls_select_list():
+def copypaste_this_into_ruff_tomls_select_list() -> None:
     names_code = [l.replace(")", "").split("(") for l in rule_categories.split("\n")]
     code_names = [(cn[1], cn[0]) for cn in names_code if len(cn) == 2]
     print(code_names)

python_linters-0.1.4/python_linters/run_linters.py

@@ -0,0 +1,42 @@
+import subprocess
+import sys
+
+from python_linters.config_files import FLAKE8_CONFIG_FILE, PYRIGHT_CONFIG_FILE
+from python_linters.extending_ruff_toml import create_extended_ruff_toml
+from python_linters.getting_to_be_linted_folders import get_folders_to_be_linted
+
+
+def run_cmd(cmd: str) -> int:
+    return subprocess.call(cmd, stdout=sys.stdout, stderr=sys.stdout, shell=True)
+
+
+class LinterException(Exception):
+    def __init__(self, linter_name: str):
+        sys.tracebacklimit = -1  # to disable traceback
+        super().__init__(f"💩 {linter_name} is not happy! 💩")
+
+
+NAME2LINTER = {
+    "ruff-format": lambda folders_tobelinted: f"ruff format --check {' '.join(folders_tobelinted)}",
+    "ruff": lambda folders_tobelinted: f"poetry run ruff check {' '.join(folders_tobelinted)} --config={create_extended_ruff_toml()}",
+    "basedpyright": lambda folders_tobelinted: f"cp -n {PYRIGHT_CONFIG_FILE} ./ && poetry run basedpyright {' '.join(folders_tobelinted)} --gitlabcodequality report.json --level $(cat pyrightlevel.txt 2>/dev/null || echo 'warning')",
+    "flake8": lambda folders_tobelinted: f"poetry run flake8 --config={FLAKE8_CONFIG_FILE} {' '.join(folders_tobelinted)}",
+}
+
+
+def main() -> None:
+    folders_tobelinted = get_folders_to_be_linted("pyproject.toml")
+    print(f"linter-order: {'->'.join(NAME2LINTER.keys())}")
+    sys.stdout.flush()
+
+    for linter_name, linter_cmd_factory in NAME2LINTER.items():
+        print(f"running {linter_name}")
+        sys.stdout.flush()
+
+        if run_cmd(linter_cmd_factory(folders_tobelinted)) != 0:
+            raise LinterException(linter_name)
+        print(f"\npassed {linter_name} linter! ✨ 🍰 ✨\n")
+
+
+if __name__ == "__main__":
+    main()

python_linters-0.1.3/python_linters/add_noqa.py

@@ -1,32 +0,0 @@
-import os
-
-from python_linters.run_linters import (
-    RUFF_CONFIG_FILE,
-    get_folders_to_be_linted,
-    run_cmd,
-)
-
-
-def main():
-    """
-    expects to run from $ContentRoot$
-    """
-    folders_tobelinted = get_folders_to_be_linted("pyproject.toml")
-    BIG_NUMBER = 9
-    for k in range(
-        BIG_NUMBER,
-    ):  # theoretically could be necessary to run this loop as long as code changes!
-        print(f"addnoqa iteration: {k}")
-        run_cmd(
-            f"poetry run ruff check {' '.join(folders_tobelinted)} --config={RUFF_CONFIG_FILE} --add-noqa",
-        )
-        try:
-            run_cmd(f"black --check {' '.join(folders_tobelinted)}")
-            break
-        except Exception:
-            run_cmd(f"black {' '.join(folders_tobelinted)}")
-            run_cmd(f"poetry run fixcode {os.getcwd()}")
-
-
-if __name__ == "__main__":
-    main()

python_linters-0.1.3/python_linters/run_linters.py

@@ -1,105 +0,0 @@
-import pathlib
-import subprocess
-import sys
-
-import toml
-
-
-# TODO: one could brute-force search all files and replace codes, but is there a more elegant way?
-# def replace_noqa_code():
-#     >> > import re
-#     >> > l = {'NORTH': 'N', 'SOUTH': 'S', 'EAST': 'E', 'WEST': 'W'}
-#     >> > pattern = '|'.join(sorted(re.escape(k) for k in l))
-#     >> > address = "123 north anywhere street"
-#     >> > re.sub(pattern, lambda m: l.get(m.group(0).upper()), address,
-#                 flags=re.IGNORECASE)
-#     '123 N anywhere street'
-#     >> >
-#
-def run_cmd(cmd: str) -> int:
-    return subprocess.call(cmd, stdout=sys.stdout, stderr=sys.stdout, shell=True)
-
-
-package_dir = str(pathlib.Path(__file__).parent.resolve())
-
-FLAKE8_CONFIG_FILE = f"{package_dir}/.flake8"
-RUFF_CONFIG_FILE = f"{package_dir}/ruff.toml"
-assert pathlib.Path(FLAKE8_CONFIG_FILE).is_file()
-assert pathlib.Path(RUFF_CONFIG_FILE).is_file()
-
-RUFF_ARGS = ["--fix", "--add-noqa"]
-
-
-class PackagesOrFoldersToBeLintedAreNotProperlyDefined(Exception):  # noqa: N818
-    def __init__(self) -> None:
-        sys.tracebacklimit = -1
-        msg = """in your pyproject.toml specify the directories that you want to be linted
-a. via packages
-
-packages = [
-    { include = \"my_package_name\" },
-]
-
-b. or via tool.python-linters
-
-[tool.python-linters]
-folders_to_be_linted=["my_directory","another_dir/my_sub_package"]"""
-        super().__init__(msg)
-
-
-def get_folders_to_be_linted(pyproject_toml: str) -> list[str]:
-    if not pathlib.Path(pyproject_toml).is_file():
-        raise FileNotFoundError(
-            f"pyproject.toml not found in {pathlib.Path.cwd()}\nplease run this script from the root of your project",
-        )
-
-    with open(pyproject_toml) as f:
-        t = toml.load(f)
-        folders = (
-            t.get("tool", {}).get("python-linters", {}).get("folders_to_be_linted", None)
-        )
-        if (
-            folders is None
-            and (packages := t.get("tool", {}).get("poetry", {}).get("packages", None))
-            is not None
-        ):
-            folders = [p["include"] for p in packages]
-            if pathlib.Path(f"{pathlib.Path(pyproject_toml).parent}/tests").is_dir():
-                folders += ["tests"]
-
-        if folders is None:
-            raise PackagesOrFoldersToBeLintedAreNotProperlyDefined
-    assert len(folders) > 0
-    print(f"found following {folders=}")
-    return folders
-
-
-class LinterException(Exception):
-    def __init__(self, linter_name: str):
-        sys.tracebacklimit = -1  # to disable traceback
-        super().__init__(f"💩 {linter_name} is not happy! 💩")
-
-
-NAME2LINTER = {
-    "black": lambda folders_tobelinted: f"black --check {' '.join(folders_tobelinted)}",
-    "ruff": lambda folders_tobelinted: f"poetry run ruff check {' '.join(folders_tobelinted)} --config={RUFF_CONFIG_FILE}",
-    "flake8": lambda folders_tobelinted: f"poetry run flake8 --config={FLAKE8_CONFIG_FILE} {' '.join(folders_tobelinted)}",
-}
-
-
-def main():
-    folders_tobelinted = get_folders_to_be_linted("pyproject.toml")
-    print(f"linter-order: {'->'.join(NAME2LINTER.keys())}")
-    sys.stdout.flush()
-
-    for linter_name, linter_cmd_factory in NAME2LINTER.items():
-        print(f"running {linter_name}")
-        sys.stdout.flush()
-
-        if run_cmd(linter_cmd_factory(folders_tobelinted)) != 0:
-            raise LinterException(linter_name)
-        print(f"\npassed {linter_name} linter! ✨ 🍰 ✨\n")
-
-
-if __name__ == "__main__":
-    main()