openstacksdk/doc/source/user/warnings.rst
Stephen Finucane 3f9685ffad Use custom warnings everywhere
Build on change I3846e8fcffdb5de2afe64365952d90b5ecb0f74a by switching
all callers of 'warning.warn' to use our custom warnings. This allows
users (like OSC) to filter these out as needed.

Since we have new types of warning, the docs are updated accordingly.

Change-Id: I5039fd8585e3352798a6d2fae7d5623fbc1adb6a
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2023-05-26 14:19:53 +01:00

771 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