Skip to content

Commit

Permalink
Merge pull request #37 from dwijn/master
Browse files Browse the repository at this point in the history
  • Loading branch information
yymao authored Sep 15, 2023
2 parents a7741d1 + 048a1de commit 1011f93
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 18 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,10 @@ source that you specified in your tex source file.
You can use `--no-update` to turn this feature off,
so that `adstex` will only look for new entries.

In addition, you can turn on parallel execution by adding the `--parallel`
option. You can further specify the number of threads it uses with
`--parallel=x` (default is 8).

6. **I have different citation keys that point to the same paper in my tex file,
can `adstex` merge and remove the repetitions?**

Expand Down
62 changes: 44 additions & 18 deletions adstex.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
from collections import defaultdict
from datetime import date
from shutil import copyfile
from joblib import Parallel, delayed

import ads
import bibtexparser
Expand All @@ -29,7 +30,7 @@
except ImportError:
from urllib import unquote

__version__ = "0.4.0"
__version__ = "0.5.0"

_this_year = date.today().year % 100
_this_cent = date.today().year // 100
Expand Down Expand Up @@ -227,11 +228,7 @@ def authoryear2bibcode(author, year, key):
return authoryear2bibcode(new_author, year, key)


def find_bibcode(key):
bibcode = id2bibcode(key)
if bibcode:
return bibcode

def find_bibcode_interactive(key):
m = _re_fayear.match(key)
if m:
fa, y = m.groups()
Expand Down Expand Up @@ -328,6 +325,18 @@ def main():
action="store_true",
help="disable SSL verification (it will render your API key vulnerable)",
)
parser.add_argument(
"--parallel",
"-P",
action="store_true",
help="enable parallel ADS update queries",
) # thanks to dwijn for adding this option
parser.add_argument(
"--threads",
default=8,
type=int,
help="specify the number of threads used when --parallel is set (default: 8)",
) # thanks to dwijn for adding this option
parser.add_argument(
"--version",
action="version",
Expand All @@ -349,9 +358,7 @@ def main():
print("OK, abort!")
return

if len(args.files) == 1 and args.files[0].lower().endswith(
".bib"
): # bib update mode
if len(args.files) == 1 and args.files[0].lower().endswith(".bib"): # bib update mode
if args.output or args.other:
parser.error(
"Input file is a bib file, not tex file. This will enter bib update mode. Do not specify `--output` and `--other` together in this mode."
Expand Down Expand Up @@ -403,11 +410,12 @@ def main():
if keys is None: # bib update mode
keys = list(bib.entries_dict)

interactive = set()
not_found = set()
to_retrieve = set()
all_entries = defaultdict(list)

for key in keys:
def update(key):
key_exists = key in bib.entries_dict
key_exists_in_others = key in bib_other.entries_dict

Expand All @@ -432,30 +440,48 @@ def main():
bibcode_new,
)
)
continue
return

if key_exists:
print("{}: EXISTING".format(key))
continue
return

if key_exists_in_others and args.merge_other:
bib.entries_dict[key] = bib_other.entries_dict[key]
bib.entries = list(bib.entries_dict.values())
print("{}: FOUND IN OTHER BIB SOURCE, MERGED".format(key))
continue
return

if key_exists_in_others:
print("{}: FOUND IN OTHER BIB SOURCE, IGNORED".format(key))
continue
return

bibcode = find_bibcode(key)
bibcode = id2bibcode(key)
if bibcode:
to_retrieve.add(bibcode)
all_entries[bibcode].append(key)
print("{}: NEW ENTRY => {}".format(key, bibcode))
else:
not_found.add(key)
print("{}: NOT FOUND".format(key))
return

# if all above failed
interactive.add(key)

if args.parallel:
Parallel(n_jobs=args.threads, prefer="threads")(delayed(update)(key) for key in keys)
else:
[update(key) for key in keys]

if interactive:
print(_headerize("Resolving keys that do not contain identifiers..."))
for key in interactive:
bibcode = find_bibcode_interactive(key)
if bibcode:
to_retrieve.add(bibcode)
all_entries[bibcode].append(key)
print("{}: NEW ENTRY => {}".format(key, bibcode))
else:
not_found.add(key)
print("{}: NOT FOUND".format(key))

if not_found:
print(_headerize("Please check the following keys"))
Expand Down
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
"requests>=2.0",
"packaging>=17.0",
"future>=0.12.0 ; python_version < '3.0'",
"joblib>=1",
],
entry_points={"console_scripts": ["adstex=adstex:main"]},
)

0 comments on commit 1011f93

Please sign in to comment.