josephedradan / code_analyzer

Code Analyzer

What is this?

A python code analyzer that allows you to visually see how your code works after executing code. Alternatively, you can think of it as a python debugger that prints all the lines executed.

Why would you use this?

Let's say you don't want to use a python debugger and you want to see how your code runs line by line printed out. You can import this module and add a few lines of code to initialize the analyzer and run your code, and you will get a simple analysis of the code executed in your terminal or exported to a txt or html file.

It is not advised to use this analyzer in a big project as the output won't fit in your terminal; though, using an export method call to see the code in a file might be more useful/helpful.

Requirements:

code_analyzer/requirements.txt

Lines 1 to 4 in e249264

	# Python dependencies required for development
	rich
	colorama
	pandas

Example:

code_analyzer/examples/example_recursive.py

Lines 24 to 53 in 571b6c7

	from code_analyzer import CodeAnalyzer
	code_analyzer = CodeAnalyzer() # Initialize analyzer
	code_analyzer.start()
	# Comment that will be displayed on the next line
	code_analyzer.record_comment_for_interpretable_next("Function definition here!")
	def recursive(depth: int) -> int:
	# Comment that will be displayed on the previous line
	code_analyzer.record_comment_for_interpretable_previous({"__depth": depth})
	if depth <= 0:
	code_analyzer.record_comment_for_interpretable_next({"Final depth": depth})
	return depth
	return recursive(depth - 1)
	code_analyzer.record_comment_for_interpretable_next("This is where the fun begins")
	recursive(5)
	code_analyzer.stop()
	code_analyzer.print()
	# code_analyzer.get_code_analyzer_printer().print_debug()
	code_analyzer.get_code_analyzer_printer().export_to_txt()
	# code_analyzer.get_code_analyzer_printer().print_rich() # export_rich_to_html prints to console by default
	code_analyzer.get_code_analyzer_printer().export_rich_to_html()

Output

Rich output html

Notes

In the output of a print (Such as in the image above):

• Blue foreground code is a callable's definition.
• Green foreground code is a callable being executed.
• Red foreground text are {Variable: value} pairs found in between the {} brackets that are new to the current interpretable relative to its scope.
• Purple foreground text are (arguments) found in between the () brackets passed to the method calls below:
  • .record_comment_for_interpretable_next(...)
  • .record_comment_for_interpretable_previous(...)

In the output of a rich export (such as the .html files in the examples folder):

• Blue background code is a callable's definition.
• Green background code is a callable being executed.
• Orange foreground text are {Variable: value} pairs found in between the {} brackets that are new to the current interpretable relative to its scope.
• Red foreground text are (arguments) found in between the () brackets passed to the method calls below:
  • .record_comment_for_interpretable_next(...)
  • .record_comment_for_interpretable_previous(...)

IF YOU SEE CODE THAT DOESN'T SEEM TO BE CODE THAT YOU SHOULD BE ANALYZING WHEN USING TYPE HINTING, ADD THE IMPORT BELOW TO THE TOP OF THE FILE TO POSSIBLY REMOVE IT

from __future__ import annotations

Installation

pip install python-code-analyzer

pypi

TODO:

• Fancy visualizer
• Memory usage?
• Timing code?
• profiler (Time and calls amount)
• dis.show_code