From 0831911658ca9af41ae4327c4a61bc820bef75bd Mon Sep 17 00:00:00 2001 From: Martin Filtenborg Date: Fri, 5 Nov 2021 13:03:19 +0100 Subject: [PATCH 01/59] Update adafruit_avrprog.py Added support for Record type 4, as described here: https://en.wikipedia.org/wiki/Intel_HEX#Record_types --- adafruit_avrprog.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py index ccd6e12..4eecffa 100644 --- a/adafruit_avrprog.py +++ b/adafruit_avrprog.py @@ -420,6 +420,10 @@ def read_hex_page(file_state, page_addr, page_size, page_buffer): continue if rec_type == 3: # sometimes appears, we ignore this continue + if rec_type == 4: + file_state["ext_addr"] = int(line[9:13], 16) << 16 + #print("ExtLin addr: %05X" % file_state['ext_addr']) + continue if rec_type != 0: # if not the above or a data record... raise RuntimeError( "Unsupported record type %d on line %d" % (rec_type, file_state["line"]) From 7570998a29bb4265832bc009f91d9a09395738cc Mon Sep 17 00:00:00 2001 From: Martin Filtenborg Date: Fri, 5 Nov 2021 13:10:05 +0100 Subject: [PATCH 02/59] Extend Boards to support ATmega644PA Add built-in support for AVR ATmega644PA. --- adafruit_avrprog.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py index ccd6e12..15f9b3f 100644 --- a/adafruit_avrprog.py +++ b/adafruit_avrprog.py @@ -71,6 +71,13 @@ class Boards: "page_size": 128, "fuse_mask": (0xFF, 0xFF, 0x07, 0x3F), } + ATmega644pa = { + "name": "ATmega644pa", + "sig": [0x1E, 0x96, 0x0A], + "flash_size": 65536, + "page_size": 256, + "fuse_mask": (0xF7, 0x8F, 0xFD, 0xFF), + } ATmega2560 = { "name": "ATmega2560", "sig": [0x1E, 0x98, 0x01], From 300a7661446673d56103d69fc8fcf02ccca6eb23 Mon Sep 17 00:00:00 2001 From: dherrada Date: Fri, 5 Nov 2021 14:49:30 -0400 Subject: [PATCH 03/59] Disabled unspecified-encoding pylint check Signed-off-by: dherrada --- .pylintrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index b934d95..29b1201 100644 --- a/.pylintrc +++ b/.pylintrc @@ -55,7 +55,7 @@ confidence= # no Warning level messages displayed, use"--disable=all --enable=classes # --disable=W" # disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call -disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation +disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,unspecified-encoding # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option From fa8c64b8b1866aada144dff8065f4c880d06ca60 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Fri, 5 Nov 2021 20:47:37 -0500 Subject: [PATCH 04/59] merge main and code format --- adafruit_avrprog.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py index 7c4550a..0f3f3ae 100644 --- a/adafruit_avrprog.py +++ b/adafruit_avrprog.py @@ -365,6 +365,7 @@ def _busy_wait(self): def read_hex_page(file_state, page_addr, page_size, page_buffer): + # pylint: disable=too-many-branches """ Helper function that does the Intel Hex parsing. Takes in a dictionary that contains the file 'state'. The dictionary should have file_state['f'] @@ -422,7 +423,7 @@ def read_hex_page(file_state, page_addr, page_size, page_buffer): continue if rec_type == 4: file_state["ext_addr"] = int(line[9:13], 16) << 16 - #print("ExtLin addr: %05X" % file_state['ext_addr']) + # print("ExtLin addr: %05X" % file_state['ext_addr']) continue if rec_type != 0: # if not the above or a data record... raise RuntimeError( From d833df2b3f8fc976838f8eac94c6c531df63389a Mon Sep 17 00:00:00 2001 From: foamyguy Date: Fri, 5 Nov 2021 20:52:41 -0500 Subject: [PATCH 05/59] merge main and code format --- adafruit_avrprog.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py index 0920ac5..542fa95 100644 --- a/adafruit_avrprog.py +++ b/adafruit_avrprog.py @@ -73,7 +73,7 @@ class Boards: } ATmega644pa = { "name": "ATmega644pa", - "sig": [0x1E, 0x96, 0x0A], + "sig": [0x1E, 0x96, 0x0A], "flash_size": 65536, "page_size": 256, "fuse_mask": (0xF7, 0x8F, 0xFD, 0xFF), From 97219bb9d4f05237d8bd28b035afef9d31c6ea9c Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 9 Nov 2021 13:31:14 -0500 Subject: [PATCH 06/59] Updated readthedocs file Signed-off-by: dherrada --- .readthedocs.yaml | 15 +++++++++++++++ .readthedocs.yml | 7 ------- 2 files changed, 15 insertions(+), 7 deletions(-) create mode 100644 .readthedocs.yaml delete mode 100644 .readthedocs.yml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..95ec218 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,15 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +python: + version: "3.6" + install: + - requirements: docs/requirements.txt + - requirements: requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml deleted file mode 100644 index 49dcab3..0000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,7 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -python: - version: 3 -requirements_file: docs/requirements.txt From 1bb3fbc4c0bf8cd53daae1fccd40ac6bf38bcb94 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 23 Nov 2021 13:11:34 -0600 Subject: [PATCH 07/59] update rtd py version --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 95ec218..1335112 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,7 @@ version: 2 python: - version: "3.6" + version: "3.7" install: - requirements: docs/requirements.txt - requirements: requirements.txt From cb9fac67ffbe5d30cf0ed36bce67ea8a89bd5800 Mon Sep 17 00:00:00 2001 From: Aaron Tusko Date: Wed, 1 Dec 2021 06:43:00 -0800 Subject: [PATCH 08/59] changed getattr() calls to chip.get() --- adafruit_avrprog.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py index 18e414b..7fe82c0 100644 --- a/adafruit_avrprog.py +++ b/adafruit_avrprog.py @@ -127,7 +127,7 @@ def program_file(self, chip, file_name, verbose=False, verify=True): print("Erasing chip....") self.erase_chip() - clock_speed = getattr(chip, "clock_speed", _FAST_CLOCK) + clock_speed = chip.get("clock_speed", _FAST_CLOCK) self.begin(clock=clock_speed) # create a file state dictionary @@ -196,7 +196,7 @@ def verify_file(self, chip, file_name, verbose=False): "f" ]: page_size = chip["page_size"] - clock_speed = getattr(chip, "clock_speed", _FAST_CLOCK) + clock_speed = chip.get("clock_speed", _FAST_CLOCK) self.begin(clock=clock_speed) for page_addr in range(0x0, chip["flash_size"], page_size): page_buffer = bytearray(page_size) From 906171bea024125bfa9ff4e155004533c41c3524 Mon Sep 17 00:00:00 2001 From: Aaron Tusko Date: Fri, 7 Jan 2022 06:56:37 -0800 Subject: [PATCH 09/59] Added _busy_wait() calls after every write_fuses() transaction --- adafruit_avrprog.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py index 7fe82c0..410f2ef 100644 --- a/adafruit_avrprog.py +++ b/adafruit_avrprog.py @@ -251,9 +251,13 @@ def write_fuses(self, chip, low=None, high=None, ext=None, lock=None): """ self.begin(clock=_SLOW_CLOCK) lock and self._transaction((0xAC, 0xE0, 0, lock)) + self._busy_wait() low and self._transaction((0xAC, 0xA0, 0, low)) + self._busy_wait() high and self._transaction((0xAC, 0xA8, 0, high)) + self._busy_wait() ext and self._transaction((0xAC, 0xA4, 0, ext)) + self._busy_wait() self.end() # pylint: enable=unused-argument,expression-not-assigned From 698357d746806cd7b39be3f0c616de15eeb0a2f8 Mon Sep 17 00:00:00 2001 From: dherrada Date: Thu, 13 Jan 2022 16:27:30 -0500 Subject: [PATCH 10/59] First part of patch Signed-off-by: dherrada --- .../PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md | 2 +- .github/workflows/build.yml | 6 +++--- .github/workflows/release.yml | 8 ++++---- .readthedocs.yaml | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md index 71ef8f8..8de294e 100644 --- a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md +++ b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md @@ -4,7 +4,7 @@ Thank you for contributing! Before you submit a pull request, please read the following. -Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html +Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://docs.circuitpython.org/en/latest/docs/design_guide.html If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index ca35544..474520d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -22,10 +22,10 @@ jobs: awk -F '\/' '{ print tolower($2) }' | tr '_' '-' ) - - name: Set up Python 3.7 - uses: actions/setup-python@v1 + - name: Set up Python 3.x + uses: actions/setup-python@v2 with: - python-version: 3.7 + python-version: "3.x" - name: Versions run: | python3 --version diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 6d0015a..a65e5de 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -24,10 +24,10 @@ jobs: awk -F '\/' '{ print tolower($2) }' | tr '_' '-' ) - - name: Set up Python 3.6 - uses: actions/setup-python@v1 + - name: Set up Python 3.x + uses: actions/setup-python@v2 with: - python-version: 3.6 + python-version: "3.x" - name: Versions run: | python3 --version @@ -67,7 +67,7 @@ jobs: echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) - name: Set up Python if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - uses: actions/setup-python@v1 + uses: actions/setup-python@v2 with: python-version: '3.x' - name: Install dependencies diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 1335112..f8b2891 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,7 @@ version: 2 python: - version: "3.7" + version: "3.x" install: - requirements: docs/requirements.txt - requirements: requirements.txt From 072bac59cdb42850cb9fec2d3ef8d8e9ddf1463f Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 24 Jan 2022 16:46:16 -0500 Subject: [PATCH 11/59] Updated docs link, updated python docs link, updated setup.py --- README.rst | 4 ++-- docs/conf.py | 4 ++-- docs/index.rst | 2 +- setup.py | 2 -- 4 files changed, 5 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 4ab5828..38c218e 100644 --- a/README.rst +++ b/README.rst @@ -3,7 +3,7 @@ Introduction ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-avrprog/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/avrprog/en/latest/ + :target: https://docs.circuitpython.org/projects/avrprog/en/latest/ :alt: Documentation Status .. image :: https://img.shields.io/discord/327254708534116352.svg @@ -59,7 +59,7 @@ See examples folder for full examples that progam various bootloaders onto chips Documentation ============= -API documentation for this library can be found on `Read the Docs `_. +API documentation for this library can be found on `Read the Docs `_. Contributing ============ diff --git a/docs/conf.py b/docs/conf.py index b608fce..fbee8e9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -26,8 +26,8 @@ # autodoc_mock_imports = ["digitalio"] intersphinx_mapping = { - "python": ("https://docs.python.org/3.4", None), - "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None), + "python": ("https://docs.python.org/3", None), + "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None), } # Add any paths that contain templates here, relative to this directory. diff --git a/docs/index.rst b/docs/index.rst index 979de03..47715a6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -30,7 +30,7 @@ Table of Contents :caption: Other Links Download - CircuitPython Reference Documentation + CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat Adafruit Learning System diff --git a/setup.py b/setup.py index 81f63eb..1fd48c8 100644 --- a/setup.py +++ b/setup.py @@ -45,8 +45,6 @@ "Topic :: System :: Hardware", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.4", - "Programming Language :: Python :: 3.5", ], # What does your project relate to? keywords="adafruit avr spi atmega attiny hardware micropython circuitpython", From 9b2a0eb15152fb8dfab11ad19af5c4a7dd3d927f Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Thu, 10 Feb 2022 09:34:45 -0500 Subject: [PATCH 12/59] Consolidate Documentation sections of README --- README.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 38c218e..c1776df 100644 --- a/README.rst +++ b/README.rst @@ -61,14 +61,11 @@ Documentation API documentation for this library can be found on `Read the Docs `_. +For information on building library documentation, please check out `this guide `_. + Contributing ============ Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. - -Documentation -============= - -For information on building library documentation, please check out `this guide `_. From dd0f6f8ebbbbca8f9acfad3ee5855b900f2f9a90 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 14 Feb 2022 15:35:02 -0500 Subject: [PATCH 13/59] Fixed readthedocs build Signed-off-by: dherrada --- .readthedocs.yaml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f8b2891..33c2a61 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,8 +8,12 @@ # Required version: 2 +build: + os: ubuntu-20.04 + tools: + python: "3" + python: - version: "3.x" install: - requirements: docs/requirements.txt - requirements: requirements.txt From 3d0c33299298a249caa5f5f74a3f64c49c2fe872 Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Mon, 28 Mar 2022 15:52:04 -0400 Subject: [PATCH 14/59] Update Black to latest. Signed-off-by: Kattni Rembor --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 1b9fadc..7467c1d 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,7 +4,7 @@ repos: - repo: https://github.com/python/black - rev: 20.8b1 + rev: 22.3.0 hooks: - id: black - repo: https://github.com/fsfe/reuse-tool From 1ca5aff200fe8f78dc3bada803856c3f0edbd15b Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 29 Mar 2022 18:14:41 -0400 Subject: [PATCH 15/59] "Reformatted per new black version" --- examples/avrprog_program_mega2560.py | 2 +- examples/avrprog_program_tiny13a.py | 2 +- examples/avrprog_program_trinket85.py | 2 +- examples/avrprog_program_uno328.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/examples/avrprog_program_mega2560.py b/examples/avrprog_program_mega2560.py index f9948e5..d3ace05 100644 --- a/examples/avrprog_program_mega2560.py +++ b/examples/avrprog_program_mega2560.py @@ -35,7 +35,7 @@ def error(err): - """ Helper to print out errors for us and then halt """ + """Helper to print out errors for us and then halt""" print("ERROR: " + err) avrprog.end() while True: diff --git a/examples/avrprog_program_tiny13a.py b/examples/avrprog_program_tiny13a.py index e5b77e3..4e8b5c5 100644 --- a/examples/avrprog_program_tiny13a.py +++ b/examples/avrprog_program_tiny13a.py @@ -25,7 +25,7 @@ def error(err): - """ Helper to print out errors for us and then halt """ + """Helper to print out errors for us and then halt""" print("ERROR: " + err) avrprog.end() while True: diff --git a/examples/avrprog_program_trinket85.py b/examples/avrprog_program_trinket85.py index 366a4fc..c8b8007 100644 --- a/examples/avrprog_program_trinket85.py +++ b/examples/avrprog_program_trinket85.py @@ -25,7 +25,7 @@ def error(err): - """ Helper to print out errors for us and then halt """ + """Helper to print out errors for us and then halt""" print("ERROR: " + err) avrprog.end() while True: diff --git a/examples/avrprog_program_uno328.py b/examples/avrprog_program_uno328.py index b832300..71e0051 100644 --- a/examples/avrprog_program_uno328.py +++ b/examples/avrprog_program_uno328.py @@ -31,7 +31,7 @@ def error(err): - """ Helper to print out errors for us and then halt """ + """Helper to print out errors for us and then halt""" print("ERROR: " + err) avrprog.end() while True: From e7bcbf543a008689acf09c8bb6fa0351953b3a93 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Thu, 21 Apr 2022 15:00:27 -0400 Subject: [PATCH 16/59] Updated gitignore Signed-off-by: evaherrada --- .gitignore | 48 ++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 40 insertions(+), 8 deletions(-) diff --git a/.gitignore b/.gitignore index 9647e71..544ec4a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,15 +1,47 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries # -# SPDX-License-Identifier: Unlicense +# SPDX-License-Identifier: MIT +# Do not include files and directories created by your personal work environment, such as the IDE +# you use, except for those already listed here. Pull requests including changes to this file will +# not be accepted. + +# This .gitignore file contains rules for files generated by working with CircuitPython libraries, +# including building Sphinx, testing with pip, and creating a virual environment, as well as the +# MacOS and IDE-specific files generated by using MacOS in general, or the PyCharm or VSCode IDEs. + +# If you find that there are files being generated on your machine that should not be included in +# your git commit, you should create a .gitignore_global file on your computer to include the +# files created by your personal setup. To do so, follow the two steps below. + +# First, create a file called .gitignore_global somewhere convenient for you, and add rules for +# the files you want to exclude from git commits. + +# Second, configure Git to use the exclude file for all Git repositories by running the +# following via commandline, replacing "path/to/your/" with the actual path to your newly created +# .gitignore_global file: +# git config --global core.excludesfile path/to/your/.gitignore_global + +# CircuitPython-specific files *.mpy -.idea + +# Python-specific files __pycache__ -_build *.pyc + +# Sphinx build-specific files +_build + +# This file results from running `pip -e install .` in a local repository +*.egg-info + +# Virtual environment-specific files .env -bundles + +# MacOS-specific files *.DS_Store -.eggs -dist -**/*.egg-info + +# IDE-specific files +.idea +.vscode +*~ From c14bde34ab00b9198c6b079980736020d7f69217 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Apr 2022 15:58:20 -0400 Subject: [PATCH 17/59] Patch: Replaced discord badge image --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index c1776df..53c6428 100644 --- a/README.rst +++ b/README.rst @@ -6,7 +6,7 @@ Introduction :target: https://docs.circuitpython.org/projects/avrprog/en/latest/ :alt: Documentation Status -.. image :: https://img.shields.io/discord/327254708534116352.svg +.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Bundle/blob/main/badges/adafruit_discord.svg :target: https://adafru.it/discord :alt: Discord From 21a2661ab9bba1aba0847fa729ff13f00600726d Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sun, 24 Apr 2022 14:01:18 -0500 Subject: [PATCH 18/59] change discord badge --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 53c6428..e7a42a9 100644 --- a/README.rst +++ b/README.rst @@ -6,7 +6,7 @@ Introduction :target: https://docs.circuitpython.org/projects/avrprog/en/latest/ :alt: Documentation Status -.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Bundle/blob/main/badges/adafruit_discord.svg +.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg :target: https://adafru.it/discord :alt: Discord From 1e99fc95817f50b1b102968a7a7a8c0237c9b334 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 15 May 2022 12:48:56 -0400 Subject: [PATCH 19/59] Patch .pre-commit-config.yaml --- .pre-commit-config.yaml | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 7467c1d..3343606 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -3,40 +3,40 @@ # SPDX-License-Identifier: Unlicense repos: -- repo: https://github.com/python/black + - repo: https://github.com/python/black rev: 22.3.0 hooks: - - id: black -- repo: https://github.com/fsfe/reuse-tool - rev: v0.12.1 + - id: black + - repo: https://github.com/fsfe/reuse-tool + rev: v0.14.0 hooks: - - id: reuse -- repo: https://github.com/pre-commit/pre-commit-hooks - rev: v2.3.0 + - id: reuse + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.2.0 hooks: - - id: check-yaml - - id: end-of-file-fixer - - id: trailing-whitespace -- repo: https://github.com/pycqa/pylint + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace + - repo: https://github.com/pycqa/pylint rev: v2.11.1 hooks: - - id: pylint + - id: pylint name: pylint (library code) types: [python] args: - --disable=consider-using-f-string exclude: "^(docs/|examples/|tests/|setup.py$)" - - id: pylint + - id: pylint name: pylint (example code) description: Run pylint rules on "examples/*.py" files types: [python] files: "^examples/" args: - - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code - - id: pylint + - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code + - id: pylint name: pylint (test code) description: Run pylint rules on "tests/*.py" files types: [python] files: "^tests/" args: - - --disable=missing-docstring,consider-using-f-string,duplicate-code + - --disable=missing-docstring,consider-using-f-string,duplicate-code From 8243ece8b373566285e4fddcc128c45c92b78878 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:55 -0400 Subject: [PATCH 20/59] Increase min lines similarity Signed-off-by: Alec Delaney --- .pylintrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index 29b1201..ca0d726 100644 --- a/.pylintrc +++ b/.pylintrc @@ -252,7 +252,7 @@ ignore-docstrings=yes ignore-imports=yes # Minimum lines number of a similarity. -min-similarity-lines=4 +min-similarity-lines=12 [BASIC] From 7336badfea8e79b53300dab3fab1585069c0b7dc Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:23 -0400 Subject: [PATCH 21/59] Switch to inclusive terminology Signed-off-by: Alec Delaney --- .pylintrc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.pylintrc b/.pylintrc index ca0d726..7af36ce 100644 --- a/.pylintrc +++ b/.pylintrc @@ -9,11 +9,11 @@ # run arbitrary code extension-pkg-whitelist= -# Add files or directories to the blacklist. They should be base names, not +# Add files or directories to the ignore-list. They should be base names, not # paths. ignore=CVS -# Add files or directories matching the regex patterns to the blacklist. The +# Add files or directories matching the regex patterns to the ignore-list. The # regex matches against base names, not paths. ignore-patterns= From b6f991be0aadbfb6a0b337ea1c72bbe94399c8a7 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 30 May 2022 14:25:04 -0400 Subject: [PATCH 22/59] Set language to "en" for documentation Signed-off-by: Alec Delaney --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index fbee8e9..8f89a08 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -57,7 +57,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. From 3c9433bedaacf99e0e2e6a0e3f320912ad571ded Mon Sep 17 00:00:00 2001 From: evaherrada Date: Tue, 7 Jun 2022 15:34:01 -0400 Subject: [PATCH 23/59] Added cp.org link to index.rst --- docs/index.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 47715a6..e820993 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -29,7 +29,8 @@ Table of Contents .. toctree:: :caption: Other Links - Download + Download from GitHub + Download Library Bundle CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat From e0cb0e908a3ec953cd01991ae4598c812223d419 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Jul 2022 13:58:28 -0400 Subject: [PATCH 24/59] Changed .env to .venv in README.rst --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index e7a42a9..a23fc44 100644 --- a/README.rst +++ b/README.rst @@ -47,8 +47,8 @@ To install in a virtual environment in your current project: .. code-block:: shell mkdir project-name && cd project-name - python3 -m venv .env - source .env/bin/activate + python3 -m venv .venv + source .venv/bin/activate pip3 install adafruit-circuitpython-avrprog Usage Example From f77a76ea01edc48ca758ed09efb779b9c8c40140 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Tue, 2 Aug 2022 17:00:20 -0400 Subject: [PATCH 25/59] Added Black formatting badge --- README.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.rst b/README.rst index a23fc44..5da80bf 100644 --- a/README.rst +++ b/README.rst @@ -14,6 +14,10 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_AVRprog/actions/ :alt: Build Status +.. image:: https://img.shields.io/badge/code%20style-black-000000.svg + :target: https://github.com/psf/black + :alt: Code Style: Black + Program your favorite AVR chips directly from CircuitPython with this handy helper class that will let you make stand-alone programmers right from your REPL. Should work with any/all AVR chips, via SPI programming. Tested with ATmega328, ATtiny85 and ATmega2560 Dependencies From 5ec34e4bc19b30519af3f3b213c80ba0630a8dbd Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 8 Aug 2022 22:05:54 -0400 Subject: [PATCH 26/59] Switched to pyproject.toml --- .github/workflows/build.yml | 18 ++++++------ .github/workflows/release.yml | 17 ++++++----- optional_requirements.txt | 3 ++ pyproject.toml | 46 +++++++++++++++++++++++++++++ requirements.txt | 2 +- setup.py | 54 ----------------------------------- 6 files changed, 70 insertions(+), 70 deletions(-) create mode 100644 optional_requirements.txt create mode 100644 pyproject.toml delete mode 100644 setup.py diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 474520d..22f6582 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -47,6 +47,8 @@ jobs: pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags + - name: Setup problem matchers + uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 - name: Pre-commit hooks run: | pre-commit run --all-files @@ -60,16 +62,16 @@ jobs: - name: Build docs working-directory: docs run: sphinx-build -E -W -b html . _build/html - - name: Check For setup.py + - name: Check For pyproject.toml id: need-pypi run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) + echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - name: Build Python package - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') run: | - pip install --upgrade setuptools wheel twine readme_renderer testresources - python setup.py sdist - python setup.py bdist_wheel --universal + pip install --upgrade build twine + for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do + sed -i -e "s/0.0.0-auto.0/1.2.3/" $file; + done; + python -m build twine check dist/* - - name: Setup problem matchers - uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a65e5de..d1b4f8d 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -61,25 +61,28 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v1 - - name: Check For setup.py + - name: Check For pyproject.toml id: need-pypi run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) + echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - name: Set up Python - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') uses: actions/setup-python@v2 with: python-version: '3.x' - name: Install dependencies - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') run: | python -m pip install --upgrade pip - pip install setuptools wheel twine + pip install --upgrade build twine - name: Build and publish - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') env: TWINE_USERNAME: ${{ secrets.pypi_username }} TWINE_PASSWORD: ${{ secrets.pypi_password }} run: | - python setup.py sdist + for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do + sed -i -e "s/0.0.0-auto.0/${{github.event.release.tag_name}}/" $file; + done; + python -m build twine upload dist/* diff --git a/optional_requirements.txt b/optional_requirements.txt new file mode 100644 index 0000000..d4e27c4 --- /dev/null +++ b/optional_requirements.txt @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..7810fe4 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,46 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", +] + +[project] +name = "adafruit-circuitpython-avrprog" +description = "CircuitPython helper library for programming AVR chips." +version = "0.0.0-auto.0" +readme = "README.rst" +authors = [ + {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} +] +urls = {Homepage = "https://github.com/adafruit/Adafruit_CircuitPython_AVRprog"} +keywords = [ + "adafruit", + "avr", + "spi", + "atmega", + "attiny", + "hardware", + "micropython", + "circuitpython", +] +license = {text = "MIT"} +classifiers = [ + "Intended Audience :: Developers", + "Topic :: Software Development :: Libraries", + "Topic :: Software Development :: Embedded Systems", + "Topic :: System :: Hardware", + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3", +] +dynamic = ["dependencies", "optional-dependencies"] + +[tool.setuptools] +py-modules = ["adafruit_avrprog"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index 17a850d..7a984a4 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # # SPDX-License-Identifier: Unlicense diff --git a/setup.py b/setup.py deleted file mode 100644 index 1fd48c8..0000000 --- a/setup.py +++ /dev/null @@ -1,54 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -"""A setuptools based setup module. - -See: -https://packaging.python.org/en/latest/distributing.html -https://github.com/pypa/sampleproject -""" - -# Always prefer setuptools over distutils -from setuptools import setup, find_packages - -# To use a consistent encoding -from codecs import open -from os import path - -here = path.abspath(path.dirname(__file__)) - -# Get the long description from the README file -with open(path.join(here, "README.rst"), encoding="utf-8") as f: - long_description = f.read() - -setup( - name="adafruit-circuitpython-avrprog", - use_scm_version=True, - setup_requires=["setuptools_scm"], - description="CircuitPython helper library for programming AVR chips.", - long_description=long_description, - long_description_content_type="text/x-rst", - # The project's main homepage. - url="https://github.com/adafruit/Adafruit_CircuitPython_AVRprog", - # Author details - author="Adafruit Industries", - author_email="circuitpython@adafruit.com", - install_requires=["Adafruit-Blinka"], - # Choose your license - license="MIT", - # See https://pypi.python.org/pypi?%3Aaction=list_classifiers - classifiers=[ - "Development Status :: 3 - Alpha", - "Intended Audience :: Developers", - "Topic :: Software Development :: Libraries", - "Topic :: System :: Hardware", - "License :: OSI Approved :: MIT License", - "Programming Language :: Python :: 3", - ], - # What does your project relate to? - keywords="adafruit avr spi atmega attiny hardware micropython circuitpython", - # You can just specify the packages manually here if your project is - # simple. Or you can use find_packages(). - py_modules=["adafruit_avrprog"], -) From 765764c92f1284a3d3dec932d783e84d564d5016 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 9 Aug 2022 12:03:54 -0400 Subject: [PATCH 27/59] Add setuptools-scm to build system requirements Signed-off-by: Alec Delaney --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index 7810fe4..885e992 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,6 +6,7 @@ requires = [ "setuptools", "wheel", + "setuptools-scm", ] [project] From 6cee98dcc3c3235be99eac85999493f45309d40a Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 18:09:15 -0400 Subject: [PATCH 28/59] Update version string --- adafruit_avrprog.py | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py index 410f2ef..a25798d 100644 --- a/adafruit_avrprog.py +++ b/adafruit_avrprog.py @@ -29,7 +29,7 @@ # imports -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AVRprog.git" from digitalio import Direction, DigitalInOut diff --git a/pyproject.toml b/pyproject.toml index 885e992..61df63a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,7 +12,7 @@ requires = [ [project] name = "adafruit-circuitpython-avrprog" description = "CircuitPython helper library for programming AVR chips." -version = "0.0.0-auto.0" +version = "0.0.0+auto.0" readme = "README.rst" authors = [ {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} From abc3fdc05c8b1be649485c97433ecc5d599cf952 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 21:09:14 -0400 Subject: [PATCH 29/59] Fix version strings in workflow files --- .github/workflows/build.yml | 2 +- .github/workflows/release.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 22f6582..cb2f60e 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -71,7 +71,7 @@ jobs: run: | pip install --upgrade build twine for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0-auto.0/1.2.3/" $file; + sed -i -e "s/0.0.0+auto.0/1.2.3/" $file; done; python -m build twine check dist/* diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index d1b4f8d..f3a0325 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -82,7 +82,7 @@ jobs: TWINE_PASSWORD: ${{ secrets.pypi_password }} run: | for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0-auto.0/${{github.event.release.tag_name}}/" $file; + sed -i -e "s/0.0.0+auto.0/${{github.event.release.tag_name}}/" $file; done; python -m build twine upload dist/* From beaed80867942b08dceb41c7d335510e39603e69 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 22 Aug 2022 21:36:32 -0400 Subject: [PATCH 30/59] Keep copyright up to date in documentation --- docs/conf.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 8f89a08..aedd5ad 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -6,6 +6,7 @@ import os import sys +import datetime sys.path.insert(0, os.path.abspath("..")) @@ -40,7 +41,8 @@ # General information about the project. project = "Adafruit AVRprog Library" -copyright = "2017 ladyada" +current_year = str(datetime.datetime.now().year) +copyright = current_year + " ladyada" author = "ladyada" # The version info for the project you're documenting, acts as replacement for From 4c4c462960496e7997ced2f9f8bc1802085fb703 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 23 Aug 2022 17:26:22 -0400 Subject: [PATCH 31/59] Use year duration range for copyright attribution --- docs/conf.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index aedd5ad..0acc6eb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -41,8 +41,14 @@ # General information about the project. project = "Adafruit AVRprog Library" +creation_year = "2017" current_year = str(datetime.datetime.now().year) -copyright = current_year + " ladyada" +year_duration = ( + current_year + if current_year == creation_year + else creation_year + " - " + current_year +) +copyright = year_duration + " ladyada" author = "ladyada" # The version info for the project you're documenting, acts as replacement for From 3259c9c4452d3c42f8ae826edbbc9b328c5ccc2c Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 00:02:50 -0400 Subject: [PATCH 32/59] Switching to composite actions --- .github/workflows/build.yml | 67 +---------------------- .github/workflows/release.yml | 88 ------------------------------ .github/workflows/release_gh.yml | 14 +++++ .github/workflows/release_pypi.yml | 14 +++++ 4 files changed, 30 insertions(+), 153 deletions(-) delete mode 100644 .github/workflows/release.yml create mode 100644 .github/workflows/release_gh.yml create mode 100644 .github/workflows/release_pypi.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index cb2f60e..041a337 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -10,68 +10,5 @@ jobs: test: runs-on: ubuntu-latest steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.x - uses: actions/setup-python@v2 - with: - python-version: "3.x" - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install dependencies - # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) - run: | - source actions-ci/install.sh - - name: Pip install Sphinx, pre-commit - run: | - pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - - name: Library version - run: git describe --dirty --always --tags - - name: Setup problem matchers - uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 - - name: Pre-commit hooks - run: | - pre-commit run --all-files - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Archive bundles - uses: actions/upload-artifact@v2 - with: - name: bundles - path: ${{ github.workspace }}/bundles/ - - name: Build docs - working-directory: docs - run: sphinx-build -E -W -b html . _build/html - - name: Check For pyproject.toml - id: need-pypi - run: | - echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - - name: Build Python package - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - run: | - pip install --upgrade build twine - for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0+auto.0/1.2.3/" $file; - done; - python -m build - twine check dist/* + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index f3a0325..0000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,88 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -name: Release Actions - -on: - release: - types: [published] - -jobs: - upload-release-assets: - runs-on: ubuntu-latest - steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.x - uses: actions/setup-python@v2 - with: - python-version: "3.x" - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install deps - run: | - source actions-ci/install.sh - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Upload Release Assets - # the 'official' actions version does not yet support dynamically - # supplying asset names to upload. @csexton's version chosen based on - # discussion in the issue below, as its the simplest to implement and - # allows for selecting files with a pattern. - # https://github.com/actions/upload-release-asset/issues/4 - #uses: actions/upload-release-asset@v1.0.1 - uses: csexton/release-asset-action@master - with: - pattern: "bundles/*" - github-token: ${{ secrets.GITHUB_TOKEN }} - - upload-pypi: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v1 - - name: Check For pyproject.toml - id: need-pypi - run: | - echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - - name: Set up Python - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - uses: actions/setup-python@v2 - with: - python-version: '3.x' - - name: Install dependencies - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - run: | - python -m pip install --upgrade pip - pip install --upgrade build twine - - name: Build and publish - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - env: - TWINE_USERNAME: ${{ secrets.pypi_username }} - TWINE_PASSWORD: ${{ secrets.pypi_password }} - run: | - for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0+auto.0/${{github.event.release.tag_name}}/" $file; - done; - python -m build - twine upload dist/* diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml new file mode 100644 index 0000000..041a337 --- /dev/null +++ b/.github/workflows/release_gh.yml @@ -0,0 +1,14 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: Build CI + +on: [pull_request, push] + +jobs: + test: + runs-on: ubuntu-latest + steps: + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml new file mode 100644 index 0000000..041a337 --- /dev/null +++ b/.github/workflows/release_pypi.yml @@ -0,0 +1,14 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: Build CI + +on: [pull_request, push] + +jobs: + test: + runs-on: ubuntu-latest + steps: + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main From b9f633fabc8a0ec995d041b91676423a612faa4b Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 00:47:00 -0400 Subject: [PATCH 33/59] Updated pylint version to 2.13.0 --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 3343606..4c43710 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -18,7 +18,7 @@ repos: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.11.1 + rev: v2.13.0 hooks: - id: pylint name: pylint (library code) From 318c65fc0781a4c8753f93527f43e595d5b7dfc1 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 08:15:20 -0400 Subject: [PATCH 34/59] Update pylint to 2.15.5 --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 4c43710..0e5fccc 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -18,7 +18,7 @@ repos: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.13.0 + rev: v2.15.5 hooks: - id: pylint name: pylint (library code) From d52e5aa3bbd9920a3086196b06a281f6430d3178 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 09:12:45 -0400 Subject: [PATCH 35/59] Fix release CI files --- .github/workflows/release_gh.yml | 14 +++++++++----- .github/workflows/release_pypi.yml | 15 ++++++++++----- 2 files changed, 19 insertions(+), 10 deletions(-) diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml index 041a337..b8aa8d6 100644 --- a/.github/workflows/release_gh.yml +++ b/.github/workflows/release_gh.yml @@ -2,13 +2,17 @@ # # SPDX-License-Identifier: MIT -name: Build CI +name: GitHub Release Actions -on: [pull_request, push] +on: + release: + types: [published] jobs: - test: + upload-release-assets: runs-on: ubuntu-latest steps: - - name: Run Build CI workflow - uses: adafruit/workflows-circuitpython-libs/build@main + - name: Run GitHub Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-gh@main + with: + github-token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml index 041a337..65775b7 100644 --- a/.github/workflows/release_pypi.yml +++ b/.github/workflows/release_pypi.yml @@ -2,13 +2,18 @@ # # SPDX-License-Identifier: MIT -name: Build CI +name: PyPI Release Actions -on: [pull_request, push] +on: + release: + types: [published] jobs: - test: + upload-release-assets: runs-on: ubuntu-latest steps: - - name: Run Build CI workflow - uses: adafruit/workflows-circuitpython-libs/build@main + - name: Run PyPI Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-pypi@main + with: + pypi-username: ${{ secrets.pypi_username }} + pypi-password: ${{ secrets.pypi_password }} From 618ffe29c8b03a2885aaac0e226762e5efe40ef6 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 18:34:33 -0400 Subject: [PATCH 36/59] Update .pylintrc for v2.15.5 --- .pylintrc | 49 ++++++------------------------------------------- 1 file changed, 6 insertions(+), 43 deletions(-) diff --git a/.pylintrc b/.pylintrc index 7af36ce..40208c3 100644 --- a/.pylintrc +++ b/.pylintrc @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries # # SPDX-License-Identifier: Unlicense @@ -26,7 +26,7 @@ jobs=1 # List of plugins (as comma separated values of python modules names) to load, # usually to register additional checkers. -load-plugins= +load-plugins=pylint.extensions.no_self_use # Pickle collected data for later comparisons. persistent=yes @@ -54,8 +54,8 @@ confidence= # --enable=similarities". If you want to run only the classes checker, but have # no Warning level messages displayed, use"--disable=all --enable=classes # --disable=W" -# disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call -disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,unspecified-encoding +# disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call +disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option @@ -225,12 +225,6 @@ max-line-length=100 # Maximum number of lines in a module max-module-lines=1000 -# List of optional constructs for which whitespace checking is disabled. `dict- -# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. -# `trailing-comma` allows a space between comma and closing bracket: (a, ). -# `empty-line` allows space-only lines. -no-space-check=trailing-comma,dict-separator - # Allow the body of a class to be on the same line as the declaration if body # contains single statement. single-line-class-stmt=no @@ -257,38 +251,22 @@ min-similarity-lines=12 [BASIC] -# Naming hint for argument names -argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct argument names argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ -# Naming hint for attribute names -attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct attribute names attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ # Bad variable names which should always be refused, separated by a comma bad-names=foo,bar,baz,toto,tutu,tata -# Naming hint for class attribute names -class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - # Regular expression matching correct class attribute names class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ -# Naming hint for class names -# class-name-hint=[A-Z_][a-zA-Z0-9]+$ -class-name-hint=[A-Z_][a-zA-Z0-9_]+$ - # Regular expression matching correct class names # class-rgx=[A-Z_][a-zA-Z0-9]+$ class-rgx=[A-Z_][a-zA-Z0-9_]+$ -# Naming hint for constant names -const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - # Regular expression matching correct constant names const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ @@ -296,9 +274,6 @@ const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ # ones are exempt. docstring-min-length=-1 -# Naming hint for function names -function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct function names function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ @@ -309,21 +284,12 @@ good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ # Include a hint for the correct naming format with invalid-name include-naming-hint=no -# Naming hint for inline iteration names -inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ - # Regular expression matching correct inline iteration names inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ -# Naming hint for method names -method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct method names method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ -# Naming hint for module names -module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - # Regular expression matching correct module names module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ @@ -339,9 +305,6 @@ no-docstring-rgx=^_ # to this list to register other decorators that produce valid properties. property-classes=abc.abstractproperty -# Naming hint for variable names -variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct variable names variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ @@ -398,7 +361,7 @@ valid-metaclass-classmethod-first-arg=mcs [DESIGN] # Maximum number of arguments for function / method -max-args=6 +max-args=5 # Maximum number of attributes for a class (see R0902). # max-attributes=7 @@ -408,7 +371,7 @@ max-attributes=11 max-bool-expr=5 # Maximum number of branch for function / method body -max-branches=15 +max-branches=12 # Maximum number of locals for function / method body max-locals=15 From ceec424c3590b01764465e9efeae5ef16c1547f0 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Mon, 7 Nov 2022 20:28:57 -0500 Subject: [PATCH 37/59] Fixed pylint errors --- adafruit_avrprog.py | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py index a25798d..2c900e6 100644 --- a/adafruit_avrprog.py +++ b/adafruit_avrprog.py @@ -114,6 +114,7 @@ def verify_sig(self, chip, verbose=False): return False return True + # pylint: disable=too-many-branches def program_file(self, chip, file_name, verbose=False, verify=True): """ Perform a chip erase and program from a file that @@ -243,25 +244,22 @@ def read_fuses(self, chip): self.end() return (low, high, ext, lock) - # pylint: disable=unused-argument,expression-not-assigned + # pylint: disable=unused-argument,too-many-arguments def write_fuses(self, chip, low=None, high=None, ext=None, lock=None): """ Write any of the 4 fuses. If the kwarg low/high/ext/lock is not passed in or is None, that fuse is skipped """ + transaction_comp = (0xE0, 0xA0, 0xA8, 0xA4) + fuses = (lock, low, high, ext) self.begin(clock=_SLOW_CLOCK) - lock and self._transaction((0xAC, 0xE0, 0, lock)) - self._busy_wait() - low and self._transaction((0xAC, 0xA0, 0, low)) - self._busy_wait() - high and self._transaction((0xAC, 0xA8, 0, high)) - self._busy_wait() - ext and self._transaction((0xAC, 0xA4, 0, ext)) - self._busy_wait() + for fuse, comp in zip (fuses, transaction_comp): + if fuse: + self._transaction((0xAC, comp, 0, fuse)) + self._busy_wait() self.end() - # pylint: enable=unused-argument,expression-not-assigned - + # pylint: disable=too-many-arguments def verify_fuses(self, chip, low=None, high=None, ext=None, lock=None): """ Verify the 4 fuses. If the kwarg low/high/ext/lock is not From fbc6a25765a6dc5df8b25ce08e6edd7f6af9e1ef Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Mon, 7 Nov 2022 20:36:01 -0500 Subject: [PATCH 38/59] Reformatted per pre-commit --- adafruit_avrprog.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py index 2c900e6..704a258 100644 --- a/adafruit_avrprog.py +++ b/adafruit_avrprog.py @@ -253,7 +253,7 @@ def write_fuses(self, chip, low=None, high=None, ext=None, lock=None): transaction_comp = (0xE0, 0xA0, 0xA8, 0xA4) fuses = (lock, low, high, ext) self.begin(clock=_SLOW_CLOCK) - for fuse, comp in zip (fuses, transaction_comp): + for fuse, comp in zip(fuses, transaction_comp): if fuse: self._transaction((0xAC, comp, 0, fuse)) self._busy_wait() From b9a1f11635eae6cbcc665e6caf32a773293c3a25 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Thu, 1 Sep 2022 20:16:31 -0400 Subject: [PATCH 39/59] Add .venv to .gitignore Signed-off-by: Alec Delaney <89490472+tekktrik@users.noreply.github.com> --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 544ec4a..db3d538 100644 --- a/.gitignore +++ b/.gitignore @@ -37,6 +37,7 @@ _build # Virtual environment-specific files .env +.venv # MacOS-specific files *.DS_Store From 0b23c3d11c6a353312974a014b7f6585d1c20c39 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Thu, 19 Jan 2023 23:39:55 -0500 Subject: [PATCH 40/59] Add upload url to release action Signed-off-by: Alec Delaney <89490472+tekktrik@users.noreply.github.com> --- .github/workflows/release_gh.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml index b8aa8d6..9acec60 100644 --- a/.github/workflows/release_gh.yml +++ b/.github/workflows/release_gh.yml @@ -16,3 +16,4 @@ jobs: uses: adafruit/workflows-circuitpython-libs/release-gh@main with: github-token: ${{ secrets.GITHUB_TOKEN }} + upload-url: ${{ github.event.release.upload_url }} From 12afa4bfd6782e0cc861e7385bd73be2481521ea Mon Sep 17 00:00:00 2001 From: Ross Kukard <75049118+RossK1@users.noreply.github.com> Date: Tue, 25 Apr 2023 09:55:17 -0700 Subject: [PATCH 41/59] Working on adding type annotations --- adafruit_avrprog.py | 71 +++++++++++++++++++++++++++++++-------------- 1 file changed, 49 insertions(+), 22 deletions(-) diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py index 704a258..028d408 100644 --- a/adafruit_avrprog.py +++ b/adafruit_avrprog.py @@ -32,10 +32,19 @@ __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AVRprog.git" -from digitalio import Direction, DigitalInOut +try: + from io import TextIOWrapper + from typing import Any, Dict, Optional -_SLOW_CLOCK = 100000 -_FAST_CLOCK = 1000000 + from _typeshed import FileDescriptorOrPath + from busio import SPI +except ImportError: + pass + +from digitalio import DigitalInOut, Direction + +_SLOW_CLOCK: int = 100000 +_FAST_CLOCK: int = 1000000 class AVRprog: @@ -86,10 +95,10 @@ class Boards: "fuse_mask": (0xFF, 0xFF, 0x07, 0x3F), } - _spi = None - _rst = None + _spi: SPI = None + _rst: DigitalInOut = None - def init(self, spi_bus, rst_pin): + def init(self, spi_bus: SPI, rst_pin) -> None: """ Initialize the programmer with an SPI port that will be used to communicate with the chip. Make sure your SPI supports 'write_readinto' @@ -100,7 +109,7 @@ def init(self, spi_bus, rst_pin): self._rst.direction = Direction.OUTPUT self._rst.value = True - def verify_sig(self, chip, verbose=False): + def verify_sig(self, chip: Dict[str, Any], verbose: bool = False) -> bool: """ Verify that the chip is connected properly, responds to commands, and has the correct signature. Returns True/False based on success @@ -115,7 +124,13 @@ def verify_sig(self, chip, verbose=False): return True # pylint: disable=too-many-branches - def program_file(self, chip, file_name, verbose=False, verify=True): + def program_file( + self, + chip: Dict[str, Any], + file_name: FileDescriptorOrPath, + verbose: bool = False, + verify: bool = True, + ) -> bool: """ Perform a chip erase and program from a file that contains Intel HEX data. Returns true on verify-success, False on @@ -132,10 +147,8 @@ def program_file(self, chip, file_name, verbose=False, verify=True): self.begin(clock=clock_speed) # create a file state dictionary - file_state = {"line": 0, "ext_addr": 0, "eof": False} - with open(file_name, "r") as file_state[ # pylint: disable=unspecified-encoding - "f" - ]: + file_state = {"line": 0, "ext_addr": 0, "eof": False, "f": TextIOWrapper} + with open(file_name, "r") as file_state["f"]: page_size = chip["page_size"] for page_addr in range(0, chip["flash_size"], page_size): @@ -183,7 +196,9 @@ def program_file(self, chip, file_name, verbose=False, verify=True): self.end() return True - def verify_file(self, chip, file_name, verbose=False): + def verify_file( + self, chip: Dict[str, Any], file_name: FileDescriptorOrPath, verbose=False + ): """ Perform a chip full-flash verification from a file that contains Intel HEX data. Returns True/False on success/fail. @@ -192,10 +207,8 @@ def verify_file(self, chip, file_name, verbose=False): raise RuntimeError("Signature read failure") # create a file state dictionary - file_state = {"line": 0, "ext_addr": 0, "eof": False} - with open(file_name, "r") as file_name[ # pylint: disable=unspecified-encoding - "f" - ]: + file_state = {"line": 0, "ext_addr": 0, "eof": False, "f": TextIOWrapper} + with open(file_name, "r") as file_name["f"]: page_size = chip["page_size"] clock_speed = chip.get("clock_speed", _FAST_CLOCK) self.begin(clock=clock_speed) @@ -230,9 +243,9 @@ def verify_file(self, chip, file_name, verbose=False): self.end() return True - def read_fuses(self, chip): + def read_fuses(self, chip: Dict[str, Any]) -> tuple: """ - Read the 4 fuses and return them in a list (low, high, ext, lock) + Read the 4 fuses and return them in a tuple (low, high, ext, lock) Each fuse is bitwise-&'s with the chip's fuse mask for simplicity """ mask = chip["fuse_mask"] @@ -245,7 +258,14 @@ def read_fuses(self, chip): return (low, high, ext, lock) # pylint: disable=unused-argument,too-many-arguments - def write_fuses(self, chip, low=None, high=None, ext=None, lock=None): + def write_fuses( + self, + chip: Dict[str, Any], + low: Optional[int] = None, + high: Optional[int] = None, + ext: Optional[int] = None, + lock: Optional[int] = None, + ) -> None: """ Write any of the 4 fuses. If the kwarg low/high/ext/lock is not passed in or is None, that fuse is skipped @@ -260,7 +280,14 @@ def write_fuses(self, chip, low=None, high=None, ext=None, lock=None): self.end() # pylint: disable=too-many-arguments - def verify_fuses(self, chip, low=None, high=None, ext=None, lock=None): + def verify_fuses( + self, + chip: Dict[str, Any], + low: Optional[int] = None, + high: Optional[int] = None, + ext: Optional[int] = None, + lock: Optional[int] = None, + ) -> bool: """ Verify the 4 fuses. If the kwarg low/high/ext/lock is not passed in or is None, that fuse is not checked. @@ -286,7 +313,7 @@ def erase_chip(self): #################### Mid level - def begin(self, clock=_FAST_CLOCK): + def begin(self, clock: int = _FAST_CLOCK) -> None: """ Begin programming mode: pull reset pin low, initialize SPI, and send the initialization command to get the AVR's attention. From 907ab2da5613f57563f5df11083659a81e1610b8 Mon Sep 17 00:00:00 2001 From: Ross Kukard <75049118+RossK1@users.noreply.github.com> Date: Tue, 25 Apr 2023 09:56:43 -0700 Subject: [PATCH 42/59] Suspected bug fix where file_name was being assigned as textio during open operation rather than a field in file_state dictionary --- adafruit_avrprog.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py index 028d408..91f0580 100644 --- a/adafruit_avrprog.py +++ b/adafruit_avrprog.py @@ -208,7 +208,7 @@ def verify_file( # create a file state dictionary file_state = {"line": 0, "ext_addr": 0, "eof": False, "f": TextIOWrapper} - with open(file_name, "r") as file_name["f"]: + with open(file_name, "r") as file_state["f"]: page_size = chip["page_size"] clock_speed = chip.get("clock_speed", _FAST_CLOCK) self.begin(clock=clock_speed) From bfe4c39f7501f7fefa6ea895724247f8fbbe79e0 Mon Sep 17 00:00:00 2001 From: Ross Kukard <75049118+RossK1@users.noreply.github.com> Date: Tue, 25 Apr 2023 12:05:52 -0700 Subject: [PATCH 43/59] Completing type annotations --- adafruit_avrprog.py | 36 +++++++++++++++++++++--------------- 1 file changed, 21 insertions(+), 15 deletions(-) diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py index 91f0580..b881d03 100644 --- a/adafruit_avrprog.py +++ b/adafruit_avrprog.py @@ -34,13 +34,15 @@ try: from io import TextIOWrapper - from typing import Any, Dict, Optional + from typing import Any, Dict, Optional, Tuple from _typeshed import FileDescriptorOrPath from busio import SPI except ImportError: pass +from math import floor + from digitalio import DigitalInOut, Direction _SLOW_CLOCK: int = 100000 @@ -324,14 +326,14 @@ def begin(self, clock: int = _FAST_CLOCK) -> None: self._spi.configure(baudrate=clock) self._transaction((0xAC, 0x53, 0, 0)) - def end(self): + def end(self) -> None: """ End programming mode: SPI is released, and reset pin set high. """ self._spi.unlock() self._rst.value = True - def read_signature(self): + def read_signature(self) -> list: """ Read and return the signature of the chip as two bytes in an array. Requires calling begin() beforehand to put in programming mode. @@ -342,7 +344,7 @@ def read_signature(self): sig.append(self._transaction((0x30, 0, i, 0))[2]) return sig - def read(self, addr, read_buffer): + def read(self, addr: int, read_buffer: bytearray) -> None: """ Read a chunk of memory from address 'addr'. The amount read is the same as the size of the bytearray 'read_buffer'. Data read is placed @@ -366,13 +368,15 @@ def read(self, addr, read_buffer): last_addr = read_addr #################### Low level - def _flash_word(self, addr, low, high): + def _flash_word(self, addr: int, low: int, high: int) -> None: self._transaction((0x40, addr >> 8, addr, low)) self._transaction((0x48, addr >> 8, addr, high)) - def _flash_page(self, page_buffer, page_addr, page_size): + def _flash_page( + self, page_buffer: bytearray, page_addr: int, page_size: int + ) -> None: page_addr //= 2 # address is by 'words' not bytes! - for i in range(page_size / 2): # page indexed by words, not bytes + for i in range(floor(page_size / 2)): # page indexed by words, not bytes lo_byte, hi_byte = page_buffer[2 * i : 2 * i + 2] self._flash_word(i, lo_byte, hi_byte) @@ -384,23 +388,25 @@ def _flash_page(self, page_buffer, page_addr, page_size): raise RuntimeError("Failed to commit page to flash") self._busy_wait() - def _transaction(self, command): + def _transaction(self, command: Tuple[int, int, int, int]) -> bytes: reply = bytearray(4) - command = bytearray([i & 0xFF for i in command]) + command_bytes = bytearray([i & 0xFF for i in command]) - self._spi.write_readinto(command, reply) - # s = [hex(i) for i in command] - # print("Sending %s reply %s" % ([hex(i) for i in command], [hex(i) for i in reply])) - if reply[2] != command[1]: + self._spi.write_readinto(command_bytes, reply) + # s = [hex(i) for i in command_bytes] + # print("Sending %s reply %s" % ([hex(i) for i in command_bytes], [hex(i) for i in reply])) + if reply[2] != command_bytes[1]: raise RuntimeError("SPI transaction failed") return reply[1:] # first byte is ignored - def _busy_wait(self): + def _busy_wait(self) -> None: while self._transaction((0xF0, 0, 0, 0))[2] & 0x01: pass -def read_hex_page(file_state, page_addr, page_size, page_buffer): +def read_hex_page( + file_state: Dict[str, Any], page_addr: int, page_size: int, page_buffer: bytearray +) -> bool: # pylint: disable=too-many-branches """ Helper function that does the Intel Hex parsing. Takes in a dictionary From 0b3e5f861d9f3146d149496c9b8d952efb58ebc6 Mon Sep 17 00:00:00 2001 From: Ross Kukard <75049118+RossK1@users.noreply.github.com> Date: Tue, 25 Apr 2023 12:15:07 -0700 Subject: [PATCH 44/59] Fixing optional import that was, actually, not optional. --- adafruit_avrprog.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py index b881d03..b930689 100644 --- a/adafruit_avrprog.py +++ b/adafruit_avrprog.py @@ -37,12 +37,12 @@ from typing import Any, Dict, Optional, Tuple from _typeshed import FileDescriptorOrPath - from busio import SPI except ImportError: pass from math import floor +from busio import SPI from digitalio import DigitalInOut, Direction _SLOW_CLOCK: int = 100000 From 054823d5a6421983c5836e5cfa443c7ba7a10a1e Mon Sep 17 00:00:00 2001 From: Ross Kukard <75049118+RossK1@users.noreply.github.com> Date: Tue, 25 Apr 2023 12:48:49 -0700 Subject: [PATCH 45/59] Working on optional imports --- adafruit_avrprog.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py index b930689..80a09f9 100644 --- a/adafruit_avrprog.py +++ b/adafruit_avrprog.py @@ -33,15 +33,15 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AVRprog.git" try: - from io import TextIOWrapper from typing import Any, Dict, Optional, Tuple - from _typeshed import FileDescriptorOrPath except ImportError: pass +from io import TextIOWrapper from math import floor +from _typeshed import FileDescriptorOrPath from busio import SPI from digitalio import DigitalInOut, Direction From 080462ebd57ec06a4ff5a9010549745076c73dd3 Mon Sep 17 00:00:00 2001 From: Ross Kukard <75049118+RossK1@users.noreply.github.com> Date: Tue, 25 Apr 2023 13:00:55 -0700 Subject: [PATCH 46/59] Working around missing _typeshed package --- adafruit_avrprog.py | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py index 80a09f9..bbd5762 100644 --- a/adafruit_avrprog.py +++ b/adafruit_avrprog.py @@ -33,15 +33,22 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AVRprog.git" try: - from typing import Any, Dict, Optional, Tuple + from os import PathLike + from typing import Any, Dict, Optional, Tuple, TypeAlias + + # Technically this type should come from: from _typeshed import FileDescriptorOrPath + # Unfortunately _typeshed is only in the standard library in newer releases of Python, e.g. 3.11 + # Thus have to define a placeholder + FileDescriptorOrPath: TypeAlias = ( + int | str | bytes | PathLike[str] | PathLike[bytes] + ) + from io import TextIOWrapper except ImportError: pass -from io import TextIOWrapper from math import floor -from _typeshed import FileDescriptorOrPath from busio import SPI from digitalio import DigitalInOut, Direction From f6d41b6236e0f570563294655b1f5dc151fe98a4 Mon Sep 17 00:00:00 2001 From: Ross Kukard <75049118+RossK1@users.noreply.github.com> Date: Tue, 25 Apr 2023 13:34:41 -0700 Subject: [PATCH 47/59] finalizing (hopefully) all type hinting --- adafruit_avrprog.py | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py index bbd5762..b0ed8fd 100644 --- a/adafruit_avrprog.py +++ b/adafruit_avrprog.py @@ -34,7 +34,7 @@ try: from os import PathLike - from typing import Any, Dict, Optional, Tuple, TypeAlias + from typing import Any, Dict, List, Optional, Tuple, TypeAlias, Union # Technically this type should come from: from _typeshed import FileDescriptorOrPath # Unfortunately _typeshed is only in the standard library in newer releases of Python, e.g. 3.11 @@ -49,7 +49,7 @@ from math import floor -from busio import SPI +from busio import I2C, SPI from digitalio import DigitalInOut, Direction _SLOW_CLOCK: int = 100000 @@ -107,7 +107,7 @@ class Boards: _spi: SPI = None _rst: DigitalInOut = None - def init(self, spi_bus: SPI, rst_pin) -> None: + def init(self, spi_bus: SPI, rst_pin: Union[SPI, I2C]) -> None: """ Initialize the programmer with an SPI port that will be used to communicate with the chip. Make sure your SPI supports 'write_readinto' @@ -206,8 +206,11 @@ def program_file( return True def verify_file( - self, chip: Dict[str, Any], file_name: FileDescriptorOrPath, verbose=False - ): + self, + chip: Dict[str, Any], + file_name: FileDescriptorOrPath, + verbose: bool = False, + ) -> bool: """ Perform a chip full-flash verification from a file that contains Intel HEX data. Returns True/False on success/fail. @@ -252,12 +255,12 @@ def verify_file( self.end() return True - def read_fuses(self, chip: Dict[str, Any]) -> tuple: + def read_fuses(self, chip: Dict[str, Any]) -> Tuple[int, int, int, int]: """ Read the 4 fuses and return them in a tuple (low, high, ext, lock) Each fuse is bitwise-&'s with the chip's fuse mask for simplicity """ - mask = chip["fuse_mask"] + mask: Tuple[int, int, int, int] = chip["fuse_mask"] self.begin(clock=_SLOW_CLOCK) low = self._transaction((0x50, 0, 0, 0))[2] & mask[0] high = self._transaction((0x58, 0x08, 0, 0))[2] & mask[1] @@ -311,7 +314,7 @@ def verify_fuses( return False return True - def erase_chip(self): + def erase_chip(self) -> None: """ Fully erases the chip. """ @@ -340,7 +343,7 @@ def end(self) -> None: self._spi.unlock() self._rst.value = True - def read_signature(self) -> list: + def read_signature(self) -> List[int]: """ Read and return the signature of the chip as two bytes in an array. Requires calling begin() beforehand to put in programming mode. @@ -395,7 +398,7 @@ def _flash_page( raise RuntimeError("Failed to commit page to flash") self._busy_wait() - def _transaction(self, command: Tuple[int, int, int, int]) -> bytes: + def _transaction(self, command: Tuple[int, int, int, int]) -> bytearray: reply = bytearray(4) command_bytes = bytearray([i & 0xFF for i in command]) From ada9e73ca6be95c31e55893d1e19df52f3a54ecd Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Tue, 9 May 2023 20:26:25 -0400 Subject: [PATCH 48/59] Update pre-commit hooks Signed-off-by: Tekktrik --- .pre-commit-config.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 0e5fccc..70ade69 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,21 +4,21 @@ repos: - repo: https://github.com/python/black - rev: 22.3.0 + rev: 23.3.0 hooks: - id: black - repo: https://github.com/fsfe/reuse-tool - rev: v0.14.0 + rev: v1.1.2 hooks: - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.2.0 + rev: v4.4.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.15.5 + rev: v2.17.4 hooks: - id: pylint name: pylint (library code) From 394d18d691ed3d1a424f8f8cc6b6d1b2fe82b00a Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Tue, 23 May 2023 21:45:52 -0400 Subject: [PATCH 49/59] Update .pylintrc, fix jQuery for docs --- .pylintrc | 2 +- docs/conf.py | 1 + docs/requirements.txt | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index 40208c3..f945e92 100644 --- a/.pylintrc +++ b/.pylintrc @@ -396,4 +396,4 @@ min-public-methods=1 # Exceptions that will emit a warning when being caught. Defaults to # "Exception" -overgeneral-exceptions=Exception +overgeneral-exceptions=builtins.Exception diff --git a/docs/conf.py b/docs/conf.py index 0acc6eb..1edeac3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,6 +17,7 @@ # ones. extensions = [ "sphinx.ext.autodoc", + "sphinxcontrib.jquery", "sphinx.ext.intersphinx", "sphinx.ext.viewcode", ] diff --git a/docs/requirements.txt b/docs/requirements.txt index 88e6733..797aa04 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,3 +3,4 @@ # SPDX-License-Identifier: Unlicense sphinx>=4.0.0 +sphinxcontrib-jquery From 7cd6fd99e329c05a86c0d102b1196a963d2333b6 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 18 Sep 2023 16:20:40 -0500 Subject: [PATCH 50/59] "fix rtd theme " --- docs/conf.py | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 1edeac3..d47fbd4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -97,19 +97,10 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -on_rtd = os.environ.get("READTHEDOCS", None) == "True" - -if not on_rtd: # only import and set the theme if we're building docs locally - try: - import sphinx_rtd_theme - - html_theme = "sphinx_rtd_theme" - html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] - except: - html_theme = "default" - html_theme_path = ["."] -else: - html_theme_path = ["."] +import sphinx_rtd_theme + +html_theme = "sphinx_rtd_theme" +html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, From 7076ed0530b8621f6734ce5f24aa4b1e51d6bb3b Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 16 Oct 2023 14:30:31 -0500 Subject: [PATCH 51/59] unpin sphinx and add sphinx-rtd-theme to docs reqs Signed-off-by: foamyguy --- docs/requirements.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 797aa04..979f568 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,5 +2,6 @@ # # SPDX-License-Identifier: Unlicense -sphinx>=4.0.0 +sphinx sphinxcontrib-jquery +sphinx-rtd-theme From ba6150fdafcc5333eac13b44c892e920397fa83e Mon Sep 17 00:00:00 2001 From: Danct12 Date: Sat, 20 Apr 2024 10:30:42 +0000 Subject: [PATCH 52/59] Add ATmega328PB to list of known chips --- adafruit_avrprog.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py index 704a258..58c1cfd 100644 --- a/adafruit_avrprog.py +++ b/adafruit_avrprog.py @@ -71,6 +71,13 @@ class Boards: "page_size": 128, "fuse_mask": (0xFF, 0xFF, 0x07, 0x3F), } + ATmega328pb = { + "name": "ATmega328pb", + "sig": [0x1E, 0x95, 0x16], + "flash_size": 32768, + "page_size": 128, + "fuse_mask": (0xFF, 0xFF, 0x07, 0x3F), + } ATmega644pa = { "name": "ATmega644pa", "sig": [0x1E, 0x96, 0x0A], From 8e1213344e0095490aea9e4a46e73d22c4169b1a Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 6 May 2024 10:29:46 -0500 Subject: [PATCH 53/59] review feedback changes --- adafruit_avrprog.py | 50 +++++++++++++++++++++++++++++++++------------ 1 file changed, 37 insertions(+), 13 deletions(-) diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py index b0ed8fd..f78c815 100644 --- a/adafruit_avrprog.py +++ b/adafruit_avrprog.py @@ -33,23 +33,47 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AVRprog.git" try: + from typing import Any, Dict, List, Optional, Tuple, Union, TypedDict + from typing_extensions import TypeAlias from os import PathLike - from typing import Any, Dict, List, Optional, Tuple, TypeAlias, Union + from busio import SPI + from microcontroller import Pin # Technically this type should come from: from _typeshed import FileDescriptorOrPath # Unfortunately _typeshed is only in the standard library in newer releases of Python, e.g. 3.11 # Thus have to define a placeholder - FileDescriptorOrPath: TypeAlias = ( - int | str | bytes | PathLike[str] | PathLike[bytes] - ) + FileDescriptorOrPath: TypeAlias = Union[ + int, str, bytes, PathLike[str], PathLike[bytes] + ] + from io import TextIOWrapper + class ChipDictionary(TypedDict): + """ + Dictionary representing a specific target chip type + """ + + name: str + sig: List[int] + flash_size: int + page_size: int + fuse_mask: Tuple[int] + + class FileState(TypedDict): + """ + Dictionary representing a File State + """ + + # pylint: disable=invalid-name + line: int + ext_addr: int + eof: bool + f: Optional[TextIOWrapper] + except ImportError: pass -from math import floor -from busio import I2C, SPI from digitalio import DigitalInOut, Direction _SLOW_CLOCK: int = 100000 @@ -104,10 +128,10 @@ class Boards: "fuse_mask": (0xFF, 0xFF, 0x07, 0x3F), } - _spi: SPI = None - _rst: DigitalInOut = None + _spi: Optional[SPI] = None + _rst: Optional[DigitalInOut] = None - def init(self, spi_bus: SPI, rst_pin: Union[SPI, I2C]) -> None: + def init(self, spi_bus: SPI, rst_pin: Pin) -> None: """ Initialize the programmer with an SPI port that will be used to communicate with the chip. Make sure your SPI supports 'write_readinto' @@ -118,7 +142,7 @@ def init(self, spi_bus: SPI, rst_pin: Union[SPI, I2C]) -> None: self._rst.direction = Direction.OUTPUT self._rst.value = True - def verify_sig(self, chip: Dict[str, Any], verbose: bool = False) -> bool: + def verify_sig(self, chip: ChipDictionary, verbose: bool = False) -> bool: """ Verify that the chip is connected properly, responds to commands, and has the correct signature. Returns True/False based on success @@ -156,7 +180,7 @@ def program_file( self.begin(clock=clock_speed) # create a file state dictionary - file_state = {"line": 0, "ext_addr": 0, "eof": False, "f": TextIOWrapper} + file_state = {"line": 0, "ext_addr": 0, "eof": False, "f": None} with open(file_name, "r") as file_state["f"]: page_size = chip["page_size"] @@ -219,7 +243,7 @@ def verify_file( raise RuntimeError("Signature read failure") # create a file state dictionary - file_state = {"line": 0, "ext_addr": 0, "eof": False, "f": TextIOWrapper} + file_state = {"line": 0, "ext_addr": 0, "eof": False, "f": None} with open(file_name, "r") as file_state["f"]: page_size = chip["page_size"] clock_speed = chip.get("clock_speed", _FAST_CLOCK) @@ -386,7 +410,7 @@ def _flash_page( self, page_buffer: bytearray, page_addr: int, page_size: int ) -> None: page_addr //= 2 # address is by 'words' not bytes! - for i in range(floor(page_size / 2)): # page indexed by words, not bytes + for i in range(page_size / 2): # page indexed by words, not bytes lo_byte, hi_byte = page_buffer[2 * i : 2 * i + 2] self._flash_word(i, lo_byte, hi_byte) From 1b12ff5c6375ea9d5df6132e0de6a86ad1f43e1b Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 6 May 2024 10:38:24 -0500 Subject: [PATCH 54/59] use TypedDict definitions for args --- adafruit_avrprog.py | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py index f78c815..0ff7bc6 100644 --- a/adafruit_avrprog.py +++ b/adafruit_avrprog.py @@ -33,7 +33,7 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AVRprog.git" try: - from typing import Any, Dict, List, Optional, Tuple, Union, TypedDict + from typing import List, Optional, Tuple, Union, TypedDict from typing_extensions import TypeAlias from os import PathLike from busio import SPI @@ -57,7 +57,7 @@ class ChipDictionary(TypedDict): sig: List[int] flash_size: int page_size: int - fuse_mask: Tuple[int] + fuse_mask: Tuple[int, int, int, int] class FileState(TypedDict): """ @@ -159,7 +159,7 @@ def verify_sig(self, chip: ChipDictionary, verbose: bool = False) -> bool: # pylint: disable=too-many-branches def program_file( self, - chip: Dict[str, Any], + chip: ChipDictionary, file_name: FileDescriptorOrPath, verbose: bool = False, verify: bool = True, @@ -231,7 +231,7 @@ def program_file( def verify_file( self, - chip: Dict[str, Any], + chip: ChipDictionary, file_name: FileDescriptorOrPath, verbose: bool = False, ) -> bool: @@ -279,7 +279,7 @@ def verify_file( self.end() return True - def read_fuses(self, chip: Dict[str, Any]) -> Tuple[int, int, int, int]: + def read_fuses(self, chip: ChipDictionary) -> Tuple[int, int, int, int]: """ Read the 4 fuses and return them in a tuple (low, high, ext, lock) Each fuse is bitwise-&'s with the chip's fuse mask for simplicity @@ -296,7 +296,7 @@ def read_fuses(self, chip: Dict[str, Any]) -> Tuple[int, int, int, int]: # pylint: disable=unused-argument,too-many-arguments def write_fuses( self, - chip: Dict[str, Any], + chip: ChipDictionary, low: Optional[int] = None, high: Optional[int] = None, ext: Optional[int] = None, @@ -318,7 +318,7 @@ def write_fuses( # pylint: disable=too-many-arguments def verify_fuses( self, - chip: Dict[str, Any], + chip: ChipDictionary, low: Optional[int] = None, high: Optional[int] = None, ext: Optional[int] = None, @@ -439,7 +439,7 @@ def _busy_wait(self) -> None: def read_hex_page( - file_state: Dict[str, Any], page_addr: int, page_size: int, page_buffer: bytearray + file_state: FileState, page_addr: int, page_size: int, page_buffer: bytearray ) -> bool: # pylint: disable=too-many-branches """ From 2493023c5506b1f8376f2bbd095a573351d69e61 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 6 May 2024 11:28:24 -0500 Subject: [PATCH 55/59] use int division --- adafruit_avrprog.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py index 0ff7bc6..656e104 100644 --- a/adafruit_avrprog.py +++ b/adafruit_avrprog.py @@ -410,7 +410,7 @@ def _flash_page( self, page_buffer: bytearray, page_addr: int, page_size: int ) -> None: page_addr //= 2 # address is by 'words' not bytes! - for i in range(page_size / 2): # page indexed by words, not bytes + for i in range(page_size // 2): # page indexed by words, not bytes lo_byte, hi_byte = page_buffer[2 * i : 2 * i + 2] self._flash_word(i, lo_byte, hi_byte) From 61e05eff3c6a55ed048840d83b70c6b77c9f0d99 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 7 Oct 2024 09:24:05 -0500 Subject: [PATCH 56/59] remove deprecated get_html_theme_path() call Signed-off-by: foamyguy --- docs/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index d47fbd4..43d74bd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -100,7 +100,6 @@ import sphinx_rtd_theme html_theme = "sphinx_rtd_theme" -html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, From a6598ca0436de042741634e57c09616aea1eea36 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 14 Jan 2025 11:32:34 -0600 Subject: [PATCH 57/59] add sphinx configuration to rtd.yaml Signed-off-by: foamyguy --- .readthedocs.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 33c2a61..88bca9f 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,6 +8,9 @@ # Required version: 2 +sphinx: + configuration: docs/conf.py + build: os: ubuntu-20.04 tools: From 25d5071a1b76305476266899eed9a7c274100b9c Mon Sep 17 00:00:00 2001 From: foamyguy Date: Thu, 15 May 2025 20:05:10 +0000 Subject: [PATCH 58/59] change to ruff --- .gitattributes | 11 + .pre-commit-config.yaml | 43 +- .pylintrc | 399 ------------------ README.rst | 6 +- adafruit_avrprog.py | 53 +-- docs/api.rst | 3 + docs/conf.py | 8 +- examples/avrprog_program_mega2560.py | 10 +- examples/avrprog_program_tiny13a.py | 1 + examples/avrprog_program_trinket85.py | 1 + examples/avrprog_program_uno328.py | 8 +- examples/avrprog_read_signature_simpletest.py | 3 +- ruff.toml | 108 +++++ 13 files changed, 161 insertions(+), 493 deletions(-) create mode 100644 .gitattributes delete mode 100644 .pylintrc create mode 100644 ruff.toml diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..21c125c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,11 @@ +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +.py text eol=lf +.rst text eol=lf +.txt text eol=lf +.yaml text eol=lf +.toml text eol=lf +.license text eol=lf +.md text eol=lf diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 70ade69..ff19dde 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,42 +1,21 @@ -# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries # # SPDX-License-Identifier: Unlicense repos: - - repo: https://github.com/python/black - rev: 23.3.0 - hooks: - - id: black - - repo: https://github.com/fsfe/reuse-tool - rev: v1.1.2 - hooks: - - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.4.0 + rev: v4.5.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - - repo: https://github.com/pycqa/pylint - rev: v2.17.4 + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.3.4 hooks: - - id: pylint - name: pylint (library code) - types: [python] - args: - - --disable=consider-using-f-string - exclude: "^(docs/|examples/|tests/|setup.py$)" - - id: pylint - name: pylint (example code) - description: Run pylint rules on "examples/*.py" files - types: [python] - files: "^examples/" - args: - - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code - - id: pylint - name: pylint (test code) - description: Run pylint rules on "tests/*.py" files - types: [python] - files: "^tests/" - args: - - --disable=missing-docstring,consider-using-f-string,duplicate-code + - id: ruff-format + - id: ruff + args: ["--fix"] + - repo: https://github.com/fsfe/reuse-tool + rev: v3.0.1 + hooks: + - id: reuse diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index f945e92..0000000 --- a/.pylintrc +++ /dev/null @@ -1,399 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -[MASTER] - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code -extension-pkg-whitelist= - -# Add files or directories to the ignore-list. They should be base names, not -# paths. -ignore=CVS - -# Add files or directories matching the regex patterns to the ignore-list. The -# regex matches against base names, not paths. -ignore-patterns= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Use multiple processes to speed up Pylint. -jobs=1 - -# List of plugins (as comma separated values of python modules names) to load, -# usually to register additional checkers. -load-plugins=pylint.extensions.no_self_use - -# Pickle collected data for later comparisons. -persistent=yes - -# Specify a configuration file. -#rcfile= - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= - -# Disable the message, report, category or checker with the given id(s). You -# can either give multiple identifiers separated by comma (,) or put this -# option multiple times (only on the command line, not in the configuration -# file where it should appear only once).You can also use "--disable=all" to -# disable everything first and then reenable specific checks. For example, if -# you want to run only the similarities checker, you can use "--disable=all -# --enable=similarities". If you want to run only the classes checker, but have -# no Warning level messages displayed, use"--disable=all --enable=classes -# --disable=W" -# disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call -disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding - -# Enable the message, report, category or checker with the given id(s). You can -# either give multiple identifier separated by comma (,) or put this option -# multiple time (only on the command line, not in the configuration file where -# it should appear only once). See also the "--disable" option for examples. -enable= - - -[REPORTS] - -# Python expression which should return a note less than 10 (10 is the highest -# note). You have access to the variables errors warning, statement which -# respectively contain the number of errors / warnings messages and the total -# number of statements analyzed. This is used by the global evaluation report -# (RP0004). -evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) - -# Template used to display messages. This is a python new-style format string -# used to format the message information. See doc for all details -#msg-template= - -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio).You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=text - -# Tells whether to display a full report or only the messages -reports=no - -# Activate the evaluation score. -score=yes - - -[REFACTORING] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - - -[LOGGING] - -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging - - -[SPELLING] - -# Spelling dictionary name. Available dictionaries: none. To make it working -# install python-enchant package. -spelling-dict= - -# List of comma separated words that should not be checked. -spelling-ignore-words= - -# A path to a file that contains private dictionary; one word per line. -spelling-private-dict-file= - -# Tells whether to store unknown words to indicated private dictionary in -# --spelling-private-dict-file option instead of raising a message. -spelling-store-unknown-words=no - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -# notes=FIXME,XXX,TODO -notes=FIXME,XXX - - -[TYPECHECK] - -# List of decorators that produce context managers, such as -# contextlib.contextmanager. Add to this list to register other decorators that -# produce valid context managers. -contextmanager-decorators=contextlib.contextmanager - -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E1101 when accessed. Python regular -# expressions are accepted. -generated-members= - -# Tells whether missing members accessed in mixin class should be ignored. A -# mixin class is detected if its name ends with "mixin" (case insensitive). -ignore-mixin-members=yes - -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes - -# List of class names for which member attributes should not be checked (useful -# for classes with dynamically set attributes). This supports the use of -# qualified names. -ignored-classes=optparse.Values,thread._local,_thread._local - -# List of module names for which member attributes should not be checked -# (useful for modules/projects where namespaces are manipulated during runtime -# and thus existing member attributes cannot be deduced by static analysis. It -# supports qualified module names, as well as Unix pattern matching. -ignored-modules=board - -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes - -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 - -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid to define new builtins when possible. -additional-builtins= - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# List of strings which can identify a callback function by name. A callback -# name must start or end with one of those strings. -callbacks=cb_,_cb - -# A regular expression matching the name of dummy variables (i.e. expectedly -# not used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ - -# Argument names that match this expression will be ignored. Default to name -# with leading underscore -ignored-argument-names=_.*|^ignored_|^unused_ - -# Tells whether we should check for unused import in __init__ files. -init-import=no - -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=six.moves,future.builtins - - -[FORMAT] - -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -# expected-line-ending-format= -expected-line-ending-format=LF - -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ - -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 - -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' - -# Maximum number of characters on a single line. -max-line-length=100 - -# Maximum number of lines in a module -max-module-lines=1000 - -# Allow the body of a class to be on the same line as the declaration if body -# contains single statement. -single-line-class-stmt=no - -# Allow the body of an if to be on the same line as the test if there is no -# else. -single-line-if-stmt=no - - -[SIMILARITIES] - -# Ignore comments when computing similarities. -ignore-comments=yes - -# Ignore docstrings when computing similarities. -ignore-docstrings=yes - -# Ignore imports when computing similarities. -ignore-imports=yes - -# Minimum lines number of a similarity. -min-similarity-lines=12 - - -[BASIC] - -# Regular expression matching correct argument names -argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct attribute names -attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Bad variable names which should always be refused, separated by a comma -bad-names=foo,bar,baz,toto,tutu,tata - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Regular expression matching correct class names -# class-rgx=[A-Z_][a-zA-Z0-9]+$ -class-rgx=[A-Z_][a-zA-Z0-9_]+$ - -# Regular expression matching correct constant names -const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 - -# Regular expression matching correct function names -function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Good variable names which should always be accepted, separated by a comma -# good-names=i,j,k,ex,Run,_ -good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ - -# Include a hint for the correct naming format with invalid-name -include-naming-hint=no - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ - -# Regular expression matching correct method names -method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct module names -module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= - -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ - -# List of decorators that produce properties, such as abc.abstractproperty. Add -# to this list to register other decorators that produce valid properties. -property-classes=abc.abstractproperty - -# Regular expression matching correct variable names -variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - - -[IMPORTS] - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# Analyse import fallback blocks. This can be used to support both Python 2 and -# 3 compatible code, which means that the block might have code that exists -# only in one or another interpreter, leading to false positives when analysed. -analyse-fallback-blocks=no - -# Deprecated modules which should not be used, separated by a comma -deprecated-modules=optparse,tkinter.tix - -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= - -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled) -import-graph= - -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled) -int-import-graph= - -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= - -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__,__new__,setUp - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict,_fields,_replace,_source,_make - -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls - -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs - - -[DESIGN] - -# Maximum number of arguments for function / method -max-args=5 - -# Maximum number of attributes for a class (see R0902). -# max-attributes=7 -max-attributes=11 - -# Maximum number of boolean expressions in a if statement -max-bool-expr=5 - -# Maximum number of branch for function / method body -max-branches=12 - -# Maximum number of locals for function / method body -max-locals=15 - -# Maximum number of parents for a class (see R0901). -max-parents=7 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 - -# Maximum number of return / yield for function / method body -max-returns=6 - -# Maximum number of statements in function / method body -max-statements=50 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=1 - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=builtins.Exception diff --git a/README.rst b/README.rst index 5da80bf..57c83da 100644 --- a/README.rst +++ b/README.rst @@ -14,9 +14,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_AVRprog/actions/ :alt: Build Status -.. image:: https://img.shields.io/badge/code%20style-black-000000.svg - :target: https://github.com/psf/black - :alt: Code Style: Black +.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json + :target: https://github.com/astral-sh/ruff + :alt: Code Style: Ruff Program your favorite AVR chips directly from CircuitPython with this handy helper class that will let you make stand-alone programmers right from your REPL. Should work with any/all AVR chips, via SPI programming. Tested with ATmega328, ATtiny85 and ATmega2560 diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py index 88353a0..1b1bfc2 100644 --- a/adafruit_avrprog.py +++ b/adafruit_avrprog.py @@ -33,18 +33,17 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AVRprog.git" try: - from typing import List, Optional, Tuple, Union, TypedDict - from typing_extensions import TypeAlias from os import PathLike + from typing import List, Optional, Tuple, TypedDict, Union + from busio import SPI from microcontroller import Pin + from typing_extensions import TypeAlias # Technically this type should come from: from _typeshed import FileDescriptorOrPath # Unfortunately _typeshed is only in the standard library in newer releases of Python, e.g. 3.11 # Thus have to define a placeholder - FileDescriptorOrPath: TypeAlias = Union[ - int, str, bytes, PathLike[str], PathLike[bytes] - ] + FileDescriptorOrPath: TypeAlias = Union[int, str, bytes, PathLike[str], PathLike[bytes]] from io import TextIOWrapper @@ -64,7 +63,6 @@ class FileState(TypedDict): Dictionary representing a File State """ - # pylint: disable=invalid-name line: int ext_addr: int eof: bool @@ -90,7 +88,6 @@ class Boards: Some well known board definitions. """ - # pylint: disable=too-few-public-methods ATtiny13a = { "name": "ATtiny13a", "sig": [0x1E, 0x90, 0x07], @@ -158,12 +155,11 @@ def verify_sig(self, chip: ChipDictionary, verbose: bool = False) -> bool: sig = self.read_signature() self.end() if verbose: - print("Found signature: %s" % [hex(i) for i in sig]) + print(f"Found signature: {[hex(i) for i in sig]}") if sig != chip["sig"]: return False return True - # pylint: disable=too-many-branches def program_file( self, chip: ChipDictionary, @@ -188,12 +184,12 @@ def program_file( # create a file state dictionary file_state = {"line": 0, "ext_addr": 0, "eof": False, "f": None} - with open(file_name, "r") as file_state["f"]: + with open(file_name) as file_state["f"]: page_size = chip["page_size"] for page_addr in range(0, chip["flash_size"], page_size): if verbose: - print("Programming page $%04X..." % page_addr, end="") + print(f"Programming page ${page_addr:04X}...", end="") page_buffer = bytearray(page_size) for b in range(page_size): page_buffer[b] = 0xFF # make an empty page @@ -214,19 +210,16 @@ def program_file( continue if verbose: - print("Verifying page @ $%04X" % page_addr) + print(f"Verifying page @ ${page_addr:04X}") read_buffer = bytearray(page_size) self.read(page_addr, read_buffer) # print("From memory: ", read_buffer) if page_buffer != read_buffer: if verbose: - # pylint: disable=line-too-long print( - "Verify fail at address %04X\nPage should be: %s\nBut contains: %s" - % (page_addr, page_buffer, read_buffer) + f"Verify fail at address {page_addr:04X}\nPage should be: {page_buffer}\nBut contains: {read_buffer}" ) - # pylint: enable=line-too-long self.end() return False @@ -251,7 +244,7 @@ def verify_file( # create a file state dictionary file_state = {"line": 0, "ext_addr": 0, "eof": False, "f": None} - with open(file_name, "r") as file_state["f"]: + with open(file_name) as file_state["f"]: page_size = chip["page_size"] clock_speed = chip.get("clock_speed", _FAST_CLOCK) self.begin(clock=clock_speed) @@ -263,7 +256,7 @@ def verify_file( read_hex_page(file_state, page_addr, page_size, page_buffer) if verbose: - print("Verifying page @ $%04X" % page_addr) + print(f"Verifying page @ ${page_addr:04X}") read_buffer = bytearray(page_size) self.read(page_addr, read_buffer) # print("From memory: ", read_buffer) @@ -271,12 +264,9 @@ def verify_file( if page_buffer != read_buffer: if verbose: - # pylint: disable=line-too-long print( - "Verify fail at address %04X\nPage should be: %s\nBut contains: %s" - % (page_addr, page_buffer, read_buffer) + f"Verify fail at address {page_addr:04X}\nPage should be: {page_buffer}\nBut contains: {read_buffer}" ) - # pylint: enable=line-too-long self.end() return False @@ -300,7 +290,6 @@ def read_fuses(self, chip: ChipDictionary) -> Tuple[int, int, int, int]: self.end() return (low, high, ext, lock) - # pylint: disable=unused-argument,too-many-arguments def write_fuses( self, chip: ChipDictionary, @@ -322,7 +311,6 @@ def write_fuses( self._busy_wait() self.end() - # pylint: disable=too-many-arguments def verify_fuses( self, chip: ChipDictionary, @@ -413,9 +401,7 @@ def _flash_word(self, addr: int, low: int, high: int) -> None: self._transaction((0x40, addr >> 8, addr, low)) self._transaction((0x48, addr >> 8, addr, high)) - def _flash_page( - self, page_buffer: bytearray, page_addr: int, page_size: int - ) -> None: + def _flash_page(self, page_buffer: bytearray, page_addr: int, page_size: int) -> None: page_addr //= 2 # address is by 'words' not bytes! for i in range(page_size // 2): # page indexed by words, not bytes lo_byte, hi_byte = page_buffer[2 * i : 2 * i + 2] @@ -448,7 +434,6 @@ def _busy_wait(self) -> None: def read_hex_page( file_state: FileState, page_addr: int, page_size: int, page_buffer: bytearray ) -> bool: - # pylint: disable=too-many-branches """ Helper function that does the Intel Hex parsing. Takes in a dictionary that contains the file 'state'. The dictionary should have file_state['f'] @@ -486,9 +471,7 @@ def read_hex_page( file_state["line_addr"] = line_addr rec_type = int(line[7:9], 16) except ValueError as err: - raise RuntimeError( - "Could not parse HEX line %d addr" % file_state["line"] - ) from err + raise RuntimeError("Could not parse HEX line %d addr" % file_state["line"]) from err if file_state["ext_addr"]: line_addr += file_state["ext_addr"] @@ -534,13 +517,7 @@ def read_hex_page( byte_buffer.append(int(line[9 + i * 2 : 11 + i * 2], 16)) # check chksum now! - chksum = ( - hex_len - + (line_addr >> 8) - + (line_addr & 0xFF) - + rec_type - + sum(byte_buffer) - ) + chksum = hex_len + (line_addr >> 8) + (line_addr & 0xFF) + rec_type + sum(byte_buffer) # print("checksum: "+hex(chksum)) if (chksum & 0xFF) != 0: raise RuntimeError("HEX Checksum fail") diff --git a/docs/api.rst b/docs/api.rst index a2550d7..3612fd1 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,5 +1,8 @@ .. If you created a package, create one automodule per module in the package. +API Reference +############# + .. automodule:: adafruit_avrprog :members: diff --git a/docs/conf.py b/docs/conf.py index 43d74bd..72cd051 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,12 +1,10 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # # SPDX-License-Identifier: MIT +import datetime import os import sys -import datetime sys.path.insert(0, os.path.abspath("..")) @@ -45,9 +43,7 @@ creation_year = "2017" current_year = str(datetime.datetime.now().year) year_duration = ( - current_year - if current_year == creation_year - else creation_year + " - " + current_year + current_year if current_year == creation_year else creation_year + " - " + current_year ) copyright = year_duration + " ladyada" author = "ladyada" diff --git a/examples/avrprog_program_mega2560.py b/examples/avrprog_program_mega2560.py index d3ace05..a4e240e 100644 --- a/examples/avrprog_program_mega2560.py +++ b/examples/avrprog_program_mega2560.py @@ -14,6 +14,7 @@ import board import busio + import adafruit_avrprog spi = busio.SPI(board.SCK, board.MOSI, board.MISO) @@ -54,15 +55,10 @@ def error(err): avrprog.write_fuses(atmega2560, low=0xFF, high=0xD8, ext=0x05, lock=0x3F) if not avrprog.verify_fuses(atmega2560, low=0xFF, high=0xD8, ext=0x05, lock=0x3F): - error( - "Failure programming fuses: " - + str([hex(i) for i in avrprog.read_fuses(atmega2560)]) - ) + error("Failure programming fuses: " + str([hex(i) for i in avrprog.read_fuses(atmega2560)])) print("Programming flash from file") -avrprog.program_file( - atmega2560, "stk500boot_v2_mega2560.hex", verbose=True, verify=True -) +avrprog.program_file(atmega2560, "stk500boot_v2_mega2560.hex", verbose=True, verify=True) avrprog.write_fuses(atmega2560, lock=0x0F) if not avrprog.verify_fuses(atmega2560, lock=0x0F): diff --git a/examples/avrprog_program_tiny13a.py b/examples/avrprog_program_tiny13a.py index 4e8b5c5..df126ad 100644 --- a/examples/avrprog_program_tiny13a.py +++ b/examples/avrprog_program_tiny13a.py @@ -14,6 +14,7 @@ import board import busio + import adafruit_avrprog spi = busio.SPI(board.SCK, board.MOSI, board.MISO) diff --git a/examples/avrprog_program_trinket85.py b/examples/avrprog_program_trinket85.py index c8b8007..9f95669 100644 --- a/examples/avrprog_program_trinket85.py +++ b/examples/avrprog_program_trinket85.py @@ -14,6 +14,7 @@ import board import busio + import adafruit_avrprog spi = busio.SPI(board.SCK, board.MOSI, board.MISO) diff --git a/examples/avrprog_program_uno328.py b/examples/avrprog_program_uno328.py index 71e0051..447327a 100644 --- a/examples/avrprog_program_uno328.py +++ b/examples/avrprog_program_uno328.py @@ -15,16 +15,15 @@ import board import busio import pwmio + import adafruit_avrprog spi = busio.SPI(board.SCK, board.MOSI, board.MISO) avrprog = adafruit_avrprog.AVRprog() avrprog.init(spi, board.D5) -# pylint: disable-msg=no-member # we can generate an 6 MHz clock for driving bare chips too! clock_pwm = pwmio.PWMOut(board.D9, frequency=6000000, duty_cycle=65536 // 2) -# pylint: enable-msg=no-member # Each chip has to have a definition so the script knows how to find it atmega328p = avrprog.Boards.ATmega328p @@ -50,10 +49,7 @@ def error(err): avrprog.write_fuses(atmega328p, low=0xFF, high=0xDE, ext=0x05, lock=0x3F) if not avrprog.verify_fuses(atmega328p, low=0xFF, high=0xDE, ext=0x05, lock=0x3F): - error( - "Failure programming fuses: " - + str([hex(i) for i in avrprog.read_fuses(atmega328p)]) - ) + error("Failure programming fuses: " + str([hex(i) for i in avrprog.read_fuses(atmega328p)])) print("Programming flash from file") avrprog.program_file(atmega328p, "optiboot_atmega328.hex", verbose=True, verify=True) diff --git a/examples/avrprog_read_signature_simpletest.py b/examples/avrprog_read_signature_simpletest.py index 52c1849..98e5af7 100644 --- a/examples/avrprog_read_signature_simpletest.py +++ b/examples/avrprog_read_signature_simpletest.py @@ -9,16 +9,15 @@ import board import busio import pwmio + import adafruit_avrprog spi = busio.SPI(board.SCK, board.MOSI, board.MISO) avrprog = adafruit_avrprog.AVRprog() avrprog.init(spi, board.D5) -# pylint: disable-msg=no-member # we can generate an 6 MHz clock for driving bare chips too! clock_pwm = pwmio.PWMOut(board.D9, frequency=6000000, duty_cycle=65536 // 2) -# pylint: enable-msg=no-member avrprog.begin() print("Signature bytes: ", [hex(i) for i in avrprog.read_signature()]) diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..6ff0123 --- /dev/null +++ b/ruff.toml @@ -0,0 +1,108 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +preview = true +select = ["I", "PL", "UP"] + +extend-select = [ + "D419", # empty-docstring + "E501", # line-too-long + "W291", # trailing-whitespace + "PLC0414", # useless-import-alias + "PLC2401", # non-ascii-name + "PLC2801", # unnecessary-dunder-call + "PLC3002", # unnecessary-direct-lambda-call + "E999", # syntax-error + "PLE0101", # return-in-init + "F706", # return-outside-function + "F704", # yield-outside-function + "PLE0116", # continue-in-finally + "PLE0117", # nonlocal-without-binding + "PLE0241", # duplicate-bases + "PLE0302", # unexpected-special-method-signature + "PLE0604", # invalid-all-object + "PLE0605", # invalid-all-format + "PLE0643", # potential-index-error + "PLE0704", # misplaced-bare-raise + "PLE1141", # dict-iter-missing-items + "PLE1142", # await-outside-async + "PLE1205", # logging-too-many-args + "PLE1206", # logging-too-few-args + "PLE1307", # bad-string-format-type + "PLE1310", # bad-str-strip-call + "PLE1507", # invalid-envvar-value + "PLE2502", # bidirectional-unicode + "PLE2510", # invalid-character-backspace + "PLE2512", # invalid-character-sub + "PLE2513", # invalid-character-esc + "PLE2514", # invalid-character-nul + "PLE2515", # invalid-character-zero-width-space + "PLR0124", # comparison-with-itself + "PLR0202", # no-classmethod-decorator + "PLR0203", # no-staticmethod-decorator + "UP004", # useless-object-inheritance + "PLR0206", # property-with-parameters + "PLR0904", # too-many-public-methods + "PLR0911", # too-many-return-statements + "PLR0912", # too-many-branches + "PLR0913", # too-many-arguments + "PLR0914", # too-many-locals + "PLR0915", # too-many-statements + "PLR0916", # too-many-boolean-expressions + "PLR1702", # too-many-nested-blocks + "PLR1704", # redefined-argument-from-local + "PLR1711", # useless-return + "C416", # unnecessary-comprehension + "PLR1733", # unnecessary-dict-index-lookup + "PLR1736", # unnecessary-list-index-lookup + + # ruff reports this rule is unstable + #"PLR6301", # no-self-use + + "PLW0108", # unnecessary-lambda + "PLW0120", # useless-else-on-loop + "PLW0127", # self-assigning-variable + "PLW0129", # assert-on-string-literal + "B033", # duplicate-value + "PLW0131", # named-expr-without-context + "PLW0245", # super-without-brackets + "PLW0406", # import-self + "PLW0602", # global-variable-not-assigned + "PLW0603", # global-statement + "PLW0604", # global-at-module-level + + # fails on the try: import typing used by libraries + #"F401", # unused-import + + "F841", # unused-variable + "E722", # bare-except + "PLW0711", # binary-op-exception + "PLW1501", # bad-open-mode + "PLW1508", # invalid-envvar-default + "PLW1509", # subprocess-popen-preexec-fn + "PLW2101", # useless-with-lock + "PLW3301", # nested-min-max +] + +ignore = [ + "PLR2004", # magic-value-comparison + "UP030", # format literals + "PLW1514", # unspecified-encoding + "PLR0913", # too-many-arguments + "PLR0915", # too-many-statements + "PLR0917", # too-many-positional-arguments + "PLR0904", # too-many-public-methods + "PLR0912", # too-many-branches + "PLR0916", # too-many-boolean-expressions + "PLR6301", # could-be-static no-self-use + "PLC0415", # import outside toplevel + "E501", # line too long +] + +[format] +line-ending = "lf" From fc17a885a8e32828ed604d03a4958d3d1eceaae4 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Wed, 4 Jun 2025 10:00:20 -0500 Subject: [PATCH 59/59] update rtd.yml file Signed-off-by: foamyguy --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 88bca9f..255dafd 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -12,7 +12,7 @@ sphinx: configuration: docs/conf.py build: - os: ubuntu-20.04 + os: ubuntu-lts-latest tools: python: "3"