Skip to content

feat: request compact prettyPrint=false JSON responses from the API #1600

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

Open
pawciobiel wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: request compact prettyPrint=false JSON responses from the API #1600

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions gspread/http_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,11 @@ def request(
data = json_dumps(dict(json), default=default_serializer)
json = None
headers = {**(headers or {}), "Content-Type": "application/json"}
# Responses are parsed before the caller sees them, so the API default of
# pretty-printed JSON only adds whitespace to transfer and parse. A caller
# passing prettyPrint explicitly still wins.
params = dict(params or {})
params.setdefault("prettyPrint", "false")
response = self.session.request(
method=method,
url=endpoint,
Expand Down
46 changes: 23 additions & 23 deletions tests/cassettes/CellTest.test_a1_value.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
{
"request": {
"method": "POST",
"uri": "https://www.googleapis.com/drive/v3/files?supportsAllDrives=True",
"uri": "https://www.googleapis.com/drive/v3/files?supportsAllDrives=True&prettyPrint=false",
"body": "{\"name\": \"Test CellTest test_a1_value\", \"mimeType\": \"application/vnd.google-apps.spreadsheet\"}",
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -90,7 +90,7 @@
{
"request": {
"method": "GET",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Sle_EDNRq8PsQGzmskqQWIGnUT4epR-d9A-9gaJsrrQ?includeGridData=false",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Sle_EDNRq8PsQGzmskqQWIGnUT4epR-d9A-9gaJsrrQ?includeGridData=false&prettyPrint=false",
"body": null,
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -166,7 +166,7 @@
{
"request": {
"method": "GET",
"uri": "https://www.googleapis.com/drive/v3/files/1Sle_EDNRq8PsQGzmskqQWIGnUT4epR-d9A-9gaJsrrQ?supportsAllDrives=True&includeItemsFromAllDrives=True&fields=id%2Cname%2CcreatedTime%2CmodifiedTime",
"uri": "https://www.googleapis.com/drive/v3/files/1Sle_EDNRq8PsQGzmskqQWIGnUT4epR-d9A-9gaJsrrQ?supportsAllDrives=True&includeItemsFromAllDrives=True&fields=id%2Cname%2CcreatedTime%2CmodifiedTime&prettyPrint=false",
"body": null,
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -246,7 +246,7 @@
{
"request": {
"method": "GET",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Sle_EDNRq8PsQGzmskqQWIGnUT4epR-d9A-9gaJsrrQ?includeGridData=false",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Sle_EDNRq8PsQGzmskqQWIGnUT4epR-d9A-9gaJsrrQ?includeGridData=false&prettyPrint=false",
"body": null,
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -322,7 +322,7 @@
{
"request": {
"method": "GET",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Sle_EDNRq8PsQGzmskqQWIGnUT4epR-d9A-9gaJsrrQ/values/%27Sheet1%27%21D4?valueRenderOption=FORMATTED_VALUE",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Sle_EDNRq8PsQGzmskqQWIGnUT4epR-d9A-9gaJsrrQ/values/%27Sheet1%27%21D4?valueRenderOption=FORMATTED_VALUE&prettyPrint=false",
"body": null,
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -398,7 +398,7 @@
{
"request": {
"method": "PUT",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Sle_EDNRq8PsQGzmskqQWIGnUT4epR-d9A-9gaJsrrQ/values/%27Sheet1%27%21B1?valueInputOption=USER_ENTERED",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Sle_EDNRq8PsQGzmskqQWIGnUT4epR-d9A-9gaJsrrQ/values/%27Sheet1%27%21B1?valueInputOption=USER_ENTERED&prettyPrint=false",
"body": "{\"values\": [[\"Dummy\"]]}",
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -480,7 +480,7 @@
{
"request": {
"method": "GET",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Sle_EDNRq8PsQGzmskqQWIGnUT4epR-d9A-9gaJsrrQ/values/%27Sheet1%27",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Sle_EDNRq8PsQGzmskqQWIGnUT4epR-d9A-9gaJsrrQ/values/%27Sheet1%27?prettyPrint=false",
"body": null,
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -556,7 +556,7 @@
{
"request": {
"method": "DELETE",
"uri": "https://www.googleapis.com/drive/v3/files/1Sle_EDNRq8PsQGzmskqQWIGnUT4epR-d9A-9gaJsrrQ?supportsAllDrives=True",
"uri": "https://www.googleapis.com/drive/v3/files/1Sle_EDNRq8PsQGzmskqQWIGnUT4epR-d9A-9gaJsrrQ?supportsAllDrives=True&prettyPrint=false",
"body": null,
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -636,7 +636,7 @@
{
"request": {
"method": "POST",
"uri": "https://www.googleapis.com/drive/v3/files?supportsAllDrives=True",
"uri": "https://www.googleapis.com/drive/v3/files?supportsAllDrives=True&prettyPrint=false",
"body": "{\"name\": \"Test CellTest test_a1_value\", \"mimeType\": \"application/vnd.google-apps.spreadsheet\"}",
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -722,7 +722,7 @@
{
"request": {
"method": "GET",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Vptx0DVg5lsmYXLHgqlPQXIRaF-C-f-HE8i308L48XI?includeGridData=false",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Vptx0DVg5lsmYXLHgqlPQXIRaF-C-f-HE8i308L48XI?includeGridData=false&prettyPrint=false",
"body": null,
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -798,7 +798,7 @@
{
"request": {
"method": "GET",
"uri": "https://www.googleapis.com/drive/v3/files/1Vptx0DVg5lsmYXLHgqlPQXIRaF-C-f-HE8i308L48XI?supportsAllDrives=True&includeItemsFromAllDrives=True&fields=id%2Cname%2CcreatedTime%2CmodifiedTime",
"uri": "https://www.googleapis.com/drive/v3/files/1Vptx0DVg5lsmYXLHgqlPQXIRaF-C-f-HE8i308L48XI?supportsAllDrives=True&includeItemsFromAllDrives=True&fields=id%2Cname%2CcreatedTime%2CmodifiedTime&prettyPrint=false",
"body": null,
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -878,7 +878,7 @@
{
"request": {
"method": "GET",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Vptx0DVg5lsmYXLHgqlPQXIRaF-C-f-HE8i308L48XI?includeGridData=false",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Vptx0DVg5lsmYXLHgqlPQXIRaF-C-f-HE8i308L48XI?includeGridData=false&prettyPrint=false",
"body": null,
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -954,7 +954,7 @@
{
"request": {
"method": "GET",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Vptx0DVg5lsmYXLHgqlPQXIRaF-C-f-HE8i308L48XI/values/%27Sheet1%27%21D4?valueRenderOption=FORMATTED_VALUE",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Vptx0DVg5lsmYXLHgqlPQXIRaF-C-f-HE8i308L48XI/values/%27Sheet1%27%21D4?valueRenderOption=FORMATTED_VALUE&prettyPrint=false",
"body": null,
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -1030,7 +1030,7 @@
{
"request": {
"method": "PUT",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Vptx0DVg5lsmYXLHgqlPQXIRaF-C-f-HE8i308L48XI/values/%27Sheet1%27%21B1?valueInputOption=USER_ENTERED",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Vptx0DVg5lsmYXLHgqlPQXIRaF-C-f-HE8i308L48XI/values/%27Sheet1%27%21B1?valueInputOption=USER_ENTERED&prettyPrint=false",
"body": "{\"values\": [[\"Dummy\"]]}",
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -1112,7 +1112,7 @@
{
"request": {
"method": "GET",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Vptx0DVg5lsmYXLHgqlPQXIRaF-C-f-HE8i308L48XI/values/%27Sheet1%27",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Vptx0DVg5lsmYXLHgqlPQXIRaF-C-f-HE8i308L48XI/values/%27Sheet1%27?prettyPrint=false",
"body": null,
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -1188,7 +1188,7 @@
{
"request": {
"method": "DELETE",
"uri": "https://www.googleapis.com/drive/v3/files/1Vptx0DVg5lsmYXLHgqlPQXIRaF-C-f-HE8i308L48XI?supportsAllDrives=True",
"uri": "https://www.googleapis.com/drive/v3/files/1Vptx0DVg5lsmYXLHgqlPQXIRaF-C-f-HE8i308L48XI?supportsAllDrives=True&prettyPrint=false",
"body": null,
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -1268,7 +1268,7 @@
{
"request": {
"method": "POST",
"uri": "https://www.googleapis.com/drive/v3/files?supportsAllDrives=True",
"uri": "https://www.googleapis.com/drive/v3/files?supportsAllDrives=True&prettyPrint=false",
"body": "{\"name\": \"Test CellTest test_a1_value\", \"mimeType\": \"application/vnd.google-apps.spreadsheet\"}",
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -1348,7 +1348,7 @@
{
"request": {
"method": "GET",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Dslt6b_MEecinUu6x5Onc-hG6WdoWD-9khrZwSHLeTI?includeGridData=false",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Dslt6b_MEecinUu6x5Onc-hG6WdoWD-9khrZwSHLeTI?includeGridData=false&prettyPrint=false",
"body": null,
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -1418,7 +1418,7 @@
{
"request": {
"method": "GET",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Dslt6b_MEecinUu6x5Onc-hG6WdoWD-9khrZwSHLeTI?includeGridData=false",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Dslt6b_MEecinUu6x5Onc-hG6WdoWD-9khrZwSHLeTI?includeGridData=false&prettyPrint=false",
"body": null,
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -1491,7 +1491,7 @@
{
"request": {
"method": "GET",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Dslt6b_MEecinUu6x5Onc-hG6WdoWD-9khrZwSHLeTI/values/%27Sheet1%27%21D4?valueRenderOption=FORMATTED_VALUE",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Dslt6b_MEecinUu6x5Onc-hG6WdoWD-9khrZwSHLeTI/values/%27Sheet1%27%21D4?valueRenderOption=FORMATTED_VALUE&prettyPrint=false",
"body": null,
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -1561,7 +1561,7 @@
{
"request": {
"method": "PUT",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Dslt6b_MEecinUu6x5Onc-hG6WdoWD-9khrZwSHLeTI/values/%27Sheet1%27%21B1?valueInputOption=USER_ENTERED",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Dslt6b_MEecinUu6x5Onc-hG6WdoWD-9khrZwSHLeTI/values/%27Sheet1%27%21B1?valueInputOption=USER_ENTERED&prettyPrint=false",
"body": "{\"values\": [[\"Dummy\"]]}",
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -1640,7 +1640,7 @@
{
"request": {
"method": "GET",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Dslt6b_MEecinUu6x5Onc-hG6WdoWD-9khrZwSHLeTI/values/%27Sheet1%27",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1Dslt6b_MEecinUu6x5Onc-hG6WdoWD-9khrZwSHLeTI/values/%27Sheet1%27?prettyPrint=false",
"body": null,
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -1710,7 +1710,7 @@
{
"request": {
"method": "DELETE",
"uri": "https://www.googleapis.com/drive/v3/files/1Dslt6b_MEecinUu6x5Onc-hG6WdoWD-9khrZwSHLeTI?supportsAllDrives=True",
"uri": "https://www.googleapis.com/drive/v3/files/1Dslt6b_MEecinUu6x5Onc-hG6WdoWD-9khrZwSHLeTI?supportsAllDrives=True&prettyPrint=false",
"body": null,
"headers": {
"User-Agent": [
Expand Down
20 changes: 10 additions & 10 deletions tests/cassettes/CellTest.test_define_named_range.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
{
"request": {
"method": "POST",
"uri": "https://www.googleapis.com/drive/v3/files?supportsAllDrives=True",
"uri": "https://www.googleapis.com/drive/v3/files?supportsAllDrives=True&prettyPrint=false",
"body": "{\"name\": \"Test CellTest test_define_named_range\", \"mimeType\": \"application/vnd.google-apps.spreadsheet\"}",
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -84,7 +84,7 @@
{
"request": {
"method": "GET",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1S_BLfCbQDFbROywtjC4LXZO18nIcmpsnVafpKgy0Kl4?includeGridData=false",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1S_BLfCbQDFbROywtjC4LXZO18nIcmpsnVafpKgy0Kl4?includeGridData=false&prettyPrint=false",
"body": null,
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -157,7 +157,7 @@
{
"request": {
"method": "GET",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1S_BLfCbQDFbROywtjC4LXZO18nIcmpsnVafpKgy0Kl4?includeGridData=false",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1S_BLfCbQDFbROywtjC4LXZO18nIcmpsnVafpKgy0Kl4?includeGridData=false&prettyPrint=false",
"body": null,
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -230,7 +230,7 @@
{
"request": {
"method": "POST",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1S_BLfCbQDFbROywtjC4LXZO18nIcmpsnVafpKgy0Kl4:batchUpdate",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1S_BLfCbQDFbROywtjC4LXZO18nIcmpsnVafpKgy0Kl4:batchUpdate?prettyPrint=false",
"body": "{\"requests\": [{\"addNamedRange\": {\"namedRange\": {\"name\": \"TestDefineNamedRange\", \"range\": {\"startRowIndex\": 0, \"endRowIndex\": 2, \"startColumnIndex\": 0, \"endColumnIndex\": 2, \"sheetId\": 0}}}}]}",
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -309,7 +309,7 @@
{
"request": {
"method": "GET",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1S_BLfCbQDFbROywtjC4LXZO18nIcmpsnVafpKgy0Kl4?fields=namedRanges",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1S_BLfCbQDFbROywtjC4LXZO18nIcmpsnVafpKgy0Kl4?fields=namedRanges&prettyPrint=false",
"body": null,
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -382,7 +382,7 @@
{
"request": {
"method": "POST",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1S_BLfCbQDFbROywtjC4LXZO18nIcmpsnVafpKgy0Kl4:batchUpdate",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1S_BLfCbQDFbROywtjC4LXZO18nIcmpsnVafpKgy0Kl4:batchUpdate?prettyPrint=false",
"body": "{\"requests\": [{\"deleteNamedRange\": {\"namedRangeId\": \"220755387\"}}]}",
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -461,7 +461,7 @@
{
"request": {
"method": "GET",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1S_BLfCbQDFbROywtjC4LXZO18nIcmpsnVafpKgy0Kl4?fields=namedRanges",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1S_BLfCbQDFbROywtjC4LXZO18nIcmpsnVafpKgy0Kl4?fields=namedRanges&prettyPrint=false",
"body": null,
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -534,7 +534,7 @@
{
"request": {
"method": "POST",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1S_BLfCbQDFbROywtjC4LXZO18nIcmpsnVafpKgy0Kl4:batchUpdate",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1S_BLfCbQDFbROywtjC4LXZO18nIcmpsnVafpKgy0Kl4:batchUpdate?prettyPrint=false",
"body": "{\"requests\": [{\"addNamedRange\": {\"namedRange\": {\"name\": \"TestDefineNamedRange\", \"range\": {\"startRowIndex\": 0, \"endRowIndex\": 2, \"startColumnIndex\": 0, \"endColumnIndex\": 2, \"sheetId\": 0}}}}]}",
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -613,7 +613,7 @@
{
"request": {
"method": "GET",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1S_BLfCbQDFbROywtjC4LXZO18nIcmpsnVafpKgy0Kl4?fields=namedRanges",
"uri": "https://sheets.googleapis.com/v4/spreadsheets/1S_BLfCbQDFbROywtjC4LXZO18nIcmpsnVafpKgy0Kl4?fields=namedRanges&prettyPrint=false",
"body": null,
"headers": {
"User-Agent": [
Expand Down Expand Up @@ -686,7 +686,7 @@
{
"request": {
"method": "DELETE",
"uri": "https://www.googleapis.com/drive/v3/files/1S_BLfCbQDFbROywtjC4LXZO18nIcmpsnVafpKgy0Kl4?supportsAllDrives=True",
"uri": "https://www.googleapis.com/drive/v3/files/1S_BLfCbQDFbROywtjC4LXZO18nIcmpsnVafpKgy0Kl4?supportsAllDrives=True&prettyPrint=false",
"body": null,
"headers": {
"User-Agent": [
Expand Down
Loading