diff options
| -rw-r--r-- | Makefile (renamed from docs/Makefile) | 39 | ||||
| -rw-r--r-- | README.rst | 22 | ||||
| -rw-r--r-- | docs/README.md | 23 | ||||
| -rw-r--r-- | docs/library/collections.rst (renamed from docs/library/ucollections.rst) | 8 | ||||
| -rw-r--r-- | docs/library/index.rst | 2 | ||||
| -rw-r--r-- | ports/atmel-samd/mpconfigport.h | 2 | ||||
| -rw-r--r-- | py/modcollections.c | 2 | ||||
| -rw-r--r-- | py/moduerrno.c | 14 | ||||
| -rw-r--r-- | py/objmodule.c | 2 | ||||
| -rw-r--r-- | tests/basics/class_store_class.py | 7 | ||||
| -rw-r--r-- | tests/basics/errno1.py | 5 | ||||
| -rw-r--r-- | tests/basics/errno1.py.exp | 3 | ||||
| -rw-r--r-- | tests/basics/namedtuple1.py | 5 | ||||
| -rw-r--r-- | tests/basics/namedtuple1_cpython_compat.py | 5 | ||||
| -rw-r--r-- | tests/basics/ordereddict1.py | 7 | ||||
| -rw-r--r-- | tests/basics/ordereddict_eq.py | 7 | ||||
| -rw-r--r-- | tests/bench/var-8-namedtuple-1st.py | 2 | ||||
| -rw-r--r-- | tests/bench/var-8.1-namedtuple-5th.py | 2 | ||||
| -rw-r--r-- | tests/skip_if.py | 5 | ||||
| -rw-r--r-- | tools/gen-cpydiff.py | 226 |
20 files changed, 98 insertions, 290 deletions
diff --git a/docs/Makefile b/Makefile index e9c128e90..7251d4d17 100644 --- a/docs/Makefile +++ b/Makefile @@ -6,13 +6,16 @@ PYTHON = python3 SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = -BUILDDIR = build/$(MICROPY_PORT) -CPYDIFFDIR = ../tools -CPYDIFF = gen-cpydiff.py -GENRSTDIR = genrst +# path to build the generated docs +BUILDDIR = _build +# path to source files to process +SOURCEDIR = . +# path to conf.py +CONFDIR = . # Run "make FORCE= ..." to avoid rebuilding from scratch (and risk # producing incorrect docs). FORCE = -E +VERBOSE = -v # User-friendly check for sphinx-build ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) @@ -22,9 +25,10 @@ endif # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +BASEOPTS = -c $(CONFDIR) $(PAPEROPT_$(PAPER)) $(FORCE) $(VERBOSE) $(SPHINXOPTS) $(SOURCEDIR) +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(BASEOPTS) # the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +I18NSPHINXOPTS = $(BASEOPTS) .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext @@ -52,19 +56,12 @@ help: @echo " pseudoxml to make pseudoxml-XML files for display purposes" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" - @echo " cpydiff to generate the MicroPython differences from CPython" clean: rm -rf $(BUILDDIR)/* - rm -f $(GENRSTDIR)/* -cpydiff: - @echo "Generating MicroPython Differences." - rm -f $(GENRSTDIR)/* - cd $(CPYDIFFDIR) && $(PYTHON) $(CPYDIFF) - -html: cpydiff - $(SPHINXBUILD) $(FORCE) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." @@ -117,30 +114,34 @@ epub: @echo @echo "Build finished. The epub file is in $(BUILDDIR)/epub." -latex: cpydiff +latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." -latexpdf: cpydiff - $(SPHINXBUILD) $(FORCE) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex +# seems to be malfunctioning +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." $(MAKE) -C $(BUILDDIR)/latex all-pdf @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." -latexpdfja: cpydiff +# seems to be malfunctioning +latexpdfja: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through platex and dvipdfmx..." $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." +# seems to be malfunctioning text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @echo @echo "Build finished. The text files are in $(BUILDDIR)/text." +# seems to be malfunctioning man: $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man @echo diff --git a/README.rst b/README.rst index 31c0cce59..6017be207 100644 --- a/README.rst +++ b/README.rst @@ -31,11 +31,14 @@ Designed for CircuitPython ~~~~~~~~~~~~~~~~~~~~~~~~~~ - `Adafruit CircuitPlayground - Express <https://www.adafruit.com/product/3333>`__ + Express <https://www.adafruit.com/product/3333>`__ (`CircuitPython Guide <https://learn.adafruit.com/adafruit-circuit-playground-express/circuitpython-quickstart>`__) - `Adafruit Feather M0 - Express <https://www.adafruit.com/product/3403>`__ -- `Adafruit Metro M0 Express <https://www.adafruit.com/product/3505>`__ -- `Adafruit Gemma M0 <https://www.adafruit.com/product/3501>`__ + Express <https://www.adafruit.com/product/3403>`__ (`CircuitPython Guide <https://learn.adafruit.com/adafruit-feather-m0-express-designed-for-circuit-python-circuitpython/kattni-circuitpython>`__) +- `Adafruit Metro M0 Express <https://www.adafruit.com/product/3505>`_ (`CircuitPython Guide <https://learn.adafruit.com/adafruit-metro-m0-express-designed-for-circuitpython/circuitpython>`__) +- `Adafruit Gemma M0 <https://www.adafruit.com/product/3501>`__ (`CircuitPython Guide <https://learn.adafruit.com/adafruit-gemma-m0/circuitpython>`__) +- `Adafruit ItsyBitsy M0 Express <https://www.adafruit.com/product/3727>`_ (no CircuitPython Guide yet!) +- `Adafruit Trinket M0 <https://www.adafruit.com/product/3500>`__ (`CircuitPython Guide <https://learn.adafruit.com/adafruit-trinket-m0-circuitpython-arduino/circuitpython>`__) +- `Adafruit Metro M4 <https://www.adafruit.com/product/3382>`__ (`CircuitPython Guide <https://learn.adafruit.com/adafruit-metro-m4-express-featuring-atsamd51/overview>`__) Other ~~~~~ @@ -69,8 +72,15 @@ System <https://learn.adafruit.com/>`__ under the `CircuitPython category <https://learn.adafruit.com/category/circuitpython>`__ and `MicroPython category <https://learn.adafruit.com/category/micropython>`__. An API -reference is also available on `Read the -Docs <http://circuitpython.readthedocs.io/en/latest/?>`__. +reference is also available on `Read the Docs +<http://circuitpython.readthedocs.io/en/latest/?>`__. A collection of awesome +resources can be found at `Awesome CircuitPython <https://github.com/adafruit/awesome-circuitpython>`__. + +Specifically useful documentation when starting out: + +- `Welcome to CircuitPython <https://learn.adafruit.com/welcome-to-circuitpython>`__ +- `CircuitPython Essentials <https://learn.adafruit.com/circuitpython-essentials>`__ +- `Example Code <https://github.com/adafruit/Adafruit_Learning_System_Guides/tree/master/CircuitPython_Essentials>`__ Contributing ------------ diff --git a/docs/README.md b/docs/README.md index 15db6aef1..b01ae9d49 100644 --- a/docs/README.md +++ b/docs/README.md @@ -22,6 +22,27 @@ preferably in a virtualenv: In `circuitpython/`, build the docs: - sphinx-build -v -b html . _build/html + make html You'll find the index page at `_build/html/index.html`. + +### More flexibility + +Running `make` by itself will list out the multiple doc generating commands available. + +All commands will, by default, run with `-E` (forces a rebuild from scratch of docs) and `-v` (verbosity level 1). This can be customized as desired: + + # will turn OFF the force rebuild + make html FORCE= + + # will turn OFF the verbosity + make html VERBOSE= + + # will turn OFF the force rebuild and make it doubly verbose when running + make html FORCE= VERBOSE="-v -v" + +You can also pass other options to sphinx by using `SPHINXOPTS`. + + make html SPHINXOPTS="-T" + +For more flexibility and customization, take a look at the Makefile for all variables you can pass in and overwrite. diff --git a/docs/library/ucollections.rst b/docs/library/collections.rst index 396ba3c87..849e8b694 100644 --- a/docs/library/ucollections.rst +++ b/docs/library/collections.rst @@ -1,9 +1,9 @@ -:mod:`ucollections` -- collection and container types +:mod:`collections` -- collection and container types ===================================================== .. include:: ../templates/unsupported_in_circuitpython.inc -.. module:: ucollections +.. module:: collections :synopsis: collection and container types |see_cpython_module| :mod:`cpython:collections`. @@ -24,7 +24,7 @@ Classes a string with space-separated field named (but this is less efficient). Example of use:: - from ucollections import namedtuple + from collections import namedtuple MyTuple = namedtuple("MyTuple", ("id", "name")) t1 = MyTuple(1, "foo") @@ -38,7 +38,7 @@ Classes added. When ordered dict is iterated over, keys/items are returned in the order they were added:: - from ucollections import OrderedDict + from collections import OrderedDict # To make benefit of ordered keys, OrderedDict should be initialized # from sequence of (key, value) pairs. diff --git a/docs/library/index.rst b/docs/library/index.rst index 466068640..c7b6879aa 100644 --- a/docs/library/index.rst +++ b/docs/library/index.rst @@ -21,7 +21,7 @@ Python standard libraries and micro-libraries gc.rst sys.rst binascii.rst - ucollections.rst + collections.rst uerrno.rst hashlib.rst uheapq.rst diff --git a/ports/atmel-samd/mpconfigport.h b/ports/atmel-samd/mpconfigport.h index e6c3a201f..27c248001 100644 --- a/ports/atmel-samd/mpconfigport.h +++ b/ports/atmel-samd/mpconfigport.h @@ -188,6 +188,8 @@ extern const struct _mp_obj_module_t usb_hid_module; #define MICROPY_PY_BUILTINS_FROZENSET (1) #define MICROPY_PY_BUILTINS_STR_SPLITLINES (1) #define MICROPY_PY_BUILTINS_REVERSED (1) + #define MICROPY_PY_UERRNO (1) + #define MICROPY_PY_UERRNO_ERRORCODE (0) #define MICROPY_PY_URE (1) #define MICROPY_PY_MICROPYTHON_MEM_INFO (1) #define MICROPY_PY_FRAMEBUF (1) diff --git a/py/modcollections.c b/py/modcollections.c index 1a1560387..837ec2f92 100644 --- a/py/modcollections.c +++ b/py/modcollections.c @@ -29,7 +29,7 @@ #if MICROPY_PY_COLLECTIONS STATIC const mp_rom_map_elem_t mp_module_collections_globals_table[] = { - { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_ucollections) }, + { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_collections) }, { MP_ROM_QSTR(MP_QSTR_namedtuple), MP_ROM_PTR(&mp_namedtuple_obj) }, #if MICROPY_PY_COLLECTIONS_ORDEREDDICT { MP_ROM_QSTR(MP_QSTR_OrderedDict), MP_ROM_PTR(&mp_type_ordereddict) }, diff --git a/py/moduerrno.c b/py/moduerrno.c index de66c941b..ce8a6bf89 100644 --- a/py/moduerrno.c +++ b/py/moduerrno.c @@ -100,6 +100,20 @@ const mp_obj_module_t mp_module_uerrno = { }; qstr mp_errno_to_str(mp_obj_t errno_val) { + // For commonly encountered errors, return human readable strings + if (MP_OBJ_IS_SMALL_INT(errno_val)) { + switch (MP_OBJ_SMALL_INT_VALUE(errno_val)) { + case EPERM: return MP_QSTR_Permission_space_denied; + case ENOENT: return MP_QSTR_No_space_such_space_file_slash_directory; + case EIO: return MP_QSTR_Input_slash_output_space_error; + case EACCES: return MP_QSTR_Permission_space_denied; + case EEXIST: return MP_QSTR_File_space_exists; + case ENODEV: return MP_QSTR_Unsupported_space_operation; + case EINVAL: return MP_QSTR_Invalid_space_argument; + } + } + + // Otherwise, return the Exxxx string for that error code #if MICROPY_PY_UERRNO_ERRORCODE // We have the errorcode dict so can do a lookup using the hash map mp_map_elem_t *elem = mp_map_lookup((mp_map_t*)&errorcode_dict.map, errno_val, MP_MAP_LOOKUP); diff --git a/py/objmodule.c b/py/objmodule.c index 3bea19644..e3464ecfa 100644 --- a/py/objmodule.c +++ b/py/objmodule.c @@ -151,7 +151,7 @@ STATIC const mp_rom_map_elem_t mp_builtin_module_table[] = { { MP_ROM_QSTR(MP_QSTR_uio), MP_ROM_PTR(&mp_module_io) }, #endif #if MICROPY_PY_COLLECTIONS - { MP_ROM_QSTR(MP_QSTR_ucollections), MP_ROM_PTR(&mp_module_collections) }, + { MP_ROM_QSTR(MP_QSTR_collections), MP_ROM_PTR(&mp_module_collections) }, #endif #if MICROPY_PY_STRUCT { MP_ROM_QSTR(MP_QSTR_ustruct), MP_ROM_PTR(&mp_module_ustruct) }, diff --git a/tests/basics/class_store_class.py b/tests/basics/class_store_class.py index 8f3e542d1..504f460a7 100644 --- a/tests/basics/class_store_class.py +++ b/tests/basics/class_store_class.py @@ -5,11 +5,8 @@ try: from collections import namedtuple except ImportError: - try: - from ucollections import namedtuple - except ImportError: - print("SKIP") - raise SystemExit + print("SKIP") + raise SystemExit import skip_if skip_if.no_cpython_compat() diff --git a/tests/basics/errno1.py b/tests/basics/errno1.py index 63930b767..bbbfac10c 100644 --- a/tests/basics/errno1.py +++ b/tests/basics/errno1.py @@ -11,7 +11,10 @@ print(type(uerrno.EIO)) # check that errors are rendered in a nice way msg = str(OSError(uerrno.EIO)) -print(msg[:7], msg[-5:]) +print(msg[:7], msg[msg.find(']'):]) + +msg = str(OSError(uerrno.ENOBUFS)) +print(msg[:7], msg[msg.find(']'):]) # check that unknown errno is still rendered print(str(OSError(9999))) diff --git a/tests/basics/errno1.py.exp b/tests/basics/errno1.py.exp index c3703df4a..b5dd529e4 100644 --- a/tests/basics/errno1.py.exp +++ b/tests/basics/errno1.py.exp @@ -1,3 +1,4 @@ <class 'int'> -[Errno ] EIO +[Errno ] Input/output error +[Errno ] ENOBUFS 9999 diff --git a/tests/basics/namedtuple1.py b/tests/basics/namedtuple1.py index 1b176b232..63d9eddd4 100644 --- a/tests/basics/namedtuple1.py +++ b/tests/basics/namedtuple1.py @@ -1,8 +1,5 @@ try: - try: - from collections import namedtuple - except ImportError: - from ucollections import namedtuple + from collections import namedtuple except ImportError: print("SKIP") raise SystemExit diff --git a/tests/basics/namedtuple1_cpython_compat.py b/tests/basics/namedtuple1_cpython_compat.py index a1b852d90..061ae94e5 100644 --- a/tests/basics/namedtuple1_cpython_compat.py +++ b/tests/basics/namedtuple1_cpython_compat.py @@ -2,10 +2,7 @@ import skip_if skip_if.no_cpython_compat() try: - try: - from collections import namedtuple - except ImportError: - from ucollections import namedtuple + from collections import namedtuple except ImportError: skip_if.skip() diff --git a/tests/basics/ordereddict1.py b/tests/basics/ordereddict1.py index d1633f0bb..9c62b2d62 100644 --- a/tests/basics/ordereddict1.py +++ b/tests/basics/ordereddict1.py @@ -1,11 +1,8 @@ try: from collections import OrderedDict except ImportError: - try: - from ucollections import OrderedDict - except ImportError: - print("SKIP") - raise SystemExit + print("SKIP") + raise SystemExit d = OrderedDict([(10, 20), ("b", 100), (1, 2)]) print(len(d)) diff --git a/tests/basics/ordereddict_eq.py b/tests/basics/ordereddict_eq.py index c69daf880..e103c867e 100644 --- a/tests/basics/ordereddict_eq.py +++ b/tests/basics/ordereddict_eq.py @@ -1,11 +1,8 @@ try: from collections import OrderedDict except ImportError: - try: - from ucollections import OrderedDict - except ImportError: - print("SKIP") - raise SystemExit + print("SKIP") + raise SystemExit x = OrderedDict() y = OrderedDict() diff --git a/tests/bench/var-8-namedtuple-1st.py b/tests/bench/var-8-namedtuple-1st.py index d862480a5..90ae7209d 100644 --- a/tests/bench/var-8-namedtuple-1st.py +++ b/tests/bench/var-8-namedtuple-1st.py @@ -1,5 +1,5 @@ import bench -from ucollections import namedtuple +from collections import namedtuple T = namedtuple("Tup", ["num", "bar"]) diff --git a/tests/bench/var-8.1-namedtuple-5th.py b/tests/bench/var-8.1-namedtuple-5th.py index 0bcf66180..0d5789d2e 100644 --- a/tests/bench/var-8.1-namedtuple-5th.py +++ b/tests/bench/var-8.1-namedtuple-5th.py @@ -1,5 +1,5 @@ import bench -from ucollections import namedtuple +from collections import namedtuple T = namedtuple("Tup", ["foo1", "foo2", "foo3", "foo4", "num"]) diff --git a/tests/skip_if.py b/tests/skip_if.py index 8d0ed8f21..7d6c5b207 100644 --- a/tests/skip_if.py +++ b/tests/skip_if.py @@ -68,10 +68,7 @@ def board_not_in(*board): def no_cpython_compat(): try: - try: - from collections import namedtuple - except ImportError: - from ucollections import namedtuple + from collections import namedtuple except ImportError: skip() try: diff --git a/tools/gen-cpydiff.py b/tools/gen-cpydiff.py deleted file mode 100644 index aff5b56e7..000000000 --- a/tools/gen-cpydiff.py +++ /dev/null @@ -1,226 +0,0 @@ -# This file is part of the MicroPython project, http://micropython.org/ -# -# The MIT License (MIT) -# -# Copyright (c) 2016 Rami Ali -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. - -""" gen-cpydiff generates documentation which outlines operations that differ between MicroPython - and CPython. This script is called by the docs Makefile for html and Latex and may be run - manually using the command make gen-cpydiff. """ - -import os -import errno -import subprocess -import time -import re -from collections import namedtuple - -# MicroPython supports syntax of CPython 3.4 with some features from 3.5, and -# such version should be used to test for differences. If your default python3 -# executable is of lower version, you can point MICROPY_CPYTHON3 environment var -# to the correct executable. -if os.name == 'nt': - CPYTHON3 = os.getenv('MICROPY_CPYTHON3', 'python3.exe') - MICROPYTHON = os.getenv('MICROPY_MICROPYTHON', '../windows/micropython.exe') -else: - CPYTHON3 = os.getenv('MICROPY_CPYTHON3', 'python3') - MICROPYTHON = os.getenv('MICROPY_MICROPYTHON', '../unix/micropython') - -TESTPATH = '../tests/cpydiff/' -DOCPATH = '../docs/genrst/' -INDEXTEMPLATE = '../docs/differences/index_template.txt' -INDEX = 'index.rst' - -HEADER = '.. This document was generated by tools/gen-cpydiff.py\n\n' -UIMPORTLIST = {'struct', 'collections', 'json'} -CLASSMAP = {'Core': 'Core Language', 'Types': 'Builtin Types'} -INDEXPRIORITY = ['syntax', 'core_language', 'builtin_types', 'modules'] -RSTCHARS = ['=', '-', '~', '`', ':'] -SPLIT = '"""\n|categories: |description: |cause: |workaround: ' -TAB = ' ' - -Output = namedtuple('output', ['name', 'class_', 'desc', 'cause', 'workaround', 'code', - 'output_cpy', 'output_upy', 'status']) - -def readfiles(): - """ Reads test files """ - tests = list(filter(lambda x: x.endswith('.py'), os.listdir(TESTPATH))) - tests.sort() - files = [] - - for test in tests: - text = open(TESTPATH + test, 'r').read() - - try: - class_, desc, cause, workaround, code = [x.rstrip() for x in \ - list(filter(None, re.split(SPLIT, text)))] - output = Output(test, class_, desc, cause, workaround, code, '', '', '') - files.append(output) - except IndexError: - print('Incorrect format in file ' + TESTPATH + test) - - return files - -def uimports(code): - """ converts CPython module names into MicroPython equivalents """ - for uimport in UIMPORTLIST: - uimport = bytes(uimport, 'utf8') - code = code.replace(uimport, b'u' + uimport) - return code - -def run_tests(tests): - """ executes all tests """ - results = [] - for test in tests: - with open(TESTPATH + test.name, 'rb') as f: - input_cpy = f.read() - input_upy = uimports(input_cpy) - - process = subprocess.Popen(CPYTHON3, shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE, stderr=subprocess.PIPE) - output_cpy = [com.decode('utf8') for com in process.communicate(input_cpy)] - - process = subprocess.Popen(MICROPYTHON, shell=True, stdout=subprocess.PIPE, stdin=subprocess.PIPE, stderr=subprocess.PIPE) - output_upy = [com.decode('utf8') for com in process.communicate(input_upy)] - - if output_cpy[0] == output_upy[0] and output_cpy[1] == output_upy[1]: - status = 'Supported' - print('Supported operation!\nFile: ' + TESTPATH + test.name) - else: - status = 'Unsupported' - - output = Output(test.name, test.class_, test.desc, test.cause, - test.workaround, test.code, output_cpy, output_upy, status) - results.append(output) - - results.sort(key=lambda x: x.class_) - return results - -def indent(block, spaces): - """ indents paragraphs of text for rst formatting """ - new_block = '' - for line in block.split('\n'): - new_block += spaces + line + '\n' - return new_block - -def gen_table(contents): - """ creates a table given any set of columns """ - xlengths = [] - ylengths = [] - for column in contents: - col_len = 0 - for entry in column: - lines = entry.split('\n') - for line in lines: - col_len = max(len(line) + 2, col_len) - xlengths.append(col_len) - for i in range(len(contents[0])): - ymax = 0 - for j in range(len(contents)): - ymax = max(ymax, len(contents[j][i].split('\n'))) - ylengths.append(ymax) - - table_divider = '+' + ''.join(['-' * i + '+' for i in xlengths]) + '\n' - table = table_divider - for i in range(len(ylengths)): - row = [column[i] for column in contents] - row = [entry + '\n' * (ylengths[i]-len(entry.split('\n'))) for entry in row] - row = [entry.split('\n') for entry in row] - for j in range(ylengths[i]): - k = 0 - for entry in row: - width = xlengths[k] - table += ''.join(['| {:{}}'.format(entry[j], width - 1)]) - k += 1 - table += '|\n' - table += table_divider - return table + '\n' - -def gen_rst(results): - """ creates restructured text documents to display tests """ - - # make sure the destination directory exists - try: - os.mkdir(DOCPATH) - except OSError as e: - if e.args[0] != errno.EEXIST and e.args[0] != errno.EISDIR: - raise - - toctree = [] - class_ = [] - for output in results: - section = output.class_.split(',') - for i in range(len(section)): - section[i] = section[i].rstrip() - if section[i] in CLASSMAP: - section[i] = CLASSMAP[section[i]] - if i >= len(class_) or section[i] != class_[i]: - if i == 0: - filename = section[i].replace(' ', '_').lower() - rst = open(DOCPATH + filename + '.rst', 'w') - rst.write(HEADER) - rst.write(section[i] + '\n') - rst.write(RSTCHARS[0] * len(section[i])) - rst.write(time.strftime("\nGenerated %a %d %b %Y %X UTC\n\n", time.gmtime())) - toctree.append(filename) - else: - rst.write(section[i] + '\n') - rst.write(RSTCHARS[min(i, len(RSTCHARS)-1)] * len(section[i])) - rst.write('\n\n') - class_ = section - rst.write('.. _cpydiff_%s:\n\n' % output.name.rsplit('.', 1)[0]) - rst.write(output.desc + '\n') - rst.write('~' * len(output.desc) + '\n\n') - if output.cause != 'Unknown': - rst.write('**Cause:** ' + output.cause + '\n\n') - if output.workaround != 'Unknown': - rst.write('**Workaround:** ' + output.workaround + '\n\n') - - rst.write('Sample code::\n\n' + indent(output.code, TAB) + '\n') - output_cpy = indent(''.join(output.output_cpy[0:2]), TAB).rstrip() - output_cpy = ('::\n\n' if output_cpy != '' else '') + output_cpy - output_upy = indent(''.join(output.output_upy[0:2]), TAB).rstrip() - output_upy = ('::\n\n' if output_upy != '' else '') + output_upy - table = gen_table([['CPy output:', output_cpy], ['uPy output:', output_upy]]) - rst.write(table) - - template = open(INDEXTEMPLATE, 'r') - index = open(DOCPATH + INDEX, 'w') - index.write(HEADER) - index.write(template.read()) - for section in INDEXPRIORITY: - if section in toctree: - index.write(indent(section + '.rst', TAB)) - toctree.remove(section) - for section in toctree: - index.write(indent(section + '.rst', TAB)) - -def main(): - """ Main function """ - - # set search path so that test scripts find the test modules (and no other ones) - os.environ['PYTHONPATH'] = TESTPATH - os.environ['MICROPYPATH'] = TESTPATH - - files = readfiles() - results = run_tests(files) - gen_rst(results) - -main() |