How to run commands in the project root directory?

[abersheeran]

pdm can run commands that defined in pyproject.toml in a certain directory in the project, but the value of cwd is the path to run pdm run .... Is there a solution (such as pyproject.toml configuration) to ensure the working directory of the command always in the project root directory?

[frostming]

No, there isn't such configuration. In what case you run the script in a sub path while still wanting the cwd to be the project root?

Configure the cwd to run script is just like you cd to that directory and run, so this doesn't make sense.

[abersheeran]

Yes. How should I do?

[frostming]

I am raising a question, not an answer.

Imagine you have a script under project/deep/path/my_script.py, you just python deep/path/my_script.py, or python -m deep.path.my_script to ensure the package path won't change

[abersheeran]

In this case, I always use Path(__file__).parent to ensure cwd in project root.

[pawamoy]

Does PDM sets the PROJECT_ROOT variable in the environment? Because if it does, one could use that variable in scripts to make sure they run in the project root. (I might have misunderstood the question and replies though)

[frostming]

No, it is a magic variable, not set in env var.

[pawamoy]

It could be interesting to add it to the env then, at least for the run command.
This way, whatever the subdir I'm in, I could use pdm run some-tool some-arg as if I was in the root (given some-tool uses PROJECT_ROOT to cd into it). That would play well with task runners such as invoke or duty ^^

[abersheeran]

This way, whatever the subdir I'm in, I could use pdm run some-tool some-arg as if I was in the root (given some-tool uses PROJECT_ROOT to cd into it). That would play well with task runners such as invoke or duty ^^

I agree you.

[frostming]

It is done in 2ce4451

[pawamoy]

I just tried yarn and it goes to project root, I am going to follow it, too.

So you were planning to make PDM always cd into the project root? Or did I misunderstand?

[164747]

If I set

export PYTHONPATH=$PYTHONPATH:./

in the command terminal, I can run commands with

pdm run python path/to/deep/file.py

from my pdm root directory. Don't know if that's the right approach though.

[164747]

Background, I have a project, a web service I deploy to google app engine For the main file app.py it is not problem to have that in the "pdm root". But I have a lot of "test script" that I like to run whilst developing. I don't want to bloat my "root" directory, so I want to call them like in my example above.

pdm run python path/to/deep/file.py

Before I did the "export trick" above, all the import statements in the deep file stoped working.

[pawamoy]

Do you use relative imports? With proper packages structure and absolute imports it should work normally, whatever the directory you're currently in. By the way, the current working directory is always added to sys.path by Python itself, so you shouldn't need to manually add it to PYTHONPATH. Hmm in fact I believe Python adds the parent directory of the script you run, not the current working directory, so that explains your situation yes.

[frostming]

Basically when you run python path/to/deep/file.py, the directory path/to/deep, not project root, will be added to sys.path. This is the basic of Python import system. pdm run only adds ${project_root}/__pypackages__/3.10/lib to the sys.path. If you want to refer to the modules under the project root, install it into the __pypackages__. This can be done by PDM automatically if your project has both name and version properties in metadata.