Add optional kasa-crypt dependency for speedups

[bdraco]

If installed, use the optimized protocol encryption procedures implemented as a C extension by kasa-crypt (https://github.com/bdraco/kasa-crypt).

[bdraco]

Still need to fix the string conversion in the lib as I forgot the null termination for the conversion

[codecov-commenter]

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.21 🎉

Comparison is base (2d42ca3) 79.29% compared to head (b95a1e4) 79.50%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #464      +/-   ##
==========================================
+ Coverage   79.29%   79.50%   +0.21%     
==========================================
  Files          26       26              
  Lines        1946     1952       +6     
  Branches      598      598              
==========================================
+ Hits         1543     1552       +9     
+ Misses        362      359       -3     
  Partials       41       41              

Impacted Files	Coverage Δ
kasa/protocol.py	86.25% <100.00%> (+0.65%)	⬆️

... and 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[bdraco]

Had to be explicit about the length cython/cython#3189

[rytilahti]

How about making this an optional dependency similar to what's done with the orjson support? That would keep the lib still usable even when binary wheels nor compiler is available on some odd platform.

[bdraco]

The kasa-crypt lib will automatically fallback to pure-python if the cython version cannot be linked or is not loadable

The CI jobs verify it works both ways https://github.com/bdraco/kasa-crypt/actions/runs/5292093943 (skip_cython, use_cython)

[rytilahti]

Tbh, I would like to see the dependency being inversed as that will still keep working even if the kasa-crypt package installation fails (if that even is a possibility).

[bdraco]

It shouldn't be possible for the package to fail installation more than any other pypi package as if anything goes wrong it will install the pure python version and skip the cython version.

Its the same logic used in dbus-fast, python-zeroconf, home-assistant-bluetooth, etc.

It will only raise on failure to build the cython version if REQUIRE_CYTHON is set in the env https://github.com/bdraco/kasa-crypt/blob/4d5a8e8b6c93672863db957ca507a96b4d3356be/build_ext.py#L47

[rytilahti]

Looks great, thanks! Would you mind adding a separate CI run for this? I suppose checking only against the newest python release would suffice.

[bdraco]

my if: isn't working as expected here. Have to go dig up the docs to see what I did wrong

[bdraco]

That should do it. My github actions is a bit rusty so it took a few tries

[bdraco]

that was way too much to get an conditional -> actions/runner#409 (comment)

actions/runner#409

[rytilahti]

Uhh, hah, I had thought it'd be much simpler and cleaner, so thanks for going the extra mile to make it work!

@bdraco I rewrote the description to make it clearer what was changed, and I'll prepare a release soon-ish. Do you happen to have some numbers to mention in the description and the release notes about the improvements this change provides?