Add stubs for JACK-Client

[markspolakovs]

No description provided.

[markspolakovs]

This only exists because I couldn't for the life of me find the type definition for cffi's buffer type; if someone can think of a better way of doing this I'd appreciate it!

[JelleZijlstra]

See perhaps python/typing#593 (summary: there's no good way yet).

[markspolakovs]

This is a raw C type (https://github.com/spatialaudio/jackclient-python/blob/master/src/jack.py#L220) and I'm not sure how to type it correctly so I left it as Any.

[JelleZijlstra]

Maybe type it as a private class (class _JackPositionT: ...).

Also, all types that don't exist at runtime should be prefixed with underscores.

[markspolakovs]

Looks (to my untrained eye) like the mypy failure is unrelated (errors from google.protobuf)

[JelleZijlstra]

I am not familiar with this library, but spotchecked a few functions and they look good. I left a few minor comments.

[JelleZijlstra]

Maybe type it as a private class (class _JackPositionT: ...).

Also, all types that don't exist at runtime should be prefixed with underscores.

[JelleZijlstra]

See perhaps python/typing#593 (summary: there's no good way yet).

[JelleZijlstra]

The str/bytes difference here looks odd. Maybe we need cffi stubs with a more precise type though.

[markspolakovs]

I got that from the cffi docs:

buf[:] or bytes(buf): copy data out of the buffer, returning a regular byte string (or buf[start:end] for a part)
buf[:] = newstr: copy data into the buffer (or buf[start:end] = newstr)
len(buf), buf[index], buf[index] = newchar: access as a sequence of characters.

It's entirely possible I've misinterpreted them though

[hauntsaninja]

stubtest has some complaints, which look valid on spot check:

jack.CBufferType is not present at runtime
jack.Client.__init__ is inconsistent, stub does not have argument "use_exact_name"
jack.Client.__init__ is inconsistent, stub does not have argument "no_start_server"
jack.Client.__init__ is inconsistent, stub does not have argument "servername"
jack.Client.__init__ is inconsistent, stub does not have argument "session_id"
jack.Client.set_port_connect_callback is inconsistent, runtime argument "callback" has a default value but stub argument does not
jack.Client.set_port_registration_callback is inconsistent, runtime argument "callback" has a default value but stub argument does not
jack.Client.set_port_rename_callback is inconsistent, runtime argument "callback" has a default value but stub argument does not
jack.Client.set_timebase_callback is inconsistent, runtime argument "callback" has a default value but stub argument does not
jack.JackErrorCode.__init__ is inconsistent, stub does not have argument "message"
jack.JackErrorCode.__init__ is inconsistent, stub does not have argument "code"
jack.JackErrorCode.__init__ is inconsistent, runtime does not have *args argument "args"
jack.JackOpenError.__init__ is inconsistent, stub does not have argument "name"
jack.JackOpenError.__init__ is inconsistent, stub does not have argument "status"
jack.JackOpenError.__init__ is inconsistent, runtime does not have *args argument "args"
jack.OwnMidiPort.__init__ is inconsistent, stub does not have *args argument "args"
jack.Port.__init__ is inconsistent, stub does not have argument "port_ptr"
jack.Port.__init__ is inconsistent, stub does not have argument "client"
jack.Ports.__init__ is inconsistent, stub does not have argument "client"
jack.Ports.__init__ is inconsistent, stub does not have argument "porttype"
jack.Ports.__init__ is inconsistent, stub does not have argument "flag"
jack.Status.__init__ is inconsistent, stub does not have argument "code"
jack.TransportState.__init__ is inconsistent, stub does not have argument "code"

[markspolakovs]

@JelleZijlstra @hauntsaninja Addressed.

@hauntsaninja I added types for the constructors of the various internal classes (Port, Status, etc.) although I left a couple as Any - the docs say that those classes aren't meant to be user-instantiable anyway, so I wasn't quite sure on the best way to handle it

[hauntsaninja]

Thanks, this looks good to me!