skylos 1.2.0__tar.gz → 1.2.2__tar.gz

{skylos-1.2.0 → skylos-1.2.2}/PKG-INFO

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

{skylos-1.2.0 → skylos-1.2.2}/README.md

@@ -3,6 +3,7 @@
 ![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)
 ![100% Local](https://img.shields.io/badge/privacy-100%25%20local-brightgreen)
 ![PyPI version](https://img.shields.io/pypi/v/skylos)
+![Security Policy](https://img.shields.io/badge/security-policy-brightgreen)
 
 <div align="center">
    <img src="assets/SKYLOS.png" alt="Skylos Logo" width="200">
@@ -40,6 +41,7 @@
 * **Unused Classes**: Detects classes that are not instantiated or inherited
 * **Unused Imports**: Identifies imports that are not used
 * **Folder Management**: Inclusion/exclusion of directories 
+* **Ignore Pragmas**: Skip lines tagged with `# pragma: no skylos`, `# pragma: no cover`, or `# noqa`
 
 ## Benchmark (You can find this benchmark test in `test` folder)
 

{skylos-1.2.0 → skylos-1.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "skylos"
-version = "1.2.0"
+version = "1.2.2"
 requires-python = ">=3.9"
 description = "A static analysis tool for Python codebases"
 authors = [{name = "oha", email = "aaronoh2015@gmail.com"}]

{skylos-1.2.0 → skylos-1.2.2}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="skylos",
-    version="1.2.0",
+    version="1.2.2",
     packages=find_packages(),
     python_requires=">=3.9",
     install_requires=["inquirer>=3.0.0"],

{skylos-1.2.0 → skylos-1.2.2}/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,7 +283,12 @@ 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:
+            # skip anything on line that carries ignore pragma
+            if d.line in self.ignored_lines:
+                continue
+
+            if (d.references == 0 and not d.is_exported
+                and d.confidence >= thr):
                     unused.append(d.to_dict())
 
         result = {
@@ -288,6 +325,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 +337,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 +345,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 → skylos-1.2.2}/skylos.egg-info/PKG-INFO

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

{skylos-1.2.0 → skylos-1.2.2}/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"])