pubs/pubs/commands/add_cmd.py
Olivier Mangin de2a50eeb2 Fix tests and terminology.
First this brings a change to the paper API: the terminology of bibdata
and bibentry is clarified: now bibentry is a dictionary of the form
{citekey: bibdata} where bibdata corresponds to the actual dictionary of
bibliographic fields and values {author: ..., year: ...}.
Now bibentry is an attribute of the paper object that is generated from
citekey and bibdata.

This commit fixes all tests in particular an issue with citekey in
bibentry not updated.

Also removes prints in tests and deprecated assertEquals.

Usecase tests now fail if the command ask for unexpected inputs.

Removes queries for user input in attach and add commands (for deletion
of a copied document file). The input was not coherent with tests and is
annoying.
2015-05-07 13:17:44 +02:00

134 lines
4.7 KiB
Python

from ..uis import get_ui
from ..configs import config
from .. import bibstruct
from .. import content
from .. import repo
from .. import paper
from .. import templates
from .. import apis
from .. import color
from .. import pretty
def parser(subparsers):
parser = subparsers.add_parser('add', help='add a paper to the repository')
parser.add_argument('bibfile', nargs='?', default=None,
help='bibtex file')
parser.add_argument('-D', '--doi', help='doi number to retrieve the bibtex entry, if it is not provided', default=None)
parser.add_argument('-I', '--isbn', help='isbn number to retrieve the bibtex entry, if it is not provided', default=None)
parser.add_argument('-d', '--docfile', help='pdf or ps file', default=None)
parser.add_argument('-t', '--tags', help='tags associated to the paper, separated by commas',
default=None)
parser.add_argument('-k', '--citekey', help='citekey associated with the paper;\nif not provided, one will be generated automatically.',
default=None)
parser.add_argument('-L', '--link', action='store_false', dest='copy', default=True,
help="don't copy document files, just create a link.")
return parser
def bibentry_from_editor(ui, rp):
again = True
bibstr = templates.add_bib
while again:
try:
bibstr = content.editor_input(config().edit_cmd,
bibstr,
suffix='.bib')
if bibstr == templates.add_bib:
again = ui.input_yn(
question='Bibfile not edited. Edit again ?',
default='y')
if not again:
ui.exit(0)
else:
bibentry = rp.databroker.verify(bibstr)
bibstruct.verify_bibdata(bibentry)
# REFACTOR Generate citykey
again = False
except ValueError:
again = ui.input_yn(
question='Invalid bibfile. Edit again ?',
default='y')
if not again:
ui.exit(0)
return bibentry
def command(args):
"""
:param bibfile: bibtex file (in .bib, .bibml or .yaml format.
:param docfile: path (no url yet) to a pdf or ps file
"""
ui = get_ui()
bibfile = args.bibfile
docfile = args.docfile
tags = args.tags
citekey = args.citekey
rp = repo.Repository(config())
# get bibtex entry
if bibfile is None:
if args.doi is None and args.isbn is None:
bibentry = bibentry_from_editor(ui, rp)
else:
if args.doi is not None:
bibentry_raw = apis.doi2bibtex(args.doi)
bibentry = rp.databroker.verify(bibentry_raw)
if bibentry is None:
ui.error('invalid doi {} or unable to retrieve bibfile from it.'.format(args.doi))
if args.isbn is None:
ui.exit(1)
if args.isbn is not None:
bibentry_raw = apis.isbn2bibtex(args.isbn)
bibentry = rp.databroker.verify(bibentry_raw)
if bibentry is None:
ui.error('invalid isbn {} or unable to retrieve bibfile from it.'.format(args.isbn))
ui.exit(1)
# TODO distinguish between cases, offer to open the error page in a webbrowser.
# TODO offer to confirm/change citekey
else:
bibentry_raw = content.get_content(bibfile, ui=ui)
bibentry = rp.databroker.verify(bibentry_raw)
if bibentry is None:
ui.error('invalid bibfile {}.'.format(bibfile))
# citekey
citekey = args.citekey
if citekey is None:
base_key = bibstruct.extract_citekey(bibentry)
citekey = rp.unique_citekey(base_key)
elif citekey in rp:
ui.error('citekey already exist {}.'.format(citekey))
ui.exit(1)
p = paper.Paper.from_bibentry(bibentry, citekey=citekey)
# tags
if tags is not None:
p.tags = set(tags.split(','))
# document file
bib_docfile = bibstruct.extract_docfile(bibentry)
if docfile is None:
docfile = bib_docfile
elif bib_docfile is not None:
ui.warning(('Skipping document file from bib file '
'{}, using {} instead.').format(bib_docfile, docfile))
# create the paper
try:
rp.push_paper(p)
if docfile is not None:
rp.push_doc(p.citekey, docfile, copy=args.copy)
ui.print_('{}\nwas added to pubs.'.format(pretty.paper_oneliner(p)))
except ValueError as v:
ui.error(v.message)
ui.exit(1)