remove more of the mypy ignore list (#830)

* remove `mps_lp.py` from mypy ignore list

* remove tests from mypy blacklist

* python 3.9 compatible `Union`

* logic simplification

* fix gurobi env test

* remove docs from blacklist

* actually implement `is_single_use_license`

* type ignores

---------

Co-authored-by: Franco Peschiera <[email protected]>

Author: frrad

doc/KPyCon2009/code/beerdistribution.py

@@ -45,7 +45,7 @@
 x = pulp.LpVariable.dicts("route", (warehouses, bars), lowBound=0, cat=pulp.LpInteger)
 
 # The objective function is added to 'prob' first
-prob += sum([x[w][b] * costs[w][b] for (w, b) in routes]), "Sum_of_Transporting_Costs"
+prob += sum([x[w][b] * costs[w][b] for (w, b) in routes]), "Sum_of_Transporting_Costs"  # type: ignore[call-overload]
 
 # Supply maximum constraints are added to prob for each supply node (warehouse)
 for w in warehouses:
@@ -75,4 +75,4 @@
     print(v.name, "=", v.varValue)
 
 # The optimised objective function value is printed to the screen
-print("Total Cost of Transportation = ", prob.objective.value())
+print("Total Cost of Transportation = ", prob.objective.value())  # type: ignore[union-attr]

doc/source/_static/plotter.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-from matplotlib import rc
+from matplotlib import rc  # type: ignore[import-not-found]
 
 rc("text", usetex=True)
 rc("font", family="serif")
@@ -28,12 +28,12 @@ def plot_interval(a, c, x_left, x_right, i, fbound):
     title(rf"Elasticized constraint\_{i}   $C(x)= {c} $")
 
 
-figure()
-subplots_adjust(hspace=0.5)
+figure()  # type: ignore[name-defined]
+subplots_adjust(hspace=0.5)  # type: ignore[name-defined]
 
 fbound = "proportionFreeBound"
 i = 1
-subplot(2, 1, i)
+subplot(2, 1, i)  # type: ignore[name-defined]
 a = [0.01, 0.01]
 c = 200
 x_left = 0.97 * c
@@ -42,14 +42,14 @@ def plot_interval(a, c, x_left, x_right, i, fbound):
 plot_interval(a, c, x_left, x_right, i, fb_string)
 
 i += 1
-subplot(2, 1, i)
+subplot(2, 1, i)  # type: ignore[name-defined]
 a = [0.02, 0.05]
 c = 500
 x_left = 0.9 * c  # scale of window
 x_right = 1.2 * c  # scale of window
 fb_string = f"{fbound}List = [{a[0]},{a[1]}]"
 plot_interval(a, c, x_left, x_right, i, fb_string)
-savefig("freebound.jpg")
-savefig("freebound.pdf")
+savefig("freebound.jpg")  # type: ignore[name-defined]
+savefig("freebound.pdf")  # type: ignore[name-defined]
 
 # vim: fenc=utf-8: ft=python:sw=4:et:nu:fdm=indent:fdn=1:syn=python

doc/source/conf.py

@@ -11,6 +11,7 @@
 # serve to show the default.
 
 import sys, os
+from typing import Any
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -79,12 +80,12 @@
 
 # List of directories, relative to source directory, that shouldn't be searched
 # for source files.
-exclude_trees = []
+exclude_trees: list[None] = []
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
+exclude_patterns: list[None] = []
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 # default_role = None
@@ -111,15 +112,15 @@
 
 # The theme to use for HTML and HTML Help pages.  Major themes that come with
 # Sphinx are currently 'default' and 'sphinxdoc'.
-import sphinx_rtd_theme
+import sphinx_rtd_theme  # type: ignore[import-untyped]
 
 html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 # html_theme_options = {}
-html_theme_options = {
+html_theme_options: dict[str, Any] = {
     # 'fixed_sidebar': True,
     # 'stickysidebar': True,
     # 'github_banner': True,

pulp/apis/gurobi_api.py

@@ -163,10 +163,9 @@ def __init__(
 
             # set the output of gurobi
             if not self.msg:
-                if self.manage_env:
-                    self.env_options["OutputFlag"] = 0
-                else:
-                    self.env_options["OutputFlag"] = 0
+                self.env_options["OutputFlag"] = 0
+
+                if not self.manage_env:
                     self.solver_params["OutputFlag"] = 0
 
         def __del__(self):

pulp/mps_lp.py

@@ -158,9 +158,9 @@ def readMPS(path: str, sense: int, dropConsNames: bool = False) -> MPS:
 
     with open(path) as reader:
         for line in reader:
-            line = re.split(" |\t", line)
-            line = [x.strip() for x in line]
-            line = list(filter(None, line))
+            line = re.split(" |\t", line)  # type: ignore[assignment]
+            line = [x.strip() for x in line]  # type: ignore[assignment]
+            line = list(filter(None, line))  # type: ignore[assignment]
 
             if line[0] == "ENDATA":
                 break
@@ -229,19 +229,19 @@ def readMPS(path: str, sense: int, dropConsNames: bool = False) -> MPS:
                     raise const.PulpError(
                         "Other RHS name was given even though name was set after RHS tag."
                     )
-                readMPSSetRhs(line, constraints)
+                readMPSSetRhs(line, constraints)  # type: ignore[arg-type]
             elif mode == CORE_FILE_RHS_MODE_NO_NAME:
-                readMPSSetRhs(line, constraints)
+                readMPSSetRhs(line, constraints)  # type: ignore[arg-type]
                 if line[0] not in rhs_names:
                     rhs_names.append(line[0])
             elif mode == CORE_FILE_BOUNDS_MODE_NAME_GIVEN:
                 if line[1] != bnd_names[-1]:
                     raise const.PulpError(
                         "Other BOUNDS name was given even though name was set after BOUNDS tag."
                     )
-                readMPSSetBounds(line, variable_info)
+                readMPSSetBounds(line, variable_info)  # type: ignore[arg-type]
             elif mode == CORE_FILE_BOUNDS_MODE_NO_NAME:
-                readMPSSetBounds(line, variable_info)
+                readMPSSetBounds(line, variable_info)  # type: ignore[arg-type]
                 if line[1] not in bnd_names:
                     bnd_names.append(line[1])
     constraints_list = list(constraints.values())
@@ -312,19 +312,19 @@ def writeMPS(
     if mpsSense != lp.sense:
         n = cobj.name
         cobj = -cobj
-        cobj.name = n
+        cobj.name = n  # type: ignore[union-attr]
     if rename:
-        constrNames, varNames, cobj.name = lp.normalisedNames()
+        constrNames, varNames, cobj.name = lp.normalisedNames()  # type: ignore[union-attr]
         # No need to call self.variables() again, we have just filled self._variables:
-        vs = lp._variables  # type: ignore
+        vs = lp._variables
     else:
         vs = lp.variables()
         varNames = {v.name: v.name for v in vs}
         constrNames = {c: c for c in lp.constraints}
     model_name = lp.name
     if rename:
         model_name = "MODEL"
-    objName = cobj.name
+    objName = cobj.name  # type: ignore[union-attr]
     if not objName:
         objName = "OBJ"
 
@@ -346,7 +346,7 @@ def writeMPS(
     for v in vs:
         name = varNames[v.name]
         columns_lines.extend(
-            writeMPSColumnLines(coefs[name], v, mip, name, cobj, objName)
+            writeMPSColumnLines(coefs[name], v, mip, name, cobj, objName)  # type: ignore[arg-type]
         )
 
     # right hand side
@@ -382,7 +382,7 @@ def writeMPS(
     if not rename:
         return vs
     else:
-        return vs, varNames, constrNames, cobj.name
+        return vs, varNames, constrNames, cobj.name  # type: ignore[union-attr]
 
 
 def writeMPSColumnLines(

pulp/tests/test_gurobipy_env.py

@@ -3,7 +3,7 @@
 from pulp import GUROBI, LpProblem, LpVariable, const
 
 try:
-    import gurobipy as gp
+    import gurobipy as gp  # type: ignore[import-not-found]
     from gurobipy import GRB
 except ImportError:
     gp = None
@@ -14,6 +14,19 @@ def check_dummy_env():
         pass
 
 
+def is_single_use_license() -> bool:
+    try:
+        with gp.Env() as env1:
+            with gp.Env() as env2:
+                pass
+    except gp.GurobiError as ge:
+        if ge.errno == gp.GRB.Error.NO_LICENSE:
+            print("single use license")
+            print(f"Error code {ge.errno}: {ge}")
+            return True
+    return False
+
+
 def generate_lp() -> LpProblem:
     prob = LpProblem("test", const.LpMaximize)
     x = LpVariable("x", 0, 1)
@@ -40,7 +53,10 @@ def test_gp_env(self):
             solver.close()
         check_dummy_env()
 
-    @unittest.SkipTest
+    @unittest.skipUnless(
+        is_single_use_license(),
+        "this test is only expected to pass with a single-use license",
+    )
     def test_gp_env_no_close(self):
         # Not closing results in an error for a single use license.
         with gp.Env(params=self.env_options) as env:
@@ -64,7 +80,10 @@ def test_multiple_gp_env(self):
 
         check_dummy_env()
 
-    @unittest.SkipTest
+    @unittest.skipUnless(
+        is_single_use_license(),
+        "this test is only expected to pass with a single-use license",
+    )
     def test_backward_compatibility(self):
         """
         Backward compatibility check as previously the environment was not being
@@ -101,7 +120,10 @@ def test_multiple_solves(self):
         solver2.close()
         check_dummy_env()
 
-    @unittest.SkipTest
+    @unittest.skipUnless(
+        is_single_use_license(),
+        "this test is only expected to pass with a single-use license",
+    )
     def test_leak(self):
         """
         Check that we cannot initialise environments after a memory leak. On a