diff options
Diffstat (limited to 'lmi/scripts/common/command/show.py')
| -rw-r--r-- | lmi/scripts/common/command/show.py | 112 |
1 files changed, 0 insertions, 112 deletions
diff --git a/lmi/scripts/common/command/show.py b/lmi/scripts/common/command/show.py deleted file mode 100644 index 1698fec..0000000 --- a/lmi/scripts/common/command/show.py +++ /dev/null @@ -1,112 +0,0 @@ -# Copyright (C) 2013-2014 Red Hat, Inc. All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions are met: -# -# 1. Redistributions of source code must retain the above copyright notice, -# this list of conditions and the following disclaimer. -# 2. Redistributions in binary form must reproduce the above copyright notice, -# this list of conditions and the following disclaimer in the documentation -# and/or other materials provided with the distribution. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE -# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -# POSSIBILITY OF SUCH DAMAGE. -# -# The views and conclusions contained in the software and documentation are -# those of the authors and should not be interpreted as representing official -# policies, either expressed or implied, of the FreeBSD Project. -# -# Authors: Michal Minar <miminar@redhat.com> -# -""" -Contains command classes producing key-value pairs to output. -""" -import abc - -from lmi.scripts.common import formatter -from lmi.scripts.common import get_logger -from lmi.scripts.common.command import meta -from lmi.scripts.common.command.session import LmiSessionCommand - -LOG = get_logger(__name__) - -class LmiShowInstance(LmiSessionCommand): - """ - End point command producing a list of properties of particular CIM - instance. Either reduced list of properties to print can be specified, or - the associated function alone can decide, which properties shall be - printed. Associated function is expected to return CIM instance as a - result. - - List of additional recognized properties: - - ``DYNAMIC_PROPERTIES`` : ``bool`` - A boolean saying, whether the associated function alone shall - specify the list of properties of rendered instance. If ``True``, - the result of function must be a pair: :: - - (props, inst) - - Where props is the same value as can be passed to ``PROPERTIES`` - property. Defaults to ``False``. - ``PROPERTIES`` : ``tuple`` - May contain list of instance properties, that will be produced in - the same order as output. Each item of list can be either: - - name : ``str`` - Name of property to render. - pair : ``tuple`` - A tuple ``(Name, render_func)``, where former item an - arbitraty name for rendered value and the latter is a - function taking as the only argument particular instance - and returning value to render. - - ``DYNAMIC_PROPERTIES`` and ``PROPERTIES`` are mutually exclusive. If none - is given, all instance properties will be printed. - - Using metaclass: :py:class:`~.meta.ShowInstanceMetaClass`. - """ - __metaclass__ = meta.ShowInstanceMetaClass - - def formatter_factory(self): - return formatter.SingleFormatter - - @abc.abstractmethod - def render(self, result): - """ - This method can either be overriden in a subclass or left alone. In the - latter case it will be generated by - :py:class:`~.meta.ShowInstanceMetaClass` metaclass with regard to - ``PROPERTIES`` and ``DYNAMIC_PROPERTIES``. - - :param result: Either an instance to - render or pair of properties and instance. - :type: :py:class:`lmi.shell.LMIInstance` or ``tuple`` - :returns: List of pairs, where the first item is a label and second a - value to render. - :rtype: list - """ - raise NotImplementedError( - "render method must be overriden in subclass") - - def take_action(self, connection, args, kwargs): - """ - Process single connection to a host, render result and return a value - to render. - - :returns: List of pairs, where the first item is a label and - second a value to render. - :rtype: list - """ - res = self.execute_on_connection(connection, *args, **kwargs) - return self.render(res) - |