Bug fix on create_eqpt_sheet.py

program was not correctly listing nodes when links duplicate EDFA entries.
I refactored it to make it simpler to understand.

I added coordinates on ../tests/data/testTopology.xls for plot purpose

Signed-off-by: EstherLerouzic <esther.lerouzic@orange.com>

examples/create_eqpt_sheet.py

@@ -11,64 +11,72 @@ If not present in the "Nodes" sheet, the "Type" column will be implicitly
 determined based on the topology.
 """
 
-from sys import exit
 try:
     from xlrd import open_workbook
 except ModuleNotFoundError:
     exit('Required: `pip install xlrd`')
 from argparse import ArgumentParser
-from collections import namedtuple, defaultdict
 
+PARSER = ArgumentParser()
+PARSER.add_argument('workbook', nargs='?', default='meshTopologyExampleV2.xls',
+                    help='create the mandatory columns in Eqpt sheet')
+ALL_ROWS = lambda sh, start=0: (sh.row(x) for x in range(start, sh.nrows))
 
-Shortlink = namedtuple('Link', 'src dest')
+class Node:
+    """ Node element contains uid, list of connected nodes and eqpt type
+    """
+    def __init__(self, uid, to_node):
+        self.uid = uid
+        self.to_node = to_node
+        self.eqpt = None
 
-Shortnode = namedtuple('Node', 'nodename eqt')
+    def __repr__(self):
+        return f'uid {self.uid} \nto_node {[node for node in self.to_node]}\neqpt {self.eqpt}\n'
 
-parser = ArgumentParser()
-parser.add_argument('workbook', nargs='?', default='meshTopologyExampleV2.xls',
-    help = 'create the mandatory columns in Eqpt sheet  ')
-all_rows = lambda sh, start=0: (sh.row(x) for x in range(start, sh.nrows))
+    def __str__(self):
+        return f'uid {self.uid} \nto_node {[node for node in self.to_node]}\neqpt {self.eqpt}\n'
 
 def read_excel(input_filename):
-    with open_workbook(input_filename) as wb:
+    """ read excel Nodes and Links sheets and create a dict of nodes with
+    their to_nodes and type of eqpt
+    """
+    with open_workbook(input_filename) as wobo:
         # reading Links sheet
-        links_sheet = wb.sheet_by_name('Links')
-        links = []
-        nodeoccuranceinlinks = []
-        links_by_src = defaultdict(list)
-        links_by_dest = defaultdict(list)
-        for row in all_rows(links_sheet, start=5):
-            links.append(Shortlink(row[0].value,row[1].value))
-            links_by_src[row[0].value].append(Shortnode(row[1].value,''))
-            links_by_dest[row[1].value].append(Shortnode(row[0].value,''))
-            #print(f'source {links[len(links)-1].src} dest {links[len(links)-1].dest}')
-            nodeoccuranceinlinks.append(row[0].value)
-            nodeoccuranceinlinks.append(row[1].value)
+        links_sheet = wobo.sheet_by_name('Links')
+        nodes = {}
+        for row in ALL_ROWS(links_sheet, start=5):
+            try:
+                nodes[row[0].value].to_node.append(row[1].value)
+            except KeyError:
+                nodes[row[0].value] = Node(row[0].value, [row[1].value])
+            try:
+                nodes[row[1].value].to_node.append(row[0].value)
+            except KeyError:
+                nodes[row[1].value] = Node(row[1].value, [row[0].value])
 
-        # reading Nodes sheet
-        nodes_sheet = wb.sheet_by_name('Nodes')
-        nodes = []
-        node_degree = []
-        for row in all_rows(nodes_sheet, start=5) :
+        nodes_sheet = wobo.sheet_by_name('Nodes')
+        for row in ALL_ROWS(nodes_sheet, start=5):
+            node = row[0].value
+            eqpt = row[6].value
+            try:
+                if eqpt == 'ILA' and len(nodes[node].to_node) != 2:
+                    print(f'Inconsistancy ILA node with degree > 2: {node} ')
+                    exit()
+                if eqpt == '' and len(nodes[node].to_node) == 2:
+                    nodes[node].eqpt = 'ILA'
+                elif eqpt == '' and len(nodes[node].to_node) != 2:
+                    nodes[node].eqpt = 'ROADM'
+                else:
+                    nodes[node].eqpt = eqpt
+            except KeyError:
+                print(f'inconsistancy between nodes and links sheet: {node} is not listed in links')
+                exit()
+        return nodes
 
-            temp_eqt = row[6].value
-            # verify node degree to confirm eqt type
-            node_degree.append(nodeoccuranceinlinks.count(row[0].value))
-            if temp_eqt.lower() == 'ila' and nodeoccuranceinlinks.count(row[0].value) !=2 :
-                print(f'Inconsistancy: node {nodes[len(nodes)-1]} has degree \
-                    {node_degree[len(nodes)-1]} and can not be an ILA ... replaced by ROADM')
-                temp_eqt = 'ROADM'
-            if temp_eqt == '' and nodeoccuranceinlinks.count(row[0].value) == 2 :
-                temp_eqt = 'ILA'
-            if temp_eqt == '' and nodeoccuranceinlinks.count(row[0].value) != 2 :
-                temp_eqt = 'ROADM'
-            # print(f'node {nodes[len(nodes)-1]} eqt {temp_eqt}')
-            nodes.append(Shortnode(row[0].value,temp_eqt))
-            # print(len(nodes)-1)
-            print(f'reading: node {nodes[len(nodes)-1].nodename} eqpt {temp_eqt}')
-        return links,nodes, links_by_src , links_by_dest
-
-def create_eqt_template(links,nodes, links_by_src , links_by_dest, input_filename):
+def create_eqt_template(nodes, input_filename):
+    """ writes list of node A node Z corresponding to Nodes and Links sheets in order
+    to help user populating Eqpt
+    """
     output_filename = f'{input_filename[:-4]}_eqpt_sheet.txt'
     with open(output_filename, 'w', encoding='utf-8') as my_file:
         # print header similar to excel
@@ -77,27 +85,17 @@ def create_eqt_template(links,nodes, links_by_src , links_by_dest, input_filenam
            \nNode A \tNode Z \tamp type \tatt_in \tamp gain \ttilt \tatt_out\
            amp type   \tatt_in \tamp gain   \ttilt   \tatt_out\n')
 
-        tab = []
-        temp = []
-        i = 0
-        for lk in links:
-            if [e for n,e in nodes if n==lk.src][0] != 'FUSED' :
-                temp = [lk.src , lk.dest]
-                tab.append(temp)
-                my_file.write(f'{temp[0]}\t{temp[1]}\n')
-        for n in nodes :
-            if n.eqt.lower() == 'roadm' :
-                for src in  links_by_dest[n.nodename] :
-                    temp = [n.nodename , src.nodename]
-                    tab.append(temp)
-                    # print(temp)
-                    my_file.write(f'{temp[0]}\t{temp[1]}\n')
-            i = i + 1
+
+        for node in nodes.values():
+            if node.eqpt == 'ILA':
+                my_file.write(f'{node.uid}\t{node.to_node[0]}\n')
+            if node.eqpt == 'ROADM':
+                for to_node in node.to_node:
+                    my_file.write(f'{node.uid}\t{to_node}\n')
+
         print(f'File {output_filename} successfully created with Node A - Node Z ' +
-        ' entries for Eqpt sheet in excel file.')
+              ' entries for Eqpt sheet in excel file.')
 
 if __name__ == '__main__':
-    args = parser.parse_args()
-    input_filename = args.workbook
-    links,nodes,links_by_src, links_by_dest = read_excel(input_filename)
-    create_eqt_template(links,nodes, links_by_src , links_by_dest , input_filename)
+    ARGS = PARSER.parse_args()
+    create_eqt_template(read_excel(ARGS.workbook), ARGS.workbook)