flake8-kwargs-spaces 0.1.2__tar.gz

flake8_kwargs_spaces-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sahar Gavriely
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

flake8_kwargs_spaces-0.1.2/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.4
+Name: flake8-kwargs-spaces
+Version: 0.1.2
+License: MIT
+Classifier: License :: OSI Approved :: MIT License
+License-File: LICENSE
+Requires-Dist: flake8>=3.7
+Requires-Dist: importlib-metadata>=0.9; python_version < "3.8"
+Dynamic: license-file

flake8_kwargs_spaces-0.1.2/README.md

@@ -0,0 +1,113 @@
+[![github-workflow](https://github.com/sahargavriely/flake8-kwargs-spaces/actions/workflows/github-action.yml/badge.svg)](https://github.com/sahargavriely/flake8-kwargs-spaces/actions/workflows/github-action.yml)
+[![codecov](https://codecov.io/gh/sahargavriely/flake8-kwargs-spaces/graph/badge.svg?token=W0V7MR7T8S)](https://codecov.io/gh/sahargavriely/flake8-kwargs-spaces)
+
+# Flake8 Keyword Arguments with Spaces Plugin
+
+The `flake8-kwargs-spaces` package is a plugin for Flake8 that enforces consistent spacing around the equals sign (`=`) in function arguments, in both definitions and calls. By integrating this plugin, developers can ensure uniform code formatting and adherence to style guidelines.
+
+## Rules
+
+- **Multiline:** When a keyword argument or default is on its own line (e.g. one argument under the `def` or call), use **spaces** around `=` → `key = 'val'`. Violations are reported as **EKS100**.
+- **Inline:** When the argument is on the same line as the `def`/call, or when multiple keyword arguments appear on the same line, use **no spaces** around `=` → `key='val'`. Violations are reported as **EKS251**.
+
+## Anti-pattern
+
+```py
+def foo(
+    key='val'
+):
+    return key
+
+
+foo(
+    key='val'
+)
+```
+
+## Best practice
+
+```py
+def foo(
+    key = 'val'
+):
+    return key
+
+
+foo(
+    key = 'val'
+)
+```
+
+### Still anti-pattern
+
+```py
+def foo(key = 'val'):
+    return key
+
+
+foo(key = 'val')
+```
+
+### Still best practice
+
+```py
+def foo(key='val'):
+    return key
+
+
+foo(key='val')
+```
+
+## Installation
+
+**From PyPI** (once published):
+
+```sh
+pip install flake8-kwargs-spaces
+```
+
+**From source** (development or before first publish):
+
+1. Clone the repository and enter it:
+
+   ```sh
+   git clone git@github.com:sahargavriely/flake8-kwargs-spaces.git
+   cd flake8-kwargs-spaces
+   ```
+
+2. Run the installation script, then activate the virtual environment:
+
+   ```sh
+   ./scripts/install.sh
+   source venv/bin/activate
+   ```
+
+3. (Optional) Run the test suite to verify everything works:
+
+   ```sh
+   pytest tests/
+   ```
+
+4. The install script builds a wheel under `wheels/`. To use the plugin with Flake8, install that wheel in the environment where you want the plugin enforced:
+
+   ```sh
+   pip install ./wheels/flake8_kwargs_spaces-0.1.0-py3-none-any.whl
+   ```
+
+5. To avoid conflicts with Flake8’s built-in E251 rule, add a `setup.cfg` (or use your existing one) with:
+
+   ```ini
+   [flake8]
+   ignore = E251
+   ```
+
+## License
+
+MIT. See [LICENSE](LICENSE).
+
+## Thanks
+
+- https://www.youtube.com/watch?v=ot5Z4KQPBL8
+- https://www.youtube.com/watch?v=4L0Jb3Ku81s
+- https://www.youtube.com/watch?v=GaWs-LenLYE
+- https://www.youtube.com/watch?v=02aAZ8u3wEQ

flake8_kwargs_spaces-0.1.2/flake8_kwargs_spaces.egg-info/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.4
+Name: flake8-kwargs-spaces
+Version: 0.1.2
+License: MIT
+Classifier: License :: OSI Approved :: MIT License
+License-File: LICENSE
+Requires-Dist: flake8>=3.7
+Requires-Dist: importlib-metadata>=0.9; python_version < "3.8"
+Dynamic: license-file

flake8_kwargs_spaces-0.1.2/flake8_kwargs_spaces.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+flake8_kwargs_spaces.py
+pyproject.toml
+setup.cfg
+setup.py
+flake8_kwargs_spaces.egg-info/PKG-INFO
+flake8_kwargs_spaces.egg-info/SOURCES.txt
+flake8_kwargs_spaces.egg-info/dependency_links.txt
+flake8_kwargs_spaces.egg-info/entry_points.txt
+flake8_kwargs_spaces.egg-info/requires.txt
+flake8_kwargs_spaces.egg-info/top_level.txt

flake8_kwargs_spaces-0.1.2/flake8_kwargs_spaces.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

flake8_kwargs_spaces-0.1.2/flake8_kwargs_spaces.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[flake8.extension]
+EKS = flake8_kwargs_spaces:Plugin

flake8_kwargs_spaces-0.1.2/flake8_kwargs_spaces.egg-info/requires.txt

@@ -0,0 +1,4 @@
+flake8>=3.7
+
+[:python_version < "3.8"]
+importlib-metadata>=0.9

flake8_kwargs_spaces-0.1.2/flake8_kwargs_spaces.egg-info/top_level.txt

@@ -0,0 +1 @@
+flake8_kwargs_spaces

flake8_kwargs_spaces-0.1.2/flake8_kwargs_spaces.py

@@ -0,0 +1,105 @@
+import ast
+import importlib.metadata
+from typing import Any, Dict, Generator, List, Tuple, Type
+
+
+missing_msg = (
+    'EKS100 missing whitespace around keyword / parameter equals '
+    '(use spaces when the argument is on its own line)'
+)
+unexpected_msg = (
+    'EKS251 unexpected whitespace around keyword / parameter equals '
+    '(no spaces when inline or multiple args on one line)'
+)
+
+
+def _default_pairs_from_args(args: ast.arguments) -> List[Tuple[ast.arg, ast.expr]]:
+    '''Return (arg, default) for every parameter that has a default.'''
+    pairs: List[Tuple[ast.arg, ast.expr]] = []
+    # Positional and positional-or-keyword: defaults apply to rightmost of (posonlyargs + args)
+    positional_only = getattr(args, 'posonlyargs', [])
+    all_positional = positional_only + args.args
+    if args.defaults:
+        for arg, default in zip(reversed(all_positional), reversed(args.defaults)):
+            pairs.append((arg, default))
+    # Keyword-only: each kwonlyarg can have a default in kw_defaults (None = no default)
+    for arg, default in zip(args.kwonlyargs, args.kw_defaults):
+        if default is not None:
+            pairs.append((arg, default))
+    return pairs
+
+
+LinesMap = Dict[int, List[Tuple[int, ast.expr]]]
+
+
+class Visitor(ast.NodeVisitor):
+    def __init__(self) -> None:
+        self.problems: List[Tuple[int, int, str]] = []  # (lineno, col_offset, message)
+
+    def visit_Call(self, node: ast.Call) -> Any:
+        lines: LinesMap = {}
+        for keyword in node.keywords:
+            if keyword.arg is None:
+                continue
+            if keyword.lineno not in lines:
+                lines[keyword.lineno] = []
+            lines[keyword.lineno].append((len(keyword.arg) + keyword.col_offset, keyword.value))
+        self.visit_lines(lines, node.lineno)
+        self.generic_visit(node)
+
+    def _visit_function_def(
+        self, node: ast.FunctionDef | ast.AsyncFunctionDef
+    ) -> None:
+        lines: LinesMap = {}
+        for arg, default in _default_pairs_from_args(node.args):
+            if arg.lineno not in lines:
+                lines[arg.lineno] = []
+            # Store start of span (end_col_offset is exclusive in AST, so it's already the first col after arg)
+            lines[arg.lineno].append((arg.end_col_offset, default))
+        self.visit_lines(lines, node.lineno)
+
+    def visit_FunctionDef(self, node: ast.FunctionDef) -> Any:
+        self._visit_function_def(node)
+        self.generic_visit(node)
+
+    def visit_AsyncFunctionDef(self, node: ast.AsyncFunctionDef) -> Any:
+        self._visit_function_def(node)
+        self.generic_visit(node)
+
+    def visit_lines(self, lines: LinesMap, func_line: int) -> None:
+        for lineno, line in lines.items():
+            if lineno == func_line or len(line) > 1:
+                for span_start, value in line:
+                    self.unexpected_spaces(lineno, span_start, value)
+            else:
+                span_start, value = line[0]
+                self.missing_spaces(lineno, span_start, value)
+
+    def missing_spaces(
+        self, line: int, span_start: int, value: ast.expr
+    ) -> None:
+        if value.col_offset - span_start < 3:
+            self.problems.append((line, span_start + 1, missing_msg))
+
+    def unexpected_spaces(
+        self, line: int, span_start: int, value: ast.expr
+    ) -> None:
+        if value.col_offset - span_start > 1:
+            self.problems.append((line, span_start + 1, unexpected_msg))
+
+
+class Plugin:
+    name = __name__
+    try:
+        version = importlib.metadata.version(__name__)
+    except importlib.metadata.PackageNotFoundError:
+        version = '0.0.0'
+
+    def __init__(self, tree: ast.AST) -> None:
+        self._tree = tree
+
+    def run(self) -> Generator[Tuple[int, int, str, Type[Any]], None, None]:
+        visitor = Visitor()
+        visitor.visit(self._tree)
+        for line, col, msg in visitor.problems:
+            yield line, col, msg, type(self)

flake8_kwargs_spaces-0.1.2/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"

flake8_kwargs_spaces-0.1.2/setup.cfg

@@ -0,0 +1,27 @@
+[metadata]
+name = flake8-kwargs-spaces
+version = 0.1.2
+license = MIT
+license_files = LICENSE
+classifiers = 
+	License :: OSI Approved :: MIT License
+
+[options]
+py_modules = flake8_kwargs_spaces
+install_requires = 
+	flake8>=3.7
+	importlib-metadata>=0.9;python_version<"3.8"
+
+[options.entry_points]
+flake8.extension = 
+	EKS=flake8_kwargs_spaces:Plugin
+
+[flake8]
+ignore = E251
+extend-ignore = E251,E722,W503
+max-line-length = 132
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

flake8_kwargs_spaces-0.1.2/setup.py

@@ -0,0 +1,4 @@
+from setuptools import setup
+
+
+setup()