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
@@ -1,178 +1,178 @@
1
- """helper functions for stub transformations"""
2
-
3
- # sourcery skip: snake-case-functions
4
- from dataclasses import dataclass
5
- from typing import Any, Dict, List, Optional, Sequence, Tuple, Union
6
-
7
- import libcst as cst
8
-
9
-
10
- @dataclass
11
- class TypeInfo:
12
- "contains the functiondefs and classdefs info read from the stubs source"
13
- name: str
14
- decorators: Sequence[cst.Decorator]
15
- params: Optional[cst.Parameters] = None
16
- returns: Optional[cst.Annotation] = None
17
- docstr_node: Optional[cst.SimpleStatementLine] = None
18
- def_node: Optional[Union[cst.FunctionDef, cst.ClassDef]] = None
19
- def_type: str = "?" # funcdef or classdef or module
20
-
21
-
22
- class TransformError(Exception):
23
- """
24
- Error raised upon encountering a known error while attempting to transform
25
- the tree.
26
- """
27
-
28
-
29
- MODULE_KEY = ("__module",)
30
- MODDOC_KEY = ("__module_docstring",)
31
-
32
- # debug helper
33
- _m = cst.parse_module("")
34
-
35
-
36
- class StubTypingCollector(cst.CSTVisitor):
37
- """
38
- Collect the function/method and class definitions from the stubs source
39
- """
40
-
41
- def __init__(self):
42
- # stack for storing the canonical name of the current function
43
- self.stack: List[str] = []
44
- # store the annotations
45
- self.annotations: Dict[
46
- Tuple[str, ...], # key: tuple of canonical class/function name
47
- Union[TypeInfo, str],
48
- ] = {}
49
- self.comments :List[str] = []
50
-
51
- # ------------------------------------------------------------
52
- def visit_Module(self, node: cst.Module) -> bool:
53
- """Store the module docstring"""
54
- docstr = node.get_docstring()
55
- if docstr:
56
- self.annotations[MODULE_KEY] = docstr
57
- return True
58
- def visit_Comment(self, node: cst.Comment) -> None:
59
- """
60
- connect comments from the source
61
- """
62
- comment = node.value
63
- if comment.startswith("# MCU: ") or comment.startswith("# Stubber:"):
64
- # very basic way to detect the stubber comments that we want to copy over
65
- self.comments.append(comment)
66
-
67
- # ------------------------------------------------------------
68
- # keep track of the the (class, method) names to the stack
69
- def visit_ClassDef(self, node: cst.ClassDef) -> Optional[bool]:
70
- """
71
- collect info from a classdef:
72
- - name, decorators, docstring
73
- """
74
- # "Store the class docstring
75
- docstr_node = self.update_append_first_node(node)
76
- ti = TypeInfo(
77
- name=node.name.value,
78
- params=None,
79
- returns=None,
80
- docstr_node=docstr_node,
81
- decorators=node.decorators,
82
- def_type="classdef",
83
- def_node=node,
84
- )
85
- self.annotations[tuple(self.stack)] = ti
86
-
87
- def leave_ClassDef(self, original_node: cst.ClassDef) -> None:
88
- """remove the class name from the stack"""
89
- self.stack.pop()
90
-
91
- # ------------------------------------------------------------
92
- def visit_FunctionDef(self, node: cst.FunctionDef) -> Optional[bool]:
93
- """
94
- collect info from a function/method
95
- - name, decorators, params, returns, docstring
96
- """
97
- # "store each function/method signature"
98
- docstr_node = self.update_append_first_node(node)
99
- ti = TypeInfo(
100
- name=node.name.value,
101
- params=node.params,
102
- returns=node.returns,
103
- docstr_node=docstr_node,
104
- decorators=node.decorators,
105
- def_type="funcdef",
106
- def_node=node,
107
- )
108
- self.annotations[tuple(self.stack)] = ti
109
-
110
- def update_append_first_node(self, node):
111
- """Store the function/method docstring or function/method sig"""
112
- self.stack.append(node.name.value)
113
- if node.get_docstring():
114
- assert isinstance(node.body.body[0], cst.SimpleStatementLine)
115
- return node.body.body[0]
116
- else:
117
- return None
118
-
119
- def leave_FunctionDef(self, original_node: cst.FunctionDef) -> None:
120
- """remove the function/method name from the stack"""
121
- self.stack.pop()
122
-
123
-
124
- def update_def_docstr(
125
- dest_node: Union[cst.FunctionDef, cst.ClassDef],
126
- src_comment: Optional[cst.SimpleStatementLine],
127
- src_node=None,
128
- ) -> Any:
129
- """
130
- Update the docstring of a function/method or class
131
-
132
- for functiondefs ending in an ellipsis, the entire body needs to be replaced.
133
- in this case the src_body is mandatory.
134
- """
135
- if not src_comment:
136
- return dest_node
137
-
138
- # function def on a single line ending with an ellipsis (...)
139
- if isinstance(dest_node.body, cst.SimpleStatementSuite):
140
- # in order to add a boy the simple hack is to copy the src_node.body
141
- return dest_node.with_changes(body=src_node.body) if src_node else dest_node
142
- # just checking
143
- if not isinstance(dest_node.body, cst.IndentedBlock):
144
- raise TransformError("Expected Def with Indented body")
145
-
146
- # classdef of functiondef with an indented body
147
- # need some funcky casting to avoid issues with changing the body
148
- # note : indented body is nested : body.body
149
- if dest_node.get_docstring() is None:
150
- # append the new docstring and append the function body
151
- body = tuple([src_comment] + list(dest_node.body.body))
152
- else:
153
- body = tuple([src_comment] + list(dest_node.body.body[1:]))
154
- body_2 = dest_node.body.with_changes(body=body)
155
-
156
- return dest_node.with_changes(body=body_2)
157
-
158
-
159
- def update_module_docstr(
160
- node: cst.Module,
161
- doc_tree: Optional[Union[str, cst.SimpleStatementLine, cst.BaseCompoundStatement]],
162
- ) -> Any:
163
- """
164
- Add or update the docstring of a module
165
- """
166
- if not doc_tree:
167
- return node
168
- if not isinstance(doc_tree, (str, cst.SimpleStatementLine, cst.BaseCompoundStatement)): # type: ignore
169
- raise TransformError("Expected a docstring or a statement")
170
- if isinstance(doc_tree, str):
171
- doc_tree = cst.parse_statement(doc_tree)
172
- # need some funcky casting to avoid issues with changing the body
173
- if node.get_docstring() is None:
174
- # append the new docstring and append the function body
175
- body = tuple([doc_tree] + list(node.body)) # type: ignore
176
- else:
177
- body = tuple([doc_tree] + list(node.body[1:])) # type: ignore
178
- return node.with_changes(body=body)
1
+ """helper functions for stub transformations"""
2
+
3
+ # sourcery skip: snake-case-functions
4
+ from dataclasses import dataclass
5
+ from typing import Any, Dict, List, Optional, Sequence, Tuple, Union
6
+
7
+ import libcst as cst
8
+
9
+
10
+ @dataclass
11
+ class TypeInfo:
12
+ "contains the functiondefs and classdefs info read from the stubs source"
13
+ name: str
14
+ decorators: Sequence[cst.Decorator]
15
+ params: Optional[cst.Parameters] = None
16
+ returns: Optional[cst.Annotation] = None
17
+ docstr_node: Optional[cst.SimpleStatementLine] = None
18
+ def_node: Optional[Union[cst.FunctionDef, cst.ClassDef]] = None
19
+ def_type: str = "?" # funcdef or classdef or module
20
+
21
+
22
+ class TransformError(Exception):
23
+ """
24
+ Error raised upon encountering a known error while attempting to transform
25
+ the tree.
26
+ """
27
+
28
+
29
+ MODULE_KEY = ("__module",)
30
+ MODDOC_KEY = ("__module_docstring",)
31
+
32
+ # debug helper
33
+ _m = cst.parse_module("")
34
+
35
+
36
+ class StubTypingCollector(cst.CSTVisitor):
37
+ """
38
+ Collect the function/method and class definitions from the stubs source
39
+ """
40
+
41
+ def __init__(self):
42
+ # stack for storing the canonical name of the current function
43
+ self.stack: List[str] = []
44
+ # store the annotations
45
+ self.annotations: Dict[
46
+ Tuple[str, ...], # key: tuple of canonical class/function name
47
+ Union[TypeInfo, str],
48
+ ] = {}
49
+ self.comments :List[str] = []
50
+
51
+ # ------------------------------------------------------------
52
+ def visit_Module(self, node: cst.Module) -> bool:
53
+ """Store the module docstring"""
54
+ docstr = node.get_docstring()
55
+ if docstr:
56
+ self.annotations[MODULE_KEY] = docstr
57
+ return True
58
+ def visit_Comment(self, node: cst.Comment) -> None:
59
+ """
60
+ connect comments from the source
61
+ """
62
+ comment = node.value
63
+ if comment.startswith("# MCU: ") or comment.startswith("# Stubber:"):
64
+ # very basic way to detect the stubber comments that we want to copy over
65
+ self.comments.append(comment)
66
+
67
+ # ------------------------------------------------------------
68
+ # keep track of the the (class, method) names to the stack
69
+ def visit_ClassDef(self, node: cst.ClassDef) -> Optional[bool]:
70
+ """
71
+ collect info from a classdef:
72
+ - name, decorators, docstring
73
+ """
74
+ # "Store the class docstring
75
+ docstr_node = self.update_append_first_node(node)
76
+ ti = TypeInfo(
77
+ name=node.name.value,
78
+ params=None,
79
+ returns=None,
80
+ docstr_node=docstr_node,
81
+ decorators=node.decorators,
82
+ def_type="classdef",
83
+ def_node=node,
84
+ )
85
+ self.annotations[tuple(self.stack)] = ti
86
+
87
+ def leave_ClassDef(self, original_node: cst.ClassDef) -> None:
88
+ """remove the class name from the stack"""
89
+ self.stack.pop()
90
+
91
+ # ------------------------------------------------------------
92
+ def visit_FunctionDef(self, node: cst.FunctionDef) -> Optional[bool]:
93
+ """
94
+ collect info from a function/method
95
+ - name, decorators, params, returns, docstring
96
+ """
97
+ # "store each function/method signature"
98
+ docstr_node = self.update_append_first_node(node)
99
+ ti = TypeInfo(
100
+ name=node.name.value,
101
+ params=node.params,
102
+ returns=node.returns,
103
+ docstr_node=docstr_node,
104
+ decorators=node.decorators,
105
+ def_type="funcdef",
106
+ def_node=node,
107
+ )
108
+ self.annotations[tuple(self.stack)] = ti
109
+
110
+ def update_append_first_node(self, node):
111
+ """Store the function/method docstring or function/method sig"""
112
+ self.stack.append(node.name.value)
113
+ if node.get_docstring():
114
+ assert isinstance(node.body.body[0], cst.SimpleStatementLine)
115
+ return node.body.body[0]
116
+ else:
117
+ return None
118
+
119
+ def leave_FunctionDef(self, original_node: cst.FunctionDef) -> None:
120
+ """remove the function/method name from the stack"""
121
+ self.stack.pop()
122
+
123
+
124
+ def update_def_docstr(
125
+ dest_node: Union[cst.FunctionDef, cst.ClassDef],
126
+ src_comment: Optional[cst.SimpleStatementLine],
127
+ src_node=None,
128
+ ) -> Any:
129
+ """
130
+ Update the docstring of a function/method or class
131
+
132
+ for functiondefs ending in an ellipsis, the entire body needs to be replaced.
133
+ in this case the src_body is mandatory.
134
+ """
135
+ if not src_comment:
136
+ return dest_node
137
+
138
+ # function def on a single line ending with an ellipsis (...)
139
+ if isinstance(dest_node.body, cst.SimpleStatementSuite):
140
+ # in order to add a boy the simple hack is to copy the src_node.body
141
+ return dest_node.with_changes(body=src_node.body) if src_node else dest_node
142
+ # just checking
143
+ if not isinstance(dest_node.body, cst.IndentedBlock):
144
+ raise TransformError("Expected Def with Indented body")
145
+
146
+ # classdef of functiondef with an indented body
147
+ # need some funcky casting to avoid issues with changing the body
148
+ # note : indented body is nested : body.body
149
+ if dest_node.get_docstring() is None:
150
+ # append the new docstring and append the function body
151
+ body = tuple([src_comment] + list(dest_node.body.body))
152
+ else:
153
+ body = tuple([src_comment] + list(dest_node.body.body[1:]))
154
+ body_2 = dest_node.body.with_changes(body=body)
155
+
156
+ return dest_node.with_changes(body=body_2)
157
+
158
+
159
+ def update_module_docstr(
160
+ node: cst.Module,
161
+ doc_tree: Optional[Union[str, cst.SimpleStatementLine, cst.BaseCompoundStatement]],
162
+ ) -> Any:
163
+ """
164
+ Add or update the docstring of a module
165
+ """
166
+ if not doc_tree:
167
+ return node
168
+ if not isinstance(doc_tree, (str, cst.SimpleStatementLine, cst.BaseCompoundStatement)): # type: ignore
169
+ raise TransformError("Expected a docstring or a statement")
170
+ if isinstance(doc_tree, str):
171
+ doc_tree = cst.parse_statement(doc_tree)
172
+ # need some funcky casting to avoid issues with changing the body
173
+ if node.get_docstring() is None:
174
+ # append the new docstring and append the function body
175
+ body = tuple([doc_tree] + list(node.body)) # type: ignore
176
+ else:
177
+ body = tuple([doc_tree] + list(node.body[1:])) # type: ignore
178
+ return node.with_changes(body=body)