micropython-stubber 1.14.1__py3-none-any.whl → 1.15.1__py3-none-any.whl

stubber/commands/get_core_cmd.py

@@ -28,12 +28,22 @@ from .cli import stubber_cli
     type=click.Path(exists=True, file_okay=False, dir_okay=True),
     show_default=True,
 )
-@click.option("--pyi/--no-pyi", default=True, help="Create .pyi files for the (new) frozen modules", show_default=True)
-@click.option("--black/--no-black", default=True, help="Run black on the (new) frozen modules", show_default=True)
+@click.option(
+    "--stubgen/--no-stubgen",
+    default=True,
+    help="run stubgen to create .pyi files for the (new) frozen modules",
+    show_default=True,
+)
+@click.option(
+    "--black/--no-black",
+    default=True,
+    help="Run black on the (new) frozen modules",
+    show_default=True,
+)
 def cli_get_core(
     stub_folder: str = CONFIG.stub_path.as_posix(),
     # core_type: str = "pycopy",  # pycopy or Micropython CPython stubs
-    pyi: bool = True,
+    stubgen: bool = True,
     black: bool = True,
 ):
     """
@@ -48,9 +58,11 @@ def cli_get_core(
         req_filename = f"requirements-core-{core_type}.txt"
         stub_path = Path(stub_folder) / f"cpython_core-{core_type}"
 
-        get_cpython.get_core(stub_path=stub_path.as_posix(), requirements=req_filename, family=core_type)
+        get_cpython.get_core(
+            stub_path=stub_path.as_posix(), requirements=req_filename, family=core_type
+        )
         stub_paths.append(stub_path)
 
     log.info("::group:: start post processing of retrieved stubs")
-    utils.do_post_processing(stub_paths, pyi, black)
+    utils.do_post_processing(stub_paths, stubgen=stubgen, black=black, autoflake=True)
     log.info("::group:: Done")

stubber/commands/get_docstubs_cmd.py

@@ -6,11 +6,13 @@ get-docstubs
 from pathlib import Path
 
 import click
+from loguru import logger as log
+
 import stubber.basicgit as git
 import stubber.utils as utils
-from loguru import logger as log
 from stubber.stubs_from_docs import generate_from_rst
 from stubber.utils.config import CONFIG
+from stubber.utils.repos import fetch_repos
 
 from .cli import stubber_cli
 
@@ -20,7 +22,13 @@ from .cli import stubber_cli
 
 
 @stubber_cli.command(name="get-docstubs")
-@click.option("--path", "-p", default=CONFIG.repo_path.as_posix(), type=click.Path(file_okay=False, dir_okay=True), show_default=True)
+@click.option(
+    "--path",
+    "-p",
+    default=CONFIG.repo_path.as_posix(),
+    type=click.Path(file_okay=False, dir_okay=True),
+    show_default=True,
+)
 @click.option(
     "--stub-path",
     "--stub-folder",
@@ -30,7 +38,10 @@ from .cli import stubber_cli
     help="Destination of the files to be generated.",
     show_default=True,
 )
-@click.option("--family", "-f", "basename", default="micropython", help="Micropython family.", show_default=True)
+#  @click.option("--family", "-f", "basename", default="micropython", help="Micropython family.", show_default=True)
+@click.option(
+    "--version", "--tag", default="", type=str, help="Version number to use. [default: Git tag]"
+)
 @click.option("--black/--no-black", "-b/-nb", default=True, help="Run black", show_default=True)
 @click.pass_context
 def cli_docstubs(
@@ -39,6 +50,7 @@ def cli_docstubs(
     target: str = CONFIG.stub_path.as_posix(),
     black: bool = True,
     basename: str = "micropython",
+    version: str = "",
 ):
     """
     Build stubs from documentation.
@@ -54,6 +66,13 @@ def cli_docstubs(
         rst_path = Path(path) / "docs" / "library"
     else:
         rst_path = Path(path)  # or specify full path
+
+    if version:
+        version = utils.clean_version(version, drop_v=False)
+        result = fetch_repos(version, CONFIG.mpy_path, CONFIG.mpy_lib_path)
+        if not result:
+            return -1
+
     v_tag = git.get_local_tag(rst_path.as_posix())
     if not v_tag:
         # if we can't find a tag , bail
@@ -64,9 +83,5 @@ def cli_docstubs(
     dst_path = Path(target) / f"{basename}-{v_tag}-docstubs"
 
     log.info(f"Get docstubs for MicroPython {utils.clean_version(v_tag, drop_v=False)}")
-    generate_from_rst(rst_path, dst_path, v_tag, release=release, suffix=".pyi")
-
-    # no need to generate .pyi in post processing
-    log.info("::group:: start post processing of retrieved stubs")
-    utils.do_post_processing([dst_path], False, black)
+    generate_from_rst(rst_path, dst_path, v_tag, release=release, suffix=".pyi",black=black)
     log.info("::group:: Done")

stubber/commands/get_frozen_cmd.py

@@ -6,10 +6,12 @@ from pathlib import Path
 from typing import List
 
 import click
+from loguru import logger as log
+
 import stubber.basicgit as git
-from stubber.freeze.get_frozen import freeze_any
 import stubber.utils as utils
-from loguru import logger as log
+from stubber.codemod.enrich import enrich_folder
+from stubber.freeze.get_frozen import freeze_any
 from stubber.utils.config import CONFIG
 from stubber.utils.repos import fetch_repos
 
@@ -26,15 +28,34 @@ from .cli import stubber_cli
     type=click.Path(exists=True, file_okay=False, dir_okay=True),
     show_default=True,
 )
-@click.option("--version", "--tag", default="", type=str, help="Version number to use. [default: Git tag]")
-@click.option("--pyi/--no-pyi", default=True, help="Create .pyi files for the (new) frozen modules", show_default=True)
-@click.option("--black/--no-black", default=True, help="Run black on the (new) frozen modules", show_default=True)
+@click.option(
+    "--version",
+    "--Version",
+    "-V",
+    "version",
+    default="",
+    # default=[CONFIG.stable_version],
+    show_default=True,
+)
+@click.option(
+    "--stubgen/--no-stubgen",
+    default=True,
+    help="Run stubgen to create .pyi files for the (new) frozen modules",
+    show_default=True,
+)
+@click.option(
+    "--black/--no-black",
+    default=True,
+    help="Run black on the (new) frozen modules",
+    show_default=True,
+)
 def cli_get_frozen(
     stub_folder: str = CONFIG.stub_path.as_posix(),
     # path: str = config.repo_path.as_posix(),
     version: str = "",
-    pyi: bool = True,
+    stubgen: bool = True,
     black: bool = True,
+    autoflake: bool = True,
 ):
     """
     Get the frozen stubs for MicroPython.
@@ -45,20 +66,52 @@ def cli_get_frozen(
     stub_paths: List[Path] = []
 
     if version:
+        version = utils.clean_version(version, drop_v=False)
         result = fetch_repos(version, CONFIG.mpy_path, CONFIG.mpy_lib_path)
         if not result:
+            log.error(
+                "Failed to fetch repos for version: {} for micropython folder: {} and micropython-lib folder: {}".format(
+                    version, CONFIG.mpy_path.as_posix(), CONFIG.mpy_lib_path.as_posix()
+                )
+            )
             return -1
     else:
         version = utils.clean_version(git.get_local_tag(CONFIG.mpy_path.as_posix()) or "0.0")
     if not version:
-        log.warning("Unable to find the micropython repo in folder : {}".format(CONFIG.mpy_path.as_posix()))
+        log.warning(
+            "Unable to find the micropython repo in folder : {}".format(CONFIG.mpy_path.as_posix())
+        )
 
     log.info("MicroPython version : {}".format(version))
     # folder/{family}-{version}-frozen
     family = "micropython"
     stub_path = Path(stub_folder) / f"{family}-{utils.clean_version(version, flat=True)}-frozen"
     stub_paths.append(stub_path)
-    freeze_any(stub_path, version=version, mpy_path=CONFIG.mpy_path, mpy_lib_path=CONFIG.mpy_lib_path)
+    freeze_any(
+        stub_path, version=version, mpy_path=CONFIG.mpy_path, mpy_lib_path=CONFIG.mpy_lib_path
+    )
+    # Also enrich the frozen modules from the doc stubs if available
+
+    # first create .pyi files so they can be enriched
+    utils.do_post_processing(stub_paths, stubgen=stubgen, black=False, autoflake=False)
+    family = "micropython"
+    docstubs_path = (
+        Path(CONFIG.stub_path)
+        / f"{family}-{utils.clean_version(version, drop_v=False, flat=True)}-docstubs"
+    )
+    if docstubs_path.exists():
+        log.info(f"Enriching {str(stub_path)} with {docstubs_path}")
+        if merged := enrich_folder(
+            stub_path,
+            docstubs_path,
+            show_diff=False,
+            write_back=True,
+            require_docstub=False,
+        ):
+            log.info(f"Enriched {merged} frozen modules from docstubs")
+    else:
+        log.info(f"No docstubs found at {docstubs_path}")
+
     log.info("::group:: start post processing of retrieved stubs")
-    utils.do_post_processing(stub_paths, pyi, black)
+    utils.do_post_processing(stub_paths, stubgen=False, black=black, autoflake=autoflake)
     log.info("::group:: Done")

stubber/commands/get_lobo_cmd.py

@@ -21,8 +21,18 @@ from stubber.utils.config import CONFIG
     type=click.Path(exists=True, file_okay=False, dir_okay=True),
     show_default=True,
 )
-@click.option("--pyi/--no-pyi", default=True, help="Create .pyi files for the (new) frozen modules", show_default=True)
-@click.option("--black/--no-black", default=True, help="Run black on the (new) frozen modules", show_default=True)
+@click.option(
+    "--pyi/--no-pyi",
+    default=True,
+    help="Create .pyi files for the (new) frozen modules",
+    show_default=True,
+)
+@click.option(
+    "--black/--no-black",
+    default=True,
+    help="Run black on the (new) frozen modules",
+    show_default=True,
+)
 def cli_get_lobo(
     stub_folder: str = CONFIG.stub_path.as_posix(),
     pyi: bool = True,
@@ -44,5 +54,5 @@ def cli_get_lobo(
     stub_paths = [stub_path]
 
     log.info("::group:: start post processing of retrieved stubs")
-    utils.do_post_processing(stub_paths, pyi, black)
+    utils.do_post_processing(stub_paths, stubgen=pyi, black=black, autoflake=True)
     log.info("::group:: Done")

stubber/commands/merge_cmd.py

@@ -5,6 +5,7 @@ from typing import List, Union
 
 import click
 from loguru import logger as log
+
 from stubber.publish.merge_docstubs import merge_all_docstubs
 from stubber.publish.package import GENERIC_L
 from stubber.utils.config import CONFIG
@@ -20,7 +21,7 @@ from .cli import stubber_cli
     "-V",
     "versions",
     multiple=True,
-    default=["auto"],
+    default=["all"],
     # type=click.Choice(ALL_VERSIONS),
     show_default=True,
     help="'latest', 'auto', or one or more versions",
@@ -30,7 +31,7 @@ from .cli import stubber_cli
     "-p",
     "ports",
     multiple=True,
-    default=["auto"],
+    default=["all"],
     show_default=True,
     help="multiple: ",
 )
@@ -39,7 +40,7 @@ from .cli import stubber_cli
     "-b",
     "boards",
     multiple=True,
-    default=[GENERIC_L],  # or "auto" ?
+    default=[GENERIC_L],  # or "all" ?
     show_default=True,
     help="multiple: ",
 )
@@ -60,4 +61,6 @@ def cli_merge_docstubs(
         versions = list(versions)
     # single version should be a string
     log.info(f"Merge docstubs for {family} {versions}")
-    _ = merge_all_docstubs(versions=versions, family=family, boards=boards, ports=ports, mpy_path=CONFIG.mpy_path)
+    _ = merge_all_docstubs(
+        versions=versions, family=family, boards=boards, ports=ports, mpy_path=CONFIG.mpy_path
+    )

stubber/commands/publish_cmd.py

@@ -6,10 +6,11 @@ from typing import List, Union
 
 import click
 from loguru import logger as log
+from tabulate import tabulate
+
 from stubber.commands.cli import stubber_cli
-from stubber.publish.package import GENERIC_U
+from stubber.publish.defaults import GENERIC_U
 from stubber.publish.publish import publish_multiple
-from tabulate import tabulate
 from stubber.utils.config import CONFIG
 
 
@@ -30,7 +31,7 @@ from stubber.utils.config import CONFIG
     "-p",
     "ports",
     multiple=True,
-    default=["auto"],
+    default=["all"],
     show_default=True,
     help="multiple: ",
 )
@@ -39,7 +40,7 @@ from stubber.utils.config import CONFIG
     "-b",
     "boards",
     multiple=True,
-    default=[GENERIC_U],  # or "auto" ?
+    default=[GENERIC_U],  # or "all" ?
     show_default=True,
     help="multiple: ",
 )

stubber/commands/stub_cmd.py

@@ -25,5 +25,6 @@ def cli_stub(source: Union[str, Path]):
 
     log.info("Generate type hint files (pyi) in folder: {}".format(source))
     OK = generate_pyi_files(Path(source))
-    do_post_processing([Path(source)], pyi=False, black=True)  # do not generate pyi files twice
+    # do not generate pyi files twice
+    do_post_processing([Path(source)], stubgen=False, black=True, autoflake=False)
     return 0 if OK else 1

stubber/commands/variants_cmd.py

@@ -1,6 +1,5 @@
 """Create all variant of createstubs*.py."""
 from pathlib import Path
-from typing import Optional
 
 import click
 from loguru import logger as log

stubber/freeze/common.py

@@ -1,4 +1,4 @@
-"""common functions for freeze stub generation"""
+"""common functions for frozen stub generation"""
 
 import re
 import shutil
@@ -7,7 +7,7 @@ from typing import Tuple
 
 from loguru import logger as log
 
-from stubber.publish.package import GENERIC_U
+from stubber.publish.defaults import GENERIC_U
 
 
 def get_portboard(manifest_path: Path):

stubber/freeze/freeze_folder.py

@@ -25,7 +25,7 @@ def freeze_folders(stub_folder: str, mpy_folder: str, lib_folder: str, version:
     - 'ports/<port>/modules/*.py'
     - 'ports/<port>/boards/<board>/modules/*.py'
     """
-    match_lib_with_mpy(version_tag=version, lib_path=Path(lib_folder))
+    match_lib_with_mpy(version_tag=version, mpy_path=Path(mpy_folder),lib_path=Path(lib_folder))
 
     targets = []
     scripts = glob.glob(mpy_folder + "/ports/**/modules/*.py", recursive=True)

stubber/freeze/get_frozen.py

@@ -54,7 +54,7 @@ def add_comment_to_path(path: Path, comment: str) -> None:
     Add a comment to the top of each file in the path
     using a codemod
     """
-    # todo: #305 add comment line to each file with the micropython version it was generated from
+    #TODO: #305 add comment line to each file with the micropython version it was generated from
     # frozen_stub_path
     # python -m libcst.tool codemod --include-stubs --no-format  add_comment.AddComment .\repos\micropython-stubs\stubs\micropython-v1_19_1-frozen\ --comment "# Micropython 1.19.1 frozen stubs"
     pass

stubber/minify.py

@@ -80,17 +80,17 @@ def edit_lines(content: str, edits: LineEdits, diff: bool = False):
         """Handles edits that require multiline comments
 
         Example:
-            self._log.debug("info: {} {}".format(
+            self.log.debug("info: {} {}".format(
                 1,
                 2
             ))
-        Here, only commenting out the first self._log line will raise
+        Here, only commenting out the first self.log line will raise
         an error. So this function returns all lines that need to
         be commented out instead.
 
         It also checks for situations such as this:
             if condition:
-                self._log.debug('message')
+                self.log.debug('message')
 
         Here, since the only functionality of the conditional is the call log,
         both lines would be returned to comment out.
@@ -129,9 +129,9 @@ def edit_lines(content: str, edits: LineEdits, diff: bool = False):
             try:
                 something()
             except:
-                self._log.debug('some message')
+                self.log.debug('some message')
 
-        Simply removing the self._log call would create a syntax error,
+        Simply removing the self.log call would create a syntax error,
         which is what this function checks for.
 
         """
@@ -214,33 +214,33 @@ def minify_script(source_script: StubSource, keep_report: bool = True, diff: boo
         ("comment", "import logging"),
         # report keepers may be inserted here
         # do report errors
-        ("rprint", "self._log.error"),
-        ("rprint", "_log.error"),
+        ("rprint", "self.log.error"),
+        ("rprint", "log.error"),
     ]
     if keep_report:
         # insert report keepers after the comment modifiers
         edits += [
             # keepers
-            ("rprint", 'self._log.info("Stub module: '),
-            ("rprint", 'self._log.warning("{}Skip module:'),
-            ("rprint", 'self._log.info("Clean/remove files in folder:'),
-            ("rprint", 'self._log.info("Created stubs for'),
-            ("rprint", 'self._log.info("Family: '),
-            ("rprint", 'self._log.info("Version: '),
-            ("rprint", 'self._log.info("Port: '),
-            ("rprint", 'self._log.info("Board: '),
+            ("rprint", 'self.log.info("Stub module: '),
+            ("rprint", 'self.log.warning("{}Skip module:'),
+            ("rprint", 'self.log.info("Clean/remove files in folder:'),
+            ("rprint", 'self.log.info("Created stubs for'),
+            ("rprint", 'self.log.info("Family: '),
+            ("rprint", 'self.log.info("Version: '),
+            ("rprint", 'self.log.info("Port: '),
+            ("rprint", 'self.log.info("Board: '),
             # all others
-            ("comment", 'self._log.'),
+            ("comment", "self.log."),
             ("comment", "_log ="),
         ]
     else:
         edits += [
             #  remove first full
-            ("comment", "self._log ="),
-            ("comment", "self._log("),
-            ("comment", "self._log.debug"),
-            ("comment", "self._log.info"),
-            ("comment", "self._log.warning"),
+            ("comment", "self.log ="),
+            ("comment", "self.log("),
+            ("comment", "self.log.debug"),
+            ("comment", "self.log.info"),
+            ("comment", "self.log.warning"),
             # then short versions
             ("comment", "_log ="),
             ("comment", "_log.debug"),
@@ -307,7 +307,7 @@ def minify(
                     target = target / "minified.py"  # or raise error?
             target_buf = stack.enter_context(target.open("w+"))
         elif isinstance(target, IOBase):  # type: ignore
-            target_buf = target 
+            target_buf = target
         try:
             minified = minify_script(source_script=source_buf, keep_report=keep_report, diff=diff)
             target_buf.write(minified)
@@ -342,15 +342,15 @@ def cross_compile(
         # target must be a Path object
         _target = get_temp_file(suffix=".mpy")
 
-    cmd = ["pipx", "run", f"mpy-cross=={version}"] if version else ["pipx", "run", "mpy-cross"]
-    # Add params
-    cmd += ["-O2", str(source_file), "-o", str(_target), "-s", "createstubs.py"]
-    log.trace(" ".join(cmd))
-    result = subprocess.run(cmd, capture_output=True, text=True)
+    result = pipx_mpy_cross(version, source_file, _target)
+    if result.stderr and "No matching distribution found for mpy-cross==" in result.stderr:
+        log.warning(f"mpy-cross=={version} not found, using latest")
+        result = pipx_mpy_cross("latest", source_file, _target)
+
     if result.returncode == 0:
         log.debug(f"mpy-cross compiled to    : {_target.name}")
     else:
-        log.error("mpy-cross failed to compile:")
+        log.error(f"mpy-cross failed to compile:{result.returncode} \n{result.stderr}")
 
     if isinstance(target, BytesIO):
         # copy the byte contents of the temp file to the target file-like object
@@ -361,6 +361,21 @@ def cross_compile(
     return result.returncode
 
 
+def pipx_mpy_cross(version, source_file, _target):
+    """Run mpy-cross using pipx"""
+    if version == "latest":
+        version = ""
+    if version:
+        version = "==" + version
+
+    cmd = ["pipx", "run", f"mpy-cross{version}"] if version else ["pipx", "run", "mpy-cross"]
+    # Add params
+    cmd += ["-O2", str(source_file), "-o", str(_target), "-s", "createstubs.py"]
+    log.trace(" ".join(cmd))
+    result = subprocess.run(cmd, capture_output=True, text=True)
+    return result
+
+
 def write_to_temp_file(source: str):
     """Writes a string to a temp file and returns the Path object"""
     _, temp_file = tempfile.mkstemp(suffix=".py", prefix="mpy_cross_")

stubber/publish/bump.py

@@ -66,7 +66,7 @@ def bump_version(
             parts.append(f".a{rc}")
         # ----------------------------------------------------------------------
         # post
-        if post_bump and rc == 0:
+        elif post_bump :
             parts.append(".post1" if current.post is None else f".post{current.post + 1}")
         # ----------------------------------------------------------------------
         # Development release