# vim:fileencoding=utf8
# Copyright (c) 2006-2021 Andrey Golovizin
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
"""
A template engine for bibliography entries and more.
Inspired by Brevé -- http://breve.twisty-industries.com/
>>> from pybtex.database import Entry, Person
>>> author = Person(first='First', last='Last', middle='Middle')
>>> fields = {
... 'title': 'The Book',
... 'year': '2000',
... }
>>> e = Entry('book', fields=fields)
>>> book_format = sentence(capfirst=True, sep=', ') [
... field('title'), field('year'), optional [field('sdf')]
... ]
>>> print(six.text_type(book_format.format_data({'entry': e})))
The Book, 2000.
>>> print(six.text_type(words ['one', 'two', words ['three', 'four']].format_data(e)))
one two three four
"""
from __future__ import unicode_literals
import six
from pybtex import richtext
from pybtex.exceptions import PybtexError
from pybtex.py3compat import fix_unicode_literals_in_doctest
__test__ = {} # for doctest
class Node(object):
def __init__(self, name, f):
self.name = name
self.f = f
self.args = []
self.kwargs = {}
self.children = []
def _clone(self):
result = Node(self.name, self.f)
result.args = list(self.args)
result.kwargs = dict(self.kwargs)
result.children = list(self.children)
return result
def __call__(self, *args, **kwargs):
result = self._clone()
result.args.extend(args)
result.kwargs.update(kwargs)
return result
def __getitem__(self, children):
result = self._clone()
if isinstance(children, (list, tuple)):
result.children.extend(children)
else:
result.children.append(children)
return result
@fix_unicode_literals_in_doctest
def __repr__(self):
"""
>>> join(', ')
join(u', ')
>>> join
join
>>> join ['a']
join [u'a']
>>> join ['a', 'b', 'c']
join [u'a', u'b', u'c']
>>> join(' ') [u'a', u'b', u'c']
join(u' ') [u'a', u'b', u'c']
>>> join(sep=' ') [u'a', u'b', u'c']
join(sep=u' ') [u'a', u'b', u'c']
>>> join(sep=u' ') [tag('em') [u'a', u'b', u'c']]
join(sep=u' ') [tag(u'em') [u'a', u'b', u'c']]
"""
params = []
args_repr = ', '.join(repr(arg) for arg in self.args)
if args_repr:
params.append(args_repr)
kwargs_repr = ', '.join(
'%s=%s' % (key, repr(value)) for (key, value) in self.kwargs.items()
)
if kwargs_repr:
params.append(kwargs_repr)
if params:
params_repr = '(%s)' % ', '.join(params)
else:
params_repr = ''
if self.children:
children_repr = ' [%s]' % ', '.join(
repr(child) for child in self.children
)
else:
children_repr = ''
return ''.join([self.name, params_repr, children_repr])
def format_data(self, data):
"""Format the given data into a piece of richtext.Text"""
return self.f(self.children, data, *self.args, **self.kwargs)
def format(self):
"""A convenience function to be used instead of format_data
when no data is needed.
"""
return self.format_data(None)
def _format_data(node, data):
try:
f = node.format_data
except AttributeError:
return node
else:
return f(data)
def _format_list(list_, data):
return (_format_data(part, data) for part in list_)
def node(f):
if f.__doc__:
__test__[f.__name__] = f
return Node(f.__name__, f)
[docs]@node
def join(children, data, sep='', sep2=None, last_sep=None):
"""Join text fragments together.
>>> print(six.text_type(join.format()))
<BLANKLINE>
>>> print(six.text_type(join ['a', 'b', 'c', 'd', 'e'].format()))
abcde
>>> print(six.text_type(join(sep=', ', sep2=' and ', last_sep=', and ') ['Tom', 'Jerry'].format()))
Tom and Jerry
>>> print(six.text_type(join(sep=', ', sep2=' and ', last_sep=', and ') ['Billy', 'Willy', 'Dilly'].format()))
Billy, Willy, and Dilly
"""
if sep2 is None:
sep2 = sep
if last_sep is None:
last_sep = sep
parts = [part for part in _format_list(children, data) if part]
if len(parts) <= 1:
return richtext.Text(*parts)
elif len(parts) == 2:
return richtext.Text(sep2).join(parts)
else:
return richtext.Text(last_sep).join([richtext.Text(sep).join(parts[:-1]), parts[-1]])
@node
def words(children, data, sep=' '):
"""Join text fragments with spaces or something else."""
return join(sep) [children].format_data(data)
@node
def together(children, data, last_tie=False):
"""
Try to keep words together, like BibTeX does.
>>> print(six.text_type(together ['very', 'long', 'road'].format()))
very long road
>>> print(six.text_type(together(last_tie=True) ['very', 'long', 'road'].format()))
very long<nbsp>road
>>> print(six.text_type(together ['a', 'very', 'long', 'road'].format()))
a<nbsp>very long road
>>> print(six.text_type(together ['chapter', '8'].format()))
chapter<nbsp>8
>>> print(six.text_type(together ['chapter', '666'].format()))
chapter 666
"""
from pybtex.textutils import tie_or_space
tie = richtext.nbsp
space = richtext.String(' ')
parts = [part for part in _format_list(children, data) if part]
if not parts:
return richtext.Text()
if len(parts) <= 2:
tie2 = tie if last_tie else tie_or_space(parts[0], tie, space, other_word=parts[-1])
return tie2.join(parts)
else:
last_tie = tie if last_tie else tie_or_space(parts[-1], tie, space)
return richtext.Text(
parts[0], tie_or_space(parts[0], tie, space),
space.join(parts[1:-1]), last_tie, parts[-1]
)
[docs]@node
def sentence(children, data, capfirst=False, capitalize=False, add_period=True, sep=', '):
"""Join text fragments, capitalyze the first letter, add a period to the end.
>>> print(six.text_type(sentence.format()))
<BLANKLINE>
>>> print(six.text_type(sentence(capitalize=True, sep=' ') ['mary', 'had', 'a', 'little', 'lamb'].format()))
Mary had a little lamb.
>>> print(six.text_type(sentence(capitalize=False, add_period=False) ['uno', 'dos', 'tres'].format()))
uno, dos, tres
"""
text = join(sep) [children].format_data(data)
if capfirst:
text = text.capfirst()
if capitalize:
text = text.capitalize()
if add_period:
text = text.add_period()
return text
class FieldIsMissing(PybtexError):
def __init__(self, field_name, entry):
self.field_name = field_name
super(FieldIsMissing, self).__init__(
u'missing {0} in {1}'.format(field_name, getattr(entry, 'key', '<unnamed>'))
)
@node
def field(children, context, name, apply_func=None, raw=False):
"""Return the contents of the bibliography entry field."""
assert not children
entry = context['entry']
try:
field = entry._find_field(name, bib_data=context.get('bib_data'))
if not raw:
field = richtext.Text.from_latex(field)
except KeyError:
raise FieldIsMissing(name, entry)
else:
if apply_func:
field = apply_func(field)
return field
[docs]@node
def names(children, context, role, **kwargs):
"""Return formatted names."""
assert not children
try:
persons = context['entry'].persons[role]
except KeyError:
raise FieldIsMissing(role, context['entry'])
style = context['style']
formatted_names = [style.format_name(person, style.abbreviate_names) for person in persons]
return join(**kwargs) [formatted_names].format_data(context)
@node
def optional(children, data):
"""If children contain a missing bibliography field, return None.
Else return formatted children.
>>> from pybtex.database import Entry
>>> template = optional [field('volume'), optional['(', field('number'), ')']]
>>> template.format_data({'entry': Entry('article')})
Text()
"""
try:
return richtext.Text(*_format_list(children, data))
except FieldIsMissing:
return richtext.Text()
@node
def optional_field(children, data, *args, **kwargs):
assert not children
return optional [field(*args, **kwargs)].format_data(data)
@node
def tag(children, data, name):
"""Wrap text into a tag.
>>> print(tag('em') ['important'].format().render_as('html'))
<em>important</em>
>>> print(sentence ['ready', 'set', tag('em') ['go']].format().render_as('html'))
ready, set, <em>go</em>.
>>> print(sentence(capitalize=True) ['ready', 'set', tag('em') ['go']].format().render_as('html'))
Ready, set, <em>go</em>.
"""
parts = _format_list(children, data)
return richtext.Tag(name, *parts)
@node
def href(children, data):
"""Wrap text into a href.
>>> print(href ['www.test.org', 'important'].format().render_as('html'))
<a href="www.test.org">important</a>
>>> print(sentence ['ready', 'set', href ['www.test.org', 'go']].format().render_as('html'))
ready, set, <a href="www.test.org">go</a>.
"""
parts = _format_list(children, data)
return richtext.HRef(*parts)
@node
def first_of(children, data):
"""Return first nonempty child."""
for child in _format_list(children, data):
if child:
return child
return richtext.Text()