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

{python_gitlab-4.5.0 → python_gitlab-4.6.0}/CHANGELOG.md

@@ -2,6 +2,161 @@
 
 
 
+## v4.6.0 (2024-05-28)
+
+### Chore
+
+* chore(deps): update python-semantic-release/upload-to-gh-release digest to 673709c ([`1b550ac`](https://github.com/python-gitlab/python-gitlab/commit/1b550ac706c8c31331a7a9dac607aed49f5e1fcf))
+
+* chore(deps): update all non-major dependencies ([`4c7014c`](https://github.com/python-gitlab/python-gitlab/commit/4c7014c13ed63f994e05b498d63b93dc8ab90c2e))
+
+* chore: update commit reference in git-blame-ignore-revs ([`d0fd5ad`](https://github.com/python-gitlab/python-gitlab/commit/d0fd5ad5a70e7eb70aedba5a0d3082418c5ffa34))
+
+* chore(cli): add ability to not add `_id_attr` as an argument
+
+In some cases we don't want to have `_id_attr` as an argument.
+
+Add ability to have it not be added as an argument. ([`2037352`](https://github.com/python-gitlab/python-gitlab/commit/20373525c1a1f98c18b953dbef896b2570d3d191))
+
+* chore: create a CustomAction dataclass ([`61d8679`](https://github.com/python-gitlab/python-gitlab/commit/61d867925772cf38f20360c9b40140ac3203efb9))
+
+* chore: add an initial .git-blame-ignore-revs
+
+This adds the `.git-blame-ignore-revs` file which allows ignoring
+certain commits when doing a `git blame --ignore-revs`
+
+Ignore the commit that requires keyword arguments for
+`register_custom_action()`
+
+https://docs.github.com/en/repositories/working-with-files/using-files/viewing-a-file#ignore-commits-in-the-blame-view ([`74db84c`](https://github.com/python-gitlab/python-gitlab/commit/74db84ca878ec7029643ff7b00db55f9ea085e9b))
+
+* chore: require keyword arguments for register_custom_action
+
+This makes it more obvious when reading the code what each argument is
+for. ([`7270523`](https://github.com/python-gitlab/python-gitlab/commit/7270523ad89a463c3542e072df73ba2255a49406))
+
+* chore: remove typing-extensions from requirements.txt
+
+We no longer support Python versions before 3.8. So it isn't needed
+anymore. ([`d569128`](https://github.com/python-gitlab/python-gitlab/commit/d56912835360a1b5a03a20390fb45cb5e8b49ce4))
+
+* chore(deps): update dependency requests to v2.32.0 [security] ([`1bc788c`](https://github.com/python-gitlab/python-gitlab/commit/1bc788ca979a36eeff2e35241bdefc764cf335ce))
+
+* chore(deps): update all non-major dependencies ([`ba1eec4`](https://github.com/python-gitlab/python-gitlab/commit/ba1eec49556ee022de471aae8d15060189f816e3))
+
+* chore(deps): update gitlab/gitlab-ee docker tag to v17 ([`5070d07`](https://github.com/python-gitlab/python-gitlab/commit/5070d07d13b9c87588dbfde3750340e322118779))
+
+* chore(cli): on the CLI help show the API endpoint of resources
+
+This makes it easier for people to map CLI command names to the API.
+
+Looks like this:
+    $ gitlab --help
+    <snip>
+                            The GitLab resource to manipulate.
+        application         API endpoint: /applications
+        application-appearance
+                            API endpoint: /application/appearance
+        application-settings
+                            API endpoint: /application/settings
+        application-statistics
+                            API endpoint: /application/statistics
+    <snip> ([`f1ef565`](https://github.com/python-gitlab/python-gitlab/commit/f1ef5650c3201f3883eb04ad90a874e8adcbcde2))
+
+* chore(cli): add some simple help for the standard operations
+
+Add help for the following standard operations:
+  * list: List the GitLab resources
+  * get: Get a GitLab resource
+  * create: Create a GitLab resource
+  * update: Update a GitLab resource
+  * delete: Delete a GitLab resource
+
+For example:
+  $ gitlab project-key --help
+  usage: gitlab project-key [-h] {list,get,create,update,delete,enable} ...
+
+  options:
+    -h, --help            show this help message and exit
+
+  action:
+    list
+    get
+    create
+    update
+    delete
+    enable
+                          Action to execute on the GitLab resource.
+      list                List the GitLab resources
+      get                 Get a GitLab resource
+      create              Create a GitLab resource
+      update              Update a GitLab resource
+      delete              Delete a GitLab resource ([`5a4a940`](https://github.com/python-gitlab/python-gitlab/commit/5a4a940f42e43ed066838503638fe612813e504f))
+
+* chore: correct type-hint for `job.trace()`
+
+Closes: #2808 ([`840572e`](https://github.com/python-gitlab/python-gitlab/commit/840572e4fa36581405b604a985d0e130fe43f4ce))
+
+* chore: add type info for ProjectFile.content
+
+Closes: #2821 ([`62fa271`](https://github.com/python-gitlab/python-gitlab/commit/62fa2719ea129b3428e5e67d3d3a493f9aead863))
+
+### Feature
+
+* feat(api):  add additional parameter to project/group iteration search (#2796)
+
+Co-authored-by: Cristiano Casella <cristiano.casella@seacom.it>
+Co-authored-by: Nejc Habjan <hab.nejc@gmail.com> ([`623dac9`](https://github.com/python-gitlab/python-gitlab/commit/623dac9c8363c61dbf53f72af58835743e96656b))
+
+* feat(api): add support for gitlab service account (#2851)
+
+
+Co-authored-by: Nejc Habjan <hab.nejc@siemens.com> ([`b187dea`](https://github.com/python-gitlab/python-gitlab/commit/b187deadabbfdf0326ecd79a3ee64c9de10c53e0))
+
+* feat: more usernames support for MR approvals
+
+I don't think commit a2b8c8ccfb5d went far enough to enable usernames
+support. We create and edit a lot of approval rules based on an external
+service (similar to CODE_OWNERS), but only have the usernames available,
+and currently, have to look up each user to get their user ID to populate
+user_ids for .set_approvers() calls. Would very much like to skip the
+lookup and just send the usernames, which this change should allow.
+
+See: https://docs.gitlab.com/ee/api/merge_request_approvals.html#create-project-level-rule
+
+Signed-off-by: Jarod Wilson <jarod@redhat.com> ([`12d195a`](https://github.com/python-gitlab/python-gitlab/commit/12d195a35a1bd14947fbd6688a8ad1bd3fc21617))
+
+### Fix
+
+* fix(deps): update minimum dependency versions in pyproject.toml
+
+Update the minimum versions of the dependencies in the pyproject.toml
+file.
+
+This is related to PR #2878 ([`37b5a70`](https://github.com/python-gitlab/python-gitlab/commit/37b5a704ef6b94774e54110ba3746a950e733986))
+
+* fix(cli): don't require `--id` when enabling a deploy key
+
+No longer require `--id` when doing:
+  gitlab project-key enable
+
+Now only the --project-id and --key-id are required. ([`98fc578`](https://github.com/python-gitlab/python-gitlab/commit/98fc5789d39b81197351660b7a3f18903c2b91ba))
+
+* fix: don't raise `RedirectError` for redirected `HEAD` requests ([`8fc13b9`](https://github.com/python-gitlab/python-gitlab/commit/8fc13b91d63d57c704d03b98920522a6469c96d7))
+
+* fix: handle large number of approval rules
+
+Use `iterator=True` when going through the list of current approval
+rules. This allows it to handle more than the default of 20 approval
+rules.
+
+Closes: #2825 ([`ef8f0e1`](https://github.com/python-gitlab/python-gitlab/commit/ef8f0e190b1add3bbba9a7b194aba2f3c1a83b2e))
+
+* fix(projects): fix 'import_project' file argument type for typings
+
+Signed-off-by: Adrian DC <radian.dc@gmail.com> ([`33fbc14`](https://github.com/python-gitlab/python-gitlab/commit/33fbc14ea8432df7e637462379e567f4d0ad6c18))
+
+
 ## v4.5.0 (2024-05-13)
 
 ### Build

{python_gitlab-4.5.0 → python_gitlab-4.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-gitlab
-Version: 4.5.0
+Version: 4.6.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>
@@ -28,8 +28,8 @@ Requires-Python: >=3.8.0
 Description-Content-Type: text/x-rst
 License-File: COPYING
 License-File: AUTHORS
-Requires-Dist: requests>=2.25.0
-Requires-Dist: requests-toolbelt>=0.10.1
+Requires-Dist: requests>=2.32.0
+Requires-Dist: requests-toolbelt>=1.0.0
 Provides-Extra: autocompletion
 Requires-Dist: argcomplete<3,>=1.10.0; extra == "autocompletion"
 Provides-Extra: yaml

{python_gitlab-4.5.0 → python_gitlab-4.6.0}/docs/gl_objects/groups.rst

@@ -458,3 +458,24 @@ Edit group push rules::
 Delete group push rules::
 
     pr.delete()
+
+Group Service Account
+=====================
+
+Reference
+---------
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.GroupServiceAccount`
+  + :class:`gitlab.v4.objects.GroupServiceAccountManager`
+  + :attr:`gitlab.v4.objects.Group.serviceaccounts`
+
+* GitLab API: https://docs.gitlab.com/ee/api/groups.html#service-accounts
+
+Examples
+---------
+
+Create group service account (only allowed at top level group)::
+
+    group.serviceaccount.create({'name': 'group-service-account', 'username': 'group-service-account'})

{python_gitlab-4.5.0 → python_gitlab-4.6.0}/docs/gl_objects/iterations.rst

@@ -31,3 +31,13 @@ List iterations for a project's ancestor groups::
 List iterations for a group::
 
     iterations = group.iterations.list()
+
+Unavailable filters or keyword conflicts::
+    
+    In case you are trying to pass a parameter that collides with a python
+    keyword (i.e. `in`) or with python-gitlab's internal arguments, you'll have
+    to use the `query_parameters` argument:
+
+    ```
+    group.iterations.list(query_parameters={"in": "title"}) 
+    ```

{python_gitlab-4.5.0 → python_gitlab-4.6.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.5.0"
+__version__ = "4.6.0"

{python_gitlab-4.5.0 → python_gitlab-4.6.0}/gitlab/cli.py

@@ -1,4 +1,5 @@
 import argparse
+import dataclasses
 import functools
 import os
 import pathlib
@@ -29,12 +30,21 @@ from gitlab.base import RESTObject
 camel_upperlower_regex = re.compile(r"([A-Z]+)([A-Z][a-z])")
 camel_lowerupper_regex = re.compile(r"([a-z\d])([A-Z])")
 
+
+@dataclasses.dataclass
+class CustomAction:
+    required: Tuple[str, ...]
+    optional: Tuple[str, ...]
+    in_object: bool
+    requires_id: bool  # if the `_id_attr` value should be a required argument
+
+
 # custom_actions = {
 #    cls: {
 #        action: (mandatory_args, optional_args, in_obj),
 #    },
 # }
-custom_actions: Dict[str, Dict[str, Tuple[Tuple[str, ...], Tuple[str, ...], bool]]] = {}
+custom_actions: Dict[str, Dict[str, CustomAction]] = {}
 
 
 # For an explanation of how these type-hints work see:
@@ -72,10 +82,12 @@ class VerticalHelpFormatter(argparse.HelpFormatter):
 
 
 def register_custom_action(
+    *,
     cls_names: Union[str, Tuple[str, ...]],
-    mandatory: Tuple[str, ...] = (),
+    required: Tuple[str, ...] = (),
     optional: Tuple[str, ...] = (),
     custom_action: Optional[str] = None,
+    requires_id: bool = True,  # if the `_id_attr` value should be a required argument
 ) -> Callable[[__F], __F]:
     def wrap(f: __F) -> __F:
         @functools.wraps(f)
@@ -98,7 +110,12 @@ def register_custom_action(
                 custom_actions[final_name] = {}
 
             action = custom_action or f.__name__.replace("_", "-")
-            custom_actions[final_name][action] = (mandatory, optional, in_obj)
+            custom_actions[final_name][action] = CustomAction(
+                required=required,
+                optional=optional,
+                in_object=in_obj,
+                requires_id=requires_id,
+            )
 
         return cast(__F, wrapped_f)
 
@@ -134,7 +151,6 @@ def _get_base_parser(add_help: bool = True) -> argparse.ArgumentParser:
     parser = argparse.ArgumentParser(
         add_help=add_help,
         description="GitLab API Command Line Interface",
-        formatter_class=VerticalHelpFormatter,
         allow_abbrev=False,
     )
     parser.add_argument("--version", help="Display the version.", action="store_true")

{python_gitlab-4.5.0 → python_gitlab-4.6.0}/gitlab/client.py

@@ -625,8 +625,8 @@ class Gitlab:
         for item in result.history:
             if item.status_code not in (301, 302):
                 continue
-            # GET methods can be redirected without issue
-            if item.request.method == "GET":
+            # GET and HEAD methods can be redirected without issue
+            if item.request.method in ("GET", "HEAD"):
                 continue
             target = item.headers.get("location")
             raise gitlab.exceptions.RedirectError(

{python_gitlab-4.5.0 → python_gitlab-4.6.0}/gitlab/mixins.py

@@ -550,7 +550,7 @@ class UserAgentDetailMixin(_RestObjectBase):
     _updated_attrs: Dict[str, Any]
     manager: base.RESTManager
 
-    @cli.register_custom_action(("Snippet", "ProjectSnippet", "ProjectIssue"))
+    @cli.register_custom_action(cls_names=("Snippet", "ProjectSnippet", "ProjectIssue"))
     @exc.on_http_error(exc.GitlabGetError)
     def user_agent_detail(self, **kwargs: Any) -> Dict[str, Any]:
         """Get the user agent detail.
@@ -578,7 +578,8 @@ class AccessRequestMixin(_RestObjectBase):
     manager: base.RESTManager
 
     @cli.register_custom_action(
-        ("ProjectAccessRequest", "GroupAccessRequest"), (), ("access_level",)
+        cls_names=("ProjectAccessRequest", "GroupAccessRequest"),
+        optional=("access_level",),
     )
     @exc.on_http_error(exc.GitlabUpdateError)
     def approve(
@@ -611,7 +612,7 @@ class DownloadMixin(_RestObjectBase):
     _updated_attrs: Dict[str, Any]
     manager: base.RESTManager
 
-    @cli.register_custom_action(("GroupExport", "ProjectExport"))
+    @cli.register_custom_action(cls_names=("GroupExport", "ProjectExport"))
     @exc.on_http_error(exc.GitlabGetError)
     def download(
         self,
@@ -721,7 +722,7 @@ class SubscribableMixin(_RestObjectBase):
     manager: base.RESTManager
 
     @cli.register_custom_action(
-        ("ProjectIssue", "ProjectMergeRequest", "ProjectLabel", "GroupLabel")
+        cls_names=("ProjectIssue", "ProjectMergeRequest", "ProjectLabel", "GroupLabel")
     )
     @exc.on_http_error(exc.GitlabSubscribeError)
     def subscribe(self, **kwargs: Any) -> None:
@@ -741,7 +742,7 @@ class SubscribableMixin(_RestObjectBase):
         self._update_attrs(server_data)
 
     @cli.register_custom_action(
-        ("ProjectIssue", "ProjectMergeRequest", "ProjectLabel", "GroupLabel")
+        cls_names=("ProjectIssue", "ProjectMergeRequest", "ProjectLabel", "GroupLabel")
     )
     @exc.on_http_error(exc.GitlabUnsubscribeError)
     def unsubscribe(self, **kwargs: Any) -> None:
@@ -769,7 +770,7 @@ class TodoMixin(_RestObjectBase):
     _updated_attrs: Dict[str, Any]
     manager: base.RESTManager
 
-    @cli.register_custom_action(("ProjectIssue", "ProjectMergeRequest"))
+    @cli.register_custom_action(cls_names=("ProjectIssue", "ProjectMergeRequest"))
     @exc.on_http_error(exc.GitlabTodoError)
     def todo(self, **kwargs: Any) -> None:
         """Create a todo associated to the object.
@@ -793,7 +794,7 @@ class TimeTrackingMixin(_RestObjectBase):
     _updated_attrs: Dict[str, Any]
     manager: base.RESTManager
 
-    @cli.register_custom_action(("ProjectIssue", "ProjectMergeRequest"))
+    @cli.register_custom_action(cls_names=("ProjectIssue", "ProjectMergeRequest"))
     @exc.on_http_error(exc.GitlabTimeTrackingError)
     def time_stats(self, **kwargs: Any) -> Dict[str, Any]:
         """Get time stats for the object.
@@ -819,7 +820,9 @@ class TimeTrackingMixin(_RestObjectBase):
             assert not isinstance(result, requests.Response)
         return result
 
-    @cli.register_custom_action(("ProjectIssue", "ProjectMergeRequest"), ("duration",))
+    @cli.register_custom_action(
+        cls_names=("ProjectIssue", "ProjectMergeRequest"), required=("duration",)
+    )
     @exc.on_http_error(exc.GitlabTimeTrackingError)
     def time_estimate(self, duration: str, **kwargs: Any) -> Dict[str, Any]:
         """Set an estimated time of work for the object.
@@ -839,7 +842,7 @@ class TimeTrackingMixin(_RestObjectBase):
             assert not isinstance(result, requests.Response)
         return result
 
-    @cli.register_custom_action(("ProjectIssue", "ProjectMergeRequest"))
+    @cli.register_custom_action(cls_names=("ProjectIssue", "ProjectMergeRequest"))
     @exc.on_http_error(exc.GitlabTimeTrackingError)
     def reset_time_estimate(self, **kwargs: Any) -> Dict[str, Any]:
         """Resets estimated time for the object to 0 seconds.
@@ -857,7 +860,9 @@ class TimeTrackingMixin(_RestObjectBase):
             assert not isinstance(result, requests.Response)
         return result
 
-    @cli.register_custom_action(("ProjectIssue", "ProjectMergeRequest"), ("duration",))
+    @cli.register_custom_action(
+        cls_names=("ProjectIssue", "ProjectMergeRequest"), required=("duration",)
+    )
     @exc.on_http_error(exc.GitlabTimeTrackingError)
     def add_spent_time(self, duration: str, **kwargs: Any) -> Dict[str, Any]:
         """Add time spent working on the object.
@@ -877,7 +882,7 @@ class TimeTrackingMixin(_RestObjectBase):
             assert not isinstance(result, requests.Response)
         return result
 
-    @cli.register_custom_action(("ProjectIssue", "ProjectMergeRequest"))
+    @cli.register_custom_action(cls_names=("ProjectIssue", "ProjectMergeRequest"))
     @exc.on_http_error(exc.GitlabTimeTrackingError)
     def reset_spent_time(self, **kwargs: Any) -> Dict[str, Any]:
         """Resets the time spent working on the object.
@@ -904,7 +909,7 @@ class ParticipantsMixin(_RestObjectBase):
     _updated_attrs: Dict[str, Any]
     manager: base.RESTManager
 
-    @cli.register_custom_action(("ProjectMergeRequest", "ProjectIssue"))
+    @cli.register_custom_action(cls_names=("ProjectMergeRequest", "ProjectIssue"))
     @exc.on_http_error(exc.GitlabListError)
     def participants(self, **kwargs: Any) -> Dict[str, Any]:
         """List the participants.
@@ -932,7 +937,8 @@ class ParticipantsMixin(_RestObjectBase):
 
 class BadgeRenderMixin(_RestManagerBase):
     @cli.register_custom_action(
-        ("GroupBadgeManager", "ProjectBadgeManager"), ("link_url", "image_url")
+        cls_names=("GroupBadgeManager", "ProjectBadgeManager"),
+        required=("link_url", "image_url"),
     )
     @exc.on_http_error(exc.GitlabRenderError)
     def render(self, link_url: str, image_url: str, **kwargs: Any) -> Dict[str, Any]:
@@ -1025,7 +1031,9 @@ class UploadMixin(_RestObjectBase):
         data = self.attributes
         return self._upload_path.format(**data)
 
-    @cli.register_custom_action(("Project", "ProjectWiki"), ("filename", "filepath"))
+    @cli.register_custom_action(
+        cls_names=("Project", "ProjectWiki"), required=("filename", "filepath")
+    )
     @exc.on_http_error(exc.GitlabUploadError)
     def upload(
         self,

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

@@ -82,7 +82,7 @@ class GitlabCLI:
 
     def do_custom(self) -> Any:
         class_instance: Union[gitlab.base.RESTManager, gitlab.base.RESTObject]
-        in_obj = cli.custom_actions[self.cls_name][self.resource_action][2]
+        in_obj = cli.custom_actions[self.cls_name][self.resource_action].in_object
 
         # Get the object (lazy), then act
         if in_obj:
@@ -207,12 +207,20 @@ def _populate_sub_parser_by_class(
     mgr_cls = getattr(gitlab.v4.objects, mgr_cls_name)
 
     action_parsers: Dict[str, argparse.ArgumentParser] = {}
-    for action_name in ["list", "get", "create", "update", "delete"]:
+    for action_name, help_text in [
+        ("list", "List the GitLab resources"),
+        ("get", "Get a GitLab resource"),
+        ("create", "Create a GitLab resource"),
+        ("update", "Update a GitLab resource"),
+        ("delete", "Delete a GitLab resource"),
+    ]:
         if not hasattr(mgr_cls, action_name):
             continue
 
         sub_parser_action = sub_parser.add_parser(
-            action_name, conflict_handler="resolve"
+            action_name,
+            conflict_handler="resolve",
+            help=help_text,
         )
         action_parsers[action_name] = sub_parser_action
         sub_parser_action.add_argument("--sudo", required=False)
@@ -307,19 +315,19 @@ def _populate_sub_parser_by_class(
                     )
                 sub_parser_action.add_argument("--sudo", required=False)
 
+            custom_action = cli.custom_actions[name][action_name]
             # We need to get the object somehow
             if not issubclass(cls, gitlab.mixins.GetWithoutIdMixin):
-                if cls._id_attr is not None:
+                if cls._id_attr is not None and custom_action.requires_id:
                     id_attr = cls._id_attr.replace("_", "-")
                     sub_parser_action.add_argument(f"--{id_attr}", required=True)
 
-            required, optional, dummy = cli.custom_actions[name][action_name]
-            for x in required:
+            for x in custom_action.required:
                 if x != cls._id_attr:
                     sub_parser_action.add_argument(
                         f"--{x.replace('_', '-')}", required=True
                     )
-            for x in optional:
+            for x in custom_action.optional:
                 if x != cls._id_attr:
                     sub_parser_action.add_argument(
                         f"--{x.replace('_', '-')}", required=False
@@ -342,13 +350,13 @@ def _populate_sub_parser_by_class(
                     )
                 sub_parser_action.add_argument("--sudo", required=False)
 
-            required, optional, dummy = cli.custom_actions[name][action_name]
-            for x in required:
+            custom_action = cli.custom_actions[name][action_name]
+            for x in custom_action.required:
                 if x != cls._id_attr:
                     sub_parser_action.add_argument(
                         f"--{x.replace('_', '-')}", required=True
                     )
-            for x in optional:
+            for x in custom_action.optional:
                 if x != cls._id_attr:
                     sub_parser_action.add_argument(
                         f"--{x.replace('_', '-')}", required=False
@@ -374,8 +382,12 @@ def extend_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
 
     for cls in sorted(classes, key=operator.attrgetter("__name__")):
         arg_name = cli.cls_to_gitlab_resource(cls)
+        mgr_cls_name = f"{cls.__name__}Manager"
+        mgr_cls = getattr(gitlab.v4.objects, mgr_cls_name)
         object_group = subparsers.add_parser(
-            arg_name, formatter_class=cli.VerticalHelpFormatter
+            arg_name,
+            formatter_class=cli.VerticalHelpFormatter,
+            help=f"API endpoint: {mgr_cls._path}",
         )
 
         object_subparsers = object_group.add_subparsers(

{python_gitlab-4.5.0 → python_gitlab-4.6.0}/gitlab/v4/objects/__init__.py

@@ -59,6 +59,7 @@ from .resource_groups import *
 from .reviewers import *
 from .runners import *
 from .secure_files import *
+from .service_accounts import *
 from .settings import *
 from .sidekiq import *
 from .snippets import *

{python_gitlab-4.5.0 → python_gitlab-4.6.0}/gitlab/v4/objects/artifacts.py

@@ -44,7 +44,9 @@ class ProjectArtifactManager(RESTManager):
         self.gitlab.http_delete(path, **kwargs)
 
     @cli.register_custom_action(
-        "ProjectArtifactManager", ("ref_name", "job"), ("job_token",)
+        cls_names="ProjectArtifactManager",
+        required=("ref_name", "job"),
+        optional=("job_token",),
     )
     @exc.on_http_error(exc.GitlabGetError)
     def download(
@@ -93,7 +95,8 @@ class ProjectArtifactManager(RESTManager):
         )
 
     @cli.register_custom_action(
-        "ProjectArtifactManager", ("ref_name", "artifact_path", "job")
+        cls_names="ProjectArtifactManager",
+        required=("ref_name", "artifact_path", "job"),
     )
     @exc.on_http_error(exc.GitlabGetError)
     def raw(

{python_gitlab-4.5.0 → python_gitlab-4.6.0}/gitlab/v4/objects/ci_lint.py

@@ -31,8 +31,8 @@ class CiLintManager(CreateMixin, RESTManager):
     )
 
     @register_custom_action(
-        "CiLintManager",
-        ("content",),
+        cls_names="CiLintManager",
+        required=("content",),
         optional=("include_merged_yaml", "include_jobs"),
     )
     def validate(self, *args: Any, **kwargs: Any) -> None:
@@ -63,8 +63,8 @@ class ProjectCiLintManager(GetWithoutIdMixin, CreateMixin, RESTManager):
         return cast(ProjectCiLint, super().get(**kwargs))
 
     @register_custom_action(
-        "ProjectCiLintManager",
-        ("content",),
+        cls_names="ProjectCiLintManager",
+        required=("content",),
         optional=("dry_run", "include_jobs", "ref"),
     )
     def validate(self, *args: Any, **kwargs: Any) -> None:

{python_gitlab-4.5.0 → python_gitlab-4.6.0}/gitlab/v4/objects/commits.py

@@ -28,7 +28,7 @@ class ProjectCommit(RESTObject):
     discussions: ProjectCommitDiscussionManager
     statuses: "ProjectCommitStatusManager"
 
-    @cli.register_custom_action("ProjectCommit")
+    @cli.register_custom_action(cls_names="ProjectCommit")
     @exc.on_http_error(exc.GitlabGetError)
     def diff(self, **kwargs: Any) -> Union[gitlab.GitlabList, List[Dict[str, Any]]]:
         """Generate the commit diff.
@@ -46,7 +46,7 @@ class ProjectCommit(RESTObject):
         path = f"{self.manager.path}/{self.encoded_id}/diff"
         return self.manager.gitlab.http_list(path, **kwargs)
 
-    @cli.register_custom_action("ProjectCommit", ("branch",))
+    @cli.register_custom_action(cls_names="ProjectCommit", required=("branch",))
     @exc.on_http_error(exc.GitlabCherryPickError)
     def cherry_pick(self, branch: str, **kwargs: Any) -> None:
         """Cherry-pick a commit into a branch.
@@ -63,7 +63,7 @@ class ProjectCommit(RESTObject):
         post_data = {"branch": branch}
         self.manager.gitlab.http_post(path, post_data=post_data, **kwargs)
 
-    @cli.register_custom_action("ProjectCommit", optional=("type",))
+    @cli.register_custom_action(cls_names="ProjectCommit", optional=("type",))
     @exc.on_http_error(exc.GitlabGetError)
     def refs(
         self, type: str = "all", **kwargs: Any
@@ -85,7 +85,7 @@ class ProjectCommit(RESTObject):
         query_data = {"type": type}
         return self.manager.gitlab.http_list(path, query_data=query_data, **kwargs)
 
-    @cli.register_custom_action("ProjectCommit")
+    @cli.register_custom_action(cls_names="ProjectCommit")
     @exc.on_http_error(exc.GitlabGetError)
     def merge_requests(
         self, **kwargs: Any
@@ -105,7 +105,7 @@ class ProjectCommit(RESTObject):
         path = f"{self.manager.path}/{self.encoded_id}/merge_requests"
         return self.manager.gitlab.http_list(path, **kwargs)
 
-    @cli.register_custom_action("ProjectCommit", ("branch",))
+    @cli.register_custom_action(cls_names="ProjectCommit", required=("branch",))
     @exc.on_http_error(exc.GitlabRevertError)
     def revert(
         self, branch: str, **kwargs: Any
@@ -127,7 +127,7 @@ class ProjectCommit(RESTObject):
         post_data = {"branch": branch}
         return self.manager.gitlab.http_post(path, post_data=post_data, **kwargs)
 
-    @cli.register_custom_action("ProjectCommit")
+    @cli.register_custom_action(cls_names="ProjectCommit")
     @exc.on_http_error(exc.GitlabGetError)
     def signature(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
         """Get the signature of the commit.

{python_gitlab-4.5.0 → python_gitlab-4.6.0}/gitlab/v4/objects/container_registry.py

@@ -42,8 +42,8 @@ class ProjectRegistryTagManager(DeleteMixin, RetrieveMixin, RESTManager):
     _path = "/projects/{project_id}/registry/repositories/{repository_id}/tags"
 
     @cli.register_custom_action(
-        "ProjectRegistryTagManager",
-        ("name_regex_delete",),
+        cls_names="ProjectRegistryTagManager",
+        required=("name_regex_delete",),
         optional=("keep_n", "name_regex_keep", "older_than"),
     )
     @exc.on_http_error(exc.GitlabDeleteError)

{python_gitlab-4.5.0 → python_gitlab-4.6.0}/gitlab/v4/objects/deploy_keys.py

@@ -36,7 +36,9 @@ class ProjectKeyManager(CRUDMixin, RESTManager):
     _create_attrs = RequiredOptional(required=("title", "key"), optional=("can_push",))
     _update_attrs = RequiredOptional(optional=("title", "can_push"))
 
-    @cli.register_custom_action("ProjectKeyManager", ("key_id",))
+    @cli.register_custom_action(
+        cls_names="ProjectKeyManager", required=("key_id",), requires_id=False
+    )
     @exc.on_http_error(exc.GitlabProjectDeployKeyError)
     def enable(
         self, key_id: int, **kwargs: Any

{python_gitlab-4.5.0 → python_gitlab-4.6.0}/gitlab/v4/objects/deployments.py

@@ -23,8 +23,8 @@ class ProjectDeployment(SaveMixin, RESTObject):
     mergerequests: ProjectDeploymentMergeRequestManager
 
     @cli.register_custom_action(
-        "ProjectDeployment",
-        mandatory=("status",),
+        cls_names="ProjectDeployment",
+        required=("status",),
         optional=("comment", "represented_as"),
     )
     @exc.on_http_error(exc.GitlabDeploymentApprovalError)