feat: set project root env

[ZeeD]

Pull Request Checklist

• A news fragment is added in news/ describing what is new.
• Test cases added for changed code.

Describe what you have changed in this PR.

Expose PROJECT_ROOT as an env variable during script runs

fixes #2993

[frostming]

Why not just inject the env into the process_env when running processes?

pdm/src/pdm/cli/commands/run.py

Line 258 in 61657a4

process_env.update(project_env.process_env)

You won't contaminate the global_options in this way.

[frostming]

Oh, the project root is already exposed via PDM_PROJECT_ROOT env.

pdm/src/pdm/environments/base.py

Line 80 in c190e14

return {"PATH": new_path, "PDM_PROJECT_ROOT": str(project.root)}

If no objection, i will close this PR.

[ZeeD]

Why not just inject the env into the process_env when running processes?

pdm/src/pdm/cli/commands/run.py

Line 258 in 61657a4

process_env.update(project_env.process_env)

You won't contaminate the global_options in this way.

Yeah, I may try this approach instead

Oh, the project root is already exposed via PDM_PROJECT_ROOT env.

pdm/src/pdm/environments/base.py

Line 80 in c190e14

return {"PATH": new_path, "PDM_PROJECT_ROOT": str(project.root)}

If no objection, i will close this PR.

I didn't knew about PDM_PROJECT_ROOT, I may have missed it in the docs, sorry.

But, while invoking directly a script I see that PDM_PROJECT_ROOT is available, it seems to me that in the .env variable expansion it doesn't work: let's say that I have

pyproject.toml:

[tool.pdm.scripts]
_.env_file = ".env"
var1 = { shell = "echo $VAR1" }
var2 = { shell = "echo $VAR2" }
var3 = { shell = "echo $PDM_PROJECT_ROOT" }

.env

VAR1 = "VAL1"

VAR2 = "VAR1=${VAR1}; USER=${USER}; PDM_PROJECT_ROOT=${PDM_PROJECT_ROOT};"

pdm run have some unexpected behaviour:

$ pdm run var1
VAL1
$ pdm run var2
VAR1=VAL1; USER=<my username>; PDM_PROJECT_ROOT=;
$ pdm run var3
<current directory
$ 

it seems that the definition of the PDM_PROJECT_ROOT env variable occurs "too late" to let dotenv enrich the .env file parsing.

Do you think it would be possible to move the PDM_PROJECT_ROOT before the evaluation of the _.env file during the execution of the run?

[frostming]

it seems that the definition of the PDM_PROJECT_ROOT env variable occurs "too late" to let dotenv enrich the .env file parsing.

Not only that, all additional env vars are not injected into os.environ before spawning the child process.

[ZeeD]

searching for PDM_PROJECT_ROOT I've found #1324
Do you think that my use case - as you can see in #2993 - could be solved changing the behavior of pdm?

[frostming]

This is superseded by #3087 thanks anyway

[ZeeD]

thanks to you for the update!