/usr/share/pyshared/doit/task.py is in python-doit 0.24.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 | """Tasks are the main abstractions managed by doit"""
import types
import os
import sys
import inspect
import six
from .cmdparse import CmdOption, TaskParse
from .exceptions import CatchedException, InvalidTask
from .action import create_action, PythonAction
def first_line(doc):
"""extract first non-blank line from text, to extract docstring title"""
if doc is not None:
for line in doc.splitlines():
striped = line.strip()
if striped:
return striped
return ''
class Task(object):
"""Task
@ivar name string
@ivar actions: list - L{BaseAction}
@ivar clean_actions: list - L{BaseAction}
@ivar teardown (list - L{BaseAction})
@ivar targets: (list -string)
@ivar task_dep: (list - string)
@ivar wild_dep: (list - string) task dependency using wildcard *
@ivar file_dep: (set - string)
@ivar calc_dep: (set - string) reference to a task
@ivar dep_changed (list - string): list of file-dependencies that changed
(are not up_to_date). this must be set before
@ivar uptodate: (list - bool/None) use bool/computed value instead of
checking dependencies
@ivar value_savers (list - callables) that return dicts to be added to
task values. Always executed on main process.
To be used by `uptodate` implementations.
@ivar setup_tasks (list - string): references to task-names
@ivar is_subtask: (bool) indicate this task is a subtask
@ivar has_subtask: (bool) indicate this task has subtasks
@ivar result: (str) last action "result". used to check task-result-dep
@ivar values: (dict) values saved by task that might be used by other tasks
@ivar getargs: (dict) values from other tasks
@ivar doc: (string) task documentation
@ivar options: (dict) calculated params values (from getargs and taskopt)
@ivar taskopt: (cmdparse.CmdParse)
@ivar custom_title: function reference that takes a task object as
parameter and returns a string.
"""
DEFAULT_VERBOSITY = 1
string_types = (str, ) if six.PY3 else (str, unicode)
# list of valid types/values for each task attribute.
valid_attr = {'basename': (string_types, ()),
'name': (string_types, ()),
'actions': ((list, tuple), (None,)),
'file_dep': ((list, tuple), ()),
'task_dep': ((list, tuple), ()),
'uptodate': ((list, tuple), ()),
'calc_dep': ((list, tuple), ()),
'targets': ((list, tuple), ()),
'setup': ((list, tuple), ()),
'clean': ((list, tuple), (True,)),
'teardown': ((list, tuple), ()),
'doc': (string_types, (None,)),
'params': ((list, tuple,), ()),
'verbosity': ((), (None,0,1,2,)),
'getargs': ((dict,), ()),
'title': ((types.FunctionType,), (None,)),
'watch': ((list, tuple), ()),
}
def __init__(self, name, actions, file_dep=(), targets=(),
task_dep=(), uptodate=(),
calc_dep=(), setup=(), clean=(), teardown=(),
is_subtask=False, has_subtask=False,
doc=None, params=(), verbosity=None, title=None, getargs=None,
watch=()):
"""sanity checks and initialization
@param params: (list of dict for parameters) see cmdparse.CmdOption
"""
getargs = getargs or {} #default
self.check_attr(name, 'name', name, self.valid_attr['name'])
self.check_attr(name, 'actions', actions, self.valid_attr['actions'])
self.check_attr(name, 'file_dep', file_dep, self.valid_attr['file_dep'])
self.check_attr(name, 'task_dep', task_dep, self.valid_attr['task_dep'])
self.check_attr(name, 'uptodate', uptodate, self.valid_attr['uptodate'])
self.check_attr(name, 'calc_dep', calc_dep, self.valid_attr['calc_dep'])
self.check_attr(name, 'targets', targets, self.valid_attr['targets'])
self.check_attr(name, 'setup', setup, self.valid_attr['setup'])
self.check_attr(name, 'clean', clean, self.valid_attr['clean'])
self.check_attr(name, 'teardown', teardown, self.valid_attr['teardown'])
self.check_attr(name, 'doc', doc, self.valid_attr['doc'])
self.check_attr(name, 'params', params, self.valid_attr['params'])
self.check_attr(name, 'verbosity', verbosity,
self.valid_attr['verbosity'])
self.check_attr(name, 'getargs', getargs, self.valid_attr['getargs'])
self.check_attr(name, 'title', title, self.valid_attr['title'])
self.check_attr(name, 'watch', watch, self.valid_attr['watch'])
self.name = name
self.taskcmd = TaskParse([CmdOption(opt) for opt in params])
self.options = self._init_options()
self.setup_tasks = list(setup)
# actions
self._action_instances = None
if actions is None:
self._actions = []
else:
self._actions = list(actions[:])
self._init_deps(file_dep, task_dep, calc_dep)
self.value_savers = []
self.uptodate = self._init_uptodate(uptodate) if uptodate else []
self.getargs = getargs
if self.getargs:
self._init_getargs()
self.targets = targets
self.is_subtask = is_subtask
self.has_subtask = has_subtask
self.result = None
self.values = {}
self.verbosity = verbosity
self.custom_title = title
# clean
if clean is True:
self._remove_targets = True
self.clean_actions = ()
else:
self._remove_targets = False
self.clean_actions = [create_action(a, self) for a in clean]
self.teardown = [create_action(a, self) for a in teardown]
self.doc = self._init_doc(doc)
self.watch = watch
def _init_deps(self, file_dep, task_dep, calc_dep):
"""init for dependency related attributes"""
self.dep_changed = None
# file_dep
self.file_dep = set()
self._expand_file_dep(file_dep)
# task_dep
self.task_dep = []
self.wild_dep = []
if task_dep:
self._expand_task_dep(task_dep)
# calc_dep
self.calc_dep = set()
if calc_dep:
self._expand_calc_dep(calc_dep)
def _init_uptodate(self, items):
"""wrap uptodate callables"""
uptodate = []
for item in items:
# configure task
if hasattr(item, 'configure_task'):
item.configure_task(self)
# check/append uptodate value to task
if isinstance(item, bool) or item is None:
uptodate.append((item, None, None))
elif hasattr(item, '__call__'):
uptodate.append((item, [], {}))
elif isinstance(item, tuple):
call = item[0]
args = list(item[1]) if len(item)>1 else []
kwargs = item[2] if len(item)>2 else {}
uptodate.append((call, args, kwargs))
else:
msg = ("%s. task invalid 'uptodate' item '%r'. " +
"Must be bool, None, callable or tuple " +
"(callable, args, kwargs).")
raise InvalidTask(msg % (self.name, item))
return uptodate
def _expand_file_dep(self, file_dep):
"""put input into file_dep"""
for dep in file_dep:
if not isinstance(dep, six.string_types):
raise InvalidTask("%s. file_dep must be a str got '%r' (%s)" %
(self.name, dep, type(dep)))
self.file_dep.add(dep)
def _expand_task_dep(self, task_dep):
"""convert task_dep input into actaul task_dep and wild_dep"""
for dep in task_dep:
if "*" in dep:
self.wild_dep.append(dep)
else:
self.task_dep.append(dep)
def _expand_calc_dep(self, calc_dep):
"""calc_dep input"""
for dep in calc_dep:
if dep not in self.calc_dep:
self.calc_dep.add(dep)
def _extend_uptodate(self, uptodate):
"""add/extend uptodate values"""
self.uptodate.extend(self._init_uptodate(uptodate))
# FIXME should support setup also
_expand_map = {'task_dep': _expand_task_dep,
'file_dep': _expand_file_dep,
'calc_dep': _expand_calc_dep,
'uptodate': _extend_uptodate,
}
def update_deps(self, deps):
"""expand all kinds of dep input"""
for dep, dep_values in six.iteritems(deps):
if dep not in self._expand_map:
continue
self._expand_map[dep](self, dep_values)
def _init_options(self):
"""put default values on options. this will be overwritten, if params
options were passed on the command line.
"""
# ignore positional parameters
return self.taskcmd.parse('')[0]
def _init_getargs(self):
"""task getargs attribute define implicit task dependencies"""
for arg_name, desc in six.iteritems(self.getargs):
# tuple (task_id, key_name)
parts = desc
if isinstance(parts, six.string_types) or len(parts) != 2:
msg = ("Taskid '%s' - Invalid format for getargs of '%s'.\n" %
(self.name, arg_name) +
"Should be tuple with 2 elements " +
"('<taskid>', '<key-name>') got '%s'\n" % desc)
raise InvalidTask(msg)
if parts[0] not in self.setup_tasks:
self.setup_tasks.append(parts[0])
@staticmethod
def _init_doc(doc):
"""process task "doc" attribute"""
# store just first non-empty line as documentation string
return first_line(doc)
@staticmethod
def check_attr(task, attr, value, valid):
"""check input task attribute is correct type/value
@param task (string): task name
@param attr (string): attribute name
@param value: actual input from user
@param valid (list): of valid types/value accepted
@raises InvalidTask if invalid input
"""
if type(value) in valid[0]:
return
if value in valid[1]:
return
# input value didnt match any valid type/value, raise execption
msg = "Task '%s' attribute '%s' must be " % (task, attr)
accept = ", ".join([getattr(v, '__name__', str(v)) for v in
(valid[0] + valid[1])])
msg += "{%s} got:%r %s" % (accept, value, type(value))
raise InvalidTask(msg)
@property
def actions(self):
"""lazy creation of action instances"""
if self._action_instances is None:
self._action_instances = [create_action(a, self) for a in self._actions]
return self._action_instances
def save_extra_values(self):
"""run value_savers updating self.values"""
for value_saver in self.value_savers:
self.values.update(value_saver())
def _get_out_err(self, out, err, verbosity):
"""select verbosity to be used"""
priority = (verbosity, # use command line option
self.verbosity, # or task default from dodo file
self.DEFAULT_VERBOSITY) # or global default
use_verbosity = [v for v in priority if v is not None][0]
out_err = [(None, None), # 0
(None, err), # 1
(out, err)] # 2
return out_err[use_verbosity]
def execute(self, out=None, err=None, verbosity=None):
"""Executes the task.
@return failure: see CmdAction.execute
"""
task_stdout, task_stderr = self._get_out_err(out, err, verbosity)
for action in self.actions:
action_return = action.execute(task_stdout, task_stderr)
if isinstance(action_return, CatchedException):
return action_return
self.result = action.result
self.values.update(action.values)
def execute_teardown(self, out=None, err=None, verbosity=None):
"""Executes task's teardown
@return failure: see CmdAction.execute
"""
task_stdout, task_stderr = self._get_out_err(out, err, verbosity)
for action in self.teardown:
action_return = action.execute(task_stdout, task_stderr)
if isinstance(action_return, CatchedException):
return action_return
def clean(self, outstream, dryrun):
"""Execute task's clean
@ivar outstream: 'write' output into this stream
@ivar dryrun (bool): if True clean tasks are not executed
(just print out what would be executed)
"""
# if clean is True remove all targets
if self._remove_targets is True:
clean_targets(self, dryrun)
else:
# clean contains a list of actions...
for action in self.clean_actions:
msg = "%s - executing '%s'\n"
outstream.write(msg % (self.name, action))
# add extra arguments used by clean actions
if isinstance(action, PythonAction):
action_args = inspect.getargspec(action.py_callable).args
if 'dryrun' in action_args:
action.kwargs['dryrun'] = dryrun
if not dryrun:
result = action.execute(out=outstream)
if isinstance(result, CatchedException):
sys.stderr.write(str(result))
def title(self):
"""String representation on output.
@return: (str) Task name and actions
"""
if self.custom_title:
return self.custom_title(self)
return self.name
def __repr__(self):
return "<Task: %s>"% self.name
# when using multiprocessing Tasks are pickled.
def __getstate__(self):
"""remove attributes that might contain unpickleble content
mostly probably closures
"""
to_pickle = self.__dict__.copy()
del to_pickle['_actions']
del to_pickle['_action_instances']
del to_pickle['clean_actions']
del to_pickle['teardown']
del to_pickle['custom_title']
del to_pickle['value_savers']
del to_pickle['uptodate']
return to_pickle
def __eq__(self, other):
return self.name == other.name
def update_from_pickle(self, pickle_obj):
"""update self with data from pickled Task"""
self.__dict__.update(pickle_obj.__dict__)
def __lt__(self, other):
"""used on default sorting of tasks (alphabetically by name)"""
return self.name < other.name
def dict_to_task(task_dict):
"""Create a task instance from dictionary.
The dictionary has the same format as returned by task-generators
from dodo files.
@param task_dict (dict): task representation as a dict.
@raise InvalidTask: If unexpected fields were passed in task_dict
"""
# check required fields
if 'actions' not in task_dict:
raise InvalidTask("Task %s must contain 'actions' field. %s" %
(task_dict['name'],task_dict))
# user friendly. dont go ahead with invalid input.
task_attrs = list(six.iterkeys(task_dict))
valid_attrs = set(six.iterkeys(Task.valid_attr))
for key in task_attrs:
if key not in valid_attrs:
raise InvalidTask("Task %s contains invalid field: '%s'"%
(task_dict['name'],key))
return Task(**task_dict)
def clean_targets(task, dryrun):
"""remove all targets from a task"""
files = [path for path in task.targets if os.path.isfile(path)]
dirs = [path for path in task.targets if os.path.isdir(path)]
# remove all files
for file_ in files:
six.print_("%s - removing file '%s'" % (task.name, file_))
if not dryrun:
os.remove(file_)
# remove all directories (if empty)
for dir_ in dirs:
if os.listdir(dir_):
msg = "%s - cannot remove (it is not empty) '%s'"
six.print_(msg % (task.name, dir_))
else:
msg = "%s - removing dir '%s'"
six.print_(msg % (task.name, dir_))
if not dryrun:
os.rmdir(dir_)
|