Micropython-Stubber
develop
Contents:
Boost MicroPython productivity in VSCode
Approach to collecting stub information
Using stubs
VSCode and Pylint configuration
Create Firmware Stubs
createstub variants
CPython and Frozen modules
Documentation Stubs
Repo structure
PowerShell Scripts
Overview of Stubs
References
Documentation
versions and changes
Changelog
v1.6.4
v1.6.3 minor cleanups
v1.6.0
Naming convention
Use Poetry
createsubs v1.5.4
improve docstubs
Tests
createstubs: v1.5.1
TO-DO (provisional)
Upstream Documentation
Development:
Developing
Testing
API Reference
Micropython-Stubber
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
_
__add__() (stubber.rst.output_dict.SourceDict method)
(stubber.rst.SourceDict method)
__all__ (in module stubber.rst)
__del__() (pyboard.TelnetToSerial method)
__getattr__() (stubber.makemanifest_2.IncludeOptions method)
__str__() (stubber.rst.ModuleSourceDict method)
(stubber.rst.output_dict.ModuleSourceDict method)
(stubber.rst.output_dict.SourceDict method)
(stubber.rst.SourceDict method)
__version__ (in module createstubs)
(in module createstubs_db)
(in module createstubs_mem)
(in module stubber)
_add_annotation_to_imports() (visitors._apply_stubber_annotations.TypeCollector method)
_add_to_toplevel_annotations() (visitors._apply_stubber_annotations.ApplyStubberAnnotationsVisitor method)
_annotate_single_target() (visitors._apply_stubber_annotations.ApplyStubberAnnotationsVisitor method)
_create_import_from_annotation() (visitors._apply_stubber_annotations.TypeCollector method)
_get_import_alias_names() (in module visitors._apply_stubber_annotations)
_get_import_names() (in module visitors._apply_stubber_annotations)
_handle_Index() (visitors._apply_stubber_annotations.TypeCollector method)
_handle_Subscript() (visitors._apply_stubber_annotations.TypeCollector method)
_import_parameter_annotations() (visitors._apply_stubber_annotations.TypeCollector method)
_info() (in module createstubs)
(in module createstubs_db)
(in module createstubs_mem)
_injected_import_hook_code (in module pyboard)
_insert_empty_line() (visitors._apply_stubber_annotations.ApplyStubberAnnotationsVisitor method)
_log (in module createstubs)
(in module createstubs_db)
(in module createstubs_mem)
_MAX_CLASS_LEVEL (in module createstubs)
(in module createstubs_db)
(in module createstubs_mem)
_qualifier_name() (visitors._apply_stubber_annotations.ApplyStubberAnnotationsVisitor method)
_run_git() (in module stubber.basicgit)
_split_module() (visitors._apply_stubber_annotations.ApplyStubberAnnotationsVisitor method)
_type_from_context() (in module stubber.rst)
(in module stubber.rst.rst_utils)
_update_parameters() (visitors._apply_stubber_annotations.ApplyStubberAnnotationsVisitor method)
A
add_args() (commands.constant_folding.ConvertConstantCommand static method)
add_comment() (stubber.rst.output_dict.SourceDict method)
(stubber.rst.SourceDict method)
add_constant() (stubber.rst.output_dict.SourceDict method)
(stubber.rst.SourceDict method)
add_constant_smart() (stubber.rst.output_dict.SourceDict method)
(stubber.rst.SourceDict method)
add_docstr() (stubber.rst.output_dict.SourceDict method)
(stubber.rst.SourceDict method)
add_import() (stubber.rst.ModuleSourceDict method)
(stubber.rst.output_dict.ModuleSourceDict method)
add_line() (stubber.rst.output_dict.SourceDict method)
(stubber.rst.SourceDict method)
add_modules() (createstubs.Stubber method)
(createstubs_db.Stubber method)
(createstubs_mem.Stubber method)
Annotations (class in visitors._apply_stubber_annotations)
ApplyStubberAnnotationsVisitor (class in visitors._apply_stubber_annotations)
at_anchor() (stubber.stubs_from_docs.RSTReader method)
at_heading() (stubber.stubs_from_docs.RSTReader method)
ata_script
module
attribute_annotations (visitors._apply_stubber_annotations.Annotations attribute)
B
basics
module
body (in module simple)
C
checkout_commit() (in module stubber.basicgit)
checkout_tag() (in module stubber.basicgit)
CHILD_PARENT_CLASS (in module stubber.rst)
(in module stubber.rst.lookup)
class_definitions (visitors._apply_stubber_annotations.Annotations attribute)
classdef (in module simple)
classes() (stubber.rst.ModuleSourceDict method)
(stubber.rst.output_dict.ModuleSourceDict method)
ClassSourceDict (class in stubber.rst)
(class in stubber.rst.output_dict)
clean() (createstubs.Stubber method)
(createstubs_db.Stubber method)
(createstubs_mem.Stubber method)
clean_version() (in module stubber.utils)
(in module stubber.utils.versions)
cleanup() (in module stubber.utils.stubmaker)
cli_clone() (in module stubber.stubber)
cli_docstubs() (in module stubber.stubber)
cli_fetch() (in module stubber.stubber)
cli_get_core() (in module stubber.stubber)
cli_get_frozen() (in module stubber.stubber)
cli_get_lobo() (in module stubber.stubber)
cli_minify() (in module stubber.stubber)
cli_stub() (in module stubber.stubber)
cli_update_fallback() (in module stubber.stubber)
clone() (in module stubber.basicgit)
close() (pyboard.ProcessPtyToTerminal method)
(pyboard.ProcessToSerial method)
(pyboard.Pyboard method)
(pyboard.TelnetToSerial method)
commands
module
commands.constant_folding
module
commands.noop
module
commands.samples
module
compound_candidates() (in module stubber.rst)
(in module stubber.rst.rst_utils)
config (in module simple)
(in module stubber)
context (in module ata_script)
CONTEXT_KEY (visitors._apply_stubber_annotations.ApplyStubberAnnotationsVisitor attribute)
convert_path() (in module stubber.makemanifest_2)
ConvertConstantCommand (class in commands.constant_folding)
create_all_stubs() (createstubs.Stubber method)
(createstubs_db.Stubber method)
(createstubs_mem.Stubber method)
create_module_stub() (createstubs.Stubber method)
(createstubs_db.Stubber method)
(createstubs_mem.Stubber method)
create_one_stub() (createstubs.Stubber method)
(createstubs_db.Stubber method)
(createstubs_mem.Stubber method)
create_update_class() (stubber.stubs_from_docs.RSTReader method)
createstubs
module
createstubs_db
module
createstubs_mem
module
D
defaults() (stubber.makemanifest_2.IncludeOptions method)
DESCRIPTION (commands.constant_folding.ConvertConstantCommand attribute)
(commands.noop.NOOPCommand attribute)
distill_return() (in module stubber.rst)
(in module stubber.rst.rst_utils)
do_post_processing() (in module stubber.utils)
(in module stubber.utils.post)
docstrings
module
DOCSTUB_SKIP (in module stubber.rst)
(in module stubber.rst.lookup)
download_file() (in module stubber.downloader)
download_files() (in module stubber.downloader)
E
edit_lines() (in module stubber.minify)
ENOENT (in module createstubs)
(in module createstubs_db)
(in module createstubs_mem)
ensure_folder() (in module createstubs)
(in module createstubs_db)
(in module createstubs_mem)
enter_raw_repl() (pyboard.Pyboard method)
eval() (pyboard.Pyboard method)
exec_() (pyboard.Pyboard method)
exec_raw() (pyboard.Pyboard method)
exec_raw_no_follow() (pyboard.Pyboard method)
execfile() (in module pyboard)
(pyboard.Pyboard method)
exit_raw_repl() (pyboard.Pyboard method)
expr (in module simple)
,
[1]
,
[2]
F
fallback_path (stubber.utils.config.StubberConfig attribute)
fallback_sources() (in module stubber.update_fallback)
FAMILY (in module stubber.get_lobo)
(in module stubber.get_mpy)
fetch() (in module stubber.basicgit)
filesystem_command() (in module pyboard)
find() (stubber.rst.ModuleSourceDict method)
(stubber.rst.output_dict.ModuleSourceDict method)
(stubber.rst.output_dict.SourceDict method)
(stubber.rst.SourceDict method)
fix_parameters() (stubber.stubs_from_docs.RSTReader method)
fix_umqtt_init() (in module stubber.utils.stubmaker)
flat_fwid (createstubs.Stubber property)
(createstubs_db.Stubber property)
(createstubs_mem.Stubber property)
follow() (pyboard.Pyboard method)
freeze() (in module stubber.makemanifest_2)
freeze_as_mpy() (in module stubber.makemanifest_2)
freeze_as_str() (in module stubber.makemanifest_2)
freeze_internal() (in module stubber.makemanifest_2)
freeze_mpy() (in module stubber.makemanifest_2)
FreezeError
fs_cat() (pyboard.Pyboard method)
fs_get() (pyboard.Pyboard method)
fs_ls() (pyboard.Pyboard method)
fs_mkdir() (pyboard.Pyboard method)
fs_put() (pyboard.Pyboard method)
fs_rm() (pyboard.Pyboard method)
fs_rmdir() (pyboard.Pyboard method)
function_annotations (visitors._apply_stubber_annotations.Annotations attribute)
FunctionAnnotation (class in visitors._apply_stubber_annotations)
FunctionSourceDict (class in stubber.rst)
(class in stubber.rst.output_dict)
G
gather_docs (stubber.stubs_from_docs.RSTReader attribute)
generate_from_rst() (in module stubber.stubs_from_docs)
generate_pyi_files() (in module stubber.utils)
(in module stubber.utils.stubmaker)
generate_pyi_from_file() (in module stubber.utils)
(in module stubber.utils.stubmaker)
get_config_value() (stubber.utils.typed_config_toml.TomlConfigSource method)
get_core() (in module stubber.get_cpython)
get_frozen() (in module stubber.get_lobo)
(in module stubber.get_mpy)
get_frozen_folders() (in module stubber.get_mpy)
get_frozen_from_manifest() (in module stubber.get_mpy)
get_obj_attributes() (createstubs.Stubber method)
(createstubs_db.Stubber method)
(createstubs_mem.Stubber method)
get_root() (in module createstubs)
(in module createstubs_db)
(in module createstubs_mem)
get_rst_hint() (stubber.stubs_from_docs.RSTReader method)
get_tag() (in module stubber.basicgit)
get_tags() (in module stubber.basicgit)
get_target_names() (in module stubber.get_mpy)
get_time() (pyboard.Pyboard method)
I
include() (in module stubber.makemanifest_2)
IncludeOptions (class in stubber.makemanifest_2)
index() (stubber.rst.output_dict.SourceDict method)
(stubber.rst.SourceDict method)
info_tree (in module basics)
inWaiting() (pyboard.ProcessPtyToTerminal method)
(pyboard.ProcessToSerial method)
(pyboard.TelnetToSerial method)
isMicroPython() (in module createstubs)
(in module createstubs_db)
(in module createstubs_mem)
L
leave_AnnAssign() (visitors._apply_stubber_annotations.TypeCollector method)
leave_Assign() (visitors._apply_stubber_annotations.ApplyStubberAnnotationsVisitor method)
leave_class() (stubber.stubs_from_docs.RSTReader method)
leave_ClassDef() (basics.TypingCollector method)
(basics.TypingTransformer method)
(visitors._apply_stubber_annotations.ApplyStubberAnnotationsVisitor method)
(visitors._apply_stubber_annotations.TypeCollector method)
leave_FunctionDef() (basics.TypingCollector method)
(basics.TypingTransformer method)
(visitors._apply_stubber_annotations.ApplyStubberAnnotationsVisitor method)
(visitors._apply_stubber_annotations.TypeCollector method)
leave_ImportFrom() (visitors._apply_stubber_annotations.ApplyStubberAnnotationsVisitor method)
leave_Module() (visitors._apply_stubber_annotations.ApplyStubberAnnotationsVisitor method)
leave_SimpleString() (commands.constant_folding.ConvertConstantCommand method)
line (stubber.stubs_from_docs.RSTReader property)
log (in module stubber.downloader)
(in module stubber.get_cpython)
(in module stubber.get_lobo)
(in module stubber.get_mpy)
(in module stubber.makemanifest_2)
(in module stubber.stubber)
(in module stubber.stubs_from_docs)
(in module stubber.update_fallback)
(in module stubber.utils.config)
(in module stubber.utils.ignore)
(in module stubber.utils.manifest)
(in module stubber.utils.post)
(in module stubber.utils.stubmaker)
(in module stubber.utils.typed_config_toml)
LOOKUP_LIST (in module stubber.rst)
(in module stubber.rst.lookup)
M
main() (in module createstubs)
(in module createstubs_mem)
(in module pyboard)
(in module stub_lvgl)
(in module stubber.update_module_list)
main_esp8266() (in module createstubs_db)
make_manifest() (in module stubber.utils)
(in module stubber.utils.manifest)
manifest() (in module stubber.utils)
(in module stubber.utils.manifest)
match_lib_with_mpy() (in module stubber.get_mpy)
minify() (in module stubber.minify)
minify_script() (in module stubber.minify)
modified_tree (in module basics)
module
ata_script
basics
commands
commands.constant_folding
commands.noop
commands.samples
createstubs
createstubs_db
createstubs_mem
docstrings
pyboard
samples
simple
stub_lvgl
stubber
stubber.basicgit
stubber.downloader
stubber.get_cpython
stubber.get_lobo
stubber.get_mpy
stubber.makemanifest_2
stubber.minify
stubber.rst
stubber.rst.classsort
stubber.rst.lookup
stubber.rst.output_dict
stubber.rst.report_return
stubber.rst.rst_utils
stubber.stubber
stubber.stubs_from_docs
stubber.update_fallback
stubber.update_module_list
stubber.utils
stubber.utils.config
stubber.utils.ignore
stubber.utils.manifest
stubber.utils.post
stubber.utils.stubmaker
stubber.utils.typed_config_toml
stubber.utils.versions
visitors
visitors._apply_stubber_annotations
MODULE_GLUE (in module stubber.rst)
(in module stubber.rst.lookup)
module_names (stubber.stubs_from_docs.RSTReader property)
ModuleSourceDict (class in stubber.rst)
(class in stubber.rst.output_dict)
mpy_lib_path (stubber.utils.config.StubberConfig attribute)
mpy_path (stubber.utils.config.StubberConfig attribute)
N
new_docstr (in module simple)
NEW_OUTPUT (in module stubber.stubs_from_docs)
newtree (in module simple)
NONE_VERBS (in module stubber.rst)
(in module stubber.rst.lookup)
NOOPCommand (class in commands.noop)
O
object_candidates() (in module stubber.rst)
(in module stubber.rst.rst_utils)
P
PARAM_FIXES (in module stubber.rst)
(in module stubber.rst.lookup)
parameters (visitors._apply_stubber_annotations.FunctionAnnotation attribute)
parse() (stubber.stubs_from_docs.RSTReader method)
parse_class() (stubber.stubs_from_docs.RSTReader method)
parse_current_module() (stubber.stubs_from_docs.RSTReader method)
parse_data() (stubber.stubs_from_docs.RSTReader method)
parse_docstring() (stubber.stubs_from_docs.RSTReader method)
parse_exception() (stubber.stubs_from_docs.RSTReader method)
parse_function() (stubber.stubs_from_docs.RSTReader method)
parse_method() (stubber.stubs_from_docs.RSTReader method)
parse_module() (stubber.stubs_from_docs.RSTReader method)
parse_name() (stubber.stubs_from_docs.RSTReader method)
parse_names() (stubber.stubs_from_docs.RSTReader method)
parse_toc() (stubber.stubs_from_docs.RSTReader method)
path_vars (in module stubber.makemanifest_2)
PORT (in module stubber.get_lobo)
post_read_hook() (stubber.utils.config.StubberConfig method)
prepare_output() (stubber.stubs_from_docs.RSTReader method)
prGreen() (in module ata_script)
process() (in module stubber.rst.report_return)
ProcessPtyToTerminal (class in pyboard)
ProcessToSerial (class in pyboard)
prRed() (in module ata_script)
pull() (in module stubber.basicgit)
py_source (in module simple)
pyboard
module
Pyboard (class in pyboard)
PyboardError
python_minifier (in module stubber.minify)
R
raw_paste_write() (pyboard.Pyboard method)
read() (pyboard.ProcessPtyToTerminal method)
(pyboard.ProcessToSerial method)
(pyboard.TelnetToSerial method)
read_exclusion_file() (in module stubber.utils)
(in module stubber.utils.ignore)
read_file() (stubber.stubs_from_docs.RSTReader method)
read_micropython_lib_commits() (in module stubber.get_mpy)
read_modules() (in module stubber.update_module_list)
read_path() (in module createstubs)
(in module createstubs_db)
(in module createstubs_mem)
read_until() (pyboard.Pyboard method)
readconfig() (in module stubber.utils)
(in module stubber.utils.config)
rel_path (in module ata_script)
,
[1]
RELEASED (in module stubber.update_fallback)
repo_path (stubber.utils.config.StubberConfig attribute)
report() (createstubs.Stubber method)
(createstubs_db.Stubber method)
(createstubs_mem.Stubber method)
resetWDT() (in module createstubs)
(in module createstubs_db)
(in module createstubs_mem)
return_type_from_context() (in module stubber.rst)
(in module stubber.rst.rst_utils)
returns (visitors._apply_stubber_annotations.FunctionAnnotation attribute)
rich_source (in module commands.samples)
(in module samples)
RST_DOC_FIXES (in module stubber.rst)
(in module stubber.rst.lookup)
RSTReader (class in stubber.stubs_from_docs)
run_black() (in module stubber.utils.post)
S
samples
module
SEPERATOR (in module stubber.stubs_from_docs)
should_ignore() (in module stubber.utils)
(in module stubber.utils.ignore)
show_help() (in module createstubs)
(in module createstubs_db)
(in module createstubs_mem)
simple
module
simple_candidates() (in module stubber.rst)
(in module stubber.rst.rst_utils)
simple_stub (in module commands.samples)
(in module samples)
sort() (stubber.rst.ModuleSourceDict method)
(stubber.rst.output_dict.ModuleSourceDict method)
sort_classes() (in module stubber.rst)
(in module stubber.rst.classsort)
source_tree (in module basics)
(in module simple)
SourceDict (class in stubber.rst)
(class in stubber.rst.output_dict)
sources_dict (in module ata_script)
sources_dir (in module ata_script)
sources_pathlist (in module ata_script)
stdout (in module pyboard)
stdout_write_bytes() (in module pyboard)
store_stub_in_context() (visitors._apply_stubber_annotations.ApplyStubberAnnotationsVisitor static method)
strip_prefixes() (stubber.stubs_from_docs.RSTReader method)
stub (in module ata_script)
stub_dir (in module stubber.makemanifest_2)
stub_lvgl
module
stub_path (stubber.utils.config.StubberConfig attribute)
stubber
module
Stubber (class in createstubs)
(class in createstubs_db)
(class in createstubs_mem)
stubber.basicgit
module
stubber.downloader
module
stubber.get_cpython
module
stubber.get_lobo
module
stubber.get_mpy
module
stubber.makemanifest_2
module
stubber.minify
module
stubber.rst
module
stubber.rst.classsort
module
stubber.rst.lookup
module
stubber.rst.output_dict
module
stubber.rst.report_return
module
stubber.rst.rst_utils
module
stubber.stubber
module
stubber.stubs_from_docs
module
stubber.update_fallback
module
stubber.update_module_list
module
stubber.utils
module
stubber.utils.config
module
stubber.utils.ignore
module
stubber.utils.manifest
module
stubber.utils.post
module
stubber.utils.stubmaker
module
stubber.utils.typed_config_toml
module
stubber.utils.versions
module
stubber_cli() (in module stubber.stubber)
StubberConfig (class in stubber.utils.config)
STUBGEN_OPT (in module stubber.utils.stubmaker)
stubs_dict (in module ata_script)
stubs_dir (in module ata_script)
stubs_pathlist (in module ata_script)
switch_branch() (in module stubber.basicgit)
switch_tag() (in module stubber.basicgit)
T
target (stubber.stubs_from_docs.RSTReader attribute)
TelnetToSerial (class in pyboard)
TomlConfigSource (class in stubber.utils.typed_config_toml)
transform_module_impl() (commands.noop.NOOPCommand method)
(visitors._apply_stubber_annotations.ApplyStubberAnnotationsVisitor method)
transformer (in module basics)
TypeCollector (class in visitors._apply_stubber_annotations)
TYPING_IMPORT (in module stubber.rst)
(in module stubber.rst.rst_utils)
TypingCollector (class in basics)
TypingTransformer (class in basics)
U
U_MODULES (in module stubber.rst)
(in module stubber.rst.lookup)
update_fallback() (in module stubber.update_fallback)
V
verbose (stubber.stubs_from_docs.RSTReader attribute)
VERSION_LIST (in module stubber.stubber)
visit_AnnAssign() (visitors._apply_stubber_annotations.TypeCollector method)
visit_ClassDef() (basics.TypingCollector method)
(basics.TypingTransformer method)
(visitors._apply_stubber_annotations.ApplyStubberAnnotationsVisitor method)
(visitors._apply_stubber_annotations.TypeCollector method)
visit_FunctionDef() (basics.TypingCollector method)
(basics.TypingTransformer method)
(visitors._apply_stubber_annotations.ApplyStubberAnnotationsVisitor method)
(visitors._apply_stubber_annotations.TypeCollector method)
visit_ImportFrom() (visitors._apply_stubber_annotations.TypeCollector method)
visitor (in module ata_script)
(in module basics)
visitors
module
visitors._apply_stubber_annotations
module
W
wrapped() (in module stubber.update_module_list)
write() (pyboard.ProcessPtyToTerminal method)
(pyboard.ProcessToSerial method)
(pyboard.TelnetToSerial method)
write_file() (stubber.stubs_from_docs.RSTReader method)
write_object_stub() (createstubs.Stubber method)
(createstubs_db.Stubber method)
(createstubs_mem.Stubber method)
Read the Docs
v: develop
Versions
master
latest
v1.6.0
v1.4.1
main
develop
Downloads
pdf
On Read the Docs
Project Home
Builds