summaryrefslogtreecommitdiff
path: root/ext/pybind11/tests/test_docstring_options.py
diff options
context:
space:
mode:
Diffstat (limited to 'ext/pybind11/tests/test_docstring_options.py')
-rw-r--r--ext/pybind11/tests/test_docstring_options.py32
1 files changed, 32 insertions, 0 deletions
diff --git a/ext/pybind11/tests/test_docstring_options.py b/ext/pybind11/tests/test_docstring_options.py
new file mode 100644
index 000000000..66ad6b89f
--- /dev/null
+++ b/ext/pybind11/tests/test_docstring_options.py
@@ -0,0 +1,32 @@
+
+
+def test_docstring_options():
+ from pybind11_tests import (test_function1, test_function2, test_function3,
+ test_function4, test_function5, test_function6,
+ test_function7, DocstringTestFoo)
+
+ # options.disable_function_signatures()
+ assert not test_function1.__doc__
+
+ assert test_function2.__doc__ == "A custom docstring"
+
+ # options.enable_function_signatures()
+ assert test_function3.__doc__ .startswith("test_function3(a: int, b: int) -> None")
+
+ assert test_function4.__doc__ .startswith("test_function4(a: int, b: int) -> None")
+ assert test_function4.__doc__ .endswith("A custom docstring\n")
+
+ # options.disable_function_signatures()
+ # options.disable_user_defined_docstrings()
+ assert not test_function5.__doc__
+
+ # nested options.enable_user_defined_docstrings()
+ assert test_function6.__doc__ == "A custom docstring"
+
+ # RAII destructor
+ assert test_function7.__doc__ .startswith("test_function7(a: int, b: int) -> None")
+ assert test_function7.__doc__ .endswith("A custom docstring\n")
+
+ # Suppression of user-defined docstrings for non-function objects
+ assert not DocstringTestFoo.__doc__
+ assert not DocstringTestFoo.value_prop.__doc__