Blame - docs/apiclient.schema.html - platform/external/python/google-api-python-client

><a href=".">index</a> <a href="file:/usr/local/google/home/jcgregorio/projects/apiclient-release/apiclient/schema.py">/usr/local/google/home/jcgregorio/projects/apiclient-release/apiclient/schema.py</a></td></tr></table>

Joe Gregorio

2401bd6

2011-12-15 09:18:49 -0500

[diff] [blame]

12

<tt>Schema processing for discovery based APIs

13

14

<a href="#Schemas">Schemas</a> holds an APIs discovery schemas. It can return those schema as

15

deserialized JSON objects, or pretty print them as prototype objects that

16

conform to the schema.

17

18

For example, given the schema:

schema = """{

"Foo": {

"type": "<a href="__builtin__.html#object">object</a>",

"properties": {

"etag": {

"type": "string",

"description": "ETag of the collection."

},

"kind": {

"type": "string",

"description": "Type of the collection ('calendar#acl').",

31

"default": "calendar#acl"

},

"nextPageToken": {

"type": "string",

"description": "Token used to access the next

36

page of this result. Omitted if no further results are available."

}

}

}

}"""

s = <a href="#Schemas">Schemas</a>(schema)

43

print s.prettyPrintByName('Foo')

44

45

Produces the following output:

46

47

{

48

"nextPageToken": "A String", # Token used to access the

49

# next page of this result. Omitted if no further results are available.

50

"kind": "A String", # Type of the collection ('calendar#acl').

51

"etag": "A String", # ETag of the collection.

52

},

53

54

The constructor takes a discovery document in which to look up named schema.</tt>

<big>Modules</big></td></tr>

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

63

</td><td width="25%" valign=top><a href="json.html">json</a>

Joe Gregorio

2401bd6

2011-12-15 09:18:49 -0500

[diff] [blame]

64

</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table>

<big>Classes</big></td></tr>

<dt><a href="__builtin__.html#object">__builtin__.object</a>

73

</dt><dd>

74

<dl>

75

<dt><a href="apiclient.schema.html#Schemas">Schemas</a>

</dt></dl>

</dd>

</dl>

<a name="Schemas">class Schemas</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</td></tr>

84

85

86

<td colspan=2><tt><a href="#Schemas">Schemas</a> for an API.  </tt></td></tr>

87

88

<td width="100%">Methods defined here:

89

<dl><dt><a name="Schemas-__init__">__init__</a>(self, discovery)</dt><dd><tt>Constructor.

90

91

Args:

92

discovery: <a href="__builtin__.html#object">object</a>, Deserialized discovery document from which we pull

93

out the named schema.</tt></dd></dl>

94

95

<dl><dt><a name="Schemas-get">get</a>(self, name)</dt><dd><tt>Get deserialized JSON schema from the schema name.

96

97

Args:

98

name: string, Schema name.</tt></dd></dl>

99

100

<dl><dt><a name="Schemas-prettyPrintByName">prettyPrintByName</a>(self, name)</dt><dd><tt>Get pretty printed <a href="__builtin__.html#object">object</a> prototype from the schema name.

101

102

Args:

103

name: string, Name of schema in the discovery document.

104

105

Returns:

106

string, A string that contains a prototype <a href="__builtin__.html#object">object</a> with

107

comments that conforms to the given schema.</tt></dd></dl>

108

109

<dl><dt><a name="Schemas-prettyPrintSchema">prettyPrintSchema</a>(self, schema)</dt><dd><tt>Get pretty printed <a href="__builtin__.html#object">object</a> prototype of schema.

110

111

Args:

112

schema: <a href="__builtin__.html#object">object</a>, Parsed JSON schema.

113

114

Returns:

115

string, A string that contains a prototype <a href="__builtin__.html#object">object</a> with

116

comments that conforms to the given schema.</tt></dd></dl>