2.4 KiB

Raw Permalink Blame History

Environment plugins

See the documentation for environment configuration.

Known third-party

hatch-containers - environments run inside containers

Life cycle

Whenever an environment is used, the following logic is performed:

::: hatch.cli.application.Application.prepare_environment rendering: show_root_heading: false show_root_toc_entry: false

Built-in

Virtual

This uses virtual environments backed by the standard virtualenv tool.

Configuration

The environment plugin name is virtual.

=== ":octicons-file-code-16: pyproject.toml"

```toml
[tool.hatch.envs.<ENV_NAME>]
type = "virtual"
```

=== ":octicons-file-code-16: hatch.toml"

```toml
[envs.<ENV_NAME>]
type = "virtual"
```

Options

Option	Default	Description
`system-packages`	`false`	Whether or not to give the virtual environment access to the system `site-packages` directory
`python`		The version of Python to find on your system and subsequently use to create the environment, defaulting to the `HATCH_PYTHON` environment variable, followed by the Python executable Hatch is running on. For more information, see the documentation.
`env:HATCH_ENV_TYPE_VIRTUAL_PATH`		An explicit path to the virtual environment

::: hatch.env.plugin.interface.EnvironmentInterface selection: members: - PLUGIN_NAME - app - root - name - data_directory - config - platform - environment_dependencies - dependencies - env_vars - env_include - env_exclude - platforms - skip_install - dev_mode - description - activate - deactivate - find - create - remove - exists - install_project - install_project_dev_mode - dependencies_in_sync - sync_dependencies - build_environment - get_build_process - construct_build_command - command_context - enter_shell - run_shell_command - resolve_commands - get_env_vars - apply_features - construct_pip_install_command - join_command_args - check_compatibility - get_option_types - get_env_var_option

2.4 KiB Raw Permalink Blame History