mirror of
https://github.com/RYDE-WORK/pybind11.git
synced 2026-01-19 13:13:19 +08:00
f1a2e03d19
* Change Python version guard: PYTHON < 3.7 IS UNSUPPORTED. * Replace or remove Python 3.6 jobs. * Move appveyor to Python 3.8 * Change `[tool.pylint]` `master.py-version` from `3.6` to `3.8` * Change `[tool.pylint]` `master.py-version` to `3.7` * Remove `centos:7` job; Change almalinux:8 job to use Python 3.8 * Try 🐍 3.8 • ubuntu-20.04 • x64 without `-DCMAKE_CXX_FLAGS="-D_=1"` * Update setup.cfg as suggested by @henryiii * Try running `cmake --build . --target cpptest` on all platforms (`standard` job). * Disable deadsnakes jobs entirely. * Apply PR #5179: Add Python 3.10, 3.11, 3.12 to win32 job matrix. * Add back `-DCMAKE_CXX_FLAGS="-D_=1"` but do not install boost in that case. * PY_VERSION_HEX < 3.7 cleanup pass: include/pybind11 * WITH_THREAD cleanup pass: include/pybind11 * Undo incorrect change. * Revert "Disable deadsnakes jobs entirely." This reverts commit bbcd0087b2d52e0130f96792dd5dd03704280a57. * WITH_THREAD cleanup pass: tests/ * Change Python version guard in pybind11/__init__.py: pybind11 does not support Python < 3.7. * Misc cleanup pass * chore: use future imports Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com> * Update tests/test_numpy_array.py * Update test_numpy_array.py --------- Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com> Co-authored-by: Henry Schreiner <henryschreineriii@gmail.com>
67 lines
2.4 KiB
Python
67 lines
2.4 KiB
Python
from __future__ import annotations
|
|
|
|
from pybind11_tests import docstring_options as m
|
|
|
|
|
|
def test_docstring_options():
|
|
# options.disable_function_signatures()
|
|
assert not m.test_function1.__doc__
|
|
|
|
assert m.test_function2.__doc__ == "A custom docstring"
|
|
|
|
# docstring specified on just the first overload definition:
|
|
assert m.test_overloaded1.__doc__ == "Overload docstring"
|
|
|
|
# docstring on both overloads:
|
|
assert m.test_overloaded2.__doc__ == "overload docstring 1\noverload docstring 2"
|
|
|
|
# docstring on only second overload:
|
|
assert m.test_overloaded3.__doc__ == "Overload docstr"
|
|
|
|
# options.enable_function_signatures()
|
|
assert m.test_function3.__doc__.startswith("test_function3(a: int, b: int) -> None")
|
|
|
|
assert m.test_function4.__doc__.startswith("test_function4(a: int, b: int) -> None")
|
|
assert m.test_function4.__doc__.endswith("A custom docstring\n")
|
|
|
|
# options.disable_function_signatures()
|
|
# options.disable_user_defined_docstrings()
|
|
assert not m.test_function5.__doc__
|
|
|
|
# nested options.enable_user_defined_docstrings()
|
|
assert m.test_function6.__doc__ == "A custom docstring"
|
|
|
|
# RAII destructor
|
|
assert m.test_function7.__doc__.startswith("test_function7(a: int, b: int) -> None")
|
|
assert m.test_function7.__doc__.endswith("A custom docstring\n")
|
|
|
|
# when all options are disabled, no docstring (instead of an empty one) should be generated
|
|
assert m.test_function8.__doc__ is None
|
|
|
|
# Suppression of user-defined docstrings for non-function objects
|
|
assert not m.DocstringTestFoo.__doc__
|
|
assert not m.DocstringTestFoo.value_prop.__doc__
|
|
|
|
# Check existig behaviour of enum docstings
|
|
assert (
|
|
m.DocstringTestEnum1.__doc__
|
|
== "Enum docstring\n\nMembers:\n\n Member1\n\n Member2"
|
|
)
|
|
|
|
# options.enable_enum_members_docstring()
|
|
assert (
|
|
m.DocstringTestEnum2.__doc__
|
|
== "Enum docstring\n\nMembers:\n\n Member1\n\n Member2"
|
|
)
|
|
|
|
# options.disable_enum_members_docstring()
|
|
assert m.DocstringTestEnum3.__doc__ == "Enum docstring"
|
|
|
|
# options.disable_user_defined_docstrings()
|
|
assert m.DocstringTestEnum4.__doc__ == "Members:\n\n Member1\n\n Member2"
|
|
|
|
# options.disable_user_defined_docstrings()
|
|
# options.disable_enum_members_docstring()
|
|
# When all options are disabled, no docstring (instead of an empty one) should be generated
|
|
assert m.DocstringTestEnum5.__doc__ is None
|