Environment Spec plugins should return an Environment model #14937

soapy1 · 2025-06-13T20:21:05Z

Description

This PR updates the EnvironmentSpecBase interface to return a model.Environment (environment model) instead of an env.env.Environment (environment.yml model). The env.env.Environment does not fully describe a conda environment. On the other hand, model.Environment can fully describe an environment. So, this type makes more sense to be the return type for env spec plugins. For more information on the Environment model see https://docs.google.com/document/d/1Q_M66kFGCYLuaqAqez_jlsqxnQEQh5tSUBtvEz3ixdA/edit?tab=t.gmwr9pinfepw.

This PR also updates conda env commands and env installers to use the new Environment model.

This is a refactor PR, there should be no changes in conda's behaviour.

fixes conda/conda-planning#62

depends on #14820

Checklist - did you ...

Add a file to the news directory (using the template) for the next release's release notes?
Add / update necessary tests?
Add / update outdated documentation?

codspeed-hq · 2025-06-13T20:36:39Z

CodSpeed Instrumentation Performance Report

Merging #14937 will not alter performance

_{Comparing soapy1:env-spec-env-model (ce38b4d) with main (01f2286)}

Summary

✅ 21 untouched benchmarks

jezdez · 2025-06-25T21:13:33Z

Could we start this up again, now that #14820 is merged? #14886 could really need a way to convert the legacy environment classes to the new models, see _create_environment_from_prefix here

soapy1 · 2025-06-25T22:18:49Z

Absolutely! Will whip it up in just a bit

soapy1 · 2025-06-25T22:32:24Z

conda/env/installers/conda.py

@@ -56,18 +57,18 @@ def _solve(

 def dry_run(
    specs: list[str], args: Namespace, env: Environment, *_, **kwargs
-) -> Environment:
+) -> EnvironmentYaml:


We want to continue to return the conda.env.env.Environment here so that we aren't changing the installer api. Eventually this should move over to use the new Environment model. But I think it's better to chunk that in another piece of work to keep this change focused on the env spec api.

I can't parse this statement

I think it would be ok to make these changes here to make sure we have covered all the API changes and nothing lingers.

codspeed-hq · 2025-06-25T23:33:55Z

CodSpeed WallTime Performance Report

Merging #14937 will not alter performance

_{Comparing soapy1:env-spec-env-model (6f3365c) with main (21abdfe)}

Summary

✅ 21 untouched benchmarks

soapy1 · 2025-06-26T06:39:12Z

tests/env/test_explicit_environment.py

@@ -1,108 +0,0 @@
-# Copyright (C) 2012 Anaconda, Inc


We don't want to support an explicit environment.yaml anymore. The conda.env.env.Environment class should just represent the conda environment.yaml format.

Wait, what's "an explicit environment.yaml"? @EXPLICIT input files are defined in CEP 23, we can't not support them

TL;DR

To clarify, this PR is still supporting explicit input files.

conda.env.env.Environment should only be representing environment.yaml files.

Previously, this was implemented by making conda.env.env.Environment support reading these files (that was in #14820). That was an ok approach at that time since env spec plugins were meant to be returning conda.env.env.Environment.

However, now we want env spec plugins to return conda.models.environment.Environment. So, I think we should back out the changes to conda.env.env.Environment that allow it to represent an explicit environment and restore it to it's original purpose which is to represent an environment.yaml file. And ExplicitSpecPlugin should create a conda.models.environment.Environment.

soapy1 · 2025-06-26T06:40:12Z

tests/plugins/test_explicit_spec.py

@@ -1,102 +0,0 @@
-# Copyright (C) 2012 Anaconda, Inc


These tests are duplicates of the ones in tests/env/specs/test_explicit.py

soapy1 · 2025-06-26T18:34:52Z

tests/env/installers/test_conda_installer_explicit.py

@@ -4,9 +4,12 @@

 import pytest

-from conda.env.env import Environment


Maybe this whole file can be deleted?

soapy1 · 2025-06-26T18:36:01Z

pre-commit.ci autofix

jezdez · 2025-06-27T10:57:42Z

conda/cli/main_env_update.py

+    if len(env.requested_packages) > 0:
+        installers["conda"] = get_installer("conda")
+
+    for installer_type in env.external_packages:


Why do we only get and set the conda installer if there are requested packages? This makes me wonder why we have a separation between requested and external packages

requested packages are only for conda packages. external are everything else (PyPI and whatever ecosystem we end up adding).

conda/cli/main_env_create.py

conda/cli/main_env_update.py

conda/misc.py

for more information, see https://pre-commit.ci

Co-authored-by: jaimergp <jaimergp@users.noreply.github.com>

for more information, see https://pre-commit.ci

Co-authored-by: Ken Odegard <kodegard@anaconda.com>

for more information, see https://pre-commit.ci

conda/env/specs/binstar.py

conda/env/specs/requirements.py

conda/env/specs/yaml_file.py

news/14937-return-environment-model

Co-authored-by: Ken Odegard <kodegard@anaconda.com>

conda-bot added this to 🔎 Review Jun 13, 2025

github-project-automation bot moved this to 🆕 New in 🔎 Review Jun 13, 2025

conda-bot added the cla-signed [bot] added once the contributor has signed the CLA label Jun 13, 2025

soapy1 force-pushed the env-spec-env-model branch 2 times, most recently from f602df7 to 29074b5 Compare June 13, 2025 21:30

This was referenced Jun 24, 2025

Store declarative input states in conda-meta/ conda/conda-planning#13

Closed

Use new Environment dataclass to refactor conda.cli.install sources conda/conda-planning#63

Closed

soapy1 force-pushed the env-spec-env-model branch from 29074b5 to 7808343 Compare June 25, 2025 22:30

soapy1 commented Jun 25, 2025

View reviewed changes

soapy1 force-pushed the env-spec-env-model branch 2 times, most recently from 167fc08 to 9776b39 Compare June 26, 2025 01:21

soapy1 commented Jun 26, 2025

View reviewed changes

soapy1 force-pushed the env-spec-env-model branch 2 times, most recently from 11c65cd to 1916f6e Compare June 26, 2025 19:17

soapy1 mentioned this pull request Jun 26, 2025

Implement environment export plugin hook #14886

Merged

3 tasks

soapy1 force-pushed the env-spec-env-model branch from 1916f6e to 971a044 Compare June 26, 2025 21:23

soapy1 marked this pull request as ready for review June 26, 2025 21:23

soapy1 requested a review from a team as a code owner June 26, 2025 21:23

soapy1 force-pushed the env-spec-env-model branch from 971a044 to 6faf13e Compare June 26, 2025 21:44

jezdez reviewed Jun 27, 2025

View reviewed changes

jaimergp reviewed Jun 27, 2025

View reviewed changes

conda/cli/main_env_create.py Outdated Show resolved Hide resolved

jaimergp reviewed Jun 27, 2025

View reviewed changes

conda/cli/main_env_update.py Outdated Show resolved Hide resolved

jaimergp reviewed Jun 27, 2025

View reviewed changes

conda/misc.py Outdated Show resolved Hide resolved

soapy1 and others added 17 commits July 2, 2025 08:15

Fix tests

4ceb726

Requirements and explicit specs should skip building an environment yaml

75524c8

Remove explicit file handling from the environment yaml model

e01148c

Fix conda installer tests

d895bc5

Fix tests

6eedd9f

Refactor explicit install

6cb2a5d

[pre-commit.ci] auto fixes from pre-commit.com hooks

fe91c00

for more information, see https://pre-commit.ci

Fix some code style

9672e2d

Co-authored-by: jaimergp <jaimergp@users.noreply.github.com>

Raise error for SpecNotFoundInPackageCache

1006b1d

Rely on PFE to only download packages that aren't already in the cache

a6d8d39

[pre-commit.ci] auto fixes from pre-commit.com hooks

c164c6a

for more information, see https://pre-commit.ci

Add news

1ef6cd7

Apply suggestions from code review

793f031

Co-authored-by: Ken Odegard <kodegard@anaconda.com>

Don't modify self when exporting env

8e247cc

Rename env spec environment -> env

93bf5bc

Co-authored-by: Ken Odegard <kodegard@anaconda.com>

Flatten out installing using env command logic

c34e2a0

[pre-commit.ci] auto fixes from pre-commit.com hooks

95f62f8

for more information, see https://pre-commit.ci

soapy1 force-pushed the env-spec-env-model branch from ef7ed2a to 95f62f8 Compare July 2, 2025 15:15

kenodegard requested changes Jul 2, 2025

View reviewed changes

conda/env/specs/binstar.py Outdated Show resolved Hide resolved

conda/env/specs/requirements.py Outdated Show resolved Hide resolved

conda/env/specs/yaml_file.py Outdated Show resolved Hide resolved

news/14937-return-environment-model Outdated Show resolved Hide resolved

github-project-automation bot moved this from ✅ Approved to 🏗️ In Progress in 🔎 Review Jul 2, 2025

soapy1 and others added 2 commits July 2, 2025 09:08

Update deprecation dates

fe5fa8c

Co-authored-by: Ken Odegard <kodegard@anaconda.com>

Update news/14937-return-environment-model

ce38b4d

Co-authored-by: Ken Odegard <kodegard@anaconda.com>

soapy1 mentioned this pull request Jul 2, 2025

Rename env.env.Environment to env.env.EnvironmentYaml #14981

Merged

3 tasks

jezdez approved these changes Jul 2, 2025

View reviewed changes

soapy1 requested a review from kenodegard July 2, 2025 17:12

kenodegard approved these changes Jul 2, 2025

View reviewed changes

github-project-automation bot moved this from 🏗️ In Progress to ✅ Approved in 🔎 Review Jul 2, 2025

soapy1 merged commit 9c502c7 into conda:main Jul 2, 2025
75 checks passed

github-project-automation bot moved this from ✅ Approved to 🏁 Done in 🔎 Review Jul 2, 2025

soapy1 deleted the env-spec-env-model branch July 2, 2025 20:23

		@@ -4,9 +4,12 @@

		import pytest

		from conda.env.env import Environment

Environment Spec plugins should return an Environment model #14937

Environment Spec plugins should return an Environment model #14937

Uh oh!

Conversation

soapy1 commented Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist - did you ...

Uh oh!

codspeed-hq bot commented Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging #14937 will not alter performance

Summary

Uh oh!

jezdez commented Jun 25, 2025

Uh oh!

soapy1 commented Jun 25, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codspeed-hq bot commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging #14937 will not alter performance

Summary

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

soapy1 commented Jun 26, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

soapy1 commented Jun 13, 2025 •

edited

Loading

codspeed-hq bot commented Jun 13, 2025 •

edited

Loading

codspeed-hq bot commented Jun 25, 2025 •

edited

Loading