Python 1. Parsing a document
1.1. Providing the source
1.2. Localized errors
1.3. Error formats
1.4. Cursor lookup
2. Querying content
2.1. Field values
2.2. List values
2.3. Keys and Comments
2.4. Predefined Types
2.5. Custom Types
3. Querying elements
3.1. Optional/required
3.2. Dynamic layouts
3.3. Requiring all elements
4. Touching elements
4.1. Assert all touched
4.2. Manual touching
5. Error Metadata
5.1. Message
5.2. Text
5.3. Snippet
5.4. Cursor
5.5. Selection
6. Addendum
6.1. A complete example
6.2. AST inspection
6.3. FAQ

Keys and Comments

Querying keys

All elements have a key (list items return the key of the list) therefore you don't need to specify optional/required here:

>>> document.elements()[0].string_key()
>>> document.fieldset('image').entries()[0].string_key()

Querying comments

All elements can have an associated comment and like with values you specify whether it's optional or required:

>>> document.field('author').required_string_comment()
>>> document.fieldset('image').optional_string_comment()

Next page: Predefined Types