micropython/tests
Damien George 36c1052183 py/objtype: Optimise instance get/set/del by skipping special accessors.
This patch is a code optimisation, trading text bytes for speed.  On
pyboard it's an increase of 0.06% in code size for a gain (in pystone
performance) of roughly 6.5%.

The patch optimises load/store/delete of attributes in user defined classes
by not looking up special accessors (@property, __get__, __delete__,
__set__, __setattr__ and __getattr_) if they are guaranteed not to exist in
the class.

Currently, if you do my_obj.foo() then the runtime has to do a few checks
to see if foo is a property or has __get__, and if so delegate the call.
And for stores things like my_obj.foo = 1 has to first check if foo is a
property or has __set__ defined on it.

Doing all those checks each and every time the attribute is accessed has a
performance penalty.  This patch eliminates all those checks for cases when
it's guaranteed that the checks will always fail, ie no attributes are
properties nor have any special accessor methods defined on them.

To make this guarantee it checks all attributes of a user-defined class
when it is first created.  If any of the attributes of the user class are
properties or have special accessors, or any of the base classes of the
user class have them, then it sets a flag in the class to indicate that
special accessors must be checked for.  Then in the load/store/delete code
it checks this flag to see if it can take the shortcut and optimise the
lookup.

It's an optimisation that's pretty widely applicable because it improves
lookup performance for all methods of user defined classes, and stores of
attributes, at least for those that don't have special accessors.  And, it
allows to enable descriptors with minimal additional runtime overhead if
they are not used for a particular user class.

There is one restriction on dynamic class creation that has been introduced
by this patch: a user-defined class cannot go from zero special accessors
to one special accessor (or more) after that class has been subclassed.  If
the script attempts this an AttributeError is raised (see addition to
tests/misc/non_compliant.py for an example of this case).

The cost in code space bytes for the optimisation in this patch is:

   unix x64:  +528
unix nanbox:  +508
      stm32:  +192
     cc3200:  +200
    esp8266:  +332
      esp32:  +244

Performance tests that were done:

- on unix x86-64, pystone improved by about 5%
- on pyboard, pystone improved by about 6.5%, from 1683 up to 1794
- on pyboard, bm_chaos (from CPython benchmark suite) improved by about 5%
- on esp32, pystone improved by about 30% (but there are caching effects)
- on esp32, bm_chaos improved by about 11%
2018-06-08 12:12:08 +10:00
..
basics py/objtype: Optimise instance get/set/del by skipping special accessors. 2018-06-08 12:12:08 +10:00
bench tests/bench: Add testcase to compare bytes(N) vs b"\0" * N. 2016-06-08 14:28:18 +03:00
cmdline py/repl: Generalise REPL autocomplete to use qstr probing. 2018-02-19 16:12:44 +11:00
cpydiff tests/cpydiff: Remove types_int_tobytesfloat now that it doesn't fail. 2018-05-08 17:05:32 +10:00
extmod tests/extmod: Remove conditional import of uos_vfs, it no longer exists. 2018-06-06 14:28:23 +10:00
feature_check tests/class_reverse_op: Test for reverse arith ops special methods. 2017-09-10 17:05:57 +03:00
float tests: Add some tests for bigint hash, float hash and float parsing. 2018-05-21 13:05:40 +10:00
import tests/import: Update comment now that uPy raises correct exception. 2017-06-28 12:21:29 +10:00
inlineasm tests: Add a test for argument passing to inline-asm functions. 2016-03-16 08:24:07 +00:00
io tests/io/bytesio_ext2: Remove dependency on specific EINVAL value 2018-05-01 15:48:43 +10:00
jni tests: Convert remaining "sys.exit()" to "raise SystemExit". 2017-06-10 20:34:38 +03:00
micropython py/emit: Combine yield value and yield-from emit funcs into one. 2018-05-23 00:22:35 +10:00
misc py/objtype: Optimise instance get/set/del by skipping special accessors. 2018-06-08 12:12:08 +10:00
net_hosted tests/net_hosted: Add test for socket connect() and poll() behaviour. 2017-11-23 10:45:12 +11:00
net_inet tests/net_inet: Update tls test to work with CPython and incl new site. 2017-10-26 12:29:24 +11:00
pyb tests/pyb: Update tests to run correctly on PYBv1.0. 2018-05-02 15:25:37 +10:00
pybnative py: Fix stack access in thumb native emitter. 2014-05-07 23:27:45 +01:00
stress tests: Move recursive tests to the tests/stress/ subdir. 2018-04-10 14:43:52 +10:00
thread py/modthread: Raise RuntimeError in release() if lock is not acquired. 2017-06-14 14:43:50 +10:00
unicode py/objstr: Add check for valid UTF-8 when making a str from bytes. 2017-09-06 16:43:09 +10:00
unix tests/unix: Add coverage test for uio.resource_stream from frozen str. 2018-03-03 23:58:03 +11:00
wipy various: Spelling fixes 2017-05-29 11:36:05 +03:00
README all: Remove trailing spaces, per coding conventions. 2017-07-19 13:12:10 +10:00
pyboard.py tests: Add a suite of tests specifically for the pyboard. 2014-05-03 16:43:27 +01:00
run-bench-tests tests/run-bench-tests: Update locations of executables, now in ports/. 2017-09-08 12:11:15 +10:00
run-tests py/objgenerator: Protect against reentering a generator. 2018-05-22 16:54:03 +10:00
run-tests-exp.py unix: Rename "_os" module to "uos" for consistency with baremetal ports. 2015-12-12 00:04:35 +02:00
run-tests-exp.sh run-tests-exp.sh: Typo fix in comment. 2015-02-21 03:22:33 +02:00

README

This directory contains tests for various functionality areas of MicroPython.
To run all stable tests, run "run-tests" script in this directory.

Tests of capabilities not supported on all platforms should be written
to check for the capability being present. If it is not, the test
should merely output 'SKIP' followed by the line terminator, and call
sys.exit() to raise SystemExit, instead of attempting to test the
missing capability. The testing framework (run-tests in this
directory, test_main.c in qemu_arm) recognizes this as a skipped test.

There are a few features for which this mechanism cannot be used to
condition a test. The run-tests script uses small scripts in the
feature_check directory to check whether each such feature is present,
and skips the relevant tests if not.

When creating new tests, anything that relies on float support should go in the
float/ subdirectory.  Anything that relies on import x, where x is not a built-in
module, should go in the import/ subdirectory.