Type annotations #37

HundredVisionsGuy · 2023-04-26T18:40:00Z

Still failing mypy and I have some questions to pose regarding the quaternion_packet.py script on line 44.

I need to head home, but I will continue working on this in the coming days. Here are the mypy results:


adafruit_bluefruit_connect\packet.py:70: error: On Python 3 formatting "b'abc'" with "{}" produces "b'abc'", not "abc"; use "{!r}" if this is desired behavior  [str-bytes-safe]
adafruit_bluefruit_connect\packet.py:130: error: On Python 3 formatting "b'abc'" with "{}" produces "b'abc'", not "abc"; use "{!r}" if this is desired behavior  [str-bytes-safe]
adafruit_bluefruit_connect\color_packet.py:45: error: Argument 1 to "len" has incompatible type "Optional[Packet]"; 
expected "Sized"  [arg-type]
adafruit_bluefruit_connect\color_packet.py:45: error: Item "Packet" of "Optional[Packet]" has no attribute "__iter__" (not iterable)  [union-attr]
adafruit_bluefruit_connect\color_packet.py:45: error: Item "None" of "Optional[Packet]" has no attribute "__iter__" 
(not iterable)  [union-attr]
adafruit_bluefruit_connect\color_packet.py:46: error: Cannot determine type of "_color"  [has-type]
adafruit_bluefruit_connect\color_packet.py:51: error: Argument 1 of "parse_private" is incompatible with supertype "Packet"; supertype defines the argument type as "bytes"  [override]
adafruit_bluefruit_connect\color_packet.py:51: note: This violates the Liskov substitution principle
adafruit_bluefruit_connect\color_packet.py:51: note: See https://mypy.readthedocs.io/en/stable/common_issues.html#incompatible-overrides
adafruit_bluefruit_connect\color_packet.py:56: error: Argument 1 to "ColorPacket" has incompatible type "Tuple[Any, 
...]"; expected "Optional[Packet]"  [arg-type]
adafruit_bluefruit_connect\color_packet.py:56: error: Argument 2 to "unpack" has incompatible type "Optional[Packet]"; expected "Union[bytes, Union[bytearray, memoryview, array[Any], mmap, _CData, PickleBuffer]]"  [arg-type]        
adafruit_bluefruit_connect\color_packet.py:61: error: Cannot determine type of "_color"  [has-type]
adafruit_bluefruit_connect\color_packet.py:69: error: Cannot determine type of "_color"  [has-type]
adafruit_bluefruit_connect\quaternion_packet.py:44: error: Unsupported operand types for + ("bytes" and "int")  [operator]
Found 12 errors in 3 files (checked 11 source files)```

This is my model for other similar packet issues (especially those with the cls parameter. As per Jeff's recommendations - we are ignoring the mypy warning on the format() method regarding bytes.

…based on new knowledge

with a little house cleaning of _xyz_packet

We are still getting mypy complaints about the Liskov Principle, and quarternion due to trying to return the sum of a bytes and an int. Need to flag this as an issue.

To avoid the dreaded Liskov Substitution Principle (thanks to mypy's fastidiousness)..

FoamyGuy · 2023-04-26T23:24:57Z

resolves: #31

FoamyGuy · 2023-04-26T23:35:47Z

Thanks for working on this!

Nice find on that issue at line 44 in quaternion packet. I'm not super familiar with this library, but after having a look around I am thinking that might be a bug. The code it warns about is this:

        partial_packet = struct.pack(
            self._FMT_CONSTRUCT, self._TYPE_HEADER, self._x, self._y, self._z, self._w
        )
        return partial_packet + self.checksum(partial_packet)

Which does look to me like it would be trying add a bytes() and an int which as the error states isn't really allowed.

I'm thinking it should be doing something like inside of here in the base class:

Adafruit_CircuitPython_BluefruitConnect/adafruit_bluefruit_connect/packet.py

Lines 143 to 147 in 863951f

    
               def add_checksum(self, partial_packet): 
        
                   """Compute the checksum of partial_packet and return a new bytes 
        
                   with the checksum appended. 
        
                   """ 
        
                   return partial_packet + bytes((self.checksum(partial_packet),))

And I'm guessing it hasn't been used in the right way for anyone to run into that issue (or at least not reported it if so).

Regarding the other mypy warnings: It's okay at this point if we're not passing 100% of the mypy checks. This first pass is aimed at getting the "low hanging fruit" of function arguments and returns. Once we get all of that taken care of eventually we'll enable automatic mypy check and decide on a configuration for it at that point with which warnings will be active in the automated check

…uy/Adafruit_CircuitPython_BluefruitConnect into type-annotations

HundredVisionsGuy · 2023-04-27T17:37:02Z

Shall I go ahead and make the PR (it's currently in draft status) even with the warning on quaternion_packet.py for line 44? FYI: When I run mypy on the entire folder, I just have 3 errors, and only the last one is related to the issue regarding quaternion_packet.py I am wondering if we want to add the `to_bytes()` method on the `self.checksum(partial_packet)` ``` adafruit_bluefruit_connect\packet.py:70: error: On Python 3 formatting "b'abc'" with "{}" produces "b'abc'", not "abc"; use "{!r}" if this is desired behavior [str-bytes-safe] adafruit_bluefruit_connect\packet.py:130: error: On Python 3 formatting "b'abc'" with "{}" produces "b'abc'", not "abc"; use "{!r}" if this is desired behavior [str-bytes-safe] adafruit_bluefruit_connect\quaternion_packet.py:44: error: Missing positional arguments "length", "byteorder" in call to "to_bytes" of "int" [call-arg] Found 3 errors in 2 files (checked 11 source files) ```

…

On Wed, Apr 26, 2023, 4:35 PM foamyguy ***@***.***> wrote: Thanks for working on this! Nice find on that issue at line 44 in quaternion packet. I'm not super familiar with this library, but after having a look around I am thinking that might be a bug. The code it warns about is this: partial_packet = struct.pack( self._FMT_CONSTRUCT, self._TYPE_HEADER, self._x, self._y, self._z, self._w ) return partial_packet + self.checksum(partial_packet) Which does look to me like it would be trying add a bytes() and an int which as the error states isn't really allowed. I'm thinking it should be doing something like inside of here in the base class: https://github.com/adafruit/Adafruit_CircuitPython_BluefruitConnect/blob/863951fb2c4b375f627982d5dafefd46022a2440/adafruit_bluefruit_connect/packet.py#L143-L147 And I'm guessing it hasn't been used in the right way for anyone to run into that issue (or at least not reported it if so). Regarding the other mypy warnings: It's okay at this point if we're not passing 100% of the mypy checks. This first pass is aimed at getting the "low hanging fruit" of function arguments and returns. Once we get all of that taken care of eventually we'll enable automatic mypy check and decide on a configuration for it at that point with which warnings will be active in the automated check — Reply to this email directly, view it on GitHub <#37 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AA5GKUUIMANNMTMBBFEVQ3LXDGWN3ANCNFSM6AAAAAAXM2NZGI> . You are receiving this because you authored the thread.Message ID: <adafruit/Adafruit_CircuitPython_BluefruitConnect/pull/37/c1524198933@ github.com>

FoamyGuy · 2023-04-28T00:04:25Z

I do think it's okay to take the PR out of draft mode even though the line 44 thing is still outstanding.

You can go ahead and make the change on line 44 if you want I think we'd be wrapping the self.checksum() inside of a call to bytes() just like the one in the code linked above.

We'll try to get someone with more familiarity with this library to take a look and verify that it makes sense.

HundredVisionsGuy · 2023-04-28T23:49:24Z

Closes #37

NOTE: on quaternion_packet.py to_bytes() line 44, I wrapped self.checksum(partial_packet, ) in bytes() per base class's to_bytes() (packet.py) per suggestion by @FoamyGuy .

FoamyGuy

One change needed for an import I believe.

The rest is looking good to me, but I do want to test it out on a device since there are a few changes that could possibly lead to different behavior. I'll report back if anything else comes up.

adafruit_bluefruit_connect/packet.py

FoamyGuy

This looks good to me now. Thanks again for taking this on @HundredVisionsGuy!

I pushed one commit to move that import into it's try block.

I tested all examples in the repo successfully with a Feather Sense and Android phone.

Updating https://github.com/adafruit/Adafruit_CircuitPython_BluefruitConnect to 1.2.9 from 1.2.8: > Merge pull request adafruit/Adafruit_CircuitPython_BluefruitConnect#37 from HundredVisionsGuy/type-annotations Updating https://github.com/adafruit/Adafruit_CircuitPython_Bundle/circuitpython_library_list.md to NA from NA: > Updated download stats for the libraries

HundredVisionsGuy added 10 commits April 25, 2023 16:32

Adding type annotations for packet

fd7294e

This is my model for other similar packet issues (especially those with the cls parameter. As per Jeff's recommendations - we are ignoring the mypy warning on the format() method regarding bytes.

Adding type annotations for _xyz_packet

08375aa

Fixing packet.py in light of sub-class implementation

cba3b77

Adding type annotations to accelerometer_packet and adjusting packet …

934ac91

…based on new knowledge

Adding type hints to button_packet

5c7c0ea

with a little house cleaning of _xyz_packet

Adding type hints to color_packet

24695d3

Adding type annotations to gyro and location packet

3171d37

Adding type annotations to several packets

e093aba

We are still getting mypy complaints about the Liskov Principle, and quarternion due to trying to return the sum of a bytes and an int. Need to flag this as an issue.

Adding type annotations to several packets

d5ee528

We are still getting mypy complaints about the Liskov Principle, and quarternion due to trying to return the sum of a bytes and an int. Need to flag this as an issue.

Fixing color_packet.py

f9f5ffe

To avoid the dreaded Liskov Substitution Principle (thanks to mypy's fastidiousness)..

Merge branch 'type-annotations' of https://github.com/HundredVisionsG…

7bb9c39

…uy/Adafruit_CircuitPython_BluefruitConnect into type-annotations

tekktrik linked an issue Apr 27, 2023 that may be closed by this pull request

Missing Type Annotations #31

Closed

12 tasks

HundredVisionsGuy added 3 commits April 28, 2023 16:01

Converting checksum() results from int to bytes as per packet base class

aa8c809

removing unnecessary typing import from _xyz_packet.py

b75d623

fixing black issues

19120bc

HundredVisionsGuy closed this Apr 28, 2023

HundredVisionsGuy reopened this Apr 28, 2023

HundredVisionsGuy marked this pull request as ready for review April 28, 2023 23:49

FoamyGuy requested changes May 8, 2023

View reviewed changes

adafruit_bluefruit_connect/packet.py Outdated Show resolved Hide resolved

move typing import into try block

5d95d67

FoamyGuy approved these changes May 8, 2023

View reviewed changes

FoamyGuy merged commit e18be23 into adafruit:main May 8, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Type annotations #37

Type annotations #37

Uh oh!

HundredVisionsGuy commented Apr 26, 2023

Uh oh!

FoamyGuy commented Apr 26, 2023

Uh oh!

FoamyGuy commented Apr 26, 2023

Uh oh!

HundredVisionsGuy commented Apr 27, 2023 via email

Uh oh!

FoamyGuy commented Apr 28, 2023

Uh oh!

HundredVisionsGuy commented Apr 28, 2023

Uh oh!

FoamyGuy left a comment

Uh oh!

Uh oh!

FoamyGuy left a comment

Uh oh!

Uh oh!

Type annotations #37

Type annotations #37

Uh oh!

Conversation

HundredVisionsGuy commented Apr 26, 2023

Uh oh!

FoamyGuy commented Apr 26, 2023

Uh oh!

FoamyGuy commented Apr 26, 2023

Uh oh!

HundredVisionsGuy commented Apr 27, 2023 via email

Uh oh!

FoamyGuy commented Apr 28, 2023

Uh oh!

HundredVisionsGuy commented Apr 28, 2023

Uh oh!

FoamyGuy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

FoamyGuy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!