feat(api): add support for project feature flags and feature flag user lists by amimas · Pull Request #3366 · python-gitlab/python-gitlab

amimas · 2026-03-09T23:09:05Z

Changes

This change introduces support for managing Project Feature Flags and Feature Flag User Lists via the API and CLI.

It adds the ProjectFeatureFlag and ProjectFeatureFlagUserList objects and their corresponding managers, which are exposed on the Project object as project.feature_flags and project.feature_flags_user_lists.

To support the specific data formats required by these GitLab APIs, this change also introduces:

JsonAttribute: A new attribute type to handle the strategies field, which is sent as a JSON object.
CommaSeparatedStringAttribute: A new attribute type to handle the user_xids field, which is sent as a comma-separated string.

Additionally, a custom save() method has been implemented for ProjectFeatureFlag to correctly handle renaming, as the flag's name is also its unique identifier.

The implementation includes:

API object and manager definitions.
Functional API tests.
Functional CLI tests.
Unit tests for the new attribute types and the custom renaming logic.

Documentation and testing

Please consider whether this PR needs documentation and tests. This is not required, but highly appreciated:

Documentation in the matching docs section
Unit tests and/or functional tests

Documentation updates:

Added new documentation pages for Project Feature Flags and Feature Flag User Lists.
Renamed the existing features.rst to gitlab_features.rst and updated its content to clearly distinguish that this API/feature is for admin-only GitLab Development Feature Flags - not for project-level feature flags.

References:

Support for following API is being included in this PR

GitLab Project Feature Flag API: https://docs.gitlab.com/api/feature_flags/
GitLab Project Feature Flag User List API: https://docs.gitlab.com/api/feature_flag_user_lists/

Documentation changed/clarified related to following existing feature in python-gitlab

API on Feature flag for GitLab Development: https://docs.gitlab.com/api/features/

closes #3350

codecov · 2026-03-10T00:53:33Z

Codecov Report

❌ Patch coverage is 95.83333% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 95.75%. Comparing base (8d76028) to head (3b1293d).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
gitlab/v4/objects/feature_flags.py	92.10%	3 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3366   +/-   ##
=======================================
  Coverage   95.75%   95.75%           
=======================================
  Files          98      100    +2     
  Lines        6054     6125   +71     
=======================================
+ Hits         5797     5865   +68     
- Misses        257      260    +3

Flag	Coverage Δ
api_func_v4	`83.78% <90.27%> (+0.12%)`	⬆️
cli_func_v4	`78.57% <70.83%> (-0.10%)`	⬇️
unit	`90.23% <94.44%> (+0.06%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
gitlab/types.py	`98.52% <100.00%> (+0.28%)`	⬆️
gitlab/utils.py	`98.59% <100.00%> (ø)`
gitlab/v4/objects/__init__.py	`100.00% <100.00%> (ø)`
gitlab/v4/objects/feature_flag_user_lists.py	`100.00% <100.00%> (ø)`
gitlab/v4/objects/projects.py	`98.95% <100.00%> (+0.01%)`	⬆️
gitlab/v4/objects/feature_flags.py	`92.10% <92.10%> (ø)`

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot

Pull request overview

This PR adds support for managing Project Feature Flags and Feature Flag User Lists in python-gitlab, enabling users to interact with the GitLab Feature Flags API and Feature Flag User Lists API via both the Python API client and CLI.

Changes:

Adds two new API object files (feature_flags.py and feature_flag_user_lists.py) with custom save() logic in ProjectFeatureFlag to support renaming via the original name in the URL
Introduces two new GitlabAttribute types: JsonAttribute (for parsing/sending JSON from the CLI) and CommaSeparatedStringAttribute (for transforming lists to CSV strings in POST/PUT bodies), plus a transform_in_post hook in utils._transform_types
Adds unit tests for the new attribute types and renaming logic, functional API tests, functional CLI tests, and updated/new documentation pages

Reviewed changes

Copilot reviewed 18 out of 18 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
`gitlab/v4/objects/feature_flags.py`	New `ProjectFeatureFlag` and `ProjectFeatureFlagManager` with custom save/rename logic
`gitlab/v4/objects/feature_flag_user_lists.py`	New `ProjectFeatureFlagUserList` and `ProjectFeatureFlagUserListManager`
`gitlab/v4/objects/__init__.py`	Adds exports for the two new object modules
`gitlab/v4/objects/projects.py`	Attaches the two new managers to `Project`
`gitlab/types.py`	New `JsonAttribute` and `CommaSeparatedStringAttribute` types
`gitlab/utils.py`	Extended `_transform_types` with `transform_in_post` support
`tests/unit/test_types.py`	Unit tests for the two new attribute types
`tests/unit/objects/test_project_feature_flags.py`	Unit test for rename save behavior
`tests/unit/objects/test_project_feature_flag_user_lists.py`	Unit test for list→CSV transformation in POST body
`tests/functional/api/test_project_feature_flags.py`	Functional API tests (CRUD + rename + strategy/scope deletion)
`tests/functional/api/test_project_feature_flag_user_lists.py`	Functional API tests (CRUD + search)
`tests/functional/cli/test_cli_project_feature_flags.py`	Functional CLI tests (CRUD + strategy creation)
`tests/functional/cli/test_cli_project_feature_flag_user_lists.py`	Functional CLI tests (CRUD)
`docs/gl_objects/project_feature_flags.rst`	New documentation page for feature flags
`docs/gl_objects/project_feature_flag_user_lists.rst`	New documentation page for user lists
`docs/gl_objects/gitlab_features.rst`	Renamed/clarified admin-only GitLab dev features doc
`docs/gl_objects/projects.rst`	Added references to the two new documentation pages
`docs/api-objects.rst`	Updated ToC to reference renamed and new docs

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

tests/unit/test_types.py

tests/unit/objects/test_project_feature_flags.py

tests/unit/objects/test_project_feature_flag_user_lists.py

amimas · 2026-03-10T15:13:08Z

/rerun-workflow "Test / functional (cli_func_v4)"

amimas · 2026-03-10T15:58:58Z

/rerun-workflow "Test / functional (api_func_v4)"

Copilot

Pull request overview

Copilot reviewed 18 out of 18 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

gitlab/types.py

JohnVillalovos

@amimas Thanks for the PR!

I left some comments/questions.

docs/gl_objects/gitlab_features.rst

docs/gl_objects/project_feature_flag_user_lists.rst

docs/gl_objects/project_feature_flags.rst

docs/gl_objects/projects.rst

gitlab/v4/objects/feature_flag_user_lists.py

tests/functional/api/test_project_feature_flags.py

gitlab/types.py

gitlab/utils.py

docs/gl_objects/project_feature_flags.rst

tests/functional/cli/test_cli_project_feature_flags.py

gitlab/utils.py

amimas · 2026-03-21T20:43:43Z

@JohnVillalovos - Thanks for reviewing this PR. I believe I've addressed all the feedbacks so far. Please take a look when you get a chance.

Copilot

Pull request overview

Copilot reviewed 18 out of 18 changed files in this pull request and generated 3 comments.

Comments suppressed due to low confidence (1)

docs/gl_objects/gitlab_features.rst:3

The overline/underline for the RST title is shorter than the title text (32 # vs 33 characters), which can cause Sphinx/reStructuredText formatting warnings or misrendering. Extend the delimiter lines so they are at least as long as the title.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

tests/unit/objects/test_project_feature_flags.py

tests/unit/objects/test_project_feature_flag_user_lists.py

gitlab/v4/objects/feature_flags.py

Copilot

Pull request overview

Copilot reviewed 18 out of 18 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

JohnVillalovos

Thanks @amimas

LGTM, though I will want to squash it down to one commit when it gets merged.

@nejch I thought I would give you a chance to review it too.

If I don't hear anything I will plan on merging it sometime on Monday 23-Mar-2026

amimas · 2026-03-22T14:32:17Z

Thank you @JohnVillalovos . Yes, please do squash & merge. Individual commits from this feature branch wouldn't be relevant in the main branch, in my opinion.

…r lists Add new API objects for managing project feature flags and feature flag user lists, including CRUD operations, CLI support, and renaming via save(). Introduce JsonAttribute type for handling JSON fields in request bodies (e.g., feature flag strategies). Closes python-gitlab#3350

JohnVillalovos requested a review from Copilot March 10, 2026 00:55

Copilot started reviewing on behalf of JohnVillalovos March 10, 2026 00:55 View session

Copilot AI reviewed Mar 10, 2026

View reviewed changes

tests/unit/test_types.py Outdated Show resolved Hide resolved

tests/unit/objects/test_project_feature_flags.py Outdated Show resolved Hide resolved

tests/unit/objects/test_project_feature_flag_user_lists.py Outdated Show resolved Hide resolved

amimas force-pushed the issue-3350 branch from 6cc25c6 to 2adc015 Compare March 15, 2026 21:53

JohnVillalovos force-pushed the issue-3350 branch from 2adc015 to 977ab5c Compare March 19, 2026 03:43

JohnVillalovos requested a review from Copilot March 19, 2026 03:47

Copilot AI reviewed Mar 19, 2026

View reviewed changes

gitlab/types.py Outdated Show resolved Hide resolved

JohnVillalovos reviewed Mar 19, 2026

View reviewed changes

amimas force-pushed the issue-3350 branch from 0007f5e to e132683 Compare March 21, 2026 15:28

JohnVillalovos reviewed Mar 21, 2026

View reviewed changes

gitlab/utils.py Outdated Show resolved Hide resolved

amimas mentioned this pull request Mar 21, 2026

docs(testing): document passing pytest options during local development #3367

Merged

2 tasks

amimas force-pushed the issue-3350 branch from 01b1684 to ba5b539 Compare March 21, 2026 19:25

JohnVillalovos requested a review from Copilot March 21, 2026 22:25

Copilot started reviewing on behalf of JohnVillalovos March 21, 2026 22:25 View session

Copilot AI reviewed Mar 21, 2026

View reviewed changes

tests/unit/objects/test_project_feature_flags.py Show resolved Hide resolved

tests/unit/objects/test_project_feature_flag_user_lists.py Outdated Show resolved Hide resolved

gitlab/v4/objects/feature_flags.py Outdated Show resolved Hide resolved

JohnVillalovos requested a review from Copilot March 22, 2026 06:35

Copilot started reviewing on behalf of JohnVillalovos March 22, 2026 06:36 View session

Copilot AI reviewed Mar 22, 2026

View reviewed changes

JohnVillalovos approved these changes Mar 22, 2026

View reviewed changes

JohnVillalovos force-pushed the issue-3350 branch from 6726189 to d320a40 Compare March 23, 2026 14:13

JohnVillalovos force-pushed the issue-3350 branch from d320a40 to 3b1293d Compare March 23, 2026 14:28

JohnVillalovos enabled auto-merge (rebase) March 23, 2026 14:37

JohnVillalovos merged commit be68285 into python-gitlab:main Mar 23, 2026
16 checks passed

Conversation

amimas commented Mar 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Documentation and testing

References:

Uh oh!

codecov bot commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

amimas commented Mar 10, 2026

Uh oh!

amimas commented Mar 10, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

JohnVillalovos left a comment

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!

Uh oh!

Uh oh!

amimas commented Mar 21, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

JohnVillalovos left a comment

Choose a reason for hiding this comment

Uh oh!

amimas commented Mar 22, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

amimas commented Mar 9, 2026 •

edited

Loading

codecov bot commented Mar 10, 2026 •

edited

Loading