1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
# 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.
"""Base classes for formatters."""
import abc
import argparse
import collections.abc
import typing as ty
class Formatter(metaclass=abc.ABCMeta):
@abc.abstractmethod
def add_argument_group(self, parser: argparse.ArgumentParser) -> None:
"""Add any options to the argument parser.
Should use our own argument group.
"""
class ListFormatter(Formatter, metaclass=abc.ABCMeta):
"""Base class for formatters that know how to deal with multiple objects."""
@abc.abstractmethod
def emit_list(
self,
column_names: collections.abc.Sequence[str],
data: collections.abc.Iterable[collections.abc.Sequence[ty.Any]],
stdout: ty.TextIO,
parsed_args: argparse.Namespace,
) -> None:
"""Format and print the list from the iterable data source.
Data values can be primitive types like ints and strings, or
can be an instance of a :class:`FormattableColumn` for
situations where the value is complex, and may need to be
handled differently for human readable output vs. machine
readable output.
:param column_names: names of the columns
:param data: iterable data source, one tuple per object
with values in order of column names
:param stdout: output stream where data should be written
:param parsed_args: argparse namespace from our local options
"""
class SingleFormatter(Formatter, metaclass=abc.ABCMeta):
"""Base class for formatters that work with single objects."""
@abc.abstractmethod
def emit_one(
self,
column_names: collections.abc.Sequence[str],
data: collections.abc.Sequence[ty.Any],
stdout: ty.TextIO,
parsed_args: argparse.Namespace,
) -> None:
"""Format and print the values associated with the single object.
Data values can be primitive types like ints and strings, or
can be an instance of a :class:`FormattableColumn` for
situations where the value is complex, and may need to be
handled differently for human readable output vs. machine
readable output.
:param column_names: names of the columns
:param data: iterable data source with values in order of column names
:param stdout: output stream where data should be written
:param parsed_args: argparse namespace from our local options
"""
|
