memtab.viz module

This module contains the visualization functions for the memtab package. It includes functions for generating markdown files based on the analysis results. The generated visualizations help users understand the memory usage and organization of their code. The module also includes functions for generating memory maps, which provide a visual representation of the memory layout of the code.

class memtab.viz.MemtabMarkdownReportSpec

Bases: object

generate_report(memtab, filename)

This generates a markdown summary file of the memory table report. This markdown can be used as a GITHUB_STEP_SUMMARY, for example. A reference for why this utility exists can be found here: https://github.com/joonvena/Robot-Reporter Documentation on the GITHUB_STEP_SUMMARY use can be found here: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#adding-a-job-summary

Return type:

None

Args:

response (Memtab): the memtab tabulator containing the data to be summarized. md (str): the markdown filename to write to. symbol_count_cutoff (int, optional): the point at which to cutoff the table of symbols. Defaults to 10. sort_by_size (bool, optional): sort the symbols by size, largest to smallest. Defaults to True. reduce_column_count (bool, optional): For brevity, only show key columns. Defaults to True.

reduce_column_count: bool = True

report_name = 'markdown'

sort_by_size: bool = True

symbol_count_cutoff: int = 10