File: //snap/google-cloud-cli/394/lib/surface/components/list.py
# -*- coding: utf-8 -*- #
# Copyright 2013 Google LLC. All Rights Reserved.
#
# 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.
"""The command to list installed/available gcloud components."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.components import util
from googlecloudsdk.core import log
class List(base.ListCommand):
"""List the status of all Google Cloud CLI components.
This command lists all the available components in the Google Cloud CLI. For
each component, the command lists the following information:
* Status on your local workstation: not installed, installed (and
up to date), and update available (installed, but not up to date)
* Name of the component (a description)
* ID of the component (used to refer to the component in other
[{parent_command}] commands)
* Size of the component
## EXAMPLES
To list the status of all Google Cloud CLI components, run:
$ {command}
To show the currently installed version (if any) and the latest available
version of each component, run:
$ {command} --show-versions
"""
@staticmethod
def Args(parser):
base.PAGE_SIZE_FLAG.RemoveFromParser(parser)
base.URI_FLAG.RemoveFromParser(parser)
parser.add_argument(
'--only-local-state',
action='store_true',
help='Only show locally installed components.',
)
parser.add_argument(
'--show-versions', required=False, action='store_true',
help='Show installed and available versions of all components.')
parser.add_argument(
'--show-hidden', required=False, action='store_true',
help='Show installed and available versions of all components.',
hidden=True,
)
parser.add_argument(
'--show-platform',
required=False,
action='store_true',
help='Show operating system and architecture of all components')
def _SetFormat(self, args):
attributes = [
'box',
'title="Components"'
]
columns = [] if args.only_local_state else ['state.name:label=Status']
columns.append('name:label=Name')
if args.show_versions:
columns.extend([
'current_version_string:label=Installed:align=right',
'latest_version_string:label=Latest:align=right',
])
columns.extend([
'id:label=ID',
'size.size(zero="",min=1048576):label=Size:align=right',
])
if args.show_platform:
columns.extend([
'platform.architecture.id:label=ARCHITECTURE',
'platform.operating_system.id:label=OPERATING_SYSTEM'
])
args.GetDisplayInfo().AddFormat('table[{attributes}]({columns})'.format(
attributes=','.join(attributes), columns=','.join(columns)))
def Run(self, args):
"""Runs the list command."""
self._SetFormat(args)
update_manager = util.GetUpdateManager(args)
result = update_manager.List(show_hidden=args.show_hidden,
only_local_state=args.only_local_state)
(to_print, self._current_version, self._latest_version) = result
return to_print
def Epilog(self, resources_were_displayed):
if not resources_were_displayed:
log.status.write('\nNo updates.')
latest_version_string = ('' if self._latest_version is None
else ' [{}]'.format(self._latest_version))
log.status.write("""\
To install or remove components at your current Google Cloud CLI version [{current}], run:
$ gcloud components install COMPONENT_ID
$ gcloud components remove COMPONENT_ID
To update your Google Cloud CLI installation to the latest version{latest}, run:
$ gcloud components update
""".format(current=self._current_version, latest=latest_version_string))