make_dot.py

#!/usr/bin/env python

import sys
import re
import os

from graphviz import Digraph

files_in_tree = {}
inspected = {}

include_regex = r'#include [<"](.*)[>"]'

def inspect_file(file_name, graph):
    """ Recursively evaluate the file #includes and throughout the project. """

    # Ensure the inspected files are within the project tree
    if not file_name in files_in_tree:
        return

    file_obj = open(files_in_tree[file_name])

    inspected[file_name] = True
    for line in file_obj:
        match = re.match(include_regex, line)
        if match:
            dep = match.group(1)
            graph.edge(dep, file_name)

            if not dep in inspected:
                inspect_out = inspect_file(dep, graph)
                if inspect_out:
                    graph = inspect_out

    file_obj.close()

    return graph

def record_project_files(root_path):
    """ Walk the root path of the project to keep a dict of files within
        the project. This keeps the script in the bounds of the project. """

    for root, dirs, files in os.walk(root_path):
        for name in files:
            if not ".git" in root:
                abs_file_path = os.path.abspath(os.path.join(root, name))
                if not name in files_in_tree:
                    files_in_tree[name] = abs_file_path

def usage():
    """ Let the user know the expected runtime args """

    if len(sys.argv) != 2:
        print("Usage: ./make_dot.py [project_root]")
        sys.exit()

def main():
    """ Recurse through a project to get the include relationships """

    usage()

    root_path = sys.argv[1]
    record_project_files(root_path)

    graph = Digraph('G', filename='source_tree.dot')

    # Recurse through the project files
    for source_file in files_in_tree:
        if not source_file in inspected:
            graph = inspect_file(source_file, graph)

    graph.save()
    graph.view()

if __name__ == '__main__':
    main()