Skip to content
Permalink
Browse files

docs: Reduce noisy changes in docs regen (#1135)

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code!  That way we can discuss the change, evaluate designs, and agree on the general idea
- [x] Ensure the tests and linter pass
- [x] Code coverage does not decrease (if any source code was changed)
- [x] Appropriate docs were updated (if necessary)

Fixes #386 🦕
  • Loading branch information
parthea committed Dec 14, 2020
1 parent 2c6d029 commit b1b0c83ae0737e7b63cb77e4e7757213a216b88e
Showing with 26 additions and 21 deletions.
  1. +1 −1 describe.py
  2. +5 −3 googleapiclient/discovery.py
  3. +6 −3 googleapiclient/schema.py
  4. +14 −14 tests/test_schema.py
@@ -234,7 +234,7 @@ def add_param(pname, desc):
pname = m.group(1)
desc = m.group(2)
add_param(pname, desc)
parameters = ", ".join(parameters)
parameters = ", ".join(sorted(parameters))
else:
parameters = ""
return parameters
@@ -898,7 +898,9 @@ def set_parameters(self, method_desc):
comes from the dictionary of methods stored in the 'methods' key in
the deserialized discovery document.
"""
for arg, desc in six.iteritems(method_desc.get("parameters", {})):
parameters = method_desc.get("parameters", {})
sorted_parameters = OrderedDict(sorted(parameters.items()))
for arg, desc in six.iteritems(sorted_parameters):
param = key2param(arg)
self.argmap[param] = arg

@@ -1137,7 +1139,7 @@ def method(self, **kwargs):
if "body" in all_args:
args_ordered.append("body")

for name in all_args:
for name in sorted(all_args):
if name not in args_ordered:
args_ordered.append(name)

@@ -1155,7 +1157,7 @@ def method(self, **kwargs):
paramdoc = paramdesc.get("description", "A parameter")
if "$ref" in paramdesc:
docs.append(
(" %s: object, %s%s%s\n The object takes the" " form of:\n\n%s\n\n")
(" %s: object, %s%s%s\n The object takes the form of:\n\n%s\n\n")
% (
arg,
paramdoc,
@@ -65,6 +65,7 @@

import copy

from collections import OrderedDict
from googleapiclient import _helpers as util


@@ -124,7 +125,7 @@ def prettyPrintByName(self, name):
comments that conforms to the given schema.
"""
# Return with trailing comma and newline removed.
return self._prettyPrintByName(name, seen=[], dent=1)[:-2]
return self._prettyPrintByName(name, seen=[], dent=0)[:-2]

@util.positional(2)
def _prettyPrintSchema(self, schema, seen=None, dent=0):
@@ -155,7 +156,7 @@ def prettyPrintSchema(self, schema):
comments that conforms to the given schema.
"""
# Return with trailing comma and newline removed.
return self._prettyPrintSchema(schema, dent=1)[:-2]
return self._prettyPrintSchema(schema, dent=0)[:-2]

def get(self, name, default=None):
"""Get deserialized JSON schema from the schema name.
@@ -253,7 +254,9 @@ def _to_str_impl(self, schema):
self.emitEnd("{", schema.get("description", ""))
self.indent()
if "properties" in schema:
for pname, pschema in six.iteritems(schema.get("properties", {})):
properties = schema.get("properties", {})
sorted_properties = OrderedDict(sorted(properties.items()))
for pname, pschema in six.iteritems(sorted_properties):
self.emitBegin('"%s": ' % pname)
self._to_str_impl(pschema)
elif "additionalProperties" in schema:
@@ -32,20 +32,20 @@ def datafile(filename):


LOAD_FEED = """{
"items": [
{
"longVal": 42,
"kind": "zoo#loadValue",
"enumVal": "A String",
"anyVal": "", # Anything will do.
"nullVal": None,
"stringVal": "A String",
"doubleVal": 3.14,
"booleanVal": True or False, # True or False.
},
],
"kind": "zoo#loadFeed",
}"""
"items": [
{
"longVal": 42,
"kind": "zoo#loadValue",
"enumVal": "A String",
"anyVal": "", # Anything will do.
"nullVal": None,
"stringVal": "A String",
"doubleVal": 3.14,
"booleanVal": True or False, # True or False.
},
],
"kind": "zoo#loadFeed",
}"""


class SchemasTest(unittest.TestCase):

0 comments on commit b1b0c83

Please sign in to comment.