def test_tripwire():
# Test tripwire object
silly_module_name = TripWire('We do not have silly_module_name')
assert_raises(TripWireError, getattr, silly_module_name, 'do_silly_thing')
assert_raises(TripWireError, silly_module_name)
# Check AttributeError can be checked too
try:
silly_module_name.__wrapped__
except TripWireError as err:
assert_true(isinstance(err, AttributeError))
else:
raise RuntimeError("No error raised, but expected")
def optional_package(name, trip_msg=None):
""" Return package-like thing and module setup for package `name`
Parameters
----------
name : str
package name
trip_msg : None or str
message to give when someone tries to use the return package, but we
could not import it, and have returned a TripWire object instead.
Default message if None.
Returns
-------
pkg_like : module or ``TripWire`` instance
If we can import the package, return it. Otherwise return an object
raising an error when accessed
have_pkg : bool
True if import for package was successful, false otherwise
module_setup : function
callable usually set as ``setup_module`` in calling namespace, to allow
skipping tests.
Example
-------
Typical use would be something like this at the top of a module using an
optional package:
>>> from dipy.utils.optpkg import optional_package
>>> pkg, have_pkg, setup_module = optional_package('not_a_package')
Of course in this case the package doesn't exist, and so, in the module:
>>> have_pkg
False
and
>>> pkg.some_function() #doctest: +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
...
TripWireError: We need package not_a_package for these functions, but ``import not_a_package`` raised an ImportError
If the module does exist - we get the module
>>> pkg, _, _ = optional_package('os')
>>> hasattr(pkg, 'path')
True
Or a submodule if that's what we asked for
>>> subpkg, _, _ = optional_package('os.path')
>>> hasattr(subpkg, 'dirname')
True
"""
try:
pkg = importlib.import_module(name)
except ImportError:
pass
else: # import worked
# top level module
return pkg, True, lambda: None
if trip_msg is None:
trip_msg = ('We need package %s for these functions, but '
'``import %s`` raised an ImportError'
% (name, name))
pkg = TripWire(trip_msg)
def setup_module():
if have_nose:
raise nose.plugins.skip.SkipTest('No %s for these tests'
% name)
return pkg, False, setup_module
self.y = torch.tensor([])
else:
self.unsupervised = False
self.y = torch.tensor(y.astype(float))
def __len__(self):
return len(self.X)
def __getitem__(self, idx):
if self.unsupervised:
return self.X[idx]
else:
return self.X[idx], self.y[idx]
else: # pragma: no cover
AFQTorchDataset = TripWire(torch_msg)
class AFQDataset:
"""Represent AFQ features and targets.
The `AFQDataset` class represents tractometry features and, optionally,
phenotypic targets.
The simplest way to create a new AFQDataset is to pass in the tractometric
features and phenotypic targets explicitly.
>>> import numpy as np
>>> AFQDataset(X=np.random.rand(50, 1000), y=np.random.rand(50))
AFQDataset(n_samples=50, n_features=1000, n_targets=1)
def test_is_tripwire():
assert_false(is_tripwire(object()))
assert_true(is_tripwire(TripWire('some message')))