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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-linters
-Version: 0.1.4
+Version: 0.1.5
 Summary: bundling config files for linters like ruff and flake8
 Home-page: https://github.com/dertilo/python-linters
 License: MIT
@@ -13,12 +13,8 @@ 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)
 Requires-Dist: ruff (>=0.0.291)
 Requires-Dist: toml (>=0.10.2,<0.11.0)
-Requires-Dist: wemake-python-styleguide (>=0.18.0,<0.19.0)
 Project-URL: Repository, https://github.com/dertilo/python-linters
 Description-Content-Type: text/markdown
 
@@ -26,11 +22,26 @@ 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, ruff and basedpyright into a single poetry-script
+- bundles 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)
 2. enforcing minimal quality-standards via a "lint-stage" in a ci-pipeline, see [setup for ci-pipeline](#3-setup-for-ci-pipeline)
+## 0. motivation: 
+### Python is a Bicycle!
+- initial idea of python: `Bridge the gap between the shell and C.`[see](https://www.artima.com/articles/pythons-design-goals)
+![img.png](images/python_is_a_bicycle.png)
+### run-time "safety"
+- type and data validation at runtime
+- pytests run your code -> runtime
+![img.png](images/runtime_safety.png)
+### lint-time "safety"
+- linting and static type checking
+![img.png](images/lint_time_safety.png)
+- flake8 already fell down!
+### more "safety" via shorter feed-back loops
+![img_3.png](images/feedback_loops.png)
+
 
 ## 1. install (via poetry)
 1. in `pyproject.toml` add to dependencies
@@ -83,7 +94,7 @@ cond9 --> | complains | cond47{{"ruff"}}:::style0
 cond47 --> | complains | op51[\"poetry run addnoqa"/]:::style1
 op51 -->  sub53[\"refactor your code \nOR\n keep/add noqa-comment"/]:::style1
 sub53 --> op2
-cond47 --> | is happy | cond58{{"flake8"}}:::style0
+cond47 --> | is happy | cond58{{"pyright"}}:::style0
 cond58 --> | complains | sub53
 cond58 --> | is happy | sub66["git commit"]
 sub66 -->  sub80
@@ -137,19 +148,6 @@ All done! ✨ 🍰 ✨
 folders_to_be_linted=['whisper_streaming', 'tests']
 ```
 
-### pythonlinter black is not happy
-```commandline
-poetry run pythonlinter
-linter-order: black->ruff->flake8
-folders_tobelinted=['whisper_streaming', 'tests']
-running black
-would reformat <somehwere>/whisper-streaming/whisper_streaming/post_asr_preparations.py
-would reformat <somehwere>/whisper-streaming/whisper_streaming/faster_whisper_inference/faster_whisper_inferencer.py
-
-Oh no! 💥 💔 💥
-2 files would be reformatted, 20 files would be left unchanged.
-python_linters.run_linters.LinterException: 💩 black is not happy! 💩
-```
 ### pythonlinter ruff is not happy
 - complains about
   - an unused argument
@@ -170,27 +168,6 @@ Found 4 errors.
 No fixes available (2 hidden fixes can be enabled with the `--unsafe-fixes` option).
 python_linters.run_linters.LinterException: 💩 ruff is not happy! 💩
 ```
-### pythonlinter flake8 is not happy
-- complains about too many methods in a class and wrong position of a function in a module
-```commandline
-poetry run pythonlinter
-linter-order: black->ruff->flake8
-folders_tobelinted=['whisper_streaming', 'tests']
-running black
-All done! ✨ 🍰 ✨
-22 files would be left unchanged.
-
-passed black linter! ✨ 🍰 ✨
-
-running ruff
-
-passed ruff linter! ✨ 🍰 ✨
-
-running flake8
-whisper_streaming/faster_whisper_inference/faster_whisper_inferencer.py:111:1: WPS214 Found too many methods: 10 > 9
-tests/conftest.py:35:8: NEW100 newspaper style: function is_in_docker_container defined in line 16 should be moved down
-python_linters.run_linters.LinterException: 💩 flake8 is not happy! 💩
-```
 ### addnoqa example
 - only shows how many noqas it added (`3`) and how many files it left unchanged (`22`)
 ```commandline
@@ -203,11 +180,9 @@ addnoqa iteration: 0
 ```
 - it adds noqas like this one:
 ```python
-def foobar(x):
+def foobar(x): # noqa: ANN001, ANN202
    return "whatever"
 
-from faster_whisper.transcribe import Segment as FasterWhisperSegment  # noqa: E402
-
 ```
 # IDE integration
 ## manual vscode integration

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

@@ -2,11 +2,26 @@
 [![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, ruff and basedpyright into a single poetry-script
+- bundles 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)
 2. enforcing minimal quality-standards via a "lint-stage" in a ci-pipeline, see [setup for ci-pipeline](#3-setup-for-ci-pipeline)
+## 0. motivation: 
+### Python is a Bicycle!
+- initial idea of python: `Bridge the gap between the shell and C.`[see](https://www.artima.com/articles/pythons-design-goals)
+![img.png](images/python_is_a_bicycle.png)
+### run-time "safety"
+- type and data validation at runtime
+- pytests run your code -> runtime
+![img.png](images/runtime_safety.png)
+### lint-time "safety"
+- linting and static type checking
+![img.png](images/lint_time_safety.png)
+- flake8 already fell down!
+### more "safety" via shorter feed-back loops
+![img_3.png](images/feedback_loops.png)
+
 
 ## 1. install (via poetry)
 1. in `pyproject.toml` add to dependencies
@@ -59,7 +74,7 @@ cond9 --> | complains | cond47{{"ruff"}}:::style0
 cond47 --> | complains | op51[\"poetry run addnoqa"/]:::style1
 op51 -->  sub53[\"refactor your code \nOR\n keep/add noqa-comment"/]:::style1
 sub53 --> op2
-cond47 --> | is happy | cond58{{"flake8"}}:::style0
+cond47 --> | is happy | cond58{{"pyright"}}:::style0
 cond58 --> | complains | sub53
 cond58 --> | is happy | sub66["git commit"]
 sub66 -->  sub80
@@ -113,19 +128,6 @@ All done! ✨ 🍰 ✨
 folders_to_be_linted=['whisper_streaming', 'tests']
 ```
 
-### pythonlinter black is not happy
-```commandline
-poetry run pythonlinter
-linter-order: black->ruff->flake8
-folders_tobelinted=['whisper_streaming', 'tests']
-running black
-would reformat <somehwere>/whisper-streaming/whisper_streaming/post_asr_preparations.py
-would reformat <somehwere>/whisper-streaming/whisper_streaming/faster_whisper_inference/faster_whisper_inferencer.py
-
-Oh no! 💥 💔 💥
-2 files would be reformatted, 20 files would be left unchanged.
-python_linters.run_linters.LinterException: 💩 black is not happy! 💩
-```
 ### pythonlinter ruff is not happy
 - complains about
   - an unused argument
@@ -146,27 +148,6 @@ Found 4 errors.
 No fixes available (2 hidden fixes can be enabled with the `--unsafe-fixes` option).
 python_linters.run_linters.LinterException: 💩 ruff is not happy! 💩
 ```
-### pythonlinter flake8 is not happy
-- complains about too many methods in a class and wrong position of a function in a module
-```commandline
-poetry run pythonlinter
-linter-order: black->ruff->flake8
-folders_tobelinted=['whisper_streaming', 'tests']
-running black
-All done! ✨ 🍰 ✨
-22 files would be left unchanged.
-
-passed black linter! ✨ 🍰 ✨
-
-running ruff
-
-passed ruff linter! ✨ 🍰 ✨
-
-running flake8
-whisper_streaming/faster_whisper_inference/faster_whisper_inferencer.py:111:1: WPS214 Found too many methods: 10 > 9
-tests/conftest.py:35:8: NEW100 newspaper style: function is_in_docker_container defined in line 16 should be moved down
-python_linters.run_linters.LinterException: 💩 flake8 is not happy! 💩
-```
 ### addnoqa example
 - only shows how many noqas it added (`3`) and how many files it left unchanged (`22`)
 ```commandline
@@ -179,11 +160,9 @@ addnoqa iteration: 0
 ```
 - it adds noqas like this one:
 ```python
-def foobar(x):
+def foobar(x): # noqa: ANN001, ANN202
    return "whatever"
 
-from faster_whisper.transcribe import Segment as FasterWhisperSegment  # noqa: E402
-
 ```
 # IDE integration
 ## manual vscode integration

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-linters"
-version = "0.1.4"
+version = "0.1.5"
 description = "bundling config files for linters like ruff and flake8"
 authors = ["Tilo Himmelsbach <dertilo@gmail.com>"]
 readme = "README.md"
@@ -16,11 +16,7 @@ addnoqa = 'python_linters.add_noqa:main'
 [tool.poetry.dependencies]
 python = "^3.10"
 toml = "^0.10.2"
-flake8 = "^6.1.0"
-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]

{python_linters-0.1.4 → python_linters-0.1.5}/python_linters/run_linters.py

@@ -1,7 +1,7 @@
 import subprocess
 import sys
 
-from python_linters.config_files import FLAKE8_CONFIG_FILE, PYRIGHT_CONFIG_FILE
+from python_linters.config_files import 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
 
@@ -20,7 +20,9 @@ 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)}",
+    # most flake8 linters are already included in ruff
+    # the news-paper-style function ordering rule is currently only enforced by a flake8 plugin but its not that important
+    # "flake8": lambda folders_tobelinted: f"poetry run flake8 --config={FLAKE8_CONFIG_FILE} {' '.join(folders_tobelinted)}",
 }