python-gitlab 4.4.0__tar.gz → 4.5.0__tar.gz

{python-gitlab-4.4.0 → python_gitlab-4.5.0}/CHANGELOG.md

@@ -2,6 +2,292 @@
 
 
 
+## v4.5.0 (2024-05-13)
+
+### Build
+
+* build: Add "--no-cache-dir" to pip commands in Dockerfile
+
+This would not leave cache files in the built docker image.
+
+Additionally, also only build the wheel in the build phase.
+
+On my machine, before this PR, size is 74845395; after this PR, size is
+72617713. ([`4ef94c8`](https://github.com/python-gitlab/python-gitlab/commit/4ef94c8260e958873bb626e86d3241daa22f7ce6))
+
+### Chore
+
+* chore(deps): update all non-major dependencies ([`4f338ae`](https://github.com/python-gitlab/python-gitlab/commit/4f338aed9c583a20ff5944e6ccbba5737c18b0f4))
+
+* chore(deps): update gitlab/gitlab-ee docker tag to v16.11.2-ee.0 ([`9be48f0`](https://github.com/python-gitlab/python-gitlab/commit/9be48f0bcc2d32b5e8489f62f963389d5d54b2f2))
+
+* chore(deps): update dependency myst-parser to v3 ([`9289189`](https://github.com/python-gitlab/python-gitlab/commit/92891890eb4730bc240213a212d392bcb869b800))
+
+* chore(deps): update all non-major dependencies ([`65d0e65`](https://github.com/python-gitlab/python-gitlab/commit/65d0e6520dcbcf5a708a87960c65fdcaf7e44bf3))
+
+* chore(deps): update dependency jinja2 to v3.1.4 [security] ([`8ea10c3`](https://github.com/python-gitlab/python-gitlab/commit/8ea10c360175453c721ad8e27386e642c2b68d88))
+
+* chore(deps): update all non-major dependencies ([`1f0343c`](https://github.com/python-gitlab/python-gitlab/commit/1f0343c1154ca8ae5b1f61de1db2343a2ad652ec))
+
+* chore(deps): update gitlab/gitlab-ee docker tag to v16.11.1-ee.0 ([`1ed8d6c`](https://github.com/python-gitlab/python-gitlab/commit/1ed8d6c21d3463b2ad09eb553871042e98090ffd))
+
+* chore(deps): update all non-major dependencies ([`0e9f4da`](https://github.com/python-gitlab/python-gitlab/commit/0e9f4da30cea507fcf83746008d9de2ee5a3bb9d))
+
+* chore(deps): update gitlab/gitlab-ee docker tag to v16 ([`ea8c4c2`](https://github.com/python-gitlab/python-gitlab/commit/ea8c4c2bc9f17f510415a697e0fb19cabff4135e))
+
+* chore(deps): update all non-major dependencies ([`d5b5fb0`](https://github.com/python-gitlab/python-gitlab/commit/d5b5fb00d8947ed9733cbb5a273e2866aecf33bf))
+
+* chore(deps): update dependency pytest-cov to v5 ([`db32000`](https://github.com/python-gitlab/python-gitlab/commit/db3200089ea83588ea7ad8bd5a7175d81f580630))
+
+* chore: update `mypy` to 1.9.0 and resolve one issue
+
+mypy 1.9.0 flagged one issue in the code. Resolve the issue. Current
+unit tests already check that a `None` value returns `text/plain`. So
+function is still working as expected. ([`dd00bfc`](https://github.com/python-gitlab/python-gitlab/commit/dd00bfc9c832aba0ed377573fe2e9120b296548d))
+
+* chore(deps): update dependency black to v24.3.0 [security] ([`f6e8692`](https://github.com/python-gitlab/python-gitlab/commit/f6e8692cfc84b5af2eb6deec4ae1c4935b42e91c))
+
+* chore(deps): update all non-major dependencies ([`14a3ffe`](https://github.com/python-gitlab/python-gitlab/commit/14a3ffe4cc161be51a39c204350b5cd45c602335))
+
+* chore(deps): update all non-major dependencies ([`3c4dcca`](https://github.com/python-gitlab/python-gitlab/commit/3c4dccaf51695334a5057b85d5ff4045739d1ad1))
+
+* chore(deps): update all non-major dependencies ([`04c569a`](https://github.com/python-gitlab/python-gitlab/commit/04c569a2130d053e35c1f2520ef8bab09f2f9651))
+
+* chore: add tox `labels` to enable running groups of environments
+
+tox now has a feature of `labels` which allows running groups of
+environments using the command `tox -m LABEL_NAME`. For example
+`tox -m lint` which has been setup to run the linters.
+
+Bumped the minimum required version of tox to be 4.0, which was
+released over a year ago. ([`d7235c7`](https://github.com/python-gitlab/python-gitlab/commit/d7235c74f8605f4abfb11eb257246864c7dcf709))
+
+* chore: add py312 & py313 to tox environment list
+
+Even though there isn't a Python 3.13 at this time, this is done for
+the future.  tox is already configured to just warn about missing
+Python versions, but not fail if they don't exist. ([`679ddc7`](https://github.com/python-gitlab/python-gitlab/commit/679ddc7587d2add676fd2398cb9673bd1ca272e3))
+
+* chore(deps): update python-semantic-release/python-semantic-release action to v9 ([`e11d889`](https://github.com/python-gitlab/python-gitlab/commit/e11d889cd19ec1555b2bbee15355a8cdfad61d5f))
+
+* chore(deps): update all non-major dependencies ([`3c4b27e`](https://github.com/python-gitlab/python-gitlab/commit/3c4b27e64f4b51746b866f240a1291c2637355cc))
+
+* chore(deps): update dependency furo to v2024 ([`f6fd02d`](https://github.com/python-gitlab/python-gitlab/commit/f6fd02d956529e2c4bce261fe7b3da1442aaea12))
+
+* chore(deps): update dependency pytest to v8 ([`253babb`](https://github.com/python-gitlab/python-gitlab/commit/253babb9a7f8a7d469440fcfe1b2741ddcd8475e))
+
+* chore(deps): update dependency pytest-docker to v3 ([`35d2aec`](https://github.com/python-gitlab/python-gitlab/commit/35d2aec04532919d6dd7b7090bc4d5209eddd10d))
+
+* chore: update version of `black` for `pre-commit`
+
+The version of `black` needs to be updated to be in sync with what is
+in `requirements-lint.txt` ([`3501716`](https://github.com/python-gitlab/python-gitlab/commit/35017167a80809a49351f9e95916fafe61c7bfd5))
+
+* chore(deps): update all non-major dependencies ([`7dc2fa6`](https://github.com/python-gitlab/python-gitlab/commit/7dc2fa6e632ed2c9adeb6ed32c4899ec155f6622))
+
+* chore(deps): update codecov/codecov-action action to v4 ([`d2be1f7`](https://github.com/python-gitlab/python-gitlab/commit/d2be1f7608acadcc2682afd82d16d3706b7f7461))
+
+* chore: adapt style for black v24 ([`4e68d32`](https://github.com/python-gitlab/python-gitlab/commit/4e68d32c77ed587ab42d229d9f44c3bc40d1d0e5))
+
+* chore(deps): update dependency black to v24 ([`f59aee3`](https://github.com/python-gitlab/python-gitlab/commit/f59aee3ddcfaeeb29fcfab4cc6768dff6b5558cb))
+
+* chore(deps): update all non-major dependencies ([`48726fd`](https://github.com/python-gitlab/python-gitlab/commit/48726fde9b3c2424310ff590b366b9fdefa4a146))
+
+### Documentation
+
+* docs: add FAQ about conflicting parameters
+
+We have received multiple issues lately about this. Add it to the FAQ. ([`683ce72`](https://github.com/python-gitlab/python-gitlab/commit/683ce723352cc09e1a4b65db28be981ae6bb9f71))
+
+* docs(README): tweak GitLab CI usage docs ([`d9aaa99`](https://github.com/python-gitlab/python-gitlab/commit/d9aaa994568ad4896a1e8a0533ef0d1d2ba06bfa))
+
+* docs: how to run smoke tests
+
+Signed-off-by: Tim Knight <tim.knight1@engineering.digital.dwp.gov.uk> ([`2d1f487`](https://github.com/python-gitlab/python-gitlab/commit/2d1f4872390df10174f865f7a935bc73f7865fec))
+
+* docs(objects): minor rst formatting typo
+
+To correctly format a code block have to use `::` ([`57dfd17`](https://github.com/python-gitlab/python-gitlab/commit/57dfd1769b4e22b43dc0936aa3600cd7e78ba289))
+
+* docs: correct rotate token example
+
+Rotate token returns a dict. Change example to print the entire dict.
+
+Closes: #2836 ([`c53e695`](https://github.com/python-gitlab/python-gitlab/commit/c53e6954f097ed10d52b40660d2fba73c2e0e300))
+
+* docs: Note how to use the Docker image from within GitLab CI
+
+Ref: #2823 ([`6d4bffb`](https://github.com/python-gitlab/python-gitlab/commit/6d4bffb5aaa676d32fc892ef1ac002973bc040cb))
+
+* docs(artifacts): Fix argument indentation ([`c631eeb`](https://github.com/python-gitlab/python-gitlab/commit/c631eeb55556920f5975b1fa2b1a0354478ce3c0))
+
+### Feature
+
+* feat(job_token_scope): support Groups in job token allowlist API  (#2816)
+
+* feat(job_token_scope): support job token access allowlist API
+
+Signed-off-by: Tim Knight <tim.knight1@engineering.digital.dwp.gov.uk>
+l.dwp.gov.uk>
+Co-authored-by: Nejc Habjan <nejc.habjan@siemens.com> ([`2d1b749`](https://github.com/python-gitlab/python-gitlab/commit/2d1b7499a93db2c9600b383e166f7463a5f22085))
+
+* feat(cli): allow skipping initial auth calls ([`001e596`](https://github.com/python-gitlab/python-gitlab/commit/001e59675f4a417a869f813d79c298a14268b87d))
+
+* feat(api): allow updating protected branches (#2771)
+
+* feat(api): allow updating protected branches
+
+Closes #2390 ([`a867c48`](https://github.com/python-gitlab/python-gitlab/commit/a867c48baa6f10ffbfb785e624a6e3888a859571))
+
+### Fix
+
+* fix: Consider `scope` an ArrayAttribute in PipelineJobManager
+
+List query params like 'scope' were not being handled correctly for
+pipeline/jobs endpoint.
+This change ensures multiple values are appended with '[]', resulting in
+the correct URL structure.
+
+Signed-off-by: Guilherme Gallo <guilherme.gallo@collabora.com>
+
+---
+
+Background:
+If one queries for pipeline jobs with `scope=["failed", "success"]`
+
+One gets:
+GET /api/v4/projects/176/pipelines/1113028/jobs?scope=success&scope=failed
+
+But it is supposed to get:
+GET /api/v4/projects/176/pipelines/1113028/jobs?scope[]=success&scope[]=failed
+
+The current version only considers the last element of the list argument.
+
+Signed-off-by: Guilherme Gallo <guilherme.gallo@collabora.com> ([`c5d0404`](https://github.com/python-gitlab/python-gitlab/commit/c5d0404ac9edfbfd328e7b4f07f554366377df3f))
+
+* fix(test): use different ids for merge request, approval rule, project
+
+The original bug was that the merge request identifier was used instead of the
+approval rule identifier. The test didn't notice that because it used `1` for
+all identifiers. Make these identifiers different so that a mixup will become
+apparent. ([`c23e6bd`](https://github.com/python-gitlab/python-gitlab/commit/c23e6bd5785205f0f4b4c80321153658fc23fb98))
+
+* fix(api): fix saving merge request approval rules
+
+Closes #2548 ([`b8b3849`](https://github.com/python-gitlab/python-gitlab/commit/b8b3849b2d4d3f2d9e81e5cf4f6b53368f7f0127))
+
+* fix: user.warn() to show correct filename of issue
+
+Previously would only go to the 2nd level of the stack for determining
+the offending filename and line number. When it should be showing the
+first filename outside of the python-gitlab source code. As we want it
+to show the warning for the user of the libraries code.
+
+Update test to show it works as expected. ([`529f1fa`](https://github.com/python-gitlab/python-gitlab/commit/529f1faacee46a88cb0a542306309eb835516796))
+
+* fix(api): update manual job status when playing it ([`9440a32`](https://github.com/python-gitlab/python-gitlab/commit/9440a3255018d6a6e49269caf4c878d80db508a8))
+
+* fix(cli): allow exclusive arguments as optional (#2770)
+
+* fix(cli): allow exclusive arguments as optional
+
+The CLI takes its arguments from the RequiredOptional, which has three fields: required, optional, and exclusive. In practice, the exclusive options are not defined as either required or optional, and would not be allowed in the CLI. This changes that, so that exclusive options are also added to the argument parser.
+
+  * fix(cli): inform argument parser that options are mutually exclusive
+
+  * fix(cli): use correct exclusive options, add unit test
+
+Closes #2769 ([`7ec3189`](https://github.com/python-gitlab/python-gitlab/commit/7ec3189d6eacdb55925e8be886a44d7ee09eb9ca))
+
+### Test
+
+* test: remove approve step
+
+Signed-off-by: Tim Knight <tim.knight1@engineering.digital.dwp.gov.uk> ([`48a6705`](https://github.com/python-gitlab/python-gitlab/commit/48a6705558c5ab6fb08c62a18de350a5985099f8))
+
+* test: tidy up functional tests
+
+Signed-off-by: Tim Knight <tim.knight1@engineering.digital.dwp.gov.uk> ([`06266ea`](https://github.com/python-gitlab/python-gitlab/commit/06266ea5966c601c035ad8ce5840729e5f9baa57))
+
+* test: update api tests for GL 16.10
+
+- Make sure we're testing python-gitlab functionality,
+make sure we're not awaiting on Gitlab Async functions
+- Decouple and improve test stability
+
+Signed-off-by: Tim Knight <tim.knight1@engineering.digital.dwp.gov.uk> ([`4bef473`](https://github.com/python-gitlab/python-gitlab/commit/4bef47301342703f87c1ce1d2920d54f9927a66a))
+
+* test(functional): enable bulk import feature flag before test ([`b81da2e`](https://github.com/python-gitlab/python-gitlab/commit/b81da2e66ce385525730c089dbc2a5a85ba23287))
+
+* test: don't use weak passwords
+
+Newer versions of GitLab will refuse to create a user with a weak
+password. In order for us to move to a newer GitLab version in testing
+use a stronger password for the tests that create a user. ([`c64d126`](https://github.com/python-gitlab/python-gitlab/commit/c64d126142cc77eae4297b8deec27bb1d68b7a13))
+
+* test: update tests for gitlab 16.8 functionality
+
+- use programmatic dates for expires_at in tokens tests
+- set PAT for 16.8 into tests
+
+Signed-off-by: Tim Knight <tim.knight1@engineering.digital.dwp.gov.uk> ([`f8283ae`](https://github.com/python-gitlab/python-gitlab/commit/f8283ae69efd86448ae60d79dd8321af3f19ba1b))
+
+* test(smoke): normalize all dist titles for smoke tests ([`ee013fe`](https://github.com/python-gitlab/python-gitlab/commit/ee013fe1579b001b4b30bae33404e827c7bdf8c1))
+
+
+## v4.4.0 (2024-01-15)
+
+### Chore
+
+* chore(deps): update all non-major dependencies ([`550f935`](https://github.com/python-gitlab/python-gitlab/commit/550f9355d29a502bb022f68dab6c902bf6913552))
+
+* chore(deps): update pre-commit hook pycqa/flake8 to v7 ([`9a199b6`](https://github.com/python-gitlab/python-gitlab/commit/9a199b6089152e181e71a393925e0ec581bc55ca))
+
+* chore(deps): update dependency jinja2 to v3.1.3 [security] ([`880913b`](https://github.com/python-gitlab/python-gitlab/commit/880913b67cce711d96e89ce6813e305e4ba10908))
+
+* chore(deps): update dependency flake8 to v7 ([`20243c5`](https://github.com/python-gitlab/python-gitlab/commit/20243c532a8a6d28eee0caff5b9c30cc7376a162))
+
+* chore(deps): update all non-major dependencies ([`cbc13a6`](https://github.com/python-gitlab/python-gitlab/commit/cbc13a61e0f15880b49a3d0208cc603d7d0b57e3))
+
+* chore(ci): align upload and download action versions ([`dcca59d`](https://github.com/python-gitlab/python-gitlab/commit/dcca59d1a5966283c1120cfb639c01a76214d2b2))
+
+* chore(deps): update actions/upload-artifact action to v4 ([`7114af3`](https://github.com/python-gitlab/python-gitlab/commit/7114af341dd12b7fb63ffc08650c455ead18ab70))
+
+* chore(ci): add Python 3.13 development CI job
+
+Add a job to test the development versions of Python 3.13. ([`ff0c11b`](https://github.com/python-gitlab/python-gitlab/commit/ff0c11b7b75677edd85f846a4dbdab08491a6bd7))
+
+* chore(deps): update all non-major dependencies ([`369a595`](https://github.com/python-gitlab/python-gitlab/commit/369a595a8763109a2af8a95a8e2423ebb30b9320))
+
+### Feature
+
+* feat(api): add reviewer_details manager for mergrequest to get reviewers of merge request
+
+Those changes implements 'GET /projects/:id/merge_requests/:merge_request_iid/reviewers' gitlab API call.
+Naming for call is not reviewers because reviewers atribute already presen in merge request response ([`adbd90c`](https://github.com/python-gitlab/python-gitlab/commit/adbd90cadffe1d9e9716a6e3826f30664866ad3f))
+
+* feat(api): support access token rotate API ([`b13971d`](https://github.com/python-gitlab/python-gitlab/commit/b13971d5472cb228f9e6a8f2fa05a7cc94d03ebe))
+
+* feat(api): support single resource access token get API ([`dae9e52`](https://github.com/python-gitlab/python-gitlab/commit/dae9e522a26041f5b3c6461cc8a5e284f3376a79))
+
+### Fix
+
+* fix(cli): support binary files with `@` notation
+
+Support binary files being used in the CLI with arguments using the
+`@` notation. For example `--avatar @/path/to/avatar.png`
+
+Also explicitly catch the common OSError exception, which is the
+parent exception for things like: FileNotFoundError, PermissionError
+and more exceptions.
+
+Remove the bare exception handling. We would rather have the full
+traceback of any exceptions that we don't know about and add them
+later if needed.
+
+Closes: #2752 ([`57749d4`](https://github.com/python-gitlab/python-gitlab/commit/57749d46de1d975aacb82758c268fc26e5e6ed8b))
+
+
 ## v4.3.0 (2023-12-28)
 
 ### Chore

{python-gitlab-4.4.0 → python_gitlab-4.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-gitlab
-Version: 4.4.0
+Version: 4.5.0
 Summary: A python wrapper for the GitLab API
 Author-email: Gauvain Pocentek <gauvain@pocentek.net>
 Maintainer-email: John Villalovos <john@sodarock.com>, Max Wittig <max.wittig@siemens.com>, Nejc Habjan <nejc.habjan@siemens.com>, Roger Meier <r.meier@siemens.com>
@@ -149,6 +149,23 @@ You can also mount your own config file:
 
    $ docker run -it --rm -v /path/to/python-gitlab.cfg:/etc/python-gitlab.cfg registry.gitlab.com/python-gitlab/python-gitlab:latest <command> ...
 
+Usage inside GitLab CI
+~~~~~~~~~~~~~~~~~~~~~~
+
+If you want to use the Docker image directly inside your GitLab CI as an ``image``, you will need to override
+the ``entrypoint``, `as noted in the official GitLab documentation <https://docs.gitlab.com/ee/ci/docker/using_docker_images.html#override-the-entrypoint-of-an-image>`__:
+
+.. code-block:: yaml
+
+   Job Name:
+      image:
+         name: registry.gitlab.com/python-gitlab/python-gitlab:latest
+         entrypoint: [""]
+      before_script:
+         gitlab --version
+      script:
+         gitlab <command>
+
 Building the image
 ~~~~~~~~~~~~~~~~~~
 

{python-gitlab-4.4.0 → python_gitlab-4.5.0}/README.rst

@@ -112,6 +112,23 @@ You can also mount your own config file:
 
    $ docker run -it --rm -v /path/to/python-gitlab.cfg:/etc/python-gitlab.cfg registry.gitlab.com/python-gitlab/python-gitlab:latest <command> ...
 
+Usage inside GitLab CI
+~~~~~~~~~~~~~~~~~~~~~~
+
+If you want to use the Docker image directly inside your GitLab CI as an ``image``, you will need to override
+the ``entrypoint``, `as noted in the official GitLab documentation <https://docs.gitlab.com/ee/ci/docker/using_docker_images.html#override-the-entrypoint-of-an-image>`__:
+
+.. code-block:: yaml
+
+   Job Name:
+      image:
+         name: registry.gitlab.com/python-gitlab/python-gitlab:latest
+         entrypoint: [""]
+      before_script:
+         gitlab --version
+      script:
+         gitlab <command>
+
 Building the image
 ~~~~~~~~~~~~~~~~~~
 

{python-gitlab-4.4.0 → python_gitlab-4.5.0}/docs/api-usage.rst

@@ -162,6 +162,11 @@ with the GitLab server error message:
    ...
    GitlabListError: 400: sort does not have a valid value
 
+.. _conflicting_parameters:
+
+Conflicting Parameters
+======================
+
 You can use the ``query_parameters`` argument to send arguments that would
 conflict with python or python-gitlab when using them as kwargs:
 

{python-gitlab-4.4.0 → python_gitlab-4.5.0}/docs/cli-examples.rst

@@ -9,9 +9,11 @@ CLI examples
 CI Lint
 -------
 
+**ci-lint has been Removed in Gitlab 16, use project-ci-lint instead**
+
 Lint a CI YAML configuration from a string:
 
-.. note:: 
+.. note::
 
    To see output, you will need to use the ``-v``/``--verbose`` flag.
 
@@ -39,6 +41,9 @@ Validate a CI YAML configuration from a file (lints and exits with non-zero on f
 
    $ gitlab ci-lint validate --content @.gitlab-ci.yml
 
+Project CI Lint
+---------------
+
 Lint a project's CI YAML configuration:
 
 .. code-block:: console

{python-gitlab-4.4.0 → python_gitlab-4.5.0}/docs/faq.rst

@@ -78,3 +78,23 @@ access an attribute that is shadowed by python-gitlab's own methods or managers.
 
 You can use the object's ``attributes`` dictionary to access it directly instead.
 See the :ref:`objects` section for more details on how attributes are exposed.
+
+.. _conflicting_parameters_faq:
+
+I cannot use the parameter ``path`` (or some other parameter) as it conflicts with the library
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+``path`` is used by the python-gitlab library and cannot be used as a parameter
+if wanting to send it to the GitLab instance.  You can use the
+``query_parameters`` argument to send arguments that would conflict with python
+or python-gitlab when using them as kwargs:
+
+.. code-block:: python
+
+   ## invalid, as ``path`` is interpreted by python-gitlab as the Path or full
+   ## URL to query ('/projects' or 'http://whatever/v4/api/projects')
+   project.commits.list(path='some_file_path', iterator=True)
+
+   project.commits.list(query_parameters={'path': 'some_file_path'}, iterator=True)  # OK
+
+See :ref:`Conflicting Parameters <conflicting_parameters>` for more information.

python_gitlab-4.5.0/docs/gl_objects/job_token_scope.rst

@@ -0,0 +1,101 @@
+#####################
+CI/CD job token scope
+#####################
+
+Reference
+---------
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.ProjectJobTokenScope`
+  + :class:`gitlab.v4.objects.ProjectJobTokenScopeManager`
+  + :attr:`gitlab.v4.objects.Project.job_token_scope`
+
+* GitLab API: https://docs.gitlab.com/ee/api/project_job_token_scopes.html
+
+Examples
+--------
+
+.. warning::
+
+   The GitLab API does **not** return any data when saving or updating
+   the job token scope settings. You need to call ``refresh()`` (or ``get()``
+   a new object) as shown below to get the latest state.
+
+Get a project's CI/CD job token access settings::
+
+    scope = project.job_token_scope.get()
+    print(scope.inbound_enabled)
+    # True
+
+Update the job token scope settings::
+
+    scope.enabled = False
+    scope.save()
+
+.. warning::
+
+   As you can see above, the attributes you receive from and send to the GitLab API
+   are not consistent. GitLab returns ``inbound_enabled`` and ``outbound_enabled``,
+   but expects ``enabled``, which only refers to the inbound scope. This is important
+   when accessing and updating these attributes.
+
+Or update the job token scope settings directly::
+
+    project.job_token_scope.update(new_data={"enabled": True})
+
+Refresh the current state of job token scope::
+
+    scope.refresh()
+    print(scope.inbound_enabled)
+    # False
+
+Get a project's CI/CD job token inbound allowlist::
+
+    allowlist = scope.allowlist.list()
+
+Add a project to the project's inbound allowlist::
+
+    allowed_project = scope.allowlist.create({"target_project_id": 42})
+
+Remove a project from the project's inbound allowlist::
+
+    allowed_project.delete()
+    # or directly using a project ID
+    scope.allowlist.delete(42)
+
+.. warning::
+
+   Similar to above, the ID attributes you receive from the create and list
+   APIs are not consistent (in create() the id is returned as ``source_project_id`` whereas list() returns as ``id``). To safely retrieve the ID of the allowlisted project
+   regardless of how the object was created, always use its ``.get_id()`` method.
+
+Using ``.get_id()``::
+
+    resp = allowlist.create({"target_project_id": 2})
+    allowlist_id = resp.get_id()
+
+    allowlists = project.allowlist.list()
+    for allowlist in allowlists:
+      allowlist_id == allowlist.get_id()
+
+Get a project's CI/CD job token inbound groups allowlist::
+
+    allowlist = scope.groups_allowlist.list()
+
+Add a project to the project's inbound groups allowlist::
+
+    allowed_project = scope.groups_allowlist.create({"target_project_id": 42})
+
+Remove a project from the project's inbound agroups llowlist::
+
+    allowed_project.delete()
+    # or directly using a Group ID
+    scope.groups_allowlist.delete(42)
+
+.. warning::
+
+   Similar to above, the ID attributes you receive from the create and list
+   APIs are not consistent. To safely retrieve the ID of the allowlisted group
+   regardless of how the object was created, always use its ``.get_id()`` method.
+

{python-gitlab-4.4.0 → python_gitlab-4.5.0}/docs/gl_objects/personal_access_tokens.rst

@@ -58,8 +58,8 @@ Rotate a personal access token and retrieve its new value::
     token.rotate()
     print(token.token)
     # or directly using a token ID
-    new_token = gl.personal_access_tokens.rotate(42)
-    print(new_token.token)
+    new_token_dict = gl.personal_access_tokens.rotate(42)
+    print(new_token_dict)
 
 Create a personal access token for a user (admin only)::
 

{python-gitlab-4.4.0 → python_gitlab-4.5.0}/docs/gl_objects/protected_branches.rst

@@ -27,6 +27,11 @@ Get a single protected branch::
 
     p_branch = project.protectedbranches.get('main')
 
+Update a protected branch::
+
+    p_branch.allow_force_push = True
+    p_branch.save()
+
 Create a protected branch::
 
     p_branch = project.protectedbranches.create({

{python-gitlab-4.4.0 → python_gitlab-4.5.0}/gitlab/_backends/protocol.py

@@ -13,8 +13,7 @@ else:
 
 class BackendResponse(Protocol):
     @abc.abstractmethod
-    def __init__(self, response: requests.Response) -> None:
-        ...
+    def __init__(self, response: requests.Response) -> None: ...
 
 
 class Backend(Protocol):
@@ -30,5 +29,4 @@ class Backend(Protocol):
         verify: Optional[Union[bool, str]],
         stream: Optional[bool],
         **kwargs: Any,
-    ) -> BackendResponse:
-        ...
+    ) -> BackendResponse: ...

{python-gitlab-4.4.0 → python_gitlab-4.5.0}/gitlab/_version.py

@@ -3,4 +3,4 @@ __copyright__ = "Copyright 2013-2019 Gauvain Pocentek, 2019-2023 python-gitlab t
 __email__ = "gauvainpocentek@gmail.com"
 __license__ = "LGPL3"
 __title__ = "python-gitlab"
-__version__ = "4.4.0"
+__version__ = "4.5.0"

{python-gitlab-4.4.0 → python_gitlab-4.5.0}/gitlab/cli.py

@@ -282,6 +282,16 @@ def _get_base_parser(add_help: bool = True) -> argparse.ArgumentParser:
         help=("GitLab CI job token [env var: CI_JOB_TOKEN]"),
         required=False,
     )
+    parser.add_argument(
+        "--skip-login",
+        help=(
+            "Skip initial authenticated API call to the current user endpoint. "
+            "This may  be useful when invoking the CLI in scripts. "
+            "[env var: GITLAB_SKIP_LOGIN]"
+        ),
+        action="store_true",
+        default=os.getenv("GITLAB_SKIP_LOGIN"),
+    )
     return parser
 
 
@@ -368,6 +378,7 @@ def main() -> None:
     debug = args.debug
     gitlab_resource = args.gitlab_resource
     resource_action = args.resource_action
+    skip_login = args.skip_login
 
     args_dict = vars(args)
     # Remove CLI behavior-related args
@@ -390,6 +401,7 @@ def main() -> None:
         "private_token",
         "oauth_token",
         "job_token",
+        "skip_login",
     ):
         args_dict.pop(item)
     args_dict = {k: _parse_value(v) for k, v in args_dict.items() if v is not None}
@@ -398,7 +410,7 @@ def main() -> None:
         gl = gitlab.Gitlab.merge_config(vars(options), gitlab_id, config_files)
         if debug:
             gl.enable_debug()
-        if gl.private_token or gl.oauth_token:
+        if not skip_login and (gl.private_token or gl.oauth_token):
             gl.auth()
     except Exception as e:
         die(str(e))

{python-gitlab-4.4.0 → python_gitlab-4.5.0}/gitlab/client.py

@@ -40,7 +40,6 @@ _PAGINATION_URL = (
 
 
 class Gitlab:
-
     """Represents a GitLab server connection.
 
     Args:

{python-gitlab-4.4.0 → python_gitlab-4.5.0}/gitlab/utils.py

@@ -18,7 +18,8 @@ class _StdoutStream:
 
 def get_content_type(content_type: Optional[str]) -> str:
     message = email.message.Message()
-    message["content-type"] = content_type
+    if content_type is not None:
+        message["content-type"] = content_type
 
     return message.get_content_type()
 
@@ -191,8 +192,7 @@ def warn(
     stacklevel = 1
     warning_from = ""
     for stacklevel, frame in enumerate(reversed(stack), start=1):
-        if stacklevel == 2:
-            warning_from = f" (python-gitlab: {frame.filename}:{frame.lineno})"
+        warning_from = f" (python-gitlab: {frame.filename}:{frame.lineno})"
         frame_dir = str(pathlib.Path(frame.filename).parent.resolve())
         if not frame_dir.startswith(str(pg_dir)):
             break

{python-gitlab-4.4.0 → python_gitlab-4.5.0}/gitlab/v4/cli.py

@@ -262,6 +262,10 @@ def _populate_sub_parser_by_class(
                 sub_parser_action.add_argument(
                     f"--{x.replace('_', '-')}", required=False
                 )
+            if mgr_cls._create_attrs.exclusive:
+                group = sub_parser_action.add_mutually_exclusive_group()
+                for x in mgr_cls._create_attrs.exclusive:
+                    group.add_argument(f"--{x.replace('_', '-')}")
 
         if action_name == "update":
             if cls._id_attr is not None:
@@ -280,6 +284,11 @@ def _populate_sub_parser_by_class(
                         f"--{x.replace('_', '-')}", required=False
                     )
 
+            if mgr_cls._update_attrs.exclusive:
+                group = sub_parser_action.add_mutually_exclusive_group()
+                for x in mgr_cls._update_attrs.exclusive:
+                    group.add_argument(f"--{x.replace('_', '-')}")
+
     if cls.__name__ in cli.custom_actions:
         name = cls.__name__
         for action_name in cli.custom_actions[name]: