Skip to content

structures

dependenpy structures module.

Edge ¤

Bases: object

Edge class. Used in Graph class.

Source code in dependenpy/structures.py 
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
class Edge(object):
    """Edge class. Used in Graph class."""

    def __init__(self, vertex_out, vertex_in, weight=1):
        """
        Initialization method.

        Args:
            vertex_out (Vertex): source vertex (edge going out).
            vertex_in (Vertex): target vertex (edge going in).
            weight (int): weight of the edge.
        """
        self.vertex_out = None
        self.vertex_in = None
        self.weight = weight
        self.go_from(vertex_out)
        self.go_in(vertex_in)

    def __str__(self):
        return f"{self.vertex_out.name} --{self.weight}--> {self.vertex_in.name}"

    def go_from(self, vertex):
        """
        Tell the edge to go out from this vertex.

        Args:
            vertex (Vertex): vertex to go from.
        """
        if self.vertex_out:
            self.vertex_out.edges_out.remove(self)
        self.vertex_out = vertex
        vertex.edges_out.add(self)

    def go_in(self, vertex):
        """
        Tell the edge to go into this vertex.

        Args:
            vertex (Vertex): vertex to go into.
        """
        if self.vertex_in:
            self.vertex_in.edges_in.remove(self)
        self.vertex_in = vertex
        vertex.edges_in.add(self)

__init__(vertex_out, vertex_in, weight=1) ¤

Initialization method.

Parameters:

Name Type Description Default
vertex_out Vertex

source vertex (edge going out).

 required
vertex_in Vertex

target vertex (edge going in).

 required
weight int

weight of the edge.

 1
Source code in dependenpy/structures.py 
256
257
258
259
260
261
262
263
264
265
266
267
268
269
def __init__(self, vertex_out, vertex_in, weight=1):
    """
    Initialization method.

    Args:
        vertex_out (Vertex): source vertex (edge going out).
        vertex_in (Vertex): target vertex (edge going in).
        weight (int): weight of the edge.
    """
    self.vertex_out = None
    self.vertex_in = None
    self.weight = weight
    self.go_from(vertex_out)
    self.go_in(vertex_in)

go_from(vertex) ¤

Tell the edge to go out from this vertex.

Parameters:

Name Type Description Default
vertex Vertex

vertex to go from.

 required
Source code in dependenpy/structures.py 
274
275
276
277
278
279
280
281
282
283
284
def go_from(self, vertex):
    """
    Tell the edge to go out from this vertex.

    Args:
        vertex (Vertex): vertex to go from.
    """
    if self.vertex_out:
        self.vertex_out.edges_out.remove(self)
    self.vertex_out = vertex
    vertex.edges_out.add(self)

go_in(vertex) ¤

Tell the edge to go into this vertex.

Parameters:

Name Type Description Default
vertex Vertex

vertex to go into.

 required
Source code in dependenpy/structures.py 
286
287
288
289
290
291
292
293
294
295
296
def go_in(self, vertex):
    """
    Tell the edge to go into this vertex.

    Args:
        vertex (Vertex): vertex to go into.
    """
    if self.vertex_in:
        self.vertex_in.edges_in.remove(self)
    self.vertex_in = vertex
    vertex.edges_in.add(self)

Graph ¤

Bases: PrintMixin

Graph class.

A class to build a graph given a list of nodes. After instantiation, it has two attributes: vertices, the set of nodes, and edges, the set of edges.

Source code in dependenpy/structures.py 
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
class Graph(PrintMixin):
    """
    Graph class.

    A class to build a graph given a list of nodes. After instantiation,
    it has two attributes: vertices, the set of nodes,
    and edges, the set of edges.
    """

    def __init__(self, *nodes, depth=0):
        """
        Initialization method.

        An intermediary matrix is built to ease the creation of the graph.

        Args:
            *nodes (list of DSM/Package/Module):
                the nodes on which to build the graph.
            depth (int): the depth of the intermediary matrix. See
                the documentation for Matrix class.
        """
        self.edges = set()
        vertices = []
        matrix = Matrix(*nodes, depth=depth)
        for key in matrix.keys:
            vertices.append(Vertex(key))
        for line_index, line in enumerate(matrix.data):
            for col_index, cell in enumerate(line):
                if cell > 0:
                    self.edges.add(Edge(vertices[line_index], vertices[col_index], weight=cell))
        self.vertices = set(vertices)

    def _to_csv(self, **kwargs):
        header = kwargs.pop("header", True)
        text = ["vertex_out,edge_weight,vertex_in\n" if header else ""]
        for edge in self.edges:
            text.append(f"{edge.vertex_out.name},{edge.weight},{edge.vertex_in.name}\n")
        for vertex in self.vertices:
            if not (vertex.edges_out or vertex.edges_in):
                text.append("{vertex.name},,\n")
        return "".join(text)

    def _to_json(self, **kwargs):
        return json.dumps(
            {
                "vertices": [vertex.name for vertex in self.vertices],
                "edges": [
                    {"out": edge.vertex_out.name, "weight": edge.weight, "in": edge.vertex_in.name}
                    for edge in self.edges
                ],
            },
            **kwargs,
        )

    def _to_text(self, **kwargs):
        return ""

__init__(*nodes, depth=0) ¤

Initialization method.

An intermediary matrix is built to ease the creation of the graph.

Parameters:

Name Type Description Default
*nodes list of DSM/Package/Module

the nodes on which to build the graph.

 ()
depth int

the depth of the intermediary matrix. See the documentation for Matrix class.

 0
Source code in dependenpy/structures.py 
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
def __init__(self, *nodes, depth=0):
    """
    Initialization method.

    An intermediary matrix is built to ease the creation of the graph.

    Args:
        *nodes (list of DSM/Package/Module):
            the nodes on which to build the graph.
        depth (int): the depth of the intermediary matrix. See
            the documentation for Matrix class.
    """
    self.edges = set()
    vertices = []
    matrix = Matrix(*nodes, depth=depth)
    for key in matrix.keys:
        vertices.append(Vertex(key))
    for line_index, line in enumerate(matrix.data):
        for col_index, cell in enumerate(line):
            if cell > 0:
                self.edges.add(Edge(vertices[line_index], vertices[col_index], weight=cell))
    self.vertices = set(vertices)

Matrix ¤

Bases: PrintMixin

Matrix class.

A class to build a matrix given a list of nodes. After instantiation, it has two attributes: data, a 2-dimensions array, and keys, the names of the entities in the corresponding order.

Source code in dependenpy/structures.py 
 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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
class Matrix(PrintMixin):
    """
    Matrix class.

    A class to build a matrix given a list of nodes. After instantiation,
    it has two attributes: data, a 2-dimensions array, and keys, the names
    of the entities in the corresponding order.
    """

    def __init__(self, *nodes: DSM | Package | Module, depth: int = 0):  # noqa: WPS231
        """
        Initialization method.

        Args:
            *nodes: The nodes on which to build the matrix.
            depth: The depth of the matrix. This depth is always
                absolute, meaning that building a matrix with a sub-package
                "A.B.C" and a depth of 1 will return a matrix of size 1,
                containing A only. To see the matrix for the sub-modules and
                sub-packages in C, you will have to give depth=4.
        """
        modules: list[Module] = []
        for node in nodes:
            if node.ismodule:
                modules.append(node)  # type: ignore[arg-type]
            elif node.ispackage or node.isdsm:
                modules.extend(node.submodules)  # type: ignore[union-attr]

        if depth < 1:
            keys = modules
        else:
            keys = []
            for module in modules:
                if module.depth <= depth:
                    keys.append(module)
                    continue
                package = module.package
                while package.depth > depth and package.package and package not in nodes:
                    package = package.package
                if package not in keys:
                    keys.append(package)

        size = len(keys)
        data = [[0] * size for _ in range(size)]  # noqa: WPS435
        keys = sorted(keys, key=lambda key: key.absolute_name())

        if depth < 1:
            for index, key in enumerate(keys):  # noqa: WPS440
                key.index = index  # type: ignore[attr-defined]
            for index, key in enumerate(keys):  # noqa: WPS440
                for dep in key.dependencies:
                    if dep.external:
                        continue
                    if dep.target.ismodule and dep.target in keys:
                        data[index][dep.target.index] += 1
                    elif dep.target.ispackage:
                        init = dep.target.get("__init__")
                        if init is not None and init in keys:
                            data[index][init.index] += 1
        else:
            for row, row_key in enumerate(keys):
                for col, col_key in enumerate(keys):
                    data[row][col] = row_key.cardinal(to=col_key)

        self.size = size
        self.keys = [key.absolute_name() for key in keys]  # noqa: WPS441
        self.data = data

    @staticmethod  # noqa: WPS602
    def cast(keys: list[str], data: list[list[int]]) -> Matrix:  # noqa: WPS602
        """
        Cast a set of keys and an array to a Matrix object.

        Arguments:
            keys: The matrix keys.
            data: The matrix data.

        Returns:
            A new matrix.
        """
        matrix = Matrix()
        matrix.keys = copy.deepcopy(keys)
        matrix.data = copy.deepcopy(data)
        return matrix

    @property
    def total(self) -> int:
        """
        Return the total number of dependencies within this matrix.

        Returns:
            The total number of dependencies.
        """
        return sum(cell for line in self.data for cell in line)

    def _to_csv(self, **kwargs):
        text = ["module,", ",".join(self.keys)]
        for index, key in enumerate(self.keys):
            line = ",".join(map(str, self.data[index]))
            text.append(f"{key},{line}")
        return "\n".join(text)

    def _to_json(self, **kwargs):
        return json.dumps({"keys": self.keys, "data": self.data}, **kwargs)

    def _to_text(self, **kwargs):
        if not self.keys or not self.data:
            return ""
        zero = kwargs.pop("zero", "0")
        max_key_length = max(len(key) for key in self.keys + ["Module"])
        max_dep_length = max([len(str(col)) for line in self.data for col in line] + [len(zero)])
        key_col_length = len(str(len(self.keys)))
        key_line_length = max(key_col_length, 2)
        column_length = max(key_col_length, max_dep_length)
        bold = Style.BRIGHT
        reset = Style.RESET_ALL

        # first line left headers
        text = [f"\n {bold}{'Module':>{max_key_length}}{reset} │ {bold}{'Id':>{key_line_length}}{reset} │"]
        # first line column headers
        for index, _ in enumerate(self.keys):
            text.append(f"{bold}{index:^{column_length}}{reset}│")
        text.append("\n")
        # line of dashes
        text.append(f" {'─' * max_key_length}─┼─{'─' * key_line_length}─┼")
        for _ in range(len(self.keys) - 1):
            text.append(f"{'─' * column_length}┼")
        text.append(f"{'─' * column_length}┤")
        text.append("\n")
        # lines
        for index, key in enumerate(self.keys):  # noqa: WPS440
            text.append(f" {key:>{max_key_length}} │ {bold}{index:>{key_line_length}}{reset} │")
            for value in self.data[index]:
                text.append((f"{value if value else zero:>{column_length}}│"))
            text.append("\n")
        text.append("\n")

        return "".join(text)

__init__(*nodes, depth=0) ¤

Initialization method.

Parameters:

Name Type Description Default
*nodes DSM | Package | Module

The nodes on which to build the matrix.

 ()
depth int

The depth of the matrix. This depth is always absolute, meaning that building a matrix with a sub-package "A.B.C" and a depth of 1 will return a matrix of size 1, containing A only. To see the matrix for the sub-modules and sub-packages in C, you will have to give depth=4.

 0
Source code in dependenpy/structures.py 
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
def __init__(self, *nodes: DSM | Package | Module, depth: int = 0):  # noqa: WPS231
    """
    Initialization method.

    Args:
        *nodes: The nodes on which to build the matrix.
        depth: The depth of the matrix. This depth is always
            absolute, meaning that building a matrix with a sub-package
            "A.B.C" and a depth of 1 will return a matrix of size 1,
            containing A only. To see the matrix for the sub-modules and
            sub-packages in C, you will have to give depth=4.
    """
    modules: list[Module] = []
    for node in nodes:
        if node.ismodule:
            modules.append(node)  # type: ignore[arg-type]
        elif node.ispackage or node.isdsm:
            modules.extend(node.submodules)  # type: ignore[union-attr]

    if depth < 1:
        keys = modules
    else:
        keys = []
        for module in modules:
            if module.depth <= depth:
                keys.append(module)
                continue
            package = module.package
            while package.depth > depth and package.package and package not in nodes:
                package = package.package
            if package not in keys:
                keys.append(package)

    size = len(keys)
    data = [[0] * size for _ in range(size)]  # noqa: WPS435
    keys = sorted(keys, key=lambda key: key.absolute_name())

    if depth < 1:
        for index, key in enumerate(keys):  # noqa: WPS440
            key.index = index  # type: ignore[attr-defined]
        for index, key in enumerate(keys):  # noqa: WPS440
            for dep in key.dependencies:
                if dep.external:
                    continue
                if dep.target.ismodule and dep.target in keys:
                    data[index][dep.target.index] += 1
                elif dep.target.ispackage:
                    init = dep.target.get("__init__")
                    if init is not None and init in keys:
                        data[index][init.index] += 1
    else:
        for row, row_key in enumerate(keys):
            for col, col_key in enumerate(keys):
                data[row][col] = row_key.cardinal(to=col_key)

    self.size = size
    self.keys = [key.absolute_name() for key in keys]  # noqa: WPS441
    self.data = data

cast(keys, data) staticmethod ¤

Cast a set of keys and an array to a Matrix object.

Parameters:

Name Type Description Default
keys list[str]

The matrix keys.

 required
data list[list[int]]

The matrix data.

 required

Returns:

Type Description
Matrix

A new matrix.
Source code in dependenpy/structures.py 
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
@staticmethod  # noqa: WPS602
def cast(keys: list[str], data: list[list[int]]) -> Matrix:  # noqa: WPS602
    """
    Cast a set of keys and an array to a Matrix object.

    Arguments:
        keys: The matrix keys.
        data: The matrix data.

    Returns:
        A new matrix.
    """
    matrix = Matrix()
    matrix.keys = copy.deepcopy(keys)
    matrix.data = copy.deepcopy(data)
    return matrix

total() property ¤

Return the total number of dependencies within this matrix.

Returns:

Type Description
int

The total number of dependencies.
Source code in dependenpy/structures.py 
102
103
104
105
106
107
108
109
110
@property
def total(self) -> int:
    """
    Return the total number of dependencies within this matrix.

    Returns:
        The total number of dependencies.
    """
    return sum(cell for line in self.data for cell in line)

TreeMap ¤

Bases: PrintMixin

TreeMap class.

Source code in dependenpy/structures.py 
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
class TreeMap(PrintMixin):
    """TreeMap class."""

    def __init__(self, *nodes: Any, value: int = -1):
        """
        Initialization method.

        Arguments:
            *nodes: the nodes from which to build the treemap.
            value: the value of the current area.
        """
        # if nodes:
        #     matrix_lower_level = Matrix(*nodes, depth=2)
        #     matrix_current_level = Matrix(*nodes, depth=1)
        #     if value == -1:
        #         value = sum(c for row in matrix_current_level.data for c in row)
        #     splits = [0]
        #     key_comp = matrix_lower_level.keys[0].split('.')[0]
        #     i = 1
        #     for key in matrix_lower_level.keys[1:]:
        #         key = key.split('.')[0]
        #         if key != key_comp:
        #             splits.append(i)
        #             key_comp = key
        #         i += 1
        #     splits.append(i)
        #
        #     self.data = []
        #     for i in range(len(splits) - 1):
        #         self.data.append([])
        #         rows = matrix_lower_level.data[splits[i]:splits[i+1]]
        #         for j in range(len(splits) - 1):
        #             self.data[i].append([row[splits[j]:splits[j+1]] for row in rows])

        self.value = value

    def _to_csv(self, **kwargs):
        return ""

    def _to_json(self, **kwargs):
        return ""

    def _to_text(self, **kwargs):
        return ""

__init__(*nodes, value=-1) ¤

Initialization method.

Parameters:

Name Type Description Default
*nodes Any

the nodes from which to build the treemap.

 ()
value int

the value of the current area.

 -1
Source code in dependenpy/structures.py 
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
def __init__(self, *nodes: Any, value: int = -1):
    """
    Initialization method.

    Arguments:
        *nodes: the nodes from which to build the treemap.
        value: the value of the current area.
    """
    # if nodes:
    #     matrix_lower_level = Matrix(*nodes, depth=2)
    #     matrix_current_level = Matrix(*nodes, depth=1)
    #     if value == -1:
    #         value = sum(c for row in matrix_current_level.data for c in row)
    #     splits = [0]
    #     key_comp = matrix_lower_level.keys[0].split('.')[0]
    #     i = 1
    #     for key in matrix_lower_level.keys[1:]:
    #         key = key.split('.')[0]
    #         if key != key_comp:
    #             splits.append(i)
    #             key_comp = key
    #         i += 1
    #     splits.append(i)
    #
    #     self.data = []
    #     for i in range(len(splits) - 1):
    #         self.data.append([])
    #         rows = matrix_lower_level.data[splits[i]:splits[i+1]]
    #         for j in range(len(splits) - 1):
    #             self.data[i].append([row[splits[j]:splits[j+1]] for row in rows])

    self.value = value

Vertex ¤

Bases: object

Vertex class. Used in Graph class.

Source code in dependenpy/structures.py 
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
class Vertex(object):
    """Vertex class. Used in Graph class."""

    def __init__(self, name):
        """
        Initialization method.

        Args:
            name (str): name of the vertex.
        """
        self.name = name
        self.edges_in = set()
        self.edges_out = set()

    def __str__(self):
        return self.name

    def connect_to(self, vertex: Vertex, weight: int = 1) -> Edge:
        """
        Connect this vertex to another one.

        Args:
            vertex: Vertex to connect to.
            weight: Weight of the edge.

        Returns:
            The newly created edge.
        """
        for edge in self.edges_out:
            if vertex == edge.vertex_in:
                return edge
        return Edge(self, vertex, weight)

    def connect_from(self, vertex: Vertex, weight: int = 1) -> Edge:
        """
        Connect another vertex to this one.

        Args:
            vertex: Vertex to connect from.
            weight: Weight of the edge.

        Returns:
            The newly created edge.
        """
        for edge in self.edges_in:
            if vertex == edge.vertex_out:
                return edge
        return Edge(vertex, self, weight)

__init__(name) ¤

Initialization method.

Parameters:

Name Type Description Default
name str

name of the vertex.

 required
Source code in dependenpy/structures.py 
206
207
208
209
210
211
212
213
214
215
def __init__(self, name):
    """
    Initialization method.

    Args:
        name (str): name of the vertex.
    """
    self.name = name
    self.edges_in = set()
    self.edges_out = set()

connect_from(vertex, weight=1) ¤

Connect another vertex to this one.

Parameters:

Name Type Description Default
vertex Vertex

Vertex to connect from.

 required
weight int

Weight of the edge.

 1

Returns:

Type Description
Edge

The newly created edge.
Source code in dependenpy/structures.py 
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
def connect_from(self, vertex: Vertex, weight: int = 1) -> Edge:
    """
    Connect another vertex to this one.

    Args:
        vertex: Vertex to connect from.
        weight: Weight of the edge.

    Returns:
        The newly created edge.
    """
    for edge in self.edges_in:
        if vertex == edge.vertex_out:
            return edge
    return Edge(vertex, self, weight)

connect_to(vertex, weight=1) ¤

Connect this vertex to another one.

Parameters:

Name Type Description Default
vertex Vertex

Vertex to connect to.

 required
weight int

Weight of the edge.

 1

Returns:

Type Description
Edge

The newly created edge.
Source code in dependenpy/structures.py 
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
def connect_to(self, vertex: Vertex, weight: int = 1) -> Edge:
    """
    Connect this vertex to another one.

    Args:
        vertex: Vertex to connect to.
        weight: Weight of the edge.

    Returns:
        The newly created edge.
    """
    for edge in self.edges_out:
        if vertex == edge.vertex_in:
            return edge
    return Edge(self, vertex, weight)