#2158 - Add Hinty for plist.py - Adds mypy from Issue #2158 (#2358)

* #2158 - Add Hinty for plist.py

* Import MATPLOTLIB from extlib.py

* Add Line2D and update for review comments

* Add regression test changes for new matplotlib.lines import

* Remove unnecessary space

* Add new line to restart appveyer build

Author: akshaycbor

.config/mypy/mypy.ini

@@ -12,3 +12,10 @@ ignore_missing_imports = True
 [mypy-scapy.modules.six,scapy.modules.six.moves,scapy.libs.winpcapy]
 ignore_errors = True
 ignore_missing_imports = True
+
+[mypy-pyx]
+ignore_missing_imports = True
+
+[mypy-matplotlib.lines]
+ignore_missing_imports = True
+

.config/mypy/mypy_enabled.txt

@@ -6,4 +6,5 @@
 
 scapy/__init__.py
 scapy/main.py
-scapy/contrib/http2.py
+scapy/contrib/http2.py
+scapy/plist.py

scapy/extlib.py

@@ -20,6 +20,7 @@
 try:
     from matplotlib import get_backend as matplotlib_get_backend
     from matplotlib import pyplot as plt
+    from matplotlib.lines import Line2D
     MATPLOTLIB = 1
     if "inline" in matplotlib_get_backend():
         MATPLOTLIB_INLINED = 1
@@ -29,6 +30,7 @@
 # RuntimeError to catch gtk "Cannot open display" error
 except (ImportError, RuntimeError):
     plt = None
+    Line2D = None
     MATPLOTLIB = 0
     MATPLOTLIB_INLINED = 0
     MATPLOTLIB_DEFAULT_PLOT_KARGS = dict()

scapy/plist.py

@@ -16,13 +16,16 @@
 from scapy.compat import lambda_tuple_converter
 from scapy.config import conf
 from scapy.base_classes import BasePacket, BasePacketList, _CanvasDumpExtended
+from scapy.fields import IPField, ShortEnumField, PacketField
 from scapy.utils import do_graph, hexdump, make_table, make_lined_table, \
     make_tex_table, issubtype
-from scapy.extlib import plt, MATPLOTLIB_INLINED, MATPLOTLIB_DEFAULT_PLOT_KARGS
+from scapy.extlib import plt, Line2D, \
+    MATPLOTLIB_INLINED, MATPLOTLIB_DEFAULT_PLOT_KARGS
 from functools import reduce
 import scapy.modules.six as six
 from scapy.modules.six.moves import range, zip
-
+from scapy.compat import Optional, List, Union, Tuple, Dict, Any, Callable
+from scapy.packet import Packet
 #############
 #  Results  #
 #############
@@ -46,18 +49,23 @@ def __init__(self, res=None, name="PacketList", stats=None):
         self.listname = name
 
     def __len__(self):
+        # type: () -> int
         return len(self.res)
 
     def _elt2pkt(self, elt):
+        # type: (Packet) -> Packet
         return elt
 
     def _elt2sum(self, elt):
+        # type: (Packet) -> str
         return elt.summary()
 
     def _elt2show(self, elt):
+        # type: (Packet) -> str
         return self._elt2sum(elt)
 
     def __repr__(self):
+        # type: () -> str
         stats = {x: 0 for x in self.stats}
         other = 0
         for r in self.res:
@@ -85,6 +93,7 @@ def __repr__(self):
                                ct.punct(">"))
 
     def __getstate__(self):
+        # type: () -> Dict[str, Union[List[PacketField], List[Packet], str]]
         """
         Creates a basic representation of the instance, used in
         conjunction with __setstate__() e.g. by pickle
@@ -99,6 +108,7 @@ def __getstate__(self):
         return state
 
     def __setstate__(self, state):
+        # type: (Dict[str, Union[List[PacketField], List[Packet], str]]) -> None  # noqa: E501
         """
         Sets instance attributes to values given by state, used in
         conjunction with __getstate__() e.g. by pickle
@@ -110,6 +120,7 @@ def __setstate__(self, state):
         self.listname = state['listname']
 
     def __getattr__(self, attr):
+        # type: (str) -> Any
         return getattr(self.res, attr)
 
     def __getitem__(self, item):
@@ -122,10 +133,12 @@ def __getitem__(self, item):
         return self.res.__getitem__(item)
 
     def __add__(self, other):
+        # type: (PacketList) -> PacketList
         return self.__class__(self.res + other.res,
                               name="%s+%s" % (self.listname, other.listname))
 
     def summary(self, prn=None, lfilter=None):
+        # type: (Optional[Callable], Optional[Callable]) -> None
         """prints a summary of each packet
 
         :param prn: function to apply to each packet instead of
@@ -143,6 +156,7 @@ def summary(self, prn=None, lfilter=None):
                 print(prn(r))
 
     def nsummary(self, prn=None, lfilter=None):
+        # type: (Optional[Callable], Optional[Callable]) -> None
         """prints a summary of each packet with the packet's number
 
         :param prn: function to apply to each packet instead of
@@ -165,29 +179,35 @@ def display(self):  # Deprecated. Use show()
         self.show()
 
     def show(self, *args, **kargs):
+        # type: (Any, Any) -> None
         """Best way to display the packet list. Defaults to nsummary() method"""  # noqa: E501
         return self.nsummary(*args, **kargs)
 
     def filter(self, func):
+        # type: (Callable) -> PacketList
         """Returns a packet list filtered by a truth function. This truth
         function has to take a packet as the only argument and return a boolean value."""  # noqa: E501
         return self.__class__([x for x in self.res if func(x)],
                               name="filtered %s" % self.listname)
 
     def make_table(self, *args, **kargs):
+        # type: (Any, Any) -> None
         """Prints a table using a function that returns for each packet its head column value, head row value and displayed value  # noqa: E501
         ex: p.make_table(lambda x:(x[IP].dst, x[TCP].dport, x[TCP].sprintf("%flags%")) """  # noqa: E501
         return make_table(self.res, *args, **kargs)
 
     def make_lined_table(self, *args, **kargs):
+        # type: (Any, Any) -> None
         """Same as make_table, but print a table with lines"""
         return make_lined_table(self.res, *args, **kargs)
 
     def make_tex_table(self, *args, **kargs):
+        # type: (Any, Any) -> None
         """Same as make_table, but print a table with LaTeX syntax"""
         return make_tex_table(self.res, *args, **kargs)
 
     def plot(self, f, lfilter=None, plot_xy=False, **kargs):
+        # type: (Callable, Optional[Callable], bool, Any) -> Line2D
         """Applies a function to each packet to get a value that will be plotted
         with matplotlib. A list of matplotlib.lines.Line2D is returned.
 
@@ -219,6 +239,7 @@ def plot(self, f, lfilter=None, plot_xy=False, **kargs):
         return lines
 
     def diffplot(self, f, delay=1, lfilter=None, **kargs):
+        # type: (Callable, int, Optional[Callable], Any) -> Line2D
         """diffplot(f, delay=1, lfilter=None)
         Applies a function to couples (l[i],l[i+delay])
 
@@ -246,6 +267,7 @@ def diffplot(self, f, delay=1, lfilter=None, **kargs):
         return lines
 
     def multiplot(self, f, lfilter=None, plot_xy=False, **kargs):
+        # type: (Callable, Optional[Callable], bool, Any) -> Line2D
         """Uses a function that returns a label and a value for this label, then
         plots all the values label by label.
 
@@ -263,7 +285,7 @@ def multiplot(self, f, lfilter=None, plot_xy=False, **kargs):
             lst_pkts = (f(*e) for e in self.res if lfilter(*e))
 
         # Apply the function f to the packets
-        d = {}
+        d = {}  # type: Dict[str, List[float]]
         for k, v in lst_pkts:
             d.setdefault(k, []).append(v)
 
@@ -286,11 +308,13 @@ def multiplot(self, f, lfilter=None, plot_xy=False, **kargs):
         return lines
 
     def rawhexdump(self):
+        # type: (Optional[Callable]) -> None
         """Prints an hexadecimal dump of each packet in the list"""
         for p in self:
             hexdump(self._elt2pkt(p))
 
     def hexraw(self, lfilter=None):
+        # type: (Optional[Callable]) -> None
         """Same as nsummary(), except that if a packet has a Raw layer, it will be hexdumped  # noqa: E501
         lfilter: a truth function that decides whether a packet must be displayed"""  # noqa: E501
         for i, res in enumerate(self.res):
@@ -304,6 +328,7 @@ def hexraw(self, lfilter=None):
                 hexdump(p.getlayer(conf.raw_layer).load)
 
     def hexdump(self, lfilter=None):
+        # type: (Optional[Callable]) -> None
         """Same as nsummary(), except that packets are also hexdumped
         lfilter: a truth function that decides whether a packet must be displayed"""  # noqa: E501
         for i, res in enumerate(self.res):
@@ -316,6 +341,7 @@ def hexdump(self, lfilter=None):
             hexdump(p)
 
     def padding(self, lfilter=None):
+        # type: (Optional[Callable]) -> None
         """Same as hexraw(), for Padding layer"""
         for i, res in enumerate(self.res):
             p = self._elt2pkt(res)
@@ -327,6 +353,7 @@ def padding(self, lfilter=None):
                     hexdump(p.getlayer(conf.padding_layer).load)
 
     def nzpadding(self, lfilter=None):
+        # type: (Optional[Callable]) -> None
         """Same as padding() but only non null padding"""
         for i, res in enumerate(self.res):
             p = self._elt2pkt(res)
@@ -389,6 +416,7 @@ def getsrcdst(pkt):
         return do_graph(gr, **kargs)
 
     def afterglow(self, src=None, event=None, dst=None, **kargs):
+        # type: (Optional[Callable], Optional[Callable], Optional[Callable], Any) -> None  # noqa: E501
         """Experimental clone attempt of http://sourceforge.net/projects/afterglow
         each datum is reduced as src -> event -> dst and the data are graphed.
         by default we have IP.src -> IP.dport -> IP.dst"""
@@ -398,9 +426,9 @@ def afterglow(self, src=None, event=None, dst=None, **kargs):
             event = lambda x: x['IP'].dport
         if dst is None:
             dst = lambda x: x['IP'].dst
-        sl = {}
-        el = {}
-        dl = {}
+        sl = {}  # type: Dict[IPField, Tuple[int, List[ShortEnumField]]]
+        el = {}  # type: Dict[ShortEnumField, Tuple[int, List[IPField]]]
+        dl = {}  # type: Dict[IPField, ShortEnumField]
         for i in self.res:
             try:
                 s, e, d = src(i), event(i), dst(i)
@@ -468,6 +496,7 @@ def minmax(x):
         return do_graph(gr, **kargs)
 
     def canvas_dump(self, **kargs):
+        # type: (Any) -> Any  # Using Any since pyx is imported later
         import pyx
         d = pyx.document.document()
         len_res = len(self.res)
@@ -483,6 +512,7 @@ def canvas_dump(self, **kargs):
         return d
 
     def sr(self, multi=0):
+        # type: (int) -> Tuple[SndRcvList, PacketList]
         """sr([multi=1]) -> (SndRcvList, PacketList)
         Matches packets in the list and return ( (matched couples), (unmatched packets) )"""  # noqa: E501
         remain = self.res[:]
@@ -545,6 +575,7 @@ def session_extractor(p):
         return dict(sessions)
 
     def replace(self, *args, **kargs):
+        # type: (Any, Any) -> PacketList
         """
         lst.replace(<field>,[<oldvalue>,]<newvalue>)
         lst.replace( (fld,[ov],nv),(fld,[ov,]nv),...)
@@ -577,7 +608,13 @@ def replace(self, *args, **kargs):
             x.append(p)
         return x
 
-    def getlayer(self, cls, nb=None, flt=None, name=None, stats=None):
+    def getlayer(self, cls,  # type: Packet
+                 nb=None,  # type: Optional[int]
+                 flt=None,  # type: Optional[Dict[str, Any]]
+                 name=None,  # type: Optional[str]
+                 stats=None  # type: Optional[List[Packet]]
+                 ):
+        # type: (...) -> PacketList
         """Returns the packet list from a given layer.
 
         See ``Packet.getlayer`` for more info.
@@ -604,7 +641,7 @@ def getlayer(self, cls, nb=None, flt=None, name=None, stats=None):
         if stats is None:
             stats = self.stats
 
-        getlayer_arg = {}
+        getlayer_arg = {}  # type: Dict[str, Any]
         if flt is not None:
             getlayer_arg.update(flt)
         getlayer_arg['cls'] = cls
@@ -619,6 +656,7 @@ def getlayer(self, cls, nb=None, flt=None, name=None, stats=None):
         )
 
     def convert_to(self, other_cls, name=None, stats=None):
+        # type: (Packet, Optional[str], Optional[List[Packet]]) -> PacketList
         """Converts all packets to another type.
 
         See ``Packet.convert_to`` for more info.
@@ -648,13 +686,20 @@ def convert_to(self, other_cls, name=None, stats=None):
 
 
 class SndRcvList(PacketList):
-    __slots__ = []
-
-    def __init__(self, res=None, name="Results", stats=None):
+    __slots__ = []  # type: List[str]
+
+    def __init__(self,
+                 res=None,  # type: Optional[Union[List[Packet], PacketList]]
+                 name="Results",  # type: str
+                 stats=None  # type: Optional[List[Packet]]
+                 ):
+        # type: (...) -> None
         PacketList.__init__(self, res, name, stats)
 
     def _elt2pkt(self, elt):
+        # type: (Tuple[Packet, Packet]) -> Packet
         return elt[1]
 
     def _elt2sum(self, elt):
+        # type: (Tuple[Packet, Packet]) -> str
         return "%s ==> %s" % (elt[0].summary(), elt[1].summary())

test/regression.uts

@@ -680,18 +680,18 @@ from mock import MagicMock, patch
 bck_scapy_ext_lib = sys.modules.get("scapy.extlib", None)
 del(sys.modules["scapy.extlib"])
 
-matplotlib = MagicMock()
-matplotlib.get_backend.return_value = "inline"
-matplotlib.pyplot = MagicMock()
-matplotlib.pyplot.plt = None
-with patch.dict("sys.modules", matplotlib=matplotlib):
-    from scapy.extlib import MATPLOTLIB, MATPLOTLIB_INLINED, MATPLOTLIB_DEFAULT_PLOT_KARGS
+mock_matplotlib = MagicMock()
+mock_matplotlib.get_backend.return_value = "inline"
+mock_matplotlib.pyplot = MagicMock()
+mock_matplotlib.pyplot.plt = None
+with patch.dict("sys.modules", **{ "matplotlib": mock_matplotlib, "matplotlib.lines": mock_matplotlib}):
+    from scapy.extlib import MATPLOTLIB, MATPLOTLIB_INLINED, MATPLOTLIB_DEFAULT_PLOT_KARGS, Line2D
     assert MATPLOTLIB == 1
     assert MATPLOTLIB_INLINED == 1
     assert "marker" in MATPLOTLIB_DEFAULT_PLOT_KARGS
 
-matplotlib.get_backend.return_value = "ko"
-with patch.dict("sys.modules", matplotlib=matplotlib):
+mock_matplotlib.get_backend.return_value = "ko"
+with patch.dict("sys.modules", **{ "matplotlib": mock_matplotlib, "matplotlib.lines": mock_matplotlib}):
     from scapy.extlib import MATPLOTLIB, MATPLOTLIB_INLINED, MATPLOTLIB_DEFAULT_PLOT_KARGS
     assert MATPLOTLIB == 1
     assert MATPLOTLIB_INLINED == 0