Deprecating `conda_build.conda_interface` #5222

beeankha · 2024-03-08T19:02:43Z

Description

Miscellaneous deprecations that were pending in conda_build.conda_interface are being done here, which encourages conda-build and other downstream projects to import from conda directly.

Note: cc_conda_build deprecation will be handled in a separate PR as it will involve some refactoring work.

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?~~

beeankha · 2024-03-08T21:41:35Z

pre-commit.ci autofix

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

ryanskeith

Other than a small ask to expand a comment. This all looks great.

conda_build/__init__.py

jezdez · 2024-03-15T20:03:01Z

conda_build/__init__.py

+# Skip context logic for doc generation since we don't install all dependencies in the CI doc build environment,
+# see .readthedocs.yml file


I would argue this is a bug and needs to be resolved by installing all dependencies in the Ci doc build environment. Maybe add caching there? Switch to setup-miniconda?

Sure but that will require that we stop using the RTD pipeline and switch to a custom workflow which is out of scope for this PR

jezdez · 2024-03-15T20:03:12Z

conda_build/__init__.py

+    reset_context()
+
+except ImportError:
+    pass


This code will be run on every import of conda_build and seems like an overreach to fix a documentation rendering issue.

I would suggest to either

make this conditional on the default Read The Doc environment variables or the equivalent for GitHub Actions (CI) (messy), or

move this into a custom Sphinx extension (how-to, basically a module with a setup(app) function) (clean).

This is supposed to run for ALL imports of conda_build, it's only for docs rendering that we don't need this

Gotcha, I'd appreciate if we'd not have to handle the special case for the docs here though. Ultimately it's not a huge deal though.

refs: - conda/conda-build#5222 - https://github.com/conda/conda-build/blob/24.1.2/conda_build/conda_interface.py#L15 - https://github.com/conda/conda-build/blob/24.1.2/conda_build/conda_interface.py#L95 - https://github.com/conda/conda-build/blob/24.1.2/conda_build/conda_interface.py#L104 - https://github.com/conda/conda-build/blob/24.1.2/conda_build/conda_interface.py#L114 - https://github.com/conda/conda/blob/24.1.2/conda/utils.py#L235 Signed-off-by: Marcel Bargull <[email protected]>

conda_build.conda_interface is goind to be marked for deprecation. refs: - conda/conda-build#5222 Signed-off-by: Marcel Bargull <[email protected]>

conda_build.conda_interface is going to be marked for deprecation. refs: - conda/conda-build#5222 Signed-off-by: Marcel Bargull <[email protected]>

conda_build.conda_interface.get_index (which is conda.exports.get_index) is using the conda.models.Dist -> conda.models.records.PackageRecord mapping. Dist class is legacy code that's being phased out, so avoid it. refs: - conda/conda-build#5152 - conda/conda-build#5222 Signed-off-by: Marcel Bargull <[email protected]>

conda_build.conda_interface is being deprecated. conda_build.conda_interface.get_index (which is conda.exports.get_index) is using the conda.models.Dist -> conda.models.records.PackageRecord mapping. Dist class is legacy code that's being phased out, so avoid it. refs: - conda/conda-build#5152 - conda/conda-build#5222 Signed-off-by: Marcel Bargull <[email protected]>

conda_build.conda_interface is being deprecated. refs: - conda/conda-build#5222 Signed-off-by: Marcel Bargull <[email protected]>

conda_build.conda_interface is being deprecated. conda_build.conda_interface.get_index (which is conda.exports.get_index) is using the conda.models.dist.Dist -> conda.models.records.PackageRecord mapping. Dist class is legacy code that's being phased out, so avoid it. refs: - conda/conda-build#5152 - conda/conda-build#5222 Signed-off-by: Marcel Bargull <[email protected]>

jezdez · 2024-03-19T15:11:07Z

conda_build/__init__.py

+    reset_context()
+
+except ImportError:
+    pass


Gotcha, I'd appreciate if we'd not have to handle the special case for the docs here though. Ultimately it's not a huge deal though.

codspeed-hq · 2024-03-19T15:37:20Z

CodSpeed Performance Report

Merging #5222 will not alter performance

_{Comparing beeankha:remove-conda_interface (fab3d1c) with main (f3615dc)}

Summary

✅ 2 untouched benchmarks

Deprecate CONDA_VERSION and binstar_upload constants

f4db0dc

conda-bot added the cla-signed [bot] added once the contributor has signed the CLA label Mar 8, 2024

beeankha assigned kenodegard and beeankha Mar 8, 2024

beeankha added source::anaconda created by members of Anaconda, Inc. type::deprecation requests removal of deprecated feature(s) labels Mar 8, 2024

Merge branch 'main' into remove-conda_interface

50846b0

pre-commit-ci bot and others added 19 commits March 8, 2024 21:42

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

c90eb18

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

Merge branch 'main' into remove-conda_interface

a8a6c62

Bump deprecation versions

606c956

Deprecating default_python

e21eb63

Deprecating envs_dirs

5d27d38

Deprecating pkgs_dirs

0d5b02c

Deprecating cc_platform

aa4df8e

Deprecate root_dir

051993a

Deprecate root_writable

63922d0

Add news file

8d1e071

Deprecate subdir constant

d9fa624

Deprecate create_default_packages

4e9180d

Deprecate get_rc_urls

72df1cb

Deprecate get_prefix

c2aa957

Deprecate get_conda_channel

f8c9b1e

Move CONDA_ALLOW_SOFTLINKS

efd79ac

Update reset_context() imports

2faec88

Deprecate conda_build.conda_interface.reset_context function

b3c6823

Wrap CONDA_ALLOW_SOFTLINKS in try-except for docs

60e4a34

beeankha marked this pull request as ready for review March 13, 2024 19:29

beeankha requested a review from a team as a code owner March 13, 2024 19:29

isuruf mentioned this pull request Mar 13, 2024

conda_build.conda_interface is getting deprecated conda-forge/conda-forge.github.io#2117

Closed

17 tasks

ryanskeith previously approved these changes Mar 14, 2024

View reviewed changes

conda_build/__init__.py Outdated Show resolved Hide resolved

beeankha commented Mar 14, 2024

View reviewed changes

conda_build/__init__.py Outdated Show resolved Hide resolved

beeankha dismissed ryanskeith’s stale review via c8c9bf7 March 14, 2024 19:48

Update conda_build/__init__.py

c8c9bf7

kenodegard approved these changes Mar 15, 2024

View reviewed changes

jezdez reviewed Mar 15, 2024

View reviewed changes

mbargull added a commit to mbargull/conda-smithy that referenced this pull request Mar 16, 2024

Stop using conda_build.conda_interface

f369cfb

conda_build.conda_interface is goind to be marked for deprecation. refs: - conda/conda-build#5222 Signed-off-by: Marcel Bargull <[email protected]>

mbargull added a commit to mbargull/conda-smithy that referenced this pull request Mar 16, 2024

Stop using conda_build.conda_interface

354a0f2

conda_build.conda_interface is going to be marked for deprecation. refs: - conda/conda-build#5222 Signed-off-by: Marcel Bargull <[email protected]>

mbargull mentioned this pull request Mar 16, 2024

Address conda-build deprecations conda-forge/conda-smithy#1868

Merged

1 task

mbargull mentioned this pull request Mar 16, 2024

Stop using conda_build.conda_interface conda-forge/cdt-builds#69

Merged

5 tasks

mbargull mentioned this pull request Mar 16, 2024

Stop using conda_build.conda_interface conda-forge/conda-forge-webservices#577

Merged

2 tasks

mbargull mentioned this pull request Mar 16, 2024

Stop using conda_build.conda_interface regro/conda-forge-feedstock-check-solvable#20

Merged

mbargull mentioned this pull request Mar 16, 2024

Address conda-build deprecations conda-forge/staged-recipes#25762

Merged

kenodegard changed the title ~~Deprecating conda_build.conda_interface.py~~ Deprecating conda_build.conda_interface Mar 17, 2024

h-vetinari mentioned this pull request Mar 19, 2024

Bump 24.3.0 conda-forge/conda-feedstock#232

Merged

5 tasks

jezdez approved these changes Mar 19, 2024

View reviewed changes

Merge branch 'main' into remove-conda_interface

fab3d1c

beeankha enabled auto-merge (squash) March 19, 2024 15:36

beeankha merged commit 1bfee9f into conda:main Mar 19, 2024
28 checks passed

kenodegard mentioned this pull request Apr 11, 2024

Finish conda_build.conda_interface deprecations #5276

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecating `conda_build.conda_interface` #5222

Deprecating `conda_build.conda_interface` #5222

beeankha commented Mar 8, 2024 •

edited by kenodegard

Loading

beeankha commented Mar 8, 2024

ryanskeith left a comment

jezdez Mar 15, 2024

kenodegard Mar 15, 2024

jezdez Mar 15, 2024 •

edited

Loading

kenodegard Mar 15, 2024

jezdez Mar 19, 2024

jezdez Mar 19, 2024

codspeed-hq bot commented Mar 19, 2024

		# Skip context logic for doc generation since we don't install all dependencies in the CI doc build environment,
		# see .readthedocs.yml file

Deprecating conda_build.conda_interface #5222

Deprecating conda_build.conda_interface #5222

Conversation

beeankha commented Mar 8, 2024 • edited by kenodegard Loading

Description

Checklist - did you ...

beeankha commented Mar 8, 2024

ryanskeith left a comment

Choose a reason for hiding this comment

jezdez Mar 15, 2024

Choose a reason for hiding this comment

kenodegard Mar 15, 2024

Choose a reason for hiding this comment

jezdez Mar 15, 2024 • edited Loading

Choose a reason for hiding this comment

kenodegard Mar 15, 2024

Choose a reason for hiding this comment

jezdez Mar 19, 2024

Choose a reason for hiding this comment

jezdez Mar 19, 2024

Choose a reason for hiding this comment

codspeed-hq bot commented Mar 19, 2024

CodSpeed Performance Report

Merging #5222 will not alter performance

Summary

Deprecating `conda_build.conda_interface` #5222

Deprecating `conda_build.conda_interface` #5222

beeankha commented Mar 8, 2024 •

edited by kenodegard

Loading

jezdez Mar 15, 2024 •

edited

Loading