polygonal_graph.polygonal_graph_model() - Code Metrics - Inspection of "update docstrings" - erivlis/graphinate - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 2ba9b1...8014f2 )

by Eran

created 2024-05-30 10:06 UTC

polygonal_graph.polygonal_graph_model() A

↳ Parent: polygonal_graph

Complexity

Conditions

Size

Total Lines	22
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	8
nop	1
dl	0
loc	22
rs	10
c	0
b	0
f	0

import graphinate
import graphinate.modeling
import networkx as nx

N: int = 8


def polygonal_graph_model(number_of_sides: int = N):
    """
    Create a polygonal graph model.

    Args:
        number_of_sides (int): Number of sides in the polygon. Defaults to N.

    Returns:
        GraphModel: A graph model representing a polygonal graph.
    """

    # Define GraphModel
    graph_model = graphinate.model(name="Octagonal Graph")

    # Register edges supplier function
    @graph_model.edge()
    def edge():
        for i in range(number_of_sides - 1):
            yield {'source': i, 'target': i + 1}
        yield {'source': number_of_sides - 1, 'target': 0}

    return graph_model


model = polygonal_graph_model()

if __name__ == '__main__':

    use_materialize = True

    if use_materialize:
        # Materialize the GraphModel
        graphinate.materialize(
            model,
            builder=graphinate.builders.GraphQLBuilder,
            actualizer=graphinate.graphql
        )

    else:
        # Or

        # 1. Define Graph Builder
        builder = graphinate.builders.NetworkxBuilder(model=model)

        # Then
        # 2. Build the Graph object
        graph: nx.Graph = builder.build()

        # Then
        # 3. Option A - Output to console
        print(graph)

        # Or
        # 3. Option B - Output as a plot
        graphinate.materializers.plot(graph)


1		import graphinate
2		import graphinate.modeling
3		import networkx as nx
4
5		N: int = 8
6
7
8		def polygonal_graph_model(number_of_sides: int = N):
9		"""
10		Create a polygonal graph model.
11
12		Args:
13		number_of_sides (int): Number of sides in the polygon. Defaults to N.
14
15		Returns:
16		GraphModel: A graph model representing a polygonal graph.
17		"""
18
19		# Define GraphModel
20		graph_model = graphinate.model(name="Octagonal Graph")
21
22		# Register edges supplier function
23		@graph_model.edge()
24		def edge():
25		for i in range(number_of_sides - 1):
26		yield {'source': i, 'target': i + 1}
27		yield {'source': number_of_sides - 1, 'target': 0}
28
29		return graph_model
30
31
32		model = polygonal_graph_model()
33
34	View Code Duplication	if __name__ == '__main__':
		0 ignored issues – show Duplication introduced 2024-03-27 00:04 UTC by Report Bug Copy Issue Report This code seems to be duplicated in your project. Loading history...
35		use_materialize = True
36
37		if use_materialize:
38		# Materialize the GraphModel
39		graphinate.materialize(
40		model,
41		builder=graphinate.builders.GraphQLBuilder,
42		actualizer=graphinate.graphql
43		)
44
45		else:
46		# Or
47
48		# 1. Define Graph Builder
49		builder = graphinate.builders.NetworkxBuilder(model=model)
50
51		# Then
52		# 2. Build the Graph object
53		graph: nx.Graph = builder.build()
54
55		# Then
56		# 3. Option A - Output to console
57		print(graph)
58
59		# Or
60		# 3. Option B - Output as a plot
61		graphinate.materializers.plot(graph)
62

erivlis / graphinate

Push — main ( 2ba9b1...8014f2 )

polygonal_graph.polygonal_graph_model() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like