CircuitPython - a Python implementation for teaching coding with microcontrollers https://git.suspectdevices.com/suspect-devices/circuitpython/atom?h=encoding 2020-07-06T18:16:25+00:00 2020-07-06T18:16:25+00:00 Diego Elio Pettenò flameeyes@flameeyes.com 2020-06-03T22:40:05+00:00 urn:sha1:34b4993d63a6b576f29d624385c681f679b4124c 2019-12-04T15:29:57+00:00 Jeff Epler jepler@gmail.com 2019-12-03T20:50:37+00:00 urn:sha1:238e12123690debaf2cf8488fb2a4d4003a06506 Protocols are nice, but there is no way for C code to verify whether a type's "protocol" structure actually implements some particular protocol. As a result, you can pass an object that implements the "vfs" protocol to one that expects the "stream" protocol, and the opposite of awesomeness ensues. This patch adds an OPTIONAL (but enabled by default) protocol identifier as the first member of any protocol structure. This identifier is simply a unique QSTR chosen by the protocol designer and used by each protocol implementer. When checking for protocol support, instead of just checking whether the object's type has a non-NULL protocol field, use `mp_proto_get` which implements the protocol check when possible. The existing protocols are now named: protocol_framebuf protocol_i2c protocol_pin protocol_stream protocol_spi protocol_vfs (most of these are unused in CP and are just inherited from MP; vfs and stream are definitely used though) I did not find any crashing examples, but here's one to give a flavor of what is improved, using `micropython_coverage`. Before the change, the vfs "ioctl" protocol is invoked, and the result is not intelligible as json (but it could have resulted in a hard fault, potentially): >>> import uos, ujson >>> u = uos.VfsPosix('/tmp') >>> ujson.load(u) Traceback (most recent call last): File "<stdin>", line 1, in <module> ValueError: syntax error in JSON After the change, the vfs object is correctly detected as not supporting the stream protocol: >>> ujson.load(p) Traceback (most recent call last): File "<stdin>", line 1, in <module> OSError: stream operation not supported 2019-01-18T19:53:09+00:00 Scott Shawcroft scott@tannewt.org 2019-01-18T19:53:09+00:00 urn:sha1:0318a9a9bcbceab308323788cb9e579da166710e 2018-08-17T00:41:38+00:00 Scott Shawcroft scott@tannewt.org 2018-08-16T21:21:44+00:00 urn:sha1:76e0373576529aa41fc90e142f8b071b6c732c2f 2018-04-10T03:41:32+00:00 Damien George damien.p.george@gmail.com 2018-03-07T06:48:53+00:00 urn:sha1:cf31d384f1d2ca09f817f154892eaa6860c10144 This patch moves the implementation of stream closure from a dedicated method to the ioctl of the stream protocol, for each type that implements closing. The benefits of this are: 1. Rounds out the stream ioctl function, which already includes flush, seek and poll (among other things). 2. Makes calling mp_stream_close() on an object slightly more efficient because it now no longer needs to lookup the close method and call it, rather it just delegates straight to the ioctl function (if it exists). 3. Reduces code size and allows future types that implement the stream protocol to be smaller because they don't need a dedicated close method. Code size reduction is around 200 bytes smaller for x86 archs and around 30 bytes smaller for the bare-metal archs. 2017-10-24T20:13:19+00:00 Paul Sokolovsky pfalcon@users.sourceforge.net 2017-10-24T20:11:42+00:00 urn:sha1:9a7e3469b28b02b05b85789acc6c0a78b9804659 These defined couple of functions added during initial experimentation, which aren't part of MicroPython API and no longer used or needed. 2017-10-23T09:09:37+00:00 Paul Sokolovsky pfalcon@users.sourceforge.net 2017-10-23T09:09:37+00:00 urn:sha1:cfff12612f92d6ae460e9748394a0cedf3b3d31d Unix naming is historical, before current conventions were established. All other ports however have it as "modusocket.c", so rename for consistency and to avoid confusion.