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
|
"""Test utilities for docstring."""
# Authors: Guillaume Lemaitre <g.lemaitre58@gmail.com>
# License: MIT
import sys
import textwrap
import pytest
from imblearn.utils import Substitution
from imblearn.utils._docstring import _n_jobs_docstring, _random_state_docstring
def _dedent_docstring(docstring):
"""Compatibility with Python 3.13+.
xref: https://github.com/python/cpython/issues/81283
"""
return "\n".join([textwrap.dedent(line) for line in docstring.split("\n")])
func_docstring = """A function.
Parameters
----------
xxx
yyy
"""
def func(param_1, param_2):
"""A function.
Parameters
----------
{param_1}
{param_2}
"""
return param_1, param_2
cls_docstring = """A class.
Parameters
----------
xxx
yyy
"""
class cls:
"""A class.
Parameters
----------
{param_1}
{param_2}
"""
def __init__(self, param_1, param_2):
self.param_1 = param_1
self.param_2 = param_2
if sys.version_info >= (3, 13):
func_docstring = _dedent_docstring(func_docstring)
cls_docstring = _dedent_docstring(cls_docstring)
@pytest.mark.parametrize(
"obj, obj_docstring", [(func, func_docstring), (cls, cls_docstring)]
)
def test_docstring_inject(obj, obj_docstring):
obj_injected_docstring = Substitution(param_1="xxx", param_2="yyy")(obj)
assert obj_injected_docstring.__doc__ == obj_docstring
def test_docstring_template():
assert "random_state" in _random_state_docstring
assert "n_jobs" in _n_jobs_docstring
def test_docstring_with_python_OO():
"""Check that we don't raise a warning if the code is executed with -OO.
Non-regression test for:
https://github.com/scikit-learn-contrib/imbalanced-learn/issues/945
"""
instance = cls(param_1="xxx", param_2="yyy")
instance.__doc__ = None # simulate -OO
instance = Substitution(param_1="xxx", param_2="yyy")(instance)
assert instance.__doc__ is None
|
