-
Notifications
You must be signed in to change notification settings - Fork 132
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
108 additions
and
108 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,108 +1,108 @@ | ||
| """ | ||
| `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.4.2' | ||
|
|
||
| from . import bibdatabase, bibtexexpression, bparser, bwriter, latexenc, customization | ||
|
|
||
|
|
||
| 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) | ||
|
|
||
|
|
||
| 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) | ||
|
|
||
|
|
||
| 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) | ||
| :type writer: BibTexWriter | ||
| :returns: BibTeX string | ||
| :rtype: unicode | ||
| """ | ||
| if writer is None: | ||
| writer = bwriter.BibTexWriter() | ||
| return writer.write(bib_database) | ||
|
|
||
|
|
||
| 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) | ||
| :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() | ||
| bibtex_file.write(writer.write(bib_database)) | ||
| """ | ||
| `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.4.3' | ||
|
|
||
| from . import bibdatabase, bibtexexpression, bparser, bwriter, latexenc, customization | ||
|
|
||
|
|
||
| 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) | ||
|
|
||
|
|
||
| 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) | ||
|
|
||
|
|
||
| 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) | ||
| :type writer: BibTexWriter | ||
| :returns: BibTeX string | ||
| :rtype: unicode | ||
| """ | ||
| if writer is None: | ||
| writer = bwriter.BibTexWriter() | ||
| return writer.write(bib_database) | ||
|
|
||
|
|
||
| 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) | ||
| :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() | ||
| bibtex_file.write(writer.write(bib_database)) |