mirror of
https://github.com/pybind/pybind11.git
synced 2024-11-14 01:23:53 +00:00
6493f496e3
* `#error BYE_BYE_GOLDEN_SNAKE` * Removing everything related to 2.7 from ci.yml * Commenting-out Centos7 * Removing `PYTHON: 27` from .appveyor.yml * "PY2" removal, mainly from tests. C++ code is not touched. * Systematic removal of `u` prefix from `u"..."` and `u'...'` literals. Collateral cleanup of a couple minor other things. * Cleaning up around case-insensitive hits for `[^a-z]py.*2` in tests/. * Removing obsolete Python 2 mention in compiling.rst * Proper `#error` for Python 2. * Using PY_VERSION_HEX to guard `#error "PYTHON 2 IS NO LONGER SUPPORTED.` * chore: bump pre-commit * style: run pre-commit for pyupgrade 3+ * tests: use sys.version_info, not PY * chore: more Python 2 removal * Uncommenting Centos7 block (PR #3691 showed that it is working again). * Update pre-commit hooks * Fix pre-commit hook * refactor: remove Python 2 from CMake * refactor: remove Python 2 from setup code * refactor: simplify, better static typing * feat: fail with nice messages * refactor: drop Python 2 C++ code * docs: cleanup for Python 3 * revert: intree revert: intree * docs: minor touchup to py2 statement Co-authored-by: Henry Schreiner <henryschreineriii@gmail.com> Co-authored-by: Aaron Gokaslan <skylion.aaron@gmail.com>
42 lines
1.6 KiB
Python
42 lines
1.6 KiB
Python
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__
|