passagemath-environment 10.4.1__py3-none-any.whl

sage/features/all.py

@@ -0,0 +1,126 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Enumeration of all defined features
+"""
+
+# *****************************************************************************
+#       Copyright (C) 2021-2023 Matthias Koeppe
+#
+#  Distributed under the terms of the GNU General Public License (GPL)
+#  as published by the Free Software Foundation; either version 2 of
+#  the License, or (at your option) any later version.
+#                  https://www.gnu.org/licenses/
+# *****************************************************************************
+
+import itertools
+
+
+def all_features():
+    r"""
+    Return an iterable of all features.
+
+    EXAMPLES::
+
+        sage: from sage.features.all import all_features
+        sage: sorted(all_features(), key=lambda f: f.name)  # random
+        [...Feature('sage.combinat')...]
+    """
+    import pkgutil
+    import importlib
+    import sage.features
+    # Following https://packaging.python.org/guides/creating-and-discovering-plugins/#using-namespace-packages
+    for finder, name, ispkg in pkgutil.iter_modules(sage.features.__path__, sage.features.__name__ + "."):
+        module = importlib.import_module(name)
+        try:
+            af = module.all_features
+        except AttributeError:
+            pass
+        else:
+            if af != all_features:
+                yield from af()
+
+
+def module_feature(module_name):
+    r"""
+    Find a top-level :class:`Feature` that provides the Python module of the given ``module_name``.
+
+    Only features known to :func:`all_features` are considered.
+
+    INPUT:
+
+    - ``module_name`` -- string
+
+    OUTPUT: a :class:`Feature` or ``None``
+
+    EXAMPLES::
+
+        sage: from sage.features.all import module_feature
+        sage: module_feature('sage.combinat.tableau')                                   # needs sage.combinat
+        Feature('sage.combinat')
+        sage: module_feature('sage.combinat.posets.poset')                              # needs sage.graphs
+        Feature('sage.graphs')
+        sage: module_feature('sage.schemes.toric.variety')                              # needs sage.geometry.polyhedron
+        Feature('sage.geometry.polyhedron')
+        sage: module_feature('scipy')                                                   # needs scipy
+        Feature('scipy')
+        sage: print(module_feature('sage.structure.element'))
+        None
+        sage: print(module_feature('sage.does_not_exist'))
+        None
+    """
+    longest_prefix = ''
+    longest_prefix_feature = None
+    for feature in all_features():
+        for joined in itertools.chain([feature], feature.joined_features()):
+            if joined.name == module_name:
+                return feature
+            if (joined.name + '.').startswith(longest_prefix):
+                if (module_name + '.').startswith(joined.name + '.'):
+                    longest_prefix = feature.name + '.'
+                    longest_prefix_feature = feature
+    return longest_prefix_feature
+
+
+def name_feature(name, toplevel=None):
+    r"""
+    Find a top-level :class:`Feature` that provides the top-level ``name``.
+
+    Only features known to :func:`all_features` are considered.
+
+    INPUT:
+
+    - ``name`` -- string
+
+    - ``toplevel`` -- a module or other namespace
+
+    OUTPUT: a :class:`Feature` or ``None``
+
+    EXAMPLES::
+
+        sage: from sage.features.all import name_feature
+        sage: name_feature('QuadraticField')                                            # needs sage.rings.number_field
+        Feature('sage.rings.number_field')
+        sage: name_feature('line')                                                      # needs sage.plot
+        Feature('sage.plot')
+        sage: print(name_feature('ZZ'))
+        None
+        sage: print(name_feature('does_not_exist'))
+        None
+    """
+    if toplevel is None:
+        try:
+            import sage.all as toplevel
+        except ImportError:
+            return None
+    try:
+        obj = getattr(toplevel, name)
+    except AttributeError:
+        return None
+
+    from sage.misc.dev_tools import find_object_modules
+
+    for module, names in find_object_modules(obj).items():
+        if name in names and (feature := module_feature(module)):
+            return feature
+
+    return None

sage/features/bliss.py

@@ -0,0 +1,85 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Features for testing the presence of ``bliss``
+"""
+
+# *****************************************************************************
+#       Copyright (C) 2016 Julian Rüth
+#                     2018 Jeroen Demeyer
+#                     2021 Matthias Koeppe
+#
+#  Distributed under the terms of the GNU General Public License (GPL)
+#  as published by the Free Software Foundation; either version 2 of
+#  the License, or (at your option) any later version.
+#                  https://www.gnu.org/licenses/
+# *****************************************************************************
+
+from . import CythonFeature, PythonModule
+from .join_feature import JoinFeature
+
+
+TEST_CODE = """
+# distutils: language=c++
+# distutils: libraries=bliss
+
+cdef extern from "bliss/graph.hh" namespace "bliss":
+    cdef cppclass Graph:
+        Graph(const unsigned int)
+
+from cysignals.signals cimport sig_on, sig_off
+
+sig_on()
+Graph(1)
+sig_off()
+"""
+
+
+class BlissLibrary(CythonFeature):
+    r"""
+    A :class:`~sage.features.Feature` which describes whether the :ref:`Bliss library <spkg_bliss>` is
+    present and functional.
+
+    EXAMPLES::
+
+        sage: from sage.features.bliss import BlissLibrary
+        sage: BlissLibrary().require()  # optional - libbliss
+    """
+
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.bliss import BlissLibrary
+            sage: BlissLibrary()
+            Feature('libbliss')
+        """
+        CythonFeature.__init__(self, "libbliss", test_code=TEST_CODE,
+                               spkg='bliss',
+                               url='http://www.tcs.hut.fi/Software/bliss/')
+
+
+class Bliss(JoinFeature):
+    r"""
+    A :class:`~sage.features.Feature` which describes whether the :mod:`sage.graphs.bliss`
+    module is available in this installation of Sage.
+
+    EXAMPLES::
+
+        sage: from sage.features.bliss import Bliss
+        sage: Bliss().require()  # optional - bliss
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.bliss import Bliss
+            sage: Bliss()
+            Feature('bliss')
+        """
+        JoinFeature.__init__(self, "bliss",
+                             [PythonModule("sage.graphs.bliss", spkg='sagemath_bliss',
+                                           url='http://www.tcs.hut.fi/Software/bliss/')])
+
+
+def all_features():
+    return [Bliss()]

sage/features/cddlib.py

@@ -0,0 +1,38 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Feature for testing the presence of ``cddlib``
+"""
+
+# *****************************************************************************
+#       Copyright (C) 2022 Matthias Koeppe
+#
+#  Distributed under the terms of the GNU General Public License (GPL)
+#  as published by the Free Software Foundation; either version 2 of
+#  the License, or (at your option) any later version.
+#                  https://www.gnu.org/licenses/
+# *****************************************************************************
+
+from . import Executable
+
+
+class CddExecutable(Executable):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of an executable
+    which comes as a part of :ref:`cddlib <spkg_cddlib>`.
+
+    EXAMPLES::
+
+        sage: from sage.features.cddlib import CddExecutable
+        sage: CddExecutable().is_present()
+        FeatureTestResult('cddexec_gmp', True)
+    """
+    def __init__(self, name='cddexec_gmp'):
+        r"""
+        TESTS::
+
+            sage: from sage.features.cddlib import CddExecutable
+            sage: isinstance(CddExecutable(), CddExecutable)
+            True
+        """
+        Executable.__init__(self, name=name, executable=name, spkg='cddlib',
+                            url='https://github.com/cddlib/cddlib', type='standard')

sage/features/coxeter3.py

@@ -0,0 +1,45 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Features for testing the presence of ``coxeter3``
+"""
+
+# *****************************************************************************
+#       Copyright (C) 2016      Julian Rüth
+#                     2018      Jeroen Demeyer
+#                     2021-2024 Matthias Koeppe
+#
+#  Distributed under the terms of the GNU General Public License (GPL)
+#  as published by the Free Software Foundation; either version 2 of
+#  the License, or (at your option) any later version.
+#                  https://www.gnu.org/licenses/
+# *****************************************************************************
+
+from . import PythonModule
+from .join_feature import JoinFeature
+
+
+class Coxeter3(JoinFeature):
+    r"""
+    A :class:`~sage.features.Feature` which describes whether the :mod:`sage.libs.coxeter3`
+    module is available in this installation of Sage.
+
+    EXAMPLES::
+
+        sage: from sage.features.coxeter3 import Coxeter3
+        sage: Coxeter3().require()  # optional - coxeter3
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.coxeter3 import Coxeter3
+            sage: Coxeter3()
+            Feature('coxeter3')
+        """
+        JoinFeature.__init__(self, "coxeter3",
+                             [PythonModule("sage.libs.coxeter3.coxeter",
+                                           spkg='sagemath_coxeter3')])
+
+
+def all_features():
+    return [Coxeter3()]

sage/features/csdp.py

@@ -0,0 +1,83 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Feature for testing the presence of ``csdp``
+"""
+
+# *****************************************************************************
+#       Copyright (C) 2016 Julian Rüth
+#                     2018 Jeroen Demeyer
+#                     2019 David Coudert
+#                     2021 Matthias Koeppe
+#
+#  Distributed under the terms of the GNU General Public License (GPL)
+#  as published by the Free Software Foundation; either version 2 of
+#  the License, or (at your option) any later version.
+#                  https://www.gnu.org/licenses/
+# *****************************************************************************
+
+import os
+import re
+import subprocess
+
+from . import Executable, FeatureTestResult
+
+
+class CSDP(Executable):
+    r"""
+    A :class:`~sage.features.Feature` which checks for the ``theta`` binary
+    of :ref:`CSDP <spkg_csdp>`.
+
+    EXAMPLES::
+
+        sage: from sage.features.csdp import CSDP
+        sage: CSDP().is_present()  # optional - csdp
+        FeatureTestResult('csdp', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.csdp import CSDP
+            sage: isinstance(CSDP(), CSDP)
+            True
+        """
+        Executable.__init__(self, name='csdp', spkg='csdp', executable='theta',
+                                url='https://github.com/dimpase/csdp')
+
+    def is_functional(self):
+        r"""
+        Check whether ``theta`` works on a trivial example.
+
+        EXAMPLES::
+
+            sage: from sage.features.csdp import CSDP
+            sage: CSDP().is_functional()  # optional - csdp
+            FeatureTestResult('csdp', True)
+        """
+        from sage.misc.temporary_file import tmp_filename
+        from sage.cpython.string import bytes_to_str
+
+        tf_name = tmp_filename()
+        with open(tf_name, 'wb') as tf:
+            tf.write(b"2\n1\n1 1")
+        with open(os.devnull, 'wb') as devnull:
+            command = ['theta', tf_name]
+            try:
+                lines = subprocess.check_output(command, stderr=devnull)
+            except subprocess.CalledProcessError as e:
+                return FeatureTestResult(self, False,
+                    reason="Call to `{command}` failed with exit code {e.returncode}."
+                                             .format(command=" ".join(command), e=e))
+
+        result = bytes_to_str(lines).strip().split('\n')[-1]
+        match = re.match("^The Lovasz Theta Number is (.*)$", result)
+        if match is None:
+            return FeatureTestResult(self, False,
+                reason="Last line of the output of `{command}` did not have the expected format."
+                                         .format(command=" ".join(command)))
+
+        return FeatureTestResult(self, True)
+
+
+def all_features():
+    return [CSDP()]

sage/features/cython.py

@@ -0,0 +1,38 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Features for testing the presence of ``cython``
+"""
+
+# *****************************************************************************
+#       Copyright (C) 2021 Matthias Koeppe
+#
+#  Distributed under the terms of the GNU General Public License (GPL)
+#  as published by the Free Software Foundation; either version 2 of
+#  the License, or (at your option) any later version.
+#                  https://www.gnu.org/licenses/
+# *****************************************************************************
+
+from . import CythonFeature
+
+
+class sage__misc__cython(CythonFeature):
+    r"""
+    A :class:`~sage.features.Feature` which describes whether :mod:`sage.misc.cython`
+    is available and functional.
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features import CythonFeature
+            sage: from sage.features.cython import sage__misc__cython
+            sage: isinstance(sage__misc__cython(), CythonFeature)
+            True
+        """
+        # It suffices to use a trivial CythonFeature because CythonFeature
+        # is implemented via sage.misc.cython.
+        CythonFeature.__init__(self, "sage.misc.cython", test_code="")
+
+
+def all_features():
+    return [sage__misc__cython()]