''' Functions to help with testing Bokeh and reporting issues.
'''
from __future__ import absolute_import, print_function
import codecs
import errno
import os
import shutil
import sys
import tempfile
def makedirs_ok_if_exists(path):
try:
os.makedirs(path)
except IOError as e: # pragma: no cover (py3 only)
if e.errno != errno.EEXIST:
raise e
except OSError as e: # pragma: no cover (py2 only)
if e.errno != errno.EEXIST:
raise e
return path
local_tmp = os.path.abspath("./build/tmp")
makedirs_ok_if_exists(local_tmp)
class WorkingDir(object):
def __init__(self, pwd):
self._new = pwd
self._old = os.getcwd()
def __exit__(self, type, value, traceback):
os.chdir(self._old)
def __enter__(self):
os.chdir(self._new)
return self._new
class TmpDir(object):
def __init__(self, prefix):
self._dir = tempfile.mkdtemp(prefix=prefix, dir=local_tmp)
def __exit__(self, type, value, traceback):
try:
shutil.rmtree(path=self._dir)
except Exception as e:
# prefer original exception to rmtree exception
if value is None:
print("Exception cleaning up TmpDir %s: %s" % (self._dir, str(e)), file=sys.stderr)
raise e
else:
print("Failed to clean up TmpDir %s: %s" % (self._dir, str(e)), file=sys.stderr)
raise value
def __enter__(self):
return self._dir
def with_temporary_file(func, dir=None):
if dir is None:
dir = local_tmp
import tempfile
# Windows throws a permission denied if we use delete=True for
# auto-delete, and then try to open the file again ourselves
# with f.name. So we manually delete in the finally block
# below.
f = tempfile.NamedTemporaryFile(dir=dir, delete=False)
try:
func(f)
finally:
f.close()
os.remove(f.name)
def with_directory_contents(contents, func):
with (TmpDir(prefix="test-")) as dirname:
for filename, file_content in contents.items():
path = os.path.join(dirname, filename)
if file_content is None:
# make a directory
makedirs_ok_if_exists(path)
else:
makedirs_ok_if_exists(os.path.dirname(path))
with codecs.open(path, 'w', 'utf-8') as f:
f.write(file_content)
return func(os.path.realpath(dirname))
def with_file_contents(contents, func, dir=None):
def with_file_object(f):
f.write(contents.encode("UTF-8"))
f.flush()
# Windows will get mad if we try to rename it without closing,
# and some users of with_file_contents want to rename it.
f.close()
func(f.name)
with_temporary_file(with_file_object, dir=dir)
[docs]def skipIfPy3(message):
''' unittest decorator to skip a test for Python 3
'''
from unittest import skipIf
from .platform import is_py3
return skipIf(is_py3(), message)
[docs]def skipIfPyPy(message):
''' unittest decorator to skip a test for PyPy
'''
from unittest import skipIf
from .platform import is_pypy
return skipIf(is_pypy(), message)
[docs]def print_versions():
''' Print the versions for Bokeh and the current Python and OS.
Returns:
None
'''
import platform as pt
from .. import __version__
message = '''
Bokeh version: %s
Python version: %s-%s
Platform: %s
''' % (__version__, pt.python_version(),
pt.python_implementation(), pt.platform())
print(message)
[docs]def runtests(args=None):
''' Run the Bokeh tests under the bokeh python directory using pytest.
Does not run tests from bokehjs or examples.
Args:
args(list, optional): command line arguments accepted by py.test
e.g. args=['-s', '-k charts'] prevents capture of standard out
and only runs tests that match charts. For more py.test options
see http://pytest.org/latest/usage.html#usage.
Returns:
int: pytest exitcode
'''
import pytest
import os
try:
import faulthandler
faulthandler.enable()
except ImportError:
# We can live without in python 2.7
pass
# change to the bokeh python source directory, for test collection
rootdir = os.path.join(os.path.dirname(__file__), os.pardir)
os.chdir(rootdir)
return pytest.main(args=args)
#----------------------
# For testing charts
#----------------------
[docs]def create_chart(klass, values, compute_values=True, **kws):
''' Create a new chart class instance with values and the extra kws keyword
parameters.
Args:
klass (class): chart class to be created
values (iterable): chart data series
compute_values (bool): if == True underlying chart attributes (e.g.,
data, ranges, source, etc.) are computed by calling _setup_show,
_prepare_show and _show_teardown methods.
**kws (refer to klass arguments specification details)
Return:
_chart: klass chart instance
'''
_chart = klass(
values, title="title", xlabel="xlabel", ylabel="ylabel",
legend="top_left", xscale="linear", yscale="linear",
width=800, height=600, tools=True,
filename=False, server=False, notebook=False,
**kws
)
return _chart
