WIP: program added/removed events

[travisghansen]

This allows registering callbacks for 2 different scenarios:

1. added/removed callback for programs directly on the controller
2. removed callback fired directly on the program

Example usage:

import time
from pyopensprinkler import Controller as OpenSprinklerController

def premoved(program):
    print("program object callback")
    print(program.index)

def pobserver(controller, action, index):
    print(f"station {index} {action}")
    if action == "added":
        print(controller.programs[index])
        controller.programs[index].add_on_removed_observer(premoved)

controller = OpenSprinklerController(...)
controller.add_program_observer(pobserver)

controller.refresh()
# go change program name
# add or remove programs
# etc
time.sleep(10)

# should trigger callbacks
controller.refresh()

exit(0)

The callback directly on the program will make it easier to bind an entity to the removal process and deregister the entity with hass in a more self-contained manner.

[vinteo]

For the sake of completeness should we have a de-register callback too?

Should there be a different event for "rename"?

Can you open a proof on concept on the HA side too?

[vinteo]

technically it is both add and remove so the name is a bit off

[travisghansen]

This is actually just remove. Chicken/egg for added.

[travisghansen]

Meaning if you’re adding a callback for added on a program...the program is already added (in the context of a program instance).

[vinteo]

yea but you have both "added" and "removed" "events". Maybe just add_observer?

[travisghansen]

The event on the program directly is only removed..

[travisghansen]

The controller callback serves both added and removed. For simplicity I think it would be difficult try to manage a rename/modify event and would probably stick with a modify is a remove and subsequent add.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
3 Code Smells

No Coverage information
0.0% Duplication