python-bibtexparser/bibtexparser/bibdatabase.py at master · bcbnz/python-bibtexparser · GitHub

History

122 lines (102 loc) · 3.33 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

from collections import OrderedDict

import sys

if sys.version_info.major == 2:

TEXT_TYPE = unicode

else:

TEXT_TYPE = str

STANDARD_TYPES = set([

'article',

'book',

'booklet',

'conference',

'inbook',

'incollection',

'inproceedings',

'manual',

'mastersthesis',

'misc',

'phdthesis',

'proceedings',

'techreport',

'unpublished'])

COMMON_STRINGS = {

'jan': 'January',

'feb': 'February',

'mar': 'March',

'apr': 'April',

'may': 'May',

'jun': 'June',

'jul': 'July',

'aug': 'August',

'sep': 'September',

'oct': 'October',

'nov': 'November',

'dec': 'December',

}

class BibDatabase(object):

"""

Bibliographic database object that follows the data structure of a BibTeX file.

"""

def __init__(self):

#: List of BibTeX entries, for example `@book{...}`, `@article{...}`, etc. Each entry is a simple dict with

#: BibTeX field-value pairs, for example `'author': 'Bird, R.B. and Armstrong, R.C. and Hassager, O.'` Each

#: entry will always have the following dict keys (in addition to other BibTeX fields):

#: * `ID` (BibTeX key)

#: * `ENTRYTYPE` (entry type in lowercase, e.g. `book`, `article` etc.)

self.entries = []

self._entries_dict = {}

#: List of BibTeX comment (`@comment{...}`) blocks.

self.comments = []

#: OrderedDict of BibTeX string definitions (`@string{...}`). In order of definition.

self.strings = OrderedDict() # Not sure if order is import, keep order just in case

#: List of BibTeX preamble (`@preamble{...}`) blocks.

self.preambles = []

def load_common_strings(self):

self.strings.update(COMMON_STRINGS)

def get_entry_list(self):

"""Get a list of bibtex entries.

:returns: BibTeX entries

:rtype: list

.. deprecated:: 0.5.6

Use :attr:`entries` instead.

"""

return self.entries

@staticmethod

def entry_sort_key(entry, fields):

result = []

for field in fields:

result.append(TEXT_TYPE(entry.get(field, '')).lower()) # Sorting always as string

return tuple(result)

def get_entry_dict(self):

"""Return a dictionary of BibTeX entries.

The dict key is the BibTeX entry key

"""

# If the hash has never been made, make it

if not self._entries_dict:

for entry in self.entries:

self._entries_dict[entry['ID']] = entry

return self._entries_dict

entries_dict = property(get_entry_dict)

def expand_string(self, name):

try:

return self.strings[name]

except KeyError:

raise(KeyError("Unknown string: {}.".format(name)))

class BibDataString(object):

"""

Represents a bibtex string.

This object enables mainting string expressions as list of strings

and BibDataString. Can be interpolated from Bibdatabase.

"""

def __init__(self, bibdatabase, name):

self._bibdatabase = bibdatabase

self.name = name.lower()

def __repr__(self):

return "BibDataString({})".format(self.name.__repr__())

def get_value(self):

"""

Query value from string name.

:returns: string

"""

return self._bibdatabase.expand_string(self.name)

python-bibtexparser/bibtexparser/bibdatabase.py at master · bcbnz/python-bibtexparser · GitHub

Expand file tree

Breadcrumbs

bibdatabase.py

Latest commit

History

Breadcrumbs

bibdatabase.py

File metadata and controls