Go to file
Jeff Epler 907c5d387f
Tweak black_bindings
Originally, black_bindings found each contiguous "//|" block and sent
it to black independently. This was slower than it needed to be.

Instead, swap the comment prefix: when running black, take off
"//|" prefixes and put "##|" prefixes on all un-prefixed lines.
Then, after black is run, do the opposite operation

This more than doubles the overall speed of "pre-commit run --all",
from 3m20s to 55s CPU time on my local machine (32.5s to under 10s
"elapsed" time)

It also causes a small amount of churn in the bindings, because
black now sees enough context to know whether one 'def' follows another
or ends the 'def's in a 'class'. In the latter case, it adds an extra
newline, which becomes a "//|" line.

I'm less sure why a trailing comma was omitted before down in
rp2pio/StateMachine.c but let's roll with it.
2022-09-30 11:18:13 -05:00
.github Revert "pin python version for doc building" 2022-09-27 08:20:44 -05:00
LICENSES Add an explicit SPDX license file for ter-u12n. 2020-07-06 19:15:41 +01:00
data Update nvm.toml to add support for Puya P25Q32H 2022-06-22 17:06:27 -06:00
devices/ble_hci ringbuf cleanup 2022-09-21 10:03:05 -04:00
docs Fix trailing whitespace 2022-09-01 13:32:49 -07:00
examples Fix all natmod tests to run on x64 2022-02-13 11:18:38 -06:00
extmod Update ulab to 5.1.1 2022-09-23 08:29:32 -05:00
frozen restore submodule commits 2022-09-28 14:48:54 -05:00
lib Merge pull request #5852 from jepler/floppy 2022-04-26 11:40:19 -04:00
locale Translated using Weblate (Swedish) 2022-09-30 10:18:14 +02:00
logo Add license to some obvious files. 2020-07-06 19:16:25 +01:00
mpy-cross Implement scan, connect, ping 2022-09-28 10:06:33 -05:00
ports Tweak black_bindings 2022-09-30 11:18:13 -05:00
py Merge pull request #6933 from jepler/🥧🐮 2022-09-28 18:09:24 -04:00
shared allow preserving pin state during deep sleep 2022-09-15 17:35:14 -04:00
shared-bindings Tweak black_bindings 2022-09-30 11:18:13 -05:00
shared-module finish status bar internal simplification 2022-09-27 15:14:40 -04:00
supervisor Merge pull request #6933 from jepler/🥧🐮 2022-09-28 18:09:24 -04:00
tests Merge pull request #6754 from jepler/check-read-utf8 2022-08-15 13:48:43 -07:00
tools Tweak black_bindings 2022-09-30 11:18:13 -05:00
.git-blame-ignore-revs top: Update .git-blame-ignore-revs for latest formatting commit. 2021-04-27 23:46:46 +10:00
.gitattributes Merge MicroPython 1.12 into CircuitPython 2021-05-03 14:01:18 -07:00
.gitignore refine stubs-building procedure 2021-06-22 08:59:05 -05:00
.gitmodules Implement enough of socketpool to do ntp and non-https requests 2022-09-28 10:06:34 -05:00
.mailmap Add a `.mailmap` file to collate together multiple author entries. 2020-07-06 19:15:41 +01:00
.pre-commit-config.yaml Add neopixel support on PWM capable pins 2021-12-14 16:59:53 -08:00
.readthedocs.yml Fetch the submodules in readthedocs with ci_fetch_deps.py 2022-05-14 23:17:49 +02:00
.rosie.yml Add license to some obvious files. 2020-07-06 19:16:25 +01:00
ACKNOWLEDGEMENTS Merge MicroPython 1.12 into CircuitPython 2021-05-03 14:01:18 -07:00
ACKNOWLEDGEMENTS.license Add license to some obvious files. 2020-07-06 19:16:25 +01:00
BUILDING.md Correct typo 2022-07-05 12:03:04 -04:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md from source-of-truth repository. 2020-06-03 10:43:36 +01:00
CONTRIBUTING.md Fix error 2020-10-26 23:36:54 +01:00
LICENSE update formatting of LICENSE and clean-up 2022-08-27 14:47:10 +05:30
LICENSE_MicroPython update formatting of LICENSE and clean-up 2022-08-27 14:47:10 +05:30
MANIFEST.in-stubs refine stubs-building procedure 2021-06-22 08:59:05 -05:00
Makefile Add fetch-modules to `make help` for main makefile 2022-05-11 23:45:37 -04:00
README.rst link to workflow page in docs. Capitalize "Workflow" 2022-07-01 13:57:32 -05:00
README.rst-stubs Actually reduce the README text for the stubs package 2021-06-24 13:41:01 -05:00
WEBUSB_README.md Rename esp32s2 port to espressif 2021-09-13 16:44:55 -07:00
conf.py exclude files from doc build 2022-09-29 21:37:23 -05:00
main.c cyw43 basic gpio support, hwaddr in boot_out 2022-09-28 10:06:33 -05:00
requirements-ci.txt build docs dynamically 2021-09-16 00:05:42 +05:30
requirements-dev.txt Update requirements-dev.txt 2022-07-27 18:28:01 +01:00
requirements-doc.txt avoid problematic sphinx version number for rtd theme 2022-09-25 16:10:11 +02:00
runtime.py Conditionalize LTO 2022-05-27 12:59:54 -07:00
setup.py-stubs use --long for describe in setup.py-stubs 2022-02-18 21:22:02 -05:00

README.rst-stubs

CircuitPython
=============

.. image:: https://s3.amazonaws.com/adafruit-circuit-python/CircuitPython_Repo_header_logo.png

|Build Status| |Doc Status| |License| |Discord| |Weblate|

`circuitpython.org <https://circuitpython.org>`__ \| `Get CircuitPython <#get-circuitpython>`__ \|
`Documentation <#documentation>`__ \| `Contributing <#contributing>`__ \|
`Branding <#branding>`__ \| `Differences from Micropython <#differences-from-micropython>`__ \|
`Project Structure <#project-structure>`__

**CircuitPython** is a *beginner friendly*, open source version of Python for tiny, inexpensive
computers called microcontrollers.

This package contains the "stubs", or type definitions for CircuitPython.  With some advanced
editors and other tools, this information can be identify TypeErrors, AttributeErrors, and other
problems before you deploy your code to a device and can even help autocomplete your code.

.. |Build Status| image:: https://github.com/adafruit/circuitpython/workflows/Build%20CI/badge.svg
   :target: https://github.com/adafruit/circuitpython/actions?query=branch%3Amain
.. |Doc Status| image:: https://readthedocs.org/projects/circuitpython/badge/?version=latest
   :target: http://circuitpython.readthedocs.io/
.. |Discord| image:: https://img.shields.io/discord/327254708534116352.svg
   :target: https://adafru.it/discord
.. |License| image:: https://img.shields.io/badge/License-MIT-brightgreen.svg
   :target: https://choosealicense.com/licenses/mit/
.. |Weblate| image:: https://hosted.weblate.org/widgets/circuitpython/-/svg-badge.svg
   :target: https://hosted.weblate.org/engage/circuitpython/?utm_source=widget