Add typing info for _sage_input_

Author: tobiasdiez

src/sage/geometry/cone.py

@@ -201,9 +201,9 @@
 # (at your option) any later version.
 #                  https://www.gnu.org/licenses/
 # ****************************************************************************
-
 from collections.abc import Hashable, Iterable, Container
 from copy import copy
+from typing import TYPE_CHECKING, Literal
 from warnings import warn
 
 from sage.misc.lazy_import import lazy_import
@@ -241,6 +241,9 @@
 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 SageInputBuilder, SageInputExpression
+
 
 def is_Cone(x):
     r"""
@@ -1500,7 +1503,7 @@ def __init__(self, rays=None, lattice=None,
         if PPL is not None:
             self._PPL_C_Polyhedron = PPL
 
-    def _sage_input_(self, sib, coerced):
+    def _sage_input_(self, sib: SageInputBuilder, coerced: bool | Literal[2]) -> SageInputExpression:
         """
         Return Sage command to reconstruct ``self``.
 

src/sage/geometry/fan.py

@@ -233,9 +233,9 @@
 # (at your option) any later version.
 #                  https://www.gnu.org/licenses/
 # ****************************************************************************
-
 from collections.abc import Callable, Container
 from copy import copy
+from typing import TYPE_CHECKING, Literal
 from warnings import warn
 
 import sage.geometry.abc
@@ -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 SageInputBuilder, SageInputExpression
+
 
 def is_Fan(x) -> bool:
     r"""
@@ -1217,7 +1220,7 @@ def __init__(self, cones, rays, lattice,
         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: bool | Literal[2]) -> SageInputExpression:
         """
         Return Sage command to reconstruct ``self``.
 

src/sage/geometry/lattice_polytope.py

@@ -120,24 +120,24 @@
 # (at your option) any later version.
 #                  https://www.gnu.org/licenses/
 # ****************************************************************************
+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, Literal
 
+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 +149,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 +165,9 @@
 lazy_import('ppl', 'point', as_='PPL_point',
             feature=PythonModule("ppl", spkg='pplpy', type='standard'))
 
+if TYPE_CHECKING:
+    from sage.misc.sage_input import SageInputBuilder, SageInputExpression
+
 
 class SetOfAllLatticePolytopesClass(Set_generic):
     def _repr_(self) -> str:
@@ -570,7 +571,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: bool | Literal[2]) -> SageInputExpression:
         """
         Return Sage command to reconstruct ``self``.
 
@@ -4443,7 +4444,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 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: bool | Literal[2]) -> SageInputExpression:
         r"""
         Return Sage command to reconstruct ``self``.
 

src/sage/geometry/polyhedron/base0.py

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

src/sage/geometry/toric_lattice.py

@@ -144,7 +144,7 @@
 #
 #                  https://www.gnu.org/licenses/
 # ****************************************************************************
-
+from typing import TYPE_CHECKING, Literal
 from sage.geometry.toric_lattice_element import ToricLatticeElement
 from sage.misc.lazy_import import lazy_import
 lazy_import('sage.geometry.toric_plotter', 'ToricPlotter')
@@ -162,6 +162,9 @@
 from sage.rings.rational_field import QQ
 from sage.structure.factory import UniqueFactory
 
+if TYPE_CHECKING:
+    from sage.misc.sage_input import SageInputBuilder, SageInputExpression
+
 
 def is_ToricLattice(x):
     r"""
@@ -897,7 +900,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: bool | Literal[2]) -> 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 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: bool | Literal[2]) -> SageInputExpression:
         r"""
         Produce an expression which will reproduce this value when evaluated.
 

src/sage/misc/explain_pickle.py

@@ -152,23 +152,24 @@
 # (at your option) any later version.
 #                  http://www.gnu.org/licenses/
 # *****************************************************************************
-
-
+import bz2 as comp_other
 import pickletools
 import re
 import sys
 import types
-
 import zlib as comp
-import bz2 as comp_other
-
 from pickletools import genops
-
-from sage.misc.sage_input import SageInputBuilder, SageInputExpression
+from typing import Literal
+
+from sage.misc.persist import (
+    SageUnpickler,
+    dumps,
+    register_unpickle_override,
+    unpickle_global,
+    unpickle_override,
+)
 from sage.misc.sage_eval import sage_eval
-from sage.misc.persist import (unpickle_override, unpickle_global, dumps,
-                               register_unpickle_override, SageUnpickler)
-
+from sage.misc.sage_input import SageInputBuilder, SageInputExpression
 
 # Python 3 does not have a "ClassType". Instead, we ensure that
 # isinstance(foo, ClassType) will always return False.
@@ -358,7 +359,7 @@ def __init__(self, value, expression):
         self.expression = expression
         self.immutable = False
 
-    def _sage_input_(self, sib, coerced):
+    def _sage_input_(self, sib: SageInputBuilder, coerced: bool | Literal[2]) -> SageInputExpression:
         r"""
         Extracts the expression from a PickleObject, and sets the immutable
         flag.
@@ -845,14 +846,13 @@ def _APPENDS_helper(self, lst, slice):
                 else:
                     for s in slice:
                         self.sib.command(lst, self.sib.name('list').append(lst, self.sib(s)))
+            elif self.pedantic:
+                app = self.sib(lst).append
+                for s in slice:
+                    self.sib.command(lst, app(self.sib(s)))
             else:
-                if self.pedantic:
-                    app = self.sib(lst).append
-                    for s in slice:
-                        self.sib.command(lst, app(self.sib(s)))
-                else:
-                    for s in slice:
-                        self.sib.command(lst, self.sib(lst).append(self.sib(s)))
+                for s in slice:
+                    self.sib.command(lst, self.sib(lst).append(self.sib(s)))
         else:
             self.sib.command(lst, self.sib.name('unpickle_appends')(self.sib(lst), slice_exp))
         self.push(lst)
@@ -2509,7 +2509,7 @@ def unpickle_extension(code):
         <class 'sage.misc.explain_pickle.EmptyNewstyleClass'>
         sage: remove_extension('sage.misc.explain_pickle', 'EmptyNewstyleClass', 42)
     """
-    from copyreg import _inverted_registry, _extension_cache
+    from copyreg import _extension_cache, _inverted_registry
     # copied from .get_extension() in pickle.py
     nil = []
     obj = _extension_cache.get(code, nil)

src/sage/misc/sage_input.py

@@ -172,6 +172,7 @@
 # (at your option) any later version.
 #                  https://www.gnu.org/licenses/
 # ****************************************************************************
+from typing import Literal
 
 from sage.misc.lazy_import import lazy_import
 
@@ -343,7 +344,7 @@ def __init__(self, allow_locals=False, preparse=True):
         self._next_local = 1
         self._locals = {}
 
-    def __call__(self, x, coerced=False):
+    def __call__(self, x, coerced: bool | Literal[2] = False):
         r"""
         Try to convert an arbitrary value ``x`` into a
         :class:`SageInputExpression` (an SIE).
@@ -477,11 +478,10 @@ def __call__(self, x, coerced=False):
                     return SIE_literal_stringrep(self, str(x) + 'r')
             elif self._preparse is False:
                 return self.int(x)
+            elif x < 0:
+                return -self.name('int')(self.int(-x))
             else:
-                if x < 0:
-                    return -self.name('int')(self.int(-x))
-                else:
-                    return self.name('int')(self.int(x))
+                return self.name('int')(self.int(x))
 
         if isinstance(x, float):
             # floats could often have prettier output,
@@ -499,8 +499,8 @@ def __call__(self, x, coerced=False):
                     return -SIE_literal_stringrep(self, str(-x))
                 else:
                     return SIE_literal_stringrep(self, str(x))
-            from sage.rings.real_mpfr import RR
             from sage.rings.integer_ring import ZZ
+            from sage.rings.real_mpfr import RR
             rrx = RR(x)
             if rrx in ZZ and abs(rrx) < (1 << 53):
                 return self.name('float')(self.int(ZZ(rrx)))
@@ -593,7 +593,7 @@ def float_str(self, n):
         """
         return SIE_literal_stringrep(self, n)
 
-    def name(self, n):
+    def name(self, n) -> SageInputExpression:
         r"""
         Given a string representing a Python name,
         produces a :class:`SageInputExpression` for that name.
@@ -2228,11 +2228,10 @@ def _sie_format(self, sif):
         values = [sif.format(val, 0) for val in self._sie_values]
         if self._sie_is_list:
             return '[%s]' % ', '.join(values), _prec_atomic
+        elif len(values) == 1:
+            return '(%s,)' % values[0], _prec_atomic
         else:
-            if len(values) == 1:
-                return '(%s,)' % values[0], _prec_atomic
-            else:
-                return '(%s)' % ', '.join(values), _prec_atomic
+            return '(%s)' % ', '.join(values), _prec_atomic
 
 
 class SIE_dict(SageInputExpression):

src/sage/modules/free_module_element.pyx

@@ -128,6 +128,7 @@ from sage.rings.abc import RealDoubleField, ComplexDoubleField
 
 from sage.rings.integer cimport Integer, smallInteger
 from sage.arith.numerical_approx cimport digits_to_bits
+from sage.misc.sage_input import SageInputBuilder, SageInputExpression
 
 # For the norm function, we cache Sage integers 1 and 2
 __one__ = smallInteger(1)
@@ -1258,7 +1259,7 @@ cdef class FreeModuleElement(Vector):   # abstract base class
             return self
         return self.change_ring(R)
 
-    def _sage_input_(self, sib, coerce):
+    def _sage_input_(self, sib: SageInputBuilder, coerced: bool | Literal[2]) -> SageInputExpression:
         r"""
         Produce an expression which will reproduce this value when evaluated.