Add options to Python language module #993

totoroot · 2024-03-01T16:18:06Z

Recently I continued using devenv for various different projects at work, so the need to have it also manage multi-language development environments got bigger.

For a lot of projects, the structure looks similar to the following.

project
├── backend
├── devenv.lock
├── devenv.nix
├── devenv.yaml
└── frontend

In this example backend would for example be the subdirectory of some Python/Django component and then there would be the frontend subdirectory e.g. some JavaScript/Node.js component.

For that reason I would like to specify a subdirectory for the individual components.

In this PR I made the necessary changes to be able to specify a working directory via languages.python.directory.
While it is already possible to pass paths of requirements files to install dependencies from, it is currently not possible to specify the location of the virtual environment or to change the working directory of the poetry command.

This makes it impossible to have the pyproject.toml file anywhere other than at the devenv root.

I also added some more missing options to languages.python.poetry.install.

totoroot · 2024-03-01T16:19:11Z

I'm planning on adding support for pdm soon, and for that, these changes would facilitate its use as well.

Also, I don't think we don't want to use lib.types.path for the directory, as that would mean copying the subdirectory's content to the Nix store. Using lib.types.str and the root of the top-level devenv project as default seems fine, but please let me know in case you think otherwise.

totoroot · 2024-03-01T16:22:54Z

If nothing speaks against it, I would go ahead and try adding a similar option for the JavaScript module, since one might also want to have the package.json in a different directory than the devenv root

domenkozar · 2024-03-02T05:27:11Z

See also #899, I'd really like to have a test for this before it's merged.

totoroot · 2024-03-04T10:41:59Z

@domenkozar I have modified the example for python-poetry to include the newly added options.

I also added an example and tests for the introduced directory option, as you requested. In this example I have also tested the python-poetry module with the Python directory option set.

examples/python-directory/devenv.yaml

domenkozar · 2024-03-05T04:56:54Z

src/modules/languages/python.nix

      description = "Whether `pip install` should avoid outputting messages during devenv initialisation.";
    };

+    directory = lib.mkOption {


does it work if you do ./. with types.path and then do config.devenv.root + cfg.directory?

I don't think I understand what you mean.

In #993 (comment) I mentioned that using types.str means not copying the specified directory to the Nix store, so poetry is still able to write the lock file.

It also gives users more flexibility when setting the option as they can set it to either an absolute path or a path relative to the devenv root with something like ./directory. I've added an example to the option.

I think you should be still able to use types.path to validate it's a path and then do mystringpath + cfg.directory

domenkozar · 2024-03-05T04:57:09Z

Great work, only two comments and it's ready to go :)

domenkozar · 2024-03-15T08:52:46Z

@totoroot ping :)

domenkozar · 2024-03-21T04:12:06Z

Can you rebase on main and I'll take over this one :)

totoroot · 2024-03-21T12:32:20Z

Can you rebase on main and I'll take over this one :)

@domenkozar Sorry, I did not have time to finish this up. Had a lot to do at work since last week, so I'm happy to hand it over to you :)
I have rebased onto main as requested. I hope that all conflicts were properly resolved.

bobvanderlinden · 2025-06-03T14:35:48Z

I recently updated a python project's devenv and to my surprise it didn't activate the poetry environment anymore. It seems activating the poetry environment is disabled by default, where-as before I was able to import libraries from poetry without poetry.activate.enable = true nor poetry run .... Was this change intentional?

bobvanderlinden · 2025-06-03T14:37:30Z

examples/python-poetry/devenv.nix

+    poetry = {
+      enable = true;
+      install = {
+        enable = true;
+        installRootPackage = false;
+        onlyInstallRootPackage = false;
+        compile = false;
+        quiet = false;
+        groups = [ ];
+        ignoredGroups = [ ];
+        onlyGroups = [ ];
+        extras = [ ];
+        allExtras = false;
+        verbosity = "no";
+      };
+      activate.enable = true;
+      package = pkgs.poetry;


By default people shouldn't need to set all of these options, should the test check for options or for the default poetry environment? 😅

totoroot · 2025-06-03T14:54:20Z

@bobvanderlinden

I recently updated a python project's devenv and to my surprise it didn't activate the poetry environment anymore. It seems activating the poetry environment is disabled by default, where-as before I was able to import libraries from poetry without poetry.activate.enable = true nor poetry run .... Was this change intentional?

I also noticed poetry's activate option in devenv breaking a while ago, but I'm fairly certain this was a while after my changes with this PR got merged. If my changes caused this changed behaviour it wasn't intentional.

Unfortunately I currently got no time to investigate this, sorry.

domenkozar · 2025-06-03T16:39:27Z

Could someone open a bug to reproduce it?

bobvanderlinden · 2025-06-03T19:26:02Z

I'll have a look 👍

bobvanderlinden · 2025-06-03T20:33:52Z

#1907

totoroot self-assigned this Mar 1, 2024

totoroot requested a review from domenkozar March 1, 2024 16:22

totoroot force-pushed the pyproject-location branch from 1bbdd53 to 6b215f3 Compare March 1, 2024 16:26

totoroot force-pushed the pyproject-location branch 3 times, most recently from f1b2130 to f1f49e7 Compare March 4, 2024 10:30

This was referenced Mar 4, 2024

Allow setting directory for javascript/python #899

Closed

Add support for specifying JavaScript root directory #995

Merged

How to use Python Poetry when the files are located in a sub directory? #941

Closed

domenkozar reviewed Mar 5, 2024

View reviewed changes

examples/python-directory/devenv.yaml Outdated Show resolved Hide resolved

domenkozar reviewed Mar 5, 2024

View reviewed changes

totoroot force-pushed the pyproject-location branch 4 times, most recently from 0ddeaae to 5b5e8e0 Compare March 5, 2024 08:05

totoroot requested a review from domenkozar March 6, 2024 14:29

totoroot added 7 commits March 21, 2024 13:25

Add support for specifying Python root directory

b825433

Add options for poetry install arguments

bed2652

Refactoring of comments and option description

ff40f02

Remove trailing whitespace

99a2d15

Add more options to poetry

5442556

Update python-poetry example

d2778e6

Add example and tests for Python directory option

d11cf57

totoroot added 2 commits March 21, 2024 13:28

Use config.devenv.root as default for Python project directory

2ff8144

Apply suggestions

8c97d19

totoroot force-pushed the pyproject-location branch from 5b5e8e0 to 8c97d19 Compare March 21, 2024 12:30

domenkozar merged commit 8c97d19 into cachix:main Mar 22, 2024

bobvanderlinden reviewed Jun 3, 2025

View reviewed changes

totoroot deleted the pyproject-location branch June 3, 2025 15:02

Add options to Python language module #993

Add options to Python language module #993

Uh oh!

Conversation

totoroot commented Mar 1, 2024

Uh oh!

totoroot commented Mar 1, 2024

Uh oh!

totoroot commented Mar 1, 2024

Uh oh!

domenkozar commented Mar 2, 2024

Uh oh!

totoroot commented Mar 4, 2024

Uh oh!

Uh oh!

domenkozar Mar 5, 2024

Choose a reason for hiding this comment

Uh oh!

totoroot Mar 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

domenkozar Mar 8, 2024

Choose a reason for hiding this comment

Uh oh!

domenkozar commented Mar 5, 2024

Uh oh!

domenkozar commented Mar 15, 2024

Uh oh!

domenkozar commented Mar 21, 2024

Uh oh!

totoroot commented Mar 21, 2024

Uh oh!

bobvanderlinden commented Jun 3, 2025

Uh oh!

bobvanderlinden Jun 3, 2025

Choose a reason for hiding this comment

Uh oh!

totoroot commented Jun 3, 2025

Uh oh!

domenkozar commented Jun 3, 2025

Uh oh!

bobvanderlinden commented Jun 3, 2025

Uh oh!

bobvanderlinden commented Jun 3, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

totoroot Mar 5, 2024 •

edited

Loading