OrderedListBuilder Class

Inheritance diagram of OrderedListBuilder

class OrderedListBuilder(start, format)

Constructor:

__init__(start, format)

Create an ordered list with sequentially numbered mark text.

The format is composed of an optional prefix text, a numbering scheme character followed by suffix text. Valid numbering schemes are:

1
Decimal Arabic
a
Lowercase alphanumeric
A
Uppercase alphanumeric
i
Lowercase Roman
I
Uppercase Roman

Prefix text may typically be ( or [ and suffix text is typically ., ) or empty, but either can be any string.

Parameters:
  • start (int) – First list item number.
  • format (str) – Format style, for example "1.".

Methods:

begin(decoder, style) Begin a list.
get_mark(value)
item(decoder, style[, value]) Begin a list item.

Attributes:

format_re Type: SRE_Pattern

Methods

OrderedListBuilder.get_mark(value)

Attributes

OrderedListBuilder.format_re = <_sre.SRE_Pattern object at 0x99a3458>

Inherited members

Methods

OrderedListBuilder.begin(decoder, style)

Begin a list.

Parameters:
  • decoder (StructuredTextDecoder) – Decoder.
  • style (dict) – Style dictionary that applies over the entire list.
OrderedListBuilder.item(decoder, style, value=None)

Begin a list item.

Parameters:
  • decoder (StructuredTextDecoder) – Decoder.
  • style (dict) – Style dictionary that applies over the list item.
  • value (str) – Optional value of the list item. The meaning is list-type dependent.

Table Of Contents

Previous topic

ListBuilder Class

Next topic

StructuredTextDecoder Class