djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
circuitpython/docs/library
History
Damien George 3c4bfd1dec py/objexcept: Support errno attribute on OSError exceptions. 
This commit adds the errno attribute to exceptions, so code can retrieve
errno codes from an OSError using exc.errno.

The implementation here simply lets `errno` (and the existing `value`)
attributes work on any exception instance (they both alias args[0]).  This
is for efficiency and to keep code size down.  The pros and cons of this
are:

Pros:
- more compatible with CPython, less difference to document and learn
- OSError().errno will correctly return None, whereas the current way of
  doing it via OSError().args[0] will raise an IndexError
- it reduces code size on most bare-metal ports (because they already have
  the errno qstr)
- for Python code that uses exc.errno the generated bytecode is 2 bytes
  smaller and more efficient to execute (compared with exc.args[0]); so
  bytecode loaded to RAM saves 2 bytes RAM for each use of this attribute,
  and bytecode that is frozen saves 2 bytes flash/ROM for each use
- it's easier/shorter to type, and saves 2 bytes of space in .py files that
  use it (for each use)

Cons:
- increases code size by 4-8 bytes on minimal ports that don't already have
  the `errno` qstr
- all exceptions now have .errno and .value attributes (a cpydiff test is
  added to address this)

See also #2407.

Signed-off-by: Damien George <damien@micropython.org>
 		2021-04-23 22:03:46 +10:00
..
_thread.rst docs/_thread: Add a placeholder docs for _thread module. 2017-11-10 00:09:43 +02:00
btree.rst docs/library/btree.rst: Correct method typo: __detitem__ to __delitem__. 2020-10-20 17:13:02 +11:00
builtins.rst py/objexcept: Support errno attribute on OSError exceptions. 2021-04-23 22:03:46 +10:00
cmath.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
esp.rst docs/library: Clarify that the arg to esp.deepsleep is in microseconds. 2020-06-30 22:01:44 +10:00
esp32.rst esp32: Add basic support for Non-Volatile-Storage in esp32 module. 2021-02-19 15:05:19 +11:00
framebuf.rst docs/library: Fix framebuf monochrome 1-bit modes, swapping HLSB/HMSB. 2020-02-10 23:04:15 +11:00
gc.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
index.rst all: Rename "sys" module to "usys". 2020-09-04 00:10:24 +10:00
lcd160cr.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
machine.ADC.rst docs/library: Specify new machine.ADC class. 2019-09-04 15:35:09 +10:00
machine.ADCWiPy.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
machine.I2C.rst docs: Update I2C and SPI docs to add reference to SoftI2C and SoftSPI. 2020-10-01 12:57:10 +10:00
machine.Pin.rst docs/library/machine.Pin.rst: Make it clear which methods are not core. 2021-02-03 00:54:18 +11:00
machine.RTC.rst docs,stm32: Fix minor typos in RTC docs, and->an. 2021-01-30 14:13:30 +11:00
machine.SD.rst docs/machine: Add initial docs for new machine.SDCard class. 2019-06-03 00:42:24 +10:00
machine.SDCard.rst esp32/machine_sdcard: Add "freq" keyword arg to SDCard constructor. 2020-05-28 12:19:04 +10:00
machine.SPI.rst docs: Update I2C and SPI docs to add reference to SoftI2C and SoftSPI. 2020-10-01 12:57:10 +10:00
machine.Signal.rst docs/library/machine.Signal.rst: Correct typo: usecases to use cases. 2020-10-20 17:21:30 +11:00
machine.Timer.rst docs/library/machine.Timer.rst: Add mention of constructor arguments. 2020-10-20 17:23:54 +11:00
machine.TimerWiPy.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
machine.UART.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
machine.WDT.rst docs/library: Fix docs for machine.WDT to specify millisecond timeout. 2020-05-02 22:55:48 +10:00
machine.rst docs/library/machine.rst: Correct minor typo: timout to timeout. 2020-10-20 17:19:47 +11:00
math.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
micropython.rst docs: Fix Sphinx 3.x warnings, and enable warnings-as-errors on build. 2020-06-05 21:42:17 +10:00
network.CC3K.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
network.WIZNET5K.rst docs/library/network: Move specific network classes to their own file. 2018-09-27 17:23:42 +10:00
network.WLAN.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
network.WLANWiPy.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
network.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
pyb.ADC.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.Accel.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.CAN.rst stm32/pyb_can: Add ability to calculate CAN bit timing from baudrate. 2020-12-17 23:01:15 +11:00
pyb.DAC.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
pyb.ExtInt.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.Flash.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
pyb.I2C.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
pyb.LCD.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.LED.rst docs: Remove spaces on lines that are empty. 2019-12-04 15:02:54 +11:00
pyb.Pin.rst docs/pyb.Pin: Minor typo fix to specify Pin in pyb.Pin.cpu. 2018-10-19 17:31:59 +11:00
pyb.RTC.rst docs,stm32: Fix minor typos in RTC docs, and->an. 2021-01-30 14:13:30 +11:00
pyb.SPI.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
pyb.Servo.rst docs/pyb.*: Use proper class case in method headers. 2016-06-08 16:21:28 +03:00
pyb.Switch.rst docs: Fix some references and RST markup to eliminate Sphinx warnings. 2018-03-15 15:50:51 +11:00
pyb.Timer.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
pyb.UART.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
pyb.USB_HID.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
pyb.USB_VCP.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
pyb.rst docs: Change `\*` to `*` in argument lists. 2020-08-21 12:24:13 +10:00
uarray.rst docs/library: Rename "array" module to "uarray". 2019-10-22 16:40:58 +11:00
uasyncio.rst docs/library/uasyncio.rst: Add docs for ThreadSafeFlag. 2021-02-16 16:35:37 +11:00
ubinascii.rst extmod/modubinascii: Update code, docs for hexlify now CPython has sep. 2020-12-14 14:35:29 +11:00
ubluetooth.rst docs/library/ubluetooth.rst: Add passkey docs. 2020-12-02 14:44:36 +11:00
ucollections.rst docs/library: Add documentation for ucollections.deque. 2018-06-26 14:29:22 +10:00
ucryptolib.rst extmod/moducryptolib: Add AES-CTR support. 2019-05-06 18:09:48 +10:00
uctypes.rst docs/library: Add / to indicate positional-only args in library docs. 2020-01-12 13:44:59 +11:00
uerrno.rst py/objexcept: Support errno attribute on OSError exceptions. 2021-04-23 22:03:46 +10:00
uhashlib.rst docs: Fix spelling in various parts of the docs. 2019-10-16 14:08:28 +11:00
uheapq.rst docs/library: Add CPython docs xref to each pertinent module. 2017-07-02 15:37:31 +03:00
uio.rst docs: Fix Sphinx 3.x warnings, and enable warnings-as-errors on build. 2020-06-05 21:42:17 +10:00
ujson.rst docs/library/ujson: Document dump() and load() functions. 2018-02-15 11:37:48 +11:00
uos.rst extmod/vfs_lfs: Add mtime support to littlefs files. 2020-08-25 17:35:19 +10:00
ure.rst docs: Fix Sphinx 3.x warnings, and enable warnings-as-errors on build. 2020-06-05 21:42:17 +10:00
uselect.rst docs/library: Add / to indicate positional-only args in library docs. 2020-01-12 13:44:59 +11:00
usocket.rst docs: Fix Sphinx 3.x warnings, and enable warnings-as-errors on build. 2020-06-05 21:42:17 +10:00
ussl.rst extmod/modussl: Fix ussl read/recv/send/write errors when non-blocking. 2021-02-17 11:50:54 +11:00
ustruct.rst docs/library: Add / to indicate positional-only args in library docs. 2020-01-12 13:44:59 +11:00
usys.rst all: Rename "sys" module to "usys". 2020-09-04 00:10:24 +10:00
utime.rst extmod/utime_mphal: Add generic utime.time_ns() function. 2020-10-01 14:20:42 +10:00
uzlib.rst docs/library: Add / to indicate positional-only args in library docs. 2020-01-12 13:44:59 +11:00
wipy.rst docs: Add usocket and ussl modules' documentation. 2015-10-21 15:30:56 +02:00