Python3: resources and libraries

[csit.git] / resources / libraries / python / TrafficScriptArg.py

diff --git a/resources/libraries/python/TrafficScriptArg.py b/resources/libraries/python/TrafficScriptArg.py
index ab76f29..247eccb 100644 (file)
--- a/resources/libraries/python/TrafficScriptArg.py
+++ b/resources/libraries/python/TrafficScriptArg.py
@@ -1,4 +1,4 @@
-# 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:
@@ -16,15 +16,18 @@
 import argparse
 
 
-class TrafficScriptArg(object):
+class TrafficScriptArg:
     """Traffic scripts argument parser.
 
     Parse arguments for traffic script. Default has two arguments '--tx_if'
     and '--rx_if'. You can provide more arguments. All arguments have string
-    representation of the value.
+    representation of the value. You can add also optional arguments. Default
+    value for optional arguments is empty string.
 
-    :param more_args: List of aditional arguments (optional).
+    :param more_args: List of additional arguments (optional).
+    :param opt_args: List of optional arguments (optional).
     :type more_args: list
+    :type opt_args: list
 
     :Example:
 
@@ -32,16 +35,21 @@ class TrafficScriptArg(object):
     >>> args = TrafficScriptArg(['src_mac', 'dst_mac', 'src_ip', 'dst_ip'])
     """
 
-    def __init__(self, more_args=None):
+    def __init__(self, more_args=None, opt_args=None):
         parser = argparse.ArgumentParser()
-        parser.add_argument("--tx_if", help="interface that sends traffic")
-        parser.add_argument("--rx_if", help="interface that receives traffic")
+        parser.add_argument(u"--tx_if", help=u"interface that sends traffic")
+        parser.add_argument(u"--rx_if", help=u"interface that receives traffic")
 
         if more_args is not None:
             for arg in more_args:
-                arg_name = '--{0}'.format(arg)
+                arg_name = f"--{arg}"
                 parser.add_argument(arg_name)
 
+        if opt_args is not None:
+            for arg in opt_args:
+                arg_name = f"--{arg}"
+                parser.add_argument(arg_name, nargs=u"?", default=u"")
+
         self._parser = parser
         self._args = vars(parser.parse_args())
 
@@ -50,11 +58,11 @@ class TrafficScriptArg(object):
 
         :param arg_name: Argument name.
         :type arg_name: str
-        :return: Argument value.
+        :returns: Argument value.
         :rtype: str
         """
         arg_val = self._args.get(arg_name)
         if arg_val is None:
-            raise Exception("Argument '{0}' not found".format(arg_name))
+            raise Exception(f"Argument '{arg_name}' not found")
 
         return arg_val