Add typing to sage_input methods

src/sage/geometry/cone.py

@@ -201,20 +201,28 @@
 # (at your option) any later version.
 #                  https://www.gnu.org/licenses/
 # ****************************************************************************
+from __future__ import annotations
 
-from collections.abc import Hashable, Iterable, Container
+from collections.abc import Container, Hashable, Iterable
 from copy import copy
+from typing import TYPE_CHECKING
 from warnings import warn
 
 from sage.misc.lazy_import import lazy_import
+
 lazy_import('sage.combinat.posets.posets', 'FinitePoset')
-from sage.arith.misc import GCD as gcd
 from sage.arith.functions import lcm
+from sage.arith.misc import GCD as gcd
 from sage.geometry.point_collection import PointCollection
 from sage.geometry.polyhedron.constructor import Polyhedron
+
 lazy_import('sage.geometry.hasse_diagram', 'lattice_from_incidences')
-from sage.geometry.toric_lattice import (ToricLattice, ToricLattice_generic,
-                                         ToricLattice_quotient)
+from sage.geometry.toric_lattice import (
+    ToricLattice,
+    ToricLattice_generic,
+    ToricLattice_quotient,
+)
+
 lazy_import('sage.geometry.toric_plotter', ['ToricPlotter', 'label_list'])
 from sage.geometry.relative_interior import RelativeInterior
 from sage.matrix.constructor import matrix
@@ -223,24 +231,28 @@
 from sage.misc.cachefunc import cached_method
 from sage.misc.flatten import flatten
 from sage.misc.latex import latex
-from sage.modules.free_module import span, VectorSpace
+from sage.modules.free_module import VectorSpace, span
 from sage.modules.free_module_element import vector
 from sage.rings.integer_ring import ZZ
 from sage.rings.rational_field import QQ
-from sage.structure.sage_object import SageObject
 from sage.structure.element import parent
-from sage.structure.richcmp import richcmp_method, richcmp
+from sage.structure.richcmp import richcmp, richcmp_method
+from sage.structure.sage_object import SageObject
+
 lazy_import('sage.geometry.integral_points', 'parallelotope_points')
-from sage.geometry.convex_set import ConvexSet_closed
 import sage.geometry.abc
-
 from sage.features import PythonModule
+from sage.geometry.convex_set import ConvexSet_closed
+
 lazy_import('ppl', ['C_Polyhedron', 'Generator_System', 'Constraint_System',
                     'Linear_Expression', 'Poly_Con_Relation'],
                     feature=PythonModule("ppl", spkg='pplpy', type='standard'))
 lazy_import('ppl', ['ray', 'point'], as_=['PPL_ray', 'PPL_point'],
                     feature=PythonModule("ppl", spkg='pplpy', type='standard'))
 
+if TYPE_CHECKING:
+    from sage.misc.sage_input import CoercionMode, SageInputBuilder, SageInputExpression
+
 
 def is_Cone(x):
     r"""
@@ -1510,7 +1522,7 @@
         if PPL is not None:
             self._PPL_C_Polyhedron = PPL
 
-    def _sage_input_(self, sib, coerced):
+    def _sage_input_(self, sib: SageInputBuilder, coerced: CoercionMode) -> SageInputExpression:
         """
         Return Sage command to reconstruct ``self``.
 
@@ -2088,31 +2100,31 @@
 
         First, we create a fan from two cones in the plane::
 
             sage: fan = Fan(cones=[(0,1), (1,2)],
             ....:           rays=[(1,0), (0,1), (-1,0)])
             sage: cone = fan.generating_cone(0)
             sage: len(cone.adjacent())                                                  # needs sage.graphs
             1
 
         The second generating cone is adjacent to this one. Now we create the
         same fan, but embedded into the 3-dimensional space::
 
             sage: fan = Fan(cones=[(0,1), (1,2)],
             ....:           rays=[(1,0,0), (0,1,0), (-1,0,0)])
             sage: cone = fan.generating_cone(0)
             sage: len(cone.adjacent())                                                  # needs sage.graphs
             1
 
         The result is as before, since we still have::
 
             sage: fan.dim()
             2
 
         Now we add another cone to make the fan 3-dimensional::
 
             sage: fan = Fan(cones=[(0,1), (1,2), (3,)],
             ....:           rays=[(1,0,0), (0,1,0), (-1,0,0), (0,0,1)])
             sage: cone = fan.generating_cone(0)
             sage: len(cone.adjacent())                                                  # needs sage.graphs
             0
 
@@ -4328,8 +4340,9 @@
         # recursively
         N = self.lattice()
         if not self.is_simplicial():
-            from sage.geometry.triangulation.point_configuration \
-                    import PointConfiguration
+            from sage.geometry.triangulation.point_configuration import (
+                PointConfiguration,
+            )
             origin = self.n_rays() # last one in pc
             pc = PointConfiguration(tuple(self.rays()) + (N(0),), star=origin)
             triangulation = pc.triangulate()
@@ -6772,12 +6785,11 @@
                     msg = 'max_rays must be at least min_ambient_dim for '
                     msg += 'a solid cone.'
                     raise ValueError(msg)
-        else:
-            # Repeat the checks above when a lattice is given.
-            if max_rays is not None and max_rays < lattice.dimension():
-                msg = "max_rays must be at least {0} for a solid cone "
-                msg += "in this lattice."
-                raise ValueError(msg.format(lattice.dimension()))
+        # Repeat the checks above when a lattice is given.
+        elif max_rays is not None and max_rays < lattice.dimension():
+            msg = "max_rays must be at least {0} for a solid cone "
+            msg += "in this lattice."
+            raise ValueError(msg.format(lattice.dimension()))
 
     # Sanity checks for non-solid cones.
     if solid is not None and not solid:
@@ -6852,9 +6864,8 @@
             if (max_ambient_dim is not None and
                     K.lattice_dim() > max_ambient_dim):
                 return False
-        else:
-            if K.lattice() is not lattice:
-                return False
+        elif K.lattice() is not lattice:
+            return False
         return all([K.n_rays() >= min_rays,
                     max_rays is None or K.n_rays() <= max_rays,
                     solid is None or K.is_solid() == solid,
@@ -6945,17 +6956,16 @@
                         rays[i][0] = pm * (ray[0].abs() + 1)
 
                     K = Cone(rays, lattice=L)
-            else:
-                # The user requested that the cone be NOT strictly
-                # convex. So it should contain some line...
-                if K.is_strictly_convex():
-                    # ...but it doesn't. If K has at least two rays,
-                    # we can just make the second one a multiple of
-                    # the first -- then K will contain a line. If K
-                    # has fewer than two rays, we punt.
-                    if len(rays) >= 2:
-                        rays[1] = -rays[0]
-                        K = Cone(rays, lattice=L)
+            # The user requested that the cone be NOT strictly
+            # convex. So it should contain some line...
+            elif K.is_strictly_convex():
+                # ...but it doesn't. If K has at least two rays,
+                # we can just make the second one a multiple of
+                # the first -- then K will contain a line. If K
+                # has fewer than two rays, we punt.
+                if len(rays) >= 2:
+                    rays[1] = -rays[0]
+                    K = Cone(rays, lattice=L)
 
         if is_valid(K):
             # Loop if we don't have a valid cone.

src/sage/geometry/fan.py

@@ -28,9 +28,9 @@
 
 Use :func:`Fan` to construct fans "explicitly"::
 
     sage: fan = Fan(cones=[(0,1), (1,2)],
     ....:           rays=[(1,0), (0,1), (-1,0)])
     sage: fan
     Rational polyhedral fan in 2-d lattice N
 
 In addition to giving such lists of cones and rays you can also create cones
@@ -40,8 +40,8 @@
 In 2 dimensions there is a unique maximal fan determined by rays, and
 you can use :func:`Fan2d` to construct it::
 
     sage: fan2d = Fan2d(rays=[(1,0), (0,1), (-1,0)])
     sage: fan2d.is_equivalent(fan)
     True
 
 But keep in mind that in higher dimensions the cone data is essential
@@ -51,12 +51,12 @@
 <sage.geometry.lattice_polytope.LatticePolytopeClass>`:
 :func:`FaceFan` and :func:`NormalFan`::
 
     sage: fan1 = FaceFan(lattice_polytope.cross_polytope(3))
     sage: fan2 = NormalFan(lattice_polytope.cross_polytope(3))
 
 Given such "automatic" fans, you may wonder what are their rays and cones::
 
     sage: fan1.rays()
     M( 1,  0,  0),
     M( 0,  1,  0),
     M( 0,  0,  1),
@@ -64,7 +64,7 @@
     M( 0, -1,  0),
     M( 0,  0, -1)
     in 3-d lattice M
     sage: fan1.generating_cones()
     (3-d cone of Rational polyhedral fan in 3-d lattice M,
      3-d cone of Rational polyhedral fan in 3-d lattice M,
      3-d cone of Rational polyhedral fan in 3-d lattice M,
@@ -76,7 +76,7 @@
 
 The last output is not very illuminating. Let's try to improve it::
 
     sage: for cone in fan1: print(cone.rays())
     M( 0, 1, 0),
     M( 0, 0, 1),
     M(-1, 0, 0)
@@ -112,7 +112,7 @@
 
 You can also do ::
 
     sage: for cone in fan1: print(cone.ambient_ray_indices())
     (1, 2, 3)
     (2, 3, 4)
     (3, 4, 5)
@@ -233,14 +233,14 @@
 # (at your option) any later version.
 #                  https://www.gnu.org/licenses/
 # ****************************************************************************
+from __future__ import annotations
 
 from collections.abc import Callable, Container
 from copy import copy
+from typing import TYPE_CHECKING
 from warnings import warn
 
 import sage.geometry.abc
-
-from sage.structure.richcmp import richcmp_method, richcmp
 from sage.misc.lazy_import import lazy_import
 lazy_import('sage.combinat.combination', 'Combinations')
 lazy_import('sage.combinat.posets.posets', 'FinitePoset')
@@ -262,6 +262,9 @@
 from sage.rings.integer_ring import ZZ
 from sage.rings.rational_field import QQ
 
+if TYPE_CHECKING:
+    from sage.misc.sage_input import CoercionMode, SageInputBuilder, SageInputExpression
+
 
 def is_Fan(x) -> bool:
     r"""
@@ -1217,7 +1220,7 @@
         if virtual_rays is not None:
             self._virtual_rays = PointCollection(virtual_rays, self.lattice())
 
-    def _sage_input_(self, sib, coerced):
+    def _sage_input_(self, sib: SageInputBuilder, coerced: CoercionMode) -> SageInputExpression:
         """
         Return Sage command to reconstruct ``self``.
 
@@ -2487,8 +2490,8 @@
         """
         if not self.is_complete():
             raise ValueError('to be polytopal, the fan should be complete')
-        from sage.geometry.triangulation.point_configuration import PointConfiguration
         from sage.geometry.polyhedron.constructor import Polyhedron
+        from sage.geometry.triangulation.point_configuration import PointConfiguration
         pc = PointConfiguration(self.rays())
         v_pc = [tuple(p) for p in pc]
         pc_to_indices = {tuple(p):i for i, p in enumerate(pc)}
@@ -2757,8 +2760,10 @@
             sage: fan1.is_isomorphic(fan1)
             True
         """
-        from sage.geometry.fan_isomorphism import \
-            fan_isomorphic_necessary_conditions, fan_isomorphism_generator
+        from sage.geometry.fan_isomorphism import (
+            fan_isomorphic_necessary_conditions,
+            fan_isomorphism_generator,
+        )
         if not fan_isomorphic_necessary_conditions(self, other):
             return False
         if self.lattice_dim() == 2:

src/sage/geometry/lattice_polytope.py

@@ -120,24 +120,26 @@
 # (at your option) any later version.
 #                  https://www.gnu.org/licenses/
 # ****************************************************************************
+from __future__ import annotations
+
+import os
+import shlex
 from collections.abc import Hashable
 from copyreg import constructor as copyreg_constructor
 from functools import reduce
 from io import IOBase, StringIO
-from subprocess import Popen, PIPE
-from warnings import warn
-import os
-import shlex
+from subprocess import PIPE, Popen
+from typing import TYPE_CHECKING
 
+import sage.geometry.abc
 from sage.arith.misc import GCD as gcd
 from sage.features import PythonModule
-from sage.features.palp import PalpExecutable
 from sage.features.databases import DatabaseReflexivePolytopes
+from sage.features.palp import PalpExecutable
 from sage.geometry.cone import _ambient_space_point, integral_length
-from sage.geometry.point_collection import (PointCollection,
-                                            read_palp_point_collection)
-from sage.geometry.toric_lattice import ToricLattice, ToricLattice_generic
 from sage.geometry.convex_set import ConvexSet_compact
+from sage.geometry.point_collection import PointCollection, read_palp_point_collection
+from sage.geometry.toric_lattice import ToricLattice, ToricLattice_generic
 from sage.matrix.constructor import matrix
 from sage.misc.cachefunc import cached_method
 from sage.misc.flatten import flatten
@@ -149,11 +151,9 @@
 from sage.rings.rational_field import QQ
 from sage.sets.set import Set_generic
 from sage.structure.element import Matrix
-from sage.structure.richcmp import richcmp_method, richcmp
+from sage.structure.richcmp import richcmp, richcmp_method
 from sage.structure.sage_object import SageObject
 from sage.structure.sequence import Sequence
-import sage.geometry.abc
-
 
 lazy_import("sage.combinat.posets.posets", 'FinitePoset')
 lazy_import("sage.geometry.hasse_diagram", 'lattice_from_incidences')
@@ -167,6 +167,9 @@
 lazy_import('ppl', 'point', as_='PPL_point',
             feature=PythonModule("ppl", spkg='pplpy', type='standard'))
 
+if TYPE_CHECKING:
+    from sage.misc.sage_input import CoercionMode, SageInputBuilder, SageInputExpression
+
 
 class SetOfAllLatticePolytopesClass(Set_generic):
     def _repr_(self) -> str:
@@ -570,7 +573,7 @@ def __init__(self, points=None, compute_vertices=None,
             self._ambient_facet_indices = tuple(ambient_facet_indices)
             self._vertices = ambient.vertices(self._ambient_vertex_indices)
 
-    def _sage_input_(self, sib, coerced):
+    def _sage_input_(self, sib: SageInputBuilder, coerced: CoercionMode) -> SageInputExpression:
         """
         Return Sage command to reconstruct ``self``.
 
@@ -4471,7 +4474,7 @@ def _repr_(self):
             pass
         return result
 
-    def _sage_input_(self, sib, coerced):
+    def _sage_input_(self, sib: SageInputBuilder, coerced: bool) -> SageInputExpression:
         """
         Return Sage command to reconstruct ``self``.
 

src/sage/geometry/point_collection.pyx

@@ -83,6 +83,8 @@ from sage.geometry.toric_lattice import ToricLattice
 from sage.matrix.constructor import matrix
 from sage.misc.latex import latex
 
+from sage.misc.sage_input import CoercionMode, SageInputBuilder, SageInputExpression
+
 
 def is_PointCollection(x):
     r"""
@@ -172,7 +174,7 @@ cdef class PointCollection(SageObject):
         self._points = tuple(points)
         self._module = self._points[0].parent() if module is None else module
 
-    def _sage_input_(self, sib, coerced):
+    def _sage_input_(self, sib: SageInputBuilder, coerced: CoercionMode) -> SageInputExpression:
         r"""
         Return Sage command to reconstruct ``self``.
 

src/sage/geometry/polyhedron/base0.py

@@ -29,11 +29,17 @@
 # (at your option) any later version.
 #                  https://www.gnu.org/licenses/
 # ****************************************************************************
+from __future__ import annotations
 
-from sage.misc.cachefunc import cached_method
+from typing import TYPE_CHECKING
+
+import sage.geometry.abc
 from sage.misc.abstract_method import abstract_method
+from sage.misc.cachefunc import cached_method
 from sage.structure.element import Element
-import sage.geometry.abc
+
+if TYPE_CHECKING:
+    from sage.misc.sage_input import CoercionMode, SageInputBuilder, SageInputExpression
 
 
 class Polyhedron_base0(Element, sage.geometry.abc.Polyhedron):
@@ -296,7 +302,7 @@ def _delete(self):
         """
         self.parent().recycle(self)
 
-    def _sage_input_(self, sib, coerced):
+    def _sage_input_(self, sib: SageInputBuilder, coerced: CoercionMode) -> SageInputExpression:
         """
         Return Sage command to reconstruct ``self``.
 

src/sage/geometry/toric_lattice.py

@@ -144,6 +144,9 @@
 #
 #                  https://www.gnu.org/licenses/
 # ****************************************************************************
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
 
 from sage.geometry.toric_lattice_element import ToricLatticeElement
 from sage.misc.lazy_import import lazy_import
@@ -162,6 +165,9 @@
 from sage.rings.rational_field import QQ
 from sage.structure.factory import UniqueFactory
 
+if TYPE_CHECKING:
+    from sage.misc.sage_input import CoercionMode, SageInputBuilder, SageInputExpression
+
 
 def is_ToricLattice(x):
     r"""
@@ -897,7 +903,7 @@ def __init__(self, rank, name, dual_name, latex_name, latex_dual_name):
         self._latex_name = latex_name
         self._latex_dual_name = latex_dual_name
 
-    def _sage_input_(self, sib, coerced):
+    def _sage_input_(self, sib: SageInputBuilder, coerced: CoercionMode) -> SageInputExpression:
         r"""
         Return Sage command to reconstruct ``self``.
 

src/sage/matrix/matrix1.pyx

@@ -24,6 +24,7 @@ from cpython.sequence cimport PySequence_Fast
 import sage.modules.free_module
 from sage.structure.coerce cimport coercion_model
 
+from sage.misc.sage_input import CoercionMode, SageInputBuilder, SageInputExpression
 
 cdef class Matrix(Matrix0):
     ###################################################
@@ -622,7 +623,7 @@ cdef class Matrix(Matrix0):
             matrix._sage_object = self
         return matrix
 
-    def _sage_input_(self, sib, coerce):
+    def _sage_input_(self, sib: SageInputBuilder, coerced: CoercionMode) -> SageInputExpression:
         r"""
         Produce an expression which will reproduce this value when evaluated.