Jun 5, 2022 · Jun 3, 2022 · Jun 3, 2022 · Jun 3, 2022 · Jun 3, 2022 · Jun 3, 2022
diff --git a/gitlab/cli.py b/gitlab/cli.py
 def _get_parser() -> argparse.ArgumentParser:
    # NOTE: We must delay import of gitlab.v4.cli until now or
    # otherwise it will cause circular import errors
 import gitlab.v4.cli
 from gitlab.v4 importcli as v4_cli

    parser = _get_base_parser()
    returngitlab.v4.cli.extend_parser(parser)
    returnv4_cli.extend_parser(parser)


 def _parse_value(v: Any) -> Any:
    if isinstance(v, str) and v.startswith("@"):
        # If the user-provided value starts with @, we try to read the file
        # path provided after @ as the real value. Exit on any error.
        try:
            with open(v[1:]) as f:
            with open(v[1:], encoding="utf-8") as f:
                return f.read()
        except Exception as e:
            sys.stderr.write(f"{e}\n")
diff --git a/gitlab/client.py b/gitlab/client.py
            raise ModuleNotFoundError(f"gitlab.v{self._api_version}.objects")
        # NOTE: We must delay import of gitlab.v4.objects until now or
        # otherwise it will cause circular import errors
 import gitlab.v4.objects
 from gitlab.v4 importobjects

        objects = gitlab.v4.objects
        self._objects = objects
        self.user: Optional[objects.CurrentUser] = None

        self.broadcastmessages = objects.BroadcastMessageManager(self)
        """See :class:`~gitlab.v4.objects.BroadcastMessageManager`"""
            )  # pragma: no cover, dead code currently
        # NOTE: We must delay import of gitlab.v4.objects until now or
        # otherwise it will cause circular import errors
 import gitlab.v4.objects
 from gitlab.v4 importobjects

        self._objects =gitlab.v4.objects
        self._objects = objects

    @property
    def url(self) -> str:
                self.http_username, self.http_password
            )

    def enable_debug(self) -> None:
    @staticmethod
    def enable_debug() -> None:
        import logging
        from http.client import HTTPConnection  # noqa

            "verify": self.ssl_verify,
        }

    def _get_base_url(self, url: Optional[str] = None) -> str:
    @staticmethod
    def _get_base_url(url: Optional[str] = None) -> str:
        """Return the base URL with the trailing slash stripped.
        If the URL is a Falsy value, return the default URL.
        Returns:
        """
        if path.startswith("http://") or path.startswith("https://"):
            return path
        else:
            return f"{self._url}{path}"
        return f"{self._url}{path}"

    def _check_redirects(self, result: requests.Response) -> None:
    @staticmethod
    def _check_redirects(result: requests.Response) -> None:
        # Check the requests history to detect 301/302 redirections.
        # If the initial verb is POST or PUT, the redirected request will use a
        # GET request, leading to unwanted behaviour.
                )
            )

    @staticmethod
    def _prepare_send_data(
        self,
        files: Optional[Dict[str, Any]] = None,
        post_data: Optional[Union[Dict[str, Any], bytes]] = None,
        raw: bool = False,
diff --git a/gitlab/config.py b/gitlab/config.py
            try:
                resolved = _resolve_file(config_file)
            except OSError as e:
                raise GitlabConfigMissingError(f"Cannot read config from file: {e}")
                raise GitlabConfigMissingError(
                    f"Cannot read config from file: {e}"
                ) from e
            resolved_files.append(resolved)

        return resolved_files
    except OSError as e:
        raise GitlabConfigMissingError(
            f"Cannot read config from PYTHON_GITLAB_CFG: {e}"
        )
        ) from e

    for config_file in _DEFAULT_FILES:
        try:
diff --git a/gitlab/exceptions.py b/gitlab/exceptions.py
    def __str__(self) -> str:
        if self.response_code is not None:
            return f"{self.response_code}: {self.error_message}"
        else:
            return f"{self.error_message}"
        return f"{self.error_message}"


 class GitlabAuthenticationError(GitlabError):
diff --git a/gitlab/mixins.py b/gitlab/mixins.py
        obj = self.gitlab.http_list(path, **data)
        if isinstance(obj, list):
            return [self._obj_cls(self, item, created_from_list=True) for item in obj]
        else:
            return base.RESTObjectList(self, self._obj_cls, obj)
        return base.RESTObjectList(self, self._obj_cls, obj)


 class RetrieveMixin(ListMixin, GetMixin):
    _path: Optional[str]
    gitlab: gitlab.Gitlab

    pass


 class CreateMixin(_RestManagerBase):
    _computed_path: Optional[str]
    _path: Optional[str]
    gitlab: gitlab.Gitlab

    pass


 class NoUpdateMixin(GetMixin, ListMixin, CreateMixin, DeleteMixin):
    _computed_path: Optional[str]
    _path: Optional[str]
    gitlab: gitlab.Gitlab

    pass


 class SaveMixin(_RestObjectBase):
    """Mixin for RESTObject's that can be updated."""
diff --git a/gitlab/types.py b/gitlab/types.py


 class FileAttribute(GitlabAttribute):
    def get_file_name(self, attr_name: Optional[str] = None) -> Optional[str]:
    @staticmethod
    def get_file_name(attr_name: Optional[str] = None) -> Optional[str]:
        return attr_name


 class ImageAttribute(FileAttribute):
    def get_file_name(self, attr_name: Optional[str] = None) -> str:
    @staticmethod
    def get_file_name(attr_name: Optional[str] = None) -> str:
        return f"{attr_name}.png" if attr_name else "image.png"
diff --git a/gitlab/v4/cli.py b/gitlab/v4/cli.py


 class JSONPrinter:
    def display(self, d: Union[str, Dict[str, Any]], **kwargs: Any) -> None:
    @staticmethod
    def display(d: Union[str, Dict[str, Any]], **kwargs: Any) -> None:
        import json  # noqa

        print(json.dumps(d))

    @staticmethod
    def display_list(
        self,
        data: List[Union[str, gitlab.base.RESTObject]],
        fields: List[str],
        **kwargs: Any,


 class YAMLPrinter:
    def display(self, d: Union[str, Dict[str, Any]], **kwargs: Any) -> None:
    @staticmethod
    def display(d: Union[str, Dict[str, Any]], **kwargs: Any) -> None:
        try:
            import yaml  # noqa

                "to use the yaml output feature"
            )

    @staticmethod
    def display_list(
        self,
        data: List[Union[str, gitlab.base.RESTObject]],
        fields: List[str],
        **kwargs: Any,
diff --git a/gitlab/v4/objects/files.py b/gitlab/v4/objects/files.py
 class ProjectFile(SaveMixin, ObjectDeleteMixin, RESTObject):
    _id_attr = "file_path"
    _repr_attr = "file_path"
    branch: str
    commit_message: str
    file_path: str
    manager: "ProjectFileManager"

diff --git a/gitlab/v4/objects/ldap.py b/gitlab/v4/objects/ldap.py
        obj = self.gitlab.http_list(path, **data)
        if isinstance(obj, list):
            return [self._obj_cls(self, item) for item in obj]
        else:
            return RESTObjectList(self, self._obj_cls, obj)
        return RESTObjectList(self, self._obj_cls, obj)
diff --git a/gitlab/v4/objects/merge_request_approvals.py b/gitlab/v4/objects/merge_request_approvals.py
    _id_attr = "approval_rule_id"
    _repr_attr = "approval_rule"
    id: int
    approval_rule_id: int
    merge_request_iid: int

    @exc.on_http_error(exc.GitlabUpdateError)
    def save(self, **kwargs: Any) -> None:
diff --git a/gitlab/v4/objects/packages.py b/gitlab/v4/objects/packages.py
        try:
            with open(path, "rb") as f:
                file_data = f.read()
        except OSError:
            raise exc.GitlabUploadError(f"Failed to read package file {path}")
        except OSError as e:
            raise exc.GitlabUploadError(f"Failed to read package file {path}") from e

        url = f"{self._computed_path}/{package_name}/{package_version}/{file_name}"
        server_data = self.gitlab.http_put(url, post_data=file_data, raw=True, **kwargs)
diff --git a/pyproject.toml b/pyproject.toml
 disable = [
    "arguments-differ",
    "arguments-renamed",
    "attribute-defined-outside-init",
    "broad-except",
    "consider-using-generator",
    "cyclic-import",
    "duplicate-code",
    "fixme",
    "implicit-str-concat",
    "import-outside-toplevel",
    "invalid-name",
    "missing-class-docstring",
    "missing-function-docstring",
    "missing-module-docstring",
    "no-else-return",
    "no-self-use",
    "protected-access",
    "raise-missing-from",
    "redefined-builtin",
    "redefined-outer-name",
    "signature-differs",
    "super-with-arguments",
    "too-few-public-methods",
    "too-many-ancestors",
    "too-many-arguments",
    "too-many-lines",
    "too-many-locals",
    "too-many-statements",
    "unexpected-keyword-arg",
    "unnecessary-pass",
    "unspecified-encoding",
    "unsubscriptable-object",
    "unused-argument",
    "useless-import-alias",
    "useless-object-inheritance",

 ]
Original file line number	Diff line number	Diff line change
Expand Up		@@ -252,18 +252,18 @@ def _get_base_parser(add_help: bool = True) -> argparse.ArgumentParser:
		def _get_parser() -> argparse.ArgumentParser:
		# NOTE: We must delay import of gitlab.v4.cli until now or
		# otherwise it will cause circular import errors
		import gitlab.v4.cli
		from gitlab.v4 importcli as v4_cli

		parser = _get_base_parser()
		returngitlab.v4.cli.extend_parser(parser)
		returnv4_cli.extend_parser(parser)


		def _parse_value(v: Any) -> Any:
		if isinstance(v, str) and v.startswith("@"):
		# If the user-provided value starts with @, we try to read the file
		# path provided after @ as the real value. Exit on any error.
		try:
		with open(v[1:]) as f:
		with open(v[1:], encoding="utf-8") as f:
		return f.read()
		except Exception as e:
		sys.stderr.write(f"{e}\n")
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -119,10 +119,10 @@ def __init__(
		raise ModuleNotFoundError(f"gitlab.v{self._api_version}.objects")
		# NOTE: We must delay import of gitlab.v4.objects until now or
		# otherwise it will cause circular import errors
		import gitlab.v4.objects
		from gitlab.v4 importobjects

		objects = gitlab.v4.objects
		self._objects = objects
		self.user: Optional[objects.CurrentUser] = None

		self.broadcastmessages = objects.BroadcastMessageManager(self)
		"""See :class:`~gitlab.v4.objects.BroadcastMessageManager`"""
Expand DownExpand Up		@@ -213,9 +213,9 @@ def __setstate__(self, state: Dict[str, Any]) -> None:
		) # pragma: no cover, dead code currently
		# NOTE: We must delay import of gitlab.v4.objects until now or
		# otherwise it will cause circular import errors
		import gitlab.v4.objects
		from gitlab.v4 importobjects

		self._objects =gitlab.v4.objects
		self._objects = objects

		@property
		def url(self) -> str:
Expand DownExpand Up		@@ -514,7 +514,8 @@ def _set_auth_info(self) -> None:
		self.http_username, self.http_password
		)

		def enable_debug(self) -> None:
		@staticmethod
		def enable_debug() -> None:
		import logging
		from http.client import HTTPConnection # noqa

Expand All		@@ -533,7 +534,8 @@ def _get_session_opts(self) -> Dict[str, Any]:
		"verify": self.ssl_verify,
		}

		def _get_base_url(self, url: Optional[str] = None) -> str:
		@staticmethod
		def _get_base_url(url: Optional[str] = None) -> str:
		"""Return the base URL with the trailing slash stripped.
		If the URL is a Falsy value, return the default URL.
		Returns:
Expand All		@@ -555,10 +557,10 @@ def _build_url(self, path: str) -> str:
		"""
		if path.startswith("http://") or path.startswith("https://"):
		return path
		else:
		return f"{self._url}{path}"
		return f"{self._url}{path}"

		def _check_redirects(self, result: requests.Response) -> None:
		@staticmethod
		def _check_redirects(result: requests.Response) -> None:
		# Check the requests history to detect 301/302 redirections.
		# If the initial verb is POST or PUT, the redirected request will use a
		# GET request, leading to unwanted behaviour.
Expand All		@@ -583,8 +585,8 @@ def _check_redirects(self, result: requests.Response) -> None:
		)
		)

		@staticmethod
		def _prepare_send_data(
		self,
		files: Optional[Dict[str, Any]] = None,
		post_data: Optional[Union[Dict[str, Any], bytes]] = None,
		raw: bool = False,
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -56,7 +56,9 @@ def _get_config_files(
		try:
		resolved = _resolve_file(config_file)
		except OSError as e:
		raise GitlabConfigMissingError(f"Cannot read config from file: {e}")
		raise GitlabConfigMissingError(
		f"Cannot read config from file: {e}"
		) from e
		resolved_files.append(resolved)

		return resolved_files
Expand All		@@ -69,7 +71,7 @@ def _get_config_files(
		except OSError as e:
		raise GitlabConfigMissingError(
		f"Cannot read config from PYTHON_GITLAB_CFG: {e}"
		)
		) from e

		for config_file in _DEFAULT_FILES:
		try:
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -47,8 +47,7 @@ def __init__(
		def __str__(self) -> str:
		if self.response_code is not None:
		return f"{self.response_code}: {self.error_message}"
		else:
		return f"{self.error_message}"
		return f"{self.error_message}"


		class GitlabAuthenticationError(GitlabError):
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -231,8 +231,7 @@ def list(self, **kwargs: Any) -> Union[base.RESTObjectList, List[base.RESTObject
		obj = self.gitlab.http_list(path, **data)
		if isinstance(obj, list):
		return [self._obj_cls(self, item, created_from_list=True) for item in obj]
		else:
		return base.RESTObjectList(self, self._obj_cls, obj)
		return base.RESTObjectList(self, self._obj_cls, obj)


		class RetrieveMixin(ListMixin, GetMixin):
Expand All		@@ -244,8 +243,6 @@ class RetrieveMixin(ListMixin, GetMixin):
		_path: Optional[str]
		gitlab: gitlab.Gitlab

		pass


		class CreateMixin(_RestManagerBase):
		_computed_path: Optional[str]
Expand DownExpand Up		@@ -429,8 +426,6 @@ class CRUDMixin(GetMixin, ListMixin, CreateMixin, UpdateMixin, DeleteMixin):
		_path: Optional[str]
		gitlab: gitlab.Gitlab

		pass


		class NoUpdateMixin(GetMixin, ListMixin, CreateMixin, DeleteMixin):
		_computed_path: Optional[str]
Expand All		@@ -441,8 +436,6 @@ class NoUpdateMixin(GetMixin, ListMixin, CreateMixin, DeleteMixin):
		_path: Optional[str]
		gitlab: gitlab.Gitlab

		pass


		class SaveMixin(_RestObjectBase):
		"""Mixin for RESTObject's that can be updated."""
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -103,10 +103,12 @@ def get_for_api(self) -> str:


		class FileAttribute(GitlabAttribute):
		def get_file_name(self, attr_name: Optional[str] = None) -> Optional[str]:
		@staticmethod
		def get_file_name(attr_name: Optional[str] = None) -> Optional[str]:
		return attr_name


		class ImageAttribute(FileAttribute):
		def get_file_name(self, attr_name: Optional[str] = None) -> str:
		@staticmethod
		def get_file_name(attr_name: Optional[str] = None) -> str:
		return f"{attr_name}.png" if attr_name else "image.png"
Original file line number	Diff line number	Diff line change
Expand Up		@@ -371,13 +371,14 @@ def get_dict(


		class JSONPrinter:
		def display(self, d: Union[str, Dict[str, Any]], **kwargs: Any) -> None:
		@staticmethod
		def display(d: Union[str, Dict[str, Any]], **kwargs: Any) -> None:
		import json # noqa

		print(json.dumps(d))

		@staticmethod
		def display_list(
		self,
		data: List[Union[str, gitlab.base.RESTObject]],
		fields: List[str],
		**kwargs: Any,
Expand All		@@ -388,7 +389,8 @@ def display_list(


		class YAMLPrinter:
		def display(self, d: Union[str, Dict[str, Any]], **kwargs: Any) -> None:
		@staticmethod
		def display(d: Union[str, Dict[str, Any]], **kwargs: Any) -> None:
		try:
		import yaml # noqa

Expand All		@@ -400,8 +402,8 @@ def display(self, d: Union[str, Dict[str, Any]], **kwargs: Any) -> None:
		"to use the yaml output feature"
		)

		@staticmethod
		def display_list(
		self,
		data: List[Union[str, gitlab.base.RESTObject]],
		fields: List[str],
		**kwargs: Any,
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -26,6 +26,8 @@
		class ProjectFile(SaveMixin, ObjectDeleteMixin, RESTObject):
		_id_attr = "file_path"
		_repr_attr = "file_path"
		branch: str
		commit_message: str
		file_path: str
		manager: "ProjectFileManager"

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -49,5 +49,4 @@ def list(self, **kwargs: Any) -> Union[List[LDAPGroup], RESTObjectList]:
		obj = self.gitlab.http_list(path, **data)
		if isinstance(obj, list):
		return [self._obj_cls(self, item) for item in obj]
		else:
		return RESTObjectList(self, self._obj_cls, obj)
		return RESTObjectList(self, self._obj_cls, obj)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -168,6 +168,8 @@ class ProjectMergeRequestApprovalRule(SaveMixin, ObjectDeleteMixin, RESTObject):
		_id_attr = "approval_rule_id"
		_repr_attr = "approval_rule"
		id: int
		approval_rule_id: int
		merge_request_iid: int

		@exc.on_http_error(exc.GitlabUpdateError)
		def save(self, **kwargs: Any) -> None:
Expand Down