symbex 1.2__tar.gz → 1.3.1__tar.gz

{symbex-1.2 → symbex-1.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: symbex
-Version: 1.2
+Version: 1.3.1
 Summary: Find the Python code for specified symbols
 Home-page: https://github.com/simonw/symbex
 Author: Simon Willison
@@ -115,6 +115,9 @@ The following filters are available:
 - `--unasync` - only non-async functions
 - `--documented` - functions/classes that have a docstring
 - `--undocumented` - functions/classes that do not have a docstring
+- `--public` - functions/classes that are public - don't have a `_name` prefix (or are `__*__` methods)
+- `--private` - functions/classes that are private - have a `_name` prefix and are not `__*__`
+- `--dunder` - functions matching `__*__` - this should usually be used with `*.*` to find all dunder methods
 - `--typed` - functions that have at least one type annotation
 - `--untyped` - functions that have no type annotations
 - `--partially-typed` - functions that have some type annotations but not all
@@ -135,6 +138,12 @@ This example shows the full source code of every class method in the Python stan
 symbex --fully-typed --no-init '*.*' --stdlib
 ```
 
+To find all public functions and methods that lack documentation, just showing the signature of each one:
+
+```bash
+symbex '*' '*.*' --public --undocumented --signatures
+```
+
 ### Example output
 
 In a fresh checkout of [Datasette](https://github.com/simonw/datasette) I ran this command:
@@ -190,40 +199,40 @@ cog.out(
 ]]] -->
 ```python
 # File: symbex/lib.py Line: 107
-def function_definition(function_node: AST)
+def function_definition(function_node: AST):
 
 # File: symbex/lib.py Line: 13
-def find_symbol_nodes(code: str, filename: str, symbols: Iterable[str]) -> List[Tuple[(AST, Optional[str])]]
+def find_symbol_nodes(code: str, filename: str, symbols: Iterable[str]) -> List[Tuple[(AST, Optional[str])]]:
 
 # File: symbex/lib.py Line: 175
-def class_definition(class_def)
+def class_definition(class_def):
 
 # File: symbex/lib.py Line: 209
-def annotation_definition(annotation: AST) -> str
+def annotation_definition(annotation: AST) -> str:
 
 # File: symbex/lib.py Line: 227
-def read_file(path)
+def read_file(path):
 
 # File: symbex/lib.py Line: 253
-class TypeSummary
+class TypeSummary:
 
 # File: symbex/lib.py Line: 258
-def type_summary(node: AST) -> Optional[TypeSummary]
+def type_summary(node: AST) -> Optional[TypeSummary]:
 
 # File: symbex/lib.py Line: 304
-def quoted_string(s)
+def quoted_string(s):
 
 # File: symbex/lib.py Line: 315
-def import_line_for_function(function_name: str, filepath: str, possible_root_dirs: List[str]) -> str
+def import_line_for_function(function_name: str, filepath: str, possible_root_dirs: List[str]) -> str:
 
 # File: symbex/lib.py Line: 37
-def code_for_node(code: str, node: AST, class_name: str, signatures: bool, docstrings: bool) -> Tuple[(str, int)]
+def code_for_node(code: str, node: AST, class_name: str, signatures: bool, docstrings: bool) -> Tuple[(str, int)]:
 
 # File: symbex/lib.py Line: 71
-def add_docstring(definition: str, node: AST, docstrings: bool, is_method: bool) -> str
+def add_docstring(definition: str, node: AST, docstrings: bool, is_method: bool) -> str:
 
 # File: symbex/lib.py Line: 82
-def match(name: str, symbols: Iterable[str]) -> bool
+def match(name: str, symbols: Iterable[str]) -> bool:
 ```
 <!-- [[[end]]] -->
 This can be combined with other options, or you can run `symbex -s` to see every symbol in the current directory and its subdirectories.
@@ -245,7 +254,7 @@ cog.out(
 ```python
 # File: symbex/lib.py Line: 82
 # from symbex.lib import match
-def match(name: str, symbols: Iterable[str]) -> bool
+def match(name: str, symbols: Iterable[str]) -> bool:
 ```
 <!-- [[[end]]] -->
 To suppress the `# File: ...` comments, use `--no-file` or `-n`.
@@ -265,7 +274,7 @@ cog.out(
 ]]] -->
 ```python
 # from symbex.lib import match
-def match(name: str, symbols: Iterable[str]) -> bool
+def match(name: str, symbols: Iterable[str]) -> bool:
 ```
 <!-- [[[end]]] -->
 
@@ -282,7 +291,7 @@ cog.out(
 ]]] -->
 ```python
 # File: symbex/lib.py Line: 82
-def match(name: str, symbols: Iterable[str]) -> bool
+def match(name: str, symbols: Iterable[str]) -> bool:
     "Returns True if name matches any of the symbols, resolving wildcards"
 ```
 <!-- [[[end]]] -->
@@ -399,14 +408,24 @@ def second_function(a: int, b: int) -> int:
 
 The `--check` option causes `symbex` to return a non-zero exit code if any matches are found for your query.
 
-You can use this in CI to guard against things like functions being added without documentation:
+You can use this in CI to guard against things like public functions being added without documentation:
 
 ```bash
-symbex --function --undocumented --check
+symbex --function --public --undocumented --check
 ```
 This will fail silently but set a `1` exit code if there are any undocumented functions.
 
-`--check` will not output anything by default. Add `--count` to output a count of matching symbols, or `-s/--signatures` to output the signatures of the matching symbols.
+Using this as a step in a CI tool such as GitHub Actions should result in a test failure.
+
+Run this to see the exit code from the last command:
+```bash
+echo $?
+```
+
+`--check` will not output anything by default. Add `--count` to output a count of matching symbols, or `-s/--signatures` to output the signatures of the matching symbols, for example:
+```bash
+symbex --function --public --undocumented --check --count
+```
 
 ## Similar tools
 
@@ -465,6 +484,10 @@ Usage: symbex [OPTIONS] [SYMBOLS]...
           return a + b + 3
       " | symbex my_function --replace
 
+      # Replace my_function with the output of a command:
+      symbex first_function --rexec "sed 's/^/# /'"
+      # This uses sed to comment out the function body
+
 Options:
   --version                  Show the version and exit.
   -f, --file FILE            Files to search
@@ -485,6 +508,9 @@ Options:
   --class                    Filter classes
   --documented               Filter functions with docstrings
   --undocumented             Filter functions without docstrings
+  --public                   Filter for symbols without a _ prefix
+  --private                  Filter for symbols with a _ prefix
+  --dunder                   Filter for symbols matching __*__
   --typed                    Filter functions with type annotations
   --untyped                  Filter functions without type annotations
   --partially-typed          Filter functions with partial type annotations

{symbex-1.2 → symbex-1.3.1}/README.md

@@ -100,6 +100,9 @@ The following filters are available:
 - `--unasync` - only non-async functions
 - `--documented` - functions/classes that have a docstring
 - `--undocumented` - functions/classes that do not have a docstring
+- `--public` - functions/classes that are public - don't have a `_name` prefix (or are `__*__` methods)
+- `--private` - functions/classes that are private - have a `_name` prefix and are not `__*__`
+- `--dunder` - functions matching `__*__` - this should usually be used with `*.*` to find all dunder methods
 - `--typed` - functions that have at least one type annotation
 - `--untyped` - functions that have no type annotations
 - `--partially-typed` - functions that have some type annotations but not all
@@ -120,6 +123,12 @@ This example shows the full source code of every class method in the Python stan
 symbex --fully-typed --no-init '*.*' --stdlib
 ```
 
+To find all public functions and methods that lack documentation, just showing the signature of each one:
+
+```bash
+symbex '*' '*.*' --public --undocumented --signatures
+```
+
 ### Example output
 
 In a fresh checkout of [Datasette](https://github.com/simonw/datasette) I ran this command:
@@ -175,40 +184,40 @@ cog.out(
 ]]] -->
 ```python
 # File: symbex/lib.py Line: 107
-def function_definition(function_node: AST)
+def function_definition(function_node: AST):
 
 # File: symbex/lib.py Line: 13
-def find_symbol_nodes(code: str, filename: str, symbols: Iterable[str]) -> List[Tuple[(AST, Optional[str])]]
+def find_symbol_nodes(code: str, filename: str, symbols: Iterable[str]) -> List[Tuple[(AST, Optional[str])]]:
 
 # File: symbex/lib.py Line: 175
-def class_definition(class_def)
+def class_definition(class_def):
 
 # File: symbex/lib.py Line: 209
-def annotation_definition(annotation: AST) -> str
+def annotation_definition(annotation: AST) -> str:
 
 # File: symbex/lib.py Line: 227
-def read_file(path)
+def read_file(path):
 
 # File: symbex/lib.py Line: 253
-class TypeSummary
+class TypeSummary:
 
 # File: symbex/lib.py Line: 258
-def type_summary(node: AST) -> Optional[TypeSummary]
+def type_summary(node: AST) -> Optional[TypeSummary]:
 
 # File: symbex/lib.py Line: 304
-def quoted_string(s)
+def quoted_string(s):
 
 # File: symbex/lib.py Line: 315
-def import_line_for_function(function_name: str, filepath: str, possible_root_dirs: List[str]) -> str
+def import_line_for_function(function_name: str, filepath: str, possible_root_dirs: List[str]) -> str:
 
 # File: symbex/lib.py Line: 37
-def code_for_node(code: str, node: AST, class_name: str, signatures: bool, docstrings: bool) -> Tuple[(str, int)]
+def code_for_node(code: str, node: AST, class_name: str, signatures: bool, docstrings: bool) -> Tuple[(str, int)]:
 
 # File: symbex/lib.py Line: 71
-def add_docstring(definition: str, node: AST, docstrings: bool, is_method: bool) -> str
+def add_docstring(definition: str, node: AST, docstrings: bool, is_method: bool) -> str:
 
 # File: symbex/lib.py Line: 82
-def match(name: str, symbols: Iterable[str]) -> bool
+def match(name: str, symbols: Iterable[str]) -> bool:
 ```
 <!-- [[[end]]] -->
 This can be combined with other options, or you can run `symbex -s` to see every symbol in the current directory and its subdirectories.
@@ -230,7 +239,7 @@ cog.out(
 ```python
 # File: symbex/lib.py Line: 82
 # from symbex.lib import match
-def match(name: str, symbols: Iterable[str]) -> bool
+def match(name: str, symbols: Iterable[str]) -> bool:
 ```
 <!-- [[[end]]] -->
 To suppress the `# File: ...` comments, use `--no-file` or `-n`.
@@ -250,7 +259,7 @@ cog.out(
 ]]] -->
 ```python
 # from symbex.lib import match
-def match(name: str, symbols: Iterable[str]) -> bool
+def match(name: str, symbols: Iterable[str]) -> bool:
 ```
 <!-- [[[end]]] -->
 
@@ -267,7 +276,7 @@ cog.out(
 ]]] -->
 ```python
 # File: symbex/lib.py Line: 82
-def match(name: str, symbols: Iterable[str]) -> bool
+def match(name: str, symbols: Iterable[str]) -> bool:
     "Returns True if name matches any of the symbols, resolving wildcards"
 ```
 <!-- [[[end]]] -->
@@ -384,14 +393,24 @@ def second_function(a: int, b: int) -> int:
 
 The `--check` option causes `symbex` to return a non-zero exit code if any matches are found for your query.
 
-You can use this in CI to guard against things like functions being added without documentation:
+You can use this in CI to guard against things like public functions being added without documentation:
 
 ```bash
-symbex --function --undocumented --check
+symbex --function --public --undocumented --check
 ```
 This will fail silently but set a `1` exit code if there are any undocumented functions.
 
-`--check` will not output anything by default. Add `--count` to output a count of matching symbols, or `-s/--signatures` to output the signatures of the matching symbols.
+Using this as a step in a CI tool such as GitHub Actions should result in a test failure.
+
+Run this to see the exit code from the last command:
+```bash
+echo $?
+```
+
+`--check` will not output anything by default. Add `--count` to output a count of matching symbols, or `-s/--signatures` to output the signatures of the matching symbols, for example:
+```bash
+symbex --function --public --undocumented --check --count
+```
 
 ## Similar tools
 
@@ -450,6 +469,10 @@ Usage: symbex [OPTIONS] [SYMBOLS]...
           return a + b + 3
       " | symbex my_function --replace
 
+      # Replace my_function with the output of a command:
+      symbex first_function --rexec "sed 's/^/# /'"
+      # This uses sed to comment out the function body
+
 Options:
   --version                  Show the version and exit.
   -f, --file FILE            Files to search
@@ -470,6 +493,9 @@ Options:
   --class                    Filter classes
   --documented               Filter functions with docstrings
   --undocumented             Filter functions without docstrings
+  --public                   Filter for symbols without a _ prefix
+  --private                  Filter for symbols with a _ prefix
+  --dunder                   Filter for symbols matching __*__
   --typed                    Filter functions with type annotations
   --untyped                  Filter functions without type annotations
   --partially-typed          Filter functions with partial type annotations

{symbex-1.2 → symbex-1.3.1}/setup.py

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

{symbex-1.2 → symbex-1.3.1}/symbex/cli.py

@@ -120,6 +120,21 @@ from .lib import (
     is_flag=True,
     help="Filter functions without docstrings",
 )
+@click.option(
+    "--public",
+    is_flag=True,
+    help="Filter for symbols without a _ prefix",
+)
+@click.option(
+    "--private",
+    is_flag=True,
+    help="Filter for symbols with a _ prefix",
+)
+@click.option(
+    "--dunder",
+    is_flag=True,
+    help="Filter for symbols matching __*__",
+)
 @click.option(
     "--typed",
     is_flag=True,
@@ -174,6 +189,9 @@ def cli(
     class_,
     documented,
     undocumented,
+    public,
+    private,
+    dunder,
     typed,
     untyped,
     partially_typed,
@@ -234,6 +252,11 @@ def cli(
             # This is a replacement implementation
             return a + b + 3
         " | symbex my_function --replace
+
+    \b
+        # Replace my_function with the output of a command:
+        symbex first_function --rexec "sed 's/^/# /'"
+        # This uses sed to comment out the function body
     """
     if modules:
         module_dirs = []
@@ -281,6 +304,9 @@ def cli(
             class_,
             documented,
             undocumented,
+            public,
+            private,
+            dunder,
             typed,
             untyped,
             partially_typed,
@@ -312,6 +338,9 @@ def cli(
                 class_,
                 documented,
                 undocumented,
+                public,
+                private,
+                dunder,
                 typed,
                 untyped,
                 partially_typed,
@@ -347,6 +376,9 @@ def cli(
             class_,
             documented,
             undocumented,
+            public,
+            private,
+            dunder,
             typed,
             untyped,
             partially_typed,
@@ -371,6 +403,12 @@ def cli(
                 return False
             if undocumented and ast.get_docstring(node):
                 return False
+            if public and node.name.startswith("_") and not is_dunder(node.name):
+                return False
+            if private and (is_dunder(node.name) or not node.name.startswith("_")):
+                return False
+            if dunder and not is_dunder(node.name):
+                return False
             summary = type_summary(node)
             # if no summary, type filters all fail
             if not summary and (
@@ -499,3 +537,7 @@ def is_subpath(path: pathlib.Path, parent: pathlib.Path) -> bool:
         return True
     except ValueError:
         return False
+
+
+def is_dunder(name):
+    return name.startswith("__") and name.endswith("__")

{symbex-1.2 → symbex-1.3.1}/symbex/lib.py

@@ -169,7 +169,7 @@ def function_definition(function_node: AST):
     if isinstance(function_node, AsyncFunctionDef):
         def_ = "async def "
 
-    return f"{def_}{function_name}({arguments_str}){return_annotation}"
+    return f"{def_}{function_name}({arguments_str}){return_annotation}:"
 
 
 def class_definition(class_def):
@@ -201,7 +201,7 @@ def class_definition(class_def):
     if signature:
         signature = f"({signature})"
 
-    class_definition = f"class {class_def.name}{signature}"
+    class_definition = f"class {class_def.name}{signature}:"
 
     return class_definition
 

{symbex-1.2 → symbex-1.3.1}/symbex.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: symbex
-Version: 1.2
+Version: 1.3.1
 Summary: Find the Python code for specified symbols
 Home-page: https://github.com/simonw/symbex
 Author: Simon Willison
@@ -115,6 +115,9 @@ The following filters are available:
 - `--unasync` - only non-async functions
 - `--documented` - functions/classes that have a docstring
 - `--undocumented` - functions/classes that do not have a docstring
+- `--public` - functions/classes that are public - don't have a `_name` prefix (or are `__*__` methods)
+- `--private` - functions/classes that are private - have a `_name` prefix and are not `__*__`
+- `--dunder` - functions matching `__*__` - this should usually be used with `*.*` to find all dunder methods
 - `--typed` - functions that have at least one type annotation
 - `--untyped` - functions that have no type annotations
 - `--partially-typed` - functions that have some type annotations but not all
@@ -135,6 +138,12 @@ This example shows the full source code of every class method in the Python stan
 symbex --fully-typed --no-init '*.*' --stdlib
 ```
 
+To find all public functions and methods that lack documentation, just showing the signature of each one:
+
+```bash
+symbex '*' '*.*' --public --undocumented --signatures
+```
+
 ### Example output
 
 In a fresh checkout of [Datasette](https://github.com/simonw/datasette) I ran this command:
@@ -190,40 +199,40 @@ cog.out(
 ]]] -->
 ```python
 # File: symbex/lib.py Line: 107
-def function_definition(function_node: AST)
+def function_definition(function_node: AST):
 
 # File: symbex/lib.py Line: 13
-def find_symbol_nodes(code: str, filename: str, symbols: Iterable[str]) -> List[Tuple[(AST, Optional[str])]]
+def find_symbol_nodes(code: str, filename: str, symbols: Iterable[str]) -> List[Tuple[(AST, Optional[str])]]:
 
 # File: symbex/lib.py Line: 175
-def class_definition(class_def)
+def class_definition(class_def):
 
 # File: symbex/lib.py Line: 209
-def annotation_definition(annotation: AST) -> str
+def annotation_definition(annotation: AST) -> str:
 
 # File: symbex/lib.py Line: 227
-def read_file(path)
+def read_file(path):
 
 # File: symbex/lib.py Line: 253
-class TypeSummary
+class TypeSummary:
 
 # File: symbex/lib.py Line: 258
-def type_summary(node: AST) -> Optional[TypeSummary]
+def type_summary(node: AST) -> Optional[TypeSummary]:
 
 # File: symbex/lib.py Line: 304
-def quoted_string(s)
+def quoted_string(s):
 
 # File: symbex/lib.py Line: 315
-def import_line_for_function(function_name: str, filepath: str, possible_root_dirs: List[str]) -> str
+def import_line_for_function(function_name: str, filepath: str, possible_root_dirs: List[str]) -> str:
 
 # File: symbex/lib.py Line: 37
-def code_for_node(code: str, node: AST, class_name: str, signatures: bool, docstrings: bool) -> Tuple[(str, int)]
+def code_for_node(code: str, node: AST, class_name: str, signatures: bool, docstrings: bool) -> Tuple[(str, int)]:
 
 # File: symbex/lib.py Line: 71
-def add_docstring(definition: str, node: AST, docstrings: bool, is_method: bool) -> str
+def add_docstring(definition: str, node: AST, docstrings: bool, is_method: bool) -> str:
 
 # File: symbex/lib.py Line: 82
-def match(name: str, symbols: Iterable[str]) -> bool
+def match(name: str, symbols: Iterable[str]) -> bool:
 ```
 <!-- [[[end]]] -->
 This can be combined with other options, or you can run `symbex -s` to see every symbol in the current directory and its subdirectories.
@@ -245,7 +254,7 @@ cog.out(
 ```python
 # File: symbex/lib.py Line: 82
 # from symbex.lib import match
-def match(name: str, symbols: Iterable[str]) -> bool
+def match(name: str, symbols: Iterable[str]) -> bool:
 ```
 <!-- [[[end]]] -->
 To suppress the `# File: ...` comments, use `--no-file` or `-n`.
@@ -265,7 +274,7 @@ cog.out(
 ]]] -->
 ```python
 # from symbex.lib import match
-def match(name: str, symbols: Iterable[str]) -> bool
+def match(name: str, symbols: Iterable[str]) -> bool:
 ```
 <!-- [[[end]]] -->
 
@@ -282,7 +291,7 @@ cog.out(
 ]]] -->
 ```python
 # File: symbex/lib.py Line: 82
-def match(name: str, symbols: Iterable[str]) -> bool
+def match(name: str, symbols: Iterable[str]) -> bool:
     "Returns True if name matches any of the symbols, resolving wildcards"
 ```
 <!-- [[[end]]] -->
@@ -399,14 +408,24 @@ def second_function(a: int, b: int) -> int:
 
 The `--check` option causes `symbex` to return a non-zero exit code if any matches are found for your query.
 
-You can use this in CI to guard against things like functions being added without documentation:
+You can use this in CI to guard against things like public functions being added without documentation:
 
 ```bash
-symbex --function --undocumented --check
+symbex --function --public --undocumented --check
 ```
 This will fail silently but set a `1` exit code if there are any undocumented functions.
 
-`--check` will not output anything by default. Add `--count` to output a count of matching symbols, or `-s/--signatures` to output the signatures of the matching symbols.
+Using this as a step in a CI tool such as GitHub Actions should result in a test failure.
+
+Run this to see the exit code from the last command:
+```bash
+echo $?
+```
+
+`--check` will not output anything by default. Add `--count` to output a count of matching symbols, or `-s/--signatures` to output the signatures of the matching symbols, for example:
+```bash
+symbex --function --public --undocumented --check --count
+```
 
 ## Similar tools
 
@@ -465,6 +484,10 @@ Usage: symbex [OPTIONS] [SYMBOLS]...
           return a + b + 3
       " | symbex my_function --replace
 
+      # Replace my_function with the output of a command:
+      symbex first_function --rexec "sed 's/^/# /'"
+      # This uses sed to comment out the function body
+
 Options:
   --version                  Show the version and exit.
   -f, --file FILE            Files to search
@@ -485,6 +508,9 @@ Options:
   --class                    Filter classes
   --documented               Filter functions with docstrings
   --undocumented             Filter functions without docstrings
+  --public                   Filter for symbols without a _ prefix
+  --private                  Filter for symbols with a _ prefix
+  --dunder                   Filter for symbols matching __*__
   --typed                    Filter functions with type annotations
   --untyped                  Filter functions without type annotations
   --partially-typed          Filter functions with partial type annotations

{symbex-1.2 → symbex-1.3.1}/tests/test_filters.py

@@ -30,6 +30,7 @@ from symbex.cli import cli
                 "def func_partially_typed_no_typed_return",
                 "def func_partially_typed_only_typed_return",
                 "def func_typed_no_params",
+                "def _private",
             ],
         ),
         (
@@ -41,6 +42,7 @@ from symbex.cli import cli
                 "class ClassWithMeta",
                 "class ClassWithMethods",
                 "class ClassForTypedTests",
+                "class _PrivateClass",
             ],
         ),
         (
@@ -69,6 +71,7 @@ from symbex.cli import cli
                 "def func_partially_typed_no_typed_return",
                 "def func_partially_typed_only_typed_return",
                 "def func_typed_no_params",
+                "def _private",
             ],
         ),
         # This doesn't make sense, so should return []
@@ -89,6 +92,7 @@ from symbex.cli import cli
                 "def func_partially_typed_no_typed_return",
                 "def func_partially_typed_only_typed_return",
                 "def func_typed_no_params",
+                "def _private",
             ],
         ),
         (
@@ -128,6 +132,7 @@ from symbex.cli import cli
                 "def func_fully_typed",
                 "async def async_func_fully_typed",
                 "def func_typed_no_params",
+                "def _private",
             ],
         ),
         # Test against methods
@@ -148,6 +153,7 @@ from symbex.cli import cli
                 "def method_keyword_only_args",
                 "async def async_method",
                 "def method_untyped",
+                "def _private_method",
             ],
         ),
         (
@@ -197,6 +203,70 @@ from symbex.cli import cli
                 "def method_untyped",
             ],
         ),
+        # Private and public and dunder
+        (
+            ["--public"],
+            [
+                "def func_no_args",
+                "def func_positional_args",
+                "async def async_func",
+                "def func_default_args",
+                "def func_arbitrary_positional_args",
+                "def func_arbitrary_keyword_args",
+                "def func_arbitrary_args",
+                "def func_positional_only_args",
+                "def func_keyword_only_args",
+                "def func_type_annotations",
+                "class ClassNoBase",
+                "class ClassSingleBase",
+                "class ClassMultipleBase",
+                "class ClassWithMeta",
+                "class ClassWithMethods",
+                "def function_with_non_pep_0484_annotation",
+                "def complex_annotations",
+                "def func_fully_typed",
+                "async def async_func_fully_typed",
+                "def func_partially_typed",
+                "def func_partially_typed_no_typed_return",
+                "def func_partially_typed_only_typed_return",
+                "def func_typed_no_params",
+                "class ClassForTypedTests",
+            ],
+        ),
+        (
+            ["--public", "*.*"],
+            [
+                "def __init__",
+                "def method_types",
+                "def method_positional_only_args",
+                "def method_keyword_only_args",
+                "async def async_method",
+                "def __init__",
+                "def method_fully_typed",
+                "def method_partially_typed",
+                "def method_untyped",
+            ],
+        ),
+        (["--private", "*.*"], ["def _private_method"]),
+        (
+            ["--public", "--class"],
+            [
+                "class ClassNoBase",
+                "class ClassSingleBase",
+                "class ClassMultipleBase",
+                "class ClassWithMeta",
+                "class ClassWithMethods",
+                "class ClassForTypedTests",
+            ],
+        ),
+        (
+            ["--private", "--class"],
+            [
+                "class _PrivateClass",
+            ],
+        ),
+        (["--private"], ["def _private", "class _PrivateClass"]),
+        (["--dunder", "*.*"], ["def __init__", "def __init__"]),
     ),
 )
 def test_filters(args, expected):
@@ -218,8 +288,8 @@ def test_filters(args, expected):
         for line in result.stdout.splitlines()
         if line.strip() and not line.startswith("# File:")
     ]
-    # We only match up to the opening "("
-    defs = [line.split("(")[0] for line in lines]
+    # We only match up to the opening "(" or ":"
+    defs = [line.split("(")[0].split(":")[0] for line in lines]
     assert defs == expected
 
     # Test the --count option too

{symbex-1.2 → symbex-1.3.1}/tests/test_symbex.py

@@ -151,23 +151,23 @@ def test_fixture(directory_full_of_code, monkeypatch, args, expected):
         (
             ["foo*", "--silent"],
             "# File: foo.py Line: 1\n"
-            "def foo1()\n"
+            "def foo1():\n"
             "\n"
             "# File: foo.py Line: 5\n"
-            "def foo2()",
+            "def foo2():",
         ),
-        (["BarClass", "--silent"], "# File: bar.py Line: 1\n" "class BarClass"),
+        (["BarClass", "--silent"], "# File: bar.py Line: 1\n" "class BarClass:"),
         (
             ["baz", "--silent"],
             (
                 "# File: nested.py/x/baz.py Line: 1\n"
-                'def baz(delimiter=", ", type=str)'
+                'def baz(delimiter=", ", type=str):'
             ),
         ),
         # Test for the --module option
         (
             ["-m", "pathlib", "Path", "--silent", "-in"],
-            ("# from pathlib import Path\nclass Path(PurePath)"),
+            ("# from pathlib import Path\nclass Path(PurePath):"),
         ),
     ),
 )

{symbex-1.2 → symbex-1.3.1}/tests/test_symbols.py

@@ -69,7 +69,7 @@ def test_method_symbols():
     assert result.exit_code == 0
     assert result.stdout == (
         "# File: tests/example_symbols.py Class: ClassWithMethods Line: 91\n"
-        "    async def async_method(a, b, c)\n"
+        "    async def async_method(a, b, c):\n"
         "\n"
     )
 
@@ -88,20 +88,20 @@ def test_docstrings():
     assert result.exit_code == 0
     expected = """
 # File: tests/example_symbols.py Line: X
-def func_no_args()
+def func_no_args():
     "This has a single line docstring"
 
 # File: tests/example_symbols.py Line: X
-def func_positional_args(a, b, c)
+def func_positional_args(a, b, c):
     \"\"\"This has a
     multi-line docstring\"\"\"
 
 # File: tests/example_symbols.py Class: ClassForTypedTests Line: X
-    def method_fully_typed(self, a: int, b: str) -> bool
+    def method_fully_typed(self, a: int, b: str) -> bool:
         "Single line"
 
 # File: tests/example_symbols.py Class: ClassForTypedTests Line: X
-    def method_partially_typed(self, a: int, b) -> bool
+    def method_partially_typed(self, a: int, b) -> bool:
         \"\"\"Multiple
         lines\"\"\"
     """.strip()
@@ -126,15 +126,15 @@ def test_imports(no_file):
     expected = """
 # File: tests/example_symbols.py Line: 28
 # from example_symbols import func_arbitrary_positional_args
-def func_arbitrary_positional_args(*args)
+def func_arbitrary_positional_args(*args):
 
 # File: tests/example_symbols.py Line: 33
 # from example_symbols import func_arbitrary_keyword_args
-def func_arbitrary_keyword_args(**kwargs)
+def func_arbitrary_keyword_args(**kwargs):
 
 # File: tests/example_symbols.py Line: 38
 # from example_symbols import func_arbitrary_args
-def func_arbitrary_args(*args, **kwargs)
+def func_arbitrary_args(*args, **kwargs):
     """.strip()
     if no_file:
         lines = expected.split("\n")