[PR] Use memo for arbitrary per-resource payload during operator lifetime

[kopf-archiver]

A pull request by nolar at 2019-11-14 12:48:12+00:00
Original URL: zalando-incubator/kopf#234
Merged by nolar at 2019-11-14 13:47:59+00:00

Issue : #112

Description

Since the per-resource in-memory runtime-only containers are already present in the core for internal purposes, it is easy to expose memo kwarg to the handlers, so that the can store arbitrary information or objects about resources.

Same as for the internal use, this should be the objects that are scoped to the operator life time, fully lost on restarts, i.e. not persistent. E.g. threads, tasks, locks, events. Maybe some regular scalars, if their meaning is also scoped to the operator process.

Example:

import kopf

@kopf.on.create('zalando.org', 'v1', 'kopfexamples', cooldown=10)
def create_fn_1(memo, **kwargs):
    print(f'{memo.xyz}')

@kopf.on.create('zalando.org', 'v1', 'kopfexamples')
def create_fn_2(memo, **kwargs):
    memo.xyz = 100

In this example, create_fn_1 raises AttributeError on the 1st attempt, then goes to create_fn_2, and then retries create_fn_1 in 10 seconds with the .xyz field already set.

Both dictionary and object interfaces are supported.

The documentation is intentionally limited — let's first see how it will be used, and what can be the examples.

Types of Changes

• New feature (non-breaking change which adds functionality)

Review

List of tasks the reviewer must do to review the PR

• Tests
• Documentation