micropython-stubber 1.17.5__tar.gz → 1.19.0__tar.gz

{micropython_stubber-1.17.5 → micropython_stubber-1.19.0}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: micropython-stubber
-Version: 1.17.5
+Version: 1.19.0
 Summary: Tooling to create and maintain stubs for MicroPython
 Home-page: https://github.com/Josverl/micropython-stubber#readme
 License: MIT
 Keywords: MicroPython,stubs,vscode,pyright,linting,static type check
 Author: Jos Verlinde
 Author-email: jos_verlinde@hotmail.com
-Requires-Python: >=3.9,<3.12
+Requires-Python: >=3.9,<4.0
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
@@ -25,6 +25,7 @@ Requires-Dist: executing (>=2.0.1,<3.0.0)
 Requires-Dist: importlib-metadata (>=1.0,<2.0) ; python_version < "3.8"
 Requires-Dist: libcst (>=1.1.0,<2.0.0)
 Requires-Dist: loguru (>=0.6,<0.8)
+Requires-Dist: mpflash (>=0.6.0)
 Requires-Dist: mpremote (>=1.22.0,<2.0.0)
 Requires-Dist: mypy (==1.7.0)
 Requires-Dist: mypy-gitlab-code-quality (>=1.1.0,<2.0.0)
@@ -51,13 +52,13 @@ Description-Content-Type: text/markdown
  
   [![pypi version](https://badgen.net/pypi/v/micropython-stubber)](https://pypi.org/project/micropython-stubber/)
   [![python versions](https://badgen.net/pypi/python/micropython-stubber)](https://badgen.net/pypi/python/micropython-stubber)
-  [![Documentation Status](https://readthedocs.org/projects/micropython-stubber/badge/?version=latest)](https://micropython-stubber.readthedocs.io/en/latest/?badge=latest "Document build status badge")
+  [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black "Black badge")
   [![Star on GitHub](https://img.shields.io/github/stars/josverl/micropython-stubber.svg?style=social)](https://github.com/josverl/micropython-stubber/stargazers)
   [![All Contributors](https://img.shields.io/badge/all_contributors-19-green.svg?style=flat-square)](#Contributions)
   <!-- break -->
-  [![pytest tests/common](https://github.com/Josverl/micropython-stubber/actions/workflows/pytest.yml/badge.svg)](https://github.com/Josverl/micropython-stubber/actions/workflows/pytest.yml)
-  [![codecov](https://codecov.io/gh/Josverl/micropython-stubber/branch/main/graph/badge.svg?token=WJFGMKBHOV)](https://codecov.io/gh/Josverl/micropython-stubber)
-  [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black "Black badge")
+  [![pytest stubber](https://github.com/Josverl/micropython-stubber/actions/workflows/pytest.yml/badge.svg)](https://github.com/Josverl/micropython-stubber/actions/workflows/pytest.yml)
+  [![pytest mpflash](https://github.com/Josverl/micropython-stubber/actions/workflows/pytest_mpflash.yml/badge.svg)](https://github.com/Josverl/micropython-stubber/actions/workflows/pytest_mpflash.yml)
+  [![Documentation Status](https://readthedocs.org/projects/micropython-stubber/badge/?version=latest)](https://micropython-stubber.readthedocs.io/en/latest/?badge=latest "Document build status badge")
   <!-- break -->
   [![Open in VSCode](https://img.shields.io/static/v1?logo=visualstudiocode&label=&message=Open%20in%20Visual%20Studio%20Code&labelColor=2c2c32&color=007acc&logoColor=007acc
 )](https://open.vscode.dev/josverl/micropython-stubber)

{micropython_stubber-1.17.5 → micropython_stubber-1.19.0}/pyproject.toml

@@ -8,7 +8,7 @@ repo-path = "./repos"
 
 [tool.poetry]
 name = "micropython-stubber"
-version = "1.17.5"
+version = "1.19.0"
 description = "Tooling to create and maintain stubs for MicroPython"
 authors = ["Jos Verlinde <jos_verlinde@hotmail.com>"]
 license = "MIT"
@@ -45,33 +45,35 @@ exclude = [
 stubber = "stubber.stubber:stubber_cli"
 
 [tool.poetry.dependencies]
-python = ">=3.9,<3.12"
-python-minifier = { version = "^2.7.0", python = "<3.12" } # no support for 3.12 yet
-requests = "^2.28.0"
-mypy = "1.7.0"
-black = ">=22.10,<23.0"
-libcst = "^1.1.0"
+python = ">=3.9,<4.0"
+mpflash = ">=0.6.0"
+mpremote = "^1.22.0"
+# others
 autoflake = ">=1.7,<3.0"
+black = ">=22.10,<23.0"
 cachetools = "^5.3.0"
 click = "^8.1.3"
+executing = "^2.0.1"
 importlib-metadata = { version = "^1.0", python = "<3.8" }
+libcst = "^1.1.0"
 loguru = ">=0.6,<0.8"
+mypy = "1.7.0"
+mypy-gitlab-code-quality = "^1.1.0"
 packaging = ">=21.3,<24.0"
 pipx = "^1.1.0"
 pygithub = "^2.1.1"
-pypi-simple = "^1.0.0"
 pyright = "^1.1.341"
+pyserial = "^3.5"
 pysondb-v2 = "^2.1.0"
+pypi-simple = "^1.0.0"
+python-minifier = { version = "^2.7.0", python = "<3.12" } # no support for 3.12 yet
+requests = "^2.28.0"
+rich-click = "^1.7.3"
 tabulate = "^0.9.0"
 tenacity = "^8.2.2"
 tomli = { version = "^2.0.1", python = "<3.11" }
 tomli-w = "^1.0.0"
 typed-config = "^1.3.0"
-pyserial = "^3.5"
-executing = "^2.0.1"
-mypy-gitlab-code-quality = "^1.1.0"
-rich-click = "^1.7.3"
-mpremote = "^1.22.0"
 
 [tool.poetry.group.docs]
 optional = true
@@ -83,21 +85,24 @@ sphinx-autoapi = "^3.0.0"
 sphinx-click = "5.1.0"
 sphinxcontrib-mermaid = ">=0.9.2"
 
-[tool.poetry.group.dev]
+[tool.poetry.group.test]
 optional = true
-[tool.poetry.group.dev.dependencies]
+[tool.poetry.group.test.dependencies]
 coverage = ">=6.4.3,<8.0.0"
-distro = "^1.8.0"
-mock = "^4.0.3"
-pydeps = "^1.10.22"
 pytest = "^7.1.2"
 pytest-github-actions-annotate-failures = ">=0.1.7,<0.3.0"
 pytest-json-report = "^1.5.0"
 pytest-metadata = ">=2.0.2,<4.0.0"
 pytest-mock = "^3.10.0"
-# mpremote = { git = "https://github.com/Josverl/mpremote", subdirectory = "tools/mpremote", optional = true }
-ipykernel = "^6.23.1"
+mock = "^4.0.3"
+distro = "^1.8.0"
 fasteners = "^0.19"
+
+[tool.poetry.group.dev]
+optional = true
+[tool.poetry.group.dev.dependencies]
+pydeps = "^1.10.22"
+ipykernel = "^6.23.1"
 python-dotenv = "^1.0.0"
 pydocstyle = "^6.3.0"
 chime = "^0.7.0"
@@ -186,7 +191,7 @@ reportUntypedNamedTuple = "none"
 [tool.black]
 # use long lines to avoid _log lines from wrapping , as this causes issues with the minification.
 line-length = 140
-target_version = ['py38']
+# target_version = ['py38']
 include = '\.pyi?$'
 exclude = '''
 (
@@ -211,18 +216,19 @@ exclude = '''
 minversion = "7.0"
 python_functions = ["test_", "*_test"]
 python_files = ["test_*.py", "*_test.py"]
-testpaths = ["tests", "src", "repos/micropython-stubs/tests", "modules/**/tests"]
+testpaths = [
+    "tests", 
+    "src/stubber", 
+    "src/mpflash", 
+    "repos/micropython-stubs/tests", 
+    "modules/**/tests",
+    ]
 norecursedirs = [
-    "repos",
-    "typings*",
-    ".svn",
-    "_build",
-    "tmp*",
     ".*",
-    "build",
-    "dist",
-    "{arch}",
-    "*.egg",
+    ".*/*",
+    # "repos/*",
+    "tests/codemods/codemod_test_cases/*",
+    "typings*",
 ]
 junit_family = "xunit1"
 
@@ -233,56 +239,65 @@ addopts = "--verbose --capture=no -m 'not basicgit'"
 # -n --numprocesses=numprocesses - 
 
 markers = [
+    "stubber: marks tests of the stubber tool",
+    "mpflash: marks tests of the mpflash tool",
+    "snippets: test snippets to check the stubs",
+
+    "legacy: reeally old tests that need to be updated or removed",
+
+    "version: run test only on specific MicroPython version",
+
     "slow: marks tests as slow (deselect with '-m \"not slow\"')",
     "integration: Integration tests (slower)",
     "basicgit: marks tests in the basicgit module that manipulate the checkout",
     "mocked: to replace/compensate for most of the slow and git tests",
-    "snippets: test snippets to check the stubs",
     #
     "minified: marks test of the minified version of createstubs",
     "minify: marks test of the minification of createstubs",
+    "native: Createstubs run against a native micropython implementation",
     "docfix: upstream documentation fix needed",
     "micropython: tests of MicroPython code on Cpython with mocks",
     "doc_stubs: tests to generate stubs from the rst documentation",
     "codemod: test libcst code modification",
     "cli: test command line interface",
-    # os versions
+    # os platforms
     "win32: run test only on Windows",
     "linux: run test only on linux",
     "darwin: run test only on Mac",
-    "version: run test only on specific version",
-    "1.19.0: run test only on 1.19.0",
-    "1.20.0: run test only on 1.20.0",
+    # micropython version dependencies 
+
+
 ]
 
 # coverage reports
+
 [tool.coverage.run]
 parallel = false
 branch = true
-source = ["src"]
+source = [
+    "src/stubber", 
+    "src/mpflash", 
+]
 omit = [
     # helper files in board
     "*/boot.py",
     "*/main.py",
     "*/stub_lvgl.py",
 
-    "*/__init__.py",
-
-    # minfied files should be excluded 
-    # duplicate file names in different folders break the coverage reports
-    # "*/minified/*.py",
-
     # dev helper script in src
     "*/src/stubber/rst/report_return.py",
     "*/src/stubber/update_module_list.py",
 
     # not my code 
-    "*/logging.py",
-    "*/make_stub_files.py",
-    "*/stubber/tools/*.py",
+    "*/src/stubber/tools/*.py",
+    "*/src/mpflash/mpflash/vendored/*.py",
 
     # partial files for variant generation
     "*/codemod/_partials/*.py",
+
+    # pytest code
+    "*/test_*.py",
+    "*/*_test.py",
 ]
 
 

{micropython_stubber-1.17.5 → micropython_stubber-1.19.0}/readme.md

@@ -2,13 +2,13 @@
  
   [![pypi version](https://badgen.net/pypi/v/micropython-stubber)](https://pypi.org/project/micropython-stubber/)
   [![python versions](https://badgen.net/pypi/python/micropython-stubber)](https://badgen.net/pypi/python/micropython-stubber)
-  [![Documentation Status](https://readthedocs.org/projects/micropython-stubber/badge/?version=latest)](https://micropython-stubber.readthedocs.io/en/latest/?badge=latest "Document build status badge")
+  [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black "Black badge")
   [![Star on GitHub](https://img.shields.io/github/stars/josverl/micropython-stubber.svg?style=social)](https://github.com/josverl/micropython-stubber/stargazers)
   [![All Contributors](https://img.shields.io/badge/all_contributors-19-green.svg?style=flat-square)](#Contributions)
   <!-- break -->
-  [![pytest tests/common](https://github.com/Josverl/micropython-stubber/actions/workflows/pytest.yml/badge.svg)](https://github.com/Josverl/micropython-stubber/actions/workflows/pytest.yml)
-  [![codecov](https://codecov.io/gh/Josverl/micropython-stubber/branch/main/graph/badge.svg?token=WJFGMKBHOV)](https://codecov.io/gh/Josverl/micropython-stubber)
-  [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black "Black badge")
+  [![pytest stubber](https://github.com/Josverl/micropython-stubber/actions/workflows/pytest.yml/badge.svg)](https://github.com/Josverl/micropython-stubber/actions/workflows/pytest.yml)
+  [![pytest mpflash](https://github.com/Josverl/micropython-stubber/actions/workflows/pytest_mpflash.yml/badge.svg)](https://github.com/Josverl/micropython-stubber/actions/workflows/pytest_mpflash.yml)
+  [![Documentation Status](https://readthedocs.org/projects/micropython-stubber/badge/?version=latest)](https://micropython-stubber.readthedocs.io/en/latest/?badge=latest "Document build status badge")
   <!-- break -->
   [![Open in VSCode](https://img.shields.io/static/v1?logo=visualstudiocode&label=&message=Open%20in%20Visual%20Studio%20Code&labelColor=2c2c32&color=007acc&logoColor=007acc
 )](https://open.vscode.dev/josverl/micropython-stubber)

{micropython_stubber-1.17.5 → micropython_stubber-1.19.0}/src/mpflash/README.md

@@ -9,12 +9,28 @@ mpflash has been tested on Windows x64, Linux X64 and ARM64, but not (yet) macOS
  1. List the connected boards including their firmware details, in a tabular or json format
  2. Download MicroPython firmware for specific boards and versions.
  3. Flash one or all connected MicroPython boards with a specific firmware or version.
-    Tested ports: rp2, samd, esp32, esp32s3, esp8266 and stm32 (requires cubeprogrammer)
+    Tested ports: rp2, samd, esp32, esp32s3, esp8266 and stm32
  
 ## Installation
 To install mpflash, you can use pip: `pip install mpflash`
 
-## How to use
+## Basic usage
+You can use mpflash to perform various operations on your MicroPython boards. Here is an example of basic usage:
+
+| Command | Description |
+|---------|-------------|
+| `mpflash list` | List the connected board(s) including their firmware details |
+| `mpflash download` | Download the MicroPython firmware(s) for the connected board(s) |
+| `mpflash flash` | Flash the latest stable firmware to the connected board(s) |
+
+
+## Linux permissions to access usb devices 
+In order to flash the firmware to the board, you need to have the correct permissions to access the USB devices.
+On Windows this will not be an issue, but on Linux you can use  udev rules to give non-root users access to the USB devices.
+[See the stm32_permissions documentation](./stm32_udev_rules.md) for more information.
+
+
+## Advanced use
 You can list the connected boards using the following command:
 ```bash
 $ mpflash list
@@ -43,9 +59,12 @@ This will download the latest stable version of the MicroPython firmware for the
 The stable version (default) is determined based on the most recent published release,
 other optionse are `--version preview` and `--version x.y.z` to download the latest preview or version x.y.z respectively.
 
+by default the firmware will be downloaded to  Downloads  in a `firmware` folder in your, but you can specify a different directory using the `--dir` option.
+
+```bash
 The directory structure will be something like this:
 ```
-firmware
+Downloads/firmware
 |   firmware.jsonl
 +---esp8266
 |       ESP8266_GENERIC-FLASH_1M-v1.22.2.bin

micropython_stubber-1.19.0/src/mpflash/libusb_flash.ipynb

@@ -0,0 +1,203 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[<DEVICE ID 0a05:7211 on Bus 002 Address 054>,\n",
+       " <DEVICE ID 0a05:7211 on Bus 002 Address 032>,\n",
+       " <DEVICE ID 045e:0c1e on Bus 002 Address 002>,\n",
+       " <DEVICE ID 045e:07b2 on Bus 002 Address 028>,\n",
+       " <DEVICE ID 045e:0904 on Bus 002 Address 015>,\n",
+       " <DEVICE ID 043e:9a39 on Bus 002 Address 057>,\n",
+       " <DEVICE ID 045e:0901 on Bus 002 Address 006>,\n",
+       " <DEVICE ID 05e3:0610 on Bus 002 Address 010>,\n",
+       " <DEVICE ID 2109:0817 on Bus 001 Address 001>,\n",
+       " <DEVICE ID 045e:0902 on Bus 002 Address 008>,\n",
+       " <DEVICE ID 1000:2000 on Bus 002 Address 016>,\n",
+       " <DEVICE ID 1189:8890 on Bus 002 Address 027>,\n",
+       " <DEVICE ID 2109:0817 on Bus 001 Address 002>,\n",
+       " <DEVICE ID 2109:2812 on Bus 002 Address 025>,\n",
+       " <DEVICE ID 046d:085e on Bus 002 Address 017>,\n",
+       " <DEVICE ID 045e:07c6 on Bus 002 Address 056>,\n",
+       " <DEVICE ID 0bda:5401 on Bus 002 Address 009>,\n",
+       " <DEVICE ID 10c4:ea60 on Bus 002 Address 055>,\n",
+       " <DEVICE ID 2109:2817 on Bus 002 Address 004>,\n",
+       " <DEVICE ID 0bda:5411 on Bus 002 Address 005>,\n",
+       " <DEVICE ID 045e:0900 on Bus 002 Address 003>,\n",
+       " <DEVICE ID 04e8:61f5 on Bus 002 Address 023>,\n",
+       " <DEVICE ID 045e:0903 on Bus 002 Address 020>,\n",
+       " <DEVICE ID 2109:2812 on Bus 002 Address 026>,\n",
+       " <DEVICE ID 8086:a0ed on Bus 002 Address 000>,\n",
+       " <DEVICE ID 2109:2817 on Bus 002 Address 013>,\n",
+       " <DEVICE ID 8087:0029 on Bus 002 Address 001>,\n",
+       " <DEVICE ID 8086:9a13 on Bus 001 Address 000>]"
+      ]
+     },
+     "execution_count": 3,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "import usb.core\n",
+    "import usb.util\n",
+    "import usb.backend.libusb1 as libusb1\n",
+    "from usb.core import USBError, Device\n",
+    "\n",
+    "from pathlib import Path\n",
+    "import platform\n",
+    "\n",
+    "if platform.system() == \"Windows\":\n",
+    "    # on windows you need to use the libusb1 backend\n",
+    "    import libusb\n",
+    "\n",
+    "    arch = \"x64\" if platform.architecture()[0] == \"64bit\" else \"x86\"\n",
+    "    libusb1_dll = Path(libusb.__file__).parent / f\"_platform\\\\_windows\\\\{arch}\\\\libusb-1.0.dll\"\n",
+    "\n",
+    "    backend = libusb1.get_backend(find_library=lambda x: libusb1_dll.as_posix())\n",
+    "usb_devices = usb.core.find(backend=backend, find_all=True)\n",
+    "\n",
+    "list(usb_devices)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "for d in usb.core.find(backend=backend, find_all=True):\n",
+    "    print(f\"Device {d.idVendor:04x}:{d.idProduct:04x}\")\n",
+    "    print(f\"{d.iManufacturer=}\")\n",
+    "    print(f\"{d.iProduct=}\")\n",
+    "    print(f\"{d.bDeviceClass=}\")\n",
+    "    print(f\"{d.bDescriptorType=}\")\n",
+    "    print(f\"{d.bcdDevice=}\")\n",
+    "    print(f\"{d.bcdUSB=}\")\n",
+    "    # print(dir(d))\n",
+    "    # print(f\"  Manufacturer: {usb.util.get_string(dev, dev.iManufacturer)}\")\n",
+    "\n",
+    "    print()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import serial.tools.list_ports\n",
+    "\n",
+    "ports = serial.tools.list_ports.comports()\n",
+    "\n",
+    "for port in ports:\n",
+    "    print(f\"Port: {port.device}\")\n",
+    "    print(f\"Description: {port.description}\")\n",
+    "    print(f\"Hardware ID: {port.hwid}\")\n",
+    "    print()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from mpflash.vendor import pydfu as pydfu\n",
+    "\n",
+    "try:\n",
+    "    pydfu.list_dfu_devices()\n",
+    "except SystemExit:\n",
+    "    print(\"No DFU devices found\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "pydfu.init()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "dfu_file = Path(\"C:\\\\Users\\\\josverl\\\\Downloads\\\\firmware\\\\stm32\\\\PYBV11-THREAD-v1.23.0-preview.203.dfu\")\n",
+    "\n",
+    "print(\"Read DFU file...\")\n",
+    "elements = pydfu.read_dfu_file(dfu_file)\n",
+    "if not elements:\n",
+    "    print(\"No data in dfu file\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Writing memory...\n"
+     ]
+    },
+    {
+     "ename": "NameError",
+     "evalue": "name 'pydfu' is not defined",
+     "output_type": "error",
+     "traceback": [
+      "\u001b[1;31m---------------------------------------------------------------------------\u001b[0m",
+      "\u001b[1;31mNameError\u001b[0m                                 Traceback (most recent call last)",
+      "Cell \u001b[1;32mIn[1], line 2\u001b[0m\n\u001b[0;32m      1\u001b[0m \u001b[38;5;28mprint\u001b[39m(\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mWriting memory...\u001b[39m\u001b[38;5;124m\"\u001b[39m)\n\u001b[1;32m----> 2\u001b[0m \u001b[43mpydfu\u001b[49m\u001b[38;5;241m.\u001b[39mwrite_elements(elements, \u001b[38;5;28;01mFalse\u001b[39;00m, progress\u001b[38;5;241m=\u001b[39mpydfu\u001b[38;5;241m.\u001b[39mcli_progress)\n",
+      "\u001b[1;31mNameError\u001b[0m: name 'pydfu' is not defined"
+     ]
+    }
+   ],
+   "source": [
+    "print(\"Writing memory...\")\n",
+    "pydfu.write_elements(elements, False, progress=pydfu.cli_progress)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print(\"Exiting DFU...\")\n",
+    "pydfu.exit_dfu()"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": ".venv",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.11.7"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}