xethorn / garcon

82%

master: 95%

LAST BUILD ON BRANCH mo-15-feb-add-contextify

branch: mo-15-feb-add-contextify

CHANGE BRANCH

x

Reset

• mo-15-feb-add-contextify
• 0.0.1
• 0.0.2a1
• 0.0.2a10
• 0.0.2a2
• 0.0.2a4
• 0.0.2a5
• 0.0.2a6
• 0.0.2a7
• 0.0.2a8
• 0.0.2a9
• 0.0.4
• 0.0.5
• 0.0.6
• 0.0.7
• 0.1.0
• 0.2.0
• 0.2.1
• 0.2.2
• 0.2.3
• 0.3.0
• 0.3.1
• 0.3.2
• 0.4.0
• 0.4.1
• add-context
• add-error-handler
• add-param
• add-version
• boto2
• branch-1.0
• master
• mo-14-dec-add-tests
• mo-14-jan-add-input-as-part-of-context
• mo-15-add-context
• mo-15-april-add-task-runner
• mo-15-feb-add-instance-and-generator
• mo-15-feb-add-run
• mo-15-feb-add-task-runner
• mo-15-feb-fix-yield
• mo-15-jan-add-timeouts
• mo-15-june-add-state
• mo-15-march-add-workflow
• mo-15-march-remove-activity
• mo-15-may-add-support-for-external
• mo-16-april-add
• mo-17-august-add-example-of-full-decider
• mo-apply-pep8
• xethorn-handle-activity-failures
• xethorn-patch-1
• xethorn/20-june-1.0.1
• xethorn/20-june-add-support-for-running-tests-on-pull-requests
• xethorn/20-june-bump-version
• xethorn/20-june-bump-version-1
• xethorn/20-may-add-github-workflows
• xethorn/20-may-add-workflow-to-publish-to-github
• xethorn/20-may-create-alpha-release
• xethorn/20-may-issue-0.4.1
• xethorn/20-may-issue-1.0.0a2
• xethorn/20-may-remove-python27
• xethorn/2021/may/add-codeql
• xethorn/21-may-update-readme

Add decorators.

Two new decorators have been added:
* `task.decorator`: which is a generic decorator for tasks. You can pass a timeout and
  `enable_contextify`.
* `task.contextify`: which methods gets information from the context and send it to the
   task.

Background:

The context is being passed to all tasks. Having the ability to know which task consume
what information makes it easier to see additional dependencies between tasks. For
instance:

```
activity = create(
    name=activity_name,
    tasks=SyncTasks(
        send_email.fill(
            user_email='context.user_email',
            user_full_name='context.user.full_name')))
```

To get the `fill` method, you can either do:

```
from garcon import tasks

@tasks.contextify
def send_email(user_email):
    pass

@tasks.decorate()
def send_email(user_email):
    pass
```

Please note:

> 1. Using the decorate method does not allow you to use `context` anymore. The goal is
> to make sure that all values needed from the context are passed to the task (making
> it explicit what the task need.)
>
> 2. Activity is now an optional param. If you don't need it, don't add it into the
> signature of the method.