micropython-stubber 1.23.1.post1__py3-none-any.whl → 1.23.3__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (149) hide show
  1. {micropython_stubber-1.23.1.post1.dist-info → micropython_stubber-1.23.3.dist-info}/LICENSE +30 -30
  2. {micropython_stubber-1.23.1.post1.dist-info → micropython_stubber-1.23.3.dist-info}/METADATA +5 -5
  3. micropython_stubber-1.23.3.dist-info/RECORD +158 -0
  4. mpflash/README.md +220 -220
  5. mpflash/libusb_flash.ipynb +203 -203
  6. mpflash/mpflash/add_firmware.py +98 -98
  7. mpflash/mpflash/ask_input.py +236 -236
  8. mpflash/mpflash/basicgit.py +304 -284
  9. mpflash/mpflash/bootloader/__init__.py +2 -2
  10. mpflash/mpflash/bootloader/activate.py +60 -60
  11. mpflash/mpflash/bootloader/detect.py +82 -82
  12. mpflash/mpflash/bootloader/manual.py +101 -101
  13. mpflash/mpflash/bootloader/micropython.py +12 -12
  14. mpflash/mpflash/bootloader/touch1200.py +36 -36
  15. mpflash/mpflash/cli_download.py +129 -129
  16. mpflash/mpflash/cli_flash.py +224 -216
  17. mpflash/mpflash/cli_group.py +111 -111
  18. mpflash/mpflash/cli_list.py +87 -87
  19. mpflash/mpflash/cli_main.py +39 -39
  20. mpflash/mpflash/common.py +207 -166
  21. mpflash/mpflash/config.py +44 -44
  22. mpflash/mpflash/connected.py +96 -77
  23. mpflash/mpflash/download.py +364 -364
  24. mpflash/mpflash/downloaded.py +130 -130
  25. mpflash/mpflash/errors.py +9 -9
  26. mpflash/mpflash/flash/__init__.py +55 -55
  27. mpflash/mpflash/flash/esp.py +59 -59
  28. mpflash/mpflash/flash/stm32.py +19 -19
  29. mpflash/mpflash/flash/stm32_dfu.py +104 -104
  30. mpflash/mpflash/flash/uf2/__init__.py +88 -88
  31. mpflash/mpflash/flash/uf2/boardid.py +15 -15
  32. mpflash/mpflash/flash/uf2/linux.py +136 -130
  33. mpflash/mpflash/flash/uf2/macos.py +42 -42
  34. mpflash/mpflash/flash/uf2/uf2disk.py +12 -12
  35. mpflash/mpflash/flash/uf2/windows.py +43 -43
  36. mpflash/mpflash/flash/worklist.py +170 -170
  37. mpflash/mpflash/list.py +106 -106
  38. mpflash/mpflash/logger.py +41 -41
  39. mpflash/mpflash/mpboard_id/__init__.py +93 -93
  40. mpflash/mpflash/mpboard_id/add_boards.py +251 -251
  41. mpflash/mpflash/mpboard_id/board.py +37 -37
  42. mpflash/mpflash/mpboard_id/board_id.py +86 -86
  43. mpflash/mpflash/mpboard_id/store.py +48 -43
  44. mpflash/mpflash/mpremoteboard/__init__.py +266 -266
  45. mpflash/mpflash/mpremoteboard/mpy_fw_info.py +152 -141
  46. mpflash/mpflash/mpremoteboard/runner.py +140 -140
  47. mpflash/mpflash/vendor/click_aliases.py +91 -91
  48. mpflash/mpflash/vendor/dfu.py +165 -165
  49. mpflash/mpflash/vendor/pydfu.py +605 -605
  50. mpflash/mpflash/vendor/readme.md +2 -2
  51. mpflash/mpflash/versions.py +135 -135
  52. mpflash/poetry.lock +1687 -1599
  53. mpflash/pyproject.toml +65 -65
  54. mpflash/stm32_udev_rules.md +62 -62
  55. stubber/__init__.py +3 -3
  56. stubber/board/board_info.csv +193 -193
  57. stubber/board/boot.py +34 -34
  58. stubber/board/createstubs.py +986 -986
  59. stubber/board/createstubs_db.py +825 -825
  60. stubber/board/createstubs_db_min.py +331 -331
  61. stubber/board/createstubs_lvgl.py +741 -741
  62. stubber/board/createstubs_lvgl_min.py +741 -741
  63. stubber/board/createstubs_mem.py +766 -766
  64. stubber/board/createstubs_mem_min.py +306 -306
  65. stubber/board/createstubs_min.py +294 -294
  66. stubber/board/fw_info.py +141 -141
  67. stubber/board/info.py +183 -183
  68. stubber/board/main.py +19 -19
  69. stubber/board/modulelist.txt +247 -247
  70. stubber/board/pyrightconfig.json +34 -34
  71. stubber/bulk/mcu_stubber.py +437 -437
  72. stubber/codemod/_partials/__init__.py +48 -48
  73. stubber/codemod/_partials/db_main.py +147 -147
  74. stubber/codemod/_partials/lvgl_main.py +77 -77
  75. stubber/codemod/_partials/modules_reader.py +80 -80
  76. stubber/codemod/add_comment.py +53 -53
  77. stubber/codemod/add_method.py +65 -65
  78. stubber/codemod/board.py +317 -317
  79. stubber/codemod/enrich.py +145 -145
  80. stubber/codemod/merge_docstub.py +284 -284
  81. stubber/codemod/modify_list.py +54 -54
  82. stubber/codemod/utils.py +56 -56
  83. stubber/commands/build_cmd.py +94 -94
  84. stubber/commands/cli.py +49 -49
  85. stubber/commands/clone_cmd.py +78 -78
  86. stubber/commands/config_cmd.py +29 -29
  87. stubber/commands/enrich_folder_cmd.py +71 -71
  88. stubber/commands/get_core_cmd.py +71 -71
  89. stubber/commands/get_docstubs_cmd.py +92 -92
  90. stubber/commands/get_frozen_cmd.py +117 -117
  91. stubber/commands/get_mcu_cmd.py +102 -102
  92. stubber/commands/merge_cmd.py +66 -66
  93. stubber/commands/publish_cmd.py +118 -118
  94. stubber/commands/stub_cmd.py +31 -31
  95. stubber/commands/switch_cmd.py +62 -62
  96. stubber/commands/variants_cmd.py +48 -48
  97. stubber/cst_transformer.py +178 -178
  98. stubber/data/board_info.csv +193 -193
  99. stubber/data/board_info.json +1729 -1729
  100. stubber/data/micropython_tags.csv +15 -15
  101. stubber/data/requirements-core-micropython.txt +38 -38
  102. stubber/data/requirements-core-pycopy.txt +39 -39
  103. stubber/downloader.py +37 -37
  104. stubber/freeze/common.py +72 -72
  105. stubber/freeze/freeze_folder.py +69 -69
  106. stubber/freeze/freeze_manifest_2.py +126 -126
  107. stubber/freeze/get_frozen.py +131 -131
  108. stubber/get_cpython.py +112 -112
  109. stubber/get_lobo.py +59 -59
  110. stubber/minify.py +423 -423
  111. stubber/publish/bump.py +86 -86
  112. stubber/publish/candidates.py +275 -275
  113. stubber/publish/database.py +18 -18
  114. stubber/publish/defaults.py +40 -40
  115. stubber/publish/enums.py +24 -24
  116. stubber/publish/helpers.py +29 -29
  117. stubber/publish/merge_docstubs.py +132 -132
  118. stubber/publish/missing_class_methods.py +51 -51
  119. stubber/publish/package.py +150 -150
  120. stubber/publish/pathnames.py +51 -51
  121. stubber/publish/publish.py +120 -120
  122. stubber/publish/pypi.py +42 -42
  123. stubber/publish/stubpackage.py +1051 -1051
  124. stubber/rst/__init__.py +9 -9
  125. stubber/rst/classsort.py +78 -78
  126. stubber/rst/lookup.py +531 -531
  127. stubber/rst/output_dict.py +401 -401
  128. stubber/rst/reader.py +814 -814
  129. stubber/rst/report_return.py +77 -77
  130. stubber/rst/rst_utils.py +541 -541
  131. stubber/stubber.py +38 -38
  132. stubber/stubs_from_docs.py +90 -90
  133. stubber/tools/manifestfile.py +654 -654
  134. stubber/tools/readme.md +6 -6
  135. stubber/update_fallback.py +117 -117
  136. stubber/update_module_list.py +123 -123
  137. stubber/utils/__init__.py +6 -6
  138. stubber/utils/config.py +137 -137
  139. stubber/utils/makeversionhdr.py +54 -54
  140. stubber/utils/manifest.py +90 -90
  141. stubber/utils/post.py +80 -80
  142. stubber/utils/repos.py +156 -156
  143. stubber/utils/stubmaker.py +139 -139
  144. stubber/utils/typed_config_toml.py +80 -80
  145. stubber/variants.py +106 -106
  146. micropython_stubber-1.23.1.post1.dist-info/RECORD +0 -159
  147. mpflash/basicgit.py +0 -288
  148. {micropython_stubber-1.23.1.post1.dist-info → micropython_stubber-1.23.3.dist-info}/WHEEL +0 -0
  149. {micropython_stubber-1.23.1.post1.dist-info → micropython_stubber-1.23.3.dist-info}/entry_points.txt +0 -0
mpflash/mpflash/config.py CHANGED
@@ -1,44 +1,44 @@
1
- """centralized configuration for mpflash"""
2
-
3
- import os
4
- from importlib.metadata import version
5
- from pathlib import Path
6
- from typing import List
7
-
8
- import platformdirs
9
-
10
- from mpflash.logger import log
11
-
12
-
13
- def get_version():
14
- name = __package__ or "mpflash"
15
- return version(name)
16
-
17
-
18
- class MPtoolConfig:
19
- """Centralized configuration for mpflash"""
20
-
21
- quiet: bool = False
22
- verbose: bool = False
23
- usb: bool = False
24
- ignore_ports: List[str] = []
25
- firmware_folder: Path = platformdirs.user_downloads_path() / "firmware"
26
- # test options specified on the commandline
27
- tests: List[str] = []
28
- _interactive: bool = True
29
-
30
- @property
31
- def interactive(self):
32
- # No interactions in CI
33
- if os.getenv("GITHUB_ACTIONS") == "true":
34
- log.warning("Disabling interactive mode in CI")
35
- return False
36
- return self._interactive
37
-
38
- @interactive.setter
39
- def interactive(self, value: bool):
40
- self._interactive = value
41
-
42
-
43
- config = MPtoolConfig()
44
- __version__ = get_version()
1
+ """centralized configuration for mpflash"""
2
+
3
+ import os
4
+ from importlib.metadata import version
5
+ from pathlib import Path
6
+ from typing import List
7
+
8
+ import platformdirs
9
+
10
+ from mpflash.logger import log
11
+
12
+
13
+ def get_version():
14
+ name = __package__ or "mpflash"
15
+ return version(name)
16
+
17
+
18
+ class MPtoolConfig:
19
+ """Centralized configuration for mpflash"""
20
+
21
+ quiet: bool = False
22
+ verbose: bool = False
23
+ usb: bool = False
24
+ ignore_ports: List[str] = []
25
+ firmware_folder: Path = platformdirs.user_downloads_path() / "firmware"
26
+ # test options specified on the commandline
27
+ tests: List[str] = []
28
+ _interactive: bool = True
29
+
30
+ @property
31
+ def interactive(self):
32
+ # No interactions in CI
33
+ if os.getenv("GITHUB_ACTIONS") == "true":
34
+ log.warning("Disabling interactive mode in CI")
35
+ return False
36
+ return self._interactive
37
+
38
+ @interactive.setter
39
+ def interactive(self, value: bool):
40
+ self._interactive = value
41
+
42
+
43
+ config = MPtoolConfig()
44
+ __version__ = get_version()
@@ -1,77 +1,96 @@
1
- from typing import List, Tuple
2
-
3
- from rich import print
4
- from rich.progress import BarColumn, Progress, SpinnerColumn, TextColumn, TimeElapsedColumn
5
- from rich.table import Column
6
-
7
- from mpflash.common import filtered_comports
8
- from mpflash.mpremoteboard import MPRemoteBoard
9
-
10
-
11
- def connected_ports_boards(*, include: List[str], ignore: List[str]) -> Tuple[List[str], List[str], List[MPRemoteBoard]]:
12
- """
13
- Returns a tuple containing lists of unique ports and boards from the connected MCUs.
14
- Boards that are physically connected, but give no tangible response are ignored.
15
-
16
- Returns:
17
- A tuple containing three lists:
18
- - A list of unique ports where MCUs are connected.
19
- - A list of unique board names of the connected MCUs.
20
- - A list of MPRemoteBoard instances of the connected MCUs.
21
- """
22
- mpr_boards = [b for b in list_mcus(include=include, ignore=ignore) if b.connected]
23
- ports = list({b.port for b in mpr_boards})
24
- boards = list({b.board for b in mpr_boards})
25
- return (ports, boards, mpr_boards)
26
-
27
-
28
- # #########################################################################################################
29
- rp_spinner = SpinnerColumn(finished_text="✅")
30
- rp_text = TextColumn("{task.description} {task.fields[device]}", table_column=Column())
31
- rp_bar = BarColumn(bar_width=None, table_column=Column())
32
-
33
-
34
- def list_mcus(*, ignore: List[str], include: List[str], bluetooth: bool = False) -> List[MPRemoteBoard]:
35
- """
36
- Retrieves information about connected microcontroller boards.
37
-
38
- Returns:
39
- List[MPRemoteBoard]: A list of MPRemoteBoard instances with board information.
40
- Raises:
41
- ConnectionError: If there is an error connecting to a board.
42
- """
43
- # conn_mcus = [MPRemoteBoard(sp) for sp in MPRemoteBoard.connected_boards(bluetooth) if sp not in config.ignore_ports]
44
-
45
- comports = filtered_comports(
46
- ignore=ignore,
47
- include=include,
48
- bluetooth=bluetooth,
49
- )
50
- conn_mcus = [MPRemoteBoard(c.device, location=c.location or "?") for c in comports]
51
-
52
- # a lot of boilerplate to show a progress bar with the comport currently scanned
53
- # low update rate to facilitate screen readers/narration
54
- with Progress(
55
- rp_spinner,
56
- rp_text,
57
- rp_bar,
58
- TimeElapsedColumn(),
59
- refresh_per_second=1,
60
- ) as progress:
61
- tsk_scan = progress.add_task("[green]Scanning", visible=False, total=None)
62
- progress.tasks[tsk_scan].fields["device"] = "..."
63
- progress.tasks[tsk_scan].visible = True
64
- progress.start_task(tsk_scan)
65
- try:
66
- for mcu in conn_mcus:
67
- progress.update(tsk_scan, device=mcu.serialport.replace("/dev/", ""))
68
- try:
69
- mcu.get_mcu_info()
70
- except ConnectionError as e:
71
- print(f"Error: {e}")
72
- continue
73
- finally:
74
- # transient
75
- progress.stop_task(tsk_scan)
76
- progress.tasks[tsk_scan].visible = False
77
- return conn_mcus
1
+ from typing import List, Tuple
2
+
3
+ from rich import print
4
+ from rich.progress import BarColumn, Progress, SpinnerColumn, TextColumn, TimeElapsedColumn
5
+ from rich.table import Column
6
+
7
+ from mpflash.common import filtered_comports
8
+ from mpflash.mpremoteboard import MPRemoteBoard
9
+
10
+ from mpflash.common import find_serial_by_path
11
+
12
+
13
+ def connected_ports_boards(
14
+ *, include: List[str], ignore: List[str], bluetooth: bool = False
15
+ ) -> Tuple[List[str], List[str], List[MPRemoteBoard]]:
16
+ """
17
+ Returns a tuple containing lists of unique ports and boards from the connected MCUs.
18
+ Boards that are physically connected, but give no tangible response are ignored.
19
+
20
+ Returns:
21
+ A tuple containing three lists:
22
+ - A list of unique ports where MCUs are connected.
23
+ - A list of unique board names of the connected MCUs.
24
+ - A list of MPRemoteBoard instances of the connected MCUs.
25
+ """
26
+ conn_mcus = [
27
+ b for b in list_mcus(include=include, ignore=ignore, bluetooth=bluetooth) if b.connected
28
+ ]
29
+ # ignore boards that have the [micropython-stubber] ignore flag set
30
+ conn_mcus = [
31
+ item for item in conn_mcus if not (item.toml.get("mpflash", {}).get("ignore", False))
32
+ ]
33
+
34
+ ports = list({b.port for b in conn_mcus})
35
+ boards = list({b.board for b in conn_mcus})
36
+ return (ports, boards, conn_mcus)
37
+
38
+
39
+ # #########################################################################################################
40
+ rp_spinner = SpinnerColumn(finished_text="✅")
41
+ rp_text = TextColumn("{task.description} {task.fields[device]}", table_column=Column())
42
+ rp_bar = BarColumn(bar_width=None, table_column=Column())
43
+
44
+
45
+ def list_mcus(
46
+ *, ignore: List[str], include: List[str], bluetooth: bool = False
47
+ ) -> List[MPRemoteBoard]:
48
+ """
49
+ Retrieves information about connected microcontroller boards.
50
+
51
+ Returns:
52
+ List[MPRemoteBoard]: A list of MPRemoteBoard instances with board information.
53
+ Raises:
54
+ ConnectionError: If there is an error connecting to a board.
55
+ """
56
+ # conn_mcus = [MPRemoteBoard(sp) for sp in MPRemoteBoard.connected_boards(bluetooth) if sp not in config.ignore_ports]
57
+
58
+ comports = filtered_comports(
59
+ ignore=ignore,
60
+ include=include,
61
+ bluetooth=bluetooth,
62
+ )
63
+ connected_mcus = [
64
+ MPRemoteBoard(
65
+ c.device,
66
+ location=find_serial_by_path(c.device) or c.location or c.hwid or "?",
67
+ )
68
+ for c in comports
69
+ ]
70
+
71
+ # a lot of boilerplate to show a progress bar with the comport currently scanned
72
+ # low update rate to facilitate screen readers/narration
73
+ with Progress(
74
+ rp_spinner,
75
+ rp_text,
76
+ rp_bar,
77
+ TimeElapsedColumn(),
78
+ refresh_per_second=1,
79
+ ) as progress:
80
+ tsk_scan = progress.add_task("[green]Scanning", visible=False, total=None)
81
+ progress.tasks[tsk_scan].fields["device"] = "..."
82
+ progress.tasks[tsk_scan].visible = True
83
+ progress.start_task(tsk_scan)
84
+ try:
85
+ for mcu in connected_mcus:
86
+ progress.update(tsk_scan, device=mcu.serialport.replace("/dev/tty", "tty"))
87
+ try:
88
+ mcu.get_mcu_info()
89
+ except ConnectionError as e:
90
+ print(f"Error: {e}")
91
+ continue
92
+ finally:
93
+ # transient
94
+ progress.stop_task(tsk_scan)
95
+ progress.tasks[tsk_scan].visible = False
96
+ return connected_mcus