module documentation
Module for reading, writing and manipulating Toolbox databases and settings files.
| Class | |
Class for reading and processing standard format marker files and strings. |
| Class | |
No class docstring; 2/4 methods documented |
| Class | |
This class is the base class for settings files. |
| Function | add |
Add blank lines before all elements and subelements specified in blank_before. |
| Function | add |
Add blank elements and subelements specified in default_fields. |
| Function | demo |
Undocumented |
| Function | remove |
Remove all elements and subelements with no text and no child elements. |
| Function | sort |
Sort the elements and subelements in order specified in field_orders. |
| Function | to |
Undocumented |
| Function | to |
Return a string with a standard format representation of the toolbox data in tree (tree can be a toolbox database or a single record). |
| Function | _sort |
sort the children of elem |
| Function | _to |
Undocumented |
| Variable | _is |
Undocumented |
Add blank lines before all elements and subelements specified in blank_before.
| Parameters | |
| tree | Undocumented |
| blanks | Undocumented |
| blanks | Undocumented |
| elem:ElementTree._ElementInterface | toolbox data in an elementtree structure |
| blank | elements and subelements to add blank lines before |
Add blank elements and subelements specified in default_fields.
| Parameters | |
| elem:ElementTree._ElementInterface | toolbox data in an elementtree structure |
| default | fields to add to each type of element and subelement |
Remove all elements and subelements with no text and no child elements.
| Parameters | |
| elem:ElementTree._ElementInterface | toolbox data in an elementtree structure |
Sort the elements and subelements in order specified in field_orders.
| Parameters | |
| elem:ElementTree._ElementInterface | toolbox data in an elementtree structure |
| field | order of fields for each type of element and subelement |
Return a string with a standard format representation of the toolbox data in tree (tree can be a toolbox database or a single record).
| Parameters | |
| tree:ElementTree._ElementInterface | flat representation of toolbox data (whole database or single record) |
| encoding:str | Name of an encoding to use. |
| errors:str | Error handling scheme for codec. Same as the encode() builtin string method. |
| unicode | |
| Returns | |
| str | Undocumented |