How to enter and exit a hatch environment (and how to know what envt the current shell is in).

[lwasser]

Hey y'all - i'm playing around with hatch environments for a tutorial i'm working on.

i dont understand how to navigate hatch created environments. Can you answer some questions please?

1. i created a new dev environment with hatch. How do i "activate" or access it when working on my package?

pyosPackage (☊ main) [✎ ×1 ] is 📦 v0.1.0 🐍 v3.12.1 
❯ hatch env show
             Standalone             
┏━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━┓
┃ Name    ┃ Type    ┃ Dependencies ┃
┡━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━┩
│ default │ virtual │              │
├─────────┼─────────┼──────────────┤
│ dev     │ virtual │ pytest       │
└─────────┴─────────┴──────────────┘

here is what i've tried:

pyosPackage (☊ main) [✎ ×1 ] is 📦 v0.1.0 🐍 v3.12.1 
❯ hatch shell dev
Already in environment: default

pyosPackage (☊ main) [✎ ×1 ] is 📦 v0.1.0 🐍 v3.12.1 
❯ hatch shell
Already in environment: default

i do have my zsh shell customized as you can see but i'm struggling to figure out how i know what environment i'm in when using hatch. it seems like i'm in a default environment but i want to be in the dev environment to work on my package (as an example).

as context i'm used to using conda where you activate an envt and start working. perhaps the model here is a bit different?
many thanks!

[ofek]

It seems like you've already entered the default environment with the shell command so you must run exit or press ctrl+d. It should update your prompt, it certainly does for others on the supported shells.

[lwasser]

thank you. that does work! i will try to figure out how to get my shell to tell me i'm in a hatch envt later :)
let me ask this differently!

i have this in my pyproject.toml file:

# Hatch config 
[tool.hatch.envs.dev]
dependencies = [
  "pytest"
]

let's pretend pytest is not installed with pipx so i need it in a dev envt.

is this how i'd run pytest (i just figured this out!):

hatch -e dev run pytest

i think the intention (tell me if i'm wrong) is that default IS the base development environment. And default will always have the package installed in editable mode.

Then if you want to run something from another hatch environment you use the hatch -e <envtname> command rather than actually entering the environment. do i have that right?

Thanks ofek.

[ofek]

i think the intention (tell me if i'm wrong) is that default IS the base development environment. And default will always have the package installed in editable mode.

Usually yeah, but the default environment can be defined however you want. Hatch makes no prescriptions.

Then if you want to run something from another hatch environment you use the hatch -e <envtname> command rather than actually entering the environment. do i have that right?

That (hatch -e env_name run ...) is one way yes but it's more common and easier to do hatch run env_name:...

[lwasser]

@ofek are you comfortable with my submitting a PR that explains how environments work on the environment page?

If you are comfortable with it then i'd also want to clarify how a user can prescribe how the default envt is defined.

if you can direct me to a link or explanation i'll then create a pr for both items on that environment page - likely this weekend.

[ofek]

Sounds great, thanks!

[itcarroll]

I'm finding that the command to open a shell in the "dev" environment is hatch -e dev shell.