bakefile 0.0.3__tar.gz → 0.0.4__tar.gz

{bakefile-0.0.3 → bakefile-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bakefile
-Version: 0.0.3
+Version: 0.0.4
 Summary: Add your description here
 Author: Wisaroot Lertthaweedech
 Author-email: Wisaroot Lertthaweedech <l.wisaroot@gmail.com>

{bakefile-0.0.3 → bakefile-0.0.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "bakefile"
-version = "0.0.3"
+version = "0.0.4" # use git tag
 description = "Add your description here"
 readme = "README.md"
 authors = [
@@ -13,7 +13,7 @@ dependencies = [
 ]
 
 [project.scripts]
-bake = "bakefile.cli.bake:app"
+bake = "bakefile.cli.bake:main"
 bakefile = "bakefile.cli.bakefile:app"
 
 [dependency-groups]

bakefile-0.0.4/src/bakefile/__init__.py

@@ -0,0 +1,13 @@
+from importlib.metadata import PackageNotFoundError, version
+
+__all__ = ["__version__"]
+
+
+def _get_version() -> str:
+    try:
+        return version("bakefile")
+    except PackageNotFoundError:
+        return "0.0.0"
+
+
+__version__ = _get_version()

bakefile-0.0.4/src/bakefile/cli/bake/__init__.py

@@ -0,0 +1,3 @@
+from bakefile.cli.bake.main import main
+
+__all__ = ["main"]

bakefile-0.0.4/src/bakefile/cli/bake/main.py

@@ -0,0 +1,127 @@
+import typer
+from typer.main import get_command_from_info
+
+from bakefile import env
+from bakefile.cli.bake.resolve_bakebook import resolve_bakebook
+from bakefile.cli.utils.version import version_callback
+from bakefile.exceptions import BakebookError
+
+from .utils import get_bakebook_args
+
+rich_markup_mode = "rich" if env.should_use_colors() else None
+
+
+bake_app = typer.Typer(
+    add_completion=False,
+    rich_markup_mode=rich_markup_mode,
+)
+
+local_bake_app = typer.Typer(
+    add_completion=False,
+    rich_markup_mode=rich_markup_mode,
+)
+
+
+GET_BAKEBOOK = "get_bakebook"
+
+
+# Common option definitions (reused across callbacks and commands)
+chdir_option = typer.Option(None, "-C", "--chdir", help="Change directory before running")
+file_name_option = typer.Option("bakefile.py", "--file-name", "-f", help="Path to bakefile.py")
+bakebook_name_option = typer.Option(
+    "bakebook", "--book-name", "-b", help="Name of bakebook object to retrieve"
+)
+version_option = typer.Option(
+    False,
+    "--version",
+    help="Show version and exit",
+    callback=version_callback,
+    is_eager=True,
+)
+
+
+def show_help_if_no_command(ctx: typer.Context) -> None:
+    if ctx.invoked_subcommand is None:
+        typer.echo(ctx.get_help())
+
+
+@local_bake_app.callback(
+    invoke_without_command=True,
+)
+def local_bake_app_callback(
+    ctx: typer.Context,
+    _chdir: str = chdir_option,
+    _file_name: str = file_name_option,
+    _bakebook_name: str = bakebook_name_option,
+    _version: bool = version_option,
+):
+    show_help_if_no_command(ctx)
+
+
+@bake_app.callback(
+    invoke_without_command=True,
+)
+def bake_app_callback(
+    ctx: typer.Context,
+    _chdir: str = chdir_option,
+    _file_name: str = file_name_option,
+    _bakebook_name: str = bakebook_name_option,
+    _version: bool = version_option,
+):
+    show_help_if_no_command(ctx)
+
+
+@bake_app.command(
+    name=GET_BAKEBOOK,
+    hidden=True,
+    context_settings={
+        "allow_extra_args": True,
+        "allow_interspersed_args": False,
+        "ignore_unknown_options": True,
+    },
+)
+def get_bakebook(
+    chdir: str = chdir_option,
+    file_name: str = file_name_option,
+    bakebook_name: str = bakebook_name_option,
+):
+    try:
+        return resolve_bakebook(file_name=file_name, bakebook_name=bakebook_name, chdir=chdir)
+    except BakebookError as e:
+        # Print error with context about what values were used
+        context_parts = []
+        context_parts.append(f"chdir={chdir!r}")
+        context_parts.append(f"file_name={file_name!r}")
+        context_parts.append(f"bakebook_name={bakebook_name!r}")
+
+        typer.secho("⚠️  ", fg="yellow", err=True, nl=False)
+        typer.secho(str(e), fg="yellow", bold=True, err=True)
+        if context_parts:
+            typer.secho(f"({', '.join(context_parts)})", fg="yellow", err=True)
+        return None
+
+
+def try_get_local_bake_app() -> typer.Typer | None:
+    args = get_bakebook_args()
+
+    for registered_command in bake_app.registered_commands:
+        if registered_command.name == GET_BAKEBOOK:
+            command = get_command_from_info(
+                registered_command,
+                pretty_exceptions_short=bake_app.pretty_exceptions_short,
+                rich_markup_mode=bake_app.rich_markup_mode,
+            )
+            with command.make_context(info_name=GET_BAKEBOOK, args=args) as ctx:
+                bakebook = command.invoke(ctx)
+                if bakebook is not None:
+                    local_bake_app.add_typer(bakebook)
+                    return local_bake_app
+                return None
+
+
+def main():
+    local_bake_app = try_get_local_bake_app()
+    if local_bake_app is None:
+        bake_app()
+    else:
+        local_bake_app()

bakefile-0.0.4/src/bakefile/cli/bake/resolve_bakebook.py

@@ -0,0 +1,103 @@
+import importlib.util
+import os
+import pathlib
+import sys
+import types
+from typing import Any, TypeVar
+
+import typer
+
+from bakefile.exceptions import BakebookError
+
+T = TypeVar("T")
+
+
+def change_directory(path: str) -> None:
+    if not path or not path.strip():
+        raise BakebookError("Directory path cannot be empty")
+    dir_path = pathlib.Path(path)
+    if not dir_path.exists():
+        raise BakebookError(f"Directory not found: {path}")
+    if not dir_path.is_dir():
+        raise BakebookError(f"Not a directory: {path}")
+    os.chdir(dir_path)
+
+
+def validate_file_name(file_name: str) -> bool:
+    if "/" in file_name or "\\" in file_name:
+        raise BakebookError(f"File name must not contain path separators: {file_name}")
+    if not file_name.endswith(".py"):
+        raise BakebookError(f"File name must end with .py: {file_name}")
+    return True
+
+
+def resolve_file_path(file_name: str) -> pathlib.Path:
+    path = pathlib.Path.cwd() / file_name
+    if not path.exists():
+        raise BakebookError(f"File not found: {file_name}")
+    return path
+
+
+def load_module(path: pathlib.Path) -> types.ModuleType:
+    module_name = "bakefile"
+    spec = importlib.util.spec_from_file_location(module_name, path)
+    if spec is None or spec.loader is None:
+        raise BakebookError(f"Failed to load: {path}")
+
+    module: types.ModuleType = importlib.util.module_from_spec(spec)
+    sys.modules[module_name] = module
+    spec.loader.exec_module(module)
+    return module
+
+
+# Update this is lowest python support is >= 3.12
+# Use a generic type parameter for this function instead of a "TypeVar".
+def validate_bakebook(bakebook: Any, bakebook_name: str, expected_type: type[T]) -> T:
+    """Validate bakebook is of expected type and return it.
+
+    Parameters
+    ----------
+    bakebook : Any
+        The bakebook object to validate
+    bakebook_name : str
+        Name of the bakebook variable (for error messages)
+    expected_type : type[T]
+        The expected type (e.g., typer.Typer)
+
+    Returns
+    -------
+    T
+        The validated bakebook
+
+    Raises
+    ------
+    BakebookError
+        If bakebook is not of expected type
+    """
+    if not isinstance(bakebook, expected_type):
+        raise BakebookError(
+            f"Bakebook '{bakebook_name}' must be a {expected_type.__name__}, "
+            f"got {type(bakebook).__name__}"
+        )
+
+    return bakebook
+
+
+def get_bakebook(module: types.ModuleType, bakebook_name: str, path: pathlib.Path) -> typer.Typer:
+    if not hasattr(module, bakebook_name):
+        raise BakebookError(f"No '{bakebook_name}' found in {path}")
+    bakebook = getattr(module, bakebook_name)
+    bakebook = validate_bakebook(
+        bakebook=bakebook, bakebook_name=bakebook_name, expected_type=typer.Typer
+    )
+    return bakebook
+
+
+def resolve_bakebook(file_name: str, bakebook_name: str, chdir: str | None = None) -> typer.Typer:
+    if chdir:
+        change_directory(chdir)
+
+    validate_file_name(file_name)
+    path = resolve_file_path(file_name)
+    module = load_module(path)
+    return get_bakebook(module=module, bakebook_name=bakebook_name, path=path)

bakefile-0.0.4/src/bakefile/cli/bake/utils.py

@@ -0,0 +1,25 @@
+import os
+import sys
+
+import click
+
+
+def get_bakebook_args(
+    args: list[str] | None = None,
+    windows_expand_args: bool = True,
+) -> list[str]:
+    # source from https://github.com/fastapi/typer/blob/b7f39eaad60141988f5d9a58df72c44d6128cd53/typer/core.py#L175-L185
+
+    if args is None:
+        args = sys.argv[1:]
+
+        # Covered in Click tests
+        if os.name == "nt" and windows_expand_args:  # pragma: no cover
+            args = click.utils._expand_args(args)
+    else:
+        args = list(args)
+
+    non_get_bakebook_args = ["--help", "--version"]
+
+    args = [arg for arg in args if arg not in non_get_bakebook_args]
+    return args

bakefile-0.0.4/src/bakefile/cli/bakefile.py

@@ -0,0 +1,19 @@
+import typer
+
+from bakefile.cli.utils.version import version_callback
+
+app = typer.Typer(add_completion=True)
+
+
+@app.command()
+def main(
+    version: bool = typer.Option(
+        False,
+        "--version",
+        help="Show version and exit",
+        callback=version_callback,
+        is_eager=True,
+    ),
+) -> None:
+    _ = version
+    typer.echo("hello world")

bakefile-0.0.4/src/bakefile/cli/utils/version.py

@@ -0,0 +1,9 @@
+import typer
+
+from bakefile import __version__
+
+
+def version_callback(value: bool) -> None:
+    if value:
+        typer.echo(__version__)
+        raise typer.Exit()

bakefile-0.0.4/src/bakefile/env.py

@@ -0,0 +1,8 @@
+import os
+
+ENV_NO_COLOR = "NO_COLOR"
+
+
+def should_use_colors() -> bool:
+    value = os.environ.get(ENV_NO_COLOR)
+    return not (value == "" or value is None)

bakefile-0.0.4/src/bakefile/exceptions.py

@@ -0,0 +1,9 @@
+"""Custom exceptions for bakefile."""
+
+
+class BaseBakefileError(Exception):
+    """Base exception for all bakefile errors."""
+
+
+class BakebookError(BaseBakefileError):
+    """Exception raised when bakebook cannot be loaded or validated."""

bakefile-0.0.3/src/bakefile/cli/bake/__init__.py

@@ -1,3 +0,0 @@
-from bakefile.cli.bake.main import app
-
-__all__ = ["app"]

bakefile-0.0.3/src/bakefile/cli/bake/main.py

@@ -1,17 +0,0 @@
-import typer
-
-from bakefile.cli.bake.resolve_bakebook import resolve_bakebook
-
-app = typer.Typer()
-
-
-@app.command()
-def main(
-    chdir: str = typer.Option(None, "-C", "--chdir", help="Change directory before running"),
-    file_name: str = typer.Option("bakefile.py", "--file-name", "-f", help="Path to bakefile.py"),
-    bakebook_name: str = typer.Option(
-        "bakebook", "--book-name", "-b", help="Name of bakebook object to retrieve"
-    ),
-) -> None:
-    bakebook = resolve_bakebook(file_name=file_name, bakebook_name=bakebook_name, chdir=chdir)
-    typer.echo(bakebook)

bakefile-0.0.3/src/bakefile/cli/bake/resolve_bakebook.py

@@ -1,75 +0,0 @@
-import importlib.util
-import os
-import pathlib
-import sys
-import types
-
-import typer
-
-
-def change_directory(path: str) -> None:
-    if not path or not path.strip():
-        typer.echo("Directory path cannot be empty", err=True)
-        raise SystemExit(1)
-    dir_path = pathlib.Path(path)
-    if not dir_path.exists():
-        typer.echo(f"Directory not found: {path}", err=True)
-        raise SystemExit(1)
-    if not dir_path.is_dir():
-        typer.echo(f"Not a directory: {path}", err=True)
-        raise SystemExit(1)
-    os.chdir(dir_path)
-
-
-def validate_file_name(file_name: str) -> None:
-    if "/" in file_name or "\\" in file_name:
-        typer.echo(f"File name must not contain path separators: {file_name}", err=True)
-        raise SystemExit(1)
-    if not file_name.endswith(".py"):
-        typer.echo(f"File name must end with .py: {file_name}", err=True)
-        raise SystemExit(1)
-
-
-def resolve_file_path(file_name: str) -> pathlib.Path:
-    path = pathlib.Path.cwd() / file_name
-    if not path.exists():
-        typer.echo(f"File not found: {file_name}", err=True)
-        raise SystemExit(1)
-    return path
-
-
-def load_module(path: pathlib.Path) -> types.ModuleType:
-    module_name = "bakefile"
-    spec = importlib.util.spec_from_file_location(module_name, path)
-    if spec is None or spec.loader is None:
-        typer.echo(f"Failed to load: {path}", err=True)
-        raise SystemExit(1)
-
-    module: types.ModuleType = importlib.util.module_from_spec(spec)
-    sys.modules[module_name] = module
-    spec.loader.exec_module(module)
-    return module
-
-
-def get_bakebook(module: types.ModuleType, bakebook_name: str, path: pathlib.Path) -> str:
-    if not hasattr(module, bakebook_name):
-        typer.echo(f"No '{bakebook_name}' found in {path}", err=True)
-        raise SystemExit(1)
-    bakebook = getattr(module, bakebook_name)
-    if not isinstance(bakebook, str):
-        typer.echo(
-            f"Bakebook '{bakebook_name}' must be a string, got {type(bakebook).__name__}",
-            err=True,
-        )
-        raise SystemExit(1)
-    return bakebook
-
-
-def resolve_bakebook(file_name: str, bakebook_name: str, chdir: str | None = None) -> str:
-    if chdir:
-        change_directory(chdir)
-
-    validate_file_name(file_name)
-    path = resolve_file_path(file_name)
-    module = load_module(path)
-    return get_bakebook(module=module, bakebook_name=bakebook_name, path=path)

bakefile-0.0.3/src/bakefile/cli/bakefile.py

@@ -1,8 +0,0 @@
-import typer
-
-app = typer.Typer()
-
-
-@app.command()
-def main() -> None:
-    typer.echo("hello world")