NoneBot CLI
Theme

nb_cli.handlers.environment

async def probe_environment_manager(*, cwd=None)​

  • 说明: Probe the environment manager available and used in the current project.

  • 参数

    • cwd (Path | None)

  • Returns

    • tuple[str, str]: A tuple of (project_manager_inferred, available_manager).

async def all_environment_managers()​

  • 说明: Get all available environment managers on the system.

  • 参数

    empty

  • Returns

    • list[str]: A list of available environment manager names.

abstract class EnvironmentExecutor(*, cwd, stdin=None, stdout=None, stderr=None, env=None, executable=None)​

  • 说明: Abstract base class for environment executors.

  • 参数

    • cwd (Path)

    • stdin (FdFile | None)

    • stdout (FdFile | None)

    • stderr (FdFile | None)

    • env (Mapping[str, str] | None)

    • executable (str | None)

async method run(*args)​

  • 说明: Run subprocess with the given parameters.

  • 参数

    • *args (str | bytes | os.PathLike[str] | os.PathLike[bytes])

  • 返回

    • Process

classmethod of(name)​

  • 说明: Get the executor class for the given environment manager name.

  • 重载

    1. (name) -> type[UvEnvironmentExecutor]

    • 参数

      • name (Literal['uv'])

    • 返回

      • type[UvEnvironmentExecutor]

    2. (name) -> type[PdmEnvironmentExecutor]

    • 参数

      • name (Literal['pdm'])

    • 返回

      • type[PdmEnvironmentExecutor]

    3. (name) -> type[PoetryEnvironmentExecutor]

    • 参数

      • name (Literal['poetry'])

    • 返回

      • type[PoetryEnvironmentExecutor]

    4. (name) -> type[PipEnvironmentExecutor]

    • 参数

      • name (Literal['pip'])

    • 返回

      • type[PipEnvironmentExecutor]

    5. (name) -> type[EnvironmentExecutor]

    • 参数

      • name (str)

    • 返回

      • type[EnvironmentExecutor]

  • Args

    • name: The name of the environment manager.

  • Returns

    The executor class corresponding to the given name.

classmethod get(name=None, *, toml_manager=GLOBAL_CONFIG, cwd=None, stdin=None, stdout=None, stderr=None, env=None, executable=None)​

  • 说明: Get an instance of the executor for the given environment manager name.

  • Args

    • name (str | None): The name of the environment manager.

    • toml_manager (ConfigManager)

    • cwd (Path | None): The current working directory for the executor.

    • stdin (FdFile | None): The standard input for the executor.

    • stdout (FdFile | None): The standard output for the executor.

    • stderr (FdFile | None): The standard error for the executor.

    • env (Mapping[str, str] | None): The environment variables for the executor.

    • executable (str | None): The executable path for the environment manager.

  • Returns

    • EnvironmentExecutor: An instance of the executor corresponding to the given name.

abstract async method init(extra_args=())​

  • 说明: Initialize the environment.

  • 参数

    • extra_args (Sequence[str])

  • 返回

    • None

abstract async method lock(extra_args=())​

  • 说明: Generate or update the lock file for the environment.

  • 参数

    • extra_args (Sequence[str])

  • 返回

    • None

abstract async method sync(extra_args=())​

  • 说明: Synchronize the environment with the lock file or configuration.

  • 参数

    • extra_args (Sequence[str])

  • 返回

    • None

abstract async method install(*packages, extra_args=(), dev=False)​

  • 说明: Install packages into the environment.

  • Args

    • *packages (Requirement): A list of package specifiers to install.

    • extra_args (Sequence[str])

    • dev (bool)

  • 返回

    • None

abstract async method update(*packages, extra_args=())​

  • 说明: Update packages in the environment.

  • Args

    • *packages (Requirement): A list of package specifiers to update. If None, update all packages.

    • extra_args (Sequence[str])

  • 返回

    • None

abstract async method uninstall(*packages, extra_args=())​

  • 说明: Uninstall packages from the environment.

  • Args

    • *packages (Requirement): A list of package specifiers to uninstall.

    • extra_args (Sequence[str])

  • 返回

    • None

class UvEnvironmentExecutor(*, cwd, stdin=None, stdout=None, stderr=None, env=None, executable=None)​

  • 说明: Environment executor for Uv environment manager.

  • 参数

    • cwd (Path)

    • stdin (FdFile | None)

    • stdout (FdFile | None)

    • stderr (FdFile | None)

    • env (Mapping[str, str] | None)

    • executable (str | None)

async method init(extra_args=())​

  • 参数

    • extra_args (Sequence[str])

  • 返回

    • None

async method lock(extra_args=())​

  • 参数

    • extra_args (Sequence[str])

  • 返回

    • None

async method sync(extra_args=())​

  • 参数

    • extra_args (Sequence[str])

  • 返回

    • None

async method install(*packages, extra_args=(), dev=False)​

  • 参数

    • *packages (Requirement)

    • extra_args (Sequence[str])

    • dev (bool)

  • 返回

    • None

async method update(*packages, extra_args=())​

  • 参数

    • *packages (Requirement)

    • extra_args (Sequence[str])

  • 返回

    • None

async method uninstall(*packages, extra_args=())​

  • 参数

    • *packages (Requirement)

    • extra_args (Sequence[str])

  • 返回

    • None

class PdmEnvironmentExecutor(*, cwd, stdin=None, stdout=None, stderr=None, env=None, executable=None)​

  • 说明: Environment executor for PDM environment manager.

  • 参数

    • cwd (Path)

    • stdin (FdFile | None)

    • stdout (FdFile | None)

    • stderr (FdFile | None)

    • env (Mapping[str, str] | None)

    • executable (str | None)

async method init(extra_args=())​

  • 参数

    • extra_args (Sequence[str])

  • 返回

    • None

async method lock(extra_args=())​

  • 参数

    • extra_args (Sequence[str])

  • 返回

    • None

async method sync(extra_args=())​

  • 参数

    • extra_args (Sequence[str])

  • 返回

    • None

async method install(*packages, extra_args=(), dev=False)​

  • 参数

    • *packages (Requirement)

    • extra_args (Sequence[str])

    • dev (bool)

  • 返回

    • None

async method update(*packages, extra_args=())​

  • 参数

    • *packages (Requirement)

    • extra_args (Sequence[str])

  • 返回

    • None

async method uninstall(*packages, extra_args=())​

  • 参数

    • *packages (Requirement)

    • extra_args (Sequence[str | bytes])

  • 返回

    • None

class PoetryEnvironmentExecutor(*, cwd, stdin=None, stdout=None, stderr=None, env=None, executable=None)​

  • 说明: Environment executor for Poetry environment manager.

  • 参数

    • cwd (Path)

    • stdin (FdFile | None)

    • stdout (FdFile | None)

    • stderr (FdFile | None)

    • env (Mapping[str, str] | None)

    • executable (str | None)

async method init(extra_args=())​

  • 参数

    • extra_args (Sequence[str])

  • 返回

    • None

async method lock(extra_args=())​

  • 参数

    • extra_args (Sequence[str])

  • 返回

    • None

async method sync(extra_args=())​

  • 参数

    • extra_args (Sequence[str])

  • 返回

    • None

async method install(*packages, extra_args=(), dev=False)​

  • 参数

    • *packages (Requirement)

    • extra_args (Sequence[str])

    • dev (bool)

  • 返回

    • None

async method update(*packages, extra_args=())​

  • 参数

    • *packages (Requirement)

    • extra_args (Sequence[str])

  • 返回

    • None

async method uninstall(*packages, extra_args=())​

  • 参数

    • *packages (Requirement)

    • extra_args (Sequence[str])

  • 返回

    • None

class PipEnvironmentExecutor(toml_manager=GLOBAL_CONFIG, *, cwd, stdin=None, stdout=None, stderr=None, env=None, executable=WINDOWS_DEFAULT_PYTHON[0] if WINDOWS else DEFAULT_PYTHON[0])​

  • 说明: Environment executor for Pip environment manager.

  • 参数

    • toml_manager (ConfigManager)

    • cwd (Path)

    • stdin (FdFile | None)

    • stdout (FdFile | None)

    • stderr (FdFile | None)

    • env (Mapping[str, str] | None)

    • executable (str)

async method init(extra_args=())​

  • 参数

    • extra_args (Sequence[str])

  • 返回

    • None

async method lock(extra_args=())​

  • 参数

    • extra_args (Sequence[str])

  • 返回

    • None

async method sync(extra_args=())​

  • 参数

    • extra_args (Sequence[str])

  • 返回

    • None

async method install(*packages, extra_args=(), dev=False)​

  • 参数

    • *packages (Requirement)

    • extra_args (Sequence[str])

    • dev (bool)

  • 返回

    • None

async method update(*packages, extra_args=())​

  • 参数

    • *packages (Requirement)

    • extra_args (Sequence[str])

  • 返回

    • None

async method uninstall(*packages, extra_args=())​

  • 参数

    • *packages (Requirement)

    • extra_args (Sequence[str])

  • 返回

    • None