chore: rename 'raw' to 'raw_post_data' in http_put/post/request

JohnVillalovos · JohnVillalovos · commit 38c636a25f63 · 2022-01-05T21:17:11.000-08:00
To minimize confusion with other usage of 'raw' in http_get, change
name to 'raw_post_data' to signify if set that the 'post_data' will be
sent as raw data.
diff --git a/gitlab/client.py b/gitlab/client.py
@@ -572,11 +572,11 @@ 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,
+        raw_post_data: bool = False,
     ) -> Tuple[
         Optional[Union[Dict[str, Any], bytes]],
         Optional[Union[Dict[str, Any], MultipartEncoder]],
@@ -599,7 +599,7 @@ def _prepare_send_data(
             data = MultipartEncoder(post_data)
             return (None, data, data.content_type)
 
-        if raw and post_data:
+        if raw_post_data and post_data:
             return (None, post_data, "application/octet-stream")
 
         return (post_data, None, "application/json")
@@ -611,7 +611,7 @@ def http_request(
         path: str,
         query_data: Optional[Dict[str, Any]] = None,
         post_data: Optional[Union[Dict[str, Any], bytes]] = None,
-        raw: bool = False,
+        raw_post_data: bool = False,
         streamed: bool = False,
         files: Optional[Dict[str, Any]] = None,
         timeout: Optional[float] = None,
@@ -628,7 +628,7 @@ def http_request(
             query_data: Data to send as query parameters
             post_data: Data to send in the body (will be converted to
                               json by default)
-            raw: If True, do not convert post_data to json
+            raw_post_data: If True, do not convert post_data to json
             streamed: Whether the data should be streamed
             files: The files to send to the server
             timeout: The timeout, in seconds, for the request
@@ -673,7 +673,9 @@ def http_request(
             timeout = opts_timeout
 
         # We need to deal with json vs. data when uploading files
-        json, data, content_type = self._prepare_send_data(files, post_data, raw)
+        json, data, content_type = self._prepare_send_data(
+            files, post_data, raw_post_data
+        )
         opts["headers"]["Content-type"] = content_type
 
         cur_retries = 0
@@ -829,7 +831,7 @@ def http_post(
         path: str,
         query_data: Optional[Dict[str, Any]] = None,
         post_data: Optional[Dict[str, Any]] = None,
-        raw: bool = False,
+        raw_post_data: bool = False,
         files: Optional[Dict[str, Any]] = None,
         **kwargs: Any,
     ) -> Union[Dict[str, Any], requests.Response]:
@@ -862,6 +864,7 @@ def http_post(
             query_data=query_data,
             post_data=post_data,
             files=files,
+            raw_post_data=raw_post_data,
             **kwargs,
         )
         try:
@@ -878,10 +881,10 @@ def http_put(
         path: str,
         query_data: Optional[Dict[str, Any]] = None,
         post_data: Optional[Union[Dict[str, Any], bytes]] = None,
-        raw: bool = False,
+        raw_post_data: bool = False,
         files: Optional[Dict[str, Any]] = None,
         **kwargs: Any,
-    ) -> Union[Dict[str, Any], requests.Response]:
+    ) -> Dict[str, Any]:
         """Make a PUT request to the Gitlab server.
 
         Args:
@@ -890,7 +893,7 @@ def http_put(
             query_data: Data to send as query parameters
             post_data: Data to send in the body (will be converted to
                               json by default)
-            raw: If True, do not convert post_data to json
+            raw_post_data: If True, do not convert post_data to json
             files: The files to send to the server
             **kwargs: Extra options to send to the server (e.g. sudo)
 
@@ -910,7 +913,7 @@ def http_put(
             query_data=query_data,
             post_data=post_data,
             files=files,
-            raw=raw,
+            raw_post_data=raw_post_data,
             **kwargs,
         )
         try:
diff --git a/gitlab/v4/objects/packages.py b/gitlab/v4/objects/packages.py
@@ -77,7 +77,9 @@ def upload(
             raise exc.GitlabUploadError(f"Failed to read package file {path}")
 
         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)
+        server_data = self.gitlab.http_put(
+            url, post_data=file_data, raw_post_data=True, **kwargs
+        )
         if TYPE_CHECKING:
             assert isinstance(server_data, dict)
 
