-# Copyright (c) 2016 Cisco and/or its affiliates.
+# Copyright (c) 2019 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
from resources.libraries.python.topology import Topology
-class NodePath(object):
+class NodePath:
"""Path utilities for nodes in the topology.
:Example:
def compute_path(self, always_same_link=True):
"""Compute path for added nodes.
+ .. note:: First add at least two nodes to the topology.
+
:param always_same_link: If True use always same link between two nodes
- in path. If False use different link (if available) between two
- nodes if one link was used before.
+ in path. If False use different link (if available)
+ between two nodes if one link was used before.
:type always_same_link: bool
-
- .. note:: First add at least two nodes to the topology.
+ :raises RuntimeError: If not enough nodes for path.
"""
nodes = self._nodes
- nodes_filer = self._nodes_filter
if len(nodes) < 2:
- raise RuntimeError('Not enough nodes to compute path')
+ raise RuntimeError(u"Not enough nodes to compute path")
for idx in range(0, len(nodes) - 1):
topo = Topology()
node2 = nodes[idx + 1]
n1_list = self._nodes_filter[idx]
n2_list = self._nodes_filter[idx + 1]
- links = topo.get_active_connecting_links(node1, node2,
- filter_list_node1=n1_list,
- filter_list_node2=n2_list)
+ links = topo.get_active_connecting_links(
+ node1, node2, filter_list_node1=n1_list,
+ filter_list_node2=n2_list
+ )
if not links:
- raise RuntimeError('No link between {0} and {1}'.format(
- node1['host'], node2['host']))
+ raise RuntimeError(
+ f"No link between {node1[u'host']} and {node2[u'host']}"
+ )
if always_same_link:
l_set = set(links).intersection(self._links)
l_set = set(links).difference(self._links)
if not l_set:
raise RuntimeError(
- 'No free link between {0} and {1}, all links already '
- 'used'.format(node1['host'], node2['host']))
+ f"No free link between {node1[u'host']} and "
+ f"{node2[u'host']}, all links already used"
+ )
if not l_set:
link = links.pop()
def next_interface(self):
"""Path interface iterator.
- :return: Interface and node or None if not next interface.
+ :returns: Interface and node or None if not next interface.
:rtype: tuple (str, dict)
.. note:: Call compute_path before.
"""
if not self._path_iter:
return None, None
- else:
- return self._path_iter.pop()
+ return self._path_iter.pop()
def first_interface(self):
"""Return first interface on the path.
- :return: Interface and node.
+ :returns: Interface and node.
:rtype: tuple (str, dict)
.. note:: Call compute_path before.
"""
if not self._path:
- raise RuntimeError('No path for topology')
+ raise RuntimeError(u"No path for topology")
return self._path[0]
def last_interface(self):
"""Return last interface on the path.
- :return: Interface and node.
+ :returns: Interface and node.
:rtype: tuple (str, dict)
.. note:: Call compute_path before.
"""
if not self._path:
- raise RuntimeError('No path for topology')
+ raise RuntimeError(u"No path for topology")
return self._path[-1]
def first_ingress_interface(self):
"""Return first ingress interface on the path.
- :return: Interface and node.
+ :returns: Interface and node.
:rtype: tuple (str, dict)
.. note:: Call compute_path before.
"""
if not self._path:
- raise RuntimeError('No path for topology')
+ raise RuntimeError(u"No path for topology")
return self._path[1]
def last_egress_interface(self):
"""Return last egress interface on the path.
- :return: Interface and node.
+ :returns: Interface and node.
:rtype: tuple (str, dict)
.. note:: Call compute_path before.
"""
if not self._path:
- raise RuntimeError('No path for topology')
+ raise RuntimeError(u"No path for topology")
return self._path[-2]