Extend schedule handling cli support #501

yparitcher · 2023-08-25T03:01:28Z

Some improvements for the schedule command.

A draft for now, I plan on adding rule edit support, please give feedback

Fixes: #265
Fixes: #436

Based on the commands in the Thesis linked in that issue.
Tested on a EP10

codecov-commenter · 2023-08-25T03:04:52Z

Codecov Report

Attention: Patch coverage is 72.97297% with 40 lines in your changes missing coverage. Please review.

Project coverage is 78.13%. Comparing base (24da24e) to head (d90bf19).
Report is 709 commits behind head on master.

Files with missing lines	Patch %	Lines
kasa/cli.py	58.33%	35 Missing ⚠️
kasa/modules/rulemodule.py	93.61%	3 Missing ⚠️
kasa/modules/time.py	60.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #501      +/-   ##
==========================================
- Coverage   79.59%   78.13%   -1.47%     
==========================================
  Files          26       26              
  Lines        1960     2108     +148     
  Branches      602      673      +71     
==========================================
+ Hits         1560     1647      +87     
- Misses        359      419      +60     
- Partials       41       42       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

rytilahti

Thanks for the PR @yparitcher! I added some initial review comments below.

rytilahti · 2023-08-26T14:24:21Z

kasa/cli.py

@@ -630,18 +631,113 @@ async def schedule(dev):

 @schedule.command(name="list")
 @pass_dev
+@click.option("--json", is_flag=True)


jsonifying is handled on the cli automatically for the return value, so there should be no need for special handling.

This way i get the actual json that is passed to the device, not the python rule wrapped in json

$ kasa --host 192.168.0.xxx --type plug schedule list id='B9A82B5BA5AB6F6DA4277429A226D632' name='7 Off 11 On' enable=<EnabledOption.Enabled: 1> wday=[1, 1, 1, 1, 1, 1, 1] repeat=<EnabledOption.Enabled: 1> sact=<Action.TurnOff: 0> stime_opt=<TimeOption.Enabled: 0> smin=420 eact=<Action.TurnOn: 1> etime_opt=<TimeOption.Enabled: 0> emin=660 s_light=None $ kasa --host 192.168.0.xxx --type plug --json schedule list id='B9A82B5BA5AB6F6DA4277429A226D632' name='7 Off 11 On' enable=<EnabledOption.Enabled: 1> wday=[1, 1, 1, 1, 1, 1, 1] repeat=<EnabledOption.Enabled: 1> sact=<Action.TurnOff: 0> stime_opt=<TimeOption.Enabled: 0> smin=420 eact=<Action.TurnOn: 1> etime_opt=<TimeOption.Enabled: 0> emin=660 s_light=None [ "id='B9A82B5BA5AB6F6DA4277429A226D632' name='7 Off 11 On' enable=<EnabledOption.Enabled: 1> wday=[1, 1, 1, 1, 1, 1, 1] repeat=<EnabledOption.Enabled: 1> sact=<Action.TurnOff: 0> stime_opt=<TimeOption.Enabled: 0> smin=420 eact=<Action.TurnOn: 1> etime_opt=<TimeOption.Enabled: 0> emin=660 s_light=None" ] $ kasa --host 192.168.0.xxx --type plug schedule list --json {"id": "B9A82B5BA5AB6F6DA4277429A226D632", "name": "7 Off 11 On", "enable": 1, "wday": [1, 1, 1, 1, 1, 1, 1], "repeat": 1, "sact": 0, "stime_opt": 0, "smin": 420, "eact": 1, "etime_opt": 0, "emin": 660, "s_light": null}

This needs to be fixed separately then (I think the proper way would be extending the json_formatter_cb by defining a serializer for pydantic BaseModel), but let's do that in a separate PR.

kasa/modules/rulemodule.py

kasa/cli.py

rytilahti · 2023-08-26T14:37:39Z

kasa/cli.py

+@click.option("--wday", type=str, required=True)
+@click.option("--sact", type=click.IntRange(-1, 2), default=None, required=True)
+@click.option("--stime_opt", type=click.IntRange(-1, 2), default=None, required=True)
+@click.option("--smin", type=click.IntRange(0, 1440), default=None, required=True)
+@click.option("--eact", type=click.IntRange(-1, 2), default=-1)
+@click.option("--etime_opt", type=click.IntRange(-1, 2), default=-1)
+@click.option("--emin", type=click.IntRange(0, 1440), default=None)


I think we should modiy the Rule to have more user-friendly field names (using alias) and add some documentation on what input values they accept.

I changed the names (If you better ones please comment), the doc still needs to be done.

Is there a way to pass the pydatic info to click? for example TimeOption

I don't have a direct answer to that, sorry. I suppose generic support for all pydantic models is not that easy, but one can use manually inherit from click.ParamType to perform the conversion.

rytilahti · 2023-08-26T14:38:28Z

kasa/cli.py

+        if name is not None:
+            rule_to_edit.name = name
+        if enable is not None:
+            rule_to_edit.enable = 1 if enable else 0


pydantic should handle the conversion just fine as long as the types are correct, so there should be no need for manual conversions here.

I want that only the user specified options should override the existing rule fields, however if the user does not specify a flag we get a None value that i don't want to pass to pydantic to overwrite the field. If there is a better way to do this with click & pydantic please let me know. (I am not too familiar with either of them)

yparitcher · 2023-08-27T03:40:44Z

As i do not have bulbs, I did not implement bulb specific functionality, but i did leave the scaffolding for someone else to do it.

yparitcher · 2023-08-27T04:01:28Z

I redid the rule inheritance a bit. not sure if there is a better way

rytilahti

I saw that you extend the time module to support timezone handling, could you please move that into its own PR to keep it easier to review? I'll try to find some time soon to take another look at this, alas, I won't be able to test this until some point next month.

rytilahti · 2023-08-27T16:41:28Z

kasa/modules/rulemodule.py

-    sact: Optional[Action]
-    stime_opt: TimeOption
-    smin: int
+    sact: Optional[Action] = Field(alias="start_action")


Suggested change

sact: Optional[Action] = Field(alias="start_action")

start_action: Optional[Action] = Field(alias="sact")

This is wrong way around, no? Basically, the alias allows using a nicer name for the field name itself, reading (and serializing?) in this case from/to a json field called sact.

yparitcher · 2023-09-05T02:57:24Z

I don't have much time to work on this (it was a bit driveby, as it now work for me locally). But i hope to eventually split out the changes into separate PRs. Anyone is also welcome to fixup this PR if wanted

github-actions · 2024-09-28T00:41:33Z

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
If you are the author of this PR, please leave a comment if you want to keep it open. Also, please rebase your PR onto the latest dev branch to ensure that it's up to date with the latest changes.
Thank you for your contribution!

github-actions · 2024-12-31T00:42:06Z

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
If you are the author of this PR, please leave a comment if you want to keep it open. Also, please rebase your PR onto the latest dev branch to ensure that it's up to date with the latest changes.
Thank you for your contribution!

github-actions · 2025-04-01T00:53:31Z

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
If you are the author of this PR, please leave a comment if you want to keep it open. Also, please rebase your PR onto the latest dev branch to ensure that it's up to date with the latest changes.
Thank you for your contribution!

yparitcher added 3 commits August 24, 2023 20:25

rule: end options are optional

dd22527

schedule: overall enable schedule

68007a7

schedule: delete all

0f00664

yparitcher marked this pull request as draft August 25, 2023 03:01

yparitcher added 5 commits August 24, 2023 23:20

rule: end options doc

ccd1756

schedule: fix list

8b51c76

schedule: doc

37fda33

schedule: add / edit rule (only plugs for now not switches)

2a3d29b

lint

a1151fa

rytilahti reviewed Aug 26, 2023

View reviewed changes

rytilahti added the enhancement New feature or request label Aug 26, 2023

rytilahti changed the title ~~Schedule~~ Extend schedule handling cli support Aug 26, 2023

yparitcher added 5 commits August 26, 2023 21:56

set timezone

af3b999

doc

178da08

EnabledOption

cb5722f

delete all fixes

736fe2b

rule: better modeling

4e46c97

yparitcher added 2 commits August 26, 2023 23:56

untested: add bulb rule items

11c408d

sun name

3da18e3

yparitcher marked this pull request as ready for review August 27, 2023 04:01

yparitcher added 2 commits August 27, 2023 00:44

document timezones: Shoild we move the list somwhere else?

acf041a

move tz info to time module

d90bf19

rytilahti reviewed Aug 27, 2023

View reviewed changes

This was referenced Jun 14, 2024

Add timezone to on_since attributes #978

Merged

Improve timezone support #980

Closed

github-actions bot added stale and removed stale labels Sep 28, 2024

sdb9696 added the stale label Oct 1, 2024

github-actions bot removed the stale label Oct 2, 2024

github-actions bot added stale and removed stale labels Dec 31, 2024

github-actions bot added stale and removed stale labels Apr 1, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extend schedule handling cli support #501

Extend schedule handling cli support #501

yparitcher commented Aug 25, 2023 •

edited

Loading

codecov-commenter commented Aug 25, 2023 •

edited by codecov bot

Loading

rytilahti left a comment

rytilahti Aug 26, 2023

yparitcher Aug 27, 2023

rytilahti Aug 27, 2023

rytilahti Aug 26, 2023

yparitcher Aug 27, 2023

rytilahti Aug 27, 2023

rytilahti Aug 26, 2023

yparitcher Aug 27, 2023

yparitcher commented Aug 27, 2023

yparitcher commented Aug 27, 2023

rytilahti left a comment

rytilahti Aug 27, 2023 •

edited

Loading

yparitcher commented Sep 5, 2023

github-actions bot commented Sep 28, 2024

github-actions bot commented Dec 31, 2024

github-actions bot commented Apr 1, 2025

	sact: Optional[Action] = Field(alias="start_action")
	start_action: Optional[Action] = Field(alias="sact")

Extend schedule handling cli support #501

Are you sure you want to change the base?

Extend schedule handling cli support #501

Conversation

yparitcher commented Aug 25, 2023 • edited Loading

codecov-commenter commented Aug 25, 2023 • edited by codecov bot Loading

Codecov Report

rytilahti left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yparitcher commented Aug 27, 2023

yparitcher commented Aug 27, 2023

rytilahti left a comment

Choose a reason for hiding this comment

rytilahti Aug 27, 2023 • edited Loading

Choose a reason for hiding this comment

yparitcher commented Sep 5, 2023

github-actions bot commented Sep 28, 2024

github-actions bot commented Dec 31, 2024

github-actions bot commented Apr 1, 2025

yparitcher commented Aug 25, 2023 •

edited

Loading

codecov-commenter commented Aug 25, 2023 •

edited by codecov bot

Loading

rytilahti Aug 27, 2023 •

edited

Loading