passagemath-environment 10.4.1__py3-none-any.whl

sage/features/databases.py

@@ -0,0 +1,302 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Features for testing the presence of various databases
+"""
+
+# *****************************************************************************
+#       Copyright (C) 2016      Julian Rüth
+#                     2018-2019 Jeroen Demeyer
+#                     2018      Timo Kaufmann
+#                     2020-2022 Matthias Koeppe
+#                     2020-2022 Sebastian Oehms
+#                     2021      Kwankyu Lee
+#
+#  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
+
+from . import StaticFile, PythonModule
+from sage.env import SAGE_DATA_PATH
+
+
+def sage_data_path(data_name):
+    r"""
+    Search path for database `data_name`.
+
+    EXAMPLES::
+
+        sage: from sage.features.databases import sage_data_path
+        sage: sage_data_path("cremona")
+        ['.../cremona']
+    """
+    if not SAGE_DATA_PATH:
+        return []
+
+    return [os.path.join(p, data_name)
+            for p in SAGE_DATA_PATH.split(os.pathsep)]
+
+
+class DatabaseCremona(StaticFile):
+    r"""
+    A :class:`~sage.features.Feature` which describes the presence of :ref:`John Cremona's
+    database of elliptic curves <spkg_database_cremona_ellcurve>`.
+
+    INPUT:
+
+    - ``name`` -- either ``'cremona'`` (the default) for the full large
+      database or ``'cremona_mini'`` for the small database
+
+    EXAMPLES::
+
+        sage: from sage.features.databases import DatabaseCremona
+        sage: DatabaseCremona('cremona_mini', type='standard').is_present()
+        FeatureTestResult('database_cremona_mini_ellcurve', True)
+        sage: DatabaseCremona().is_present()                                    # optional - database_cremona_ellcurve
+        FeatureTestResult('database_cremona_ellcurve', True)
+    """
+    def __init__(self, name='cremona', spkg='database_cremona_ellcurve', type='optional'):
+        r"""
+        TESTS::
+
+            sage: from sage.features.databases import DatabaseCremona
+            sage: isinstance(DatabaseCremona(), DatabaseCremona)
+            True
+        """
+        from sage.env import CREMONA_MINI_DATA_DIR, CREMONA_LARGE_DATA_DIR
+        CREMONA_DATA_DIRS = set([CREMONA_MINI_DATA_DIR, CREMONA_LARGE_DATA_DIR])
+        CREMONA_DATA_DIRS.discard(None)
+        search_path = CREMONA_DATA_DIRS or sage_data_path("cremona")
+
+        spkg = "database_cremona_ellcurve"
+        spkg_type = "optional"
+        if name == 'cremona_mini':
+            spkg = "elliptic_curves"
+            spkg_type = "standard"
+
+        StaticFile.__init__(self, f"database_{name}_ellcurve",
+                            filename=f"{name}.db",
+                            search_path=search_path,
+                            spkg=spkg,
+                            type=spkg_type,
+                            url='https://github.com/JohnCremona/ecdata',
+                            description="Cremona's database of elliptic curves")
+
+
+class DatabaseEllcurves(StaticFile):
+    r"""
+    A :class:`~sage.features.Feature` which describes the presence of
+    William Stein's database of interesting curves.
+
+    EXAMPLES::
+
+        sage: from sage.features.databases import DatabaseEllcurves
+        sage: bool(DatabaseEllcurves().is_present())  # optional - database_ellcurves
+        True
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.databases import DatabaseEllcurves
+            sage: isinstance(DatabaseEllcurves(), DatabaseEllcurves)
+            True
+        """
+        from sage.env import ELLCURVE_DATA_DIR
+        search_path = ELLCURVE_DATA_DIR or sage_data_path("ellcurves")
+
+        StaticFile.__init__(self, "database_ellcurves",
+                            filename='rank0',
+                            search_path=search_path,
+                            spkg='elliptic_curves',
+                            type='standard',
+                            description="William Stein's database of interesting curve")
+
+
+class DatabaseGraphs(StaticFile):
+    r"""
+    A :class:`~sage.features.Feature` which describes the presence of
+    the graphs database.
+
+    EXAMPLES::
+
+        sage: from sage.features.databases import DatabaseGraphs
+        sage: bool(DatabaseGraphs().is_present())  # optional - database_graphs
+        True
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.databases import DatabaseGraphs
+            sage: isinstance(DatabaseGraphs(), DatabaseGraphs)
+            True
+        """
+        from sage.env import GRAPHS_DATA_DIR
+        search_path = GRAPHS_DATA_DIR or sage_data_path("graphs")
+
+        StaticFile.__init__(self, "database_graphs",
+                            filename='graphs.db',
+                            search_path=search_path,
+                            spkg='graphs',
+                            type='standard',
+                            description="A database of graphs")
+
+
+class DatabaseJones(StaticFile):
+    r"""
+    A :class:`~sage.features.Feature` which describes the presence of
+    :ref:`John Jones's tables of number fields <spkg_database_jones_numfield>`.
+
+    EXAMPLES::
+
+        sage: from sage.features.databases import DatabaseJones
+        sage: bool(DatabaseJones().is_present())  # optional - database_jones_numfield
+        True
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.databases import DatabaseJones
+            sage: isinstance(DatabaseJones(), DatabaseJones)
+            True
+        """
+        StaticFile.__init__(self, "database_jones_numfield",
+                            filename='jones.sobj',
+                            search_path=sage_data_path("jones"),
+                            spkg='database_jones_numfield',
+                            description="John Jones's tables of number fields")
+
+
+class DatabaseKnotInfo(PythonModule):
+    r"""
+    A :class:`~sage.features.Feature` which describes the presence of the
+    :ref:`package providing the KnotInfo and LinkInfo databases <spkg_database_knotinfo>`.
+
+    The homes of these databases are the
+    web-pages `KnotInfo <https://knotinfo.math.indiana.edu/>`__ and
+    `LinkInfo <https://linkinfo.sitehost.iu.edu>`__.
+
+    EXAMPLES::
+
+        sage: from sage.features.databases import DatabaseKnotInfo
+        sage: DatabaseKnotInfo().is_present()  # optional - database_knotinfo
+        FeatureTestResult('database_knotinfo', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.databases import DatabaseKnotInfo
+            sage: isinstance(DatabaseKnotInfo(), DatabaseKnotInfo)
+            True
+        """
+        PythonModule.__init__(self, 'database_knotinfo', spkg='database_knotinfo')
+
+
+class DatabaseMatroids(PythonModule):
+    r"""
+    A :class:`~sage.features.Feature` which describes the presence of
+    :ref:`Yoshitake Matsumoto's Database of Matroids <spkg_matroid_database>`.
+
+    EXAMPLES::
+
+        sage: from sage.features.databases import DatabaseMatroids
+        sage: DatabaseMatroids().is_present()                                           # optional - matroid_database
+        FeatureTestResult('matroid_database', True)
+
+    REFERENCES:
+
+    [Mat2012]_
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.databases import DatabaseMatroids
+            sage: isinstance(DatabaseMatroids(), DatabaseMatroids)
+            True
+        """
+        PythonModule.__init__(self, 'matroid_database', spkg='matroid_database')
+
+
+class DatabaseCubicHecke(PythonModule):
+    r"""
+    A :class:`~sage.features.Feature` which describes the presence of the
+    :ref:`Cubic Hecke algebra database package <spkg_database_cubic_hecke>`.
+
+    The home of this database is the
+    web-page `Cubic Hecke algebra on 4 strands <http://www.lamfa.u-picardie.fr/marin/representationH4-en.html>`__
+    of Ivan Marin.
+
+    EXAMPLES::
+
+        sage: from sage.features.databases import DatabaseCubicHecke
+        sage: DatabaseCubicHecke().is_present()  # optional - database_cubic_hecke
+        FeatureTestResult('database_cubic_hecke', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.databases import DatabaseCubicHecke
+            sage: isinstance(DatabaseCubicHecke(), DatabaseCubicHecke)
+            True
+        """
+        PythonModule.__init__(self, 'database_cubic_hecke', spkg='database_cubic_hecke')
+
+
+class DatabaseReflexivePolytopes(StaticFile):
+    r"""
+    A :class:`~sage.features.Feature` which describes the presence of the
+    :ref:`PALP databases of reflexive three-dimensional <spkg_polytopes_db>`
+    and :ref:`four-dimensional lattice polytopes <spkg_polytopes_db_4d>`.
+
+    EXAMPLES::
+
+        sage: from sage.features.databases import DatabaseReflexivePolytopes
+        sage: bool(DatabaseReflexivePolytopes().is_present())                   # optional - polytopes_db
+        True
+        sage: bool(DatabaseReflexivePolytopes('polytopes_db_4d').is_present())  # optional - polytopes_db_4d
+        True
+    """
+    def __init__(self, name='polytopes_db'):
+        """
+        TESTS::
+
+            sage: from sage.features.databases import DatabaseReflexivePolytopes
+            sage: isinstance(DatabaseReflexivePolytopes(), DatabaseReflexivePolytopes)
+            True
+            sage: DatabaseReflexivePolytopes().filename
+            'Full3d'
+            sage: DatabaseReflexivePolytopes('polytopes_db_4d').filename
+            'Hodge4d'
+        """
+        from sage.env import POLYTOPE_DATA_DIR
+        search_path = POLYTOPE_DATA_DIR or sage_data_path("reflexive_polytopes")
+
+        dirname = "Full3d"
+        if name == "polytopes_db_4d":
+            dirname = "Hodge4d"
+
+        StaticFile.__init__(self, name,
+                            filename=dirname,
+                            search_path=search_path)
+
+
+def all_features():
+    return [PythonModule('conway_polynomials', spkg='conway_polynomials', type='standard'),
+            DatabaseCremona(),
+            DatabaseCremona('cremona_mini', type='standard'),
+            DatabaseEllcurves(),
+            DatabaseGraphs(),
+            DatabaseJones(),
+            DatabaseKnotInfo(),
+            DatabaseMatroids(),
+            DatabaseCubicHecke(),
+            DatabaseReflexivePolytopes(),
+            DatabaseReflexivePolytopes('polytopes_db_4d')]

sage/features/dvipng.py

@@ -0,0 +1,40 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Feature for testing the presence of ``dvipng``
+"""
+# ****************************************************************************
+#       Copyright (C) 2021 Sebastien Labbe <slabqc@gmail.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License 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 dvipng(Executable):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of ``dvipng``.
+
+    EXAMPLES::
+
+        sage: from sage.features.dvipng import dvipng
+        sage: dvipng().is_present()             # optional - dvipng
+        FeatureTestResult('dvipng', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.dvipng import dvipng
+            sage: isinstance(dvipng(), dvipng)
+            True
+        """
+        Executable.__init__(self, 'dvipng', executable='dvipng',
+                            url='https://savannah.nongnu.org/projects/dvipng/')
+
+
+def all_features():
+    return [dvipng()]

sage/features/ecm.py

@@ -0,0 +1,42 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Feature for testing the presence of ``ecm`` or ``gmp-ecm``
+"""
+# ****************************************************************************
+#       Copyright (C) 2032 Dima Pasechnik <dima@pasechnik.info>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License 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
+from sage.env import SAGE_ECMBIN
+
+
+class Ecm(Executable):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of :ref:`GMP-ECM <spkg_ecm>`.
+
+    EXAMPLES::
+
+        sage: from sage.features.ecm import Ecm
+        sage: Ecm().is_present()
+        FeatureTestResult('ecm', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.ecm import Ecm
+            sage: isinstance(Ecm(), Ecm)
+            True
+        """
+        Executable.__init__(self, name='ecm', executable=SAGE_ECMBIN,
+                            spkg='ecm', type='standard')
+
+
+def all_features():
+    return [Ecm()]

sage/features/ffmpeg.py

@@ -0,0 +1,119 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Feature for testing the presence of ``ffmpeg``
+"""
+# ****************************************************************************
+#       Copyright (C) 2018-2022 Sebastien Labbe <slabqc@gmail.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License 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, FeatureTestResult
+
+class FFmpeg(Executable):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of :ref:`ffmpeg <spkg_ffmpeg>`.
+
+    EXAMPLES::
+
+        sage: from sage.features.ffmpeg import FFmpeg
+        sage: FFmpeg().is_present()  # optional - ffmpeg
+        FeatureTestResult('ffmpeg', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.ffmpeg import FFmpeg
+            sage: isinstance(FFmpeg(), FFmpeg)
+            True
+        """
+        Executable.__init__(self, 'ffmpeg', executable='ffmpeg',
+                            spkg='ffmpeg',
+                            url='https://www.ffmpeg.org/')
+
+    def is_functional(self):
+        r"""
+        Return whether command ``ffmpeg`` in the path is functional.
+
+        EXAMPLES::
+
+            sage: from sage.features.ffmpeg import FFmpeg
+            sage: FFmpeg().is_functional()   # optional - ffmpeg
+            FeatureTestResult('ffmpeg', True)
+        """
+        # Create the content of 1-pixel png file
+        content = b'\x89PNG\r\n\x1a\n\x00\x00\x00\rIHDR\x00\x00\x00\x01\x00\x00\x00\x01\x08\x00\x00\x00\x00:~\x9bU\x00\x00\x00\nIDATx\x9cc`\x00\x00\x00\x02\x00\x01H\xaf\xa4q\x00\x00\x00\x00IEND\xaeB`\x82'
+
+        # NOTE:
+        #
+        # This is how the above content of a 1 pixel PNG was created::
+        #
+        #    sage: import numpy as np
+        #    sage: from PIL import Image
+        #    sage: image = Image.fromarray(np.array([[100]], dtype=np.uint8))
+        #    sage: image.save('file.png')
+        #    sage: with open('file.png', 'rb') as f:
+        #    ....:     content = f.read()
+
+        # create a png file with the content
+        from sage.misc.temporary_file import tmp_filename
+        base_filename_png = tmp_filename(ext='.png')
+        with open(base_filename_png, 'wb') as f:
+            f.write(content)
+
+        # Set up filenames
+        import os
+        base, filename_png = os.path.split(base_filename_png)
+        filename, _png = os.path.splitext(filename_png)
+
+        # Setting a list of commands (taken from sage/plot/animate.py)
+        # The `-nostdin` is needed to avoid the command to hang, see
+        # https://stackoverflow.com/questions/16523746/ffmpeg-hangs-when-run-in-background
+        commands = []
+        for ext in ['.avi', '.flv', '.gif', '.mkv', '.mov', #'.mpg',
+                '.mp4', '.ogg', '.ogv', '.webm', '.wmv']:
+
+            cmd = ['ffmpeg', '-nostdin', '-y', '-f', 'image2', '-r', '5',
+                    '-i', filename_png, '-pix_fmt', 'rgb24', '-loop', '0',
+                    filename + ext]
+            commands.append(cmd)
+
+        for ext in ['.avi', '.flv', '.gif', '.mkv', '.mov', '.mpg',
+                '.mp4', '.ogg', '.ogv', '.webm', '.wmv']:
+
+            cmd = ['ffmpeg', '-nostdin', '-y', '-f', 'image2', '-i',
+                    filename_png, filename + ext]
+            commands.append(cmd)
+
+        # Running the commands and reporting any issue encountered
+        from subprocess import run
+        for cmd in commands:
+            try:
+                result = run(cmd, cwd=base, capture_output=True, text=True)
+            except OSError as e:
+                return FeatureTestResult(self, False, reason='Running command "{}" '
+                            'raised an OSError "{}" '.format(' '.join(cmd), e))
+
+            # If an error occurred, return False
+            if result.returncode:
+                return FeatureTestResult(self, False, reason='Running command "{}" '
+                            'returned nonzero exit status "{}" with stderr '
+                            '"{}" and stdout "{}".'.format(result.args,
+                                                            result.returncode,
+                                                            result.stderr.strip(),
+                                                            result.stdout.strip()))
+
+        # If necessary, run more tests here
+        # ...
+
+        # The command seems functional
+        return FeatureTestResult(self, True)
+
+
+def all_features():
+    return [FFmpeg()]

sage/features/four_ti_2.py

@@ -0,0 +1,55 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Features for testing the presence of ``4ti2``
+"""
+
+from . import Executable
+from .join_feature import JoinFeature
+
+
+class FourTi2Executable(Executable):
+    r"""
+    A :class:`~sage.features.Feature` for the :ref:`4ti2 <spkg_4ti2>` executables.
+    """
+    def __init__(self, name):
+        r"""
+        TESTS::
+
+            sage: from sage.features.four_ti_2 import FourTi2Executable
+            sage: isinstance(FourTi2Executable('hilbert'), FourTi2Executable)
+            True
+        """
+        from sage.env import SAGE_ENV
+        Executable.__init__(self,
+                            name="4ti2-" + name,
+                            executable=SAGE_ENV.get("FOURTITWO_" + name.upper(), None) or name,
+                            spkg='4ti2')
+
+
+class FourTi2(JoinFeature):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of all :ref:`4ti2 <spkg_4ti2>` executables.
+
+    EXAMPLES::
+
+        sage: from sage.features.four_ti_2 import FourTi2
+        sage: FourTi2().is_present()  # optional - 4ti2
+        FeatureTestResult('4ti2', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.four_ti_2 import FourTi2
+            sage: isinstance(FourTi2(), FourTi2)
+            True
+        """
+        JoinFeature.__init__(self, '4ti2',
+                             [FourTi2Executable(x)
+                              # same list is tested in build/pkgs/4ti2/spkg-configure.m4
+                              for x in ('hilbert', 'markov', 'graver', 'zsolve', 'qsolve',
+                                        'rays', 'ppi', 'circuits', 'groebner')])
+
+
+def all_features():
+    return [FourTi2()]

sage/features/fricas.py

@@ -0,0 +1,66 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Features for testing the presence of ``fricas``
+"""
+
+# *****************************************************************************
+#       Copyright (C) 2023 Dima Pasechnik
+#
+#  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 subprocess
+from . import Executable, FeatureTestResult
+
+class FriCAS(Executable):
+    r"""
+    A :class:`~sage.features.Feature` which checks for the :ref:`fricas <fricas>` binary.
+
+    EXAMPLES::
+
+        sage: from sage.features.fricas import FriCAS
+        sage: FriCAS().is_present()  # optional - fricas
+        FeatureTestResult('fricas', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.fricas import FriCAS
+            sage: isinstance(FriCAS(), FriCAS)
+            True
+        """
+        Executable.__init__(self, name='fricas', spkg='fricas',
+                            executable='fricas',
+                            url='https://fricas.github.io')
+
+    def is_functional(self):
+        r"""
+        Check whether ``fricas`` works on trivial input.
+
+        EXAMPLES::
+
+            sage: from sage.features.fricas import FriCAS
+            sage: FriCAS().is_functional()  # optional - fricas
+            FeatureTestResult('fricas', True)
+        """
+        command = ['fricas -nosman -eval ")quit"']
+        try:
+            lines = subprocess.check_output(command, stderr=subprocess.STDOUT, shell=True)
+        except subprocess.CalledProcessError as e:
+            return FeatureTestResult(self, False,
+                    reason="Call `{command}` failed with exit code {e.returncode}".format(command=" ".join(command), e=e))
+
+        expected = b"FriCAS"
+        if lines.find(expected) == -1:
+            return FeatureTestResult(self, False,
+                    reason="Call `{command}` did not produce output which contains `{expected}`".format(command=" ".join(command), expected=expected))
+
+        return FeatureTestResult(self, True)
+
+def all_features():
+    return [FriCAS()]