Typing?

[moi90]

Are you open to including typing annotations into the code? It would greatly simplify navigating around in the code. (And users have to rely heavily on exploring the code base themselves as there is no documentation, just examples.)

Related question: What is the oldest supported version of Python?

[trinamic-bp]

Yes, for newer code we occasionally add type annotations. So we are fine with it in general.

[trinamic-bp]

We did not specify the required Python version yet, but this is on my list. We wehere going for Requires: Python >=3.7. I'll add this to the package metadata.

[moi90]

Sounds good!

I just quickly ran mypy on the master branch:

$ mypy --disable-error-code=import-untyped pytrinamic/
pytrinamic/datalogger.py:189: error: Incompatible types in assignment (expression has type "None", variable has type "int")  [assignment]
pytrinamic/datalogger.py:190: error: Incompatible types in assignment (expression has type "None", variable has type "float")  [assignment]
pytrinamic/datalogger.py:192: error: Incompatible types in assignment (expression has type "None", variable has type "Trigger")  [assignment]
pytrinamic/datalogger.py:194: error: Missing return statement  [return]
pytrinamic/datalogger.py:328: error: "DataType" has no attribute "signed"  [attr-defined]
pytrinamic/datalogger.py:383: error: Argument "request_object" to "_RequestEntry" has incompatible type "Field"; expected "None"  [arg-type]
pytrinamic/connections/socket_tmcl_interface.py:52: error: Incompatible types in assignment (expression has type "None", variable has type "int")  [assignment]
pytrinamic/modules/TMCM1690.py:71: error: Name "set_target_current" already defined on line 68  [no-redef]
pytrinamic/modules/TMCM1617.py:10: error: Name "TMC4671" already defined (by an import)  [no-redef]
pytrinamic/modules/TMCM1617.py:10: error: Name "TMC6200" already defined (by an import)  [no-redef]
pytrinamic/ic/TMC9660/TMC9660.py:71: error: Cannot determine type of "ALL_REGISTERS"  [has-type]
pytrinamic/ic/TMC9660/TMC9660.py:72: error: Cannot determine type of "ALL_REGISTERS"  [has-type]
pytrinamic/ic/TMC9660/TMC9660.py:73: error: Cannot determine type of "ALL_REGISTERS"  [has-type]
pytrinamic/ic/MAX22215/MAX22215map.py:85: note: By default the bodies of untyped functions are not checked, consider using --check-untyped-defs  [annotation-unchecked]
pytrinamic/ic/MAX22215/MAX22215map.py:97: note: By default the bodies of untyped functions are not checked, consider using --check-untyped-defs  [annotation-unchecked]
pytrinamic/ic/MAX22215/MAX22215map.py:116: note: By default the bodies of untyped functions are not checked, consider using --check-untyped-defs  [annotation-unchecked]
pytrinamic/ic/MAX22215/MAX22215map.py:144: note: By default the bodies of untyped functions are not checked, consider using --check-untyped-defs  [annotation-unchecked]
pytrinamic/ic/MAX22215/MAX22215map.py:200: error: Name "_OCP0" already defined on line 186  [no-redef]
pytrinamic/ic/MAX22215/MAX22215map.py:435: error: Name "_LFD1_MASK" already defined on line 393  [no-redef]
pytrinamic/ic/MAX22215/MAX22215map.py:480: note: By default the bodies of untyped functions are not checked, consider using --check-untyped-defs  [annotation-unchecked]
pytrinamic/connections/connection_manager.py:110: error: Argument 2 to "_Interface" has incompatible type "type[DummyTmclInterface]"; expected "None"  [arg-type]
pytrinamic/connections/connection_manager.py:111: error: Argument 2 to "_Interface" has incompatible type "type[KvaserTmclInterface]"; expected "None"  [arg-type]
pytrinamic/connections/connection_manager.py:112: error: Argument 2 to "_Interface" has incompatible type "type[PcanTmclInterface]"; expected "None"  [arg-type]
pytrinamic/connections/connection_manager.py:113: error: Argument 2 to "_Interface" has incompatible type "type[SlcanTmclInterface]"; expected "None"  [arg-type]
pytrinamic/connections/connection_manager.py:114: error: Argument 2 to "_Interface" has incompatible type "type[SocketcanTmclInterface]"; expected "None"  [arg-type]
pytrinamic/connections/connection_manager.py:115: error: Argument 2 to "_Interface" has incompatible type "type[SerialTmclInterface]"; expected "None"  [arg-type]
pytrinamic/connections/connection_manager.py:116: error: Argument 2 to "_Interface" has incompatible type "type[UartIcInterface]"; expected "None"  [arg-type]
pytrinamic/connections/connection_manager.py:117: error: Argument 2 to "_Interface" has incompatible type "type[UsbTmclInterface]"; expected "None"  [arg-type]
pytrinamic/connections/connection_manager.py:118: error: Argument 2 to "_Interface" has incompatible type "type[IxxatTmclInterface]"; expected "None"  [arg-type]
pytrinamic/connections/connection_manager.py:119: error: Argument 2 to "_Interface" has incompatible type "type[SocketTmclInterface]"; expected "None"  [arg-type]
Found 25 errors in 7 files (checked 185 source files)

Some of these are actually logical errors that should be fixed (e.g. redefinition of existing names).