arxiv_query.py

#!/usr/bin/env python3
"""Return bibliographic data for a given a arXiv number.

https://arxiv.org/help/api/index
https://arxiv.org/help/api/basics
http://export.arxiv.org/api/query?id_list=2001.08293
"""

__author__ = "Joseph Reagle"
__copyright__ = "Copyright (C) 2009-2023 Joseph Reagle"
__license__ = "GLPv3"
__version__ = "1.0"

import logging as log
import pprint
import sys

import requests
import xmltodict

ACCEPT_HEADERS = {
    "atom": "application/atom+xml",
}


def query(number: int, accept: str = "application/atom+xml"):
    """Query the number Web service; returns string."""
    log.info(f"{accept=}")
    log.info(f"{number=}")
    headers = {"Accept": accept}
    url = f"http://export.arxiv.org/api/query?id_list={number}"
    log.info(f"{url=}")
    r = requests.get(url, headers=headers)
    requested_content_type = accept.split(";")[0]
    log.debug(f"{r=}")
    returned_content_type = r.headers["content-type"]
    log.info("{returned_content_type=}; {requested_content_type=}")
    if requested_content_type in returned_content_type:
        xml_bib = r.content
        return xmltodict.parse(xml_bib)["feed"]["entry"]

    else:
        return False


if __name__ == "__main__":
    import argparse

    arg_parser = argparse.ArgumentParser(
        description="Given an arXiv number return bibliographic data."
    )
    # positional arguments
    arg_parser.add_argument("number", nargs="+")
    # optional arguments
    arg_parser.add_argument("-s", "--style", help="style of bibliography data")
    arg_parser.add_argument(
        "-L",
        "--log-to-file",
        action="store_true",
        default=False,
        help="log to file %(prog)s.log",
    )
    arg_parser.add_argument(
        "-V",
        "--verbose",
        action="count",
        default=0,
        help="increase verbosity from critical though error, warning, info, and debug",
    )
    arg_parser.add_argument(
        "--version",
        action="version",
        version=f"{__version__} using Python {sys.version}",
    )
    args = arg_parser.parse_args()

    log_level = (log.CRITICAL) - (args.verbose * 10)
    LOG_FORMAT = "%(levelname).4s %(funcName).10s:%(lineno)-4d| %(message)s"
    if args.log_to_file:
        log.basicConfig(
            filename="arxiv_query.log",
            filemode="w",
            level=log_level,
            format=LOG_FORMAT,
        )
    else:
        log.basicConfig(level=log_level, format=LOG_FORMAT)

    accept = ACCEPT_HEADERS["atom"]
    if args.style:
        accept = ACCEPT_HEADERS.get(args.style, args.style)
    log.info(f"accept = {accept} ")

    pprint.pprint(query(args.number[0], accept))