# coding=utf-8
# Copyright (c) 2015-2018, UT-BATTELLE, LLC
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# 3. Neither the name of the copyright holder nor the names of its contributors
# may be used to endorse or promote products derived from this software without
# specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
import io
from pathlib import Path
import pybtex.database
import pybtex.io
from pybtex.backends.latex import Backend as LatexBaseBackend
from pybtex.backends.html import Backend as HTMLBaseBackend
from pybtex.style.formatting.plain import Style as PlainStyle
# FIXME: This is hacky! Here we're returning actual latex as if it's html so we
# can coopt the bib2html function. Either need to make a generic renderbib
# function or a bib2latex function...
[docs]class LatexBackend(LatexBaseBackend):
def __init__(self, *args, **kwargs):
super(LatexBackend, self).__init__(*args, **kwargs)
def _repr_html(self, formatted_bibliography):
stream = io.StringIO()
self.write_to_stream(formatted_bibliography, stream)
return stream.getvalue()
[docs]class HTMLBackend(HTMLBaseBackend):
def __init__(self, *args, **kwargs):
super(HTMLBackend, self).__init__(*args, **kwargs)
self._html = ''
[docs] def output(self, html):
self._html += html
[docs] def write_prologue(self):
self.output('<div class="bibliography"><h2>References</h2>'
'<p>LIVVkit is an open source project licensed under a BSD 3-clause License. '
'We ask that you please acknowledge LIVVkit in any work it is used or supports. '
'In any corresponding published work, please cite: </p><dl>')
[docs] def write_epilogue(self):
self.output('</dl></div>')
def _repr_html(self, formatted_bibliography):
self.write_prologue()
for entry in formatted_bibliography:
self.write_entry(entry.key, entry.label, entry.text.render(self))
self.write_epilogue()
return self._html.replace('\n', ' ').replace('\\url <a', '<a')
# FIXME: For python 3.7+ only...
# from functools import singledispatch
# from collections.abc import Iterable
# from typing import Union
#
# @singledispatch
# def bib2html(bib, style=None, backend=None):
# raise NotImplementedError('I do not now how to convert a {} type to a bibliography'.format(type(bib)))
[docs]def bib2html(bib, style=None, backend=None):
if isinstance(bib, (str, Path)):
return _bib2html_string(bib, style=style, backend=backend)
if isinstance(bib, (list, set, tuple)):
return _bib2html_list(bib, style=style, backend=backend)
if isinstance(bib, pybtex.database.BibliographyData):
return _bib2html_bibdata(bib, style=style, backend=backend)
else:
raise NotImplementedError('I do not now how to convert a {} type to a bibliography'.format(type(bib)))
# FIXME: For python 3.7+ only...
# @bib2html.register
# def _bib2html_string(bib: Union[str, Path], style=None, backend=None):
def _bib2html_string(bib, style=None, backend=None):
if style is None:
style = PlainStyle()
if backend is None:
backend = HTMLBackend()
formatted_bib = style.format_bibliography(pybtex.database.parse_file(bib))
return backend._repr_html(formatted_bib)
# FIXME: For python 3.7+ only...
# @bib2html.register
# def _bib2html_list(bib: Iterable, style=None, backend=None):
def _bib2html_list(bib, style=None, backend=None):
if style is None:
style = PlainStyle()
if backend is None:
backend = HTMLBackend()
bibliography = pybtex.database.BibliographyData()
for bib_file in bib:
temp_bib = pybtex.database.parse_file(bib_file)
for key, entry in temp_bib.entries.items():
try:
bibliography.add_entry(key, entry)
except pybtex.database.BibliographyDataError:
# FIXME: should log this...
# Skip duplicate entries
continue
formatted_bib = style.format_bibliography(bibliography)
return backend._repr_html(formatted_bib)
# FIXME: For python 3.7+ only...
# @bib2html.register
# def _bib2html_bibdata(bib: pybtex.database.BibliographyData, style=None, backend=None):
def _bib2html_bibdata(bib, style=None, backend=None):
if style is None:
style = PlainStyle()
if backend is None:
backend = HTMLBackend()
formatted_bib = style.format_bibliography(bib)
return backend._repr_html(formatted_bib)
