API

StoringTeXhandler

Bases: BibTeXhandler

A BibTeX handler keeping the entries in memory

__init__()

Constructor

startDocument()

Called at the begin of a document's processing

addStringDefinition(key, value)

Adds the definition of a string

Stores the definition in the self._stringMap dictionary.

Parameters:
  • key (str) –

    The shortcut for the string.

  • value (str) –

    The value of the string.
Todo

Remove self._stringMapKeys

addComment(key, value)

Adds a comment

This implementation is somehow "magic" as it targets parsing JabRef comments that contain a group assignment.

Parameters:
  • key (str) –

    The name of the comment?

  • value (str) –

    The value of the comment.
Todo

Extract JabRef-parsing.

startEntry(entryID)

Called if a new entry is started to being parsed.

Begins entry by storing it in internal containers.

Parameters:
  • entryID (str) –

    The ID (key) of the entry

addField(entryID, key, value)

Called if a new attribute of an entry shall be added.

Stores the attribute in the self._entries[entryID] dictionary.

Parameters:
  • entryID (str) –

    The ID (key) of the entry

  • key (str) –

    The name of the attribute

  • value (str) –

    The value of the attribute

addField2(entryID, key, pairs)

Called if a new attribute consisting of multiple named fields shall be added.

Allocates a dictionary entry in self._entries[entryID] with the given key. Inserts the given pairs as key/values into this dictionary.

Parameters:
  • entryID (str) –

    The ID (key) of the entry

  • key (str) –

    The name of the attribute

  • pairs (List[Tuple[str, str]]) –

    The value of the attribute

closeEntry(entryID)

Closes the entry

Parameters:
  • entryID (str) –

    The ID (key) of the entry

endDocument()

Called after parsing a document