openstacksdk/doc/source/user/warnings.rst
Stephen Finucane 7349594757 docs: Document various warnings
Add a ':members:' option to ensure we actually list the available
warnings, as was the original intent.

Change-Id: Ia7cf763e0a4f2aa345b0f41b6a096a05512dbcaf
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2023-08-28 17:57:24 +01:00

784 B

Warnings

openstacksdk uses the warnings infrastructure to warn users about deprecated resources and resource fields, as well as deprecated behavior in openstacksdk itself. These warnings are derived from Warning or DeprecationWarning. In Python, warnings are emitted by default while deprecation warnings are silenced by default and must be turned on using the -Wa Python command line option or the PYTHONWARNINGS environment variable. If you are writing an application that uses openstacksdk, you may wish to enable some of these warnings during test runs to ensure you migrate away from deprecated behavior.

Available warnings

openstack.warnings