You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
119 lines
3.7 KiB
119 lines
3.7 KiB
from __future__ import (print_function, absolute_import, division,
|
|
unicode_literals)
|
|
|
|
import copy
|
|
|
|
try:
|
|
import bibtexparser as bp
|
|
except ImportError:
|
|
print("error: you need to install bibterxparser; try running 'pip install "
|
|
"bibtexparser'.")
|
|
exit(-1)
|
|
|
|
import yaml
|
|
|
|
|
|
"""Important notice:
|
|
All functions and methods in this file assume and produce unicode data.
|
|
"""
|
|
|
|
|
|
def sanitize_citekey(record):
|
|
record['id'] = record['id'].strip('\n')
|
|
return record
|
|
|
|
|
|
def customizations(record):
|
|
""" Use some functions delivered by the library
|
|
|
|
:param record: a record
|
|
:returns: -- customized record
|
|
"""
|
|
record = bp.customization.convert_to_unicode(record)
|
|
record = bp.customization.type(record)
|
|
record = bp.customization.author(record)
|
|
record = bp.customization.editor(record)
|
|
record = bp.customization.journal(record)
|
|
record = bp.customization.keyword(record)
|
|
record = bp.customization.link(record)
|
|
record = bp.customization.page_double_hyphen(record)
|
|
record = bp.customization.doi(record)
|
|
|
|
record = sanitize_citekey(record)
|
|
|
|
return record
|
|
|
|
bibfield_order = ['author', 'title', 'journal', 'institution', 'publisher',
|
|
'year', 'month', 'number', 'pages', 'link', 'doi', 'id',
|
|
'note', 'abstract']
|
|
|
|
|
|
class EnDecoder(object):
|
|
""" Encode and decode content.
|
|
|
|
Design choices:
|
|
* Has no interaction with disk.
|
|
* Incoming content is not trusted.
|
|
* Returned content must be correctly formatted (no one else checks).
|
|
* Failures raise ValueError
|
|
* encode_bibdata will try to recognize exceptions
|
|
"""
|
|
|
|
def encode_metadata(self, metadata):
|
|
return yaml.safe_dump(metadata, allow_unicode=True,
|
|
encoding=None, indent=4)
|
|
|
|
def decode_metadata(self, metadata_raw):
|
|
return yaml.safe_load(metadata_raw)
|
|
|
|
def encode_bibdata(self, bibdata):
|
|
"""Encode bibdata """
|
|
return '\n'.join(self._encode_bibentry(citekey, entry)
|
|
for citekey, entry in bibdata.items())
|
|
|
|
@staticmethod
|
|
def _encode_field(key, value):
|
|
if key == 'link':
|
|
return ', '.join(link['url'] for link in value)
|
|
elif key == 'author':
|
|
return ' and '.join(author for author in value)
|
|
elif key == 'editor':
|
|
return ' and '.join(editor['name'] for editor in value)
|
|
elif key == 'journal':
|
|
return value['name']
|
|
elif key == 'keyword':
|
|
return ', '.join(keyword for keyword in value)
|
|
else:
|
|
return value
|
|
|
|
@staticmethod
|
|
def _encode_bibentry(citekey, bibentry):
|
|
bibraw = '@{}{{{},\n'.format(bibentry['type'], citekey)
|
|
bibentry = copy.copy(bibentry)
|
|
for key in bibfield_order:
|
|
if key in bibentry:
|
|
value = bibentry.pop(key)
|
|
bibraw += ' {} = {{{}}},\n'.format(
|
|
key, EnDecoder._encode_field(key, value))
|
|
for key, value in bibentry.items():
|
|
if key != 'type':
|
|
bibraw += ' {} = {{{}}},\n'.format(
|
|
key, EnDecoder._encode_field(key, value))
|
|
bibraw += '}\n'
|
|
return bibraw
|
|
|
|
def decode_bibdata(self, bibdata):
|
|
""""""
|
|
try:
|
|
entries = bp.bparser.BibTexParser(
|
|
bibdata, customization=customizations).get_entry_dict()
|
|
# Remove 'id' attribute which is stored as citekey
|
|
for e in entries:
|
|
entries[e].pop('id')
|
|
if len(entries) > 0:
|
|
return entries
|
|
except Exception:
|
|
import traceback
|
|
traceback.print_exc()
|
|
raise ValueError('could not parse bibdata')
|