d1a88bad18
Add a new way of formatting our output in a consistent way. This turns print_list and print_dict into a formatter that has the same API as any other formatter and allows users to create their own formatters and plug them into cratonclient. This includes tests for the base level formatter and our two default formatters as well as some refactoring to allow users to specify their own --format. At the moment, however, the subcommand shells do *not* use the pluggable formatter decided by the user. That change and all of the downstream effects it has on testing is going to be *very* significant and deserves its own commit as this one is large enough. Change-Id: I6649ebce57d5ddf2d4aeb689e77e3c17ef3a2e97
73 lines
2.5 KiB
Python
73 lines
2.5 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.
|
|
"""JSON formatter implementation for the craton CLI."""
|
|
from __future__ import print_function
|
|
|
|
import json
|
|
|
|
from cratonclient.formatters import base
|
|
|
|
|
|
class Formatter(base.Formatter):
|
|
"""JSON output formatter for the CLI."""
|
|
|
|
def after_init(self):
|
|
"""Set-up our defaults.
|
|
|
|
At some point in the future, we may allow people to configure this via
|
|
the CLI.
|
|
"""
|
|
self.indent = 4
|
|
self.sort_keys = True
|
|
|
|
def format(self, dictionary):
|
|
"""Return the dictionary as a JSON string."""
|
|
return json.dumps(
|
|
dictionary,
|
|
sort_keys=self.sort_keys,
|
|
indent=self.indent,
|
|
)
|
|
|
|
def handle_instance(self, instance):
|
|
"""Print the JSON representation of a single instance."""
|
|
print(self.format(instance.to_dict()))
|
|
|
|
def handle_generator(self, generator):
|
|
"""Print the JSON representation of a collection."""
|
|
# NOTE(sigmavirus24): This is tricky logic that is caused by the JSON
|
|
# specification's intolerance for trailing commas.
|
|
try:
|
|
instance = next(generator)
|
|
except StopIteration:
|
|
# If there is nothing in the generator, we should just print an
|
|
# empty Array and then exit immediately.
|
|
print('[]')
|
|
return
|
|
|
|
# Otherwise, let's print our opening bracket to start our Array
|
|
# formatting.
|
|
print('[', end='')
|
|
while True:
|
|
print(self.format(instance.to_dict()), end='')
|
|
# After printing our instance as a JSON object, we need to
|
|
# decide if we have another object to print. If we do have
|
|
# another object to print, we need to print a comma to separate
|
|
# our previous object and our next one. If we don't, we exit our
|
|
# loop to print our closing Array bracket.
|
|
try:
|
|
instance = next(generator)
|
|
except StopIteration:
|
|
break
|
|
else:
|
|
print(', ', end='')
|
|
print(']')
|