Python 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.
Reason this release was yanked:
wrong deps
Project description
Python Module Parser
Python 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.py
This project inspired by https://github.com/xnuinside/codegraph and https://github.com/xnuinside/py-models-parser and will be used as a parser inside them in the future.
Features
- Parse Python modules and extract information about imports, functions, and variables
- Identify line numbers for each import, function, and variable
- Represent the extracted information in a structured format
Installation
To install the Python Module Parser library, use pip
:
pip install py-module-parser
Usage
Here's a simple example of how to use the Python Module Parser library:
from py_module_parser import PyModulesParser
source_code = """from django.db import models
class 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='from_import'
),
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,
default=FuncCallOutput(
lineno_start=5,
lineno_end=5,
func_name='models.CharField',
args=[],
kwargs={'max_length': 50},
node_type='func_call'
),
properties={},
node_type='variable'
),
VariableOutput(
lineno_start=6,
lineno_end=6,
name='last_name',
type_annotation=None,
default=FuncCallOutput(
lineno_start=6,
lineno_end=6,
func_name='models.CharField',
args=[],
kwargs={'max_length': 50},
node_type='func_call'
),
properties={},
node_type='variable'
),
VariableOutput(
lineno_start=7,
lineno_end=7,
name='instrument',
type_annotation=None,
default=FuncCallOutput(
lineno_start=7,
lineno_end=7,
func_name='models.CharField',
args=[],
kwargs={'max_length': 100},
node_type='func_call'
),
properties={},
node_type='variable'
)
],
node_type='class'
)
]
To parse from file, you can use method parse_from_file
from py_module_parser import parse_from_file
parsed_output = parse_from_file(file_path='path_to/python_module.py')
print(parsed_output)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for py_module_parser-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 582da1b936ad1ff6ef5f7bee8899e48591c8328ff323dc25372e16e5c4462853 |
|
MD5 | 1c7525ca3a2b335815d0e9a629fc1466 |
|
BLAKE2b-256 | 94e880cefe9da0dd6f0af039c59b5e8aca7b0410dd4387a5e6a6d9e2d1759778 |