Skip to content

fix: handle query_params tuples in JSONConnection.build_api_url #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tswast merged 2 commits into from
Sep 24, 2020
Merged

fix: handle query_params tuples in JSONConnection.build_api_url #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eecb338
fix: handle query_params tuples in JSONConnection.build_api_url
tswast Sep 23, 2020
7146157
Update google/cloud/_http.py
tswast Sep 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions google/cloud/_http.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,13 @@

"""Shared implementation of connections to API servers."""

import collections
import json
import platform
import warnings

from pkg_resources import get_distribution
from six.moves import collections_abc
from six.moves.urllib.parse import urlencode

from google.api_core.client_info import ClientInfo
Expand Down Expand Up @@ -212,9 +214,15 @@ def build_api_url(

query_params = query_params or {}

if "prettyPrint" not in query_params:
if isinstance(query_params, collections_abc.Mapping):
query_params = query_params.copy()
query_params["prettyPrint"] = "false"
else:
query_params_dict = collections.defaultdict(list)
for key, value in query_params:
query_params_dict[key].append(value)
query_params = query_params_dict

query_params.setdefault("prettyPrint", "false")

url += "?" + urlencode(query_params, doseq=True)

Expand Down
19 changes: 19 additions & 0 deletions tests/unit/test__http.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,25 @@ def test_build_api_url_w_extra_query_params(self):
parms = dict(parse_qs(qs))
self.assertEqual(parms["bar"], ["baz"])
self.assertEqual(parms["qux"], ["quux", "corge"])
self.assertEqual(parms["prettyPrint"], ["false"])

def test_build_api_url_w_extra_query_params_tuples(self):
from six.moves.urllib.parse import parse_qs
from six.moves.urllib.parse import urlsplit

client = object()
conn = self._make_mock_one(client)
uri = conn.build_api_url("/foo", [("bar", "baz"), ("qux", "quux"), ("qux", "corge")])

scheme, netloc, path, qs, _ = urlsplit(uri)
self.assertEqual("%s://%s" % (scheme, netloc), conn.API_BASE_URL)
# Intended to emulate mock_template
PATH = "/".join(["", "mock", conn.API_VERSION, "foo"])
self.assertEqual(path, PATH)
parms = dict(parse_qs(qs))
self.assertEqual(parms["bar"], ["baz"])
self.assertEqual(parms["qux"], ["quux", "corge"])
self.assertEqual(parms["prettyPrint"], ["false"])

def test__make_request_no_data_no_content_type_no_headers(self):
from google.cloud._http import CLIENT_INFO_HEADER
Expand Down