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

gitlab/__init__.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # Copyright (C) 2013-2019 Gauvain Pocentek, 2019-2023 python-gitlab team
 #

gitlab/_backends/protocol.py

@@ -1,15 +1,11 @@
+from __future__ import annotations
+
 import abc
-import sys
-from typing import Any, Dict, Optional, Union
+from typing import Any, Protocol
 
 import requests
 from requests_toolbelt.multipart.encoder import MultipartEncoder  # type: ignore
 
-if sys.version_info >= (3, 8):
-    from typing import Protocol
-else:
-    from typing_extensions import Protocol
-
 
 class BackendResponse(Protocol):
     @abc.abstractmethod
@@ -22,11 +18,11 @@ class Backend(Protocol):
         self,
         method: str,
         url: str,
-        json: Optional[Union[Dict[str, Any], bytes]],
-        data: Optional[Union[Dict[str, Any], MultipartEncoder]],
-        params: Optional[Any],
-        timeout: Optional[float],
-        verify: Optional[Union[bool, str]],
-        stream: Optional[bool],
+        json: dict[str, Any] | bytes | None,
+        data: dict[str, Any] | MultipartEncoder | None,
+        params: Any | None,
+        timeout: float | None,
+        verify: bool | str | None,
+        stream: bool | None,
         **kwargs: Any,
     ) -> BackendResponse: ...

gitlab/_backends/requests_backend.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import dataclasses
-from typing import Any, BinaryIO, Dict, Optional, TYPE_CHECKING, Union
+from typing import Any, BinaryIO, TYPE_CHECKING
 
 import requests
 from requests import PreparedRequest
@@ -44,8 +44,8 @@ class JobTokenAuth(TokenAuth, AuthBase):
 @dataclasses.dataclass
 class SendData:
     content_type: str
-    data: Optional[Union[Dict[str, Any], MultipartEncoder]] = None
-    json: Optional[Union[Dict[str, Any], bytes]] = None
+    data: dict[str, Any] | MultipartEncoder | None = None
+    json: dict[str, Any] | bytes | None = None
 
     def __post_init__(self) -> None:
         if self.json is not None and self.data is not None:
@@ -84,7 +84,7 @@ class RequestsResponse(protocol.BackendResponse):
 
 
 class RequestsBackend(protocol.Backend):
-    def __init__(self, session: Optional[requests.Session] = None) -> None:
+    def __init__(self, session: requests.Session | None = None) -> None:
         self._client: requests.Session = session or requests.Session()
 
     @property
@@ -93,8 +93,8 @@ class RequestsBackend(protocol.Backend):
 
     @staticmethod
     def prepare_send_data(
-        files: Optional[Dict[str, Any]] = None,
-        post_data: Optional[Union[Dict[str, Any], bytes, BinaryIO]] = None,
+        files: dict[str, Any] | None = None,
+        post_data: dict[str, Any] | bytes | BinaryIO | None = None,
         raw: bool = False,
     ) -> SendData:
         if files:
@@ -130,12 +130,12 @@ class RequestsBackend(protocol.Backend):
         self,
         method: str,
         url: str,
-        json: Optional[Union[Dict[str, Any], bytes]] = None,
-        data: Optional[Union[Dict[str, Any], MultipartEncoder]] = None,
-        params: Optional[Any] = None,
-        timeout: Optional[float] = None,
-        verify: Optional[Union[bool, str]] = True,
-        stream: Optional[bool] = False,
+        json: dict[str, Any] | bytes | None = None,
+        data: dict[str, Any] | MultipartEncoder | None = None,
+        params: Any | None = None,
+        timeout: float | None = None,
+        verify: bool | str | None = True,
+        stream: bool | None = False,
         **kwargs: Any,
     ) -> RequestsResponse:
         """Make HTTP request

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__ = "5.6.0"
+__version__ = "6.1.0"

gitlab/base.py

@@ -1,10 +1,13 @@
+from __future__ import annotations
+
 import copy
 import importlib
 import json
 import pprint
 import textwrap
+from collections.abc import Iterable
 from types import ModuleType
-from typing import Any, Dict, Iterable, Optional, Type, TYPE_CHECKING, Union
+from typing import Any, ClassVar, Generic, TYPE_CHECKING, TypeVar
 
 import gitlab
 from gitlab import types as g_types
@@ -12,11 +15,7 @@ from gitlab.exceptions import GitlabParsingError
 
 from .client import Gitlab, GitlabList
 
-__all__ = [
-    "RESTObject",
-    "RESTObjectList",
-    "RESTManager",
-]
+__all__ = ["RESTObject", "RESTObjectList", "RESTManager"]
 
 
 _URL_ATTRIBUTE_ERROR = (
@@ -40,20 +39,20 @@ class RESTObject:
     object's ``__repr__()`` method.
     """
 
-    _id_attr: Optional[str] = "id"
-    _attrs: Dict[str, Any]
+    _id_attr: str | None = "id"
+    _attrs: dict[str, Any]
     _created_from_list: bool  # Indicates if object was created from a list() action
     _module: ModuleType
-    _parent_attrs: Dict[str, Any]
-    _repr_attr: Optional[str] = None
-    _updated_attrs: Dict[str, Any]
+    _parent_attrs: dict[str, Any]
+    _repr_attr: str | None = None
+    _updated_attrs: dict[str, Any]
     _lazy: bool
-    manager: "RESTManager"
+    manager: RESTManager[Any]
 
     def __init__(
         self,
-        manager: "RESTManager",
-        attrs: Dict[str, Any],
+        manager: RESTManager[Any],
+        attrs: dict[str, Any],
         *,
         created_from_list: bool = False,
         lazy: bool = False,
@@ -77,13 +76,13 @@ class RESTObject:
         self.__dict__["_parent_attrs"] = self.manager.parent_attrs
         self._create_managers()
 
-    def __getstate__(self) -> Dict[str, Any]:
+    def __getstate__(self) -> dict[str, Any]:
         state = self.__dict__.copy()
         module = state.pop("_module")
         state["_module_name"] = module.__name__
         return state
 
-    def __setstate__(self, state: Dict[str, Any]) -> None:
+    def __setstate__(self, state: dict[str, Any]) -> None:
         module_name = state.pop("_module_name")
         self.__dict__.update(state)
         self.__dict__["_module"] = importlib.import_module(module_name)
@@ -136,7 +135,7 @@ class RESTObject:
     def __setattr__(self, name: str, value: Any) -> None:
         self.__dict__["_updated_attrs"][name] = value
 
-    def asdict(self, *, with_parent_attrs: bool = False) -> Dict[str, Any]:
+    def asdict(self, *, with_parent_attrs: bool = False) -> dict[str, Any]:
         data = {}
         if with_parent_attrs:
             data.update(copy.deepcopy(self._parent_attrs))
@@ -145,7 +144,7 @@ class RESTObject:
         return data
 
     @property
-    def attributes(self) -> Dict[str, Any]:
+    def attributes(self) -> dict[str, Any]:
         return self.asdict(with_parent_attrs=True)
 
     def to_json(self, *, with_parent_attrs: bool = False, **kwargs: Any) -> str:
@@ -220,11 +219,11 @@ class RESTObject:
             # Since we have our own __setattr__ method, we can't use setattr()
             self.__dict__[attr] = manager
 
-    def _update_attrs(self, new_attrs: Dict[str, Any]) -> None:
+    def _update_attrs(self, new_attrs: dict[str, Any]) -> None:
         self.__dict__["_updated_attrs"] = {}
         self.__dict__["_attrs"] = new_attrs
 
-    def get_id(self) -> Optional[Union[int, str]]:
+    def get_id(self) -> int | str | None:
         """Returns the id of the resource."""
         if self._id_attr is None or not hasattr(self, self._id_attr):
             return None
@@ -234,7 +233,7 @@ class RESTObject:
         return id_val
 
     @property
-    def _repr_value(self) -> Optional[str]:
+    def _repr_value(self) -> str | None:
         """Safely returns the human-readable resource name if present."""
         if self._repr_attr is None or not hasattr(self, self._repr_attr):
             return None
@@ -244,7 +243,7 @@ class RESTObject:
         return repr_val
 
     @property
-    def encoded_id(self) -> Optional[Union[int, str]]:
+    def encoded_id(self) -> int | str | None:
         """Ensure that the ID is url-encoded so that it can be safely used in a URL
         path"""
         obj_id = self.get_id()
@@ -253,7 +252,10 @@ class RESTObject:
         return obj_id
 
 
-class RESTObjectList:
+TObjCls = TypeVar("TObjCls", bound=RESTObject)
+
+
+class RESTObjectList(Generic[TObjCls]):
     """Generator object representing a list of RESTObject's.
 
     This generator uses the Gitlab pagination system to fetch new data when
@@ -269,7 +271,7 @@ class RESTObjectList:
     """
 
     def __init__(
-        self, manager: "RESTManager", obj_cls: Type[RESTObject], _list: GitlabList
+        self, manager: RESTManager[TObjCls], obj_cls: type[TObjCls], _list: GitlabList
     ) -> None:
         """Creates an objects list from a GitlabList.
 
@@ -285,16 +287,16 @@ class RESTObjectList:
         self._obj_cls = obj_cls
         self._list = _list
 
-    def __iter__(self) -> "RESTObjectList":
+    def __iter__(self) -> RESTObjectList[TObjCls]:
         return self
 
     def __len__(self) -> int:
         return len(self._list)
 
-    def __next__(self) -> RESTObject:
+    def __next__(self) -> TObjCls:
         return self.next()
 
-    def next(self) -> RESTObject:
+    def next(self) -> TObjCls:
         data = self._list.next()
         return self._obj_cls(self.manager, data, created_from_list=True)
 
@@ -304,7 +306,7 @@ class RESTObjectList:
         return self._list.current_page
 
     @property
-    def prev_page(self) -> Optional[int]:
+    def prev_page(self) -> int | None:
         """The previous page number.
 
         If None, the current page is the first.
@@ -312,7 +314,7 @@ class RESTObjectList:
         return self._list.prev_page
 
     @property
-    def next_page(self) -> Optional[int]:
+    def next_page(self) -> int | None:
         """The next page number.
 
         If None, the current page is the last.
@@ -320,22 +322,22 @@ class RESTObjectList:
         return self._list.next_page
 
     @property
-    def per_page(self) -> Optional[int]:
+    def per_page(self) -> int | None:
         """The number of items per page."""
         return self._list.per_page
 
     @property
-    def total_pages(self) -> Optional[int]:
+    def total_pages(self) -> int | None:
         """The total number of pages."""
         return self._list.total_pages
 
     @property
-    def total(self) -> Optional[int]:
+    def total(self) -> int | None:
         """The total number of items."""
         return self._list.total
 
 
-class RESTManager:
+class RESTManager(Generic[TObjCls]):
     """Base class for CRUD operations on objects.
 
     Derived class must define ``_path`` and ``_obj_cls``.
@@ -346,17 +348,17 @@ class RESTManager:
 
     _create_attrs: g_types.RequiredOptional = g_types.RequiredOptional()
     _update_attrs: g_types.RequiredOptional = g_types.RequiredOptional()
-    _path: Optional[str] = None
-    _obj_cls: Optional[Type[RESTObject]] = None
-    _from_parent_attrs: Dict[str, Any] = {}
-    _types: Dict[str, Type[g_types.GitlabAttribute]] = {}
-
-    _computed_path: Optional[str]
-    _parent: Optional[RESTObject]
-    _parent_attrs: Dict[str, Any]
+    _path: ClassVar[str]
+    _obj_cls: type[TObjCls]
+    _from_parent_attrs: dict[str, Any] = {}
+    _types: dict[str, type[g_types.GitlabAttribute]] = {}
+
+    _computed_path: str
+    _parent: RESTObject | None
+    _parent_attrs: dict[str, Any]
     gitlab: Gitlab
 
-    def __init__(self, gl: Gitlab, parent: Optional[RESTObject] = None) -> None:
+    def __init__(self, gl: Gitlab, parent: RESTObject | None = None) -> None:
         """REST manager constructor.
 
         Args:
@@ -368,19 +370,17 @@ class RESTManager:
         self._computed_path = self._compute_path()
 
     @property
-    def parent_attrs(self) -> Optional[Dict[str, Any]]:
+    def parent_attrs(self) -> dict[str, Any] | None:
         return self._parent_attrs
 
-    def _compute_path(self, path: Optional[str] = None) -> Optional[str]:
+    def _compute_path(self, path: str | None = None) -> str:
         self._parent_attrs = {}
         if path is None:
             path = self._path
-        if path is None:
-            return None
         if self._parent is None or not self._from_parent_attrs:
             return path
 
-        data: Dict[str, Optional[gitlab.utils.EncodedId]] = {}
+        data: dict[str, gitlab.utils.EncodedId | None] = {}
         for self_attr, parent_attr in self._from_parent_attrs.items():
             if not hasattr(self._parent, parent_attr):
                 data[self_attr] = None
@@ -390,5 +390,5 @@ class RESTManager:
         return path.format(**data)
 
     @property
-    def path(self) -> Optional[str]:
+    def path(self) -> str:
         return self._computed_path

gitlab/cli.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import argparse
 import dataclasses
 import functools
@@ -6,19 +8,7 @@ import pathlib
 import re
 import sys
 from types import ModuleType
-from typing import (
-    Any,
-    Callable,
-    cast,
-    Dict,
-    NoReturn,
-    Optional,
-    Tuple,
-    Type,
-    TYPE_CHECKING,
-    TypeVar,
-    Union,
-)
+from typing import Any, Callable, cast, NoReturn, TYPE_CHECKING, TypeVar
 
 from requests.structures import CaseInsensitiveDict
 
@@ -33,11 +23,11 @@ camel_lowerupper_regex = re.compile(r"([a-z\d])([A-Z])")
 
 @dataclasses.dataclass
 class CustomAction:
-    required: Tuple[str, ...]
-    optional: Tuple[str, ...]
+    required: tuple[str, ...]
+    optional: tuple[str, ...]
     in_object: bool
     requires_id: bool  # if the `_id_attr` value should be a required argument
-    help: Optional[str]  # help text for the custom action
+    help: str | None  # help text for the custom action
 
 
 # custom_actions = {
@@ -45,7 +35,7 @@ class CustomAction:
 #        action: CustomAction,
 #    },
 # }
-custom_actions: Dict[str, Dict[str, CustomAction]] = {}
+custom_actions: dict[str, dict[str, CustomAction]] = {}
 
 
 # For an explanation of how these type-hints work see:
@@ -57,12 +47,12 @@ __F = TypeVar("__F", bound=Callable[..., Any])
 
 def register_custom_action(
     *,
-    cls_names: Union[str, Tuple[str, ...]],
-    required: Tuple[str, ...] = (),
-    optional: Tuple[str, ...] = (),
-    custom_action: Optional[str] = None,
+    cls_names: str | tuple[str, ...],
+    required: tuple[str, ...] = (),
+    optional: tuple[str, ...] = (),
+    custom_action: str | None = None,
     requires_id: bool = True,  # if the `_id_attr` value should be a required argument
-    help: Optional[str] = None,  # help text for the action
+    help: str | None = None,  # help text for the action
 ) -> Callable[[__F], __F]:
     def wrap(f: __F) -> __F:
         @functools.wraps(f)
@@ -98,7 +88,7 @@ def register_custom_action(
     return wrap
 
 
-def die(msg: str, e: Optional[Exception] = None) -> NoReturn:
+def die(msg: str, e: Exception | None = None) -> NoReturn:
     if e:
         msg = f"{msg} ({e})"
     sys.stderr.write(f"{msg}\n")
@@ -107,7 +97,7 @@ def die(msg: str, e: Optional[Exception] = None) -> NoReturn:
 
 def gitlab_resource_to_cls(
     gitlab_resource: str, namespace: ModuleType
-) -> Type[RESTObject]:
+) -> type[RESTObject]:
     classes = CaseInsensitiveDict(namespace.__dict__)
     lowercase_class = gitlab_resource.replace("-", "")
     class_type = classes[lowercase_class]
@@ -117,7 +107,7 @@ def gitlab_resource_to_cls(
     return class_type
 
 
-def cls_to_gitlab_resource(cls: RESTObject) -> str:
+def cls_to_gitlab_resource(cls: type[RESTObject]) -> str:
     dasherized_uppercase = camel_upperlower_regex.sub(r"\1-\2", cls.__name__)
     dasherized_lowercase = camel_lowerupper_regex.sub(r"\1-\2", dasherized_uppercase)
     return dasherized_lowercase.lower()