v0.0.3

Author: jet-logic

.github/workflows/build.yml

@@ -19,14 +19,18 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install pytest pytest-cov toml
+          pip install pytest pytest-cov toml flake8 black mypy
           pip install -e .
 
-      # - name: Run tests
-      #   run: pytest --cov=runce --cov-report=xml
       - name: Run tests
         run: sh tests/run_tests_with_coverage.sh
 
+      - name: Run flake8
+        run: flake8 --ignore=E501 || true
+
+      - name: Run mypy
+        run: mypy renx || true
+
       # - name: Verify version sync
       #   run: |
       #     python -c "from runce import __version__; print(__version__)" > actual_version

README.md

@@ -1,9 +1,16 @@
 # renx - Advanced File Renaming Tool
 
 [![Python Version](https://img.shields.io/badge/python-3.7+-blue.svg)](https://www.python.org/downloads/)
+[![PyPI version fury.io](https://badge.fury.io/py/renx.svg)](https://pypi.python.org/pypi/renx/)
 
 `renx` is a powerful command-line utility for batch renaming files and directories with advanced pattern matching and transformation capabilities.
 
+## ☕ Support
+
+If you find this project helpful, consider supporting me:
+
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/B0B01E8SY7)
+
 ## Features
 
 - Recursive directory traversal (top-down or bottom-up)

pyproject.toml

@@ -4,18 +4,17 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "renx"
-version = "0.0.2"
+version = "0.0.3"
 description = "Advanced file renaming tool with regex and case transformation support"
 readme = "README.md"
 authors = [
     {name = "JetLogic"},
 ]
-license = {text = "MIT"}
+license-files = ["LICEN[CS]E*"]
 classifiers = [
     "Development Status :: 4 - Beta",
     "Intended Audience :: Developers",
     "Intended Audience :: System Administrators",
-    "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.7",
     "Programming Language :: Python :: 3.8",
@@ -37,7 +36,7 @@ BugTracker = "https://github.com/jet-logic/renx/issues"
 Changelog = "https://github.com/jet-logic/renx/releases"
 
 [project.scripts]
-renx = "renx.__main__:ScanDir.main"
+renx = "renx.__main__:App.main"
 
 [project.optional-dependencies]
 test = [
@@ -58,7 +57,7 @@ python_files = "test_*.py"
 addopts = "--cov=renx --cov-report=term-missing"
 
 [tool.black]
-line-length = 88
+line-length = 127
 target-version = ['py37']
 include = '\.pyi?$'
 exclude = '''

renx/__main__.py

@@ -4,7 +4,7 @@
 import unicodedata
 
 
-def text_to_ascii(text):
+def text_to_ascii(text: str):
     """
     Converts a Unicode string to its closest ASCII equivalent by removing
     accent marks and other non-ASCII characters.
@@ -19,21 +19,23 @@ def __init__(self) -> None:
         self._entry_filters = []
         super().__init__()
 
-    def add_arguments(self, ap):
+    def add_arguments(self, argp):
         self.dry_run = True
         self.bottom_up = True
         self.excludes = []
         self.includes = []
-        ap.add_argument("--subs", "-s", action="append", default=[], help="subs regex")
-        ap.add_argument("--lower", action="store_true", help="to lower case")
-        ap.add_argument("--upper", action="store_true", help="to upper case")
-        ap.add_argument(
+        argp.add_argument(
+            "--subs", "-s", action="append", default=[], help="subs regex"
+        )
+        argp.add_argument("--lower", action="store_true", help="to lower case")
+        argp.add_argument("--upper", action="store_true", help="to upper case")
+        argp.add_argument(
             "--urlsafe", action="store_true", help="only urlsafe characters"
         )
-        if not ap.description:
-            ap.description = "Renames files matching re substitution pattern"
+        if not argp.description:
+            argp.description = "Renames files matching re substitution pattern"
 
-        super(App, self).add_arguments(ap)
+        super(App, self).add_arguments(argp)
 
     def start(self):
         from re import compile as regex

renx/main.py

@@ -1,9 +1,9 @@
-from typing import TYPE_CHECKING, Any, Sequence
+from typing import TYPE_CHECKING
 
 __version__ = "0.0.0"
 if TYPE_CHECKING:
     import argparse
-    from typing import Sequence
+    from typing import Any, Sequence
 
 INVALID = object()
 
@@ -16,7 +16,7 @@ def __init__(self, *args: str, **kwargs):
         self.kwargs = kwargs
 
     def _add(
-        self, name: str, type_: type, argp: "argparse.ArgumentParser", that: Any
+        self, name: str, type_: type, argp: "argparse.ArgumentParser", that: "Any"
     ) -> None:
         """Add argument to parser."""
         args = []
@@ -94,7 +94,7 @@ def add_args(x: str) -> None:
         argp.add_argument(*args, **kwargs)
 
 
-def _arg_fields(inst: Any) -> Any:
+def _arg_fields(inst: "Any") -> "Any":
     for c in inst.__class__.__mro__:
         for k, v in tuple(c.__dict__.items()):
             if isinstance(v, Argument):
@@ -117,7 +117,7 @@ def flag(*args: str, **kwargs) -> Argument:
 class Main:
     """Base class for all CLI commands."""
 
-    def __getattr__(self, name: str) -> Any:
+    def __getattr__(self, name: str) -> "Any":
         if not name.startswith("_get_"):
             f = getattr(self, f"_get_{name}", None)
             if f:
@@ -134,7 +134,11 @@ def __getattr__(self, name: str) -> Any:
         else:
             return m(name)
 
-    def main(self, args: Sequence[str] = None, argp: "argparse.ArgumentParser" = None):
+    def main(
+        self,
+        args: "Sequence[str]|None" = None,
+        argp: "argparse.ArgumentParser|None" = None,
+    ):
         """Main entry point for the command."""
         if argp is None:
             argp = self.new_argparse()
@@ -162,7 +166,7 @@ def add_arguments(self, argp: "argparse.ArgumentParser") -> None:
             v._add(k, t, argp, self)
 
     def parse_arguments(
-        self, argp: "argparse.ArgumentParser", args: Sequence[str]
+        self, argp: "argparse.ArgumentParser", args: "Sequence[str]|None"
     ) -> None:
         """Parse command line arguments."""
         sp = None
@@ -188,12 +192,12 @@ def parse_arguments(
                     for k, v, t in _arg_fields(s):
                         if k in m:
                             setattr(s, k, m[k])
-                    p = getattr(s, "_parent_arg", None)
-                    if p:
+                    q: "Main|None" = getattr(s, "_parent_arg", None)
+                    if q:
                         s.ready()
                         s.start()
                         s.done()
-                    s = p
+                    s = q
         else:
             argp.parse_args(args, self)
 
@@ -209,6 +213,6 @@ def start(self) -> None:
         """Main command execution."""
         pass
 
-    def sub_args(self) -> Any:
+    def sub_args(self) -> "Any":
         """Yield subcommands."""
         yield None, {}

renx/scantree.py

@@ -56,33 +56,8 @@ def add_arguments(self, argp):
                     dest="dry_run",
                     help="test run only",
                 )
-        try:
-            name_re = self.name_re
-        except AttributeError:
-            self.name_re = None
-        else:
-            from argparse import Action
-            from re import compile as regex, escape, I
-
-            def re_from_glob(s):
-                s = escape(s)
-                s = s.replace(r"\*", ".*")
-                s = s.replace(r"\?", ".")
-                return regex(s, I)
-
-            class GlobAction(Action):
-                def __init__(self, option_strings, dest, nargs=None, **kwargs):
-                    if not (nargs is None or nargs == 1):
-                        raise ValueError("nargs not allowed")
-                    super().__init__(option_strings, dest, **kwargs)
-
-                def __call__(self, parser, namespace, values, option_string=None):
-                    # print("name_re %r %r %r" % (namespace, values, option_string))
-                    name_re.append(re_from_glob(values))
-                    # setattr(namespace, self.dest, values)
 
         if self.excludes is not None or self.includes is not None:
-            from fnmatch import translate
             from re import compile as regex
 
             group.add_argument(

renx/walkdir.py

@@ -76,7 +76,7 @@ def scan_directory(self, src: str) -> Generator[DirEntry, None, None]:
             yield from scandir(src)
         except FileNotFoundError:
             pass
-        except:
+        except Exception:
             if self.carry_on:
                 pass
             else:

tests/test_etc.py

@@ -1,5 +1,4 @@
 import unittest
-import os
 import tempfile
 import subprocess
 from pathlib import Path

tests/test_regex_substitution.py

@@ -1,5 +1,4 @@
 import unittest
-import os
 import tempfile
 import subprocess
 from pathlib import Path

tests/test_urlsafe.py

@@ -1,5 +1,4 @@
 import unittest
-import os
 import tempfile
 import subprocess
 from pathlib import Path