From b758131f3cca4047c31d74fe772168b59a56baf1 Mon Sep 17 00:00:00 2001 From: Viliam Luc Date: Wed, 6 Oct 2021 10:02:04 +0200 Subject: docstring: Docstring warnings fixed. Change-Id: I8679c819b7c6ecd9e680bdc6edeafd2124def0b5 Signed-off-by: Viliam Luc --- resources/libraries/python/Classify.py | 28 +++++++++++------------ resources/libraries/python/CpuUtils.py | 2 +- resources/libraries/python/IPUtil.py | 6 ++--- resources/libraries/python/IncrementUtil.py | 2 +- resources/libraries/python/LoadBalancerUtil.py | 6 ++--- resources/libraries/python/Tap.py | 2 +- resources/libraries/python/VhostUser.py | 2 +- resources/libraries/python/autogen/Regenerator.py | 2 +- resources/libraries/python/ssh.py | 6 ++--- 9 files changed, 28 insertions(+), 28 deletions(-) (limited to 'resources/libraries/python') diff --git a/resources/libraries/python/Classify.py b/resources/libraries/python/Classify.py index 9a73f29ba6..dd3c78f449 100644 --- a/resources/libraries/python/Classify.py +++ b/resources/libraries/python/Classify.py @@ -258,15 +258,15 @@ class Classify: :param advance: For add, advance value for session. (Default value = 0) :param action: 0: No action (by default) metadata is not used. 1: Classified IP packets will be looked up from the specified ipv4 - fib table (configured by metadata as VRF id). - Only valid for L3 input ACL node + fib table (configured by metadata as VRF id). + Only valid for L3 input ACL node 2: Classified IP packets will be looked up from the specified ipv6 - fib table (configured by metadata as VRF id). - Only valid for L3 input ACL node + fib table (configured by metadata as VRF id). + Only valid for L3 input ACL node 3: Classified packet will be steered to source routing policy of - given index (in metadata). - This is only valid for IPv6 packets redirected to a source - routing node. + given index (in metadata). + This is only valid for IPv6 packets redirected to a source + routing node. :param metadata: Valid only if action != 0. VRF id if action is 1 or 2. SR policy index if action is 3. (Default value = 0) :type node: dict @@ -453,15 +453,15 @@ class Classify: :param opaque_index: opaque_index of new session. (Default value = ~0) :param action: 0: No action (by default) metadata is not used. 1: Classified IP packets will be looked up from the specified ipv4 - fib table (configured by metadata as VRF id). - Only valid for L3 input ACL node + fib table (configured by metadata as VRF id). + Only valid for L3 input ACL node 2: Classified IP packets will be looked up from the specified ipv6 - fib table (configured by metadata as VRF id). - Only valid for L3 input ACL node + fib table (configured by metadata as VRF id). + Only valid for L3 input ACL node 3: Classified packet will be steered to source routing policy of - given index (in metadata). - This is only valid for IPv6 packets redirected to a source - routing node. + given index (in metadata). + This is only valid for IPv6 packets redirected to a source + routing node. :param metadata: Valid only if action != 0. VRF id if action is 1 or 2. SR policy index if action is 3. (Default value = 0) :type node: dict diff --git a/resources/libraries/python/CpuUtils.py b/resources/libraries/python/CpuUtils.py index b03e3e9bbc..5805ba7787 100644 --- a/resources/libraries/python/CpuUtils.py +++ b/resources/libraries/python/CpuUtils.py @@ -268,7 +268,7 @@ class CpuUtils: :returns: List of CPUs allocated to NF. :rtype: list :raises RuntimeError: If we require more cpus than available or if - placement is not possible due to wrong parameters. + placement is not possible due to wrong parameters. """ if not 1 <= nf_chain <= nf_chains: raise RuntimeError(u"ChainID is out of range!") diff --git a/resources/libraries/python/IPUtil.py b/resources/libraries/python/IPUtil.py index 0a573d72fb..57a738bb46 100644 --- a/resources/libraries/python/IPUtil.py +++ b/resources/libraries/python/IPUtil.py @@ -500,7 +500,7 @@ class IPUtil: :type ip_addr: str :type prefix_length: int :type namespace: str - :rtype boolean + :rtype: boolean :raises RuntimeError: Request fails. """ ip_addr_with_prefix = f"{ip_addr}/{prefix_length}" @@ -652,7 +652,7 @@ class IPUtil: vrf: VRF table ID. (int) count: number of IP addresses to add starting from network IP (int) local: The route is local with same prefix (increment is 1). - If None, then is not used. (bool) + If None, then is not used. (bool) lookup_vrf: VRF table ID for lookup. (int) weight: Weight value for unequal cost multipath routing. (int) (Multipath value enters at higher level.) @@ -724,7 +724,7 @@ class IPUtil: vrf: VRF table ID. (int) count: number of IP addresses to add starting from network IP (int) local: The route is local with same prefix (increment is 1 network) - If None, then is not used. (bool) + If None, then is not used. (bool) lookup_vrf: VRF table ID for lookup. (int) multipath: Enable multipath routing. (bool) Default: True. weight: Weight value for unequal cost multipath routing. (int) diff --git a/resources/libraries/python/IncrementUtil.py b/resources/libraries/python/IncrementUtil.py index fca0839ac0..544e5708f0 100644 --- a/resources/libraries/python/IncrementUtil.py +++ b/resources/libraries/python/IncrementUtil.py @@ -22,7 +22,7 @@ class ObjIncrement(object): Subclasses should override: _incr: when a simple '+' binary operation isn't sufficient. _str_fmt: when a simple str representation of the incremented object - isn't the proper format. + isn't the proper format. """ def __init__(self, initial_value, increment): """ diff --git a/resources/libraries/python/LoadBalancerUtil.py b/resources/libraries/python/LoadBalancerUtil.py index 986d5b598d..6810122257 100644 --- a/resources/libraries/python/LoadBalancerUtil.py +++ b/resources/libraries/python/LoadBalancerUtil.py @@ -84,13 +84,13 @@ class LoadBalancerUtil: protocol: tcp or udp. (int) port: destination port. (int) encap: encap is ip4 GRE(0) or ip6 (1GRE) or L3DSR(2) or NAT4(3) or - NAT6(4). (int) + NAT6(4). (int) dscp: dscp bit corresponding to VIP type: service type target_port: Pod's port corresponding to specific service node_port: Node's port new_len: Size of the new connections flow table used - for this VIP + for this VIP is_del: 1 if the VIP should be removed otherwise 0. :type node: dict @@ -150,7 +150,7 @@ class LoadBalancerUtil: as_addr: The application server address. (str) is_del: 1 if the VIP should be removed otherwise 0. (int) is_flush: 1 if the sessions related to this AS should be flushed - otherwise 0. (int) + otherwise 0. (int) :type node: dict :type kwargs: dict diff --git a/resources/libraries/python/Tap.py b/resources/libraries/python/Tap.py index c729d602b1..7a987fc34b 100644 --- a/resources/libraries/python/Tap.py +++ b/resources/libraries/python/Tap.py @@ -210,7 +210,7 @@ class TapFeatureMask: @staticmethod def is_feature_enabled(tap_feature_mask, tap_feature_flag): """Checks if concrete tap feature is enabled within - tap_feature_mask + tap_feature_mask :param tap_feature_mask: Mask of enabled tap features :param tap_feature_flag: Checked tap feature :type tap_feature_mask: int diff --git a/resources/libraries/python/VhostUser.py b/resources/libraries/python/VhostUser.py index e868938cd1..b36edbf95a 100644 --- a/resources/libraries/python/VhostUser.py +++ b/resources/libraries/python/VhostUser.py @@ -203,7 +203,7 @@ class VirtioFeatureMask: @staticmethod def is_feature_enabled(virtio_feature_mask, virtio_feature_flag): """Checks if concrete virtio feature is enabled within - virtio_feature_mask + virtio_feature_mask :param virtio_feature_mask: Mask of enabled virtio features :param virtio_feature_flag: Checked virtio feature :type virtio_feature_mask: int diff --git a/resources/libraries/python/autogen/Regenerator.py b/resources/libraries/python/autogen/Regenerator.py index 0554f24d79..bb2e5b5fbc 100644 --- a/resources/libraries/python/autogen/Regenerator.py +++ b/resources/libraries/python/autogen/Regenerator.py @@ -654,7 +654,7 @@ class Regenerator: Log-like prints are emitted to sys.stderr. - :param pattern: Glob pattern to select files. Example: *-ndrpdr.robot + :param pattern: Glob pattern to select files. Example: \*-ndrpdr.robot :param protocol: String determining minimal frame size. Default: "ip4" :type pattern: str :type protocol: str diff --git a/resources/libraries/python/ssh.py b/resources/libraries/python/ssh.py index 6f6fc557f4..fad00482ed 100644 --- a/resources/libraries/python/ssh.py +++ b/resources/libraries/python/ssh.py @@ -322,7 +322,7 @@ class SSH: :param chan: SSH channel with opened terminal. :param cmd: Command to be executed. :param prompt: Command prompt, sequence of characters used to - indicate readiness to accept commands. + indicate readiness to accept commands. :returns: Command output. .. warning:: Interruptingcow is used here, and it uses @@ -370,9 +370,9 @@ class SSH: connect() method has to be called first! :param local_path: Path to local file that should be uploaded; or - path where to save remote file. + path where to save remote file. :param remote_path: Remote path where to place uploaded file; or - path to remote file which should be downloaded. + path to remote file which should be downloaded. :param get: scp operation to perform. Default is put. :param timeout: Timeout value in seconds. :param wildcard: If path has wildcard characters. Default is false. -- cgit 1.2.3-korg