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

exception openstack.warnings.OpenStackDeprecationWarning

Base class for warnings about deprecated features in openstacksdk.

exception openstack.warnings.RemovedResourceWarning

Indicates that a resource has been removed in newer API versions and should not be used.

exception openstack.warnings.RemovedFieldWarning

Indicates that a field has been removed in newer API versions and should not be used.

exception openstack.warnings.LegacyAPIWarning

Indicates an API that is in ‘legacy’ status, a long term deprecation.

exception openstack.warnings.RemovedInSDK40Warning

Indicates an argument that is deprecated for removal in SDK 4.0.

exception openstack.warnings.RemovedInSDK50Warning

Indicates an argument that is deprecated for removal in SDK 5.0.

exception openstack.warnings.OpenStackWarning

Base class for general warnings in openstacksdk.

exception openstack.warnings.ConfigurationWarning

Indicates an issue with configuration.

exception openstack.warnings.UnsupportedServiceVersion

Indicates a major version that SDK doesn’t understand.