Merge branch 'master' of github.com:adafruit/circuitpython

rhooper · rhooper · commit 90a09dba59e1 · 2018-05-15T14:54:54.000-04:00
diff --git a/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
@@ -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
@@ -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/collections.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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -11,7 +11,10 @@
 
 # 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
@@ -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
@@ -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
@@ -2,10 +2,7 @@
 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -68,10 +68,7 @@ def __init__(self, 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
