Source code for designateclient.cli.base

# Copyright 2012 Managed I.T.
# Author: Kiall Mac Innes <>
# 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
# 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.
import abc
import warnings

from keystoneauth1 import exceptions as ks_exceptions
from osc_lib.command import command
import six

from designateclient import exceptions
from designateclient import utils
from designateclient.v1 import Client

[docs]@six.add_metaclass(abc.ABCMeta) class Command(command.Command):
[docs] def run(self, parsed_args): warnings.simplefilter('once', category=DeprecationWarning) warnings.warn( 'The "designate" CLI is being deprecated in favour of the ' '"openstack" CLI plugin. All designate API v2 commands are ' 'implemented there. When the v1 API is removed this CLI will ' 'stop functioning', DeprecationWarning) warnings.resetwarnings() warnings.simplefilter('ignore', category=DeprecationWarning) self.client = Client(,,,,,, warnings.resetwarnings() try: return super(Command, self).run(parsed_args) except exceptions.RemoteError as e: columns = ['Code', 'Type'] values = [e.code, e.type] if e.message: columns.append('Message') values.append(e.message) if e.errors: columns.append('Errors') values.append(e.errors) self.error_output(parsed_args, columns, values) except ks_exceptions.EndpointNotFound as e:'No endpoint was found. You must provide a ' 'username or user id via --os-username, ' '--os-user-id, env[OS_USERNAME] or ' 'env[OS_USER_ID]. You may also be using a ' 'cloud that does not have the V1 API enabled. ' 'If your cloud does not have the V1 DNS API ' 'use the openstack CLI to interact with the ' 'DNS Service.') return 1
[docs] def error_output(self, parsed_args, column_names, data): self.formatter.emit_one(column_names, data,, parsed_args)'The requested action did not complete ' 'successfully')
[docs] @abc.abstractmethod def execute(self, parsed_args): """ Execute something, this is since we overload self.take_action() in order to format the data This method __NEEDS__ to be overloaded! :param parsed_args: The parsed args that are given by take_action() """
[docs] def post_execute(self, data): """ Format the results locally if needed, by default we just return data :param data: Whatever is returned by self.execute() """ return data
[docs] def take_action(self, parsed_args): results = self.execute(parsed_args) return self.post_execute(results)
[docs] def find_resourceid_by_name_or_id(self, resource_plural, name_or_id): resource_client = getattr(self.client, resource_plural) return utils.find_resourceid_by_name_or_id(resource_client, name_or_id)
[docs]class ListCommand(Command, command.Lister): columns = None
[docs] def post_execute(self, results): if len(results) > 0: columns = self.columns or utils.get_columns(results) data = [utils.get_item_properties(i, columns) for i in results] return columns, data else: return [], ()
[docs]class GetCommand(Command, command.ShowOne):
[docs] def post_execute(self, results): return results.keys(), results.values()
[docs]class CreateCommand(Command, command.ShowOne):
[docs] def post_execute(self, results): return results.keys(), results.values()
[docs]class UpdateCommand(Command, command.ShowOne):
[docs] def post_execute(self, results): return results.keys(), results.values()
[docs]class DeleteCommand(Command, command.ShowOne):
[docs] def post_execute(self, results): return [], []
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.