summaryrefslogtreecommitdiff
path: root/gitlab/v4/objects/environments.py
diff options
context:
space:
mode:
authorJohn L. Villalovos <john@sodarock.com>2021-11-06 21:33:07 -0700
committerJohn L. Villalovos <john@sodarock.com>2021-11-08 07:21:17 -0800
commit7828ba2fd13c833c118a673bac09b215587ba33b (patch)
tree71312fe159fcc62ace0aeb24be94072ee4cf33cf /gitlab/v4/objects/environments.py
parent9a2f54cf044929dfc3fd89714ce657fa839e35d0 (diff)
downloadgitlab-jlvillal/mypy_small_files_1.tar.gz
chore: enforce type-hints on most files in gitlab/v4/objects/jlvillal/mypy_small_files_1
* Add type-hints to some of the files in gitlab/v4/objects/ * Fix issues detected when adding type-hints * Changed mypy exclusion to explicitly list the 13 files that have not yet had type-hints added.
Diffstat (limited to 'gitlab/v4/objects/environments.py')
-rw-r--r--gitlab/v4/objects/environments.py11
1 files changed, 9 insertions, 2 deletions
diff --git a/gitlab/v4/objects/environments.py b/gitlab/v4/objects/environments.py
index 3ecb957..67787b0 100644
--- a/gitlab/v4/objects/environments.py
+++ b/gitlab/v4/objects/environments.py
@@ -1,3 +1,7 @@
+from typing import Any, Dict, Union
+
+import requests
+
from gitlab import cli
from gitlab import exceptions as exc
from gitlab.base import RequiredOptional, RESTManager, RESTObject
@@ -19,7 +23,7 @@ __all__ = [
class ProjectEnvironment(SaveMixin, ObjectDeleteMixin, RESTObject):
@cli.register_custom_action("ProjectEnvironment")
@exc.on_http_error(exc.GitlabStopError)
- def stop(self, **kwargs):
+ def stop(self, **kwargs: Any) -> Union[Dict[str, Any], requests.Response]:
"""Stop the environment.
Args:
@@ -28,9 +32,12 @@ class ProjectEnvironment(SaveMixin, ObjectDeleteMixin, RESTObject):
Raises:
GitlabAuthenticationError: If authentication is not correct
GitlabStopError: If the operation failed
+
+ Returns:
+ A dict of the result.
"""
path = f"{self.manager.path}/{self.get_id()}/stop"
- self.manager.gitlab.http_post(path, **kwargs)
+ return self.manager.gitlab.http_post(path, **kwargs)
class ProjectEnvironmentManager(