Initialize stubs (#1073)

* stubgen -p pyscipopt

* Move stubs in source tree

* Remove pure python module stubs

* Fixup some artifacts from Cython

* Add py.typed file

Author: jonathanberthias

src/pyscipopt/__init__.py

@@ -7,38 +7,38 @@
         os.add_dll_directory(os.path.join(os.getenv('SCIPOPTDIR').strip('"'), 'bin'))
 
 # export user-relevant objects:
-from pyscipopt.Multidict import multidict
-from pyscipopt.scip      import Model
-from pyscipopt.scip      import Variable
-from pyscipopt.scip      import MatrixVariable
-from pyscipopt.scip      import Constraint
-from pyscipopt.scip      import MatrixConstraint
-from pyscipopt.scip      import Benders
-from pyscipopt.scip      import Benderscut
-from pyscipopt.scip      import Branchrule
-from pyscipopt.scip      import Nodesel
-from pyscipopt.scip      import Conshdlr
-from pyscipopt.scip      import Eventhdlr
-from pyscipopt.scip      import Heur
-from pyscipopt.scip      import Presol
-from pyscipopt.scip      import Pricer
-from pyscipopt.scip      import Prop
-from pyscipopt.scip      import Reader
-from pyscipopt.scip      import Sepa
-from pyscipopt.scip      import LP
+from pyscipopt.Multidict import multidict as multidict
+from pyscipopt.scip      import Model as Model
+from pyscipopt.scip      import Variable as Variable
+from pyscipopt.scip      import MatrixVariable as MatrixVariable
+from pyscipopt.scip      import Constraint as Constraint
+from pyscipopt.scip      import MatrixConstraint as MatrixConstraint
+from pyscipopt.scip      import Benders as Benders
+from pyscipopt.scip      import Benderscut as Benderscut
+from pyscipopt.scip      import Branchrule as Branchrule
+from pyscipopt.scip      import Nodesel as Nodesel
+from pyscipopt.scip      import Conshdlr as Conshdlr
+from pyscipopt.scip      import Eventhdlr as Eventhdlr
+from pyscipopt.scip      import Heur as Heur
+from pyscipopt.scip      import Presol as Presol
+from pyscipopt.scip      import Pricer as Pricer
+from pyscipopt.scip      import Prop as Prop
+from pyscipopt.scip      import Reader as Reader
+from pyscipopt.scip      import Sepa as Sepa
+from pyscipopt.scip      import LP as LP
 from pyscipopt.scip      import PY_SCIP_LPPARAM as SCIP_LPPARAM
-from pyscipopt.scip      import readStatistics
-from pyscipopt.scip      import Expr
-from pyscipopt.scip      import MatrixExpr
-from pyscipopt.scip      import MatrixExprCons
-from pyscipopt.scip      import ExprCons
-from pyscipopt.scip      import quicksum
-from pyscipopt.scip      import quickprod
-from pyscipopt.scip      import exp
-from pyscipopt.scip      import log
-from pyscipopt.scip      import sqrt
-from pyscipopt.scip      import sin
-from pyscipopt.scip      import cos
+from pyscipopt.scip      import readStatistics as readStatistics
+from pyscipopt.scip      import Expr as Expr
+from pyscipopt.scip      import MatrixExpr as MatrixExpr
+from pyscipopt.scip      import MatrixExprCons as MatrixExprCons
+from pyscipopt.scip      import ExprCons as ExprCons
+from pyscipopt.scip      import quicksum as quicksum
+from pyscipopt.scip      import quickprod as quickprod
+from pyscipopt.scip      import exp as exp
+from pyscipopt.scip      import log as log
+from pyscipopt.scip      import sqrt as sqrt
+from pyscipopt.scip      import sin as sin
+from pyscipopt.scip      import cos as cos
 from pyscipopt.scip      import PY_SCIP_RESULT       as SCIP_RESULT
 from pyscipopt.scip      import PY_SCIP_PARAMSETTING as SCIP_PARAMSETTING
 from pyscipopt.scip      import PY_SCIP_PARAMEMPHASIS as SCIP_PARAMEMPHASIS

src/pyscipopt/_version.py

@@ -1 +1 @@
-__version__ = '5.5.0'
+__version__: str = '5.5.0'

src/pyscipopt/py.typed

@@ -1,7 +1,7 @@
 from pyscipopt import Model, quicksum
 
 
-def get_infeasible_constraints(orig_model: Model, verbose=False):
+def get_infeasible_constraints(orig_model: Model, verbose: bool = False):
     """
     Given a model, adds slack variables to all the constraints and minimizes a binary variable that indicates if they're positive.
     Positive slack variables correspond to infeasible constraints.

src/pyscipopt/recipes/infeasibilities.py

@@ -1,6 +1,6 @@
 from pyscipopt import Model
 
-def set_nonlinear_objective(model: Model, expr, sense="minimize"):
+def set_nonlinear_objective(model: Model, expr, sense: str = "minimize"):
     """
     Takes a nonlinear expression and performs an epigraph reformulation.
     """