passagemath-environment 10.4.1__py3-none-any.whl

sage/features/latex.py

@@ -0,0 +1,300 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Features for testing the presence of ``latex`` and equivalent programs
+"""
+
+# ****************************************************************************
+#       Copyright (C) 2021 Sebastien Labbe <slabqc@gmail.com>
+#                     2021 Matthias Koeppe
+#                     2022 Kwankyu Lee
+#                     2022 Sebastian Oehms
+#
+# 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 StaticFile, Executable, FeatureTestResult, FeatureNotPresentError
+
+latex_url = 'https://www.latex-project.org/'
+latex_spkg = 'texlive'
+
+
+class LaTeX(Executable):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of ``latex``.
+
+    EXAMPLES::
+
+        sage: from sage.features.latex import latex
+        sage: latex().is_present()             # optional - latex
+        FeatureTestResult('latex', True)
+    """
+    def __init__(self, name):
+        r"""
+        TESTS::
+
+            sage: from sage.features.latex import latex
+            sage: isinstance(latex(), latex)
+            True
+        """
+        super().__init__(name, executable=name, spkg=latex_spkg, url=latex_url)
+
+    def is_functional(self):
+        r"""
+        Return whether ``latex`` in the path is functional.
+
+        EXAMPLES::
+
+            sage: from sage.features.latex import latex
+            sage: latex().is_functional()             # optional - latex
+            FeatureTestResult('latex', True)
+
+        When the feature is not functional, more information on the reason
+        can be obtained as follows::
+
+            sage: result = latex().is_functional()    # not tested
+            sage: print(result.reason)                # not tested
+            Running latex on a sample file
+            (with command='latex -interaction=nonstopmode tmp_wmpos8ak.tex')
+            returned nonzero exit status='1' with stderr=''
+            and stdout='This is pdfTeX,
+            ...
+            Runaway argument?
+            {document
+            ! File ended while scanning use of \end.
+            ...
+            No pages of output.
+            Transcript written on tmp_wmpos8ak.log.'
+        """
+        lines = []
+        lines.append(r"\documentclass{article}")
+        lines.append(r"\begin{document}")
+        lines.append(r"$\alpha+2$")
+        lines.append(r"\end{document}")
+        content = '\n'.join(lines)
+
+        # create a simple tex file with the content
+        from sage.misc.temporary_file import tmp_filename
+        base_filename_tex = tmp_filename(ext='.tex')
+        with open(base_filename_tex, 'w') as f:
+            f.write(content)
+        import os
+        base, filename_tex = os.path.split(base_filename_tex)
+
+        # running latex
+        from subprocess import run
+        cmd = [self.name, '-interaction=nonstopmode', filename_tex]
+        cmd = ' '.join(cmd)
+        result = run(cmd, shell=True, cwd=base, capture_output=True, text=True)
+
+        # return
+        if result.returncode == 0:
+            return FeatureTestResult(self, True)
+        else:
+            return FeatureTestResult(self, False, reason="Running latex on "
+                                     "a sample file (with command='{}') returned nonzero "
+                                     "exit status='{}' with stderr='{}' "
+                                     "and stdout='{}'".format(result.args,
+                                                              result.returncode,
+                                                              result.stderr.strip(),
+                                                              result.stdout.strip()))
+
+
+class latex(LaTeX):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of ``latex``.
+
+    EXAMPLES::
+
+        sage: from sage.features.latex import latex
+        sage: latex().is_present()             # optional - latex
+        FeatureTestResult('latex', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.latex import latex
+            sage: isinstance(latex(), latex)
+            True
+        """
+        super().__init__("latex")
+
+
+class pdflatex(LaTeX):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of ``pdflatex``.
+
+    EXAMPLES::
+
+        sage: from sage.features.latex import pdflatex
+        sage: pdflatex().is_present()             # optional - pdflatex
+        FeatureTestResult('pdflatex', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.latex import pdflatex
+            sage: isinstance(pdflatex(), pdflatex)
+            True
+        """
+        super().__init__("pdflatex")
+
+
+class xelatex(LaTeX):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of ``xelatex``.
+
+    EXAMPLES::
+
+        sage: from sage.features.latex import xelatex
+        sage: xelatex().is_present()             # optional - xelatex
+        FeatureTestResult('xelatex', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.latex import xelatex
+            sage: isinstance(xelatex(), xelatex)
+            True
+        """
+        super().__init__("xelatex")
+
+
+class lualatex(LaTeX):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of ``lualatex``.
+
+    EXAMPLES::
+
+        sage: from sage.features.latex import lualatex
+        sage: lualatex().is_present()             # optional - lualatex
+        FeatureTestResult('lualatex', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.latex import lualatex
+            sage: isinstance(lualatex(), lualatex)
+            True
+        """
+        super().__init__("lualatex")
+
+
+class dvips(Executable):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of ``dvips``.
+
+    EXAMPLES::
+
+        sage: from sage.features.latex import dvips
+        sage: dvips().is_present()             # optional - dvips
+        FeatureTestResult('dvips', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.latex import dvips
+            sage: isinstance(dvips(), dvips)
+            True
+        """
+        Executable.__init__(self, 'dvips', executable='dvips',
+                            url='https://tug.org/texinfohtml/dvips.html')
+
+class TeXFile(StaticFile):
+    r"""
+    A :class:`sage.features.Feature` describing the presence of a TeX file.
+
+    EXAMPLES::
+
+        sage: from sage.features.latex import TeXFile
+        sage: TeXFile('x', 'x.tex').is_present()  # optional - latex
+        FeatureTestResult('x', True)
+    """
+    def __init__(self, name, filename, **kwds):
+        r"""
+        Initialize.
+
+        TESTS::
+
+            sage: from sage.features.latex import TeXFile
+            sage: TeXFile('nonexisting', 'xxxxxx-nonexisting-file.tex').is_present()  # optional - latex
+            FeatureTestResult('nonexisting', False)
+        """
+        StaticFile.__init__(self, name, filename, search_path=[], **kwds)
+
+    def absolute_filename(self) -> str:
+        r"""
+        The absolute path of the file.
+
+        EXAMPLES::
+
+            sage: from sage.features.latex import TeXFile
+            sage: feature = TeXFile('latex_class_article', 'article.cls')
+            sage: feature.absolute_filename()  # optional - latex
+            '.../latex/base/article.cls'
+        """
+        from subprocess import run, CalledProcessError, PIPE
+        try:
+            proc = run(['kpsewhich', self.filename],
+                       capture_output=True, text=True, check=True)
+            return proc.stdout.strip()
+        except CalledProcessError:
+            reason = "{filename!r} not found by kpsewhich".format(filename=self.filename)
+            raise FeatureNotPresentError(self, reason)
+
+    def _is_present(self):
+        r"""
+        Test for the presence of the TeX file.
+
+        EXAMPLES::
+
+            sage: from sage.features.latex import LaTeXPackage, latex
+            sage: f = LaTeXPackage("tkz-graph")
+            sage: g = latex()
+            sage: not f.is_present() or bool(g.is_present())  # indirect doctest
+            True
+        """
+        return latex().is_present() and super()._is_present()
+
+
+class LaTeXPackage(TeXFile):
+    r"""
+    A :class:`sage.features.Feature` describing the presence of a LaTeX package
+    (``.sty`` file).
+
+    EXAMPLES::
+
+        sage: from sage.features.latex import LaTeXPackage
+        sage: LaTeXPackage('graphics').is_present()  # optional - latex
+        FeatureTestResult('latex_package_graphics', True)
+    """
+    @staticmethod
+    def __classcall__(cls, package_name, **kwds):
+        """
+        TESTS::
+
+            sage: from sage.features.latex import LaTeXPackage
+            sage: LaTeXPackage('graphics') is LaTeXPackage('graphics')
+            True
+        """
+        return TeXFile.__classcall__(cls,
+                                     f'latex_package_{package_name}'.replace('-', '_'),
+                                     f'{package_name}.sty',
+                                     **kwds)
+
+
+def all_features():
+    return [latex(),
+            pdflatex(),
+            xelatex(),
+            lualatex(),
+            dvips(),
+            LaTeXPackage("tkz-graph")]

sage/features/latte.py

@@ -0,0 +1,85 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Features for testing the presence of ``latte_int``
+"""
+
+# ****************************************************************************
+#       Copyright (C) 2018 Vincent Delecroix
+#                     2019 Frédéric Chapoton
+#                     2021 Matthias Koeppe
+#                     2021 Kwankyu Lee
+#
+# 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
+
+
+LATTE_URL = "https://www.math.ucdavis.edu/~latte/software.php"
+
+
+class Latte_count(Executable):
+    r"""
+    Feature for the executable ``count`` from :ref:`LattE integrale <spkg_latte_int>`.
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.latte import Latte_count
+            sage: isinstance(Latte_count(), Latte_count)
+            True
+        """
+        Executable.__init__(self, 'count', executable='count',
+                            spkg='latte_int',
+                            url=LATTE_URL)
+
+
+class Latte_integrate(Executable):
+    r"""
+    Feature for the executable ``integrate`` from :ref:`LattE integrale <spkg_latte_int>`.
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.latte import Latte_integrate
+            sage: isinstance(Latte_integrate(), Latte_integrate)
+            True
+        """
+        Executable.__init__(self, 'integrate', executable='integrate',
+                            spkg='latte_int',
+                            url=LATTE_URL)
+
+
+class Latte(JoinFeature):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of excecutables
+    from :ref:`LattE integrale <spkg_latte_int>`.
+
+    EXAMPLES::
+
+        sage: from sage.features.latte import Latte
+        sage: Latte().is_present()  # optional - latte_int
+        FeatureTestResult('latte_int', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.latte import Latte
+            sage: isinstance(Latte(), Latte)
+            True
+        """
+        JoinFeature.__init__(self, 'latte_int',
+                             (Latte_count(), Latte_integrate()),
+                             description='LattE')
+
+
+def all_features():
+    return [Latte()]

sage/features/lrs.py

@@ -0,0 +1,164 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Feature for testing the presence of ``lrslib``
+"""
+
+# *****************************************************************************
+#       Copyright (C) 2016      Julian Rüth
+#                     2018      Jeroen Demeyer
+#                     2021-2022 Matthias Koeppe
+#                     2021      Kwankyu Lee
+#                     2022      Sébastien Labbé
+#
+#  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 subprocess
+
+from . import Executable, FeatureTestResult
+from .join_feature import JoinFeature
+
+
+class Lrs(Executable):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of the ``lrs``
+    binary which comes as a part of ``lrslib``.
+
+    EXAMPLES::
+
+        sage: from sage.features.lrs import Lrs
+        sage: Lrs().is_present()  # optional - lrslib
+        FeatureTestResult('lrs', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.lrs import Lrs
+            sage: isinstance(Lrs(), Lrs)
+            True
+        """
+        Executable.__init__(self, "lrs", executable='lrs', spkg='lrslib',
+                            url='http://cgm.cs.mcgill.ca/~avis/C/lrs.html')
+
+    def is_functional(self):
+        r"""
+        Test whether ``lrs`` works on a trivial input.
+
+        EXAMPLES::
+
+            sage: from sage.features.lrs import Lrs
+            sage: Lrs().is_functional()  # optional - lrslib
+            FeatureTestResult('lrs', True)
+        """
+        from sage.misc.temporary_file import tmp_filename
+
+        tf_name = tmp_filename()
+        with open(tf_name, 'w') as tf:
+            tf.write("V-representation\nbegin\n 1 1 rational\n 1 \nend\nvolume")
+        command = [self.absolute_filename(), tf_name]
+        try:
+            result = subprocess.run(command, capture_output=True, text=True)
+        except OSError as e:
+            return FeatureTestResult(self, False, reason='Running command "{}" '
+                        'raised an OSError "{}" '.format(' '.join(command), e))
+
+        if result.returncode:
+            return FeatureTestResult(self, False,
+                reason="Call to `{command}` failed with exit code {result.returncode}.".format(command=" ".join(command), result=result))
+
+        expected_list = ["Volume= 1", "Volume=1"]
+        if all(result.stdout.find(expected) == -1 for expected in expected_list):
+            return FeatureTestResult(self, False,
+                reason="Output of `{command}` did not contain the expected result {expected}; output: {result.stdout}".format(
+                    command=" ".join(command),
+                    expected=" or ".join(expected_list),
+                    result=result))
+
+        return FeatureTestResult(self, True)
+
+
+class LrsNash(Executable):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of the ``lrsnash``
+    binary which comes as a part of ``lrslib``.
+
+    EXAMPLES::
+
+        sage: from sage.features.lrs import LrsNash
+        sage: LrsNash().is_present()  # optional - lrslib
+        FeatureTestResult('lrsnash', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.lrs import LrsNash
+            sage: isinstance(LrsNash(), LrsNash)
+            True
+        """
+        Executable.__init__(self, "lrsnash", executable='lrsnash', spkg='lrslib',
+                            url='http://cgm.cs.mcgill.ca/~avis/C/lrs.html')
+
+    def is_functional(self):
+        r"""
+        Test whether ``lrsnash`` works on a trivial input.
+
+        EXAMPLES::
+
+            sage: from sage.features.lrs import LrsNash
+            sage: LrsNash().is_functional()  # optional - lrslib
+            FeatureTestResult('lrsnash', True)
+        """
+        from sage.misc.temporary_file import tmp_filename
+
+        # Checking whether `lrsnash` can handle the new input format
+        # This test is currently done in build/pkgs/lrslib/spkg-configure.m4
+        tf_name = tmp_filename()
+        with open(tf_name, 'w') as tf:
+            tf.write("1 1\n \n 0\n \n 0\n")
+        command = [self.absolute_filename(), tf_name]
+        try:
+            result = subprocess.run(command, capture_output=True, text=True)
+        except OSError as e:
+            return FeatureTestResult(self, False, reason='Running command "{}" '
+                        'raised an OSError "{}" '.format(' '.join(command), e))
+        if result.returncode:
+            return FeatureTestResult(self, False, reason='Running command "{}" '
+                        'returned nonzero exit status "{}" with stderr '
+                        '"{}" and stdout "{}".'.format(' '.join(result.args),
+                                                        result.returncode,
+                                                        result.stderr.strip(),
+                                                        result.stdout.strip()))
+
+        return FeatureTestResult(self, True)
+
+
+class Lrslib(JoinFeature):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of the executables
+    :class:`lrs <Lrs>` and :class:`lrsnash <LrsNash>` provided by the :ref:`lrslib <spkg_lrslib>` package.
+
+    EXAMPLES::
+
+        sage: from sage.features.lrs import Lrslib
+        sage: Lrslib().is_present()  # optional - lrslib
+        FeatureTestResult('lrslib', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.lrs import Lrslib
+            sage: isinstance(Lrslib(), Lrslib)
+            True
+        """
+        JoinFeature.__init__(self, "lrslib",
+                             (Lrs(), LrsNash()))
+
+
+def all_features():
+    return [Lrslib()]

sage/features/mcqd.py

@@ -0,0 +1,45 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Features for testing the presence of ``mcqd``
+"""
+
+# *****************************************************************************
+#       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 PythonModule
+from .join_feature import JoinFeature
+
+
+class Mcqd(JoinFeature):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of the :mod:`~sage.graphs.mcqd` module,
+    which is the SageMath interface to the :ref:`mcqd <spkg_mcqd>` library
+
+    EXAMPLES::
+
+        sage: from sage.features.mcqd import Mcqd
+        sage: Mcqd().is_present()  # optional - mcqd
+        FeatureTestResult('mcqd', True)
+    """
+
+    def __init__(self):
+        """
+        TESTS::
+
+            sage: from sage.features.mcqd import Mcqd
+            sage: isinstance(Mcqd(), Mcqd)
+            True
+        """
+        JoinFeature.__init__(self, 'mcqd',
+                             [PythonModule('sage.graphs.mcqd',
+                                           spkg='sagemath_mcqd')])
+
+
+def all_features():
+    return [Mcqd()]

sage/features/meataxe.py

@@ -0,0 +1,46 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Feature for testing the presence of ``meataxe``
+"""
+
+# *****************************************************************************
+#       Copyright (C) 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/
+# *****************************************************************************
+
+
+from . import PythonModule
+from .join_feature import JoinFeature
+
+
+class Meataxe(JoinFeature):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of the Sage modules
+    that depend on the :ref:`meataxe <spkg_meataxe>` library.
+
+    EXAMPLES::
+
+        sage: from sage.features.meataxe import Meataxe
+        sage: Meataxe().is_present()  # optional - meataxe
+        FeatureTestResult('meataxe', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.meataxe import Meataxe
+            sage: isinstance(Meataxe(), Meataxe)
+            True
+        """
+        JoinFeature.__init__(self, 'meataxe',
+                             [PythonModule('sage.matrix.matrix_gfpn_dense',
+                                           spkg='sagemath_meataxe')])
+
+
+def all_features():
+    return [Meataxe()]