passagemath-environment 10.4.1__py3-none-any.whl

sage/features/gap.py

@@ -0,0 +1,86 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Features for testing the presence of the SageMath interfaces to ``gap`` and of GAP packages
+"""
+# *****************************************************************************
+#       Copyright (C) 2016 Julian Rüth
+#                     2018 Jeroen Demeyer
+#
+#  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 Feature, FeatureTestResult, PythonModule
+from .join_feature import JoinFeature
+from .sagemath import sage__libs__gap
+
+class GapPackage(Feature):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of a GAP package.
+
+    A GAP package is "present" if it *can be* loaded, not if it *has
+    been* loaded.
+
+    .. SEEALSO::
+
+        :class:`Feature sage.libs.gap <~sage.features.sagemath.sage__libs__gap>`
+
+    EXAMPLES::
+
+        sage: from sage.features.gap import GapPackage
+        sage: GapPackage("grape", spkg='gap_packages')
+        Feature('gap_package_grape')
+    """
+    def __init__(self, package, **kwds):
+        r"""
+        TESTS::
+
+            sage: from sage.features.gap import GapPackage
+            sage: isinstance(GapPackage("grape", spkg='gap_packages'), GapPackage)
+            True
+        """
+        Feature.__init__(self, f"gap_package_{package}", **kwds)
+        self.package = package
+
+    def _is_present(self):
+        r"""
+        Return whether or not the GAP package is present.
+
+        If the package is installed but not yet loaded, it is loaded
+        first. This does *not* check that the package is functional.
+
+        EXAMPLES::
+
+            sage: from sage.features.gap import GapPackage
+            sage: GapPackage("grape", spkg='gap_packages')._is_present()  # optional - gap_package_grape
+            FeatureTestResult('gap_package_grape', True)
+        """
+        try:
+            from sage.libs.gap.libgap import libgap
+        except ImportError:
+            return FeatureTestResult(self, False,
+                                     reason="sage.libs.gap is not available")
+
+        # This returns "true" even if the package is already loaded.
+        command = 'LoadPackage("{package}")'.format(package=self.package)
+        presence = libgap.eval(command)
+
+        if presence:
+            return FeatureTestResult(self, True,
+                    reason="`{command}` evaluated to `{presence}` in GAP.".format(command=command, presence=presence))
+        else:
+            return FeatureTestResult(self, False,
+                    reason="`{command}` evaluated to `{presence}` in GAP.".format(command=command, presence=presence))
+
+
+def all_features():
+    return [GapPackage("atlasrep", spkg='gap_packages'),
+            GapPackage("design", spkg='gap_packages'),
+            GapPackage("grape", spkg='gap_packages'),
+            GapPackage("guava", spkg='gap_packages'),
+            GapPackage("hap", spkg='gap_packages'),
+            GapPackage("polycyclic", spkg='gap_packages'),
+            GapPackage("qpa", spkg='gap_packages'),
+            GapPackage("quagroup", spkg='gap_packages')]

sage/features/gfan.py

@@ -0,0 +1,38 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Features for testing the presence of ``gfan``
+"""
+
+# *****************************************************************************
+#       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 GfanExecutable(Executable):
+    r"""
+    A :class:`~sage.features.Feature` for the :ref:`gfan <spkg_gfan>` executables.
+    """
+    def __init__(self, cmd=None):
+        r"""
+        TESTS::
+
+            sage: from sage.features.gfan import GfanExecutable
+            sage: isinstance(GfanExecutable('groebnercone'), GfanExecutable)
+            True
+        """
+        if cmd is None:
+            name = "gfan"
+        else:
+            name = f"gfan_{cmd}"
+        Executable.__init__(self, name, executable=name, spkg='gfan', type='standard')
+
+
+def all_features():
+    return [GfanExecutable()]

sage/features/giac.py

@@ -0,0 +1,30 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Feature for testing the presence of ``giac``
+"""
+
+from . import Executable, FeatureTestResult
+
+class Giac(Executable):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of :ref:`giac <spkg_giac>`.
+
+    EXAMPLES::
+
+        sage: from sage.features.giac import Giac
+        sage: Giac().is_present()  # needs giac
+        FeatureTestResult('giac', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.giac import Giac
+            sage: isinstance(Giac(), Giac)
+            True
+        """
+        Executable.__init__(self, 'giac', executable='giac',
+                            spkg='giac', type='standard')
+
+def all_features():
+    return [Giac()]

sage/features/graph_generators.py

@@ -0,0 +1,171 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Features for testing the presence of graph generator programs ``benzene``, ``buckygen``, ``plantri``
+"""
+
+# *****************************************************************************
+#       Copyright (C) 2016 Julian Rüth
+#                     2018 Jeroen Demeyer
+#                     2019 Frédéric Chapoton
+#                     2021 Matthias Koeppe
+#                     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
+import subprocess
+
+from . import Executable, FeatureTestResult
+
+
+class Plantri(Executable):
+    r"""
+    A :class:`~sage.features.Feature` which checks for the :ref:`plantri <spkg_plantri>` binary.
+
+    EXAMPLES::
+
+        sage: from sage.features.graph_generators import Plantri
+        sage: Plantri().is_present()  # optional - plantri
+        FeatureTestResult('plantri', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.graph_generators import Plantri
+            sage: isinstance(Plantri(), Plantri)
+            True
+        """
+        Executable.__init__(self, name='plantri', spkg='plantri',
+                            executable='plantri',
+                            url='http://users.cecs.anu.edu.au/~bdm/plantri/')
+
+    def is_functional(self):
+        r"""
+        Check whether ``plantri`` works on trivial input.
+
+        EXAMPLES::
+
+            sage: from sage.features.graph_generators import Plantri
+            sage: Plantri().is_functional()  # optional - plantri
+            FeatureTestResult('plantri', True)
+        """
+        command = ["plantri", "4"]
+        try:
+            lines = subprocess.check_output(command, stderr=subprocess.STDOUT)
+        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"1 triangulations written"
+        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)
+
+
+class Buckygen(Executable):
+    r"""
+    A :class:`~sage.features.Feature` which checks for the :ref:`buckygen <spkg_buckygen>` binary.
+
+    EXAMPLES::
+
+        sage: from sage.features.graph_generators import Buckygen
+        sage: Buckygen().is_present()  # optional - buckygen
+        FeatureTestResult('buckygen', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.graph_generators import Buckygen
+            sage: isinstance(Buckygen(), Buckygen)
+            True
+        """
+        Executable.__init__(self, name='buckygen', spkg='buckygen',
+                            executable='buckygen',
+                            url='http://caagt.ugent.be/buckygen/')
+
+    def is_functional(self):
+        r"""
+        Check whether ``buckygen`` works on trivial input.
+
+        EXAMPLES::
+
+            sage: from sage.features.graph_generators import Buckygen
+            sage: Buckygen().is_functional()  # optional - buckygen
+            FeatureTestResult('buckygen', True)
+        """
+        command = ["buckygen", "-d", "22d"]
+        try:
+            lines = subprocess.check_output(command, stderr=subprocess.STDOUT)
+        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"Number of fullerenes generated with 13 vertices: 0"
+        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)
+
+
+class Benzene(Executable):
+    r"""
+    A :class:`~sage.features.Feature` which checks for the :ref:`benzene <spkg_benzene>`
+    binary.
+
+    EXAMPLES::
+
+        sage: from sage.features.graph_generators import Benzene
+        sage: Benzene().is_present()  # optional - benzene
+        FeatureTestResult('benzene', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.graph_generators import Benzene
+            sage: isinstance(Benzene(), Benzene)
+            True
+        """
+        Executable.__init__(self, name='benzene', spkg='benzene',
+                            executable='benzene',
+                            url='http://www.grinvin.org/')
+
+    def is_functional(self):
+        r"""
+        Check whether ``benzene`` works on trivial input.
+
+        EXAMPLES::
+
+            sage: from sage.features.graph_generators import Benzene
+            sage: Benzene().is_functional()  # optional - benzene
+            FeatureTestResult('benzene', True)
+        """
+        devnull = open(os.devnull, 'wb')
+        command = ["benzene", "2", "p"]
+        try:
+            lines = subprocess.check_output(command, stderr=devnull)
+        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">>planar_code<<"
+        if not lines.startswith(expected):
+            return FeatureTestResult(self, False,
+                    reason="Call `{command}` did not produce output that started with `{expected}`.".format(command=" ".join(command), expected=expected))
+
+        return FeatureTestResult(self, True)
+
+
+def all_features():
+    return [Plantri(),
+            Buckygen(),
+            Benzene()]

sage/features/graphviz.py

@@ -0,0 +1,117 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Features for testing the presence of ``graphviz``
+"""
+
+# ****************************************************************************
+#       Copyright (C) 2018 Sebastien Labbe <slabqc@gmail.com>
+#                     2021 Matthias Koeppe
+#
+# 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 .join_feature import JoinFeature
+
+
+class dot(Executable):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of ``dot``.
+
+    TESTS::
+
+        sage: from sage.features.graphviz import dot
+        sage: dot().is_present()  # optional - graphviz
+        FeatureTestResult('dot', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.graphviz import dot
+            sage: isinstance(dot(), dot)
+            True
+        """
+        Executable.__init__(self, 'dot', executable='dot',
+                            spkg='graphviz',
+                            url='https://www.graphviz.org/')
+
+
+class neato(Executable):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of ``neato``.
+
+    TESTS:
+
+        sage: from sage.features.graphviz import neato
+        sage: neato().is_present()  # optional - graphviz
+        FeatureTestResult('neato', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.graphviz import neato
+            sage: isinstance(neato(), neato)
+            True
+        """
+        Executable.__init__(self, 'neato', executable='neato',
+                            spkg='graphviz',
+                            url='https://www.graphviz.org/')
+
+
+class twopi(Executable):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of ``twopi``.
+
+    TESTS::
+
+        sage: from sage.features.graphviz import twopi
+        sage: twopi().is_present()  # optional - graphviz
+        FeatureTestResult('twopi', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.graphviz import twopi
+            sage: isinstance(twopi(), twopi)
+            True
+        """
+        Executable.__init__(self, 'twopi', executable='twopi',
+                            spkg='graphviz',
+                            url='https://www.graphviz.org/')
+
+
+class Graphviz(JoinFeature):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of
+    the :class:`dot`, :class:`neato`, and :class:`twopi` executables from the
+    :ref:`graphviz <spkg_graphviz>` package.
+
+    EXAMPLES::
+
+        sage: from sage.features.graphviz import Graphviz
+        sage: Graphviz().is_present()  # optional - graphviz
+        FeatureTestResult('graphviz', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.graphviz import Graphviz
+            sage: isinstance(Graphviz(), Graphviz)
+            True
+        """
+        JoinFeature.__init__(self, 'graphviz',
+                             [dot(), neato(), twopi()],
+                             spkg='graphviz',
+                             url='https://www.graphviz.org/')
+
+
+def all_features():
+    return [Graphviz()]

sage/features/igraph.py

@@ -0,0 +1,44 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Check for igraph
+"""
+
+# ****************************************************************************
+#       Copyright (C) 2021 Matthias Koeppe
+#
+# 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 PythonModule
+from .join_feature import JoinFeature
+
+
+class python_igraph(JoinFeature):
+    r"""
+    A :class:`sage.features.Feature` describing the presence of the
+    Python package :ref:`igraph <spkg_python_igraph>`.
+
+    EXAMPLES::
+
+        sage: from sage.features.igraph import python_igraph
+        sage: python_igraph().is_present()                    # optional - python_igraph
+        FeatureTestResult('python_igraph', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.igraph import python_igraph
+            sage: isinstance(python_igraph(), python_igraph)
+            True
+        """
+        JoinFeature.__init__(self, 'python_igraph',
+                             [PythonModule('igraph', spkg='python_igraph',
+                                            url='http://igraph.org')])
+
+def all_features():
+    return [python_igraph()]

sage/features/imagemagick.py

@@ -0,0 +1,138 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Feature for testing the presence of ``imagemagick``
+
+Currently we only check for the presence of ``convert`` or ``magick``. When needed, other
+commands like ``magick-script``, ``mogrify``,
+``identify``, ``composite``, ``montage``, ``compare``, etc. could be also
+checked in this module.
+"""
+
+# ****************************************************************************
+#       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
+from .join_feature import JoinFeature
+
+class Magick(Executable):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of ``magick`` or the deprecated ``convert``.
+
+    EXAMPLES::
+
+        sage: from sage.features.imagemagick import Magick
+        sage: Magick().is_present()  # optional - imagemagick
+        FeatureTestResult('magick', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.imagemagick import Magick
+            sage: isinstance(Magick(), Magick)
+            True
+        """
+        Executable.__init__(self, 'magick', executable='magick')
+        try:
+            _ = self.absolute_filename()
+        except RuntimeError:
+            Executable.__init__(self, 'magick', executable='convert')
+
+    def is_functional(self):
+        r"""
+        Return whether command ``magick`` or ``convert`` in the path is functional.
+
+        EXAMPLES::
+
+            sage: from sage.features.imagemagick import Magick
+            sage: Magick().is_functional()   # optional - imagemagick
+            FeatureTestResult('magick', 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)
+        filename_gif = filename + '.gif'
+
+        # running command magick/convert (taken from sage/plot/animate.py)
+        from subprocess import run
+        cmd = [self.executable, '-dispose', 'Background', '-delay', '20',
+                '-loop', '0', filename_png, filename_gif]
+
+        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)
+
+
+class ImageMagick(JoinFeature):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of
+    :ref:`ImageMagick <spkg_imagemagick>`
+
+    Currently, only the availability of the :class:`magick` (or :class:`convert`) program is checked.
+
+    EXAMPLES::
+
+        sage: from sage.features.imagemagick import ImageMagick
+        sage: ImageMagick().is_present()  # optional - imagemagick
+        FeatureTestResult('imagemagick', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.imagemagick import ImageMagick
+            sage: isinstance(ImageMagick(), ImageMagick)
+            True
+        """
+        JoinFeature.__init__(self, 'imagemagick',
+                             [Magick()],
+                             spkg='imagemagick',
+                             url='https://www.imagemagick.org/')
+
+def all_features():
+    return [ImageMagick()]