def test(label='full', extra_arg_string='', coverage=False):
"""Test vispy software
Parameters
----------
label : str
Can be one of 'full', 'unit', 'nobackend', 'extra', 'lineendings',
'flake', 'docs', or any backend name (e.g., 'qt').
extra_arg_string : str
Extra arguments to sent to ``pytest``.
coverage : bool
If True, collect coverage data.
"""
if label == 'osmesa':
# Special case for OSMesa, we have to modify the VISPY_GL_LIB envvar
# before the vispy.gloo package gets imported
from vispy.util.osmesa_gl import fix_osmesa_gl_lib
fix_osmesa_gl_lib()
from vispy.app.backends import BACKEND_NAMES as backend_names
label = label.lower()
label = 'pytest' if label == 'nose' else label
known_types = [
'full', 'unit', 'lineendings', 'extra', 'flake', 'docs', 'nobackend',
'examples'
]
if label not in known_types + backend_names:
raise ValueError('label must be one of %s, or a backend name %s, '
'not \'%s\'' % (known_types, backend_names, label))
# figure out what we actually need to run
runs = []
if label in ('full', 'unit'):
for backend in backend_names:
runs.append(
[partial(_unit, backend, extra_arg_string, coverage), backend])
elif label in backend_names:
runs.append([partial(_unit, label, extra_arg_string, coverage), label])
if label in ('full', 'unit', 'nobackend'):
runs.append([
partial(_unit, 'nobackend', extra_arg_string, coverage),
'nobackend'
])
if label == "examples":
# take the extra arguments so that specific examples can be run
runs.append([partial(_examples, extra_arg_string), 'examples'])
elif label == 'full':
# run all the examples
runs.append([partial(_examples, ""), 'examples'])
if label in ('full', 'extra', 'lineendings'):
runs.append([_check_line_endings, 'lineendings'])
if label in ('full', 'extra', 'flake'):
runs.append([_flake, 'flake'])
if label in ('extra', 'docs'):
runs.append([_docs, 'docs'])
t0 = time()
fail = []
skip = []
for run in runs:
try:
run[0]()
except RuntimeError as exp:
print('Failed: %s' % str(exp))
fail += [run[1]]
except SkipTest:
skip += [run[1]]
except Exception as exp:
# this should only happen if we've screwed up the test setup
fail += [run[1]]
print('Failed strangely (%s): %s\n' % (type(exp), str(exp)))
import traceback
type_, value, tb = sys.exc_info()
traceback.print_exception(type_, value, tb)
else:
print('Passed\n')
sys.stdout.flush()
dt = time() - t0
stat = '%s failed, %s skipped' % (fail if fail else 0, skip if skip else 0)
extra = 'failed' if fail else 'succeeded'
print('Testing %s (%s) in %0.3f seconds' % (extra, stat, dt))
sys.stdout.flush()
if len(fail) > 0:
raise RuntimeError('FAILURE')
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.
* 'PySide': use Qt widget toolkit via PySide.
* '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:
* 'ipynb_vnc': render in the IPython notebook via a VNC approach
(experimental)
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".')
# Example for future. This wont work (yet).
if app == 'ipynb_webgl':
app = 'headless'
gl = 'webgl'
if app == 'osmesa':
from vispy.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:
import vispy.gloo
from vispy import config
config['gl_backend'] = gl
vispy.gloo.gl.use_gl(gl)
if app:
import vispy.app
vispy.app.use_app(app)
def test(label='full', extra_arg_string='', coverage=False):
"""Test vispy software
Parameters
----------
label : str
Can be one of 'full', 'unit', 'nobackend', 'extra', 'lineendings',
'flake', 'docs', or any backend name (e.g., 'qt').
extra_arg_string : str
Extra arguments to sent to ``pytest``.
coverage : bool
If True, collect coverage data.
"""
if label == 'osmesa':
# Special case for OSMesa, we have to modify the VISPY_GL_LIB envvar
# before the vispy.gloo package gets imported
from vispy.util.osmesa_gl import fix_osmesa_gl_lib
fix_osmesa_gl_lib()
from vispy.app.backends import BACKEND_NAMES as backend_names
label = label.lower()
label = 'pytest' if label == 'nose' else label
known_types = ['full', 'unit', 'lineendings', 'extra', 'flake',
'docs', 'nobackend', 'examples']
if label not in known_types + backend_names:
raise ValueError('label must be one of %s, or a backend name %s, '
'not \'%s\'' % (known_types, backend_names, label))
# figure out what we actually need to run
runs = []
if label in ('full', 'unit'):
for backend in backend_names:
runs.append([partial(_unit, backend, extra_arg_string, coverage),
backend])
elif label in backend_names:
runs.append([partial(_unit, label, extra_arg_string, coverage), label])
if label in ('full', 'unit', 'nobackend'):
runs.append([partial(_unit, 'nobackend', extra_arg_string, coverage),
'nobackend'])
if label == "examples":
# take the extra arguments so that specific examples can be run
runs.append([partial(_examples, extra_arg_string),
'examples'])
elif label == 'full':
# run all the examples
runs.append([partial(_examples, ""), 'examples'])
if label in ('full', 'extra', 'lineendings'):
runs.append([_check_line_endings, 'lineendings'])
if label in ('full', 'extra', 'flake'):
runs.append([_flake, 'flake'])
if label in ('extra', 'docs'):
runs.append([_docs, 'docs'])
t0 = time()
fail = []
skip = []
for run in runs:
try:
run[0]()
except RuntimeError as exp:
print('Failed: %s' % str(exp))
fail += [run[1]]
except SkipTest:
skip += [run[1]]
except Exception as exp:
# this should only happen if we've screwed up the test setup
fail += [run[1]]
print('Failed strangely (%s): %s\n' % (type(exp), str(exp)))
import traceback
type_, value, tb = sys.exc_info()
traceback.print_exception(type_, value, tb)
else:
print('Passed\n')
sys.stdout.flush()
dt = time() - t0
stat = '%s failed, %s skipped' % (fail if fail else 0, skip if skip else 0)
extra = 'failed' if fail else 'succeeded'
print('Testing %s (%s) in %0.3f seconds' % (extra, stat, dt))
sys.stdout.flush()
if len(fail) > 0:
raise RuntimeError('FAILURE')
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.
* 'PySide': use Qt widget toolkit via PySide.
* '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:
* 'ipynb_vnc': render in the IPython notebook via a VNC approach
(experimental)
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".')
# Example for future. This wont work (yet).
if app == 'ipynb_webgl':
app = 'headless'
gl = 'webgl'
if app == 'osmesa':
from vispy.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:
import vispy.gloo
from vispy import config
config['gl_backend'] = gl
vispy.gloo.gl.use_gl(gl)
if app:
import vispy.app
vispy.app.use_app(app)
