Source code for bibtexparser

"""
`BibTeX <http://en.wikipedia.org/wiki/BibTeX>`_ is a bibliographic data file format.

The :mod:`bibtexparser` module can parse BibTeX files and write them. The API is similar to the
:mod:`json` module. The parsed data is returned as a simple :class:`BibDatabase` object with the main attribute being
:attr:`entries` representing bibliographic sources such as books and journal articles.

The following functions provide a quick and basic way to manipulate a BibTeX file.
More advanced features are also available in this module.

Parsing a file is as simple as::

    import bibtexparser
    with open('bibtex.bib') as bibtex_file:
       bibtex_database = bibtexparser.load(bibtex_file)

And writing::

    import bibtexparser
    with open('bibtex.bib', 'w') as bibtex_file:
        bibtexparser.dump(bibtex_database, bibtex_file)

"""
__all__ = [
    'loads', 'load', 'dumps', 'dump', 'bibdatabase',
    'bparser', 'bwriter', 'bibtexexpression', 'latexenc', 'customization',
]
__version__ = '1.1.0'

import sys

from . import bibdatabase, bibtexexpression, bparser, bwriter, latexenc, customization


[docs]def loads(bibtex_str, parser=None): """ Load :class:`BibDatabase` object from a string :param bibtex_str: input BibTeX string to be parsed :type bibtex_str: str or unicode :param parser: custom parser to use (optional) :type parser: BibTexParser :returns: bibliographic database object :rtype: BibDatabase """ if parser is None: parser = bparser.BibTexParser() return parser.parse(bibtex_str)
[docs]def load(bibtex_file, parser=None): """ Load :class:`BibDatabase` object from a file :param bibtex_file: input file to be parsed :type bibtex_file: file :param parser: custom parser to use (optional) :type parser: BibTexParser :returns: bibliographic database object :rtype: BibDatabase Example:: import bibtexparser with open('bibtex.bib') as bibtex_file: bibtex_database = bibtexparser.load(bibtex_file) """ if parser is None: parser = bparser.BibTexParser() return parser.parse_file(bibtex_file)
[docs]def dumps(bib_database, writer=None): """ Dump :class:`BibDatabase` object to a BibTeX string :param bib_database: bibliographic database object :type bib_database: BibDatabase :param writer: custom writer to use (optional) (not yet implemented) :type writer: BibTexWriter :returns: BibTeX string :rtype: unicode """ if writer is None: writer = bwriter.BibTexWriter() return writer.write(bib_database)
[docs]def dump(bib_database, bibtex_file, writer=None): """ Dump :class:`BibDatabase` object as a BibTeX text file :param bib_database: bibliographic database object :type bib_database: BibDatabase :param bibtex_file: file to write to :type bibtex_file: file :param writer: custom writer to use (optional) (not yet implemented) :type writer: BibTexWriter Example:: import bibtexparser with open('bibtex.bib', 'w') as bibtex_file: bibtexparser.dump(bibtex_database, bibtex_file) """ if writer is None: writer = bwriter.BibTexWriter() if sys.version_info >= (3, 0): bibtex_file.write(writer.write(bib_database)) else: # Encode to UTF-8 bibtex_file.write(writer.write(bib_database).encode("utf-8"))