cleany 0.0.1__tar.gz

cleany-0.0.1/PKG-INFO

@@ -0,0 +1,17 @@
+Metadata-Version: 2.4
+Name: cleany
+Version: 0.0.1
+Summary: CLI to clean up your Python comments
+Author-email: Ben Weddle <ben.weddle@gmail.com>
+Maintainer-email: Ben Weddle <ben.weddle@gmail.com>
+Project-URL: Repository, https://pointlessapi.com
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: regex
+Requires-Dist: pytest
+Requires-Dist: ruff
+Requires-Dist: pydantic
+
+# Clean Comments
+
+clean up your comments, people!

cleany-0.0.1/README.md

@@ -0,0 +1,3 @@
+# Clean Comments
+
+clean up your comments, people!

cleany-0.0.1/pyproject.toml

@@ -0,0 +1,29 @@
+[project]
+name = "cleany"
+version = "0.0.1"
+description = "CLI to clean up your Python comments"
+readme = "README.md"
+authors = [{name = "Ben Weddle", email = "ben.weddle@gmail.com"}]
+maintainers = [{name = "Ben Weddle", email = "ben.weddle@gmail.com"}]
+requires-python = ">=3.10"
+
+dependencies = [
+"regex",
+"pytest",
+"ruff",
+"pydantic"
+]
+
+[project.urls]
+Repository = "https://pointlessapi.com"
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["cleany*"]
+
+[project.scripts]
+cleany = "cleany.cli:main"

cleany-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

cleany-0.0.1/src/cleany/__init__.py

@@ -0,0 +1 @@
+from cleany.cleany import Cleany

cleany-0.0.1/src/cleany/cleany.py

@@ -0,0 +1,122 @@
+import subprocess
+import tokenize
+from tokenize import TokenInfo
+import regex
+from pathlib import Path
+
+from pydantic import BaseModel, Field
+
+grapheme_pattern = regex.compile(r"\X", regex.UNICODE)
+emoji_pattern = regex.compile(r"\p{Extended_Pictographic}")
+
+class Cleany(BaseModel):
+
+    path: Path
+    ignore_dir: list = Field(default_factory=list)
+    ignore_file: list = Field(default_factory=list)
+    nuke: bool = False
+    emoji: bool = False
+    quiet: bool = False
+    list_of_files: list[Path] = Field(default_factory=list)
+    total_emojis_removed: int = 0
+
+    def model_post_init(self, __context):
+        self.list_of_files = self.create_list_of_files()
+
+    def main_loop(self):
+        if not any([self.nuke, self.emoji]):
+            return print("no modification commands")
+        if not self.path.exists():
+            return print(f"cannot find matchign directory: {self.path}")
+        if len(self.list_of_files) == 0:
+            return print(f"no files found in {self.path}")
+        for file in self.list_of_files:
+            if self.nuke:
+                self.nuke_comments(file)
+            if self.emoji:
+                self.remove_emojis(file)
+                print(f"removed {self.total_emojis_removed} emojis")
+
+    def create_list_of_files(self) -> list[Path]:
+        list_of_files: list = []
+        for file in self.path.rglob("*.py"):
+            if any(part in self.ignore_dir for part in file.parent.parts):
+                continue
+            if any(str(file).endswith(to_ignore) for to_ignore in self.ignore_file):
+                continue
+            else:
+                list_of_files.append(file)
+        return list_of_files
+
+    def nuke_comments(self, path: Path):
+        self.print_to_screen(f"----- scanning comments in {path} -----")
+        total_removed: int = 0
+        with open(path, "rb") as f:
+            tokens = list(tokenize.tokenize(f.readline))
+
+        new_tokens = []
+
+        for token in tokens:
+            if token.type == tokenize.COMMENT:
+                self.print_to_screen(f"removing comment from line {token.start[0]} of {path}")
+                total_removed += 1
+                pass
+            else:
+                new_tokens.append(token)
+
+        if tokens == new_tokens:
+            self.print_to_screen(f"----- no comments found in {path} -----")
+            self.print_to_screen(statement="")
+            return
+
+        self.print_to_screen(f"removed {total_removed} comments from {path}")
+        new_source = tokenize.untokenize(new_tokens)
+        path.write_bytes(new_source)
+        self.run_ruff(path=path)
+
+    def remove_emojis(self, path: Path):
+        self.print_to_screen(f"----- scanning comments in {path} -----")
+        with open(path, "rb") as f:
+            tokens = list(tokenize.tokenize(f.readline))
+
+        new_tokens = []
+
+        for token in tokens:
+            if token.type == tokenize.COMMENT:
+                new_comment = self.replace_emojis_in_comment(token)
+                token = tokenize.TokenInfo(
+                    token.type,
+                    new_comment,
+                    token.start,
+                    token.end,
+                    token.line,
+                )
+            new_tokens.append(token)
+
+        if tokens == new_tokens:
+            self.print_to_screen(f"----- no emojis found in {path} -----")
+            self.print_to_screen(statement="")
+            return
+
+        new_source = tokenize.untokenize(new_tokens)
+        path.write_bytes(new_source)
+        self.run_ruff(path=path)
+
+    def replace_emojis_in_comment(self, text: TokenInfo, replacement: str = "") -> str:
+        graphemes = grapheme_pattern.findall(text.string)
+        new_parts = []
+        for g in graphemes:
+            if emoji_pattern.search(g):
+                new_parts.append(replacement)
+                self.print_to_screen(f"removing {g} from line {text.start[0]}")
+                self.total_emojis_removed += 1
+            else:
+                new_parts.append(g)
+        return "".join(new_parts)
+    
+    def run_ruff(self, path: Path):
+        subprocess.run(["ruff", "format", "--silent", str(path)], check=True)
+
+    def print_to_screen(self, statement):
+        if not self.quiet:
+            print(statement)

cleany-0.0.1/src/cleany/cli.py

@@ -0,0 +1,67 @@
+import argparse
+from pathlib import Path
+import sys
+
+from cleany.cleany import Cleany
+
+def parse_args():
+    parser = argparse.ArgumentParser(description="Clean up your comments")
+    parser.add_argument(
+        "--path",
+        type=str,
+        default=".",
+        help="Path to the directory containing Python files (default: current directory)",
+    )
+    parser.add_argument(
+        "--ignore-dir",
+        action="append",
+        default=[],
+        help="ignore matching directories"
+    )
+    parser.add_argument(
+        "--ignore-file",
+        type=str,
+        required=False,
+        help="ignore matching files"
+    )
+    parser.add_argument(
+        "--nuke",
+        action="store_true",
+        help="Removes ALL comments",
+    )
+    parser.add_argument(
+        "--emoji", 
+        action="store_true", 
+        help="Removes emojis"
+    )
+    parser.add_argument(
+        "--quiet",
+        action="store_true",
+        help="surpress output"
+    )
+    return parser.parse_args()
+
+
+def main():
+    args = parse_args()
+
+    if len(sys.argv) == 1:
+        return print("cleany -h for help")
+    
+    ignore_dir = ["venv", "tests"]
+    for ignored in args.ignore_dir:
+        ignore_dir.append(ignored)
+
+    ignore_file = []
+    if args.ignore_file:
+        ignore_file.append(args.ignore_file)
+    
+    cleany = Cleany(
+        path=args.path,
+        ignore_dir=ignore_dir,
+        ignore_file=ignore_file,
+        nuke=args.nuke,
+        emoji=args.emoji,
+        quiet=args.quiet
+        )
+    cleany.main_loop()

cleany-0.0.1/src/cleany.egg-info/PKG-INFO

@@ -0,0 +1,17 @@
+Metadata-Version: 2.4
+Name: cleany
+Version: 0.0.1
+Summary: CLI to clean up your Python comments
+Author-email: Ben Weddle <ben.weddle@gmail.com>
+Maintainer-email: Ben Weddle <ben.weddle@gmail.com>
+Project-URL: Repository, https://pointlessapi.com
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: regex
+Requires-Dist: pytest
+Requires-Dist: ruff
+Requires-Dist: pydantic
+
+# Clean Comments
+
+clean up your comments, people!

cleany-0.0.1/src/cleany.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+README.md
+pyproject.toml
+src/cleany/__init__.py
+src/cleany/cleany.py
+src/cleany/cli.py
+src/cleany.egg-info/PKG-INFO
+src/cleany.egg-info/SOURCES.txt
+src/cleany.egg-info/dependency_links.txt
+src/cleany.egg-info/entry_points.txt
+src/cleany.egg-info/requires.txt
+src/cleany.egg-info/top_level.txt
+tests/test_base.py

cleany-0.0.1/src/cleany.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

cleany-0.0.1/src/cleany.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+cleany = cleany.cli:main

cleany-0.0.1/src/cleany.egg-info/requires.txt

@@ -0,0 +1,4 @@
+regex
+pytest
+ruff
+pydantic

cleany-0.0.1/src/cleany.egg-info/top_level.txt

@@ -0,0 +1 @@
+cleany

cleany-0.0.1/tests/test_base.py

@@ -0,0 +1,66 @@
+import os
+from pathlib import Path
+import subprocess
+
+import pytest
+
+def test_init_1():
+    '''if nothing passed in, should return default help message'''
+    output = subprocess.run("cleany", capture_output=True)
+    assert "help" in str(output.stdout)
+
+def test_init_2():
+    '''runs...'''
+    subprocess.run(["cleany", "--nuke"])
+
+def test_init_3():
+    '''wrong type passed to path. should be str'''
+    with pytest.raises(Exception):
+        subprocess.run(["cleany", "--path", 2])
+
+def test_init_4():
+    '''if no modification commands passed (emoji, nuke, etc)'''
+    output = subprocess.run(["cleany", "--path", "some_dir"], capture_output=True)
+    assert "no modification commands" in str(output.stdout)
+
+def test_init_5():
+    '''if no modification commands passed (emoji, nuke, etc)'''
+    output = subprocess.run(["cleany", "--ignore-dir", "some_dir"], capture_output=True)
+    assert "no modification commands" in str(output.stdout)
+
+def test_init_6():
+    '''passing in non-existent directory'''
+    output = subprocess.run(["cleany", "--path", "doesnt_exist", "--nuke"], capture_output=True)
+    assert "cannot find matchign directory" in str(output.stdout)
+
+def test_init_7(tmp_path):
+    '''specifying directory with no matching python files'''
+    output = subprocess.run(["cleany", "--path", tmp_path, "--nuke"], capture_output=True)
+    assert "no files found in" in str(output.stdout)
+
+def test_quiet():
+    output = subprocess.run(["cleany", "--nuke", "--quiet"], capture_output=True)
+    output = str(output.stdout).strip("b''")
+    assert len(str(output)) == 0
+
+def test_remove_emojis_1(tmp_path):
+    pre = Path("tests/fixtures/pre-clean-emojis.py")
+    post = Path("tests/fixtures/post-clean-emojis.py")
+
+    temp: Path = tmp_path / "emoji.py"
+    temp.write_text(pre.read_text())
+
+    subprocess.run(["cleany", "--emoji", "--path", tmp_path])
+
+    assert temp.read_text() == post.read_text()
+
+def test_nuke_1(tmp_path):
+    pre = Path("tests/fixtures/pre-clean-nuke.py")
+    post = Path("tests/fixtures/post-clean-nuke.py")
+
+    temp: Path = tmp_path / "nuke.py"
+    temp.write_text(pre.read_text())
+
+    subprocess.run(["cleany", "--nuke", "--path", tmp_path])
+
+    assert temp.read_text() == post.read_text()