flake8-ic 0.1.0__py3-none-any.whl

flake8_ic/__init__.py

@@ -0,0 +1,3 @@
+from flake8_ic.checker import IcecreamChecker
+
+__all__ = ["IcecreamChecker"]

flake8_ic/checker.py

@@ -0,0 +1,41 @@
+import ast
+from typing import Generator, Tuple
+
+from flake8_ic.metadata import get_project_metadata
+
+
+class IcecreamChecker:
+    """
+    Flake8 plugin to check for usage of the `ic()` method from the `icecream` package.
+    """
+
+    IC_ERROR_CODE = "IC100"
+
+    def __init__(self, tree: ast.Module):
+        self.tree = tree
+        self._load_metadata()
+
+    def _load_metadata(self) -> dict:
+        """
+        Load the project metadata from the `pyproject.toml` file.
+        """
+        metadata = get_project_metadata()
+        self.name = metadata["name"]
+        self.version = metadata["version"]
+
+    def run(self) -> Generator[Tuple[int, int, str, type], None, None]:
+        """
+        Generator that yields issues found in the AST.
+        """
+        for node in ast.walk(self.tree):
+            if isinstance(node, ast.Call) and isinstance(node.func, ast.Name):
+                if node.func.id == "ic":
+                    yield (
+                        node.lineno,
+                        node.col_offset,
+                        (
+                            f"{self.IC_ERROR_CODE} Avoid using `ic()` from the "
+                            "`icecream` package in production code."
+                        ),
+                        type(self),
+                    )

flake8_ic/metadata.py

@@ -0,0 +1,19 @@
+import toml
+
+
+def get_project_metadata():
+    """
+    Load the project metadata from pyproject.toml.
+    Returns:
+        dict: Project metadata including name and version.
+    """
+    try:
+        with open("pyproject.toml", "r", encoding="utf-8") as f:
+            pyproject = toml.load(f)
+        project = pyproject.get("project", {})
+        return {
+            "name": project.get("name", "flake8-ic"),
+            "version": project.get("version", "0.1.0"),
+        }
+    except Exception:
+        return {"name": "flake8-ic", "version": "0.1.0"}

flake8_ic-0.1.0.dist-info/METADATA

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: flake8-ic
+Version: 0.1.0
+Summary: This package provides a plugin for flake8 that checks the usage of ic() function from icecream package.
+Author-email: Marco Espinosa <marco@marcoespinosa.com>
+License: MIT License
+        
+        Copyright (c) 2025 Marco Espinosa
+        
+        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.
+License-File: LICENSE
+Keywords: code quality,debugging,flake8,ic,icecream,linting,plugin
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.11
+Requires-Dist: flake8>=7.1.1
+Requires-Dist: toml>=0.10.2
+Description-Content-Type: text/markdown
+
+<!-- Shields -->
+<p align="center">
+<a href="https://github.com/maekind/flake8-ic"><img src="https://img.shields.io/github/actions/workflow/status/maekind/flake8-ic/.github%2Fworkflows%2Ftesting.yaml?label=tests&color=green" hspace="5"></a>
+<a href="https://codecov.io/gh/maekind/flake8-ic"><img src="https://codecov.io/gh/maekind/flake8-ic/graph/badge.svg?token=JcGna50uJL" hspace="5"/></a>
+<a href="https://github.com/maekind/flake8-ic/releases"><img src="https://img.shields.io/github/actions/workflow/status/maekind/flake8-ic/.github%2Fworkflows%2Frelease.yaml?label=build package&color=green" hspace="5"></a>
+<a href="https://pypi.org/project/flake8-ic"><img src="https://img.shields.io/github/v/release/maekind/flake8-ic?color=blue&label=pypi latest" hspace="5"></a>
+<br>
+<a href="https://github.com/maekind/flake8-ic/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-orange.svg" hspace="5"></a>
+<a href="https://github.com/maekind/flake8-ic"><img src="https://img.shields.io/github/repo-size/maekind/flake8-ic?color=red" hspace="5"></a>
+<a href="https://github.com/maekind/flake8-ic"><img src="https://img.shields.io/github/last-commit/maekind/flake8-ic?color=black" hspace="5"></a>
+<a href="https://www.python.org/downloads/"><img src="https://img.shields.io/github/languages/top/maekind/flake8-ic?color=darkgreen" hspace="5"></a>
+<a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python%20version-%3E3.11-lightblue" hspace="5"></a>
+</p>
+
+# flake8-ic
+
+## Description
+
+This package provides a plugin for `flake8` to check the usage of the `ic()` function from the `icecream` package in your codebase.
+
+## Installation
+
+You can install this package using pip:
+
+```bash
+pip install flake8-ic
+```
+
+## Check installation
+
+You can check the installation by running the following command:
+
+```bash
+flake8 --version
+```
+
+You should see the installed version of `flake8` and the installed plugins, including `flake8-ic`.
+
+## Contributors
+
+<a href="https://github.com/maekind/flake8-ic/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=maekind/flake8-ic" />
+</a>
+<br/>
+<br/>
+
+(c) <a href="mailto:marco@marcoespinosa.com">Marco Espinosa</a>, 2024

flake8_ic-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+flake8_ic/__init__.py,sha256=fF5NHoA6bi94M17PkZAdyVxE5ABIKMNk0WmXM63_gG0,77
+flake8_ic/checker.py,sha256=HKvl7TjOxLB0FFLuuaE0LhAVL7DC_jOsyeA4A2XRKfM,1286
+flake8_ic/metadata.py,sha256=VNbhtGjtd3x2uPvyx1Ut6PO6oSsQnS3_d7QdRO4VQ3k,555
+flake8_ic-0.1.0.dist-info/METADATA,sha256=qrVxrD13CAlt4KR82MWGzzYXpqDtQOxlCi9BWTD10fg,4540
+flake8_ic-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+flake8_ic-0.1.0.dist-info/licenses/LICENSE,sha256=seDhX1EGuAm_zNAplG3wrxZmQnDaifnwtiZSP8VSLeg,1070
+flake8_ic-0.1.0.dist-info/RECORD,,

flake8_ic-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

flake8_ic-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Marco Espinosa
+
+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.