def test_check_positive(scitype, mtype, fixture_index):
"""Tests that check_is_mtype correctly confirms the mtype of examples.
Parameters
----------
scitype : str - scitype of fixture
mtype : str - mtype of fixture
fixture_index : int - index of fixture tuple with that scitype and mtype
Raises
------
RuntimeError if scitype is not defined or has no mtypes or examples
AssertionError if examples are not correctly identified
error if check itself raises an error
"""
# retrieve fixture for checking
fixture = get_examples(mtype=mtype, as_scitype=scitype).get(fixture_index)
# todo: possibly remove this once all checks are defined
check_is_defined = (mtype, scitype) in check_dict.keys()
# check fixtures that exist against checks that exist
if fixture is not None and check_is_defined:
check_result = check_is_mtype(fixture, mtype, scitype, return_metadata=True)
if not check_result[0]:
msg = (
f"check_is_mtype returns False on scitype {scitype}, mtype {mtype} "
f"fixture {fixture_index}, message: "
)
msg = msg + check_result[1]
assert check_result[0], msg
def test_scitype_infer(scitype, mtype, fixture_index):
"""Tests that scitype correctly infers the mtype of examples.
Parameters
----------
scitype : str - scitype of fixture
mtype : str - mtype of fixture
fixture_index : int - index of fixture tuple with that scitype and mtype
Raises
------
RuntimeError if scitype is not defined or has no mtypes or examples
AssertionError if mtype of examples is not correctly identified
error if check itself raises an error
"""
# if mtypes are ambiguous, then this test should be skipped
if scitype in SKIP_SCITYPES or mtype in AMBIGUOUS_MTYPES:
return None
# retrieve fixture for checking
fixture = get_examples(mtype=mtype, as_scitype=scitype).get(fixture_index)
# todo: possibly remove this once all checks are defined
check_is_defined = (mtype, scitype) in check_dict.keys()
# check fixtures that exist against checks that exist
if fixture is not None and check_is_defined:
assert scitype == infer_scitype(
fixture, candidate_scitypes=SCITYPES_FOR_INFER_TEST
), f"mtype {mtype} not correctly identified for fixture {fixture_index}"
def test_mtype_infer(scitype, mtype, fixture_index):
"""Tests that mtype correctly infers the mtype of examples.
Parameters
----------
scitype : str - name of scitype for which mtype conversions are tested
Raises
------
RuntimeError if scitype is not defined or has no mtypes or examples
AssertionError if mtype of examples is not correctly identified
error if check itself raises an error
"""
# if mtypes are ambiguous, then this test should be skipped
if scitype in SCITYPES_AMBIGUOUS_MTYPE:
return None
# retrieve fixture for checking
fixture = get_examples(mtype=mtype, as_scitype=scitype).get(fixture_index)
# todo: possibly remove this once all checks are defined
check_is_defined = (mtype, scitype) in check_dict.keys()
# check fixtures that exist against checks that exist
if fixture is not None and check_is_defined:
assert mtype == infer_mtype(
fixture, as_scitype=scitype
), f"mtype {mtype} not correctly identified for fixture {fixture_index}"
def test_check_positive(scitype):
"""Tests that check_is_mtype correctly confirms the mtype of examples.
Parameters
----------
scitype : str - name of scitype for which mtype conversions are tested
Raises
------
RuntimeError if scitype is not defined or has no mtypes or examples
AssertionError if examples are not correctly identified
error if check itself raises an error
"""
if scitype not in [s[0] for s in SCITYPE_REGISTER]:
raise RuntimeError(scitype + " is not in the SCITYPE_REGISTER")
mtypes = [key[0] for key in MTYPE_REGISTER if key[1] == scitype]
if len(mtypes) == 0:
raise RuntimeError("no mtypes defined for scitype " + scitype)
fixtures = dict()
for mtype in mtypes:
# if we don't do this we get into a clash between linters
mtype_long_variable_name_to_avoid_linter_clash = mtype
fixtures[mtype] = get_examples(
mtype=mtype_long_variable_name_to_avoid_linter_clash,
as_scitype=scitype,
)
n_fixtures = np.max([len(fixtures[mtype]) for mtype in mtypes])
if n_fixtures == 0:
raise RuntimeError("no fixtures defined for scitype " + scitype)
for i in range(n_fixtures):
for mtype in mtypes:
# retrieve fixture for checking
fixture = fixtures[mtype].get(i)
# todo: possibly remove this once all checks are defined
check_is_defined = (mtype, scitype) in check_dict.keys()
# check fixtures that exist against checks that exist
if fixture is not None and check_is_defined:
check_result = check_is_mtype(
fixture, mtype, scitype, return_metadata=True
)
if not check_result[0]:
msg = (
f"check_is_mtype returns False on {mtype} "
f"fixture {i}, message: "
)
msg = msg + check_result[1]
assert check_result[0], msg
def test_check_negative(scitype):
"""Tests that check_is_mtype correctly identifies wrong mtypes of examples.
Parameters
----------
scitype : str - name of scitype for which mtype conversions are tested
Raises
------
RuntimeError if scitype is not defined or has no mtypes or examples
AssertionError if a examples are correctly identified as incompatible
error if check itself raises an error
"""
if scitype not in [s[0] for s in SCITYPE_REGISTER]:
raise RuntimeError(scitype + " is not in the SCITYPE_REGISTER")
if scitype in SCITYPES_AMBIGUOUS_MTYPE:
return None
mtypes = [key[0] for key in MTYPE_REGISTER if key[1] == scitype]
if len(mtypes) == 0:
raise RuntimeError("no mtypes defined for scitype " + scitype)
fixtures = dict()
for mtype in mtypes:
# if we don't do this we get into a clash between linters
mtype_long_variable_name_to_avoid_linter_clash = mtype
fixtures[mtype] = get_examples(
mtype=mtype_long_variable_name_to_avoid_linter_clash,
as_scitype=scitype,
)
n_fixtures = np.max([len(fixtures[mtype]) for mtype in mtypes])
if n_fixtures == 0:
raise RuntimeError("no fixtures defined for scitype " + scitype)
for i in range(n_fixtures):
for mtype in mtypes:
for wrong_mtype in list(set(mtypes).difference(set([mtype]))):
# retrieve fixture for checking
fixture_wrong_type = fixtures[wrong_mtype].get(i)
# todo: possibly remove this once all checks are defined
check_is_defined = (mtype, scitype) in check_dict.keys()
# check fixtures that exist against checks that exist
if fixture_wrong_type is not None and check_is_defined:
assert not check_is_mtype(fixture_wrong_type, mtype, scitype), (
f"check_is_mtype {mtype} returns True "
f"on {wrong_mtype} fixture {i}"
)
def test_check_negative(scitype, mtype):
"""Tests that check_is_mtype correctly identifies wrong mtypes of examples.
Parameters
----------
scitype : str - scitype of fixture
mtype : str - mtype of fixture
Raises
------
RuntimeError if scitype is not defined or has no mtypes or examples
AssertionError if a examples are correctly identified as incompatible
error if check itself raises an error
"""
# if the scitype is ambiguous, we can't assume that other mtypes are negative
if scitype in SCITYPES_AMBIGUOUS_MTYPE:
return None
mtypes = scitype_to_mtype(scitype)
fixtures = dict()
for other_mtype in mtypes:
fixtures[other_mtype] = get_examples(mtype=other_mtype, as_scitype=scitype)
n_fixtures = np.max([len(fixtures[mtype]) for mtype in mtypes])
if n_fixtures == 0:
raise RuntimeError("no fixtures defined for scitype " + scitype)
for i in range(n_fixtures):
# if mtype is not ambiguous, other mtypes are negative examples
for wrong_mtype in list(set(mtypes).difference(set([mtype]))):
# retrieve fixture for checking
fixture_wrong_type = fixtures[wrong_mtype].get(i)
# todo: possibly remove this once all checks are defined
check_is_defined = (mtype, scitype) in check_dict.keys()
# check fixtures that exist against checks that exist
if fixture_wrong_type is not None and check_is_defined:
assert not check_is_mtype(fixture_wrong_type, mtype, scitype), (
f"check_is_mtype {mtype} returns True "
f"on {wrong_mtype} fixture {i}"
)
def test_check_metadata_inference(scitype, mtype, fixture_index):
"""Tests that check_is_mtype correctly infers metadata of examples.
Parameters
----------
scitype : str - scitype of fixture
mtype : str - mtype of fixture
fixture_index : int - index of fixture tuple with that scitype and mtype
Raises
------
RuntimeError if scitype is not defined or has no mtypes or examples
AssertionError if example metadata is not correctly inferred
error if check itself raises an error
"""
# retrieve fixture for checking
fixture, _, expected_metadata = get_examples(
mtype=mtype, as_scitype=scitype, return_metadata=True
).get(fixture_index)
# todo: possibly remove this once all checks are defined
check_is_defined = (mtype, scitype) in check_dict.keys()
# if the examples have no metadata to them, don't test
metadata_provided = expected_metadata is not None
# check fixtures that exist against checks that exist
if fixture is not None and check_is_defined and metadata_provided:
check_result = check_is_mtype(fixture, mtype, scitype, return_metadata=True)
metadata = check_result[2]
# remove mtype & scitype key if exists, since comparison is on scitype level
if "mtype" in metadata:
del metadata["mtype"]
if "scitype" in metadata:
del metadata["scitype"]
msg = (
f"check_is_mtype returns wrong metadata on scitype {scitype}, "
f"mtype {mtype}, fixture {fixture_index}. "
f"returned: {metadata}; expected: {expected_metadata}"
)
assert metadata == expected_metadata, msg