Init

Author: jakecyr

.gitignore

@@ -0,0 +1,8 @@
+*.egg-info
+.vscode
+env
+**/**/__pycache__
+.coverage
+.pytest_cache
+build
+dist

README.md

@@ -0,0 +1,17 @@
+# Python Code Parser
+
+Parse Python code to extract information about functions, classes, methods, etc.
+
+## Upload to PyPi
+
+First you have to build the wheel file:
+
+```bash
+python setup.py bdist_wheel
+```
+
+Then the wheel file can be uploaded to PyPi with:
+
+```bash
+twine upload --skip-existing dist/*
+```

pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["setuptools", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "python_code_parse"
+authors = [
+    {name = "Jake Cyr", email = "cyrjake@gmail.com"},
+]
+version = "0.0.1"
+description = "Parse code to get information about functions, etc."
+readme = "README.md"
+requires-python = ">=3.7"
+keywords = ["code", "parse", "python", "ast", "abstract syntax tree"]
+license = {text = "MIT"}
+classifiers = [
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+]
+dependencies = []
+
+[project.optional-dependencies]
+dev = [
+  "twine",
+  "wheel",
+]
+

python_code_parse/__init__.py

@@ -0,0 +1,5 @@
+__all__ = ["get_all_function_info_from_code", "models"]
+from python_code_parse.get_all_function_info_from_code import (
+    get_all_function_info_from_code,
+)
+from python_code_parse.models import FunctionArg, FunctionInfo

python_code_parse/get_all_function_info_from_code.py

@@ -0,0 +1,38 @@
+import ast
+from typing import List
+from python_code_parse.models.function_arg import FunctionArg
+from python_code_parse.models.function_info import FunctionInfo
+
+
+def get_all_function_info_from_code(code: str) -> List[FunctionInfo]:
+    """Get a list of functions found in a code string."""
+
+    functions: List[FunctionInfo] = []
+    tree: ast.Module = ast.parse(code)
+
+    for node in ast.walk(tree):
+        if isinstance(node, ast.FunctionDef):
+            args: List[FunctionArg] = []
+            for arg in node.args.args:
+                arg_str = arg.arg
+                if arg.annotation:
+                    arg_str += ": " + ast.unparse(arg.annotation).strip()
+                    args.append(
+                        FunctionArg(
+                            name=arg.arg, annotation=ast.unparse(arg.annotation).strip()
+                        )
+                    )
+                else:
+                    args.append(FunctionArg(name=arg.arg, annotation=""))
+
+            functions.append(
+                FunctionInfo(
+                    name=node.name,
+                    args=args,
+                    return_type=ast.unparse(node.returns).strip()
+                    if node.returns
+                    else "",
+                    line=node.lineno,
+                )
+            )
+    return functions

python_code_parse/main.py

@@ -0,0 +1,19 @@
+import os
+from python_code_parse.get_all_function_info_from_code import get_function_info_from_code
+import json
+
+
+def main():
+    file_path = os.path.join(os.path.dirname(__file__), "../test.py")
+
+    with open(file_path, encoding="utf-8") as f:
+        code = f.read()
+
+    functions = get_function_info_from_code(code)
+    json_version = json.dumps(functions, default=lambda o: o.__dict__, indent=4)
+
+    print(json_version)
+
+
+if __name__ == "__main__":
+    main()

python_code_parse/models/__init__.py

@@ -0,0 +1,2 @@
+from python_code_parse.models.function_arg import FunctionArg
+from python_code_parse.models.function_info import FunctionInfo

python_code_parse/models/function_arg.py

@@ -0,0 +1,9 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class FunctionArg:
+    """A dataclass to hold information about a function argument."""
+
+    name: str
+    annotation: str

python_code_parse/models/function_info.py

@@ -0,0 +1,13 @@
+from dataclasses import dataclass
+from typing import List
+from python_code_parse.models.function_arg import FunctionArg
+
+
+@dataclass
+class FunctionInfo:
+    """A dataclass to hold information about a function."""
+
+    name: str
+    args: List[FunctionArg]
+    return_type: str
+    line: int

setup.py

@@ -0,0 +1,12 @@
+from setuptools import setup, find_packages
+
+
+def get_readme():
+    with open("README.md") as f:
+        return f.read()
+
+
+setup(
+    long_description=get_readme(),
+    packages=find_packages(),
+)