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 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
|
r"""Utilities for Developers (: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 utilities
-----------------
Common functionality to support testing in skbio.
.. autosummary::
:toctree: generated/
get_data_path
assert_ordination_results_equal
assert_data_frame_almost_equal
Plotting utilities
------------------
.. autosummary::
:toctree: generated/
PlottableMixin
Decorators
----------
.. autosummary::
:toctree: generated/
overrides
classproperty
classonlymethod
deprecated
aliased
register_aliases
params_aliased
Miscellaneous utilities
-----------------------
Generally useful functionality that doesn't fit in more specific locations.
.. autosummary::
:toctree: generated/
get_rng
cardinal_to_ordinal
find_duplicates
safe_md5
""" # noqa: D412, D416, D205, D415
# ----------------------------------------------------------------------------
# Copyright (c) 2013--, scikit-bio development team.
#
# Distributed under the terms of the Modified BSD License.
#
# The full license is in the file LICENSE.txt, distributed with this software.
# ----------------------------------------------------------------------------
from ._misc import cardinal_to_ordinal, find_duplicates, safe_md5, get_rng
from ._testing import (
get_data_path,
assert_ordination_results_equal,
assert_data_frame_almost_equal,
pytestrunner,
)
from ._decorator import (
overrides,
classproperty,
classonlymethod,
deprecated,
aliased,
register_aliases,
params_aliased,
)
from ._plotting import PlottableMixin
__all__ = [
"cardinal_to_ordinal",
"find_duplicates",
"safe_md5",
"get_rng",
"get_data_path",
"assert_ordination_results_equal",
"assert_data_frame_almost_equal",
"pytestrunner",
"PlottableMixin",
"overrides",
"classproperty",
"classonlymethod",
"deprecated",
"aliased",
"register_aliases",
"params_aliased",
]
|