bib2x

TeXhandler.JSON

API

JSONexportingTeXhandler

Bases: handler.BibTeXhandler

A BibTex handler that exports entries as JSON.

__init__(fdo)

Constructor

Parameters:

Name Type Description Default
fdo file descriptor

The file to write to

 required

startDocument()

Called at the begin of a document's processing

addStringDefinition(key, value)

Adds the definition of a string

This implementation does nothing.

Parameters:

Name Type Description Default
key str

The shortcut for the string

 required
value str

The value of the string

 required

Todo: check whether string definition should not be saved

addComment(key, value)

Adds a comment

This implementation does nothing.

Parameters:

Name Type Description Default
key str

The name of the comment?

 required
value str

The value of the comment

 required

startEntry(entryID)

Called if a new entry is started to being parsed.

Begins entry encoding by generating a named JSON map.

Parameters:

Name Type Description Default
entryID str

The ID (key) of the entry

 required

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:

Name Type Description Default
entryID str

The ID (key) of the entry

 required
key str

The name of the attribute

 required
value str

The value of the attribute

 required

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:

Name Type Description Default
entryID str

The ID (key) of the entry

 required
key str

The name of the attribute

 required
pairs List[Tuple[str, str]]

The value of the attribute

 required

closeEntry(entryID)

Closes the entry

Parameters:

Name Type Description Default
entryID str

The ID (key) of the entry

 required

endDocument()

Called after parsing a document