Package: py-module-parser
Python Module ParserPython Module Parser is a library that parses Python modules and outputs information about imports, functions, variables, and their corresponding line numbers. This makes it easier to analyze and understand the structure of your Python code.To get more samples of output - check tests: tests/test_py_module_parser.pyThis project inspired byhttps://github.com/xnuinside/codegraphandhttps://github.com/xnuinside/py-models-parserand will be used as a parser inside them in the future.FeaturesParse Python modules and extract information about imports, functions, and variablesIdentify line numbers for each import, function, and variableRepresent the extracted information in a structured formatInstallationTo install the Python Module Parser library, usepip:pipinstallpy-module-parserUsageExample with different output formats provided in example/example.py# to run examplepythonexample/example.pyHere's a simple example of how to use the Python Module Parser library:frompy_module_parserimportPyModulesParsersource_code="""from django.db import modelsclass Musician(models.Model):first_name = models.CharField(max_length=50)last_name = models.CharField(max_length=50)instrument = models.CharField(max_length=100)"""parsed_output=PyModulesParser(source_code).parse()print(parsed_output)This will output:[FromImportOutput(lineno_start=1,lineno_end=1,module='django.db',imports=[ImportOutput(lineno_start=1,lineno_end=1,name='models',alias=None,node_type='import')],node_type='import_from'),ClassOutput(lineno_start=4,lineno_end=7,name='Musician',parents=['models.Model'],attrs=[VariableOutput(lineno_start=5,lineno_end=5,name='first_name',type_annotation=None,value=CallOutput(lineno_start=5,lineno_end=5,func_name='models.CharField',args=[],kwargs={'max_length':50},node_type='call'),properties={},node_type='variable'),VariableOutput(lineno_start=6,lineno_end=6,name='last_name',type_annotation=None,value=CallOutput(lineno_start=6,lineno_end=6,func_name='models.CharField',args=[],kwargs={'max_length':50},node_type='call'),properties={},node_type='variable'),VariableOutput(lineno_start=7,lineno_end=7,name='instrument',type_annotation=None,value=CallOutput(lineno_start=7,lineno_end=7,func_name='models.CharField',args=[],kwargs={'max_length':100},node_type='call'),properties={},node_type='variable')],node_type='class')]To parse from file, you can use methodparse_from_filefrompy_module_parserimportparse_from_fileparsed_output=parse_from_file(file_path='path_to/python_module.py')print(parsed_output)Parser OutputBy default parser output is a ParserOutput model -it is a list with some additional methods.
List contains inside a nodes from parsed files - all Nodes is a Pydantic models with nested objects.List of possible node types exists as enum in py_modules_parser.NodesTypes:VARIABLE = 'variable' - all variables likea='b'CALL = 'call' - all calls - function calls or class calls likefunc_name(a)orClassA()CLASS = 'class' - classes defenitionsclass SomeClass: ...FUNCTION_DEF = 'func_def' - functions defenitionsdef some_func(): ...IMPORT = 'import' - imports likeimport moduleIMPORT_FROM = 'import_from' - imports likefrom module import nameOutput is a list of pydantic models specific for each node.
Node type is always stored in argumennode_typeBecause, output models is Pydantic models - you can do anything with them that you can do with pydantic models.Output group_by_typeparsed_output=PyModulesParser(source_code).parse()parsed_output_group=parsed_output.group_by_type()print("Result group_by_type:\n",parsed_output_group)# you can also use parsed_output.group_by_type().json()# to get json output grouped by typeOutput jsonparsed_output=PyModulesParser(source_code).parse()parsed_output_json=parsed_output.json()print("Result in json:\n",parsed_output_json)Output dictparsed_output=PyModulesParser(source_code).parse()parsed_output_group_dict=parsed_output.group_by_type().model_dump()print("Result as python dict:\n")print(parsed_output_group_dict)TODO in future releasesImplement parsing of function argumentsImplement parsing of function returnsImplement parsing of nested classesChangelog** 0.5.0 - Update pydantic to 2.x version **Pydantic is updated to 2.5.2VariableOutput.default was renamed to VariableOutput.value** 0.4.0 - First stable release**Renamed FuncCallOutput to CallOutput to include Class calls as well as function calls.Added Enum to define available NodeTypes as py_module_parser.NodeTypes.Added parsing of function definition nodes.Implemented parsing of decorators.Parser results can now be dumped to Python dictionaries or JSON, as well as grouped by type. For more details, please refer to the example/ directory and the README file.