Convert to Python 3 (sonic-net#1128)

Conform syntax to support Python 3 using 2to3 tool and manual assessment

Author: jleveque

README.md

@@ -24,13 +24,12 @@ Currently, this list of dependencies is as follows:
 
 - libyang_1.0.73_amd64.deb
 - libyang-cpp_1.0.73_amd64.deb
-- python2-yang_1.0.73_amd64.deb
 - python3-yang_1.0.73_amd64.deb
-- redis_dump_load-1.1-py2-none-any.whl
-- swsssdk-2.0.1-py2-none-any.whl
-- sonic_py_common-1.0-py2-none-any.whl
-- sonic_config_engine-1.0-py2-none-any.whl
-- sonic_yang_mgmt-1.0-py2-none-any.whl
+- redis_dump_load-1.1-py3-none-any.whl
+- swsssdk-2.0.1-py3-none-any.whl
+- sonic_py_common-1.0-py3-none-any.whl
+- sonic_config_engine-1.0-py3-none-any.whl
+- sonic_yang_mgmt-1.0-py3-none-any.whl
 - sonic_yang_models-1.0-py3-none-any.whl
 
 
@@ -43,7 +42,7 @@ A convenient alternative is to let the SONiC build system configure a build envi
 
 2. Build the sonic-utilities Python wheel package inside the Buster slave container, and tell the build system to keep the container alive when finished
     ```
-    make NOJESSIE=1 NOSTRETCH=1 KEEP_SLAVE_ON=yes target/python-wheels/sonic_utilities-1.2-py2-none-any.whl
+    make NOJESSIE=1 NOSTRETCH=1 KEEP_SLAVE_ON=yes target/python-wheels/sonic_utilities-1.2-py3-none-any.whl
     ```
 
 3. When the build finishes, your prompt will change to indicate you are inside the slave container. Change into the `src/sonic-utilities/` directory
@@ -56,13 +55,13 @@ A convenient alternative is to let the SONiC build system configure a build envi
 #### To build
 
 ```
-python2 setup.py bdist_wheel
+python3 setup.py bdist_wheel
 ```
 
 #### To run unit tests
 
 ```
-python2 setup.py test
+python3 setup.py test
 ```
 
 

acl_loader/main.py

@@ -1,7 +1,7 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
 import click
-import ipaddr
+import ipaddress
 import json
 import syslog
 
@@ -30,7 +30,7 @@ def error(msg):
 
 
 def deep_update(dst, src):
-    for key, value in src.iteritems():
+    for key, value in src.items():
         if isinstance(value, dict):
             node = dst.setdefault(key, {})
             deep_update(node, value)
@@ -182,7 +182,7 @@ def read_policers_info(self):
         # For multi-npu platforms we will read from any one of front asic namespace 
         # config db as the information should be same across all config db
         if self.per_npu_configdb:
-            namespace_configdb = (self.per_npu_configdb.values())[0]
+            namespace_configdb = (list(self.per_npu_configdb.values()))[0]
             self.policers_db_info = namespace_configdb.get_table(self.POLICER)
         else:
             self.policers_db_info = self.configdb.get_table(self.POLICER)
@@ -199,19 +199,19 @@ def read_sessions_info(self):
         # For multi-npu platforms we will read from any one of front asic namespace 
         # config db as the information should be same across all config db
         if self.per_npu_configdb:
-            namespace_configdb = (self.per_npu_configdb.values())[0]
+            namespace_configdb = (list(self.per_npu_configdb.values()))[0]
             self.sessions_db_info = namespace_configdb.get_table(self.CFG_MIRROR_SESSION_TABLE)
         else:
             self.sessions_db_info = self.configdb.get_table(self.CFG_MIRROR_SESSION_TABLE)
-        for key in self.sessions_db_info.keys():
+        for key in list(self.sessions_db_info.keys()):
             if self.per_npu_statedb:
                 # For multi-npu platforms we will read from all front asic name space 
                 # statedb as the monitor port will be differnt for each asic 
                 # and it's status also might be different (ideally should not happen)
                 # We will store them as dict of 'asic' : value
                 self.sessions_db_info[key]["status"] = {}
                 self.sessions_db_info[key]["monitor_port"] = {}
-                for namespace_key, namespace_statedb in self.per_npu_statedb.iteritems():
+                for namespace_key, namespace_statedb in self.per_npu_statedb.items():
                     state_db_info = namespace_statedb.get_all(self.statedb.STATE_DB, "{}|{}".format(self.STATE_MIRROR_SESSION_TABLE, key))
                     self.sessions_db_info[key]["status"][namespace_key] = state_db_info.get("status", "inactive") if state_db_info else "error"
                     self.sessions_db_info[key]["monitor_port"][namespace_key] = state_db_info.get("monitor_port", "") if state_db_info else ""
@@ -367,7 +367,7 @@ def validate_actions(self, table_name, action_props):
             # For multi-npu we will read using anyone statedb connector for front asic namespace. 
             # Same information should be there in all state DB's 
             # as it is static information about switch capability
-            namespace_statedb = (self.per_npu_statedb.values())[0]
+            namespace_statedb = (list(self.per_npu_statedb.values()))[0]
             capability = namespace_statedb.get_all(self.statedb.STATE_DB, "{}|switch".format(self.SWITCH_CAPABILITY_TABLE))
         else: 
             capability = self.statedb.get_all(self.statedb.STATE_DB, "{}|switch".format(self.SWITCH_CAPABILITY_TABLE))
@@ -417,7 +417,7 @@ def convert_ip(self, table_name, rule_idx, rule):
         # FIXME: 0 is a valid protocol number, but openconfig seems to use it as a default value,
         # so there isn't currently a good way to check if the user defined proto=0 or not.
         if rule.ip.config.protocol:
-            if self.ip_protocol_map.has_key(rule.ip.config.protocol):
+            if rule.ip.config.protocol in self.ip_protocol_map:
                 rule_props["IP_PROTOCOL"] = self.ip_protocol_map[rule.ip.config.protocol]
             else:
                 try:
@@ -430,14 +430,14 @@ def convert_ip(self, table_name, rule_idx, rule):
 
         if rule.ip.config.source_ip_address:
             source_ip_address = rule.ip.config.source_ip_address.encode("ascii")
-            if ipaddr.IPNetwork(source_ip_address).version == 4:
+            if ipaddress.ip_network(source_ip_address).version == 4:
                 rule_props["SRC_IP"] = source_ip_address
             else:
                 rule_props["SRC_IPV6"] = source_ip_address
 
         if rule.ip.config.destination_ip_address:
             destination_ip_address = rule.ip.config.destination_ip_address.encode("ascii")
-            if ipaddr.IPNetwork(destination_ip_address).version == 4:
+            if ipaddress.ip_network(destination_ip_address).version == 4:
                 rule_props["DST_IP"] = destination_ip_address
             else:
                 rule_props["DST_IPV6"] = destination_ip_address
@@ -579,17 +579,17 @@ def full_update(self):
         be removed and new rules in that table will be installed.
         :return:
         """
-        for key in self.rules_db_info.keys():
+        for key in list(self.rules_db_info.keys()):
             if self.current_table is None or self.current_table == key[0]:
                 self.configdb.mod_entry(self.ACL_RULE, key, None)
                 # Program for per front asic namespace also if present
-                for namespace_configdb in self.per_npu_configdb.values():
+                for namespace_configdb in list(self.per_npu_configdb.values()):
                     namespace_configdb.mod_entry(self.ACL_RULE, key, None)
 
 
         self.configdb.mod_config({self.ACL_RULE: self.rules_info})
         # Program for per front asic namespace also if present
-        for namespace_configdb in self.per_npu_configdb.values():
+        for namespace_configdb in list(self.per_npu_configdb.values()):
             namespace_configdb.mod_config({self.ACL_RULE: self.rules_info})
 
     def incremental_update(self):
@@ -605,10 +605,10 @@ def incremental_update(self):
         # update on dataplane ACLs, and only perform an incremental update on
         # control plane ACLs.
 
-        new_rules = set(self.rules_info.iterkeys())
+        new_rules = set(self.rules_info.keys())
         new_dataplane_rules = set()
         new_controlplane_rules = set()
-        current_rules = set(self.rules_db_info.iterkeys())
+        current_rules = set(self.rules_db_info.keys())
         current_dataplane_rules = set()
         current_controlplane_rules = set()
 
@@ -630,15 +630,15 @@ def incremental_update(self):
         for key in current_dataplane_rules:
             self.configdb.mod_entry(self.ACL_RULE, key, None)
             # Program for per-asic namespace also if present
-            for namespace_configdb in self.per_npu_configdb.values():
+            for namespace_configdb in list(self.per_npu_configdb.values()):
                 namespace_configdb.mod_entry(self.ACL_RULE, key, None)
 
 
         # Add all new dataplane rules
         for key in new_dataplane_rules:
             self.configdb.mod_entry(self.ACL_RULE, key, self.rules_info[key])
             # Program for per-asic namespace corresponding to front asic also if present. 
-            for namespace_configdb in self.per_npu_configdb.values():
+            for namespace_configdb in list(self.per_npu_configdb.values()):
                 namespace_configdb.mod_entry(self.ACL_RULE, key, self.rules_info[key])
 
         added_controlplane_rules = new_controlplane_rules.difference(current_controlplane_rules)
@@ -649,22 +649,22 @@ def incremental_update(self):
             self.configdb.mod_entry(self.ACL_RULE, key, self.rules_info[key])
             # Program for per-asic namespace corresponding to front asic also if present. 
             # For control plane ACL it's not needed but to keep all db in sync program everywhere
-            for namespace_configdb in self.per_npu_configdb.values():
+            for namespace_configdb in list(self.per_npu_configdb.values()):
                 namespace_configdb.mod_entry(self.ACL_RULE, key, self.rules_info[key])
 
         for key in removed_controlplane_rules:
             self.configdb.mod_entry(self.ACL_RULE, key, None)
             # Program for per-asic namespace corresponding to front asic also if present. 
             # For control plane ACL it's not needed but to keep all db in sync program everywhere
-            for namespace_configdb in self.per_npu_configdb.values():
+            for namespace_configdb in list(self.per_npu_configdb.values()):
                 namespace_configdb.mod_entry(self.ACL_RULE, key, None)
 
         for key in existing_controlplane_rules:
             if cmp(self.rules_info[key], self.rules_db_info[key]) != 0:
                 self.configdb.set_entry(self.ACL_RULE, key, self.rules_info[key])
                 # Program for per-asic namespace corresponding to front asic also if present. 
                 # For control plane ACL it's not needed but to keep all db in sync program everywhere
-                for namespace_configdb in self.per_npu_configdb.values():
+                for namespace_configdb in list(self.per_npu_configdb.values()):
                     namespace_configdb.set_entry(self.ACL_RULE, key, self.rules_info[key])
 
     def delete(self, table=None, rule=None):
@@ -673,12 +673,12 @@ def delete(self, table=None, rule=None):
         :param rule:
         :return:
         """
-        for key in self.rules_db_info.iterkeys():
+        for key in self.rules_db_info.keys():
             if not table or table == key[0]:
                 if not rule or rule == key[1]:
                     self.configdb.set_entry(self.ACL_RULE, key, None)
                     # Program for per-asic namespace corresponding to front asic also if present. 
-                    for namespace_configdb in self.per_npu_configdb.values():
+                    for namespace_configdb in list(self.per_npu_configdb.values()):
                         namespace_configdb.set_entry(self.ACL_RULE, key, None)
 
     def show_table(self, table_name):
@@ -690,7 +690,7 @@ def show_table(self, table_name):
         header = ("Name", "Type", "Binding", "Description", "Stage")
 
         data = []
-        for key, val in self.get_tables_db_info().iteritems():
+        for key, val in self.get_tables_db_info().items():
             if table_name and key != table_name:
                 continue
 
@@ -728,7 +728,7 @@ def show_session(self, session_name):
 
         erspan_data = []
         span_data = []
-        for key, val in self.get_sessions_db_info().iteritems():
+        for key, val in self.get_sessions_db_info().items():
             if session_name and key != session_name:
                 continue
 
@@ -756,7 +756,7 @@ def show_policer(self, policer_name):
         header = ("Name", "Type", "Mode", "CIR", "CBS")
 
         data = []
-        for key, val in self.get_policers_db_info().iteritems():
+        for key, val in self.get_policers_db_info().items():
             if policer_name and key != policer_name:
                 continue
 
@@ -807,7 +807,7 @@ def pop_matches(val):
             return matches
 
         raw_data = []
-        for (tname, rid), val in self.get_rules_db_info().iteritems():
+        for (tname, rid), val in self.get_rules_db_info().items():
 
             if table_name and table_name != tname:
                 continue

clear/main.py

@@ -1,13 +1,8 @@
-import click
+import configparser
 import os
 import subprocess
 
-try:
-    # noinspection PyPep8Naming
-    import ConfigParser as configparser
-except ImportError:
-    # noinspection PyUnresolvedReferences
-    import configparser
+import click
 
 
 # This is from the aliases example:
@@ -82,6 +77,7 @@ def get_routing_stack():
         proc = subprocess.Popen(command,
                                 stdout=subprocess.PIPE,
                                 shell=True,
+                                text=True,
                                 stderr=subprocess.STDOUT)
         stdout = proc.communicate()[0]
         proc.wait()
@@ -99,7 +95,7 @@ def get_routing_stack():
 
 def run_command(command, pager=False, return_output=False):
     # Provide option for caller function to Process the output.
-    proc = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE)
+    proc = subprocess.Popen(command, shell=True, text=True, stdout=subprocess.PIPE)
     if return_output:
         return proc.communicate()
     elif pager:

config/aaa.py

@@ -1,8 +1,4 @@
-#!/usr/bin/env python -u
-# -*- coding: utf-8 -*-
-
 import click
-
 from swsssdk import ConfigDBConnector
 import utilities_common.cli as clicommon
 
@@ -193,8 +189,3 @@ def delete(address):
     config_db.connect()
     config_db.set_entry('TACPLUS_SERVER', address, None)
 tacacs.add_command(delete)
-
-
-if __name__ == "__main__":
-    aaa()
-

config/config_mgmt.py

@@ -77,7 +77,7 @@ def __init__(self, source="configDB", debug=False, allowTablesWithoutYang=True):
 
         except Exception as e:
             self.sysLog(doPrint=True, logLevel=syslog.LOG_ERR, msg=str(e))
-            raise(Exception('ConfigMgmt Class creation failed'))
+            raise Exception('ConfigMgmt Class creation failed')
 
         return
 
@@ -168,7 +168,7 @@ def readConfigDBJson(self, source=CONFIG_DB_JSON_FILE):
         self.configdbJsonIn = readJsonFile(source)
         #self.sysLog(msg=type(self.configdbJsonIn))
         if not self.configdbJsonIn:
-            raise(Exception("Can not load config from config DB json file"))
+            raise Exception("Can not load config from config DB json file")
         self.sysLog(msg='Reading Input {}'.format(self.configdbJsonIn))
 
         return
@@ -247,7 +247,7 @@ def __init__(self, source="configDB", debug=False, allowTablesWithoutYang=True):
 
         except Exception as e:
             self.sysLog(doPrint=True, logLevel=syslog.LOG_ERR, msg=str(e))
-            raise(Exception('ConfigMgmtDPB Class creation failed'))
+            raise Exception('ConfigMgmtDPB Class creation failed')
 
         return
 
@@ -331,8 +331,7 @@ def _verifyAsicDB(self, db, ports, portMap, timeout):
             if waitTime + 1 == timeout:
                 self.sysLog(syslog.LOG_CRIT, "!!!  Critical Failure, Ports \
                     are not Deleted from ASIC DB, Bail Out  !!!", doPrint=True)
-                raise(Exception("Ports are present in ASIC DB after {} secs".\
-                    format(timeout)))
+                raise Exception("Ports are present in ASIC DB after {} secs".format(timeout))
 
         except Exception as e:
             self.sysLog(doPrint=True, logLevel=syslog.LOG_ERR, msg=str(e))
@@ -470,7 +469,7 @@ def _addPorts(self, portJson=dict(), loadDefConfig=True):
             (configToLoad, ret) (tuple)[dict, bool]
         '''
         configToLoad = None
-        ports = portJson['PORT'].keys()
+        ports = list(portJson['PORT'].keys())
         try:
             self.sysLog(doPrint=True, msg='Start Port Addition')
             self.sysLog(msg="addPorts Args portjson: {} loadDefConfig: {}".\
@@ -546,7 +545,7 @@ def _mergeItems(it1, it2):
                     pass
                 return
 
-            for it in D1.keys():
+            for it in list(D1.keys()):
                 # D2 has the key
                 if D2.get(it):
                     _mergeItems(D1[it], D2[it])
@@ -578,7 +577,7 @@ def _searchKeysInConfig(self, In, Out, skeys):
         '''
         found = False
         if isinstance(In, dict):
-            for key in In.keys():
+            for key in list(In.keys()):
                 for skey in skeys:
                     # pattern is very specific to current primary keys in
                     # config DB, may need to be updated later.

config/console.py

@@ -1,7 +1,4 @@
-#!/usr/bin/env python
-
 import click
-
 import utilities_common.cli as clicommon
 
 #

config/feature.py

@@ -1,6 +1,6 @@
-import click
 import sys
 
+import click
 from utilities_common.cli import AbbreviationGroup, pass_db
 
 #
@@ -42,7 +42,7 @@ def feature_autorestart(db, name, autorestart):
         click.echo("Unable to retrieve feature table from Config DB.")
         sys.exit(1)
 
-    if not feature_table.has_key(name):
+    if name not in feature_table:
         click.echo("Unable to retrieve feature '{}'".format(name))
         sys.exit(1)