stubber: Simplify config to use repo-path = "./repos"

Author: Josverl

src/stubber/commands/clone_cmd.py

@@ -31,16 +31,16 @@ def cli_clone(path: Union[str, Path], stubs: bool = False):
     dest_path = Path(path)
     if not dest_path.exists():
         os.mkdir(dest_path)
-    # repos are relative to provided path
-    if dest_path != CONFIG.repo_path:
+    if dest_path == CONFIG.repo_path:
+        # same as default
+        mpy_path = CONFIG.mpy_path
+        mpy_lib_path = CONFIG.mpy_lib_path
+        mpy_stubs_path = CONFIG.mpy_stubs_path
+    else:
+        # repos are relative to provided path
         mpy_path = dest_path / "micropython"
         mpy_lib_path = dest_path / "micropython-lib"
         mpy_stubs_path = dest_path / "micropython-stubs"
-    else:
-        mpy_path = CONFIG.mpy_path
-        mpy_lib_path = CONFIG.mpy_lib_path
-
-        mpy_stubs_path = CONFIG.stub_path.parent
 
     repos: List[Tuple[Path, str, str]] = [
         (mpy_path, "https://github.com/micropython/micropython.git", "master"),

src/stubber/commands/config_cmd.py

@@ -1,7 +1,9 @@
 """Show the current configuration"""
+
 # pragma: no cover
 
 from loguru import logger as log
+
 from stubber.utils.config import CONFIG
 
 from .cli import stubber_cli
@@ -20,6 +22,7 @@ def cli_config():
     log.info(f"CONFIG.repo_path           {CONFIG.repo_path}")
     log.info(f"CONFIG.mpy_path            {CONFIG.mpy_path}")
     log.info(f"CONFIG.mpy_lib_path        {CONFIG.mpy_lib_path}")
+    log.info(f"CONFIG.mpy_stubs_path      {CONFIG.mpy_stubs_path}")
 
     log.info(f"CONFIG.stub_path           {CONFIG.stub_path}")
     log.info(f"CONFIG.publish_path        {CONFIG.publish_path}")

src/stubber/utils/config.py

@@ -15,8 +15,10 @@
 @section("micropython-stubber")
 class StubberConfig(Config):
     "stubber configuration class"
-    stub_path = key(key_name="stub-path", cast=Path, required=False, default=Path("./stubs"))
-    "a Path to the stubs directory"
+    # legacy
+    # stub_path = key(key_name="stub-path", cast=Path, required=False, default=Path("./stubs"))
+    # "a Path to the stubs directory"
+
     # relative to stubs folder
     fallback_path = key(key_name="fallback-path", cast=Path, required=False, default=Path("typings/fallback"))
     "a Path to the fallback stubs directory"
@@ -32,24 +34,8 @@ class StubberConfig(Config):
     mpy_lib_path = key(key_name="mpy-lib-path", cast=Path, required=False, default=Path("micropython-lib"))
     "a Path to the micropython-lib folder in the repos directory"
 
-    # mpy_stubs_repo_path = key(key_name="mpy-stubs-repo-path", cast=Path, required=False, default=Path("./micropython-stubs"))
-    # "a Path to the micropython-stubs folder in the repos directory"
-
-    publish_path = key(
-        key_name="publish-path",
-        cast=Path,
-        required=False,
-        default=Path("./repos/micropython-stubs/publish"),
-    )
-    "A Path to the folder where all stub publication artifacts are stored"
-
-    template_path = key(
-        key_name="template-path",
-        cast=Path,
-        required=False,
-        default=Path("./repos/micropython-stubs/publish/template"),
-    )
-    "a Path to the publication folder that has the template files"
+    mpy_stubs_path = key(key_name="mpy-stubs-path", cast=Path, required=False, default=Path("micropython-stubs"))
+    "a Path to the micropython-stubs folder in the repos directory (or current directory)"
 
     stable_version = key(key_name="stable-version", cast=str, required=False, default="1.20.0")
 
@@ -66,25 +52,33 @@ class StubberConfig(Config):
     BLOCKED_PORTS = ["minimal", "bare-arm"]
     "ports that should be ignored as a source of stubs"
 
-    # def __init__(self):
-    #     super().__init__()
-    #     self.update_versions()
+    @property
+    def stub_path(self) -> Path:
+        "return the stubs path in the microypthon-stubs repo"
+        return self.mpy_stubs_path / "stubs"
+
+    @property
+    def publish_path(self) -> Path:
+        "return the stubs path in the microypthon-stubs repo"
+        return self.mpy_stubs_path / "publish"
 
-    # def update_versions(self):
-    #     try:
-    #         self.ALL_VERSIONS = git.get_tags(self.mpy_path, minver="v1.17")
-    #     except Exception:
-    #         self.ALL_VERSIONS = ["1.17", "1.18", "1.19", "1.19.1"]
-    #     self.STABLE_VERSION = self.ALL_VERSIONS[-1]
+    @property
+    def template_path(self) -> Path:
+        "return the stubs path in the microypthon-stubs repo"
+        return self.mpy_stubs_path / "publish" / "template"
 
     def post_read_hook(self) -> dict:
         config_updates = {}
         # relative to stubs
-        config_updates.update(fallback_path=self.stub_path / self.fallback_path)
+        # config_updates.update(fallback_path=self.stub_path / self.fallback_path)
 
         # relative to repo path
         config_updates.update(mpy_path=self.repo_path / self.mpy_path)
         config_updates.update(mpy_lib_path=self.repo_path / self.mpy_lib_path)
+        if self.mpy_stubs_path.is_absolute() or self.mpy_stubs_path == Path("."):
+            config_updates.update(mpy_stubs_path=self.mpy_stubs_path)
+        else:
+            config_updates.update(mpy_stubs_path=self.repo_path / self.mpy_stubs_path)
         # read the versions from the git tags
         all_versions = []
         try:

src/stubber/utils/repos.py

@@ -107,9 +107,9 @@ def fetch_repos(tag: str, mpy_path: Path, mpy_lib_path: Path):
     git.fetch(mpy_path)
     git.fetch(mpy_lib_path)
     try:
-        git.fetch(CONFIG.stub_path.parent)
+        git.fetch(CONFIG.mpy_stubs_path)
     except Exception:
-        log.trace("no stubs repo found : {CONFIG.stub_path.parent}")
+        log.trace("no stubs repo found : {CONFIG.mpy_stubs_path}")
 
     if not tag:
         tag = V_PREVIEW

tests/common/config_test.py

@@ -1,10 +1,13 @@
+import os
 from pathlib import Path
 
 import pytest
+
 from stubber.utils.config import StubberConfig, TomlConfigSource, readconfig
 
 pytestmark = [pytest.mark.stubber]
 
+
 def test_toplevel_config():
     # exists on top-level
     from stubber.utils.config import CONFIG
@@ -47,8 +50,44 @@ def test_config():
     assert isinstance(config.mpy_path, Path)
     assert isinstance(config.mpy_lib_path, Path)
 
-    assert config.stub_path == Path("./my-stubs")
     assert config.repo_path == Path("./my-repos")
     assert config.mpy_path == Path("./my-repos/micropython")
+    assert config.mpy_lib_path == Path("./my-repos/micropython-lib")
+    assert config.mpy_stubs_path == Path("./my-repos/micropython-stubs")
     # TODO Make sure this is relative to the stubs repo
+    assert config.stub_path == Path("./my-repos/micropython-stubs/stubs")
+    assert config.publish_path == Path("./my-repos/micropython-stubs/publish")
+
+
+def test_config_stubs_repo():
+    # test config used in the stubs repo
+    config = readconfig(filename="tests/data/stubs_repo.toml", prefix="tool.", must_exist=True)
+    assert config.repo_path == Path("./repos")
+    assert config.mpy_path == Path("./repos/micropython")
+    assert config.mpy_lib_path == Path("./repos/micropython-lib")
+
+    assert config.mpy_stubs_path == Path(".")
+    assert config.stub_path == Path("./stubs")
+    assert config.publish_path == Path("./publish")
+
+
+@pytest.fixture
+def change_test_dir(request):
+    """Change the working directory to the test directory, and back after the test."""
+    os.chdir(request.fspath.dirname)
+    try:
+        yield
+    finally:
+        os.chdir(request.config.invocation_params.dir)
+
+
+def test_config_no_config(change_test_dir, tmp_path: Path):
+    # there will be no config file in the test directory
+    os.chdir(tmp_path)
+    config = readconfig()
+    assert config.repo_path == Path("./repos")
+    assert config.mpy_path == Path("./repos/micropython")
+    assert config.mpy_lib_path == Path("./repos/micropython-lib")
+    assert config.mpy_stubs_path == Path("./repos/micropython-stubs")
+
     assert config.publish_path == Path("./repos/micropython-stubs/publish")

tests/data/stubs_repo.toml

@@ -0,0 +1,7 @@
+# stripped pyproject toml file used for testing
+# same config used in the stubber repo
+[tool.micropython-stubber]
+"mpy-stubs-path" = "."
+
+
+

tests/data/test.toml

@@ -1,31 +1,6 @@
 # stripped pyproject toml file used for testing
 
 [tool.micropython-stubber]
-stub-path = "./my-stubs"
 repo-path = "./my-repos"
 
-[tool.poetry.scripts]
-stubber = "stubber.stubber:stubber_cli"
-pyboard = "stubber.tools.pyboard:main"
 
-[build-system]
-requires = ["poetry-core>=1.0.0"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.black]
-# use long lines to avoid _log lines from wrapping , as this causes issues with the minification.
-line-length = 140
-target_version = ['py38']
-include = '\.pyi?$'
-exclude = '''
-(
-    /(
-        | \..*
-        | minified
-        | micropython
-        | micropython-lib
-        | tests[\\/]mocks
-        | scratch
-    )/
-)
-'''