aboutsummaryrefslogtreecommitdiffstats
path: root/resources/libraries/python/Classify.py
diff options
context:
space:
mode:
authorVratko Polak <vrpolak@cisco.com>2018-04-13 19:45:33 +0200
committerPeter Mikus <pmikus@cisco.com>2018-04-25 08:47:31 +0000
commit4c6fe5602edcbd9857a846e5b13a21d5c671a2c8 (patch)
treeb360a3e65094f9fe542451a747132ff24663b115 /resources/libraries/python/Classify.py
parent59e06f5e3143bf093bdb6b53c0186b050668e3d4 (diff)
Fix warnings reported by gen_doc.sh
+ Docstring warnings fixed. + Multiline param descriptions indented by 4 spaces. - Except the PacketVerifier.py one - I have tried several quote-like blocks, nothing works. - Rst warnings not fixed. - How can I fix them? They refer to temporarily created files. + Other improvements: + Python lines no longer than 80 characters. + :return: -> :returns: + Notes before params. + :raises + closing colon after exception class. + Description is a sentence. + Present tense in conditional sentences. + Bumped copyright year in edited files. Change-Id: I462c194eeecb666dc146e26858486a07c990be9b Signed-off-by: Vratko Polak <vrpolak@cisco.com>
Diffstat (limited to 'resources/libraries/python/Classify.py')
-rw-r--r--resources/libraries/python/Classify.py36
1 files changed, 18 insertions, 18 deletions
diff --git a/resources/libraries/python/Classify.py b/resources/libraries/python/Classify.py
index a66994906b..2510da0b77 100644
--- a/resources/libraries/python/Classify.py
+++ b/resources/libraries/python/Classify.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2017 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:
@@ -32,10 +32,10 @@ class Classify(object):
:type node: dict
:type ip_version: str
:type direction: str
- :returns (table_index, skip_n, match_n)
- table_index: Classify table index.
- skip_n: Number of skip vectors.
- match_n: Number of match vectors.
+ :returns: (table_index, skip_n, match_n)
+ table_index: Classify table index.
+ skip_n: Number of skip vectors.
+ match_n: Number of match vectors.
:rtype: tuple(int, int, int)
:raises RuntimeError: If VPP can't create table.
"""
@@ -64,10 +64,10 @@ class Classify(object):
:param direction: Direction of traffic - src/dst.
:type node: dict
:type direction: str
- :returns (table_index, skip_n, match_n)
- table_index: Classify table index.
- skip_n: Number of skip vectors.
- match_n: Number of match vectors.
+ :returns: (table_index, skip_n, match_n)
+ table_index: Classify table index.
+ skip_n: Number of skip vectors.
+ match_n: Number of match vectors.
:rtype: tuple(int, int, int)
:raises RuntimeError: If VPP can't create table.
"""
@@ -95,10 +95,10 @@ class Classify(object):
:param hex_mask: Classify hex mask.
:type node: dict
:type hex_mask: str
- :returns (table_index, skip_n, match_n)
- table_index: Classify table index.
- skip_n: Number of skip vectors.
- match_n: Number of match vectors.
+ :returns: (table_index, skip_n, match_n)
+ table_index: Classify table index.
+ skip_n: Number of skip vectors.
+ match_n: Number of match vectors.
:rtype: tuple(int, int, int)
:raises RuntimeError: If VPP can't create table.
"""
@@ -216,14 +216,14 @@ class Classify(object):
:param node: VPP node to setup classify session.
:param session_type: Session type - hit-next, l2-hit-next, acl-hit-next
- or policer-hit-next, and their respective parameters.
+ or policer-hit-next, and their respective parameters.
:param table_index: Classify table index.
:param skip_n: Number of skip vectors based on mask.
:param match_n: Number of match vectors based on mask.
:param match: Match value - l2, l3, l4 or hex, and their
- respective parameters.
+ respective parameters.
:param match2: Additional match values, to avoid using overly long
- variables in RobotFramework.
+ variables in RobotFramework.
:type node: dict
:type session_type: str
:type table_index: int
@@ -256,7 +256,7 @@ class Classify(object):
:type protocol: str
:type direction: str
:returns: Classify hex mask.
- :rtype : str
+ :rtype: str
:raises ValueError: If protocol is not TCP or UDP.
:raises ValueError: If direction is not source or destination or
source + destination.
@@ -310,7 +310,7 @@ class Classify(object):
:param ip_version: Version of IP protocol.
:type ip_version: str
- :return: Base hex mask.
+ :returns: Base hex mask.
:rtype: str
"""
if ip_version == 'ip4':