Fix warnings reported by gen_doc.sh
[csit.git] / resources / libraries / python / Map.py
index a1db3a8..ec1d22c 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (c) 2016 Cisco and/or its affiliates.
+# Copyright (c) 2018 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:
@@ -35,7 +35,7 @@ class Map(object):
         :param psid_offset: Port Set Identifier (PSID) offset.
         :param psid_len: Port Set Identifier (PSID) length.
         :param map_t: Mapping using translation instead of encapsulation.
-        Default False.
+            Default False.
         :type vpp_node: dict
         :type ip4_pfx: str
         :type ip6_pfx: str
@@ -44,7 +44,7 @@ class Map(object):
         :type psid_offset: int
         :type psid_len: int
         :type map_t: bool
-        :return: Index of created map domain.
+        :returns: Index of created map domain.
         :rtype: int
         :raises RuntimeError: If unable to add map domain.
         """
@@ -108,7 +108,8 @@ class Map(object):
 
     @staticmethod
     def get_psid_from_port(port, psid_len, psid_offset):
-        """Return PSID from port.
+        """Return PSID from port.::
+
                               0                   1
                               0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
                              +-----------+-----------+-------+
@@ -124,8 +125,7 @@ class Map(object):
         :type port: int
         :type psid_len: int
         :type psid_offset: int
-
-        :return: PSID.
+        :returns: PSID.
         :rtype: int
         """
         ones = 2**16-1
@@ -149,11 +149,11 @@ class Map(object):
         :type ea_bit_len: int
         :type psid_len: int
         :type psid: int
-        :return: Number representing EA bit field of destination IPv6 address.
+        :returns: Number representing EA bit field of destination IPv6 address.
         :rtype: int
         """
-        v4_suffix_len = ipv4_net._max_prefixlen - ipv4_net.prefixlen
-        v4_suffix = ipv4_net.network_address._ip ^ ipv4_host._ip
+        v4_suffix_len = ipv4_net.max_prefixlen - ipv4_net.prefixlen
+        v4_suffix = int(ipv4_net.network_address) ^ int(ipv4_host)
 
         if ipv4_net.prefixlen + ea_bit_len <= 32:
             ea_bits = v4_suffix >> (v4_suffix_len - ea_bit_len)
@@ -181,27 +181,23 @@ class Map(object):
         :type dst_ip: ipaddress.IPv4Address
         :type ea_bit_len: int
         :type psid: int
-        :return: Number representing interface id field of destination IPv6
-        address.
+        :returns: Number representing interface id field of destination IPv6
+            address.
         :rtype: int
         """
         if rule_net.prefixlen + ea_bit_len < 32:
-            v4_suffix_len = rule_net._max_prefixlen - rule_net.prefixlen
-            v4_suffix = rule_net.network_address._ip ^ dst_ip._ip
+            v4_suffix_len = rule_net.max_prefixlen - rule_net.prefixlen
+            v4_suffix = int(rule_net.network_address) ^ int(dst_ip)
             ea_bits = v4_suffix >> (v4_suffix_len - ea_bit_len)
-            address = rule_net.network_address._ip >> v4_suffix_len
+            address = int(rule_net.network_address) >> v4_suffix_len
             address <<= ea_bit_len
             address |= ea_bits
             address <<= 32 - rule_net.prefixlen - ea_bit_len
             address <<= 16
-            # psid_field = 0
-            # address = address | psid_field
         elif rule_net.prefixlen + ea_bit_len == 32:
-            address = dst_ip._ip << 16
-            # psid_field = 0
-            # address = address | psid_field
+            address = int(dst_ip) << 16
         else:
-            address = dst_ip._ip << 16
+            address = int(dst_ip) << 16
             address |= psid
             return address
 
@@ -212,14 +208,13 @@ class Map(object):
                                              psid_offset, psid_len, ipv4_dst,
                                              dst_port):
         """Compute IPv6 destination address from IPv4 address for MAP algorithm.
-        (RFC 7597)
-
-       |     n bits         |  o bits   | s bits  |   128-n-o-s bits      |
-       +--------------------+-----------+---------+-----------------------+
-       |  Rule IPv6 prefix  |  EA bits  |subnet ID|     interface ID      |
-       +--------------------+-----------+---------+-----------------------+
-       |<---  End-user IPv6 prefix  --->|
+        (RFC 7597)::
 
+          |     n bits         |  o bits   | s bits  |   128-n-o-s bits      |
+          +--------------------+-----------+---------+-----------------------+
+          |  Rule IPv6 prefix  |  EA bits  |subnet ID|     interface ID      |
+          +--------------------+-----------+---------+-----------------------+
+          |<---  End-user IPv6 prefix  --->|
 
         :param ipv4_pfx: Domain IPv4 preffix.
         :param ipv6_pfx: Domain IPv6 preffix.
@@ -235,22 +230,20 @@ class Map(object):
         :type psid_len: int
         :type ipv4_dst: str
         :type dst_port: int
-        :return: Computed IPv6 address.
+        :returns: Computed IPv6 address.
         :rtype: str
         """
         ipv6_net = ipaddress.ip_network(unicode(ipv6_pfx))
         ipv4_net = ipaddress.ip_network(unicode(ipv4_pfx))
         ipv4_host = ipaddress.ip_address(unicode(ipv4_dst))
 
-        ipv6_host_len = ipv6_net._max_prefixlen - ipv6_net.prefixlen
-        ipv4_host_len = ipv4_net._max_prefixlen - ipv4_net.prefixlen
+        ipv6_host_len = ipv6_net.max_prefixlen - ipv6_net.prefixlen
         end_user_v6_pfx_len = ipv6_net.prefixlen + ea_bit_len
         psid = Map.get_psid_from_port(dst_port, psid_len, psid_offset)
 
-        rule_v6_pfx = ipv6_net.network_address._ip >> ipv6_host_len
+        rule_v6_pfx = int(ipv6_net.network_address) >> ipv6_host_len
         ea_bits = Map._make_ea_bits(ipv4_net, ipv4_host, ea_bit_len, psid_len,
                                     psid)
-        subnet_id = 0
         interface_id = Map._make_interface_id(ipv4_net, ipv4_host, ea_bit_len,
                                               psid)
 
@@ -276,13 +269,13 @@ class Map(object):
         :param ipv4_src: IPv4 source address
         :type ipv6_pfx: str
         :type ipv4_src: str
-        :return: IPv6 address, combination of IPv6 prefix and IPv4 address.
+        :returns: IPv6 address, combination of IPv6 prefix and IPv4 address.
         :rtype: str
         """
         ipv6_net = ipaddress.ip_network(unicode(ipv6_pfx))
         ipv4_host = ipaddress.ip_address(unicode(ipv4_src))
 
-        address = ipv6_net.network_address._ip
-        address |= ipv4_host._ip
+        address = int(ipv6_net.network_address)
+        address |= int(ipv4_host)
 
         return str(ipaddress.ip_address(address))