dql.output module

Formatting and displaying output

class dql.output.BaseFormat(results, ostream, width=u'auto', pagesize=u'auto')

Bases: object

Base class for formatters

display(self)

Write results to an output stream

format_field(self, field)

Format a single Dynamo value

pagesize

The number of results to display at a time

post_write(self)

Called once after writing all records

pre_write(self)

Called once before writing the very first record

wait(self)

Block for user input

width

The display width

write(self, result)

Write a single result and stick it in an output stream

class dql.output.ColumnFormat(*args, **kwargs)

Bases: dql.output.BaseFormat

A layout that puts item attributes in columns

post_write(self)

pre_write(self)

wait(self)

Block for user input

write(self, result)

class dql.output.ExpandedFormat(results, ostream, width=u'auto', pagesize=u'auto')

Bases: dql.output.BaseFormat

A layout that puts item attributes on separate lines

pagesize

write(self, result)

class dql.output.SmartBuffer(buf)

Bases: object

A buffer that wraps another buffer and encodes unicode strings.

flush(self)

flush the buffer

write(self, arg)

Write a string or bytes object to the buffer

class dql.output.SmartFormat(results, ostream, *args, **kwargs)

Bases: object

A layout that chooses column/expanded format intelligently

display(self)

Write results to an output stream

dql.output.delta_to_str(rd)

Convert a relativedelta to a human-readable string

dql.output.format_json(json_object, indent)

Pretty-format json data

dql.output.less_display(*args, **kwds)

Use smoke and mirrors to acquire ‘less’ for pretty paging

dql.output.make_list(obj)

Turn an object into a list if it isn’t already

dql.output.serialize_json_var(obj)

Serialize custom types to JSON

dql.output.stdout_display(*args, **kwds)

Print results straight to stdout

dql.output.truncate(string, length, ellipsis=u'u2026')

Truncate a string to a length, ending with ‘…’ if it overflows

dql.output.wrap(string, length, indent)

Wrap a string at a line length