Sourcery refactored master branch by sourcery-ai[bot] · Pull Request #1 · edson-github/google-api-python-client

sourcery-ai · 2022-04-21T13:02:31Z

Branch master refactored by Sourcery.

If you're happy with these changes, merge this Pull Request using the Squash and merge strategy.

See our documentation here.

Run Sourcery locally

Reduce the feedback loop during development by using the Sourcery editor plugin:

Review changes via command line

To manually merge these changes, make sure you're on the master branch, then run:

git fetch origin sourcery/master
git merge --ff-only FETCH_HEAD
git reset HEAD^

Help us improve this pull request!

sourcery-ai

Due to GitHub API limits, only the first 60 comments can be shown.

sourcery-ai · 2022-04-21T13:02:33Z

describe.py

                return
            if "(required)" not in desc:
-                pname = pname + "=None"
+                pname = f"{pname}=None"


Function method_params.add_param refactored with the following changes:

Use f-string instead of string concatenation (use-fstring-for-concatenation)

sourcery-ai · 2022-04-21T13:02:33Z

describe.py

        if i == 0:
            display = root_discovery.get("title", display)
-        crumbs.append('<a href="{}.html">{}</a>'.format(prefix + p, display))
+        crumbs.append(f'<a href="{prefix + p}.html">{display}</a>')


Function breadcrumbs refactored with the following changes:

Replace call to format with f-string. (use-fstring-for-formatting)

sourcery-ai · 2022-04-21T13:02:33Z

describe.py

        css,
-        "<h1>%s</h1>" % breadcrumbs(path[:-1], root_discovery),
+        f"<h1>{breadcrumbs(path[:-1], root_discovery)}</h1>",
        "<h2>Instance Methods</h2>",
    ]



Function document_collection refactored with the following changes:

Replace interpolated string formatting with f-string (replace-interpolation-with-fstring)

sourcery-ai · 2022-04-21T13:02:33Z

describe.py

-    f = open(os.path.join(FLAGS.dest, path + "html"), "w")
-    if sys.version_info.major < 3:
-        html = html.encode("utf-8")
-
-    f.write(html)
-    f.close()
+    with open(os.path.join(FLAGS.dest, f"{path}html"), "w") as f:
+        if sys.version_info.major < 3:
+            html = html.encode("utf-8")

+        f.write(html)


Function document_collection_recursive refactored with the following changes:

Use with when opening file to ensure closure (ensure-file-closed)

Use f-string instead of string concatenation (use-fstring-for-concatenation)

sourcery-ai · 2022-04-21T13:02:34Z

describe.py

-        print("Warning: {} {} found but could not be built.".format(name, version))
+        print(f"Warning: {name} {version} found but could not be built.")
        return
    except HttpError as e:
-        print("Warning: {} {} returned {}.".format(name, version, e))
+        print(f"Warning: {name} {version} returned {e}.")


Function document_api refactored with the following changes:

Replace call to format with f-string. (use-fstring-for-formatting)

sourcery-ai · 2022-04-21T13:02:35Z

apiclient/__init__.py

@@ -1,5 +1,6 @@
 """Retain apiclient as an alias for googleapiclient."""



Lines 36-36 refactored with the following changes:

Replace interpolated string formatting with f-string (replace-interpolation-with-fstring)

sourcery-ai · 2022-04-21T13:02:35Z

googleapiclient/_auth.py

-    else:
-        try:
-            if credentials.create_scoped_required():
-                return credentials.create_scoped(scopes)
-            else:
-                return credentials
-        except AttributeError:
-            return credentials
+    try:
+        return (
+            credentials.create_scoped(scopes)
+            if credentials.create_scoped_required()
+            else credentials
+        )
+
+    except AttributeError:
+        return credentials


Function with_scopes refactored with the following changes:

Remove unnecessary else after guard condition (remove-unnecessary-else)

Replace if statement with if expression (assign-if-exp)

sourcery-ai · 2022-04-21T13:02:35Z

googleapiclient/_auth.py

-    if HAS_GOOGLE_AUTH and isinstance(credentials, google.auth.credentials.Credentials):
-        if google_auth_httplib2 is None:
-            raise ValueError(
-                "Credentials from google.auth specified, but "
-                "google-api-python-client is unable to use these credentials "
-                "unless google-auth-httplib2 is installed. Please install "
-                "google-auth-httplib2."
-            )
-        return google_auth_httplib2.AuthorizedHttp(credentials, http=build_http())
-    else:
+    if not HAS_GOOGLE_AUTH or not isinstance(
+        credentials, google.auth.credentials.Credentials
+    ):
        return credentials.authorize(build_http())
+    if google_auth_httplib2 is None:
+        raise ValueError(
+            "Credentials from google.auth specified, but "
+            "google-api-python-client is unable to use these credentials "
+            "unless google-auth-httplib2 is installed. Please install "
+            "google-auth-httplib2."
+        )
+    return google_auth_httplib2.AuthorizedHttp(credentials, http=build_http())


Function authorized_http refactored with the following changes:

Swap if/else branches (swap-if-else-branches)

Remove unnecessary else after guard condition (remove-unnecessary-else)

sourcery-ai · 2022-04-21T13:02:36Z

googleapiclient/_auth.py

-    if HAS_GOOGLE_AUTH and isinstance(credentials, google.auth.credentials.Credentials):
-        request = google_auth_httplib2.Request(refresh_http)
-        return credentials.refresh(request)
-    else:
+    if not HAS_GOOGLE_AUTH or not isinstance(
+        credentials, google.auth.credentials.Credentials
+    ):
        return credentials.refresh(refresh_http)
+    request = google_auth_httplib2.Request(refresh_http)
+    return credentials.refresh(request)


Function refresh_credentials refactored with the following changes:

Swap if/else branches (swap-if-else-branches)

Remove unnecessary else after guard condition (remove-unnecessary-else)

sourcery-ai · 2022-04-21T13:02:36Z

googleapiclient/_helpers.py

-                plural_s = ""
-                if max_positional_args != 1:
-                    plural_s = "s"
+                plural_s = "s" if max_positional_args != 1 else ""


Function positional.positional_decorator.positional_wrapper refactored with the following changes:

Replace if statement with if expression (assign-if-exp)

Move setting of default value for variable into else branch (introduce-default-else)

sourcery-ai · 2022-04-21T13:02:42Z

googleapiclient/_helpers.py

-            msg = "URL-encoded content contains a repeated value:" "%s -> %s" % (
-                key,
-                ", ".join(value),
-            )
+            msg = f'URL-encoded content contains a repeated value:{key} -> {", ".join(value)}'
+


Function parse_unique_urlencoded refactored with the following changes:

Replace interpolated string formatting with f-string (replace-interpolation-with-fstring)

sourcery-ai · 2022-04-21T13:02:42Z

googleapiclient/_helpers.py

-    if value is None:
-        return url
-    else:
-        return update_query_params(url, {name: value})
+    return url if value is None else update_query_params(url, {name: value})


Function _add_query_parameter refactored with the following changes:

Replace if statement with if expression (assign-if-exp)

sourcery-ai · 2022-04-21T13:02:43Z

googleapiclient/channel.py

-    for k, v in six.iteritems(headers):
-        new_headers[k.upper()] = v
-    return new_headers
+    return {k.upper(): v for k, v in six.iteritems(headers)}


Function _upper_header_keys refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

Convert for loop into dictionary comprehension (dict-comprehension)

sourcery-ai · 2022-04-21T13:02:43Z

googleapiclient/channel.py

-            "Channel id mismatch: %s != %s" % (channel.id, channel_id)
+            f"Channel id mismatch: {channel.id} != {channel_id}"
        )
-    else:
-        message_number = int(headers[X_GOOG_MESSAGE_NUMBER])
-        state = headers[X_GOOG_RESOURCE_STATE]
-        resource_uri = headers[X_GOOG_RESOURCE_URI]
-        resource_id = headers[X_GOOG_RESOURCE_ID]
-        return Notification(message_number, state, resource_uri, resource_id)
+
+    message_number = int(headers[X_GOOG_MESSAGE_NUMBER])
+    state = headers[X_GOOG_RESOURCE_STATE]
+    resource_uri = headers[X_GOOG_RESOURCE_URI]
+    resource_id = headers[X_GOOG_RESOURCE_ID]
+    return Notification(message_number, state, resource_uri, resource_id)


Function notification_from_headers refactored with the following changes:

Swap if/else branches (swap-if-else-branches)

Remove unnecessary else after guard condition (remove-unnecessary-else)

Replace interpolated string formatting with f-string (replace-interpolation-with-fstring)

sourcery-ai · 2022-04-21T13:02:43Z

googleapiclient/channel.py

-        if expiration_ms < 0:
-            expiration_ms = 0
-
+        expiration_ms = max(expiration_ms, 0)


Function new_webhook_channel refactored with the following changes:

Replace comparison with min/max call (min-max-identity)

sourcery-ai · 2022-04-21T13:02:44Z

googleapiclient/errors.py

-                error_detail_keyword = next((kw for kw in ["detail", "details", "message"] if kw in data["error"]), "")
-                if error_detail_keyword:
+                if error_detail_keyword := next(
+                    (
+                        kw
+                        for kw in ["detail", "details", "message"]
+                        if kw in data["error"]
+                    ),
+                    "",
+                ):


Function HttpError._get_reason refactored with the following changes:

Use named expression to simplify assignment and conditional (use-named-expression)

sourcery-ai · 2022-04-21T13:02:45Z

googleapiclient/errors.py

-            "Received unexpected call %s" % methodId
+            f"Received unexpected call {methodId}"


Function UnexpectedMethodError.__init__ refactored with the following changes:

Replace interpolated string formatting with f-string (replace-interpolation-with-fstring)

sourcery-ai · 2022-04-21T13:02:45Z

googleapiclient/errors.py

-            "Expected: [%s] - Provided: [%s]" % (expected, provided)
+            f"Expected: [{expected}] - Provided: [{provided}]"


Function UnexpectedBodyError.__init__ refactored with the following changes:

Replace interpolated string formatting with f-string (replace-interpolation-with-fstring)

sourcery-ai · 2022-04-21T13:02:45Z

googleapiclient/http.py

            else:
                reason = data[0]["error"]["errors"]["reason"]
-        except (UnicodeDecodeError, ValueError, KeyError):
+        except (ValueError, KeyError):


Function _should_retry_response refactored with the following changes:

Remove redundant exceptions from an except clause (remove-redundant-exception)

sourcery-ai · 2022-04-21T13:02:45Z

googleapiclient/http.py

        self._fd = fd
        self._mimetype = mimetype
-        if not (chunksize == -1 or chunksize > 0):
+        if chunksize != -1 and chunksize <= 0:


Function MediaIoBaseUpload.__init__ refactored with the following changes:

Simplify logical expression using De Morgan identities (de-morgan)

sourcery-ai · 2022-04-21T13:02:49Z

googleapiclient/http.py

-            if mimetype is None:
-                # Guess failed, use octet-stream.
-                mimetype = "application/octet-stream"
+        if mimetype is None:
+            # Guess failed, use octet-stream.
+            mimetype = "application/octet-stream"


Function MediaFileUpload.__init__ refactored with the following changes:

Hoist conditional out of nested conditional (hoist-if-from-if)

sourcery-ai · 2022-04-21T13:02:49Z

googleapiclient/http.py

-        self._headers = {}
-        for k, v in six.iteritems(request.headers):
-            # allow users to supply custom headers by setting them on the request
-            # but strip out the ones that are set by default on requests generated by
-            # API methods like Drive's files().get(fileId=...)
-            if not k.lower() in ("accept", "accept-encoding", "user-agent"):
-                self._headers[k] = v
+        self._headers = {
+            k: v
+            for k, v in six.iteritems(request.headers)
+            if k.lower() not in ("accept", "accept-encoding", "user-agent")
+        }


Function MediaIoBaseDownload.__init__ refactored with the following changes:

Convert for loop into dictionary comprehension (dict-comprehension)

Simplify logical expression using De Morgan identities (de-morgan)

This removes the following comments ( why? ):

# but strip out the ones that are set by default on requests generated by # allow users to supply custom headers by setting them on the request # API methods like Drive's files().get(fileId=...)

sourcery-ai · 2022-04-21T13:02:49Z

googleapiclient/http.py

-        if self.resumable.size() is None:
-            size = "*"
-        else:
-            size = str(self.resumable.size())
-
+        size = "*" if self.resumable.size() is None else str(self.resumable.size())


Function HttpRequest.next_chunk refactored with the following changes:

Replace if statement with if expression (assign-if-exp)

Replace interpolated string formatting with f-string (replace-interpolation-with-fstring)

sourcery-ai · 2022-04-21T13:02:49Z

googleapiclient/http.py

-        if creds is not None:
-            if id(creds) not in self._refreshed_credentials:
-                _auth.refresh_credentials(creds)
-                self._refreshed_credentials[id(creds)] = 1
+        if creds is not None and id(creds) not in self._refreshed_credentials:
+            _auth.refresh_credentials(creds)
+            self._refreshed_credentials[id(creds)] = 1


Function BatchHttpRequest._refresh_and_apply_credentials refactored with the following changes:

Merge nested if conditions (merge-nested-ifs)

sourcery-ai · 2022-04-21T13:02:49Z

googleapiclient/http.py

-        return "<%s + %s>" % (self._base_id, quote(id_))
+        return f"<{self._base_id} + {quote(id_)}>"


Function BatchHttpRequest._id_to_header refactored with the following changes:

Replace interpolated string formatting with f-string (replace-interpolation-with-fstring)

sourcery-ai · 2022-04-21T13:02:51Z

googleapiclient/model.py

-        headers["x-goog-api-client"] += "gdcl/%s gl-python/%s" % (
-            _LIBRARY_VERSION,
-            _PY_VERSION,
-        )
+        headers[
+            "x-goog-api-client"
+        ] += f"gdcl/{_LIBRARY_VERSION} gl-python/{_PY_VERSION}"
+


Function BaseModel.request refactored with the following changes:

Replace interpolated string formatting with f-string (replace-interpolation-with-fstring)

sourcery-ai · 2022-04-21T13:02:51Z

googleapiclient/model.py

                    value = value.encode("utf-8")
                astuples.append((key, value))
-        return "?" + urlencode(astuples)
+        return f"?{urlencode(astuples)}"


Function BaseModel._build_query refactored with the following changes:

Use f-string instead of string concatenation (use-fstring-for-concatenation)

sourcery-ai · 2022-04-21T13:02:51Z

googleapiclient/model.py

-        # Error handling is TBD, for example, do we retry
-        # for some operation/error combinations?
        if resp.status < 300:
-            if resp.status == 204:
-                # A 204: No Content response should be treated differently
-                # to all the other success states
-                return self.no_content_response
-            return self.deserialize(content)
-        else:
-            LOGGER.debug("Content from bad request was: %r" % content)
-            raise HttpError(resp, content)
+            return (
+                self.no_content_response
+                if resp.status == 204
+                else self.deserialize(content)
+            )
+
+        LOGGER.debug("Content from bad request was: %r" % content)
+        raise HttpError(resp, content)


Function BaseModel.response refactored with the following changes:

Remove unnecessary else after guard condition (remove-unnecessary-else)

Lift code into else after jump in control flow (reintroduce-else)

Replace if statement with if expression (assign-if-exp)

This removes the following comments ( why? ):

# to all the other success states # Error handling is TBD, for example, do we retry # A 204: No Content response should be treated differently # for some operation/error combinations?

sourcery-ai · 2022-04-21T13:02:51Z

googleapiclient/model.py

-        else:
-            # Don't add anything to patch if there's no change
-            pass


Function makepatch refactored with the following changes:

Remove redundant pass statement (remove-redundant-pass)

This removes the following comments ( why? ):

# Don't add anything to patch if there's no change

sourcery-ai · 2022-04-21T13:02:52Z

googleapiclient/sample_tools.py


    if scope is None:
-        scope = "https://www.googleapis.com/auth/" + name
+        scope = f"https://www.googleapis.com/auth/{name}"


Function init refactored with the following changes:

Use f-string instead of string concatenation (use-fstring-for-concatenation)

'Refactored by Sourcery'

6448dfe

sourcery-ai bot requested a review from edson-github April 21, 2022 13:02

sourcery-ai bot commented Apr 21, 2022

View reviewed changes

		@@ -1,5 +1,6 @@
		"""Retain apiclient as an alias for googleapiclient."""

		"Received unexpected call %s" % methodId
		f"Received unexpected call {methodId}"

		"Expected: [%s] - Provided: [%s]" % (expected, provided)
		f"Expected: [{expected}] - Provided: [{provided}]"

		return "<%s + %s>" % (self._base_id, quote(id_))
		return f"<{self._base_id} + {quote(id_)}>"

Conversation

sourcery-ai bot commented Apr 21, 2022

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 21, 2022

Choose a reason for hiding this comment