symbex 0.2__tar.gz → 0.2.1__tar.gz

{symbex-0.2/symbex.egg-info → symbex-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: symbex
-Version: 0.2
+Version: 0.2.1
 Summary: Find the Python code for specified symbols
 Home-page: https://github.com/simonw/symbex
 Author: Simon Willison
@@ -54,6 +54,14 @@ To search within a specific directory and all of its subdirectories, use the `-d
 ```bash
 symbex Database -d ~/projects/datasette
 ```
+If `symbex` encounters any Python code that it cannot parse, it will print a warning message and continue searching:
+```
+# Syntax error in path/badcode.py: expected ':' (<unknown>, line 1)
+```
+Pass `--silent` to suppress these warnings:
+```bash
+symbex MyClass --silent
+```
 
 ## Example output
 

{symbex-0.2 → symbex-0.2.1}/README.md

@@ -39,6 +39,14 @@ To search within a specific directory and all of its subdirectories, use the `-d
 ```bash
 symbex Database -d ~/projects/datasette
 ```
+If `symbex` encounters any Python code that it cannot parse, it will print a warning message and continue searching:
+```
+# Syntax error in path/badcode.py: expected ':' (<unknown>, line 1)
+```
+Pass `--silent` to suppress these warnings:
+```bash
+symbex MyClass --silent
+```
 
 ## Example output
 

{symbex-0.2 → symbex-0.2.1}/setup.py

@@ -1,7 +1,7 @@
 from setuptools import setup
 import os
 
-VERSION = "0.2"
+VERSION = "0.2.1"
 
 
 def get_long_description():

{symbex-0.2 → symbex-0.2.1}/symbex/cli.py

@@ -8,7 +8,12 @@ from .lib import code_for_node, find_symbol_nodes
 @click.version_option()
 @click.argument("symbols", nargs=-1)
 @click.option(
-    "files", "-f", "--file", type=click.File("r"), multiple=True, help="Files to search"
+    "files",
+    "-f",
+    "--file",
+    type=click.Path(file_okay=True, dir_okay=False),
+    multiple=True,
+    help="Files to search",
 )
 @click.option(
     "directories",
@@ -18,7 +23,12 @@ from .lib import code_for_node, find_symbol_nodes
     multiple=True,
     help="Directories to search",
 )
-def cli(symbols, files, directories):
+@click.option(
+    "--silent",
+    is_flag=True,
+    help="Silently ignore Python files with parse errors",
+)
+def cli(symbols, files, directories, silent):
     """
     Find symbols in Python code and print the code for them.
 
@@ -40,13 +50,18 @@ def cli(symbols, files, directories):
     """
     if not files and not directories:
         directories = ["."]
-    files = list(files)
+    files = [pathlib.Path(f) for f in files]
     for directory in directories:
         files.extend(pathlib.Path(directory).rglob("*.py"))
     pwd = pathlib.Path(".").resolve()
     for file in files:
         code = file.read_text("utf-8") if hasattr(file, "read_text") else file.read()
-        nodes = find_symbol_nodes(code, symbols)
+        try:
+            nodes = find_symbol_nodes(code, symbols)
+        except SyntaxError as ex:
+            if not silent:
+                click.secho(f"# Syntax error in {file}: {ex}", err=True, fg="yellow")
+            continue
         for node in nodes:
             # If file is within pwd, print relative path
             # else print absolute path

{symbex-0.2 → symbex-0.2.1/symbex.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: symbex
-Version: 0.2
+Version: 0.2.1
 Summary: Find the Python code for specified symbols
 Home-page: https://github.com/simonw/symbex
 Author: Simon Willison
@@ -54,6 +54,14 @@ To search within a specific directory and all of its subdirectories, use the `-d
 ```bash
 symbex Database -d ~/projects/datasette
 ```
+If `symbex` encounters any Python code that it cannot parse, it will print a warning message and continue searching:
+```
+# Syntax error in path/badcode.py: expected ':' (<unknown>, line 1)
+```
+Pass `--silent` to suppress these warnings:
+```bash
+symbex MyClass --silent
+```
 
 ## Example output
 

symbex-0.2.1/tests/test_symbex.py

@@ -0,0 +1,68 @@
+import pathlib
+import pytest
+from click.testing import CliRunner
+
+from symbex.cli import cli
+
+
+@pytest.fixture
+def directory_full_of_code(tmpdir):
+    for path, content in (
+        ("foo.py", "def foo1():\n    pass\n\n@decorated\ndef foo2():\n    pass\n\n"),
+        ("bar.py", "class BarClass:\n    pass\n\n"),
+        ("nested/baz.py", "def baz():\n    pass\n\n"),
+        ("nested/error.py", "def baz_error()" + "bug:\n    pass\n\n"),
+    ):
+        p = pathlib.Path(tmpdir / path)
+        p.parent.mkdir(parents=True, exist_ok=True)
+        p.write_text(content, "utf-8")
+    return tmpdir
+
+
+@pytest.mark.parametrize(
+    "args,expected",
+    (
+        (["foo1", "--silent"], "# File: foo.py Line: 1\ndef foo1():\n    pass\n\n"),
+        (
+            ["foo*", "--silent"],
+            "# File: foo.py Line: 1\ndef foo1():\n    pass\n\n# File: foo.py Line: 4\n@decorated\ndef foo2():\n    pass\n\n",
+        ),
+        (
+            ["BarClass", "--silent"],
+            "# File: bar.py Line: 1\nclass BarClass:\n    pass\n\n",
+        ),
+        (
+            ["baz", "--silent"],
+            "# File: nested/baz.py Line: 1\ndef baz():\n    pass\n\n",
+        ),
+        # The -f option
+        (
+            ["baz", "-f", "nested/baz.py", "--silent"],
+            "# File: nested/baz.py Line: 1\ndef baz():\n    pass\n\n",
+        ),
+        # The -d option
+        (
+            ["baz", "-d", "nested", "--silent"],
+            "# File: nested/baz.py Line: 1\ndef baz():\n    pass\n\n",
+        ),
+    ),
+)
+def test_fixture(directory_full_of_code, args, expected, monkeypatch):
+    runner = CliRunner()
+    monkeypatch.chdir(directory_full_of_code)
+    result = runner.invoke(cli, args, catch_exceptions=False)
+    assert result.exit_code == 0
+    assert result.stdout == expected
+
+
+def test_errors(directory_full_of_code, monkeypatch):
+    # Test without --silent to see errors
+    runner = CliRunner(mix_stderr=False)
+    monkeypatch.chdir(directory_full_of_code)
+    result = runner.invoke(cli, ["baz"], catch_exceptions=False)
+    assert result.exit_code == 0
+    assert result.stdout == (
+        "# File: nested/baz.py Line: 1\n" "def baz():\n" "    pass\n\n"
+    )
+    # This differs between different Python versions
+    assert result.stderr.startswith("# Syntax error in nested/error.py:")

symbex-0.2/tests/test_symbex.py

@@ -1,38 +0,0 @@
-import pathlib
-import pytest
-from click.testing import CliRunner
-
-from symbex.cli import cli
-
-
-@pytest.fixture
-def directory_full_of_code(tmpdir):
-    for path, content in (
-        ("foo.py", "def foo1():\n    pass\n\n@decorated\ndef foo2():\n    pass\n\n"),
-        ("bar.py", "class BarClass:\n    pass\n\n"),
-        ("nested/baz.py", "def baz():\n    pass\n\n"),
-    ):
-        p = pathlib.Path(tmpdir / path)
-        p.parent.mkdir(parents=True, exist_ok=True)
-        p.write_text(content, "utf-8")
-    return tmpdir
-
-
-@pytest.mark.parametrize(
-    "args,expected",
-    (
-        (["foo1"], "# File: foo.py Line: 1\ndef foo1():\n    pass\n\n"),
-        (
-            ["foo*"],
-            "# File: foo.py Line: 1\ndef foo1():\n    pass\n\n# File: foo.py Line: 4\n@decorated\ndef foo2():\n    pass\n\n",
-        ),
-        (["BarClass"], "# File: bar.py Line: 1\nclass BarClass:\n    pass\n\n"),
-        (["baz"], "# File: nested/baz.py Line: 1\ndef baz():\n    pass\n\n"),
-    ),
-)
-def test_fixture(directory_full_of_code, args, expected, monkeypatch):
-    runner = CliRunner()
-    monkeypatch.chdir(directory_full_of_code)
-    result = runner.invoke(cli, args, catch_exceptions=False)
-    assert result.exit_code == 0
-    assert result.stdout == expected