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
|
# 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.
"""Formattable column tools."""
import abc
import typing as ty
_T = ty.TypeVar('_T')
class FormattableColumn(ty.Generic[_T], metaclass=abc.ABCMeta):
def __init__(self, value: _T) -> None:
self._value = value
def __eq__(self, other: object) -> bool:
if not isinstance(other, FormattableColumn):
return False
return bool(self._value == other._value)
def __lt__(self, other: object) -> bool:
if not isinstance(other, FormattableColumn):
return False
return bool(self._value < other._value)
def __str__(self) -> str:
return self.human_readable()
def __repr__(self) -> str:
return f'{self.__class__.__name__}({self.machine_readable()!r})'
@abc.abstractmethod
def human_readable(self) -> str:
"""Return a basic human readable version of the data."""
def machine_readable(self) -> _T:
"""Return a raw data structure using only Python built-in types.
It must be possible to serialize the return value directly
using a formatter like JSON, and it will be up to the
formatter plugin to decide how to make that transformation.
"""
return self._value
|