Homec4science
Diffusion invenio-infoscience (maint-2.1) Browse

R3600/modules/bibsched/lib/bibtasklet.py
4689c96c165emaint-2.1

Last Change
Raw File

bibtasklet.py
View Options

# -*- coding: utf-8 -*-
##
## This file is part of Invenio.
## Copyright (C) 2009, 2010, 2011 CERN.
##
## 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.
##
## 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 Invenio; if not, write to the Free Software Foundation, Inc.,
## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
"""Invenio Bibliographic Tasklet BibTask.
This is a particular BibTask that execute tasklets, which can be any
function dropped into /opt/cds-invenio/lib/python/invenio/bibsched_tasklets/.
"""
__revision__ = "$Id$"
import sys
import os
from invenio.bibtask import task_init, write_message, task_set_option, \
task_get_option, task_update_progress
from invenio.pluginutils import PluginContainer, get_callable_documentation, \
check_arguments_compatibility
from invenio.bibtask_config import CFG_BIBTASK_TASKLETS_PATH
def _load_tasklets():
"""
Load all the bibsched tasklets into the global variable _TASKLETS.
"""
return PluginContainer(os.path.join(CFG_BIBTASK_TASKLETS_PATH, 'bst_*.py'))
_TASKLETS = _load_tasklets()
def cli_list_tasklets():
"""
Print the list of available tasklets and broken tasklets.
"""
print """Available tasklets:"""
for tasklet in _TASKLETS.values():
print get_callable_documentation(tasklet)
print """Broken tasklets:"""
for tasklet_name, error in _TASKLETS.get_broken_plugins().iteritems():
print "%s: %s" % (tasklet_name, error)
sys.exit(0)
def task_submit_elaborate_specific_parameter(key, value,
dummy_opts, dummy_args):
""" Given the string key it checks it's meaning, eventually using the
value. Usually it fills some key in the options dict.
It must return True if it has elaborated the key, False, if it doesn't
know that key.
eg:
if key in ('-n', '--number'):
task_set_option('number', value)
return True
return False
"""
if key in ('-T', '--tasklet'):
task_set_option('tasklet', value)
return True
elif key in ('-a', '--argument'):
arguments = task_get_option('arguments', {})
try:
key, value = value.split('=', 1)
except NameError:
print >> sys.stderr, 'ERROR: an argument must be in the form ' \
'param=value, not "%s"' % value
return False
arguments[key] = value
task_set_option('arguments', arguments)
return True
elif key in ('-l', '--list-tasklets'):
cli_list_tasklets()
return True
return False
def task_submit_check_options():
"""
Check if a tasklet has been specified, and if the parameters are good
"""
tasklet = task_get_option('tasklet', None)
arguments = task_get_option('arguments', {})
if not tasklet:
print >> sys.stderr, 'ERROR: no tasklet specified'
return False
elif tasklet not in _TASKLETS:
print >> sys.stderr, 'ERROR: "%s" is not a valid tasklet. Use ' \
'--list-tasklets to obtain a list of the working tasklets.' % \
tasklet
return False
else:
try:
check_arguments_compatibility(_TASKLETS[tasklet], arguments)
except ValueError, err:
print >> sys.stderr, 'ERROR: wrong arguments (%s) specified for ' \
'tasklet "%s": %s' % (arguments, tasklet, err)
return False
return True
def task_run_core():
"""
Run the specific tasklet.
"""
tasklet = task_get_option('tasklet')
arguments = task_get_option('arguments', {})
write_message('Starting tasklet "%s" (with arguments %s)' %
(tasklet, arguments))
task_update_progress('%s started' % tasklet)
ret = _TASKLETS[tasklet](**arguments)
task_update_progress('%s finished' % tasklet)
write_message('Finished tasklet "%s" (with arguments %s)' %
(tasklet, arguments))
if ret is not None:
return ret
return True
def main():
"""
Main body of bibtasklet.
"""
task_init(
authorization_action='runbibtasklet',
authorization_msg="BibTaskLet Task Submission",
help_specific_usage="""\
-T, --tasklet Execute the specific tasklet
-a, --argument Specify an argument to be passed to tasklet in the form
param=value, e.g. --argument foo=bar
-l, --list-tasklets List the existing tasklets
""",
version=__revision__,
specific_params=("T:a:l",
["tasklet=", "argument=", "list-tasklets"]),
task_submit_elaborate_specific_parameter_fnc=
task_submit_elaborate_specific_parameter,
task_run_fnc=task_run_core,
task_submit_check_options_fnc=task_submit_check_options)
if __name__ == "__main__":
main()
c4science · Help