Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

perf: make ape run --help faster #2364

Merged
merged 6 commits into from
Nov 4, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 21 additions & 11 deletions src/ape_run/_cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,18 @@
from typing import Any, Union

import click
from click import Command, Context, Option

from ape.cli.commands import ConnectedProviderCommand
from ape.cli.options import _VERBOSITY_VALUES, _create_verbosity_kwargs, verbosity_option
from ape.exceptions import ApeException, handle_ape_exception
from ape.logging import logger
from ape.utils.basemodel import ManagerAccessMixin as access
from ape.utils.os import get_relative_path, use_temp_sys_path
from ape_console._cli import console


@contextmanager
def use_scripts_sys_path(path: Path):
# perf: avoid importing at top of module so `--help` is faster.
from ape.utils.os import use_temp_sys_path

# First, ensure there is not an existing scripts module.
scripts = sys.modules.get("scripts")
if scripts:
Expand Down Expand Up @@ -70,7 +69,9 @@ def __init__(self, *args, **kwargs):
self._command_called = None
self._has_warned_missing_hook: set[Path] = set()

def invoke(self, ctx: Context) -> Any:
def invoke(self, ctx: click.Context) -> Any:
from ape.utils.basemodel import ManagerAccessMixin as access

try:
return super().invoke(ctx)
except Exception as err:
Expand All @@ -95,7 +96,8 @@ def invoke(self, ctx: Context) -> Any:
raise

def _get_command(self, filepath: Path) -> Union[click.Command, click.Group, None]:
relative_filepath = get_relative_path(filepath, access.local_project.path)
scripts_folder = Path.cwd() / "scripts"
relative_filepath = filepath.relative_to(scripts_folder)

# First load the code module by compiling it
# NOTE: This does not execute the module
Expand All @@ -122,14 +124,14 @@ def _get_command(self, filepath: Path) -> Union[click.Command, click.Group, None

self._namespace[filepath.stem] = cli_ns
cli_obj = cli_ns["cli"]
if not isinstance(cli_obj, Command):
if not isinstance(cli_obj, click.Command):
logger.warning("Found `cli()` method but it is not a click command.")
return None

params = [getattr(x, "name", None) for x in cli_obj.params]
if "verbosity" not in params:
option_kwargs = _create_verbosity_kwargs()
option = Option(_VERBOSITY_VALUES, **option_kwargs)
option = click.Option(_VERBOSITY_VALUES, **option_kwargs)
cli_obj.params.append(option)

cli_obj.name = filepath.stem if cli_obj.name in ("cli", "", None) else cli_obj.name
Expand Down Expand Up @@ -175,13 +177,16 @@ def call():

@property
def commands(self) -> dict[str, Union[click.Command, click.Group]]:
if not access.local_project.scripts_folder.is_dir():
# perf: Don't reference `.local_project.scripts_folder` here;
# it's too slow when doing just doing `--help`.
scripts_folder = Path.cwd() / "scripts"
if not scripts_folder.is_dir():
return {}

return self._get_cli_commands(access.local_project.scripts_folder)
return self._get_cli_commands(scripts_folder)

def _get_cli_commands(self, base_path: Path) -> dict:
commands: dict[str, Command] = {}
commands: dict[str, click.Command] = {}

for filepath in base_path.iterdir():
if filepath.stem.startswith("_"):
Expand All @@ -194,6 +199,7 @@ def _get_cli_commands(self, base_path: Path) -> dict:
subcommands = self._get_cli_commands(filepath)
for subcommand in subcommands.values():
group.add_command(subcommand)

commands[filepath.stem] = group

if filepath.suffix == ".py":
Expand Down Expand Up @@ -223,6 +229,8 @@ def result_callback(self, result, interactive: bool): # type: ignore[override]
return result

def _launch_console(self):
from ape.utils.basemodel import ManagerAccessMixin as access

trace = inspect.trace()
trace_frames = [
x for x in trace if x.filename.startswith(str(access.local_project.scripts_folder))
Expand All @@ -247,6 +255,8 @@ def _launch_console(self):
if frame:
del frame

from ape_console._cli import console

return console(project=access.local_project, extra_locals=extra_locals, embed=True)


Expand Down
Loading