fractaltext.naked

class fractaltext.naked.Item
fractaltext.naked.from_dict(d: Any) Item

from_dict_naked

Convert from str-in-list-in-dict structure to document.

Parameters:

d (Any) – input str-in-list-in-dict structure

Returns:

output item

Return type:

Item

Raises:

ValueError – if d is not str-in-list-in-dict structure

fractaltext.naked.to_dict(it: Item) Any

to_dict_naked

Convert from document to str-in-list-in-dict structure.

Parameters:

it (Item) – input document

Returns:

output str-in-list-in-dict structure

Return type:

Any

exception fractaltext.naked.FractalTextParseError(message: str, n: int)
fractaltext.naked.load(f: TextIO) Item

load_naked

Main entry point for loading a naked FractalText document.

Parameters:

f (TextIO) – input text stream

Returns:

output naked document

Return type:

Item

Raises:

FractalTextParseError – if parse error happens

fractaltext.naked.parse(text: str) Item

parse_naked

Main entry point for parsing a naked FractalText document.

Parameters:

text (str) – input text

Returns:

output naked document

Return type:

Item

Raises:

FractalTextParseError – if parse error happens

fractaltext.naked.dump(it: Item, f: TextIO, isucc: int = 2)

dump_naked

Write serialized document which is naked.

Parameters:
  • doc (DocumentA) – input naked document

  • f (TextIO) – output text stream

  • isucc (int) – indent width

fractaltext.naked.serialize(it0: Item, isucc: int = 2) Iterable[str]

serialize_naked

Convert naked document into text stream.

Parameters:
  • doc (DocumentA) – input naked document

  • isucc (int) – indent width

Returns:

output linewise text stream

Return type:

Iterable[str]

fractaltext.naked.itself() Path
fractaltext.naked.lookup(k: str, n: Path) Path
fractaltext.naked.delete(it: Item, p: Path, i: int) Item
fractaltext.naked.exists(it: Item, p: Path) bool
fractaltext.naked.insert(it: Item, p: Path, i: int, v: str) Item
fractaltext.naked.update(it: Item, p: Path, i: int, v: str) Item