maketool 0.8.2__py3-none-any.whl → 0.8.12__py3-none-any.whl

maketool/refscan.py

@@ -1,46 +1,31 @@
 #!/usr/bin/env python3
-"""maketool-refscan
-
-Two heuristic reports (single command, minimal args):
-
-1) MISSING (used but not installed)
-   - If an entry script is provided (Sublime {file}) and it's a .py file,
-     AST-scans it and any locally-resolvable sibling modules for imports.
-   - Excludes stdlib, local modules/packages, and imports mapped to installed pip dists.
-   - Uses a local-roots importability check to reduce false positives.
-
-2) UNUSED files (no filename/path tokens found)
-   - Scans the project directory (derived from Sublime {file} or current directory)
-   - Shows ONLY unused candidates
-   - Groups by extension, separated by a blank line
-   - No group headers
+"""
+maketool-refscan
 
-Expected input (same style as refscan):
-  refscan "C:\\full\\path\\to\\current_file.py"   # Sublime passes {file}
-  refscan                                        # scans current directory; missing-imports skipped
+Usage:
+  maketool-refscan <entry_file>
 
-Notes:
-- Missing-imports requires Python 3.8+ for importlib.metadata.packages_distributions().
+Reports:
+  1) UNUSED files: filename/path tokens not found in scanned text sources
+  2) MISSING imports: imports used by entry (and local-resolved siblings) but not installed
 """
 
 from __future__ import annotations
 
 import ast
 import sys
-from collections import defaultdict
-from dataclasses import dataclass
 from pathlib import Path
-from typing import Dict, Iterable, List, Optional, Set, Tuple
+from dataclasses import dataclass
+from typing import Dict, Iterable, List, Optional, Set
 
 try:
     from importlib.metadata import packages_distributions  # py 3.8+
 except Exception:
     packages_distributions = None  # type: ignore
 
-
-# ======================================================
-# Refscan config (unused-file token scan)
-# ======================================================
+# ----------------------------
+# Refscan settings
+# ----------------------------
 
 DEFAULT_IGNORE_DIRS = {
     ".git", ".hg", ".svn",
@@ -70,10 +55,17 @@ DEFAULT_SKIP_CONTENT_EXTS = {
 class Candidate:
     path: Path
     rel: str
-    tokens: Tuple[str, ...]
+    tokens: tuple[str, ...]
+
 
+def usage_exit(msg: str = "") -> None:
+    if msg:
+        print(msg, file=sys.stderr)
+    print("Usage: maketool-refscan <entry_file>", file=sys.stderr)
+    raise SystemExit(2)
 
-def iter_files(root: Path, ignore_dirs: Set[str]) -> Iterable[Path]:
+
+def iter_files(root: Path, ignore_dirs: set[str]) -> Iterable[Path]:
     for p in root.rglob("*"):
         if p.is_dir():
             continue
@@ -88,23 +80,23 @@ def safe_read_text(p: Path) -> Optional[str]:
     except Exception:
         return None
 
-
 def norm(s: str) -> str:
     return s.replace("\\", "/").lower()
 
 
-def build_candidates(root: Path, files: List[Path]) -> List[Candidate]:
-    out: List[Candidate] = []
+def build_candidates(root: Path, files: list[Path]) -> list[Candidate]:
+    out: list[Candidate] = []
     for p in files:
         rel = str(p.relative_to(root))
         rel_norm = norm(rel)
         base = p.name.lower()
         stem = p.stem.lower()
+
         tokens = {
-            base,
-            stem,
-            rel_norm,
-            rel_norm.replace("/", "\\"),
+            base,                          # rat.ico
+            stem,                          # common
+            rel_norm,                      # icons/rat.ico
+            rel_norm.replace("/", "\\"),   # icons\rat.ico
         }
         out.append(Candidate(p, rel, tuple(t for t in tokens if t)))
     return out
@@ -117,50 +109,24 @@ def is_text_source(p: Path) -> bool:
     return ext in DEFAULT_SCAN_EXTS
 
 
-def print_unused_files_grouped(root: Path) -> None:
-    files = sorted(iter_files(root, DEFAULT_IGNORE_DIRS))
-    candidates = build_candidates(root, files)
-    text_sources = [p for p in files if is_text_source(p)]
-
-    references: Dict[str, List[str]] = {c.rel: [] for c in candidates}
-
-    for src in text_sources:
-        text = safe_read_text(src)
-        if not text:
-            continue
-        hay = text.lower()
-        src_rel = str(src.relative_to(root))
-
-        for c in candidates:
-            if src == c.path:
-                continue
-            if any(tok in hay for tok in c.tokens):
-                references[c.rel].append(src_rel)
-
-    unused = [c for c in candidates if not references[c.rel]]
-
-    # group by extension (no headers, blank line between groups)
-    groups: Dict[str, List[str]] = defaultdict(list)
-    for c in unused:
-        ext = c.path.suffix.lower() or ""
-        groups[ext].append(c.rel)
-
-    title = "UNUSED files (no filename/path tokens found)"
+def print_group(title: str, rows: list[tuple[str, list[str]]]) -> None:
     print(title)
     print("-" * len(title))
+    for rel, refs in rows:
+        is_py = rel.lower().endswith(".py")
+        name = f"[PY] {rel}" if is_py else rel
 
-    first = True
-    for ext in sorted(groups):
-        # if not first: print()  # group spacer
-        first = False
-        for rel in sorted(groups[ext]):
-            print(rel)
+        if refs:
+            preview = ", ".join(refs[:3]) + (" ..." if len(refs) > 3 else "")
+            print(f"{name}   <-- {preview}")
+        else:
+            print(name)
     print()
 
 
-# ======================================================
-# Missing-imports report (integrated from report.py)
-# ======================================================
+# ----------------------------
+# Missing-import report (merged from report.py)
+# ----------------------------
 
 def stdlib_names() -> Set[str]:
     names = set(getattr(sys, "stdlib_module_names", set()) or set())
@@ -188,10 +154,6 @@ def resolve_local_module(module_name: str, base_dir: Path) -> Optional[Path]:
 
 
 def imported_top_level_packages(entry_file: Path) -> Set[str]:
-    """
-    Parse entry_file and recursively parse local imports that resolve within the
-    importing file's directory (conservative, no sys.path emulation).
-    """
     visited: Set[Path] = set()
     found: Set[str] = set()
 
@@ -237,6 +199,7 @@ def _index_local_modules_under(root: Path) -> Set[str]:
 
     for init_file in root.glob("*/__init__.py"):
         found.add(init_file.parent.name)
+
     for py in root.glob("*.py"):
         found.add(py.stem)
 
@@ -244,13 +207,9 @@ def _index_local_modules_under(root: Path) -> Set[str]:
 
 
 def index_local_modules(project_root: Path) -> Set[str]:
-    """
-    Index local top-level import names from:
-      - project_root
-      - common source roots under it if present
-    (No extra args to keep refscan UX minimal.)
-    """
     roots: List[Path] = [project_root]
+
+    # common extra roots (optional)
     for name in ["src", "lib", "app", "python", "package", "packages"]:
         p = project_root / name
         if p.exists() and p.is_dir():
@@ -259,17 +218,17 @@ def index_local_modules(project_root: Path) -> Set[str]:
     locals_found: Set[str] = set()
     for r in roots:
         locals_found |= _index_local_modules_under(r)
+
     return locals_found
 
 
-def try_importable_as_local(name: str, project_root: Path, extra_roots: List[Path]) -> bool:
+def try_importable_as_local(name: str, project_root: Path) -> bool:
     added: List[str] = []
     try:
-        for p in [project_root, *extra_roots]:
-            sp = str(p)
-            if sp and sp not in sys.path:
-                sys.path.insert(0, sp)
-                added.append(sp)
+        sp = str(project_root)
+        if sp and sp not in sys.path:
+            sys.path.insert(0, sp)
+            added.append(sp)
         __import__(name)
         return True
     except Exception:
@@ -289,13 +248,7 @@ def compute_missing_used_imports(
     import_to_dists: Dict[str, List[str]],
     project_root: Path,
 ) -> Set[str]:
-    """
-    Missing = not stdlib, not local, not mapped to installed dists, and not importable
-    when project roots are on sys.path.
-    """
     missing: Set[str] = set()
-    extra_roots: List[Path] = []  # keep refscan input simple; no extra flags
-
     for name in used_import_names:
         if not name or name in std:
             continue
@@ -303,34 +256,32 @@ def compute_missing_used_imports(
             continue
         if import_to_dists.get(name):
             continue
-        if try_importable_as_local(name, project_root, extra_roots):
+        if try_importable_as_local(name, project_root):
             continue
         try:
             __import__(name)
             continue
         except Exception:
             missing.add(name)
-
     return missing
 
+def print_unused_grouped_by_ext(unused_rels: list[str]) -> None:
+    # Sort by: extension (lower), then full path (lower)
+    def key(rel: str):
+        ext = Path(rel).suffix.lower()
+        return (ext, rel.lower())
 
-def print_missing_imports(entry: Path) -> None:
+    for rel in sorted(unused_rels, key=key):
+        print(rel)
 
-    title = "MISSING (used but not installed):"
-    print(title)
-    print("-" * len(title))
+def run_missing_imports_report(entry: Path, project_root: Path) -> None:
+    print("MISSING (used but not installed):")
+    print("------------------------------")
 
     if packages_distributions is None:
-        print("(skipped: Python 3.8+ required for packages_distributions())")
-        print()
-        return
-
-    if not entry.exists() or entry.suffix.lower() != ".py":
-        print("(skipped: entry is not a .py file)")
-        print()
+        print("(skipped: Python 3.8+ required for importlib.metadata.packages_distributions())\n")
         return
 
-    project_root = entry.parent  # matches your earlier behavior (reliable + simple)
     std = stdlib_names()
     local_index = index_local_modules(project_root)
     used_import_names = imported_top_level_packages(entry)
@@ -344,52 +295,66 @@ def print_missing_imports(entry: Path) -> None:
         project_root=project_root,
     )
 
-    if missing:
-        for m in sorted(missing):
-            print(f"{m}")
-    # else:
-    #     print("(none)")
-        
+    if not missing: return
+
+    for m in sorted(missing):
+        print(m)
     print()
 
 
-# ======================================================
-# Main (refscan UX)
-# ======================================================
+# ----------------------------
+# Main
+# ----------------------------
 
 def main() -> int:
+    if len(sys.argv) != 2:
+        usage_exit()
 
-    # refscan input: optional positional path (Sublime {file}); otherwise CWD
-    entry: Optional[Path] = None
-    root = Path.cwd().resolve()
+    entry = Path(sys.argv[1]).expanduser()
+    if not entry.exists():
+        usage_exit(f"Entry file not found: {entry}")
 
-    if len(sys.argv) >= 2:
-        p = Path(sys.argv[1]).expanduser()
-        try:
-            p = p.resolve()
-        except Exception:
-            pass
+    entry = entry.resolve()
+    root = entry.parent
 
-        # If Sublime passes a file, scan its parent dir; also use it as entry if .py
-        if p.suffix:
-            root = p.parent
-            if p.suffix.lower() == ".py":
-                entry = p
-        else:
-            # If user passes a directory, use it as root; no entry inferred
-            if p.exists() and p.is_dir():
-                root = p
+    ignore_dirs = set(DEFAULT_IGNORE_DIRS)
+
+    files = sorted(iter_files(root, ignore_dirs))
+    candidates = build_candidates(root, files)
+    text_sources = [p for p in files if is_text_source(p)]
 
+    references: Dict[str, List[str]] = {c.rel: [] for c in candidates}
+
+    for src in text_sources:
+        src_rel = str(src.relative_to(root))
+        text = safe_read_text(src)
+        if not text:
+            continue
+        hay = text.lower()
+
+        for c in candidates:
+            if src == c.path:
+                continue
+            if src == entry:
+                continue
+            if any(tok in hay for tok in c.tokens):
+                references[c.rel].append(src_rel)
 
+    unused_rows: list[tuple[str, List[str]]] = []
+    for c in candidates:
+        refs = references[c.rel]
+        if not refs:
+            unused_rows.append((c.rel, refs))
 
-    print_unused_files_grouped(root)
+    print_group("2UNUSED files (no filename/path tokens found)", unused_rows)
 
-    if entry is not None:
-        print_missing_imports(entry)
+    # Second report: missing imports (based on entry .py)
+    if entry.suffix.lower() == ".py":
+        run_missing_imports_report(entry=entry, project_root=root)
     else:
         print("MISSING (used but not installed):")
-        print("  (skipped: no entry .py provided)")
-        print()
+        print("------------------------------")
+        print("(skipped: entry is not a .py file)\n")
 
     return 0
 

{maketool-0.8.2.dist-info → maketool-0.8.12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maketool
-Version: 0.8.2
+Version: 0.8.12
 Summary: Python Automation tool for building PySide6 UI and PyInstaller EXE.
 Author-email: Alan Lilly <panofish@gmail.com>
 Requires-Python: >=3.7

maketool-0.8.12.dist-info/RECORD

@@ -0,0 +1,12 @@
+maketool/__init__.py,sha256=in3uaJRClTGaMIQ6sg725m8so86U7gBr1QfCErxuLAk,172
+maketool/build.py,sha256=-x45Nq-FZyemyAmh1gZlZ0c_JcSUePsbViLCeZezb4o,3921
+maketool/clean.py,sha256=pJYb-kt23_HaOrckv8Kft09HKl9m4_Lt1Tf15HQCmvE,3245
+maketool/compile.py,sha256=n1mzoyU5hlOjHVn2ytCsZVEvN6hta8-VHyR25UGc1CQ,14496
+maketool/refscan.py,sha256=YpNrujP85iOPjfwg9OdUc9IFDqqZTjMsYYo_ceEZN_g,10089
+maketool/run.py,sha256=UO6O7IaSl8XBqPEsC0CaTt65Or0m3_wQFvWZUnY4J00,2399
+maketool/sublime.py,sha256=Ah_Y3tT7ifpUh_pGugY7hqM4SQ0UE-OPLam2hZZtar0,9116
+maketool-0.8.12.dist-info/METADATA,sha256=iOaC-rrw1kvOpB0ByOLHCdYpcM3DMrEshbxf75F5J5A,4845
+maketool-0.8.12.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+maketool-0.8.12.dist-info/entry_points.txt,sha256=hYswW0t7b9YacCLg0-4zAI1CKKjeOH1LJfi34Z8lAPc,248
+maketool-0.8.12.dist-info/top_level.txt,sha256=e7JbT3AdVc2AJstJ1xW1hcwhwfFQ6U8QRdFzaFQe6sQ,9
+maketool-0.8.12.dist-info/RECORD,,

maketool-0.8.2.dist-info/RECORD

@@ -1,12 +0,0 @@
-maketool/__init__.py,sha256=in3uaJRClTGaMIQ6sg725m8so86U7gBr1QfCErxuLAk,172
-maketool/build.py,sha256=-x45Nq-FZyemyAmh1gZlZ0c_JcSUePsbViLCeZezb4o,3921
-maketool/clean.py,sha256=pJYb-kt23_HaOrckv8Kft09HKl9m4_Lt1Tf15HQCmvE,3245
-maketool/compile.py,sha256=n1mzoyU5hlOjHVn2ytCsZVEvN6hta8-VHyR25UGc1CQ,14496
-maketool/refscan.py,sha256=-Mtje3zA0App0JONENGf_F5mNMQ7ItSDss_ClYV21oA,11545
-maketool/run.py,sha256=UO6O7IaSl8XBqPEsC0CaTt65Or0m3_wQFvWZUnY4J00,2399
-maketool/sublime.py,sha256=Ah_Y3tT7ifpUh_pGugY7hqM4SQ0UE-OPLam2hZZtar0,9116
-maketool-0.8.2.dist-info/METADATA,sha256=DelUlpdHMgeeKvyd1D54yWic-I6tsQ3TKhat5Je04fA,4844
-maketool-0.8.2.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-maketool-0.8.2.dist-info/entry_points.txt,sha256=hYswW0t7b9YacCLg0-4zAI1CKKjeOH1LJfi34Z8lAPc,248
-maketool-0.8.2.dist-info/top_level.txt,sha256=e7JbT3AdVc2AJstJ1xW1hcwhwfFQ6U8QRdFzaFQe6sQ,9
-maketool-0.8.2.dist-info/RECORD,,