Fix warnings reported by gen_doc.sh

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

diff --git a/resources/libraries/python/PacketVerifier.py b/resources/libraries/python/PacketVerifier.py
index 4500961..d1e7bbd 100644 (file)
--- a/resources/libraries/python/PacketVerifier.py
+++ b/resources/libraries/python/PacketVerifier.py
@@ -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:
@@ -13,59 +13,60 @@
 
 """PacketVerifier module.
 
-    :Example:
-
-    >>> from scapy.all import *
-    >>> from PacketVerifier import *
-    >>> rxq = RxQueue('eth1')
-    >>> txq = TxQueue('eth1')
-    >>> src_mac = "AA:BB:CC:DD:EE:FF"
-    >>> dst_mac = "52:54:00:ca:5d:0b"
-    >>> src_ip = "11.11.11.10"
-    >>> dst_ip = "11.11.11.11"
-    >>> sent_packets = []
-    >>> pkt_send = Ether(src=src_mac, dst=dst_mac) /
-    ... IP(src=src_ip, dst=dst_ip) /
-    ... ICMP()
-    >>> sent_packets.append(pkt_send)
-    >>> txq.send(pkt_send)
-    >>> pkt_send = Ether(src=src_mac, dst=dst_mac) /
-    ... ARP(hwsrc=src_mac, psrc=src_ip, hwdst=dst_mac, pdst=dst_ip, op=2)
-    >>> sent_packets.append(pkt_send)
-    >>> txq.send(pkt_send)
-    >>> rxq.recv(100, sent_packets).show()
-    ###[ Ethernet ]###
-      dst       = aa:bb:cc:dd:ee:ff
-      src       = 52:54:00:ca:5d:0b
-      type      = 0x800
-    ###[ IP ]###
-      version   = 4L
-      ihl       = 5L
-      tos       = 0x0
-      len       = 28
-      id        = 43183
-      flags     =
-      frag      = 0L
-      ttl       = 64
-      proto     = icmp
-      chksum    = 0xa607
-      src       = 11.11.11.11
-      dst       = 11.11.11.10
-      options
-    ###[ ICMP ]###
-      type      = echo-reply
-      code      = 0
-      chksum    = 0xffff
-      id        = 0x0
-      seq       = 0x0
-    ###[ Padding ]###
-      load = 'RT\x00\xca]\x0b\xaa\xbb\xcc\xdd\xee\xff\x08\x06\x00\x01\x08\x00'
+  Example. ::
+
+    | >>> from scapy.all import *
+    | >>> from PacketVerifier import *
+    | >>> rxq = RxQueue('eth1')
+    | >>> txq = TxQueue('eth1')
+    | >>> src_mac = "AA:BB:CC:DD:EE:FF"
+    | >>> dst_mac = "52:54:00:ca:5d:0b"
+    | >>> src_ip = "11.11.11.10"
+    | >>> dst_ip = "11.11.11.11"
+    | >>> sent_packets = []
+    | >>> pkt_send = Ether(src=src_mac, dst=dst_mac) /
+    | ... IP(src=src_ip, dst=dst_ip) /
+    | ... ICMP()
+    | >>> sent_packets.append(pkt_send)
+    | >>> txq.send(pkt_send)
+    | >>> pkt_send = Ether(src=src_mac, dst=dst_mac) /
+    | ... ARP(hwsrc=src_mac, psrc=src_ip, hwdst=dst_mac, pdst=dst_ip, op=2)
+    | >>> sent_packets.append(pkt_send)
+    | >>> txq.send(pkt_send)
+    | >>> rxq.recv(100, sent_packets).show()
+    | ###[ Ethernet ]###
+    |   dst       = aa:bb:cc:dd:ee:ff
+    |   src       = 52:54:00:ca:5d:0b
+    |   type      = 0x800
+    | ###[ IP ]###
+    |   version   = 4L
+    |   ihl       = 5L
+    |   tos       = 0x0
+    |   len       = 28
+    |   id        = 43183
+    |   flags     =
+    |   frag      = 0L
+    |   ttl       = 64
+    |   proto     = icmp
+    |   chksum    = 0xa607
+    |   src       = 11.11.11.11
+    |   dst       = 11.11.11.10
+    |   options
+    | ###[ ICMP ]###
+    |   type      = echo-reply
+    |   code      = 0
+    |   chksum    = 0xffff
+    |   id        = 0x0
+    |   seq       = 0x0
+    | ###[ Padding ]###
+    |   load = 'RT\x00\xca]\x0b\xaa\xbb\xcc\xdd\xee\xff\x08\x06\x00\x01\x08\x00'
+
+  Example end.
 """
 
 import os
 import select
 
-import interruptingcow
 from scapy.config import conf
 from scapy.all import ETH_P_IP, ETH_P_IPV6, ETH_P_ALL, ETH_P_ARP
 from scapy.layers.inet6 import IPv6
@@ -218,33 +219,29 @@ class RxQueue(PacketVerifier):
         :returns: Ether() initialized object from packet data.
         :rtype: scapy.Ether
         """
-        (rlist, _, _) = select.select([self._sock], [], [], timeout)
-        if self._sock not in rlist:
-            return None
-        try:
-            with interruptingcow.timeout(timeout,
-                                         exception=RuntimeError('Timeout')):
-                ignore_list = list()
-                if ignore is not None:
-                    for ig_pkt in ignore:
-                        # Auto pad all packets in ignore list
-                        ignore_list.append(auto_pad(ig_pkt))
-                while True:
-                    pkt = self._sock.recv(0x7fff)
-                    pkt_pad = auto_pad(pkt)
-                    print 'Received packet on {0} of len {1}'\
-                        .format(self._ifname, len(pkt))
-                    if verbose:
-                        pkt.show2()  # pylint: disable=no-member
-                        print
-                    if pkt_pad in ignore_list:
-                        ignore_list.remove(pkt_pad)
-                        print 'Received packet ignored.'
-                        continue
-                    else:
-                        return pkt
-        except RuntimeError:
-            return None
+        ignore_list = list()
+        if ignore is not None:
+            for ig_pkt in ignore:
+                # Auto pad all packets in ignore list
+                ignore_list.append(auto_pad(ig_pkt))
+        while True:
+            (rlist, _, _) = select.select([self._sock], [], [], timeout)
+            if self._sock not in rlist:
+                return None
+
+            pkt = self._sock.recv(0x7fff)
+            pkt_pad = auto_pad(pkt)
+            print 'Received packet on {0} of len {1}'\
+                .format(self._ifname, len(pkt))
+            if verbose:
+                pkt.show2()  # pylint: disable=no-member
+                print
+            if pkt_pad in ignore_list:
+                ignore_list.remove(pkt_pad)
+                print 'Received packet ignored.'
+                continue
+            else:
+                return pkt
 
 
 class TxQueue(PacketVerifier):