mpflash 0.9.1__py3-none-any.whl → 0.9.1.post2__py3-none-any.whl

mpflash/basicgit.py

@@ -0,0 +1,284 @@
+"""
+Simple Git module, where needed via powershell
+
+Some of the functions are based on the PyGithub module
+"""
+
+import os
+import subprocess
+from pathlib import Path
+from typing import List, Optional, Union
+
+import cachetools.func
+from github import Auth, Github
+from loguru import logger as log
+from packaging.version import parse
+
+# from mpflash.versions import SET_PREVIEW
+
+# Token with no permissions to avoid throttling
+# https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api?apiVersion=2022-11-28#getting-a-higher-rate-limit
+PAT_NO_ACCESS = "github_pat" + "_11AAHPVFQ0qAkDnSUaMKSp" + "_ZkDl5NRRwBsUN6EYg9ahp1Dvj4FDDONnXVgimxC2EtpY7Q7BUKBoQ0Jq72X"
+PAT = os.environ.get("GITHUB_TOKEN") or PAT_NO_ACCESS
+GH_CLIENT = Github(auth=Auth.Token(PAT))
+
+
+def _run_local_git(
+    cmd: List[str],
+    repo: Optional[Union[Path, str]] = None,
+    expect_stderr=False,
+    capture_output=True,
+    echo_output=True,
+):
+    "run a external (git) command in the repo's folder and deal with some of the errors"
+    try:
+        if repo:
+            if isinstance(repo, str):
+                repo = Path(repo)
+            result = subprocess.run(cmd, capture_output=capture_output, check=True, cwd=repo.absolute().as_posix(), encoding="utf-8")
+        else:
+            result = subprocess.run(cmd, capture_output=capture_output, check=True, encoding="utf-8")
+    except (NotADirectoryError, FileNotFoundError) as e:  # pragma: no cover
+        return None
+    except subprocess.CalledProcessError as e:  # pragma: no cover
+        # add some logging for github actions
+        log.error(f"{str(e)} : { e.stderr}")
+        return None
+    if result.stderr and result.stderr != b"":
+        stderr = result.stderr
+        if "cloning into" in stderr.lower():
+            # log.info(stderr)
+            expect_stderr = True
+        if "warning" in stderr.lower():
+            log.warning(stderr)
+            expect_stderr = True
+        elif capture_output and echo_output:  # pragma: no cover
+            log.info(stderr)
+        if not expect_stderr:
+            raise ChildProcessError(stderr)
+
+    if result.returncode and result.returncode < 0:
+        raise ChildProcessError(result.stderr)
+    return result
+
+
+def clone(remote_repo: str, path: Path, shallow: bool = False, tag: Optional[str] = None) -> bool:
+    """git clone [--depth 1] [--branch <tag_name>] <remote> <directory>"""
+    cmd = ["git", "clone"]
+    if shallow:
+        cmd += ["--depth", "1"]
+    if tag in {"preview", "latest", "master"}:
+        tag = None
+    cmd += [remote_repo, "--branch", tag, str(path)] if tag else [remote_repo, str(path)]
+    if result := _run_local_git(cmd, expect_stderr=True, capture_output=False):
+        return result.returncode == 0
+    else:
+        return False
+
+
+def get_local_tag(repo: Optional[Union[str, Path]] = None, abbreviate: bool = True) -> Union[str, None]:
+    """
+    get the most recent git version tag of a local repo
+    repo Path should be in the form of : repo = "./repo/micropython"
+
+    returns the tag or None
+    """
+    if not repo:
+        repo = Path(".")
+    elif isinstance(repo, str):
+        repo = Path(repo)
+
+    result = _run_local_git(
+        # ["git", "describe", "--tags"],
+        ["git", "describe", "--tags", "--dirty", "--always", "--match", "v[1-9].*"],
+        repo=repo.as_posix(),
+        expect_stderr=True,
+    )
+    if not result:
+        return None
+    tag: str = result.stdout
+    tag = tag.replace("\r", "").replace("\n", "")
+    if not abbreviate or "-" not in tag:
+        return tag
+    if "-preview" in tag:
+        tag = tag.split("-preview")[0] + "-preview"
+    return tag
+
+
+def get_local_tags(repo: Optional[Path] = None, minver: Optional[str] = None) -> List[str]:
+    """
+    get list of all tags of a local repo
+    """
+    if not repo:
+        repo = Path(".")
+
+    result = _run_local_git(["git", "tag", "-l"], repo=repo.as_posix(), expect_stderr=True)
+    if not result or result.returncode != 0:
+        return []
+    tags = result.stdout.replace("\r", "").split("\n")
+    tags = [tag for tag in tags if tag.startswith("v")]
+    if minver:
+        tags = [tag for tag in tags if parse(tag) >= parse(minver)]
+    return sorted(tags)
+
+
+@cachetools.func.ttl_cache(maxsize=16, ttl=60)  # 60 seconds
+def get_tags(repo: str, minver: Optional[str] = None) -> List[str]:
+    """
+    Get list of tag of a repote github repo
+    """
+    if not repo or not isinstance(repo, str) or "/" not in repo:  # type: ignore
+        return []
+    try:
+        gh_repo = GH_CLIENT.get_repo(repo)
+    except ConnectionError as e:
+        # TODO: unable to capture the exeption
+        log.warning(f"Unable to get tags - {e}")
+        return []
+    tags = [tag.name for tag in gh_repo.get_tags()]
+    if minver:
+        tags = [tag for tag in tags if parse(tag) >= parse(minver)]
+    return sorted(tags)
+
+
+def checkout_tag(tag: str, repo: Optional[Union[str, Path]] = None) -> bool:
+    """
+    checkout a specific git tag
+    """
+    cmd = ["git", "checkout", tag, "--quiet", "--force"]
+    result = _run_local_git(cmd, repo=repo, expect_stderr=True, capture_output=True)
+    if not result:
+        return False
+    # actually a good result
+    msg = {result.stdout}
+    if msg != {""}:
+        log.warning(f"git message: {msg}")
+    return True
+
+
+def sync_submodules(repo: Optional[Union[Path, str]] = None) -> bool:
+    """
+    make sure any submodules are in sync
+    """
+    cmds = [
+        ["git", "submodule", "sync", "--quiet"],
+        # ["git", "submodule", "update", "--quiet"],
+        ["git", "submodule", "update", "--init", "lib/micropython-lib"],
+    ]
+    for cmd in cmds:
+        if result := _run_local_git(cmd, repo=repo, expect_stderr=True):
+            # actually a good result
+            log.debug(result.stderr)
+        else:
+            return False
+    return True
+
+
+def checkout_commit(commit_hash: str, repo: Optional[Union[Path, str]] = None) -> bool:
+    """
+    Checkout a specific commit
+    """
+    cmd = ["git", "checkout", commit_hash, "--quiet", "--force"]
+    result = _run_local_git(cmd, repo=repo, expect_stderr=True)
+    if not result:
+        return False
+    # actually a good result
+    log.debug(result.stderr)
+    return True
+
+
+def switch_tag(tag: Union[str, Path], repo: Optional[Union[Path, str]] = None) -> bool:
+    """
+    switch to the specified version tag of a local repo
+    repo should be in the form of : path/.git
+    repo = '../micropython/.git'
+    returns None
+    """
+
+    cmd = ["git", "switch", "--detach", tag, "--quiet", "--force"]
+    result = _run_local_git(cmd, repo=repo, expect_stderr=True)
+    if not result:
+        return False
+    # actually a good result
+    log.debug(result.stderr)
+    return True
+
+
+def switch_branch(branch: str, repo: Optional[Union[Path, str]] = None) -> bool:
+    """
+    switch to the specified branch in a local repo"
+    repo should be in the form of : path/.git
+    repo = '../micropython/.git'
+    returns None
+    """
+    cmd = ["git", "switch", branch, "--quiet", "--force"]
+    result = _run_local_git(cmd, repo=repo, expect_stderr=True)
+    if not result:
+        return False
+    # actually a good result
+    log.debug(result.stderr)
+    return True
+
+
+def fetch(repo: Union[Path, str]) -> bool:
+    """
+    fetches a repo
+    repo should be in the form of : path/.git
+    repo = '../micropython/.git'
+    returns True on success
+    """
+    if not repo:
+        raise NotADirectoryError
+
+    cmd = ["git", "fetch", "--all", "--tags", "--quiet"]
+    result = _run_local_git(cmd, repo=repo, echo_output=False)
+    return result.returncode == 0 if result else False
+
+
+def pull(repo: Union[Path, str], branch: str = "main") -> bool:
+    """
+    pull a repo origin into main
+    repo should be in the form of : path/.git
+    repo = '../micropython/.git'
+    returns True on success
+    """
+    if not repo:
+        raise NotADirectoryError
+    repo = Path(repo)
+    # first checkout HEAD
+    cmd = ["git", "checkout", branch, "--quiet", "--force"]
+    result = _run_local_git(cmd, repo=repo, expect_stderr=True)
+    if not result:
+        log.error("error during git checkout main", result)
+        return False
+
+    cmd = ["git", "pull", "origin", branch, "--quiet", "--autostash"]
+    result = _run_local_git(cmd, repo=repo, expect_stderr=True)
+    if not result:
+        log.error("error durign pull", result)
+        return False
+    return result.returncode == 0
+
+
+def get_git_describe(folder: Optional[str] = None):
+    """
+    Based on MicroPython makeversionhdr.py
+    returns : current git tag, commits ,commit hash : "v1.19.1-841-g3446"
+    """
+    # Note: git describe doesn't work if no tag is available
+    try:
+        git_describe = subprocess.check_output(
+            ["git", "describe", "--tags", "--dirty", "--always", "--match", "v[1-9].*"],
+            stderr=subprocess.STDOUT,
+            universal_newlines=True,
+            cwd=folder,
+        ).strip()
+    except subprocess.CalledProcessError as er:
+        if er.returncode == 128:
+            # git exit code of 128 means no repository found
+            return None
+        git_describe = ""
+    except OSError:
+        return None
+    # format
+    return git_describe

mpflash/flash/worklist.py

@@ -6,12 +6,11 @@ from typing import Dict, List, Optional, Tuple
 from loguru import logger as log
 
 from mpflash.common import FWInfo, filtered_comports
+from mpflash.downloaded import find_downloaded_firmware
 from mpflash.errors import MPFlashError
-
-from ..downloaded import find_downloaded_firmware
-from ..list import show_mcus
-from ..mpboard_id import find_known_board
-from ..mpremoteboard import MPRemoteBoard
+from mpflash.list import show_mcus
+from mpflash.mpboard_id import find_known_board
+from mpflash.mpremoteboard import MPRemoteBoard
 
 # #########################################################################################################
 WorkList = List[Tuple[MPRemoteBoard, FWInfo]]
@@ -41,9 +40,7 @@ def auto_update(
     wl: WorkList = []
     for mcu in conn_boards:
         if mcu.family not in ("micropython", "unknown"):
-            log.warning(
-                f"Skipping flashing {mcu.family} {mcu.port} {mcu.board} on {mcu.serialport} as it is not a MicroPython firmware"
-            )
+            log.warning(f"Skipping flashing {mcu.family} {mcu.port} {mcu.board} on {mcu.serialport} as it is not a MicroPython firmware")
             continue
         board_firmwares = find_downloaded_firmware(
             fw_folder=fw_folder,

mpflash/mpboard_id/add_boards.py

@@ -12,7 +12,7 @@ import rich.table
 from rich.console import Console
 from rich.progress import track
 
-import basicgit as git
+import mpflash.basicgit as git
 from mpflash.logger import log
 from mpflash.mpboard_id import Board
 from mpflash.mpboard_id.store import write_boardinfo_json
@@ -222,11 +222,7 @@ def make_table(board_list: List[Board]) -> rich.table.Table:
 
 def ask_mpy_path():
     """Ask the user for the path to the MicroPython repository."""
-    questions = [
-        inquirer.Text(
-            "mpy_path", message="Enter the path to the MicroPython repository", default=".\\repos\\micropython"
-        )
-    ]
+    questions = [inquirer.Text("mpy_path", message="Enter the path to the MicroPython repository", default=".\\repos\\micropython")]
     if answers := inquirer.prompt(questions):
         return Path(answers["mpy_path"])
     else:

mpflash/versions.py

@@ -4,10 +4,13 @@
 #############################################################
 """
 
-from cache_to_disk import cache_to_disk, NoCacheCondition
+from pathlib import Path
+
+from cache_to_disk import NoCacheCondition, cache_to_disk
 from loguru import logger as log
 from packaging.version import parse
 
+import mpflash.basicgit as git
 from mpflash.common import GH_CLIENT
 
 OLDEST_VERSION = "1.16"
@@ -27,7 +30,7 @@ def clean_version(
     commit: bool = False,
     drop_v: bool = False,
     flat: bool = False,
-):
+):  # sourcery skip: assign-if-exp
     "Clean up and transform the many flavours of versions"
     # 'v1.13.0-103-gb137d064e' --> 'v1.13-103'
     if version in {"", "-"}:
@@ -48,14 +51,12 @@ def clean_version(
     if len(nibbles) == 1:
         version = nibbles[0]
     elif build and not is_preview:
+        # HACK: this is not always right, but good enough most of the time
         version = "-".join(nibbles) if commit else "-".join(nibbles[:-1])
+    elif is_preview:
+        version = "-".join((nibbles[0], V_PREVIEW))
     else:
-        # version = "-".join((nibbles[0], LATEST))
-        # HACK: this is not always right, but good enough most of the time
-        if is_preview:
-            version = "-".join((nibbles[0], V_PREVIEW))
-        else:
-            version = V_PREVIEW
+        version = V_PREVIEW
     if flat:
         version = version.strip().replace(".", "_").replace("-", "_")
     else:
@@ -122,3 +123,13 @@ def get_preview_mp_version() -> str:
     # read the versions from the git tags
     all_versions = micropython_versions(minver=OLDEST_VERSION)
     return [v for v in all_versions if v.endswith(V_PREVIEW)][-1]
+
+
+# Do not cache , same path will have different versions checked out
+def checkedout_version(path: Path, flat: bool = False) -> str:
+    """Get the checked-out version of the repo"""
+    version = git.get_local_tag(path.as_posix())
+    if not version:
+        raise ValueError("No valid Tag found")
+    version = clean_version(version, flat=flat, drop_v=False)
+    return version

{mpflash-0.9.1.dist-info → mpflash-0.9.1.post2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mpflash
-Version: 0.9.1
+Version: 0.9.1.post2
 Summary: Flash and download tool for MicroPython firmwares
 Home-page: https://github.com/Josverl/micropython-stubber/blob/main/src/mpflash/README.md
 License: MIT

{mpflash-0.9.1.dist-info → mpflash-0.9.1.post2.dist-info}/RECORD

@@ -1,6 +1,7 @@
 mpflash/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mpflash/add_firmware.py,sha256=h-Nu9AnXO6ug2CurmgLoUVG1gNy6CA1NjwQl1nUoMZ4,3330
 mpflash/ask_input.py,sha256=EsPPlPS_wLC8j9f4o68yKIcqex0dV5tRH7k3rP3spG0,8710
+mpflash/basicgit.py,sha256=r_bI2U6QYFiS8ypUd6KtrjyZjK4JCANyK80L6wEzFoU,9213
 mpflash/bootloader/__init__.py,sha256=cRIxVRtUc4jZAgtFggRNhEn0BW-9WFpzm5xRy5B4B2U,105
 mpflash/bootloader/activate.py,sha256=sN2YuIuFGjLBd_PdG6P3N1yLuLyjnsVWDksrTMhzr_M,2301
 mpflash/bootloader/detect.py,sha256=eXL_JPcowb8g0tpZmj9DQXYbpfZFoSrzq86lScKhkT4,2608
@@ -28,11 +29,11 @@ mpflash/flash/uf2/linux.py,sha256=4azbcx_YqLZ3RyYNWljejHG_Y6SU-wREL8hhkTYqCjI,40
 mpflash/flash/uf2/macos.py,sha256=sncXJsc2FVfm9rvLDjcEu7ZIyrDeHmazHiNQTUaf1Y0,1187
 mpflash/flash/uf2/uf2disk.py,sha256=dQ8_U6e3qkFOyfXZDpWAsvEBIlMr-ZzLkzTDD8SADqM,286
 mpflash/flash/uf2/windows.py,sha256=k9Yv71YswPnLx-Z5rf4KjhtVkEWr8SU8EXpeRv87h3A,1290
-mpflash/flash/worklist.py,sha256=K16sbvzJCgkHNssYlBA3ezayI02RMuIcp19XAs74XeQ,5835
+mpflash/flash/worklist.py,sha256=1uBvn-T35Oey04g6xxNxo5t68q5_tp18eZcRAamF0tY,5828
 mpflash/list.py,sha256=O0tX4BvclmDMnnjMxCN9Zh8hdL6vnuvS9pLNxYLBya8,3112
 mpflash/logger.py,sha256=BAVrSXMGZLfSDRFbtVBtvb7Rl0sTJxooCgBS5t-6bXo,1057
 mpflash/mpboard_id/__init__.py,sha256=rQrPCN30GP-lfB2a2deA-lQ6iKvaKPK_xbtBoIavGsM,3716
-mpflash/mpboard_id/add_boards.py,sha256=0tP-4Ibc5_BBTQx1oBFXmKo80n31BrW6E5KrWKpP2FU,9407
+mpflash/mpboard_id/add_boards.py,sha256=ehQn560S0XxAD3nsUMo4o_f6w8XTVAfO0GCnfTKa6-4,9379
 mpflash/mpboard_id/board.py,sha256=yQ8IDHQS09AelvTvmPhpmsL4oX3L7IXGqHorkxDOkoE,1114
 mpflash/mpboard_id/board_id.py,sha256=wzGrxJu_ciOVT7n2861lhoKmPAjh1QjWnAdfcqNUUqc,2871
 mpflash/mpboard_id/board_info.zip,sha256=F6YowS96DAqjten4ySe4MXgZwPtE-saZOUfY5OQkqKk,19759
@@ -44,9 +45,9 @@ mpflash/vendor/click_aliases.py,sha256=K98inhtze8td1dw312kexJS7OX_0ojlptPQ5Z0SHx
 mpflash/vendor/dfu.py,sha256=jGsiD3lbSV1Ar9qJubhoY_hy-L8FI-K55aow8vgwoYQ,5590
 mpflash/vendor/pydfu.py,sha256=1ObubGsPFrQ7T9M3JRlIPNIG2xx8uYffaEe0Y6bdf_g,19937
 mpflash/vendor/readme.md,sha256=ZVg7kuUYyXcWcrWkaSJ0CunwebCqu2SiS2sqDadwrT8,84
-mpflash/versions.py,sha256=SrXVZx6qVWcighHlg8pJ0RPRZ3gcYN7l2DnSicconAk,4098
-mpflash-0.9.1.dist-info/LICENSE,sha256=xHwgxGNkI0R2iN4KNfbPbQSzRomWyRz7bJnR1O2mln8,1057
-mpflash-0.9.1.dist-info/METADATA,sha256=81r3-DTSaPrLNwLUdQDjgnFT8WJhC-awFTW1FAC6sXU,16058
-mpflash-0.9.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-mpflash-0.9.1.dist-info/entry_points.txt,sha256=Jk_visOhYOsZIcSP2Ms9hKqfKy1iorR-6dYltSoWCpY,52
-mpflash-0.9.1.dist-info/RECORD,,
+mpflash/versions.py,sha256=x5VrdVfWhZJfH7tZmwu2vVx-mPrK1iunYSpSce9VUXU,4492
+mpflash-0.9.1.post2.dist-info/LICENSE,sha256=xHwgxGNkI0R2iN4KNfbPbQSzRomWyRz7bJnR1O2mln8,1057
+mpflash-0.9.1.post2.dist-info/METADATA,sha256=SFrk166YQmHI5NcNGZYbOmSx9O2D1r9zvG-DxKs26EM,16064
+mpflash-0.9.1.post2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+mpflash-0.9.1.post2.dist-info/entry_points.txt,sha256=Jk_visOhYOsZIcSP2Ms9hKqfKy1iorR-6dYltSoWCpY,52
+mpflash-0.9.1.post2.dist-info/RECORD,,