aselimov/pubs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

renamed n_authors into max_authors

Browse Source
This commit is contained in:
Fabien C. Y. Benureau 2020-05-10 08:53:11 +09:00
parent a30e75a5e6
commit 04b25a22c8
No known key found for this signature in database
GPG Key ID: C3FB5E831A249A9A
8 changed files with 22 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
pubs/commands/add_cmd.py
View File

@ -147,7 +147,7 @@ def command(conf, args):
doc_add = conf['main']['doc_add']
rp.push_paper(p)
ui.message('added to pubs:\n{}'.format(pretty.paper_oneliner(p, n_authors=conf['main']['n_authors'])))
ui.message('added to pubs:\n{}'.format(pretty.paper_oneliner(p, max_authors=conf['main']['max_authors'])))
if docfile is not None:
rp.push_doc(p.citekey, docfile, copy=(doc_add in ('copy', 'move')))
if doc_add == 'move' and content.content_type(docfile) != 'url':

2
pubs/commands/list_cmd.py
View File

@ -54,7 +54,7 @@ def command(conf, args):
papers = sorted(papers, key=date_added)
if len(papers) > 0:
ui.message('\n'.join(
pretty.paper_oneliner(p, citekey_only=args.citekeys, n_authors=conf['main']['n_authors'])
pretty.paper_oneliner(p, citekey_only=args.citekeys, max_authors=conf['main']['max_authors'])
for p in papers))
rp.close()

2
pubs/commands/tag_cmd.py
View File

@ -117,7 +117,7 @@ def command(conf, args):
len(p.tags.intersection(excluded)) == 0):
papers_list.append(p)
ui.message('\n'.join(pretty.paper_oneliner(p, n_authors=conf['main']['n_authors'])
ui.message('\n'.join(pretty.paper_oneliner(p, max_authors=conf['main']['max_authors'])
for p in papers_list))
rp.close()

2
pubs/config/spec.py
View File

@ -29,7 +29,7 @@ note_extension = string(default='txt')
# How many authors to display when displaying a citation. If there are more
# authors, only the first author is diplayed followed by 'et al.'.
n_authors = integer(default=3)
max_authors = integer(default=3)
# If true debug mode is on which means exceptions are not catched and
# the full python stack is printed.

20
pubs/pretty.py
View File

@ -23,30 +23,24 @@ def person_repr(p):
' '.join(p.lineage(abbr=True))] if s)
def short_authors(bibdata, n_authors=3):
def short_authors(bibdata, max_authors=3):
"""
:param n_authors: number of authors to display completely. Additional authors will be
:param max_authors: number of authors to display completely. Additional authors will be
represented by 'et al.'.
"""
try:
authors = [p for p in bibdata['author']]
if 0 < n_authors < len(authors):
if 0 < max_authors < len(authors):
authors_str = '{} et al.'.format(authors[0])
else:
authors_str = ' and '.join(authors)
# if n_authors > 0:
# authors = authors[:n_authors]
# authors_str = ' and '.join(authors)
# if 0 < n_authors < len(bibdata['author']):
# authors_str += ' et al.'
return authors_str
except KeyError: # When no author is defined
return ''
def bib_oneliner(bibdata, n_authors=3):
authors = short_authors(bibdata, n_authors=n_authors)
def bib_oneliner(bibdata, max_authors=3):
authors = short_authors(bibdata, max_authors=max_authors)
journal = ''
if 'journal' in bibdata:
journal = ' ' + bibdata['journal']
@ -71,11 +65,11 @@ def bib_desc(bib_data):
return s
def paper_oneliner(p, citekey_only=False, n_authors=3):
def paper_oneliner(p, citekey_only=False, max_authors=3):
if citekey_only:
return p.citekey
else:
bibdesc = bib_oneliner(p.get_unicode_bibdata(), n_authors=n_authors)
bibdesc = bib_oneliner(p.get_unicode_bibdata(), max_authors=max_authors)
doc_str = ''
if p.docpath is not None:
doc_extension = os.path.splitext(p.docpath)[1]

2
pubs/utils.py
View File

@ -33,7 +33,7 @@ def resolve_citekey(repo, citekey, ui=None, exit_on_fail=True):
"citekeys:".format(citekey))
for c in citekeys:
p = repo.pull_paper(c)
ui.message(' {}'.format(pretty.paper_oneliner(p, n_authors=conf['main']['n_authors'])))
ui.message(' {}'.format(pretty.paper_oneliner(p, max_authors=conf['main']['max_authors'])))
if exit_on_fail:
ui.exit()
return citekey

10
tests/test_pretty.py
View File

@ -28,15 +28,15 @@ class TestPretty(unittest.TestCase):
line = 'Page, Lawrence et al. "The PageRank Citation Ranking: Bringing Order to the Web."'
self.assertEqual(color.undye(pretty.bib_oneliner(bibdata['Page99'])), line)
def test_oneliner_n_authors(self):
def test_oneliner_max_authors(self):
decoder = endecoder.EnDecoder()
bibdata = decoder.decode_bibdata(bibtex_raw0)
for n_authors in [1, 2, 3]:
for max_authors in [1, 2, 3]:
line = 'Page, Lawrence et al. "The PageRank Citation Ranking: Bringing Order to the Web." (1999)'
self.assertEqual(color.undye(pretty.bib_oneliner(bibdata['Page99'], n_authors=n_authors)), line)
for n_authors in [-1, 0, 4, 5, 10]:
self.assertEqual(color.undye(pretty.bib_oneliner(bibdata['Page99'], max_authors=max_authors)), line)
for max_authors in [-1, 0, 4, 5, 10]:
line = 'Page, Lawrence and Brin, Sergey and Motwani, Rajeev and Winograd, Terry "The PageRank Citation Ranking: Bringing Order to the Web." (1999)'
self.assertEqual(color.undye(pretty.bib_oneliner(bibdata['Page99'], n_authors=n_authors)), line)
self.assertEqual(color.undye(pretty.bib_oneliner(bibdata['Page99'], max_authors=max_authors)), line)
if __name__ == '__main__':
unittest.main()

10
tests/test_usecase.py
View File

@ -1157,18 +1157,18 @@ class TestCache(DataCommandTestCase):
class TestConfigChange(DataCommandTestCase):
def test_n_authors_default(self):
def test_max_authors_default(self):
line_al = '[Page99] Page, Lawrence et al. "The PageRank Citation Ranking: Bringing Order to the Web." (1999) \n'
line_full = '[Page99] Page, Lawrence and Brin, Sergey and Motwani, Rajeev and Winograd, Terry "The PageRank Citation Ranking: Bringing Order to the Web." (1999) \n'
self.execute_cmds(['pubs init', 'pubs add data/pagerank.bib'])
for n_authors in [1, 2, 3]:
self.update_config({'main': {'n_authors': n_authors}})
for max_authors in [1, 2, 3]:
self.update_config({'main': {'max_authors': max_authors}})
self.execute_cmds([('pubs list', None, line_al, None)])
for n_authors in [-1, 0, 4, 5, 10]:
self.update_config({'main': {'n_authors': n_authors}})
for max_authors in [-1, 0, 4, 5, 10]:
self.update_config({'main': {'max_authors': max_authors}})
self.execute_cmds([('pubs list', None, line_full, None)])