What's the best practice to use optional-dependencies as environment dependencies too?

[alvarobartt]

e.g. I want to define some optional dependencies to be installed as package extras as follows:

[project.optional-dependencies]
quality = [
  "black~=22.6.0",
  "flake8~=4.0.1",
  "isort~=5.10.1",
  "pre-commit~=2.20.0",
]

And then I want to use those optional dependencies as the dependencies for a certain environment, should I do it this way?

[tool.hatch.envs.quality]
dependencies = [
  "pkg[quality]"
]
detached = true

Is there a better way to do this? Does it make sense to work this way?

[ofek]

https://hatch.pypa.io/latest/config/environment/overview/#features

[alvarobartt]

Oops you're right, didn't see that! Posting the solution here in case someone wants to know!

[tool.hatch.envs.quality]
features = [
  "quality",
]

[blink1073]

It seems as if features does not work when detached is also used.

If I use features = ["lint"] and detached = true, I end up with an older version of ruff (I do not see a "Synching Dependencies" notice):

hatch run lint:style
cmd [1] | ruff .
error unknown variant `UP`, expected one...

If I remove detached = true, then it picks up the version of ruff from my lint dependencies.

hatch run lint:style
cmd [1] | ruff .
warning: `I252` has been remapped to `TID252`

[alvarobartt]

Hi @blink1073 yes, indeed as you see in the reply above, I also removed detached=True so as to use features 👍🏻 Read the documentation at https://hatch.pypa.io/latest/config/environment/overview/#detached-environments since the idea behind detached=True is to define standalone environments, in this case, you want the environment to rely on the extras defined under optional-dependencies.

[lonkeknol]

So I'm trying to create an environment with pytest etc. installed. This is my toml file:

[project]
name = "rrapi"
version = "0.0.1"
authors = [
    {name ="...", email="..."},
]
requires-python = ">=3.11"
dependencies = [
    "fastapi == 0.95.0",
    "httpx == 0.24.0",
    "uvicorn == 0.21.1",
]

[project.optional-dependencies]
dev = [
    "pytest == 7.2.1",
    "pytest-env == 0.8.1",
    "pre-commit == 3.2.1",
]

[tool.hatch.envs.rrapi]
features = [
    "dev"
]

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

When I run hatch env create it doesn't include pytest etc. Just the main dependencies. Can someone see where I'm going wrong?
Perhaps I'm misunderstanding what this is supposed to do. I tried this before:

[tool.hatch.envs.rrapi]
dependencies = [
    "pytest == 7.2.1",
    "pytest-env == 0.8.1",
    "pre-commit == 3.2.1",
]

But that also doesn't install pytest or the others.

[lonkeknol]

I figured it out, but just documenting here in case it's useful for someone. Features wasn't what I needed, but dependencies. So I changed it to:

[tool.hatch.envs.rrapi]
dependencies = [
    "pytest == 7.2.1",
    "pytest-env == 0.8.1",
    "pre-commit == 3.2.1",
]

And here's the part I missed. I needed to specify the environment name, so hatch env create rrapi. This confused me because running hatch env create also creates an environment called rrapi, but without the dependencies installed.

[Olaf-Wolf3D]

When I run hatch env create it doesn't include pytest etc. Just the main dependencies. Can someone see where I'm going wrong?

It could be that hatch env create only creates the default environment. Since you defined your environment as [tool.hatch.envs.rrapi] and not [tool.hatch.envs.default], it might not create it. You could try hatch env create rrapi.