Files
openstacksdk/openstack/warnings.py
Stephen Finucane 7069879b58 Deprecate unnecessary options, aliases
Change-Id: Ia2203bea15c8593611f01eca6ab511c0e11ae8b6
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2024-10-02 09:52:16 +02:00

75 lines
2.2 KiB
Python

# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
# API deprecation warnings
#
# These are for service-related deprecations, such as the removal of an API or
# API field due to a microversion.
class OpenStackDeprecationWarning(DeprecationWarning):
"""Base class for warnings about deprecated features in openstacksdk."""
class RemovedResourceWarning(OpenStackDeprecationWarning):
"""Indicates that a resource has been removed in newer API versions and
should not be used.
"""
class RemovedFieldWarning(OpenStackDeprecationWarning):
"""Indicates that a field has been removed in newer API versions and should
not be used.
"""
class LegacyAPIWarning(OpenStackDeprecationWarning):
"""Indicates an API that is in 'legacy' status, a long term deprecation."""
# Package deprecation warnings
#
# These are for SDK-specific deprecations, such as removed functions or
# function parameters.
class _RemovedInSDKWarning(PendingDeprecationWarning):
"""Indicates an argument that is deprecated for removal.
This is a base class and should not be used directly.
"""
class RemovedInSDK50Warning(_RemovedInSDKWarning):
"""Indicates an argument that is deprecated for removal in SDK 5.0."""
class RemovedInSDK60Warning(_RemovedInSDKWarning):
"""Indicates an argument that is deprecated for removal in SDK 6.0."""
# General warnings
#
# These are usually related to misconfigurations.
class OpenStackWarning(Warning):
"""Base class for general warnings in openstacksdk."""
class ConfigurationWarning(OpenStackWarning):
"""Indicates an issue with configuration."""
class UnsupportedServiceVersion(OpenStackWarning):
"""Indicates a major version that SDK doesn't understand."""