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

[akshaycbor]

Not all functions were covered due to mypy issues

Cannot determine type after isInstance check - PacketList.init()
python/mypy#6846

Issue when a None method is recasted using an inner def - PacketList.conversations()
python/mypy#2608

part of #2158

[guedou]

Thanks for your PR. See my comment.

[codecov]

Codecov Report

Merging #2358 into master will increase coverage by 0.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #2358      +/-   ##
==========================================
+ Coverage    87.8%   87.82%   +0.01%     
==========================================
  Files         243      243              
  Lines       50735    50749      +14     
==========================================
+ Hits        44549    44570      +21     
+ Misses       6186     6179       -7

Impacted Files	Coverage Δ
scapy/plist.py	86.97% <100%> (+0.1%)	⬆️
scapy/extlib.py	86.11% <100%> (+0.81%)	⬆️
scapy/contrib/cdp.py	90.13% <0%> (-0.78%)	⬇️
scapy/layers/inet6.py	81.75% <0%> (-0.27%)	⬇️
scapy/layers/ntp.py	91.77% <0%> (ø)	⬆️
scapy/layers/inet.py	73.1% <0%> (+0.16%)	⬆️
scapy/asn1/ber.py	83.69% <0%> (+0.27%)	⬆️
scapy/layers/tls/record.py	90.46% <0%> (+0.86%)	⬆️
scapy/layers/tls/record_sslv2.py	87.7% <0%> (+1.67%)	⬆️
scapy/autorun.py	82.64% <0%> (+4.13%)	⬆️

[akshaycbor]

4 build jobs are failing with the following error
ERROR: InvocationError for command /usr/bin/sudo -E .tox/py27-linux_root/bin/python -m coverage run -a -m scapy.tools.UTscapy -c ./test/configs/linux.utsc -K random_weird_py3 -K tshark (exited with code 1)

Not sure what is causing that

[guedou]

I did a complete review and commented on the types that can be stricter.

[akshaycbor]

One test in regression.uts is failing because of the addition to extlib.py made in this commit.

>>> with patch.dict("sys.modules", matplotlib=matplotlib):
...     from scapy.extlib import MATPLOTLIB, MATPLOTLIB_INLINED, MATPLOTLIB_DEFAULT_PLOT_KARGS
...     assert MATPLOTLIB == 1
...     assert MATPLOTLIB_INLINED == 1
...     assert "marker" in MATPLOTLIB_DEFAULT_PLOT_KARGS

Seems like the extlib import is failing even when it's not supposed to. But I cannot figure out what's causing that.
This is my first commit on scapy so I'm not aware of what configuration and/or test changes I might be missing here

[guedou]

This fixes the issue:

$ git diff
diff --git a/test/regression.uts b/test/regression.uts
index 9ee9eb95..87a81efd 100644
--- a/test/regression.uts
+++ b/test/regression.uts
@@ -680,18 +680,19 @@ 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
+    print(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

[guedou]

I made one final comment.

[guedou]

This changes is not needed. Can you remove it?

[akshaycbor]

I've removed this change

[gpotter2]

Don't worry about AppVeyor.
Chocolatey has been broken for the past week...
https://status.chocolatey.org/