Skip to content

Roject Manager

ProjectManager

Manages a software project by analyzing its structure and dependencies.

Attributes:

Name Type Description
repo_path

The path to the repository being analyzed.
project_hierarchy

The relative path within the repository to the project_hierarchy.json file.
graph

A networkx graph representing the project's dependency structure.
Source code in repo_agent/project_manager.py 
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
class ProjectManager:
    """
    Manages a software project by analyzing its structure and dependencies.

    Attributes:
        repo_path: The path to the repository being analyzed.
        project_hierarchy: The relative path within the repository to the
            project_hierarchy.json file.
        graph: A networkx graph representing the project's dependency structure.
    """

    def __init__(self, repo_path, project_hierarchy):
        """
        Initializes a project analysis environment with the repository path and location of its project hierarchy definition.



        Args:
            repo_path: The path to the repository being analyzed.
            project_hierarchy: The relative path within the repository to the
                project_hierarchy.json file.

        Returns:
            None

        """

        self.repo_path = repo_path
        self.project = jedi.Project(self.repo_path)
        self.project_hierarchy = os.path.join(
            self.repo_path, project_hierarchy, "project_hierarchy.json"
        )

    def get_project_structure(self):
        """
        No valid docstring found.

        """

        def walk_dir(root, prefix=""):
            structure.append(prefix + os.path.basename(root))
            new_prefix = prefix + "  "
            for name in sorted(os.listdir(root)):
                if name.startswith("."):
                    continue
                path = os.path.join(root, name)
                if os.path.isdir(path):
                    structure.append(new_prefix + name)
                    walk_dir(path, new_prefix)
                elif os.path.isfile(path) and name.endswith(".py"):
                    structure.append(new_prefix + name)

        structure = []
        walk_dir(self.repo_path)
        return "\n".join(structure)

    def build_path_tree(self, who_reference_me, reference_who, doc_item_path):
        """
        Constructs a hierarchical tree structure representing relationships between documentation paths, visualizing references to and from a given item.

        Args:
            who_reference_me: A list of paths that reference this item.
            reference_who: A list of paths that this item references.
            doc_item_path: The path to the documentation item.

        Returns:
            str: A string representation of the constructed path tree.


        """

        from collections import defaultdict

        def tree():
            return defaultdict(tree)

        path_tree = tree()
        for path_list in [who_reference_me, reference_who]:
            for path in path_list:
                parts = path.split(os.sep)
                node = path_tree
                for part in parts:
                    node = node[part]
        parts = doc_item_path.split(os.sep)
        parts[-1] = "✳️" + parts[-1]
        node = path_tree
        for part in parts:
            node = node[part]

        def tree_to_string(tree, indent=0):
            s = ""
            for key, value in sorted(tree.items()):
                s += "    " * indent + key + "\n"
                if isinstance(value, dict):
                    s += tree_to_string(value, indent + 1)
            return s

        return tree_to_string(path_tree)

__init__(repo_path, project_hierarchy)

Initializes a project analysis environment with the repository path and location of its project hierarchy definition.

Parameters:

Name Type Description Default
repo_path

The path to the repository being analyzed.

 required
project_hierarchy

The relative path within the repository to the project_hierarchy.json file.

 required

Returns:

Type Description

None
Source code in repo_agent/project_manager.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
def __init__(self, repo_path, project_hierarchy):
    """
    Initializes a project analysis environment with the repository path and location of its project hierarchy definition.



    Args:
        repo_path: The path to the repository being analyzed.
        project_hierarchy: The relative path within the repository to the
            project_hierarchy.json file.

    Returns:
        None

    """

    self.repo_path = repo_path
    self.project = jedi.Project(self.repo_path)
    self.project_hierarchy = os.path.join(
        self.repo_path, project_hierarchy, "project_hierarchy.json"
    )

build_path_tree(who_reference_me, reference_who, doc_item_path)

Constructs a hierarchical tree structure representing relationships between documentation paths, visualizing references to and from a given item.

Parameters:

Name Type Description Default
who_reference_me

A list of paths that reference this item.

 required
reference_who

A list of paths that this item references.

 required
doc_item_path

The path to the documentation item.

 required

Returns:

Name Type Description
str

A string representation of the constructed path tree.
Source code in repo_agent/project_manager.py 
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
def build_path_tree(self, who_reference_me, reference_who, doc_item_path):
    """
    Constructs a hierarchical tree structure representing relationships between documentation paths, visualizing references to and from a given item.

    Args:
        who_reference_me: A list of paths that reference this item.
        reference_who: A list of paths that this item references.
        doc_item_path: The path to the documentation item.

    Returns:
        str: A string representation of the constructed path tree.


    """

    from collections import defaultdict

    def tree():
        return defaultdict(tree)

    path_tree = tree()
    for path_list in [who_reference_me, reference_who]:
        for path in path_list:
            parts = path.split(os.sep)
            node = path_tree
            for part in parts:
                node = node[part]
    parts = doc_item_path.split(os.sep)
    parts[-1] = "✳️" + parts[-1]
    node = path_tree
    for part in parts:
        node = node[part]

    def tree_to_string(tree, indent=0):
        s = ""
        for key, value in sorted(tree.items()):
            s += "    " * indent + key + "\n"
            if isinstance(value, dict):
                s += tree_to_string(value, indent + 1)
        return s

    return tree_to_string(path_tree)

get_project_structure()

No valid docstring found.

Source code in repo_agent/project_manager.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
def get_project_structure(self):
    """
    No valid docstring found.

    """

    def walk_dir(root, prefix=""):
        structure.append(prefix + os.path.basename(root))
        new_prefix = prefix + "  "
        for name in sorted(os.listdir(root)):
            if name.startswith("."):
                continue
            path = os.path.join(root, name)
            if os.path.isdir(path):
                structure.append(new_prefix + name)
                walk_dir(path, new_prefix)
            elif os.path.isfile(path) and name.endswith(".py"):
                structure.append(new_prefix + name)

    structure = []
    walk_dir(self.repo_path)
    return "\n".join(structure)