def _get_crossreferenced_citations(self, citations, min_crossrefs):
r"""
Get cititations not cited explicitly but referenced by other citations.
>>> from pybtex.database import Entry
>>> data = BibliographyData({
... 'main_article': Entry('article', {'crossref': 'xrefd_arcicle'}),
... 'xrefd_arcicle': Entry('article'),
... })
>>> list(data._get_crossreferenced_citations([], min_crossrefs=1))
[]
>>> list(data._get_crossreferenced_citations(['main_article'], min_crossrefs=1))
[u'xrefd_arcicle']
>>> list(data._get_crossreferenced_citations(['Main_article'], min_crossrefs=1))
[u'xrefd_arcicle']
>>> list(data._get_crossreferenced_citations(['main_article'], min_crossrefs=2))
[]
>>> list(data._get_crossreferenced_citations(['xrefd_arcicle'], min_crossrefs=1))
[]
>>> data2 = BibliographyData(data.entries, wanted_entries=data.entries.keys())
>>> list(data2._get_crossreferenced_citations([], min_crossrefs=1))
[]
>>> list(data2._get_crossreferenced_citations(['main_article'], min_crossrefs=1))
[u'xrefd_arcicle']
>>> list(data2._get_crossreferenced_citations(['Main_article'], min_crossrefs=1))
[u'xrefd_arcicle']
>>> list(data2._get_crossreferenced_citations(['main_article'], min_crossrefs=2))
[]
>>> list(data2._get_crossreferenced_citations(['xrefd_arcicle'], min_crossrefs=1))
[]
>>> list(data2._get_crossreferenced_citations(['xrefd_arcicle'], min_crossrefs=1))
[]
"""
crossref_count = CaseInsensitiveDefaultDict(int)
citation_set = CaseInsensitiveSet(citations)
for citation in citations:
try:
entry = self.entries[citation]
crossref = entry.fields['crossref']
except KeyError:
continue
try:
crossref_entry = self.entries[crossref]
except KeyError:
report_error(BibliographyDataError(
'bad cross-reference: entry "{key}" refers to '
'entry "{crossref}" which does not exist.'.format(
key=citation, crossref=crossref,
)
))
continue
canonical_crossref = crossref_entry.key
crossref_count[canonical_crossref] += 1
if crossref_count[canonical_crossref] >= min_crossrefs and canonical_crossref not in citation_set:
citation_set.add(canonical_crossref)
yield canonical_crossref
def __init__(self,
entries=None,
preamble=None,
wanted_entries=None,
min_crossrefs=2):
"""
A :py:class:`.BibliographyData` object contains a dictionary of bibliography
entries referenced by their keys.
Each entry represented by an :py:class:`.Entry` object.
Additionally, :py:class:`.BibliographyData` may contain a LaTeX
preamble defined by ``@PREAMBLE`` commands in the BibTeX file.
"""
self.entries = OrderedCaseInsensitiveDict()
'''A dictionary of bibliography entries referenced by their keys.
The dictionary is case insensitive:
>>> bib_data = parse_string("""
... @ARTICLE{gnats,
... author = {L[eslie] A. Aamport},
... title = {The Gnats and Gnus Document Preparation System},
... }
... """, 'bibtex')
>>> bib_data.entries['gnats'] == bib_data.entries['GNATS']
True
'''
self.crossref_count = CaseInsensitiveDefaultDict(int)
self.min_crossrefs = min_crossrefs
self._preamble = []
if wanted_entries is not None:
self.wanted_entries = CaseInsensitiveSet(wanted_entries)
self.citations = CaseInsensitiveSet(wanted_entries)
else:
self.wanted_entries = None
self.citations = CaseInsensitiveSet()
if entries:
if isinstance(entries, Mapping):
entries = entries.items()
for (key, entry) in entries:
self.add_entry(key, entry)
if preamble:
self._preamble.extend(preamble)
def __init__(self, entries=None, preamble=None, wanted_entries=None, min_crossrefs=2):
self.entries = OrderedCaseInsensitiveDict()
self.crossref_count = CaseInsensitiveDefaultDict(int)
self.min_crossrefs = min_crossrefs
self._preamble = []
if wanted_entries is not None:
self.wanted_entries = CaseInsensitiveSet(wanted_entries)
self.citations = CaseInsensitiveSet(wanted_entries)
else:
self.wanted_entries = None
self.citations = CaseInsensitiveSet()
if entries:
if isinstance(entries, Mapping):
entries = entries.iteritems()
for (key, entry) in entries:
self.add_entry(key, entry)
if preamble:
self._preamble.extend(preamble)
def __init__(self,
encoding=None,
macros=month_names,
person_fields=Person.valid_roles,
keyless_entries=False,
**kwargs):
BaseParser.__init__(self, encoding, **kwargs)
self.macros = CaseInsensitiveDict(macros)
self.person_fields = CaseInsensitiveSet(person_fields)
self.keyless_entries = keyless_entries
def expand_wildcard_citations(self, citations):
"""
Expand wildcard citations (\citation{*} in .aux file).
>>> from pybtex.database import Entry
>>> data = BibliographyData((
... ('uno', Entry('article')),
... ('dos', Entry('article')),
... ('tres', Entry('article')),
... ('cuatro', Entry('article')),
... ))
>>> list(data.expand_wildcard_citations([]))
[]
>>> list(data.expand_wildcard_citations(['*']))
['uno', 'dos', 'tres', 'cuatro']
>>> list(data.expand_wildcard_citations(['uno', '*']))
['uno', 'dos', 'tres', 'cuatro']
>>> list(data.expand_wildcard_citations(['dos', '*']))
['dos', 'uno', 'tres', 'cuatro']
>>> list(data.expand_wildcard_citations(['*', 'uno']))
['uno', 'dos', 'tres', 'cuatro']
>>> list(data.expand_wildcard_citations(['*', 'DOS']))
['uno', 'dos', 'tres', 'cuatro']
"""
citation_set = CaseInsensitiveSet()
for citation in citations:
if citation == '*':
for key in self.entries:
if key not in citation_set:
citation_set.add(key)
yield key
else:
if citation not in citation_set:
citation_set.add(citation)
yield citation
