micropython-stubber 1.20.5__py3-none-any.whl → 1.23.0__py3-none-any.whl

stubber/stubber.py

@@ -1,38 +1,38 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-"""Create, Process, and Maintain stubs ✏️  for MicroPython"""
-
-
-from stubber.commands.build_cmd import cli_build
-from stubber.commands.cli import stubber_cli
-from stubber.commands.clone_cmd import cli_clone
-from stubber.commands.config_cmd import cli_config
-from stubber.commands.enrich_folder_cmd import cli_enrich_folder
-from stubber.commands.get_core_cmd import cli_get_core
-from stubber.commands.get_docstubs_cmd import cli_docstubs
-from stubber.commands.get_frozen_cmd import cli_get_frozen
-from stubber.commands.merge_cmd import cli_merge_docstubs
-from stubber.commands.publish_cmd import cli_publish
-from stubber.commands.stub_cmd import cli_stub
-from stubber.commands.switch_cmd import cli_switch
-from stubber.commands.variants_cmd import cli_variants
-from stubber.commands.get_mcu_cmd import cli_create_mcu_stubs
-
-##########################################################################################
-if __name__ == "__main__":
-    # add all commands to the CLI
-    stubber_cli.add_command(cli_build)
-    stubber_cli.add_command(cli_config)
-    stubber_cli.add_command(cli_clone)
-    stubber_cli.add_command(cli_switch)
-    stubber_cli.add_command(cli_docstubs)
-    stubber_cli.add_command(cli_get_core)
-    stubber_cli.add_command(cli_get_frozen)
-    stubber_cli.add_command(cli_stub)
-    stubber_cli.add_command(cli_enrich_folder)
-    stubber_cli.add_command(cli_publish)
-    stubber_cli.add_command(cli_merge_docstubs)
-    stubber_cli.add_command(cli_variants)
-    stubber_cli.add_command(cli_create_mcu_stubs)
-    stubber_cli()
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""Create, Process, and Maintain stubs ✏️  for MicroPython"""
+
+
+from stubber.commands.build_cmd import cli_build
+from stubber.commands.cli import stubber_cli
+from stubber.commands.clone_cmd import cli_clone
+from stubber.commands.config_cmd import cli_config
+from stubber.commands.enrich_folder_cmd import cli_enrich_folder
+from stubber.commands.get_core_cmd import cli_get_core
+from stubber.commands.get_docstubs_cmd import cli_docstubs
+from stubber.commands.get_frozen_cmd import cli_get_frozen
+from stubber.commands.merge_cmd import cli_merge_docstubs
+from stubber.commands.publish_cmd import cli_publish
+from stubber.commands.stub_cmd import cli_stub
+from stubber.commands.switch_cmd import cli_switch
+from stubber.commands.variants_cmd import cli_variants
+from stubber.commands.get_mcu_cmd import cli_create_mcu_stubs
+
+##########################################################################################
+if __name__ == "__main__":
+    # add all commands to the CLI
+    stubber_cli.add_command(cli_build)
+    stubber_cli.add_command(cli_config)
+    stubber_cli.add_command(cli_clone)
+    stubber_cli.add_command(cli_switch)
+    stubber_cli.add_command(cli_docstubs)
+    stubber_cli.add_command(cli_get_core)
+    stubber_cli.add_command(cli_get_frozen)
+    stubber_cli.add_command(cli_stub)
+    stubber_cli.add_command(cli_enrich_folder)
+    stubber_cli.add_command(cli_publish)
+    stubber_cli.add_command(cli_merge_docstubs)
+    stubber_cli.add_command(cli_variants)
+    stubber_cli.add_command(cli_create_mcu_stubs)
+    stubber_cli()

stubber/stubs_from_docs.py

@@ -1,90 +1,90 @@
-""" 
-Read the Micropython library documentation files and use them to build stubs that can be used for static typechecking 
-using a custom-built parser to read and process the micropython RST files
-"""
-
-import os
-from pathlib import Path
-from typing import List, Optional
-
-from loguru import logger as log
-
-from stubber import utils
-from stubber.rst import DOCSTUB_SKIP, U_MODULES
-from stubber.rst.reader import RSTWriter
-
-
-def generate_from_rst(
-    rst_path: Path,
-    dst_path: Path,
-    v_tag: str,
-    release: Optional[str] = None,
-    pattern: str = "*.rst",
-    suffix: str = ".py",
-    black: bool = True,
-) -> int:
-    dst_path.mkdir(parents=True, exist_ok=True)
-    if not release:
-        release = v_tag
-    # skip
-    #  - index,
-    # - modules with a . in the stem :  module.xxx.rst is included in module.py
-
-    files = get_rst_sources(rst_path, pattern)
-
-    # simplify debugging
-    # files = [f for f in files if f.name == "collections.rst"]
-
-    clean_destination(dst_path)
-    make_docstubs(dst_path, v_tag, release, suffix, files)
-
-    log.info("::group:: start post processing of retrieved stubs")
-    # do not run stubgen
-    utils.do_post_processing([dst_path], stubgen=False, black=black, autoflake=True)
-
-    # Generate a module manifest for the docstubs
-    utils.make_manifest(
-        folder=dst_path,
-        family="micropython",
-        version=utils.clean_version(v_tag),
-        release=release,
-        port="-",
-        stubtype="documentation",
-    )
-    return len(files)
-
-
-def clean_destination(dst_path: Path):
-    """Remove all .py/.pyi files in desination folder to avoid left-behinds"""
-    for f in dst_path.rglob(pattern="*.py*"):
-        try:
-            os.remove(f)
-        except OSError:
-            pass
-
-
-def get_rst_sources(rst_path: Path, pattern: str) -> List[Path]:
-    """Get the list of rst files to process"""
-    files = [f for f in rst_path.glob(pattern) if f.stem != "index" and "." not in f.stem]
-
-    # - excluded modules, ones that offer little advantage  or cause much problems
-    files = [f for f in files if f.name not in DOCSTUB_SKIP]
-    return files
-
-
-def make_docstubs(dst_path: Path, v_tag: str, release: str, suffix: str, files: List[Path]):
-    """Create the docstubs"""
-
-    for file in files:
-        reader = RSTWriter(v_tag)
-        reader.source_release = release
-        log.debug(f"Reading: {file}")
-        reader.read_file(file)
-        reader.parse()
-        fname = (dst_path / file.name).with_suffix(suffix)
-        reader.write_file(fname)
-        if file.stem in U_MODULES:
-            # create umod.py file and mod.py file
-            fname = (dst_path / ("u" + file.name)).with_suffix(suffix)
-            reader.write_file(fname)
-        del reader
+""" 
+Read the Micropython library documentation files and use them to build stubs that can be used for static typechecking 
+using a custom-built parser to read and process the micropython RST files
+"""
+
+import os
+from pathlib import Path
+from typing import List, Optional
+
+from loguru import logger as log
+
+from stubber import utils
+from stubber.rst import DOCSTUB_SKIP, U_MODULES
+from stubber.rst.reader import RSTWriter
+
+
+def generate_from_rst(
+    rst_path: Path,
+    dst_path: Path,
+    v_tag: str,
+    release: Optional[str] = None,
+    pattern: str = "*.rst",
+    suffix: str = ".py",
+    black: bool = True,
+) -> int:
+    dst_path.mkdir(parents=True, exist_ok=True)
+    if not release:
+        release = v_tag
+    # skip
+    #  - index,
+    # - modules with a . in the stem :  module.xxx.rst is included in module.py
+
+    files = get_rst_sources(rst_path, pattern)
+
+    # simplify debugging
+    # files = [f for f in files if f.name == "collections.rst"]
+
+    clean_destination(dst_path)
+    make_docstubs(dst_path, v_tag, release, suffix, files)
+
+    log.info("::group:: start post processing of retrieved stubs")
+    # do not run stubgen
+    utils.do_post_processing([dst_path], stubgen=False, black=black, autoflake=True)
+
+    # Generate a module manifest for the docstubs
+    utils.make_manifest(
+        folder=dst_path,
+        family="micropython",
+        version=utils.clean_version(v_tag),
+        release=release,
+        port="-",
+        stubtype="documentation",
+    )
+    return len(files)
+
+
+def clean_destination(dst_path: Path):
+    """Remove all .py/.pyi files in desination folder to avoid left-behinds"""
+    for f in dst_path.rglob(pattern="*.py*"):
+        try:
+            os.remove(f)
+        except OSError:
+            pass
+
+
+def get_rst_sources(rst_path: Path, pattern: str) -> List[Path]:
+    """Get the list of rst files to process"""
+    files = [f for f in rst_path.glob(pattern) if f.stem != "index" and "." not in f.stem]
+
+    # - excluded modules, ones that offer little advantage  or cause much problems
+    files = [f for f in files if f.name not in DOCSTUB_SKIP]
+    return files
+
+
+def make_docstubs(dst_path: Path, v_tag: str, release: str, suffix: str, files: List[Path]):
+    """Create the docstubs"""
+
+    for file in files:
+        reader = RSTWriter(v_tag)
+        reader.source_release = release
+        log.debug(f"Reading: {file}")
+        reader.read_file(file)
+        reader.parse()
+        fname = (dst_path / file.name).with_suffix(suffix)
+        reader.write_file(fname)
+        if file.stem in U_MODULES:
+            # create umod.py file and mod.py file
+            fname = (dst_path / ("u" + file.name)).with_suffix(suffix)
+            reader.write_file(fname)
+        del reader