feat: add customFields property to Experiment#125
Open
vazarkevych wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds support for Custom Fields in Experiments, allowing developers to access
custom metadata defined in the GrowthBook UI through the Python SDK.
What Changed
customFieldsproperty to theExperimentclass (defaults to{})customFieldsfrom the API response duringExperimentconstructioncustomFieldsinto_dict()when non-emptyWhy
GrowthBook UI allows defining Custom Fields for experiments (e.g. team
ownership, ticket links, metric type). The API returns these under a flat
customFieldsobject, but the Python SDK previously dropped the field duringparsing, making it inaccessible to developers even when the API returned it.
Test plan
test_custom_fields_parsed_from_api_dict— parses string and numeric values from the API dicttest_custom_fields_default_when_absent— defaults to{}and is omitted fromto_dict()when emptytest_custom_fields_public_init— works via the public constructorAll 545 tests in
tests/test_growthbook.pypass.