vispy 0.15.0__cp312-cp312-macosx_10_13_x86_64.whl

vispy/util/wrappers.py

@@ -0,0 +1,155 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) Vispy Development Team. All Rights Reserved.
+# Distributed under the (new) BSD License. See LICENSE.txt for more info.
+"""
+Some wrappers to avoid circular imports, or make certain calls easier.
+
+The idea of a 'global' vispy.use function is that although vispy.app
+and vispy.gloo.gl can be used independently, they are not complely
+independent for some configureation. E.g. when using real ES 2.0,
+the app backend should use EGL and not a desktop OpenGL context. Also,
+we probably want it to be easy to configure vispy to use the ipython
+notebook backend, which requires specific config of both app and gl.
+
+This module does not have to be aware of the available app and gl
+backends, but it should be(come) aware of (in)compatibilities between
+them.
+"""
+
+import subprocess
+from .config import _get_args
+
+
+def use(app=None, gl=None):
+    """Set the usage options for vispy
+
+    Specify what app backend and GL backend to use.
+
+    Parameters
+    ----------
+    app : str
+        The app backend to use (case insensitive). Standard backends:
+            * 'PyQt4': use Qt widget toolkit via PyQt4.
+            * 'PyQt5': use Qt widget toolkit via PyQt5.
+            * 'PyQt6': use Qt widget toolkit via PyQt6.
+            * 'PySide': use Qt widget toolkit via PySide.
+            * 'PySide2': use Qt widget toolkit via PySide2.
+            * 'PySide6': use Qt widget toolkit via PySide6.
+            * 'PyGlet': use Pyglet backend.
+            * 'Glfw': use Glfw backend (successor of Glut). Widely available
+              on Linux.
+            * 'SDL2': use SDL v2 backend.
+            * 'osmesa': Use OSMesa backend
+        Additional backends:
+            * 'jupyter_rfb': show vispy canvases in Jupyter lab/notebook
+              (depends on the jupyter_rfb library).
+
+    gl : str
+        The gl backend to use (case insensitive). Options are:
+            * 'gl2': use Vispy's desktop OpenGL API.
+            * 'pyopengl2': use PyOpenGL's desktop OpenGL API. Mostly for
+              testing.
+            * 'es2': (TO COME) use real OpenGL ES 2.0 on Windows via Angle.
+              Availability of ES 2.0 is larger for Windows, since it relies
+              on DirectX.
+            * 'gl+': use the full OpenGL functionality available on
+              your system (via PyOpenGL).
+
+    Notes
+    -----
+    If the app option is given, ``vispy.app.use_app()`` is called. If
+    the gl option is given, ``vispy.gloo.use_gl()`` is called.
+
+    If an app backend name is provided, and that backend could not be
+    loaded, an error is raised.
+
+    If no backend name is provided, Vispy will first check if the GUI
+    toolkit corresponding to each backend is already imported, and try
+    that backend first. If this is unsuccessful, it will try the
+    'default_backend' provided in the vispy config. If still not
+    succesful, it will try each backend in a predetermined order.
+
+    See Also
+    --------
+    vispy.app.use_app
+    vispy.gloo.gl.use_gl
+    """
+    if app is None and gl is None:
+        raise TypeError('Must specify at least one of "app" or "gl".')
+
+    if app == 'osmesa':
+        from ..util.osmesa_gl import fix_osmesa_gl_lib
+        fix_osmesa_gl_lib()
+        if gl is not None:
+            raise ValueError("Do not specify gl when using osmesa")
+
+    # Apply now
+    if gl:
+        from .. import gloo, config
+        config['gl_backend'] = gl
+        gloo.gl.use_gl(gl)
+    if app:
+        from ..app import use_app
+        use_app(app)
+
+
+def run_subprocess(command, return_code=False, **kwargs):
+    """Run command using subprocess.Popen
+
+    Run command and wait for command to complete. If the return code was zero
+    then return, otherwise raise CalledProcessError.
+    By default, this will also add stdout= and stderr=subproces.PIPE
+    to the call to Popen to suppress printing to the terminal.
+
+    Parameters
+    ----------
+    command : list of str
+        Command to run as subprocess (see subprocess.Popen documentation).
+    return_code : bool
+        If True, the returncode will be returned, and no error checking
+        will be performed (so this function should always return without
+        error).
+    **kwargs : dict
+        Additional kwargs to pass to ``subprocess.Popen``.
+
+    Returns
+    -------
+    stdout : str
+        Stdout returned by the process.
+    stderr : str
+        Stderr returned by the process.
+    code : int
+        The command exit code. Only returned if ``return_code`` is True.
+    """
+    # code adapted with permission from mne-python
+    use_kwargs = dict(stderr=subprocess.PIPE, stdout=subprocess.PIPE)
+    use_kwargs.update(kwargs)
+
+    p = subprocess.Popen(command, **use_kwargs)
+    output = p.communicate()
+
+    # communicate() may return bytes, str, or None depending on the kwargs
+    # passed to Popen(). Convert all to unicode str:
+    output = ['' if s is None else s for s in output]
+    output = [s.decode('utf-8') if isinstance(s, bytes) else s for s in output]
+    output = tuple(output)
+
+    if not return_code and p.returncode:
+        print(output[0])
+        print(output[1])
+        err_fun = subprocess.CalledProcessError.__init__
+        if 'output' in _get_args(err_fun):
+            raise subprocess.CalledProcessError(p.returncode, command, output)
+        else:
+            raise subprocess.CalledProcessError(p.returncode, command)
+    if return_code:
+        output = output + (p.returncode,)
+    return output
+
+
+def test(*args, **kwargs):
+    """Proxy function to delay `.testing` import"""
+    from vispy.testing import test as _test  # noqa
+    return _test(*args, **kwargs)
+
+test.__test__ = False  # no discover test function as test

vispy/version.py

@@ -0,0 +1,21 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.15.0'
+__version_tuple__ = version_tuple = (0, 15, 0)

vispy/visuals/__init__.py

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) Vispy Development Team. All Rights Reserved.
+# Distributed under the (new) BSD License. See LICENSE.txt for more info.
+"""
+This module provides a library of Visual classes, which are drawable objects
+intended to encapsulate simple graphic objects such as lines, meshes, points,
+2D shapes, images, text, etc.
+
+These classes define only the OpenGL machinery and connot be used directly in
+a scenegraph. For scenegraph use, see the complementary Visual+Node classes
+defined in vispy.scene.
+"""
+
+from .axis import AxisVisual  # noqa
+from .box import BoxVisual  # noqa
+from .cube import CubeVisual  # noqa
+from .ellipse import EllipseVisual  # noqa
+from .gridlines import GridLinesVisual  # noqa
+from .image import ImageVisual  # noqa
+from .image_complex import ComplexImageVisual  # noqa
+from .gridmesh import GridMeshVisual  # noqa
+from .histogram import HistogramVisual  # noqa
+from .infinite_line import InfiniteLineVisual  # noqa
+from .instanced_mesh import InstancedMeshVisual  # noqa
+from .isocurve import IsocurveVisual  # noqa
+from .isoline import IsolineVisual  # noqa
+from .isosurface import IsosurfaceVisual  # noqa
+from .line import LineVisual, ArrowVisual  # noqa
+from .linear_region import LinearRegionVisual  # noqa
+from .line_plot import LinePlotVisual  # noqa
+from .markers import MarkersVisual  # noqa
+from .mesh import MeshVisual  # noqa
+from .mesh_normals import MeshNormalsVisual  # noqa
+from .plane import PlaneVisual  # noqa
+from .polygon import PolygonVisual  # noqa
+from .rectangle import RectangleVisual  # noqa
+from .regular_polygon import RegularPolygonVisual  # noqa
+from .scrolling_lines import ScrollingLinesVisual  # noqa
+from .spectrogram import SpectrogramVisual  # noqa
+from .sphere import SphereVisual  # noqa
+from .surface_plot import SurfacePlotVisual  # noqa
+from .text import TextVisual  # noqa
+from .tube import TubeVisual  # noqa
+from .visual import BaseVisual, Visual, CompoundVisual  # noqa
+from .volume import VolumeVisual  # noqa
+from .xyz_axis import XYZAxisVisual  # noqa
+from .border import _BorderVisual  # noqa
+from .colorbar import ColorBarVisual  # noqa
+from .graphs import GraphVisual  # noqa
+from .windbarb import WindbarbVisual  # noqa