API Reference

run

run.version

Current version.

class run.CallTaskEvent(task, *, uid, state, args=(), kwargs={})

Task call event.

Parameters

task: Task
Task object.
uid: int
Call unique identifier.
state: str
Call state: INIT, DONE or FAIL.
args: tuple
Call args.
kwargs: dict
Call kwargs.
class run.depend(dependency)

Decorate method to add custom dependency.

Examples

Dependency has to be instance of run.dependency.Dependency:

class Module(Module):

    @depend(require('other_method'))
    @depend(custom_dependency)
    def method(self):
        pass
run.hide(obj)

Convert object to hidden task.

class run.module(*args, **kwargs)

Decorate class to make module with default kwargs to invoke.

Examples

There are two ways to use decorator:

  • Form without kwargs is designed for case when you have to convert class to module prototype immidiatly in class body to use some of it methods:

    class Module(Module):
    
        @module
        class module(Module):
            def default(self): pass
    
        module.meta_require('other_method')
    
  • Form with kwargs makes the same and adds default kwargs to invoke:

    class Module(Module):
    
        @var(**kwargs)
        class module(Module):
            def default(self, **kwargs): pass
    
class run.require(_require__target, *args, **kwargs)

Decorate method to add require dependency.

Examples

Usage example:

class Module(Module):

    @require('other_method')
    def method(self):
        pass

Notes

It’s a shortcut for run.dependency.depend decorator.

class run.skip

Make object to be not converted while convert call.

Examples

Usage example:

class Module(Module):

    @skip
    def method(self):
        pass

In this case method will not be converted to run’s task and will stay as regular python method.

run.stylize(string, *, style, **patch)

Format string with style.

class run.task(*args, **kwargs)

Decorate method to make task with default kwargs to invoke.

Examples

There are two ways to use decorator:

  • Form without kwargs is designed for case when you have to convert method to task prototype immidiatly in class body to use some of it methods:

    class Module(Module):
    
        @task
        def method(self):
            pass
    
        method.require('other_method')
    
  • Form with kwargs makes the same and adds default kwargs to invoke:

    class Module(Module):
    
        @task(**kwargs)
        def method(self, **kwargs):
            pass
    
class run.trigger(_trigger__target, *args, on_success=True, on_fail=False, **kwargs)

Decorate method to add trigger dependency.

Examples

Usage example:

class Module(Module):

    @trigger('other_method')
    def method(self):
        pass

Notes

It’s a shortcut for run.dependency.depend decorator.

class run.var(*args, **kwargs)

Decorate method to make var with default kwargs to invoke.

Examples

There are two ways to use decorator:

  • Form without kwargs is designed for case when you have to convert method to var prototype immidiatly in class body to use some of it methods:

    class Module(Module):
    
        @var
        def method(self):
            pass
    
        method.meta_require('other_method')
    
  • Form with kwargs makes the same and adds default kwargs to invoke:

    class Module(Module):
    
        @var(**kwargs)
        def method(self, **kwargs):
            pass