mistletoe.block_token.ListItem

class documentation

class ListItem(BlockToken): (source)

List item token. This is a container block token. Its children are block tokens - container or leaf ones.

Not included in the parsing process, but called by List.

Class Method	`parse_continuation`	Returns content (i.e. the line with the prepend stripped off) iff the line is a valid continuation line for a list item with the given prepend length, otherwise None.
Class Method	`parse_marker`	Returns a tuple (prepend, leader, content) iff the line has a valid leader and at least one space separating leader and content, or if the content is empty, in which case there need not be any spaces. ...
Class Method	`read`	Undocumented
Static Method	`other_token`	Undocumented
Method	`__init__`	Undocumented
Class Variable	`continuation_pattern`	Undocumented
Class Variable	`pattern`	Undocumented
Class Variable	`repr_attributes`	Undocumented
Instance Variable	`children`	Undocumented
Instance Variable	`leader`	Undocumented
Instance Variable	`loose`	Undocumented
Instance Variable	`prepend`	Undocumented

Inherited from BlockToken:

Method __contains__ Undocumented

Inherited from Token (via BlockToken):

Method __repr__ Undocumented

@classmethod
def parse_continuation(cls, line, prepend): (source) ¶

Returns content (i.e. the line with the prepend stripped off) iff the line is a valid continuation line for a list item with the given prepend length, otherwise None.

Note that the list item may still continue even if this test doesn't pass due to lazy continuation.

@classmethod
def parse_marker(cls, line): (source) ¶

Returns a tuple (prepend, leader, content) iff the line has a valid leader and at least one space separating leader and content, or if the content is empty, in which case there need not be any spaces. The return value is None if the line doesn't have a valid marker.

The leader is a bullet list marker, or an ordered list marker.

The prepend is the start position of the content, i.e., the indentation required for continuation lines.

@classmethod
def read(cls, lines, prev_marker=None): (source) ¶

overrides mistletoe.block_token.BlockToken.read

Undocumented

@staticmethod
def other_token(line): (source) ¶

Undocumented

def __init__(self, parse_buffer, prepend, leader): (source) ¶

overrides mistletoe.block_token.BlockToken.__init__

Undocumented

continuation_pattern = (source) ¶

Undocumented