added more ignores to solver libraries + mypy in docs

Author: pchtsp

doc/source/develop/contribute.rst

@@ -68,14 +68,24 @@ Applying the black linter / formatter
 -----------------------------------------------------
 
 We use `the black formatter <https://black.readthedocs.io/en/stable/>`_. Before sending your changes, be sure to execute the black package to style the resulting files.
-The quickest way to do this is to run:
+The quickest way to do this is to run::
 
     python -m black pulp
 
 And it will do the changes directly on the files.
 
 The easiest way is to integrate it inside your IDE so it runs every time you save a file. Learn how to do that `in the black integration docs <https://black.readthedocs.io/en/stable/integrations/editors.html>`_.
 
+Checking types with mypy
+-------------------------------------
+
+We use `the mypy type checker <https://mypy.readthedocs.io/en/stable/index.html>`_. Before sending your changes, be sure to execute the mypy package to check the types.
+The quickest way to do this is to run::
+
+    python -m mypy ./
+
+Fix all the errors you see before pushing the changes.
+
 Building the documentation
 ----------------------------
 

pulp/apis/coin_api.py

@@ -891,7 +891,7 @@ class CYLP(LpSolver):
     name = "CyLP"
     try:
         global cy
-        from cylp import cy  # type: ignore[import-not-found]
+        from cylp import cy  # type: ignore[import-not-found, import-untyped, unused-ignore]
     except:
 
         def available(self):

pulp/apis/copt_api.py

@@ -861,7 +861,7 @@ class COPT(LpSolver):
 
     try:
         global coptpy
-        import coptpy  # type: ignore[import-not-found]
+        import coptpy  # type: ignore[import-not-found, import-untyped, unused-ignore]
     except:
 
         def available(self):

pulp/apis/gurobi_api.py

@@ -57,7 +57,7 @@ class GUROBI(LpSolver):
     try:
         # to import the name into the module scope
         global gp
-        import gurobipy as gp  # type: ignore[import-not-found]
+        import gurobipy as gp  # type: ignore[import-not-found, import-untyped, unused-ignore]
     except:  # FIXME: Bug because gurobi returns
         #  a gurobi exception on failed imports
         def available(self):

pulp/apis/highs_api.py

@@ -276,7 +276,7 @@ class HiGHS(LpSolver):
 
     try:
         global highspy
-        import highspy  # type: ignore[import-not-found]
+        import highspy  # type: ignore[import-not-found, import-untyped, unused-ignore]
     except:
 
         def available(self):

pulp/apis/sas_api.py

@@ -176,7 +176,7 @@ class SAS94(SASsolver):
 
     try:
         global saspy
-        import saspy  # type: ignore[import-not-found]
+        import saspy  # type: ignore[import-not-found, import-untyped, unused-ignore]
 
     except:
 
@@ -485,7 +485,7 @@ class SASCAS(SASsolver):
 
     try:
         global swat
-        import swat  # type: ignore[import-not-found]
+        import swat  # type: ignore[import-not-found, import-untyped, unused-ignore]
 
     except ImportError:
 

pulp/apis/scip_api.py

@@ -477,7 +477,7 @@ class SCIP_PY(LpSolver):
 
     try:
         global scip
-        import pyscipopt as scip  # type: ignore[import-not-found]
+        import pyscipopt as scip  # type: ignore[import-not-found, import-untyped, unused-ignore]
 
     except ImportError:
 

pulp/apis/xpress_api.py

@@ -381,7 +381,7 @@ def available(self):
         if self._available is None:
             try:
                 global xpress
-                import xpress  # type: ignore[import-not-found]
+                import xpress  # type: ignore[import-not-found, import-untyped, unused-ignore]
 
                 # Always disable the global output. We only want output if
                 # we install callbacks explicitly