Additional cleanups/fixes

Author: johnslavik

docs/reference/api/cli.md

@@ -4,10 +4,10 @@
 
 ::: griffecli.main
 
-::: griffe.check
+::: griffecli.check
 
-::: griffe.dump
+::: griffecli.dump
 
 ## **Advanced API**
 
-::: griffe.get_parser
+::: griffecli.get_parser

duties.py

@@ -24,7 +24,7 @@
     from duty.context import Context
 
 
-PY_SRC_PATHS = (Path(_) for _ in ("src", "tests", "duties.py", "scripts"))
+PY_SRC_PATHS = (Path(_) for _ in ("packages/griffecli/src", "packages/griffelib/src", "tests", "duties.py", "scripts"))
 PY_SRC_LIST = tuple(str(_) for _ in PY_SRC_PATHS)
 PY_SRC = " ".join(PY_SRC_LIST)
 CI = os.environ.get("CI", "0") in {"1", "true", "yes", ""}
@@ -287,7 +287,20 @@ def check_api(ctx: Context, *cli_args: str) -> None:
     ctx.run(
         tools.griffe.check(
             "griffe",
-            search=["src"],
+            search=["packages/griffelib/src"],
+            color=True,
+            extensions=[
+                "griffe_inherited_docstrings",
+                "unpack_typeddict",
+            ],
+        ).add_args(*cli_args),
+        title="Checking for API breaking changes",
+        nofail=True,
+    )
+    ctx.run(
+        tools.griffe.check(
+            "griffecli",
+            search=["packages/griffecli/src"],
             color=True,
             extensions=[
                 "griffe_inherited_docstrings",

packages/griffelib/src/griffe/__init__.py

@@ -601,14 +601,9 @@
     "main",
 ]
 
-try:
-    from griffecli._internal.cli import DEFAULT_LOG_LEVEL, check, dump, get_parser, main
-except ImportError:
-    def __getattr__(attr: str) -> object:
-        if attr in __cli_all__:
-            import griffecli._internal.cli as griffecli_mod
-            return getattr(griffecli_mod, attr)
-        raise AttributeError(attr)
-
-else:
-    __all__.extend(__cli_all__)
+__all__ += __cli_all__
+
+def __getattr__(attr: str) -> object:
+    if attr in __cli_all__:
+        raise ImportError(f'Install `griffecli` to use {"griffe." + attr!r}')
+    raise AttributeError(attr)

packages/griffelib/src/griffe/__main__.py

@@ -10,11 +10,11 @@
 
 try:
     from griffecli import main
-except ModuleNotFoundError:
-    raise ImportError(
-        "`griffecli` is not installed. Install `griffecli` "
-        "to use `python -m griffe`."
-    )
+except ModuleNotFoundError as exc:
+    raise ModuleNotFoundError(
+        "`griffecli` or its dependencies are not installed. "
+        "Install `griffecli` to use `python -m griffe`.",
+    ) from exc
 
 if __name__ == "__main__":
     sys.exit(main(sys.argv[1:]))

packages/griffelib/src/griffe/_internal/finder.py

@@ -508,7 +508,7 @@ def _handle_editable_module(path: Path) -> list[_SP]:
                 and node.value.func.id == "install"
                 and isinstance(node.value.args[1], ast.Constant)
             ):
-                build_path = Path(node.value.args[1].value, "src")  # type: ignore[arg-type]
+                build_path = Path(node.value.args[1].value, "packages/griffelib/src")  # type: ignore[arg-type]
                 # NOTE: What if there are multiple packages?
                 pkg_name = next(build_path.iterdir()).name
                 return [_SP(build_path, always_scan_for=pkg_name)]

tests/test_api.py

@@ -140,7 +140,7 @@ def _public_path(obj: griffe.Object | griffe.Alias) -> bool:
         return obj.is_public and (obj.parent is None or _public_path(obj.parent))
 
     multiple_locations = {}
-    for obj_name in griffe.__all__:
+    for obj_name in set(griffe.__all__) - set(griffe.__cli_all__):
         obj = public_api[obj_name]
         if obj.aliases and (
             public_aliases := [path for path, alias in obj.aliases.items() if path != obj.path and _public_path(alias)]

tests/test_finder.py

@@ -125,9 +125,9 @@ def test_editables_file_handling(tmp_path: Path, editable_file_name: str) -> Non
         tmp_path: Pytest fixture.
     """
     pth_file = tmp_path / editable_file_name
-    pth_file.write_text("hello\nF.map_module('griffe', 'src/griffe/__init__.py')", encoding="utf8")
+    pth_file.write_text("hello\nF.map_module('griffe', 'packages/griffelib/src/griffe/__init__.py')", encoding="utf8")
     paths = [sp.path for sp in _handle_editable_module(pth_file)]
-    assert paths == [Path("src")]
+    assert paths == [Path("packages/griffelib/src")]
 
 
 @pytest.mark.parametrize("annotation", ["", ": dict[str, str]"])
@@ -197,7 +197,7 @@ def test_meson_python_file_handling(tmp_path: Path) -> None:
     search_paths = _handle_editable_module(pth_file)
     assert all(sp.always_scan_for == "griffe" for sp in search_paths)
     paths = [sp.path for sp in search_paths]
-    assert paths == [Path("src")]
+    assert paths == [Path("packages/griffelib/src")]
 
 
 @pytest.mark.parametrize(