turn callback helpers in ODReader to decorators

Repository metrics

Stars

140 stars (140 stars)

PR merge metrics

Avg merge 2h 18m (Avg merge 2h 18m)1 merged PR in 30d (1 merged PR in 30d)

Description

from pioreactor.background_jobs.od_reading import ODReader

# example of using callbacks to OD reading...

def hello(self):
    print(f"Hello, {self}!")


def goodbye(self, readings):
    print(f"Goodbye, {self}, witnessed {readings}!")

ODReader.add_pre_read_callback(hello)
ODReader.add_post_read_callback(goodbye)

from pioreactor.background_jobs.od_reading import ODReader

# example of using callbacks to OD reading...

@ODReader.add_pre_read_callback
def hello(self):
    print(f"Hello, {self}!")


@ODReader.add_post_read_callback
def goodbye(self, readings):
    print(f"Goodbye, {self}, witnessed {readings}!")

Contributor guide

Research direction

Modify the add pre read callback and add post read callback methods in ODReader to be used as decorators, then apply them to the example functions.

Tech stack

python

Domain

backend

Issue type

Refactor

DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.

2

Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.

Under 1 hour

Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.

Fresh

ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.

Clear

Prerequisites

Python

Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.

85