skylos 1.2.0__py3-none-any.whl → 1.2.1__py3-none-any.whl

skylos/analyzer.py

@@ -11,6 +11,10 @@ from skylos.test_aware import TestAwareVisitor
 import os
 import traceback
 from skylos.framework_aware import FrameworkAwareVisitor, detect_framework_usage
+import io
+import tokenize
+import re
+import warnings
 
 logging.basicConfig(level=logging.INFO,format='%(asctime)s - %(levelname)s - %(message)s')
 logger=logging.getLogger('Skylos')
@@ -30,12 +34,27 @@ def parse_exclude_folders(user_exclude_folders, use_defaults=True, include_folde
     
     return exclude_set
 
+IGNORE_PATTERNS = (
+    r"#\s*pragma:\s*no\s+skylos", ## our own pragma
+    r"#\s*pragma:\s*no\s+cover",
+    r"#\s*noqa(?:\b|:)", # flake8 style
+)
+
+def _collect_ignored_lines(source: str) -> set[int]:
+    ignores = set()
+    for tok in tokenize.generate_tokens(io.StringIO(source).readline):
+        if tok.type == tokenize.COMMENT:
+            if any(re.search(pat, tok.string, flags=re.I) for pat in IGNORE_PATTERNS):
+                ignores.add(tok.start[0])
+    return ignores
+
 class Skylos:
     def __init__(self):
         self.defs={}
         self.refs=[]
         self.dynamic=set()
         self.exports=defaultdict(set)
+        self.ignored_lines:set[int]=set()
 
     def _module(self,root,f):
         p=list(f.relative_to(root).parts)
@@ -232,7 +251,20 @@ class Skylos:
         
         for file in files:
             mod = modmap[file]
-            defs, refs, dyn, exports, test_flags, framework_flags = proc_file(file, mod)
+
+            result = proc_file(file, mod)
+
+            if len(result) == 7: ##new
+                defs, refs, dyn, exports, test_flags, framework_flags, ignored = result
+                self.ignored_lines.update(ignored)
+            else: ##legacy
+                warnings.warn(
+                    "proc_file() now returns 7 values (added ignored_lines). "
+                    "The 6-value form is deprecated and will disappear.",
+                    DeprecationWarning,
+                    stacklevel=2,
+                )
+                defs, refs, dyn, exports, test_flags, framework_flags = result
 
             # apply penalties while we still have the file-specific flags
             for d in defs:
@@ -251,8 +283,10 @@ class Skylos:
 
         unused = []
         for d in self.defs.values():
-                if d.references == 0 and not d.is_exported and d.confidence > 0 and d.confidence >= thr:
-                    unused.append(d.to_dict())
+                if (d.references == 0 and not d.is_exported
+                    and d.confidence >= thr
+                    and d.line not in self.ignored_lines):
+                        unused.append(d.to_dict())
 
         result = {
             "unused_functions": [], 
@@ -288,6 +322,7 @@ def proc_file(file_or_args, mod=None):
 
     try:
         source = Path(file).read_text(encoding="utf-8")
+        ignored = _collect_ignored_lines(source)   
         tree   = ast.parse(source)
 
         tv = TestAwareVisitor(filename=file)
@@ -299,7 +334,7 @@ def proc_file(file_or_args, mod=None):
         v  = Visitor(mod, file)
         v.visit(tree)
 
-        return v.defs, v.refs, v.dyn, v.exports, tv, fv
+        return v.defs, v.refs, v.dyn, v.exports, tv, fv, ignored
     except Exception as e:
         logger.error(f"{file}: {e}")
         if os.getenv("SKYLOS_DEBUG"):
@@ -307,7 +342,7 @@ def proc_file(file_or_args, mod=None):
         dummy_visitor = TestAwareVisitor(filename=file)
         dummy_framework_visitor = FrameworkAwareVisitor(filename=file)
 
-        return [], [], set(), set(), dummy_visitor, dummy_framework_visitor
+        return [], [], set(), set(), dummy_visitor, dummy_framework_visitor, set()
 
 def analyze(path,conf=60, exclude_folders=None):
     return Skylos().analyze(path,conf, exclude_folders)

{skylos-1.2.0.dist-info → skylos-1.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: skylos
-Version: 1.2.0
+Version: 1.2.1
 Summary: A static analysis tool for Python codebases
 Author-email: oha <aaronoh2015@gmail.com>
 Requires-Python: >=3.9

{skylos-1.2.0.dist-info → skylos-1.2.1.dist-info}/RECORD

@@ -1,5 +1,5 @@
 skylos/__init__.py,sha256=ZZWhq0TZ3G-yDi9inbYvMn8OBes-pqo1aYB5EivuxFI,152
-skylos/analyzer.py,sha256=MVO16T58bPpcISQKiHWtcQaeHG6r2awH6IuxHUmG56E,13858
+skylos/analyzer.py,sha256=zbWheTzHGbgfwbW0Z2euQyca1dDZL4BPscIHvAMVkME,15079
 skylos/cli.py,sha256=6udZY4vLU6PFzVMkaiCLCRcLXgquyHdmf4rIOAPosWc,18266
 skylos/constants.py,sha256=F1kMjuTxfw2hJjd0SeOQcgex5WhHMUhXCzOlVmwuACs,1230
 skylos/framework_aware.py,sha256=p7BGoFnzkpaLJoE3M5qgyIeZvXx17tOkdyXgeqGKmqU,5804
@@ -9,7 +9,7 @@ test/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 test/compare_tools.py,sha256=0g9PDeJlbst-7hOaQzrL4MiJFQKpqM8q8VeBGzpPczg,22738
 test/conftest.py,sha256=57sTF6vLL5U0CVKwGQFJcRs6n7t1dEHIriQoSluNmAI,6418
 test/diagnostics.py,sha256=ExuFOCVpc9BDwNYapU96vj9RXLqxji32Sv6wVF4nJYU,13802
-test/test_analyzer.py,sha256=c8gbZuUls3N8xGGDXdPzsaoma6AFR2fIDqp9cNJlg7c,22104
+test/test_analyzer.py,sha256=vZ-0cSF_otm7ZYdp6U3a8eWGwRZ6Tf0tVuJxYqcxdqM,22816
 test/test_changes_analyzer.py,sha256=l1hspCFz-sF8gqOilJvntUDuGckwhYsVtzvSRB13ZWw,5085
 test/test_cli.py,sha256=rtdKzanDRJT_F92jKkCQFdhvlfwVJxfXKO8Hrbn-mIg,13180
 test/test_constants.py,sha256=pMuDy0UpC81zENMDCeK6Bqmm3BR_HHZQSlMG-9TgOm0,12602
@@ -25,8 +25,8 @@ test/sample_repo/sample_repo/commands.py,sha256=b6gQ9YDabt2yyfqGbOpLo0osF7wya8O4
 test/sample_repo/sample_repo/models.py,sha256=xXIg3pToEZwKuUCmKX2vTlCF_VeFA0yZlvlBVPIy5Qw,3320
 test/sample_repo/sample_repo/routes.py,sha256=8yITrt55BwS01G7nWdESdx8LuxmReqop1zrGUKPeLi8,2475
 test/sample_repo/sample_repo/utils.py,sha256=S56hEYh8wkzwsD260MvQcmUFOkw2EjFU27nMLFE6G2k,1103
-skylos-1.2.0.dist-info/METADATA,sha256=FqeObdsFPYrqrKzpBngriBQbKZXnOJUnqDKJQSn-N4k,224
-skylos-1.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-skylos-1.2.0.dist-info/entry_points.txt,sha256=zzRpN2ByznlQoLeuLolS_TFNYSQxUGBL1EXQsAd6bIA,43
-skylos-1.2.0.dist-info/top_level.txt,sha256=f8GA_7KwfaEopPMP8-EXDQXaqd4IbsOQPakZy01LkdQ,12
-skylos-1.2.0.dist-info/RECORD,,
+skylos-1.2.1.dist-info/METADATA,sha256=DY1_WEnwZbz1xpWVbV7WwRRmxPqg8pVdS8DlTWs62Sc,224
+skylos-1.2.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+skylos-1.2.1.dist-info/entry_points.txt,sha256=zzRpN2ByznlQoLeuLolS_TFNYSQxUGBL1EXQsAd6bIA,43
+skylos-1.2.1.dist-info/top_level.txt,sha256=f8GA_7KwfaEopPMP8-EXDQXaqd4IbsOQPakZy01LkdQ,12
+skylos-1.2.1.dist-info/RECORD,,

test/test_analyzer.py

@@ -451,7 +451,7 @@ class TestClass:
                     mock_framework_visitor = Mock(spec=FrameworkAwareVisitor)
                     mock_framework_visitor_class.return_value = mock_framework_visitor
                     
-                    defs, refs, dyn, exports, test_flags, framework_flags = proc_file(f.name, "test_module")
+                    defs, refs, dyn, exports, test_flags, framework_flags, _ = proc_file(f.name, "test_module")
                     
                     mock_visitor_class.assert_called_once_with("test_module", f.name)
                     mock_visitor.visit.assert_called_once()
@@ -472,7 +472,7 @@ class TestClass:
             f.flush()
             
             try:
-                defs, refs, dyn, exports, test_flags, framework_flags = proc_file(f.name, "test_module")
+                defs, refs, dyn, exports, test_flags, framework_flags, _ = proc_file(f.name, "test_module")
                 
                 assert defs == []
                 assert refs == []
@@ -506,7 +506,7 @@ class TestClass:
                     mock_framework_visitor = Mock(spec=FrameworkAwareVisitor)
                     mock_framework_visitor_class.return_value = mock_framework_visitor
                     
-                    # defs, refs, dyn, exports, test_flags, framework_flags = proc_file((f.name, "test_module"))
+                    defs, refs, dyn, exports, test_flags, framework_flags, _ = proc_file((f.name, "test_module"))
                     
                     mock_visitor_class.assert_called_once_with("test_module", f.name)
             finally:
@@ -608,5 +608,35 @@ class TestApplyPenalties:
         skylos._apply_penalties(mock_def, mock_test_aware_visitor, mock_framework_aware_visitor)
         assert mock_def.confidence == 0
 
+class TestIgnorePragmas:
+    def test_analyze_respects_ignore_pragmas(self, tmp_path):
+        src = tmp_path / "demo.py"
+        src.write_text(
+            """
+def used():
+    pass
+
+def unused_no_ignore():
+    pass
+
+def unused_ignore():   # pragma: no skylos
+    pass
+
+used()
+"""
+        )
+
+        result_json = analyze(str(tmp_path), conf=0)
+        result = json.loads(result_json)
+
+        # collect names of functions flagged as unreachable
+        unreachable = {item["name"].split(".")[-1] for item in result["unused_functions"]}
+
+        # expectations
+        assert "unused_no_ignore" in unreachable
+        assert "unused_ignore" not in unreachable
+        assert "used" not in unreachable
+
+
 if __name__ == "__main__":
     pytest.main([__file__, "-v"])