FlexMeasures / flexmeasures-client / 39045458329

96%

push

github

Add automation methods (#230)

* Add methods for the automation endpoints of FlexMeasures v1.1.0

List, inspect, create, update, delete and trigger automations on an asset.
update_automation takes its fields as a dict and/or as keyword arguments, and passes them on unchecked,
so fields the server makes editable later need no client release.
A 404 from a server older than v1.1.0 raises InsufficientServerVersionError,
while v1.1.0 pre-releases are accepted.

Closes #228

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KVweu7HHCzk5yhWTskgjva
Signed-off-by: F.N. Claessen <felix@seita.nl>

* Document the automation methods

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KVweu7HHCzk5yhWTskgjva
Signed-off-by: F.N. Claessen <felix@seita.nl>

* Rename trigger_and_await_automation to trigger_automation_and_wait

"Await" already means something else in Python.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KVweu7HHCzk5yhWTskgjva
Signed-off-by: F.N. Claessen <felix@seita.nl>

* Break the automation guide's lines only after punctuation

Also render the update_automation docstring's example as a code block.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KVweu7HHCzk5yhWTskgjva
Signed-off-by: F.N. Claessen <felix@seita.nl>

* Name the automation's await wrapper trigger_and_await_automation again

It matches trigger_and_await_report:
trigger_and_get_* methods return their result,
while trigger_and_await_* methods return the finished job, as their results are written to sensors.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KVweu7HHCzk5yhWTskgjva
Signed-off-by: F.N. Claessen <felix@seita.nl>

* Explain the trigger_and_get_* and trigger_and_await_* naming in the automation guide

Co... (continued)

76 of 83 new or added lines in 2 files covered. (91.57%)

961 of 1005 relevant lines covered (95.62%)

9.56 hits per line