python-gitlab 5.6.0__py3-none-any.whl → 6.1.0__py3-none-any.whl

gitlab/v4/objects/settings.py

@@ -1,22 +1,23 @@
-from typing import Any, cast, Dict, Optional, Union
+from __future__ import annotations
+
+from typing import Any
 
 from gitlab import exceptions as exc
 from gitlab import types
-from gitlab.base import RESTManager, RESTObject
+from gitlab.base import RESTObject
 from gitlab.mixins import GetWithoutIdMixin, SaveMixin, UpdateMixin
 from gitlab.types import RequiredOptional
 
-__all__ = [
-    "ApplicationSettings",
-    "ApplicationSettingsManager",
-]
+__all__ = ["ApplicationSettings", "ApplicationSettingsManager"]
 
 
 class ApplicationSettings(SaveMixin, RESTObject):
     _id_attr = None
 
 
-class ApplicationSettingsManager(GetWithoutIdMixin, UpdateMixin, RESTManager):
+class ApplicationSettingsManager(
+    GetWithoutIdMixin[ApplicationSettings], UpdateMixin[ApplicationSettings]
+):
     _path = "/application/settings"
     _obj_cls = ApplicationSettings
     _update_attrs = RequiredOptional(
@@ -24,6 +25,7 @@ class ApplicationSettingsManager(GetWithoutIdMixin, UpdateMixin, RESTManager):
             "id",
             "default_projects_limit",
             "signup_enabled",
+            "silent_mode_enabled",
             "password_authentication_enabled_for_web",
             "gravatar_enabled",
             "sign_in_text",
@@ -78,7 +80,7 @@ class ApplicationSettingsManager(GetWithoutIdMixin, UpdateMixin, RESTManager):
             "allow_local_requests_from_hooks_and_services",
             "allow_local_requests_from_web_hooks_and_services",
             "allow_local_requests_from_system_hooks",
-        ),
+        )
     )
     _types = {
         "asset_proxy_allowlist": types.ArrayAttribute,
@@ -92,10 +94,10 @@ class ApplicationSettingsManager(GetWithoutIdMixin, UpdateMixin, RESTManager):
     @exc.on_http_error(exc.GitlabUpdateError)
     def update(
         self,
-        id: Optional[Union[str, int]] = None,
-        new_data: Optional[Dict[str, Any]] = None,
+        id: str | int | None = None,
+        new_data: dict[str, Any] | None = None,
         **kwargs: Any,
-    ) -> Dict[str, Any]:
+    ) -> dict[str, Any]:
         """Update an object on the server.
 
         Args:
@@ -115,6 +117,3 @@ class ApplicationSettingsManager(GetWithoutIdMixin, UpdateMixin, RESTManager):
         if "domain_whitelist" in data and data["domain_whitelist"] is None:
             data.pop("domain_whitelist")
         return super().update(id, data, **kwargs)
-
-    def get(self, **kwargs: Any) -> ApplicationSettings:
-        return cast(ApplicationSettings, super().get(**kwargs))

gitlab/v4/objects/sidekiq.py

@@ -1,26 +1,29 @@
-from typing import Any, Dict, Union
+from __future__ import annotations
+
+from typing import Any
 
 import requests
 
 from gitlab import cli
 from gitlab import exceptions as exc
-from gitlab.base import RESTManager
+from gitlab.base import RESTManager, RESTObject
 
-__all__ = [
-    "SidekiqManager",
-]
+__all__ = ["SidekiqManager"]
 
 
-class SidekiqManager(RESTManager):
+class SidekiqManager(RESTManager[RESTObject]):
     """Manager for the Sidekiq methods.
 
     This manager doesn't actually manage objects but provides helper function
     for the sidekiq metrics API.
     """
 
+    _path = "/sidekiq"
+    _obj_cls = RESTObject
+
     @cli.register_custom_action(cls_names="SidekiqManager")
     @exc.on_http_error(exc.GitlabGetError)
-    def queue_metrics(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
+    def queue_metrics(self, **kwargs: Any) -> dict[str, Any] | requests.Response:
         """Return the registered queues information.
 
         Args:
@@ -33,13 +36,11 @@ class SidekiqManager(RESTManager):
         Returns:
             Information about the Sidekiq queues
         """
-        return self.gitlab.http_get("/sidekiq/queue_metrics", **kwargs)
+        return self.gitlab.http_get(f"{self.path}/queue_metrics", **kwargs)
 
     @cli.register_custom_action(cls_names="SidekiqManager")
     @exc.on_http_error(exc.GitlabGetError)
-    def process_metrics(
-        self, **kwargs: Any
-    ) -> Union[Dict[str, Any], requests.Response]:
+    def process_metrics(self, **kwargs: Any) -> dict[str, Any] | requests.Response:
         """Return the registered sidekiq workers.
 
         Args:
@@ -52,11 +53,11 @@ class SidekiqManager(RESTManager):
         Returns:
             Information about the register Sidekiq worker
         """
-        return self.gitlab.http_get("/sidekiq/process_metrics", **kwargs)
+        return self.gitlab.http_get(f"{self.path}/process_metrics", **kwargs)
 
     @cli.register_custom_action(cls_names="SidekiqManager")
     @exc.on_http_error(exc.GitlabGetError)
-    def job_stats(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
+    def job_stats(self, **kwargs: Any) -> dict[str, Any] | requests.Response:
         """Return statistics about the jobs performed.
 
         Args:
@@ -69,13 +70,11 @@ class SidekiqManager(RESTManager):
         Returns:
             Statistics about the Sidekiq jobs performed
         """
-        return self.gitlab.http_get("/sidekiq/job_stats", **kwargs)
+        return self.gitlab.http_get(f"{self.path}/job_stats", **kwargs)
 
     @cli.register_custom_action(cls_names="SidekiqManager")
     @exc.on_http_error(exc.GitlabGetError)
-    def compound_metrics(
-        self, **kwargs: Any
-    ) -> Union[Dict[str, Any], requests.Response]:
+    def compound_metrics(self, **kwargs: Any) -> dict[str, Any] | requests.Response:
         """Return all available metrics and statistics.
 
         Args:
@@ -88,4 +87,4 @@ class SidekiqManager(RESTManager):
         Returns:
             All available Sidekiq metrics and statistics
         """
-        return self.gitlab.http_get("/sidekiq/compound_metrics", **kwargs)
+        return self.gitlab.http_get(f"{self.path}/compound_metrics", **kwargs)

gitlab/v4/objects/snippets.py

@@ -1,22 +1,13 @@
-from typing import (
-    Any,
-    Callable,
-    cast,
-    Iterator,
-    List,
-    Literal,
-    Optional,
-    overload,
-    TYPE_CHECKING,
-    Union,
-)
+from __future__ import annotations
+
+from typing import Any, Callable, Iterator, Literal, overload, TYPE_CHECKING
 
 import requests
 
 from gitlab import cli
 from gitlab import exceptions as exc
 from gitlab import utils
-from gitlab.base import RESTManager, RESTObject, RESTObjectList
+from gitlab.base import RESTObject, RESTObjectList
 from gitlab.mixins import CRUDMixin, ObjectDeleteMixin, SaveMixin, UserAgentDetailMixin
 from gitlab.types import RequiredOptional
 
@@ -24,12 +15,7 @@ from .award_emojis import ProjectSnippetAwardEmojiManager  # noqa: F401
 from .discussions import ProjectSnippetDiscussionManager  # noqa: F401
 from .notes import ProjectSnippetNoteManager  # noqa: F401
 
-__all__ = [
-    "Snippet",
-    "SnippetManager",
-    "ProjectSnippet",
-    "ProjectSnippetManager",
-]
+__all__ = ["Snippet", "SnippetManager", "ProjectSnippet", "ProjectSnippetManager"]
 
 
 class Snippet(UserAgentDetailMixin, SaveMixin, ObjectDeleteMixin, RESTObject):
@@ -61,7 +47,7 @@ class Snippet(UserAgentDetailMixin, SaveMixin, ObjectDeleteMixin, RESTObject):
     def content(
         self,
         streamed: Literal[True] = True,
-        action: Optional[Callable[[bytes], Any]] = None,
+        action: Callable[[bytes], Any] | None = None,
         chunk_size: int = 1024,
         *,
         iterator: Literal[False] = False,
@@ -73,12 +59,12 @@ class Snippet(UserAgentDetailMixin, SaveMixin, ObjectDeleteMixin, RESTObject):
     def content(
         self,
         streamed: bool = False,
-        action: Optional[Callable[..., Any]] = None,
+        action: Callable[..., Any] | None = None,
         chunk_size: int = 1024,
         *,
         iterator: bool = False,
         **kwargs: Any,
-    ) -> Optional[Union[bytes, Iterator[Any]]]:
+    ) -> bytes | Iterator[Any] | None:
         """Return the content of a snippet.
 
         Args:
@@ -110,31 +96,37 @@ class Snippet(UserAgentDetailMixin, SaveMixin, ObjectDeleteMixin, RESTObject):
         )
 
 
-class SnippetManager(CRUDMixin, RESTManager):
+class SnippetManager(CRUDMixin[Snippet]):
     _path = "/snippets"
     _obj_cls = Snippet
     _create_attrs = RequiredOptional(
         required=("title",),
         exclusive=("files", "file_name"),
-        optional=(
-            "description",
-            "content",
-            "visibility",
-        ),
+        optional=("description", "content", "visibility"),
     )
     _update_attrs = RequiredOptional(
-        optional=(
-            "title",
-            "files",
-            "file_name",
-            "content",
-            "visibility",
-            "description",
-        ),
+        optional=("title", "files", "file_name", "content", "visibility", "description")
     )
 
+    @overload
+    def list_public(
+        self, *, iterator: Literal[False] = False, **kwargs: Any
+    ) -> list[Snippet]: ...
+
+    @overload
+    def list_public(
+        self, *, iterator: Literal[True] = True, **kwargs: Any
+    ) -> RESTObjectList[Snippet]: ...
+
+    @overload
+    def list_public(
+        self, *, iterator: bool = False, **kwargs: Any
+    ) -> RESTObjectList[Snippet] | list[Snippet]: ...
+
     @cli.register_custom_action(cls_names="SnippetManager")
-    def list_public(self, **kwargs: Any) -> Union[RESTObjectList, List[RESTObject]]:
+    def list_public(
+        self, *, iterator: bool = False, **kwargs: Any
+    ) -> RESTObjectList[Snippet] | list[Snippet]:
         """List all public snippets.
 
         Args:
@@ -151,10 +143,27 @@ class SnippetManager(CRUDMixin, RESTManager):
         Returns:
             The list of snippets, or a generator if `iterator` is True
         """
-        return self.list(path="/snippets/public", **kwargs)
+        return self.list(path="/snippets/public", iterator=iterator, **kwargs)
+
+    @overload
+    def list_all(
+        self, *, iterator: Literal[False] = False, **kwargs: Any
+    ) -> list[Snippet]: ...
+
+    @overload
+    def list_all(
+        self, *, iterator: Literal[True] = True, **kwargs: Any
+    ) -> RESTObjectList[Snippet]: ...
+
+    @overload
+    def list_all(
+        self, *, iterator: bool = False, **kwargs: Any
+    ) -> RESTObjectList[Snippet] | list[Snippet]: ...
 
     @cli.register_custom_action(cls_names="SnippetManager")
-    def list_all(self, **kwargs: Any) -> Union[RESTObjectList, List[RESTObject]]:
+    def list_all(
+        self, *, iterator: bool = False, **kwargs: Any
+    ) -> RESTObjectList[Snippet] | list[Snippet]:
         """List all snippets.
 
         Args:
@@ -171,9 +180,30 @@ class SnippetManager(CRUDMixin, RESTManager):
         Returns:
             A generator for the snippets list
         """
-        return self.list(path="/snippets/all", **kwargs)
+        return self.list(path="/snippets/all", iterator=iterator, **kwargs)
 
-    def public(self, **kwargs: Any) -> Union[RESTObjectList, List[RESTObject]]:
+    @overload
+    def public(
+        self,
+        *,
+        iterator: Literal[False] = False,
+        page: int | None = None,
+        **kwargs: Any,
+    ) -> list[Snippet]: ...
+
+    @overload
+    def public(
+        self, *, iterator: Literal[True] = True, **kwargs: Any
+    ) -> RESTObjectList[Snippet]: ...
+
+    @overload
+    def public(
+        self, *, iterator: bool = False, **kwargs: Any
+    ) -> RESTObjectList[Snippet] | list[Snippet]: ...
+
+    def public(
+        self, *, iterator: bool = False, **kwargs: Any
+    ) -> RESTObjectList[Snippet] | list[Snippet]:
         """List all public snippets.
 
         Args:
@@ -197,10 +227,7 @@ class SnippetManager(CRUDMixin, RESTManager):
             ),
             category=DeprecationWarning,
         )
-        return self.list(path="/snippets/public", **kwargs)
-
-    def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> Snippet:
-        return cast(Snippet, super().get(id=id, lazy=lazy, **kwargs))
+        return self.list(path="/snippets/public", iterator=iterator, **kwargs)
 
 
 class ProjectSnippet(UserAgentDetailMixin, SaveMixin, ObjectDeleteMixin, RESTObject):
@@ -237,7 +264,7 @@ class ProjectSnippet(UserAgentDetailMixin, SaveMixin, ObjectDeleteMixin, RESTObj
     def content(
         self,
         streamed: Literal[True] = True,
-        action: Optional[Callable[[bytes], Any]] = None,
+        action: Callable[[bytes], Any] | None = None,
         chunk_size: int = 1024,
         *,
         iterator: Literal[False] = False,
@@ -249,12 +276,12 @@ class ProjectSnippet(UserAgentDetailMixin, SaveMixin, ObjectDeleteMixin, RESTObj
     def content(
         self,
         streamed: bool = False,
-        action: Optional[Callable[..., Any]] = None,
+        action: Callable[..., Any] | None = None,
         chunk_size: int = 1024,
         *,
         iterator: bool = False,
         **kwargs: Any,
-    ) -> Optional[Union[bytes, Iterator[Any]]]:
+    ) -> bytes | Iterator[Any] | None:
         """Return the content of a snippet.
 
         Args:
@@ -286,30 +313,15 @@ class ProjectSnippet(UserAgentDetailMixin, SaveMixin, ObjectDeleteMixin, RESTObj
         )
 
 
-class ProjectSnippetManager(CRUDMixin, RESTManager):
+class ProjectSnippetManager(CRUDMixin[ProjectSnippet]):
     _path = "/projects/{project_id}/snippets"
     _obj_cls = ProjectSnippet
     _from_parent_attrs = {"project_id": "id"}
     _create_attrs = RequiredOptional(
         required=("title", "visibility"),
         exclusive=("files", "file_name"),
-        optional=(
-            "description",
-            "content",
-        ),
+        optional=("description", "content"),
     )
     _update_attrs = RequiredOptional(
-        optional=(
-            "title",
-            "files",
-            "file_name",
-            "content",
-            "visibility",
-            "description",
-        ),
+        optional=("title", "files", "file_name", "content", "visibility", "description")
     )
-
-    def get(
-        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
-    ) -> ProjectSnippet:
-        return cast(ProjectSnippet, super().get(id=id, lazy=lazy, **kwargs))

gitlab/v4/objects/statistics.py

@@ -1,6 +1,4 @@
-from typing import Any, cast
-
-from gitlab.base import RESTManager, RESTObject
+from gitlab.base import RESTObject
 from gitlab.mixins import GetWithoutIdMixin, RefreshMixin
 from gitlab.types import ArrayAttribute
 
@@ -22,66 +20,53 @@ class ProjectAdditionalStatistics(RefreshMixin, RESTObject):
     _id_attr = None
 
 
-class ProjectAdditionalStatisticsManager(GetWithoutIdMixin, RESTManager):
+class ProjectAdditionalStatisticsManager(
+    GetWithoutIdMixin[ProjectAdditionalStatistics]
+):
     _path = "/projects/{project_id}/statistics"
     _obj_cls = ProjectAdditionalStatistics
     _from_parent_attrs = {"project_id": "id"}
 
-    def get(self, **kwargs: Any) -> ProjectAdditionalStatistics:
-        return cast(ProjectAdditionalStatistics, super().get(**kwargs))
-
 
 class IssuesStatistics(RefreshMixin, RESTObject):
     _id_attr = None
 
 
-class IssuesStatisticsManager(GetWithoutIdMixin, RESTManager):
+class IssuesStatisticsManager(GetWithoutIdMixin[IssuesStatistics]):
     _path = "/issues_statistics"
     _obj_cls = IssuesStatistics
     _list_filters = ("iids",)
     _types = {"iids": ArrayAttribute}
 
-    def get(self, **kwargs: Any) -> IssuesStatistics:
-        return cast(IssuesStatistics, super().get(**kwargs))
-
 
 class GroupIssuesStatistics(RefreshMixin, RESTObject):
     _id_attr = None
 
 
-class GroupIssuesStatisticsManager(GetWithoutIdMixin, RESTManager):
+class GroupIssuesStatisticsManager(GetWithoutIdMixin[GroupIssuesStatistics]):
     _path = "/groups/{group_id}/issues_statistics"
     _obj_cls = GroupIssuesStatistics
     _from_parent_attrs = {"group_id": "id"}
     _list_filters = ("iids",)
     _types = {"iids": ArrayAttribute}
 
-    def get(self, **kwargs: Any) -> GroupIssuesStatistics:
-        return cast(GroupIssuesStatistics, super().get(**kwargs))
-
 
 class ProjectIssuesStatistics(RefreshMixin, RESTObject):
     _id_attr = None
 
 
-class ProjectIssuesStatisticsManager(GetWithoutIdMixin, RESTManager):
+class ProjectIssuesStatisticsManager(GetWithoutIdMixin[ProjectIssuesStatistics]):
     _path = "/projects/{project_id}/issues_statistics"
     _obj_cls = ProjectIssuesStatistics
     _from_parent_attrs = {"project_id": "id"}
     _list_filters = ("iids",)
     _types = {"iids": ArrayAttribute}
 
-    def get(self, **kwargs: Any) -> ProjectIssuesStatistics:
-        return cast(ProjectIssuesStatistics, super().get(**kwargs))
-
 
 class ApplicationStatistics(RESTObject):
     _id_attr = None
 
 
-class ApplicationStatisticsManager(GetWithoutIdMixin, RESTManager):
+class ApplicationStatisticsManager(GetWithoutIdMixin[ApplicationStatistics]):
     _path = "/application/statistics"
     _obj_cls = ApplicationStatistics
-
-    def get(self, **kwargs: Any) -> ApplicationStatistics:
-        return cast(ApplicationStatistics, super().get(**kwargs))

gitlab/v4/objects/status_checks.py

@@ -1,4 +1,4 @@
-from gitlab.base import RESTManager, RESTObject
+from gitlab.base import RESTObject
 from gitlab.mixins import (
     CreateMixin,
     DeleteMixin,
@@ -23,7 +23,10 @@ class ProjectExternalStatusCheck(SaveMixin, ObjectDeleteMixin, RESTObject):
 
 
 class ProjectExternalStatusCheckManager(
-    ListMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTManager
+    ListMixin[ProjectExternalStatusCheck],
+    CreateMixin[ProjectExternalStatusCheck],
+    UpdateMixin[ProjectExternalStatusCheck],
+    DeleteMixin[ProjectExternalStatusCheck],
 ):
     _path = "/projects/{project_id}/external_status_checks"
     _obj_cls = ProjectExternalStatusCheck
@@ -42,7 +45,7 @@ class ProjectMergeRequestStatusCheck(SaveMixin, RESTObject):
     pass
 
 
-class ProjectMergeRequestStatusCheckManager(ListMixin, RESTManager):
+class ProjectMergeRequestStatusCheckManager(ListMixin[ProjectMergeRequestStatusCheck]):
     _path = "/projects/{project_id}/merge_requests/{merge_request_iid}/status_checks"
     _obj_cls = ProjectMergeRequestStatusCheck
     _from_parent_attrs = {"project_id": "project_id", "merge_request_iid": "iid"}

gitlab/v4/objects/tags.py

@@ -1,6 +1,4 @@
-from typing import Any, cast, Union
-
-from gitlab.base import RESTManager, RESTObject
+from gitlab.base import RESTObject
 from gitlab.mixins import NoUpdateMixin, ObjectDeleteMixin
 from gitlab.types import RequiredOptional
 
@@ -17,32 +15,25 @@ class ProjectTag(ObjectDeleteMixin, RESTObject):
     _repr_attr = "name"
 
 
-class ProjectTagManager(NoUpdateMixin, RESTManager):
+class ProjectTagManager(NoUpdateMixin[ProjectTag]):
     _path = "/projects/{project_id}/repository/tags"
     _obj_cls = ProjectTag
     _from_parent_attrs = {"project_id": "id"}
+    _list_filters = ("order_by", "sort", "search")
     _create_attrs = RequiredOptional(
         required=("tag_name", "ref"), optional=("message",)
     )
 
-    def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> ProjectTag:
-        return cast(ProjectTag, super().get(id=id, lazy=lazy, **kwargs))
-
 
 class ProjectProtectedTag(ObjectDeleteMixin, RESTObject):
     _id_attr = "name"
     _repr_attr = "name"
 
 
-class ProjectProtectedTagManager(NoUpdateMixin, RESTManager):
+class ProjectProtectedTagManager(NoUpdateMixin[ProjectProtectedTag]):
     _path = "/projects/{project_id}/protected_tags"
     _obj_cls = ProjectProtectedTag
     _from_parent_attrs = {"project_id": "id"}
     _create_attrs = RequiredOptional(
         required=("name",), optional=("create_access_level",)
     )
-
-    def get(
-        self, id: Union[str, int], lazy: bool = False, **kwargs: Any
-    ) -> ProjectProtectedTag:
-        return cast(ProjectProtectedTag, super().get(id=id, lazy=lazy, **kwargs))