API

JSONexportingTeXhandler

Bases: BibTeXhandler

A BibTex handler that exports entries as JSON.

__init__(fdo)

Constructor

Parameters:
  • fdo (file descriptor) –

    The file to write to

startDocument()

Called at the begin of a document's processing

addStringDefinition(key, value)

Adds the definition of a string

This implementation does nothing.

Parameters:
  • key (str) –

    The shortcut for the string

  • value (str) –

    The value of the string
Todo

check whether string definition should not be saved

addComment(key, value)

Adds a comment

This implementation does nothing.

Parameters:
  • key (str) –

    The name of the comment?

  • value (str) –

    The value of the comment

startEntry(entryID)

Called if a new entry is started to being parsed.

Begins entry encoding by generating a named JSON map.

Parameters:
  • entryID (str) –

    The ID (key) of the entry

addField(entryID, key, value)

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

Appends the attribute encoded as JSON to the current item's definition.

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.

Opens a new attribute with the given name and appends the pairs as key/value JSON objects inside it.

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