[Hinty] Type hinting: prepare tests & setup Mypy

.appveyor.yml

@@ -31,8 +31,8 @@ build: off
 
 install:
   # Install the npcap, windump and wireshark suites
-  - ps: .\.appveyor\InstallNpcap.ps1
-  - ps: .\.appveyor\InstallWindumpNpcap.ps1
+  - ps: .\.config\appveyor\InstallNpcap.ps1
+  - ps: .\.config\appveyor\InstallWindumpNpcap.ps1
   # Installs Wireshark 3.0 (and its dependencies)
   # https://github.com/mkevenaar/chocolatey-packages/issues/16
   - choco install -n KB3033929 KB2919355 kb2999226

.config/mypy/mypy.ini

@@ -0,0 +1,13 @@
+[mypy]
+
+[mypy-IPython]
+ignore_missing_imports = True
+
+[mypy-colorama]
+ignore_missing_imports = True
+
+[mypy-traitlets.config.loader]
+ignore_missing_imports = True
+
+[mypy-scapy.modules.six,scapy.modules.winpcapy]
+ignore_errors = True

.config/mypy/mypy_check.py

@@ -0,0 +1,50 @@
+# This file is part of Scapy
+# See http://www.secdev.org/projects/scapy for more information
+# Copyright (C) Philippe Biondi <[email protected]>
+# Copyright (C) Gabriel Potter <[email protected]>
+# This program is published under a GPLv2 license
+
+"""
+Performs Static typing checks over Scapy's codebase
+"""
+
+# IMPORTANT NOTE
+#
+# Because we are rolling out mypy tests progressively,
+# we currently use --follow-imports=skip. This means that
+# mypy doesn't check consistency between the imports (different files).
+#
+# Once each file has been processed individually, we'll remove that to
+# check the inconsistencies across the files
+
+import io
+import os
+import sys
+
+from mypy.main import main as mypy_main
+
+# Load files
+
+with io.open("./.config/mypy/mypy_enabled.txt") as fd:
+    FILES = [l.strip() for l in fd.readlines() if l.strip() and l[0] != "#"]
+
+if not FILES:
+    print("No files specified. Arborting")
+    sys.exit(0)
+
+# Generate mypy arguments
+
+ARGS = [
+    "--py2",
+    "--follow-imports=skip",
+    "--config-file=" + os.path.abspath(
+        os.path.join(
+            os.path.split(__file__)[0],
+            "mypy.ini"
+        )
+    )
+] + [os.path.abspath(f) for f in FILES]
+
+# Run mypy over the files
+
+mypy_main(None, sys.stdout, sys.stderr, ARGS)

.config/mypy/mypy_enabled.txt

@@ -0,0 +1,9 @@
+# This file registers all files that have already been processed as part of
+# https://github.com/secdev/scapy/issues/2158, and therefore will be enforced
+# with unit tests in future development.
+
+# Style cheet: https://mypy.readthedocs.io/en/latest/cheat_sheet.html
+
+scapy/__init__.py
+scapy/main.py
+scapy/contrib/http2.py

.travis/install.sh → .config/travis/install.sh

@@ -2,13 +2,11 @@
 # Install on osx
 if [ "$TRAVIS_OS_NAME" = "osx" ]
 then
-  pip3 install tox
   if [ ! -z $SCAPY_USE_PCAPDNET ]
   then
     brew update
     brew install libdnet libpcap
   fi
-  exit 0
 fi
 
 # Install wireshark data
@@ -25,11 +23,11 @@ then
   $SCAPY_SUDO apt-get -qy install libdumbnet-dev libpcap-dev
 fi
 
-# Check pip
-sudo pip install --upgrade pip setuptools --ignore-installed
+# Update pip & setuptools (tox uses those)
+python -m pip install --upgrade pip setuptools --ignore-installed
 
 # Make sure tox is installed and up to date
-pip install -U tox --ignore-installed
+python -m pip install -U tox --ignore-installed
 
 # Dump Environment (so that we can check PATH, UT_FLAGS, etc.)
 set

.travis.yml

@@ -6,7 +6,7 @@ matrix:
         - os: linux
           python: 3.6
           env:
-            - TOXENV=flake8,twine,docs,spell
+            - TOXENV=mypy,flake8,twine,docs,spell
 
         # Run as a regular user
         - os: linux
@@ -130,7 +130,7 @@ matrix:
             - TOXENV=linux_warnings
 
 install:
-  - bash .travis/install.sh
+  - bash .config/travis/install.sh
   - python -c "from scapy.all import conf; print(repr(conf))"
 
-script: bash .travis/test.sh
+script: bash .config/travis/test.sh

scapy/__init__.py

@@ -19,6 +19,7 @@
 
 
 def _version_from_git_describe():
+    # type: () -> str
     """
     Read the version from ``git describe``. It returns the latest tag with an
     optional suffix if the current directory is not exactly on the tag.
@@ -38,6 +39,9 @@ def _version_from_git_describe():
 
         >>> _version_from_git_describe()
         '2.3.2.dev346'
+
+    :raises CalledProcessError: if git is unavailable
+    :return: Scapy's latest tag
     """
     if not os.path.isdir(os.path.join(os.path.dirname(_SCAPY_PKG_DIR), '.git')):  # noqa: E501
         raise ValueError('not in scapy git repo')
@@ -62,6 +66,11 @@ def _version_from_git_describe():
 
 
 def _version():
+    # type: () -> str
+    """Returns the Scapy version from multiple methods
+
+    :return: the Scapy version
+    """
     version_file = os.path.join(_SCAPY_PKG_DIR, 'VERSION')
     try:
         tag = _version_from_git_describe()
@@ -91,7 +100,9 @@ def _version():
 
 
 VERSION = __version__ = _version()
-VERSION_MAIN = re.search(r"[0-9.]+", VERSION).group()
+
+_tmp = re.search(r"[0-9.]+", VERSION)
+VERSION_MAIN = _tmp.group() if _tmp is not None else VERSION
 
 if __name__ == "__main__":
     from scapy.main import interact

scapy/compat.py

@@ -117,3 +117,32 @@ def gzip_compress(x):
 else:
     gzip_decompress = gzip.decompress
     gzip_compress = gzip.compress
+
+# Typing compatibility
+
+try:
+    # Only required if using mypy-lang for static typing
+    from typing import Optional, List, Union, Callable, Any, Tuple, Sized, \
+        Dict, Pattern, cast
+except ImportError:
+    # Let's make some fake ones.
+
+    def cast(_type, obj):
+        return obj
+
+    class _FakeType(object):
+        # make the objects subscriptable indefinetly
+        def __getitem__(self, item):
+            return _FakeType()
+
+    Optional = _FakeType()
+    Union = _FakeType()
+    Callable = _FakeType()
+    List = _FakeType()
+    Dict = _FakeType()
+    Any = _FakeType()
+    Tuple = _FakeType()
+    Pattern = _FakeType()
+
+    class Sized(object):
+        pass