1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
|
"""
Utility functionality (:mod:`skbio.util`)
=========================================
.. currentmodule:: skbio.util
This package provides general exception/warning definitions used throughout
scikit-bio, as well as various utility functionality, including I/O and
unit-testing convenience functions.
Testing functionality
---------------------
Common functionality to support testing in skbio.
.. autosummary::
:toctree: generated/
get_data_path
assert_ordination_results_equal
assert_data_frame_almost_equal
Miscellaneous functionality
---------------------------
Generally useful functionality that doesn't fit in more specific locations.
.. autosummary::
:toctree: generated/
cardinal_to_ordinal
find_duplicates
safe_md5
classproperty
Warnings
--------
.. autosummary::
:toctree: generated/
EfficiencyWarning
RepresentationWarning
"""
# ----------------------------------------------------------------------------
# Copyright (c) 2013--, scikit-bio development team.
#
# Distributed under the terms of the Modified BSD License.
#
# The full license is in the file COPYING.txt, distributed with this software.
# ----------------------------------------------------------------------------
from ._warning import EfficiencyWarning, RepresentationWarning, SkbioWarning
from ._misc import cardinal_to_ordinal, find_duplicates, safe_md5
from ._testing import (get_data_path,
assert_ordination_results_equal,
assert_data_frame_almost_equal, pytestrunner)
from ._decorator import classproperty
__all__ = ['SkbioWarning', 'EfficiencyWarning', 'RepresentationWarning',
'cardinal_to_ordinal', 'find_duplicates', 'safe_md5',
'get_data_path', 'assert_ordination_results_equal',
'assert_data_frame_almost_equal', 'classproperty', 'pytestrunner']
|