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

stubber/publish/candidates.py

@@ -20,7 +20,8 @@ from packaging.version import parse
 import stubber.basicgit as git
 from stubber import utils
 from stubber.publish.defaults import GENERIC, GENERIC_L, GENERIC_U
-from stubber.publish.enums import COMBO_STUBS, DOC_STUBS, FIRMWARE_STUBS
+
+# from stubber.publish.enums import COMBO_STUBS
 from stubber.utils.config import CONFIG
 from stubber.utils.versions import OLDEST_VERSION, SET_PREVIEW, V_PREVIEW, clean_version, micropython_versions
 
@@ -139,7 +140,7 @@ def frozen_candidates(
                     "version": version,
                     "port": port,
                     "board": GENERIC_L,
-                    "pkg_type": COMBO_STUBS,
+                    # "pkg_type": COMBO_STUBS,
                 }
             # if not auto_board:
             #     for board in boards:
@@ -177,7 +178,7 @@ def frozen_candidates(
                         "version": version,
                         "port": port,
                         "board": board,
-                        "pkg_type": COMBO_STUBS,
+                        # "pkg_type": COMBO_STUBS,
                     }
 
 
@@ -189,33 +190,11 @@ def is_auto(thing: Union[None, str, List[str]]):
         return any(i in ["auto", "all"] for i in thing)
 
 
-def docstub_candidates(
-    family: str = "micropython",
-    versions: Union[str, List[str]] = V_PREVIEW,
-    path: Path = CONFIG.stub_path,
-):
-    """
-    Generate a list of possible documentation stub candidates for the given family and version.
-
-    Note that the folders do not need to exist, with the exception of auto which will scan the stubs folder for versions of docstubs
-    """
-    if isinstance(versions, str):
-        if is_auto(versions):  # auto with vprefix ...
-            versions = list(version_candidates(suffix="docstubs", prefix=family, path=path))
-        else:
-            versions = [versions]
-    versions = [clean_version(v, flat=True) for v in versions]
-
-    for version in versions:
-        yield {"family": family, "version": version, "pkg_type": DOC_STUBS}
-
-
 def board_candidates(
     family: str = "micropython",
     versions: Union[str, List[str]] = V_PREVIEW,
     *,
     mpy_path: Path = CONFIG.mpy_path,
-    pt: str = FIRMWARE_STUBS,
 ):
     """
     generate a list of possible board stub candidates for the given family and version.
@@ -236,7 +215,9 @@ def board_candidates(
         else:
             r = git.checkout_tag(repo=mpy_path, tag=version)
         if not r:
-            log.warning(f"Incorrect version: {version} or did you forget to run `stubber clone` to get the micropython repo?")
+            log.warning(
+                f"Incorrect version: {version} or did you forget to run `stubber clone` to get the micropython repo?"
+            )
             return []
         ports = list_micropython_ports(family=family, mpy_path=mpy_path)
         for port in ports:
@@ -246,7 +227,6 @@ def board_candidates(
                 "version": version,
                 "port": port,
                 "board": GENERIC_U,
-                "pkg_type": pt,
             }
             for board in list_micropython_port_boards(family=family, mpy_path=mpy_path, port=port):
                 if board not in GENERIC:
@@ -255,7 +235,6 @@ def board_candidates(
                         "version": version,
                         "port": port,
                         "board": board,
-                        "pkg_type": pt,
                     }
 
 

stubber/publish/enums.py

@@ -22,9 +22,3 @@ class StubSource(str, Enum):
         # Always force string values
         return self.value
 
-
-ALL_TYPES = ["combo", "doc", "core", "firmware"]
-COMBO_STUBS = ALL_TYPES[0]
-DOC_STUBS = ALL_TYPES[1]
-CORE_STUBS = ALL_TYPES[2]
-FIRMWARE_STUBS = ALL_TYPES[3]

stubber/publish/package.py

@@ -2,6 +2,7 @@
 prepare a set of stub files for publishing to PyPi
 
 """
+
 import sys
 from pathlib import Path
 from typing import Dict, Union
@@ -11,7 +12,7 @@ from packaging.version import parse
 from pysondb import PysonDB
 
 from stubber.publish.defaults import GENERIC, GENERIC_L, default_board
-from stubber.publish.enums import COMBO_STUBS, CORE_STUBS, DOC_STUBS, StubSource
+from stubber.publish.enums import StubSource
 from stubber.publish.stubpackage import StubPackage, StubSources
 from stubber.utils.config import CONFIG
 from stubber.utils.versions import clean_version
@@ -21,27 +22,12 @@ log.remove()
 log.add(sys.stderr, level="INFO", backtrace=True, diagnose=True)
 
 
-def package_name(
-    pkg_type: str, *, port: str = "", board: str = "", family: str = "micropython", **kwargs
-) -> str:
+def package_name(*, port: str = "", board: str = "", family: str = "micropython", **kwargs) -> str:
     "generate a package name for the given package type"
-    if pkg_type == COMBO_STUBS:
-        # # {family}-{port}-{board}-stubs
-        name = f"{family}-{port}-{board}-stubs".lower()
-        name = name.replace("-generic-stubs", "-stubs")
-        # Use explicit generic_ names for the stubs
-        # name = name.replace("-generic_", "-")  # @GENERIC Prefix
-        return name
-    elif pkg_type == DOC_STUBS:
-        return f"{family}-doc-stubs".lower()
-    elif pkg_type == CORE_STUBS:
-        return f"{family}-core-stubs".lower()
-    # # {family}-{port}-{board}-{type}-stubs
-    name = f"{family}-{port}-{board}-{pkg_type}-stubs".lower()
+    # # {family}-{port}[-{board}[-{variant}]]-stubs
+    name = f"{family}-{port}-{board}-stubs".lower()
+    name = name.replace("-generic-stubs", "-stubs")
     # Use explicit generic_ names for the stubs
-    # # remove -generic- from the name
-    # name = name.replace(f"-generic-{pkg_type}-stubs", f"-{pkg_type}-stubs")
-    # # remove -genetic_ from the name
     # name = name.replace("-generic_", "-")  # @GENERIC Prefix
     return name
 
@@ -49,14 +35,13 @@ def package_name(
 def get_package(
     db: PysonDB,
     *,
-    pkg_type: str,
     version: str,
     port: str,
     board: str = GENERIC_L,
     family: str = "micropython",
 ) -> StubPackage:
     """Get the package from the database or create a new one if it does not exist."""
-    pkg_name = package_name(pkg_type, port=port, board=board, family=family)
+    pkg_name = package_name(port=port, board=board, family=family)
     version = clean_version(version, drop_v=True)
     if package_info := get_package_info(
         db,
@@ -74,13 +59,10 @@ def get_package(
         port=port,
         board=board,
         family=family,
-        pkg_type=pkg_type,
     )
 
 
-def get_package_info(
-    db: PysonDB, pub_path: Path, *, pkg_name: str, mpy_version: str
-) -> Union[Dict, None]:
+def get_package_info(db: PysonDB, pub_path: Path, *, pkg_name: str, mpy_version: str) -> Union[Dict, None]:
     """
     get a package's record from the json db if it can be found
     matches om the package name and version
@@ -88,9 +70,7 @@ def get_package_info(
         mpy_version: micropython/firmware version (1.18)
     """
     # find in the database
-    recs = db.get_by_query(
-        query=lambda x: x["mpy_version"] == mpy_version and x["name"] == pkg_name
-    )
+    recs = db.get_by_query(query=lambda x: x["mpy_version"] == mpy_version and x["name"] == pkg_name)
     # dict to list
     recs = [{"id": key, "data": recs[key]} for key in recs]
     # sort
@@ -108,32 +88,21 @@ def create_package(
     pkg_name: str,
     mpy_version: str,
     *,
-    port: str = "",
+    port: str,
     board: str = "",
     family: str = "micropython",
-    pkg_type: str = COMBO_STUBS,
+    # pkg_type: str = COMBO_STUBS,
 ) -> StubPackage:  # sourcery skip: merge-duplicate-blocks, remove-redundant-if
     """
     create and initialize a package with the correct sources
     """
     ver_flat = clean_version(mpy_version, flat=True)
     stubs: StubSources = []
-    if pkg_type == COMBO_STUBS:
-        assert port != "", "port must be specified for combo stubs"
-        stubs = combo_sources(family, port, board, ver_flat)
-    elif pkg_type == DOC_STUBS:
-        stubs = [
-            (
-                StubSource.DOC,
-                Path(f"{family}-{ver_flat}-docstubs"),
-            ),
-        ]
-    elif pkg_type == CORE_STUBS:
-        # TODO add core stubs
-        raise NotImplementedError(type)
-    else:
-        raise NotImplementedError(type)
+    # if pkg_type != COMBO_STUBS:
+    #     raise ValueError("Not Supported")
 
+    assert port != "", "port must be specified for combo stubs"
+    stubs = combo_sources(family, port, board, ver_flat)
     return StubPackage(pkg_name, port=port, board=board, version=mpy_version, stubs=stubs)
 
 

stubber/publish/publish.py

@@ -11,7 +11,6 @@ from loguru import logger as log
 from stubber.publish.candidates import board_candidates, filter_list
 from stubber.publish.database import get_database
 from stubber.publish.defaults import GENERIC_U
-from stubber.publish.enums import COMBO_STUBS
 from stubber.publish.package import get_package
 from stubber.utils.config import CONFIG
 from stubber.utils.versions import V_PREVIEW
@@ -110,7 +109,7 @@ def build_worklist(
     if family != "micropython":
         return []
     # get all the candidates
-    worklist = list(board_candidates(family=family, versions=versions, pt=COMBO_STUBS))
+    worklist = list(board_candidates(family=family, versions=versions))
     worklist = filter_list(worklist, ports, boards)
 
     for b in boards:

stubber/rst/lookup.py

@@ -254,7 +254,7 @@ PARAM_FIXES = [
     Fix("\\*", "*"),  # change weirdly written wildcards \* --> *
     Fix(r"\**", "*"),  # change weirdly written wildcards \* --> *
     Fix(r"/*", "*"),  # change weirdly written wildcards \* --> *
-    # ("**", "*"),  # change weirdly written wildcards \* --> *
+    Fix(r"/)", ")"),  # strange terminator in machine.USBDevice `USBDevice.active(self, [value] /)`
     Fix("'param'", "param"),  # loose notation in documentation
     # illegal keywords
     Fix(
@@ -484,17 +484,17 @@ PARAM_FIXES = [
 # List of classes and their parent classes that should be added to the class definition
 CHILD_PARENT_CLASS = {
     # machine
-    # SoftSPI is defined before SPI, so baseclass is not yet available - but in a .pyi that is OK 
-    "SoftSPI": "SPI",  
+    # SoftSPI is defined before SPI, so baseclass is not yet available - but in a .pyi that is OK
+    "SoftSPI": "SPI",
     "SoftI2C": "I2C",
     "Switch": "Pin",
     "Signal": "Pin",
     # uio # unclear regarding deprecation in python 3.12
     # "IOBase": "IO",  # DOCME  not in documentation
-    "TextIOWrapper": "IO", # "TextIOBase, TextIO",  # based on Stdlib
-    "FileIO": "IO", #  "RawIOBase, BinaryIO",  # based on Stdlib
-    "StringIO": "IO", #  "BufferedIOBase, BinaryIO",  # based on Stdlib
-    "BytesIO": "IO", # "BufferedIOBase, BinaryIO",  # based on Stdlib
+    "TextIOWrapper": "IO",  # "TextIOBase, TextIO",  # based on Stdlib
+    "FileIO": "IO",  #  "RawIOBase, BinaryIO",  # based on Stdlib
+    "StringIO": "IO",  #  "BufferedIOBase, BinaryIO",  # based on Stdlib
+    "BytesIO": "IO",  # "BufferedIOBase, BinaryIO",  # based on Stdlib
     "BufferedWriter": "IOBase",  # DOCME: not in documentation #   "BufferedWriter": "BufferedIOBase",  # based on Stdlib
     # uzlib
     # "DecompIO": "IO",  # https://docs.python.org/3/library/typing.html#other-concrete-types

stubber/rst/reader.py

@@ -63,7 +63,6 @@ Note: black on python 3.7 does not like some function defs
 
 """
 
-
 import re
 from pathlib import Path
 from typing import List, Optional, Tuple
@@ -150,11 +149,7 @@ class FileReadWriter:
         """
         append = 0
         newline = self.rst_text[self.line_no]
-        while (
-            not self.is_balanced(newline)
-            and self.line_no >= 0
-            and (self.line_no + append + 1) <= self.max_line
-        ):
+        while not self.is_balanced(newline) and self.line_no >= 0 and (self.line_no + append + 1) <= self.max_line:
             append += 1
             # concat the lines
             newline += self.rst_text[self.line_no + append]
@@ -225,9 +220,7 @@ class RSTReader(FileReadWriter):
         "stop at heading"
         u_line = self.rst_text[min(self.line_no + 1, self.max_line - 1)].rstrip()
         # Heading  ---, ==, ~~~
-        underlined = (
-            u_line.startswith("---") or u_line.startswith("===") or u_line.startswith("~~~")
-        )
+        underlined = u_line.startswith("---") or u_line.startswith("===") or u_line.startswith("~~~")
         if underlined and self.line_no > 0:
             # check if previous line is a heading
             line = self.rst_text[self.line_no].strip()
@@ -374,12 +367,8 @@ class RSTParser(RSTReader):
     target = ".py"  # py/pyi
     # TODO: Move to lookup.py
     PARAM_RE_FIXES = [
-        Fix(
-            r"\[angle, time=0\]", "[angle], time=0", is_re=True
-        ),  # fix: method:: Servo.angle([angle, time=0])
-        Fix(
-            r"\[speed, time=0\]", "[speed], time=0", is_re=True
-        ),  # fix: .. method:: Servo.speed([speed, time=0])
+        Fix(r"\[angle, time=0\]", "[angle], time=0", is_re=True),  # fix: method:: Servo.angle([angle, time=0])
+        Fix(r"\[speed, time=0\]", "[speed], time=0", is_re=True),  # fix: .. method:: Servo.speed([speed, time=0])
         Fix(
             r"\[service_id, key=None, \*, \.\.\.\]", "[service_id], [key], *, ...", is_re=True
         ),  # fix: network - AbstractNIC.connect
@@ -446,9 +435,7 @@ class RSTParser(RSTReader):
     def apply_fix(fix: Fix, params: str, name: str = ""):
         if fix.name and fix.name != name:
             return params
-        return (
-            re.sub(fix.from_, fix.to, params) if fix.is_re else params.replace(fix.from_, fix.to)
-        )
+        return re.sub(fix.from_, fix.to, params) if fix.is_re else params.replace(fix.from_, fix.to)
 
     def create_update_class(self, name: str, params: str, docstr: List[str]):
         # a bit of a hack: assume no classes in classes  or functions in function
@@ -509,12 +496,10 @@ class RSTParser(RSTReader):
             if "nightly" in self.source_tag:
                 version = V_PREVIEW
             else:
-                version = self.source_tag.replace(
-                    "_", "."
-                )  # TODO Use clean_version(self.source_tag)
-            docstr[
-                0
-            ] = f"{docstr[0]}.\n\nMicroPython module: https://docs.micropython.org/en/{version}/library/{module_name}.html"
+                version = self.source_tag.replace("_", ".")  # TODO Use clean_version(self.source_tag)
+            docstr[0] = (
+                f"{docstr[0]}.\n\nMicroPython module: https://docs.micropython.org/en/{version}/library/{module_name}.html"
+            )
 
         self.output_dict.name = module_name
         self.output_dict.add_comment(f"# source version: {self.source_tag}")
@@ -546,9 +531,7 @@ class RSTParser(RSTReader):
 
         for this_function in function_names:
             # Parse return type from docstring
-            ret_type = return_type_from_context(
-                docstring=docstr, signature=this_function, module=self.current_module
-            )
+            ret_type = return_type_from_context(docstring=docstr, signature=this_function, module=self.current_module)
 
             # defaults
             name = params = ""
@@ -663,6 +646,8 @@ class RSTParser(RSTReader):
             #   - staticmethod          (       <params>) -> <ret_type>:
             #   - all other methods     (self,  <params>) -> <ret_type>:
             if name == "__init__":
+                # avoid params starting with `self ,`
+                params = self.lstrip_self(params)
                 method = FunctionSourceDict(
                     name=f"def {name}",
                     indent=parent_class.indent + 4,
@@ -688,6 +673,8 @@ class RSTParser(RSTReader):
                     is_async=is_async,
                 )
             else:  # just plain method
+                # avoid params starting with `self ,`
+                params = self.lstrip_self(params)
                 method = FunctionSourceDict(
                     name=f"def {name}",
                     indent=parent_class.indent + 4,
@@ -695,8 +682,20 @@ class RSTParser(RSTReader):
                     docstr=docstr,
                     is_async=is_async,
                 )
+
             parent_class += method
 
+    def lstrip_self(self, params):
+        """
+        To avoid duplicate selfs,
+        Remove `self,` from the start of the parameters
+        """
+        if params.startswith("self,"):
+            params = params[6:]
+        elif params.startswith("self ,"):
+            params = params[7:]
+        return params
+
     def parse_exception(self):
         log.trace(f"# {self.line.rstrip()}")
         name = self.line.split(SEPERATOR)[1].strip()

stubber/update_module_list.py

@@ -10,8 +10,6 @@ for this :
 - write updates to:
     - board/modulelist.txt
     - board/createstubs.py 
-
-- TODO: remove the frozen modules from this list
 """
 
 from pathlib import Path