Homec4science
Diffusion invenio-infoscience (master) Browse

R3600/modules/bibclassify/lib/bibclassify_cli.py
a3c0c8681ca8master

Last Change
Raw File

bibclassify_cli.py
View Options

# -*- coding: utf-8 -*-
##
## This file is part of CDS Invenio.
## Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008 CERN.
##
## CDS Invenio is free software; you can redistribute it and/or
## modify it under the terms of the GNU General Public License as
## published by the Free Software Foundation; either version 2 of the
## License, or (at your option) any later version.
##
## CDS Invenio is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with CDS Invenio; if not, write to the Free Software Foundation, Inc.,
## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
"""
Bibclassify keyword extractor command line entry point.
"""
__revision__ = "$Id$"
import getopt
import os
import sys
import time
try:
from bibclassifylib import get_regular_expressions, \
get_keywords_from_text
from bibclassify_text_extractor import text_lines_from_local_file, \
text_lines_from_url, \
is_pdf
except ImportError, err:
print >> sys.stderr, "Error: %s" % err
sys.exit(1)
_OPTIONS = {}
def display_help():
"""Prints the help message for this module."""
print >> sys.stdout, """Usage: bibclassify [OPTION]... [FILE/URL]...
or: bibclassify [OPTION]... [DIRECTORY]...
Searches keywords in FILEs and/or files in DIRECTORY(ies). If a directory is
specified, BibClassify will generate keywords for all PDF documents contained
in the directory.
-h, --help display this help and exit
-V, --version output version information and exit
-v, --verbose LEVEL sets the verbose to LEVEL (=0)
-k, --ontology FILE sets the FILE to read the ontology from
-o, --output-mode TYPE changes the output format to TYPE (text, marcxml or
html) (=text)
-s, --spires outputs keywords in the SPIRES format
-n, --keywords-number INT sets the number of keywords displayed (=20), use 0
to set no limit
-m, --matching-mode TYPE changes the search mode to TYPE (full or partial)
(=full)
--rebuild-cache ignores the existing cache and regenerates it
--no-cache don't cache the ontology
Backward compatibility (using these options is discouraged):
-q equivalent to -s
-f FILE URL sets the file to read the keywords from
Example:
python bibclassifycli.py -k etc/HEP.rdf http://arxiv.org/pdf/0808.1825
python bibclassifycli.py -k etc/HEP.rdf article.pdf
python bibclassifycli.py -k etc/HEP.rdf directory/"""
sys.exit(0)
def main():
"""Main function """
read_options(sys.argv[1:])
# Ontology check
if _OPTIONS["check_ontology"]:
print >> sys.stdout, ("Checking ontology file %s" %
_OPTIONS["ontology_file"])
# End of ontology check.
# Initialize cache
get_regular_expressions(_OPTIONS["ontology_file"],
_OPTIONS["rebuild_cache"],
_OPTIONS["no_cache"])
for entry in _OPTIONS["text_files"]:
text_lines = None
source = ""
if os.path.isdir(entry):
for filename in os.listdir(entry):
if (os.path.isfile(entry + filename) and
is_pdf(entry + filename)):
source = filename
text_lines = text_lines_from_local_file(entry + filename)
elif os.path.isfile(entry):
text_lines = text_lines_from_local_file(entry)
source = os.path.basename(entry)
else:
# Treat as a URL.
text_lines = text_lines_from_url(entry)
source = entry.split("/")[-1]
if text_lines is not None:
print >> sys.stdout, source
print >> sys.stdout, get_keywords_from_text(text_lines,
output_mode=_OPTIONS["output_mode"],
output_limit=_OPTIONS["output_limit"],
spires=_OPTIONS["spires"],
match_mode=_OPTIONS["match_mode"],
with_explicit=_OPTIONS["with_explicit"])
def read_options(options_string):
"""Reads the options, test if the specified values are consistent and
populates the options dictionary."""
global _OPTIONS
_OPTIONS = {}
_OPTIONS["spires"] = False
_OPTIONS["output_limit"] = 20
_OPTIONS["text_files"] = []
_OPTIONS["ontology_file"] = ""
_OPTIONS["output_mode"] = "text"
_OPTIONS["verbose"] = 0
_OPTIONS["match_mode"] = "full"
_OPTIONS["output_prefix"] = None
_OPTIONS["rebuild_cache"] = False
_OPTIONS["no_cache"] = False
_OPTIONS["check_ontology"] = False
_OPTIONS["with_explicit"] = False
output_modes = ("html", "text", "marcxml")
modes = ("full", "partial")
try:
long_flags = ["ontology=", "output-mode=", "verbose=", "spires",
"keywords-number=", "matching-mode=", "help", "version",
"file", "rebuild-cache", "no-limit", "no-cache",
"check-ontology", "with-explicit"]
short_flags = "f:k:o:n:m:v:sqhV"
opts, args = getopt.gnu_getopt(options_string, short_flags, long_flags)
except getopt.GetoptError, err1:
print >> sys.stderr, "Options problem: %s" % err1
usage()
for opt, arg in opts:
if opt in ("-h", "--help"):
display_help()
elif opt in ("-V", "--version"):
# TODO Fix version
print >> sys.stdout, "Should output the version."
sys.exit(1)
elif opt in ("-v", "--verbose"):
_OPTIONS["verbose"] = arg
elif opt in ("-k", "--ontology"):
_OPTIONS["ontology_file"] = arg
elif opt in ("-o", "--output-mode"):
_OPTIONS["output_mode"] = arg.lower()
elif opt in ("-m", "--matching-mode"):
_OPTIONS["match_mode"] = arg.lower()
# -q for backward compatibility
elif opt in ("-s", "--spires", "-q"):
_OPTIONS["spires"] = True
elif opt in ("-n", "--nkeywords"):
_OPTIONS["output_limit"] = arg
elif opt == "--rebuild-cache":
_OPTIONS["rebuild_cache"] = True
elif opt == "--no-cache":
_OPTIONS["no_cache"] = True
elif opt == "--write-to-file":
_OPTIONS["output_prefix"] = arg
# -f for compatibility reasons
elif opt in ("-f", "--file"):
_OPTIONS["text_files"].append(arg)
elif opt == "--check-ontology":
_OPTIONS["check_ontology"] = True
elif opt == "--with-explicit":
_OPTIONS["with_explicit"] = True
if not opts and not args:
display_help()
_OPTIONS["text_files"] += args
# Test if the options are consistent.
if not args:
if not _OPTIONS["check_ontology"] and not _OPTIONS["text_files"]:
print >> sys.stderr, "ERROR: please specify a file or directory."
usage()
if not _OPTIONS["ontology_file"]:
print >> sys.stderr, "ERROR: please specify an ontology file (-k)."
usage()
if _OPTIONS["output_mode"] not in output_modes:
print >> sys.stderr, ("ERROR: output (-o) should be TEXT, MARCXML or "
"HTML.")
usage()
if _OPTIONS["match_mode"] not in modes:
print >> sys.stderr, "ERROR: mode (-m) should be FULL or PARTIAL."
usage()
try:
_OPTIONS["output_limit"] = int(_OPTIONS["output_limit"])
if _OPTIONS["output_limit"] < 0:
print >> sys.stderr, ("ERROR: output limit must be a positive "
"integer.")
except ValueError:
print >> sys.stderr, ("ERROR: output limit must be a positive "
"integer.")
usage()
def usage():
"""Displays usage (single line) and exit."""
# TODO: write usage
display_help()
sys.exit(1)
def version():
"""Display BibClassify version and exit."""
# TODO
display_help()
sys.exit(0)
def write_message(msg, stream=sys.stdout, verbose=1):
"""Write message and flush output stream (may be sys.stdout or sys.stderr).
Useful for debugging stuff. Copied from bibtask.py."""
if msg and _OPTIONS["verbose"] >= verbose:
if stream == sys.stdout or stream == sys.stderr:
stream.write(time.strftime("%Y-%m-%d %H:%M:%S --> ",
time.localtime()))
try:
stream.write("%s\n" % msg)
except UnicodeEncodeError:
stream.write("%s\n" % msg.encode('ascii', 'backslashreplace'))
stream.flush()
else:
sys.stderr.write("Unknown stream %s. [must be sys.stdout or "
"sys.stderr]\n" % stream)
if __name__ == '__main__':
# import cProfile
# cProfile.run('main()', 'profile_dump')
# import pstats
# p = pstats.Stats('profile_dump')
# p.sort_stats('time').print_stats(15)
# p.sort_stats('cumulative').print_stats(15)
# p.sort_stats('calls').print_stats(15)
main()
c4science · Help