formatter Package

formatter Package

class formatter2.Formatter

Bases: object

format_directory(directory)

format_file(name)

format_path(path, recursive=False)

classmethod format_string(string)

class formatter2.Token(offsets, tok_type, token, begin, end, line)

Bases: object

begin

The begin coordinates.

Settings this to a tuple will set the first to the row and the latter to the col.

This returns a SmartList with the row and the column.

begin_col

The begin column.

begin_row

The begin row.

col

The column.

Setting this to a tuple will set the first to the begin and the latter to the end.

This returns a SmartList with the begin and end column.

end

The end.

Settings this to a tuple will set the first to the row and the latter to the col.

This returns a SmartList with the row and column.

end_col

The end column.

end_row

The end row.

line

The line.

Setting the line automatically updates the column as well.

Returns a str() object with the line.

preprocess()

formatter2.types.TokenType.preprocess()

row

The row.

Setting this to a tuple will set the first to the begin and the latter to the end.

This returns a SmartList with the begin and end row.

type

class formatter2.Tokens(readline)

Bases: object

format()

Format the string, expects the extra whitespace to be removed already

classmethod from_fh(fh)

classmethod from_readline(readline)

generate_tokens(readline)

strip()

Strip all whitespace so we can begin formatting

to_str()

Convert the tokens back to a string

class formatter2.TokenOffsets(parent, default_type=None)

Bases: dict

get(key, recurse=False)

get_key(key)

update(other)

class formatter2.TokenOffset(parent, type_, token, pre=0, post=0, children=None, end=None, pre_collapse=True, post_collapse=True)

Bases: object

copy(type_=None, token=None)

end

Set the end token in case of children.

Should either be a token or a tuple with TokenType and token which will be a string.

parent

The parent. TokenOffsets

surround

Surround the token with this amount of space. Setting will set the pre and post when given a tuple or int().

type

The type. TokenType

update(other)

class formatter2.DefaultTokenOffset(parent=None)

Bases: formatter2.offsets.TokenOffset

pprint(stream=<open file '<stderr>', mode 'w'>)

formatter Module

class formatter2.formatter.Formatter

Bases: object

format_directory(directory)

format_file(name)

format_path(path, recursive=False)

classmethod format_string(string)

main Module

formatter2.main.main(*argv)

offsets Module

class formatter2.offsets.DefaultTokenOffset(parent=None)

Bases: formatter2.offsets.TokenOffset

pprint(stream=<open file '<stderr>', mode 'w'>)

class formatter2.offsets.TokenOffset(parent, type_, token, pre=0, post=0, children=None, end=None, pre_collapse=True, post_collapse=True)

Bases: object

copy(type_=None, token=None)

end

Set the end token in case of children.

Should either be a token or a tuple with TokenType and token which will be a string.

parent

The parent. TokenOffsets

surround

Surround the token with this amount of space. Setting will set the pre and post when given a tuple or int().

type

The type. TokenType

update(other)

class formatter2.offsets.TokenOffsets(parent, default_type=None)

Bases: dict

get(key, recurse=False)

get_key(key)

update(other)

formatter2.offsets.get_token_offsets()

tokens Module

class formatter2.tokens.SmartList(*items, **kwargs)

Bases: list

copy()

set(value)

class formatter2.tokens.Token(offsets, tok_type, token, begin, end, line)

Bases: object

begin

The begin coordinates.

Settings this to a tuple will set the first to the row and the latter to the col.

This returns a SmartList with the row and the column.

begin_col

The begin column.

begin_row

The begin row.

col

The column.

Setting this to a tuple will set the first to the begin and the latter to the end.

This returns a SmartList with the begin and end column.

end

The end.

Settings this to a tuple will set the first to the row and the latter to the col.

This returns a SmartList with the row and column.

end_col

The end column.

end_row

The end row.

line

The line.

Setting the line automatically updates the column as well.

Returns a str() object with the line.

preprocess()

formatter2.types.TokenType.preprocess()

row

The row.

Setting this to a tuple will set the first to the begin and the latter to the end.

This returns a SmartList with the begin and end row.

type

class formatter2.tokens.Tokens(readline)

Bases: object

format()

Format the string, expects the extra whitespace to be removed already

classmethod from_fh(fh)

classmethod from_readline(readline)

generate_tokens(readline)

strip()

Strip all whitespace so we can begin formatting

to_str()

Convert the tokens back to a string

types Module

class formatter2.types.CommentTokenType(id_, name)

Bases: formatter2.types.TokenType

name = 'COMMENT'

preprocess(token)

class formatter2.types.DefaultTokenType

Bases: formatter2.types.TokenType

class formatter2.types.StringTokenType(id_, name)

Bases: formatter2.types.TokenType

name = 'STRING'

preprocess(token)

Preprocess the token

This automatically replaces strings with ” to ‘ if possible

class formatter2.types.TokenType(id_, name)

Bases: object

get_keys()

preprocess(token)

Preprocess the token, this can do pretty much anything including changing the column

class formatter2.types.TokenTypes

Bases: dict

register(token_type)

formatter2.types.get_token_types()