Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow querying the contents of settings.yml (and settings_user!) from ConfigAPI #15151

Merged
merged 7 commits into from
Nov 24, 2023
Merged

Allow querying the contents of settings.yml (and settings_user!) from ConfigAPI #15151

merged 7 commits into from
Nov 24, 2023

Conversation

AbrilRBS
Copy link
Member

@AbrilRBS AbrilRBS commented Nov 21, 2023 •
edited by czoido
Loading

Changelog: Feature: Allow accessing the contents of settings.yml (and settings_user!) from ConfigAPI.
Changelog: Feature: Add builtin conf access from ConfigAPI.
Docs: Omit

Closes #15125

@AbrilRBS AbrilRBS added this to the 2.0.15 milestone Nov 21, 2023
memsharded
memsharded approved these changes Nov 21, 2023
View reviewed changes
Copy link
Member

@memsharded memsharded left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

conan/api/subapi/config.py Outdated Show resolved Hide resolved
conan/cli/commands/config.py Outdated Show resolved Hide resolved
conan/api/subapi/config.py Outdated Show resolved Hide resolved
memsharded
memsharded reviewed Nov 22, 2023
View reviewed changes
Copy link
Member

@memsharded memsharded left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

@AbrilRBS
Copy link
Member Author

Will move the sertial_print outsude its current location as a separate PR

@AbrilRBS AbrilRBS requested a review from czoido November 22, 2023 17:07
@AbrilRBS AbrilRBS marked this pull request as ready for review November 22, 2023 17:11
@czoido
Copy link
Contributor

czoido commented Nov 23, 2023 •
edited
Loading

I was thinking if instead of adding such an specific subcommand as conan config settings-yml we could do a more generic command such as conan config view that can accept other configuration files. As this is also adding the user settings and it's not the contents of the settings.yml directly maybe it would be something like this?

$ conan config view settings
# if we don't care that's not exactly the contents of the file we could do
$ conan config view settings.yml

Should we add another command that locates the config files? Like:

$ conan config locate settings.yml

@AbrilRBS
Copy link
Member Author

I've now simplified this PR to only the requested API changes, as we're not sure this is useful outside super specific cases - We'll be happy to reevaluate this if needs arise for this feature, but until then let's not complicate ourselves

@czoido czoido merged commit 0d9f52f into conan-io:release/2.0 Nov 24, 2023
2 checks passed
@AbrilRBS AbrilRBS deleted the rr/settings-yml-api branch November 24, 2023 09:24
AbrilRBS added a commit to AbrilRBS/conan that referenced this pull request Dec 18, 2023
@AbrilRBS
Squashed commit of the following:
5faf53f 
commit 98d8f6a
Author: Rubén Rincón Blanco <rubenrb@jfrog.com>
Date:   Sun Dec 17 20:37:54 2023 +0100

    Try to address NMakeDeps quoting issues (conan-io#15140)

    * Better spacing and quotes for defines in NMakeDeps

    * No need to escape parenthesis in defines

    * Fix tests

    * Follow proper syntax definition

    * Add numeric test

    * Ensure functional tests cover the quoting

    * Add test for space in values

    * fix values with whitespace in nmaketoolchain defines

    * fix nmakedeps and test

    * simplify

    * review

    ---------

    Co-authored-by: danimtb <danimanzaneque@gmail.com>

commit 94a3549
Author: memsharded <james@conan.io>
Date:   Sat Dec 16 23:45:06 2023 +0100

    fix broken test after source() VirtualBuildEnv

commit 6958893
Author: James <james@conan.io>
Date:   Fri Dec 15 14:00:05 2023 +0100

    Define toolset and architecture in CMakePresets.json for VS to avoid mismatches (conan-io#15215)

    * checking what breaks

    * fix test

    * testing it really fix something

    * wip

    * wip

commit 7921be1
Author: James <james@conan.io>
Date:   Fri Dec 15 12:45:07 2023 +0100

    adding tools.microsoft:winsdk_version conf (conan-io#15272)

    * adding tools.microsoft:winsdk_version conf

    * fix tests

    * wip

    * fix

    * review

commit 018441d
Author: James <james@conan.io>
Date:   Fri Dec 15 12:38:10 2023 +0100

    new CMake.ctest() method (conan-io#15282)

commit 053f22a
Author: James <james@conan.io>
Date:   Fri Dec 15 12:23:57 2023 +0100

    Feature/cmakedeps legacy adapter (conan-io#15207)

    * reusing fixture, will reduce CI time

    * proposal for legacy cmake-like generator

    * better ux for VS not found error (conan-io#15250)

    * better ux

    * improve

    * Update conan/tools/microsoft/visual.py

    Co-authored-by: Rubén Rincón Blanco <git@rinconblanco.es>

    ---------

    Co-authored-by: Rubén Rincón Blanco <git@rinconblanco.es>

    * fix and remove more xfails (conan-io#15251)

    fix and remove xfails

    * Fix/save restore portable (conan-io#15253)

    * make save-restore portable

    * msg

    * require-replaces proposal (conan-io#15136)

    * wip

    * test passing

    * wip

    * wip

    * wip

    * wip

    * wip

    * wip

    * new approach

    * extra checks

    * more tests

    * review

    * Fix failing tests in macos (conan-io#15255)

    Fix tests in macos

    * Add test to ensure &: syntax works in `--requires` install (conan-io#15258)

    Add test to ensure &: syntax qorks in --requires install

    * add CONAN_LOG_LEVEL env-var (conan-io#15263)

    * add CONAN_LOG_LEVEL env-var

    * Update conan/cli/command.py

    ---------

    Co-authored-by: Francisco Ramírez <franchuti688@gmail.com>

    * review

    * review

    ---------

    Co-authored-by: Rubén Rincón Blanco <git@rinconblanco.es>
    Co-authored-by: Rubén Rincón Blanco <rubenrb@jfrog.com>
    Co-authored-by: Francisco Ramírez <franchuti688@gmail.com>

commit 9afacb4
Author: Rubén Rincón Blanco <rubenrb@jfrog.com>
Date:   Fri Dec 15 11:32:21 2023 +0100

    Add different ref tracking syntax for  `<host_version>` (conan-io#15274)

    * Use light=True where possible in build_requires tests

    * Sketch for allowing tracking of different ref

    * Add remote input to build-map command

    * Update conans/client/graph/graph_builder.py

    Co-authored-by: James <memsharded@gmail.com>

    * Update conans/client/graph/graph_builder.py

    Co-authored-by: James <memsharded@gmail.com>

    * Update conans/client/graph/graph_builder.py

    Co-authored-by: James <memsharded@gmail.com>

    * Fix tests

    ---------

    Co-authored-by: James <memsharded@gmail.com>

commit 92af096
Author: Luis Caro Campos <3535649+jcar87@users.noreply.github.com>
Date:   Fri Dec 15 10:10:45 2023 +0000

    Add pyproject.toml (conan-io#15186)

    * Move to pyproject.toml

    * Exclude conan server

    * Try adding a line

    * Upgrade pip in venv

    * update setuptools too

    * Read version from conans.__init__

    * Restore setup.py for compatibility

    * Minimal pyproject toml

    * Restore setup.py

    * Restore jenkinsfile

commit 0c786c5
Author: Carlos Zoido <mrgalleta@gmail.com>
Date:   Fri Dec 15 01:36:22 2023 +0100

    Add environment information to CMakePresets (conan-io#15192)

    * build to config and run to test preset

    * first draft

    * revert

    * wip

    * fix format

    * test ctest

    * simplify

    * get env in right place

    * move test

    * fix windows

    * hopefully fix tests

    * fix test

    * fix test again

    * simplify test

    * add opt-out

    * wip

    * auto_generate for run env

    * minor changes

commit 5becb2a
Author: Juan <35701596+juansblanco@users.noreply.github.com>
Date:   Thu Dec 14 15:58:32 2023 +0100

    Make paths format in layout consistent on Windows (conan-io#15260)

    Changelog: Omit
    Docs: Omit

commit 9f023c3
Author: James <james@conan.io>
Date:   Thu Dec 14 15:48:28 2023 +0100

    proposal for source() buildenv discussion (conan-io#15153)

    * proposal for source() buildenv discussion

    * wip, failing

    * trying alternative opt-in class attribute

    * fix

    * wip

    * wip

    * add cmake_layout test

    * wip

    * named auto_generate

commit 0843372
Author: James <james@conan.io>
Date:   Thu Dec 14 12:34:54 2023 +0100

    fix migration lru (conan-io#15135)

    * fix migration lru

    * fix back migration

commit c655809
Author: Carlos Zoido <mrgalleta@gmail.com>
Date:   Wed Dec 13 16:32:02 2023 +0100

    Add pkglist formatter for conan export command (conan-io#15266)

    add pkglist formatter and test

commit d0e6a3f
Author: James <james@conan.io>
Date:   Wed Dec 13 13:59:50 2023 +0100

    optimize test (conan-io#15214)

    * optimize test

    * fixes

    * fix

commit 6f3f445
Author: James <james@conan.io>
Date:   Wed Dec 13 12:57:00 2023 +0100

    add CONAN_LOG_LEVEL env-var (conan-io#15263)

    * add CONAN_LOG_LEVEL env-var

    * Update conan/cli/command.py

    ---------

    Co-authored-by: Francisco Ramírez <franchuti688@gmail.com>

commit 032eefc
Author: Rubén Rincón Blanco <rubenrb@jfrog.com>
Date:   Tue Dec 12 19:43:09 2023 +0100

    Add test to ensure &: syntax works in `--requires` install (conan-io#15258)

    Add test to ensure &: syntax qorks in --requires install

commit 694b7d1
Author: Rubén Rincón Blanco <rubenrb@jfrog.com>
Date:   Tue Dec 12 14:57:14 2023 +0100

    Fix failing tests in macos (conan-io#15255)

    Fix tests in macos

commit 286d552
Author: James <james@conan.io>
Date:   Tue Dec 12 14:16:18 2023 +0100

    require-replaces proposal (conan-io#15136)

    * wip

    * test passing

    * wip

    * wip

    * wip

    * wip

    * wip

    * wip

    * new approach

    * extra checks

    * more tests

    * review

commit 7aa0b4b
Author: James <james@conan.io>
Date:   Tue Dec 12 12:21:02 2023 +0100

    Fix/save restore portable (conan-io#15253)

    * make save-restore portable

    * msg

commit 1c43d5f
Author: James <james@conan.io>
Date:   Tue Dec 12 09:43:07 2023 +0100

    fix and remove more xfails (conan-io#15251)

    fix and remove xfails

commit 2717bbe
Author: James <james@conan.io>
Date:   Mon Dec 11 20:06:14 2023 +0100

    better ux for VS not found error (conan-io#15250)

    * better ux

    * improve

    * Update conan/tools/microsoft/visual.py

    Co-authored-by: Rubén Rincón Blanco <git@rinconblanco.es>

    ---------

    Co-authored-by: Rubén Rincón Blanco <git@rinconblanco.es>

commit 5ef6824
Author: James <james@conan.io>
Date:   Mon Dec 11 15:18:06 2023 +0100

    drop --build unused patterns unused functionality (conan-io#15233)

commit 1d058e9
Author: James <james@conan.io>
Date:   Mon Dec 11 13:47:21 2023 +0100

    fix deploy absolute folders (conan-io#15244)

    * fix deploy absolute folders

    * fix tests

commit 63ee9c7
Author: James <james@conan.io>
Date:   Mon Dec 11 07:59:37 2023 +0100

    allow hard set_name() set_version() (conan-io#15211)

commit 37573ee
Author: James <james@conan.io>
Date:   Thu Dec 7 15:09:24 2023 +0100

    Tests maintenance, fix some xfail, remove other xfails (conan-io#15234)

    remove xfail

commit e6aa291
Author: Rubén Rincón Blanco <rubenrb@jfrog.com>
Date:   Thu Dec 7 15:04:23 2023 +0100

    Add `in` operator support for ConanFile's `self.dependencies` (conan-io#15221)

    * Add in operator support for ConanFile self.dependencies

    * Ensure tool_requires also work

commit a6f42bf
Author: Rubén Rincón Blanco <rubenrb@jfrog.com>
Date:   Wed Dec 6 12:57:44 2023 +0100

    Fix range escaping in conflict reports involving ranges (conan-io#15222)

    * Add failing test that should pass after issue is fixed

    * Fix range escaping in conflict reports involving ranges

commit acbaf44
Author: Rubén Rincón Blanco <rubenrb@jfrog.com>
Date:   Mon Dec 4 23:16:38 2023 +0100

    Fix `conan graph explain` binary distance calculation (conan-io#15212)

    * Bugfix binary distance calculation

    * Add proper distance culling test

commit 5493a77
Author: James <james@conan.io>
Date:   Mon Dec 4 08:27:53 2023 +0100

    reusing fixture, will reduce CI time (conan-io#15204)

commit 412a027
Author: James <james@conan.io>
Date:   Fri Dec 1 13:58:04 2023 +0100

    New [platform_requires]  similar to system-tools, but for all requires (conan-io#14871)

    * wip

    * test passing

    * wip

    * wip

    * wip

    * wip

    * wip

    * renaming and review

    * fixes

    * add missing dumps

    * Simplified if-else clauses. Keeping more prio for platform_tool_requires

    * Renamed first naming proposal

    * review test, new check

    * fix test

    * fix

    ---------

    Co-authored-by: Francisco Ramirez de Anton <franchuti688@gmail.com>

commit 1f548d8
Author: Luis Caro Campos <3535649+jcar87@users.noreply.github.com>
Date:   Fri Dec 1 09:57:43 2023 +0000

    Fix pyinstaller script on Windows (conan-io#15194)

commit dc98b6a
Author: Rubén Rincón Blanco <rubenrb@jfrog.com>
Date:   Fri Dec 1 10:25:16 2023 +0100

    Fix `conan graph info --format=html` reporting misleading conflicting nodes (conan-io#15196)

    * Fix graph info --format=html conflict report misleading nodes

    * Add node map test

commit 3f3fd45
Author: memsharded <james@conan.io>
Date:   Thu Nov 30 00:33:54 2023 +0100

    wip

commit 9145028
Author: Rubén Rincón Blanco <rubenrb@jfrog.com>
Date:   Wed Nov 29 22:47:57 2023 +0100

    Add `redirect_stdout` to CMake integration methods (conan-io#15150)

    * Add redirect_stdout to CMake integration methods

    * Fix windows tests

    * Simplify tests

    * Directly pass stdout & stderr streams instead of files

    * Ensure outputs are redirected to the correct streams

    * Fix unittests

    * Update conans/test/functional/toolchains/cmake/test_cmake_toolchain.py

    Co-authored-by: Carlos Zoido <mrgalleta@gmail.com>

    * Remove unused method

    * Add cmake.test stdout test, fix failing test

    * Simpify testing

    * Change testing approach for build

    * Change testing approach for build

    * Finally fix tests (hopefully)

    * Simplify tests

    * Comment wording

    * Check for emptyness in Windows

    ---------

    Co-authored-by: Carlos Zoido <mrgalleta@gmail.com>

commit 71d863a
Author: James <james@conan.io>
Date:   Wed Nov 29 17:17:48 2023 +0100

    poc for filtering lists with profile-like inputs (conan-io#14694)

    * poc for filtering lists with profile-like inputs

    * per-package and options and distance

    * wip

    * wip

    * wip

    * refactor list format compact

    * wip

    * wip

    * ready

    * fix test

    * fix tests

    * converted to graph find-binaries approach

    * wip

    * review

    * Create custom formatters to ensure we can expand the command in the future

    * review

    ---------

    Co-authored-by: Rubén Rincón <rubenrb@jfrog.com>

commit 25070c1
Author: Luis Caro Campos <3535649+jcar87@users.noreply.github.com>
Date:   Wed Nov 29 14:02:38 2023 +0000

    Cleanup pyinstall.py (conan-io#15188)

commit 29e9f95
Author: James <james@conan.io>
Date:   Wed Nov 29 10:58:08 2023 +0100

    proposal for deploy() feature (conan-io#15172)

    * proposal for deploy() feature

    * rename argument --deploy-package

    * rename arg

commit f0a1b35
Author: Rubén Rincón Blanco <rubenrb@jfrog.com>
Date:   Tue Nov 28 15:45:17 2023 +0100

    Fix serialization of tool_requires in `conan profile show --format=json` (conan-io#15185)

    * Fix serialization of tool_requires in profile show --format=json

    * Serialize recipe reference as repr in profile tool_requires

    * Fix test

commit a5605d1
Author: James <james@conan.io>
Date:   Tue Nov 28 14:29:54 2023 +0100

    Refactor ``conan list --format=compact`` format code (conan-io#15177)

    * refactor list format compact

    * wip

    * wip

commit 2e56813
Author: Rubén Rincón Blanco <rubenrb@jfrog.com>
Date:   Mon Nov 27 16:47:23 2023 +0100

    Add test showing that `configure()` can be used to set `deprecated` (conan-io#15180)

    Add test showing that configure can set deprecated option just fin

commit 65ec31c
Author: Juan <35701596+juansblanco@users.noreply.github.com>
Date:   Sat Nov 25 08:01:42 2023 +0100

    Removed conan migration compatibility warning (conan-io#15174)

    removed warning and related test

commit dde76f6
Author: Rubén Rincón Blanco <rubenrb@jfrog.com>
Date:   Fri Nov 24 19:20:32 2023 +0100

    Fix `conan graph info --format=text` being printed to stderr (conan-io#15170)

    Fix graph info --format=text being printed to stderr

commit 0d9f52f
Author: Rubén Rincón Blanco <rubenrb@jfrog.com>
Date:   Fri Nov 24 07:00:27 2023 +0100

    Allow querying the contents of settings.yml (and settings_user!) from ConfigAPI (conan-io#15151)

    * Allow querying the contents of settings.yml (and settings_user!) from the API

    * Add tests

    * Pretty print settings, make ConfigAPI.builtin_confs a @Property

    * Fix tests, ensure null is properly printed

    * Remove conan config settings command until it's asked by someone

    * Remove unneeded test

    * Remove unused import
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@memsharded memsharded memsharded approved these changes

@czoido czoido czoido approved these changes

Assignees

@czoido czoido

Labels
None yet
Projects
None yet
Milestone
2.0.15
Development

Successfully merging this pull request may close these issues.

[question][api] Access to possible_values settings after version 2.0.14
3 participants
@AbrilRBS @czoido @memsharded