unicodes_api.parser.Formatter : API documentation

class documentation

class Formatter(ABC):

Known subclasses: unicodes_api.cli.all_to_stdout, unicodes_api.cli.PairsDisplay

Formatter class.

Class Variable	`NAME`	subcommand name.
Method	`__init__`	instantiate Formatter class.
Instance Variable	`popts`	ParserOpts instance.
Instance Variable	`args`	argparse.Namespace value.
Method	`setup`	setup class for run.
Method	`set_args`	set arguments.
Method	`setup_popts`	setup parser options.
Method	`run`	Run program.
Method	`iterator`	Iterator.
Static Method	`fmt_single_normal`	format unicode value normally.
Static Method	`fmt_dval_sub_lines`	Format unicode value as staggered line.
Static Method	`tab_shift`	Shift text over.
Static Method	`fmt_group_multi_detail`	Format group with detail.
Static Method	`fmt_group_multi_detail_staggered_lines`	Format group with staggered lines.
Method	`fmt_group_normal`	Format group normally.
Method	`fmt_json`	Format as parsable json.
Instance Variable	`_iterator`	Iterator if set.

NAME =

overridden in unicodes_api.cli.all_to_stdout, unicodes_api.cli.PairsDisplay

subcommand name.

(type: Any)

def __init__(self):

overridden in unicodes_api.cli.PairsDisplay

instantiate Formatter class.

popts =

ParserOpts instance.

_iterator =

Iterator if set.

args =

argparse.Namespace value.

def setup(self, iterator):

overridden in unicodes_api.cli.all_to_stdout, unicodes_api.cli.PairsDisplay

setup class for run.

def set_args(self, args):

set arguments.

Parameters args Undocumented (type: argparse.Namespace)

@abstractmethod
def setup_popts(self):

overridden in unicodes_api.cli.all_to_stdout, unicodes_api.cli.PairsDisplay

setup parser options.

@abstractmethod
def run(self):

overridden in unicodes_api.cli.all_to_stdout, unicodes_api.cli.PairsDisplay

Run program.

def iterator(self):

Iterator.

Returns Undocumented (type: Iterator[Dict])

@staticmethod
def fmt_single_normal(dval):

format unicode value normally.

@staticmethod
def fmt_dval_sub_lines(dval):

Format unicode value as staggered line.

@staticmethod
def tab_shift(txtblock, shift_len):

Shift text over.

Parameters	txtblock	Undocumented (type: `str`)
	shift_len	Undocumented (type: `int`)

@staticmethod
def fmt_group_multi_detail(title, dvals):

Format group with detail.

Parameters	title	Undocumented
	dvals	Undocumented (type: `Iterable[Dict]`)

@staticmethod
def fmt_group_multi_detail_staggered_lines(title, dvals):

Format group with staggered lines.

Parameters	title	Undocumented
	dvals	Undocumented (type: `Iterable[Dict]`)

def fmt_group_normal(self):

Format group normally.

Returns Undocumented (type: Iterator[str])

def fmt_json(self):

Format as parsable json.

Returns Undocumented (type: Iterable[str])

API Documentation for unicodes_api, generated by pydoctor 21.2.2 at 1996-06-17 15:00:00.