). The page title may be followed by a link to the
- * corresponding source code (using 'span.codelink').
- * - The footer consists of a navigation bar, a timestamp, and a
- * pointer to epydoc's homepage.
- */
-h1.epydoc { margin: 0; font-size: +140%; font-weight: bold; }
-h2.epydoc { font-size: +130%; font-weight: bold; }
-h3.epydoc { font-size: +115%; font-weight: bold;
- margin-top: 0.2em; }
-td h3.epydoc { font-size: +115%; font-weight: bold;
- margin-bottom: 0; }
-table.navbar { background: #a0c0ff; color: #000000;
- border: 2px groove #c0d0d0; }
-table.navbar table { color: #000000; }
-th.navbar-select { background: #70b0ff;
- color: #000000; }
-table.navbar a { text-decoration: none; }
-table.navbar a:link { color: #0000ff; }
-table.navbar a:visited { color: #204080; }
-span.breadcrumbs { font-size: 85%; font-weight: bold; }
-span.options { font-size: 70%; }
-span.codelink { font-size: 85%; }
-td.footer { font-size: 85%; }
-
-/* Table Headers
- * - Each summary table and details section begins with a 'header'
- * row. This row contains a section title (marked by
- * 'span.table-header') as well as a show/hide private link
- * (marked by 'span.options', defined above).
- * - Summary tables that contain user-defined groups mark those
- * groups using 'group header' rows.
- */
-td.table-header { background: #70b0ff; color: #000000;
- border: 1px solid #608090; }
-td.table-header table { color: #000000; }
-td.table-header table a:link { color: #0000ff; }
-td.table-header table a:visited { color: #204080; }
-span.table-header { font-size: 120%; font-weight: bold; }
-th.group-header { background: #c0e0f8; color: #000000;
- text-align: left; font-style: italic;
- font-size: 115%;
- border: 1px solid #608090; }
-
-/* Summary Tables (functions, variables, etc)
- * - Each object is described by a single row of the table with
- * two cells. The left cell gives the object's type, and is
- * marked with 'code.summary-type'. The right cell gives the
- * object's name and a summary description.
- * - CSS styles for the table's header and group headers are
- * defined above, under 'Table Headers'
- */
-table.summary { border-collapse: collapse;
- background: #e8f0f8; color: #000000;
- border: 1px solid #608090;
- margin-bottom: 0.5em; }
-td.summary { border: 1px solid #608090; }
-code.summary-type { font-size: 85%; }
-table.summary a:link { color: #0000ff; }
-table.summary a:visited { color: #204080; }
-
-
-/* Details Tables (functions, variables, etc)
- * - Each object is described in its own div.
- * - A single-row summary table w/ table-header is used as
- * a header for each details section (CSS style for table-header
- * is defined above, under 'Table Headers').
- */
-table.details { border-collapse: collapse;
- background: #e8f0f8; color: #000000;
- border: 1px solid #608090;
- margin: .2em 0 0 0; }
-table.details table { color: #000000; }
-table.details a:link { color: #0000ff; }
-table.details a:visited { color: #204080; }
-
-/* Fields */
-dl.fields { margin-left: 2em; margin-top: 1em;
- margin-bottom: 1em; }
-dl.fields dd ul { margin-left: 0em; padding-left: 0em; }
-dl.fields dd ul li ul { margin-left: 2em; padding-left: 0em; }
-div.fields { margin-left: 2em; }
-div.fields p { margin-bottom: 0.5em; }
-
-/* Index tables (identifier index, term index, etc)
- * - link-index is used for indices containing lists of links
- * (namely, the identifier index & term index).
- * - index-where is used in link indices for the text indicating
- * the container/source for each link.
- * - metadata-index is used for indices containing metadata
- * extracted from fields (namely, the bug index & todo index).
- */
-table.link-index { border-collapse: collapse;
- background: #e8f0f8; color: #000000;
- border: 1px solid #608090; }
-td.link-index { border-width: 0px; }
-table.link-index a:link { color: #0000ff; }
-table.link-index a:visited { color: #204080; }
-span.index-where { font-size: 70%; }
-table.metadata-index { border-collapse: collapse;
- background: #e8f0f8; color: #000000;
- border: 1px solid #608090;
- margin: .2em 0 0 0; }
-td.metadata-index { border-width: 1px; border-style: solid; }
-table.metadata-index a:link { color: #0000ff; }
-table.metadata-index a:visited { color: #204080; }
-
-/* Function signatures
- * - sig* is used for the signature in the details section.
- * - .summary-sig* is used for the signature in the summary
- * table, and when listing property accessor functions.
- * */
-.sig-name { color: #006080; }
-.sig-arg { color: #008060; }
-.sig-default { color: #602000; }
-.summary-sig { font-family: monospace; }
-.summary-sig-name { color: #006080; font-weight: bold; }
-table.summary a.summary-sig-name:link
- { color: #006080; font-weight: bold; }
-table.summary a.summary-sig-name:visited
- { color: #006080; font-weight: bold; }
-.summary-sig-arg { color: #006040; }
-.summary-sig-default { color: #501800; }
-
-/* Subclass list
- */
-ul.subclass-list { display: inline; }
-ul.subclass-list li { display: inline; }
-
-/* To render variables, classes etc. like functions */
-table.summary .summary-name { color: #006080; font-weight: bold;
- font-family: monospace; }
-table.summary
- a.summary-name:link { color: #006080; font-weight: bold;
- font-family: monospace; }
-table.summary
- a.summary-name:visited { color: #006080; font-weight: bold;
- font-family: monospace; }
-
-/* Variable values
- * - In the 'variable details' sections, each varaible's value is
- * listed in a 'pre.variable' box. The width of this box is
- * restricted to 80 chars; if the value's repr is longer than
- * this it will be wrapped, using a backslash marked with
- * class 'variable-linewrap'. If the value's repr is longer
- * than 3 lines, the rest will be ellided; and an ellipsis
- * marker ('...' marked with 'variable-ellipsis') will be used.
- * - If the value is a string, its quote marks will be marked
- * with 'variable-quote'.
- * - If the variable is a regexp, it is syntax-highlighted using
- * the re* CSS classes.
- */
-pre.variable { padding: .5em; margin: 0;
- background: #dce4ec; color: #000000;
- border: 1px solid #708890; }
-.variable-linewrap { color: #604000; font-weight: bold; }
-.variable-ellipsis { color: #604000; font-weight: bold; }
-.variable-quote { color: #604000; font-weight: bold; }
-.variable-group { color: #008000; font-weight: bold; }
-.variable-op { color: #604000; font-weight: bold; }
-.variable-string { color: #006030; }
-.variable-unknown { color: #a00000; font-weight: bold; }
-.re { color: #000000; }
-.re-char { color: #006030; }
-.re-op { color: #600000; }
-.re-group { color: #003060; }
-.re-ref { color: #404040; }
-
-/* Base tree
- * - Used by class pages to display the base class hierarchy.
- */
-pre.base-tree { font-size: 80%; margin: 0; }
-
-/* Frames-based table of contents headers
- * - Consists of two frames: one for selecting modules; and
- * the other listing the contents of the selected module.
- * - h1.toc is used for each frame's heading
- * - h2.toc is used for subheadings within each frame.
- */
-h1.toc { text-align: center; font-size: 105%;
- margin: 0; font-weight: bold;
- padding: 0; }
-h2.toc { font-size: 100%; font-weight: bold;
- margin: 0.5em 0 0 -0.3em; }
-
-/* Syntax Highlighting for Source Code
- * - doctest examples are displayed in a 'pre.py-doctest' block.
- * If the example is in a details table entry, then it will use
- * the colors specified by the 'table pre.py-doctest' line.
- * - Source code listings are displayed in a 'pre.py-src' block.
- * Each line is marked with 'span.py-line' (used to draw a line
- * down the left margin, separating the code from the line
- * numbers). Line numbers are displayed with 'span.py-lineno'.
- * The expand/collapse block toggle button is displayed with
- * 'a.py-toggle' (Note: the CSS style for 'a.py-toggle' should not
- * modify the font size of the text.)
- * - If a source code page is opened with an anchor, then the
- * corresponding code block will be highlighted. The code
- * block's header is highlighted with 'py-highlight-hdr'; and
- * the code block's body is highlighted with 'py-highlight'.
- * - The remaining py-* classes are used to perform syntax
- * highlighting (py-string for string literals, py-name for names,
- * etc.)
- */
-pre.py-doctest { padding: .5em; margin: 1em;
- background: #e8f0f8; color: #000000;
- border: 1px solid #708890; }
-table pre.py-doctest { background: #dce4ec;
- color: #000000; }
-pre.py-src { border: 2px solid #000000;
- background: #f0f0f0; color: #000000; }
-.py-line { border-left: 2px solid #000000;
- margin-left: .2em; padding-left: .4em; }
-.py-lineno { font-style: italic; font-size: 90%;
- padding-left: .5em; }
-a.py-toggle { text-decoration: none; }
-div.py-highlight-hdr { border-top: 2px solid #000000;
- border-bottom: 2px solid #000000;
- background: #d8e8e8; }
-div.py-highlight { border-bottom: 2px solid #000000;
- background: #d0e0e0; }
-.py-prompt { color: #005050; font-weight: bold;}
-.py-more { color: #005050; font-weight: bold;}
-.py-string { color: #006030; }
-.py-comment { color: #003060; }
-.py-keyword { color: #600000; }
-.py-output { color: #404040; }
-.py-name { color: #000050; }
-.py-name:link { color: #000050 !important; }
-.py-name:visited { color: #000050 !important; }
-.py-number { color: #005000; }
-.py-defname { color: #000060; font-weight: bold; }
-.py-def-name { color: #000060; font-weight: bold; }
-.py-base-class { color: #000060; }
-.py-param { color: #000060; }
-.py-docstring { color: #006030; }
-.py-decorator { color: #804020; }
-/* Use this if you don't want links to names underlined: */
-/*a.py-name { text-decoration: none; }*/
-
-/* Graphs & Diagrams
- * - These CSS styles are used for graphs & diagrams generated using
- * Graphviz dot. 'img.graph-without-title' is used for bare
- * diagrams (to remove the border created by making the image
- * clickable).
- */
-img.graph-without-title { border: none; }
-img.graph-with-title { border: 1px solid #000000; }
-span.graph-title { font-weight: bold; }
-span.graph-caption { }
-
-/* General-purpose classes
- * - 'p.indent-wrapped-lines' defines a paragraph whose first line
- * is not indented, but whose subsequent lines are.
- * - The 'nomargin-top' class is used to remove the top margin (e.g.
- * from lists). The 'nomargin' class is used to remove both the
- * top and bottom margin (but not the left or right margin --
- * for lists, that would cause the bullets to disappear.)
- */
-p.indent-wrapped-lines { padding: 0 0 0 7em; text-indent: -7em;
- margin: 0; }
-.nomargin-top { margin-top: 0; }
-.nomargin { margin-top: 0; margin-bottom: 0; }
-
-/* HTML Log */
-div.log-block { padding: 0; margin: .5em 0 .5em 0;
- background: #e8f0f8; color: #000000;
- border: 1px solid #000000; }
-div.log-error { padding: .1em .3em .1em .3em; margin: 4px;
- background: #ffb0b0; color: #000000;
- border: 1px solid #000000; }
-div.log-warning { padding: .1em .3em .1em .3em; margin: 4px;
- background: #ffffb0; color: #000000;
- border: 1px solid #000000; }
-div.log-info { padding: .1em .3em .1em .3em; margin: 4px;
- background: #b0ffb0; color: #000000;
- border: 1px solid #000000; }
-h2.log-hdr { background: #70b0ff; color: #000000;
- margin: 0; padding: 0em 0.5em 0em 0.5em;
- border-bottom: 1px solid #000000; font-size: 110%; }
-p.log { font-weight: bold; margin: .5em 0 .5em 0; }
-tr.opt-changed { color: #000000; font-weight: bold; }
-tr.opt-default { color: #606060; }
-pre.log { margin: 0; padding: 0; padding-left: 1em; }
diff --git a/docs/epy/epydoc.js b/docs/epy/epydoc.js
deleted file mode 100644
index e787dbcf471..00000000000
--- a/docs/epy/epydoc.js
+++ /dev/null
@@ -1,293 +0,0 @@
-function toggle_private() {
- // Search for any private/public links on this page. Store
- // their old text in "cmd," so we will know what action to
- // take; and change their text to the opposite action.
- var cmd = "?";
- var elts = document.getElementsByTagName("a");
- for(var i=0; i...
";
- elt.innerHTML = s;
- }
-}
-
-function toggle(id) {
- elt = document.getElementById(id+"-toggle");
- if (elt.innerHTML == "-")
- collapse(id);
- else
- expand(id);
- return false;
-}
-
-function highlight(id) {
- var elt = document.getElementById(id+"-def");
- if (elt) elt.className = "py-highlight-hdr";
- var elt = document.getElementById(id+"-expanded");
- if (elt) elt.className = "py-highlight";
- var elt = document.getElementById(id+"-collapsed");
- if (elt) elt.className = "py-highlight";
-}
-
-function num_lines(s) {
- var n = 1;
- var pos = s.indexOf("\n");
- while ( pos > 0) {
- n += 1;
- pos = s.indexOf("\n", pos+1);
- }
- return n;
-}
-
-// Collapse all blocks that mave more than `min_lines` lines.
-function collapse_all(min_lines) {
- var elts = document.getElementsByTagName("div");
- for (var i=0; i 0)
- if (elt.id.substring(split, elt.id.length) == "-expanded")
- if (num_lines(elt.innerHTML) > min_lines)
- collapse(elt.id.substring(0, split));
- }
-}
-
-function expandto(href) {
- var start = href.indexOf("#")+1;
- if (start != 0 && start != href.length) {
- if (href.substring(start, href.length) != "-") {
- collapse_all(4);
- pos = href.indexOf(".", start);
- while (pos != -1) {
- var id = href.substring(start, pos);
- expand(id);
- pos = href.indexOf(".", pos+1);
- }
- var id = href.substring(start, href.length);
- expand(id);
- highlight(id);
- }
- }
-}
-
-function kill_doclink(id) {
- var parent = document.getElementById(id);
- parent.removeChild(parent.childNodes.item(0));
-}
-function auto_kill_doclink(ev) {
- if (!ev) var ev = window.event;
- if (!this.contains(ev.toElement)) {
- var parent = document.getElementById(this.parentID);
- parent.removeChild(parent.childNodes.item(0));
- }
-}
-
-function doclink(id, name, targets_id) {
- var elt = document.getElementById(id);
-
- // If we already opened the box, then destroy it.
- // (This case should never occur, but leave it in just in case.)
- if (elt.childNodes.length > 1) {
- elt.removeChild(elt.childNodes.item(0));
- }
- else {
- // The outer box: relative + inline positioning.
- var box1 = document.createElement("div");
- box1.style.position = "relative";
- box1.style.display = "inline";
- box1.style.top = 0;
- box1.style.left = 0;
-
- // A shadow for fun
- var shadow = document.createElement("div");
- shadow.style.position = "absolute";
- shadow.style.left = "-1.3em";
- shadow.style.top = "-1.3em";
- shadow.style.background = "#404040";
-
- // The inner box: absolute positioning.
- var box2 = document.createElement("div");
- box2.style.position = "relative";
- box2.style.border = "1px solid #a0a0a0";
- box2.style.left = "-.2em";
- box2.style.top = "-.2em";
- box2.style.background = "white";
- box2.style.padding = ".3em .4em .3em .4em";
- box2.style.fontStyle = "normal";
- box2.onmouseout=auto_kill_doclink;
- box2.parentID = id;
-
- // Get the targets
- var targets_elt = document.getElementById(targets_id);
- var targets = targets_elt.getAttribute("targets");
- var links = "";
- target_list = targets.split(",");
- for (var i=0; i" +
- target[0] + "";
- }
-
- // Put it all together.
- elt.insertBefore(box1, elt.childNodes.item(0));
- //box1.appendChild(box2);
- box1.appendChild(shadow);
- shadow.appendChild(box2);
- box2.innerHTML =
- "Which "+name+" do you want to see documentation for?" +
- "" +
- links +
- "- "+
- "None of the above
";
- }
- return false;
-}
-
-function get_anchor() {
- var href = location.href;
- var start = href.indexOf("#")+1;
- if ((start != 0) && (start != href.length))
- return href.substring(start, href.length);
- }
-function redirect_url(dottedName) {
- // Scan through each element of the "pages" list, and check
- // if "name" matches with any of them.
- for (var i=0; i-m" or "-c";
- // extract the portion & compare it to dottedName.
- var pagename = pages[i].substring(0, pages[i].length-2);
- if (pagename == dottedName.substring(0,pagename.length)) {
-
- // We've found a page that matches `dottedName`;
- // construct its URL, using leftover `dottedName`
- // content to form an anchor.
- var pagetype = pages[i].charAt(pages[i].length-1);
- var url = pagename + ((pagetype=="m")?"-module.html":
- "-class.html");
- if (dottedName.length > pagename.length)
- url += "#" + dottedName.substring(pagename.length+1,
- dottedName.length);
- return url;
- }
- }
- }
diff --git a/docs/epy/frames.html b/docs/epy/frames.html
deleted file mode 100644
index 042cb61ab1f..00000000000
--- a/docs/epy/frames.html
+++ /dev/null
@@ -1,17 +0,0 @@
-
-
-
-
- API Documentation
-
-
-
diff --git a/docs/epy/googleapiclient-module.html b/docs/epy/googleapiclient-module.html
deleted file mode 100644
index c71277b53e2..00000000000
--- a/docs/epy/googleapiclient-module.html
+++ /dev/null
@@ -1,168 +0,0 @@
-
-
-
-
- googleapiclient
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Package googleapiclient
-
-
-
-
-
-
-
- Submodules
-
-
-
-
-
-
- - googleapiclient._auth: Helpers for authentication using oauth2client or google-auth.
- - googleapiclient._helpers: Helper functions for commonly used utilities.
- - googleapiclient.channel: Channel notifications support.
- - googleapiclient.discovery: Client for discovery based APIs.
- - googleapiclient.discovery_cache: Caching utility for the discovery document.
-
- - googleapiclient.discovery_cache.appengine_memcache: App Engine memcache based cache for the discovery document.
- - googleapiclient.discovery_cache.base: An abstract class for caching the discovery document.
- - googleapiclient.discovery_cache.file_cache: File based cache for the discovery document.
-
-
- - googleapiclient.errors: Errors for the library.
- - googleapiclient.http: Classes to encapsulate a single HTTP request.
- - googleapiclient.mimeparse: MIME-Type Parser
- - googleapiclient.model: Model objects for requests and responses.
- - googleapiclient.sample_tools: Utilities for making samples.
- - googleapiclient.schema: Schema processing for discovery based APIs
-
-
-
-
-
-
-
-
-
-
- Variables
-
-
-
-
-
-
-
-
- __package__ = 'googleapiclient'
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:21 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient-pysrc.html b/docs/epy/googleapiclient-pysrc.html
deleted file mode 100644
index 63b4e14d477..00000000000
--- a/docs/epy/googleapiclient-pysrc.html
+++ /dev/null
@@ -1,137 +0,0 @@
-
-
-
-
- googleapiclient
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Source Code for Package googleapiclient
-
- 1 # Copyright 2014 Google Inc. All Rights Reserved.
- 2 #
- 3 # Licensed under the Apache License, Version 2.0 (the "License");
- 4 # you may not use this file except in compliance with the License.
- 5 # You may obtain a copy of the License at
- 6 #
- 7 # http://www.apache.org/licenses/LICENSE-2.0
- 8 #
- 9 # Unless required by applicable law or agreed to in writing, software
-10 # distributed under the License is distributed on an "AS IS" BASIS,
-11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-12 # See the License for the specific language governing permissions and
-13 # limitations under the License.
-14
-15 # Set default logging handler to avoid "No handler found" warnings.
-16 import logging
-17
-18 try: # Python 2.7+
-19 from logging import NullHandler
-20 except ImportError:
-21
-25
-26
-27 logging.getLogger(__name__).addHandler(NullHandler())
-28
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.NullHandler-class.html b/docs/epy/googleapiclient.NullHandler-class.html
deleted file mode 100644
index 723ee152f96..00000000000
--- a/docs/epy/googleapiclient.NullHandler-class.html
+++ /dev/null
@@ -1,282 +0,0 @@
-
-
-
-
- googleapiclient.NullHandler
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class NullHandler
-
-
-
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- emit(self,
- record)
- Do whatever it takes to actually log the specified logging record.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from logging.Handler:
- __init__,
- acquire,
- close,
- createLock,
- flush,
- format,
- get_name,
- handle,
- handleError,
- release,
- setFormatter,
- setLevel,
- set_name
-
- Inherited from logging.Filterer:
- addFilter,
- filter,
- removeFilter
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Class Variables
-
-
-
-
-
-
- Inherited from logging.Handler:
- name
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- emit(self,
- record)
-
- source code
-
-
-
-
-
-Do whatever it takes to actually log the specified logging record.
-
-This version is intended to be implemented by subclasses and so
-raises a NotImplementedError.
-
-
-
- - Overrides:
- logging.Handler.emit
-
- (inherited documentation)
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Thu Apr 30 17:06:05 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient._auth-module.html b/docs/epy/googleapiclient._auth-module.html
deleted file mode 100644
index a166d7753a0..00000000000
--- a/docs/epy/googleapiclient._auth-module.html
+++ /dev/null
@@ -1,390 +0,0 @@
-
-
-
-
- googleapiclient._auth
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module _auth
-Helpers for authentication using oauth2client or google-auth.
-
-
-
-
-
-
-
-
- Functions
-
-
-
-
-
-
-
-
-
-
- credentials_from_file(filename,
- scopes=None,
- quota_project_id=None)
- Returns credentials loaded from a file.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- default_credentials(scopes=None,
- quota_project_id=None)
- Returns Application Default Credentials.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- with_scopes(credentials,
- scopes)
- Scopes the credentials if necessary.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- authorized_http(credentials)
- Returns an http client that is authorized with the given credentials.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- refresh_credentials(credentials)
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- apply_credentials(credentials,
- headers)
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- is_valid(credentials)
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- get_credentials_from_http(http)
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Variables
-
-
-
-
-
-
-
-
- HAS_GOOGLE_AUTH = False
-
-
-
-
-
-
- google_auth_httplib2 = None
-
-
-
-
-
-
- HAS_OAUTH2CLIENT = False
-
-
-
-
-
-
- __package__ = 'googleapiclient'
-
-
-
-
-
-
-
-
-
- Function Details
-
-
-
-
-
-
-
-
-
-
-
- with_scopes(credentials,
- scopes)
-
- source code
-
-
-
-
-Scopes the credentials if necessary.
-
-Args:
- credentials (Union[
- google.auth.credentials.Credentials,
- oauth2client.client.Credentials]): The credentials to scope.
- scopes (Sequence[str]): The list of scopes.
-
-Returns:
- Union[google.auth.credentials.Credentials,
- oauth2client.client.Credentials]: The scoped credentials.
-
-
-
-
-
-
-
-
-
-
-
-
- authorized_http(credentials)
-
- source code
-
-
-
-
-Returns an http client that is authorized with the given credentials.
-
-Args:
- credentials (Union[
- google.auth.credentials.Credentials,
- oauth2client.client.Credentials]): The credentials to use.
-
-Returns:
- Union[httplib2.Http, google_auth_httplib2.AuthorizedHttp]: An
- authorized http client.
-
-
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:21 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient._auth-pysrc.html b/docs/epy/googleapiclient._auth-pysrc.html
deleted file mode 100644
index 9717363ccfd..00000000000
--- a/docs/epy/googleapiclient._auth-pysrc.html
+++ /dev/null
@@ -1,290 +0,0 @@
-
-
-
-
- googleapiclient._auth
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Source Code for Module googleapiclient._auth
-
- 1 # Copyright 2016 Google Inc. All Rights Reserved.
- 2 #
- 3 # Licensed under the Apache License, Version 2.0 (the "License");
- 4 # you may not use this file except in compliance with the License.
- 5 # You may obtain a copy of the License at
- 6 #
- 7 # http://www.apache.org/licenses/LICENSE-2.0
- 8 #
- 9 # Unless required by applicable law or agreed to in writing, software
- 10 # distributed under the License is distributed on an "AS IS" BASIS,
- 11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- 12 # See the License for the specific language governing permissions and
- 13 # limitations under the License.
- 14
- 15 """Helpers for authentication using oauth2client or google-auth."""
- 16
- 17 import httplib2
- 18
- 19 try:
- 20 import google.auth
- 21 import google.auth.credentials
- 22
- 23 HAS_GOOGLE_AUTH = True
- 24 except ImportError: # pragma: NO COVER
- 25 HAS_GOOGLE_AUTH = False
- 26
- 27 try:
- 28 import google_auth_httplib2
- 29 except ImportError: # pragma: NO COVER
- 30 google_auth_httplib2 = None
- 31
- 32 try:
- 33 import oauth2client
- 34 import oauth2client.client
- 35
- 36 HAS_OAUTH2CLIENT = True
- 37 except ImportError: # pragma: NO COVER
- 38 HAS_OAUTH2CLIENT = False
- 39
- 40
- 42 """Returns credentials loaded from a file."""
- 43 if HAS_GOOGLE_AUTH:
- 44 credentials, _ = google.auth.load_credentials_from_file(filename, scopes=scopes, quota_project_id=quota_project_id)
- 45 return credentials
- 46 else:
- 47 raise EnvironmentError(
- 48 "client_options.credentials_file is only supported in google-auth.")
- 49
- 50
- 52 """Returns Application Default Credentials."""
- 53 if HAS_GOOGLE_AUTH:
- 54 credentials, _ = google.auth.default(scopes=scopes, quota_project_id=quota_project_id)
- 55 return credentials
- 56 elif HAS_OAUTH2CLIENT:
- 57 if scopes is not None or quota_project_id is not None:
- 58 raise EnvironmentError(
- 59 "client_options.scopes and client_options.quota_project_id are not supported in oauth2client."
- 60 "Please install google-auth."
- 61 )
- 62 return oauth2client.client.GoogleCredentials.get_application_default()
- 63 else:
- 64 raise EnvironmentError(
- 65 "No authentication library is available. Please install either "
- 66 "google-auth or oauth2client."
- 67 )
- 68
- 69
- 71 """Scopes the credentials if necessary.
- 72
- 73 Args:
- 74 credentials (Union[
- 75 google.auth.credentials.Credentials,
- 76 oauth2client.client.Credentials]): The credentials to scope.
- 77 scopes (Sequence[str]): The list of scopes.
- 78
- 79 Returns:
- 80 Union[google.auth.credentials.Credentials,
- 81 oauth2client.client.Credentials]: The scoped credentials.
- 82 """
- 83 if HAS_GOOGLE_AUTH and isinstance(credentials, google.auth.credentials.Credentials):
- 84 return google.auth.credentials.with_scopes_if_required(credentials, scopes)
- 85 else:
- 86 try:
- 87 if credentials.create_scoped_required():
- 88 return credentials.create_scoped(scopes)
- 89 else:
- 90 return credentials
- 91 except AttributeError:
- 92 return credentials
- 93
- 94
-120
-121
-123 # Refresh must use a new http instance, as the one associated with the
-124 # credentials could be a AuthorizedHttp or an oauth2client-decorated
-125 # Http instance which would cause a weird recursive loop of refreshing
-126 # and likely tear a hole in spacetime.
-127 refresh_http = httplib2.Http()
-128 if HAS_GOOGLE_AUTH and isinstance(credentials, google.auth.credentials.Credentials):
-129 request = google_auth_httplib2.Request(refresh_http)
-130 return credentials.refresh(request)
-131 else:
-132 return credentials.refresh(refresh_http)
-133
-134
-136 # oauth2client and google-auth have the same interface for this.
-137 if not is_valid(credentials):
-138 refresh_credentials(credentials)
-139 return credentials.apply(headers)
-140
-141
-143 if HAS_GOOGLE_AUTH and isinstance(credentials, google.auth.credentials.Credentials):
-144 return credentials.valid
-145 else:
-146 return (
-147 credentials.access_token is not None
-148 and not credentials.access_token_expired
-149 )
-150
-151
-153 if http is None:
-154 return None
-155 elif hasattr(http.request, "credentials"):
-156 return http.request.credentials
-157 elif hasattr(http, "credentials") and not isinstance(
-158 http.credentials, httplib2.Credentials
-159 ):
-160 return http.credentials
-161 else:
-162 return None
-163
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient._helpers-module.html b/docs/epy/googleapiclient._helpers-module.html
deleted file mode 100644
index bd1a42b0241..00000000000
--- a/docs/epy/googleapiclient._helpers-module.html
+++ /dev/null
@@ -1,531 +0,0 @@
-
-
-
-
- googleapiclient._helpers
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module _helpers
-Helper functions for commonly used utilities.
-
-
-
-
-
-
-
-
- Functions
-
-
-
-
-
-
-
-
-
-
- positional(max_positional_args)
- A decorator to declare that only the first N arguments may be positional.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- parse_unique_urlencoded(content)
- Parses unique key-value parameters from urlencoded content.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- update_query_params(uri,
- params)
- Updates a URI with new query parameters.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _add_query_parameter(url,
- name,
- value)
- Adds a query parameter to a url.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Variables
-
-
-
-
-
-
-
-
- logger = logging.getLogger(__name__)
-
-
-
-
-
-
- POSITIONAL_WARNING = 'WARNING'
-
-
-
-
-
- POSITIONAL_EXCEPTION = 'EXCEPTION'
-
-
-
-
-
- POSITIONAL_IGNORE = 'IGNORE'
-
-
-
-
-
- POSITIONAL_SET = frozenset(['EXCEPTION', 'IGNORE', 'WARNING'])
-
-
-
-
-
- positional_parameters_enforcement = 'WARNING'
-
-
-
-
-
- _SYM_LINK_MESSAGE = 'File: {0}: Is a symbolic link.'
-
-
-
-
-
- _IS_DIR_MESSAGE = '{0}: Is a directory'
-
-
-
-
-
- _MISSING_FILE_MESSAGE = 'Cannot access {0}: No such file or di...
-
-
-
-
-
- __package__ = 'googleapiclient'
-
-
-
-
-
-
-
-
-
- Function Details
-
-
-
-
-
-
-
-
-
-
-
- positional(max_positional_args)
-
- source code
-
-
-
-
-A decorator to declare that only the first N arguments may be positional.
-
-This decorator makes it easy to support Python 3 style keyword-only
-parameters. For example, in Python 3 it is possible to write::
-
- def fn(pos1, *, kwonly1=None, kwonly1=None):
- ...
-
-All named parameters after ``*`` must be a keyword::
-
- fn(10, 'kw1', 'kw2') # Raises exception.
- fn(10, kwonly1='kw1') # Ok.
-
-Example
-^^^^^^^
-
-To define a function like above, do::
-
- @positional(1)
- def fn(pos1, kwonly1=None, kwonly2=None):
- ...
-
-If no default value is provided to a keyword argument, it becomes a
-required keyword argument::
-
- @positional(0)
- def fn(required_kw):
- ...
-
-This must be called with the keyword parameter::
-
- fn() # Raises exception.
- fn(10) # Raises exception.
- fn(required_kw=10) # Ok.
-
-When defining instance or class methods always remember to account for
-``self`` and ``cls``::
-
- class MyClass(object):
-
- @positional(2)
- def my_method(self, pos1, kwonly1=None):
- ...
-
- @classmethod
- @positional(2)
- def my_method(cls, pos1, kwonly1=None):
- ...
-
-The positional decorator behavior is controlled by
-``_helpers.positional_parameters_enforcement``, which may be set to
-``POSITIONAL_EXCEPTION``, ``POSITIONAL_WARNING`` or
-``POSITIONAL_IGNORE`` to raise an exception, log a warning, or do
-nothing, respectively, if a declaration is violated.
-
-Args:
- max_positional_arguments: Maximum number of positional arguments. All
- parameters after the this index must be
- keyword only.
-
-Returns:
- A decorator that prevents using arguments after max_positional_args
- from being used as positional parameters.
-
-Raises:
- TypeError: if a key-word only argument is provided as a positional
- parameter, but only if
- _helpers.positional_parameters_enforcement is set to
- POSITIONAL_EXCEPTION.
-
-
-
-
-
-
-
-
-
-
-
-
- parse_unique_urlencoded(content)
-
- source code
-
-
-
-
-Parses unique key-value parameters from urlencoded content.
-
-Args:
- content: string, URL-encoded key-value pairs.
-
-Returns:
- dict, The key-value pairs from ``content``.
-
-Raises:
- ValueError: if one of the keys is repeated.
-
-
-
-
-
-
-
-
-
-
-
-
- update_query_params(uri,
- params)
-
- source code
-
-
-
-
-Updates a URI with new query parameters.
-
-If a given key from ``params`` is repeated in the ``uri``, then
-the URI will be considered invalid and an error will occur.
-
-If the URI is valid, then each value from ``params`` will
-replace the corresponding value in the query parameters (if
-it exists).
-
-Args:
- uri: string, A valid URI, with potential existing query parameters.
- params: dict, A dictionary of query parameters.
-
-Returns:
- The same URI but with the new query parameters added.
-
-
-
-
-
-
-
-
-
-
-
-
- _add_query_parameter(url,
- name,
- value)
-
- source code
-
-
-
-
-Adds a query parameter to a url.
-
-Replaces the current value if it already exists in the URL.
-
-Args:
- url: string, url to add the query parameter to.
- name: string, query parameter name.
- value: string, query parameter value.
-
-Returns:
- Updated query parameter. Does not update the url if value is None.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Variables Details
-
-
-
-
-
-
-
-
-
- _MISSING_FILE_MESSAGE
-
-
-
-
- - Value:
-
-'Cannot access {0}: No such file or directory'
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient._helpers-pysrc.html b/docs/epy/googleapiclient._helpers-pysrc.html
deleted file mode 100644
index 8110814a8b8..00000000000
--- a/docs/epy/googleapiclient._helpers-pysrc.html
+++ /dev/null
@@ -1,324 +0,0 @@
-
-
-
-
- googleapiclient._helpers
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Source Code for Module googleapiclient._helpers
-
- 1 # Copyright 2015 Google Inc. All rights reserved.
- 2 #
- 3 # Licensed under the Apache License, Version 2.0 (the "License");
- 4 # you may not use this file except in compliance with the License.
- 5 # You may obtain a copy of the License at
- 6 #
- 7 # http://www.apache.org/licenses/LICENSE-2.0
- 8 #
- 9 # Unless required by applicable law or agreed to in writing, software
- 10 # distributed under the License is distributed on an "AS IS" BASIS,
- 11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- 12 # See the License for the specific language governing permissions and
- 13 # limitations under the License.
- 14
- 15 """Helper functions for commonly used utilities."""
- 16
- 17 import functools
- 18 import inspect
- 19 import logging
- 20 import warnings
- 21
- 22 import six
- 23 from six.moves import urllib
- 24
- 25
- 26 logger = logging.getLogger(__name__)
- 27
- 28 POSITIONAL_WARNING = "WARNING"
- 29 POSITIONAL_EXCEPTION = "EXCEPTION"
- 30 POSITIONAL_IGNORE = "IGNORE"
- 31 POSITIONAL_SET = frozenset(
- 32 [POSITIONAL_WARNING, POSITIONAL_EXCEPTION, POSITIONAL_IGNORE]
- 33 )
- 34
- 35 positional_parameters_enforcement = POSITIONAL_WARNING
- 36
- 37 _SYM_LINK_MESSAGE = "File: {0}: Is a symbolic link."
- 38 _IS_DIR_MESSAGE = "{0}: Is a directory"
- 39 _MISSING_FILE_MESSAGE = "Cannot access {0}: No such file or directory"
- 43 """A decorator to declare that only the first N arguments may be positional.
- 44
- 45 This decorator makes it easy to support Python 3 style keyword-only
- 46 parameters. For example, in Python 3 it is possible to write::
- 47
- 48 def fn(pos1, *, kwonly1=None, kwonly1=None):
- 49 ...
- 50
- 51 All named parameters after ``*`` must be a keyword::
- 52
- 53 fn(10, 'kw1', 'kw2') # Raises exception.
- 54 fn(10, kwonly1='kw1') # Ok.
- 55
- 56 Example
- 57 ^^^^^^^
- 58
- 59 To define a function like above, do::
- 60
- 61 @positional(1)
- 62 def fn(pos1, kwonly1=None, kwonly2=None):
- 63 ...
- 64
- 65 If no default value is provided to a keyword argument, it becomes a
- 66 required keyword argument::
- 67
- 68 @positional(0)
- 69 def fn(required_kw):
- 70 ...
- 71
- 72 This must be called with the keyword parameter::
- 73
- 74 fn() # Raises exception.
- 75 fn(10) # Raises exception.
- 76 fn(required_kw=10) # Ok.
- 77
- 78 When defining instance or class methods always remember to account for
- 79 ``self`` and ``cls``::
- 80
- 81 class MyClass(object):
- 82
- 83 @positional(2)
- 84 def my_method(self, pos1, kwonly1=None):
- 85 ...
- 86
- 87 @classmethod
- 88 @positional(2)
- 89 def my_method(cls, pos1, kwonly1=None):
- 90 ...
- 91
- 92 The positional decorator behavior is controlled by
- 93 ``_helpers.positional_parameters_enforcement``, which may be set to
- 94 ``POSITIONAL_EXCEPTION``, ``POSITIONAL_WARNING`` or
- 95 ``POSITIONAL_IGNORE`` to raise an exception, log a warning, or do
- 96 nothing, respectively, if a declaration is violated.
- 97
- 98 Args:
- 99 max_positional_arguments: Maximum number of positional arguments. All
-100 parameters after the this index must be
-101 keyword only.
-102
-103 Returns:
-104 A decorator that prevents using arguments after max_positional_args
-105 from being used as positional parameters.
-106
-107 Raises:
-108 TypeError: if a key-word only argument is provided as a positional
-109 parameter, but only if
-110 _helpers.positional_parameters_enforcement is set to
-111 POSITIONAL_EXCEPTION.
-112 """
-113
-114 def positional_decorator(wrapped):
-115 @functools.wraps(wrapped)
-116 def positional_wrapper(*args, **kwargs):
-117 if len(args) > max_positional_args:
-118 plural_s = ""
-119 if max_positional_args != 1:
-120 plural_s = "s"
-121 message = (
-122 "{function}() takes at most {args_max} positional "
-123 "argument{plural} ({args_given} given)".format(
-124 function=wrapped.__name__,
-125 args_max=max_positional_args,
-126 args_given=len(args),
-127 plural=plural_s,
-128 )
-129 )
-130 if positional_parameters_enforcement == POSITIONAL_EXCEPTION:
-131 raise TypeError(message)
-132 elif positional_parameters_enforcement == POSITIONAL_WARNING:
-133 logger.warning(message)
-134 return wrapped(*args, **kwargs)
-135
-136 return positional_wrapper
-137
-138 if isinstance(max_positional_args, six.integer_types):
-139 return positional_decorator
-140 else:
-141 args, _, _, defaults = inspect.getargspec(max_positional_args)
-142 return positional(len(args) - len(defaults))(max_positional_args)
-143
-146 """Parses unique key-value parameters from urlencoded content.
-147
-148 Args:
-149 content: string, URL-encoded key-value pairs.
-150
-151 Returns:
-152 dict, The key-value pairs from ``content``.
-153
-154 Raises:
-155 ValueError: if one of the keys is repeated.
-156 """
-157 urlencoded_params = urllib.parse.parse_qs(content)
-158 params = {}
-159 for key, value in six.iteritems(urlencoded_params):
-160 if len(value) != 1:
-161 msg = "URL-encoded content contains a repeated value:" "%s -> %s" % (
-162 key,
-163 ", ".join(value),
-164 )
-165 raise ValueError(msg)
-166 params[key] = value[0]
-167 return params
-168
-171 """Updates a URI with new query parameters.
-172
-173 If a given key from ``params`` is repeated in the ``uri``, then
-174 the URI will be considered invalid and an error will occur.
-175
-176 If the URI is valid, then each value from ``params`` will
-177 replace the corresponding value in the query parameters (if
-178 it exists).
-179
-180 Args:
-181 uri: string, A valid URI, with potential existing query parameters.
-182 params: dict, A dictionary of query parameters.
-183
-184 Returns:
-185 The same URI but with the new query parameters added.
-186 """
-187 parts = urllib.parse.urlparse(uri)
-188 query_params = parse_unique_urlencoded(parts.query)
-189 query_params.update(params)
-190 new_query = urllib.parse.urlencode(query_params)
-191 new_parts = parts._replace(query=new_query)
-192 return urllib.parse.urlunparse(new_parts)
-193
-196 """Adds a query parameter to a url.
-197
-198 Replaces the current value if it already exists in the URL.
-199
-200 Args:
-201 url: string, url to add the query parameter to.
-202 name: string, query parameter name.
-203 value: string, query parameter value.
-204
-205 Returns:
-206 Updated query parameter. Does not update the url if value is None.
-207 """
-208 if value is None:
-209 return url
-210 else:
-211 return update_query_params(url, {name: value})
-212
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.channel-module.html b/docs/epy/googleapiclient.channel-module.html
deleted file mode 100644
index cc6b3c7f18d..00000000000
--- a/docs/epy/googleapiclient.channel-module.html
+++ /dev/null
@@ -1,490 +0,0 @@
-
-
-
-
- googleapiclient.channel
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module channel
-
-Channel notifications support.
-
-Classes and functions to support channel subscriptions and notifications
-on those channels.
-
-Notes:
- - This code is based on experimental APIs and is subject to change.
- - Notification does not do deduplication of notification ids, that's up to
- the receiver.
- - Storing the Channel between calls is up to the caller.
-
-
-Example setting up a channel:
-
- # Create a new channel that gets notifications via webhook.
- channel = new_webhook_channel("https://example.com/my_web_hook")
-
- # Store the channel, keyed by 'channel.id'. Store it before calling the
- # watch method because notifications may start arriving before the watch
- # method returns.
- ...
-
- resp = service.objects().watchAll(
- bucket="some_bucket_id", body=channel.body()).execute()
- channel.update(resp)
-
- # Store the channel, keyed by 'channel.id'. Store it after being updated
- # since the resource_id value will now be correct, and that's needed to
- # stop a subscription.
- ...
-
-
-An example Webhook implementation using webapp2. Note that webapp2 puts
-headers in a case insensitive dictionary, as headers aren't guaranteed to
-always be upper case.
-
- id = self.request.headers[X_GOOG_CHANNEL_ID]
-
- # Retrieve the channel by id.
- channel = ...
-
- # Parse notification from the headers, including validating the id.
- n = notification_from_headers(channel, self.request.headers)
-
- # Do app specific stuff with the notification here.
- if n.resource_state == 'sync':
- # Code to handle sync state.
- elif n.resource_state == 'exists':
- # Code to handle the exists state.
- elif n.resource_state == 'not_exists':
- # Code to handle the not exists state.
-
-
-Example of unsubscribing.
-
- service.channels().stop(channel.body()).execute()
-
-
-
-
-
-
-
-
-
-
- Classes
-
-
-
-
-
-
-
-
- Notification
- A Notification from a Channel.
-
-
-
-
-
-
- Channel
- A Channel for notifications.
-
-
-
-
-
-
-
-
-
-
- Functions
-
-
-
-
-
-
-
-
-
-
- _upper_header_keys(headers)
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- notification_from_headers(channel,
- headers)
- Parse a notification from the webhook request headers, validate
- the notification, and return a Notification object.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- new_webhook_channel(*args,
- **kwargs)
- Create a new webhook Channel.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Variables
-
-
-
-
-
-
-
-
- EPOCH = datetime.datetime(1970, 1, 1, 0, 0)
-
-
-
-
-
-
- CHANNEL_PARAMS = {'address': 'address', 'expiration': 'expirat...
-
-
-
-
-
- X_GOOG_CHANNEL_ID = 'X-GOOG-CHANNEL-ID'
-
-
-
-
-
- X_GOOG_MESSAGE_NUMBER = 'X-GOOG-MESSAGE-NUMBER'
-
-
-
-
-
- X_GOOG_RESOURCE_STATE = 'X-GOOG-RESOURCE-STATE'
-
-
-
-
-
- X_GOOG_RESOURCE_URI = 'X-GOOG-RESOURCE-URI'
-
-
-
-
-
- X_GOOG_RESOURCE_ID = 'X-GOOG-RESOURCE-ID'
-
-
-
-
-
- __package__ = None
-
-
-
-
-
-
-
-
-
-
- Function Details
-
-
-
-
-
-
-
-
-
-
-
- notification_from_headers(channel,
- headers)
-
- source code
-
-
-
-
-Parse a notification from the webhook request headers, validate
- the notification, and return a Notification object.
-
-Args:
- channel: Channel, The channel that the notification is associated with.
- headers: dict, A dictionary like object that contains the request headers
- from the webhook HTTP request.
-
-Returns:
- A Notification object.
-
-Raises:
- errors.InvalidNotificationError if the notification is invalid.
- ValueError if the X-GOOG-MESSAGE-NUMBER can't be converted to an int.
-
-
-
-
-
-
-
-
-
-
-
-
- new_webhook_channel(*args,
- **kwargs)
-
- source code
-
-
-
-
-Create a new webhook Channel.
-
-Args:
- url: str, URL to post notifications to.
- token: str, An arbitrary string associated with the channel that
- is delivered to the target address with each notification delivered
- over this channel.
- expiration: datetime.datetime, A time in the future when the channel
- should expire. Can also be None if the subscription should use the
- default expiration. Note that different services may have different
- limits on how long a subscription lasts. Check the response from the
- watch() method to see the value the service has set for an expiration
- time.
- params: dict, Extra parameters to pass on channel creation. Currently
- not used for webhook channels.
-
-
-
- - Decorators:
-
- @util.positional(2)
-
-
-
-
-
-
-
-
-
-
- Variables Details
-
-
-
-
-
-
-
-
-
- CHANNEL_PARAMS
-
-
-
-
- - Value:
-
-{'address': 'address',
- 'expiration': 'expiration',
- 'id': 'id',
- 'params': 'params',
- 'resourceId': 'resource_id',
- 'resourceUri': 'resource_uri',
- 'token': 'token',
- 'type': 'type'}
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.channel-pysrc.html b/docs/epy/googleapiclient.channel-pysrc.html
deleted file mode 100644
index 16b07df5cb2..00000000000
--- a/docs/epy/googleapiclient.channel-pysrc.html
+++ /dev/null
@@ -1,433 +0,0 @@
-
-
-
-
- googleapiclient.channel
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Source Code for Module googleapiclient.channel
-
- 1 # Copyright 2014 Google Inc. All Rights Reserved.
- 2 #
- 3 # Licensed under the Apache License, Version 2.0 (the "License");
- 4 # you may not use this file except in compliance with the License.
- 5 # You may obtain a copy of the License at
- 6 #
- 7 # http://www.apache.org/licenses/LICENSE-2.0
- 8 #
- 9 # Unless required by applicable law or agreed to in writing, software
- 10 # distributed under the License is distributed on an "AS IS" BASIS,
- 11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- 12 # See the License for the specific language governing permissions and
- 13 # limitations under the License.
- 14
- 15 """Channel notifications support.
- 16
- 17 Classes and functions to support channel subscriptions and notifications
- 18 on those channels.
- 19
- 20 Notes:
- 21 - This code is based on experimental APIs and is subject to change.
- 22 - Notification does not do deduplication of notification ids, that's up to
- 23 the receiver.
- 24 - Storing the Channel between calls is up to the caller.
- 25
- 26
- 27 Example setting up a channel:
- 28
- 29 # Create a new channel that gets notifications via webhook.
- 30 channel = new_webhook_channel("https://example.com/my_web_hook")
- 31
- 32 # Store the channel, keyed by 'channel.id'. Store it before calling the
- 33 # watch method because notifications may start arriving before the watch
- 34 # method returns.
- 35 ...
- 36
- 37 resp = service.objects().watchAll(
- 38 bucket="some_bucket_id", body=channel.body()).execute()
- 39 channel.update(resp)
- 40
- 41 # Store the channel, keyed by 'channel.id'. Store it after being updated
- 42 # since the resource_id value will now be correct, and that's needed to
- 43 # stop a subscription.
- 44 ...
- 45
- 46
- 47 An example Webhook implementation using webapp2. Note that webapp2 puts
- 48 headers in a case insensitive dictionary, as headers aren't guaranteed to
- 49 always be upper case.
- 50
- 51 id = self.request.headers[X_GOOG_CHANNEL_ID]
- 52
- 53 # Retrieve the channel by id.
- 54 channel = ...
- 55
- 56 # Parse notification from the headers, including validating the id.
- 57 n = notification_from_headers(channel, self.request.headers)
- 58
- 59 # Do app specific stuff with the notification here.
- 60 if n.resource_state == 'sync':
- 61 # Code to handle sync state.
- 62 elif n.resource_state == 'exists':
- 63 # Code to handle the exists state.
- 64 elif n.resource_state == 'not_exists':
- 65 # Code to handle the not exists state.
- 66
- 67
- 68 Example of unsubscribing.
- 69
- 70 service.channels().stop(channel.body()).execute()
- 71 """
- 72 from __future__ import absolute_import
- 73
- 74 import datetime
- 75 import uuid
- 76
- 77 from googleapiclient import errors
- 78 from googleapiclient import _helpers as util
- 79 import six
- 80
- 81
- 82 # The unix time epoch starts at midnight 1970.
- 83 EPOCH = datetime.datetime.utcfromtimestamp(0)
- 84
- 85 # Map the names of the parameters in the JSON channel description to
- 86 # the parameter names we use in the Channel class.
- 87 CHANNEL_PARAMS = {
- 88 "address": "address",
- 89 "id": "id",
- 90 "expiration": "expiration",
- 91 "params": "params",
- 92 "resourceId": "resource_id",
- 93 "resourceUri": "resource_uri",
- 94 "type": "type",
- 95 "token": "token",
- 96 }
- 97
- 98 X_GOOG_CHANNEL_ID = "X-GOOG-CHANNEL-ID"
- 99 X_GOOG_MESSAGE_NUMBER = "X-GOOG-MESSAGE-NUMBER"
-100 X_GOOG_RESOURCE_STATE = "X-GOOG-RESOURCE-STATE"
-101 X_GOOG_RESOURCE_URI = "X-GOOG-RESOURCE-URI"
-102 X_GOOG_RESOURCE_ID = "X-GOOG-RESOURCE-ID"
-106 new_headers = {}
-107 for k, v in six.iteritems(headers):
-108 new_headers[k.upper()] = v
-109 return new_headers
-110
-113 """A Notification from a Channel.
-114
-115 Notifications are not usually constructed directly, but are returned
-116 from functions like notification_from_headers().
-117
-118 Attributes:
-119 message_number: int, The unique id number of this notification.
-120 state: str, The state of the resource being monitored.
-121 uri: str, The address of the resource being monitored.
-122 resource_id: str, The unique identifier of the version of the resource at
-123 this event.
-124 """
-125
-126 @util.positional(5)
-128 """Notification constructor.
-129
-130 Args:
-131 message_number: int, The unique id number of this notification.
-132 state: str, The state of the resource being monitored. Can be one
-133 of "exists", "not_exists", or "sync".
-134 resource_uri: str, The address of the resource being monitored.
-135 resource_id: str, The identifier of the watched resource.
-136 """
-137 self.message_number = message_number
-138 self.state = state
-139 self.resource_uri = resource_uri
-140 self.resource_id = resource_id
-141
-144 """A Channel for notifications.
-145
-146 Usually not constructed directly, instead it is returned from helper
-147 functions like new_webhook_channel().
-148
-149 Attributes:
-150 type: str, The type of delivery mechanism used by this channel. For
-151 example, 'web_hook'.
-152 id: str, A UUID for the channel.
-153 token: str, An arbitrary string associated with the channel that
-154 is delivered to the target address with each event delivered
-155 over this channel.
-156 address: str, The address of the receiving entity where events are
-157 delivered. Specific to the channel type.
-158 expiration: int, The time, in milliseconds from the epoch, when this
-159 channel will expire.
-160 params: dict, A dictionary of string to string, with additional parameters
-161 controlling delivery channel behavior.
-162 resource_id: str, An opaque id that identifies the resource that is
-163 being watched. Stable across different API versions.
-164 resource_uri: str, The canonicalized ID of the watched resource.
-165 """
-166
-167 @util.positional(5)
-168 - def __init__(
-169 self,
-170 type,
-171 id,
-172 token,
-173 address,
-174 expiration=None,
-175 params=None,
-176 resource_id="",
-177 resource_uri="",
-178 ):
-179 """Create a new Channel.
-180
-181 In user code, this Channel constructor will not typically be called
-182 manually since there are functions for creating channels for each specific
-183 type with a more customized set of arguments to pass.
-184
-185 Args:
-186 type: str, The type of delivery mechanism used by this channel. For
-187 example, 'web_hook'.
-188 id: str, A UUID for the channel.
-189 token: str, An arbitrary string associated with the channel that
-190 is delivered to the target address with each event delivered
-191 over this channel.
-192 address: str, The address of the receiving entity where events are
-193 delivered. Specific to the channel type.
-194 expiration: int, The time, in milliseconds from the epoch, when this
-195 channel will expire.
-196 params: dict, A dictionary of string to string, with additional parameters
-197 controlling delivery channel behavior.
-198 resource_id: str, An opaque id that identifies the resource that is
-199 being watched. Stable across different API versions.
-200 resource_uri: str, The canonicalized ID of the watched resource.
-201 """
-202 self.type = type
-203 self.id = id
-204 self.token = token
-205 self.address = address
-206 self.expiration = expiration
-207 self.params = params
-208 self.resource_id = resource_id
-209 self.resource_uri = resource_uri
-210
-212 """Build a body from the Channel.
-213
-214 Constructs a dictionary that's appropriate for passing into watch()
-215 methods as the value of body argument.
-216
-217 Returns:
-218 A dictionary representation of the channel.
-219 """
-220 result = {
-221 "id": self.id,
-222 "token": self.token,
-223 "type": self.type,
-224 "address": self.address,
-225 }
-226 if self.params:
-227 result["params"] = self.params
-228 if self.resource_id:
-229 result["resourceId"] = self.resource_id
-230 if self.resource_uri:
-231 result["resourceUri"] = self.resource_uri
-232 if self.expiration:
-233 result["expiration"] = self.expiration
-234
-235 return result
-236
-238 """Update a channel with information from the response of watch().
-239
-240 When a request is sent to watch() a resource, the response returned
-241 from the watch() request is a dictionary with updated channel information,
-242 such as the resource_id, which is needed when stopping a subscription.
-243
-244 Args:
-245 resp: dict, The response from a watch() method.
-246 """
-247 for json_name, param_name in six.iteritems(CHANNEL_PARAMS):
-248 value = resp.get(json_name)
-249 if value is not None:
-250 setattr(self, param_name, value)
-251
-254 """Parse a notification from the webhook request headers, validate
-255 the notification, and return a Notification object.
-256
-257 Args:
-258 channel: Channel, The channel that the notification is associated with.
-259 headers: dict, A dictionary like object that contains the request headers
-260 from the webhook HTTP request.
-261
-262 Returns:
-263 A Notification object.
-264
-265 Raises:
-266 errors.InvalidNotificationError if the notification is invalid.
-267 ValueError if the X-GOOG-MESSAGE-NUMBER can't be converted to an int.
-268 """
-269 headers = _upper_header_keys(headers)
-270 channel_id = headers[X_GOOG_CHANNEL_ID]
-271 if channel.id != channel_id:
-272 raise errors.InvalidNotificationError(
-273 "Channel id mismatch: %s != %s" % (channel.id, channel_id)
-274 )
-275 else:
-276 message_number = int(headers[X_GOOG_MESSAGE_NUMBER])
-277 state = headers[X_GOOG_RESOURCE_STATE]
-278 resource_uri = headers[X_GOOG_RESOURCE_URI]
-279 resource_id = headers[X_GOOG_RESOURCE_ID]
-280 return Notification(message_number, state, resource_uri, resource_id)
-281
-282
-283 @util.positional(2)
-284 -def new_webhook_channel(url, token=None, expiration=None, params=None):
-285 """Create a new webhook Channel.
-286
-287 Args:
-288 url: str, URL to post notifications to.
-289 token: str, An arbitrary string associated with the channel that
-290 is delivered to the target address with each notification delivered
-291 over this channel.
-292 expiration: datetime.datetime, A time in the future when the channel
-293 should expire. Can also be None if the subscription should use the
-294 default expiration. Note that different services may have different
-295 limits on how long a subscription lasts. Check the response from the
-296 watch() method to see the value the service has set for an expiration
-297 time.
-298 params: dict, Extra parameters to pass on channel creation. Currently
-299 not used for webhook channels.
-300 """
-301 expiration_ms = 0
-302 if expiration:
-303 delta = expiration - EPOCH
-304 expiration_ms = (
-305 delta.microseconds / 1000 + (delta.seconds + delta.days * 24 * 3600) * 1000
-306 )
-307 if expiration_ms < 0:
-308 expiration_ms = 0
-309
-310 return Channel(
-311 "web_hook",
-312 str(uuid.uuid4()),
-313 token,
-314 url,
-315 expiration=expiration_ms,
-316 params=params,
-317 )
-318
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.channel.Channel-class.html b/docs/epy/googleapiclient.channel.Channel-class.html
deleted file mode 100644
index 5a15b5369f3..00000000000
--- a/docs/epy/googleapiclient.channel.Channel-class.html
+++ /dev/null
@@ -1,380 +0,0 @@
-
-
-
-
- googleapiclient.channel.Channel
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class Channel
-
-object --+
- |
- Channel
-
-
-
-
-A Channel for notifications.
-
-Usually not constructed directly, instead it is returned from helper
-functions like new_webhook_channel().
-
-Attributes:
- type: str, The type of delivery mechanism used by this channel. For
- example, 'web_hook'.
- id: str, A UUID for the channel.
- token: str, An arbitrary string associated with the channel that
- is delivered to the target address with each event delivered
- over this channel.
- address: str, The address of the receiving entity where events are
- delivered. Specific to the channel type.
- expiration: int, The time, in milliseconds from the epoch, when this
- channel will expire.
- params: dict, A dictionary of string to string, with additional parameters
- controlling delivery channel behavior.
- resource_id: str, An opaque id that identifies the resource that is
- being watched. Stable across different API versions.
- resource_uri: str, The canonicalized ID of the watched resource.
-
-
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
- Create a new Channel.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- body(self)
- Build a body from the Channel.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- update(self,
- resp)
- Update a channel with information from the response of watch().
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
-
(Constructor)
-
- source code
-
-
-
-
-Create a new Channel.
-
-In user code, this Channel constructor will not typically be called
-manually since there are functions for creating channels for each specific
-type with a more customized set of arguments to pass.
-
-Args:
- type: str, The type of delivery mechanism used by this channel. For
- example, 'web_hook'.
- id: str, A UUID for the channel.
- token: str, An arbitrary string associated with the channel that
- is delivered to the target address with each event delivered
- over this channel.
- address: str, The address of the receiving entity where events are
- delivered. Specific to the channel type.
- expiration: int, The time, in milliseconds from the epoch, when this
- channel will expire.
- params: dict, A dictionary of string to string, with additional parameters
- controlling delivery channel behavior.
- resource_id: str, An opaque id that identifies the resource that is
- being watched. Stable across different API versions.
- resource_uri: str, The canonicalized ID of the watched resource.
-
-
-
- - Decorators:
-
- @util.positional(5)
- Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
-
- body(self)
-
- source code
-
-
-
-
-Build a body from the Channel.
-
-Constructs a dictionary that's appropriate for passing into watch()
-methods as the value of body argument.
-
-Returns:
- A dictionary representation of the channel.
-
-
-
-
-
-
-
-
-
-
-
-
- update(self,
- resp)
-
- source code
-
-
-
-
-Update a channel with information from the response of watch().
-
-When a request is sent to watch() a resource, the response returned
-from the watch() request is a dictionary with updated channel information,
-such as the resource_id, which is needed when stopping a subscription.
-
-Args:
- resp: dict, The response from a watch() method.
-
-
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.channel.Notification-class.html b/docs/epy/googleapiclient.channel.Notification-class.html
deleted file mode 100644
index 2960e086f3b..00000000000
--- a/docs/epy/googleapiclient.channel.Notification-class.html
+++ /dev/null
@@ -1,263 +0,0 @@
-
-
-
-
- googleapiclient.channel.Notification
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class Notification
-
-object --+
- |
- Notification
-
-
-
-
-A Notification from a Channel.
-
-Notifications are not usually constructed directly, but are returned
-from functions like notification_from_headers().
-
-Attributes:
- message_number: int, The unique id number of this notification.
- state: str, The state of the resource being monitored.
- uri: str, The address of the resource being monitored.
- resource_id: str, The unique identifier of the version of the resource at
- this event.
-
-
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
- Notification constructor.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
-
(Constructor)
-
- source code
-
-
-
-
-Notification constructor.
-
-Args:
- message_number: int, The unique id number of this notification.
- state: str, The state of the resource being monitored. Can be one
- of "exists", "not_exists", or "sync".
- resource_uri: str, The address of the resource being monitored.
- resource_id: str, The identifier of the watched resource.
-
-
-
- - Decorators:
-
- @util.positional(5)
- Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.discovery-module.html b/docs/epy/googleapiclient.discovery-module.html
deleted file mode 100644
index ecf85168715..00000000000
--- a/docs/epy/googleapiclient.discovery-module.html
+++ /dev/null
@@ -1,1564 +0,0 @@
-
-
-
-
- googleapiclient.discovery
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module discovery
-Client for discovery based APIs.
- A client library for Google's discovery based APIs.
-
-
- Author:
- jcgregorio@google.com (Joe Gregorio)
-
-
-
-
-
-
-
-
- Classes
-
-
-
-
-
-
-
-
- _BytesGenerator
-
-
-
-
-
-
- ResourceMethodParameters
- Represents the parameters associated with a method.
-
-
-
-
-
-
- Resource
- A class for interacting with a resource.
-
-
-
-
-
-
-
-
-
-
- Functions
-
-
-
-
-
-
-
-
-
-
- fix_method_name(name)
- Fix method names to avoid '$' characters and reserved word conflicts.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- key2param(key)
- Converts key names into parameter names.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- build(serviceName,
- version,
- http=None,
- discoveryServiceUrl=DISCOVERY_URI,
- developerKey=None,
- model=None,
- requestBuilder=HttpRequest,
- credentials=None,
- cache_discovery=True,
- cache=None,
- client_options=None,
- adc_cert_path=None,
- adc_key_path=None,
- num_retries=1)
- Construct a Resource for interacting with an API.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _discovery_service_uri_options(discoveryServiceUrl,
- version)
- Returns Discovery URIs to be used for attemnting to build the API Resource.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _retrieve_discovery_doc(url,
- http,
- cache_discovery,
- cache=None,
- developerKey=None,
- num_retries=1)
- Retrieves the discovery_doc from cache or the internet.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- build_from_document(service,
- base=None,
- future=None,
- http=None,
- developerKey=None,
- model=None,
- requestBuilder=HttpRequest,
- credentials=None,
- client_options=None,
- adc_cert_path=None,
- adc_key_path=None)
- Create a Resource for interacting with an API.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _cast(value,
- schema_type)
- Convert value to a string based on JSON Schema type.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _media_size_to_long(maxSize)
- Convert a string media size, such as 10GB or 3TB into an integer.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _media_path_url_from_info(root_desc,
- path_url)
- Creates an absolute media path URL.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _fix_up_parameters(method_desc,
- root_desc,
- http_method,
- schema)
- Updates parameters of an API method with values specific to this library.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _fix_up_media_upload(method_desc,
- root_desc,
- path_url,
- parameters)
- Adds 'media_body' and 'media_mime_type' parameters if supported by method.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _fix_up_method_description(method_desc,
- root_desc,
- schema)
- Updates a method description in a discovery document.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _urljoin(base,
- url)
- Custom urljoin replacement supporting : before / in url.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- createMethod(methodName,
- methodDesc,
- rootDesc,
- schema)
- Creates a method for attaching to a Resource.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- createNextMethod(methodName,
- pageTokenName="pageToken",
- nextPageTokenName="nextPageToken",
- isPageTokenParameter=True)
- Creates any _next methods for attaching to a Resource.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _findPageTokenName(fields)
- Search field names for one like a page token.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _methodProperties(methodDesc,
- schema,
- name)
- Get properties of a field in a method description.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Variables
-
-
-
-
-
-
-
-
- google_auth_httplib2 = None
-
-
-
-
-
-
- logger = logging.getLogger(__name__)
-
-
-
-
-
-
- URITEMPLATE = re.compile("{[^}]*}")
-
-
-
-
-
-
- VARNAME = re.compile("[a-zA-Z0-9_-]+")
-
-
-
-
-
-
- DISCOVERY_URI = "https://www.googleapis.com/discovery/v1/apis/...
-
-
-
-
-
-
- V1_DISCOVERY_URI = "https://www.googleapis.com/discovery/v1/ap...
-
-
-
-
-
-
- V2_DISCOVERY_URI = "https://{api}.googleapis.com/$discovery/re...
-
-
-
-
-
-
- DEFAULT_METHOD_DOC = "A description of how to use this function"
-
-
-
-
-
-
- HTTP_PAYLOAD_METHODS = frozenset(["PUT", "POST", "PATCH"])
-
-
-
-
-
-
- _MEDIA_SIZE_BIT_SHIFTS = {"KB": 10, "MB": 20, "GB": 30, "TB": 40}
-
-
-
-
-
-
- BODY_PARAMETER_DEFAULT_VALUE = {"description": "The request bo...
-
-
-
-
-
-
- MEDIA_BODY_PARAMETER_DEFAULT_VALUE = {"description":("The file...
-
-
-
-
-
-
- MEDIA_MIME_TYPE_PARAMETER_DEFAULT_VALUE = {"description":("The...
-
-
-
-
-
-
- _PAGE_TOKEN_NAMES = "pageToken", "nextPageToken"
-
-
-
-
-
-
- GOOGLE_API_USE_CLIENT_CERTIFICATE = "GOOGLE_API_USE_CLIENT_CER...
-
-
-
-
-
-
- GOOGLE_API_USE_MTLS_ENDPOINT = "GOOGLE_API_USE_MTLS_ENDPOINT"
-
-
-
-
-
-
- STACK_QUERY_PARAMETERS = frozenset(["trace", "pp", "userip", "...
-
-
-
-
-
-
- STACK_QUERY_PARAMETER_DEFAULT_VALUE = {"type": "string", "loca...
-
-
-
-
-
-
- RESERVED_WORDS = frozenset(["body"])
-
-
-
-
-
-
-
-
-
-
- Function Details
-
-
-
-
-
-
-
-
-
-
-
- fix_method_name(name)
-
- source code
-
-
-
-
-Fix method names to avoid '$' characters and reserved word conflicts.
-
-Args:
- name: string, method name.
-
-Returns:
- The name with '_' appended if the name is a reserved word and '$' and '-'
- replaced with '_'.
-
-
-
-
-
-
-
-
-
-
-
-
- key2param(key)
-
- source code
-
-
-
-
-Converts key names into parameter names.
-
-For example, converting "max-results" -> "max_results"
-
-Args:
- key: string, the method key name.
-
-Returns:
- A safe method name based on the key name.
-
-
-
-
-
-
-
-
-
-
-
-
- build(serviceName,
- version,
- http=None,
- discoveryServiceUrl=DISCOVERY_URI,
- developerKey=None,
- model=None,
- requestBuilder=HttpRequest,
- credentials=None,
- cache_discovery=True,
- cache=None,
- client_options=None,
- adc_cert_path=None,
- adc_key_path=None,
- num_retries=1)
-
- source code
-
-
-
-
-Construct a Resource for interacting with an API.
-
-Construct a Resource object for interacting with an API. The serviceName and
-version are the names from the Discovery service.
-
-Args:
- serviceName: string, name of the service.
- version: string, the version of the service.
- http: httplib2.Http, An instance of httplib2.Http or something that acts
- like it that HTTP requests will be made through.
- discoveryServiceUrl: string, a URI Template that points to the location of
- the discovery service. It should have two parameters {api} and
- {apiVersion} that when filled in produce an absolute URI to the discovery
- document for that service.
- developerKey: string, key obtained from
- https://code.google.com/apis/console.
- model: googleapiclient.Model, converts to and from the wire format.
- requestBuilder: googleapiclient.http.HttpRequest, encapsulator for an HTTP
- request.
- credentials: oauth2client.Credentials or
- google.auth.credentials.Credentials, credentials to be used for
- authentication.
- cache_discovery: Boolean, whether or not to cache the discovery doc.
- cache: googleapiclient.discovery_cache.base.CacheBase, an optional
- cache object for the discovery documents.
- client_options: Mapping object or google.api_core.client_options, client
- options to set user options on the client.
- (1) The API endpoint should be set through client_options. If API endpoint
- is not set, `GOOGLE_API_USE_MTLS_ENDPOINT` environment variable can be used
- to control which endpoint to use.
- (2) client_cert_source is not supported, client cert should be provided using
- client_encrypted_cert_source instead. In order to use the provided client
- cert, `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be
- set to `true`.
- More details on the environment variables are here:
- https://google.aip.dev/auth/4114
- adc_cert_path: str, client certificate file path to save the application
- default client certificate for mTLS. This field is required if you want to
- use the default client certificate. `GOOGLE_API_USE_CLIENT_CERTIFICATE`
- environment variable must be set to `true` in order to use this field,
- otherwise this field doesn't nothing.
- More details on the environment variables are here:
- https://google.aip.dev/auth/4114
- adc_key_path: str, client encrypted private key file path to save the
- application default client encrypted private key for mTLS. This field is
- required if you want to use the default client certificate.
- `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be set to
- `true` in order to use this field, otherwise this field doesn't nothing.
- More details on the environment variables are here:
- https://google.aip.dev/auth/4114
- num_retries: Integer, number of times to retry discovery with
- randomized exponential backoff in case of intermittent/connection issues.
-
-Returns:
- A Resource object with methods for interacting with the service.
-
-Raises:
- google.auth.exceptions.MutualTLSChannelError: if there are any problems
- setting up mutual TLS channel.
-
-
-
- - Decorators:
-
- @positional(2)
-
-
-
-
-
-
-
-
- _discovery_service_uri_options(discoveryServiceUrl,
- version)
-
- source code
-
-
-
-
-
- Returns Discovery URIs to be used for attemnting to build the API Resource.
-
-Args:
- discoveryServiceUrl:
- string, the Original Discovery Service URL preferred by the customer.
- version:
- string, API Version requested
-
-Returns:
- A list of URIs to be tried for the Service Discovery, in order.
-
-
-
-
-
-
-
-
-
-
-
-
-
- _retrieve_discovery_doc(url,
- http,
- cache_discovery,
- cache=None,
- developerKey=None,
- num_retries=1)
-
- source code
-
-
-
-
-Retrieves the discovery_doc from cache or the internet.
-
-Args:
- url: string, the URL of the discovery document.
- http: httplib2.Http, An instance of httplib2.Http or something that acts
- like it through which HTTP requests will be made.
- cache_discovery: Boolean, whether or not to cache the discovery doc.
- cache: googleapiclient.discovery_cache.base.Cache, an optional cache
- object for the discovery documents.
- developerKey: string, Key for controlling API usage, generated
- from the API Console.
- num_retries: Integer, number of times to retry discovery with
- randomized exponential backoff in case of intermittent/connection issues.
-
-Returns:
- A unicode string representation of the discovery document.
-
-
-
-
-
-
-
-
-
-
-
-
- build_from_document(service,
- base=None,
- future=None,
- http=None,
- developerKey=None,
- model=None,
- requestBuilder=HttpRequest,
- credentials=None,
- client_options=None,
- adc_cert_path=None,
- adc_key_path=None)
-
- source code
-
-
-
-
-Create a Resource for interacting with an API.
-
-Same as `build()`, but constructs the Resource object from a discovery
-document that is it given, as opposed to retrieving one over HTTP.
-
-Args:
- service: string or object, the JSON discovery document describing the API.
- The value passed in may either be the JSON string or the deserialized
- JSON.
- base: string, base URI for all HTTP requests, usually the discovery URI.
- This parameter is no longer used as rootUrl and servicePath are included
- within the discovery document. (deprecated)
- future: string, discovery document with future capabilities (deprecated).
- http: httplib2.Http, An instance of httplib2.Http or something that acts
- like it that HTTP requests will be made through.
- developerKey: string, Key for controlling API usage, generated
- from the API Console.
- model: Model class instance that serializes and de-serializes requests and
- responses.
- requestBuilder: Takes an http request and packages it up to be executed.
- credentials: oauth2client.Credentials or
- google.auth.credentials.Credentials, credentials to be used for
- authentication.
- client_options: Mapping object or google.api_core.client_options, client
- options to set user options on the client.
- (1) The API endpoint should be set through client_options. If API endpoint
- is not set, `GOOGLE_API_USE_MTLS_ENDPOINT` environment variable can be used
- to control which endpoint to use.
- (2) client_cert_source is not supported, client cert should be provided using
- client_encrypted_cert_source instead. In order to use the provided client
- cert, `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be
- set to `true`.
- More details on the environment variables are here:
- https://google.aip.dev/auth/4114
- adc_cert_path: str, client certificate file path to save the application
- default client certificate for mTLS. This field is required if you want to
- use the default client certificate. `GOOGLE_API_USE_CLIENT_CERTIFICATE`
- environment variable must be set to `true` in order to use this field,
- otherwise this field doesn't nothing.
- More details on the environment variables are here:
- https://google.aip.dev/auth/4114
- adc_key_path: str, client encrypted private key file path to save the
- application default client encrypted private key for mTLS. This field is
- required if you want to use the default client certificate.
- `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be set to
- `true` in order to use this field, otherwise this field doesn't nothing.
- More details on the environment variables are here:
- https://google.aip.dev/auth/4114
-
-Returns:
- A Resource object with methods for interacting with the service.
-
-Raises:
- google.auth.exceptions.MutualTLSChannelError: if there are any problems
- setting up mutual TLS channel.
-
-
-
- - Decorators:
-
- @positional(1)
-
-
-
-
-
-
-
-
- _cast(value,
- schema_type)
-
- source code
-
-
-
-
-Convert value to a string based on JSON Schema type.
-
-See http://tools.ietf.org/html/draft-zyp-json-schema-03 for more details on
-JSON Schema.
-
-Args:
- value: any, the value to convert
- schema_type: string, the type that value should be interpreted as
-
-Returns:
- A string representation of 'value' based on the schema_type.
-
-
-
-
-
-
-
-
-
-
-
-
- _media_size_to_long(maxSize)
-
- source code
-
-
-
-
-Convert a string media size, such as 10GB or 3TB into an integer.
-
-Args:
- maxSize: string, size as a string, such as 2MB or 7GB.
-
-Returns:
- The size as an integer value.
-
-
-
-
-
-
-
-
-
-
-
-
- _media_path_url_from_info(root_desc,
- path_url)
-
- source code
-
-
-
-
-Creates an absolute media path URL.
-
-Constructed using the API root URI and service path from the discovery
-document and the relative path for the API method.
-
-Args:
- root_desc: Dictionary; the entire original deserialized discovery document.
- path_url: String; the relative URL for the API method. Relative to the API
- root, which is specified in the discovery document.
-
-Returns:
- String; the absolute URI for media upload for the API method.
-
-
-
-
-
-
-
-
-
-
-
-
- _fix_up_parameters(method_desc,
- root_desc,
- http_method,
- schema)
-
- source code
-
-
-
-
-Updates parameters of an API method with values specific to this library.
-
-Specifically, adds whatever global parameters are specified by the API to the
-parameters for the individual method. Also adds parameters which don't
-appear in the discovery document, but are available to all discovery based
-APIs (these are listed in STACK_QUERY_PARAMETERS).
-
-SIDE EFFECTS: This updates the parameters dictionary object in the method
-description.
-
-Args:
- method_desc: Dictionary with metadata describing an API method. Value comes
- from the dictionary of methods stored in the 'methods' key in the
- deserialized discovery document.
- root_desc: Dictionary; the entire original deserialized discovery document.
- http_method: String; the HTTP method used to call the API method described
- in method_desc.
- schema: Object, mapping of schema names to schema descriptions.
-
-Returns:
- The updated Dictionary stored in the 'parameters' key of the method
- description dictionary.
-
-
-
-
-
-
-
-
-
-
-
-
- _fix_up_media_upload(method_desc,
- root_desc,
- path_url,
- parameters)
-
- source code
-
-
-
-
-Adds 'media_body' and 'media_mime_type' parameters if supported by method.
-
-SIDE EFFECTS: If there is a 'mediaUpload' in the method description, adds
-'media_upload' key to parameters.
-
-Args:
- method_desc: Dictionary with metadata describing an API method. Value comes
- from the dictionary of methods stored in the 'methods' key in the
- deserialized discovery document.
- root_desc: Dictionary; the entire original deserialized discovery document.
- path_url: String; the relative URL for the API method. Relative to the API
- root, which is specified in the discovery document.
- parameters: A dictionary describing method parameters for method described
- in method_desc.
-
-Returns:
- Triple (accept, max_size, media_path_url) where:
- - accept is a list of strings representing what content types are
- accepted for media upload. Defaults to empty list if not in the
- discovery document.
- - max_size is a long representing the max size in bytes allowed for a
- media upload. Defaults to 0L if not in the discovery document.
- - media_path_url is a String; the absolute URI for media upload for the
- API method. Constructed using the API root URI and service path from
- the discovery document and the relative path for the API method. If
- media upload is not supported, this is None.
-
-
-
-
-
-
-
-
-
-
-
-
- _fix_up_method_description(method_desc,
- root_desc,
- schema)
-
- source code
-
-
-
-
-Updates a method description in a discovery document.
-
-SIDE EFFECTS: Changes the parameters dictionary in the method description with
-extra parameters which are used locally.
-
-Args:
- method_desc: Dictionary with metadata describing an API method. Value comes
- from the dictionary of methods stored in the 'methods' key in the
- deserialized discovery document.
- root_desc: Dictionary; the entire original deserialized discovery document.
- schema: Object, mapping of schema names to schema descriptions.
-
-Returns:
- Tuple (path_url, http_method, method_id, accept, max_size, media_path_url)
- where:
- - path_url is a String; the relative URL for the API method. Relative to
- the API root, which is specified in the discovery document.
- - http_method is a String; the HTTP method used to call the API method
- described in the method description.
- - method_id is a String; the name of the RPC method associated with the
- API method, and is in the method description in the 'id' key.
- - accept is a list of strings representing what content types are
- accepted for media upload. Defaults to empty list if not in the
- discovery document.
- - max_size is a long representing the max size in bytes allowed for a
- media upload. Defaults to 0L if not in the discovery document.
- - media_path_url is a String; the absolute URI for media upload for the
- API method. Constructed using the API root URI and service path from
- the discovery document and the relative path for the API method. If
- media upload is not supported, this is None.
-
-
-
-
-
-
-
-
-
-
-
-
- createMethod(methodName,
- methodDesc,
- rootDesc,
- schema)
-
- source code
-
-
-
-
-Creates a method for attaching to a Resource.
-
-Args:
- methodName: string, name of the method to use.
- methodDesc: object, fragment of deserialized discovery document that
- describes the method.
- rootDesc: object, the entire deserialized discovery document.
- schema: object, mapping of schema names to schema descriptions.
-
-
-
-
-
-
-
-
-
-
-
-
- createNextMethod(methodName,
- pageTokenName="pageToken",
- nextPageTokenName="nextPageToken",
- isPageTokenParameter=True)
-
- source code
-
-
-
-
-Creates any _next methods for attaching to a Resource.
-
-The _next methods allow for easy iteration through list() responses.
-
-Args:
- methodName: string, name of the method to use.
- pageTokenName: string, name of request page token field.
- nextPageTokenName: string, name of response page token field.
- isPageTokenParameter: Boolean, True if request page token is a query
- parameter, False if request page token is a field of the request body.
-
-
-
-
-
-
-
-
-
-
-
-
- _findPageTokenName(fields)
-
- source code
-
-
-
-
-Search field names for one like a page token.
-
-Args:
- fields: container of string, names of fields.
-
-Returns:
- First name that is either 'pageToken' or 'nextPageToken' if one exists,
- otherwise None.
-
-
-
-
-
-
-
-
-
-
-
-
- _methodProperties(methodDesc,
- schema,
- name)
-
- source code
-
-
-
-
-Get properties of a field in a method description.
-
-Args:
- methodDesc: object, fragment of deserialized discovery document that
- describes the method.
- schema: object, mapping of schema names to schema descriptions.
- name: string, name of top-level field in method description.
-
-Returns:
- Object representing fragment of deserialized discovery document
- corresponding to 'properties' field of object corresponding to named field
- in method description, if it exists, otherwise empty dict.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Variables Details
-
-
-
-
-
-
-
-
-
- DISCOVERY_URI
-
-
-
-
- - Value:
-
-"https://www.googleapis.com/discovery/v1/apis/" "{api}/{apiVersion}/re
-st"
-
-
-
-
-
-
-
-
- V1_DISCOVERY_URI
-
-
-
-
- - Value:
-
-"https://www.googleapis.com/discovery/v1/apis/" "{api}/{apiVersion}/re
-st"
-
-
-
-
-
-
-
-
- V2_DISCOVERY_URI
-
-
-
-
- - Value:
-
-"https://{api}.googleapis.com/$discovery/rest?" "version={apiVersion}"
-
-
-
-
-
-
-
-
- BODY_PARAMETER_DEFAULT_VALUE
-
-
-
-
- - Value:
-
-{"description": "The request body.", "type": "object"}
-
-
-
-
-
-
-
-
- MEDIA_BODY_PARAMETER_DEFAULT_VALUE
-
-
-
-
- - Value:
-
-{"description":("The filename of the media request body, or an instanc
-e " "of a MediaUpload object."), "type": "string", "required": False,}
-
-
-
-
-
-
-
-
- MEDIA_MIME_TYPE_PARAMETER_DEFAULT_VALUE
-
-
-
-
- - Value:
-
-{"description":("The MIME type of the media request body, or an instan
-ce " "of a MediaUpload object."), "type": "string", "required": False,
-}
-
-
-
-
-
-
-
-
- GOOGLE_API_USE_CLIENT_CERTIFICATE
-
-
-
-
- - Value:
-
-"GOOGLE_API_USE_CLIENT_CERTIFICATE"
-
-
-
-
-
-
-
-
- STACK_QUERY_PARAMETERS
-
-
-
-
- - Value:
-
-frozenset(["trace", "pp", "userip", "strict"])
-
-
-
-
-
-
-
-
- STACK_QUERY_PARAMETER_DEFAULT_VALUE
-
-
-
-
- - Value:
-
-{"type": "string", "location": "query"}
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.discovery-pysrc.html b/docs/epy/googleapiclient.discovery-pysrc.html
deleted file mode 100644
index d063c472d52..00000000000
--- a/docs/epy/googleapiclient.discovery-pysrc.html
+++ /dev/null
@@ -1,1806 +0,0 @@
-
-
-
-
- googleapiclient.discovery
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Source Code for Module googleapiclient.discovery
-
- 1 # Copyright 2014 Google Inc. All Rights Reserved.
- 2 #
- 3 # Licensed under the Apache License, Version 2.0 (the "License");
- 4 # you may not use this file except in compliance with the License.
- 5 # You may obtain a copy of the License at
- 6 #
- 7 # http://www.apache.org/licenses/LICENSE-2.0
- 8 #
- 9 # Unless required by applicable law or agreed to in writing, software
- 10 # distributed under the License is distributed on an "AS IS" BASIS,
- 11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- 12 # See the License for the specific language governing permissions and
- 13 # limitations under the License.
- 14
- 15 """Client for discovery based APIs.
- 16
- 17 A client library for Google's discovery based APIs.
- 18 """
- 19 from __future__ import absolute_import
- 20 import six
- 21 from six.moves import zip
- 22
- 23 __author__ = "jcgregorio@google.com (Joe Gregorio)"
- 24 __all__ = ["build", "build_from_document", "fix_method_name", "key2param"]
- 25
- 26 from six import BytesIO
- 27 from six.moves import http_client
- 28 from six.moves.urllib.parse import urlencode, urlparse, urljoin, urlunparse, parse_qsl
- 29
- 30 # Standard library imports
- 31 import copy
- 32 from collections import OrderedDict
- 33
- 34 try:
- 35 from email.generator import BytesGenerator
- 36 except ImportError:
- 37 from email.generator import Generator as BytesGenerator
- 38 from email.mime.multipart import MIMEMultipart
- 39 from email.mime.nonmultipart import MIMENonMultipart
- 40 import json
- 41 import keyword
- 42 import logging
- 43 import mimetypes
- 44 import os
- 45 import re
- 46
- 47 # Third-party imports
- 48 import httplib2
- 49 import uritemplate
- 50 import google.api_core.client_options
- 51 from google.auth.transport import mtls
- 52 from google.auth.exceptions import MutualTLSChannelError
- 53
- 54 try:
- 55 import google_auth_httplib2
- 56 except ImportError: # pragma: NO COVER
- 57 google_auth_httplib2 = None
- 58
- 59 # Local imports
- 60 from googleapiclient import _auth
- 61 from googleapiclient import mimeparse
- 62 from googleapiclient.errors import HttpError
- 63 from googleapiclient.errors import InvalidJsonError
- 64 from googleapiclient.errors import MediaUploadSizeError
- 65 from googleapiclient.errors import UnacceptableMimeTypeError
- 66 from googleapiclient.errors import UnknownApiNameOrVersion
- 67 from googleapiclient.errors import UnknownFileType
- 68 from googleapiclient.http import build_http
- 69 from googleapiclient.http import BatchHttpRequest
- 70 from googleapiclient.http import HttpMock
- 71 from googleapiclient.http import HttpMockSequence
- 72 from googleapiclient.http import HttpRequest
- 73 from googleapiclient.http import MediaFileUpload
- 74 from googleapiclient.http import MediaUpload
- 75 from googleapiclient.model import JsonModel
- 76 from googleapiclient.model import MediaModel
- 77 from googleapiclient.model import RawModel
- 78 from googleapiclient.schema import Schemas
- 79
- 80 from googleapiclient._helpers import _add_query_parameter
- 81 from googleapiclient._helpers import positional
- 82
- 83
- 84 # The client library requires a version of httplib2 that supports RETRIES.
- 85 httplib2.RETRIES = 1
- 86
- 87 logger = logging.getLogger(__name__)
- 88
- 89 URITEMPLATE = re.compile("{[^}]*}")
- 90 VARNAME = re.compile("[a-zA-Z0-9_-]+")
- 91 DISCOVERY_URI = (
- 92 "https://www.googleapis.com/discovery/v1/apis/" "{api}/{apiVersion}/rest"
- 93 )
- 94 V1_DISCOVERY_URI = DISCOVERY_URI
- 95 V2_DISCOVERY_URI = (
- 96 "https://{api}.googleapis.com/$discovery/rest?" "version={apiVersion}"
- 97 )
- 98 DEFAULT_METHOD_DOC = "A description of how to use this function"
- 99 HTTP_PAYLOAD_METHODS = frozenset(["PUT", "POST", "PATCH"])
- 100
- 101 _MEDIA_SIZE_BIT_SHIFTS = {"KB": 10, "MB": 20, "GB": 30, "TB": 40}
- 102 BODY_PARAMETER_DEFAULT_VALUE = {"description": "The request body.", "type": "object"}
- 103 MEDIA_BODY_PARAMETER_DEFAULT_VALUE = {
- 104 "description": (
- 105 "The filename of the media request body, or an instance "
- 106 "of a MediaUpload object."
- 107 ),
- 108 "type": "string",
- 109 "required": False,
- 110 }
- 111 MEDIA_MIME_TYPE_PARAMETER_DEFAULT_VALUE = {
- 112 "description": (
- 113 "The MIME type of the media request body, or an instance "
- 114 "of a MediaUpload object."
- 115 ),
- 116 "type": "string",
- 117 "required": False,
- 118 }
- 119 _PAGE_TOKEN_NAMES = ("pageToken", "nextPageToken")
- 120
- 121 # Parameters controlling mTLS behavior. See https://google.aip.dev/auth/4114.
- 122 GOOGLE_API_USE_CLIENT_CERTIFICATE = "GOOGLE_API_USE_CLIENT_CERTIFICATE"
- 123 GOOGLE_API_USE_MTLS_ENDPOINT = "GOOGLE_API_USE_MTLS_ENDPOINT"
- 124
- 125 # Parameters accepted by the stack, but not visible via discovery.
- 126 # TODO(dhermes): Remove 'userip' in 'v2'.
- 127 STACK_QUERY_PARAMETERS = frozenset(["trace", "pp", "userip", "strict"])
- 128 STACK_QUERY_PARAMETER_DEFAULT_VALUE = {"type": "string", "location": "query"}
- 129
- 130 # Library-specific reserved words beyond Python keywords.
- 131 RESERVED_WORDS = frozenset(["body"])
- 132
- 133 # patch _write_lines to avoid munging '\r' into '\n'
- 134 # ( https://bugs.python.org/issue18886 https://bugs.python.org/issue19003 )
- 135 -class _BytesGenerator(BytesGenerator):
- 136 _write_lines = BytesGenerator.write
- 137
- 140 """Fix method names to avoid '$' characters and reserved word conflicts.
- 141
- 142 Args:
- 143 name: string, method name.
- 144
- 145 Returns:
- 146 The name with '_' appended if the name is a reserved word and '$' and '-'
- 147 replaced with '_'.
- 148 """
- 149 name = name.replace("$", "_").replace("-", "_")
- 150 if keyword.iskeyword(name) or name in RESERVED_WORDS:
- 151 return name + "_"
- 152 else:
- 153 return name
- 154
- 157 """Converts key names into parameter names.
- 158
- 159 For example, converting "max-results" -> "max_results"
- 160
- 161 Args:
- 162 key: string, the method key name.
- 163
- 164 Returns:
- 165 A safe method name based on the key name.
- 166 """
- 167 result = []
- 168 key = list(key)
- 169 if not key[0].isalpha():
- 170 result.append("x")
- 171 for c in key:
- 172 if c.isalnum():
- 173 result.append(c)
- 174 else:
- 175 result.append("_")
- 176
- 177 return "".join(result)
- 178
- 179
- 180 @positional(2)
- 181 -def build(
- 182 serviceName,
- 183 version,
- 184 http=None,
- 185 discoveryServiceUrl=DISCOVERY_URI,
- 186 developerKey=None,
- 187 model=None,
- 188 requestBuilder=HttpRequest,
- 189 credentials=None,
- 190 cache_discovery=True,
- 191 cache=None,
- 192 client_options=None,
- 193 adc_cert_path=None,
- 194 adc_key_path=None,
- 195 num_retries=1,
- 196 ):
- 197 """Construct a Resource for interacting with an API.
- 198
- 199 Construct a Resource object for interacting with an API. The serviceName and
- 200 version are the names from the Discovery service.
- 201
- 202 Args:
- 203 serviceName: string, name of the service.
- 204 version: string, the version of the service.
- 205 http: httplib2.Http, An instance of httplib2.Http or something that acts
- 206 like it that HTTP requests will be made through.
- 207 discoveryServiceUrl: string, a URI Template that points to the location of
- 208 the discovery service. It should have two parameters {api} and
- 209 {apiVersion} that when filled in produce an absolute URI to the discovery
- 210 document for that service.
- 211 developerKey: string, key obtained from
- 212 https://code.google.com/apis/console.
- 213 model: googleapiclient.Model, converts to and from the wire format.
- 214 requestBuilder: googleapiclient.http.HttpRequest, encapsulator for an HTTP
- 215 request.
- 216 credentials: oauth2client.Credentials or
- 217 google.auth.credentials.Credentials, credentials to be used for
- 218 authentication.
- 219 cache_discovery: Boolean, whether or not to cache the discovery doc.
- 220 cache: googleapiclient.discovery_cache.base.CacheBase, an optional
- 221 cache object for the discovery documents.
- 222 client_options: Mapping object or google.api_core.client_options, client
- 223 options to set user options on the client.
- 224 (1) The API endpoint should be set through client_options. If API endpoint
- 225 is not set, `GOOGLE_API_USE_MTLS_ENDPOINT` environment variable can be used
- 226 to control which endpoint to use.
- 227 (2) client_cert_source is not supported, client cert should be provided using
- 228 client_encrypted_cert_source instead. In order to use the provided client
- 229 cert, `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be
- 230 set to `true`.
- 231 More details on the environment variables are here:
- 232 https://google.aip.dev/auth/4114
- 233 adc_cert_path: str, client certificate file path to save the application
- 234 default client certificate for mTLS. This field is required if you want to
- 235 use the default client certificate. `GOOGLE_API_USE_CLIENT_CERTIFICATE`
- 236 environment variable must be set to `true` in order to use this field,
- 237 otherwise this field doesn't nothing.
- 238 More details on the environment variables are here:
- 239 https://google.aip.dev/auth/4114
- 240 adc_key_path: str, client encrypted private key file path to save the
- 241 application default client encrypted private key for mTLS. This field is
- 242 required if you want to use the default client certificate.
- 243 `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be set to
- 244 `true` in order to use this field, otherwise this field doesn't nothing.
- 245 More details on the environment variables are here:
- 246 https://google.aip.dev/auth/4114
- 247 num_retries: Integer, number of times to retry discovery with
- 248 randomized exponential backoff in case of intermittent/connection issues.
- 249
- 250 Returns:
- 251 A Resource object with methods for interacting with the service.
- 252
- 253 Raises:
- 254 google.auth.exceptions.MutualTLSChannelError: if there are any problems
- 255 setting up mutual TLS channel.
- 256 """
- 257 params = {"api": serviceName, "apiVersion": version}
- 258
- 259 if http is None:
- 260 discovery_http = build_http()
- 261 else:
- 262 discovery_http = http
- 263
- 264 service = None
- 265
- 266 for discovery_url in _discovery_service_uri_options(discoveryServiceUrl, version):
- 267 requested_url = uritemplate.expand(discovery_url, params)
- 268
- 269 try:
- 270 content = _retrieve_discovery_doc(
- 271 requested_url,
- 272 discovery_http,
- 273 cache_discovery,
- 274 cache,
- 275 developerKey,
- 276 num_retries=num_retries,
- 277 )
- 278 service = build_from_document(
- 279 content,
- 280 base=discovery_url,
- 281 http=http,
- 282 developerKey=developerKey,
- 283 model=model,
- 284 requestBuilder=requestBuilder,
- 285 credentials=credentials,
- 286 client_options=client_options,
- 287 adc_cert_path=adc_cert_path,
- 288 adc_key_path=adc_key_path,
- 289 )
- 290 break # exit if a service was created
- 291 except HttpError as e:
- 292 if e.resp.status == http_client.NOT_FOUND:
- 293 continue
- 294 else:
- 295 raise e
- 296
- 297 # If discovery_http was created by this function, we are done with it
- 298 # and can safely close it
- 299 if http is None:
- 300 discovery_http.close()
- 301
- 302 if service is None:
- 303 raise UnknownApiNameOrVersion("name: %s version: %s" % (serviceName, version))
- 304 else:
- 305 return service
- 306
- 309 """
- 310 Returns Discovery URIs to be used for attemnting to build the API Resource.
- 311
- 312 Args:
- 313 discoveryServiceUrl:
- 314 string, the Original Discovery Service URL preferred by the customer.
- 315 version:
- 316 string, API Version requested
- 317
- 318 Returns:
- 319 A list of URIs to be tried for the Service Discovery, in order.
- 320 """
- 321
- 322 urls = [discoveryServiceUrl, V2_DISCOVERY_URI]
- 323 # V1 Discovery won't work if the requested version is None
- 324 if discoveryServiceUrl == V1_DISCOVERY_URI and version is None:
- 325 logger.warning(
- 326 "Discovery V1 does not support empty versions. Defaulting to V2..."
- 327 )
- 328 urls.pop(0)
- 329 return list(OrderedDict.fromkeys(urls))
- 330
- 331
- 332 -def _retrieve_discovery_doc(
- 333 url, http, cache_discovery, cache=None, developerKey=None, num_retries=1
- 334 ):
- 335 """Retrieves the discovery_doc from cache or the internet.
- 336
- 337 Args:
- 338 url: string, the URL of the discovery document.
- 339 http: httplib2.Http, An instance of httplib2.Http or something that acts
- 340 like it through which HTTP requests will be made.
- 341 cache_discovery: Boolean, whether or not to cache the discovery doc.
- 342 cache: googleapiclient.discovery_cache.base.Cache, an optional cache
- 343 object for the discovery documents.
- 344 developerKey: string, Key for controlling API usage, generated
- 345 from the API Console.
- 346 num_retries: Integer, number of times to retry discovery with
- 347 randomized exponential backoff in case of intermittent/connection issues.
- 348
- 349 Returns:
- 350 A unicode string representation of the discovery document.
- 351 """
- 352 if cache_discovery:
- 353 from . import discovery_cache
- 354
- 355 if cache is None:
- 356 cache = discovery_cache.autodetect()
- 357 if cache:
- 358 content = cache.get(url)
- 359 if content:
- 360 return content
- 361
- 362 actual_url = url
- 363 # REMOTE_ADDR is defined by the CGI spec [RFC3875] as the environment
- 364 # variable that contains the network address of the client sending the
- 365 # request. If it exists then add that to the request for the discovery
- 366 # document to avoid exceeding the quota on discovery requests.
- 367 if "REMOTE_ADDR" in os.environ:
- 368 actual_url = _add_query_parameter(url, "userIp", os.environ["REMOTE_ADDR"])
- 369 if developerKey:
- 370 actual_url = _add_query_parameter(url, "key", developerKey)
- 371 logger.debug("URL being requested: GET %s", actual_url)
- 372
- 373 # Execute this request with retries build into HttpRequest
- 374 # Note that it will already raise an error if we don't get a 2xx response
- 375 req = HttpRequest(http, HttpRequest.null_postproc, actual_url)
- 376 resp, content = req.execute(num_retries=num_retries)
- 377
- 378 try:
- 379 content = content.decode("utf-8")
- 380 except AttributeError:
- 381 pass
- 382
- 383 try:
- 384 service = json.loads(content)
- 385 except ValueError as e:
- 386 logger.error("Failed to parse as JSON: " + content)
- 387 raise InvalidJsonError()
- 388 if cache_discovery and cache:
- 389 cache.set(url, content)
- 390 return content
- 391
- 392
- 393 @positional(1)
- 394 -def build_from_document(
- 395 service,
- 396 base=None,
- 397 future=None,
- 398 http=None,
- 399 developerKey=None,
- 400 model=None,
- 401 requestBuilder=HttpRequest,
- 402 credentials=None,
- 403 client_options=None,
- 404 adc_cert_path=None,
- 405 adc_key_path=None,
- 406 ):
- 407 """Create a Resource for interacting with an API.
- 408
- 409 Same as `build()`, but constructs the Resource object from a discovery
- 410 document that is it given, as opposed to retrieving one over HTTP.
- 411
- 412 Args:
- 413 service: string or object, the JSON discovery document describing the API.
- 414 The value passed in may either be the JSON string or the deserialized
- 415 JSON.
- 416 base: string, base URI for all HTTP requests, usually the discovery URI.
- 417 This parameter is no longer used as rootUrl and servicePath are included
- 418 within the discovery document. (deprecated)
- 419 future: string, discovery document with future capabilities (deprecated).
- 420 http: httplib2.Http, An instance of httplib2.Http or something that acts
- 421 like it that HTTP requests will be made through.
- 422 developerKey: string, Key for controlling API usage, generated
- 423 from the API Console.
- 424 model: Model class instance that serializes and de-serializes requests and
- 425 responses.
- 426 requestBuilder: Takes an http request and packages it up to be executed.
- 427 credentials: oauth2client.Credentials or
- 428 google.auth.credentials.Credentials, credentials to be used for
- 429 authentication.
- 430 client_options: Mapping object or google.api_core.client_options, client
- 431 options to set user options on the client.
- 432 (1) The API endpoint should be set through client_options. If API endpoint
- 433 is not set, `GOOGLE_API_USE_MTLS_ENDPOINT` environment variable can be used
- 434 to control which endpoint to use.
- 435 (2) client_cert_source is not supported, client cert should be provided using
- 436 client_encrypted_cert_source instead. In order to use the provided client
- 437 cert, `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be
- 438 set to `true`.
- 439 More details on the environment variables are here:
- 440 https://google.aip.dev/auth/4114
- 441 adc_cert_path: str, client certificate file path to save the application
- 442 default client certificate for mTLS. This field is required if you want to
- 443 use the default client certificate. `GOOGLE_API_USE_CLIENT_CERTIFICATE`
- 444 environment variable must be set to `true` in order to use this field,
- 445 otherwise this field doesn't nothing.
- 446 More details on the environment variables are here:
- 447 https://google.aip.dev/auth/4114
- 448 adc_key_path: str, client encrypted private key file path to save the
- 449 application default client encrypted private key for mTLS. This field is
- 450 required if you want to use the default client certificate.
- 451 `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be set to
- 452 `true` in order to use this field, otherwise this field doesn't nothing.
- 453 More details on the environment variables are here:
- 454 https://google.aip.dev/auth/4114
- 455
- 456 Returns:
- 457 A Resource object with methods for interacting with the service.
- 458
- 459 Raises:
- 460 google.auth.exceptions.MutualTLSChannelError: if there are any problems
- 461 setting up mutual TLS channel.
- 462 """
- 463
- 464 if client_options is None:
- 465 client_options = google.api_core.client_options.ClientOptions()
- 466 if isinstance(client_options, six.moves.collections_abc.Mapping):
- 467 client_options = google.api_core.client_options.from_dict(client_options)
- 468
- 469 if http is not None:
- 470 # if http is passed, the user cannot provide credentials
- 471 banned_options = [
- 472 (credentials, "credentials"),
- 473 (client_options.credentials_file, "client_options.credentials_file"),
- 474 ]
- 475 for option, name in banned_options:
- 476 if option is not None:
- 477 raise ValueError("Arguments http and {} are mutually exclusive".format(name))
- 478
- 479 if isinstance(service, six.string_types):
- 480 service = json.loads(service)
- 481 elif isinstance(service, six.binary_type):
- 482 service = json.loads(service.decode("utf-8"))
- 483
- 484 if "rootUrl" not in service and isinstance(http, (HttpMock, HttpMockSequence)):
- 485 logger.error(
- 486 "You are using HttpMock or HttpMockSequence without"
- 487 + "having the service discovery doc in cache. Try calling "
- 488 + "build() without mocking once first to populate the "
- 489 + "cache."
- 490 )
- 491 raise InvalidJsonError()
- 492
- 493 # If an API Endpoint is provided on client options, use that as the base URL
- 494 base = urljoin(service["rootUrl"], service["servicePath"])
- 495 if client_options.api_endpoint:
- 496 base = client_options.api_endpoint
- 497
- 498 schema = Schemas(service)
- 499
- 500 # If the http client is not specified, then we must construct an http client
- 501 # to make requests. If the service has scopes, then we also need to setup
- 502 # authentication.
- 503 if http is None:
- 504 # Does the service require scopes?
- 505 scopes = list(
- 506 service.get("auth", {}).get("oauth2", {}).get("scopes", {}).keys()
- 507 )
- 508
- 509 # If so, then the we need to setup authentication if no developerKey is
- 510 # specified.
- 511 if scopes and not developerKey:
- 512 # Make sure the user didn't pass multiple credentials
- 513 if client_options.credentials_file and credentials:
- 514 raise google.api_core.exceptions.DuplicateCredentialArgs(
- 515 "client_options.credentials_file and credentials are mutually exclusive."
- 516 )
- 517 # Check for credentials file via client options
- 518 if client_options.credentials_file:
- 519 credentials = _auth.credentials_from_file(
- 520 client_options.credentials_file,
- 521 scopes=client_options.scopes,
- 522 quota_project_id=client_options.quota_project_id,
- 523 )
- 524 # If the user didn't pass in credentials, attempt to acquire application
- 525 # default credentials.
- 526 if credentials is None:
- 527 credentials = _auth.default_credentials(
- 528 scopes=client_options.scopes,
- 529 quota_project_id=client_options.quota_project_id,
- 530 )
- 531
- 532 # The credentials need to be scoped.
- 533 # If the user provided scopes via client_options don't override them
- 534 if not client_options.scopes:
- 535 credentials = _auth.with_scopes(credentials, scopes)
- 536
- 537 # If credentials are provided, create an authorized http instance;
- 538 # otherwise, skip authentication.
- 539 if credentials:
- 540 http = _auth.authorized_http(credentials)
- 541
- 542 # If the service doesn't require scopes then there is no need for
- 543 # authentication.
- 544 else:
- 545 http = build_http()
- 546
- 547 # Obtain client cert and create mTLS http channel if cert exists.
- 548 client_cert_to_use = None
- 549 use_client_cert = os.getenv(GOOGLE_API_USE_CLIENT_CERTIFICATE, "false")
- 550 if not use_client_cert in ("true", "false"):
- 551 raise MutualTLSChannelError(
- 552 "Unsupported GOOGLE_API_USE_CLIENT_CERTIFICATE value. Accepted values: true, false"
- 553 )
- 554 if client_options and client_options.client_cert_source:
- 555 raise MutualTLSChannelError(
- 556 "ClientOptions.client_cert_source is not supported, please use ClientOptions.client_encrypted_cert_source."
- 557 )
- 558 if use_client_cert == "true":
- 559 if (
- 560 client_options
- 561 and hasattr(client_options, "client_encrypted_cert_source")
- 562 and client_options.client_encrypted_cert_source
- 563 ):
- 564 client_cert_to_use = client_options.client_encrypted_cert_source
- 565 elif (
- 566 adc_cert_path and adc_key_path and mtls.has_default_client_cert_source()
- 567 ):
- 568 client_cert_to_use = mtls.default_client_encrypted_cert_source(
- 569 adc_cert_path, adc_key_path
- 570 )
- 571 if client_cert_to_use:
- 572 cert_path, key_path, passphrase = client_cert_to_use()
- 573
- 574 # The http object we built could be google_auth_httplib2.AuthorizedHttp
- 575 # or httplib2.Http. In the first case we need to extract the wrapped
- 576 # httplib2.Http object from google_auth_httplib2.AuthorizedHttp.
- 577 http_channel = (
- 578 http.http
- 579 if google_auth_httplib2
- 580 and isinstance(http, google_auth_httplib2.AuthorizedHttp)
- 581 else http
- 582 )
- 583 http_channel.add_certificate(key_path, cert_path, "", passphrase)
- 584
- 585 # If user doesn't provide api endpoint via client options, decide which
- 586 # api endpoint to use.
- 587 if "mtlsRootUrl" in service and (
- 588 not client_options or not client_options.api_endpoint
- 589 ):
- 590 mtls_endpoint = urljoin(service["mtlsRootUrl"], service["servicePath"])
- 591 use_mtls_endpoint = os.getenv(GOOGLE_API_USE_MTLS_ENDPOINT, "auto")
- 592
- 593 if not use_mtls_endpoint in ("never", "auto", "always"):
- 594 raise MutualTLSChannelError(
- 595 "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted values: never, auto, always"
- 596 )
- 597
- 598 # Switch to mTLS endpoint, if environment variable is "always", or
- 599 # environment varibable is "auto" and client cert exists.
- 600 if use_mtls_endpoint == "always" or (
- 601 use_mtls_endpoint == "auto" and client_cert_to_use
- 602 ):
- 603 base = mtls_endpoint
- 604
- 605 if model is None:
- 606 features = service.get("features", [])
- 607 model = JsonModel("dataWrapper" in features)
- 608
- 609 return Resource(
- 610 http=http,
- 611 baseUrl=base,
- 612 model=model,
- 613 developerKey=developerKey,
- 614 requestBuilder=requestBuilder,
- 615 resourceDesc=service,
- 616 rootDesc=service,
- 617 schema=schema,
- 618 )
- 619
- 622 """Convert value to a string based on JSON Schema type.
- 623
- 624 See http://tools.ietf.org/html/draft-zyp-json-schema-03 for more details on
- 625 JSON Schema.
- 626
- 627 Args:
- 628 value: any, the value to convert
- 629 schema_type: string, the type that value should be interpreted as
- 630
- 631 Returns:
- 632 A string representation of 'value' based on the schema_type.
- 633 """
- 634 if schema_type == "string":
- 635 if type(value) == type("") or type(value) == type(u""):
- 636 return value
- 637 else:
- 638 return str(value)
- 639 elif schema_type == "integer":
- 640 return str(int(value))
- 641 elif schema_type == "number":
- 642 return str(float(value))
- 643 elif schema_type == "boolean":
- 644 return str(bool(value)).lower()
- 645 else:
- 646 if type(value) == type("") or type(value) == type(u""):
- 647 return value
- 648 else:
- 649 return str(value)
- 650
- 653 """Convert a string media size, such as 10GB or 3TB into an integer.
- 654
- 655 Args:
- 656 maxSize: string, size as a string, such as 2MB or 7GB.
- 657
- 658 Returns:
- 659 The size as an integer value.
- 660 """
- 661 if len(maxSize) < 2:
- 662 return 0
- 663 units = maxSize[-2:].upper()
- 664 bit_shift = _MEDIA_SIZE_BIT_SHIFTS.get(units)
- 665 if bit_shift is not None:
- 666 return int(maxSize[:-2]) << bit_shift
- 667 else:
- 668 return int(maxSize)
- 669
- 672 """Creates an absolute media path URL.
- 673
- 674 Constructed using the API root URI and service path from the discovery
- 675 document and the relative path for the API method.
- 676
- 677 Args:
- 678 root_desc: Dictionary; the entire original deserialized discovery document.
- 679 path_url: String; the relative URL for the API method. Relative to the API
- 680 root, which is specified in the discovery document.
- 681
- 682 Returns:
- 683 String; the absolute URI for media upload for the API method.
- 684 """
- 685 return "%(root)supload/%(service_path)s%(path)s" % {
- 686 "root": root_desc["rootUrl"],
- 687 "service_path": root_desc["servicePath"],
- 688 "path": path_url,
- 689 }
- 690
- 693 """Updates parameters of an API method with values specific to this library.
- 694
- 695 Specifically, adds whatever global parameters are specified by the API to the
- 696 parameters for the individual method. Also adds parameters which don't
- 697 appear in the discovery document, but are available to all discovery based
- 698 APIs (these are listed in STACK_QUERY_PARAMETERS).
- 699
- 700 SIDE EFFECTS: This updates the parameters dictionary object in the method
- 701 description.
- 702
- 703 Args:
- 704 method_desc: Dictionary with metadata describing an API method. Value comes
- 705 from the dictionary of methods stored in the 'methods' key in the
- 706 deserialized discovery document.
- 707 root_desc: Dictionary; the entire original deserialized discovery document.
- 708 http_method: String; the HTTP method used to call the API method described
- 709 in method_desc.
- 710 schema: Object, mapping of schema names to schema descriptions.
- 711
- 712 Returns:
- 713 The updated Dictionary stored in the 'parameters' key of the method
- 714 description dictionary.
- 715 """
- 716 parameters = method_desc.setdefault("parameters", {})
- 717
- 718 # Add in the parameters common to all methods.
- 719 for name, description in six.iteritems(root_desc.get("parameters", {})):
- 720 parameters[name] = description
- 721
- 722 # Add in undocumented query parameters.
- 723 for name in STACK_QUERY_PARAMETERS:
- 724 parameters[name] = STACK_QUERY_PARAMETER_DEFAULT_VALUE.copy()
- 725
- 726 # Add 'body' (our own reserved word) to parameters if the method supports
- 727 # a request payload.
- 728 if http_method in HTTP_PAYLOAD_METHODS and "request" in method_desc:
- 729 body = BODY_PARAMETER_DEFAULT_VALUE.copy()
- 730 body.update(method_desc["request"])
- 731 parameters["body"] = body
- 732
- 733 return parameters
- 734
- 737 """Adds 'media_body' and 'media_mime_type' parameters if supported by method.
- 738
- 739 SIDE EFFECTS: If there is a 'mediaUpload' in the method description, adds
- 740 'media_upload' key to parameters.
- 741
- 742 Args:
- 743 method_desc: Dictionary with metadata describing an API method. Value comes
- 744 from the dictionary of methods stored in the 'methods' key in the
- 745 deserialized discovery document.
- 746 root_desc: Dictionary; the entire original deserialized discovery document.
- 747 path_url: String; the relative URL for the API method. Relative to the API
- 748 root, which is specified in the discovery document.
- 749 parameters: A dictionary describing method parameters for method described
- 750 in method_desc.
- 751
- 752 Returns:
- 753 Triple (accept, max_size, media_path_url) where:
- 754 - accept is a list of strings representing what content types are
- 755 accepted for media upload. Defaults to empty list if not in the
- 756 discovery document.
- 757 - max_size is a long representing the max size in bytes allowed for a
- 758 media upload. Defaults to 0L if not in the discovery document.
- 759 - media_path_url is a String; the absolute URI for media upload for the
- 760 API method. Constructed using the API root URI and service path from
- 761 the discovery document and the relative path for the API method. If
- 762 media upload is not supported, this is None.
- 763 """
- 764 media_upload = method_desc.get("mediaUpload", {})
- 765 accept = media_upload.get("accept", [])
- 766 max_size = _media_size_to_long(media_upload.get("maxSize", ""))
- 767 media_path_url = None
- 768
- 769 if media_upload:
- 770 media_path_url = _media_path_url_from_info(root_desc, path_url)
- 771 parameters["media_body"] = MEDIA_BODY_PARAMETER_DEFAULT_VALUE.copy()
- 772 parameters["media_mime_type"] = MEDIA_MIME_TYPE_PARAMETER_DEFAULT_VALUE.copy()
- 773
- 774 return accept, max_size, media_path_url
- 775
- 778 """Updates a method description in a discovery document.
- 779
- 780 SIDE EFFECTS: Changes the parameters dictionary in the method description with
- 781 extra parameters which are used locally.
- 782
- 783 Args:
- 784 method_desc: Dictionary with metadata describing an API method. Value comes
- 785 from the dictionary of methods stored in the 'methods' key in the
- 786 deserialized discovery document.
- 787 root_desc: Dictionary; the entire original deserialized discovery document.
- 788 schema: Object, mapping of schema names to schema descriptions.
- 789
- 790 Returns:
- 791 Tuple (path_url, http_method, method_id, accept, max_size, media_path_url)
- 792 where:
- 793 - path_url is a String; the relative URL for the API method. Relative to
- 794 the API root, which is specified in the discovery document.
- 795 - http_method is a String; the HTTP method used to call the API method
- 796 described in the method description.
- 797 - method_id is a String; the name of the RPC method associated with the
- 798 API method, and is in the method description in the 'id' key.
- 799 - accept is a list of strings representing what content types are
- 800 accepted for media upload. Defaults to empty list if not in the
- 801 discovery document.
- 802 - max_size is a long representing the max size in bytes allowed for a
- 803 media upload. Defaults to 0L if not in the discovery document.
- 804 - media_path_url is a String; the absolute URI for media upload for the
- 805 API method. Constructed using the API root URI and service path from
- 806 the discovery document and the relative path for the API method. If
- 807 media upload is not supported, this is None.
- 808 """
- 809 path_url = method_desc["path"]
- 810 http_method = method_desc["httpMethod"]
- 811 method_id = method_desc["id"]
- 812
- 813 parameters = _fix_up_parameters(method_desc, root_desc, http_method, schema)
- 814 # Order is important. `_fix_up_media_upload` needs `method_desc` to have a
- 815 # 'parameters' key and needs to know if there is a 'body' parameter because it
- 816 # also sets a 'media_body' parameter.
- 817 accept, max_size, media_path_url = _fix_up_media_upload(
- 818 method_desc, root_desc, path_url, parameters
- 819 )
- 820
- 821 return path_url, http_method, method_id, accept, max_size, media_path_url
- 822
- 825 """Custom urljoin replacement supporting : before / in url."""
- 826 # In general, it's unsafe to simply join base and url. However, for
- 827 # the case of discovery documents, we know:
- 828 # * base will never contain params, query, or fragment
- 829 # * url will never contain a scheme or net_loc.
- 830 # In general, this means we can safely join on /; we just need to
- 831 # ensure we end up with precisely one / joining base and url. The
- 832 # exception here is the case of media uploads, where url will be an
- 833 # absolute url.
- 834 if url.startswith("http://") or url.startswith("https://"):
- 835 return urljoin(base, url)
- 836 new_base = base if base.endswith("/") else base + "/"
- 837 new_url = url[1:] if url.startswith("/") else url
- 838 return new_base + new_url
- 839
- 840
- 841 # TODO(dhermes): Convert this class to ResourceMethod and make it callable
- 842 -class ResourceMethodParameters(object):
- 843 """Represents the parameters associated with a method.
- 844
- 845 Attributes:
- 846 argmap: Map from method parameter name (string) to query parameter name
- 847 (string).
- 848 required_params: List of required parameters (represented by parameter
- 849 name as string).
- 850 repeated_params: List of repeated parameters (represented by parameter
- 851 name as string).
- 852 pattern_params: Map from method parameter name (string) to regular
- 853 expression (as a string). If the pattern is set for a parameter, the
- 854 value for that parameter must match the regular expression.
- 855 query_params: List of parameters (represented by parameter name as string)
- 856 that will be used in the query string.
- 857 path_params: Set of parameters (represented by parameter name as string)
- 858 that will be used in the base URL path.
- 859 param_types: Map from method parameter name (string) to parameter type. Type
- 860 can be any valid JSON schema type; valid values are 'any', 'array',
- 861 'boolean', 'integer', 'number', 'object', or 'string'. Reference:
- 862 http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
- 863 enum_params: Map from method parameter name (string) to list of strings,
- 864 where each list of strings is the list of acceptable enum values.
- 865 """
- 866
- 868 """Constructor for ResourceMethodParameters.
- 869
- 870 Sets default values and defers to set_parameters to populate.
- 871
- 872 Args:
- 873 method_desc: Dictionary with metadata describing an API method. Value
- 874 comes from the dictionary of methods stored in the 'methods' key in
- 875 the deserialized discovery document.
- 876 """
- 877 self.argmap = {}
- 878 self.required_params = []
- 879 self.repeated_params = []
- 880 self.pattern_params = {}
- 881 self.query_params = []
- 882 # TODO(dhermes): Change path_params to a list if the extra URITEMPLATE
- 883 # parsing is gotten rid of.
- 884 self.path_params = set()
- 885 self.param_types = {}
- 886 self.enum_params = {}
- 887
- 888 self.set_parameters(method_desc)
- 889
- 891 """Populates maps and lists based on method description.
- 892
- 893 Iterates through each parameter for the method and parses the values from
- 894 the parameter dictionary.
- 895
- 896 Args:
- 897 method_desc: Dictionary with metadata describing an API method. Value
- 898 comes from the dictionary of methods stored in the 'methods' key in
- 899 the deserialized discovery document.
- 900 """
- 901 for arg, desc in six.iteritems(method_desc.get("parameters", {})):
- 902 param = key2param(arg)
- 903 self.argmap[param] = arg
- 904
- 905 if desc.get("pattern"):
- 906 self.pattern_params[param] = desc["pattern"]
- 907 if desc.get("enum"):
- 908 self.enum_params[param] = desc["enum"]
- 909 if desc.get("required"):
- 910 self.required_params.append(param)
- 911 if desc.get("repeated"):
- 912 self.repeated_params.append(param)
- 913 if desc.get("location") == "query":
- 914 self.query_params.append(param)
- 915 if desc.get("location") == "path":
- 916 self.path_params.add(param)
- 917 self.param_types[param] = desc.get("type", "string")
- 918
- 919 # TODO(dhermes): Determine if this is still necessary. Discovery based APIs
- 920 # should have all path parameters already marked with
- 921 # 'location: path'.
- 922 for match in URITEMPLATE.finditer(method_desc["path"]):
- 923 for namematch in VARNAME.finditer(match.group(0)):
- 924 name = key2param(namematch.group(0))
- 925 self.path_params.add(name)
- 926 if name in self.query_params:
- 927 self.query_params.remove(name)
- 928
- 931 """Creates a method for attaching to a Resource.
- 932
- 933 Args:
- 934 methodName: string, name of the method to use.
- 935 methodDesc: object, fragment of deserialized discovery document that
- 936 describes the method.
- 937 rootDesc: object, the entire deserialized discovery document.
- 938 schema: object, mapping of schema names to schema descriptions.
- 939 """
- 940 methodName = fix_method_name(methodName)
- 941 (
- 942 pathUrl,
- 943 httpMethod,
- 944 methodId,
- 945 accept,
- 946 maxSize,
- 947 mediaPathUrl,
- 948 ) = _fix_up_method_description(methodDesc, rootDesc, schema)
- 949
- 950 parameters = ResourceMethodParameters(methodDesc)
- 951
- 952 def method(self, **kwargs):
- 953 # Don't bother with doc string, it will be over-written by createMethod.
- 954
- 955 for name in six.iterkeys(kwargs):
- 956 if name not in parameters.argmap:
- 957 raise TypeError('Got an unexpected keyword argument "%s"' % name)
- 958
- 959 # Remove args that have a value of None.
- 960 keys = list(kwargs.keys())
- 961 for name in keys:
- 962 if kwargs[name] is None:
- 963 del kwargs[name]
- 964
- 965 for name in parameters.required_params:
- 966 if name not in kwargs:
- 967 # temporary workaround for non-paging methods incorrectly requiring
- 968 # page token parameter (cf. drive.changes.watch vs. drive.changes.list)
- 969 if name not in _PAGE_TOKEN_NAMES or _findPageTokenName(
- 970 _methodProperties(methodDesc, schema, "response")
- 971 ):
- 972 raise TypeError('Missing required parameter "%s"' % name)
- 973
- 974 for name, regex in six.iteritems(parameters.pattern_params):
- 975 if name in kwargs:
- 976 if isinstance(kwargs[name], six.string_types):
- 977 pvalues = [kwargs[name]]
- 978 else:
- 979 pvalues = kwargs[name]
- 980 for pvalue in pvalues:
- 981 if re.match(regex, pvalue) is None:
- 982 raise TypeError(
- 983 'Parameter "%s" value "%s" does not match the pattern "%s"'
- 984 % (name, pvalue, regex)
- 985 )
- 986
- 987 for name, enums in six.iteritems(parameters.enum_params):
- 988 if name in kwargs:
- 989 # We need to handle the case of a repeated enum
- 990 # name differently, since we want to handle both
- 991 # arg='value' and arg=['value1', 'value2']
- 992 if name in parameters.repeated_params and not isinstance(
- 993 kwargs[name], six.string_types
- 994 ):
- 995 values = kwargs[name]
- 996 else:
- 997 values = [kwargs[name]]
- 998 for value in values:
- 999 if value not in enums:
-1000 raise TypeError(
-1001 'Parameter "%s" value "%s" is not an allowed value in "%s"'
-1002 % (name, value, str(enums))
-1003 )
-1004
-1005 actual_query_params = {}
-1006 actual_path_params = {}
-1007 for key, value in six.iteritems(kwargs):
-1008 to_type = parameters.param_types.get(key, "string")
-1009 # For repeated parameters we cast each member of the list.
-1010 if key in parameters.repeated_params and type(value) == type([]):
-1011 cast_value = [_cast(x, to_type) for x in value]
-1012 else:
-1013 cast_value = _cast(value, to_type)
-1014 if key in parameters.query_params:
-1015 actual_query_params[parameters.argmap[key]] = cast_value
-1016 if key in parameters.path_params:
-1017 actual_path_params[parameters.argmap[key]] = cast_value
-1018 body_value = kwargs.get("body", None)
-1019 media_filename = kwargs.get("media_body", None)
-1020 media_mime_type = kwargs.get("media_mime_type", None)
-1021
-1022 if self._developerKey:
-1023 actual_query_params["key"] = self._developerKey
-1024
-1025 model = self._model
-1026 if methodName.endswith("_media"):
-1027 model = MediaModel()
-1028 elif "response" not in methodDesc:
-1029 model = RawModel()
-1030
-1031 headers = {}
-1032 headers, params, query, body = model.request(
-1033 headers, actual_path_params, actual_query_params, body_value
-1034 )
-1035
-1036 expanded_url = uritemplate.expand(pathUrl, params)
-1037 url = _urljoin(self._baseUrl, expanded_url + query)
-1038
-1039 resumable = None
-1040 multipart_boundary = ""
-1041
-1042 if media_filename:
-1043 # Ensure we end up with a valid MediaUpload object.
-1044 if isinstance(media_filename, six.string_types):
-1045 if media_mime_type is None:
-1046 logger.warning(
-1047 "media_mime_type argument not specified: trying to auto-detect for %s",
-1048 media_filename,
-1049 )
-1050 media_mime_type, _ = mimetypes.guess_type(media_filename)
-1051 if media_mime_type is None:
-1052 raise UnknownFileType(media_filename)
-1053 if not mimeparse.best_match([media_mime_type], ",".join(accept)):
-1054 raise UnacceptableMimeTypeError(media_mime_type)
-1055 media_upload = MediaFileUpload(media_filename, mimetype=media_mime_type)
-1056 elif isinstance(media_filename, MediaUpload):
-1057 media_upload = media_filename
-1058 else:
-1059 raise TypeError("media_filename must be str or MediaUpload.")
-1060
-1061 # Check the maxSize
-1062 if media_upload.size() is not None and media_upload.size() > maxSize > 0:
-1063 raise MediaUploadSizeError("Media larger than: %s" % maxSize)
-1064
-1065 # Use the media path uri for media uploads
-1066 expanded_url = uritemplate.expand(mediaPathUrl, params)
-1067 url = _urljoin(self._baseUrl, expanded_url + query)
-1068 if media_upload.resumable():
-1069 url = _add_query_parameter(url, "uploadType", "resumable")
-1070
-1071 if media_upload.resumable():
-1072 # This is all we need to do for resumable, if the body exists it gets
-1073 # sent in the first request, otherwise an empty body is sent.
-1074 resumable = media_upload
-1075 else:
-1076 # A non-resumable upload
-1077 if body is None:
-1078 # This is a simple media upload
-1079 headers["content-type"] = media_upload.mimetype()
-1080 body = media_upload.getbytes(0, media_upload.size())
-1081 url = _add_query_parameter(url, "uploadType", "media")
-1082 else:
-1083 # This is a multipart/related upload.
-1084 msgRoot = MIMEMultipart("related")
-1085 # msgRoot should not write out it's own headers
-1086 setattr(msgRoot, "_write_headers", lambda self: None)
-1087
-1088 # attach the body as one part
-1089 msg = MIMENonMultipart(*headers["content-type"].split("/"))
-1090 msg.set_payload(body)
-1091 msgRoot.attach(msg)
-1092
-1093 # attach the media as the second part
-1094 msg = MIMENonMultipart(*media_upload.mimetype().split("/"))
-1095 msg["Content-Transfer-Encoding"] = "binary"
-1096
-1097 payload = media_upload.getbytes(0, media_upload.size())
-1098 msg.set_payload(payload)
-1099 msgRoot.attach(msg)
-1100 # encode the body: note that we can't use `as_string`, because
-1101 # it plays games with `From ` lines.
-1102 fp = BytesIO()
-1103 g = _BytesGenerator(fp, mangle_from_=False)
-1104 g.flatten(msgRoot, unixfrom=False)
-1105 body = fp.getvalue()
-1106
-1107 multipart_boundary = msgRoot.get_boundary()
-1108 headers["content-type"] = (
-1109 "multipart/related; " 'boundary="%s"'
-1110 ) % multipart_boundary
-1111 url = _add_query_parameter(url, "uploadType", "multipart")
-1112
-1113 logger.debug("URL being requested: %s %s" % (httpMethod, url))
-1114 return self._requestBuilder(
-1115 self._http,
-1116 model.response,
-1117 url,
-1118 method=httpMethod,
-1119 body=body,
-1120 headers=headers,
-1121 methodId=methodId,
-1122 resumable=resumable,
-1123 )
-1124
-1125 docs = [methodDesc.get("description", DEFAULT_METHOD_DOC), "\n\n"]
-1126 if len(parameters.argmap) > 0:
-1127 docs.append("Args:\n")
-1128
-1129 # Skip undocumented params and params common to all methods.
-1130 skip_parameters = list(rootDesc.get("parameters", {}).keys())
-1131 skip_parameters.extend(STACK_QUERY_PARAMETERS)
-1132
-1133 all_args = list(parameters.argmap.keys())
-1134 args_ordered = [key2param(s) for s in methodDesc.get("parameterOrder", [])]
-1135
-1136 # Move body to the front of the line.
-1137 if "body" in all_args:
-1138 args_ordered.append("body")
-1139
-1140 for name in all_args:
-1141 if name not in args_ordered:
-1142 args_ordered.append(name)
-1143
-1144 for arg in args_ordered:
-1145 if arg in skip_parameters:
-1146 continue
-1147
-1148 repeated = ""
-1149 if arg in parameters.repeated_params:
-1150 repeated = " (repeated)"
-1151 required = ""
-1152 if arg in parameters.required_params:
-1153 required = " (required)"
-1154 paramdesc = methodDesc["parameters"][parameters.argmap[arg]]
-1155 paramdoc = paramdesc.get("description", "A parameter")
-1156 if "$ref" in paramdesc:
-1157 docs.append(
-1158 (" %s: object, %s%s%s\n The object takes the" " form of:\n\n%s\n\n")
-1159 % (
-1160 arg,
-1161 paramdoc,
-1162 required,
-1163 repeated,
-1164 schema.prettyPrintByName(paramdesc["$ref"]),
-1165 )
-1166 )
-1167 else:
-1168 paramtype = paramdesc.get("type", "string")
-1169 docs.append(
-1170 " %s: %s, %s%s%s\n" % (arg, paramtype, paramdoc, required, repeated)
-1171 )
-1172 enum = paramdesc.get("enum", [])
-1173 enumDesc = paramdesc.get("enumDescriptions", [])
-1174 if enum and enumDesc:
-1175 docs.append(" Allowed values\n")
-1176 for (name, desc) in zip(enum, enumDesc):
-1177 docs.append(" %s - %s\n" % (name, desc))
-1178 if "response" in methodDesc:
-1179 if methodName.endswith("_media"):
-1180 docs.append("\nReturns:\n The media object as a string.\n\n ")
-1181 else:
-1182 docs.append("\nReturns:\n An object of the form:\n\n ")
-1183 docs.append(schema.prettyPrintSchema(methodDesc["response"]))
-1184
-1185 setattr(method, "__doc__", "".join(docs))
-1186 return (methodName, method)
-1187
-1188
-1189 -def createNextMethod(
-1190 methodName,
-1191 pageTokenName="pageToken",
-1192 nextPageTokenName="nextPageToken",
-1193 isPageTokenParameter=True,
-1194 ):
-1195 """Creates any _next methods for attaching to a Resource.
-1196
-1197 The _next methods allow for easy iteration through list() responses.
-1198
-1199 Args:
-1200 methodName: string, name of the method to use.
-1201 pageTokenName: string, name of request page token field.
-1202 nextPageTokenName: string, name of response page token field.
-1203 isPageTokenParameter: Boolean, True if request page token is a query
-1204 parameter, False if request page token is a field of the request body.
-1205 """
-1206 methodName = fix_method_name(methodName)
-1207
-1208 def methodNext(self, previous_request, previous_response):
-1209 """Retrieves the next page of results.
-1210
-1211 Args:
-1212 previous_request: The request for the previous page. (required)
-1213 previous_response: The response from the request for the previous page. (required)
-1214
-1215 Returns:
-1216 A request object that you can call 'execute()' on to request the next
-1217 page. Returns None if there are no more items in the collection.
-1218 """
-1219 # Retrieve nextPageToken from previous_response
-1220 # Use as pageToken in previous_request to create new request.
-1221
-1222 nextPageToken = previous_response.get(nextPageTokenName, None)
-1223 if not nextPageToken:
-1224 return None
-1225
-1226 request = copy.copy(previous_request)
-1227
-1228 if isPageTokenParameter:
-1229 # Replace pageToken value in URI
-1230 request.uri = _add_query_parameter(
-1231 request.uri, pageTokenName, nextPageToken
-1232 )
-1233 logger.debug("Next page request URL: %s %s" % (methodName, request.uri))
-1234 else:
-1235 # Replace pageToken value in request body
-1236 model = self._model
-1237 body = model.deserialize(request.body)
-1238 body[pageTokenName] = nextPageToken
-1239 request.body = model.serialize(body)
-1240 logger.debug("Next page request body: %s %s" % (methodName, body))
-1241
-1242 return request
-1243
-1244 return (methodName, methodNext)
-1245
-1248 """A class for interacting with a resource."""
-1249
-1250 - def __init__(
-1251 self,
-1252 http,
-1253 baseUrl,
-1254 model,
-1255 requestBuilder,
-1256 developerKey,
-1257 resourceDesc,
-1258 rootDesc,
-1259 schema,
-1260 ):
-1261 """Build a Resource from the API description.
-1262
-1263 Args:
-1264 http: httplib2.Http, Object to make http requests with.
-1265 baseUrl: string, base URL for the API. All requests are relative to this
-1266 URI.
-1267 model: googleapiclient.Model, converts to and from the wire format.
-1268 requestBuilder: class or callable that instantiates an
-1269 googleapiclient.HttpRequest object.
-1270 developerKey: string, key obtained from
-1271 https://code.google.com/apis/console
-1272 resourceDesc: object, section of deserialized discovery document that
-1273 describes a resource. Note that the top level discovery document
-1274 is considered a resource.
-1275 rootDesc: object, the entire deserialized discovery document.
-1276 schema: object, mapping of schema names to schema descriptions.
-1277 """
-1278 self._dynamic_attrs = []
-1279
-1280 self._http = http
-1281 self._baseUrl = baseUrl
-1282 self._model = model
-1283 self._developerKey = developerKey
-1284 self._requestBuilder = requestBuilder
-1285 self._resourceDesc = resourceDesc
-1286 self._rootDesc = rootDesc
-1287 self._schema = schema
-1288
-1289 self._set_service_methods()
-1290
-1292 """Sets an instance attribute and tracks it in a list of dynamic attributes.
-1293
-1294 Args:
-1295 attr_name: string; The name of the attribute to be set
-1296 value: The value being set on the object and tracked in the dynamic cache.
-1297 """
-1298 self._dynamic_attrs.append(attr_name)
-1299 self.__dict__[attr_name] = value
-1300
-1302 """Trim the state down to something that can be pickled.
-1303
-1304 Uses the fact that the instance variable _dynamic_attrs holds attrs that
-1305 will be wiped and restored on pickle serialization.
-1306 """
-1307 state_dict = copy.copy(self.__dict__)
-1308 for dynamic_attr in self._dynamic_attrs:
-1309 del state_dict[dynamic_attr]
-1310 del state_dict["_dynamic_attrs"]
-1311 return state_dict
-1312
-1314 """Reconstitute the state of the object from being pickled.
-1315
-1316 Uses the fact that the instance variable _dynamic_attrs holds attrs that
-1317 will be wiped and restored on pickle serialization.
-1318 """
-1319 self.__dict__.update(state)
-1320 self._dynamic_attrs = []
-1321 self._set_service_methods()
-1322
-1323
-1326
-1328 self.close()
-1329
-1331 """Close httplib2 connections."""
-1332 # httplib2 leaves sockets open by default.
-1333 # Cleanup using the `close` method.
-1334 # https://github.com/httplib2/httplib2/issues/148
-1335 self._http.http.close()
-1336
-1338 self._add_basic_methods(self._resourceDesc, self._rootDesc, self._schema)
-1339 self._add_nested_resources(self._resourceDesc, self._rootDesc, self._schema)
-1340 self._add_next_methods(self._resourceDesc, self._schema)
-1341
-1343 # If this is the root Resource, add a new_batch_http_request() method.
-1344 if resourceDesc == rootDesc:
-1345 batch_uri = "%s%s" % (
-1346 rootDesc["rootUrl"],
-1347 rootDesc.get("batchPath", "batch"),
-1348 )
-1349
-1350 def new_batch_http_request(callback=None):
-1351 """Create a BatchHttpRequest object based on the discovery document.
-1352
-1353 Args:
-1354 callback: callable, A callback to be called for each response, of the
-1355 form callback(id, response, exception). The first parameter is the
-1356 request id, and the second is the deserialized response object. The
-1357 third is an apiclient.errors.HttpError exception object if an HTTP
-1358 error occurred while processing the request, or None if no error
-1359 occurred.
-1360
-1361 Returns:
-1362 A BatchHttpRequest object based on the discovery document.
-1363 """
-1364 return BatchHttpRequest(callback=callback, batch_uri=batch_uri)
-1365
-1366 self._set_dynamic_attr("new_batch_http_request", new_batch_http_request)
-1367
-1368 # Add basic methods to Resource
-1369 if "methods" in resourceDesc:
-1370 for methodName, methodDesc in six.iteritems(resourceDesc["methods"]):
-1371 fixedMethodName, method = createMethod(
-1372 methodName, methodDesc, rootDesc, schema
-1373 )
-1374 self._set_dynamic_attr(
-1375 fixedMethodName, method.__get__(self, self.__class__)
-1376 )
-1377 # Add in _media methods. The functionality of the attached method will
-1378 # change when it sees that the method name ends in _media.
-1379 if methodDesc.get("supportsMediaDownload", False):
-1380 fixedMethodName, method = createMethod(
-1381 methodName + "_media", methodDesc, rootDesc, schema
-1382 )
-1383 self._set_dynamic_attr(
-1384 fixedMethodName, method.__get__(self, self.__class__)
-1385 )
-1386
-1388 # Add in nested resources
-1389 if "resources" in resourceDesc:
-1390
-1391 def createResourceMethod(methodName, methodDesc):
-1392 """Create a method on the Resource to access a nested Resource.
-1393
-1394 Args:
-1395 methodName: string, name of the method to use.
-1396 methodDesc: object, fragment of deserialized discovery document that
-1397 describes the method.
-1398 """
-1399 methodName = fix_method_name(methodName)
-1400
-1401 def methodResource(self):
-1402 return Resource(
-1403 http=self._http,
-1404 baseUrl=self._baseUrl,
-1405 model=self._model,
-1406 developerKey=self._developerKey,
-1407 requestBuilder=self._requestBuilder,
-1408 resourceDesc=methodDesc,
-1409 rootDesc=rootDesc,
-1410 schema=schema,
-1411 )
-1412
-1413 setattr(methodResource, "__doc__", "A collection resource.")
-1414 setattr(methodResource, "__is_resource__", True)
-1415
-1416 return (methodName, methodResource)
-1417
-1418 for methodName, methodDesc in six.iteritems(resourceDesc["resources"]):
-1419 fixedMethodName, method = createResourceMethod(methodName, methodDesc)
-1420 self._set_dynamic_attr(
-1421 fixedMethodName, method.__get__(self, self.__class__)
-1422 )
-1423
-1425 # Add _next() methods if and only if one of the names 'pageToken' or
-1426 # 'nextPageToken' occurs among the fields of both the method's response
-1427 # type either the method's request (query parameters) or request body.
-1428 if "methods" not in resourceDesc:
-1429 return
-1430 for methodName, methodDesc in six.iteritems(resourceDesc["methods"]):
-1431 nextPageTokenName = _findPageTokenName(
-1432 _methodProperties(methodDesc, schema, "response")
-1433 )
-1434 if not nextPageTokenName:
-1435 continue
-1436 isPageTokenParameter = True
-1437 pageTokenName = _findPageTokenName(methodDesc.get("parameters", {}))
-1438 if not pageTokenName:
-1439 isPageTokenParameter = False
-1440 pageTokenName = _findPageTokenName(
-1441 _methodProperties(methodDesc, schema, "request")
-1442 )
-1443 if not pageTokenName:
-1444 continue
-1445 fixedMethodName, method = createNextMethod(
-1446 methodName + "_next",
-1447 pageTokenName,
-1448 nextPageTokenName,
-1449 isPageTokenParameter,
-1450 )
-1451 self._set_dynamic_attr(
-1452 fixedMethodName, method.__get__(self, self.__class__)
-1453 )
-1454
-1457 """Search field names for one like a page token.
-1458
-1459 Args:
-1460 fields: container of string, names of fields.
-1461
-1462 Returns:
-1463 First name that is either 'pageToken' or 'nextPageToken' if one exists,
-1464 otherwise None.
-1465 """
-1466 return next(
-1467 (tokenName for tokenName in _PAGE_TOKEN_NAMES if tokenName in fields), None
-1468 )
-1469
-1472 """Get properties of a field in a method description.
-1473
-1474 Args:
-1475 methodDesc: object, fragment of deserialized discovery document that
-1476 describes the method.
-1477 schema: object, mapping of schema names to schema descriptions.
-1478 name: string, name of top-level field in method description.
-1479
-1480 Returns:
-1481 Object representing fragment of deserialized discovery document
-1482 corresponding to 'properties' field of object corresponding to named field
-1483 in method description, if it exists, otherwise empty dict.
-1484 """
-1485 desc = methodDesc.get(name, {})
-1486 if "$ref" in desc:
-1487 desc = schema.get(desc["$ref"], {})
-1488 return desc.get("properties", {})
-1489
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.discovery.Resource-class.html b/docs/epy/googleapiclient.discovery.Resource-class.html
deleted file mode 100644
index 95f9f2120c8..00000000000
--- a/docs/epy/googleapiclient.discovery.Resource-class.html
+++ /dev/null
@@ -1,517 +0,0 @@
-
-
-
-
- googleapiclient.discovery.Resource
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class Resource
-
-object --+
- |
- Resource
-
-
-
-A class for interacting with a resource.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- http,
- baseUrl,
- model,
- requestBuilder,
- developerKey,
- resourceDesc,
- rootDesc,
- schema)
- Build a Resource from the API description.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _set_dynamic_attr(self,
- attr_name,
- value)
- Sets an instance attribute and tracks it in a list of dynamic attributes.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- __getstate__(self)
- Trim the state down to something that can be pickled.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- __setstate__(self,
- state)
- Reconstitute the state of the object from being pickled.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- __enter__(self)
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- __exit__(self,
- exc_type,
- exc,
- exc_tb)
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- close(self)
- Close httplib2 connections.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _set_service_methods(self)
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _add_basic_methods(self,
- resourceDesc,
- rootDesc,
- schema)
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _add_nested_resources(self,
- resourceDesc,
- rootDesc,
- schema)
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _add_next_methods(self,
- resourceDesc,
- schema)
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- http,
- baseUrl,
- model,
- requestBuilder,
- developerKey,
- resourceDesc,
- rootDesc,
- schema)
-
(Constructor)
-
- source code
-
-
-
-
-Build a Resource from the API description.
-
-Args:
- http: httplib2.Http, Object to make http requests with.
- baseUrl: string, base URL for the API. All requests are relative to this
- URI.
- model: googleapiclient.Model, converts to and from the wire format.
- requestBuilder: class or callable that instantiates an
- googleapiclient.HttpRequest object.
- developerKey: string, key obtained from
- https://code.google.com/apis/console
- resourceDesc: object, section of deserialized discovery document that
- describes a resource. Note that the top level discovery document
- is considered a resource.
- rootDesc: object, the entire deserialized discovery document.
- schema: object, mapping of schema names to schema descriptions.
-
-
-
- - Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
-
- _set_dynamic_attr(self,
- attr_name,
- value)
-
- source code
-
-
-
-
-Sets an instance attribute and tracks it in a list of dynamic attributes.
-
-Args:
- attr_name: string; The name of the attribute to be set
- value: The value being set on the object and tracked in the dynamic cache.
-
-
-
-
-
-
-
-
-
-
-
-
- __getstate__(self)
-
- source code
-
-
-
- Trim the state down to something that can be pickled.
- Uses the fact that the instance variable _dynamic_attrs holds attrs
- that will be wiped and restored on pickle serialization.
-
-
-
-
-
-
-
-
-
-
- __setstate__(self,
- state)
-
- source code
-
-
-
- Reconstitute the state of the object from being pickled.
- Uses the fact that the instance variable _dynamic_attrs holds attrs
- that will be wiped and restored on pickle serialization.
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.discovery.ResourceMethodParameters-class.html b/docs/epy/googleapiclient.discovery.ResourceMethodParameters-class.html
deleted file mode 100644
index c9955b71b78..00000000000
--- a/docs/epy/googleapiclient.discovery.ResourceMethodParameters-class.html
+++ /dev/null
@@ -1,319 +0,0 @@
-
-
-
-
- googleapiclient.discovery.ResourceMethodParameters
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class ResourceMethodParameters
-
-object --+
- |
- ResourceMethodParameters
-
-
-
-
-Represents the parameters associated with a method.
-
-Attributes:
- argmap: Map from method parameter name (string) to query parameter name
- (string).
- required_params: List of required parameters (represented by parameter
- name as string).
- repeated_params: List of repeated parameters (represented by parameter
- name as string).
- pattern_params: Map from method parameter name (string) to regular
- expression (as a string). If the pattern is set for a parameter, the
- value for that parameter must match the regular expression.
- query_params: List of parameters (represented by parameter name as string)
- that will be used in the query string.
- path_params: Set of parameters (represented by parameter name as string)
- that will be used in the base URL path.
- param_types: Map from method parameter name (string) to parameter type. Type
- can be any valid JSON schema type; valid values are 'any', 'array',
- 'boolean', 'integer', 'number', 'object', or 'string'. Reference:
- http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
- enum_params: Map from method parameter name (string) to list of strings,
- where each list of strings is the list of acceptable enum values.
-
-
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- method_desc)
- Constructor for ResourceMethodParameters.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- set_parameters(self,
- method_desc)
- Populates maps and lists based on method description.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- method_desc)
-
(Constructor)
-
- source code
-
-
-
-
-Constructor for ResourceMethodParameters.
-
-Sets default values and defers to set_parameters to populate.
-
-Args:
- method_desc: Dictionary with metadata describing an API method. Value
- comes from the dictionary of methods stored in the 'methods' key in
- the deserialized discovery document.
-
-
-
- - Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
-
- set_parameters(self,
- method_desc)
-
- source code
-
-
-
-
-Populates maps and lists based on method description.
-
-Iterates through each parameter for the method and parses the values from
-the parameter dictionary.
-
-Args:
- method_desc: Dictionary with metadata describing an API method. Value
- comes from the dictionary of methods stored in the 'methods' key in
- the deserialized discovery document.
-
-
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.discovery._BytesGenerator-class.html b/docs/epy/googleapiclient.discovery._BytesGenerator-class.html
deleted file mode 100644
index 3c6a1e9fdfb..00000000000
--- a/docs/epy/googleapiclient.discovery._BytesGenerator-class.html
+++ /dev/null
@@ -1,137 +0,0 @@
-
-
-
-
- googleapiclient.discovery._BytesGenerator
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class _BytesGenerator
-
-email.generator.Generator --+
- |
- _BytesGenerator
-
-
-
-
-
-
-
-
-
-
- Class Variables
-
-
-
-
-
-
-
-
- _write_lines = BytesGenerator.write
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.discovery_cache-module.html b/docs/epy/googleapiclient.discovery_cache-module.html
deleted file mode 100644
index 4b9b3462e84..00000000000
--- a/docs/epy/googleapiclient.discovery_cache-module.html
+++ /dev/null
@@ -1,251 +0,0 @@
-
-
-
-
- googleapiclient.discovery_cache
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Package discovery_cache
-Caching utility for the discovery document.
-
-
-
-
-
-
-
-
- Submodules
-
-
-
-
-
-
- - googleapiclient.discovery_cache.appengine_memcache: App Engine memcache based cache for the discovery document.
- - googleapiclient.discovery_cache.base: An abstract class for caching the discovery document.
- - googleapiclient.discovery_cache.file_cache: File based cache for the discovery document.
-
-
-
-
-
-
-
-
-
-
- Functions
-
-
-
-
-
-
-
-
-
-
- autodetect()
- Detects an appropriate cache module and returns it.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Variables
-
-
-
-
-
-
-
-
- LOGGER = logging.getLogger(__name__)
-
-
-
-
-
-
- DISCOVERY_DOC_MAX_AGE = 86400
-
-
-
-
-
-
- __package__ = None
-
-
-
-
-
-
-
-
-
-
- Function Details
-
-
-
-
-
-
-
-
-
-
-
- autodetect()
-
- source code
-
-
-
-
-Detects an appropriate cache module and returns it.
-
-Returns:
- googleapiclient.discovery_cache.base.Cache, a cache object which
- is auto detected, or None if no cache object is available.
-
-
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.discovery_cache-pysrc.html b/docs/epy/googleapiclient.discovery_cache-pysrc.html
deleted file mode 100644
index 361cc180588..00000000000
--- a/docs/epy/googleapiclient.discovery_cache-pysrc.html
+++ /dev/null
@@ -1,170 +0,0 @@
-
-
-
-
- googleapiclient.discovery_cache
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Source Code for Package googleapiclient.discovery_cache
-
- 1 # Copyright 2014 Google Inc. All Rights Reserved.
- 2 #
- 3 # Licensed under the Apache License, Version 2.0 (the "License");
- 4 # you may not use this file except in compliance with the License.
- 5 # You may obtain a copy of the License at
- 6 #
- 7 # http://www.apache.org/licenses/LICENSE-2.0
- 8 #
- 9 # Unless required by applicable law or agreed to in writing, software
-10 # distributed under the License is distributed on an "AS IS" BASIS,
-11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-12 # See the License for the specific language governing permissions and
-13 # limitations under the License.
-14
-15 """Caching utility for the discovery document."""
-16
-17 from __future__ import absolute_import
-18
-19 import logging
-20 import datetime
-21 import os
-22
-23 LOGGER = logging.getLogger(__name__)
-24
-25 DISCOVERY_DOC_MAX_AGE = 60 * 60 * 24 # 1 day
-26
-27
-29 """Detects an appropriate cache module and returns it.
-30
-31 Returns:
-32 googleapiclient.discovery_cache.base.Cache, a cache object which
-33 is auto detected, or None if no cache object is available.
-34 """
-35 if 'APPENGINE_RUNTIME' in os.environ:
-36 try:
-37 from google.appengine.api import memcache
-38 from . import appengine_memcache
-39
-40 return appengine_memcache.cache
-41 except Exception:
-42 pass
-43 try:
-44 from . import file_cache
-45
-46 return file_cache.cache
-47 except Exception as e:
-48 LOGGER.warning(e, exc_info=True)
-49 return None
-50
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.discovery_cache.appengine_memcache-module.html b/docs/epy/googleapiclient.discovery_cache.appengine_memcache-module.html
deleted file mode 100644
index 39b24ca20f0..00000000000
--- a/docs/epy/googleapiclient.discovery_cache.appengine_memcache-module.html
+++ /dev/null
@@ -1,172 +0,0 @@
-
-
-
-
- googleapiclient.discovery_cache.appengine_memcache
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module appengine_memcache
-App Engine memcache based cache for the discovery document.
-
-
-
-
-
-
-
-
- Classes
-
-
-
-
-
-
-
-
- Cache
- A cache with app engine memcache API.
-
-
-
-
-
-
-
-
-
-
- Variables
-
-
-
-
-
-
-
-
- LOGGER = logging.getLogger(__name__)
-
-
-
-
-
-
- NAMESPACE = "google-api-client"
-
-
-
-
-
-
- cache = Cache(max_age= DISCOVERY_DOC_MAX_AGE)
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.discovery_cache.appengine_memcache-pysrc.html b/docs/epy/googleapiclient.discovery_cache.appengine_memcache-pysrc.html
deleted file mode 100644
index bb284303f59..00000000000
--- a/docs/epy/googleapiclient.discovery_cache.appengine_memcache-pysrc.html
+++ /dev/null
@@ -1,188 +0,0 @@
-
-
-
-
- googleapiclient.discovery_cache.appengine_memcache
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Source Code for Module googleapiclient.discovery_cache.appengine_memcache
-
- 1 # Copyright 2014 Google Inc. All Rights Reserved.
- 2 #
- 3 # Licensed under the Apache License, Version 2.0 (the "License");
- 4 # you may not use this file except in compliance with the License.
- 5 # You may obtain a copy of the License at
- 6 #
- 7 # http://www.apache.org/licenses/LICENSE-2.0
- 8 #
- 9 # Unless required by applicable law or agreed to in writing, software
-10 # distributed under the License is distributed on an "AS IS" BASIS,
-11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-12 # See the License for the specific language governing permissions and
-13 # limitations under the License.
-14
-15 """App Engine memcache based cache for the discovery document."""
-16
-17 import logging
-18
-19 # This is only an optional dependency because we only import this
-20 # module when google.appengine.api.memcache is available.
-21 from google.appengine.api import memcache
-22
-23 from . import base
-24 from ..discovery_cache import DISCOVERY_DOC_MAX_AGE
-25
-26
-27 LOGGER = logging.getLogger(__name__)
-28
-29 NAMESPACE = "google-api-client"
-30
-31
-33 """A cache with app engine memcache API."""
-34
-36 """Constructor.
-37
-38 Args:
-39 max_age: Cache expiration in seconds.
-40 """
-41 self._max_age = max_age
-42
-44 try:
-45 return memcache.get(url, namespace=NAMESPACE)
-46 except Exception as e:
-47 LOGGER.warning(e, exc_info=True)
-48
-54
-55
-56 cache = Cache(max_age=DISCOVERY_DOC_MAX_AGE)
-57
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.discovery_cache.appengine_memcache.Cache-class.html b/docs/epy/googleapiclient.discovery_cache.appengine_memcache.Cache-class.html
deleted file mode 100644
index 625c4ee1a9b..00000000000
--- a/docs/epy/googleapiclient.discovery_cache.appengine_memcache.Cache-class.html
+++ /dev/null
@@ -1,404 +0,0 @@
-
-
-
-
- googleapiclient.discovery_cache.appengine_memcache.Cache
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class Cache
-
-object --+
- |
-base.Cache --+
- |
- Cache
-
-
-
-A cache with app engine memcache API.
-
-
-
-
-
-
-
-
- Nested Classes
-
-
-
-
-
-
- Inherited from base.Cache:
- __metaclass__
-
-
-
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- max_age)
- Constructor.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- get(self,
- url)
- Gets the content from the memcache with a given key.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- set(self,
- url,
- content)
- Sets the given key and content in the cache.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Class Variables
-
-
-
-
-
-
- Inherited from base.Cache:
- __abstractmethods__
-
- Inherited from base.Cache (private):
- _abc_cache,
- _abc_negative_cache,
- _abc_negative_cache_version,
- _abc_registry
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- max_age)
-
(Constructor)
-
- source code
-
-
-
-
-Constructor.
-
-Args:
- max_age: Cache expiration in seconds.
-
-
-
- - Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
-
- get(self,
- url)
-
- source code
-
-
-
-
-Gets the content from the memcache with a given key.
-
-Args:
- url: string, the key for the cache.
-
-Returns:
- object, the value in the cache for the given key, or None if the key is
- not in the cache.
-
-
-
- - Overrides:
- base.Cache.get
-
- (inherited documentation)
-
-
-
-
-
-
-
-
-
-
- set(self,
- url,
- content)
-
- source code
-
-
-
-
-Sets the given key and content in the cache.
-
-Args:
- url: string, the key for the cache.
- content: string, the discovery document.
-
-
-
- - Overrides:
- base.Cache.set
-
- (inherited documentation)
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.discovery_cache.base-module.html b/docs/epy/googleapiclient.discovery_cache.base-module.html
deleted file mode 100644
index 027251a1374..00000000000
--- a/docs/epy/googleapiclient.discovery_cache.base-module.html
+++ /dev/null
@@ -1,158 +0,0 @@
-
-
-
-
- googleapiclient.discovery_cache.base
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module base
-An abstract class for caching the discovery document.
-
-
-
-
-
-
-
-
- Classes
-
-
-
-
-
-
-
-
- Cache
- A base abstract cache class.
-
-
-
-
-
-
-
-
-
-
- Variables
-
-
-
-
-
-
-
-
- __package__ = 'googleapiclient.discovery_cache'
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.discovery_cache.base-pysrc.html b/docs/epy/googleapiclient.discovery_cache.base-pysrc.html
deleted file mode 100644
index 9abf76f0422..00000000000
--- a/docs/epy/googleapiclient.discovery_cache.base-pysrc.html
+++ /dev/null
@@ -1,158 +0,0 @@
-
-
-
-
- googleapiclient.discovery_cache.base
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Source Code for Module googleapiclient.discovery_cache.base
-
- 1 # Copyright 2014 Google Inc. All Rights Reserved.
- 2 #
- 3 # Licensed under the Apache License, Version 2.0 (the "License");
- 4 # you may not use this file except in compliance with the License.
- 5 # You may obtain a copy of the License at
- 6 #
- 7 # http://www.apache.org/licenses/LICENSE-2.0
- 8 #
- 9 # Unless required by applicable law or agreed to in writing, software
-10 # distributed under the License is distributed on an "AS IS" BASIS,
-11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-12 # See the License for the specific language governing permissions and
-13 # limitations under the License.
-14
-15 """An abstract class for caching the discovery document."""
-16
-17 import abc
-21 """A base abstract cache class."""
-22
-23 __metaclass__ = abc.ABCMeta
-24
-25 @abc.abstractmethod
-27 """Gets the content from the memcache with a given key.
-28
-29 Args:
-30 url: string, the key for the cache.
-31
-32 Returns:
-33 object, the value in the cache for the given key, or None if the key is
-34 not in the cache.
-35 """
-36 raise NotImplementedError()
-37
-38 @abc.abstractmethod
-47
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.discovery_cache.base.Cache-class.html b/docs/epy/googleapiclient.discovery_cache.base.Cache-class.html
deleted file mode 100644
index a604c954655..00000000000
--- a/docs/epy/googleapiclient.discovery_cache.base.Cache-class.html
+++ /dev/null
@@ -1,415 +0,0 @@
-
-
-
-
- googleapiclient.discovery_cache.base.Cache
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class Cache
-
-object --+
- |
- Cache
-
-
-
-A base abstract cache class.
-
-
-
-
-
-
-
-
- Nested Classes
-
-
-
-
-
-
-
-
- __metaclass__
- Metaclass for defining Abstract Base Classes (ABCs).
-
-
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- get(self,
- url)
- Gets the content from the memcache with a given key.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- set(self,
- url,
- content)
- Sets the given key and content in the cache.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __init__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Class Variables
-
-
-
-
-
-
-
-
- __abstractmethods__ = frozenset(['get', 'set'])
-
-
-
-
-
- _abc_cache = <_weakrefset.WeakSet object at 0x7fb69e350450>
-
-
-
-
-
-
- _abc_negative_cache = <_weakrefset.WeakSet object at 0x7fb69e3...
-
-
-
-
-
-
- _abc_negative_cache_version = 22
-
-
-
-
-
-
- _abc_registry = <_weakrefset.WeakSet object at 0x7fb69e350490>
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- get(self,
- url)
-
- source code
-
-
-
-
-Gets the content from the memcache with a given key.
-
-Args:
- url: string, the key for the cache.
-
-Returns:
- object, the value in the cache for the given key, or None if the key is
- not in the cache.
-
-
-
- - Decorators:
-
- @abc.abstractmethod
-
-
-
-
-
-
-
-
- set(self,
- url,
- content)
-
- source code
-
-
-
-
-Sets the given key and content in the cache.
-
-Args:
- url: string, the key for the cache.
- content: string, the discovery document.
-
-
-
- - Decorators:
-
- @abc.abstractmethod
-
-
-
-
-
-
-
-
-
-
- Class Variable Details
-
-
-
-
-
-
-
-
-
- _abc_negative_cache
-
-
-
-
- - Value:
-
-<_weakrefset.WeakSet object at 0x7fb69e350510>
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.discovery_cache.file_cache-module.html b/docs/epy/googleapiclient.discovery_cache.file_cache-module.html
deleted file mode 100644
index 503a269fe58..00000000000
--- a/docs/epy/googleapiclient.discovery_cache.file_cache-module.html
+++ /dev/null
@@ -1,233 +0,0 @@
-
-
-
-
- googleapiclient.discovery_cache.file_cache
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module file_cache
-File based cache for the discovery document.
- The cache is stored in a single file so that multiple processes can
- share the same cache. It locks the file whenever accesing to the file.
- When the cache content is corrupted, it will be initialized with an empty
- cache.
-
-
-
-
-
-
-
-
- Classes
-
-
-
-
-
-
-
-
- Cache
- A file based cache for the discovery documents.
-
-
-
-
-
-
-
-
-
-
- Functions
-
-
-
-
-
-
-
-
-
-
- _to_timestamp(date)
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _read_or_initialize_cache(f)
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.discovery_cache.file_cache-pysrc.html b/docs/epy/googleapiclient.discovery_cache.file_cache-pysrc.html
deleted file mode 100644
index 824a0b092cf..00000000000
--- a/docs/epy/googleapiclient.discovery_cache.file_cache-pysrc.html
+++ /dev/null
@@ -1,303 +0,0 @@
-
-
-
-
- googleapiclient.discovery_cache.file_cache
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Source Code for Module googleapiclient.discovery_cache.file_cache
-
- 1 # Copyright 2014 Google Inc. All Rights Reserved.
- 2 #
- 3 # Licensed under the Apache License, Version 2.0 (the "License");
- 4 # you may not use this file except in compliance with the License.
- 5 # You may obtain a copy of the License at
- 6 #
- 7 # http://www.apache.org/licenses/LICENSE-2.0
- 8 #
- 9 # Unless required by applicable law or agreed to in writing, software
- 10 # distributed under the License is distributed on an "AS IS" BASIS,
- 11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- 12 # See the License for the specific language governing permissions and
- 13 # limitations under the License.
- 14
- 15 """File based cache for the discovery document.
- 16
- 17 The cache is stored in a single file so that multiple processes can
- 18 share the same cache. It locks the file whenever accesing to the
- 19 file. When the cache content is corrupted, it will be initialized with
- 20 an empty cache.
- 21 """
- 22
- 23 from __future__ import division
- 24
- 25 import datetime
- 26 import json
- 27 import logging
- 28 import os
- 29 import tempfile
- 30 import threading
- 31
- 32 try:
- 33 from oauth2client.contrib.locked_file import LockedFile
- 34 except ImportError:
- 35 # oauth2client < 2.0.0
- 36 try:
- 37 from oauth2client.locked_file import LockedFile
- 38 except ImportError:
- 39 # oauth2client > 4.0.0 or google-auth
- 40 raise ImportError(
- 41 "file_cache is unavailable when using oauth2client >= 4.0.0 or google-auth"
- 42 )
- 43
- 44 from . import base
- 45 from ..discovery_cache import DISCOVERY_DOC_MAX_AGE
- 46
- 47 LOGGER = logging.getLogger(__name__)
- 48
- 49 FILENAME = "google-api-python-client-discovery-doc.cache"
- 50 EPOCH = datetime.datetime.utcfromtimestamp(0)
- 51
- 52
- 54 try:
- 55 return (date - EPOCH).total_seconds()
- 56 except AttributeError:
- 57 # The following is the equivalent of total_seconds() in Python2.6.
- 58 # See also: https://docs.python.org/2/library/datetime.html
- 59 delta = date - EPOCH
- 60 return (
- 61 delta.microseconds + (delta.seconds + delta.days * 24 * 3600) * 10 ** 6
- 62 ) / 10 ** 6
- 63
- 64
- 66 f.file_handle().seek(0)
- 67 try:
- 68 cache = json.load(f.file_handle())
- 69 except Exception:
- 70 # This means it opens the file for the first time, or the cache is
- 71 # corrupted, so initializing the file with an empty dict.
- 72 cache = {}
- 73 f.file_handle().truncate(0)
- 74 f.file_handle().seek(0)
- 75 json.dump(cache, f.file_handle())
- 76 return cache
- 77
- 78
- 80 """A file based cache for the discovery documents."""
- 81
- 83 """Constructor.
- 84
- 85 Args:
- 86 max_age: Cache expiration in seconds.
- 87 """
- 88 self._max_age = max_age
- 89 self._file = os.path.join(tempfile.gettempdir(), FILENAME)
- 90 f = LockedFile(self._file, "a+", "r")
- 91 try:
- 92 f.open_and_lock()
- 93 if f.is_locked():
- 94 _read_or_initialize_cache(f)
- 95 # If we can not obtain the lock, other process or thread must
- 96 # have initialized the file.
- 97 except Exception as e:
- 98 LOGGER.warning(e, exc_info=True)
- 99 finally:
-100 f.unlock_and_close()
-101
-103 f = LockedFile(self._file, "r+", "r")
-104 try:
-105 f.open_and_lock()
-106 if f.is_locked():
-107 cache = _read_or_initialize_cache(f)
-108 if url in cache:
-109 content, t = cache.get(url, (None, 0))
-110 if _to_timestamp(datetime.datetime.now()) < t + self._max_age:
-111 return content
-112 return None
-113 else:
-114 LOGGER.debug("Could not obtain a lock for the cache file.")
-115 return None
-116 except Exception as e:
-117 LOGGER.warning(e, exc_info=True)
-118 finally:
-119 f.unlock_and_close()
-120
-122 f = LockedFile(self._file, "r+", "r")
-123 try:
-124 f.open_and_lock()
-125 if f.is_locked():
-126 cache = _read_or_initialize_cache(f)
-127 cache[url] = (content, _to_timestamp(datetime.datetime.now()))
-128 # Remove stale cache.
-129 for k, (_, timestamp) in list(cache.items()):
-130 if (
-131 _to_timestamp(datetime.datetime.now())
-132 >= timestamp + self._max_age
-133 ):
-134 del cache[k]
-135 f.file_handle().truncate(0)
-136 f.file_handle().seek(0)
-137 json.dump(cache, f.file_handle())
-138 else:
-139 LOGGER.debug("Could not obtain a lock for the cache file.")
-140 except Exception as e:
-141 LOGGER.warning(e, exc_info=True)
-142 finally:
-143 f.unlock_and_close()
-144
-145
-146 cache = Cache(max_age=DISCOVERY_DOC_MAX_AGE)
-147
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.discovery_cache.file_cache.Cache-class.html b/docs/epy/googleapiclient.discovery_cache.file_cache.Cache-class.html
deleted file mode 100644
index 56483f623ad..00000000000
--- a/docs/epy/googleapiclient.discovery_cache.file_cache.Cache-class.html
+++ /dev/null
@@ -1,404 +0,0 @@
-
-
-
-
- googleapiclient.discovery_cache.file_cache.Cache
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class Cache
-
-object --+
- |
-base.Cache --+
- |
- Cache
-
-
-
-A file based cache for the discovery documents.
-
-
-
-
-
-
-
-
- Nested Classes
-
-
-
-
-
-
- Inherited from base.Cache:
- __metaclass__
-
-
-
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- max_age)
- Constructor.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- get(self,
- url)
- Gets the content from the memcache with a given key.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- set(self,
- url,
- content)
- Sets the given key and content in the cache.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Class Variables
-
-
-
-
-
-
- Inherited from base.Cache:
- __abstractmethods__
-
- Inherited from base.Cache (private):
- _abc_cache,
- _abc_negative_cache,
- _abc_negative_cache_version,
- _abc_registry
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- max_age)
-
(Constructor)
-
- source code
-
-
-
-
-Constructor.
-
-Args:
- max_age: Cache expiration in seconds.
-
-
-
- - Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
-
- get(self,
- url)
-
- source code
-
-
-
-
-Gets the content from the memcache with a given key.
-
-Args:
- url: string, the key for the cache.
-
-Returns:
- object, the value in the cache for the given key, or None if the key is
- not in the cache.
-
-
-
- - Overrides:
- base.Cache.get
-
- (inherited documentation)
-
-
-
-
-
-
-
-
-
-
- set(self,
- url,
- content)
-
- source code
-
-
-
-
-Sets the given key and content in the cache.
-
-Args:
- url: string, the key for the cache.
- content: string, the discovery document.
-
-
-
- - Overrides:
- base.Cache.set
-
- (inherited documentation)
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.errors-module.html b/docs/epy/googleapiclient.errors-module.html
deleted file mode 100644
index dbca37f9754..00000000000
--- a/docs/epy/googleapiclient.errors-module.html
+++ /dev/null
@@ -1,267 +0,0 @@
-
-
-
-
- googleapiclient.errors
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module errors
-Errors for the library.
- All exceptions defined by the library should be defined in this
- file.
-
-
- Author:
- jcgregorio@google.com (Joe Gregorio)
-
-
-
-
-
-
-
-
- Classes
-
-
-
-
-
-
-
-
- Error
- Base error for this module.
-
-
-
-
-
-
- HttpError
- HTTP data was invalid or unexpected.
-
-
-
-
-
-
- InvalidJsonError
- The JSON returned could not be parsed.
-
-
-
-
-
-
- UnknownFileType
- File type unknown or unexpected.
-
-
-
-
-
-
- UnknownLinkType
- Link type unknown or unexpected.
-
-
-
-
-
-
- UnknownApiNameOrVersion
- No API with that name and version exists.
-
-
-
-
-
-
- UnacceptableMimeTypeError
- That is an unacceptable mimetype for this operation.
-
-
-
-
-
-
- MediaUploadSizeError
- Media is larger than the method can accept.
-
-
-
-
-
-
- ResumableUploadError
- Error occurred during resumable upload.
-
-
-
-
-
-
- InvalidChunkSizeError
- The given chunksize is not valid.
-
-
-
-
-
-
- InvalidNotificationError
- The channel Notification is invalid.
-
-
-
-
-
-
- BatchError
- Error occurred during batch operations.
-
-
-
-
-
-
- UnexpectedMethodError
- Exception raised by RequestMockBuilder on unexpected calls.
-
-
-
-
-
-
- UnexpectedBodyError
- Exception raised by RequestMockBuilder on unexpected bodies.
-
-
-
-
-
-
-
-
-
-
- Variables
-
-
-
-
-
-
-
-
- __package__ = None
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.errors-pysrc.html b/docs/epy/googleapiclient.errors-pysrc.html
deleted file mode 100644
index 7e6d8110c12..00000000000
--- a/docs/epy/googleapiclient.errors-pysrc.html
+++ /dev/null
@@ -1,345 +0,0 @@
-
-
-
-
- googleapiclient.errors
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Source Code for Module googleapiclient.errors
-
- 1 # Copyright 2014 Google Inc. All Rights Reserved.
- 2 #
- 3 # Licensed under the Apache License, Version 2.0 (the "License");
- 4 # you may not use this file except in compliance with the License.
- 5 # You may obtain a copy of the License at
- 6 #
- 7 # http://www.apache.org/licenses/LICENSE-2.0
- 8 #
- 9 # Unless required by applicable law or agreed to in writing, software
- 10 # distributed under the License is distributed on an "AS IS" BASIS,
- 11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- 12 # See the License for the specific language governing permissions and
- 13 # limitations under the License.
- 14
- 15 """Errors for the library.
- 16
- 17 All exceptions defined by the library
- 18 should be defined in this file.
- 19 """
- 20 from __future__ import absolute_import
- 21
- 22 __author__ = "jcgregorio@google.com (Joe Gregorio)"
- 23
- 24 import json
- 25
- 26 from googleapiclient import _helpers as util
- 33
- 36 """HTTP data was invalid or unexpected."""
- 37
- 38 @util.positional(3)
- 40 self.resp = resp
- 41 if not isinstance(content, bytes):
- 42 raise TypeError("HTTP content should be bytes")
- 43 self.content = content
- 44 self.uri = uri
- 45 self.error_details = ""
- 46
- 48 """Calculate the reason for the error from the response content."""
- 49 reason = self.resp.reason
- 50 try:
- 51 data = json.loads(self.content.decode("utf-8"))
- 52 if isinstance(data, dict):
- 53 reason = data["error"]["message"]
- 54 if "details" in data["error"]:
- 55 self.error_details = data["error"]["details"]
- 56 elif "detail" in data["error"]:
- 57 self.error_details = data["error"]["detail"]
- 58 elif isinstance(data, list) and len(data) > 0:
- 59 first_error = data[0]
- 60 reason = first_error["error"]["message"]
- 61 if "details" in first_error["error"]:
- 62 self.error_details = first_error["error"]["details"]
- 63 except (ValueError, KeyError, TypeError):
- 64 pass
- 65 if reason is None:
- 66 reason = ""
- 67 return reason
- 68
- 70 reason = self._get_reason()
- 71 if self.error_details:
- 72 return '<HttpError %s when requesting %s returned "%s". Details: "%s">' % (
- 73 self.resp.status,
- 74 self.uri,
- 75 reason.strip(),
- 76 self.error_details,
- 77 )
- 78 elif self.uri:
- 79 return '<HttpError %s when requesting %s returned "%s">' % (
- 80 self.resp.status,
- 81 self.uri,
- 82 self._get_reason().strip(),
- 83 )
- 84 else:
- 85 return '<HttpError %s "%s">' % (self.resp.status, self._get_reason())
- 86
- 87 __str__ = __repr__
- 88
- 94
-100
-106
-112
-118
-124
-130
-136
-142
-145 """Error occurred during batch operations."""
-146
-147 @util.positional(2)
-152
-154 if getattr(self.resp, "status", None) is None:
-155 return '<BatchError "%s">' % (self.reason)
-156 else:
-157 return '<BatchError %s "%s">' % (self.resp.status, self.reason)
-158
-159 __str__ = __repr__
-160
-163 """Exception raised by RequestMockBuilder on unexpected calls."""
-164
-165 @util.positional(1)
-167 """Constructor for an UnexpectedMethodError."""
-168 super(UnexpectedMethodError, self).__init__(
-169 "Received unexpected call %s" % methodId
-170 )
-171
-174 """Exception raised by RequestMockBuilder on unexpected bodies."""
-175
-177 """Constructor for an UnexpectedMethodError."""
-178 super(UnexpectedBodyError, self).__init__(
-179 "Expected: [%s] - Provided: [%s]" % (expected, provided)
-180 )
-181
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.errors.BatchError-class.html b/docs/epy/googleapiclient.errors.BatchError-class.html
deleted file mode 100644
index a2c838e6333..00000000000
--- a/docs/epy/googleapiclient.errors.BatchError-class.html
+++ /dev/null
@@ -1,344 +0,0 @@
-
-
-
-
- googleapiclient.errors.BatchError
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class BatchError
-
- object --+
- |
-exceptions.BaseException --+
- |
- exceptions.Exception --+
- |
- Error --+
- |
- HttpError --+
- |
- BatchError
-
-
-
-Error occurred during batch operations.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
- x.__init__(...) initializes x; see help(type(x)) for signature
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- __repr__(self)
- str(x)
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- __str__(self)
- str(x)
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from HttpError (private):
- _get_reason
-
- Inherited from exceptions.Exception:
- __new__
-
- Inherited from exceptions.BaseException:
- __delattr__,
- __getattribute__,
- __getitem__,
- __getslice__,
- __reduce__,
- __setattr__,
- __setstate__,
- __unicode__
-
- Inherited from object:
- __format__,
- __hash__,
- __reduce_ex__,
- __sizeof__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from exceptions.BaseException:
- args,
- message
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
-
(Constructor)
-
- source code
-
-
-
- x.__init__(...) initializes x; see help(type(x)) for signature
-
- - Decorators:
-
- @util.positional(2)
- Overrides:
- object.__init__
-
- (inherited documentation)
-
-
-
-
-
-
-
-
-
-
- __repr__(self)
-
(Representation operator)
-
- source code
-
-
-
- str(x)
-
- - Overrides:
- object.__repr__
-
- (inherited documentation)
-
-
-
-
-
-
-
-
-
-
- __str__(self)
-
(Informal representation operator)
-
- source code
-
-
-
- str(x)
-
- - Overrides:
- object.__str__
-
- (inherited documentation)
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.errors.Error-class.html b/docs/epy/googleapiclient.errors.Error-class.html
deleted file mode 100644
index 2aca9c6b918..00000000000
--- a/docs/epy/googleapiclient.errors.Error-class.html
+++ /dev/null
@@ -1,198 +0,0 @@
-
-
-
-
- googleapiclient.errors.Error
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class Error
-
- object --+
- |
-exceptions.BaseException --+
- |
- exceptions.Exception --+
- |
- Error
-
-
-- Known Subclasses:
--
-
-
-
-
-Base error for this module.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
- Inherited from exceptions.Exception:
- __init__,
- __new__
-
- Inherited from exceptions.BaseException:
- __delattr__,
- __getattribute__,
- __getitem__,
- __getslice__,
- __reduce__,
- __repr__,
- __setattr__,
- __setstate__,
- __str__,
- __unicode__
-
- Inherited from object:
- __format__,
- __hash__,
- __reduce_ex__,
- __sizeof__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from exceptions.BaseException:
- args,
- message
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.errors.HttpError-class.html b/docs/epy/googleapiclient.errors.HttpError-class.html
deleted file mode 100644
index 876bff07b7a..00000000000
--- a/docs/epy/googleapiclient.errors.HttpError-class.html
+++ /dev/null
@@ -1,362 +0,0 @@
-
-
-
-
- googleapiclient.errors.HttpError
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class HttpError
-
- object --+
- |
-exceptions.BaseException --+
- |
- exceptions.Exception --+
- |
- Error --+
- |
- HttpError
-
-
-- Known Subclasses:
--
-
-
-
-
-HTTP data was invalid or unexpected.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
- x.__init__(...) initializes x; see help(type(x)) for signature
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _get_reason(self)
- Calculate the reason for the error from the response content.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- __repr__(self)
- str(x)
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- __str__(self)
- str(x)
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from exceptions.Exception:
- __new__
-
- Inherited from exceptions.BaseException:
- __delattr__,
- __getattribute__,
- __getitem__,
- __getslice__,
- __reduce__,
- __setattr__,
- __setstate__,
- __unicode__
-
- Inherited from object:
- __format__,
- __hash__,
- __reduce_ex__,
- __sizeof__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from exceptions.BaseException:
- args,
- message
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
-
(Constructor)
-
- source code
-
-
-
- x.__init__(...) initializes x; see help(type(x)) for signature
-
- - Decorators:
-
- @util.positional(3)
- Overrides:
- object.__init__
-
- (inherited documentation)
-
-
-
-
-
-
-
-
-
-
- __repr__(self)
-
(Representation operator)
-
- source code
-
-
-
- str(x)
-
- - Overrides:
- object.__repr__
-
- (inherited documentation)
-
-
-
-
-
-
-
-
-
-
- __str__(self)
-
(Informal representation operator)
-
- source code
-
-
-
- str(x)
-
- - Overrides:
- object.__str__
-
- (inherited documentation)
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.errors.InvalidChunkSizeError-class.html b/docs/epy/googleapiclient.errors.InvalidChunkSizeError-class.html
deleted file mode 100644
index d15621e96bc..00000000000
--- a/docs/epy/googleapiclient.errors.InvalidChunkSizeError-class.html
+++ /dev/null
@@ -1,194 +0,0 @@
-
-
-
-
- googleapiclient.errors.InvalidChunkSizeError
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class InvalidChunkSizeError
-
- object --+
- |
-exceptions.BaseException --+
- |
- exceptions.Exception --+
- |
- Error --+
- |
- InvalidChunkSizeError
-
-
-
-The given chunksize is not valid.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
- Inherited from exceptions.Exception:
- __init__,
- __new__
-
- Inherited from exceptions.BaseException:
- __delattr__,
- __getattribute__,
- __getitem__,
- __getslice__,
- __reduce__,
- __repr__,
- __setattr__,
- __setstate__,
- __str__,
- __unicode__
-
- Inherited from object:
- __format__,
- __hash__,
- __reduce_ex__,
- __sizeof__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from exceptions.BaseException:
- args,
- message
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.errors.InvalidJsonError-class.html b/docs/epy/googleapiclient.errors.InvalidJsonError-class.html
deleted file mode 100644
index 1d2f7aa5194..00000000000
--- a/docs/epy/googleapiclient.errors.InvalidJsonError-class.html
+++ /dev/null
@@ -1,194 +0,0 @@
-
-
-
-
- googleapiclient.errors.InvalidJsonError
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class InvalidJsonError
-
- object --+
- |
-exceptions.BaseException --+
- |
- exceptions.Exception --+
- |
- Error --+
- |
- InvalidJsonError
-
-
-
-The JSON returned could not be parsed.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
- Inherited from exceptions.Exception:
- __init__,
- __new__
-
- Inherited from exceptions.BaseException:
- __delattr__,
- __getattribute__,
- __getitem__,
- __getslice__,
- __reduce__,
- __repr__,
- __setattr__,
- __setstate__,
- __str__,
- __unicode__
-
- Inherited from object:
- __format__,
- __hash__,
- __reduce_ex__,
- __sizeof__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from exceptions.BaseException:
- args,
- message
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.errors.InvalidNotificationError-class.html b/docs/epy/googleapiclient.errors.InvalidNotificationError-class.html
deleted file mode 100644
index c818fe45f65..00000000000
--- a/docs/epy/googleapiclient.errors.InvalidNotificationError-class.html
+++ /dev/null
@@ -1,194 +0,0 @@
-
-
-
-
- googleapiclient.errors.InvalidNotificationError
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class InvalidNotificationError
-
- object --+
- |
-exceptions.BaseException --+
- |
- exceptions.Exception --+
- |
- Error --+
- |
- InvalidNotificationError
-
-
-
-The channel Notification is invalid.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
- Inherited from exceptions.Exception:
- __init__,
- __new__
-
- Inherited from exceptions.BaseException:
- __delattr__,
- __getattribute__,
- __getitem__,
- __getslice__,
- __reduce__,
- __repr__,
- __setattr__,
- __setstate__,
- __str__,
- __unicode__
-
- Inherited from object:
- __format__,
- __hash__,
- __reduce_ex__,
- __sizeof__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from exceptions.BaseException:
- args,
- message
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.errors.MediaUploadSizeError-class.html b/docs/epy/googleapiclient.errors.MediaUploadSizeError-class.html
deleted file mode 100644
index 4887e12d2ed..00000000000
--- a/docs/epy/googleapiclient.errors.MediaUploadSizeError-class.html
+++ /dev/null
@@ -1,194 +0,0 @@
-
-
-
-
- googleapiclient.errors.MediaUploadSizeError
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class MediaUploadSizeError
-
- object --+
- |
-exceptions.BaseException --+
- |
- exceptions.Exception --+
- |
- Error --+
- |
- MediaUploadSizeError
-
-
-
-Media is larger than the method can accept.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
- Inherited from exceptions.Exception:
- __init__,
- __new__
-
- Inherited from exceptions.BaseException:
- __delattr__,
- __getattribute__,
- __getitem__,
- __getslice__,
- __reduce__,
- __repr__,
- __setattr__,
- __setstate__,
- __str__,
- __unicode__
-
- Inherited from object:
- __format__,
- __hash__,
- __reduce_ex__,
- __sizeof__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from exceptions.BaseException:
- args,
- message
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.errors.ResumableUploadError-class.html b/docs/epy/googleapiclient.errors.ResumableUploadError-class.html
deleted file mode 100644
index 09c5dfadf5b..00000000000
--- a/docs/epy/googleapiclient.errors.ResumableUploadError-class.html
+++ /dev/null
@@ -1,201 +0,0 @@
-
-
-
-
- googleapiclient.errors.ResumableUploadError
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class ResumableUploadError
-
- object --+
- |
-exceptions.BaseException --+
- |
- exceptions.Exception --+
- |
- Error --+
- |
- HttpError --+
- |
- ResumableUploadError
-
-
-
-Error occurred during resumable upload.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
- Inherited from HttpError:
- __init__,
- __repr__,
- __str__
-
- Inherited from HttpError (private):
- _get_reason
-
- Inherited from exceptions.Exception:
- __new__
-
- Inherited from exceptions.BaseException:
- __delattr__,
- __getattribute__,
- __getitem__,
- __getslice__,
- __reduce__,
- __setattr__,
- __setstate__,
- __unicode__
-
- Inherited from object:
- __format__,
- __hash__,
- __reduce_ex__,
- __sizeof__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from exceptions.BaseException:
- args,
- message
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.errors.UnacceptableMimeTypeError-class.html b/docs/epy/googleapiclient.errors.UnacceptableMimeTypeError-class.html
deleted file mode 100644
index 503edad2340..00000000000
--- a/docs/epy/googleapiclient.errors.UnacceptableMimeTypeError-class.html
+++ /dev/null
@@ -1,194 +0,0 @@
-
-
-
-
- googleapiclient.errors.UnacceptableMimeTypeError
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class UnacceptableMimeTypeError
-
- object --+
- |
-exceptions.BaseException --+
- |
- exceptions.Exception --+
- |
- Error --+
- |
- UnacceptableMimeTypeError
-
-
-
-That is an unacceptable mimetype for this operation.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
- Inherited from exceptions.Exception:
- __init__,
- __new__
-
- Inherited from exceptions.BaseException:
- __delattr__,
- __getattribute__,
- __getitem__,
- __getslice__,
- __reduce__,
- __repr__,
- __setattr__,
- __setstate__,
- __str__,
- __unicode__
-
- Inherited from object:
- __format__,
- __hash__,
- __reduce_ex__,
- __sizeof__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from exceptions.BaseException:
- args,
- message
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.errors.UnexpectedBodyError-class.html b/docs/epy/googleapiclient.errors.UnexpectedBodyError-class.html
deleted file mode 100644
index eb6267c3ee3..00000000000
--- a/docs/epy/googleapiclient.errors.UnexpectedBodyError-class.html
+++ /dev/null
@@ -1,256 +0,0 @@
-
-
-
-
- googleapiclient.errors.UnexpectedBodyError
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class UnexpectedBodyError
-
- object --+
- |
-exceptions.BaseException --+
- |
- exceptions.Exception --+
- |
- Error --+
- |
- UnexpectedBodyError
-
-
-
-Exception raised by RequestMockBuilder on unexpected bodies.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- expected,
- provided)
- Constructor for an UnexpectedMethodError.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from exceptions.Exception:
- __new__
-
- Inherited from exceptions.BaseException:
- __delattr__,
- __getattribute__,
- __getitem__,
- __getslice__,
- __reduce__,
- __repr__,
- __setattr__,
- __setstate__,
- __str__,
- __unicode__
-
- Inherited from object:
- __format__,
- __hash__,
- __reduce_ex__,
- __sizeof__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from exceptions.BaseException:
- args,
- message
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- expected,
- provided)
-
(Constructor)
-
- source code
-
-
-
- Constructor for an UnexpectedMethodError.
-
- - Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.errors.UnexpectedMethodError-class.html b/docs/epy/googleapiclient.errors.UnexpectedMethodError-class.html
deleted file mode 100644
index 8a87d9917c7..00000000000
--- a/docs/epy/googleapiclient.errors.UnexpectedMethodError-class.html
+++ /dev/null
@@ -1,258 +0,0 @@
-
-
-
-
- googleapiclient.errors.UnexpectedMethodError
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class UnexpectedMethodError
-
- object --+
- |
-exceptions.BaseException --+
- |
- exceptions.Exception --+
- |
- Error --+
- |
- UnexpectedMethodError
-
-
-
-Exception raised by RequestMockBuilder on unexpected calls.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
- Constructor for an UnexpectedMethodError.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from exceptions.Exception:
- __new__
-
- Inherited from exceptions.BaseException:
- __delattr__,
- __getattribute__,
- __getitem__,
- __getslice__,
- __reduce__,
- __repr__,
- __setattr__,
- __setstate__,
- __str__,
- __unicode__
-
- Inherited from object:
- __format__,
- __hash__,
- __reduce_ex__,
- __sizeof__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from exceptions.BaseException:
- args,
- message
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
-
(Constructor)
-
- source code
-
-
-
- Constructor for an UnexpectedMethodError.
-
- - Decorators:
-
- @util.positional(1)
- Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.errors.UnknownApiNameOrVersion-class.html b/docs/epy/googleapiclient.errors.UnknownApiNameOrVersion-class.html
deleted file mode 100644
index b076c559034..00000000000
--- a/docs/epy/googleapiclient.errors.UnknownApiNameOrVersion-class.html
+++ /dev/null
@@ -1,194 +0,0 @@
-
-
-
-
- googleapiclient.errors.UnknownApiNameOrVersion
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class UnknownApiNameOrVersion
-
- object --+
- |
-exceptions.BaseException --+
- |
- exceptions.Exception --+
- |
- Error --+
- |
- UnknownApiNameOrVersion
-
-
-
-No API with that name and version exists.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
- Inherited from exceptions.Exception:
- __init__,
- __new__
-
- Inherited from exceptions.BaseException:
- __delattr__,
- __getattribute__,
- __getitem__,
- __getslice__,
- __reduce__,
- __repr__,
- __setattr__,
- __setstate__,
- __str__,
- __unicode__
-
- Inherited from object:
- __format__,
- __hash__,
- __reduce_ex__,
- __sizeof__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from exceptions.BaseException:
- args,
- message
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.errors.UnknownFileType-class.html b/docs/epy/googleapiclient.errors.UnknownFileType-class.html
deleted file mode 100644
index 14ccd08bcfb..00000000000
--- a/docs/epy/googleapiclient.errors.UnknownFileType-class.html
+++ /dev/null
@@ -1,194 +0,0 @@
-
-
-
-
- googleapiclient.errors.UnknownFileType
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class UnknownFileType
-
- object --+
- |
-exceptions.BaseException --+
- |
- exceptions.Exception --+
- |
- Error --+
- |
- UnknownFileType
-
-
-
-File type unknown or unexpected.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
- Inherited from exceptions.Exception:
- __init__,
- __new__
-
- Inherited from exceptions.BaseException:
- __delattr__,
- __getattribute__,
- __getitem__,
- __getslice__,
- __reduce__,
- __repr__,
- __setattr__,
- __setstate__,
- __str__,
- __unicode__
-
- Inherited from object:
- __format__,
- __hash__,
- __reduce_ex__,
- __sizeof__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from exceptions.BaseException:
- args,
- message
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.errors.UnknownLinkType-class.html b/docs/epy/googleapiclient.errors.UnknownLinkType-class.html
deleted file mode 100644
index e0d8eb3e85a..00000000000
--- a/docs/epy/googleapiclient.errors.UnknownLinkType-class.html
+++ /dev/null
@@ -1,194 +0,0 @@
-
-
-
-
- googleapiclient.errors.UnknownLinkType
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class UnknownLinkType
-
- object --+
- |
-exceptions.BaseException --+
- |
- exceptions.Exception --+
- |
- Error --+
- |
- UnknownLinkType
-
-
-
-Link type unknown or unexpected.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
- Inherited from exceptions.Exception:
- __init__,
- __new__
-
- Inherited from exceptions.BaseException:
- __delattr__,
- __getattribute__,
- __getitem__,
- __getslice__,
- __reduce__,
- __repr__,
- __setattr__,
- __setstate__,
- __str__,
- __unicode__
-
- Inherited from object:
- __format__,
- __hash__,
- __reduce_ex__,
- __sizeof__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from exceptions.BaseException:
- args,
- message
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.http-module.html b/docs/epy/googleapiclient.http-module.html
deleted file mode 100644
index 7533cd999fe..00000000000
--- a/docs/epy/googleapiclient.http-module.html
+++ /dev/null
@@ -1,636 +0,0 @@
-
-
-
-
- googleapiclient.http
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module http
-Classes to encapsulate a single HTTP request.
- The classes implement a command pattern, with every object supporting
- an execute() method that does the actual HTTP request.
-
-
- Author:
- jcgregorio@google.com (Joe Gregorio)
-
-
-
-
-
-
-
-
- Classes
-
-
-
-
-
-
-
-
- MediaUploadProgress
- Status of a resumable upload.
-
-
-
-
-
-
- MediaDownloadProgress
- Status of a resumable download.
-
-
-
-
-
-
- MediaUpload
- Describes a media object to upload.
-
-
-
-
-
-
- MediaIoBaseUpload
- A MediaUpload for a io.Base objects.
-
-
-
-
-
-
- MediaFileUpload
- A MediaUpload for a file.
-
-
-
-
-
-
- MediaInMemoryUpload
- MediaUpload for a chunk of bytes.
-
-
-
-
-
-
- MediaIoBaseDownload
- "Download media resources.
-
-
-
-
-
-
- _StreamSlice
- Truncated stream.
-
-
-
-
-
-
- HttpRequest
- Encapsulates a single HTTP request.
-
-
-
-
-
-
- BatchHttpRequest
- Batches multiple HttpRequest objects into a single HTTP request.
-
-
-
-
-
-
- HttpRequestMock
- Mock of HttpRequest.
-
-
-
-
-
-
- RequestMockBuilder
- A simple mock of HttpRequest
-
-
-
-
-
-
- HttpMock
- Mock of httplib2.Http
-
-
-
-
-
-
- HttpMockSequence
- Mock of httplib2.Http
-
-
-
-
-
-
-
-
-
-
- Functions
-
-
-
-
-
-
-
-
-
-
- _should_retry_response(resp_status,
- content)
- Determines whether a response should be retried.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _retry_request(http,
- num_retries,
- req_type,
- sleep,
- rand,
- uri,
- method,
- *args,
- **kwargs)
- Retries an HTTP request multiple times while handling errors.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- set_user_agent(http,
- user_agent)
- Set the user-agent on every request.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- tunnel_patch(http)
- Tunnel PATCH requests over POST.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- build_http()
- Builds httplib2.Http object
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Variables
-
-
-
-
-
-
-
-
- LOGGER = logging.getLogger(__name__)
-
-
-
-
-
-
- DEFAULT_CHUNK_SIZE = 104857600
-
-
-
-
-
-
- MAX_URI_LENGTH = 2048
-
-
-
-
-
-
- MAX_BATCH_LIMIT = 1000
-
-
-
-
-
-
- _TOO_MANY_REQUESTS = 429
-
-
-
-
-
-
- DEFAULT_HTTP_TIMEOUT_SEC = 60
-
-
-
-
-
-
- _LEGACY_BATCH_URI = 'https://www.googleapis.com/batch'
-
-
-
-
-
- ConnectionError = None
-
-
-
-
-
-
- __package__ = None
-
-
-
-
-
-
-
-
-
-
- Function Details
-
-
-
-
-
-
-
-
-
-
-
- _should_retry_response(resp_status,
- content)
-
- source code
-
-
-
-
-Determines whether a response should be retried.
-
-Args:
- resp_status: The response status received.
- content: The response content body.
-
-Returns:
- True if the response should be retried, otherwise False.
-
-
-
-
-
-
-
-
-
-
-
-
- _retry_request(http,
- num_retries,
- req_type,
- sleep,
- rand,
- uri,
- method,
- *args,
- **kwargs)
-
- source code
-
-
-
-
-Retries an HTTP request multiple times while handling errors.
-
-If after all retries the request still fails, last error is either returned as
-return value (for HTTP 5xx errors) or thrown (for ssl.SSLError).
-
-Args:
- http: Http object to be used to execute request.
- num_retries: Maximum number of retries.
- req_type: Type of the request (used for logging retries).
- sleep, rand: Functions to sleep for random time between retries.
- uri: URI to be requested.
- method: HTTP method to be used.
- args, kwargs: Additional arguments passed to http.request.
-
-Returns:
- resp, content - Response from the http request (may be HTTP 5xx).
-
-
-
-
-
-
-
-
-
-
-
-
- set_user_agent(http,
- user_agent)
-
- source code
-
-
-
-
-Set the user-agent on every request.
-
-Args:
- http - An instance of httplib2.Http
- or something that acts like it.
- user_agent: string, the value for the user-agent header.
-
-Returns:
- A modified instance of http that was passed in.
-
-Example:
-
- h = httplib2.Http()
- h = set_user_agent(h, "my-app-name/6.0")
-
-Most of the time the user-agent will be set doing auth, this is for the rare
-cases where you are accessing an unauthenticated endpoint.
-
-
-
-
-
-
-
-
-
-
-
-
- tunnel_patch(http)
-
- source code
-
-
-
-
-Tunnel PATCH requests over POST.
-Args:
- http - An instance of httplib2.Http
- or something that acts like it.
-
-Returns:
- A modified instance of http that was passed in.
-
-Example:
-
- h = httplib2.Http()
- h = tunnel_patch(h, "my-app-name/6.0")
-
-Useful if you are running on a platform that doesn't support PATCH.
-Apply this last if you are using OAuth 1.0, as changing the method
-will result in a different signature.
-
-
-
-
-
-
-
-
-
-
-
-
- build_http()
-
- source code
-
-
-
-
-Builds httplib2.Http object
-
-Returns:
-A httplib2.Http object, which is used to make http requests, and which has timeout set by default.
-To override default timeout call
-
- socket.setdefaulttimeout(timeout_in_sec)
-
-before interacting with this method.
-
-
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.http-pysrc.html b/docs/epy/googleapiclient.http-pysrc.html
deleted file mode 100644
index 3dfa21e889f..00000000000
--- a/docs/epy/googleapiclient.http-pysrc.html
+++ /dev/null
@@ -1,2349 +0,0 @@
-
-
-
-
- googleapiclient.http
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Source Code for Module googleapiclient.http
-
- 1 # Copyright 2014 Google Inc. All Rights Reserved.
- 2 #
- 3 # Licensed under the Apache License, Version 2.0 (the "License");
- 4 # you may not use this file except in compliance with the License.
- 5 # You may obtain a copy of the License at
- 6 #
- 7 # http://www.apache.org/licenses/LICENSE-2.0
- 8 #
- 9 # Unless required by applicable law or agreed to in writing, software
- 10 # distributed under the License is distributed on an "AS IS" BASIS,
- 11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- 12 # See the License for the specific language governing permissions and
- 13 # limitations under the License.
- 14
- 15 """Classes to encapsulate a single HTTP request.
- 16
- 17 The classes implement a command pattern, with every
- 18 object supporting an execute() method that does the
- 19 actual HTTP request.
- 20 """
- 21 from __future__ import absolute_import
- 22 import six
- 23 from six.moves import http_client
- 24 from six.moves import range
- 25
- 26 __author__ = "jcgregorio@google.com (Joe Gregorio)"
- 27
- 28 from six import BytesIO, StringIO
- 29 from six.moves.urllib.parse import urlparse, urlunparse, quote, unquote
- 30
- 31 import base64
- 32 import copy
- 33 import gzip
- 34 import httplib2
- 35 import json
- 36 import logging
- 37 import mimetypes
- 38 import os
- 39 import random
- 40 import socket
- 41 import sys
- 42 import time
- 43 import uuid
- 44
- 45 # TODO(issue 221): Remove this conditional import jibbajabba.
- 46 try:
- 47 import ssl
- 48 except ImportError:
- 49 _ssl_SSLError = object()
- 50 else:
- 51 _ssl_SSLError = ssl.SSLError
- 52
- 53 from email.generator import Generator
- 54 from email.mime.multipart import MIMEMultipart
- 55 from email.mime.nonmultipart import MIMENonMultipart
- 56 from email.parser import FeedParser
- 57
- 58 from googleapiclient import _helpers as util
- 59
- 60 from googleapiclient import _auth
- 61 from googleapiclient.errors import BatchError
- 62 from googleapiclient.errors import HttpError
- 63 from googleapiclient.errors import InvalidChunkSizeError
- 64 from googleapiclient.errors import ResumableUploadError
- 65 from googleapiclient.errors import UnexpectedBodyError
- 66 from googleapiclient.errors import UnexpectedMethodError
- 67 from googleapiclient.model import JsonModel
- 68
- 69
- 70 LOGGER = logging.getLogger(__name__)
- 71
- 72 DEFAULT_CHUNK_SIZE = 100 * 1024 * 1024
- 73
- 74 MAX_URI_LENGTH = 2048
- 75
- 76 MAX_BATCH_LIMIT = 1000
- 77
- 78 _TOO_MANY_REQUESTS = 429
- 79
- 80 DEFAULT_HTTP_TIMEOUT_SEC = 60
- 81
- 82 _LEGACY_BATCH_URI = "https://www.googleapis.com/batch"
- 83
- 84 if six.PY2:
- 85 # That's a builtin python3 exception, nonexistent in python2.
- 86 # Defined to None to avoid NameError while trying to catch it
- 87 ConnectionError = None
- 91 """Determines whether a response should be retried.
- 92
- 93 Args:
- 94 resp_status: The response status received.
- 95 content: The response content body.
- 96
- 97 Returns:
- 98 True if the response should be retried, otherwise False.
- 99 """
- 100 # Retry on 5xx errors.
- 101 if resp_status >= 500:
- 102 return True
- 103
- 104 # Retry on 429 errors.
- 105 if resp_status == _TOO_MANY_REQUESTS:
- 106 return True
- 107
- 108 # For 403 errors, we have to check for the `reason` in the response to
- 109 # determine if we should retry.
- 110 if resp_status == six.moves.http_client.FORBIDDEN:
- 111 # If there's no details about the 403 type, don't retry.
- 112 if not content:
- 113 return False
- 114
- 115 # Content is in JSON format.
- 116 try:
- 117 data = json.loads(content.decode("utf-8"))
- 118 if isinstance(data, dict):
- 119 reason = data["error"]["errors"][0]["reason"]
- 120 else:
- 121 reason = data[0]["error"]["errors"]["reason"]
- 122 except (UnicodeDecodeError, ValueError, KeyError):
- 123 LOGGER.warning("Invalid JSON content from response: %s", content)
- 124 return False
- 125
- 126 LOGGER.warning('Encountered 403 Forbidden with reason "%s"', reason)
- 127
- 128 # Only retry on rate limit related failures.
- 129 if reason in ("userRateLimitExceeded", "rateLimitExceeded"):
- 130 return True
- 131
- 132 # Everything else is a success or non-retriable so break.
- 133 return False
- 134
- 135
- 136 -def _retry_request(
- 137 http, num_retries, req_type, sleep, rand, uri, method, *args, **kwargs
- 138 ):
- 139 """Retries an HTTP request multiple times while handling errors.
- 140
- 141 If after all retries the request still fails, last error is either returned as
- 142 return value (for HTTP 5xx errors) or thrown (for ssl.SSLError).
- 143
- 144 Args:
- 145 http: Http object to be used to execute request.
- 146 num_retries: Maximum number of retries.
- 147 req_type: Type of the request (used for logging retries).
- 148 sleep, rand: Functions to sleep for random time between retries.
- 149 uri: URI to be requested.
- 150 method: HTTP method to be used.
- 151 args, kwargs: Additional arguments passed to http.request.
- 152
- 153 Returns:
- 154 resp, content - Response from the http request (may be HTTP 5xx).
- 155 """
- 156 resp = None
- 157 content = None
- 158 exception = None
- 159 for retry_num in range(num_retries + 1):
- 160 if retry_num > 0:
- 161 # Sleep before retrying.
- 162 sleep_time = rand() * 2 ** retry_num
- 163 LOGGER.warning(
- 164 "Sleeping %.2f seconds before retry %d of %d for %s: %s %s, after %s",
- 165 sleep_time,
- 166 retry_num,
- 167 num_retries,
- 168 req_type,
- 169 method,
- 170 uri,
- 171 resp.status if resp else exception,
- 172 )
- 173 sleep(sleep_time)
- 174
- 175 try:
- 176 exception = None
- 177 resp, content = http.request(uri, method, *args, **kwargs)
- 178 # Retry on SSL errors and socket timeout errors.
- 179 except _ssl_SSLError as ssl_error:
- 180 exception = ssl_error
- 181 except socket.timeout as socket_timeout:
- 182 # It's important that this be before socket.error as it's a subclass
- 183 # socket.timeout has no errorcode
- 184 exception = socket_timeout
- 185 except ConnectionError as connection_error:
- 186 # Needs to be before socket.error as it's a subclass of
- 187 # OSError (socket.error)
- 188 exception = connection_error
- 189 except socket.error as socket_error:
- 190 # errno's contents differ by platform, so we have to match by name.
- 191 if socket.errno.errorcode.get(socket_error.errno) not in {
- 192 "WSAETIMEDOUT",
- 193 "ETIMEDOUT",
- 194 "EPIPE",
- 195 "ECONNABORTED",
- 196 }:
- 197 raise
- 198 exception = socket_error
- 199 except httplib2.ServerNotFoundError as server_not_found_error:
- 200 exception = server_not_found_error
- 201
- 202 if exception:
- 203 if retry_num == num_retries:
- 204 raise exception
- 205 else:
- 206 continue
- 207
- 208 if not _should_retry_response(resp.status, content):
- 209 break
- 210
- 211 return resp, content
- 212
- 215 """Status of a resumable upload."""
- 216
- 218 """Constructor.
- 219
- 220 Args:
- 221 resumable_progress: int, bytes sent so far.
- 222 total_size: int, total bytes in complete upload, or None if the total
- 223 upload size isn't known ahead of time.
- 224 """
- 225 self.resumable_progress = resumable_progress
- 226 self.total_size = total_size
- 227
- 229 """Percent of upload completed, as a float.
- 230
- 231 Returns:
- 232 the percentage complete as a float, returning 0.0 if the total size of
- 233 the upload is unknown.
- 234 """
- 235 if self.total_size is not None and self.total_size != 0:
- 236 return float(self.resumable_progress) / float(self.total_size)
- 237 else:
- 238 return 0.0
- 239
- 242 """Status of a resumable download."""
- 243
- 245 """Constructor.
- 246
- 247 Args:
- 248 resumable_progress: int, bytes received so far.
- 249 total_size: int, total bytes in complete download.
- 250 """
- 251 self.resumable_progress = resumable_progress
- 252 self.total_size = total_size
- 253
- 255 """Percent of download completed, as a float.
- 256
- 257 Returns:
- 258 the percentage complete as a float, returning 0.0 if the total size of
- 259 the download is unknown.
- 260 """
- 261 if self.total_size is not None and self.total_size != 0:
- 262 return float(self.resumable_progress) / float(self.total_size)
- 263 else:
- 264 return 0.0
- 265
- 268 """Describes a media object to upload.
- 269
- 270 Base class that defines the interface of MediaUpload subclasses.
- 271
- 272 Note that subclasses of MediaUpload may allow you to control the chunksize
- 273 when uploading a media object. It is important to keep the size of the chunk
- 274 as large as possible to keep the upload efficient. Other factors may influence
- 275 the size of the chunk you use, particularly if you are working in an
- 276 environment where individual HTTP requests may have a hardcoded time limit,
- 277 such as under certain classes of requests under Google App Engine.
- 278
- 279 Streams are io.Base compatible objects that support seek(). Some MediaUpload
- 280 subclasses support using streams directly to upload data. Support for
- 281 streaming may be indicated by a MediaUpload sub-class and if appropriate for a
- 282 platform that stream will be used for uploading the media object. The support
- 283 for streaming is indicated by has_stream() returning True. The stream() method
- 284 should return an io.Base object that supports seek(). On platforms where the
- 285 underlying httplib module supports streaming, for example Python 2.6 and
- 286 later, the stream will be passed into the http library which will result in
- 287 less memory being used and possibly faster uploads.
- 288
- 289 If you need to upload media that can't be uploaded using any of the existing
- 290 MediaUpload sub-class then you can sub-class MediaUpload for your particular
- 291 needs.
- 292 """
- 293
- 295 """Chunk size for resumable uploads.
- 296
- 297 Returns:
- 298 Chunk size in bytes.
- 299 """
- 300 raise NotImplementedError()
- 301
- 303 """Mime type of the body.
- 304
- 305 Returns:
- 306 Mime type.
- 307 """
- 308 return "application/octet-stream"
- 309
- 311 """Size of upload.
- 312
- 313 Returns:
- 314 Size of the body, or None of the size is unknown.
- 315 """
- 316 return None
- 317
- 319 """Whether this upload is resumable.
- 320
- 321 Returns:
- 322 True if resumable upload or False.
- 323 """
- 324 return False
- 325
- 327 """Get bytes from the media.
- 328
- 329 Args:
- 330 begin: int, offset from beginning of file.
- 331 length: int, number of bytes to read, starting at begin.
- 332
- 333 Returns:
- 334 A string of bytes read. May be shorter than length if EOF was reached
- 335 first.
- 336 """
- 337 raise NotImplementedError()
- 338
- 340 """Does the underlying upload support a streaming interface.
- 341
- 342 Streaming means it is an io.IOBase subclass that supports seek, i.e.
- 343 seekable() returns True.
- 344
- 345 Returns:
- 346 True if the call to stream() will return an instance of a seekable io.Base
- 347 subclass.
- 348 """
- 349 return False
- 350
- 352 """A stream interface to the data being uploaded.
- 353
- 354 Returns:
- 355 The returned value is an io.IOBase subclass that supports seek, i.e.
- 356 seekable() returns True.
- 357 """
- 358 raise NotImplementedError()
- 359
- 360 @util.positional(1)
- 362 """Utility function for creating a JSON representation of a MediaUpload.
- 363
- 364 Args:
- 365 strip: array, An array of names of members to not include in the JSON.
- 366
- 367 Returns:
- 368 string, a JSON representation of this instance, suitable to pass to
- 369 from_json().
- 370 """
- 371 t = type(self)
- 372 d = copy.copy(self.__dict__)
- 373 if strip is not None:
- 374 for member in strip:
- 375 del d[member]
- 376 d["_class"] = t.__name__
- 377 d["_module"] = t.__module__
- 378 return json.dumps(d)
- 379
- 381 """Create a JSON representation of an instance of MediaUpload.
- 382
- 383 Returns:
- 384 string, a JSON representation of this instance, suitable to pass to
- 385 from_json().
- 386 """
- 387 return self._to_json()
- 388
- 389 @classmethod
- 391 """Utility class method to instantiate a MediaUpload subclass from a JSON
- 392 representation produced by to_json().
- 393
- 394 Args:
- 395 s: string, JSON from to_json().
- 396
- 397 Returns:
- 398 An instance of the subclass of MediaUpload that was serialized with
- 399 to_json().
- 400 """
- 401 data = json.loads(s)
- 402 # Find and call the right classmethod from_json() to restore the object.
- 403 module = data["_module"]
- 404 m = __import__(module, fromlist=module.split(".")[:-1])
- 405 kls = getattr(m, data["_class"])
- 406 from_json = getattr(kls, "from_json")
- 407 return from_json(s)
- 408
- 411 """A MediaUpload for a io.Base objects.
- 412
- 413 Note that the Python file object is compatible with io.Base and can be used
- 414 with this class also.
- 415
- 416 fh = BytesIO('...Some data to upload...')
- 417 media = MediaIoBaseUpload(fh, mimetype='image/png',
- 418 chunksize=1024*1024, resumable=True)
- 419 farm.animals().insert(
- 420 id='cow',
- 421 name='cow.png',
- 422 media_body=media).execute()
- 423
- 424 Depending on the platform you are working on, you may pass -1 as the
- 425 chunksize, which indicates that the entire file should be uploaded in a single
- 426 request. If the underlying platform supports streams, such as Python 2.6 or
- 427 later, then this can be very efficient as it avoids multiple connections, and
- 428 also avoids loading the entire file into memory before sending it. Note that
- 429 Google App Engine has a 5MB limit on request size, so you should never set
- 430 your chunksize larger than 5MB, or to -1.
- 431 """
- 432
- 433 @util.positional(3)
- 435 """Constructor.
- 436
- 437 Args:
- 438 fd: io.Base or file object, The source of the bytes to upload. MUST be
- 439 opened in blocking mode, do not use streams opened in non-blocking mode.
- 440 The given stream must be seekable, that is, it must be able to call
- 441 seek() on fd.
- 442 mimetype: string, Mime-type of the file.
- 443 chunksize: int, File will be uploaded in chunks of this many bytes. Only
- 444 used if resumable=True. Pass in a value of -1 if the file is to be
- 445 uploaded as a single chunk. Note that Google App Engine has a 5MB limit
- 446 on request size, so you should never set your chunksize larger than 5MB,
- 447 or to -1.
- 448 resumable: bool, True if this is a resumable upload. False means upload
- 449 in a single request.
- 450 """
- 451 super(MediaIoBaseUpload, self).__init__()
- 452 self._fd = fd
- 453 self._mimetype = mimetype
- 454 if not (chunksize == -1 or chunksize > 0):
- 455 raise InvalidChunkSizeError()
- 456 self._chunksize = chunksize
- 457 self._resumable = resumable
- 458
- 459 self._fd.seek(0, os.SEEK_END)
- 460 self._size = self._fd.tell()
- 461
- 463 """Chunk size for resumable uploads.
- 464
- 465 Returns:
- 466 Chunk size in bytes.
- 467 """
- 468 return self._chunksize
- 469
- 471 """Mime type of the body.
- 472
- 473 Returns:
- 474 Mime type.
- 475 """
- 476 return self._mimetype
- 477
- 479 """Size of upload.
- 480
- 481 Returns:
- 482 Size of the body, or None of the size is unknown.
- 483 """
- 484 return self._size
- 485
- 487 """Whether this upload is resumable.
- 488
- 489 Returns:
- 490 True if resumable upload or False.
- 491 """
- 492 return self._resumable
- 493
- 495 """Get bytes from the media.
- 496
- 497 Args:
- 498 begin: int, offset from beginning of file.
- 499 length: int, number of bytes to read, starting at begin.
- 500
- 501 Returns:
- 502 A string of bytes read. May be shorted than length if EOF was reached
- 503 first.
- 504 """
- 505 self._fd.seek(begin)
- 506 return self._fd.read(length)
- 507
- 509 """Does the underlying upload support a streaming interface.
- 510
- 511 Streaming means it is an io.IOBase subclass that supports seek, i.e.
- 512 seekable() returns True.
- 513
- 514 Returns:
- 515 True if the call to stream() will return an instance of a seekable io.Base
- 516 subclass.
- 517 """
- 518 return True
- 519
- 521 """A stream interface to the data being uploaded.
- 522
- 523 Returns:
- 524 The returned value is an io.IOBase subclass that supports seek, i.e.
- 525 seekable() returns True.
- 526 """
- 527 return self._fd
- 528
- 532
- 535 """A MediaUpload for a file.
- 536
- 537 Construct a MediaFileUpload and pass as the media_body parameter of the
- 538 method. For example, if we had a service that allowed uploading images:
- 539
- 540 media = MediaFileUpload('cow.png', mimetype='image/png',
- 541 chunksize=1024*1024, resumable=True)
- 542 farm.animals().insert(
- 543 id='cow',
- 544 name='cow.png',
- 545 media_body=media).execute()
- 546
- 547 Depending on the platform you are working on, you may pass -1 as the
- 548 chunksize, which indicates that the entire file should be uploaded in a single
- 549 request. If the underlying platform supports streams, such as Python 2.6 or
- 550 later, then this can be very efficient as it avoids multiple connections, and
- 551 also avoids loading the entire file into memory before sending it. Note that
- 552 Google App Engine has a 5MB limit on request size, so you should never set
- 553 your chunksize larger than 5MB, or to -1.
- 554 """
- 555
- 556 @util.positional(2)
- 557 - def __init__(
- 558 self, filename, mimetype=None, chunksize=DEFAULT_CHUNK_SIZE, resumable=False
- 559 ):
- 560 """Constructor.
- 561
- 562 Args:
- 563 filename: string, Name of the file.
- 564 mimetype: string, Mime-type of the file. If None then a mime-type will be
- 565 guessed from the file extension.
- 566 chunksize: int, File will be uploaded in chunks of this many bytes. Only
- 567 used if resumable=True. Pass in a value of -1 if the file is to be
- 568 uploaded in a single chunk. Note that Google App Engine has a 5MB limit
- 569 on request size, so you should never set your chunksize larger than 5MB,
- 570 or to -1.
- 571 resumable: bool, True if this is a resumable upload. False means upload
- 572 in a single request.
- 573 """
- 574 self._filename = filename
- 575 fd = open(self._filename, "rb")
- 576 if mimetype is None:
- 577 # No mimetype provided, make a guess.
- 578 mimetype, _ = mimetypes.guess_type(filename)
- 579 if mimetype is None:
- 580 # Guess failed, use octet-stream.
- 581 mimetype = "application/octet-stream"
- 582 super(MediaFileUpload, self).__init__(
- 583 fd, mimetype, chunksize=chunksize, resumable=resumable
- 584 )
- 585
- 587 self._fd.close()
- 588
- 590 """Creating a JSON representation of an instance of MediaFileUpload.
- 591
- 592 Returns:
- 593 string, a JSON representation of this instance, suitable to pass to
- 594 from_json().
- 595 """
- 596 return self._to_json(strip=["_fd"])
- 597
- 598 @staticmethod
- 600 d = json.loads(s)
- 601 return MediaFileUpload(
- 602 d["_filename"],
- 603 mimetype=d["_mimetype"],
- 604 chunksize=d["_chunksize"],
- 605 resumable=d["_resumable"],
- 606 )
- 607
- 610 """MediaUpload for a chunk of bytes.
- 611
- 612 DEPRECATED: Use MediaIoBaseUpload with either io.TextIOBase or StringIO for
- 613 the stream.
- 614 """
- 615
- 616 @util.positional(2)
- 617 - def __init__(
- 618 self,
- 619 body,
- 620 mimetype="application/octet-stream",
- 621 chunksize=DEFAULT_CHUNK_SIZE,
- 622 resumable=False,
- 623 ):
- 624 """Create a new MediaInMemoryUpload.
- 625
- 626 DEPRECATED: Use MediaIoBaseUpload with either io.TextIOBase or StringIO for
- 627 the stream.
- 628
- 629 Args:
- 630 body: string, Bytes of body content.
- 631 mimetype: string, Mime-type of the file or default of
- 632 'application/octet-stream'.
- 633 chunksize: int, File will be uploaded in chunks of this many bytes. Only
- 634 used if resumable=True.
- 635 resumable: bool, True if this is a resumable upload. False means upload
- 636 in a single request.
- 637 """
- 638 fd = BytesIO(body)
- 639 super(MediaInMemoryUpload, self).__init__(
- 640 fd, mimetype, chunksize=chunksize, resumable=resumable
- 641 )
- 642
- 645 """"Download media resources.
- 646
- 647 Note that the Python file object is compatible with io.Base and can be used
- 648 with this class also.
- 649
- 650
- 651 Example:
- 652 request = farms.animals().get_media(id='cow')
- 653 fh = io.FileIO('cow.png', mode='wb')
- 654 downloader = MediaIoBaseDownload(fh, request, chunksize=1024*1024)
- 655
- 656 done = False
- 657 while done is False:
- 658 status, done = downloader.next_chunk()
- 659 if status:
- 660 print "Download %d%%." % int(status.progress() * 100)
- 661 print "Download Complete!"
- 662 """
- 663
- 664 @util.positional(3)
- 666 """Constructor.
- 667
- 668 Args:
- 669 fd: io.Base or file object, The stream in which to write the downloaded
- 670 bytes.
- 671 request: googleapiclient.http.HttpRequest, the media request to perform in
- 672 chunks.
- 673 chunksize: int, File will be downloaded in chunks of this many bytes.
- 674 """
- 675 self._fd = fd
- 676 self._request = request
- 677 self._uri = request.uri
- 678 self._chunksize = chunksize
- 679 self._progress = 0
- 680 self._total_size = None
- 681 self._done = False
- 682
- 683 # Stubs for testing.
- 684 self._sleep = time.sleep
- 685 self._rand = random.random
- 686
- 687 self._headers = {}
- 688 for k, v in six.iteritems(request.headers):
- 689 # allow users to supply custom headers by setting them on the request
- 690 # but strip out the ones that are set by default on requests generated by
- 691 # API methods like Drive's files().get(fileId=...)
- 692 if not k.lower() in ("accept", "accept-encoding", "user-agent"):
- 693 self._headers[k] = v
- 694
- 695 @util.positional(1)
- 697 """Get the next chunk of the download.
- 698
- 699 Args:
- 700 num_retries: Integer, number of times to retry with randomized
- 701 exponential backoff. If all retries fail, the raised HttpError
- 702 represents the last request. If zero (default), we attempt the
- 703 request only once.
- 704
- 705 Returns:
- 706 (status, done): (MediaDownloadProgress, boolean)
- 707 The value of 'done' will be True when the media has been fully
- 708 downloaded or the total size of the media is unknown.
- 709
- 710 Raises:
- 711 googleapiclient.errors.HttpError if the response was not a 2xx.
- 712 httplib2.HttpLib2Error if a transport error has occurred.
- 713 """
- 714 headers = self._headers.copy()
- 715 headers["range"] = "bytes=%d-%d" % (
- 716 self._progress,
- 717 self._progress + self._chunksize,
- 718 )
- 719 http = self._request.http
- 720
- 721 resp, content = _retry_request(
- 722 http,
- 723 num_retries,
- 724 "media download",
- 725 self._sleep,
- 726 self._rand,
- 727 self._uri,
- 728 "GET",
- 729 headers=headers,
- 730 )
- 731
- 732 if resp.status in [200, 206]:
- 733 if "content-location" in resp and resp["content-location"] != self._uri:
- 734 self._uri = resp["content-location"]
- 735 self._progress += len(content)
- 736 self._fd.write(content)
- 737
- 738 if "content-range" in resp:
- 739 content_range = resp["content-range"]
- 740 length = content_range.rsplit("/", 1)[1]
- 741 self._total_size = int(length)
- 742 elif "content-length" in resp:
- 743 self._total_size = int(resp["content-length"])
- 744
- 745 if self._total_size is None or self._progress == self._total_size:
- 746 self._done = True
- 747 return MediaDownloadProgress(self._progress, self._total_size), self._done
- 748 else:
- 749 raise HttpError(resp, content, uri=self._uri)
- 750
- 753 """Truncated stream.
- 754
- 755 Takes a stream and presents a stream that is a slice of the original stream.
- 756 This is used when uploading media in chunks. In later versions of Python a
- 757 stream can be passed to httplib in place of the string of data to send. The
- 758 problem is that httplib just blindly reads to the end of the stream. This
- 759 wrapper presents a virtual stream that only reads to the end of the chunk.
- 760 """
- 761
- 763 """Constructor.
- 764
- 765 Args:
- 766 stream: (io.Base, file object), the stream to wrap.
- 767 begin: int, the seek position the chunk begins at.
- 768 chunksize: int, the size of the chunk.
- 769 """
- 770 self._stream = stream
- 771 self._begin = begin
- 772 self._chunksize = chunksize
- 773 self._stream.seek(begin)
- 774
- 776 """Read n bytes.
- 777
- 778 Args:
- 779 n, int, the number of bytes to read.
- 780
- 781 Returns:
- 782 A string of length 'n', or less if EOF is reached.
- 783 """
- 784 # The data left available to read sits in [cur, end)
- 785 cur = self._stream.tell()
- 786 end = self._begin + self._chunksize
- 787 if n == -1 or cur + n > end:
- 788 n = end - cur
- 789 return self._stream.read(n)
- 790
- 793 """Encapsulates a single HTTP request."""
- 794
- 795 @util.positional(4)
- 796 - def __init__(
- 797 self,
- 798 http,
- 799 postproc,
- 800 uri,
- 801 method="GET",
- 802 body=None,
- 803 headers=None,
- 804 methodId=None,
- 805 resumable=None,
- 806 ):
- 807 """Constructor for an HttpRequest.
- 808
- 809 Args:
- 810 http: httplib2.Http, the transport object to use to make a request
- 811 postproc: callable, called on the HTTP response and content to transform
- 812 it into a data object before returning, or raising an exception
- 813 on an error.
- 814 uri: string, the absolute URI to send the request to
- 815 method: string, the HTTP method to use
- 816 body: string, the request body of the HTTP request,
- 817 headers: dict, the HTTP request headers
- 818 methodId: string, a unique identifier for the API method being called.
- 819 resumable: MediaUpload, None if this is not a resumbale request.
- 820 """
- 821 self.uri = uri
- 822 self.method = method
- 823 self.body = body
- 824 self.headers = headers or {}
- 825 self.methodId = methodId
- 826 self.http = http
- 827 self.postproc = postproc
- 828 self.resumable = resumable
- 829 self.response_callbacks = []
- 830 self._in_error_state = False
- 831
- 832 # The size of the non-media part of the request.
- 833 self.body_size = len(self.body or "")
- 834
- 835 # The resumable URI to send chunks to.
- 836 self.resumable_uri = None
- 837
- 838 # The bytes that have been uploaded.
- 839 self.resumable_progress = 0
- 840
- 841 # Stubs for testing.
- 842 self._rand = random.random
- 843 self._sleep = time.sleep
- 844
- 845 @util.positional(1)
- 847 """Execute the request.
- 848
- 849 Args:
- 850 http: httplib2.Http, an http object to be used in place of the
- 851 one the HttpRequest request object was constructed with.
- 852 num_retries: Integer, number of times to retry with randomized
- 853 exponential backoff. If all retries fail, the raised HttpError
- 854 represents the last request. If zero (default), we attempt the
- 855 request only once.
- 856
- 857 Returns:
- 858 A deserialized object model of the response body as determined
- 859 by the postproc.
- 860
- 861 Raises:
- 862 googleapiclient.errors.HttpError if the response was not a 2xx.
- 863 httplib2.HttpLib2Error if a transport error has occurred.
- 864 """
- 865 if http is None:
- 866 http = self.http
- 867
- 868 if self.resumable:
- 869 body = None
- 870 while body is None:
- 871 _, body = self.next_chunk(http=http, num_retries=num_retries)
- 872 return body
- 873
- 874 # Non-resumable case.
- 875
- 876 if "content-length" not in self.headers:
- 877 self.headers["content-length"] = str(self.body_size)
- 878 # If the request URI is too long then turn it into a POST request.
- 879 # Assume that a GET request never contains a request body.
- 880 if len(self.uri) > MAX_URI_LENGTH and self.method == "GET":
- 881 self.method = "POST"
- 882 self.headers["x-http-method-override"] = "GET"
- 883 self.headers["content-type"] = "application/x-www-form-urlencoded"
- 884 parsed = urlparse(self.uri)
- 885 self.uri = urlunparse(
- 886 (parsed.scheme, parsed.netloc, parsed.path, parsed.params, None, None)
- 887 )
- 888 self.body = parsed.query
- 889 self.headers["content-length"] = str(len(self.body))
- 890
- 891 # Handle retries for server-side errors.
- 892 resp, content = _retry_request(
- 893 http,
- 894 num_retries,
- 895 "request",
- 896 self._sleep,
- 897 self._rand,
- 898 str(self.uri),
- 899 method=str(self.method),
- 900 body=self.body,
- 901 headers=self.headers,
- 902 )
- 903
- 904 for callback in self.response_callbacks:
- 905 callback(resp)
- 906 if resp.status >= 300:
- 907 raise HttpError(resp, content, uri=self.uri)
- 908 return self.postproc(resp, content)
- 909
- 910 @util.positional(2)
- 912 """add_response_headers_callback
- 913
- 914 Args:
- 915 cb: Callback to be called on receiving the response headers, of signature:
- 916
- 917 def cb(resp):
- 918 # Where resp is an instance of httplib2.Response
- 919 """
- 920 self.response_callbacks.append(cb)
- 921
- 922 @util.positional(1)
- 924 """Execute the next step of a resumable upload.
- 925
- 926 Can only be used if the method being executed supports media uploads and
- 927 the MediaUpload object passed in was flagged as using resumable upload.
- 928
- 929 Example:
- 930
- 931 media = MediaFileUpload('cow.png', mimetype='image/png',
- 932 chunksize=1000, resumable=True)
- 933 request = farm.animals().insert(
- 934 id='cow',
- 935 name='cow.png',
- 936 media_body=media)
- 937
- 938 response = None
- 939 while response is None:
- 940 status, response = request.next_chunk()
- 941 if status:
- 942 print "Upload %d%% complete." % int(status.progress() * 100)
- 943
- 944
- 945 Args:
- 946 http: httplib2.Http, an http object to be used in place of the
- 947 one the HttpRequest request object was constructed with.
- 948 num_retries: Integer, number of times to retry with randomized
- 949 exponential backoff. If all retries fail, the raised HttpError
- 950 represents the last request. If zero (default), we attempt the
- 951 request only once.
- 952
- 953 Returns:
- 954 (status, body): (ResumableMediaStatus, object)
- 955 The body will be None until the resumable media is fully uploaded.
- 956
- 957 Raises:
- 958 googleapiclient.errors.HttpError if the response was not a 2xx.
- 959 httplib2.HttpLib2Error if a transport error has occurred.
- 960 """
- 961 if http is None:
- 962 http = self.http
- 963
- 964 if self.resumable.size() is None:
- 965 size = "*"
- 966 else:
- 967 size = str(self.resumable.size())
- 968
- 969 if self.resumable_uri is None:
- 970 start_headers = copy.copy(self.headers)
- 971 start_headers["X-Upload-Content-Type"] = self.resumable.mimetype()
- 972 if size != "*":
- 973 start_headers["X-Upload-Content-Length"] = size
- 974 start_headers["content-length"] = str(self.body_size)
- 975
- 976 resp, content = _retry_request(
- 977 http,
- 978 num_retries,
- 979 "resumable URI request",
- 980 self._sleep,
- 981 self._rand,
- 982 self.uri,
- 983 method=self.method,
- 984 body=self.body,
- 985 headers=start_headers,
- 986 )
- 987
- 988 if resp.status == 200 and "location" in resp:
- 989 self.resumable_uri = resp["location"]
- 990 else:
- 991 raise ResumableUploadError(resp, content)
- 992 elif self._in_error_state:
- 993 # If we are in an error state then query the server for current state of
- 994 # the upload by sending an empty PUT and reading the 'range' header in
- 995 # the response.
- 996 headers = {"Content-Range": "bytes */%s" % size, "content-length": "0"}
- 997 resp, content = http.request(self.resumable_uri, "PUT", headers=headers)
- 998 status, body = self._process_response(resp, content)
- 999 if body:
-1000 # The upload was complete.
-1001 return (status, body)
-1002
-1003 if self.resumable.has_stream():
-1004 data = self.resumable.stream()
-1005 if self.resumable.chunksize() == -1:
-1006 data.seek(self.resumable_progress)
-1007 chunk_end = self.resumable.size() - self.resumable_progress - 1
-1008 else:
-1009 # Doing chunking with a stream, so wrap a slice of the stream.
-1010 data = _StreamSlice(
-1011 data, self.resumable_progress, self.resumable.chunksize()
-1012 )
-1013 chunk_end = min(
-1014 self.resumable_progress + self.resumable.chunksize() - 1,
-1015 self.resumable.size() - 1,
-1016 )
-1017 else:
-1018 data = self.resumable.getbytes(
-1019 self.resumable_progress, self.resumable.chunksize()
-1020 )
-1021
-1022 # A short read implies that we are at EOF, so finish the upload.
-1023 if len(data) < self.resumable.chunksize():
-1024 size = str(self.resumable_progress + len(data))
-1025
-1026 chunk_end = self.resumable_progress + len(data) - 1
-1027
-1028 headers = {
-1029 "Content-Range": "bytes %d-%d/%s"
-1030 % (self.resumable_progress, chunk_end, size),
-1031 # Must set the content-length header here because httplib can't
-1032 # calculate the size when working with _StreamSlice.
-1033 "Content-Length": str(chunk_end - self.resumable_progress + 1),
-1034 }
-1035
-1036 for retry_num in range(num_retries + 1):
-1037 if retry_num > 0:
-1038 self._sleep(self._rand() * 2 ** retry_num)
-1039 LOGGER.warning(
-1040 "Retry #%d for media upload: %s %s, following status: %d"
-1041 % (retry_num, self.method, self.uri, resp.status)
-1042 )
-1043
-1044 try:
-1045 resp, content = http.request(
-1046 self.resumable_uri, method="PUT", body=data, headers=headers
-1047 )
-1048 except:
-1049 self._in_error_state = True
-1050 raise
-1051 if not _should_retry_response(resp.status, content):
-1052 break
-1053
-1054 return self._process_response(resp, content)
-1055
-1057 """Process the response from a single chunk upload.
-1058
-1059 Args:
-1060 resp: httplib2.Response, the response object.
-1061 content: string, the content of the response.
-1062
-1063 Returns:
-1064 (status, body): (ResumableMediaStatus, object)
-1065 The body will be None until the resumable media is fully uploaded.
-1066
-1067 Raises:
-1068 googleapiclient.errors.HttpError if the response was not a 2xx or a 308.
-1069 """
-1070 if resp.status in [200, 201]:
-1071 self._in_error_state = False
-1072 return None, self.postproc(resp, content)
-1073 elif resp.status == 308:
-1074 self._in_error_state = False
-1075 # A "308 Resume Incomplete" indicates we are not done.
-1076 try:
-1077 self.resumable_progress = int(resp["range"].split("-")[1]) + 1
-1078 except KeyError:
-1079 # If resp doesn't contain range header, resumable progress is 0
-1080 self.resumable_progress = 0
-1081 if "location" in resp:
-1082 self.resumable_uri = resp["location"]
-1083 else:
-1084 self._in_error_state = True
-1085 raise HttpError(resp, content, uri=self.uri)
-1086
-1087 return (
-1088 MediaUploadProgress(self.resumable_progress, self.resumable.size()),
-1089 None,
-1090 )
-1091
-1093 """Returns a JSON representation of the HttpRequest."""
-1094 d = copy.copy(self.__dict__)
-1095 if d["resumable"] is not None:
-1096 d["resumable"] = self.resumable.to_json()
-1097 del d["http"]
-1098 del d["postproc"]
-1099 del d["_sleep"]
-1100 del d["_rand"]
-1101
-1102 return json.dumps(d)
-1103
-1104 @staticmethod
-1106 """Returns an HttpRequest populated with info from a JSON object."""
-1107 d = json.loads(s)
-1108 if d["resumable"] is not None:
-1109 d["resumable"] = MediaUpload.new_from_json(d["resumable"])
-1110 return HttpRequest(
-1111 http,
-1112 postproc,
-1113 uri=d["uri"],
-1114 method=d["method"],
-1115 body=d["body"],
-1116 headers=d["headers"],
-1117 methodId=d["methodId"],
-1118 resumable=d["resumable"],
-1119 )
-1120
-1121 @staticmethod
-1124
-1127 """Batches multiple HttpRequest objects into a single HTTP request.
-1128
-1129 Example:
-1130 from googleapiclient.http import BatchHttpRequest
-1131
-1132 def list_animals(request_id, response, exception):
-1133 \"\"\"Do something with the animals list response.\"\"\"
-1134 if exception is not None:
-1135 # Do something with the exception.
-1136 pass
-1137 else:
-1138 # Do something with the response.
-1139 pass
-1140
-1141 def list_farmers(request_id, response, exception):
-1142 \"\"\"Do something with the farmers list response.\"\"\"
-1143 if exception is not None:
-1144 # Do something with the exception.
-1145 pass
-1146 else:
-1147 # Do something with the response.
-1148 pass
-1149
-1150 service = build('farm', 'v2')
-1151
-1152 batch = BatchHttpRequest()
-1153
-1154 batch.add(service.animals().list(), list_animals)
-1155 batch.add(service.farmers().list(), list_farmers)
-1156 batch.execute(http=http)
-1157 """
-1158
-1159 @util.positional(1)
-1161 """Constructor for a BatchHttpRequest.
-1162
-1163 Args:
-1164 callback: callable, A callback to be called for each response, of the
-1165 form callback(id, response, exception). The first parameter is the
-1166 request id, and the second is the deserialized response object. The
-1167 third is an googleapiclient.errors.HttpError exception object if an HTTP error
-1168 occurred while processing the request, or None if no error occurred.
-1169 batch_uri: string, URI to send batch requests to.
-1170 """
-1171 if batch_uri is None:
-1172 batch_uri = _LEGACY_BATCH_URI
-1173
-1174 if batch_uri == _LEGACY_BATCH_URI:
-1175 LOGGER.warning(
-1176 "You have constructed a BatchHttpRequest using the legacy batch "
-1177 "endpoint %s. This endpoint will be turned down on August 12, 2020. "
-1178 "Please provide the API-specific endpoint or use "
-1179 "service.new_batch_http_request(). For more details see "
-1180 "https://developers.googleblog.com/2018/03/discontinuing-support-for-json-rpc-and.html"
-1181 "and https://developers.google.com/api-client-library/python/guide/batch.",
-1182 _LEGACY_BATCH_URI,
-1183 )
-1184 self._batch_uri = batch_uri
-1185
-1186 # Global callback to be called for each individual response in the batch.
-1187 self._callback = callback
-1188
-1189 # A map from id to request.
-1190 self._requests = {}
-1191
-1192 # A map from id to callback.
-1193 self._callbacks = {}
-1194
-1195 # List of request ids, in the order in which they were added.
-1196 self._order = []
-1197
-1198 # The last auto generated id.
-1199 self._last_auto_id = 0
-1200
-1201 # Unique ID on which to base the Content-ID headers.
-1202 self._base_id = None
-1203
-1204 # A map from request id to (httplib2.Response, content) response pairs
-1205 self._responses = {}
-1206
-1207 # A map of id(Credentials) that have been refreshed.
-1208 self._refreshed_credentials = {}
-1209
-1211 """Refresh the credentials and apply to the request.
-1212
-1213 Args:
-1214 request: HttpRequest, the request.
-1215 http: httplib2.Http, the global http object for the batch.
-1216 """
-1217 # For the credentials to refresh, but only once per refresh_token
-1218 # If there is no http per the request then refresh the http passed in
-1219 # via execute()
-1220 creds = None
-1221 request_credentials = False
-1222
-1223 if request.http is not None:
-1224 creds = _auth.get_credentials_from_http(request.http)
-1225 request_credentials = True
-1226
-1227 if creds is None and http is not None:
-1228 creds = _auth.get_credentials_from_http(http)
-1229
-1230 if creds is not None:
-1231 if id(creds) not in self._refreshed_credentials:
-1232 _auth.refresh_credentials(creds)
-1233 self._refreshed_credentials[id(creds)] = 1
-1234
-1235 # Only apply the credentials if we are using the http object passed in,
-1236 # otherwise apply() will get called during _serialize_request().
-1237 if request.http is None or not request_credentials:
-1238 _auth.apply_credentials(creds, request.headers)
-1239
-1241 """Convert an id to a Content-ID header value.
-1242
-1243 Args:
-1244 id_: string, identifier of individual request.
-1245
-1246 Returns:
-1247 A Content-ID header with the id_ encoded into it. A UUID is prepended to
-1248 the value because Content-ID headers are supposed to be universally
-1249 unique.
-1250 """
-1251 if self._base_id is None:
-1252 self._base_id = uuid.uuid4()
-1253
-1254 # NB: we intentionally leave whitespace between base/id and '+', so RFC2822
-1255 # line folding works properly on Python 3; see
-1256 # https://github.com/googleapis/google-api-python-client/issues/164
-1257 return "<%s + %s>" % (self._base_id, quote(id_))
-1258
-1260 """Convert a Content-ID header value to an id.
-1261
-1262 Presumes the Content-ID header conforms to the format that _id_to_header()
-1263 returns.
-1264
-1265 Args:
-1266 header: string, Content-ID header value.
-1267
-1268 Returns:
-1269 The extracted id value.
-1270
-1271 Raises:
-1272 BatchError if the header is not in the expected format.
-1273 """
-1274 if header[0] != "<" or header[-1] != ">":
-1275 raise BatchError("Invalid value for Content-ID: %s" % header)
-1276 if "+" not in header:
-1277 raise BatchError("Invalid value for Content-ID: %s" % header)
-1278 base, id_ = header[1:-1].split(" + ", 1)
-1279
-1280 return unquote(id_)
-1281
-1283 """Convert an HttpRequest object into a string.
-1284
-1285 Args:
-1286 request: HttpRequest, the request to serialize.
-1287
-1288 Returns:
-1289 The request as a string in application/http format.
-1290 """
-1291 # Construct status line
-1292 parsed = urlparse(request.uri)
-1293 request_line = urlunparse(
-1294 ("", "", parsed.path, parsed.params, parsed.query, "")
-1295 )
-1296 status_line = request.method + " " + request_line + " HTTP/1.1\n"
-1297 major, minor = request.headers.get("content-type", "application/json").split(
-1298 "/"
-1299 )
-1300 msg = MIMENonMultipart(major, minor)
-1301 headers = request.headers.copy()
-1302
-1303 if request.http is not None:
-1304 credentials = _auth.get_credentials_from_http(request.http)
-1305 if credentials is not None:
-1306 _auth.apply_credentials(credentials, headers)
-1307
-1308 # MIMENonMultipart adds its own Content-Type header.
-1309 if "content-type" in headers:
-1310 del headers["content-type"]
-1311
-1312 for key, value in six.iteritems(headers):
-1313 msg[key] = value
-1314 msg["Host"] = parsed.netloc
-1315 msg.set_unixfrom(None)
-1316
-1317 if request.body is not None:
-1318 msg.set_payload(request.body)
-1319 msg["content-length"] = str(len(request.body))
-1320
-1321 # Serialize the mime message.
-1322 fp = StringIO()
-1323 # maxheaderlen=0 means don't line wrap headers.
-1324 g = Generator(fp, maxheaderlen=0)
-1325 g.flatten(msg, unixfrom=False)
-1326 body = fp.getvalue()
-1327
-1328 return status_line + body
-1329
-1331 """Convert string into httplib2 response and content.
-1332
-1333 Args:
-1334 payload: string, headers and body as a string.
-1335
-1336 Returns:
-1337 A pair (resp, content), such as would be returned from httplib2.request.
-1338 """
-1339 # Strip off the status line
-1340 status_line, payload = payload.split("\n", 1)
-1341 protocol, status, reason = status_line.split(" ", 2)
-1342
-1343 # Parse the rest of the response
-1344 parser = FeedParser()
-1345 parser.feed(payload)
-1346 msg = parser.close()
-1347 msg["status"] = status
-1348
-1349 # Create httplib2.Response from the parsed headers.
-1350 resp = httplib2.Response(msg)
-1351 resp.reason = reason
-1352 resp.version = int(protocol.split("/", 1)[1].replace(".", ""))
-1353
-1354 content = payload.split("\r\n\r\n", 1)[1]
-1355
-1356 return resp, content
-1357
-1359 """Create a new id.
-1360
-1361 Auto incrementing number that avoids conflicts with ids already used.
-1362
-1363 Returns:
-1364 string, a new unique id.
-1365 """
-1366 self._last_auto_id += 1
-1367 while str(self._last_auto_id) in self._requests:
-1368 self._last_auto_id += 1
-1369 return str(self._last_auto_id)
-1370
-1371 @util.positional(2)
-1373 """Add a new request.
-1374
-1375 Every callback added will be paired with a unique id, the request_id. That
-1376 unique id will be passed back to the callback when the response comes back
-1377 from the server. The default behavior is to have the library generate it's
-1378 own unique id. If the caller passes in a request_id then they must ensure
-1379 uniqueness for each request_id, and if they are not an exception is
-1380 raised. Callers should either supply all request_ids or never supply a
-1381 request id, to avoid such an error.
-1382
-1383 Args:
-1384 request: HttpRequest, Request to add to the batch.
-1385 callback: callable, A callback to be called for this response, of the
-1386 form callback(id, response, exception). The first parameter is the
-1387 request id, and the second is the deserialized response object. The
-1388 third is an googleapiclient.errors.HttpError exception object if an HTTP error
-1389 occurred while processing the request, or None if no errors occurred.
-1390 request_id: string, A unique id for the request. The id will be passed
-1391 to the callback with the response.
-1392
-1393 Returns:
-1394 None
-1395
-1396 Raises:
-1397 BatchError if a media request is added to a batch.
-1398 KeyError is the request_id is not unique.
-1399 """
-1400
-1401 if len(self._order) >= MAX_BATCH_LIMIT:
-1402 raise BatchError(
-1403 "Exceeded the maximum calls(%d) in a single batch request."
-1404 % MAX_BATCH_LIMIT
-1405 )
-1406 if request_id is None:
-1407 request_id = self._new_id()
-1408 if request.resumable is not None:
-1409 raise BatchError("Media requests cannot be used in a batch request.")
-1410 if request_id in self._requests:
-1411 raise KeyError("A request with this ID already exists: %s" % request_id)
-1412 self._requests[request_id] = request
-1413 self._callbacks[request_id] = callback
-1414 self._order.append(request_id)
-1415
-1417 """Serialize batch request, send to server, process response.
-1418
-1419 Args:
-1420 http: httplib2.Http, an http object to be used to make the request with.
-1421 order: list, list of request ids in the order they were added to the
-1422 batch.
-1423 requests: list, list of request objects to send.
-1424
-1425 Raises:
-1426 httplib2.HttpLib2Error if a transport error has occurred.
-1427 googleapiclient.errors.BatchError if the response is the wrong format.
-1428 """
-1429 message = MIMEMultipart("mixed")
-1430 # Message should not write out it's own headers.
-1431 setattr(message, "_write_headers", lambda self: None)
-1432
-1433 # Add all the individual requests.
-1434 for request_id in order:
-1435 request = requests[request_id]
-1436
-1437 msg = MIMENonMultipart("application", "http")
-1438 msg["Content-Transfer-Encoding"] = "binary"
-1439 msg["Content-ID"] = self._id_to_header(request_id)
-1440
-1441 body = self._serialize_request(request)
-1442 msg.set_payload(body)
-1443 message.attach(msg)
-1444
-1445 # encode the body: note that we can't use `as_string`, because
-1446 # it plays games with `From ` lines.
-1447 fp = StringIO()
-1448 g = Generator(fp, mangle_from_=False)
-1449 g.flatten(message, unixfrom=False)
-1450 body = fp.getvalue()
-1451
-1452 headers = {}
-1453 headers["content-type"] = (
-1454 "multipart/mixed; " 'boundary="%s"'
-1455 ) % message.get_boundary()
-1456
-1457 resp, content = http.request(
-1458 self._batch_uri, method="POST", body=body, headers=headers
-1459 )
-1460
-1461 if resp.status >= 300:
-1462 raise HttpError(resp, content, uri=self._batch_uri)
-1463
-1464 # Prepend with a content-type header so FeedParser can handle it.
-1465 header = "content-type: %s\r\n\r\n" % resp["content-type"]
-1466 # PY3's FeedParser only accepts unicode. So we should decode content
-1467 # here, and encode each payload again.
-1468 if six.PY3:
-1469 content = content.decode("utf-8")
-1470 for_parser = header + content
-1471
-1472 parser = FeedParser()
-1473 parser.feed(for_parser)
-1474 mime_response = parser.close()
-1475
-1476 if not mime_response.is_multipart():
-1477 raise BatchError(
-1478 "Response not in multipart/mixed format.", resp=resp, content=content
-1479 )
-1480
-1481 for part in mime_response.get_payload():
-1482 request_id = self._header_to_id(part["Content-ID"])
-1483 response, content = self._deserialize_response(part.get_payload())
-1484 # We encode content here to emulate normal http response.
-1485 if isinstance(content, six.text_type):
-1486 content = content.encode("utf-8")
-1487 self._responses[request_id] = (response, content)
-1488
-1489 @util.positional(1)
-1491 """Execute all the requests as a single batched HTTP request.
-1492
-1493 Args:
-1494 http: httplib2.Http, an http object to be used in place of the one the
-1495 HttpRequest request object was constructed with. If one isn't supplied
-1496 then use a http object from the requests in this batch.
-1497
-1498 Returns:
-1499 None
-1500
-1501 Raises:
-1502 httplib2.HttpLib2Error if a transport error has occurred.
-1503 googleapiclient.errors.BatchError if the response is the wrong format.
-1504 """
-1505 # If we have no requests return
-1506 if len(self._order) == 0:
-1507 return None
-1508
-1509 # If http is not supplied use the first valid one given in the requests.
-1510 if http is None:
-1511 for request_id in self._order:
-1512 request = self._requests[request_id]
-1513 if request is not None:
-1514 http = request.http
-1515 break
-1516
-1517 if http is None:
-1518 raise ValueError("Missing a valid http object.")
-1519
-1520 # Special case for OAuth2Credentials-style objects which have not yet been
-1521 # refreshed with an initial access_token.
-1522 creds = _auth.get_credentials_from_http(http)
-1523 if creds is not None:
-1524 if not _auth.is_valid(creds):
-1525 LOGGER.info("Attempting refresh to obtain initial access_token")
-1526 _auth.refresh_credentials(creds)
-1527
-1528 self._execute(http, self._order, self._requests)
-1529
-1530 # Loop over all the requests and check for 401s. For each 401 request the
-1531 # credentials should be refreshed and then sent again in a separate batch.
-1532 redo_requests = {}
-1533 redo_order = []
-1534
-1535 for request_id in self._order:
-1536 resp, content = self._responses[request_id]
-1537 if resp["status"] == "401":
-1538 redo_order.append(request_id)
-1539 request = self._requests[request_id]
-1540 self._refresh_and_apply_credentials(request, http)
-1541 redo_requests[request_id] = request
-1542
-1543 if redo_requests:
-1544 self._execute(http, redo_order, redo_requests)
-1545
-1546 # Now process all callbacks that are erroring, and raise an exception for
-1547 # ones that return a non-2xx response? Or add extra parameter to callback
-1548 # that contains an HttpError?
-1549
-1550 for request_id in self._order:
-1551 resp, content = self._responses[request_id]
-1552
-1553 request = self._requests[request_id]
-1554 callback = self._callbacks[request_id]
-1555
-1556 response = None
-1557 exception = None
-1558 try:
-1559 if resp.status >= 300:
-1560 raise HttpError(resp, content, uri=request.uri)
-1561 response = request.postproc(resp, content)
-1562 except HttpError as e:
-1563 exception = e
-1564
-1565 if callback is not None:
-1566 callback(request_id, response, exception)
-1567 if self._callback is not None:
-1568 self._callback(request_id, response, exception)
-1569
-1572 """Mock of HttpRequest.
-1573
-1574 Do not construct directly, instead use RequestMockBuilder.
-1575 """
-1576
-1578 """Constructor for HttpRequestMock
-1579
-1580 Args:
-1581 resp: httplib2.Response, the response to emulate coming from the request
-1582 content: string, the response body
-1583 postproc: callable, the post processing function usually supplied by
-1584 the model class. See model.JsonModel.response() as an example.
-1585 """
-1586 self.resp = resp
-1587 self.content = content
-1588 self.postproc = postproc
-1589 if resp is None:
-1590 self.resp = httplib2.Response({"status": 200, "reason": "OK"})
-1591 if "reason" in self.resp:
-1592 self.resp.reason = self.resp["reason"]
-1593
-1601
-1604 """A simple mock of HttpRequest
-1605
-1606 Pass in a dictionary to the constructor that maps request methodIds to
-1607 tuples of (httplib2.Response, content, opt_expected_body) that should be
-1608 returned when that method is called. None may also be passed in for the
-1609 httplib2.Response, in which case a 200 OK response will be generated.
-1610 If an opt_expected_body (str or dict) is provided, it will be compared to
-1611 the body and UnexpectedBodyError will be raised on inequality.
-1612
-1613 Example:
-1614 response = '{"data": {"id": "tag:google.c...'
-1615 requestBuilder = RequestMockBuilder(
-1616 {
-1617 'plus.activities.get': (None, response),
-1618 }
-1619 )
-1620 googleapiclient.discovery.build("plus", "v1", requestBuilder=requestBuilder)
-1621
-1622 Methods that you do not supply a response for will return a
-1623 200 OK with an empty string as the response content or raise an excpetion
-1624 if check_unexpected is set to True. The methodId is taken from the rpcName
-1625 in the discovery document.
-1626
-1627 For more details see the project wiki.
-1628 """
-1629
-1631 """Constructor for RequestMockBuilder
-1632
-1633 The constructed object should be a callable object
-1634 that can replace the class HttpResponse.
-1635
-1636 responses - A dictionary that maps methodIds into tuples
-1637 of (httplib2.Response, content). The methodId
-1638 comes from the 'rpcName' field in the discovery
-1639 document.
-1640 check_unexpected - A boolean setting whether or not UnexpectedMethodError
-1641 should be raised on unsupplied method.
-1642 """
-1643 self.responses = responses
-1644 self.check_unexpected = check_unexpected
-1645
-1646 - def __call__(
-1647 self,
-1648 http,
-1649 postproc,
-1650 uri,
-1651 method="GET",
-1652 body=None,
-1653 headers=None,
-1654 methodId=None,
-1655 resumable=None,
-1656 ):
-1657 """Implements the callable interface that discovery.build() expects
-1658 of requestBuilder, which is to build an object compatible with
-1659 HttpRequest.execute(). See that method for the description of the
-1660 parameters and the expected response.
-1661 """
-1662 if methodId in self.responses:
-1663 response = self.responses[methodId]
-1664 resp, content = response[:2]
-1665 if len(response) > 2:
-1666 # Test the body against the supplied expected_body.
-1667 expected_body = response[2]
-1668 if bool(expected_body) != bool(body):
-1669 # Not expecting a body and provided one
-1670 # or expecting a body and not provided one.
-1671 raise UnexpectedBodyError(expected_body, body)
-1672 if isinstance(expected_body, str):
-1673 expected_body = json.loads(expected_body)
-1674 body = json.loads(body)
-1675 if body != expected_body:
-1676 raise UnexpectedBodyError(expected_body, body)
-1677 return HttpRequestMock(resp, content, postproc)
-1678 elif self.check_unexpected:
-1679 raise UnexpectedMethodError(methodId=methodId)
-1680 else:
-1681 model = JsonModel(False)
-1682 return HttpRequestMock(None, "{}", model.response)
-1683
-1686 """Mock of httplib2.Http"""
-1687
-1689 """
-1690 Args:
-1691 filename: string, absolute filename to read response from
-1692 headers: dict, header to return with response
-1693 """
-1694 if headers is None:
-1695 headers = {"status": "200"}
-1696 if filename:
-1697 with open(filename, "rb") as f:
-1698 self.data = f.read()
-1699 else:
-1700 self.data = None
-1701 self.response_headers = headers
-1702 self.headers = None
-1703 self.uri = None
-1704 self.method = None
-1705 self.body = None
-1706 self.headers = None
-1707
-1708 - def request(
-1709 self,
-1710 uri,
-1711 method="GET",
-1712 body=None,
-1713 headers=None,
-1714 redirections=1,
-1715 connection_type=None,
-1716 ):
-1717 self.uri = uri
-1718 self.method = method
-1719 self.body = body
-1720 self.headers = headers
-1721 return httplib2.Response(self.response_headers), self.data
-1722
-1725
-1727 """Mock of httplib2.Http
-1728
-1729 Mocks a sequence of calls to request returning different responses for each
-1730 call. Create an instance initialized with the desired response headers
-1731 and content and then use as if an httplib2.Http instance.
-1732
-1733 http = HttpMockSequence([
-1734 ({'status': '401'}, ''),
-1735 ({'status': '200'}, '{"access_token":"1/3w","expires_in":3600}'),
-1736 ({'status': '200'}, 'echo_request_headers'),
-1737 ])
-1738 resp, content = http.request("http://examples.com")
-1739
-1740 There are special values you can pass in for content to trigger
-1741 behavours that are helpful in testing.
-1742
-1743 'echo_request_headers' means return the request headers in the response body
-1744 'echo_request_headers_as_json' means return the request headers in
-1745 the response body
-1746 'echo_request_body' means return the request body in the response body
-1747 'echo_request_uri' means return the request uri in the response body
-1748 """
-1749
-1751 """
-1752 Args:
-1753 iterable: iterable, a sequence of pairs of (headers, body)
-1754 """
-1755 self._iterable = iterable
-1756 self.follow_redirects = True
-1757 self.request_sequence = list()
-1758
-1759 - def request(
-1760 self,
-1761 uri,
-1762 method="GET",
-1763 body=None,
-1764 headers=None,
-1765 redirections=1,
-1766 connection_type=None,
-1767 ):
-1768 # Remember the request so after the fact this mock can be examined
-1769 self.request_sequence.append((uri, method, body, headers))
-1770 resp, content = self._iterable.pop(0)
-1771 content = six.ensure_binary(content)
-1772
-1773 if content == b"echo_request_headers":
-1774 content = headers
-1775 elif content == b"echo_request_headers_as_json":
-1776 content = json.dumps(headers)
-1777 elif content == b"echo_request_body":
-1778 if hasattr(body, "read"):
-1779 content = body.read()
-1780 else:
-1781 content = body
-1782 elif content == b"echo_request_uri":
-1783 content = uri
-1784 if isinstance(content, six.text_type):
-1785 content = content.encode("utf-8")
-1786 return httplib2.Response(resp), content
-1787
-1790 """Set the user-agent on every request.
-1791
-1792 Args:
-1793 http - An instance of httplib2.Http
-1794 or something that acts like it.
-1795 user_agent: string, the value for the user-agent header.
-1796
-1797 Returns:
-1798 A modified instance of http that was passed in.
-1799
-1800 Example:
-1801
-1802 h = httplib2.Http()
-1803 h = set_user_agent(h, "my-app-name/6.0")
-1804
-1805 Most of the time the user-agent will be set doing auth, this is for the rare
-1806 cases where you are accessing an unauthenticated endpoint.
-1807 """
-1808 request_orig = http.request
-1809
-1810 # The closure that will replace 'httplib2.Http.request'.
-1811 def new_request(
-1812 uri,
-1813 method="GET",
-1814 body=None,
-1815 headers=None,
-1816 redirections=httplib2.DEFAULT_MAX_REDIRECTS,
-1817 connection_type=None,
-1818 ):
-1819 """Modify the request headers to add the user-agent."""
-1820 if headers is None:
-1821 headers = {}
-1822 if "user-agent" in headers:
-1823 headers["user-agent"] = user_agent + " " + headers["user-agent"]
-1824 else:
-1825 headers["user-agent"] = user_agent
-1826 resp, content = request_orig(
-1827 uri,
-1828 method=method,
-1829 body=body,
-1830 headers=headers,
-1831 redirections=redirections,
-1832 connection_type=connection_type,
-1833 )
-1834 return resp, content
-1835
-1836 http.request = new_request
-1837 return http
-1838
-1841 """Tunnel PATCH requests over POST.
-1842 Args:
-1843 http - An instance of httplib2.Http
-1844 or something that acts like it.
-1845
-1846 Returns:
-1847 A modified instance of http that was passed in.
-1848
-1849 Example:
-1850
-1851 h = httplib2.Http()
-1852 h = tunnel_patch(h, "my-app-name/6.0")
-1853
-1854 Useful if you are running on a platform that doesn't support PATCH.
-1855 Apply this last if you are using OAuth 1.0, as changing the method
-1856 will result in a different signature.
-1857 """
-1858 request_orig = http.request
-1859
-1860 # The closure that will replace 'httplib2.Http.request'.
-1861 def new_request(
-1862 uri,
-1863 method="GET",
-1864 body=None,
-1865 headers=None,
-1866 redirections=httplib2.DEFAULT_MAX_REDIRECTS,
-1867 connection_type=None,
-1868 ):
-1869 """Modify the request headers to add the user-agent."""
-1870 if headers is None:
-1871 headers = {}
-1872 if method == "PATCH":
-1873 if "oauth_token" in headers.get("authorization", ""):
-1874 LOGGER.warning(
-1875 "OAuth 1.0 request made with Credentials after tunnel_patch."
-1876 )
-1877 headers["x-http-method-override"] = "PATCH"
-1878 method = "POST"
-1879 resp, content = request_orig(
-1880 uri,
-1881 method=method,
-1882 body=body,
-1883 headers=headers,
-1884 redirections=redirections,
-1885 connection_type=connection_type,
-1886 )
-1887 return resp, content
-1888
-1889 http.request = new_request
-1890 return http
-1891
-1894 """Builds httplib2.Http object
-1895
-1896 Returns:
-1897 A httplib2.Http object, which is used to make http requests, and which has timeout set by default.
-1898 To override default timeout call
-1899
-1900 socket.setdefaulttimeout(timeout_in_sec)
-1901
-1902 before interacting with this method.
-1903 """
-1904 if socket.getdefaulttimeout() is not None:
-1905 http_timeout = socket.getdefaulttimeout()
-1906 else:
-1907 http_timeout = DEFAULT_HTTP_TIMEOUT_SEC
-1908 http = httplib2.Http(timeout=http_timeout)
-1909 # 308's are used by several Google APIs (Drive, YouTube)
-1910 # for Resumable Uploads rather than Permanent Redirects.
-1911 # This asks httplib2 to exclude 308s from the status codes
-1912 # it treats as redirects
-1913 try:
-1914 http.redirect_codes = http.redirect_codes - {308}
-1915 except AttributeError:
-1916 # Apache Beam tests depend on this library and cannot
-1917 # currently upgrade their httplib2 version
-1918 # http.redirect_codes does not exist in previous versions
-1919 # of httplib2, so pass
-1920 pass
-1921
-1922 return http
-1923
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.http.BatchHttpRequest-class.html b/docs/epy/googleapiclient.http.BatchHttpRequest-class.html
deleted file mode 100644
index 965e376c832..00000000000
--- a/docs/epy/googleapiclient.http.BatchHttpRequest-class.html
+++ /dev/null
@@ -1,752 +0,0 @@
-
-
-
-
- googleapiclient.http.BatchHttpRequest
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class BatchHttpRequest
-
-object --+
- |
- BatchHttpRequest
-
-
-
-
-Batches multiple HttpRequest objects into a single HTTP request.
-
-Example:
- from googleapiclient.http import BatchHttpRequest
-
- def list_animals(request_id, response, exception):
- """Do something with the animals list response."""
- if exception is not None:
- # Do something with the exception.
- pass
- else:
- # Do something with the response.
- pass
-
- def list_farmers(request_id, response, exception):
- """Do something with the farmers list response."""
- if exception is not None:
- # Do something with the exception.
- pass
- else:
- # Do something with the response.
- pass
-
- service = build('farm', 'v2')
-
- batch = BatchHttpRequest()
-
- batch.add(service.animals().list(), list_animals)
- batch.add(service.farmers().list(), list_farmers)
- batch.execute(http=http)
-
-
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
- Constructor for a BatchHttpRequest.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _refresh_and_apply_credentials(self,
- request,
- http)
- Refresh the credentials and apply to the request.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _id_to_header(self,
- id_)
- Convert an id to a Content-ID header value.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _header_to_id(self,
- header)
- Convert a Content-ID header value to an id.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _serialize_request(self,
- request)
- Convert an HttpRequest object into a string.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _deserialize_response(self,
- payload)
- Convert string into httplib2 response and content.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _new_id(self)
- Create a new id.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- add(*args,
- **kwargs)
- Add a new request.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _execute(self,
- http,
- order,
- requests)
- Serialize batch request, send to server, process response.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- execute(*args,
- **kwargs)
- Execute all the requests as a single batched HTTP request.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
-
(Constructor)
-
- source code
-
-
-
-
-Constructor for a BatchHttpRequest.
-
-Args:
- callback: callable, A callback to be called for each response, of the
- form callback(id, response, exception). The first parameter is the
- request id, and the second is the deserialized response object. The
- third is an googleapiclient.errors.HttpError exception object if an HTTP error
- occurred while processing the request, or None if no error occurred.
- batch_uri: string, URI to send batch requests to.
-
-
-
- - Decorators:
-
- @util.positional(1)
- Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
-
- _refresh_and_apply_credentials(self,
- request,
- http)
-
- source code
-
-
-
-
-Refresh the credentials and apply to the request.
-
-Args:
- request: HttpRequest, the request.
- http: httplib2.Http, the global http object for the batch.
-
-
-
-
-
-
-
-
-
-
-
-
- _id_to_header(self,
- id_)
-
- source code
-
-
-
-
-Convert an id to a Content-ID header value.
-
-Args:
- id_: string, identifier of individual request.
-
-Returns:
- A Content-ID header with the id_ encoded into it. A UUID is prepended to
- the value because Content-ID headers are supposed to be universally
- unique.
-
-
-
-
-
-
-
-
-
-
-
-
- _header_to_id(self,
- header)
-
- source code
-
-
-
-
-Convert a Content-ID header value to an id.
-
-Presumes the Content-ID header conforms to the format that _id_to_header()
-returns.
-
-Args:
- header: string, Content-ID header value.
-
-Returns:
- The extracted id value.
-
-Raises:
- BatchError if the header is not in the expected format.
-
-
-
-
-
-
-
-
-
-
-
-
- _serialize_request(self,
- request)
-
- source code
-
-
-
-
-Convert an HttpRequest object into a string.
-
-Args:
- request: HttpRequest, the request to serialize.
-
-Returns:
- The request as a string in application/http format.
-
-
-
-
-
-
-
-
-
-
-
-
- _deserialize_response(self,
- payload)
-
- source code
-
-
-
-
-Convert string into httplib2 response and content.
-
-Args:
- payload: string, headers and body as a string.
-
-Returns:
- A pair (resp, content), such as would be returned from httplib2.request.
-
-
-
-
-
-
-
-
-
-
-
-
- _new_id(self)
-
- source code
-
-
-
-
-Create a new id.
-
-Auto incrementing number that avoids conflicts with ids already used.
-
-Returns:
- string, a new unique id.
-
-
-
-
-
-
-
-
-
-
-
-
- add(*args,
- **kwargs)
-
- source code
-
-
-
-
-Add a new request.
-
-Every callback added will be paired with a unique id, the request_id. That
-unique id will be passed back to the callback when the response comes back
-from the server. The default behavior is to have the library generate it's
-own unique id. If the caller passes in a request_id then they must ensure
-uniqueness for each request_id, and if they are not an exception is
-raised. Callers should either supply all request_ids or never supply a
-request id, to avoid such an error.
-
-Args:
- request: HttpRequest, Request to add to the batch.
- callback: callable, A callback to be called for this response, of the
- form callback(id, response, exception). The first parameter is the
- request id, and the second is the deserialized response object. The
- third is an googleapiclient.errors.HttpError exception object if an HTTP error
- occurred while processing the request, or None if no errors occurred.
- request_id: string, A unique id for the request. The id will be passed
- to the callback with the response.
-
-Returns:
- None
-
-Raises:
- BatchError if a media request is added to a batch.
- KeyError is the request_id is not unique.
-
-
-
- - Decorators:
-
- @util.positional(2)
-
-
-
-
-
-
-
-
- _execute(self,
- http,
- order,
- requests)
-
- source code
-
-
-
-
-Serialize batch request, send to server, process response.
-
-Args:
- http: httplib2.Http, an http object to be used to make the request with.
- order: list, list of request ids in the order they were added to the
- batch.
- requests: list, list of request objects to send.
-
-Raises:
- httplib2.HttpLib2Error if a transport error has occurred.
- googleapiclient.errors.BatchError if the response is the wrong format.
-
-
-
-
-
-
-
-
-
-
-
-
- execute(*args,
- **kwargs)
-
- source code
-
-
-
-
-Execute all the requests as a single batched HTTP request.
-
-Args:
- http: httplib2.Http, an http object to be used in place of the one the
- HttpRequest request object was constructed with. If one isn't supplied
- then use a http object from the requests in this batch.
-
-Returns:
- None
-
-Raises:
- httplib2.HttpLib2Error if a transport error has occurred.
- googleapiclient.errors.BatchError if the response is the wrong format.
-
-
-
- - Decorators:
-
- @util.positional(1)
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.http.HttpMock-class.html b/docs/epy/googleapiclient.http.HttpMock-class.html
deleted file mode 100644
index fdc03ae8052..00000000000
--- a/docs/epy/googleapiclient.http.HttpMock-class.html
+++ /dev/null
@@ -1,282 +0,0 @@
-
-
-
-
- googleapiclient.http.HttpMock
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class HttpMock
-
-object --+
- |
- HttpMock
-
-
-
-Mock of httplib2.Http
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- filename=None,
- headers=None)
- Args:...
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- request(self,
- uri,
- method='GET',
- body=None,
- headers=None,
- redirections=1,
- connection_type=None)
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- close(self)
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- filename=None,
- headers=None)
-
(Constructor)
-
- source code
-
-
-
-
-
-Args:
- filename: string, absolute filename to read response from
- headers: dict, header to return with response
-
-
-
- - Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.http.HttpMockSequence-class.html b/docs/epy/googleapiclient.http.HttpMockSequence-class.html
deleted file mode 100644
index 9eaf4d1e7c4..00000000000
--- a/docs/epy/googleapiclient.http.HttpMockSequence-class.html
+++ /dev/null
@@ -1,286 +0,0 @@
-
-
-
-
- googleapiclient.http.HttpMockSequence
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class HttpMockSequence
-
-object --+
- |
- HttpMockSequence
-
-
-
-
-Mock of httplib2.Http
-
-Mocks a sequence of calls to request returning different responses for each
-call. Create an instance initialized with the desired response headers
-and content and then use as if an httplib2.Http instance.
-
- http = HttpMockSequence([
- ({'status': '401'}, ''),
- ({'status': '200'}, '{"access_token":"1/3w","expires_in":3600}'),
- ({'status': '200'}, 'echo_request_headers'),
- ])
- resp, content = http.request("http://examples.com")
-
-There are special values you can pass in for content to trigger
-behavours that are helpful in testing.
-
-'echo_request_headers' means return the request headers in the response body
-'echo_request_headers_as_json' means return the request headers in
- the response body
-'echo_request_body' means return the request body in the response body
-'echo_request_uri' means return the request uri in the response body
-
-
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- iterable)
- Args:...
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- request(self,
- uri,
- method='GET',
- body=None,
- headers=None,
- redirections=1,
- connection_type=None)
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- iterable)
-
(Constructor)
-
- source code
-
-
-
-
-
-Args:
- iterable: iterable, a sequence of pairs of (headers, body)
-
-
-
- - Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.http.HttpRequest-class.html b/docs/epy/googleapiclient.http.HttpRequest-class.html
deleted file mode 100644
index 3a1e38b5d0a..00000000000
--- a/docs/epy/googleapiclient.http.HttpRequest-class.html
+++ /dev/null
@@ -1,572 +0,0 @@
-
-
-
-
- googleapiclient.http.HttpRequest
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class HttpRequest
-
-object --+
- |
- HttpRequest
-
-
-
-Encapsulates a single HTTP request.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
- Constructor for an HttpRequest.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- execute(*args,
- **kwargs)
- Execute the request.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- add_response_callback(*args,
- **kwargs)
- add_response_headers_callback
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- next_chunk(*args,
- **kwargs)
- Execute the next step of a resumable upload.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _process_response(self,
- resp,
- content)
- Process the response from a single chunk upload.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- to_json(self)
- Returns a JSON representation of the HttpRequest.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Static Methods
-
-
-
-
-
-
-
-
-
-
- from_json(s,
- http,
- postproc)
- Returns an HttpRequest populated with info from a JSON object.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- null_postproc(resp,
- contents)
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
-
(Constructor)
-
- source code
-
-
-
-
-Constructor for an HttpRequest.
-
-Args:
- http: httplib2.Http, the transport object to use to make a request
- postproc: callable, called on the HTTP response and content to transform
- it into a data object before returning, or raising an exception
- on an error.
- uri: string, the absolute URI to send the request to
- method: string, the HTTP method to use
- body: string, the request body of the HTTP request,
- headers: dict, the HTTP request headers
- methodId: string, a unique identifier for the API method being called.
- resumable: MediaUpload, None if this is not a resumbale request.
-
-
-
- - Decorators:
-
- @util.positional(4)
- Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
-
- execute(*args,
- **kwargs)
-
- source code
-
-
-
-
-Execute the request.
-
-Args:
- http: httplib2.Http, an http object to be used in place of the
- one the HttpRequest request object was constructed with.
- num_retries: Integer, number of times to retry with randomized
- exponential backoff. If all retries fail, the raised HttpError
- represents the last request. If zero (default), we attempt the
- request only once.
-
-Returns:
- A deserialized object model of the response body as determined
- by the postproc.
-
-Raises:
- googleapiclient.errors.HttpError if the response was not a 2xx.
- httplib2.HttpLib2Error if a transport error has occurred.
-
-
-
- - Decorators:
-
- @util.positional(1)
-
-
-
-
-
-
-
-
- add_response_callback(*args,
- **kwargs)
-
- source code
-
-
-
-
-add_response_headers_callback
-
-Args:
- cb: Callback to be called on receiving the response headers, of signature:
-
- def cb(resp):
- # Where resp is an instance of httplib2.Response
-
-
-
- - Decorators:
-
- @util.positional(2)
-
-
-
-
-
-
-
-
- next_chunk(*args,
- **kwargs)
-
- source code
-
-
-
-
-Execute the next step of a resumable upload.
-
-Can only be used if the method being executed supports media uploads and
-the MediaUpload object passed in was flagged as using resumable upload.
-
-Example:
-
- media = MediaFileUpload('cow.png', mimetype='image/png',
- chunksize=1000, resumable=True)
- request = farm.animals().insert(
- id='cow',
- name='cow.png',
- media_body=media)
-
- response = None
- while response is None:
- status, response = request.next_chunk()
- if status:
- print "Upload %d%% complete." % int(status.progress() * 100)
-
-
-Args:
- http: httplib2.Http, an http object to be used in place of the
- one the HttpRequest request object was constructed with.
- num_retries: Integer, number of times to retry with randomized
- exponential backoff. If all retries fail, the raised HttpError
- represents the last request. If zero (default), we attempt the
- request only once.
-
-Returns:
- (status, body): (ResumableMediaStatus, object)
- The body will be None until the resumable media is fully uploaded.
-
-Raises:
- googleapiclient.errors.HttpError if the response was not a 2xx.
- httplib2.HttpLib2Error if a transport error has occurred.
-
-
-
- - Decorators:
-
- @util.positional(1)
-
-
-
-
-
-
-
-
- _process_response(self,
- resp,
- content)
-
- source code
-
-
-
-
-Process the response from a single chunk upload.
-
-Args:
- resp: httplib2.Response, the response object.
- content: string, the content of the response.
-
-Returns:
- (status, body): (ResumableMediaStatus, object)
- The body will be None until the resumable media is fully uploaded.
-
-Raises:
- googleapiclient.errors.HttpError if the response was not a 2xx or a 308.
-
-
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.http.HttpRequestMock-class.html b/docs/epy/googleapiclient.http.HttpRequestMock-class.html
deleted file mode 100644
index 804582119fd..00000000000
--- a/docs/epy/googleapiclient.http.HttpRequestMock-class.html
+++ /dev/null
@@ -1,290 +0,0 @@
-
-
-
-
- googleapiclient.http.HttpRequestMock
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class HttpRequestMock
-
-object --+
- |
- HttpRequestMock
-
-
-
-Mock of HttpRequest.
- Do not construct directly, instead use RequestMockBuilder.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- resp,
- content,
- postproc)
- Constructor for HttpRequestMock
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- execute(self,
- http=None)
- Execute the request.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- resp,
- content,
- postproc)
-
(Constructor)
-
- source code
-
-
-
-
-Constructor for HttpRequestMock
-
-Args:
- resp: httplib2.Response, the response to emulate coming from the request
- content: string, the response body
- postproc: callable, the post processing function usually supplied by
- the model class. See model.JsonModel.response() as an example.
-
-
-
- - Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
-
- execute(self,
- http=None)
-
- source code
-
-
-
- Execute the request.
- Same behavior as HttpRequest.execute(), but the response is mocked and
- not really from an HTTP request/response.
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.http.MediaDownloadProgress-class.html b/docs/epy/googleapiclient.http.MediaDownloadProgress-class.html
deleted file mode 100644
index 5f6648e4b97..00000000000
--- a/docs/epy/googleapiclient.http.MediaDownloadProgress-class.html
+++ /dev/null
@@ -1,288 +0,0 @@
-
-
-
-
- googleapiclient.http.MediaDownloadProgress
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class MediaDownloadProgress
-
-object --+
- |
- MediaDownloadProgress
-
-
-
-Status of a resumable download.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- resumable_progress,
- total_size)
- Constructor.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- progress(self)
- Percent of download completed, as a float.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- resumable_progress,
- total_size)
-
(Constructor)
-
- source code
-
-
-
-
-Constructor.
-
-Args:
- resumable_progress: int, bytes received so far.
- total_size: int, total bytes in complete download.
-
-
-
- - Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
-
- progress(self)
-
- source code
-
-
-
-
-Percent of download completed, as a float.
-
-Returns:
- the percentage complete as a float, returning 0.0 if the total size of
- the download is unknown.
-
-
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.http.MediaFileUpload-class.html b/docs/epy/googleapiclient.http.MediaFileUpload-class.html
deleted file mode 100644
index b4f9a073ce9..00000000000
--- a/docs/epy/googleapiclient.http.MediaFileUpload-class.html
+++ /dev/null
@@ -1,413 +0,0 @@
-
-
-
-
- googleapiclient.http.MediaFileUpload
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class MediaFileUpload
-
- object --+
- |
- MediaUpload --+
- |
-MediaIoBaseUpload --+
- |
- MediaFileUpload
-
-
-
-
-A MediaUpload for a file.
-
-Construct a MediaFileUpload and pass as the media_body parameter of the
-method. For example, if we had a service that allowed uploading images:
-
- media = MediaFileUpload('cow.png', mimetype='image/png',
- chunksize=1024*1024, resumable=True)
- farm.animals().insert(
- id='cow',
- name='cow.png',
- media_body=media).execute()
-
-Depending on the platform you are working on, you may pass -1 as the
-chunksize, which indicates that the entire file should be uploaded in a single
-request. If the underlying platform supports streams, such as Python 2.6 or
-later, then this can be very efficient as it avoids multiple connections, and
-also avoids loading the entire file into memory before sending it. Note that
-Google App Engine has a 5MB limit on request size, so you should never set
-your chunksize larger than 5MB, or to -1.
-
-
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
- Constructor.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- __del__(self)
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- to_json(self)
- Creating a JSON representation of an instance of MediaFileUpload.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from MediaIoBaseUpload:
- chunksize,
- getbytes,
- has_stream,
- mimetype,
- resumable,
- size,
- stream
-
- Inherited from MediaUpload (private):
- _to_json
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Class Methods
-
-
-
-
-
-
- Inherited from MediaUpload:
- new_from_json
-
-
-
-
-
-
-
-
-
-
-
- Static Methods
-
-
-
-
-
-
-
-
-
-
- from_json(s)
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
-
(Constructor)
-
- source code
-
-
-
-
-Constructor.
-
-Args:
- filename: string, Name of the file.
- mimetype: string, Mime-type of the file. If None then a mime-type will be
- guessed from the file extension.
- chunksize: int, File will be uploaded in chunks of this many bytes. Only
- used if resumable=True. Pass in a value of -1 if the file is to be
- uploaded in a single chunk. Note that Google App Engine has a 5MB limit
- on request size, so you should never set your chunksize larger than 5MB,
- or to -1.
- resumable: bool, True if this is a resumable upload. False means upload
- in a single request.
-
-
-
- - Decorators:
-
- @util.positional(2)
- Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
-
- to_json(self)
-
- source code
-
-
-
-
-Creating a JSON representation of an instance of MediaFileUpload.
-
-Returns:
- string, a JSON representation of this instance, suitable to pass to
- from_json().
-
-
-
- - Overrides:
- MediaUpload.to_json
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.http.MediaInMemoryUpload-class.html b/docs/epy/googleapiclient.http.MediaInMemoryUpload-class.html
deleted file mode 100644
index 04e696d937d..00000000000
--- a/docs/epy/googleapiclient.http.MediaInMemoryUpload-class.html
+++ /dev/null
@@ -1,300 +0,0 @@
-
-
-
-
- googleapiclient.http.MediaInMemoryUpload
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class MediaInMemoryUpload
-
- object --+
- |
- MediaUpload --+
- |
-MediaIoBaseUpload --+
- |
- MediaInMemoryUpload
-
-
-
-MediaUpload for a chunk of bytes.
- DEPRECATED: Use MediaIoBaseUpload with either io.TextIOBase or
- StringIO for the stream.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
- Create a new MediaInMemoryUpload.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from MediaIoBaseUpload:
- chunksize,
- getbytes,
- has_stream,
- mimetype,
- resumable,
- size,
- stream,
- to_json
-
- Inherited from MediaUpload (private):
- _to_json
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Class Methods
-
-
-
-
-
-
- Inherited from MediaUpload:
- new_from_json
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
-
(Constructor)
-
- source code
-
-
-
-
-Create a new MediaInMemoryUpload.
-
-DEPRECATED: Use MediaIoBaseUpload with either io.TextIOBase or StringIO for
-the stream.
-
-Args:
- body: string, Bytes of body content.
- mimetype: string, Mime-type of the file or default of
- 'application/octet-stream'.
- chunksize: int, File will be uploaded in chunks of this many bytes. Only
- used if resumable=True.
- resumable: bool, True if this is a resumable upload. False means upload
- in a single request.
-
-
-
-
- - Decorators:
-
- @util.positional(2)
- Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.http.MediaIoBaseDownload-class.html b/docs/epy/googleapiclient.http.MediaIoBaseDownload-class.html
deleted file mode 100644
index d4f8b4293c4..00000000000
--- a/docs/epy/googleapiclient.http.MediaIoBaseDownload-class.html
+++ /dev/null
@@ -1,329 +0,0 @@
-
-
-
-
- googleapiclient.http.MediaIoBaseDownload
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class MediaIoBaseDownload
-
-object --+
- |
- MediaIoBaseDownload
-
-
-
-
-"Download media resources.
-
-Note that the Python file object is compatible with io.Base and can be used
-with this class also.
-
-
-Example:
- request = farms.animals().get_media(id='cow')
- fh = io.FileIO('cow.png', mode='wb')
- downloader = MediaIoBaseDownload(fh, request, chunksize=1024*1024)
-
- done = False
- while done is False:
- status, done = downloader.next_chunk()
- if status:
- print "Download %d%%." % int(status.progress() * 100)
- print "Download Complete!"
-
-
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
- Constructor.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- next_chunk(*args,
- **kwargs)
- Get the next chunk of the download.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
-
(Constructor)
-
- source code
-
-
-
-
-Constructor.
-
-Args:
- fd: io.Base or file object, The stream in which to write the downloaded
- bytes.
- request: googleapiclient.http.HttpRequest, the media request to perform in
- chunks.
- chunksize: int, File will be downloaded in chunks of this many bytes.
-
-
-
- - Decorators:
-
- @util.positional(3)
- Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
-
- next_chunk(*args,
- **kwargs)
-
- source code
-
-
-
-
-Get the next chunk of the download.
-
-Args:
- num_retries: Integer, number of times to retry with randomized
- exponential backoff. If all retries fail, the raised HttpError
- represents the last request. If zero (default), we attempt the
- request only once.
-
-Returns:
- (status, done): (MediaDownloadProgress, boolean)
- The value of 'done' will be True when the media has been fully
- downloaded or the total size of the media is unknown.
-
-Raises:
- googleapiclient.errors.HttpError if the response was not a 2xx.
- httplib2.HttpLib2Error if a transport error has occurred.
-
-
-
- - Decorators:
-
- @util.positional(1)
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.http.MediaIoBaseUpload-class.html b/docs/epy/googleapiclient.http.MediaIoBaseUpload-class.html
deleted file mode 100644
index a64712a7d5e..00000000000
--- a/docs/epy/googleapiclient.http.MediaIoBaseUpload-class.html
+++ /dev/null
@@ -1,683 +0,0 @@
-
-
-
-
- googleapiclient.http.MediaIoBaseUpload
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class MediaIoBaseUpload
-
- object --+
- |
-MediaUpload --+
- |
- MediaIoBaseUpload
-
-
-- Known Subclasses:
--
-
-
-
-
-
-A MediaUpload for a io.Base objects.
-
-Note that the Python file object is compatible with io.Base and can be used
-with this class also.
-
- fh = BytesIO('...Some data to upload...')
- media = MediaIoBaseUpload(fh, mimetype='image/png',
- chunksize=1024*1024, resumable=True)
- farm.animals().insert(
- id='cow',
- name='cow.png',
- media_body=media).execute()
-
-Depending on the platform you are working on, you may pass -1 as the
-chunksize, which indicates that the entire file should be uploaded in a single
-request. If the underlying platform supports streams, such as Python 2.6 or
-later, then this can be very efficient as it avoids multiple connections, and
-also avoids loading the entire file into memory before sending it. Note that
-Google App Engine has a 5MB limit on request size, so you should never set
-your chunksize larger than 5MB, or to -1.
-
-
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
- Constructor.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- chunksize(self)
- Chunk size for resumable uploads.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- mimetype(self)
- Mime type of the body.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- size(self)
- Size of upload.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- resumable(self)
- Whether this upload is resumable.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- getbytes(self,
- begin,
- length)
- Get bytes from the media.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- has_stream(self)
- Does the underlying upload support a streaming interface.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- stream(self)
- A stream interface to the data being uploaded.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- to_json(self)
- This upload type is not serializable.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from MediaUpload (private):
- _to_json
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Class Methods
-
-
-
-
-
-
- Inherited from MediaUpload:
- new_from_json
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
-
(Constructor)
-
- source code
-
-
-
-
-Constructor.
-
-Args:
- fd: io.Base or file object, The source of the bytes to upload. MUST be
- opened in blocking mode, do not use streams opened in non-blocking mode.
- The given stream must be seekable, that is, it must be able to call
- seek() on fd.
- mimetype: string, Mime-type of the file.
- chunksize: int, File will be uploaded in chunks of this many bytes. Only
- used if resumable=True. Pass in a value of -1 if the file is to be
- uploaded as a single chunk. Note that Google App Engine has a 5MB limit
- on request size, so you should never set your chunksize larger than 5MB,
- or to -1.
- resumable: bool, True if this is a resumable upload. False means upload
- in a single request.
-
-
-
- - Decorators:
-
- @util.positional(3)
- Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
-
- chunksize(self)
-
- source code
-
-
-
-
-Chunk size for resumable uploads.
-
-Returns:
- Chunk size in bytes.
-
-
-
- - Overrides:
- MediaUpload.chunksize
-
-
-
-
-
-
-
-
-
-
- mimetype(self)
-
- source code
-
-
-
-
-Mime type of the body.
-
-Returns:
- Mime type.
-
-
-
- - Overrides:
- MediaUpload.mimetype
-
-
-
-
-
-
-
-
-
-
- size(self)
-
- source code
-
-
-
-
-Size of upload.
-
-Returns:
- Size of the body, or None of the size is unknown.
-
-
-
- - Overrides:
- MediaUpload.size
-
-
-
-
-
-
-
-
-
-
- resumable(self)
-
- source code
-
-
-
-
-Whether this upload is resumable.
-
-Returns:
- True if resumable upload or False.
-
-
-
- - Overrides:
- MediaUpload.resumable
-
-
-
-
-
-
-
-
-
-
- getbytes(self,
- begin,
- length)
-
- source code
-
-
-
-
-Get bytes from the media.
-
-Args:
- begin: int, offset from beginning of file.
- length: int, number of bytes to read, starting at begin.
-
-Returns:
- A string of bytes read. May be shorted than length if EOF was reached
- first.
-
-
-
- - Overrides:
- MediaUpload.getbytes
-
-
-
-
-
-
-
-
-
-
- has_stream(self)
-
- source code
-
-
-
-
-Does the underlying upload support a streaming interface.
-
-Streaming means it is an io.IOBase subclass that supports seek, i.e.
-seekable() returns True.
-
-Returns:
- True if the call to stream() will return an instance of a seekable io.Base
- subclass.
-
-
-
- - Overrides:
- MediaUpload.has_stream
-
-
-
-
-
-
-
-
-
-
- stream(self)
-
- source code
-
-
-
-
-A stream interface to the data being uploaded.
-
-Returns:
- The returned value is an io.IOBase subclass that supports seek, i.e.
- seekable() returns True.
-
-
-
- - Overrides:
- MediaUpload.stream
-
-
-
-
-
-
-
-
-
-
- to_json(self)
-
- source code
-
-
-
- This upload type is not serializable.
-
- - Overrides:
- MediaUpload.to_json
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.http.MediaUpload-class.html b/docs/epy/googleapiclient.http.MediaUpload-class.html
deleted file mode 100644
index bb0ca394f2c..00000000000
--- a/docs/epy/googleapiclient.http.MediaUpload-class.html
+++ /dev/null
@@ -1,694 +0,0 @@
-
-
-
-
- googleapiclient.http.MediaUpload
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class MediaUpload
-
-object --+
- |
- MediaUpload
-
-
-- Known Subclasses:
--
-
-
-
-
-Describes a media object to upload.
- Base class that defines the interface of MediaUpload subclasses.
- Note that subclasses of MediaUpload may allow you to control the
- chunksize when uploading a media object. It is important to keep the size
- of the chunk as large as possible to keep the upload efficient. Other
- factors may influence the size of the chunk you use, particularly if you
- are working in an environment where individual HTTP requests may have a
- hardcoded time limit, such as under certain classes of requests under
- Google App Engine.
- Streams are io.Base compatible objects that support seek(). Some
- MediaUpload subclasses support using streams directly to upload data.
- Support for streaming may be indicated by a MediaUpload sub-class and if
- appropriate for a platform that stream will be used for uploading the
- media object. The support for streaming is indicated by has_stream()
- returning True. The stream() method should return an io.Base object that
- supports seek(). On platforms where the underlying httplib module
- supports streaming, for example Python 2.6 and later, the stream will be
- passed into the http library which will result in less memory being used
- and possibly faster uploads.
- If you need to upload media that can't be uploaded using any of the
- existing MediaUpload sub-class then you can sub-class MediaUpload for
- your particular needs.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- chunksize(self)
- Chunk size for resumable uploads.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- mimetype(self)
- Mime type of the body.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- size(self)
- Size of upload.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- resumable(self)
- Whether this upload is resumable.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- getbytes(self,
- begin,
- end)
- Get bytes from the media.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- has_stream(self)
- Does the underlying upload support a streaming interface.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- stream(self)
- A stream interface to the data being uploaded.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _to_json(*args,
- **kwargs)
- Utility function for creating a JSON representation of a MediaUpload.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- to_json(self)
- Create a JSON representation of an instance of MediaUpload.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __init__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Class Methods
-
-
-
-
-
-
-
-
-
-
- new_from_json(cls,
- s)
- Utility class method to instantiate a MediaUpload subclass from a JSON
-representation produced by to_json().
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- chunksize(self)
-
- source code
-
-
-
-
-Chunk size for resumable uploads.
-
-Returns:
- Chunk size in bytes.
-
-
-
-
-
-
-
-
-
-
-
-
- mimetype(self)
-
- source code
-
-
-
-
-Mime type of the body.
-
-Returns:
- Mime type.
-
-
-
-
-
-
-
-
-
-
-
-
- size(self)
-
- source code
-
-
-
-
-Size of upload.
-
-Returns:
- Size of the body, or None of the size is unknown.
-
-
-
-
-
-
-
-
-
-
-
-
- resumable(self)
-
- source code
-
-
-
-
-Whether this upload is resumable.
-
-Returns:
- True if resumable upload or False.
-
-
-
-
-
-
-
-
-
-
-
-
- getbytes(self,
- begin,
- end)
-
- source code
-
-
-
-
-Get bytes from the media.
-
-Args:
- begin: int, offset from beginning of file.
- length: int, number of bytes to read, starting at begin.
-
-Returns:
- A string of bytes read. May be shorter than length if EOF was reached
- first.
-
-
-
-
-
-
-
-
-
-
-
-
- has_stream(self)
-
- source code
-
-
-
-
-Does the underlying upload support a streaming interface.
-
-Streaming means it is an io.IOBase subclass that supports seek, i.e.
-seekable() returns True.
-
-Returns:
- True if the call to stream() will return an instance of a seekable io.Base
- subclass.
-
-
-
-
-
-
-
-
-
-
-
-
- stream(self)
-
- source code
-
-
-
-
-A stream interface to the data being uploaded.
-
-Returns:
- The returned value is an io.IOBase subclass that supports seek, i.e.
- seekable() returns True.
-
-
-
-
-
-
-
-
-
-
-
-
- _to_json(*args,
- **kwargs)
-
- source code
-
-
-
-
-Utility function for creating a JSON representation of a MediaUpload.
-
-Args:
- strip: array, An array of names of members to not include in the JSON.
-
-Returns:
- string, a JSON representation of this instance, suitable to pass to
- from_json().
-
-
-
- - Decorators:
-
- @util.positional(1)
-
-
-
-
-
-
-
-
- to_json(self)
-
- source code
-
-
-
-
-Create a JSON representation of an instance of MediaUpload.
-
-Returns:
- string, a JSON representation of this instance, suitable to pass to
- from_json().
-
-
-
-
-
-
-
-
-
-
-
-
- new_from_json(cls,
- s)
-
Class Method
-
- source code
-
-
-
-
-Utility class method to instantiate a MediaUpload subclass from a JSON
-representation produced by to_json().
-
-Args:
- s: string, JSON from to_json().
-
-Returns:
- An instance of the subclass of MediaUpload that was serialized with
- to_json().
-
-
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.http.MediaUploadProgress-class.html b/docs/epy/googleapiclient.http.MediaUploadProgress-class.html
deleted file mode 100644
index d9111e82f15..00000000000
--- a/docs/epy/googleapiclient.http.MediaUploadProgress-class.html
+++ /dev/null
@@ -1,289 +0,0 @@
-
-
-
-
- googleapiclient.http.MediaUploadProgress
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class MediaUploadProgress
-
-object --+
- |
- MediaUploadProgress
-
-
-
-Status of a resumable upload.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- resumable_progress,
- total_size)
- Constructor.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- progress(self)
- Percent of upload completed, as a float.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- resumable_progress,
- total_size)
-
(Constructor)
-
- source code
-
-
-
-
-Constructor.
-
-Args:
- resumable_progress: int, bytes sent so far.
- total_size: int, total bytes in complete upload, or None if the total
- upload size isn't known ahead of time.
-
-
-
- - Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
-
- progress(self)
-
- source code
-
-
-
-
-Percent of upload completed, as a float.
-
-Returns:
- the percentage complete as a float, returning 0.0 if the total size of
- the upload is unknown.
-
-
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.http.RequestMockBuilder-class.html b/docs/epy/googleapiclient.http.RequestMockBuilder-class.html
deleted file mode 100644
index 001c33cb526..00000000000
--- a/docs/epy/googleapiclient.http.RequestMockBuilder-class.html
+++ /dev/null
@@ -1,335 +0,0 @@
-
-
-
-
- googleapiclient.http.RequestMockBuilder
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class RequestMockBuilder
-
-object --+
- |
- RequestMockBuilder
-
-
-
-
-A simple mock of HttpRequest
-
-Pass in a dictionary to the constructor that maps request methodIds to
-tuples of (httplib2.Response, content, opt_expected_body) that should be
-returned when that method is called. None may also be passed in for the
-httplib2.Response, in which case a 200 OK response will be generated.
-If an opt_expected_body (str or dict) is provided, it will be compared to
-the body and UnexpectedBodyError will be raised on inequality.
-
-Example:
- response = '{"data": {"id": "tag:google.c...'
- requestBuilder = RequestMockBuilder(
- {
- 'plus.activities.get': (None, response),
- }
- )
- googleapiclient.discovery.build("plus", "v1", requestBuilder=requestBuilder)
-
-Methods that you do not supply a response for will return a
-200 OK with an empty string as the response content or raise an excpetion
-if check_unexpected is set to True. The methodId is taken from the rpcName
-in the discovery document.
-
-For more details see the project wiki.
-
-
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- responses,
- check_unexpected=False)
- Constructor for RequestMockBuilder
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- __call__(self,
- http,
- postproc,
- uri,
- method='GET',
- body=None,
- headers=None,
- methodId=None,
- resumable=None)
- Implements the callable interface that discovery.build() expects of
- requestBuilder, which is to build an object compatible with
- HttpRequest.execute().
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- responses,
- check_unexpected=False)
-
(Constructor)
-
- source code
-
-
-
-
-Constructor for RequestMockBuilder
-
-The constructed object should be a callable object
-that can replace the class HttpResponse.
-
-responses - A dictionary that maps methodIds into tuples
- of (httplib2.Response, content). The methodId
- comes from the 'rpcName' field in the discovery
- document.
-check_unexpected - A boolean setting whether or not UnexpectedMethodError
- should be raised on unsupplied method.
-
-
-
- - Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
-
- __call__(self,
- http,
- postproc,
- uri,
- method='GET',
- body=None,
- headers=None,
- methodId=None,
- resumable=None)
-
(Call operator)
-
- source code
-
-
-
- Implements the callable interface that discovery.build() expects of
- requestBuilder, which is to build an object compatible with
- HttpRequest.execute(). See that method for the description of the
- parameters and the expected response.
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.http._StreamSlice-class.html b/docs/epy/googleapiclient.http._StreamSlice-class.html
deleted file mode 100644
index bef1a37383e..00000000000
--- a/docs/epy/googleapiclient.http._StreamSlice-class.html
+++ /dev/null
@@ -1,301 +0,0 @@
-
-
-
-
- googleapiclient.http._StreamSlice
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class _StreamSlice
-
-object --+
- |
- _StreamSlice
-
-
-
-Truncated stream.
- Takes a stream and presents a stream that is a slice of the original
- stream. This is used when uploading media in chunks. In later versions of
- Python a stream can be passed to httplib in place of the string of data
- to send. The problem is that httplib just blindly reads to the end of the
- stream. This wrapper presents a virtual stream that only reads to the end
- of the chunk.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- stream,
- begin,
- chunksize)
- Constructor.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- read(self,
- n=-1)
- Read n bytes.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- stream,
- begin,
- chunksize)
-
(Constructor)
-
- source code
-
-
-
-
-Constructor.
-
-Args:
- stream: (io.Base, file object), the stream to wrap.
- begin: int, the seek position the chunk begins at.
- chunksize: int, the size of the chunk.
-
-
-
- - Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
-
- read(self,
- n=-1)
-
- source code
-
-
-
-
-Read n bytes.
-
-Args:
- n, int, the number of bytes to read.
-
-Returns:
- A string of length 'n', or less if EOF is reached.
-
-
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.mimeparse-module.html b/docs/epy/googleapiclient.mimeparse-module.html
deleted file mode 100644
index a4b675177c9..00000000000
--- a/docs/epy/googleapiclient.mimeparse-module.html
+++ /dev/null
@@ -1,508 +0,0 @@
-
-
-
-
- googleapiclient.mimeparse
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module mimeparse
-
-MIME-Type Parser
-
-This module provides basic functions for handling mime-types. It can handle
-matching mime-types against a list of media-ranges. See section 14.1 of the
-HTTP specification [RFC 2616] for a complete explanation.
-
- http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1
-
-Contents:
- - parse_mime_type(): Parses a mime-type into its component parts.
- - parse_media_range(): Media-ranges are mime-types with wild-cards and a 'q'
- quality parameter.
- - quality(): Determines the quality ('q') of a mime-type when
- compared against a list of media-ranges.
- - quality_parsed(): Just like quality() except the second parameter must be
- pre-parsed.
- - best_match(): Choose the mime-type with the highest quality ('q')
- from a list of candidates.
-
-
-
-
- Version:
- 0.1.3
-
- Author:
- Joe Gregorio
-
- License:
- MIT License
-
-
-
-
-
-
-
-
- Functions
-
-
-
-
-
-
-
-
-
-
- parse_mime_type(mime_type)
- Parses a mime-type into its component parts.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- parse_media_range(range)
- Parse a media-range into its component parts.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- fitness_and_quality_parsed(mime_type,
- parsed_ranges)
- Find the best match for a mime-type amongst parsed media-ranges.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- quality_parsed(mime_type,
- parsed_ranges)
- Find the best match for a mime-type amongst parsed media-ranges.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- quality(mime_type,
- ranges)
- Return the quality ('q') of a mime-type against a list of
- media-ranges.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- best_match(supported,
- header)
- Return mime-type with the highest quality ('q') from list of
- candidates.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _filter_blank(i)
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Variables
-
-
-
-
-
-
-
-
- __email__ = 'joe@bitworking.org'
-
-
-
-
-
- __credits__ = ''
-
-
-
-
-
- __package__ = None
-
-
-
-
-
-
-
-
-
-
- Function Details
-
-
-
-
-
-
-
-
-
-
-
- parse_mime_type(mime_type)
-
- source code
-
-
-
-
-Parses a mime-type into its component parts.
-
-Carves up a mime-type and returns a tuple of the (type, subtype, params)
-where 'params' is a dictionary of all the parameters for the media range.
-For example, the media range 'application/xhtml;q=0.5' would get parsed
-into:
-
- ('application', 'xhtml', {'q', '0.5'})
-
-
-
-
-
-
-
-
-
-
-
-
-
- parse_media_range(range)
-
- source code
-
-
-
-
-Parse a media-range into its component parts.
-
-Carves up a media range and returns a tuple of the (type, subtype,
-params) where 'params' is a dictionary of all the parameters for the media
-range. For example, the media range 'application/*;q=0.5' would get parsed
-into:
-
- ('application', '*', {'q', '0.5'})
-
-In addition this function also guarantees that there is a value for 'q'
-in the params dictionary, filling it in with a proper default if
-necessary.
-
-
-
-
-
-
-
-
-
-
-
-
- fitness_and_quality_parsed(mime_type,
- parsed_ranges)
-
- source code
-
-
-
- Find the best match for a mime-type amongst parsed media-ranges.
- Find the best match for a given mime-type against a list of
- media_ranges that have already been parsed by parse_media_range().
- Returns a tuple of the fitness value and the value of the 'q' quality
- parameter of the best match, or (-1, 0) if no match was found. Just as
- for quality_parsed(), 'parsed_ranges' must be a list of parsed media
- ranges.
-
-
-
-
-
-
-
-
-
-
- quality_parsed(mime_type,
- parsed_ranges)
-
- source code
-
-
-
- Find the best match for a mime-type amongst parsed media-ranges.
- Find the best match for a given mime-type against a list of
- media_ranges that have already been parsed by parse_media_range().
- Returns the 'q' quality parameter of the best match, 0 if no match was
- found. This function bahaves the same as quality() except that
- 'parsed_ranges' must be a list of parsed media ranges.
-
-
-
-
-
-
-
-
-
-
- quality(mime_type,
- ranges)
-
- source code
-
-
-
- Return the quality ('q') of a mime-type against a list of
- media-ranges.
- Returns the quality 'q' of a mime-type when compared against the
- media-ranges in ranges. For example:
-
->>> quality('text/html','text/*;q=0.3, text/html;q=0.7,
- text/html;level=1, text/html;level=2;q=0.4, */*;q=0.5')
-0.7
-
-
-
-
-
-
-
-
-
-
- best_match(supported,
- header)
-
- source code
-
-
-
- Return mime-type with the highest quality ('q') from list of
- candidates.
- Takes a list of supported mime-types and finds the best match for all
- the media-ranges listed in header. The value of header must be a string
- that conforms to the format of the HTTP Accept: header. The value of
- 'supported' is a list of mime-types. The list of supported mime-types
- should be sorted in order of increasing desirability, in case of a
- situation where there is a tie.
-
->>> best_match(['application/xbel+xml', 'text/xml'],
- 'text/*;q=0.5,*/*; q=0.1')
-'text/xml'
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.mimeparse-pysrc.html b/docs/epy/googleapiclient.mimeparse-pysrc.html
deleted file mode 100644
index 15e66eb266f..00000000000
--- a/docs/epy/googleapiclient.mimeparse-pysrc.html
+++ /dev/null
@@ -1,294 +0,0 @@
-
-
-
-
- googleapiclient.mimeparse
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Source Code for Module googleapiclient.mimeparse
-
- 1 # Copyright 2014 Joe Gregorio
- 2 #
- 3 # Licensed under the MIT License
- 4
- 5 """MIME-Type Parser
- 6
- 7 This module provides basic functions for handling mime-types. It can handle
- 8 matching mime-types against a list of media-ranges. See section 14.1 of the
- 9 HTTP specification [RFC 2616] for a complete explanation.
- 10
- 11 http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1
- 12
- 13 Contents:
- 14 - parse_mime_type(): Parses a mime-type into its component parts.
- 15 - parse_media_range(): Media-ranges are mime-types with wild-cards and a 'q'
- 16 quality parameter.
- 17 - quality(): Determines the quality ('q') of a mime-type when
- 18 compared against a list of media-ranges.
- 19 - quality_parsed(): Just like quality() except the second parameter must be
- 20 pre-parsed.
- 21 - best_match(): Choose the mime-type with the highest quality ('q')
- 22 from a list of candidates.
- 23 """
- 24 from __future__ import absolute_import
- 25 from functools import reduce
- 26 import six
- 27
- 28 __version__ = "0.1.3"
- 29 __author__ = "Joe Gregorio"
- 30 __email__ = "joe@bitworking.org"
- 31 __license__ = "MIT License"
- 32 __credits__ = ""
- 33
- 34
- 36 """Parses a mime-type into its component parts.
- 37
- 38 Carves up a mime-type and returns a tuple of the (type, subtype, params)
- 39 where 'params' is a dictionary of all the parameters for the media range.
- 40 For example, the media range 'application/xhtml;q=0.5' would get parsed
- 41 into:
- 42
- 43 ('application', 'xhtml', {'q', '0.5'})
- 44 """
- 45 parts = mime_type.split(";")
- 46 params = dict(
- 47 [tuple([s.strip() for s in param.split("=", 1)]) for param in parts[1:]]
- 48 )
- 49 full_type = parts[0].strip()
- 50 # Java URLConnection class sends an Accept header that includes a
- 51 # single '*'. Turn it into a legal wildcard.
- 52 if full_type == "*":
- 53 full_type = "*/*"
- 54 (type, subtype) = full_type.split("/")
- 55
- 56 return (type.strip(), subtype.strip(), params)
- 57
- 58
- 60 """Parse a media-range into its component parts.
- 61
- 62 Carves up a media range and returns a tuple of the (type, subtype,
- 63 params) where 'params' is a dictionary of all the parameters for the media
- 64 range. For example, the media range 'application/*;q=0.5' would get parsed
- 65 into:
- 66
- 67 ('application', '*', {'q', '0.5'})
- 68
- 69 In addition this function also guarantees that there is a value for 'q'
- 70 in the params dictionary, filling it in with a proper default if
- 71 necessary.
- 72 """
- 73 (type, subtype, params) = parse_mime_type(range)
- 74 if (
- 75 "q" not in params
- 76 or not params["q"]
- 77 or not float(params["q"])
- 78 or float(params["q"]) > 1
- 79 or float(params["q"]) < 0
- 80 ):
- 81 params["q"] = "1"
- 82
- 83 return (type, subtype, params)
- 84
- 85
- 87 """Find the best match for a mime-type amongst parsed media-ranges.
- 88
- 89 Find the best match for a given mime-type against a list of media_ranges
- 90 that have already been parsed by parse_media_range(). Returns a tuple of
- 91 the fitness value and the value of the 'q' quality parameter of the best
- 92 match, or (-1, 0) if no match was found. Just as for quality_parsed(),
- 93 'parsed_ranges' must be a list of parsed media ranges.
- 94 """
- 95 best_fitness = -1
- 96 best_fit_q = 0
- 97 (target_type, target_subtype, target_params) = parse_media_range(mime_type)
- 98 for (type, subtype, params) in parsed_ranges:
- 99 type_match = type == target_type or type == "*" or target_type == "*"
-100 subtype_match = (
-101 subtype == target_subtype or subtype == "*" or target_subtype == "*"
-102 )
-103 if type_match and subtype_match:
-104 param_matches = reduce(
-105 lambda x, y: x + y,
-106 [
-107 1
-108 for (key, value) in six.iteritems(target_params)
-109 if key != "q" and key in params and value == params[key]
-110 ],
-111 0,
-112 )
-113 fitness = (type == target_type) and 100 or 0
-114 fitness += (subtype == target_subtype) and 10 or 0
-115 fitness += param_matches
-116 if fitness > best_fitness:
-117 best_fitness = fitness
-118 best_fit_q = params["q"]
-119
-120 return best_fitness, float(best_fit_q)
-121
-122
-124 """Find the best match for a mime-type amongst parsed media-ranges.
-125
-126 Find the best match for a given mime-type against a list of media_ranges
-127 that have already been parsed by parse_media_range(). Returns the 'q'
-128 quality parameter of the best match, 0 if no match was found. This function
-129 bahaves the same as quality() except that 'parsed_ranges' must be a list of
-130 parsed media ranges.
-131 """
-132
-133 return fitness_and_quality_parsed(mime_type, parsed_ranges)[1]
-134
-135
-137 """Return the quality ('q') of a mime-type against a list of media-ranges.
-138
-139 Returns the quality 'q' of a mime-type when compared against the
-140 media-ranges in ranges. For example:
-141
-142 >>> quality('text/html','text/*;q=0.3, text/html;q=0.7,
-143 text/html;level=1, text/html;level=2;q=0.4, */*;q=0.5')
-144 0.7
-145
-146 """
-147 parsed_ranges = [parse_media_range(r) for r in ranges.split(",")]
-148
-149 return quality_parsed(mime_type, parsed_ranges)
-150
-151
-153 """Return mime-type with the highest quality ('q') from list of candidates.
-154
-155 Takes a list of supported mime-types and finds the best match for all the
-156 media-ranges listed in header. The value of header must be a string that
-157 conforms to the format of the HTTP Accept: header. The value of 'supported'
-158 is a list of mime-types. The list of supported mime-types should be sorted
-159 in order of increasing desirability, in case of a situation where there is
-160 a tie.
-161
-162 >>> best_match(['application/xbel+xml', 'text/xml'],
-163 'text/*;q=0.5,*/*; q=0.1')
-164 'text/xml'
-165 """
-166 split_header = _filter_blank(header.split(","))
-167 parsed_header = [parse_media_range(r) for r in split_header]
-168 weighted_matches = []
-169 pos = 0
-170 for mime_type in supported:
-171 weighted_matches.append(
-172 (fitness_and_quality_parsed(mime_type, parsed_header), pos, mime_type)
-173 )
-174 pos += 1
-175 weighted_matches.sort()
-176
-177 return weighted_matches[-1][0][1] and weighted_matches[-1][2] or ""
-178
-179
-184
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.model-module.html b/docs/epy/googleapiclient.model-module.html
deleted file mode 100644
index c1ab3850f73..00000000000
--- a/docs/epy/googleapiclient.model-module.html
+++ /dev/null
@@ -1,344 +0,0 @@
-
-
-
-
- googleapiclient.model
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module model
-Model objects for requests and responses.
- Each API may support one or more serializations, such as JSON, Atom,
- etc. The model classes are responsible for converting between the wire
- format and the Python object representation.
-
-
- Author:
- jcgregorio@google.com (Joe Gregorio)
-
-
-
-
-
-
-
-
- Classes
-
-
-
-
-
-
-
-
- Model
- Model base class.
-
-
-
-
-
-
- BaseModel
- Base model class.
-
-
-
-
-
-
- JsonModel
- Model class for JSON.
-
-
-
-
-
-
- RawModel
- Model class for requests that don't return JSON.
-
-
-
-
-
-
- MediaModel
- Model class for requests that return Media.
-
-
-
-
-
-
- ProtocolBufferModel
- Model class for protocol buffers.
-
-
-
-
-
-
-
-
-
-
- Functions
-
-
-
-
-
-
-
-
-
-
- _abstract()
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- makepatch(original,
- modified)
- Create a patch object.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Variables
-
-
-
-
-
-
-
-
- _LIBRARY_VERSION = '1.10.0'
-
-
-
-
-
- _PY_VERSION = '2.7.18'
-
-
-
-
-
- LOGGER = logging.getLogger(__name__)
-
-
-
-
-
-
- dump_request_response = False
-
-
-
-
-
-
- __package__ = None
-
-
-
-
-
-
-
-
-
-
- Function Details
-
-
-
-
-
-
-
-
-
-
-
- makepatch(original,
- modified)
-
- source code
-
-
-
-
-Create a patch object.
-
-Some methods support PATCH, an efficient way to send updates to a resource.
-This method allows the easy construction of patch bodies by looking at the
-differences between a resource before and after it was modified.
-
-Args:
- original: object, the original deserialized resource
- modified: object, the modified deserialized resource
-Returns:
- An object that contains only the changes from original to modified, in a
- form suitable to pass to a PATCH method.
-
-Example usage:
- item = service.activities().get(postid=postid, userid=userid).execute()
- original = copy.deepcopy(item)
- item['object']['content'] = 'This is updated.'
- service.activities.patch(postid=postid, userid=userid,
- body=makepatch(original, item)).execute()
-
-
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.model-pysrc.html b/docs/epy/googleapiclient.model-pysrc.html
deleted file mode 100644
index e6ca29efdc9..00000000000
--- a/docs/epy/googleapiclient.model-pysrc.html
+++ /dev/null
@@ -1,675 +0,0 @@
-
-
-
-
- googleapiclient.model
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Source Code for Module googleapiclient.model
-
- 1 # Copyright 2014 Google Inc. All Rights Reserved.
- 2 #
- 3 # Licensed under the Apache License, Version 2.0 (the "License");
- 4 # you may not use this file except in compliance with the License.
- 5 # You may obtain a copy of the License at
- 6 #
- 7 # http://www.apache.org/licenses/LICENSE-2.0
- 8 #
- 9 # Unless required by applicable law or agreed to in writing, software
- 10 # distributed under the License is distributed on an "AS IS" BASIS,
- 11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- 12 # See the License for the specific language governing permissions and
- 13 # limitations under the License.
- 14
- 15 """Model objects for requests and responses.
- 16
- 17 Each API may support one or more serializations, such
- 18 as JSON, Atom, etc. The model classes are responsible
- 19 for converting between the wire format and the Python
- 20 object representation.
- 21 """
- 22 from __future__ import absolute_import
- 23 import six
- 24
- 25 __author__ = "jcgregorio@google.com (Joe Gregorio)"
- 26
- 27 import json
- 28 import logging
- 29 import platform
- 30 import pkg_resources
- 31
- 32 from six.moves.urllib.parse import urlencode
- 33
- 34 from googleapiclient.errors import HttpError
- 35
- 36 _LIBRARY_VERSION = pkg_resources.get_distribution("google-api-python-client").version
- 37 _PY_VERSION = platform.python_version()
- 38
- 39 LOGGER = logging.getLogger(__name__)
- 40
- 41 dump_request_response = False
- 46
- 49 """Model base class.
- 50
- 51 All Model classes should implement this interface.
- 52 The Model serializes and de-serializes between a wire
- 53 format such as JSON and a Python object representation.
- 54 """
- 55
- 57 """Updates outgoing requests with a serialized body.
- 58
- 59 Args:
- 60 headers: dict, request headers
- 61 path_params: dict, parameters that appear in the request path
- 62 query_params: dict, parameters that appear in the query
- 63 body_value: object, the request body as a Python object, which must be
- 64 serializable.
- 65 Returns:
- 66 A tuple of (headers, path_params, query, body)
- 67
- 68 headers: dict, request headers
- 69 path_params: dict, parameters that appear in the request path
- 70 query: string, query part of the request URI
- 71 body: string, the body serialized in the desired wire format.
- 72 """
- 73 _abstract()
- 74
- 76 """Convert the response wire format into a Python object.
- 77
- 78 Args:
- 79 resp: httplib2.Response, the HTTP response headers and status
- 80 content: string, the body of the HTTP response
- 81
- 82 Returns:
- 83 The body de-serialized as a Python object.
- 84
- 85 Raises:
- 86 googleapiclient.errors.HttpError if a non 2xx response is received.
- 87 """
- 88 _abstract()
- 89
- 92 """Base model class.
- 93
- 94 Subclasses should provide implementations for the "serialize" and
- 95 "deserialize" methods, as well as values for the following class attributes.
- 96
- 97 Attributes:
- 98 accept: The value to use for the HTTP Accept header.
- 99 content_type: The value to use for the HTTP Content-type header.
-100 no_content_response: The value to return when deserializing a 204 "No
-101 Content" response.
-102 alt_param: The value to supply as the "alt" query parameter for requests.
-103 """
-104
-105 accept = None
-106 content_type = None
-107 no_content_response = None
-108 alt_param = None
-109
-111 """Logs debugging information about the request if requested."""
-112 if dump_request_response:
-113 LOGGER.info("--request-start--")
-114 LOGGER.info("-headers-start-")
-115 for h, v in six.iteritems(headers):
-116 LOGGER.info("%s: %s", h, v)
-117 LOGGER.info("-headers-end-")
-118 LOGGER.info("-path-parameters-start-")
-119 for h, v in six.iteritems(path_params):
-120 LOGGER.info("%s: %s", h, v)
-121 LOGGER.info("-path-parameters-end-")
-122 LOGGER.info("body: %s", body)
-123 LOGGER.info("query: %s", query)
-124 LOGGER.info("--request-end--")
-125
-127 """Updates outgoing requests with a serialized body.
-128
-129 Args:
-130 headers: dict, request headers
-131 path_params: dict, parameters that appear in the request path
-132 query_params: dict, parameters that appear in the query
-133 body_value: object, the request body as a Python object, which must be
-134 serializable by json.
-135 Returns:
-136 A tuple of (headers, path_params, query, body)
-137
-138 headers: dict, request headers
-139 path_params: dict, parameters that appear in the request path
-140 query: string, query part of the request URI
-141 body: string, the body serialized as JSON
-142 """
-143 query = self._build_query(query_params)
-144 headers["accept"] = self.accept
-145 headers["accept-encoding"] = "gzip, deflate"
-146 if "user-agent" in headers:
-147 headers["user-agent"] += " "
-148 else:
-149 headers["user-agent"] = ""
-150 headers["user-agent"] += "(gzip)"
-151 if "x-goog-api-client" in headers:
-152 headers["x-goog-api-client"] += " "
-153 else:
-154 headers["x-goog-api-client"] = ""
-155 headers["x-goog-api-client"] += "gdcl/%s gl-python/%s" % (
-156 _LIBRARY_VERSION,
-157 _PY_VERSION,
-158 )
-159
-160 if body_value is not None:
-161 headers["content-type"] = self.content_type
-162 body_value = self.serialize(body_value)
-163 self._log_request(headers, path_params, query, body_value)
-164 return (headers, path_params, query, body_value)
-165
-167 """Builds a query string.
-168
-169 Args:
-170 params: dict, the query parameters
-171
-172 Returns:
-173 The query parameters properly encoded into an HTTP URI query string.
-174 """
-175 if self.alt_param is not None:
-176 params.update({"alt": self.alt_param})
-177 astuples = []
-178 for key, value in six.iteritems(params):
-179 if type(value) == type([]):
-180 for x in value:
-181 x = x.encode("utf-8")
-182 astuples.append((key, x))
-183 else:
-184 if isinstance(value, six.text_type) and callable(value.encode):
-185 value = value.encode("utf-8")
-186 astuples.append((key, value))
-187 return "?" + urlencode(astuples)
-188
-190 """Logs debugging information about the response if requested."""
-191 if dump_request_response:
-192 LOGGER.info("--response-start--")
-193 for h, v in six.iteritems(resp):
-194 LOGGER.info("%s: %s", h, v)
-195 if content:
-196 LOGGER.info(content)
-197 LOGGER.info("--response-end--")
-198
-200 """Convert the response wire format into a Python object.
-201
-202 Args:
-203 resp: httplib2.Response, the HTTP response headers and status
-204 content: string, the body of the HTTP response
-205
-206 Returns:
-207 The body de-serialized as a Python object.
-208
-209 Raises:
-210 googleapiclient.errors.HttpError if a non 2xx response is received.
-211 """
-212 self._log_response(resp, content)
-213 # Error handling is TBD, for example, do we retry
-214 # for some operation/error combinations?
-215 if resp.status < 300:
-216 if resp.status == 204:
-217 # A 204: No Content response should be treated differently
-218 # to all the other success states
-219 return self.no_content_response
-220 return self.deserialize(content)
-221 else:
-222 LOGGER.debug("Content from bad request was: %r" % content)
-223 raise HttpError(resp, content)
-224
-226 """Perform the actual Python object serialization.
-227
-228 Args:
-229 body_value: object, the request body as a Python object.
-230
-231 Returns:
-232 string, the body in serialized form.
-233 """
-234 _abstract()
-235
-237 """Perform the actual deserialization from response string to Python
-238 object.
-239
-240 Args:
-241 content: string, the body of the HTTP response
-242
-243 Returns:
-244 The body de-serialized as a Python object.
-245 """
-246 _abstract()
-247
-250 """Model class for JSON.
-251
-252 Serializes and de-serializes between JSON and the Python
-253 object representation of HTTP request and response bodies.
-254 """
-255
-256 accept = "application/json"
-257 content_type = "application/json"
-258 alt_param = "json"
-259
-261 """Construct a JsonModel.
-262
-263 Args:
-264 data_wrapper: boolean, wrap requests and responses in a data wrapper
-265 """
-266 self._data_wrapper = data_wrapper
-267
-269 if (
-270 isinstance(body_value, dict)
-271 and "data" not in body_value
-272 and self._data_wrapper
-273 ):
-274 body_value = {"data": body_value}
-275 return json.dumps(body_value)
-276
-278 try:
-279 content = content.decode("utf-8")
-280 except AttributeError:
-281 pass
-282 body = json.loads(content)
-283 if self._data_wrapper and isinstance(body, dict) and "data" in body:
-284 body = body["data"]
-285 return body
-286
-287 @property
-290
-293 """Model class for requests that don't return JSON.
-294
-295 Serializes and de-serializes between JSON and the Python
-296 object representation of HTTP request, and returns the raw bytes
-297 of the response body.
-298 """
-299
-300 accept = "*/*"
-301 content_type = "application/json"
-302 alt_param = None
-303
-306
-307 @property
-310
-313 """Model class for requests that return Media.
-314
-315 Serializes and de-serializes between JSON and the Python
-316 object representation of HTTP request, and returns the raw bytes
-317 of the response body.
-318 """
-319
-320 accept = "*/*"
-321 content_type = "application/json"
-322 alt_param = "media"
-323
-326
-327 @property
-330
-333 """Model class for protocol buffers.
-334
-335 Serializes and de-serializes the binary protocol buffer sent in the HTTP
-336 request and response bodies.
-337 """
-338
-339 accept = "application/x-protobuf"
-340 content_type = "application/x-protobuf"
-341 alt_param = "proto"
-342
-344 """Constructs a ProtocolBufferModel.
-345
-346 The serialized protocol buffer returned in an HTTP response will be
-347 de-serialized using the given protocol buffer class.
-348
-349 Args:
-350 protocol_buffer: The protocol buffer class used to de-serialize a
-351 response from the API.
-352 """
-353 self._protocol_buffer = protocol_buffer
-354
-357
-360
-361 @property
-364
-367 """Create a patch object.
-368
-369 Some methods support PATCH, an efficient way to send updates to a resource.
-370 This method allows the easy construction of patch bodies by looking at the
-371 differences between a resource before and after it was modified.
-372
-373 Args:
-374 original: object, the original deserialized resource
-375 modified: object, the modified deserialized resource
-376 Returns:
-377 An object that contains only the changes from original to modified, in a
-378 form suitable to pass to a PATCH method.
-379
-380 Example usage:
-381 item = service.activities().get(postid=postid, userid=userid).execute()
-382 original = copy.deepcopy(item)
-383 item['object']['content'] = 'This is updated.'
-384 service.activities.patch(postid=postid, userid=userid,
-385 body=makepatch(original, item)).execute()
-386 """
-387 patch = {}
-388 for key, original_value in six.iteritems(original):
-389 modified_value = modified.get(key, None)
-390 if modified_value is None:
-391 # Use None to signal that the element is deleted
-392 patch[key] = None
-393 elif original_value != modified_value:
-394 if type(original_value) == type({}):
-395 # Recursively descend objects
-396 patch[key] = makepatch(original_value, modified_value)
-397 else:
-398 # In the case of simple types or arrays we just replace
-399 patch[key] = modified_value
-400 else:
-401 # Don't add anything to patch if there's no change
-402 pass
-403 for key in modified:
-404 if key not in original:
-405 patch[key] = modified[key]
-406
-407 return patch
-408
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.model.BaseModel-class.html b/docs/epy/googleapiclient.model.BaseModel-class.html
deleted file mode 100644
index e06fde60409..00000000000
--- a/docs/epy/googleapiclient.model.BaseModel-class.html
+++ /dev/null
@@ -1,565 +0,0 @@
-
-
-
-
- googleapiclient.model.BaseModel
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class BaseModel
-
-object --+
- |
- Model --+
- |
- BaseModel
-
-
-- Known Subclasses:
--
-
-
-
-
-
-Base model class.
-
-Subclasses should provide implementations for the "serialize" and
-"deserialize" methods, as well as values for the following class attributes.
-
-Attributes:
- accept: The value to use for the HTTP Accept header.
- content_type: The value to use for the HTTP Content-type header.
- no_content_response: The value to return when deserializing a 204 "No
- Content" response.
- alt_param: The value to supply as the "alt" query parameter for requests.
-
-
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- _log_request(self,
- headers,
- path_params,
- query,
- body)
- Logs debugging information about the request if requested.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- request(self,
- headers,
- path_params,
- query_params,
- body_value)
- Updates outgoing requests with a serialized body.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _build_query(self,
- params)
- Builds a query string.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _log_response(self,
- resp,
- content)
- Logs debugging information about the response if requested.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- response(self,
- resp,
- content)
- Convert the response wire format into a Python object.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- serialize(self,
- body_value)
- Perform the actual Python object serialization.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- deserialize(self,
- content)
- Perform the actual deserialization from response string to Python
-object.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __init__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Class Variables
-
-
-
-
-
-
-
-
- accept = None
-
-
-
-
-
-
- content_type = None
-
-
-
-
-
-
- no_content_response = None
-
-
-
-
-
-
- alt_param = None
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- request(self,
- headers,
- path_params,
- query_params,
- body_value)
-
- source code
-
-
-
-
-Updates outgoing requests with a serialized body.
-
-Args:
- headers: dict, request headers
- path_params: dict, parameters that appear in the request path
- query_params: dict, parameters that appear in the query
- body_value: object, the request body as a Python object, which must be
- serializable by json.
-Returns:
- A tuple of (headers, path_params, query, body)
-
- headers: dict, request headers
- path_params: dict, parameters that appear in the request path
- query: string, query part of the request URI
- body: string, the body serialized as JSON
-
-
-
- - Overrides:
- Model.request
-
-
-
-
-
-
-
-
-
-
- _build_query(self,
- params)
-
- source code
-
-
-
-
-Builds a query string.
-
-Args:
- params: dict, the query parameters
-
-Returns:
- The query parameters properly encoded into an HTTP URI query string.
-
-
-
-
-
-
-
-
-
-
-
-
- response(self,
- resp,
- content)
-
- source code
-
-
-
-
-Convert the response wire format into a Python object.
-
-Args:
- resp: httplib2.Response, the HTTP response headers and status
- content: string, the body of the HTTP response
-
-Returns:
- The body de-serialized as a Python object.
-
-Raises:
- googleapiclient.errors.HttpError if a non 2xx response is received.
-
-
-
- - Overrides:
- Model.response
-
-
-
-
-
-
-
-
-
-
- serialize(self,
- body_value)
-
- source code
-
-
-
-
-Perform the actual Python object serialization.
-
-Args:
- body_value: object, the request body as a Python object.
-
-Returns:
- string, the body in serialized form.
-
-
-
-
-
-
-
-
-
-
-
-
- deserialize(self,
- content)
-
- source code
-
-
-
-
-Perform the actual deserialization from response string to Python
-object.
-
-Args:
- content: string, the body of the HTTP response
-
-Returns:
- The body de-serialized as a Python object.
-
-
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.model.JsonModel-class.html b/docs/epy/googleapiclient.model.JsonModel-class.html
deleted file mode 100644
index 75688f74604..00000000000
--- a/docs/epy/googleapiclient.model.JsonModel-class.html
+++ /dev/null
@@ -1,446 +0,0 @@
-
-
-
-
- googleapiclient.model.JsonModel
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class JsonModel
-
-object --+
- |
- Model --+
- |
- BaseModel --+
- |
- JsonModel
-
-
-- Known Subclasses:
--
-
-
-
-
-Model class for JSON.
- Serializes and de-serializes between JSON and the Python object
- representation of HTTP request and response bodies.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- data_wrapper=False)
- Construct a JsonModel.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- serialize(self,
- body_value)
- Perform the actual Python object serialization.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- deserialize(self,
- content)
- Perform the actual deserialization from response string to Python
-object.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from BaseModel:
- request,
- response
-
- Inherited from BaseModel (private):
- _build_query,
- _log_request,
- _log_response
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Class Variables
-
-
-
-
-
-
-
-
- accept = 'application/json'
-
-
-
-
-
- content_type = 'application/json'
-
-
-
-
-
- alt_param = 'json'
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
-
-
- no_content_response
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- data_wrapper=False)
-
(Constructor)
-
- source code
-
-
-
-
-Construct a JsonModel.
-
-Args:
- data_wrapper: boolean, wrap requests and responses in a data wrapper
-
-
-
- - Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
-
- serialize(self,
- body_value)
-
- source code
-
-
-
-
-Perform the actual Python object serialization.
-
-Args:
- body_value: object, the request body as a Python object.
-
-Returns:
- string, the body in serialized form.
-
-
-
- - Overrides:
- BaseModel.serialize
-
- (inherited documentation)
-
-
-
-
-
-
-
-
-
-
- deserialize(self,
- content)
-
- source code
-
-
-
-
-Perform the actual deserialization from response string to Python
-object.
-
-Args:
- content: string, the body of the HTTP response
-
-Returns:
- The body de-serialized as a Python object.
-
-
-
- - Overrides:
- BaseModel.deserialize
-
- (inherited documentation)
-
-
-
-
-
-
-
-
-
-
-
-
- Property Details
-
-
-
-
-
-
-
-
-
- no_content_response
-
-
- - Get Method:
- - unreachable.no_content_response(self)
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.model.MediaModel-class.html b/docs/epy/googleapiclient.model.MediaModel-class.html
deleted file mode 100644
index e31449b280a..00000000000
--- a/docs/epy/googleapiclient.model.MediaModel-class.html
+++ /dev/null
@@ -1,348 +0,0 @@
-
-
-
-
- googleapiclient.model.MediaModel
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class MediaModel
-
-object --+
- |
- Model --+
- |
- BaseModel --+
- |
- JsonModel --+
- |
- MediaModel
-
-
-
-Model class for requests that return Media.
- Serializes and de-serializes between JSON and the Python object
- representation of HTTP request, and returns the raw bytes of the response
- body.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- deserialize(self,
- content)
- Perform the actual deserialization from response string to Python
-object.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from JsonModel:
- __init__,
- serialize
-
- Inherited from BaseModel:
- request,
- response
-
- Inherited from BaseModel (private):
- _build_query,
- _log_request,
- _log_response
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Class Variables
-
-
-
-
-
-
-
-
- accept = '*/*'
-
-
-
-
-
- content_type = "application/json"
-
-
-
-
-
-
- alt_param = 'media'
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
-
-
- no_content_response
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- deserialize(self,
- content)
-
- source code
-
-
-
-
-Perform the actual deserialization from response string to Python
-object.
-
-Args:
- content: string, the body of the HTTP response
-
-Returns:
- The body de-serialized as a Python object.
-
-
-
- - Overrides:
- BaseModel.deserialize
-
- (inherited documentation)
-
-
-
-
-
-
-
-
-
-
-
-
- Property Details
-
-
-
-
-
-
-
-
-
- no_content_response
-
-
- - Get Method:
- - unreachable.no_content_response(self)
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.model.Model-class.html b/docs/epy/googleapiclient.model.Model-class.html
deleted file mode 100644
index 26a8f3bffcb..00000000000
--- a/docs/epy/googleapiclient.model.Model-class.html
+++ /dev/null
@@ -1,318 +0,0 @@
-
-
-
-
- googleapiclient.model.Model
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class Model
-
-object --+
- |
- Model
-
-
-- Known Subclasses:
--
-
-
-
-
-Model base class.
- All Model classes should implement this interface. The Model
- serializes and de-serializes between a wire format such as JSON and a
- Python object representation.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- request(self,
- headers,
- path_params,
- query_params,
- body_value)
- Updates outgoing requests with a serialized body.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- response(self,
- resp,
- content)
- Convert the response wire format into a Python object.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __init__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- request(self,
- headers,
- path_params,
- query_params,
- body_value)
-
- source code
-
-
-
-
-Updates outgoing requests with a serialized body.
-
-Args:
- headers: dict, request headers
- path_params: dict, parameters that appear in the request path
- query_params: dict, parameters that appear in the query
- body_value: object, the request body as a Python object, which must be
- serializable.
-Returns:
- A tuple of (headers, path_params, query, body)
-
- headers: dict, request headers
- path_params: dict, parameters that appear in the request path
- query: string, query part of the request URI
- body: string, the body serialized in the desired wire format.
-
-
-
-
-
-
-
-
-
-
-
-
- response(self,
- resp,
- content)
-
- source code
-
-
-
-
-Convert the response wire format into a Python object.
-
-Args:
- resp: httplib2.Response, the HTTP response headers and status
- content: string, the body of the HTTP response
-
-Returns:
- The body de-serialized as a Python object.
-
-Raises:
- googleapiclient.errors.HttpError if a non 2xx response is received.
-
-
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.model.ProtocolBufferModel-class.html b/docs/epy/googleapiclient.model.ProtocolBufferModel-class.html
deleted file mode 100644
index 85ce4d0b957..00000000000
--- a/docs/epy/googleapiclient.model.ProtocolBufferModel-class.html
+++ /dev/null
@@ -1,444 +0,0 @@
-
-
-
-
- googleapiclient.model.ProtocolBufferModel
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class ProtocolBufferModel
-
-object --+
- |
- Model --+
- |
- BaseModel --+
- |
- ProtocolBufferModel
-
-
-
-Model class for protocol buffers.
- Serializes and de-serializes the binary protocol buffer sent in the
- HTTP request and response bodies.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- protocol_buffer)
- Constructs a ProtocolBufferModel.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- serialize(self,
- body_value)
- Perform the actual Python object serialization.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- deserialize(self,
- content)
- Perform the actual deserialization from response string to Python
-object.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from BaseModel:
- request,
- response
-
- Inherited from BaseModel (private):
- _build_query,
- _log_request,
- _log_response
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Class Variables
-
-
-
-
-
-
-
-
- accept = 'application/x-protobuf'
-
-
-
-
-
- content_type = 'application/x-protobuf'
-
-
-
-
-
- alt_param = 'proto'
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
-
-
- no_content_response
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- protocol_buffer)
-
(Constructor)
-
- source code
-
-
-
-
-Constructs a ProtocolBufferModel.
-
-The serialized protocol buffer returned in an HTTP response will be
-de-serialized using the given protocol buffer class.
-
-Args:
- protocol_buffer: The protocol buffer class used to de-serialize a
- response from the API.
-
-
-
- - Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
-
- serialize(self,
- body_value)
-
- source code
-
-
-
-
-Perform the actual Python object serialization.
-
-Args:
- body_value: object, the request body as a Python object.
-
-Returns:
- string, the body in serialized form.
-
-
-
- - Overrides:
- BaseModel.serialize
-
- (inherited documentation)
-
-
-
-
-
-
-
-
-
-
- deserialize(self,
- content)
-
- source code
-
-
-
-
-Perform the actual deserialization from response string to Python
-object.
-
-Args:
- content: string, the body of the HTTP response
-
-Returns:
- The body de-serialized as a Python object.
-
-
-
- - Overrides:
- BaseModel.deserialize
-
- (inherited documentation)
-
-
-
-
-
-
-
-
-
-
-
-
- Property Details
-
-
-
-
-
-
-
-
-
- no_content_response
-
-
- - Get Method:
- - unreachable.no_content_response(self)
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.model.RawModel-class.html b/docs/epy/googleapiclient.model.RawModel-class.html
deleted file mode 100644
index 7b662798cc0..00000000000
--- a/docs/epy/googleapiclient.model.RawModel-class.html
+++ /dev/null
@@ -1,348 +0,0 @@
-
-
-
-
- googleapiclient.model.RawModel
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class RawModel
-
-object --+
- |
- Model --+
- |
- BaseModel --+
- |
- JsonModel --+
- |
- RawModel
-
-
-
-Model class for requests that don't return JSON.
- Serializes and de-serializes between JSON and the Python object
- representation of HTTP request, and returns the raw bytes of the response
- body.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- deserialize(self,
- content)
- Perform the actual deserialization from response string to Python
-object.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from JsonModel:
- __init__,
- serialize
-
- Inherited from BaseModel:
- request,
- response
-
- Inherited from BaseModel (private):
- _build_query,
- _log_request,
- _log_response
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Class Variables
-
-
-
-
-
-
-
-
- accept = '*/*'
-
-
-
-
-
- content_type = "application/json"
-
-
-
-
-
-
- alt_param = None
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
-
-
- no_content_response
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- deserialize(self,
- content)
-
- source code
-
-
-
-
-Perform the actual deserialization from response string to Python
-object.
-
-Args:
- content: string, the body of the HTTP response
-
-Returns:
- The body de-serialized as a Python object.
-
-
-
- - Overrides:
- BaseModel.deserialize
-
- (inherited documentation)
-
-
-
-
-
-
-
-
-
-
-
-
- Property Details
-
-
-
-
-
-
-
-
-
- no_content_response
-
-
- - Get Method:
- - unreachable.no_content_response(self)
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.sample_tools-module.html b/docs/epy/googleapiclient.sample_tools-module.html
deleted file mode 100644
index 042bbb63293..00000000000
--- a/docs/epy/googleapiclient.sample_tools-module.html
+++ /dev/null
@@ -1,223 +0,0 @@
-
-
-
-
- googleapiclient.sample_tools
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module sample_tools
-Utilities for making samples.
- Consolidates a lot of code commonly repeated in sample
- applications.
-
-
- Author:
- jcgregorio@google.com (Joe Gregorio)
-
-
-
-
-
-
-
-
- Functions
-
-
-
-
-
-
-
-
-
-
- init(argv,
- name,
- version,
- doc,
- filename,
- scope=None,
- parents=[],
- discovery_filename=None)
- A common initialization routine for samples.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Function Details
-
-
-
-
-
-
-
-
-
-
-
- init(argv,
- name,
- version,
- doc,
- filename,
- scope=None,
- parents=[],
- discovery_filename=None)
-
- source code
-
-
-
-
-A common initialization routine for samples.
-
-Many of the sample applications do the same initialization, which has now
-been consolidated into this function. This function uses common idioms found
-in almost all the samples, i.e. for an API with name 'apiname', the
-credentials are stored in a file named apiname.dat, and the
-client_secrets.json file is stored in the same directory as the application
-main file.
-
-Args:
- argv: list of string, the command-line parameters of the application.
- name: string, name of the API.
- version: string, version of the API.
- doc: string, description of the application. Usually set to __doc__.
- file: string, filename of the application. Usually set to __file__.
- parents: list of argparse.ArgumentParser, additional command-line flags.
- scope: string, The OAuth scope used.
- discovery_filename: string, name of local discovery file (JSON). Use when discovery doc not available via URL.
-
-Returns:
- A tuple of (service, flags), where service is the service object and flags
- is the parsed command-line flags.
-
-
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.sample_tools-pysrc.html b/docs/epy/googleapiclient.sample_tools-pysrc.html
deleted file mode 100644
index dc722c2dace..00000000000
--- a/docs/epy/googleapiclient.sample_tools-pysrc.html
+++ /dev/null
@@ -1,224 +0,0 @@
-
-
-
-
- googleapiclient.sample_tools
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Source Code for Module googleapiclient.sample_tools
-
- 1 # Copyright 2014 Google Inc. All Rights Reserved.
- 2 #
- 3 # Licensed under the Apache License, Version 2.0 (the "License");
- 4 # you may not use this file except in compliance with the License.
- 5 # You may obtain a copy of the License at
- 6 #
- 7 # http://www.apache.org/licenses/LICENSE-2.0
- 8 #
- 9 # Unless required by applicable law or agreed to in writing, software
- 10 # distributed under the License is distributed on an "AS IS" BASIS,
- 11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- 12 # See the License for the specific language governing permissions and
- 13 # limitations under the License.
- 14
- 15 """Utilities for making samples.
- 16
- 17 Consolidates a lot of code commonly repeated in sample applications.
- 18 """
- 19 from __future__ import absolute_import
- 20
- 21 __author__ = "jcgregorio@google.com (Joe Gregorio)"
- 22 __all__ = ["init"]
- 23
- 24
- 25 import argparse
- 26 import os
- 27
- 28 from googleapiclient import discovery
- 29 from googleapiclient.http import build_http
- 30
- 31
- 32 -def init(
- 33 argv, name, version, doc, filename, scope=None, parents=[], discovery_filename=None
- 34 ):
- 35 """A common initialization routine for samples.
- 36
- 37 Many of the sample applications do the same initialization, which has now
- 38 been consolidated into this function. This function uses common idioms found
- 39 in almost all the samples, i.e. for an API with name 'apiname', the
- 40 credentials are stored in a file named apiname.dat, and the
- 41 client_secrets.json file is stored in the same directory as the application
- 42 main file.
- 43
- 44 Args:
- 45 argv: list of string, the command-line parameters of the application.
- 46 name: string, name of the API.
- 47 version: string, version of the API.
- 48 doc: string, description of the application. Usually set to __doc__.
- 49 file: string, filename of the application. Usually set to __file__.
- 50 parents: list of argparse.ArgumentParser, additional command-line flags.
- 51 scope: string, The OAuth scope used.
- 52 discovery_filename: string, name of local discovery file (JSON). Use when discovery doc not available via URL.
- 53
- 54 Returns:
- 55 A tuple of (service, flags), where service is the service object and flags
- 56 is the parsed command-line flags.
- 57 """
- 58 try:
- 59 from oauth2client import client
- 60 from oauth2client import file
- 61 from oauth2client import tools
- 62 except ImportError:
- 63 raise ImportError(
- 64 "googleapiclient.sample_tools requires oauth2client. Please install oauth2client and try again."
- 65 )
- 66
- 67 if scope is None:
- 68 scope = "https://www.googleapis.com/auth/" + name
- 69
- 70 # Parser command-line arguments.
- 71 parent_parsers = [tools.argparser]
- 72 parent_parsers.extend(parents)
- 73 parser = argparse.ArgumentParser(
- 74 description=doc,
- 75 formatter_class=argparse.RawDescriptionHelpFormatter,
- 76 parents=parent_parsers,
- 77 )
- 78 flags = parser.parse_args(argv[1:])
- 79
- 80 # Name of a file containing the OAuth 2.0 information for this
- 81 # application, including client_id and client_secret, which are found
- 82 # on the API Access tab on the Google APIs
- 83 # Console <http://code.google.com/apis/console>.
- 84 client_secrets = os.path.join(os.path.dirname(filename), "client_secrets.json")
- 85
- 86 # Set up a Flow object to be used if we need to authenticate.
- 87 flow = client.flow_from_clientsecrets(
- 88 client_secrets, scope=scope, message=tools.message_if_missing(client_secrets)
- 89 )
- 90
- 91 # Prepare credentials, and authorize HTTP object with them.
- 92 # If the credentials don't exist or are invalid run through the native client
- 93 # flow. The Storage object will ensure that if successful the good
- 94 # credentials will get written back to a file.
- 95 storage = file.Storage(name + ".dat")
- 96 credentials = storage.get()
- 97 if credentials is None or credentials.invalid:
- 98 credentials = tools.run_flow(flow, storage, flags)
- 99 http = credentials.authorize(http=build_http())
-100
-101 if discovery_filename is None:
-102 # Construct a service object via the discovery service.
-103 service = discovery.build(name, version, http=http)
-104 else:
-105 # Construct a service object using a local discovery document file.
-106 with open(discovery_filename) as discovery_file:
-107 service = discovery.build_from_document(
-108 discovery_file.read(), base="https://www.googleapis.com/", http=http
-109 )
-110 return (service, flags)
-111
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.schema-module.html b/docs/epy/googleapiclient.schema-module.html
deleted file mode 100644
index d80380b3987..00000000000
--- a/docs/epy/googleapiclient.schema-module.html
+++ /dev/null
@@ -1,214 +0,0 @@
-
-
-
-
- googleapiclient.schema
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module schema
-
-Schema processing for discovery based APIs
-
-Schemas holds an APIs discovery schemas. It can return those schema as
-deserialized JSON objects, or pretty print them as prototype objects that
-conform to the schema.
-
-For example, given the schema:
-
- schema = """{
- "Foo": {
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the collection."
- },
- "kind": {
- "type": "string",
- "description": "Type of the collection ('calendar#acl').",
- "default": "calendar#acl"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token used to access the next
- page of this result. Omitted if no further results are available."
- }
- }
- }
- }"""
-
- s = Schemas(schema)
- print s.prettyPrintByName('Foo')
-
- Produces the following output:
-
- {
- "nextPageToken": "A String", # Token used to access the
- # next page of this result. Omitted if no further results are available.
- "kind": "A String", # Type of the collection ('calendar#acl').
- "etag": "A String", # ETag of the collection.
- },
-
-The constructor takes a discovery document in which to look up named schema.
-
-
-
-
- Author:
- jcgregorio@google.com (Joe Gregorio)
-
-
-
-
-
-
-
-
- Classes
-
-
-
-
-
-
-
-
- Schemas
- Schemas for an API.
-
-
-
-
-
-
- _SchemaToStruct
- Convert schema to a prototype object.
-
-
-
-
-
-
-
-
-
-
- Variables
-
-
-
-
-
-
-
-
- __package__ = None
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.schema-pysrc.html b/docs/epy/googleapiclient.schema-pysrc.html
deleted file mode 100644
index c9c1c49c6bd..00000000000
--- a/docs/epy/googleapiclient.schema-pysrc.html
+++ /dev/null
@@ -1,477 +0,0 @@
-
-
-
-
- googleapiclient.schema
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Source Code for Module googleapiclient.schema
-
- 1 # Copyright 2014 Google Inc. All Rights Reserved.
- 2 #
- 3 # Licensed under the Apache License, Version 2.0 (the "License");
- 4 # you may not use this file except in compliance with the License.
- 5 # You may obtain a copy of the License at
- 6 #
- 7 # http://www.apache.org/licenses/LICENSE-2.0
- 8 #
- 9 # Unless required by applicable law or agreed to in writing, software
- 10 # distributed under the License is distributed on an "AS IS" BASIS,
- 11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- 12 # See the License for the specific language governing permissions and
- 13 # limitations under the License.
- 14
- 15 """Schema processing for discovery based APIs
- 16
- 17 Schemas holds an APIs discovery schemas. It can return those schema as
- 18 deserialized JSON objects, or pretty print them as prototype objects that
- 19 conform to the schema.
- 20
- 21 For example, given the schema:
- 22
- 23 schema = \"\"\"{
- 24 "Foo": {
- 25 "type": "object",
- 26 "properties": {
- 27 "etag": {
- 28 "type": "string",
- 29 "description": "ETag of the collection."
- 30 },
- 31 "kind": {
- 32 "type": "string",
- 33 "description": "Type of the collection ('calendar#acl').",
- 34 "default": "calendar#acl"
- 35 },
- 36 "nextPageToken": {
- 37 "type": "string",
- 38 "description": "Token used to access the next
- 39 page of this result. Omitted if no further results are available."
- 40 }
- 41 }
- 42 }
- 43 }\"\"\"
- 44
- 45 s = Schemas(schema)
- 46 print s.prettyPrintByName('Foo')
- 47
- 48 Produces the following output:
- 49
- 50 {
- 51 "nextPageToken": "A String", # Token used to access the
- 52 # next page of this result. Omitted if no further results are available.
- 53 "kind": "A String", # Type of the collection ('calendar#acl').
- 54 "etag": "A String", # ETag of the collection.
- 55 },
- 56
- 57 The constructor takes a discovery document in which to look up named schema.
- 58 """
- 59 from __future__ import absolute_import
- 60 import six
- 61
- 62 # TODO(jcgregorio) support format, enum, minimum, maximum
- 63
- 64 __author__ = "jcgregorio@google.com (Joe Gregorio)"
- 65
- 66 import copy
- 67
- 68 from googleapiclient import _helpers as util
- 72 """Schemas for an API."""
- 73
- 75 """Constructor.
- 76
- 77 Args:
- 78 discovery: object, Deserialized discovery document from which we pull
- 79 out the named schema.
- 80 """
- 81 self.schemas = discovery.get("schemas", {})
- 82
- 83 # Cache of pretty printed schemas.
- 84 self.pretty = {}
- 85
- 86 @util.positional(2)
- 88 """Get pretty printed object prototype from the schema name.
- 89
- 90 Args:
- 91 name: string, Name of schema in the discovery document.
- 92 seen: list of string, Names of schema already seen. Used to handle
- 93 recursive definitions.
- 94
- 95 Returns:
- 96 string, A string that contains a prototype object with
- 97 comments that conforms to the given schema.
- 98 """
- 99 if seen is None:
-100 seen = []
-101
-102 if name in seen:
-103 # Do not fall into an infinite loop over recursive definitions.
-104 return "# Object with schema name: %s" % name
-105 seen.append(name)
-106
-107 if name not in self.pretty:
-108 self.pretty[name] = _SchemaToStruct(
-109 self.schemas[name], seen, dent=dent
-110 ).to_str(self._prettyPrintByName)
-111
-112 seen.pop()
-113
-114 return self.pretty[name]
-115
-117 """Get pretty printed object prototype from the schema name.
-118
-119 Args:
-120 name: string, Name of schema in the discovery document.
-121
-122 Returns:
-123 string, A string that contains a prototype object with
-124 comments that conforms to the given schema.
-125 """
-126 # Return with trailing comma and newline removed.
-127 return self._prettyPrintByName(name, seen=[], dent=1)[:-2]
-128
-129 @util.positional(2)
-131 """Get pretty printed object prototype of schema.
-132
-133 Args:
-134 schema: object, Parsed JSON schema.
-135 seen: list of string, Names of schema already seen. Used to handle
-136 recursive definitions.
-137
-138 Returns:
-139 string, A string that contains a prototype object with
-140 comments that conforms to the given schema.
-141 """
-142 if seen is None:
-143 seen = []
-144
-145 return _SchemaToStruct(schema, seen, dent=dent).to_str(self._prettyPrintByName)
-146
-148 """Get pretty printed object prototype of schema.
-149
-150 Args:
-151 schema: object, Parsed JSON schema.
-152
-153 Returns:
-154 string, A string that contains a prototype object with
-155 comments that conforms to the given schema.
-156 """
-157 # Return with trailing comma and newline removed.
-158 return self._prettyPrintSchema(schema, dent=1)[:-2]
-159
-161 """Get deserialized JSON schema from the schema name.
-162
-163 Args:
-164 name: string, Schema name.
-165 default: object, return value if name not found.
-166 """
-167 return self.schemas.get(name, default)
-168
-171 """Convert schema to a prototype object."""
-172
-173 @util.positional(3)
-175 """Constructor.
-176
-177 Args:
-178 schema: object, Parsed JSON schema.
-179 seen: list, List of names of schema already seen while parsing. Used to
-180 handle recursive definitions.
-181 dent: int, Initial indentation depth.
-182 """
-183 # The result of this parsing kept as list of strings.
-184 self.value = []
-185
-186 # The final value of the parsing.
-187 self.string = None
-188
-189 # The parsed JSON schema.
-190 self.schema = schema
-191
-192 # Indentation level.
-193 self.dent = dent
-194
-195 # Method that when called returns a prototype object for the schema with
-196 # the given name.
-197 self.from_cache = None
-198
-199 # List of names of schema already seen while parsing.
-200 self.seen = seen
-201
-203 """Add text as a line to the output.
-204
-205 Args:
-206 text: string, Text to output.
-207 """
-208 self.value.extend([" " * self.dent, text, "\n"])
-209
-211 """Add text to the output, but with no line terminator.
-212
-213 Args:
-214 text: string, Text to output.
-215 """
-216 self.value.extend([" " * self.dent, text])
-217
-219 """Add text and comment to the output with line terminator.
-220
-221 Args:
-222 text: string, Text to output.
-223 comment: string, Python comment.
-224 """
-225 if comment:
-226 divider = "\n" + " " * (self.dent + 2) + "# "
-227 lines = comment.splitlines()
-228 lines = [x.rstrip() for x in lines]
-229 comment = divider.join(lines)
-230 self.value.extend([text, " # ", comment, "\n"])
-231 else:
-232 self.value.extend([text, "\n"])
-233
-237
-241
-243 """Prototype object based on the schema, in Python code with comments.
-244
-245 Args:
-246 schema: object, Parsed JSON schema file.
-247
-248 Returns:
-249 Prototype object based on the schema, in Python code with comments.
-250 """
-251 stype = schema.get("type")
-252 if stype == "object":
-253 self.emitEnd("{", schema.get("description", ""))
-254 self.indent()
-255 if "properties" in schema:
-256 for pname, pschema in six.iteritems(schema.get("properties", {})):
-257 self.emitBegin('"%s": ' % pname)
-258 self._to_str_impl(pschema)
-259 elif "additionalProperties" in schema:
-260 self.emitBegin('"a_key": ')
-261 self._to_str_impl(schema["additionalProperties"])
-262 self.undent()
-263 self.emit("},")
-264 elif "$ref" in schema:
-265 schemaName = schema["$ref"]
-266 description = schema.get("description", "")
-267 s = self.from_cache(schemaName, seen=self.seen)
-268 parts = s.splitlines()
-269 self.emitEnd(parts[0], description)
-270 for line in parts[1:]:
-271 self.emit(line.rstrip())
-272 elif stype == "boolean":
-273 value = schema.get("default", "True or False")
-274 self.emitEnd("%s," % str(value), schema.get("description", ""))
-275 elif stype == "string":
-276 value = schema.get("default", "A String")
-277 self.emitEnd('"%s",' % str(value), schema.get("description", ""))
-278 elif stype == "integer":
-279 value = schema.get("default", "42")
-280 self.emitEnd("%s," % str(value), schema.get("description", ""))
-281 elif stype == "number":
-282 value = schema.get("default", "3.14")
-283 self.emitEnd("%s," % str(value), schema.get("description", ""))
-284 elif stype == "null":
-285 self.emitEnd("None,", schema.get("description", ""))
-286 elif stype == "any":
-287 self.emitEnd('"",', schema.get("description", ""))
-288 elif stype == "array":
-289 self.emitEnd("[", schema.get("description"))
-290 self.indent()
-291 self.emitBegin("")
-292 self._to_str_impl(schema["items"])
-293 self.undent()
-294 self.emit("],")
-295 else:
-296 self.emit("Unknown type! %s" % stype)
-297 self.emitEnd("", "")
-298
-299 self.string = "".join(self.value)
-300 return self.string
-301
-303 """Prototype object based on the schema, in Python code with comments.
-304
-305 Args:
-306 from_cache: callable(name, seen), Callable that retrieves an object
-307 prototype for a schema with the given name. Seen is a list of schema
-308 names already seen as we recursively descend the schema definition.
-309
-310 Returns:
-311 Prototype object based on the schema, in Python code with comments.
-312 The lines of the code will all be properly indented.
-313 """
-314 self.from_cache = from_cache
-315 return self._to_str_impl(self.schema)
-316
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.schema.Schemas-class.html b/docs/epy/googleapiclient.schema.Schemas-class.html
deleted file mode 100644
index 544fe9e1205..00000000000
--- a/docs/epy/googleapiclient.schema.Schemas-class.html
+++ /dev/null
@@ -1,494 +0,0 @@
-
-
-
-
- googleapiclient.schema.Schemas
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class Schemas
-
-object --+
- |
- Schemas
-
-
-
-Schemas for an API.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- discovery)
- Constructor.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _prettyPrintByName(*args,
- **kwargs)
- Get pretty printed object prototype from the schema name.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- prettyPrintByName(self,
- name)
- Get pretty printed object prototype from the schema name.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _prettyPrintSchema(*args,
- **kwargs)
- Get pretty printed object prototype of schema.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- prettyPrintSchema(self,
- schema)
- Get pretty printed object prototype of schema.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- get(self,
- name,
- default=None)
- Get deserialized JSON schema from the schema name.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(self,
- discovery)
-
(Constructor)
-
- source code
-
-
-
-
-Constructor.
-
-Args:
- discovery: object, Deserialized discovery document from which we pull
- out the named schema.
-
-
-
- - Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
-
- _prettyPrintByName(*args,
- **kwargs)
-
- source code
-
-
-
-
-Get pretty printed object prototype from the schema name.
-
-Args:
- name: string, Name of schema in the discovery document.
- seen: list of string, Names of schema already seen. Used to handle
- recursive definitions.
-
-Returns:
- string, A string that contains a prototype object with
- comments that conforms to the given schema.
-
-
-
- - Decorators:
-
- @util.positional(2)
-
-
-
-
-
-
-
-
- prettyPrintByName(self,
- name)
-
- source code
-
-
-
-
-Get pretty printed object prototype from the schema name.
-
-Args:
- name: string, Name of schema in the discovery document.
-
-Returns:
- string, A string that contains a prototype object with
- comments that conforms to the given schema.
-
-
-
-
-
-
-
-
-
-
-
-
- _prettyPrintSchema(*args,
- **kwargs)
-
- source code
-
-
-
-
-Get pretty printed object prototype of schema.
-
-Args:
- schema: object, Parsed JSON schema.
- seen: list of string, Names of schema already seen. Used to handle
- recursive definitions.
-
-Returns:
- string, A string that contains a prototype object with
- comments that conforms to the given schema.
-
-
-
- - Decorators:
-
- @util.positional(2)
-
-
-
-
-
-
-
-
- prettyPrintSchema(self,
- schema)
-
- source code
-
-
-
-
-Get pretty printed object prototype of schema.
-
-Args:
- schema: object, Parsed JSON schema.
-
-Returns:
- string, A string that contains a prototype object with
- comments that conforms to the given schema.
-
-
-
-
-
-
-
-
-
-
-
-
- get(self,
- name,
- default=None)
-
- source code
-
-
-
-
-Get deserialized JSON schema from the schema name.
-
-Args:
- name: string, Schema name.
- default: object, return value if name not found.
-
-
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/googleapiclient.schema._SchemaToStruct-class.html b/docs/epy/googleapiclient.schema._SchemaToStruct-class.html
deleted file mode 100644
index 973fb50c22e..00000000000
--- a/docs/epy/googleapiclient.schema._SchemaToStruct-class.html
+++ /dev/null
@@ -1,516 +0,0 @@
-
-
-
-
- googleapiclient.schema._SchemaToStruct
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class _SchemaToStruct
-
-object --+
- |
- _SchemaToStruct
-
-
-
-Convert schema to a prototype object.
-
-
-
-
-
-
-
-
- Instance Methods
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
- Constructor.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- emit(self,
- text)
- Add text as a line to the output.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- emitBegin(self,
- text)
- Add text to the output, but with no line terminator.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- emitEnd(self,
- text,
- comment)
- Add text and comment to the output with line terminator.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- indent(self)
- Increase indentation level.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- undent(self)
- Decrease indentation level.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- _to_str_impl(self,
- schema)
- Prototype object based on the schema, in Python code with comments.
-
- source code
-
-
-
-
-
-
-
-
-
-
-
-
-
- to_str(self,
- from_cache)
- Prototype object based on the schema, in Python code with comments.
-
- source code
-
-
-
-
-
-
-
-
-
- Inherited from object:
- __delattr__,
- __format__,
- __getattribute__,
- __hash__,
- __new__,
- __reduce__,
- __reduce_ex__,
- __repr__,
- __setattr__,
- __sizeof__,
- __str__,
- __subclasshook__
-
-
-
-
-
-
-
-
-
-
-
- Properties
-
-
-
-
-
-
- Inherited from object:
- __class__
-
-
-
-
-
-
-
-
-
-
-
- Method Details
-
-
-
-
-
-
-
-
-
-
-
- __init__(*args,
- **kwargs)
-
(Constructor)
-
- source code
-
-
-
-
-Constructor.
-
-Args:
- schema: object, Parsed JSON schema.
- seen: list, List of names of schema already seen while parsing. Used to
- handle recursive definitions.
- dent: int, Initial indentation depth.
-
-
-
- - Decorators:
-
- @util.positional(3)
- Overrides:
- object.__init__
-
-
-
-
-
-
-
-
-
-
- emit(self,
- text)
-
- source code
-
-
-
-
-Add text as a line to the output.
-
-Args:
- text: string, Text to output.
-
-
-
-
-
-
-
-
-
-
-
-
- emitBegin(self,
- text)
-
- source code
-
-
-
-
-Add text to the output, but with no line terminator.
-
-Args:
- text: string, Text to output.
-
-
-
-
-
-
-
-
-
-
-
-
-
- emitEnd(self,
- text,
- comment)
-
- source code
-
-
-
-
-Add text and comment to the output with line terminator.
-
-Args:
- text: string, Text to output.
- comment: string, Python comment.
-
-
-
-
-
-
-
-
-
-
-
-
- _to_str_impl(self,
- schema)
-
- source code
-
-
-
-
-Prototype object based on the schema, in Python code with comments.
-
-Args:
- schema: object, Parsed JSON schema file.
-
-Returns:
- Prototype object based on the schema, in Python code with comments.
-
-
-
-
-
-
-
-
-
-
-
-
- to_str(self,
- from_cache)
-
- source code
-
-
-
-
-Prototype object based on the schema, in Python code with comments.
-
-Args:
- from_cache: callable(name, seen), Callable that retrieves an object
- prototype for a schema with the given name. Seen is a list of schema
- names already seen as we recursively descend the schema definition.
-
-Returns:
- Prototype object based on the schema, in Python code with comments.
- The lines of the code will all be properly indented.
-
-
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/help.html b/docs/epy/help.html
deleted file mode 100644
index 97c6d2a0485..00000000000
--- a/docs/epy/help.html
+++ /dev/null
@@ -1,268 +0,0 @@
-
-
-
-
- Help
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- API Documentation
-
- This document contains the API (Application Programming Interface)
-documentation for this project. Documentation for the Python
-objects defined by the project is divided into separate pages for each
-package, module, and class. The API documentation also includes two
-pages containing information about the project as a whole: a trees
-page, and an index page.
-
- Object Documentation
-
- Each Package Documentation page contains:
-
- - A description of the package.
- - A list of the modules and sub-packages contained by the
- package.
- - A summary of the classes defined by the package.
- - A summary of the functions defined by the package.
- - A summary of the variables defined by the package.
- - A detailed description of each function defined by the
- package.
- - A detailed description of each variable defined by the
- package.
-
-
- Each Module Documentation page contains:
-
- - A description of the module.
- - A summary of the classes defined by the module.
- - A summary of the functions defined by the module.
- - A summary of the variables defined by the module.
- - A detailed description of each function defined by the
- module.
- - A detailed description of each variable defined by the
- module.
-
-
- Each Class Documentation page contains:
-
- - A class inheritance diagram.
- - A list of known subclasses.
- - A description of the class.
- - A summary of the methods defined by the class.
- - A summary of the instance variables defined by the class.
- - A summary of the class (static) variables defined by the
- class.
- - A detailed description of each method defined by the
- class.
- - A detailed description of each instance variable defined by the
- class.
- - A detailed description of each class (static) variable defined
- by the class.
-
-
- Project Documentation
-
- The Trees page contains the module and class hierarchies:
-
- - The module hierarchy lists every package and module, with
- modules grouped into packages. At the top level, and within each
- package, modules and sub-packages are listed alphabetically.
- - The class hierarchy lists every class, grouped by base
- class. If a class has more than one base class, then it will be
- listed under each base class. At the top level, and under each base
- class, classes are listed alphabetically.
-
-
- The Index page contains indices of terms and
- identifiers:
-
- - The term index lists every term indexed by any object's
- documentation. For each term, the index provides links to each
- place where the term is indexed.
- - The identifier index lists the (short) name of every package,
- module, class, method, function, variable, and parameter. For each
- identifier, the index provides a short description, and a link to
- its documentation.
-
-
- The Table of Contents
-
- The table of contents occupies the two frames on the left side of
-the window. The upper-left frame displays the project
-contents, and the lower-left frame displays the module
-contents:
-
-
-
-
- Project
Contents
...
-
- API
Documentation
Frame
-
-
-
-
- Module
Contents
...
-
-
-
-
- The project contents frame contains a list of all packages
-and modules that are defined by the project. Clicking on an entry
-will display its contents in the module contents frame. Clicking on a
-special entry, labeled "Everything," will display the contents of
-the entire project.
-
- The module contents frame contains a list of every
-submodule, class, type, exception, function, and variable defined by a
-module or package. Clicking on an entry will display its
-documentation in the API documentation frame. Clicking on the name of
-the module, at the top of the frame, will display the documentation
-for the module itself.
-
- The "frames" and "no frames" buttons below the top
-navigation bar can be used to control whether the table of contents is
-displayed or not.
-
- The Navigation Bar
-
- A navigation bar is located at the top and bottom of every page.
-It indicates what type of page you are currently viewing, and allows
-you to go to related pages. The following table describes the labels
-on the navigation bar. Note that not some labels (such as
-[Parent]) are not displayed on all pages.
-
-
-
- Label
- Highlighted when...
- Links to...
-
- [Parent]
- (never highlighted)
- the parent of the current package [Package]
- viewing a package
- the package containing the current object
- [Module]
- viewing a module
- the module containing the current object
- [Class]
- viewing a class
- the class containing the current object [Trees]
- viewing the trees page
- the trees page [Index]
- viewing the index page
- the index page [Help]
- viewing the help page
- the help page
-
- The "show private" and "hide private" buttons below
-the top navigation bar can be used to control whether documentation
-for private objects is displayed. Private objects are usually defined
-as objects whose (short) names begin with a single underscore, but do
-not end with an underscore. For example, "_x",
-"__pprint", and "epydoc.epytext._tokenize"
-are private objects; but "re.sub",
-"__init__", and "type_" are not. However,
-if a module defines the "__all__" variable, then its
-contents are used to decide which objects are private.
-
- A timestamp below the bottom navigation bar indicates when each
-page was last updated.
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:21 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/identifier-index.html b/docs/epy/identifier-index.html
deleted file mode 100644
index 1434e534f14..00000000000
--- a/docs/epy/identifier-index.html
+++ /dev/null
@@ -1,1187 +0,0 @@
-
-
-
-
- Identifier Index
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Identifier Index
-
-[
- A
- B
- C
- D
- E
- F
- G
- H
- I
- J
- K
- L
- M
- N
- O
- P
- Q
- R
- S
- T
- U
- V
- W
- X
- Y
- Z
- _
-]
-
-
-A
-
-
-add()
-(in BatchHttpRequest)
-alt_param
-(in RawModel)
-
-
-accept
-(in BaseModel)
-add_response_callback()
-(in HttpRequest)
-appengine_memcache
-(in googleapiclient.discovery_cache)
-
-
-accept
-(in JsonModel)
-alt_param
-(in BaseModel)
-apply_credentials()
-(in googleapiclient._auth)
-
-
-accept
-(in MediaModel)
-alt_param
-(in JsonModel)
-authorized_http()
-(in googleapiclient._auth)
-
-
-accept
-(in ProtocolBufferModel)
-alt_param
-(in MediaModel)
-autodetect()
-(in googleapiclient.discovery_cache)
-
-
-accept
-(in RawModel)
-alt_param
-(in ProtocolBufferModel)
-
-
-
- B
-
-
-base
-(in googleapiclient.discovery_cache)
-best_match()
-(in googleapiclient.mimeparse)
-build_from_document()
-(in googleapiclient.discovery)
-
-
-BaseModel
-(in googleapiclient.model)
-body()
-(in Channel)
-build_http()
-(in googleapiclient.http)
-
-
-BatchError
-(in googleapiclient.errors)
-BODY_PARAMETER_DEFAULT_VALUE
-(in googleapiclient.discovery)
-
-
-
-BatchHttpRequest
-(in googleapiclient.http)
-build()
-(in googleapiclient.discovery)
-
-
-
- C
-
-
-Cache
-(in googleapiclient.discovery_cache.appengine_memcache)
-CHANNEL_PARAMS
-(in googleapiclient.channel)
-content_type
-(in JsonModel)
-
-
-cache
-(in googleapiclient.discovery_cache.appengine_memcache)
-chunksize()
-(in MediaIoBaseUpload)
-content_type
-(in MediaModel)
-
-
-Cache
-(in googleapiclient.discovery_cache.base)
-chunksize()
-(in MediaUpload)
-content_type
-(in ProtocolBufferModel)
-
-
-Cache
-(in googleapiclient.discovery_cache.file_cache)
-close()
-(in Resource)
-content_type
-(in RawModel)
-
-
-cache
-(in googleapiclient.discovery_cache.file_cache)
-close()
-(in HttpMock)
-createMethod()
-(in googleapiclient.discovery)
-
-
-channel
-(in googleapiclient)
-ConnectionError
-(in googleapiclient.http)
-createNextMethod()
-(in googleapiclient.discovery)
-
-
-Channel
-(in googleapiclient.channel)
-content_type
-(in BaseModel)
-credentials_from_file()
-(in googleapiclient._auth)
-
-
- D
-
-
-DEFAULT_CHUNK_SIZE
-(in googleapiclient.http)
-deserialize()
-(in JsonModel)
-discovery_cache
-(in googleapiclient)
-
-
-default_credentials()
-(in googleapiclient._auth)
-deserialize()
-(in MediaModel)
-DISCOVERY_DOC_MAX_AGE
-(in googleapiclient.discovery_cache)
-
-
-DEFAULT_HTTP_TIMEOUT_SEC
-(in googleapiclient.http)
-deserialize()
-(in ProtocolBufferModel)
-DISCOVERY_URI
-(in googleapiclient.discovery)
-
-
-DEFAULT_METHOD_DOC
-(in googleapiclient.discovery)
-deserialize()
-(in RawModel)
-dump_request_response
-(in googleapiclient.model)
-
-
-deserialize()
-(in BaseModel)
-discovery
-(in googleapiclient)
-
-
-
- E
-
-
-emit()
-(in _SchemaToStruct)
-EPOCH
-(in googleapiclient.discovery_cache.file_cache)
-execute()
-(in HttpRequest)
-
-
-emitBegin()
-(in _SchemaToStruct)
-Error
-(in googleapiclient.errors)
-execute()
-(in HttpRequestMock)
-
-
-emitEnd()
-(in _SchemaToStruct)
-errors
-(in googleapiclient)
-
-
-
-EPOCH
-(in googleapiclient.channel)
-execute()
-(in BatchHttpRequest)
-
-
-
- F
-
-
-file_cache
-(in googleapiclient.discovery_cache)
-fitness_and_quality_parsed()
-(in googleapiclient.mimeparse)
-from_json()
-(in HttpRequest)
-
-
-FILENAME
-(in googleapiclient.discovery_cache.file_cache)
-fix_method_name()
-(in googleapiclient.discovery)
-from_json()
-(in MediaFileUpload)
-
-
- G
-
-
-get()
-(in Cache)
-get_credentials_from_http()
-(in googleapiclient._auth)
-GOOGLE_API_USE_MTLS_ENDPOINT
-(in googleapiclient.discovery)
-
-
-get()
-(in Cache)
-getbytes()
-(in MediaIoBaseUpload)
-google_auth_httplib2
-(in googleapiclient._auth)
-
-
-get()
-(in Cache)
-getbytes()
-(in MediaUpload)
-google_auth_httplib2
-(in googleapiclient.discovery)
-
-
-get()
-(in Schemas)
-GOOGLE_API_USE_CLIENT_CERTIFICATE
-(in googleapiclient.discovery)
-googleapiclient
-
-
- H
-
-
-HAS_GOOGLE_AUTH
-(in googleapiclient._auth)
-http
-(in googleapiclient)
-HttpMockSequence
-(in googleapiclient.http)
-
-
-HAS_OAUTH2CLIENT
-(in googleapiclient._auth)
-HTTP_PAYLOAD_METHODS
-(in googleapiclient.discovery)
-HttpRequest
-(in googleapiclient.http)
-
-
-has_stream()
-(in MediaIoBaseUpload)
-HttpError
-(in googleapiclient.errors)
-HttpRequestMock
-(in googleapiclient.http)
-
-
-has_stream()
-(in MediaUpload)
-HttpMock
-(in googleapiclient.http)
-
-
-
- I
-
-
-indent()
-(in _SchemaToStruct)
-InvalidChunkSizeError
-(in googleapiclient.errors)
-InvalidNotificationError
-(in googleapiclient.errors)
-
-
-init()
-(in googleapiclient.sample_tools)
-InvalidJsonError
-(in googleapiclient.errors)
-is_valid()
-(in googleapiclient._auth)
-
-
- J
-
-
-JsonModel
-(in googleapiclient.model)
-
-
-
-
- K
-
-
-key2param()
-(in googleapiclient.discovery)
-
-
-
-
- L
-
-
-logger
-(in googleapiclient._helpers)
-LOGGER
-(in googleapiclient.discovery_cache.appengine_memcache)
-LOGGER
-(in googleapiclient.model)
-
-
-logger
-(in googleapiclient.discovery)
-LOGGER
-(in googleapiclient.discovery_cache.file_cache)
-
-
-
-LOGGER
-(in googleapiclient.discovery_cache)
-LOGGER
-(in googleapiclient.http)
-
-
-
- M
-
-
-makepatch()
-(in googleapiclient.model)
-MediaInMemoryUpload
-(in googleapiclient.http)
-mimeparse
-(in googleapiclient)
-
-
-MAX_BATCH_LIMIT
-(in googleapiclient.http)
-MediaIoBaseDownload
-(in googleapiclient.http)
-mimetype()
-(in MediaIoBaseUpload)
-
-
-MAX_URI_LENGTH
-(in googleapiclient.http)
-MediaIoBaseUpload
-(in googleapiclient.http)
-mimetype()
-(in MediaUpload)
-
-
-MEDIA_BODY_PARAMETER_DEFAULT_VALUE
-(in googleapiclient.discovery)
-MediaModel
-(in googleapiclient.model)
-model
-(in googleapiclient)
-
-
-MEDIA_MIME_TYPE_PARAMETER_DEFAULT_VALUE
-(in googleapiclient.discovery)
-MediaUpload
-(in googleapiclient.http)
-Model
-(in googleapiclient.model)
-
-
-MediaDownloadProgress
-(in googleapiclient.http)
-MediaUploadProgress
-(in googleapiclient.http)
-
-
-
-MediaFileUpload
-(in googleapiclient.http)
-MediaUploadSizeError
-(in googleapiclient.errors)
-
-
-
- N
-
-
-NAMESPACE
-(in googleapiclient.discovery_cache.appengine_memcache)
-no_content_response
-(in BaseModel)
-Notification
-(in googleapiclient.channel)
-
-
-new_from_json()
-(in MediaUpload)
-no_content_response
-(in JsonModel)
-notification_from_headers()
-(in googleapiclient.channel)
-
-
-new_webhook_channel()
-(in googleapiclient.channel)
-no_content_response
-(in MediaModel)
-null_postproc()
-(in HttpRequest)
-
-
-next_chunk()
-(in HttpRequest)
-no_content_response
-(in ProtocolBufferModel)
-
-
-
-next_chunk()
-(in MediaIoBaseDownload)
-no_content_response
-(in RawModel)
-
-
-
- P
-
-
-parse_media_range()
-(in googleapiclient.mimeparse)
-POSITIONAL_IGNORE
-(in googleapiclient._helpers)
-prettyPrintSchema()
-(in Schemas)
-
-
-parse_mime_type()
-(in googleapiclient.mimeparse)
-positional_parameters_enforcement
-(in googleapiclient._helpers)
-progress()
-(in MediaDownloadProgress)
-
-
-parse_unique_urlencoded()
-(in googleapiclient._helpers)
-POSITIONAL_SET
-(in googleapiclient._helpers)
-progress()
-(in MediaUploadProgress)
-
-
-positional()
-(in googleapiclient._helpers)
-POSITIONAL_WARNING
-(in googleapiclient._helpers)
-ProtocolBufferModel
-(in googleapiclient.model)
-
-
-POSITIONAL_EXCEPTION
-(in googleapiclient._helpers)
-prettyPrintByName()
-(in Schemas)
-
-
-
- Q
-
-
-quality()
-(in googleapiclient.mimeparse)
-quality_parsed()
-(in googleapiclient.mimeparse)
-
-
-
- R
-
-
-RawModel
-(in googleapiclient.model)
-request()
-(in Model)
-response()
-(in Model)
-
-
-read()
-(in _StreamSlice)
-RequestMockBuilder
-(in googleapiclient.http)
-resumable()
-(in MediaIoBaseUpload)
-
-
-refresh_credentials()
-(in googleapiclient._auth)
-RESERVED_WORDS
-(in googleapiclient.discovery)
-resumable()
-(in MediaUpload)
-
-
-request()
-(in HttpMock)
-Resource
-(in googleapiclient.discovery)
-ResumableUploadError
-(in googleapiclient.errors)
-
-
-request()
-(in HttpMockSequence)
-ResourceMethodParameters
-(in googleapiclient.discovery)
-
-
-
-request()
-(in BaseModel)
-response()
-(in BaseModel)
-
-
-
- S
-
-
-sample_tools
-(in googleapiclient)
-set()
-(in Cache)
-size()
-(in MediaUpload)
-
-
-schema
-(in googleapiclient)
-set()
-(in Cache)
-STACK_QUERY_PARAMETER_DEFAULT_VALUE
-(in googleapiclient.discovery)
-
-
-Schemas
-(in googleapiclient.schema)
-set()
-(in Cache)
-STACK_QUERY_PARAMETERS
-(in googleapiclient.discovery)
-
-
-serialize()
-(in BaseModel)
-set_parameters()
-(in ResourceMethodParameters)
-stream()
-(in MediaIoBaseUpload)
-
-
-serialize()
-(in JsonModel)
-set_user_agent()
-(in googleapiclient.http)
-stream()
-(in MediaUpload)
-
-
-serialize()
-(in ProtocolBufferModel)
-size()
-(in MediaIoBaseUpload)
-
-
-
- T
-
-
-to_json()
-(in HttpRequest)
-to_json()
-(in MediaIoBaseUpload)
-to_str()
-(in _SchemaToStruct)
-
-
-to_json()
-(in MediaFileUpload)
-to_json()
-(in MediaUpload)
-tunnel_patch()
-(in googleapiclient.http)
-
-
- U
-
-
-UnacceptableMimeTypeError
-(in googleapiclient.errors)
-UnknownApiNameOrVersion
-(in googleapiclient.errors)
-update_query_params()
-(in googleapiclient._helpers)
-
-
-undent()
-(in _SchemaToStruct)
-UnknownFileType
-(in googleapiclient.errors)
-URITEMPLATE
-(in googleapiclient.discovery)
-
-
-UnexpectedBodyError
-(in googleapiclient.errors)
-UnknownLinkType
-(in googleapiclient.errors)
-
-
-
-UnexpectedMethodError
-(in googleapiclient.errors)
-update()
-(in Channel)
-
-
-
- V
-
-
-V1_DISCOVERY_URI
-(in googleapiclient.discovery)
-V2_DISCOVERY_URI
-(in googleapiclient.discovery)
-VARNAME
-(in googleapiclient.discovery)
-
-
- W
-
-
-with_scopes()
-(in googleapiclient._auth)
-
-
-
-
- X
-
-
-X_GOOG_CHANNEL_ID
-(in googleapiclient.channel)
-X_GOOG_RESOURCE_ID
-(in googleapiclient.channel)
-X_GOOG_RESOURCE_URI
-(in googleapiclient.channel)
-
-
-X_GOOG_MESSAGE_NUMBER
-(in googleapiclient.channel)
-X_GOOG_RESOURCE_STATE
-(in googleapiclient.channel)
-
-
-
- _
-
-
-__abstractmethods__
-(in Cache)
-__package__
-(in googleapiclient._helpers)
-_id_to_header()
-(in BatchHttpRequest)
-
-
-__call__()
-(in RequestMockBuilder)
-__package__
-(in googleapiclient.channel)
-_IS_DIR_MESSAGE
-(in googleapiclient._helpers)
-
-
-__credits__
-(in googleapiclient.mimeparse)
-__package__
-(in googleapiclient.discovery_cache)
-_LEGACY_BATCH_URI
-(in googleapiclient.http)
-
-
-__del__()
-(in MediaFileUpload)
-__package__
-(in googleapiclient.discovery_cache.base)
-_LIBRARY_VERSION
-(in googleapiclient.model)
-
-
-__email__
-(in googleapiclient.mimeparse)
-__package__
-(in googleapiclient.errors)
-_log_request()
-(in BaseModel)
-
-
-__enter__()
-(in Resource)
-__package__
-(in googleapiclient.http)
-_log_response()
-(in BaseModel)
-
-
-__exit__()
-(in Resource)
-__package__
-(in googleapiclient.mimeparse)
-_media_path_url_from_info()
-(in googleapiclient.discovery)
-
-
-__getstate__()
-(in Resource)
-__package__
-(in googleapiclient.model)
-_MEDIA_SIZE_BIT_SHIFTS
-(in googleapiclient.discovery)
-
-
-__init__()
-(in Channel)
-__package__
-(in googleapiclient.schema)
-_media_size_to_long()
-(in googleapiclient.discovery)
-
-
-__init__()
-(in Notification)
-__repr__()
-(in BatchError)
-_methodProperties()
-(in googleapiclient.discovery)
-
-
-__init__()
-(in Resource)
-__repr__()
-(in HttpError)
-_MISSING_FILE_MESSAGE
-(in googleapiclient._helpers)
-
-
-__init__()
-(in ResourceMethodParameters)
-__setstate__()
-(in Resource)
-_new_id()
-(in BatchHttpRequest)
-
-
-__init__()
-(in Cache)
-_abc_cache
-(in Cache)
-_PAGE_TOKEN_NAMES
-(in googleapiclient.discovery)
-
-
-__init__()
-(in Cache)
-_abc_invalidation_counter
-(in ABCMeta)
-_prettyPrintByName()
-(in Schemas)
-
-
-__init__()
-(in BatchError)
-_abc_negative_cache
-(in Cache)
-_prettyPrintSchema()
-(in Schemas)
-
-
-__init__()
-(in HttpError)
-_abc_negative_cache_version
-(in Cache)
-_process_response()
-(in HttpRequest)
-
-
-__init__()
-(in UnexpectedBodyError)
-_abc_registry
-(in Cache)
-_PY_VERSION
-(in googleapiclient.model)
-
-
-__init__()
-(in UnexpectedMethodError)
-_abstract()
-(in googleapiclient.model)
-_read_or_initialize_cache()
-(in googleapiclient.discovery_cache.file_cache)
-
-
-__init__()
-(in BatchHttpRequest)
-_add_basic_methods()
-(in Resource)
-_refresh_and_apply_credentials()
-(in BatchHttpRequest)
-
-
-__init__()
-(in HttpMock)
-_add_nested_resources()
-(in Resource)
-_retrieve_discovery_doc()
-(in googleapiclient.discovery)
-
-
-__init__()
-(in HttpMockSequence)
-_add_next_methods()
-(in Resource)
-_retry_request()
-(in googleapiclient.http)
-
-
-__init__()
-(in HttpRequest)
-_add_query_parameter()
-(in googleapiclient._helpers)
-_SchemaToStruct
-(in googleapiclient.schema)
-
-
-__init__()
-(in HttpRequestMock)
-_auth
-(in googleapiclient)
-_serialize_request()
-(in BatchHttpRequest)
-
-
-__init__()
-(in MediaDownloadProgress)
-_build_query()
-(in BaseModel)
-_set_dynamic_attr()
-(in Resource)
-
-
-__init__()
-(in MediaFileUpload)
-_BytesGenerator
-(in googleapiclient.discovery)
-_set_service_methods()
-(in Resource)
-
-
-__init__()
-(in MediaInMemoryUpload)
-_cast()
-(in googleapiclient.discovery)
-_should_retry_response()
-(in googleapiclient.http)
-
-
-__init__()
-(in MediaIoBaseDownload)
-_deserialize_response()
-(in BatchHttpRequest)
-_StreamSlice
-(in googleapiclient.http)
-
-
-__init__()
-(in MediaIoBaseUpload)
-_discovery_service_uri_options()
-(in googleapiclient.discovery)
-_SYM_LINK_MESSAGE
-(in googleapiclient._helpers)
-
-
-__init__()
-(in MediaUploadProgress)
-_execute()
-(in BatchHttpRequest)
-_to_json()
-(in MediaUpload)
-
-
-__init__()
-(in RequestMockBuilder)
-_filter_blank()
-(in googleapiclient.mimeparse)
-_to_str_impl()
-(in _SchemaToStruct)
-
-
-__init__()
-(in _StreamSlice)
-_findPageTokenName()
-(in googleapiclient.discovery)
-_to_timestamp()
-(in googleapiclient.discovery_cache.file_cache)
-
-
-__init__()
-(in JsonModel)
-_fix_up_media_upload()
-(in googleapiclient.discovery)
-_TOO_MANY_REQUESTS
-(in googleapiclient.http)
-
-
-__init__()
-(in ProtocolBufferModel)
-_fix_up_method_description()
-(in googleapiclient.discovery)
-_upper_header_keys()
-(in googleapiclient.channel)
-
-
-__init__()
-(in Schemas)
-_fix_up_parameters()
-(in googleapiclient.discovery)
-_urljoin()
-(in googleapiclient.discovery)
-
-
-__init__()
-(in _SchemaToStruct)
-_get_reason()
-(in HttpError)
-_write_lines
-(in _BytesGenerator)
-
-
-__package__
-(in googleapiclient)
-_header_to_id()
-(in BatchHttpRequest)
-
-
-
-__package__
-(in googleapiclient._auth)
-_helpers
-(in googleapiclient)
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:21 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/index.html b/docs/epy/index.html
deleted file mode 100644
index 042cb61ab1f..00000000000
--- a/docs/epy/index.html
+++ /dev/null
@@ -1,17 +0,0 @@
-
-
-
-
- API Documentation
-
-
-
diff --git a/docs/epy/module-tree.html b/docs/epy/module-tree.html
deleted file mode 100644
index 1c8da08dc5d..00000000000
--- a/docs/epy/module-tree.html
+++ /dev/null
@@ -1,125 +0,0 @@
-
-
-
-
- Module Hierarchy
-
-
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- [ Module Hierarchy
- | Class Hierarchy ]
-
-Module Hierarchy
-
- - googleapiclient
-
- - googleapiclient._auth: Helpers for authentication using oauth2client or google-auth.
- - googleapiclient._helpers: Helper functions for commonly used utilities.
- - googleapiclient.channel: Channel notifications support.
- - googleapiclient.discovery: Client for discovery based APIs.
- - googleapiclient.discovery_cache: Caching utility for the discovery document.
-
- - googleapiclient.discovery_cache.appengine_memcache: App Engine memcache based cache for the discovery document.
- - googleapiclient.discovery_cache.base: An abstract class for caching the discovery document.
- - googleapiclient.discovery_cache.file_cache: File based cache for the discovery document.
-
-
- - googleapiclient.errors: Errors for the library.
- - googleapiclient.http: Classes to encapsulate a single HTTP request.
- - googleapiclient.mimeparse: MIME-Type Parser
- - googleapiclient.model: Model objects for requests and responses.
- - googleapiclient.sample_tools: Utilities for making samples.
- - googleapiclient.schema: Schema processing for discovery based APIs
-
-
-
-
-
-
-
- Home
-
-
- Trees
-
-
- Indices
-
-
- Help
-
-
-
-
-
-
- Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:21 2020
-
-
- http://epydoc.sourceforge.net
-
-
-
-
-
-
-
diff --git a/docs/epy/redirect.html b/docs/epy/redirect.html
deleted file mode 100644
index db937d05cf9..00000000000
--- a/docs/epy/redirect.html
+++ /dev/null
@@ -1,38 +0,0 @@
-Epydoc Redirect Page
-
-
-
-
-
-
-
-
-Epydoc Auto-redirect page
-
-When javascript is enabled, this page will redirect URLs of
-the form redirect.html#dotted.name to the
-documentation for the object with the given fully-qualified
-dotted name.
-
-
-
-
-
-
diff --git a/docs/epy/toc-everything.html b/docs/epy/toc-everything.html
deleted file mode 100644
index 3eba82a7c20..00000000000
--- a/docs/epy/toc-everything.html
+++ /dev/null
@@ -1,346 +0,0 @@
-
-
-
-
- Everything
-
-
-
-
-
-Everything
-
- All Classes
- googleapiclient.channel.Channel
googleapiclient.channel.Notification
-
-
- googleapiclient.discovery_cache.appengine_memcache.Cache
googleapiclient.discovery_cache.base.Cache
googleapiclient.discovery_cache.file_cache.Cache
googleapiclient.errors.BatchError
googleapiclient.errors.Error
googleapiclient.errors.HttpError
googleapiclient.errors.InvalidChunkSizeError
googleapiclient.errors.InvalidJsonError
googleapiclient.errors.InvalidNotificationError
googleapiclient.errors.MediaUploadSizeError
googleapiclient.errors.ResumableUploadError
googleapiclient.errors.UnacceptableMimeTypeError
googleapiclient.errors.UnexpectedBodyError
googleapiclient.errors.UnexpectedMethodError
googleapiclient.errors.UnknownApiNameOrVersion
googleapiclient.errors.UnknownFileType
googleapiclient.errors.UnknownLinkType
googleapiclient.http.BatchHttpRequest
googleapiclient.http.HttpMock
googleapiclient.http.HttpMockSequence
googleapiclient.http.HttpRequest
googleapiclient.http.HttpRequestMock
googleapiclient.http.MediaDownloadProgress
googleapiclient.http.MediaFileUpload
googleapiclient.http.MediaInMemoryUpload
googleapiclient.http.MediaIoBaseDownload
googleapiclient.http.MediaIoBaseUpload
googleapiclient.http.MediaUpload
googleapiclient.http.MediaUploadProgress
googleapiclient.http.RequestMockBuilder
- googleapiclient.model.BaseModel
googleapiclient.model.JsonModel
googleapiclient.model.MediaModel
googleapiclient.model.Model
googleapiclient.model.ProtocolBufferModel
googleapiclient.model.RawModel
googleapiclient.schema.Schemas
- All Functions
-
-
-
-
-
-
-
-
-
-
-
-
-
- googleapiclient.channel.new_webhook_channel
googleapiclient.channel.notification_from_headers
-
-
-
-
-
-
-
-
-
-
- googleapiclient.discovery.build
googleapiclient.discovery.build_from_document
-
- googleapiclient.discovery.fix_method_name
googleapiclient.discovery.key2param
googleapiclient.discovery_cache.autodetect
-
-
-
- googleapiclient.http.build_http
googleapiclient.http.set_user_agent
googleapiclient.http.tunnel_patch
- googleapiclient.mimeparse.best_match
googleapiclient.mimeparse.fitness_and_quality_parsed
googleapiclient.mimeparse.parse_media_range
googleapiclient.mimeparse.parse_mime_type
googleapiclient.mimeparse.quality
googleapiclient.mimeparse.quality_parsed
- googleapiclient.model.makepatch
googleapiclient.sample_tools.init
All Variables
- googleapiclient.__package__
-
-
-
-
-
-
-
-
-
-
-
-
-
- googleapiclient.channel.CHANNEL_PARAMS
googleapiclient.channel.EPOCH
googleapiclient.channel.X_GOOG_CHANNEL_ID
googleapiclient.channel.X_GOOG_MESSAGE_NUMBER
googleapiclient.channel.X_GOOG_RESOURCE_ID
googleapiclient.channel.X_GOOG_RESOURCE_STATE
googleapiclient.channel.X_GOOG_RESOURCE_URI
googleapiclient.channel.__package__
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- googleapiclient.discovery_cache.DISCOVERY_DOC_MAX_AGE
googleapiclient.discovery_cache.LOGGER
googleapiclient.discovery_cache.__package__
googleapiclient.discovery_cache.appengine_memcache.LOGGER
googleapiclient.discovery_cache.appengine_memcache.NAMESPACE
googleapiclient.discovery_cache.appengine_memcache.cache
googleapiclient.discovery_cache.base.__package__
googleapiclient.discovery_cache.file_cache.EPOCH
googleapiclient.discovery_cache.file_cache.FILENAME
googleapiclient.discovery_cache.file_cache.LOGGER
googleapiclient.discovery_cache.file_cache.cache
googleapiclient.errors.__package__
googleapiclient.http.ConnectionError
googleapiclient.http.DEFAULT_CHUNK_SIZE
googleapiclient.http.DEFAULT_HTTP_TIMEOUT_SEC
googleapiclient.http.LOGGER
googleapiclient.http.MAX_BATCH_LIMIT
googleapiclient.http.MAX_URI_LENGTH
-
- googleapiclient.http.__package__
googleapiclient.mimeparse.__credits__
googleapiclient.mimeparse.__email__
googleapiclient.mimeparse.__package__
googleapiclient.model.LOGGER
-
- googleapiclient.model.__package__
googleapiclient.model.dump_request_response
googleapiclient.schema.__package__
-
-
-
-
-
diff --git a/docs/epy/toc-googleapiclient-module.html b/docs/epy/toc-googleapiclient-module.html
deleted file mode 100644
index 864fc0c83a3..00000000000
--- a/docs/epy/toc-googleapiclient-module.html
+++ /dev/null
@@ -1,31 +0,0 @@
-
-
-
-
- googleapiclient
-
-
-
-
-
-Module googleapiclient
-
- Variables
- __package__
-
-
-
-
-
diff --git a/docs/epy/toc-googleapiclient._auth-module.html b/docs/epy/toc-googleapiclient._auth-module.html
deleted file mode 100644
index 1329ca1884c..00000000000
--- a/docs/epy/toc-googleapiclient._auth-module.html
+++ /dev/null
@@ -1,67 +0,0 @@
-
-
-
-
- _auth
-
-
-
-
-
-Module _auth
-
- Functions
-
-
-
-
-
-
- is_valid
-
-
- Variables
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/epy/toc-googleapiclient._helpers-module.html b/docs/epy/toc-googleapiclient._helpers-module.html
deleted file mode 100644
index 6bacd8fbb34..00000000000
--- a/docs/epy/toc-googleapiclient._helpers-module.html
+++ /dev/null
@@ -1,73 +0,0 @@
-
-
-
-
- _helpers
-
-
-
-
-
-Module _helpers
-
- Functions
-
-
-
-
- Variables
-
-
-
-
-
-
-
-
-
- logger
-
-
-
-
-
-
-
diff --git a/docs/epy/toc-googleapiclient.channel-module.html b/docs/epy/toc-googleapiclient.channel-module.html
deleted file mode 100644
index 7b78305d0ba..00000000000
--- a/docs/epy/toc-googleapiclient.channel-module.html
+++ /dev/null
@@ -1,47 +0,0 @@
-
-
-
-
- channel
-
-
-
-
-
-Module channel
-
- Classes
- Channel
Notification
Functions
-
- new_webhook_channel
notification_from_headers
Variables
- CHANNEL_PARAMS
EPOCH
X_GOOG_CHANNEL_ID
X_GOOG_MESSAGE_NUMBER
X_GOOG_RESOURCE_ID
X_GOOG_RESOURCE_STATE
X_GOOG_RESOURCE_URI
__package__
-
-
-
-
-
diff --git a/docs/epy/toc-googleapiclient.discovery-module.html b/docs/epy/toc-googleapiclient.discovery-module.html
deleted file mode 100644
index e099063d78c..00000000000
--- a/docs/epy/toc-googleapiclient.discovery-module.html
+++ /dev/null
@@ -1,141 +0,0 @@
-
-
-
-
- discovery
-
-
-
-
-
-Module discovery
-
- Classes
-
- Resource
-
-
- Functions
-
- _cast
-
-
-
-
-
-
-
-
-
-
- _urljoin
- build
build_from_document
-
- fix_method_name
key2param
Variables
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- VARNAME
-
-
-
-
- logger
-
-
-
-
-
-
diff --git a/docs/epy/toc-googleapiclient.discovery_cache-module.html b/docs/epy/toc-googleapiclient.discovery_cache-module.html
deleted file mode 100644
index 37ee8f00080..00000000000
--- a/docs/epy/toc-googleapiclient.discovery_cache-module.html
+++ /dev/null
@@ -1,35 +0,0 @@
-
-
-
-
- discovery_cache
-
-
-
-
-
-Module discovery_cache
-
- Functions
- autodetect
Variables
- DISCOVERY_DOC_MAX_AGE
LOGGER
__package__
-
-
-
-
-
diff --git a/docs/epy/toc-googleapiclient.discovery_cache.appengine_memcache-module.html b/docs/epy/toc-googleapiclient.discovery_cache.appengine_memcache-module.html
deleted file mode 100644
index f8a098d7e89..00000000000
--- a/docs/epy/toc-googleapiclient.discovery_cache.appengine_memcache-module.html
+++ /dev/null
@@ -1,35 +0,0 @@
-
-
-
-
- appengine_memcache
-
-
-
-
-
-Module appengine_memcache
-
- Classes
- Cache
Variables
- LOGGER
NAMESPACE
cache
-
-
-
-
-
diff --git a/docs/epy/toc-googleapiclient.discovery_cache.base-module.html b/docs/epy/toc-googleapiclient.discovery_cache.base-module.html
deleted file mode 100644
index 80841a0ec12..00000000000
--- a/docs/epy/toc-googleapiclient.discovery_cache.base-module.html
+++ /dev/null
@@ -1,33 +0,0 @@
-
-
-
-
- base
-
-
-
-
-
-Module base
-
- Classes
- Cache
Variables
- __package__
-
-
-
-
-
diff --git a/docs/epy/toc-googleapiclient.discovery_cache.file_cache-module.html b/docs/epy/toc-googleapiclient.discovery_cache.file_cache-module.html
deleted file mode 100644
index 43bf6a2090e..00000000000
--- a/docs/epy/toc-googleapiclient.discovery_cache.file_cache-module.html
+++ /dev/null
@@ -1,43 +0,0 @@
-
-
-
-
- file_cache
-
-
-
-
-
-Module file_cache
-
- Classes
- Cache
Functions
-
-
- Variables
- EPOCH
FILENAME
LOGGER
cache
-
-
-
-
-
diff --git a/docs/epy/toc-googleapiclient.errors-module.html b/docs/epy/toc-googleapiclient.errors-module.html
deleted file mode 100644
index da2af5eb093..00000000000
--- a/docs/epy/toc-googleapiclient.errors-module.html
+++ /dev/null
@@ -1,46 +0,0 @@
-
-
-
-
- errors
-
-
-
-
-
-Module errors
-
- Classes
- BatchError
Error
HttpError
InvalidChunkSizeError
InvalidJsonError
InvalidNotificationError
MediaUploadSizeError
ResumableUploadError
UnacceptableMimeTypeError
UnexpectedBodyError
UnexpectedMethodError
UnknownApiNameOrVersion
UnknownFileType
UnknownLinkType
Variables
- __package__
-
-
-
-
-
diff --git a/docs/epy/toc-googleapiclient.http-module.html b/docs/epy/toc-googleapiclient.http-module.html
deleted file mode 100644
index 2bb0f69fed0..00000000000
--- a/docs/epy/toc-googleapiclient.http-module.html
+++ /dev/null
@@ -1,70 +0,0 @@
-
-
-
-
- http
-
-
-
-
-
-Module http
-
- Classes
- BatchHttpRequest
HttpMock
HttpMockSequence
HttpRequest
HttpRequestMock
MediaDownloadProgress
MediaFileUpload
MediaInMemoryUpload
MediaIoBaseDownload
MediaIoBaseUpload
MediaUpload
MediaUploadProgress
RequestMockBuilder
- Functions
-
-
- build_http
set_user_agent
tunnel_patch
Variables
- ConnectionError
DEFAULT_CHUNK_SIZE
DEFAULT_HTTP_TIMEOUT_SEC
LOGGER
MAX_BATCH_LIMIT
MAX_URI_LENGTH
-
- __package__
-
-
-
-
-
diff --git a/docs/epy/toc-googleapiclient.mimeparse-module.html b/docs/epy/toc-googleapiclient.mimeparse-module.html
deleted file mode 100644
index 020de8a2b50..00000000000
--- a/docs/epy/toc-googleapiclient.mimeparse-module.html
+++ /dev/null
@@ -1,43 +0,0 @@
-
-
-
-
- mimeparse
-
-
-
-
-
-Module mimeparse
-
- Functions
-
- best_match
fitness_and_quality_parsed
parse_media_range
parse_mime_type
quality
quality_parsed
Variables
- __credits__
__email__
__package__
-
-
-
-
-
diff --git a/docs/epy/toc-googleapiclient.model-module.html b/docs/epy/toc-googleapiclient.model-module.html
deleted file mode 100644
index dc1edcb5a33..00000000000
--- a/docs/epy/toc-googleapiclient.model-module.html
+++ /dev/null
@@ -1,51 +0,0 @@
-
-
-
-
- model
-
-
-
-
-
-Module model
-
- Classes
- BaseModel
JsonModel
MediaModel
Model
ProtocolBufferModel
RawModel
Functions
-
- makepatch
Variables
- LOGGER
-
- __package__
dump_request_response
-
-
-
-
-
diff --git a/docs/epy/toc-googleapiclient.sample_tools-module.html b/docs/epy/toc-googleapiclient.sample_tools-module.html
deleted file mode 100644
index d45c2fa9e95..00000000000
--- a/docs/epy/toc-googleapiclient.sample_tools-module.html
+++ /dev/null
@@ -1,31 +0,0 @@
-
-
-
-
- sample_tools
-
-
-
-
-
-Module sample_tools
-
- Functions
- init
-
-
-
-
-
diff --git a/docs/epy/toc-googleapiclient.schema-module.html b/docs/epy/toc-googleapiclient.schema-module.html
deleted file mode 100644
index 3762e30563e..00000000000
--- a/docs/epy/toc-googleapiclient.schema-module.html
+++ /dev/null
@@ -1,36 +0,0 @@
-
-
-
-
- schema
-
-
-
-
-
-Module schema
-
- Classes
- Schemas
- Variables
- __package__
-
-
-
-
-
diff --git a/docs/epy/toc.html b/docs/epy/toc.html
deleted file mode 100644
index ac8c6d61560..00000000000
--- a/docs/epy/toc.html
+++ /dev/null
@@ -1,51 +0,0 @@
-
-
-
-
- Table of Contents
-
-
-
-
-
-Table of Contents
-
- Everything
-
- Modules
- googleapiclient
-
- googleapiclient.channel
googleapiclient.discovery
googleapiclient.discovery_cache
googleapiclient.discovery_cache.appengine_memcache
googleapiclient.discovery_cache.base
googleapiclient.discovery_cache.file_cache
googleapiclient.errors
googleapiclient.http
googleapiclient.mimeparse
googleapiclient.model
googleapiclient.sample_tools
googleapiclient.schema
-
-
-
-
-
diff --git a/docs/epy/uml_class_diagram_for_googleap.gif b/docs/epy/uml_class_diagram_for_googleap.gif
deleted file mode 100644
index 55249e0a86284e21c6b46377a607ffeb058025fe..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001
literal 13024
zcmcgw^*>C>E!(=k2W%`_9IkLf(dX^!b;r`ryv*>rdJFdN3g*rsOR_vfGZ
zzJ7i^UiEmz^Yzr!){vHQTm|4`{{aASv2o)P;`CJ1Mu$g{D)P42xTAuDlqes-~(xD~_6y1Q{Gyg$O(z9u4#lT&>CJFDij!
z<6_d`7t5<==4SG;@^O^ZdOCVJ_GWRewor4kl3jI68@i4e<&sezFJeICo5sAq1GQ9IGdHzlmf@(<;1Ztl|%)Wh)I~K$XERr
za|&{{p$TfDrzQp&%|pg{+V0lm#1WA+r6Vu4cbiPi0zyPaSzL@YO)eYO6rnum;^uP!_Vs+ehA5bmZxXoPG-CNyCsM?sFVZ@8+SGZULq^M
z+fvfh&}3_Ei^V+tgr6A>o1X#sM1gyO-II&
zkzDNWHkq3}JU)=%;a-2c!1%zJXsJibkjL-(XUj^e4D{lBU`_V6RS9u%c(_Pf>WAOg
zIYJO53)5`Pf9+u_FD5}vNxfQAf=Q2qyF!^5m`I37X3KK)WaUeu;ASdnah_041||qQ
zXHIaSt&Sed+$_f*rl%-xrlE%Pfk6%Q`ty)#|0#zDO7KJAPPS@N694`^0{$Nbe2a?(
z0PFxD|MU63nE((x0;~v`w9u%bSOO}3+evi!NFq6hPKj1)#aJqxxaaO@>fG@jK?X?SUlw!G=4hW-{Dz&ot?WQsHE447I~q6MI*g<+>vlG6wY#r0{Pi5hF>f|Knl9DtYT4@xz522@)Ajbl
z`#_Iw8X}PIJ_tZUpVtQ*JmNFT^7N7iwjNCs{2_`umln61DG=8SCsEhVSuqw%YAFdN
z;-N2dUf9#?ZilVszr2sn`YPmZX%#q8!;Jaiy~uP;y+h66L(4n%Eyq~wQ`q%cQZ01R
z8B3N_f35scw^lL#kK06EE7lFdWttW|=8#rE8J`8Tq}`u*^Wxt-;NB>fO9?E`Wf7mm
z_`*n!Rv3fUpymLe)MB4#NS8Ys1C&&$so>=#@#H#M7EmphjJ=mb^ha?Xv_|Br)MXA=
zM=8db8z-bF6mZ}$wx!|V=m820HV9NUt{0hxH=hAXY1q9QfI#qU4){LJUTF}X3S~}
z(O^}xdBj)D>L;+C?PqWbOTL`DCKkd9aOH&l(snNNw$NwWw6-vYJJ!Fri6S3Z3?ITH
zy~2Ws3~l=}o>JpIk^jJ5sT^Eqn`|ITh%sGN)`q{5=4%>fim(-K^=2qOv$es1Ks=UJ
z5YS9mPk-Aq&jvDoK>pAsK(fpsbBJMVcBp+pDIj8F@fp7N)pGD*fA+kjGZs)J2lr|G
zs+mnGX#KhP*IzKs0MDNr(0m2kO@(SK00h?c_4khNgy5guzzy#|d!Z-Ie;#+5;nBI<
z5%@wk2XP=DX-H&%>+d6^^Jk2K(Nm$@V}FG*)8ibscio?)9b0Zs>;s~*Pf+<$ZKqP1
zK6hW*%I&ER5+{W2FEA^m-A3q*miur0-yXbkr8hua-!>?R7}pVIh=KIz#@&@pZ%j2kYG?{N&$t4tmnFy7}k>nXvRx_^iOS`6|7EDs-n?n|{n%-
zu#hE6O@N)eM8`!upZVblJ72uMrpJmqMd;BMLwBq&3@jw@xCpJs98N_V1eo*oGPE33
z2!!h&5=;9&$@!c?YB)P&fxCw-OImMWkB47j%FEk-bcCz5Tazj*N+!XJ1}0#maOEQw
z8CDCHd7G}^d~S2?6+^f1V$SV`Q%VcpIDwyIaDuj~^**|+gn46%
z$8UH=!J1PnqdZu4r?H~%Fl8*GzEpPc^`ss_qV75{lOxn^Co`w4#1Uq+x>;r8E*3LcKS3fFNL%sY(dG_2D$^QozRY^pvN*VE9{+3_LrRk_08V#i8i^X!Cg(~
z-a1jlwkw1nuF*8o{at4HMKRQ
zF=cXkaHoI)$Bn6}tu!TF4{!nQBMSgj5e}ET^5@hUNe4e|mZxq#8lsu%J!epjBjeXr
z2bHW?XUECg@o#N)IGJAtYHF&82~8*@Kl)jo=}M>vkpZNgo_3K}fqyxW3DQ|em~Xlo
zAHB_4SK}%$OXimB$#QHhaS_CioRJEZsiz^uQx*NT<)P&*U4!NQORk6hOJj0&$pt1yie+F!YofO_f7{hIFy#z;gt(HS
zl)CP{OuTWdj@ieZ7^-2y`54#hvOmqPN|~e(N3dDBsY9J=&)j)WG=1Ez)G4)W%E!qR
zSe<@kew&xV7pP#P)j!cukd&i&&HnY8^WQl=uW-}YFFCb}zy>42Z$g#q9UI#k`R_~l
zA$6U781{QFyJz~}Bffdb{A^MdeU#F*0K4`%MG1zDZ%xm2jR&>3f2EVXB05VF;Ql1K
z(Ct8Y@$G2-6FOOP)`^kWTEa~>=oj!CRNQ$h+a$DdmV$>x0~Z)CkzU|GkW
zrT(_U$s6y5deGU>3#ePkmL}pirr7%{yGP&76yBeV$;fZza^d=TRf^}>8t{|n$UBDo
zfr|#a?_*a>;iPqRxZlS5m(<@LUxaLRaYThF{(M{Yr|rYw$BvBDkNeS2LvByEK97m6
zgAt^#7>XyYNtzF6N~)`)KD7Oan255dw5TlX2!a5l)prhU8zmNQr>TRBvb$oq{;crMIV8NPcvB7Y{{>Q9uIPz~|e
zic+!opzTr-$Y|i}=|eeG9V-b`8`gP44Jtoo7`~Pa!l%TkfNxZJ6)fw|(i(g;GZ^gj
z`U?yX9P$87;+^n-s%b%i2)-q1(1HX^uqL`XM4_-N>eSVn;gdIE2atHp=m{{EGB+kv
zS$H>(R0V)o`vK$L#JM(!HXSr%`ed9}8zp5SfTL-KcOp#i$5a{k^64jEMgn2;Q=wKP
z65%Y;F<*x1VaU9Su;4Ef4DEB>&4B5|fanfm$cecxmxW)szj&>MKZT`?1#`(Fw$Y$6
z>xMA>#Pb&i&*`b6A6?p`S-~Mn`Shw2(&<5=Rwwkj7FM|yQieRq3L%WoC#)@Mlj#ye
zRw|QN{6Z?+#j7?cYC=03pCqf>t
zgx`JeA6k6OW;w)JBOt=@!&#%l6YI&Q$0Axg#lZywyOr>jrm{7(DWuObLeV+8eCbkQ
zIYzhSq=46ER%zwrxt3GpRT;Roi@9qB#CBmsW+Jbxtnx^V(;6M}JkQA8d-8nh$-Qs$
z{H@6SWb%Wp@`L&ELkshLdh+4*c~Q6dF7yS6IBYi(2_)
z4%+E*TIs0S^dx@7L}x1WOv!d`QP{*3e{H9094dZCSn>*7GNoOD_9$u7mKyPp8jxX}
ze>?*%YNw)1OPKsh(qfq&mYELym{%Q{KV~xTEHRJ$U_Oyy3Ct|b4T$2&Q4v@z+c(w~
zl7QO+7#b7RvvJB8!DUEOwhvuwY))Wee(-i1nE5A|jFSBr45CI+Z{uh$y!c}w9atI|*v1pb&I_*)e6=iSA`6Tc16?P(ZaWi9G=|R16jfrTK`$Mg#aTM>NhEcGFGdLDik=Ln{4@-G*R-p)oB2SeWi0{a2qJ_
zdZq7%g$-9la7RS2K8g^U*0hC-JfRXTx+~s=K1WACj}*Z|$a**e8Te~`va%cKTN_Xu
z;smEn`N5#Yh6)THXgY;r_D)92RAQ$=B6O))*`hhnuNjot{ANVbJhmmGyyYkbbnHp-
zdAsH4u7#$RWgy_~P0`!CZ7DzoUga(Do&k+5hmKu&tH=MAKn{4VLvdMzZt6x;EuqN-
zQpg1;DCJrMELti2TIq^|8Hg#Ec3NNjX?;S`#x57cc}|Yk@a8+=Bg>z96~ayj(%%lp
z<&Hd!GJHGacwfqyj=&7E8p9c2+aJ!#Qc!xOiqB!~Ioa(bt?h=CTsl803#jW}(z;=-{n!4_499GHgW!=|-&)A@2WcWt{csuInS}Z1A(3!m55yo3r
z>S@Bo)>Y97v?;&@_etyZksCCM7@s!|@;ABMcQNp&#m-2_Hq#||9C|IWO4s=U;pe*|NMRbBICd~F@Vw+jd}F4=@cMuj~I}i>1fbt-ev6F
z?`t~n0`*yePQ2)%L1BoecENt7udv>)Gmr)-!~Kj&p#b7YB|>L%P!5XP0>w-gEnN)2
z$;Waz7X|(+rnYbh4agj5`q49E1)4bv{d;8}N})v0R2mI_@8?Jz4}DL&h;18Rzty$5wMM+)&a?iYV=oonz&K2y`
zR_lbBaC*1IKw$3Z=jTYT;mp#69tHqS^x%(Hi$q2n{EIH4mbN5IgRoCaWB!+8VeW7R
z*g)n9C+i)!6g(Q4skzwYvcjXKUL6~-3w6$enxdf<7gG@roFBWCMxSCQ(SasbC#%^T
z%ajOpjPU(q1}P54+L2LCkSTy#z1lV>);j1i-~D>S^-p5eU7}m~xZ9l@eb^7+s_mTd
zFN~l(u=!!y)EB#)5|j=BB@AK_I$#410LNlF^+Pj(6wO3(<3Fs&MSpd~WHFERgD43M
zx?E#=J7+z^W9rs{4db4mf@vcaQ!l_ILJyQcFkjsU)S&~3I&^G}&j%>OSV=!
zb^b<9!7sff=zOHKd{7VXl7}9>?Zv$Rx-DxxU`zp|FO=};d)Whq#N(;w=bR+y0RUpN
zr8Yg##qSv(hW9xs-K?cTQGUJ(>hZ*yW|lX~F*Ex2>n~%x=(&tYtOwRMY%5L4v3y2F
z1PAfN$m3opk02ahRB
z;5+bxK0nU$^3_t
zUvIW%YHf!S%jVwD>2I_aPHul-1Pv?UbeHa+QQ)4m9gzc2*WOOn+|Iz?ol?4Y0hh@b
z{dbehHst*Sb9>SYk8?{)e`Qwe_VOE-NObo$n>$1I_9g@N4g}u~!sX8yXTLU*kRj1W
ze?hdiQW=T+Ey`B%v-{i3t-Fy6P}R|&krs}Sw_lmxtXz(pqQ(RL#)VQKU&9MF=6jeE&@Lna05hlJdK*Y>T-7zGyW$3_K$a~M0Rx;qLb}!0Km68
zhO*O1r_&S-dnMp?3-h8W@Hz=xrrT?gXsOjfEgP40C7pLhf9aaj=z8yOByJh|F(H;p
zaux9Im{C{!F^@>dl$2P<4g~A#db8cNQ}yYk;+kHm?{oKtQ>fo>?*X(dYvSI9RZ@2X
zs@rO;+iKqrp#XfPkSGEYJC)eZOy5}Xv`osSZ;bp>tpGgem3`|?*Z%cOGpT{;iewnY
z?(p9oses*t^4(7RosZ1>;bd*Mb{DQx2h(JI6ZUOW`xh@pE|wol7h2ku?7!-&e%(%Q
z*l20rnwLIl1}#4ie9^wYXR{xExeulKa4ZytH2rY)xEGoE*?#21_ZGS$3#or!zpm>Z
zlJBeHDS`;*MTpAY5Pila`FtR$>r83jga-Zag%NbPfq?(o2tFK02wbk?Pp$v`s;?_9
zI6tM8`uH(tw|!dVh}rWJYzZkizC&DBMqCM@8rL~6?&Co{wmG&
zrz%m0ykZUD$484DH#L^)Y4|dt<)g8ew(0rDL)VUgybkTCuF;l-7i6DkI6s-ObU4a(
z`b2etHa}4(d9`U=ncCNw`}|Ja_jA8r0GaM%HDSep*?x%s%i(
z$a}Ptr!I!IE8tld|9}t0*YBYU@kD=4VxrDmbWTxsH?JB`O*U8azn`MuWIw&7UsuJzJrf9623V)xyK2rz&V^r;C4IS=MgNyD8c_Bejjqk1Mk0(v$;SCgz
zOt26g18=}xlZVX(*mAuYl)}YWoV&G3gygz$;!WX!iB?D(Q;uQB(-m1mslI7%=G2&y
zV1W#FMa&TNcY{f7m6mzDW3Z1>oQp=7Y22rF#aY$rd6p6wnM6hT@wFyks$fXzdr8=q
zv&S1$9GhxV5<3yVcH1!<;ov@!K}h2FgIKE|fPVhzulwvA8xMC63
zw^Io7pNpg9GZ4-s}5>@W?$dbV0om`5PRJYOOpiB+j5EW5+l@g{WBd+Wy!n6%U&#KKBKut9h|xUg$e)WoLfiBkX_OeZ9do|-I%6@rZ5
zmZou~8MJQ&%Cd9wFjbJi+Hv?ZfacmrfY3TN8&P+rY^d0dVv{#iEIuOc>@09dk!ibx
zl4%e!T0l{l+CfHkR=vd@@m)Q6y~rl@C|;TOLMPR>%{!!x!ef1oOegQSg|H%BSG$4xbiT)
zVd!Vuph;nKq=I{
zIh>8afGf&7_frHg!y+q4@dc$yU5RBq)#ko6-;lL{f9{fGGQ>IO-}-j5c!ueK044h{
zL_tVY*M1bSfnw95>1%~Q2Q#dGW-fFO(XS1TREfMFnQ+SqwFuPa!5NhMsu_BtFT>_4
zOJc~YP;`z2>ZV2%skRb8I(=mgOyv?a3_AFu!yu%+d@ZZ!no}!qicNuzS-H+}=++S}
z2%w`ZuETvRrhlmCVZD-*UX_N0NR1Crad_?iyiQdgY@ElQMA@(uPiUabcxgjQ4ZnG7
zy7tAWtO&bKO`YEqNc7x>j;*nbKppfYU20U!Tq+~CnfI8Vhzc;sP=Us~aRC6P7vr$y
zMK$d8!FK0&w4S5tLILIH7GEgy8VTIp3_?bDD%
z!zd@UH=I3g&&qEXLWx#Ucwl!EhY+JEZV9)V`!X*`Vs@}gIy*@LF;i}Og{)(d
zp-3-f;&4XgZ6>p(S4dwbWp$ZmWvv%et8996V6W+J(TmrvL2T!xtfRvS)~?sr3rr%<
z=T+rVK1=fSzaXE2a!WXxxA};{IH}GTY7v4pX%OcIrYvg}dLrWtqmOkuW7`Ii{AO+5
z&Xq@-4NLFZn~~nf9O7r>hh&YG6Z}J*GeQ47appa_kQVNbYc|EXzhSlUMZ%8jLSJPy
zbEj+PyAU2)g&Plex~Pdc6GwpR;YdECssgcEkX
z2+uY3vc*9=0h^?;dAj}Xf<#2YOouWC1;Y@`kNBZ{N7A?HBg|1h5a5jir2Mpig^ZSp
zA`wNhE$*1g)Rg*@KZlQL7&WI=8Na@ogQYZEV35$dC~}9(WMs*bV{VGvvL$PoW@DaR
zm~8sFB||sKlV9N;P4zDTm6TM@TXox$<={IMO^JPcxJpNvVSB$qwPKH*G_XB-{KDmH
z$4rDe?d6I4+S!;3_~e=oywQ)myFW
zOHM8?ebnJ;=kXOePy~4}nV_YC#GT4!Bku2&*k4|bpweM2xzW|SGDL&wo-*}Y-xY63
z4`rd^(TVi!(KnH=8%~Uns$iStVo4{rWPL6zan3d!J(HF`^o6T4V_Tyi`vHW>MrxUM
zQM%?US&1*V_+!r!(n6V|$L-u_ZJvQcM*C0iz?e1l%;m=W>a~Ev2yLxlY<|*IbLt|m
zBw^UFV>;)JFDtfCj7^(WN-#+I=OC7s4O4cSWA{iSl^^mY<-(vjDm22%9w9R8NYzMJ
z*sGhtK$E?i0XO>Lnuezn7X(hI>
z;Bc|Z7y7II!fz;|vF?$}yxyC4pen`nq4eNxj6qu8Pd4L)o15JC{2}(Va*`YErf8nGidTy%q-Pl{(E>P``7(g$h3I_2!A3k2
z>O4P5iZ6}C^-{6X0>j}bEczU{dC|a-9=vOhr>3g|cxII)bc3Q@RTfyh6
zEE_oZU8f-4gU(h(*q&YZjW`5FJZkd56)D3tFg&WC2hX9y0aq$iBHGs$*oR
zH&vA@>Ra#bEuZWyKkTK13^+hZTg92$RL3RFG~TB&*yd=om5+N;7kiCrG%k&M>lOK2
zYfL1MMiOaux1wJua|=a_#k2KKiT5|P$_p9wzbN6pxJ!XrYsO~uBT@ZTJ@U9IT
zA!}cFFBlu*akQbrKZ1z=fjhYnu5rlJCc@bM7^+5UM)er=Gn2&r|uWFWWv;0v$Cp$WBJSMJa
ztg2$evxzTbw)2448dkHyhG`Ckh*W)v7OX++0tkb-C
z>9h^O#0&u+P^-exm@^gu3#H*y6-)aeA9A6Wx+!1dP`Jcl%DYA{U@Bg@tdJ|c5}%>{
z*=t}U0I^v-usy@~VX19!b0r(sj96M+Ua&z{l|L7gv@)Z$nXRx*m90KD#Y4KRA=miK
zxe%PzL$W!2|M8s)_OnZl_b9V;W3P1Wi1#E~@9Rj`8p2oN-Bq8HzQ4o)P+6JkU#$YD
zn|ezcjf
zkHjQwrunI-MZAc?D(6Vd+9)qlU!Y=$*HJJKGc5UK?kUkGvT}njS~);}M3!_p#Y-sm
zoG@f>$U|mSdQ=UOHhii^D?d7Nq%!gKc;r+JqGXn2S8Zi5y7gOa3$QC=vb&H+Jf`?O
zNoSP~SiOnh+A@$YFbwSBo811UqFH*iQ2nU0
z7%0&yBj%qv7tNq7m`vf+)^ahEI%ip{(^yw%*!>DNk|Zy?)?Tf9-d=>k+`Zq{-?$sJ
zyS-#*=Ur!IpTXT+|K`%M__JdnXcswSzc-*9XgeDTCZ
z-J`BWS*vpz+Y7E1Rh=sJhVF-;7KJ#WtZX3zu@C3od%=EOmRZ$R%)+?8t;_BgDyOCK
z$23^?k~&Cix%r0|
z!ojvGtGOl83tq-nS-KA2E>x4x9V+emNW{5b_Yl>olM;XHc|PkcX3fQ|7ob@xuCN%>5+k#mKz&nknqVsmtpiu|ISKyYC9Nn40
zuYQpxh;nYp;kW+8`YT%pbEjYb?v2`v&Rw6U+1IoO)9FVJRG5q=;AX!)E)K())IqIR
z!wIPsa*w|+cLUBU2M-rZLoM3}-_8$O;y~Zy4GA&Ks@GJ$iqao10b_6hlT~w5v*1;X
z-pc^beCA282SiI~?h#yn90ar+o*!i~t6?=80{366QVXJ@POTC88^e}gpff_fb8FLc
zIl=R?YN<9T=O>Q&
z6Mwt22CLH%zNp3FPx=iz`9GcL+`=j?Z}SpwGed6+o?ff|
zh%TPEE!ns&J-IFW6IS*r8lODw4bNT0)9_MFTqV?P#t(pHMnY}kU0wcNeeGRC*Inbp
zUDL*0vv7ULAAkos77e;@<+*Qrdf%>jkFmJ#aJ%pP9v=Abu9GJM;G59;D$Y$hLKpxL
zS&R@t<5*_IwdN;iW<<2HCb*s64~IlB{|ZN2z~xYM0_6973-<$t@IerK_!V4E`r&c(
z!vp5keZcGc34DO(Cax|)#PrkqckdqtLH9%d9_ByXFW^UxCq_(IzySbk1G)Zy>e#KXo0oOCdu_cRi810>ZV_E7q(b`U45mEflIu=OO~{WR9a9ak;`$9pl_
zWf8F46}dF=cNiZ)YZ+(mfF*~5AAq8cy5JvQ`ww@;IVHt$F9HltfieIBz;co89ReA{
z1GUe<3jGWO(1{e!ODq8{%&83D`}CkcUUE!ku>MD#y8Psv&f&LcgPr~4nk^7f(4z7%
z9=TBJ2xPF4<^@EHQVifvfLbzRkPD6^K}x7_QY+moCQb+j5Vw0%vi2K)GK*t^Eg;y
z1!7d2X(c6DBh!E@vs6us=!*L0k_~R{z6Oi-veZ8k2BpD1SOIv{jwW*4M63z9Hy@qk
zWTNALc6<1Lni@HxNO?s(s+Xwu2-MS6>^!gI&b
zW-s4|Q8Uq%Qn$}ajKKW}U0Cc~HQ7r5Kh$|jxBQZ&#>lCXnIBid1#H2jcQ+q(o_v$$
z%v5JcHhrzce_NTMDSOMAqa`H6l`W|r#+7Hluf>(WYgNcq;5gjrlJC+$JIwvAu7|tW
zyZ4s6#BW-Lr!;7rFdEnOi^m2Q;O3SG6++KnM7Y!8?D&yzgtrrb+$R&eh=auUQ8P5$D~<
z*d8rfNPq(sd8uW{rr;WSsFihM~EpviCN7rXBe4c}_
zoR;^b*zgrGg3!1@;eF=uWIQsQcoM?(JnPGxCkd4LtTPf9!@>(g%LHOG*M14iPqr>+
zQj-;8E15INO=pEkLNWd`q#Rs>sWH2piBb%ZN~~p}h*e^)F-UnU^T2}%iFnr!nqRAe
zQJJ&iN|KlAK2&dzZCQKTYMJU?&|gU6Iluvum}IKFotZvjRF6Ga+62jAuSJz+M)f>!
zX#)HqXGz0f+CGFTl8r-G5H@qE&Z*Cdkp9$lowca)aqCijIM|4!E1xwtC{NsK$|;c;
zKu4OuLjn-$W^O*MQWj0V!AjtQ6n&zw&g`mwq_t@m|E?#lpdF87ig9SS;#u6ed>()w
zaeB9dzTez)t4MQw!yE-zjMHqsdGtA8h`oHLnY9{<_$sGr4=Bv-DTN&mT=f%BYy}&T`S|altZVmvk&J&6kfeT6>oYOT&ol2N~oFYElEx*E+VC$=%jJ+gwJV>G|litLl
zM|a0Du@7}}5+x~N%d4FGAFB!pEfJ5QZGb7@#D(WdWahjHc!4=@{vs1Yy4q0`Gc^1R
zTLhZSqpSp2JPG3FNiQ5i@kB7|@9EbrPBmm~o=oCR2xpuoWky~naiEQnTET)|vnVGn
zo9ha?xk+5^nM#&+PJBzw1+BIMjixfcx9k=EcI7EqbPTSXqFQ=p{s(FTmzFbEdz3mS
zG9X0wkfb%)iqn|d=N|hFJuL;QqFw$E63+ufy*zb_wvba&J$!sGqprAEqT?l&>*s^o
z+DpH|dE`IxErcz%mmNdgbjc25B7e5Od3@ke!r@
zrDPLK1?>Q@hIqqLnm?wJ-2Nkyh*?F6RkUV{+Eh{0-ZVz-J!%tsG$aH;?Nt;-QPir@qOtdmO6|RU
zi&||-@80*5-yiThkIsY7Ip=!4&pEGiUe~3rsV4K-PK87QcnJW2fFN`%+5-sc?e6t3
z(vcGr?2Sev>>YbcN}KE*Re&HJEgd!%2818tY<+XFp(*1YcY7MTw7e9qAXgfV*zE2t
zRaU{5XN;z0a05Zyyxa&z2DGzfqMzg8G@govswp`}_9$5-W-Mk2!h%_%Ek
zsih)#m+kE0Z1HpZS%0sGxn;hXM0;L7TurXp2tHbvi1zZx5A<*}(qRCCRAeQZ62hq{
zK;iaq?t9$T3E_+784|qQ8GasYbPP>d8Q~OEj#?@z|HLOGj#gDSz4VY17UX7O*c={B
zq+>{Y>3BH5Se=}hAL_AKmEZ1%xc+^8*x4R#4NsJn!xv_R+dEPLL8B!ZXZwen4W;c_
z8P&DbmdYyCvEij!I{1=O^h*y08mi6D?bqX@2y=LEUZUkco#vLKdHE8;f{83_`H|u6
zk>MFx83+n04-=hsXUmKSg6&!8>VKe=|A9gucK71b(CC-{$RMt#@l9!H9c2|q6Zqot
zqT^jQOJTwMXmq};oWwsF3E`IJme<3hO=%hUs%kV4bbWe;rl1-vDcx*t>MhJq^m6Qt
zL?HfQ1cC&4|ItXa)YB2X$96V68t!Z<@qjzyA2&S}6)8dPyZ?kC80e@F*6`}8Y7hj}
z8;fpoc0AkOTx@RI?C&jAQyI<5IQ)iR>}=1MlBhO;voSLCCMPy|d2Ei4CNeS{E-x=_`lQq@0|cZi2z@6HjTQXE)Re^
zYtCm0Y?=+FL+Sj_t1O2a%0{w99ES5X8_UPu$oTIs4mG}?c&mt_VApD@n0lv?{=jOu
zsdDDM!Mk;%DW{Ct4`z)omxe!mnEPnklfbUs>|vs4^e&JD*IcvE;vu
zya#fe7a#j=jp&Jg474O4$f5)})AwK8r~E{hV_V(t$cy#e_)I<5S-^VgPSA1UGo?Bh
zIa}g^`d3KEEd=z=N)n%9YT*~m_XxJWgj0~l9?jb#kFGUR3!b~EiT5@Wq~JSdioJG}
zj{%8Y@l=ITb>vcS5k3pN47Sl@fp0q{{~yq$P^oau4+$q4xla{C(}
z-h)Jy=DVX3iNM5aCEr_%V7J|Li=u545|rv=r%Y4lHm7VIg?XhMhpdqD05|J8=QrN{
zk6jAZJbby+h-yxdVLr5>XqRUlt#l5r29-1RuIIFDP7Tkla<}c852oBU)mGVzFR+)n
z%XTtHDN0yh(GD9Pd*Zyv94IpB1lmY8?EduK>q}qtr)8~0-xnFNA8IX*_aD|B(mYYB
zAMi>&WE}CDI&7Q*iX1V{etyYZtx3^OB2cWtruEh$heVMP6%ZY5cS~E&mz;|BBIYH@
z8!n(-DCh0>;+c8%U_OmqBV@pmb2bOShLDzYOMzhb--zf$yXpYlW&98p^CIztk;R|N
zcZw6MBUTxmo7gZ6sB4d57ydeYY>?}l2D1B_U*Gqrn3HRf@jIou2*;RAa?bCj>F;Lc3w?ro-Bge@gqi4OVjcLE|sRf^F2FpRP36$O$Ve+<9|
z)g2aYXMVR-B#~mMSoY)IRY?Kg;UIKdXIj|y#QT25A!!(%qWxl50h7p%i^T=HKZl>x
z&Dq+m)@z^q=p=n4chmo@@HA&fu1irr6yLb~&1~nhSxEUU4UN|{1Sy&yzCiY}U&=gw
zNOB4)NHpD|GP%NSjKQ%hC1_PQZ=1eU!;Bp8p%F~cUqs0*$xi6F
zpjR~CvD`-WZw4nNDx~W9&A0Z;mZv5+hTLZhxu?FQf>Q~k+C&g#*yaB-xytp+z3)wE0roU@xgnAf*D!F
zw2Cb10lv5}6>OC9jubJd#NB`+0putdhLsQ$_^L)De>dhh9~!i2(ef?CDVJ>2F*Y~#
z2_@v=MRwZxHA~-#7ye3oC$b2nkX3@+Zl!V-d-q*4NLDR#Ttzm)A%A0?`|WGGellld
z{wBr1^MrEzd#+Ty-`}#6E^Y^?wznzDXxPPGdVUPkmEU__{QGtmk(N>E8Yd3G2~mXG
zQx(XNkU45RV~sVgX5=}LifGFb_lXwCygIPzku~Y?bIeEmf(Xd?MrqihDp7qO>};Y5
zT|PkiUBzg<`(I|d^`!1+ZdJR=|M`wZn>3~Jc)C6GGsiC*fBH~B)Nr?2fD`(q?lqQq
zy8H}XNZmAP;r-<4&3cGGk0n~g^z%}wR{-_B0!j~M
zkK$EDZrdp8>>8;0!FQm7anmwwQiTdCmrrVcPmHmQ>C5`sQQ$52ewpG`U>*PmVxdG*
z$_#6=Bl+JkEWSswP#B6C@IPY@wbfV)5}RN8p;$`)UNIE_U}*pY##25D5h$#0
z-Q)bG;iD5YE;UQs=fC0N^|SA#v<-2FRpE
zS+IOXJIhaUFGUFJs<`a5(;Kh8UZs*k#jZp?&SSa9;z;`at?}WoePf%82xk&#tr``DIS=uK
zzUBH4H}Y<5Ve}+@^OZyPn7AJ9FR@2i?`Gf?T+xSQ@YP>aB%cV<02hgkA}yVZ{O`Tx
zaklpWcSuW&H$w$0Bg_Jp6ZN4!>cec*-798JGxK{g(ZB9QQTs;o^E+K(5Q2p0&*jn7
z(oq?B7F?GGILL=wU6beP#g&OKM$}h%knJ8rWTGLO5#yU!?5l7UErjvr=JSigxT8~1
zNun`t?ELuO`=y_u(j_fURc&@YaaiE|A6!`TcKgfi=pExpqDk0F03bO(NU3c|C^A-(
zj9KXtrg9l$Fz8cr$BuH=z?n9Hh*1xS^9#mg2SD#&2A=UMrcejQVKA7u*HZyDOo3QX
zZ0xML6R$(Jy?qPaU9U@VUra#UO!&PF(wh>p9D{h2FU?P;yY6Jn0c6a7rQ~3wir?j`6pNQTr%c&WX$DcafFPn?H15wdGb!h53?dWOkeQpQj(1RE
zyD$%OW3OLXiMO*AB(o7O40ZQ1LgIA-D~*D`XJbyXneOC7YcjtG@rn(}NzTYw;*GAU
z*LZTp3~ljBX7*HaWo;FOX4JvY9>XHS{mwu|nPc
zZY7xAbIw&B>rE$XMQJ6`2Jo?OCQ1}!y-QUpBJ_$sucpl%#cvlI7f0eBUl46e1lt1D
zY%K-?tcfj>M#?-1qGHS9A}Er;If=YoPy(kDqy<*cER)bYZI?=FpCo4A>Keq9@~}M~
z){Lb2W(d%5$e3!%Z}?{3)e7#pl28r|e#me)+C|=H+aYlVhL?e9^}xhU4cOe0CLIgc
z(1q$wkROAE{}Ga$Hj3gIi<54@c1f3V|5>n$Bgs&P{jA6j%SGtN8~?g;Vc2_3DVy5!
zT#lE;g?||KCFn^TJw?kUh|>qwECO*@oB1!Y+Nz41@%G0JSJ>*KyP)bX|
zEW4+|$e{Xm5)~T-tkr-$eNhMueObfvGGFuMAUY$ym?zGV6rv8(-YbWHwv+z+(kM5B
z_!XWRrvxZ|4C6N7lg$L559GZX4k{GQA~DOlxy;PDlNF^>NhCu$3-G%R!EBC6UP*J@
z(s-BpIVW+bc)qj>GgLLRSrtwGVU+trgyx4{#}6U#AKFVlAcj7aZhr74ug+n}0W#&T
zh~_3oRb!Oknen>b=B~N9Fknlr+ga{wyP7x>aOkSM-j#MQg=U#%&3KDibns&C=V$8u&R
zJeJY%$;I)DAp!~Y%5lENYd!IE{B_bS3Hy76Wv=WG)sn}vc`v59RzMifx$=^TN
zRt@;`0j%Iz@mu;&uZv6aW=hoGz+g|_k!UwcC%pa*b$x37lo;otaL{=D^GVmU)Ypck
zzfq;_Eu}H_%33dBraa;MES0UcWjRu5*0L~52Dd=tPbZ(0*w2(=9+pd}mK(rXTqt}C
z4clUTjXghS9cVc@S!5vcbOIA#!J+Rt)7rkxz0ap?{V?$Id5CUoC@iiD)@T7^SPf5p
zkY7M(dn;9GxmTG@k!8}Vmj4oodx$KmVkLLG_maG(I_zEI3yt+=PzPi;mSd(Yh9$>;j#aYMr|WEc*w(hhJcS%Qc3pU=yLQCM?u{KGY!0
zqvJnY{Q9Ey$6bAA7`A6_@#9H|^nUC~6Gnv3pMN!RQiJ2d?qkakMtJ}Rpv3L4GAHMN
zAqynha|nIDF5Gn88({r>Tm02RSBhwmyJ-k2HIO&F;VYfsQA0xz)90>C98)V!lqWb+
z9kxx|6(oZV1vJg4Hq!OM==XzD2A;2lYSaW6=koPTxb_}YkeOPDzF?I-4z5b%YGxa)
zPxCdtt}v^)45j{+a{Cu$2WiXSXD$X5ea!Kx!G|qSHr%89Cho@%i9;=--#ODIa@n8b
zTVLdLB^9SHx1=X~sA}-{DU3#)gz3C@vB^P*P(3BVN~C>l)|pzI)$u
z*WVZqi`a#+3Jx_K!pJELz7@wA1ILqd3b0)D$x4L_9^=xo4F@F+1m+abnR$~wES
zw$`5Bpo!$J#%DdfeY-{jSCbSHNov}qhV27y+N+~BoVZ>R*;jWblX99Y9`<9E`Y$Y}
zle(Ipe0~CW5k{0r5%wGi4o_vO9N22lu8CT?u-lTt@OPBi$Z(1PYv1r83OC#JGHY0J`96gzd?hulBR|omS!{MMzE=)R2#Fu)aL5!
z=gwm1G)m@v^v`Xs&Fw=7lU#&xHA0;oVJMc6T}()w8udVzk4X-3!RDU9riP=w$JmXf
zM2#gBk8Sl5UWwMmuZ^MY=2H!ESf%k9)$hE}j$Nvc3MJM|Y5E7%u`V(Tm;11vatML}
zqQ-NoB#-a*EI(IxF!`G}^r`KQ2m6Cj7;p&&BC^ldQlrV_jrJP~?_rk~8zx!LlOFtm
z(d)9x9ln=Xg28kXpRh{2oiozfo>V^Qe#)#4^@y#%XrL)n_+@
zn?a)+C1cMOXk^Cjz(OunrO@~b+lYF5-6fL5VHbJi*U}C5j$vx(j9}!fpOrT=F+R&`
z6BV+_k-MptoO5}zxyZU@bhi_3y|t~qX{N9xPGlZsVJ2;7PKkg`B(9luGS5F?w(CSE
zlgy__Y^OJErxnj9bj`~wZ(;1ZmsPom49Xwx$iXPOISqc}q(%Jq*qA$Ny1pL4b(XW7
z!g?p5f_}<;f!%d^-8|*pyk4i^`-cdFpvBzQ0@9j#vf8a`lD#H=A-p|=ci|!b8}Ry&
zL?E)yEeN}Q^A*e0ST;VEV%Pm}M$E0GmmyRPl`8hET{`Oh6z5WKlHtl1ugSFHgBx;+0PwG)m-5$$}b
zFt!e=j61h~df{kuVfvH;`G-OM_#8V);r2SoNRiURo5FhqTY<^jEU4{1=MOlVY5P+^&0U7Nrhdd
z0ImUSCMe&o_;nqh*Nf1i>!5>ml$8_SjK}BiMQCBi=PyP6ECo{7c$0vN!6mn@+c`Yi
zp8nEKxgMIhpfR}qLd*gLbKKaxrWk+ZUQJ6{m2zXFPx<{LMMK@?EQhDfUy8LAzYQBA
zRStB{{e*sb2tBTQJ>bojA25ZW(
z)a(jqnBlrg!W|*&-YcJ}5>saRND#BprbZf%Zs;Q6WK%0k$f^^~oNlL;E9tr1tLX<2
z0LVuWK`iiHgA&yk=Rw<^U88c{Y^f1u;|Jr002!;kJmUkCTC0voFssR-S%bwBlAJsf
z&ygyN#m*R3)Bh|#2OKT;y)pe^-IhOD3uc2kT6D&26_VJt3iB2@FdV41|Fc_%GX>}(
z+gs?8g_xj@#4PNP4&!vG(#+E0ug2w}EUT|3alg*2%xs)7`z#gFBP9Ln
zbbI2R{zotDLE?h)lmFUD_2o`SpXtkA2>aYp_!UlCt2{E_z!N{k4~>z3GC6oJ!=-r;
z$jV!B+lk6TY_YC~P9t|U@exucx#d*$4>Cbev1=PE2$12zLi?dRShmiqEwsNfX%(PF
zfy%d+PG84YmAY}Y4#nhoB3HsFqHj
z!$}*}VC`Gnk%(55gW|Ejd_u<^7%?V>7Y;ArHbwgCjb0YD$nSea?iV#
zW;)OBy+sMz?N@!2f*2bJMeTzF`#t!SzZ}^5Dk@cq}jZLH&C)CHh
zQi9fBhl0C=ptx-eYq9o^bPbJBg1LnO>=_fs=Nm`Ke&p}%lR>_flG73K6?=a(mP}(Ev?@ZRCZlelZ9%tXAYmkv
z(X_XVK$5LWG=Y<-+oh{u)vJ{2lL<6mJNB^Vc-?<(RMqeoxK2<8*7AJHQ8=(vM>HS+kx4@ll9v+q2X)dhe&i0pjem*
zrW~Q51pf5B%syB^iJCiI?dgNt;fOO58ev5i2AvTJ#A7nL!YCeyC04kIA0Q~#b+_F%
zn#Q$yljYI({zo1_VbHO$l?MsZ%WlLN@ry)OgBY0YgCNbS2Nm7rIxD=Ab5R^P>GBl@
zASVbwk1!>rjpgW(FJ|;C>)n(j4I-e9jEYo&Qf{#??+3)l<23}kjWDBirF^zMWRpWA
z<)^3QUW;Pc0mV2zjVO@#nO!)+mQ{B4aqo+D9utc=hRSP+C>Prv#)3FffqbrnSL>=w
z9~Yg~_v|TYZK!oKs!sPj#?
zN>B;20|1eT=g8T$zOqL*x;ozdV#u2j8jywswQLkM^RW{Zi65o((dnlYUHZ}%O=WWP
zJiUtT`r;tpLgvsw=?fnqE7?O5smMwqQ~7UtVSRv-rH3IoH|HMnPAi`u&^?>4uBP5A
z!7!F`mJobl4_Z^x*D$HIW8wU?l`G2MQ-ain#!nKesRGya#s{mbjwy0|58
z?z~b;rX4wJT{@MS{`rmQ8&o!
z@3Wl*)VTmX?3n&=wo3&zfTKN}Sl@gfW4vfAK5}={x0su4ZvIeTaP-{!&BEJ@ixxh1
zFJHdA#jXEN^zw}2l!=Z-0tQM!Q6G%5>hpP)Pa!^k{|oaDpxX{q@Evtv81-h%8}KZf
zlJ5F)@WU?Jd6go&%tDPf`~TvC!Eb#6lSSt#gX{m2gC4Fz9h7vuN-3v0S!dKKO}>(j
z-0AI+N1UgrD-$d41jhU#dvgnV4zufk02f|M{|d4E^&0v&%tc#_Zq&)!DqpL+SjRu_
zT<<;>Z-n)WoFghe&aBEjN)oEp3!t-m=WavE3TW>9QTuFaMd?>RVIW!dTtffIYb|tP
zE5|#k(dx$&4-ug>@W5TuyuYsAKP4a_B6d?};x-#DUfGUk|LUFYcAf-|>7Eb~m|Gq<*Kv*4ldj
zPqtE1E!_#lJY8MqvpMP9p*${lo3*vk@oQ$nJ7no#SrMm1yAbq4v;LN%BAY#ENB!0B
zsaNFmg7&2Qn5Vy4MIt5pfrB(fU%jnJHZ^uQsy_LMF&#gxp!lR(6qDo{O=4N`*bL+p
zEFo>6=$IFi1b_&bMXMr_(8Mwe0u+vm0TG})lZsEH0i+o~OS7n?xaix7?kckmC$sFau_TS*q3djc|wcARl=0`&Q67q@au5)5LIF8RnJnqE+uMN86nri-t%
zSUjEB4Uv<0kYD_KP(pO1No_`%OSVO%sYsN&=dWmwc+*=6c+Z(#kJMqIG`eRuwdb)!
zzHC!ZepioNd$#;$kNHW@Q+T=}LvI#;JsYY%sRF1HUeErpH?2;DmXw0Ejzln}_bqL`
zI(Pj3LgB%TN-Srhfo)}rOqAbu?5l%#+Q_XE{
zP5JVr=d(~n?w6Ut$D4yf$9>gqgYSk|tLpO>Tl)lQzkEr5(ny)#6qcNc?#Vh+-DED9
z7ATyIQiC7Hx6TZGdG}q(JE&yE-eXP$Z}8?@?>{wh^VGQ9Rz{M%Z&XL@oaA9}Sc
zIY)kqYFASswGksFGTMnL0KhK#bJNI|-jR0vNXMpj=NbA_=|B@g26w2|rPJEl1noI|
z(yODh>(5os{j85ot-qaWK!t0Ns;4=8WDGLqC1wN>XzeKfUYF7sDo>2N|2cCsvbcG!uLGZ5vo5I9FswSay`)>wng9fkJ7S0
z!(8=;p{S&|rW<#(RmB93zv)@yS5@36BAim_Sj>SIDsKTY<}~`yh(9^Ke(QPp
zF7RI>r@e|&;=wCR;-9JFRgCefPI$Edym|~?BNMM#hS&Op*Y3lsgOP>+xY8J2A3ST|
z1or^QxZy~(`bYtapl9-xZxzW5V`j}VjWw6>dIhrGN2T|q0IBDSF
zR|#8DZkF3RD)tNE+Zh6_NJF#wJ2!?mTmTWyX31
zCi;?d0XJ}uEtHr6$e9+S6hY$0pKQ5G>P&k}iD(tu_X6duYs^O=u{uWStderTOrQ0k
z{DY%B>p-zfu}o$VXI!i=Cq%)F5F0@fxMil3X_8X(E&0xOO&;U7FfyA}lnyRdJ|~)q
z6KsEOqL34P%azn7CrXqb1qYMK$;3LlqEO%j*OV7Vwh;SZKnV{74kOLd1$iLR0*dC0
zuDMf$)NVFI~gxd_It%zy7`Gz=#
z#DD>)Ez&l50$K>(o@qX{MM@OSfhbc)`ExGyIxQ(lE+#52ejA(b+aeVkT;NnBgTwIp
zb(RVQQdds6XfVJbX`u~lrQEk*tZS{{O8S)@jghtOV8O!lQJbV^>juzVrNLtEP#LSkr`cR_$5V=*LM{v|`hjmTa
zGPZ6RuuVt<12XP^6Ke%|5FoyTF`}HPhXi8
zzh|<}BRqFMnHZ-Kv(BHjE>OPyV0#n*fV*m7gtpg(FV-JHHbfXVM0q#Fq&CFWHY7|o
zB%L>;0ym^%H^dliPgDsjbJC$Hi3H+P)bWEXB@;i7^$QRcD+J+2Jbjukeejj_eYJe=Sf5!*xGVXG}
z0u;Wr<8J*D3wBH8bwicy7wf@q6HUv?%^Cyuo7CKttPUC@_tR<*y20-C|Lrt*y=;no
z`KfuYD(gi)^)4b4|5|U>EeEIyLrGoj{=6~KV8^J`*}msNxdE2Nu0T!^Bt!&fEP9!s
z5;I@YhnnzuF=g^1E8x2m5;V5$k!Uq9;A*bndN`2mF{3t*hj>mUduk9oR=0pwDG)Iv
z$jtV@TLGdz32rUhxpp#tKjt~;MLIz|!m8qPYrel3`##@!w7-0m)A!#jFXV*yBHr0+
zC-%S5Os|Dr=+=U$Aro)42(OaOpyAZV;{{O^d?r*uZf;jT;76n=
zA+Jg&Yd;?#0(Ziu{sMrs@HVgry?e4F6v_nJAKH!
zefiaW1-_oJ4VWSKFeo90qRc!06sq%)GeO2AmG_&zyUi0
zrT`;vghDXF{Ph{LS%8`Ax$CZ*vaUbc%s-Lm0*?8qv=yMLit$zjw>m{BOn|frXG%OM
zGUyqFjj=Z$-eB$$PvuiURbE(e(w^t-{
z8(e%9bjtNHAnfB(t{Q%YdYMe*O5|gJfa#S_cF<$8E0?=h(Lu|o?8^j~D}4zg{d{TNE%=K^;iB%Ncr24{4HR@1sLQS>*o_K%K4{(k5pmRSGfZM
z@bSLcviX}CR5I`zTlQO-2X*dg(-QEf;%o33c<+Ps?@s-d`bS|6PyaM=;6HhXRs8eT
zU-`F5{|@2-XYhnXdEql2T@01m9tGlw_Q%^|#}EWAR+8YaV1V|={d=hPd^yOxX{@f~
zZ}8r3kU(2#*6Jk3%{0@RFXtN8`=$yLfj7Mg>Wi4(Ar*#UEIEs6g)NcWD6&a#gEiYS
z<|6*}&DsuXMH)|8m^{6FvmA8Iuo6DQM9k{EI+?iIc^z3+7bii$L<^r}}>42fanOC%euE(6+XbPs^bS=kRy>WDWMiRRQ{=lnFCWX74!L}9D%ENsF{nb^
zQZ3bcFIpf={gOBFNsC_+F<8*_U*ycYyI9{TjzI^cOr}}7_
zX`@%cPl^5Hs@tq>5~);3vG6!a_a2^tgVk=z?&Ku*i#5p+ubu5@dOUBngfY);tmLFl
zyP-LTy)|E^DWg4!@JCO7%kCdip5%wsAAujZax_<}ta|E;o3#zs1#wufM}XEa)Z({j
z|8ac~vO@-Npz0oAaM*Re8t3)B*yLu82d)|(u5w+aCN6nmqqw9`kZxET1
zi9aSGmr6+yrIsLuXONV{afdQ3y$VmPw~SF$2rPDD=9K^gMtH>Zl)^L|*0JGDN;K&z
zdZk$HN4DwEdrsG9jv4$?WY$XVXlL#>uegSC(x9Th>>ron{P+YXeNHr$Qi{a+RGk1K
zV5O{ll&(a|u_0e!2r-UVX-ba3TNcqFV3toN8V}{jI@Y9RzU31&rf*_T4tUQ{?9cc>
zxZc2pw~&!x|D94Kol05Tet>{=E=!XDhhR}7*0{6@^U1~pws|VJWn%hB!5{f2hN8I4HELNxbumB3zI~4{
z$I`_?53v>e#rQv4_icE(ZZOVhUz>?p&esh3A)r=;Y6Y~UC9k9-I+y`=V$(otZo!S8
zD}9p<~G4$-A}D@Jrm)70h6N%`STQ>qRY
zErB=A<~<)bao6Sg#`B~@l29E`Fh7Tw?a%jW{{^umn7lr^JxiYYZcB5x_=pWL{mJTl
zp&`?1O3J0C$tuW&D80OFa9NP8Ny<1#CQfZWy%I(b9>i=wPNO&@NOt;*P_$Y(tk_T(nz|@+d)8+S%cyjEUBTcgI_zsbs*d>z_
z%aG2IOr?1^dLg-ea^?j7ueGGIsYU3(P}dUdd_127@F!R0`7;M^qYqu(!h(m5Vf39(f-RulpuY=4e7nMV>Y;?Pz
zfPnw-FsG49RWDV%_{^}D$3@SZJ)Z=VeC<0QEBa7i(OBPwd$5OTeIjXweBIg@p6QBy
z$%gtQukib98~g*0r|Xjg+wb4~Sur4gTK_t-`rTe02~vr!AthFh`yPGepsLu*hScP6
zZtnX6Lz+enX<6;uyj+?IB+&Zw!fS5+X9B~9X$=|Way$>7R}LFDG-TF>^9VW!jJ%j`
z$ZBrq5%#Yfu{v$Y?!4v^K?#i7(KY7u%khe(SB^S~HRg_o^Gf`4dEAT|^S&`?DFOgb
F{s-UZ>bU>_
diff --git a/docs/epy/uml_class_diagram_for_googleap_11.gif b/docs/epy/uml_class_diagram_for_googleap_11.gif
deleted file mode 100644
index 5c2e5617185f6bbfd9c10d64e1fc8a2fbf9afd14..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001
literal 9233
zcmdsb`9Bkm1O7H6$H;9MhPmdJ7mFVpzw{30-$+?OW
zDoT=ar0?hZ`u-Q+=lAD%J#
zQico0VNFpnATUV`(UBFix3IX_SccM6EerFD;p8T&$U&IFN5@A^w=t?n1i=g2ABOA5
zh&dXg&QuT=>qta@j~Fj3LV(-P8cpl%pUEY`1h|_rVmwSyWpOyHp>~Wj2BjiL@WrAv
zRfz&HqNXOa!R!t8dzhnY;&3tU7?he^
znWlD)Ihqs|L#-$SGl0wR1ll{AA1^mGgD5A4n5nBFd0}zRSj-LWGBs6g5V)za33~^7
zJ~h)Hj5|L(>TvhiBU2X}o0>9+9lm}?U-tT=Vrop$=cnhit`3qUVsB}Y80_J98%-PR
zpD7>_g<%i|FpQUbYj%cOK_n^2(Vmwr*3}UF{c2JO1O_mXm%HqSwzi5YHzzmN6y1?U
zfG|T;k#aK?q{X^2ga8aC04s}&!5X3nz8+{zZBiHxeM1{#i0UsOmPO$_%+WFKSd^OT
zzke5i|BoPg0tNyAeE_-to9X{{0>F3ysA7Z}w^WWKF>)cX6D?JgRCaOGGIgKo(M;$S
zU)qF~+h`VCKLcixyE&dKZPSQdJwQwsD&0-N$+XwKER_uULYvH!eDzqz<`iPuu{%~}
zn1_r_yWiBlG=G0v(Gmx~FB6lEx+LJk#^TMGSCsW9w^A+j|5+?y`CEF;g>d$zNg1
zGsKbG3{li9%y?DRT@KmRk+yjnfRtgpJ)#jfdX%Wfh`;oo5VXs0Ez`D}wq6+FcFU-2
zJ>@4KJ@5M$HJ4MI9U^BZWAiR{jcb`kd6f-yY}`M3WM;shwk-B&51tnY2n746SWo65
z0T%2ddR~sWKs}_NrPw+XFD!@o^8RR*iKNtum_2eaQZEt7{Kpf>TU=zF?!sy9v&sA6
zk@q{^OCEgCs4uNM!ZC;Q^&etS_Ltws1KD;96B&^!pd>cEp5$B5-U6?c8PY*h&~?eF{qi0JPycBV4U8T{1`6
zLFIJvz1G$#Uh|wB77#BjF{2{p^aXuUn&D*i9gaU&J@f6nUU(L|X!6TQ+%1UoDw%Iy
z-7XE9b=WCyh4HTjUu?V`9&^zEh?PnXo%|y6$3?bLO50CuWnslJ8+LNbPm7CLE}j2M
z0fbm@@X0^0&q;@xM=UtIcGDLU0ID%2i9Hs>Zt`7g{-UzYT^EutQ03c_ue^Q7r(b)?
zAibtmM|fXyo1@ZKxekDFAARTZ=S%D^(lo0P3eWiq13>_MV_8rDyre|spy*Ouj7SWD
zg0|CmNs0pWIp!EpTjLJ=EZgVGOwYKblOna_^uhp%0*_Df)TxUa(3>2v>M$%P#;93D8U
z-RoG->igE;ce($7DwrMPHFdY*XQlVm*D^#=5|F|_!F8$q2QV6?MDLT8K+g#q2E|#y
z>AC@z)G*bc^ATr=|3~rPuryYMVNQVQ4il@kD3@*;zhDlfxScklUcnBCLChds#=>Q1NiXN29~jbJTZ#cW=r2XdBoYcVayX*QIr
zlmsbxAk3FIt84HbDeCvMpTMS}M$1hcq7M)gg7@_kIbQzAp8fnJ{2LO}?=m!X}DRi~U?3mi5l5rH38O
z`<4OE#%W&)TJaJO)KaOP%$39RCC2pAmYByp^FL9qezB*awhF`R#46;>9>vD3L*EIj
zl!h$mus8z%IvvCG03TpYC5kCUb7~;|i&QoDC@4t`Q}s2UJ3O18wut8gB%J~Pa$8IQ
z1klB?;mwO1y~*_TX8K!rI*Y$#EAX=K&^hZzr+=X9QkWUVaAVM%@UfH_Rn<%Kc=btO
zU3+lrV(kNH5LKxO`rYtwXzZ|MUT?3bMFQ9mdj`n)8)h>E_a{3Z+{+dtt0JYw1BY+^OEZ61Jvq6H65wskc!+Zc
z{k?PRTHfo_;|^tA`7f!ty^F_N9WnuvUvBrEzG=w{l?_SXmPkHa>Y43)uIq50R;~Fa
zZ^^qh{^g7fmt*PJjbqik{UTEjv=SZp9n4A;Kpoa)sb@V#$$s1$L6s_vt?Kp2auHVG
z+W;&;u3hl;10On_HT>r6kjl#<@iHCd)`aBV&g*^@nk)128=bL^`xOC?^Ln+#^vG`}
z&85W*=?qZlf{g*kIKfcmsJA0XcOZautB`ZP;QP&soqfJ@4&+mHB!+{>?49B^X^5`CBIp#4G+77
ze2oI)gW}UT5)0e{{?r8!!STs%PAj9>Yq^1}YEI(0fh^tTB|1#St%A(1U{Mk{{D7~w
zg$`jHNCXCDCUMXf-9^)BC4<6!k}sD3xpu-jNz
z9jds^r}ztp2)C9GOR??NyFa0O(LARb)I%RKA(RjiYEu`Atv8OAh8ov-lzhC4vsX7X
zOuHYR7MR1lo(r&tCoO~lFi;_nZm54ZG-x^LFQ0EBmzR}+*Y^-@$BpovD-lWKm>Zx=
zfI#|Zf#8xBI(Yz~bpy;4cnM>#)ztvc2#Q#xL@fT11~6o@{fT{8`%doh_s*EU@21J(}`|`f4qbf5-oj=+-@8mmYCMMt3m$-eH=*+3a
zup9jNHtF*?)MbSslu-!>P3csT0;;(#`KYG{r5@r7k~W#@*o8RY8bA$S(&zYu`BcY)
zR8xKTcoTS*eJO{yr2+?j;ZCcNLL8Au?q1D14Nn|Qvt2mMuqVyB|~TH+I{fDiugovIfD
z8=?OiNYf`qbS6-&3iOWUgLtcGhseUC`kd&|9Pnqe%NkJS15(@%V0g7X<3_X$vSMxG
z(Rg8uNbw_Xd&3*2F*?36@E1@c9R~D{@CsjrwoHg-WR9R_t<=-9+l{IACAE(Bwb->>
z$J1IQf1NvXoinrX{BhnI2PwU(4qs)XziOtOp32M!oi8AHE|M}5>ytLYS_#)7_9h{X
z&vwL!SRZ-zW5y48YQXp#mN%Ebjx|E>eVtygEC1Fwt|F1*o
z-{j&hF&t_c)Z-n>&e*!%X47`Jw1f5yUUgQj{y-6;;M18sO?~Z?2(ua2LA#
z9&MRFDowd{E0wDft@PAbpy>RnYcg$w`Km?DTcVm!ab&enb$eB6wdk|zn-kU9$JImJ
zPw>i5l65<`kNh>h6xcQ98%)s&r`PB)ljeVSP8&&!7AKY{iHXb9FW;%V^10przCe;d
zcj;0Wjs+bU-Tl_BJL(yK$a;73X!rAZ|9EO$GDkg6VRwmcPe@IDDo4X`eNVwik8NZ?
zdTYa@=?xdM@C-SEN(5
z5>yj@q@@Kt&n@aHDa|1ZMtRuv2d53x_t2eaDxdXg{QZ&O0Yka2M
zJSUgRQiC0b46)t0rPSPHD%uYke@3;EGfHtx56G?7ydz4EVt5;UFrs|EJC%-rKn&-)0B?0r>-1nGlbnQ-Vu$5fHxPM=3VHBPyI
z>QwD7p5Aw*KW?+>=ZC6Wk^^IhIJAwEg=^@0!Sv6keBXS>J!jmuOVeGROw6b>X9Si1
zV}^qJTo$5-_Lzw0HrfraK|aUF1HljNVNsD2_qr`r5NGNMhg$h3L5WUK$}>|zvReSy;7{dq+9P3QdC^*
z^ycl`2=RWxVN<5sU+XjM*jI_uvp;FCV$Ig0?yrYuuH&Aq2TiY2k6z&u
zdp2s;nVe{$B?;;Cb10d0!ku{xf57a1L%~HRlz)I`>C`OzFez74^cVMnWDmW2r1;am
zBpl3K`9Co)`p4>7WF%zN{5qdp>
z``L0#bHu~?>2>Zr8MBqRl(wYUwrY{i=(0H#gRCF;bk(Ehg-Q+d9
z*|Yb!n&IQs!Ij8cGxGFRX1JNWfiHKy!3@6fl?dJQQFtP|*J|#+XPLETn+3&W)!Y__
z+RyHdD2(bqpB?wlTUW??dy)HoHg~fkw`aeOsQV%dNK0(prj+lejMVR`Jud+6B#G`U
zm2XY=qj#MH!n5Wh**yMA!B
z0U3sudfqGJOqTQqNf{~i!FDc!u9WZoeDDMKstWo~mi~(TgAMV?Gg(lGGALot(KRIW
z&-?VC&w6n`Y>HH5KZ?^z)g(UhN!bj9e#CuZPIvH*$XofwH#F$X{j+#}(D%x;%`kNbbJke+Gu
z7(Mf?Hc0{;dufDo=3}q$>P>~!y6taks(W~=y@>4ZpJN=*7j@G&PM$n0oOkXbEuLH<
zQtW2eN^Z^tvaTm=|1r`2COLWfWBi^jdu-dyvksTDuK2T_S9FjTU{uc8;J>rs$7i}a
z#ry!^Sp50KT13+r{2L_FVQ0mlme)?>WA?{9{Q3zZUuDk^}k^&kXn>hX!K}ibXJIYLV3wvaaCuIPi;>@j_uss6juw^`|MKki#J1>6|r6)KUTE
z!EIA-UZ@p2h-K$U*I{!p)IBXex@%E;>x!Ph&t%FlH;1^!=vvOb+s_##P^c?`HmEC3
zFL`NE$4%*Jd5j7t)iuPm_IsbbuGeg3N^`}Y@&2ve^|$LwDmBa~vJXO`QrdaL&f6c=
zjArB;r|oeEd)4|41zv3T@^@IgdeWMqCe)7et!;2<$NpWbzrQMacR9;MuzP&H&*95)
zd29GV&TzUGEROah=o3rcwE!leFw|#wvE8*lFfGd0^-I3LD_Wu>4mK}mxv0C&MIG{`rIyiN=yJ($PWPB#!FD201Xhuys0#(Jq3Rb4k0
zWulK8i|I<>g*yum-k3g9KouSGQtkd6{L(FA1C`4b5P@gp^`ccLaap@1<%(IfY$RYJ
z8m_S2QqdSGP`n;FZtjfH%`
zpr$qh%n`e4WliCmotw)Oq7K+oh?^5zbgXwr+%x^XahnOO@7ag3%&IlDtSl-V6ef!=
z7kieIk{oFvAG5musBb-zAA_=!Y~SHM3t3Yfyjbsb@$aa?kFBI2Ry|KZt+F}cnQ8!?
z4PRDGaI|0BW~CcNJTPW;52;4mgoHS>hTj*Poj~9fk{Etc+F!r>@UT(_z@KysItjMEb71tXwcot$!Sf)N8ZwCXwUp%otqTNi
zB|s_y^V+)L9aSb~v3nsR=UYZYhvk>qPS#!iVHt+`nQ{^sP_Enk%bi64CWyDa4Xi7N
z<%UiUV_n*7juss}oxP5}B5{*rbWGi>Xari-lEkk`7N!Kz@t^!;@E|9!1cm|&fU
zINd5fMUA@2i<{6F@du`rOE1;+ss
zwP=#CEmipRk(b_P@jTTFQO{p4@ty{)F~8%jDKx%!fzc4Tm{XeuS7Ie%G~q{YcI
zpLL_gN}x&)fWRm5N;isTDtMGDs&J-R_a;kMNi(9v=7Bv*3%SAICl&&))3X9WT%#af
zRi}pK6^H7iw_mKy50>kT`RE2I~$6!+ZT4R
zI3n2OGcp8L`Z%$=FL8->1vowsaiy1KU<$siU-1_2V#nb?9$aV!IOYg21dq){Pi_N+vot_8e5wjcl1Ifokmc|@6O}2_
zixfYUN##P*=%XiY=W8Mx&pVRg9Z%^2>bX*o2~53j!?^f@iafhfH55L~Ac^-)_lG23
zmg0NHR=PBl_J$!cU6e<+g^Q`kOzgkIm2uJkJ=os@Q`8a?v)yce=IUEx**$MHKX5IX
z1SDo)B0jL@_t435A9!;Pym=*Yh`Pkh4hEF*X9wRp3gmmc#kSuZ@Q|xiLE8$*0|W5H
zBW
z?^9Qo7VhRfe795Gu=??9WldU6#?r-zD387ZN87cdPps)xbV7$<-q`~M%r5Aae{Xl1
zj#eO3Mi}jIU$LaNLGKEg{h>f_aM(>if>HHE=X%P1ipCb1`gSalnmY<>-$Dnb-|jKU
zd|vGQ7E0;+>Q`V_rT#B%_AvlXxgV6
z;l0b(zr{gyfqR4DgTG_H`(~%he$$8mb8N5(!ec%#;ZlL5x7zglc;`X(jxkYMU^B8Y_rh6}H7!kAESTx_dgm|3VqMg6Wt4S)#ZZ@`G5lDCV1%k+
z>KRu)xU@h>n*%aid
z{VJqOPlisV7|%w?ncUOm~f#831HxQLK&sc~j
zd4QUh>%X5pJUr08L}F#!(q@WbW$xEz@nD5CX|tkP*fh#!rL@G_eWdATSb}kSau&z$S9UG?K}Fi5;w)!#*afJ4=^v)1Dwj
zAWM_TGBso=?8OxdJ6XhmptM0&I3g>8DN0*pSr}37s6-yo2~wt4_Mj*tD1Ay4UOjze
zV3KANMU6^PiqP*(quA+D9406_Fv<-`&Gi3t!4%XSJ;W#3z@B=0IN^qLGG-&ml9A59
z0|lAW*TW+8QTlX`l9d9Jw4{?Qa{$(mWa9|@)j&E)V|p#
zzzH`t3|y#mw!7q;2cT=aqY5jNqI11znW3P<=4KMu+1Vl0hbPGP2
zt2&v7nj|4i04<;gG1@4r$s*EZu7^pX>Sg~UV{P!{-0nmfgi;bJ^((a>KEatbEJ7ZYO+G_UmSBzaVJ1ySQ~7?A%^s%p=O(oKf<^y)@G
zBq3pfG&5NN?WZYI(VkOgyic+J&(XSU=b`}HEBeGuUkhX
z{_y)DTvXt2fWgH9c0-~X?67zauBEPyj^dIMRkZ|nY;#&d2A{xaSw_h%d`2X$AuVC4
zhT2>}#b~QxkvfdDjM4gr=D=W_9Y#SMj#5=v8yO`9y6rA5HDqNh)tBI1uxd&QC%;Y*
zq5=Z{GB?MNSiqx|RE6{K!=2r=CK`qX-0--eqkszM6QD*1H&7C0Drs)!sFL_#s=Pw5
z1EwQB;beSNfSaqq#f`+lwcFLfD9$L+)=BWjWr)H@i%T$iYFM-mDKMA|3Z@oN@&D|h
zxDH=8oE1vvU+{le6_9Ajq+L1#Ck~&69dsM$;0g
zk-=^*ZYLw7&AC)OpTOG7j?qfmT1zuEJ|Wn}jZs!YyM<5qhaL+!frBd}65o)P5p0Li
zQBpV@8Rg>Uazp>i3X9TEK#0Q?q!Dgbn1=cWFceHfqZkxYvoG#&V{NIWd2N6(T0q^M
zo1sc0I->Cn4%iY6wG1HvMpj01Xz<$j=12q*N6Sh`p}{l?Y36am$@jyxu8z?f8s6PaM^#OL@1Ivma~27u
zty2<>Pw>UTMd4f=T%%>wl3V}kSc1{k!6H$lKpa98u5cbfjmEo~V@l%j!46oAo(>j`
z$_Nd{Sz$T~GSuW1+|Z~5Z#R^N+TXuS!2h3|`w0dD02=^>{|))SGXY>@0{qzFrccXz
ziERAxZbMHi`cil#%}Y$5RraUDE(INk<;_Q
zktVsPp6A%);g9Rb_jx)$5qR#ceYz&2=-J2gY-8asSRx0-y#5DLQb1}^QZ5)}Varz?
zv$v4w+)hbcINVOFOJeP+HvVtd#;@x$KWdyjTzcO*ko
z%L~<~6Yn{~?RM2uPWzjeJ6<+-T15++4duFfJU{ZKoW5Wqm(=2|^Fg6`%C18G(c>>0
zt^y^Uq89|8&&7XgdkLjKdV&R5ke_0Cf)ttnvKEl%)f&RZw4hY*-0~tYc01w&y
zM)+i5FZ+d)A?yrNy^4bKXB3(D)bs?2S2$Wo!03HXbNURHuoQ}zuyyBqAj5=dgts!qS7V{6Q>S|gj
zLvFRL8u9*}0+v-HHSHz4WyL1qHbM*L1jvL`86Z9gx~~j()D66A`g5{
zpeW}u;GE9cKZi}_kF`Ig9z-kUKN-}!`MGto>(*X3tA4`QII#yO2V;4QTjnYCBm2F4
ztCNg{r?#C62;wD|Efgos6W9q?PQu25Wx5QKL~JYgo&)pZ!v#{Lfd=@d)nwRGcyfM3
zvSyJ8rz}a5^DIFI=+Q$G!4A>$uk8ylIZ!jsbVF`v@oo|}brpQUlzdj+h6q2DU}HZ=
z7tNj^RdT|BmX0Fp{uA1sTpvBU*h=a{zDf)OxkdVi(8`Z()qQn*45wgc*zvWQvDhrJ
ze0~!xZc~Mhr9;`ybzmIN!DnlzahL*nFSzw&L+}jL7P<+7R;@nCGcTRa$=?!%qDPVEZ(8H
z#&{y_dw=;uWbLT`T;oQB7xztPqhYIprhMl^nhSmt-VST)738+uj@WXyDkt?xWrfK~
z$)ayl;rn;)!q88}%Q%37h(0pV78#s$EG
z#)Jf3u}>RP%97^1xea#d8^JylPbtQ-vC1|Pk~9rK4}%3SIKK;+>%|#z3_m5AeT%ni
zErUKLSvGiy5f>O6QO}|S8hrXVoS<H)%Bn+bN~Lp=a4wmwXO3R!^r+q(zt0bkhQ?
zAC1q5UVqWh$gBxUXL-AzccTSm#tl8mR_Dl&;BFQu?4gSb{#H%I@`X`fzZTUELZLu=RwQl
zZtVI>NzI^xzNg-$VA;<&z)1YWw-rnCjzU5%6yZ(vOAFYr^KD;OTZ
zMy=R6*ZSjLDhsMMbS*zqs@o!}9wlgZ@f0Q1qV17+aVBf$&xj1G41~{@n97PL&py&c
zV42v5qNf@H^B-BFBzW3)ud~lPsQ5Zv5S%gh8*X-zjj_sb+YWT>`2I%uHn({>|F`)b
z?(Y*(E1xRQiH-dVjGUr!<0_Mqw=o|hruDa*AHHD=d=NgBUu*TE-f?Wl;XYphx(tH2
zX!gnF?XS7~(Y3`e
z;XWwvQB2v7rkEQ$aj)^b6#loGTxyRCzdBib=VVz13&Y`Tfs#d*6aQU~hNZzSH@{U*
z@cq;tb>8_b&*lv`(+I5uJ@5PMiR&^tnA>EBB6h0HwrH62AdvX2lS<@7YJgtEVcNSaBPjkQ_3KObm*Kht7n$*Y`uP_^
z^rCxe)AaSSVfPZdHsENVw6hHb_Pj>i*>>;A@rHl4@ARd3>uT&yH*~015gcAq=nyMDNOJk)JmoP9e%)am}uK}WsAo2w^?HFst8^7b#^nB&17
zr~j5W?R6;@mgQYf@4mD)c<1Nqz0Ey8wUb>(+^?`E=JE4|KRV>@KM<|k_hea(A?Y)>)p>*0zYDLo5aPdzimb&G-xIcKLX&$#SyOLYSKq!95q4A~EWRMjVhTH#
z8urTpc2bbkUI=?Fc#R=-7P}t~8E_Lj2tU1Pxk?4aMVw(LKrVSh%RQsf5=6Ebn1CNl
zSmw6qu>-s){L8Ghxk02{q0G%DcT8lIrMLBQGqLNrl#>Csfh_5&ESUnlp=xsDq?MF1
zOVXe7{EyG`ak7}cUsRY0-t&M>(cmIl0^(IGyuNyKq4!3L7d|BipWl+qMEl2MCG6}j
zQ|vdRB~qihB2(tG)e=o1w>8O`PB7OPSel6`n<;WI3eO6AS|Y
z=CZ*Y01kre6~@*bkImS*Z?P|uJvxUHQ{Vf#N{Qoy;z>3}m)GLTFB^{*8N#DDZ8bH#
zv$?c6HunK(+)0SVl!vdF>ziP_GZwuLX-b*>uvHRGgtL%uCf+PRfJ#7IS*2u
zlQT=w7C~QT=hym~cZ-*LQH6^752h2~tap!^&`iBQOHDNtO-2z4Dncf3RHX_+BQR-$
zVzOOx#-tGA@`kV1Az8{_>}QRrTrKAMFkj(p^2T8@;vn1;N$S5Y(Rt+BtM11C&_EUm
z*-Xlbe-HSBhKv9>Msi6w_WbHu(&rb}HnQYnRSFg9zSw_l1>&ysBT_|1-K+_bRG~6k
zbunJ$M(B1?eLv-NH8|PnUeYn8F`l+yPA3C1=(X2h_FW%1E?Hc7&`?$8J&;M_(--iJy|xOx
zb&k_p0t(^FTGGO-*6|fy&k8Tdx{5%a$og@h$}I-UNMG+7&ls38*r5x;ZrLd}4YTX+
zJRs%x1yuWWHfIxfrEZ@CFSH1A|Ez>M!}y&2hjBT#ZP|V5gwOX#OAA7JVq6EzT;a~S
zuVQk~{q*-j<&OI04yEL#R6vUM@jDfXKYmtO#iin0YDCzp{EJNli}_5QYeLfa!gi<;
z@q9OmsZoJ^G3L}b7d|7i5Nv>$!@UPgIO|m>ty|W`u6AZHfi~fpjr=*@0t&G1Rt^|#
zqYG=p+}ZI?*M<-DRl&cCyP-(nn+qj~Yb&v+5)q>kn#k8eaK4@!PzfoFnwTx1c?hew}zxOD~w(r|xU-z!R_0O;ycygkx-$Gt6)PqZ7^fZvM*4yux?)QC`jkzC72w{4;!ooO$;+`R=#hF8$5>An10*C*A>}&^Wc)
zq=;Jj!?wz#m!1JhNjY`*@*7L$>WIMhV6}RZZN04hOR;m#nlLM4&2Y#dq_F7Dr%Caq
z;zG1j1hMx~+4@V?M`T;3M1$69goI4w@XZS&@^WK4_xu)K2K;_@TT*G$B|5(1#ttb>XXTcCoJkP77G}AP&emI7&1S4C;bl7
zA{}j@C6t~na-oLE+cbT%dqz8+A?uj188hRbxv;?5Jl*vDBaU}5YIz}6Nugq`y~k8D
zK7wMnl^(}u#Qme_?nDL3+_mq~HgGte@3_6?OkkU9)eA?MUpiyvicRS6XO^OU
zUG>88XA+Yv5|gO?y5-f$L5ZZKHV2(1i;lMH9EP6C%de~*@ZN#l&4Dw(!A+S#QNzIx
zeuFU)1O6HQfn34Ngrz}J#o%4up$ytfLhs91nZEJK+JLCgtYBE~%g}F}{qSIs2cmb1
zgOh(p7o{ik->GoJ%ZaPDg{wPBUWP?rP%slG*i_JP1_st|es3%y@^(|2(L-{n9PG6V
ztoG-yZwYKQt!qU-3lnMm<@Ymk^X!xwTQ?^d1k#f$~`r
z@9(E$IcdW>c(sJy_Sl#gXZjOznq)3q88VF>Xv^3frLP`m9*;inIT^cS+pNcEM!k(I
z+K+o)ku|$>*T{_l2rxA17%$YhX*oJV;(S#Ocet9-ZQt>FL9p8SW&ik(1Uv0SH*FZM
zVea*HmP
z#_;NY^4Fx>6L^PHRfdI~hOKs{Q*wqM9VeCcwiDmCH$}~?Z{}5Igg5R;Y-2~%U_^D*
zk<`f%A=Xo{`B^>PR|{9j{o3S~1o9Yf7jg0x>FcYN&FQ|A;xUy`pV(1@l(fx}QPa&)
zJ&v(kOkkyxV72Zi%hotJB6HFcqPgqF&-
zJFG|f(lH89Qny3Nmfv+UNhAj@~j
zU++F*woXhhqfV9PyEoo4`}2agw3PqUVpge>uw|o&;u7ble$UbV7o-(&-8P?$-f-O|
z{m+9~-FF)ImJeH(HN@TuB@HeQz8k7|r*djl;QhN%^y<>NRfWt|zH@;|#juxWM2tQQ
zr*XYK{(M{AvTjv6Owb9|9Q6KZ8O=MMEVIyF#`WP~xwHL+Bqz(G(MQ5SRSDj}4hhfj
zz&{=yb!4WZCYqj*ohY>o!KJp67e!w^ibSs=qH>wlx_mX&WnB9z!Q?
zluPt7fokfW$X+gf?(n{DPbC|_`9)I2Gjc`m#AL
zTd%zcDewA2Z`G>E6rZ8B_WfGeba5Ba8$~&&NqEG>d1uENaCJ%+Pt53M&s(l%eR1;q
zv|QEyv9fkGU2TQcbtP^*aaVCFg{y5;X#jERUG@0u?|-Q0+&|y$T?G?Ak41l;YX%Yb
z=a$fM(~e&@ZhhG*`?AyZWsntQlg+v-zIULvx0?l_>+ut8*x*n1PFD7q%ss%_eHQ(F
zu=TzY0AeG-4(ZH%+y4W~^H2TL!2&6?Bt!I2=4i*1hs6alrd;cO{C!ky*?6ZUD!JZA{|
zfi~YmyLo7YeXs$~Rf(e;f4|3u@dTYc)R_2@=<$^+`$zIc9!}*0%H92H<>TbL92a>w
zvhMCTt{zwHb4WiqF1Wk@$n$5hHBV9Z&$4$v%bxr!Kl>|9{}=7zan0>tu@8RL?|pB0
z_Y3#;*V6|_P5QsBJbt%WAGSUCt=0Xzqni%|;Aqo00eG@VuYwtOgI@Feip_zHGyk4U
zoc%MU|7XVI&)n@l3lIJ*cK=gZ0X-*-6+h?wKV{Z=ryrjw??rE3gnc~COhUj#S41`<
zl{~?JJ$D?}x_=(|%@(}B6wCMvFf?8@NOA^@B8zO^BPplE^hhw<52!T3bGKL|CjO6E
z{6{Q8K>6^JT${QG78e;YQLT7dC6P1J)v0TUkJSKEa7Lsqb{~{^m0KQm;*`zOIA~_s
zx^&ELVpA>~gR(Lxnn_c-nT6TPG_ufp`D%Bqx5ye71*$Gip=62=_vRY-O~
z^AT&MW$Z|>!9Daju{rAb=W
zO0b>@es1cEP}B}Ewuf4|1bF;H2_=g;_}vy#6T
z*z$(X9=n=cr>Xg#{NwYFg4^c`ioDZRzSmJQuP_S=SM0t@z1$)nMyUo=vnIy|JbXaW
z4wSiH5WgLtIk4zXd*ogm__!PTHsDF0_|{ItYw;UFP3*a==`Y^7w}-TGii(D`_hWB{
zcK+CK4Sc=_)p>at&{iGZciKcJqF>mrBVzDuicaJ(zi`!;o{K4=`@@$vJ8rzzFYJgM
zHAzw0>#{cabJ%U>r+a?-YKrdnr;cHr(G>SW-I(RZmZj)-VLt+5-lxRmet#D-SQ@+T
zbD4QOm*=7PtLuJD8Gg+0|5#BIx5J(8?y{R-2W7e=_PS%l67MaNIhj#%ut|I_B);Ek!4abhqhUp-7O(0;gts@`VPPJ~AGD+}RX=J>RWR_ex=R?~
zt@0f+;-hhjXQwG>d$G?cRKW>gc4XlkB*YdgA=J+as5G>`xuF~zdg633VB={efB?nv
z00B!5>XD-r<)HUqXmu`0E1Z6+6=ovpv(uc%PJ4(wmOBd`Y0skXRRJrt{k9a#j$
zZEH9;IC~{MfQ0xPUvZgAZUNZTA_MH(UFIl40wwCj91Z*Ii*s`=t^FaPQSGiPA6i6g
z2rMEy6RsbG=G!{O0Kxe|IVu2Qjy|VQe1$2Os%DJfRDbB-@b^or%yaGU8dvxUXTYnW
zz>duqrHX+-@+D$+uXYz0p`)bSX5X)6@j!bv{sw9tppW(jBK;p7{v1brIoPqD{{fx_qedyMAM(1+!lPn`@lo0?D|hqxobGx?wWqcgJ91Y|l3Lvt*f?mb?i
z6&|-(6Mw~4wwMbjcqO^Q@5~Aryt3hVzT@gtK2!63nI`OXUzUJ`Yq6y~x#0<2BcRpj
z13irqV#W``Ul~Y>Sf0|64$%wox0w>(ZK_KPtTW(rab?NPM%D+1vf|h?!2AYbG8e+m6Ru*TDSo$LNZUtdv4KBoX{5{oXav}PCR`l+o
z05klr@zQirP3&XETiY2%DhW$hJO+RN`1+abwzd}(J0*Q9va-4(7UrkLdf7_9XmF{j
z{?UJ9B6{DRG`ej*jQr0&fq6qU$L*%H%*)RiWx6z(KXE#nixZ`KmE{)3J6BKJ&Pv|D
z(I9O3>H5d``E9nN`fJyA>(1YVzGfc2Z0TebA)r7@O7l*SOQQ&~VAjK~n6ABRXL^iL
z?;zbVrxr>HFT+DKPFXu#)N~Y1e<-ieX2CKfY%kbj2?U;b@eFgkSCX>E_M^
zv^^;@7A?<)PB}&j^r-hMxC7nbt+$Anr$B*QN!jNCF#;{`RzU<#3JJFY#Q<*oE#@S1
zBfwv6Vhs-7nQ*xq^m1|-8kbhz{qIzsr{KH4%=qEe<Xl3D)q^{&>RJ^k=MKf2q2Jpj~wAfl&1r3a)|48|H%di6j%3Ry`8*qk1A
zwR{eRCO`kiQ)@lkhdrmMr?ksKY=B-qwO;-u0~=E%ULe7zoFq)@g;9G&XuYD%y=NG`
z@R?q*wO;YV-m_r3#I7OWn8XVNm@g0!Sh^IBE{&(lkm#~hx*Uxz-^`?6V9*t2=!zZ4
z^J+-M8eLhSPq71{j6sI^gB3EQ^35nJ_`b^|Bk4n=kXoN+vyrAkpA@POA;9XhYNVe)
z=l3V7N}!M(eMTsTd`TaV79E90sW$ZKE)jz?|Gl?RvN}n@u?)*KhLjs>$Dd&(U@SXo
zB(-FOn_xFLFjgrifmSJIu@u*Eit+*x6O7c6Wff_Inh*5{WdnT-p#D8juLY3XjIju;
zA4lywPcyoXA3(T0f|&Q2HJ}2Qh!?^^A*NuHHVC@5A5uxtl?DB~&%I&+kpdJu9-^5n
z(TD&wfel9DlKij()+Jdsv_abrNPsLub&C?f>_7!E2I7`L0X!)#a0ZeAiU0%j6^N82
zkfG)fLI-LcYick$XxnVE-7}c6#<0^dA~XzGbg)?2AWi&@TygZ25|e@@qQ*W{3P*|z
zH@hp)pP7-B)of-09@fof5D;emZ6t)+kjo4s9}F<^G_6)JPir2cEe%^S%(foe06>bjCc$rl!OsTOQMP!_MNGk(zfeG{)B<$cSp2hrEzKh)B_l6uM_y(a
zHI$&$2vF}s3$Heo;BX54UVoTdIjg6|OEt=^Udk0G^G-aYotEA~#a!=5wrU$4!y`vZ
zIA5)eT8)lQAjWj}G5-O^m{WL$S2%QbZFD*#eFi`FhBl@`vTU2Ub1*r!yf(ISX!#jP
zxU7s+IUf6{TNge|RlpA}+LIa8>z|FI{u?$@Tdf-Lmc+83o8D$(@?Gz%{As
z3B+Xs^Y~$n)z3?JHd8Qbk=Z?R0A|Xc_4@fddl8b
zVv97VGcCMKv=T#OPt9s8&Km04M+gutEa@ENRL;b!IsibJEK!dK6cBqgs2LfoNzx4`
z#bCf;TNGV3kQEFiV)}1trj*F^SOKUG&%COHqt}9i$<|z0KRRR$eLjS)+5-+?%2GTv
z9dw)qqZ3U0$PNMOlNMa_5sHqSzOcQX$mTn1
"; - elt.innerHTML = s; - } -} - -function toggle(id) { - elt = document.getElementById(id+"-toggle"); - if (elt.innerHTML == "-") - collapse(id); - else - expand(id); - return false; -} - -function highlight(id) { - var elt = document.getElementById(id+"-def"); - if (elt) elt.className = "py-highlight-hdr"; - var elt = document.getElementById(id+"-expanded"); - if (elt) elt.className = "py-highlight"; - var elt = document.getElementById(id+"-collapsed"); - if (elt) elt.className = "py-highlight"; -} - -function num_lines(s) { - var n = 1; - var pos = s.indexOf("\n"); - while ( pos > 0) { - n += 1; - pos = s.indexOf("\n", pos+1); - } - return n; -} - -// Collapse all blocks that mave more than `min_lines` lines. -function collapse_all(min_lines) { - var elts = document.getElementsByTagName("div"); - for (var i=0; i
- " +
- links +
- "
- "+ - "None of the above
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Package googleapiclient
- - -
-
|
-|||
-
| |||
- - -
-
|
-|||
| - - |
- __package__ = |
- ||
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:21 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Source Code for Package googleapiclient
-- 1 # Copyright 2014 Google Inc. All Rights Reserved. - 2 # - 3 # Licensed under the Apache License, Version 2.0 (the "License"); - 4 # you may not use this file except in compliance with the License. - 5 # You may obtain a copy of the License at - 6 # - 7 # http://www.apache.org/licenses/LICENSE-2.0 - 8 # - 9 # Unless required by applicable law or agreed to in writing, software -10 # distributed under the License is distributed on an "AS IS" BASIS, -11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -12 # See the License for the specific language governing permissions and -13 # limitations under the License. -14 -15 # Set default logging handler to avoid "No handler found" warnings. -16 import logging -17 -18 try: # Python 2.7+ -19 from logging import NullHandler -20 except ImportError: -21 -25 -26 -27 logging.getLogger(__name__).addHandler(NullHandler()) -28 --
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class NullHandler
-- - -
-
|
-|||
| - - |
-
|
- ||
|
- Inherited from Inherited from Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
- -Do whatever it takes to actually log the specified logging record. - -This version is intended to be implemented by subclasses and so -raises a NotImplementedError. - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Thu Apr 30 17:06:05 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Module _auth
-Helpers for authentication using oauth2client or google-auth.
- - - -
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
-
|
-|||
| - - |
- HAS_GOOGLE_AUTH = False
- |
- ||
| - - |
- google_auth_httplib2 = None
- |
- ||
| - - |
- HAS_OAUTH2CLIENT = False
- |
- ||
| - - |
- __package__ = |
- ||
-
|
-|||
-
-
-
-
-
-
-Scopes the credentials if necessary. - -Args: - credentials (Union[ - google.auth.credentials.Credentials, - oauth2client.client.Credentials]): The credentials to scope. - scopes (Sequence[str]): The list of scopes. - -Returns: - Union[google.auth.credentials.Credentials, - oauth2client.client.Credentials]: The scoped credentials. - --
|
-
-
-
-
-
-Returns an http client that is authorized with the given credentials. - -Args: - credentials (Union[ - google.auth.credentials.Credentials, - oauth2client.client.Credentials]): The credentials to use. - -Returns: - Union[httplib2.Http, google_auth_httplib2.AuthorizedHttp]: An - authorized http client. - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:21 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Source Code for Module googleapiclient._auth
-- 1 # Copyright 2016 Google Inc. All Rights Reserved. - 2 # - 3 # Licensed under the Apache License, Version 2.0 (the "License"); - 4 # you may not use this file except in compliance with the License. - 5 # You may obtain a copy of the License at - 6 # - 7 # http://www.apache.org/licenses/LICENSE-2.0 - 8 # - 9 # Unless required by applicable law or agreed to in writing, software - 10 # distributed under the License is distributed on an "AS IS" BASIS, - 11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - 12 # See the License for the specific language governing permissions and - 13 # limitations under the License. - 14 - 15 """Helpers for authentication using oauth2client or google-auth.""" - 16 - 17 import httplib2 - 18 - 19 try: - 20 import google.auth - 21 import google.auth.credentials - 22 - 23 HAS_GOOGLE_AUTH = True - 24 except ImportError: # pragma: NO COVER - 25 HAS_GOOGLE_AUTH = False - 26 - 27 try: - 28 import google_auth_httplib2 - 29 except ImportError: # pragma: NO COVER - 30 google_auth_httplib2 = None - 31 - 32 try: - 33 import oauth2client - 34 import oauth2client.client - 35 - 36 HAS_OAUTH2CLIENT = True - 37 except ImportError: # pragma: NO COVER - 38 HAS_OAUTH2CLIENT = False - 39 - 40 --42 """Returns credentials loaded from a file.""" - 43 if HAS_GOOGLE_AUTH: - 44 credentials, _ = google.auth.load_credentials_from_file(filename, scopes=scopes, quota_project_id=quota_project_id) - 45 return credentials - 46 else: - 47 raise EnvironmentError( - 48 "client_options.credentials_file is only supported in google-auth.") -49 - 50 -52 """Returns Application Default Credentials.""" - 53 if HAS_GOOGLE_AUTH: - 54 credentials, _ = google.auth.default(scopes=scopes, quota_project_id=quota_project_id) - 55 return credentials - 56 elif HAS_OAUTH2CLIENT: - 57 if scopes is not None or quota_project_id is not None: - 58 raise EnvironmentError( - 59 "client_options.scopes and client_options.quota_project_id are not supported in oauth2client." - 60 "Please install google-auth." - 61 ) - 62 return oauth2client.client.GoogleCredentials.get_application_default() - 63 else: - 64 raise EnvironmentError( - 65 "No authentication library is available. Please install either " - 66 "google-auth or oauth2client." - 67 ) -68 - 69 -71 """Scopes the credentials if necessary. - 72 - 73 Args: - 74 credentials (Union[ - 75 google.auth.credentials.Credentials, - 76 oauth2client.client.Credentials]): The credentials to scope. - 77 scopes (Sequence[str]): The list of scopes. - 78 - 79 Returns: - 80 Union[google.auth.credentials.Credentials, - 81 oauth2client.client.Credentials]: The scoped credentials. - 82 """ - 83 if HAS_GOOGLE_AUTH and isinstance(credentials, google.auth.credentials.Credentials): - 84 return google.auth.credentials.with_scopes_if_required(credentials, scopes) - 85 else: - 86 try: - 87 if credentials.create_scoped_required(): - 88 return credentials.create_scoped(scopes) - 89 else: - 90 return credentials - 91 except AttributeError: - 92 return credentials -93 - 94 -120 -121 -123 # Refresh must use a new http instance, as the one associated with the -124 # credentials could be a AuthorizedHttp or an oauth2client-decorated -125 # Http instance which would cause a weird recursive loop of refreshing -126 # and likely tear a hole in spacetime. -127 refresh_http = httplib2.Http() -128 if HAS_GOOGLE_AUTH and isinstance(credentials, google.auth.credentials.Credentials): -129 request = google_auth_httplib2.Request(refresh_http) -130 return credentials.refresh(request) -131 else: -132 return credentials.refresh(refresh_http) -133 -134 -136 # oauth2client and google-auth have the same interface for this. -137 if not is_valid(credentials): -138 refresh_credentials(credentials) -139 return credentials.apply(headers) -140 -141 -143 if HAS_GOOGLE_AUTH and isinstance(credentials, google.auth.credentials.Credentials): -144 return credentials.valid -145 else: -146 return ( -147 credentials.access_token is not None -148 and not credentials.access_token_expired -149 ) -150 -151 -153 if http is None: -154 return None -155 elif hasattr(http.request, "credentials"): -156 return http.request.credentials -157 elif hasattr(http, "credentials") and not isinstance( -158 http.credentials, httplib2.Credentials -159 ): -160 return http.credentials -161 else: -162 return None -163 -
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Module _helpers
-Helper functions for commonly used utilities.
- - - -
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
-
|
-|||
| - - |
- logger = logging.getLogger(__name__)
- |
- ||
| - - |
- POSITIONAL_WARNING = |
- ||
| - - |
- POSITIONAL_EXCEPTION = |
- ||
| - - |
- POSITIONAL_IGNORE = |
- ||
| - - |
- POSITIONAL_SET = |
- ||
| - - |
- positional_parameters_enforcement = |
- ||
| - - |
- _SYM_LINK_MESSAGE = |
- ||
| - - |
- _IS_DIR_MESSAGE = |
- ||
| - - |
- _MISSING_FILE_MESSAGE = |
- ||
| - - |
- __package__ = |
- ||
-
|
-|||
-
-
-
-
-
-
-A decorator to declare that only the first N arguments may be positional. - -This decorator makes it easy to support Python 3 style keyword-only -parameters. For example, in Python 3 it is possible to write:: - - def fn(pos1, *, kwonly1=None, kwonly1=None): - ... - -All named parameters after ``*`` must be a keyword:: - - fn(10, 'kw1', 'kw2') # Raises exception. - fn(10, kwonly1='kw1') # Ok. - -Example -^^^^^^^ - -To define a function like above, do:: - - @positional(1) - def fn(pos1, kwonly1=None, kwonly2=None): - ... - -If no default value is provided to a keyword argument, it becomes a -required keyword argument:: - - @positional(0) - def fn(required_kw): - ... - -This must be called with the keyword parameter:: - - fn() # Raises exception. - fn(10) # Raises exception. - fn(required_kw=10) # Ok. - -When defining instance or class methods always remember to account for -``self`` and ``cls``:: - - class MyClass(object): - - @positional(2) - def my_method(self, pos1, kwonly1=None): - ... - - @classmethod - @positional(2) - def my_method(cls, pos1, kwonly1=None): - ... - -The positional decorator behavior is controlled by -``_helpers.positional_parameters_enforcement``, which may be set to -``POSITIONAL_EXCEPTION``, ``POSITIONAL_WARNING`` or -``POSITIONAL_IGNORE`` to raise an exception, log a warning, or do -nothing, respectively, if a declaration is violated. - -Args: - max_positional_arguments: Maximum number of positional arguments. All - parameters after the this index must be - keyword only. - -Returns: - A decorator that prevents using arguments after max_positional_args - from being used as positional parameters. - -Raises: - TypeError: if a key-word only argument is provided as a positional - parameter, but only if - _helpers.positional_parameters_enforcement is set to - POSITIONAL_EXCEPTION. - --
|
-
-
-
-
-
-
-Parses unique key-value parameters from urlencoded content. - -Args: - content: string, URL-encoded key-value pairs. - -Returns: - dict, The key-value pairs from ``content``. - -Raises: - ValueError: if one of the keys is repeated. - --
|
-
-
-
-
-
-
-Updates a URI with new query parameters. - -If a given key from ``params`` is repeated in the ``uri``, then -the URI will be considered invalid and an error will occur. - -If the URI is valid, then each value from ``params`` will -replace the corresponding value in the query parameters (if -it exists). - -Args: - uri: string, A valid URI, with potential existing query parameters. - params: dict, A dictionary of query parameters. - -Returns: - The same URI but with the new query parameters added. - --
|
-
-
-
-
-
-Adds a query parameter to a url. - -Replaces the current value if it already exists in the URL. - -Args: - url: string, url to add the query parameter to. - name: string, query parameter name. - value: string, query parameter value. - -Returns: - Updated query parameter. Does not update the url if value is None. - --
|
- - -
-
|
-|||
-
-
-
-
- _MISSING_FILE_MESSAGE- -
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Source Code for Module googleapiclient._helpers
-- 1 # Copyright 2015 Google Inc. All rights reserved. - 2 # - 3 # Licensed under the Apache License, Version 2.0 (the "License"); - 4 # you may not use this file except in compliance with the License. - 5 # You may obtain a copy of the License at - 6 # - 7 # http://www.apache.org/licenses/LICENSE-2.0 - 8 # - 9 # Unless required by applicable law or agreed to in writing, software - 10 # distributed under the License is distributed on an "AS IS" BASIS, - 11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - 12 # See the License for the specific language governing permissions and - 13 # limitations under the License. - 14 - 15 """Helper functions for commonly used utilities.""" - 16 - 17 import functools - 18 import inspect - 19 import logging - 20 import warnings - 21 - 22 import six - 23 from six.moves import urllib - 24 - 25 - 26 logger = logging.getLogger(__name__) - 27 - 28 POSITIONAL_WARNING = "WARNING" - 29 POSITIONAL_EXCEPTION = "EXCEPTION" - 30 POSITIONAL_IGNORE = "IGNORE" - 31 POSITIONAL_SET = frozenset( - 32 [POSITIONAL_WARNING, POSITIONAL_EXCEPTION, POSITIONAL_IGNORE] - 33 ) - 34 - 35 positional_parameters_enforcement = POSITIONAL_WARNING - 36 - 37 _SYM_LINK_MESSAGE = "File: {0}: Is a symbolic link." - 38 _IS_DIR_MESSAGE = "{0}: Is a directory" - 39 _MISSING_FILE_MESSAGE = "Cannot access {0}: No such file or directory" --43 """A decorator to declare that only the first N arguments may be positional. - 44 - 45 This decorator makes it easy to support Python 3 style keyword-only - 46 parameters. For example, in Python 3 it is possible to write:: - 47 - 48 def fn(pos1, *, kwonly1=None, kwonly1=None): - 49 ... - 50 - 51 All named parameters after ``*`` must be a keyword:: - 52 - 53 fn(10, 'kw1', 'kw2') # Raises exception. - 54 fn(10, kwonly1='kw1') # Ok. - 55 - 56 Example - 57 ^^^^^^^ - 58 - 59 To define a function like above, do:: - 60 - 61 @positional(1) - 62 def fn(pos1, kwonly1=None, kwonly2=None): - 63 ... - 64 - 65 If no default value is provided to a keyword argument, it becomes a - 66 required keyword argument:: - 67 - 68 @positional(0) - 69 def fn(required_kw): - 70 ... - 71 - 72 This must be called with the keyword parameter:: - 73 - 74 fn() # Raises exception. - 75 fn(10) # Raises exception. - 76 fn(required_kw=10) # Ok. - 77 - 78 When defining instance or class methods always remember to account for - 79 ``self`` and ``cls``:: - 80 - 81 class MyClass(object): - 82 - 83 @positional(2) - 84 def my_method(self, pos1, kwonly1=None): - 85 ... - 86 - 87 @classmethod - 88 @positional(2) - 89 def my_method(cls, pos1, kwonly1=None): - 90 ... - 91 - 92 The positional decorator behavior is controlled by - 93 ``_helpers.positional_parameters_enforcement``, which may be set to - 94 ``POSITIONAL_EXCEPTION``, ``POSITIONAL_WARNING`` or - 95 ``POSITIONAL_IGNORE`` to raise an exception, log a warning, or do - 96 nothing, respectively, if a declaration is violated. - 97 - 98 Args: - 99 max_positional_arguments: Maximum number of positional arguments. All -100 parameters after the this index must be -101 keyword only. -102 -103 Returns: -104 A decorator that prevents using arguments after max_positional_args -105 from being used as positional parameters. -106 -107 Raises: -108 TypeError: if a key-word only argument is provided as a positional -109 parameter, but only if -110 _helpers.positional_parameters_enforcement is set to -111 POSITIONAL_EXCEPTION. -112 """ -113 -114 def positional_decorator(wrapped): -115 @functools.wraps(wrapped) -116 def positional_wrapper(*args, **kwargs): -117 if len(args) > max_positional_args: -118 plural_s = "" -119 if max_positional_args != 1: -120 plural_s = "s" -121 message = ( -122 "{function}() takes at most {args_max} positional " -123 "argument{plural} ({args_given} given)".format( -124 function=wrapped.__name__, -125 args_max=max_positional_args, -126 args_given=len(args), -127 plural=plural_s, -128 ) -129 ) -130 if positional_parameters_enforcement == POSITIONAL_EXCEPTION: -131 raise TypeError(message) -132 elif positional_parameters_enforcement == POSITIONAL_WARNING: -133 logger.warning(message) -134 return wrapped(*args, **kwargs) -135 -136 return positional_wrapper -137 -138 if isinstance(max_positional_args, six.integer_types): -139 return positional_decorator -140 else: -141 args, _, _, defaults = inspect.getargspec(max_positional_args) -142 return positional(len(args) - len(defaults))(max_positional_args) -143 -146 """Parses unique key-value parameters from urlencoded content. -147 -148 Args: -149 content: string, URL-encoded key-value pairs. -150 -151 Returns: -152 dict, The key-value pairs from ``content``. -153 -154 Raises: -155 ValueError: if one of the keys is repeated. -156 """ -157 urlencoded_params = urllib.parse.parse_qs(content) -158 params = {} -159 for key, value in six.iteritems(urlencoded_params): -160 if len(value) != 1: -161 msg = "URL-encoded content contains a repeated value:" "%s -> %s" % ( -162 key, -163 ", ".join(value), -164 ) -165 raise ValueError(msg) -166 params[key] = value[0] -167 return params -168 -171 """Updates a URI with new query parameters. -172 -173 If a given key from ``params`` is repeated in the ``uri``, then -174 the URI will be considered invalid and an error will occur. -175 -176 If the URI is valid, then each value from ``params`` will -177 replace the corresponding value in the query parameters (if -178 it exists). -179 -180 Args: -181 uri: string, A valid URI, with potential existing query parameters. -182 params: dict, A dictionary of query parameters. -183 -184 Returns: -185 The same URI but with the new query parameters added. -186 """ -187 parts = urllib.parse.urlparse(uri) -188 query_params = parse_unique_urlencoded(parts.query) -189 query_params.update(params) -190 new_query = urllib.parse.urlencode(query_params) -191 new_parts = parts._replace(query=new_query) -192 return urllib.parse.urlunparse(new_parts) -193 -196 """Adds a query parameter to a url. -197 -198 Replaces the current value if it already exists in the URL. -199 -200 Args: -201 url: string, url to add the query parameter to. -202 name: string, query parameter name. -203 value: string, query parameter value. -204 -205 Returns: -206 Updated query parameter. Does not update the url if value is None. -207 """ -208 if value is None: -209 return url -210 else: -211 return update_query_params(url, {name: value}) -212 -
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Module channel
-
-Channel notifications support.
-
-Classes and functions to support channel subscriptions and notifications
-on those channels.
-
-Notes:
- - This code is based on experimental APIs and is subject to change.
- - Notification does not do deduplication of notification ids, that's up to
- the receiver.
- - Storing the Channel between calls is up to the caller.
-
-
-Example setting up a channel:
-
- # Create a new channel that gets notifications via webhook.
- channel = new_webhook_channel("https://example.com/my_web_hook")
-
- # Store the channel, keyed by 'channel.id'. Store it before calling the
- # watch method because notifications may start arriving before the watch
- # method returns.
- ...
-
- resp = service.objects().watchAll(
- bucket="some_bucket_id", body=channel.body()).execute()
- channel.update(resp)
-
- # Store the channel, keyed by 'channel.id'. Store it after being updated
- # since the resource_id value will now be correct, and that's needed to
- # stop a subscription.
- ...
-
-
-An example Webhook implementation using webapp2. Note that webapp2 puts
-headers in a case insensitive dictionary, as headers aren't guaranteed to
-always be upper case.
-
- id = self.request.headers[X_GOOG_CHANNEL_ID]
-
- # Retrieve the channel by id.
- channel = ...
-
- # Parse notification from the headers, including validating the id.
- n = notification_from_headers(channel, self.request.headers)
-
- # Do app specific stuff with the notification here.
- if n.resource_state == 'sync':
- # Code to handle sync state.
- elif n.resource_state == 'exists':
- # Code to handle the exists state.
- elif n.resource_state == 'not_exists':
- # Code to handle the not exists state.
-
-
-Example of unsubscribing.
-
- service.channels().stop(channel.body()).execute()
-
-
-
-
-
-
-
|
-|||
| - - |
- Notification - A Notification from a Channel. - |
- ||
| - - |
- Channel - A Channel for notifications. - |
- ||
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
-
|
-|||
| - - |
- EPOCH = datetime.datetime(1970, 1, 1, 0, 0)
- |
- ||
| - - |
- CHANNEL_PARAMS = |
- ||
| - - |
- X_GOOG_CHANNEL_ID = |
- ||
| - - |
- X_GOOG_MESSAGE_NUMBER = |
- ||
| - - |
- X_GOOG_RESOURCE_STATE = |
- ||
| - - |
- X_GOOG_RESOURCE_URI = |
- ||
| - - |
- X_GOOG_RESOURCE_ID = |
- ||
| - - |
- __package__ = None
- |
- ||
-
|
-|||
-
-
-
-
-
-
-Parse a notification from the webhook request headers, validate - the notification, and return a Notification object. - -Args: - channel: Channel, The channel that the notification is associated with. - headers: dict, A dictionary like object that contains the request headers - from the webhook HTTP request. - -Returns: - A Notification object. - -Raises: - errors.InvalidNotificationError if the notification is invalid. - ValueError if the X-GOOG-MESSAGE-NUMBER can't be converted to an int. - --
|
-
-
-
-
-
-Create a new webhook Channel. - -Args: - url: str, URL to post notifications to. - token: str, An arbitrary string associated with the channel that - is delivered to the target address with each notification delivered - over this channel. - expiration: datetime.datetime, A time in the future when the channel - should expire. Can also be None if the subscription should use the - default expiration. Note that different services may have different - limits on how long a subscription lasts. Check the response from the - watch() method to see the value the service has set for an expiration - time. - params: dict, Extra parameters to pass on channel creation. Currently - not used for webhook channels. - --
|
- - -
-
|
-|||
-
-
-
-
- CHANNEL_PARAMS- -
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Source Code for Module googleapiclient.channel
-- 1 # Copyright 2014 Google Inc. All Rights Reserved. - 2 # - 3 # Licensed under the Apache License, Version 2.0 (the "License"); - 4 # you may not use this file except in compliance with the License. - 5 # You may obtain a copy of the License at - 6 # - 7 # http://www.apache.org/licenses/LICENSE-2.0 - 8 # - 9 # Unless required by applicable law or agreed to in writing, software - 10 # distributed under the License is distributed on an "AS IS" BASIS, - 11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - 12 # See the License for the specific language governing permissions and - 13 # limitations under the License. - 14 - 15 """Channel notifications support. - 16 - 17 Classes and functions to support channel subscriptions and notifications - 18 on those channels. - 19 - 20 Notes: - 21 - This code is based on experimental APIs and is subject to change. - 22 - Notification does not do deduplication of notification ids, that's up to - 23 the receiver. - 24 - Storing the Channel between calls is up to the caller. - 25 - 26 - 27 Example setting up a channel: - 28 - 29 # Create a new channel that gets notifications via webhook. - 30 channel = new_webhook_channel("https://example.com/my_web_hook") - 31 - 32 # Store the channel, keyed by 'channel.id'. Store it before calling the - 33 # watch method because notifications may start arriving before the watch - 34 # method returns. - 35 ... - 36 - 37 resp = service.objects().watchAll( - 38 bucket="some_bucket_id", body=channel.body()).execute() - 39 channel.update(resp) - 40 - 41 # Store the channel, keyed by 'channel.id'. Store it after being updated - 42 # since the resource_id value will now be correct, and that's needed to - 43 # stop a subscription. - 44 ... - 45 - 46 - 47 An example Webhook implementation using webapp2. Note that webapp2 puts - 48 headers in a case insensitive dictionary, as headers aren't guaranteed to - 49 always be upper case. - 50 - 51 id = self.request.headers[X_GOOG_CHANNEL_ID] - 52 - 53 # Retrieve the channel by id. - 54 channel = ... - 55 - 56 # Parse notification from the headers, including validating the id. - 57 n = notification_from_headers(channel, self.request.headers) - 58 - 59 # Do app specific stuff with the notification here. - 60 if n.resource_state == 'sync': - 61 # Code to handle sync state. - 62 elif n.resource_state == 'exists': - 63 # Code to handle the exists state. - 64 elif n.resource_state == 'not_exists': - 65 # Code to handle the not exists state. - 66 - 67 - 68 Example of unsubscribing. - 69 - 70 service.channels().stop(channel.body()).execute() - 71 """ - 72 from __future__ import absolute_import - 73 - 74 import datetime - 75 import uuid - 76 - 77 from googleapiclient import errors - 78 from googleapiclient import _helpers as util - 79 import six - 80 - 81 - 82 # The unix time epoch starts at midnight 1970. - 83 EPOCH = datetime.datetime.utcfromtimestamp(0) - 84 - 85 # Map the names of the parameters in the JSON channel description to - 86 # the parameter names we use in the Channel class. - 87 CHANNEL_PARAMS = { - 88 "address": "address", - 89 "id": "id", - 90 "expiration": "expiration", - 91 "params": "params", - 92 "resourceId": "resource_id", - 93 "resourceUri": "resource_uri", - 94 "type": "type", - 95 "token": "token", - 96 } - 97 - 98 X_GOOG_CHANNEL_ID = "X-GOOG-CHANNEL-ID" - 99 X_GOOG_MESSAGE_NUMBER = "X-GOOG-MESSAGE-NUMBER" -100 X_GOOG_RESOURCE_STATE = "X-GOOG-RESOURCE-STATE" -101 X_GOOG_RESOURCE_URI = "X-GOOG-RESOURCE-URI" -102 X_GOOG_RESOURCE_ID = "X-GOOG-RESOURCE-ID" --106 new_headers = {} -107 for k, v in six.iteritems(headers): -108 new_headers[k.upper()] = v -109 return new_headers -110 -113 """A Notification from a Channel. -114 -115 Notifications are not usually constructed directly, but are returned -116 from functions like notification_from_headers(). -117 -118 Attributes: -119 message_number: int, The unique id number of this notification. -120 state: str, The state of the resource being monitored. -121 uri: str, The address of the resource being monitored. -122 resource_id: str, The unique identifier of the version of the resource at -123 this event. -124 """ -125 -126 @util.positional(5) -141 -128 """Notification constructor. -129 -130 Args: -131 message_number: int, The unique id number of this notification. -132 state: str, The state of the resource being monitored. Can be one -133 of "exists", "not_exists", or "sync". -134 resource_uri: str, The address of the resource being monitored. -135 resource_id: str, The identifier of the watched resource. -136 """ -137 self.message_number = message_number -138 self.state = state -139 self.resource_uri = resource_uri -140 self.resource_id = resource_id -144 """A Channel for notifications. -145 -146 Usually not constructed directly, instead it is returned from helper -147 functions like new_webhook_channel(). -148 -149 Attributes: -150 type: str, The type of delivery mechanism used by this channel. For -151 example, 'web_hook'. -152 id: str, A UUID for the channel. -153 token: str, An arbitrary string associated with the channel that -154 is delivered to the target address with each event delivered -155 over this channel. -156 address: str, The address of the receiving entity where events are -157 delivered. Specific to the channel type. -158 expiration: int, The time, in milliseconds from the epoch, when this -159 channel will expire. -160 params: dict, A dictionary of string to string, with additional parameters -161 controlling delivery channel behavior. -162 resource_id: str, An opaque id that identifies the resource that is -163 being watched. Stable across different API versions. -164 resource_uri: str, The canonicalized ID of the watched resource. -165 """ -166 -167 @util.positional(5) -251 -168 - def __init__( -169 self, -170 type, -171 id, -172 token, -173 address, -174 expiration=None, -175 params=None, -176 resource_id="", -177 resource_uri="", -178 ): -179 """Create a new Channel. -180 -181 In user code, this Channel constructor will not typically be called -182 manually since there are functions for creating channels for each specific -183 type with a more customized set of arguments to pass. -184 -185 Args: -186 type: str, The type of delivery mechanism used by this channel. For -187 example, 'web_hook'. -188 id: str, A UUID for the channel. -189 token: str, An arbitrary string associated with the channel that -190 is delivered to the target address with each event delivered -191 over this channel. -192 address: str, The address of the receiving entity where events are -193 delivered. Specific to the channel type. -194 expiration: int, The time, in milliseconds from the epoch, when this -195 channel will expire. -196 params: dict, A dictionary of string to string, with additional parameters -197 controlling delivery channel behavior. -198 resource_id: str, An opaque id that identifies the resource that is -199 being watched. Stable across different API versions. -200 resource_uri: str, The canonicalized ID of the watched resource. -201 """ -202 self.type = type -203 self.id = id -204 self.token = token -205 self.address = address -206 self.expiration = expiration -207 self.params = params -208 self.resource_id = resource_id -209 self.resource_uri = resource_uri -210 -212 """Build a body from the Channel. -213 -214 Constructs a dictionary that's appropriate for passing into watch() -215 methods as the value of body argument. -216 -217 Returns: -218 A dictionary representation of the channel. -219 """ -220 result = { -221 "id": self.id, -222 "token": self.token, -223 "type": self.type, -224 "address": self.address, -225 } -226 if self.params: -227 result["params"] = self.params -228 if self.resource_id: -229 result["resourceId"] = self.resource_id -230 if self.resource_uri: -231 result["resourceUri"] = self.resource_uri -232 if self.expiration: -233 result["expiration"] = self.expiration -234 -235 return result -236 -238 """Update a channel with information from the response of watch(). -239 -240 When a request is sent to watch() a resource, the response returned -241 from the watch() request is a dictionary with updated channel information, -242 such as the resource_id, which is needed when stopping a subscription. -243 -244 Args: -245 resp: dict, The response from a watch() method. -246 """ -247 for json_name, param_name in six.iteritems(CHANNEL_PARAMS): -248 value = resp.get(json_name) -249 if value is not None: -250 setattr(self, param_name, value) -254 """Parse a notification from the webhook request headers, validate -255 the notification, and return a Notification object. -256 -257 Args: -258 channel: Channel, The channel that the notification is associated with. -259 headers: dict, A dictionary like object that contains the request headers -260 from the webhook HTTP request. -261 -262 Returns: -263 A Notification object. -264 -265 Raises: -266 errors.InvalidNotificationError if the notification is invalid. -267 ValueError if the X-GOOG-MESSAGE-NUMBER can't be converted to an int. -268 """ -269 headers = _upper_header_keys(headers) -270 channel_id = headers[X_GOOG_CHANNEL_ID] -271 if channel.id != channel_id: -272 raise errors.InvalidNotificationError( -273 "Channel id mismatch: %s != %s" % (channel.id, channel_id) -274 ) -275 else: -276 message_number = int(headers[X_GOOG_MESSAGE_NUMBER]) -277 state = headers[X_GOOG_RESOURCE_STATE] -278 resource_uri = headers[X_GOOG_RESOURCE_URI] -279 resource_id = headers[X_GOOG_RESOURCE_ID] -280 return Notification(message_number, state, resource_uri, resource_id) -281 -282 -283 @util.positional(2) -284 -def new_webhook_channel(url, token=None, expiration=None, params=None): -285 """Create a new webhook Channel. -286 -287 Args: -288 url: str, URL to post notifications to. -289 token: str, An arbitrary string associated with the channel that -290 is delivered to the target address with each notification delivered -291 over this channel. -292 expiration: datetime.datetime, A time in the future when the channel -293 should expire. Can also be None if the subscription should use the -294 default expiration. Note that different services may have different -295 limits on how long a subscription lasts. Check the response from the -296 watch() method to see the value the service has set for an expiration -297 time. -298 params: dict, Extra parameters to pass on channel creation. Currently -299 not used for webhook channels. -300 """ -301 expiration_ms = 0 -302 if expiration: -303 delta = expiration - EPOCH -304 expiration_ms = ( -305 delta.microseconds / 1000 + (delta.seconds + delta.days * 24 * 3600) * 1000 -306 ) -307 if expiration_ms < 0: -308 expiration_ms = 0 -309 -310 return Channel( -311 "web_hook", -312 str(uuid.uuid4()), -313 token, -314 url, -315 expiration=expiration_ms, -316 params=params, -317 ) -318 -
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class Channel
--object --+ - | - Channel -- -
-
-A Channel for notifications. - -Usually not constructed directly, instead it is returned from helper -functions like new_webhook_channel(). - -Attributes: - type: str, The type of delivery mechanism used by this channel. For - example, 'web_hook'. - id: str, A UUID for the channel. - token: str, An arbitrary string associated with the channel that - is delivered to the target address with each event delivered - over this channel. - address: str, The address of the receiving entity where events are - delivered. Specific to the channel type. - expiration: int, The time, in milliseconds from the epoch, when this - channel will expire. - params: dict, A dictionary of string to string, with additional parameters - controlling delivery channel behavior. - resource_id: str, An opaque id that identifies the resource that is - being watched. Stable across different API versions. - resource_uri: str, The canonicalized ID of the watched resource. - -- - - -
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
-Create a new Channel. - -In user code, this Channel constructor will not typically be called -manually since there are functions for creating channels for each specific -type with a more customized set of arguments to pass. - -Args: - type: str, The type of delivery mechanism used by this channel. For - example, 'web_hook'. - id: str, A UUID for the channel. - token: str, An arbitrary string associated with the channel that - is delivered to the target address with each event delivered - over this channel. - address: str, The address of the receiving entity where events are - delivered. Specific to the channel type. - expiration: int, The time, in milliseconds from the epoch, when this - channel will expire. - params: dict, A dictionary of string to string, with additional parameters - controlling delivery channel behavior. - resource_id: str, An opaque id that identifies the resource that is - being watched. Stable across different API versions. - resource_uri: str, The canonicalized ID of the watched resource. - --
|
-
-
-
-
-
-
-Build a body from the Channel. - -Constructs a dictionary that's appropriate for passing into watch() -methods as the value of body argument. - -Returns: - A dictionary representation of the channel. - --
|
-
-
-
-
-
-Update a channel with information from the response of watch(). - -When a request is sent to watch() a resource, the response returned -from the watch() request is a dictionary with updated channel information, -such as the resource_id, which is needed when stopping a subscription. - -Args: - resp: dict, The response from a watch() method. - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class Notification
--object --+ - | - Notification -- -
-
-A Notification from a Channel. - -Notifications are not usually constructed directly, but are returned -from functions like notification_from_headers(). - -Attributes: - message_number: int, The unique id number of this notification. - state: str, The state of the resource being monitored. - uri: str, The address of the resource being monitored. - resource_id: str, The unique identifier of the version of the resource at - this event. - -- - - -
-
|
-|||
| - - |
-
|
- ||
|
- Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-Notification constructor. - -Args: - message_number: int, The unique id number of this notification. - state: str, The state of the resource being monitored. Can be one - of "exists", "not_exists", or "sync". - resource_uri: str, The address of the resource being monitored. - resource_id: str, The identifier of the watched resource. - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Module discovery
-Client for discovery based APIs.
-A client library for Google's discovery based APIs.
- --
Author: - jcgregorio@google.com (Joe Gregorio) -
-
-
|
-|||
| - - | - _BytesGenerator - | -||
| - - |
- ResourceMethodParameters - Represents the parameters associated with a method. - |
- ||
| - - |
- Resource - A class for interacting with a resource. - |
- ||
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
-
|
-|||
| - - |
- google_auth_httplib2 = None
- |
- ||
| - - |
- logger = logging.getLogger(__name__)
- |
- ||
| - - |
- URITEMPLATE = re.compile("{[^}]*}")
- |
- ||
| - - |
- VARNAME = re.compile("[a-zA-Z0-9_-]+")
- |
- ||
| - - |
- DISCOVERY_URI = "https://www.googleapis.com/discovery/v1/apis/
- |
- ||
| - - |
- V1_DISCOVERY_URI = "https://www.googleapis.com/discovery/v1/ap
- |
- ||
| - - |
- V2_DISCOVERY_URI = "https://{api}.googleapis.com/$discovery/re
- |
- ||
| - - |
- DEFAULT_METHOD_DOC = "A description of how to use this function"
- |
- ||
| - - |
- HTTP_PAYLOAD_METHODS = frozenset(["PUT", "POST", "PATCH"])
- |
- ||
| - - |
- _MEDIA_SIZE_BIT_SHIFTS = {"KB": 10, "MB": 20, "GB": 30, "TB": 40}
- |
- ||
| - - |
- BODY_PARAMETER_DEFAULT_VALUE = {"description": "The request bo
- |
- ||
| - - |
- MEDIA_BODY_PARAMETER_DEFAULT_VALUE = {"description":("The file
- |
- ||
| - - |
- MEDIA_MIME_TYPE_PARAMETER_DEFAULT_VALUE = {"description":("The
- |
- ||
| - - |
- _PAGE_TOKEN_NAMES = "pageToken", "nextPageToken"
- |
- ||
| - - |
- GOOGLE_API_USE_CLIENT_CERTIFICATE = "GOOGLE_API_USE_CLIENT_CER
- |
- ||
| - - |
- GOOGLE_API_USE_MTLS_ENDPOINT = "GOOGLE_API_USE_MTLS_ENDPOINT"
- |
- ||
| - - |
- STACK_QUERY_PARAMETERS = frozenset(["trace", "pp", "userip", "
- |
- ||
| - - |
- STACK_QUERY_PARAMETER_DEFAULT_VALUE = {"type": "string", "loca
- |
- ||
| - - |
- RESERVED_WORDS = frozenset(["body"])
- |
- ||
-
|
-|||
-
-
-
-
-
-
-Fix method names to avoid '$' characters and reserved word conflicts. - -Args: - name: string, method name. - -Returns: - The name with '_' appended if the name is a reserved word and '$' and '-' - replaced with '_'. - --
|
-
-
-
-
-
-
-Converts key names into parameter names. - -For example, converting "max-results" -> "max_results" - -Args: - key: string, the method key name. - -Returns: - A safe method name based on the key name. - --
|
-
-
-
-
-
-
-Construct a Resource for interacting with an API.
-
-Construct a Resource object for interacting with an API. The serviceName and
-version are the names from the Discovery service.
-
-Args:
- serviceName: string, name of the service.
- version: string, the version of the service.
- http: httplib2.Http, An instance of httplib2.Http or something that acts
- like it that HTTP requests will be made through.
- discoveryServiceUrl: string, a URI Template that points to the location of
- the discovery service. It should have two parameters {api} and
- {apiVersion} that when filled in produce an absolute URI to the discovery
- document for that service.
- developerKey: string, key obtained from
- https://code.google.com/apis/console.
- model: googleapiclient.Model, converts to and from the wire format.
- requestBuilder: googleapiclient.http.HttpRequest, encapsulator for an HTTP
- request.
- credentials: oauth2client.Credentials or
- google.auth.credentials.Credentials, credentials to be used for
- authentication.
- cache_discovery: Boolean, whether or not to cache the discovery doc.
- cache: googleapiclient.discovery_cache.base.CacheBase, an optional
- cache object for the discovery documents.
- client_options: Mapping object or google.api_core.client_options, client
- options to set user options on the client.
- (1) The API endpoint should be set through client_options. If API endpoint
- is not set, `GOOGLE_API_USE_MTLS_ENDPOINT` environment variable can be used
- to control which endpoint to use.
- (2) client_cert_source is not supported, client cert should be provided using
- client_encrypted_cert_source instead. In order to use the provided client
- cert, `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be
- set to `true`.
- More details on the environment variables are here:
- https://google.aip.dev/auth/4114
- adc_cert_path: str, client certificate file path to save the application
- default client certificate for mTLS. This field is required if you want to
- use the default client certificate. `GOOGLE_API_USE_CLIENT_CERTIFICATE`
- environment variable must be set to `true` in order to use this field,
- otherwise this field doesn't nothing.
- More details on the environment variables are here:
- https://google.aip.dev/auth/4114
- adc_key_path: str, client encrypted private key file path to save the
- application default client encrypted private key for mTLS. This field is
- required if you want to use the default client certificate.
- `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be set to
- `true` in order to use this field, otherwise this field doesn't nothing.
- More details on the environment variables are here:
- https://google.aip.dev/auth/4114
- num_retries: Integer, number of times to retry discovery with
- randomized exponential backoff in case of intermittent/connection issues.
-
-Returns:
- A Resource object with methods for interacting with the service.
-
-Raises:
- google.auth.exceptions.MutualTLSChannelError: if there are any problems
- setting up mutual TLS channel.
-
-
-
|
-
-
-
-
-
-
- - Returns Discovery URIs to be used for attemnting to build the API Resource. - -Args: - discoveryServiceUrl: - string, the Original Discovery Service URL preferred by the customer. - version: - string, API Version requested - -Returns: - A list of URIs to be tried for the Service Discovery, in order. - - --
|
-
-
-
-
-
-
-Retrieves the discovery_doc from cache or the internet. - -Args: - url: string, the URL of the discovery document. - http: httplib2.Http, An instance of httplib2.Http or something that acts - like it through which HTTP requests will be made. - cache_discovery: Boolean, whether or not to cache the discovery doc. - cache: googleapiclient.discovery_cache.base.Cache, an optional cache - object for the discovery documents. - developerKey: string, Key for controlling API usage, generated - from the API Console. - num_retries: Integer, number of times to retry discovery with - randomized exponential backoff in case of intermittent/connection issues. - -Returns: - A unicode string representation of the discovery document. - --
|
-
-
-
-
-
-
-Create a Resource for interacting with an API. - -Same as `build()`, but constructs the Resource object from a discovery -document that is it given, as opposed to retrieving one over HTTP. - -Args: - service: string or object, the JSON discovery document describing the API. - The value passed in may either be the JSON string or the deserialized - JSON. - base: string, base URI for all HTTP requests, usually the discovery URI. - This parameter is no longer used as rootUrl and servicePath are included - within the discovery document. (deprecated) - future: string, discovery document with future capabilities (deprecated). - http: httplib2.Http, An instance of httplib2.Http or something that acts - like it that HTTP requests will be made through. - developerKey: string, Key for controlling API usage, generated - from the API Console. - model: Model class instance that serializes and de-serializes requests and - responses. - requestBuilder: Takes an http request and packages it up to be executed. - credentials: oauth2client.Credentials or - google.auth.credentials.Credentials, credentials to be used for - authentication. - client_options: Mapping object or google.api_core.client_options, client - options to set user options on the client. - (1) The API endpoint should be set through client_options. If API endpoint - is not set, `GOOGLE_API_USE_MTLS_ENDPOINT` environment variable can be used - to control which endpoint to use. - (2) client_cert_source is not supported, client cert should be provided using - client_encrypted_cert_source instead. In order to use the provided client - cert, `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be - set to `true`. - More details on the environment variables are here: - https://google.aip.dev/auth/4114 - adc_cert_path: str, client certificate file path to save the application - default client certificate for mTLS. This field is required if you want to - use the default client certificate. `GOOGLE_API_USE_CLIENT_CERTIFICATE` - environment variable must be set to `true` in order to use this field, - otherwise this field doesn't nothing. - More details on the environment variables are here: - https://google.aip.dev/auth/4114 - adc_key_path: str, client encrypted private key file path to save the - application default client encrypted private key for mTLS. This field is - required if you want to use the default client certificate. - `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be set to - `true` in order to use this field, otherwise this field doesn't nothing. - More details on the environment variables are here: - https://google.aip.dev/auth/4114 - -Returns: - A Resource object with methods for interacting with the service. - -Raises: - google.auth.exceptions.MutualTLSChannelError: if there are any problems - setting up mutual TLS channel. - --
|
-
-
-
-
-
-
-Convert value to a string based on JSON Schema type. - -See http://tools.ietf.org/html/draft-zyp-json-schema-03 for more details on -JSON Schema. - -Args: - value: any, the value to convert - schema_type: string, the type that value should be interpreted as - -Returns: - A string representation of 'value' based on the schema_type. - --
|
-
-
-
-
-
-
-Convert a string media size, such as 10GB or 3TB into an integer. - -Args: - maxSize: string, size as a string, such as 2MB or 7GB. - -Returns: - The size as an integer value. - --
|
-
-
-
-
-
-
-Creates an absolute media path URL. - -Constructed using the API root URI and service path from the discovery -document and the relative path for the API method. - -Args: - root_desc: Dictionary; the entire original deserialized discovery document. - path_url: String; the relative URL for the API method. Relative to the API - root, which is specified in the discovery document. - -Returns: - String; the absolute URI for media upload for the API method. - --
|
-
-
-
-
-
-
-Updates parameters of an API method with values specific to this library. - -Specifically, adds whatever global parameters are specified by the API to the -parameters for the individual method. Also adds parameters which don't -appear in the discovery document, but are available to all discovery based -APIs (these are listed in STACK_QUERY_PARAMETERS). - -SIDE EFFECTS: This updates the parameters dictionary object in the method -description. - -Args: - method_desc: Dictionary with metadata describing an API method. Value comes - from the dictionary of methods stored in the 'methods' key in the - deserialized discovery document. - root_desc: Dictionary; the entire original deserialized discovery document. - http_method: String; the HTTP method used to call the API method described - in method_desc. - schema: Object, mapping of schema names to schema descriptions. - -Returns: - The updated Dictionary stored in the 'parameters' key of the method - description dictionary. - --
|
-
-
-
-
-
-
-Adds 'media_body' and 'media_mime_type' parameters if supported by method. - -SIDE EFFECTS: If there is a 'mediaUpload' in the method description, adds -'media_upload' key to parameters. - -Args: - method_desc: Dictionary with metadata describing an API method. Value comes - from the dictionary of methods stored in the 'methods' key in the - deserialized discovery document. - root_desc: Dictionary; the entire original deserialized discovery document. - path_url: String; the relative URL for the API method. Relative to the API - root, which is specified in the discovery document. - parameters: A dictionary describing method parameters for method described - in method_desc. - -Returns: - Triple (accept, max_size, media_path_url) where: - - accept is a list of strings representing what content types are - accepted for media upload. Defaults to empty list if not in the - discovery document. - - max_size is a long representing the max size in bytes allowed for a - media upload. Defaults to 0L if not in the discovery document. - - media_path_url is a String; the absolute URI for media upload for the - API method. Constructed using the API root URI and service path from - the discovery document and the relative path for the API method. If - media upload is not supported, this is None. - --
|
-
-
-
-
-
-
-Updates a method description in a discovery document. - -SIDE EFFECTS: Changes the parameters dictionary in the method description with -extra parameters which are used locally. - -Args: - method_desc: Dictionary with metadata describing an API method. Value comes - from the dictionary of methods stored in the 'methods' key in the - deserialized discovery document. - root_desc: Dictionary; the entire original deserialized discovery document. - schema: Object, mapping of schema names to schema descriptions. - -Returns: - Tuple (path_url, http_method, method_id, accept, max_size, media_path_url) - where: - - path_url is a String; the relative URL for the API method. Relative to - the API root, which is specified in the discovery document. - - http_method is a String; the HTTP method used to call the API method - described in the method description. - - method_id is a String; the name of the RPC method associated with the - API method, and is in the method description in the 'id' key. - - accept is a list of strings representing what content types are - accepted for media upload. Defaults to empty list if not in the - discovery document. - - max_size is a long representing the max size in bytes allowed for a - media upload. Defaults to 0L if not in the discovery document. - - media_path_url is a String; the absolute URI for media upload for the - API method. Constructed using the API root URI and service path from - the discovery document and the relative path for the API method. If - media upload is not supported, this is None. - --
|
-
-
-
-
-
-
-Creates a method for attaching to a Resource. - -Args: - methodName: string, name of the method to use. - methodDesc: object, fragment of deserialized discovery document that - describes the method. - rootDesc: object, the entire deserialized discovery document. - schema: object, mapping of schema names to schema descriptions. - --
|
-
-
-
-
-
-
-Creates any _next methods for attaching to a Resource. - -The _next methods allow for easy iteration through list() responses. - -Args: - methodName: string, name of the method to use. - pageTokenName: string, name of request page token field. - nextPageTokenName: string, name of response page token field. - isPageTokenParameter: Boolean, True if request page token is a query - parameter, False if request page token is a field of the request body. - --
|
-
-
-
-
-
-
-Search field names for one like a page token. - -Args: - fields: container of string, names of fields. - -Returns: - First name that is either 'pageToken' or 'nextPageToken' if one exists, - otherwise None. - --
|
-
-
-
-
-
-Get properties of a field in a method description. - -Args: - methodDesc: object, fragment of deserialized discovery document that - describes the method. - schema: object, mapping of schema names to schema descriptions. - name: string, name of top-level field in method description. - -Returns: - Object representing fragment of deserialized discovery document - corresponding to 'properties' field of object corresponding to named field - in method description, if it exists, otherwise empty dict. - --
|
- - -
-
|
-|||
-
-
-
-
-
- DISCOVERY_URI- -
|
-
-
-
-
-
- V1_DISCOVERY_URI- -
|
-
-
-
-
-
- V2_DISCOVERY_URI- -
|
-
-
-
-
-
- BODY_PARAMETER_DEFAULT_VALUE- -
|
-
-
-
-
-
- MEDIA_BODY_PARAMETER_DEFAULT_VALUE- -
|
-
-
-
-
-
- MEDIA_MIME_TYPE_PARAMETER_DEFAULT_VALUE- -
|
-
-
-
-
-
- GOOGLE_API_USE_CLIENT_CERTIFICATE- -
|
-
-
-
-
-
- STACK_QUERY_PARAMETERS- -
|
-
-
-
-
- STACK_QUERY_PARAMETER_DEFAULT_VALUE- -
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Source Code for Module googleapiclient.discovery
-- 1 # Copyright 2014 Google Inc. All Rights Reserved. - 2 # - 3 # Licensed under the Apache License, Version 2.0 (the "License"); - 4 # you may not use this file except in compliance with the License. - 5 # You may obtain a copy of the License at - 6 # - 7 # http://www.apache.org/licenses/LICENSE-2.0 - 8 # - 9 # Unless required by applicable law or agreed to in writing, software - 10 # distributed under the License is distributed on an "AS IS" BASIS, - 11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - 12 # See the License for the specific language governing permissions and - 13 # limitations under the License. - 14 - 15 """Client for discovery based APIs. - 16 - 17 A client library for Google's discovery based APIs. - 18 """ - 19 from __future__ import absolute_import - 20 import six - 21 from six.moves import zip - 22 - 23 __author__ = "jcgregorio@google.com (Joe Gregorio)" - 24 __all__ = ["build", "build_from_document", "fix_method_name", "key2param"] - 25 - 26 from six import BytesIO - 27 from six.moves import http_client - 28 from six.moves.urllib.parse import urlencode, urlparse, urljoin, urlunparse, parse_qsl - 29 - 30 # Standard library imports - 31 import copy - 32 from collections import OrderedDict - 33 - 34 try: - 35 from email.generator import BytesGenerator - 36 except ImportError: - 37 from email.generator import Generator as BytesGenerator - 38 from email.mime.multipart import MIMEMultipart - 39 from email.mime.nonmultipart import MIMENonMultipart - 40 import json - 41 import keyword - 42 import logging - 43 import mimetypes - 44 import os - 45 import re - 46 - 47 # Third-party imports - 48 import httplib2 - 49 import uritemplate - 50 import google.api_core.client_options - 51 from google.auth.transport import mtls - 52 from google.auth.exceptions import MutualTLSChannelError - 53 - 54 try: - 55 import google_auth_httplib2 - 56 except ImportError: # pragma: NO COVER - 57 google_auth_httplib2 = None - 58 - 59 # Local imports - 60 from googleapiclient import _auth - 61 from googleapiclient import mimeparse - 62 from googleapiclient.errors import HttpError - 63 from googleapiclient.errors import InvalidJsonError - 64 from googleapiclient.errors import MediaUploadSizeError - 65 from googleapiclient.errors import UnacceptableMimeTypeError - 66 from googleapiclient.errors import UnknownApiNameOrVersion - 67 from googleapiclient.errors import UnknownFileType - 68 from googleapiclient.http import build_http - 69 from googleapiclient.http import BatchHttpRequest - 70 from googleapiclient.http import HttpMock - 71 from googleapiclient.http import HttpMockSequence - 72 from googleapiclient.http import HttpRequest - 73 from googleapiclient.http import MediaFileUpload - 74 from googleapiclient.http import MediaUpload - 75 from googleapiclient.model import JsonModel - 76 from googleapiclient.model import MediaModel - 77 from googleapiclient.model import RawModel - 78 from googleapiclient.schema import Schemas - 79 - 80 from googleapiclient._helpers import _add_query_parameter - 81 from googleapiclient._helpers import positional - 82 - 83 - 84 # The client library requires a version of httplib2 that supports RETRIES. - 85 httplib2.RETRIES = 1 - 86 - 87 logger = logging.getLogger(__name__) - 88 - 89 URITEMPLATE = re.compile("{[^}]*}") - 90 VARNAME = re.compile("[a-zA-Z0-9_-]+") - 91 DISCOVERY_URI = ( - 92 "https://www.googleapis.com/discovery/v1/apis/" "{api}/{apiVersion}/rest" - 93 ) - 94 V1_DISCOVERY_URI = DISCOVERY_URI - 95 V2_DISCOVERY_URI = ( - 96 "https://{api}.googleapis.com/$discovery/rest?" "version={apiVersion}" - 97 ) - 98 DEFAULT_METHOD_DOC = "A description of how to use this function" - 99 HTTP_PAYLOAD_METHODS = frozenset(["PUT", "POST", "PATCH"]) - 100 - 101 _MEDIA_SIZE_BIT_SHIFTS = {"KB": 10, "MB": 20, "GB": 30, "TB": 40} - 102 BODY_PARAMETER_DEFAULT_VALUE = {"description": "The request body.", "type": "object"} - 103 MEDIA_BODY_PARAMETER_DEFAULT_VALUE = { - 104 "description": ( - 105 "The filename of the media request body, or an instance " - 106 "of a MediaUpload object." - 107 ), - 108 "type": "string", - 109 "required": False, - 110 } - 111 MEDIA_MIME_TYPE_PARAMETER_DEFAULT_VALUE = { - 112 "description": ( - 113 "The MIME type of the media request body, or an instance " - 114 "of a MediaUpload object." - 115 ), - 116 "type": "string", - 117 "required": False, - 118 } - 119 _PAGE_TOKEN_NAMES = ("pageToken", "nextPageToken") - 120 - 121 # Parameters controlling mTLS behavior. See https://google.aip.dev/auth/4114. - 122 GOOGLE_API_USE_CLIENT_CERTIFICATE = "GOOGLE_API_USE_CLIENT_CERTIFICATE" - 123 GOOGLE_API_USE_MTLS_ENDPOINT = "GOOGLE_API_USE_MTLS_ENDPOINT" - 124 - 125 # Parameters accepted by the stack, but not visible via discovery. - 126 # TODO(dhermes): Remove 'userip' in 'v2'. - 127 STACK_QUERY_PARAMETERS = frozenset(["trace", "pp", "userip", "strict"]) - 128 STACK_QUERY_PARAMETER_DEFAULT_VALUE = {"type": "string", "location": "query"} - 129 - 130 # Library-specific reserved words beyond Python keywords. - 131 RESERVED_WORDS = frozenset(["body"]) --132 - 133 # patch _write_lines to avoid munging '\r' into '\n' - 134 # ( https://bugs.python.org/issue18886 https://bugs.python.org/issue19003 ) - 135 -class _BytesGenerator(BytesGenerator): -136 _write_lines = BytesGenerator.write -137 -140 """Fix method names to avoid '$' characters and reserved word conflicts. - 141 - 142 Args: - 143 name: string, method name. - 144 - 145 Returns: - 146 The name with '_' appended if the name is a reserved word and '$' and '-' - 147 replaced with '_'. - 148 """ - 149 name = name.replace("$", "_").replace("-", "_") - 150 if keyword.iskeyword(name) or name in RESERVED_WORDS: - 151 return name + "_" - 152 else: - 153 return name -154 -157 """Converts key names into parameter names. - 158 - 159 For example, converting "max-results" -> "max_results" - 160 - 161 Args: - 162 key: string, the method key name. - 163 - 164 Returns: - 165 A safe method name based on the key name. - 166 """ - 167 result = [] - 168 key = list(key) - 169 if not key[0].isalpha(): - 170 result.append("x") - 171 for c in key: - 172 if c.isalnum(): - 173 result.append(c) - 174 else: - 175 result.append("_") - 176 - 177 return "".join(result) -178 -179 - 180 @positional(2) - 181 -def build( - 182 serviceName, - 183 version, - 184 http=None, - 185 discoveryServiceUrl=DISCOVERY_URI, - 186 developerKey=None, - 187 model=None, - 188 requestBuilder=HttpRequest, - 189 credentials=None, - 190 cache_discovery=True, - 191 cache=None, - 192 client_options=None, - 193 adc_cert_path=None, - 194 adc_key_path=None, - 195 num_retries=1, - 196 ): -197 """Construct a Resource for interacting with an API. - 198 - 199 Construct a Resource object for interacting with an API. The serviceName and - 200 version are the names from the Discovery service. - 201 - 202 Args: - 203 serviceName: string, name of the service. - 204 version: string, the version of the service. - 205 http: httplib2.Http, An instance of httplib2.Http or something that acts - 206 like it that HTTP requests will be made through. - 207 discoveryServiceUrl: string, a URI Template that points to the location of - 208 the discovery service. It should have two parameters {api} and - 209 {apiVersion} that when filled in produce an absolute URI to the discovery - 210 document for that service. - 211 developerKey: string, key obtained from - 212 https://code.google.com/apis/console. - 213 model: googleapiclient.Model, converts to and from the wire format. - 214 requestBuilder: googleapiclient.http.HttpRequest, encapsulator for an HTTP - 215 request. - 216 credentials: oauth2client.Credentials or - 217 google.auth.credentials.Credentials, credentials to be used for - 218 authentication. - 219 cache_discovery: Boolean, whether or not to cache the discovery doc. - 220 cache: googleapiclient.discovery_cache.base.CacheBase, an optional - 221 cache object for the discovery documents. - 222 client_options: Mapping object or google.api_core.client_options, client - 223 options to set user options on the client. - 224 (1) The API endpoint should be set through client_options. If API endpoint - 225 is not set, `GOOGLE_API_USE_MTLS_ENDPOINT` environment variable can be used - 226 to control which endpoint to use. - 227 (2) client_cert_source is not supported, client cert should be provided using - 228 client_encrypted_cert_source instead. In order to use the provided client - 229 cert, `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be - 230 set to `true`. - 231 More details on the environment variables are here: - 232 https://google.aip.dev/auth/4114 - 233 adc_cert_path: str, client certificate file path to save the application - 234 default client certificate for mTLS. This field is required if you want to - 235 use the default client certificate. `GOOGLE_API_USE_CLIENT_CERTIFICATE` - 236 environment variable must be set to `true` in order to use this field, - 237 otherwise this field doesn't nothing. - 238 More details on the environment variables are here: - 239 https://google.aip.dev/auth/4114 - 240 adc_key_path: str, client encrypted private key file path to save the - 241 application default client encrypted private key for mTLS. This field is - 242 required if you want to use the default client certificate. - 243 `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be set to - 244 `true` in order to use this field, otherwise this field doesn't nothing. - 245 More details on the environment variables are here: - 246 https://google.aip.dev/auth/4114 - 247 num_retries: Integer, number of times to retry discovery with - 248 randomized exponential backoff in case of intermittent/connection issues. - 249 - 250 Returns: - 251 A Resource object with methods for interacting with the service. - 252 - 253 Raises: - 254 google.auth.exceptions.MutualTLSChannelError: if there are any problems - 255 setting up mutual TLS channel. - 256 """ - 257 params = {"api": serviceName, "apiVersion": version} - 258 - 259 if http is None: - 260 discovery_http = build_http() - 261 else: - 262 discovery_http = http - 263 - 264 service = None - 265 - 266 for discovery_url in _discovery_service_uri_options(discoveryServiceUrl, version): - 267 requested_url = uritemplate.expand(discovery_url, params) - 268 - 269 try: - 270 content = _retrieve_discovery_doc( - 271 requested_url, - 272 discovery_http, - 273 cache_discovery, - 274 cache, - 275 developerKey, - 276 num_retries=num_retries, - 277 ) - 278 service = build_from_document( - 279 content, - 280 base=discovery_url, - 281 http=http, - 282 developerKey=developerKey, - 283 model=model, - 284 requestBuilder=requestBuilder, - 285 credentials=credentials, - 286 client_options=client_options, - 287 adc_cert_path=adc_cert_path, - 288 adc_key_path=adc_key_path, - 289 ) - 290 break # exit if a service was created - 291 except HttpError as e: - 292 if e.resp.status == http_client.NOT_FOUND: - 293 continue - 294 else: - 295 raise e - 296 - 297 # If discovery_http was created by this function, we are done with it - 298 # and can safely close it - 299 if http is None: - 300 discovery_http.close() - 301 - 302 if service is None: - 303 raise UnknownApiNameOrVersion("name: %s version: %s" % (serviceName, version)) - 304 else: - 305 return service -306 -309 """ - 310 Returns Discovery URIs to be used for attemnting to build the API Resource. - 311 - 312 Args: - 313 discoveryServiceUrl: - 314 string, the Original Discovery Service URL preferred by the customer. - 315 version: - 316 string, API Version requested - 317 - 318 Returns: - 319 A list of URIs to be tried for the Service Discovery, in order. - 320 """ - 321 - 322 urls = [discoveryServiceUrl, V2_DISCOVERY_URI] - 323 # V1 Discovery won't work if the requested version is None - 324 if discoveryServiceUrl == V1_DISCOVERY_URI and version is None: - 325 logger.warning( - 326 "Discovery V1 does not support empty versions. Defaulting to V2..." - 327 ) - 328 urls.pop(0) - 329 return list(OrderedDict.fromkeys(urls)) -330 -331 - 332 -def _retrieve_discovery_doc( - 333 url, http, cache_discovery, cache=None, developerKey=None, num_retries=1 - 334 ): -335 """Retrieves the discovery_doc from cache or the internet. - 336 - 337 Args: - 338 url: string, the URL of the discovery document. - 339 http: httplib2.Http, An instance of httplib2.Http or something that acts - 340 like it through which HTTP requests will be made. - 341 cache_discovery: Boolean, whether or not to cache the discovery doc. - 342 cache: googleapiclient.discovery_cache.base.Cache, an optional cache - 343 object for the discovery documents. - 344 developerKey: string, Key for controlling API usage, generated - 345 from the API Console. - 346 num_retries: Integer, number of times to retry discovery with - 347 randomized exponential backoff in case of intermittent/connection issues. - 348 - 349 Returns: - 350 A unicode string representation of the discovery document. - 351 """ - 352 if cache_discovery: - 353 from . import discovery_cache - 354 - 355 if cache is None: - 356 cache = discovery_cache.autodetect() - 357 if cache: - 358 content = cache.get(url) - 359 if content: - 360 return content - 361 - 362 actual_url = url - 363 # REMOTE_ADDR is defined by the CGI spec [RFC3875] as the environment - 364 # variable that contains the network address of the client sending the - 365 # request. If it exists then add that to the request for the discovery - 366 # document to avoid exceeding the quota on discovery requests. - 367 if "REMOTE_ADDR" in os.environ: - 368 actual_url = _add_query_parameter(url, "userIp", os.environ["REMOTE_ADDR"]) - 369 if developerKey: - 370 actual_url = _add_query_parameter(url, "key", developerKey) - 371 logger.debug("URL being requested: GET %s", actual_url) - 372 - 373 # Execute this request with retries build into HttpRequest - 374 # Note that it will already raise an error if we don't get a 2xx response - 375 req = HttpRequest(http, HttpRequest.null_postproc, actual_url) - 376 resp, content = req.execute(num_retries=num_retries) - 377 - 378 try: - 379 content = content.decode("utf-8") - 380 except AttributeError: - 381 pass - 382 - 383 try: - 384 service = json.loads(content) - 385 except ValueError as e: - 386 logger.error("Failed to parse as JSON: " + content) - 387 raise InvalidJsonError() - 388 if cache_discovery and cache: - 389 cache.set(url, content) - 390 return content -391 -392 - 393 @positional(1) - 394 -def build_from_document( - 395 service, - 396 base=None, - 397 future=None, - 398 http=None, - 399 developerKey=None, - 400 model=None, - 401 requestBuilder=HttpRequest, - 402 credentials=None, - 403 client_options=None, - 404 adc_cert_path=None, - 405 adc_key_path=None, - 406 ): -407 """Create a Resource for interacting with an API. - 408 - 409 Same as `build()`, but constructs the Resource object from a discovery - 410 document that is it given, as opposed to retrieving one over HTTP. - 411 - 412 Args: - 413 service: string or object, the JSON discovery document describing the API. - 414 The value passed in may either be the JSON string or the deserialized - 415 JSON. - 416 base: string, base URI for all HTTP requests, usually the discovery URI. - 417 This parameter is no longer used as rootUrl and servicePath are included - 418 within the discovery document. (deprecated) - 419 future: string, discovery document with future capabilities (deprecated). - 420 http: httplib2.Http, An instance of httplib2.Http or something that acts - 421 like it that HTTP requests will be made through. - 422 developerKey: string, Key for controlling API usage, generated - 423 from the API Console. - 424 model: Model class instance that serializes and de-serializes requests and - 425 responses. - 426 requestBuilder: Takes an http request and packages it up to be executed. - 427 credentials: oauth2client.Credentials or - 428 google.auth.credentials.Credentials, credentials to be used for - 429 authentication. - 430 client_options: Mapping object or google.api_core.client_options, client - 431 options to set user options on the client. - 432 (1) The API endpoint should be set through client_options. If API endpoint - 433 is not set, `GOOGLE_API_USE_MTLS_ENDPOINT` environment variable can be used - 434 to control which endpoint to use. - 435 (2) client_cert_source is not supported, client cert should be provided using - 436 client_encrypted_cert_source instead. In order to use the provided client - 437 cert, `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be - 438 set to `true`. - 439 More details on the environment variables are here: - 440 https://google.aip.dev/auth/4114 - 441 adc_cert_path: str, client certificate file path to save the application - 442 default client certificate for mTLS. This field is required if you want to - 443 use the default client certificate. `GOOGLE_API_USE_CLIENT_CERTIFICATE` - 444 environment variable must be set to `true` in order to use this field, - 445 otherwise this field doesn't nothing. - 446 More details on the environment variables are here: - 447 https://google.aip.dev/auth/4114 - 448 adc_key_path: str, client encrypted private key file path to save the - 449 application default client encrypted private key for mTLS. This field is - 450 required if you want to use the default client certificate. - 451 `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be set to - 452 `true` in order to use this field, otherwise this field doesn't nothing. - 453 More details on the environment variables are here: - 454 https://google.aip.dev/auth/4114 - 455 - 456 Returns: - 457 A Resource object with methods for interacting with the service. - 458 - 459 Raises: - 460 google.auth.exceptions.MutualTLSChannelError: if there are any problems - 461 setting up mutual TLS channel. - 462 """ - 463 - 464 if client_options is None: - 465 client_options = google.api_core.client_options.ClientOptions() - 466 if isinstance(client_options, six.moves.collections_abc.Mapping): - 467 client_options = google.api_core.client_options.from_dict(client_options) - 468 - 469 if http is not None: - 470 # if http is passed, the user cannot provide credentials - 471 banned_options = [ - 472 (credentials, "credentials"), - 473 (client_options.credentials_file, "client_options.credentials_file"), - 474 ] - 475 for option, name in banned_options: - 476 if option is not None: - 477 raise ValueError("Arguments http and {} are mutually exclusive".format(name)) - 478 - 479 if isinstance(service, six.string_types): - 480 service = json.loads(service) - 481 elif isinstance(service, six.binary_type): - 482 service = json.loads(service.decode("utf-8")) - 483 - 484 if "rootUrl" not in service and isinstance(http, (HttpMock, HttpMockSequence)): - 485 logger.error( - 486 "You are using HttpMock or HttpMockSequence without" - 487 + "having the service discovery doc in cache. Try calling " - 488 + "build() without mocking once first to populate the " - 489 + "cache." - 490 ) - 491 raise InvalidJsonError() - 492 - 493 # If an API Endpoint is provided on client options, use that as the base URL - 494 base = urljoin(service["rootUrl"], service["servicePath"]) - 495 if client_options.api_endpoint: - 496 base = client_options.api_endpoint - 497 - 498 schema = Schemas(service) - 499 - 500 # If the http client is not specified, then we must construct an http client - 501 # to make requests. If the service has scopes, then we also need to setup - 502 # authentication. - 503 if http is None: - 504 # Does the service require scopes? - 505 scopes = list( - 506 service.get("auth", {}).get("oauth2", {}).get("scopes", {}).keys() - 507 ) - 508 - 509 # If so, then the we need to setup authentication if no developerKey is - 510 # specified. - 511 if scopes and not developerKey: - 512 # Make sure the user didn't pass multiple credentials - 513 if client_options.credentials_file and credentials: - 514 raise google.api_core.exceptions.DuplicateCredentialArgs( - 515 "client_options.credentials_file and credentials are mutually exclusive." - 516 ) - 517 # Check for credentials file via client options - 518 if client_options.credentials_file: - 519 credentials = _auth.credentials_from_file( - 520 client_options.credentials_file, - 521 scopes=client_options.scopes, - 522 quota_project_id=client_options.quota_project_id, - 523 ) - 524 # If the user didn't pass in credentials, attempt to acquire application - 525 # default credentials. - 526 if credentials is None: - 527 credentials = _auth.default_credentials( - 528 scopes=client_options.scopes, - 529 quota_project_id=client_options.quota_project_id, - 530 ) - 531 - 532 # The credentials need to be scoped. - 533 # If the user provided scopes via client_options don't override them - 534 if not client_options.scopes: - 535 credentials = _auth.with_scopes(credentials, scopes) - 536 - 537 # If credentials are provided, create an authorized http instance; - 538 # otherwise, skip authentication. - 539 if credentials: - 540 http = _auth.authorized_http(credentials) - 541 - 542 # If the service doesn't require scopes then there is no need for - 543 # authentication. - 544 else: - 545 http = build_http() - 546 - 547 # Obtain client cert and create mTLS http channel if cert exists. - 548 client_cert_to_use = None - 549 use_client_cert = os.getenv(GOOGLE_API_USE_CLIENT_CERTIFICATE, "false") - 550 if not use_client_cert in ("true", "false"): - 551 raise MutualTLSChannelError( - 552 "Unsupported GOOGLE_API_USE_CLIENT_CERTIFICATE value. Accepted values: true, false" - 553 ) - 554 if client_options and client_options.client_cert_source: - 555 raise MutualTLSChannelError( - 556 "ClientOptions.client_cert_source is not supported, please use ClientOptions.client_encrypted_cert_source." - 557 ) - 558 if use_client_cert == "true": - 559 if ( - 560 client_options - 561 and hasattr(client_options, "client_encrypted_cert_source") - 562 and client_options.client_encrypted_cert_source - 563 ): - 564 client_cert_to_use = client_options.client_encrypted_cert_source - 565 elif ( - 566 adc_cert_path and adc_key_path and mtls.has_default_client_cert_source() - 567 ): - 568 client_cert_to_use = mtls.default_client_encrypted_cert_source( - 569 adc_cert_path, adc_key_path - 570 ) - 571 if client_cert_to_use: - 572 cert_path, key_path, passphrase = client_cert_to_use() - 573 - 574 # The http object we built could be google_auth_httplib2.AuthorizedHttp - 575 # or httplib2.Http. In the first case we need to extract the wrapped - 576 # httplib2.Http object from google_auth_httplib2.AuthorizedHttp. - 577 http_channel = ( - 578 http.http - 579 if google_auth_httplib2 - 580 and isinstance(http, google_auth_httplib2.AuthorizedHttp) - 581 else http - 582 ) - 583 http_channel.add_certificate(key_path, cert_path, "", passphrase) - 584 - 585 # If user doesn't provide api endpoint via client options, decide which - 586 # api endpoint to use. - 587 if "mtlsRootUrl" in service and ( - 588 not client_options or not client_options.api_endpoint - 589 ): - 590 mtls_endpoint = urljoin(service["mtlsRootUrl"], service["servicePath"]) - 591 use_mtls_endpoint = os.getenv(GOOGLE_API_USE_MTLS_ENDPOINT, "auto") - 592 - 593 if not use_mtls_endpoint in ("never", "auto", "always"): - 594 raise MutualTLSChannelError( - 595 "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted values: never, auto, always" - 596 ) - 597 - 598 # Switch to mTLS endpoint, if environment variable is "always", or - 599 # environment varibable is "auto" and client cert exists. - 600 if use_mtls_endpoint == "always" or ( - 601 use_mtls_endpoint == "auto" and client_cert_to_use - 602 ): - 603 base = mtls_endpoint - 604 - 605 if model is None: - 606 features = service.get("features", []) - 607 model = JsonModel("dataWrapper" in features) - 608 - 609 return Resource( - 610 http=http, - 611 baseUrl=base, - 612 model=model, - 613 developerKey=developerKey, - 614 requestBuilder=requestBuilder, - 615 resourceDesc=service, - 616 rootDesc=service, - 617 schema=schema, - 618 ) -619 -622 """Convert value to a string based on JSON Schema type. - 623 - 624 See http://tools.ietf.org/html/draft-zyp-json-schema-03 for more details on - 625 JSON Schema. - 626 - 627 Args: - 628 value: any, the value to convert - 629 schema_type: string, the type that value should be interpreted as - 630 - 631 Returns: - 632 A string representation of 'value' based on the schema_type. - 633 """ - 634 if schema_type == "string": - 635 if type(value) == type("") or type(value) == type(u""): - 636 return value - 637 else: - 638 return str(value) - 639 elif schema_type == "integer": - 640 return str(int(value)) - 641 elif schema_type == "number": - 642 return str(float(value)) - 643 elif schema_type == "boolean": - 644 return str(bool(value)).lower() - 645 else: - 646 if type(value) == type("") or type(value) == type(u""): - 647 return value - 648 else: - 649 return str(value) -650 -653 """Convert a string media size, such as 10GB or 3TB into an integer. - 654 - 655 Args: - 656 maxSize: string, size as a string, such as 2MB or 7GB. - 657 - 658 Returns: - 659 The size as an integer value. - 660 """ - 661 if len(maxSize) < 2: - 662 return 0 - 663 units = maxSize[-2:].upper() - 664 bit_shift = _MEDIA_SIZE_BIT_SHIFTS.get(units) - 665 if bit_shift is not None: - 666 return int(maxSize[:-2]) << bit_shift - 667 else: - 668 return int(maxSize) -669 -672 """Creates an absolute media path URL. - 673 - 674 Constructed using the API root URI and service path from the discovery - 675 document and the relative path for the API method. - 676 - 677 Args: - 678 root_desc: Dictionary; the entire original deserialized discovery document. - 679 path_url: String; the relative URL for the API method. Relative to the API - 680 root, which is specified in the discovery document. - 681 - 682 Returns: - 683 String; the absolute URI for media upload for the API method. - 684 """ - 685 return "%(root)supload/%(service_path)s%(path)s" % { - 686 "root": root_desc["rootUrl"], - 687 "service_path": root_desc["servicePath"], - 688 "path": path_url, - 689 } -690 -693 """Updates parameters of an API method with values specific to this library. - 694 - 695 Specifically, adds whatever global parameters are specified by the API to the - 696 parameters for the individual method. Also adds parameters which don't - 697 appear in the discovery document, but are available to all discovery based - 698 APIs (these are listed in STACK_QUERY_PARAMETERS). - 699 - 700 SIDE EFFECTS: This updates the parameters dictionary object in the method - 701 description. - 702 - 703 Args: - 704 method_desc: Dictionary with metadata describing an API method. Value comes - 705 from the dictionary of methods stored in the 'methods' key in the - 706 deserialized discovery document. - 707 root_desc: Dictionary; the entire original deserialized discovery document. - 708 http_method: String; the HTTP method used to call the API method described - 709 in method_desc. - 710 schema: Object, mapping of schema names to schema descriptions. - 711 - 712 Returns: - 713 The updated Dictionary stored in the 'parameters' key of the method - 714 description dictionary. - 715 """ - 716 parameters = method_desc.setdefault("parameters", {}) - 717 - 718 # Add in the parameters common to all methods. - 719 for name, description in six.iteritems(root_desc.get("parameters", {})): - 720 parameters[name] = description - 721 - 722 # Add in undocumented query parameters. - 723 for name in STACK_QUERY_PARAMETERS: - 724 parameters[name] = STACK_QUERY_PARAMETER_DEFAULT_VALUE.copy() - 725 - 726 # Add 'body' (our own reserved word) to parameters if the method supports - 727 # a request payload. - 728 if http_method in HTTP_PAYLOAD_METHODS and "request" in method_desc: - 729 body = BODY_PARAMETER_DEFAULT_VALUE.copy() - 730 body.update(method_desc["request"]) - 731 parameters["body"] = body - 732 - 733 return parameters -734 -737 """Adds 'media_body' and 'media_mime_type' parameters if supported by method. - 738 - 739 SIDE EFFECTS: If there is a 'mediaUpload' in the method description, adds - 740 'media_upload' key to parameters. - 741 - 742 Args: - 743 method_desc: Dictionary with metadata describing an API method. Value comes - 744 from the dictionary of methods stored in the 'methods' key in the - 745 deserialized discovery document. - 746 root_desc: Dictionary; the entire original deserialized discovery document. - 747 path_url: String; the relative URL for the API method. Relative to the API - 748 root, which is specified in the discovery document. - 749 parameters: A dictionary describing method parameters for method described - 750 in method_desc. - 751 - 752 Returns: - 753 Triple (accept, max_size, media_path_url) where: - 754 - accept is a list of strings representing what content types are - 755 accepted for media upload. Defaults to empty list if not in the - 756 discovery document. - 757 - max_size is a long representing the max size in bytes allowed for a - 758 media upload. Defaults to 0L if not in the discovery document. - 759 - media_path_url is a String; the absolute URI for media upload for the - 760 API method. Constructed using the API root URI and service path from - 761 the discovery document and the relative path for the API method. If - 762 media upload is not supported, this is None. - 763 """ - 764 media_upload = method_desc.get("mediaUpload", {}) - 765 accept = media_upload.get("accept", []) - 766 max_size = _media_size_to_long(media_upload.get("maxSize", "")) - 767 media_path_url = None - 768 - 769 if media_upload: - 770 media_path_url = _media_path_url_from_info(root_desc, path_url) - 771 parameters["media_body"] = MEDIA_BODY_PARAMETER_DEFAULT_VALUE.copy() - 772 parameters["media_mime_type"] = MEDIA_MIME_TYPE_PARAMETER_DEFAULT_VALUE.copy() - 773 - 774 return accept, max_size, media_path_url -775 -778 """Updates a method description in a discovery document. - 779 - 780 SIDE EFFECTS: Changes the parameters dictionary in the method description with - 781 extra parameters which are used locally. - 782 - 783 Args: - 784 method_desc: Dictionary with metadata describing an API method. Value comes - 785 from the dictionary of methods stored in the 'methods' key in the - 786 deserialized discovery document. - 787 root_desc: Dictionary; the entire original deserialized discovery document. - 788 schema: Object, mapping of schema names to schema descriptions. - 789 - 790 Returns: - 791 Tuple (path_url, http_method, method_id, accept, max_size, media_path_url) - 792 where: - 793 - path_url is a String; the relative URL for the API method. Relative to - 794 the API root, which is specified in the discovery document. - 795 - http_method is a String; the HTTP method used to call the API method - 796 described in the method description. - 797 - method_id is a String; the name of the RPC method associated with the - 798 API method, and is in the method description in the 'id' key. - 799 - accept is a list of strings representing what content types are - 800 accepted for media upload. Defaults to empty list if not in the - 801 discovery document. - 802 - max_size is a long representing the max size in bytes allowed for a - 803 media upload. Defaults to 0L if not in the discovery document. - 804 - media_path_url is a String; the absolute URI for media upload for the - 805 API method. Constructed using the API root URI and service path from - 806 the discovery document and the relative path for the API method. If - 807 media upload is not supported, this is None. - 808 """ - 809 path_url = method_desc["path"] - 810 http_method = method_desc["httpMethod"] - 811 method_id = method_desc["id"] - 812 - 813 parameters = _fix_up_parameters(method_desc, root_desc, http_method, schema) - 814 # Order is important. `_fix_up_media_upload` needs `method_desc` to have a - 815 # 'parameters' key and needs to know if there is a 'body' parameter because it - 816 # also sets a 'media_body' parameter. - 817 accept, max_size, media_path_url = _fix_up_media_upload( - 818 method_desc, root_desc, path_url, parameters - 819 ) - 820 - 821 return path_url, http_method, method_id, accept, max_size, media_path_url -822 -825 """Custom urljoin replacement supporting : before / in url.""" - 826 # In general, it's unsafe to simply join base and url. However, for - 827 # the case of discovery documents, we know: - 828 # * base will never contain params, query, or fragment - 829 # * url will never contain a scheme or net_loc. - 830 # In general, this means we can safely join on /; we just need to - 831 # ensure we end up with precisely one / joining base and url. The - 832 # exception here is the case of media uploads, where url will be an - 833 # absolute url. - 834 if url.startswith("http://") or url.startswith("https://"): - 835 return urljoin(base, url) - 836 new_base = base if base.endswith("/") else base + "/" - 837 new_url = url[1:] if url.startswith("/") else url - 838 return new_base + new_url -839 -840 - 841 # TODO(dhermes): Convert this class to ResourceMethod and make it callable - 842 -class ResourceMethodParameters(object): -843 """Represents the parameters associated with a method. - 844 - 845 Attributes: - 846 argmap: Map from method parameter name (string) to query parameter name - 847 (string). - 848 required_params: List of required parameters (represented by parameter - 849 name as string). - 850 repeated_params: List of repeated parameters (represented by parameter - 851 name as string). - 852 pattern_params: Map from method parameter name (string) to regular - 853 expression (as a string). If the pattern is set for a parameter, the - 854 value for that parameter must match the regular expression. - 855 query_params: List of parameters (represented by parameter name as string) - 856 that will be used in the query string. - 857 path_params: Set of parameters (represented by parameter name as string) - 858 that will be used in the base URL path. - 859 param_types: Map from method parameter name (string) to parameter type. Type - 860 can be any valid JSON schema type; valid values are 'any', 'array', - 861 'boolean', 'integer', 'number', 'object', or 'string'. Reference: - 862 http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 - 863 enum_params: Map from method parameter name (string) to list of strings, - 864 where each list of strings is the list of acceptable enum values. - 865 """ - 866 -928 -868 """Constructor for ResourceMethodParameters. - 869 - 870 Sets default values and defers to set_parameters to populate. - 871 - 872 Args: - 873 method_desc: Dictionary with metadata describing an API method. Value - 874 comes from the dictionary of methods stored in the 'methods' key in - 875 the deserialized discovery document. - 876 """ - 877 self.argmap = {} - 878 self.required_params = [] - 879 self.repeated_params = [] - 880 self.pattern_params = {} - 881 self.query_params = [] - 882 # TODO(dhermes): Change path_params to a list if the extra URITEMPLATE - 883 # parsing is gotten rid of. - 884 self.path_params = set() - 885 self.param_types = {} - 886 self.enum_params = {} - 887 - 888 self.set_parameters(method_desc) -889 -891 """Populates maps and lists based on method description. - 892 - 893 Iterates through each parameter for the method and parses the values from - 894 the parameter dictionary. - 895 - 896 Args: - 897 method_desc: Dictionary with metadata describing an API method. Value - 898 comes from the dictionary of methods stored in the 'methods' key in - 899 the deserialized discovery document. - 900 """ - 901 for arg, desc in six.iteritems(method_desc.get("parameters", {})): - 902 param = key2param(arg) - 903 self.argmap[param] = arg - 904 - 905 if desc.get("pattern"): - 906 self.pattern_params[param] = desc["pattern"] - 907 if desc.get("enum"): - 908 self.enum_params[param] = desc["enum"] - 909 if desc.get("required"): - 910 self.required_params.append(param) - 911 if desc.get("repeated"): - 912 self.repeated_params.append(param) - 913 if desc.get("location") == "query": - 914 self.query_params.append(param) - 915 if desc.get("location") == "path": - 916 self.path_params.add(param) - 917 self.param_types[param] = desc.get("type", "string") - 918 - 919 # TODO(dhermes): Determine if this is still necessary. Discovery based APIs - 920 # should have all path parameters already marked with - 921 # 'location: path'. - 922 for match in URITEMPLATE.finditer(method_desc["path"]): - 923 for namematch in VARNAME.finditer(match.group(0)): - 924 name = key2param(namematch.group(0)) - 925 self.path_params.add(name) - 926 if name in self.query_params: - 927 self.query_params.remove(name) -931 """Creates a method for attaching to a Resource. - 932 - 933 Args: - 934 methodName: string, name of the method to use. - 935 methodDesc: object, fragment of deserialized discovery document that - 936 describes the method. - 937 rootDesc: object, the entire deserialized discovery document. - 938 schema: object, mapping of schema names to schema descriptions. - 939 """ - 940 methodName = fix_method_name(methodName) - 941 ( - 942 pathUrl, - 943 httpMethod, - 944 methodId, - 945 accept, - 946 maxSize, - 947 mediaPathUrl, - 948 ) = _fix_up_method_description(methodDesc, rootDesc, schema) - 949 - 950 parameters = ResourceMethodParameters(methodDesc) - 951 - 952 def method(self, **kwargs): - 953 # Don't bother with doc string, it will be over-written by createMethod. - 954 - 955 for name in six.iterkeys(kwargs): - 956 if name not in parameters.argmap: - 957 raise TypeError('Got an unexpected keyword argument "%s"' % name) - 958 - 959 # Remove args that have a value of None. - 960 keys = list(kwargs.keys()) - 961 for name in keys: - 962 if kwargs[name] is None: - 963 del kwargs[name] - 964 - 965 for name in parameters.required_params: - 966 if name not in kwargs: - 967 # temporary workaround for non-paging methods incorrectly requiring - 968 # page token parameter (cf. drive.changes.watch vs. drive.changes.list) - 969 if name not in _PAGE_TOKEN_NAMES or _findPageTokenName( - 970 _methodProperties(methodDesc, schema, "response") - 971 ): - 972 raise TypeError('Missing required parameter "%s"' % name) - 973 - 974 for name, regex in six.iteritems(parameters.pattern_params): - 975 if name in kwargs: - 976 if isinstance(kwargs[name], six.string_types): - 977 pvalues = [kwargs[name]] - 978 else: - 979 pvalues = kwargs[name] - 980 for pvalue in pvalues: - 981 if re.match(regex, pvalue) is None: - 982 raise TypeError( - 983 'Parameter "%s" value "%s" does not match the pattern "%s"' - 984 % (name, pvalue, regex) - 985 ) - 986 - 987 for name, enums in six.iteritems(parameters.enum_params): - 988 if name in kwargs: - 989 # We need to handle the case of a repeated enum - 990 # name differently, since we want to handle both - 991 # arg='value' and arg=['value1', 'value2'] - 992 if name in parameters.repeated_params and not isinstance( - 993 kwargs[name], six.string_types - 994 ): - 995 values = kwargs[name] - 996 else: - 997 values = [kwargs[name]] - 998 for value in values: - 999 if value not in enums: -1000 raise TypeError( -1001 'Parameter "%s" value "%s" is not an allowed value in "%s"' -1002 % (name, value, str(enums)) -1003 ) -1004 -1005 actual_query_params = {} -1006 actual_path_params = {} -1007 for key, value in six.iteritems(kwargs): -1008 to_type = parameters.param_types.get(key, "string") -1009 # For repeated parameters we cast each member of the list. -1010 if key in parameters.repeated_params and type(value) == type([]): -1011 cast_value = [_cast(x, to_type) for x in value] -1012 else: -1013 cast_value = _cast(value, to_type) -1014 if key in parameters.query_params: -1015 actual_query_params[parameters.argmap[key]] = cast_value -1016 if key in parameters.path_params: -1017 actual_path_params[parameters.argmap[key]] = cast_value -1018 body_value = kwargs.get("body", None) -1019 media_filename = kwargs.get("media_body", None) -1020 media_mime_type = kwargs.get("media_mime_type", None) -1021 -1022 if self._developerKey: -1023 actual_query_params["key"] = self._developerKey -1024 -1025 model = self._model -1026 if methodName.endswith("_media"): -1027 model = MediaModel() -1028 elif "response" not in methodDesc: -1029 model = RawModel() -1030 -1031 headers = {} -1032 headers, params, query, body = model.request( -1033 headers, actual_path_params, actual_query_params, body_value -1034 ) -1035 -1036 expanded_url = uritemplate.expand(pathUrl, params) -1037 url = _urljoin(self._baseUrl, expanded_url + query) -1038 -1039 resumable = None -1040 multipart_boundary = "" -1041 -1042 if media_filename: -1043 # Ensure we end up with a valid MediaUpload object. -1044 if isinstance(media_filename, six.string_types): -1045 if media_mime_type is None: -1046 logger.warning( -1047 "media_mime_type argument not specified: trying to auto-detect for %s", -1048 media_filename, -1049 ) -1050 media_mime_type, _ = mimetypes.guess_type(media_filename) -1051 if media_mime_type is None: -1052 raise UnknownFileType(media_filename) -1053 if not mimeparse.best_match([media_mime_type], ",".join(accept)): -1054 raise UnacceptableMimeTypeError(media_mime_type) -1055 media_upload = MediaFileUpload(media_filename, mimetype=media_mime_type) -1056 elif isinstance(media_filename, MediaUpload): -1057 media_upload = media_filename -1058 else: -1059 raise TypeError("media_filename must be str or MediaUpload.") -1060 -1061 # Check the maxSize -1062 if media_upload.size() is not None and media_upload.size() > maxSize > 0: -1063 raise MediaUploadSizeError("Media larger than: %s" % maxSize) -1064 -1065 # Use the media path uri for media uploads -1066 expanded_url = uritemplate.expand(mediaPathUrl, params) -1067 url = _urljoin(self._baseUrl, expanded_url + query) -1068 if media_upload.resumable(): -1069 url = _add_query_parameter(url, "uploadType", "resumable") -1070 -1071 if media_upload.resumable(): -1072 # This is all we need to do for resumable, if the body exists it gets -1073 # sent in the first request, otherwise an empty body is sent. -1074 resumable = media_upload -1075 else: -1076 # A non-resumable upload -1077 if body is None: -1078 # This is a simple media upload -1079 headers["content-type"] = media_upload.mimetype() -1080 body = media_upload.getbytes(0, media_upload.size()) -1081 url = _add_query_parameter(url, "uploadType", "media") -1082 else: -1083 # This is a multipart/related upload. -1084 msgRoot = MIMEMultipart("related") -1085 # msgRoot should not write out it's own headers -1086 setattr(msgRoot, "_write_headers", lambda self: None) -1087 -1088 # attach the body as one part -1089 msg = MIMENonMultipart(*headers["content-type"].split("/")) -1090 msg.set_payload(body) -1091 msgRoot.attach(msg) -1092 -1093 # attach the media as the second part -1094 msg = MIMENonMultipart(*media_upload.mimetype().split("/")) -1095 msg["Content-Transfer-Encoding"] = "binary" -1096 -1097 payload = media_upload.getbytes(0, media_upload.size()) -1098 msg.set_payload(payload) -1099 msgRoot.attach(msg) -1100 # encode the body: note that we can't use `as_string`, because -1101 # it plays games with `From ` lines. -1102 fp = BytesIO() -1103 g = _BytesGenerator(fp, mangle_from_=False) -1104 g.flatten(msgRoot, unixfrom=False) -1105 body = fp.getvalue() -1106 -1107 multipart_boundary = msgRoot.get_boundary() -1108 headers["content-type"] = ( -1109 "multipart/related; " 'boundary="%s"' -1110 ) % multipart_boundary -1111 url = _add_query_parameter(url, "uploadType", "multipart") -1112 -1113 logger.debug("URL being requested: %s %s" % (httpMethod, url)) -1114 return self._requestBuilder( -1115 self._http, -1116 model.response, -1117 url, -1118 method=httpMethod, -1119 body=body, -1120 headers=headers, -1121 methodId=methodId, -1122 resumable=resumable, -1123 ) -1124 -1125 docs = [methodDesc.get("description", DEFAULT_METHOD_DOC), "\n\n"] -1126 if len(parameters.argmap) > 0: -1127 docs.append("Args:\n") -1128 -1129 # Skip undocumented params and params common to all methods. -1130 skip_parameters = list(rootDesc.get("parameters", {}).keys()) -1131 skip_parameters.extend(STACK_QUERY_PARAMETERS) -1132 -1133 all_args = list(parameters.argmap.keys()) -1134 args_ordered = [key2param(s) for s in methodDesc.get("parameterOrder", [])] -1135 -1136 # Move body to the front of the line. -1137 if "body" in all_args: -1138 args_ordered.append("body") -1139 -1140 for name in all_args: -1141 if name not in args_ordered: -1142 args_ordered.append(name) -1143 -1144 for arg in args_ordered: -1145 if arg in skip_parameters: -1146 continue -1147 -1148 repeated = "" -1149 if arg in parameters.repeated_params: -1150 repeated = " (repeated)" -1151 required = "" -1152 if arg in parameters.required_params: -1153 required = " (required)" -1154 paramdesc = methodDesc["parameters"][parameters.argmap[arg]] -1155 paramdoc = paramdesc.get("description", "A parameter") -1156 if "$ref" in paramdesc: -1157 docs.append( -1158 (" %s: object, %s%s%s\n The object takes the" " form of:\n\n%s\n\n") -1159 % ( -1160 arg, -1161 paramdoc, -1162 required, -1163 repeated, -1164 schema.prettyPrintByName(paramdesc["$ref"]), -1165 ) -1166 ) -1167 else: -1168 paramtype = paramdesc.get("type", "string") -1169 docs.append( -1170 " %s: %s, %s%s%s\n" % (arg, paramtype, paramdoc, required, repeated) -1171 ) -1172 enum = paramdesc.get("enum", []) -1173 enumDesc = paramdesc.get("enumDescriptions", []) -1174 if enum and enumDesc: -1175 docs.append(" Allowed values\n") -1176 for (name, desc) in zip(enum, enumDesc): -1177 docs.append(" %s - %s\n" % (name, desc)) -1178 if "response" in methodDesc: -1179 if methodName.endswith("_media"): -1180 docs.append("\nReturns:\n The media object as a string.\n\n ") -1181 else: -1182 docs.append("\nReturns:\n An object of the form:\n\n ") -1183 docs.append(schema.prettyPrintSchema(methodDesc["response"])) -1184 -1185 setattr(method, "__doc__", "".join(docs)) -1186 return (methodName, method) -1187 -1188 -1189 -def createNextMethod( -1190 methodName, -1191 pageTokenName="pageToken", -1192 nextPageTokenName="nextPageToken", -1193 isPageTokenParameter=True, -1194 ): -1195 """Creates any _next methods for attaching to a Resource. -1196 -1197 The _next methods allow for easy iteration through list() responses. -1198 -1199 Args: -1200 methodName: string, name of the method to use. -1201 pageTokenName: string, name of request page token field. -1202 nextPageTokenName: string, name of response page token field. -1203 isPageTokenParameter: Boolean, True if request page token is a query -1204 parameter, False if request page token is a field of the request body. -1205 """ -1206 methodName = fix_method_name(methodName) -1207 -1208 def methodNext(self, previous_request, previous_response): -1209 """Retrieves the next page of results. -1210 -1211 Args: -1212 previous_request: The request for the previous page. (required) -1213 previous_response: The response from the request for the previous page. (required) -1214 -1215 Returns: -1216 A request object that you can call 'execute()' on to request the next -1217 page. Returns None if there are no more items in the collection. -1218 """ -1219 # Retrieve nextPageToken from previous_response -1220 # Use as pageToken in previous_request to create new request. -1221 -1222 nextPageToken = previous_response.get(nextPageTokenName, None) -1223 if not nextPageToken: -1224 return None -1225 -1226 request = copy.copy(previous_request) -1227 -1228 if isPageTokenParameter: -1229 # Replace pageToken value in URI -1230 request.uri = _add_query_parameter( -1231 request.uri, pageTokenName, nextPageToken -1232 ) -1233 logger.debug("Next page request URL: %s %s" % (methodName, request.uri)) -1234 else: -1235 # Replace pageToken value in request body -1236 model = self._model -1237 body = model.deserialize(request.body) -1238 body[pageTokenName] = nextPageToken -1239 request.body = model.serialize(body) -1240 logger.debug("Next page request body: %s %s" % (methodName, body)) -1241 -1242 return request -1243 -1244 return (methodName, methodNext) -1245 -1248 """A class for interacting with a resource.""" -1249 -1386 -1250 - def __init__( -1251 self, -1252 http, -1253 baseUrl, -1254 model, -1255 requestBuilder, -1256 developerKey, -1257 resourceDesc, -1258 rootDesc, -1259 schema, -1260 ): -1261 """Build a Resource from the API description. -1262 -1263 Args: -1264 http: httplib2.Http, Object to make http requests with. -1265 baseUrl: string, base URL for the API. All requests are relative to this -1266 URI. -1267 model: googleapiclient.Model, converts to and from the wire format. -1268 requestBuilder: class or callable that instantiates an -1269 googleapiclient.HttpRequest object. -1270 developerKey: string, key obtained from -1271 https://code.google.com/apis/console -1272 resourceDesc: object, section of deserialized discovery document that -1273 describes a resource. Note that the top level discovery document -1274 is considered a resource. -1275 rootDesc: object, the entire deserialized discovery document. -1276 schema: object, mapping of schema names to schema descriptions. -1277 """ -1278 self._dynamic_attrs = [] -1279 -1280 self._http = http -1281 self._baseUrl = baseUrl -1282 self._model = model -1283 self._developerKey = developerKey -1284 self._requestBuilder = requestBuilder -1285 self._resourceDesc = resourceDesc -1286 self._rootDesc = rootDesc -1287 self._schema = schema -1288 -1289 self._set_service_methods() -1290 -1292 """Sets an instance attribute and tracks it in a list of dynamic attributes. -1293 -1294 Args: -1295 attr_name: string; The name of the attribute to be set -1296 value: The value being set on the object and tracked in the dynamic cache. -1297 """ -1298 self._dynamic_attrs.append(attr_name) -1299 self.__dict__[attr_name] = value -1300 -1302 """Trim the state down to something that can be pickled. -1303 -1304 Uses the fact that the instance variable _dynamic_attrs holds attrs that -1305 will be wiped and restored on pickle serialization. -1306 """ -1307 state_dict = copy.copy(self.__dict__) -1308 for dynamic_attr in self._dynamic_attrs: -1309 del state_dict[dynamic_attr] -1310 del state_dict["_dynamic_attrs"] -1311 return state_dict -1312 -1314 """Reconstitute the state of the object from being pickled. -1315 -1316 Uses the fact that the instance variable _dynamic_attrs holds attrs that -1317 will be wiped and restored on pickle serialization. -1318 """ -1319 self.__dict__.update(state) -1320 self._dynamic_attrs = [] -1321 self._set_service_methods() -1322 -1323 -1326 -1328 self.close() -1329 -1331 """Close httplib2 connections.""" -1332 # httplib2 leaves sockets open by default. -1333 # Cleanup using the `close` method. -1334 # https://github.com/httplib2/httplib2/issues/148 -1335 self._http.http.close() -1336 -1338 self._add_basic_methods(self._resourceDesc, self._rootDesc, self._schema) -1339 self._add_nested_resources(self._resourceDesc, self._rootDesc, self._schema) -1340 self._add_next_methods(self._resourceDesc, self._schema) -1341 -1343 # If this is the root Resource, add a new_batch_http_request() method. -1344 if resourceDesc == rootDesc: -1345 batch_uri = "%s%s" % ( -1346 rootDesc["rootUrl"], -1347 rootDesc.get("batchPath", "batch"), -1348 ) -1349 -1350 def new_batch_http_request(callback=None): -1351 """Create a BatchHttpRequest object based on the discovery document. -1352 -1353 Args: -1354 callback: callable, A callback to be called for each response, of the -1355 form callback(id, response, exception). The first parameter is the -1356 request id, and the second is the deserialized response object. The -1357 third is an apiclient.errors.HttpError exception object if an HTTP -1358 error occurred while processing the request, or None if no error -1359 occurred. -1360 -1361 Returns: -1362 A BatchHttpRequest object based on the discovery document. -1363 """ -1364 return BatchHttpRequest(callback=callback, batch_uri=batch_uri) -1365 -1366 self._set_dynamic_attr("new_batch_http_request", new_batch_http_request) -1367 -1368 # Add basic methods to Resource -1369 if "methods" in resourceDesc: -1370 for methodName, methodDesc in six.iteritems(resourceDesc["methods"]): -1371 fixedMethodName, method = createMethod( -1372 methodName, methodDesc, rootDesc, schema -1373 ) -1374 self._set_dynamic_attr( -1375 fixedMethodName, method.__get__(self, self.__class__) -1376 ) -1377 # Add in _media methods. The functionality of the attached method will -1378 # change when it sees that the method name ends in _media. -1379 if methodDesc.get("supportsMediaDownload", False): -1380 fixedMethodName, method = createMethod( -1381 methodName + "_media", methodDesc, rootDesc, schema -1382 ) -1383 self._set_dynamic_attr( -1384 fixedMethodName, method.__get__(self, self.__class__) -1385 ) -1388 # Add in nested resources -1389 if "resources" in resourceDesc: -1390 -1391 def createResourceMethod(methodName, methodDesc): -1392 """Create a method on the Resource to access a nested Resource. -1393 -1394 Args: -1395 methodName: string, name of the method to use. -1396 methodDesc: object, fragment of deserialized discovery document that -1397 describes the method. -1398 """ -1399 methodName = fix_method_name(methodName) -1400 -1401 def methodResource(self): -1402 return Resource( -1403 http=self._http, -1404 baseUrl=self._baseUrl, -1405 model=self._model, -1406 developerKey=self._developerKey, -1407 requestBuilder=self._requestBuilder, -1408 resourceDesc=methodDesc, -1409 rootDesc=rootDesc, -1410 schema=schema, -1411 ) -1412 -1413 setattr(methodResource, "__doc__", "A collection resource.") -1414 setattr(methodResource, "__is_resource__", True) -1415 -1416 return (methodName, methodResource) -1417 -1418 for methodName, methodDesc in six.iteritems(resourceDesc["resources"]): -1419 fixedMethodName, method = createResourceMethod(methodName, methodDesc) -1420 self._set_dynamic_attr( -1421 fixedMethodName, method.__get__(self, self.__class__) -1422 ) -1423 -1425 # Add _next() methods if and only if one of the names 'pageToken' or -1426 # 'nextPageToken' occurs among the fields of both the method's response -1427 # type either the method's request (query parameters) or request body. -1428 if "methods" not in resourceDesc: -1429 return -1430 for methodName, methodDesc in six.iteritems(resourceDesc["methods"]): -1431 nextPageTokenName = _findPageTokenName( -1432 _methodProperties(methodDesc, schema, "response") -1433 ) -1434 if not nextPageTokenName: -1435 continue -1436 isPageTokenParameter = True -1437 pageTokenName = _findPageTokenName(methodDesc.get("parameters", {})) -1438 if not pageTokenName: -1439 isPageTokenParameter = False -1440 pageTokenName = _findPageTokenName( -1441 _methodProperties(methodDesc, schema, "request") -1442 ) -1443 if not pageTokenName: -1444 continue -1445 fixedMethodName, method = createNextMethod( -1446 methodName + "_next", -1447 pageTokenName, -1448 nextPageTokenName, -1449 isPageTokenParameter, -1450 ) -1451 self._set_dynamic_attr( -1452 fixedMethodName, method.__get__(self, self.__class__) -1453 ) -1454 -1457 """Search field names for one like a page token. -1458 -1459 Args: -1460 fields: container of string, names of fields. -1461 -1462 Returns: -1463 First name that is either 'pageToken' or 'nextPageToken' if one exists, -1464 otherwise None. -1465 """ -1466 return next( -1467 (tokenName for tokenName in _PAGE_TOKEN_NAMES if tokenName in fields), None -1468 ) -1469 -1472 """Get properties of a field in a method description. -1473 -1474 Args: -1475 methodDesc: object, fragment of deserialized discovery document that -1476 describes the method. -1477 schema: object, mapping of schema names to schema descriptions. -1478 name: string, name of top-level field in method description. -1479 -1480 Returns: -1481 Object representing fragment of deserialized discovery document -1482 corresponding to 'properties' field of object corresponding to named field -1483 in method description, if it exists, otherwise empty dict. -1484 """ -1485 desc = methodDesc.get(name, {}) -1486 if "$ref" in desc: -1487 desc = schema.get(desc["$ref"], {}) -1488 return desc.get("properties", {}) -1489 -
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class Resource
--object --+ - | - Resource -- -
-
A class for interacting with a resource.
- - - -
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
-Build a Resource from the API description. - -Args: - http: httplib2.Http, Object to make http requests with. - baseUrl: string, base URL for the API. All requests are relative to this - URI. - model: googleapiclient.Model, converts to and from the wire format. - requestBuilder: class or callable that instantiates an - googleapiclient.HttpRequest object. - developerKey: string, key obtained from - https://code.google.com/apis/console - resourceDesc: object, section of deserialized discovery document that - describes a resource. Note that the top level discovery document - is considered a resource. - rootDesc: object, the entire deserialized discovery document. - schema: object, mapping of schema names to schema descriptions. - --
|
-
-
-
-
-
-
-Sets an instance attribute and tracks it in a list of dynamic attributes. - -Args: - attr_name: string; The name of the attribute to be set - value: The value being set on the object and tracked in the dynamic cache. - --
|
-
-
-
-
-
-
Trim the state down to something that can be pickled. -Uses the fact that the instance variable _dynamic_attrs holds attrs - that will be wiped and restored on pickle serialization. -
|
-
-
-
-
-
Reconstitute the state of the object from being pickled. -Uses the fact that the instance variable _dynamic_attrs holds attrs - that will be wiped and restored on pickle serialization. -
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class ResourceMethodParameters
--object --+ - | - ResourceMethodParameters -- -
-
-Represents the parameters associated with a method. - -Attributes: - argmap: Map from method parameter name (string) to query parameter name - (string). - required_params: List of required parameters (represented by parameter - name as string). - repeated_params: List of repeated parameters (represented by parameter - name as string). - pattern_params: Map from method parameter name (string) to regular - expression (as a string). If the pattern is set for a parameter, the - value for that parameter must match the regular expression. - query_params: List of parameters (represented by parameter name as string) - that will be used in the query string. - path_params: Set of parameters (represented by parameter name as string) - that will be used in the base URL path. - param_types: Map from method parameter name (string) to parameter type. Type - can be any valid JSON schema type; valid values are 'any', 'array', - 'boolean', 'integer', 'number', 'object', or 'string'. Reference: - http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 - enum_params: Map from method parameter name (string) to list of strings, - where each list of strings is the list of acceptable enum values. - -- - - -
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
-Constructor for ResourceMethodParameters. - -Sets default values and defers to set_parameters to populate. - -Args: - method_desc: Dictionary with metadata describing an API method. Value - comes from the dictionary of methods stored in the 'methods' key in - the deserialized discovery document. - --
|
-
-
-
-
-
-Populates maps and lists based on method description. - -Iterates through each parameter for the method and parses the values from -the parameter dictionary. - -Args: - method_desc: Dictionary with metadata describing an API method. Value - comes from the dictionary of methods stored in the 'methods' key in - the deserialized discovery document. - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class _BytesGenerator
--email.generator.Generator --+ - | - _BytesGenerator -- -
- - -
-
|
-|||
| - - |
- _write_lines = BytesGenerator.write
- |
- ||
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Package discovery_cache
-Caching utility for the discovery document.
- - - -
-
|
-|||
-
| |||
- - -
-
|
-|||
| - - |
-
|
- ||
-
|
-|||
| - - |
- LOGGER = logging.getLogger(__name__)
- |
- ||
| - - |
- DISCOVERY_DOC_MAX_AGE = 86400
- |
- ||
| - - |
- __package__ = None
- |
- ||
-
|
-|||
-
-
-
-
-
-Detects an appropriate cache module and returns it. - -Returns: - googleapiclient.discovery_cache.base.Cache, a cache object which - is auto detected, or None if no cache object is available. - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Source Code for Package googleapiclient.discovery_cache
-- 1 # Copyright 2014 Google Inc. All Rights Reserved. - 2 # - 3 # Licensed under the Apache License, Version 2.0 (the "License"); - 4 # you may not use this file except in compliance with the License. - 5 # You may obtain a copy of the License at - 6 # - 7 # http://www.apache.org/licenses/LICENSE-2.0 - 8 # - 9 # Unless required by applicable law or agreed to in writing, software -10 # distributed under the License is distributed on an "AS IS" BASIS, -11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -12 # See the License for the specific language governing permissions and -13 # limitations under the License. -14 -15 """Caching utility for the discovery document.""" -16 -17 from __future__ import absolute_import -18 -19 import logging -20 import datetime -21 import os -22 -23 LOGGER = logging.getLogger(__name__) -24 -25 DISCOVERY_DOC_MAX_AGE = 60 * 60 * 24 # 1 day -26 -27 --29 """Detects an appropriate cache module and returns it. -30 -31 Returns: -32 googleapiclient.discovery_cache.base.Cache, a cache object which -33 is auto detected, or None if no cache object is available. -34 """ -35 if 'APPENGINE_RUNTIME' in os.environ: -36 try: -37 from google.appengine.api import memcache -38 from . import appengine_memcache -39 -40 return appengine_memcache.cache -41 except Exception: -42 pass -43 try: -44 from . import file_cache -45 -46 return file_cache.cache -47 except Exception as e: -48 LOGGER.warning(e, exc_info=True) -49 return None -50 -
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Module appengine_memcache
-App Engine memcache based cache for the discovery document.
- - - -
-
|
-|||
| - - |
- Cache - A cache with app engine memcache API. - |
- ||
-
|
-|||
| - - |
- LOGGER = logging.getLogger(__name__)
- |
- ||
| - - |
- NAMESPACE = "google-api-client"
- |
- ||
| - - |
- cache = Cache(max_age= DISCOVERY_DOC_MAX_AGE)
- |
- ||
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Source Code for Module googleapiclient.discovery_cache.appengine_memcache
-- 1 # Copyright 2014 Google Inc. All Rights Reserved. - 2 # - 3 # Licensed under the Apache License, Version 2.0 (the "License"); - 4 # you may not use this file except in compliance with the License. - 5 # You may obtain a copy of the License at - 6 # - 7 # http://www.apache.org/licenses/LICENSE-2.0 - 8 # - 9 # Unless required by applicable law or agreed to in writing, software -10 # distributed under the License is distributed on an "AS IS" BASIS, -11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -12 # See the License for the specific language governing permissions and -13 # limitations under the License. -14 -15 """App Engine memcache based cache for the discovery document.""" -16 -17 import logging -18 -19 # This is only an optional dependency because we only import this -20 # module when google.appengine.api.memcache is available. -21 from google.appengine.api import memcache -22 -23 from . import base -24 from ..discovery_cache import DISCOVERY_DOC_MAX_AGE -25 -26 -27 LOGGER = logging.getLogger(__name__) -28 -29 NAMESPACE = "google-api-client" -30 -31 --33 """A cache with app engine memcache API.""" -34 -54 -55 -56 cache = Cache(max_age=DISCOVERY_DOC_MAX_AGE) -57 -36 """Constructor. -37 -38 Args: -39 max_age: Cache expiration in seconds. -40 """ -41 self._max_age = max_age -42 -44 try: -45 return memcache.get(url, namespace=NAMESPACE) -46 except Exception as e: -47 LOGGER.warning(e, exc_info=True) -48 -
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class Cache
--object --+ - | -base.Cache --+ - | - Cache -- -
-
A cache with app engine memcache API.
- - - -
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from |
- |||
-
|
-|||
|
- Inherited from Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
-Constructor. - -Args: - max_age: Cache expiration in seconds. - --
|
-
-
-
-
-
-
-Gets the content from the memcache with a given key. - -Args: - url: string, the key for the cache. - -Returns: - object, the value in the cache for the given key, or None if the key is - not in the cache. - --
|
-
-
-
-
-
-Sets the given key and content in the cache. - -Args: - url: string, the key for the cache. - content: string, the discovery document. - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Module base
-An abstract class for caching the discovery document.
- - - -
-
|
-|||
| - - |
- Cache - A base abstract cache class. - |
- ||
-
|
-|||
| - - |
- __package__ = |
- ||
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Source Code for Module googleapiclient.discovery_cache.base
-- 1 # Copyright 2014 Google Inc. All Rights Reserved. - 2 # - 3 # Licensed under the Apache License, Version 2.0 (the "License"); - 4 # you may not use this file except in compliance with the License. - 5 # You may obtain a copy of the License at - 6 # - 7 # http://www.apache.org/licenses/LICENSE-2.0 - 8 # - 9 # Unless required by applicable law or agreed to in writing, software -10 # distributed under the License is distributed on an "AS IS" BASIS, -11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -12 # See the License for the specific language governing permissions and -13 # limitations under the License. -14 -15 """An abstract class for caching the discovery document.""" -16 -17 import abc --21 """A base abstract cache class.""" -22 -23 __metaclass__ = abc.ABCMeta -24 -25 @abc.abstractmethod -47 -27 """Gets the content from the memcache with a given key. -28 -29 Args: -30 url: string, the key for the cache. -31 -32 Returns: -33 object, the value in the cache for the given key, or None if the key is -34 not in the cache. -35 """ -36 raise NotImplementedError() -37 -38 @abc.abstractmethod -
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class Cache
--object --+ - | - Cache -- -
-
A base abstract cache class.
- - - -
-
|
-|||
| - - |
- __metaclass__ - Metaclass for defining Abstract Base Classes (ABCs). - |
- ||
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from |
- |||
-
|
-|||
| - - |
- __abstractmethods__ = |
- ||
| - - |
- _abc_cache = <_weakrefset.WeakSet object at 0x7fb69e350450>
- |
- ||
| - - |
- _abc_negative_cache = <_weakrefset.WeakSet object at 0x7fb69e3
- |
- ||
| - - |
- _abc_negative_cache_version = 22
- |
- ||
| - - |
- _abc_registry = <_weakrefset.WeakSet object at 0x7fb69e350490>
- |
- ||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
-Gets the content from the memcache with a given key. - -Args: - url: string, the key for the cache. - -Returns: - object, the value in the cache for the given key, or None if the key is - not in the cache. - --
|
-
-
-
-
-
-Sets the given key and content in the cache. - -Args: - url: string, the key for the cache. - content: string, the discovery document. - --
|
- - -
-
|
-|||
-
-
-
-
- _abc_negative_cache- -
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Module file_cache
-File based cache for the discovery document.
-The cache is stored in a single file so that multiple processes can - share the same cache. It locks the file whenever accesing to the file. - When the cache content is corrupted, it will be initialized with an empty - cache.
- - - -
-
|
-|||
| - - |
- Cache - A file based cache for the discovery documents. - |
- ||
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Source Code for Module googleapiclient.discovery_cache.file_cache
-- 1 # Copyright 2014 Google Inc. All Rights Reserved. - 2 # - 3 # Licensed under the Apache License, Version 2.0 (the "License"); - 4 # you may not use this file except in compliance with the License. - 5 # You may obtain a copy of the License at - 6 # - 7 # http://www.apache.org/licenses/LICENSE-2.0 - 8 # - 9 # Unless required by applicable law or agreed to in writing, software - 10 # distributed under the License is distributed on an "AS IS" BASIS, - 11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - 12 # See the License for the specific language governing permissions and - 13 # limitations under the License. - 14 - 15 """File based cache for the discovery document. - 16 - 17 The cache is stored in a single file so that multiple processes can - 18 share the same cache. It locks the file whenever accesing to the - 19 file. When the cache content is corrupted, it will be initialized with - 20 an empty cache. - 21 """ - 22 - 23 from __future__ import division - 24 - 25 import datetime - 26 import json - 27 import logging - 28 import os - 29 import tempfile - 30 import threading - 31 - 32 try: - 33 from oauth2client.contrib.locked_file import LockedFile - 34 except ImportError: - 35 # oauth2client < 2.0.0 - 36 try: - 37 from oauth2client.locked_file import LockedFile - 38 except ImportError: - 39 # oauth2client > 4.0.0 or google-auth - 40 raise ImportError( - 41 "file_cache is unavailable when using oauth2client >= 4.0.0 or google-auth" - 42 ) - 43 - 44 from . import base - 45 from ..discovery_cache import DISCOVERY_DOC_MAX_AGE - 46 - 47 LOGGER = logging.getLogger(__name__) - 48 - 49 FILENAME = "google-api-python-client-discovery-doc.cache" - 50 EPOCH = datetime.datetime.utcfromtimestamp(0) - 51 - 52 --54 try: - 55 return (date - EPOCH).total_seconds() - 56 except AttributeError: - 57 # The following is the equivalent of total_seconds() in Python2.6. - 58 # See also: https://docs.python.org/2/library/datetime.html - 59 delta = date - EPOCH - 60 return ( - 61 delta.microseconds + (delta.seconds + delta.days * 24 * 3600) * 10 ** 6 - 62 ) / 10 ** 6 -63 - 64 -66 f.file_handle().seek(0) - 67 try: - 68 cache = json.load(f.file_handle()) - 69 except Exception: - 70 # This means it opens the file for the first time, or the cache is - 71 # corrupted, so initializing the file with an empty dict. - 72 cache = {} - 73 f.file_handle().truncate(0) - 74 f.file_handle().seek(0) - 75 json.dump(cache, f.file_handle()) - 76 return cache -77 - 78 -80 """A file based cache for the discovery documents.""" - 81 -144 -145 -146 cache = Cache(max_age=DISCOVERY_DOC_MAX_AGE) -147 -83 """Constructor. - 84 - 85 Args: - 86 max_age: Cache expiration in seconds. - 87 """ - 88 self._max_age = max_age - 89 self._file = os.path.join(tempfile.gettempdir(), FILENAME) - 90 f = LockedFile(self._file, "a+", "r") - 91 try: - 92 f.open_and_lock() - 93 if f.is_locked(): - 94 _read_or_initialize_cache(f) - 95 # If we can not obtain the lock, other process or thread must - 96 # have initialized the file. - 97 except Exception as e: - 98 LOGGER.warning(e, exc_info=True) - 99 finally: -100 f.unlock_and_close() -101 -103 f = LockedFile(self._file, "r+", "r") -104 try: -105 f.open_and_lock() -106 if f.is_locked(): -107 cache = _read_or_initialize_cache(f) -108 if url in cache: -109 content, t = cache.get(url, (None, 0)) -110 if _to_timestamp(datetime.datetime.now()) < t + self._max_age: -111 return content -112 return None -113 else: -114 LOGGER.debug("Could not obtain a lock for the cache file.") -115 return None -116 except Exception as e: -117 LOGGER.warning(e, exc_info=True) -118 finally: -119 f.unlock_and_close() -120 -122 f = LockedFile(self._file, "r+", "r") -123 try: -124 f.open_and_lock() -125 if f.is_locked(): -126 cache = _read_or_initialize_cache(f) -127 cache[url] = (content, _to_timestamp(datetime.datetime.now())) -128 # Remove stale cache. -129 for k, (_, timestamp) in list(cache.items()): -130 if ( -131 _to_timestamp(datetime.datetime.now()) -132 >= timestamp + self._max_age -133 ): -134 del cache[k] -135 f.file_handle().truncate(0) -136 f.file_handle().seek(0) -137 json.dump(cache, f.file_handle()) -138 else: -139 LOGGER.debug("Could not obtain a lock for the cache file.") -140 except Exception as e: -141 LOGGER.warning(e, exc_info=True) -142 finally: -143 f.unlock_and_close() -
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class Cache
--object --+ - | -base.Cache --+ - | - Cache -- -
-
A file based cache for the discovery documents.
- - - -
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from |
- |||
-
|
-|||
|
- Inherited from Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
-Constructor. - -Args: - max_age: Cache expiration in seconds. - --
|
-
-
-
-
-
-
-Gets the content from the memcache with a given key. - -Args: - url: string, the key for the cache. - -Returns: - object, the value in the cache for the given key, or None if the key is - not in the cache. - --
|
-
-
-
-
-
-Sets the given key and content in the cache. - -Args: - url: string, the key for the cache. - content: string, the discovery document. - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Module errors
-Errors for the library.
-All exceptions defined by the library should be defined in this - file.
- --
Author: - jcgregorio@google.com (Joe Gregorio) -
-
-
|
-|||
| - - |
- Error - Base error for this module. - |
- ||
| - - |
- HttpError - HTTP data was invalid or unexpected. - |
- ||
| - - |
- InvalidJsonError - The JSON returned could not be parsed. - |
- ||
| - - |
- UnknownFileType - File type unknown or unexpected. - |
- ||
| - - |
- UnknownLinkType - Link type unknown or unexpected. - |
- ||
| - - |
- UnknownApiNameOrVersion - No API with that name and version exists. - |
- ||
| - - |
- UnacceptableMimeTypeError - That is an unacceptable mimetype for this operation. - |
- ||
| - - |
- MediaUploadSizeError - Media is larger than the method can accept. - |
- ||
| - - |
- ResumableUploadError - Error occurred during resumable upload. - |
- ||
| - - |
- InvalidChunkSizeError - The given chunksize is not valid. - |
- ||
| - - |
- InvalidNotificationError - The channel Notification is invalid. - |
- ||
| - - |
- BatchError - Error occurred during batch operations. - |
- ||
| - - |
- UnexpectedMethodError - Exception raised by RequestMockBuilder on unexpected calls. - |
- ||
| - - |
- UnexpectedBodyError - Exception raised by RequestMockBuilder on unexpected bodies. - |
- ||
-
|
-|||
| - - |
- __package__ = None
- |
- ||
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Source Code for Module googleapiclient.errors
-- 1 # Copyright 2014 Google Inc. All Rights Reserved. - 2 # - 3 # Licensed under the Apache License, Version 2.0 (the "License"); - 4 # you may not use this file except in compliance with the License. - 5 # You may obtain a copy of the License at - 6 # - 7 # http://www.apache.org/licenses/LICENSE-2.0 - 8 # - 9 # Unless required by applicable law or agreed to in writing, software - 10 # distributed under the License is distributed on an "AS IS" BASIS, - 11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - 12 # See the License for the specific language governing permissions and - 13 # limitations under the License. - 14 - 15 """Errors for the library. - 16 - 17 All exceptions defined by the library - 18 should be defined in this file. - 19 """ - 20 from __future__ import absolute_import - 21 - 22 __author__ = "jcgregorio@google.com (Joe Gregorio)" - 23 - 24 import json - 25 - 26 from googleapiclient import _helpers as util - 33 --36 """HTTP data was invalid or unexpected.""" - 37 - 38 @util.positional(3) -88 - 94 -100 -106 -112 -118 -124 -130 -136 -142 -40 self.resp = resp - 41 if not isinstance(content, bytes): - 42 raise TypeError("HTTP content should be bytes") - 43 self.content = content - 44 self.uri = uri - 45 self.error_details = "" -46 -48 """Calculate the reason for the error from the response content.""" - 49 reason = self.resp.reason - 50 try: - 51 data = json.loads(self.content.decode("utf-8")) - 52 if isinstance(data, dict): - 53 reason = data["error"]["message"] - 54 if "details" in data["error"]: - 55 self.error_details = data["error"]["details"] - 56 elif "detail" in data["error"]: - 57 self.error_details = data["error"]["detail"] - 58 elif isinstance(data, list) and len(data) > 0: - 59 first_error = data[0] - 60 reason = first_error["error"]["message"] - 61 if "details" in first_error["error"]: - 62 self.error_details = first_error["error"]["details"] - 63 except (ValueError, KeyError, TypeError): - 64 pass - 65 if reason is None: - 66 reason = "" - 67 return reason -68 -70 reason = self._get_reason() - 71 if self.error_details: - 72 return '<HttpError %s when requesting %s returned "%s". Details: "%s">' % ( - 73 self.resp.status, - 74 self.uri, - 75 reason.strip(), - 76 self.error_details, - 77 ) - 78 elif self.uri: - 79 return '<HttpError %s when requesting %s returned "%s">' % ( - 80 self.resp.status, - 81 self.uri, - 82 self._get_reason().strip(), - 83 ) - 84 else: - 85 return '<HttpError %s "%s">' % (self.resp.status, self._get_reason()) -86 - 87 __str__ = __repr__ -145 """Error occurred during batch operations.""" -146 -147 @util.positional(2) -152 -160 -154 if getattr(self.resp, "status", None) is None: -155 return '<BatchError "%s">' % (self.reason) -156 else: -157 return '<BatchError %s "%s">' % (self.resp.status, self.reason) -158 -159 __str__ = __repr__ -163 """Exception raised by RequestMockBuilder on unexpected calls.""" -164 -165 @util.positional(1) -171 -167 """Constructor for an UnexpectedMethodError.""" -168 super(UnexpectedMethodError, self).__init__( -169 "Received unexpected call %s" % methodId -170 ) -174 """Exception raised by RequestMockBuilder on unexpected bodies.""" -175 -181 -177 """Constructor for an UnexpectedMethodError.""" -178 super(UnexpectedBodyError, self).__init__( -179 "Expected: [%s] - Provided: [%s]" % (expected, provided) -180 ) -
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class BatchError
-- object --+ - | -exceptions.BaseException --+ - | - exceptions.Exception --+ - | - Error --+ - | - HttpError --+ - | - BatchError -- -
-
Error occurred during batch operations.
- - - -
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from Inherited from Inherited from Inherited from |
- |||
-
|
-|||
|
- Inherited from Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
x.__init__(...) initializes x; see help(type(x)) for signature -
|
-
-
-
-
-
-
str(x) -
|
-
-
-
-
-
str(x) -
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class Error
-- object --+ - | -exceptions.BaseException --+ - | - exceptions.Exception --+ - | - Error -- -
- Known Subclasses: -
- - -
-
Base error for this module.
- - - -
-
|
-|||
|
- Inherited from Inherited from Inherited from |
- |||
-
|
-|||
|
- Inherited from Inherited from |
- |||
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class HttpError
-- object --+ - | -exceptions.BaseException --+ - | - exceptions.Exception --+ - | - Error --+ - | - HttpError -- -
- Known Subclasses: -
- - -
-
HTTP data was invalid or unexpected.
- - - -
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from Inherited from Inherited from |
- |||
-
|
-|||
|
- Inherited from Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
x.__init__(...) initializes x; see help(type(x)) for signature -
|
-
-
-
-
-
-
str(x) -
|
-
-
-
-
-
str(x) -
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class InvalidChunkSizeError
-- object --+ - | -exceptions.BaseException --+ - | - exceptions.Exception --+ - | - Error --+ - | - InvalidChunkSizeError -- -
-
The given chunksize is not valid.
- - - -
-
|
-|||
|
- Inherited from Inherited from Inherited from |
- |||
-
|
-|||
|
- Inherited from Inherited from |
- |||
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class InvalidJsonError
-- object --+ - | -exceptions.BaseException --+ - | - exceptions.Exception --+ - | - Error --+ - | - InvalidJsonError -- -
-
The JSON returned could not be parsed.
- - - -
-
|
-|||
|
- Inherited from Inherited from Inherited from |
- |||
-
|
-|||
|
- Inherited from Inherited from |
- |||
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class InvalidNotificationError
-- object --+ - | -exceptions.BaseException --+ - | - exceptions.Exception --+ - | - Error --+ - | - InvalidNotificationError -- -
-
The channel Notification is invalid.
- - - -
-
|
-|||
|
- Inherited from Inherited from Inherited from |
- |||
-
|
-|||
|
- Inherited from Inherited from |
- |||
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class MediaUploadSizeError
-- object --+ - | -exceptions.BaseException --+ - | - exceptions.Exception --+ - | - Error --+ - | - MediaUploadSizeError -- -
-
Media is larger than the method can accept.
- - - -
-
|
-|||
|
- Inherited from Inherited from Inherited from |
- |||
-
|
-|||
|
- Inherited from Inherited from |
- |||
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class ResumableUploadError
-- object --+ - | -exceptions.BaseException --+ - | - exceptions.Exception --+ - | - Error --+ - | - HttpError --+ - | - ResumableUploadError -- -
-
Error occurred during resumable upload.
- - - -
-
|
-|||
|
- Inherited from Inherited from Inherited from Inherited from Inherited from |
- |||
-
|
-|||
|
- Inherited from Inherited from |
- |||
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class UnacceptableMimeTypeError
-- object --+ - | -exceptions.BaseException --+ - | - exceptions.Exception --+ - | - Error --+ - | - UnacceptableMimeTypeError -- -
-
That is an unacceptable mimetype for this operation.
- - - -
-
|
-|||
|
- Inherited from Inherited from Inherited from |
- |||
-
|
-|||
|
- Inherited from Inherited from |
- |||
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class UnexpectedBodyError
-- object --+ - | -exceptions.BaseException --+ - | - exceptions.Exception --+ - | - Error --+ - | - UnexpectedBodyError -- -
-
Exception raised by RequestMockBuilder on unexpected bodies.
- - - -
-
|
-|||
| - - |
-
|
- ||
|
- Inherited from Inherited from Inherited from |
- |||
-
|
-|||
|
- Inherited from Inherited from |
- |||
-
|
-|||
-
-
-
-
-
Constructor for an UnexpectedMethodError. -
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class UnexpectedMethodError
-- object --+ - | -exceptions.BaseException --+ - | - exceptions.Exception --+ - | - Error --+ - | - UnexpectedMethodError -- -
-
Exception raised by RequestMockBuilder on unexpected calls.
- - - -
-
|
-|||
| - - |
-
|
- ||
|
- Inherited from Inherited from Inherited from |
- |||
-
|
-|||
|
- Inherited from Inherited from |
- |||
-
|
-|||
-
-
-
-
-
Constructor for an UnexpectedMethodError. -
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class UnknownApiNameOrVersion
-- object --+ - | -exceptions.BaseException --+ - | - exceptions.Exception --+ - | - Error --+ - | - UnknownApiNameOrVersion -- -
-
No API with that name and version exists.
- - - -
-
|
-|||
|
- Inherited from Inherited from Inherited from |
- |||
-
|
-|||
|
- Inherited from Inherited from |
- |||
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class UnknownFileType
-- object --+ - | -exceptions.BaseException --+ - | - exceptions.Exception --+ - | - Error --+ - | - UnknownFileType -- -
-
File type unknown or unexpected.
- - - -
-
|
-|||
|
- Inherited from Inherited from Inherited from |
- |||
-
|
-|||
|
- Inherited from Inherited from |
- |||
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class UnknownLinkType
-- object --+ - | -exceptions.BaseException --+ - | - exceptions.Exception --+ - | - Error --+ - | - UnknownLinkType -- -
-
Link type unknown or unexpected.
- - - -
-
|
-|||
|
- Inherited from Inherited from Inherited from |
- |||
-
|
-|||
|
- Inherited from Inherited from |
- |||
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Module http
-Classes to encapsulate a single HTTP request.
-The classes implement a command pattern, with every object supporting - an execute() method that does the actual HTTP request.
- --
Author: - jcgregorio@google.com (Joe Gregorio) -
-
-
|
-|||
| - - |
- MediaUploadProgress - Status of a resumable upload. - |
- ||
| - - |
- MediaDownloadProgress - Status of a resumable download. - |
- ||
| - - |
- MediaUpload - Describes a media object to upload. - |
- ||
| - - |
- MediaIoBaseUpload - A MediaUpload for a io.Base objects. - |
- ||
| - - |
- MediaFileUpload - A MediaUpload for a file. - |
- ||
| - - |
- MediaInMemoryUpload - MediaUpload for a chunk of bytes. - |
- ||
| - - |
- MediaIoBaseDownload - "Download media resources. - |
- ||
| - - |
- _StreamSlice - Truncated stream. - |
- ||
| - - |
- HttpRequest - Encapsulates a single HTTP request. - |
- ||
| - - |
- BatchHttpRequest - Batches multiple HttpRequest objects into a single HTTP request. - |
- ||
| - - |
- HttpRequestMock - Mock of HttpRequest. - |
- ||
| - - |
- RequestMockBuilder - A simple mock of HttpRequest - |
- ||
| - - |
- HttpMock - Mock of httplib2.Http - |
- ||
| - - |
- HttpMockSequence - Mock of httplib2.Http - |
- ||
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
-
|
-|||
| - - |
- LOGGER = logging.getLogger(__name__)
- |
- ||
| - - |
- DEFAULT_CHUNK_SIZE = 104857600
- |
- ||
| - - |
- MAX_URI_LENGTH = 2048
- |
- ||
| - - |
- MAX_BATCH_LIMIT = 1000
- |
- ||
| - - |
- _TOO_MANY_REQUESTS = 429
- |
- ||
| - - |
- DEFAULT_HTTP_TIMEOUT_SEC = 60
- |
- ||
| - - |
- _LEGACY_BATCH_URI = |
- ||
| - - |
- ConnectionError = None
- |
- ||
| - - |
- __package__ = None
- |
- ||
-
|
-|||
-
-
-
-
-
-
-Determines whether a response should be retried. - -Args: - resp_status: The response status received. - content: The response content body. - -Returns: - True if the response should be retried, otherwise False. - --
|
-
-
-
-
-
-
-Retries an HTTP request multiple times while handling errors. - -If after all retries the request still fails, last error is either returned as -return value (for HTTP 5xx errors) or thrown (for ssl.SSLError). - -Args: - http: Http object to be used to execute request. - num_retries: Maximum number of retries. - req_type: Type of the request (used for logging retries). - sleep, rand: Functions to sleep for random time between retries. - uri: URI to be requested. - method: HTTP method to be used. - args, kwargs: Additional arguments passed to http.request. - -Returns: - resp, content - Response from the http request (may be HTTP 5xx). - --
|
-
-
-
-
-
-
-Set the user-agent on every request. - -Args: - http - An instance of httplib2.Http - or something that acts like it. - user_agent: string, the value for the user-agent header. - -Returns: - A modified instance of http that was passed in. - -Example: - - h = httplib2.Http() - h = set_user_agent(h, "my-app-name/6.0") - -Most of the time the user-agent will be set doing auth, this is for the rare -cases where you are accessing an unauthenticated endpoint. - --
|
-
-
-
-
-
-
-Tunnel PATCH requests over POST. -Args: - http - An instance of httplib2.Http - or something that acts like it. - -Returns: - A modified instance of http that was passed in. - -Example: - - h = httplib2.Http() - h = tunnel_patch(h, "my-app-name/6.0") - -Useful if you are running on a platform that doesn't support PATCH. -Apply this last if you are using OAuth 1.0, as changing the method -will result in a different signature. - --
|
-
-
-
-
-
-Builds httplib2.Http object - -Returns: -A httplib2.Http object, which is used to make http requests, and which has timeout set by default. -To override default timeout call - - socket.setdefaulttimeout(timeout_in_sec) - -before interacting with this method. - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Source Code for Module googleapiclient.http
-- 1 # Copyright 2014 Google Inc. All Rights Reserved. - 2 # - 3 # Licensed under the Apache License, Version 2.0 (the "License"); - 4 # you may not use this file except in compliance with the License. - 5 # You may obtain a copy of the License at - 6 # - 7 # http://www.apache.org/licenses/LICENSE-2.0 - 8 # - 9 # Unless required by applicable law or agreed to in writing, software - 10 # distributed under the License is distributed on an "AS IS" BASIS, - 11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - 12 # See the License for the specific language governing permissions and - 13 # limitations under the License. - 14 - 15 """Classes to encapsulate a single HTTP request. - 16 - 17 The classes implement a command pattern, with every - 18 object supporting an execute() method that does the - 19 actual HTTP request. - 20 """ - 21 from __future__ import absolute_import - 22 import six - 23 from six.moves import http_client - 24 from six.moves import range - 25 - 26 __author__ = "jcgregorio@google.com (Joe Gregorio)" - 27 - 28 from six import BytesIO, StringIO - 29 from six.moves.urllib.parse import urlparse, urlunparse, quote, unquote - 30 - 31 import base64 - 32 import copy - 33 import gzip - 34 import httplib2 - 35 import json - 36 import logging - 37 import mimetypes - 38 import os - 39 import random - 40 import socket - 41 import sys - 42 import time - 43 import uuid - 44 - 45 # TODO(issue 221): Remove this conditional import jibbajabba. - 46 try: - 47 import ssl - 48 except ImportError: - 49 _ssl_SSLError = object() - 50 else: - 51 _ssl_SSLError = ssl.SSLError - 52 - 53 from email.generator import Generator - 54 from email.mime.multipart import MIMEMultipart - 55 from email.mime.nonmultipart import MIMENonMultipart - 56 from email.parser import FeedParser - 57 - 58 from googleapiclient import _helpers as util - 59 - 60 from googleapiclient import _auth - 61 from googleapiclient.errors import BatchError - 62 from googleapiclient.errors import HttpError - 63 from googleapiclient.errors import InvalidChunkSizeError - 64 from googleapiclient.errors import ResumableUploadError - 65 from googleapiclient.errors import UnexpectedBodyError - 66 from googleapiclient.errors import UnexpectedMethodError - 67 from googleapiclient.model import JsonModel - 68 - 69 - 70 LOGGER = logging.getLogger(__name__) - 71 - 72 DEFAULT_CHUNK_SIZE = 100 * 1024 * 1024 - 73 - 74 MAX_URI_LENGTH = 2048 - 75 - 76 MAX_BATCH_LIMIT = 1000 - 77 - 78 _TOO_MANY_REQUESTS = 429 - 79 - 80 DEFAULT_HTTP_TIMEOUT_SEC = 60 - 81 - 82 _LEGACY_BATCH_URI = "https://www.googleapis.com/batch" - 83 - 84 if six.PY2: - 85 # That's a builtin python3 exception, nonexistent in python2. - 86 # Defined to None to avoid NameError while trying to catch it - 87 ConnectionError = None --91 """Determines whether a response should be retried. - 92 - 93 Args: - 94 resp_status: The response status received. - 95 content: The response content body. - 96 - 97 Returns: - 98 True if the response should be retried, otherwise False. - 99 """ - 100 # Retry on 5xx errors. - 101 if resp_status >= 500: - 102 return True - 103 - 104 # Retry on 429 errors. - 105 if resp_status == _TOO_MANY_REQUESTS: - 106 return True - 107 - 108 # For 403 errors, we have to check for the `reason` in the response to - 109 # determine if we should retry. - 110 if resp_status == six.moves.http_client.FORBIDDEN: - 111 # If there's no details about the 403 type, don't retry. - 112 if not content: - 113 return False - 114 - 115 # Content is in JSON format. - 116 try: - 117 data = json.loads(content.decode("utf-8")) - 118 if isinstance(data, dict): - 119 reason = data["error"]["errors"][0]["reason"] - 120 else: - 121 reason = data[0]["error"]["errors"]["reason"] - 122 except (UnicodeDecodeError, ValueError, KeyError): - 123 LOGGER.warning("Invalid JSON content from response: %s", content) - 124 return False - 125 - 126 LOGGER.warning('Encountered 403 Forbidden with reason "%s"', reason) - 127 - 128 # Only retry on rate limit related failures. - 129 if reason in ("userRateLimitExceeded", "rateLimitExceeded"): - 130 return True - 131 - 132 # Everything else is a success or non-retriable so break. - 133 return False -134 -135 - 136 -def _retry_request( - 137 http, num_retries, req_type, sleep, rand, uri, method, *args, **kwargs - 138 ): -139 """Retries an HTTP request multiple times while handling errors. - 140 - 141 If after all retries the request still fails, last error is either returned as - 142 return value (for HTTP 5xx errors) or thrown (for ssl.SSLError). - 143 - 144 Args: - 145 http: Http object to be used to execute request. - 146 num_retries: Maximum number of retries. - 147 req_type: Type of the request (used for logging retries). - 148 sleep, rand: Functions to sleep for random time between retries. - 149 uri: URI to be requested. - 150 method: HTTP method to be used. - 151 args, kwargs: Additional arguments passed to http.request. - 152 - 153 Returns: - 154 resp, content - Response from the http request (may be HTTP 5xx). - 155 """ - 156 resp = None - 157 content = None - 158 exception = None - 159 for retry_num in range(num_retries + 1): - 160 if retry_num > 0: - 161 # Sleep before retrying. - 162 sleep_time = rand() * 2 ** retry_num - 163 LOGGER.warning( - 164 "Sleeping %.2f seconds before retry %d of %d for %s: %s %s, after %s", - 165 sleep_time, - 166 retry_num, - 167 num_retries, - 168 req_type, - 169 method, - 170 uri, - 171 resp.status if resp else exception, - 172 ) - 173 sleep(sleep_time) - 174 - 175 try: - 176 exception = None - 177 resp, content = http.request(uri, method, *args, **kwargs) - 178 # Retry on SSL errors and socket timeout errors. - 179 except _ssl_SSLError as ssl_error: - 180 exception = ssl_error - 181 except socket.timeout as socket_timeout: - 182 # It's important that this be before socket.error as it's a subclass - 183 # socket.timeout has no errorcode - 184 exception = socket_timeout - 185 except ConnectionError as connection_error: - 186 # Needs to be before socket.error as it's a subclass of - 187 # OSError (socket.error) - 188 exception = connection_error - 189 except socket.error as socket_error: - 190 # errno's contents differ by platform, so we have to match by name. - 191 if socket.errno.errorcode.get(socket_error.errno) not in { - 192 "WSAETIMEDOUT", - 193 "ETIMEDOUT", - 194 "EPIPE", - 195 "ECONNABORTED", - 196 }: - 197 raise - 198 exception = socket_error - 199 except httplib2.ServerNotFoundError as server_not_found_error: - 200 exception = server_not_found_error - 201 - 202 if exception: - 203 if retry_num == num_retries: - 204 raise exception - 205 else: - 206 continue - 207 - 208 if not _should_retry_response(resp.status, content): - 209 break - 210 - 211 return resp, content -212 -215 """Status of a resumable upload.""" - 216 -239 -218 """Constructor. - 219 - 220 Args: - 221 resumable_progress: int, bytes sent so far. - 222 total_size: int, total bytes in complete upload, or None if the total - 223 upload size isn't known ahead of time. - 224 """ - 225 self.resumable_progress = resumable_progress - 226 self.total_size = total_size -227 -229 """Percent of upload completed, as a float. - 230 - 231 Returns: - 232 the percentage complete as a float, returning 0.0 if the total size of - 233 the upload is unknown. - 234 """ - 235 if self.total_size is not None and self.total_size != 0: - 236 return float(self.resumable_progress) / float(self.total_size) - 237 else: - 238 return 0.0 -242 """Status of a resumable download.""" - 243 -265 -245 """Constructor. - 246 - 247 Args: - 248 resumable_progress: int, bytes received so far. - 249 total_size: int, total bytes in complete download. - 250 """ - 251 self.resumable_progress = resumable_progress - 252 self.total_size = total_size -253 -255 """Percent of download completed, as a float. - 256 - 257 Returns: - 258 the percentage complete as a float, returning 0.0 if the total size of - 259 the download is unknown. - 260 """ - 261 if self.total_size is not None and self.total_size != 0: - 262 return float(self.resumable_progress) / float(self.total_size) - 263 else: - 264 return 0.0 -268 """Describes a media object to upload. - 269 - 270 Base class that defines the interface of MediaUpload subclasses. - 271 - 272 Note that subclasses of MediaUpload may allow you to control the chunksize - 273 when uploading a media object. It is important to keep the size of the chunk - 274 as large as possible to keep the upload efficient. Other factors may influence - 275 the size of the chunk you use, particularly if you are working in an - 276 environment where individual HTTP requests may have a hardcoded time limit, - 277 such as under certain classes of requests under Google App Engine. - 278 - 279 Streams are io.Base compatible objects that support seek(). Some MediaUpload - 280 subclasses support using streams directly to upload data. Support for - 281 streaming may be indicated by a MediaUpload sub-class and if appropriate for a - 282 platform that stream will be used for uploading the media object. The support - 283 for streaming is indicated by has_stream() returning True. The stream() method - 284 should return an io.Base object that supports seek(). On platforms where the - 285 underlying httplib module supports streaming, for example Python 2.6 and - 286 later, the stream will be passed into the http library which will result in - 287 less memory being used and possibly faster uploads. - 288 - 289 If you need to upload media that can't be uploaded using any of the existing - 290 MediaUpload sub-class then you can sub-class MediaUpload for your particular - 291 needs. - 292 """ - 293 -408 -295 """Chunk size for resumable uploads. - 296 - 297 Returns: - 298 Chunk size in bytes. - 299 """ - 300 raise NotImplementedError() -301 -303 """Mime type of the body. - 304 - 305 Returns: - 306 Mime type. - 307 """ - 308 return "application/octet-stream" -309 -311 """Size of upload. - 312 - 313 Returns: - 314 Size of the body, or None of the size is unknown. - 315 """ - 316 return None -317 -319 """Whether this upload is resumable. - 320 - 321 Returns: - 322 True if resumable upload or False. - 323 """ - 324 return False -325 -327 """Get bytes from the media. - 328 - 329 Args: - 330 begin: int, offset from beginning of file. - 331 length: int, number of bytes to read, starting at begin. - 332 - 333 Returns: - 334 A string of bytes read. May be shorter than length if EOF was reached - 335 first. - 336 """ - 337 raise NotImplementedError() -338 -340 """Does the underlying upload support a streaming interface. - 341 - 342 Streaming means it is an io.IOBase subclass that supports seek, i.e. - 343 seekable() returns True. - 344 - 345 Returns: - 346 True if the call to stream() will return an instance of a seekable io.Base - 347 subclass. - 348 """ - 349 return False -350 -352 """A stream interface to the data being uploaded. - 353 - 354 Returns: - 355 The returned value is an io.IOBase subclass that supports seek, i.e. - 356 seekable() returns True. - 357 """ - 358 raise NotImplementedError() -359 - 360 @util.positional(1) -362 """Utility function for creating a JSON representation of a MediaUpload. - 363 - 364 Args: - 365 strip: array, An array of names of members to not include in the JSON. - 366 - 367 Returns: - 368 string, a JSON representation of this instance, suitable to pass to - 369 from_json(). - 370 """ - 371 t = type(self) - 372 d = copy.copy(self.__dict__) - 373 if strip is not None: - 374 for member in strip: - 375 del d[member] - 376 d["_class"] = t.__name__ - 377 d["_module"] = t.__module__ - 378 return json.dumps(d) -379 -381 """Create a JSON representation of an instance of MediaUpload. - 382 - 383 Returns: - 384 string, a JSON representation of this instance, suitable to pass to - 385 from_json(). - 386 """ - 387 return self._to_json() -388 - 389 @classmethod -391 """Utility class method to instantiate a MediaUpload subclass from a JSON - 392 representation produced by to_json(). - 393 - 394 Args: - 395 s: string, JSON from to_json(). - 396 - 397 Returns: - 398 An instance of the subclass of MediaUpload that was serialized with - 399 to_json(). - 400 """ - 401 data = json.loads(s) - 402 # Find and call the right classmethod from_json() to restore the object. - 403 module = data["_module"] - 404 m = __import__(module, fromlist=module.split(".")[:-1]) - 405 kls = getattr(m, data["_class"]) - 406 from_json = getattr(kls, "from_json") - 407 return from_json(s) -411 """A MediaUpload for a io.Base objects. - 412 - 413 Note that the Python file object is compatible with io.Base and can be used - 414 with this class also. - 415 - 416 fh = BytesIO('...Some data to upload...') - 417 media = MediaIoBaseUpload(fh, mimetype='image/png', - 418 chunksize=1024*1024, resumable=True) - 419 farm.animals().insert( - 420 id='cow', - 421 name='cow.png', - 422 media_body=media).execute() - 423 - 424 Depending on the platform you are working on, you may pass -1 as the - 425 chunksize, which indicates that the entire file should be uploaded in a single - 426 request. If the underlying platform supports streams, such as Python 2.6 or - 427 later, then this can be very efficient as it avoids multiple connections, and - 428 also avoids loading the entire file into memory before sending it. Note that - 429 Google App Engine has a 5MB limit on request size, so you should never set - 430 your chunksize larger than 5MB, or to -1. - 431 """ - 432 - 433 @util.positional(3) -532 -435 """Constructor. - 436 - 437 Args: - 438 fd: io.Base or file object, The source of the bytes to upload. MUST be - 439 opened in blocking mode, do not use streams opened in non-blocking mode. - 440 The given stream must be seekable, that is, it must be able to call - 441 seek() on fd. - 442 mimetype: string, Mime-type of the file. - 443 chunksize: int, File will be uploaded in chunks of this many bytes. Only - 444 used if resumable=True. Pass in a value of -1 if the file is to be - 445 uploaded as a single chunk. Note that Google App Engine has a 5MB limit - 446 on request size, so you should never set your chunksize larger than 5MB, - 447 or to -1. - 448 resumable: bool, True if this is a resumable upload. False means upload - 449 in a single request. - 450 """ - 451 super(MediaIoBaseUpload, self).__init__() - 452 self._fd = fd - 453 self._mimetype = mimetype - 454 if not (chunksize == -1 or chunksize > 0): - 455 raise InvalidChunkSizeError() - 456 self._chunksize = chunksize - 457 self._resumable = resumable - 458 - 459 self._fd.seek(0, os.SEEK_END) - 460 self._size = self._fd.tell() -461 -463 """Chunk size for resumable uploads. - 464 - 465 Returns: - 466 Chunk size in bytes. - 467 """ - 468 return self._chunksize -469 -471 """Mime type of the body. - 472 - 473 Returns: - 474 Mime type. - 475 """ - 476 return self._mimetype -477 -479 """Size of upload. - 480 - 481 Returns: - 482 Size of the body, or None of the size is unknown. - 483 """ - 484 return self._size -485 -487 """Whether this upload is resumable. - 488 - 489 Returns: - 490 True if resumable upload or False. - 491 """ - 492 return self._resumable -493 -495 """Get bytes from the media. - 496 - 497 Args: - 498 begin: int, offset from beginning of file. - 499 length: int, number of bytes to read, starting at begin. - 500 - 501 Returns: - 502 A string of bytes read. May be shorted than length if EOF was reached - 503 first. - 504 """ - 505 self._fd.seek(begin) - 506 return self._fd.read(length) -507 -509 """Does the underlying upload support a streaming interface. - 510 - 511 Streaming means it is an io.IOBase subclass that supports seek, i.e. - 512 seekable() returns True. - 513 - 514 Returns: - 515 True if the call to stream() will return an instance of a seekable io.Base - 516 subclass. - 517 """ - 518 return True -519 -521 """A stream interface to the data being uploaded. - 522 - 523 Returns: - 524 The returned value is an io.IOBase subclass that supports seek, i.e. - 525 seekable() returns True. - 526 """ - 527 return self._fd -528 -535 """A MediaUpload for a file. - 536 - 537 Construct a MediaFileUpload and pass as the media_body parameter of the - 538 method. For example, if we had a service that allowed uploading images: - 539 - 540 media = MediaFileUpload('cow.png', mimetype='image/png', - 541 chunksize=1024*1024, resumable=True) - 542 farm.animals().insert( - 543 id='cow', - 544 name='cow.png', - 545 media_body=media).execute() - 546 - 547 Depending on the platform you are working on, you may pass -1 as the - 548 chunksize, which indicates that the entire file should be uploaded in a single - 549 request. If the underlying platform supports streams, such as Python 2.6 or - 550 later, then this can be very efficient as it avoids multiple connections, and - 551 also avoids loading the entire file into memory before sending it. Note that - 552 Google App Engine has a 5MB limit on request size, so you should never set - 553 your chunksize larger than 5MB, or to -1. - 554 """ - 555 - 556 @util.positional(2) -607 -557 - def __init__( - 558 self, filename, mimetype=None, chunksize=DEFAULT_CHUNK_SIZE, resumable=False - 559 ): -560 """Constructor. - 561 - 562 Args: - 563 filename: string, Name of the file. - 564 mimetype: string, Mime-type of the file. If None then a mime-type will be - 565 guessed from the file extension. - 566 chunksize: int, File will be uploaded in chunks of this many bytes. Only - 567 used if resumable=True. Pass in a value of -1 if the file is to be - 568 uploaded in a single chunk. Note that Google App Engine has a 5MB limit - 569 on request size, so you should never set your chunksize larger than 5MB, - 570 or to -1. - 571 resumable: bool, True if this is a resumable upload. False means upload - 572 in a single request. - 573 """ - 574 self._filename = filename - 575 fd = open(self._filename, "rb") - 576 if mimetype is None: - 577 # No mimetype provided, make a guess. - 578 mimetype, _ = mimetypes.guess_type(filename) - 579 if mimetype is None: - 580 # Guess failed, use octet-stream. - 581 mimetype = "application/octet-stream" - 582 super(MediaFileUpload, self).__init__( - 583 fd, mimetype, chunksize=chunksize, resumable=resumable - 584 ) -585 -587 self._fd.close() -588 -590 """Creating a JSON representation of an instance of MediaFileUpload. - 591 - 592 Returns: - 593 string, a JSON representation of this instance, suitable to pass to - 594 from_json(). - 595 """ - 596 return self._to_json(strip=["_fd"]) -597 - 598 @staticmethod -600 d = json.loads(s) - 601 return MediaFileUpload( - 602 d["_filename"], - 603 mimetype=d["_mimetype"], - 604 chunksize=d["_chunksize"], - 605 resumable=d["_resumable"], - 606 ) -610 """MediaUpload for a chunk of bytes. - 611 - 612 DEPRECATED: Use MediaIoBaseUpload with either io.TextIOBase or StringIO for - 613 the stream. - 614 """ - 615 - 616 @util.positional(2) -642 -617 - def __init__( - 618 self, - 619 body, - 620 mimetype="application/octet-stream", - 621 chunksize=DEFAULT_CHUNK_SIZE, - 622 resumable=False, - 623 ): -624 """Create a new MediaInMemoryUpload. - 625 - 626 DEPRECATED: Use MediaIoBaseUpload with either io.TextIOBase or StringIO for - 627 the stream. - 628 - 629 Args: - 630 body: string, Bytes of body content. - 631 mimetype: string, Mime-type of the file or default of - 632 'application/octet-stream'. - 633 chunksize: int, File will be uploaded in chunks of this many bytes. Only - 634 used if resumable=True. - 635 resumable: bool, True if this is a resumable upload. False means upload - 636 in a single request. - 637 """ - 638 fd = BytesIO(body) - 639 super(MediaInMemoryUpload, self).__init__( - 640 fd, mimetype, chunksize=chunksize, resumable=resumable - 641 ) -645 """"Download media resources. - 646 - 647 Note that the Python file object is compatible with io.Base and can be used - 648 with this class also. - 649 - 650 - 651 Example: - 652 request = farms.animals().get_media(id='cow') - 653 fh = io.FileIO('cow.png', mode='wb') - 654 downloader = MediaIoBaseDownload(fh, request, chunksize=1024*1024) - 655 - 656 done = False - 657 while done is False: - 658 status, done = downloader.next_chunk() - 659 if status: - 660 print "Download %d%%." % int(status.progress() * 100) - 661 print "Download Complete!" - 662 """ - 663 - 664 @util.positional(3) -750 -666 """Constructor. - 667 - 668 Args: - 669 fd: io.Base or file object, The stream in which to write the downloaded - 670 bytes. - 671 request: googleapiclient.http.HttpRequest, the media request to perform in - 672 chunks. - 673 chunksize: int, File will be downloaded in chunks of this many bytes. - 674 """ - 675 self._fd = fd - 676 self._request = request - 677 self._uri = request.uri - 678 self._chunksize = chunksize - 679 self._progress = 0 - 680 self._total_size = None - 681 self._done = False - 682 - 683 # Stubs for testing. - 684 self._sleep = time.sleep - 685 self._rand = random.random - 686 - 687 self._headers = {} - 688 for k, v in six.iteritems(request.headers): - 689 # allow users to supply custom headers by setting them on the request - 690 # but strip out the ones that are set by default on requests generated by - 691 # API methods like Drive's files().get(fileId=...) - 692 if not k.lower() in ("accept", "accept-encoding", "user-agent"): - 693 self._headers[k] = v -694 - 695 @util.positional(1) -697 """Get the next chunk of the download. - 698 - 699 Args: - 700 num_retries: Integer, number of times to retry with randomized - 701 exponential backoff. If all retries fail, the raised HttpError - 702 represents the last request. If zero (default), we attempt the - 703 request only once. - 704 - 705 Returns: - 706 (status, done): (MediaDownloadProgress, boolean) - 707 The value of 'done' will be True when the media has been fully - 708 downloaded or the total size of the media is unknown. - 709 - 710 Raises: - 711 googleapiclient.errors.HttpError if the response was not a 2xx. - 712 httplib2.HttpLib2Error if a transport error has occurred. - 713 """ - 714 headers = self._headers.copy() - 715 headers["range"] = "bytes=%d-%d" % ( - 716 self._progress, - 717 self._progress + self._chunksize, - 718 ) - 719 http = self._request.http - 720 - 721 resp, content = _retry_request( - 722 http, - 723 num_retries, - 724 "media download", - 725 self._sleep, - 726 self._rand, - 727 self._uri, - 728 "GET", - 729 headers=headers, - 730 ) - 731 - 732 if resp.status in [200, 206]: - 733 if "content-location" in resp and resp["content-location"] != self._uri: - 734 self._uri = resp["content-location"] - 735 self._progress += len(content) - 736 self._fd.write(content) - 737 - 738 if "content-range" in resp: - 739 content_range = resp["content-range"] - 740 length = content_range.rsplit("/", 1)[1] - 741 self._total_size = int(length) - 742 elif "content-length" in resp: - 743 self._total_size = int(resp["content-length"]) - 744 - 745 if self._total_size is None or self._progress == self._total_size: - 746 self._done = True - 747 return MediaDownloadProgress(self._progress, self._total_size), self._done - 748 else: - 749 raise HttpError(resp, content, uri=self._uri) -753 """Truncated stream. - 754 - 755 Takes a stream and presents a stream that is a slice of the original stream. - 756 This is used when uploading media in chunks. In later versions of Python a - 757 stream can be passed to httplib in place of the string of data to send. The - 758 problem is that httplib just blindly reads to the end of the stream. This - 759 wrapper presents a virtual stream that only reads to the end of the chunk. - 760 """ - 761 -790 -763 """Constructor. - 764 - 765 Args: - 766 stream: (io.Base, file object), the stream to wrap. - 767 begin: int, the seek position the chunk begins at. - 768 chunksize: int, the size of the chunk. - 769 """ - 770 self._stream = stream - 771 self._begin = begin - 772 self._chunksize = chunksize - 773 self._stream.seek(begin) -774 -776 """Read n bytes. - 777 - 778 Args: - 779 n, int, the number of bytes to read. - 780 - 781 Returns: - 782 A string of length 'n', or less if EOF is reached. - 783 """ - 784 # The data left available to read sits in [cur, end) - 785 cur = self._stream.tell() - 786 end = self._begin + self._chunksize - 787 if n == -1 or cur + n > end: - 788 n = end - cur - 789 return self._stream.read(n) -793 """Encapsulates a single HTTP request.""" - 794 - 795 @util.positional(4) -1124 -796 - def __init__( - 797 self, - 798 http, - 799 postproc, - 800 uri, - 801 method="GET", - 802 body=None, - 803 headers=None, - 804 methodId=None, - 805 resumable=None, - 806 ): -807 """Constructor for an HttpRequest. - 808 - 809 Args: - 810 http: httplib2.Http, the transport object to use to make a request - 811 postproc: callable, called on the HTTP response and content to transform - 812 it into a data object before returning, or raising an exception - 813 on an error. - 814 uri: string, the absolute URI to send the request to - 815 method: string, the HTTP method to use - 816 body: string, the request body of the HTTP request, - 817 headers: dict, the HTTP request headers - 818 methodId: string, a unique identifier for the API method being called. - 819 resumable: MediaUpload, None if this is not a resumbale request. - 820 """ - 821 self.uri = uri - 822 self.method = method - 823 self.body = body - 824 self.headers = headers or {} - 825 self.methodId = methodId - 826 self.http = http - 827 self.postproc = postproc - 828 self.resumable = resumable - 829 self.response_callbacks = [] - 830 self._in_error_state = False - 831 - 832 # The size of the non-media part of the request. - 833 self.body_size = len(self.body or "") - 834 - 835 # The resumable URI to send chunks to. - 836 self.resumable_uri = None - 837 - 838 # The bytes that have been uploaded. - 839 self.resumable_progress = 0 - 840 - 841 # Stubs for testing. - 842 self._rand = random.random - 843 self._sleep = time.sleep -844 - 845 @util.positional(1) -847 """Execute the request. - 848 - 849 Args: - 850 http: httplib2.Http, an http object to be used in place of the - 851 one the HttpRequest request object was constructed with. - 852 num_retries: Integer, number of times to retry with randomized - 853 exponential backoff. If all retries fail, the raised HttpError - 854 represents the last request. If zero (default), we attempt the - 855 request only once. - 856 - 857 Returns: - 858 A deserialized object model of the response body as determined - 859 by the postproc. - 860 - 861 Raises: - 862 googleapiclient.errors.HttpError if the response was not a 2xx. - 863 httplib2.HttpLib2Error if a transport error has occurred. - 864 """ - 865 if http is None: - 866 http = self.http - 867 - 868 if self.resumable: - 869 body = None - 870 while body is None: - 871 _, body = self.next_chunk(http=http, num_retries=num_retries) - 872 return body - 873 - 874 # Non-resumable case. - 875 - 876 if "content-length" not in self.headers: - 877 self.headers["content-length"] = str(self.body_size) - 878 # If the request URI is too long then turn it into a POST request. - 879 # Assume that a GET request never contains a request body. - 880 if len(self.uri) > MAX_URI_LENGTH and self.method == "GET": - 881 self.method = "POST" - 882 self.headers["x-http-method-override"] = "GET" - 883 self.headers["content-type"] = "application/x-www-form-urlencoded" - 884 parsed = urlparse(self.uri) - 885 self.uri = urlunparse( - 886 (parsed.scheme, parsed.netloc, parsed.path, parsed.params, None, None) - 887 ) - 888 self.body = parsed.query - 889 self.headers["content-length"] = str(len(self.body)) - 890 - 891 # Handle retries for server-side errors. - 892 resp, content = _retry_request( - 893 http, - 894 num_retries, - 895 "request", - 896 self._sleep, - 897 self._rand, - 898 str(self.uri), - 899 method=str(self.method), - 900 body=self.body, - 901 headers=self.headers, - 902 ) - 903 - 904 for callback in self.response_callbacks: - 905 callback(resp) - 906 if resp.status >= 300: - 907 raise HttpError(resp, content, uri=self.uri) - 908 return self.postproc(resp, content) -909 - 910 @util.positional(2) -912 """add_response_headers_callback - 913 - 914 Args: - 915 cb: Callback to be called on receiving the response headers, of signature: - 916 - 917 def cb(resp): - 918 # Where resp is an instance of httplib2.Response - 919 """ - 920 self.response_callbacks.append(cb) -921 - 922 @util.positional(1) -924 """Execute the next step of a resumable upload. - 925 - 926 Can only be used if the method being executed supports media uploads and - 927 the MediaUpload object passed in was flagged as using resumable upload. - 928 - 929 Example: - 930 - 931 media = MediaFileUpload('cow.png', mimetype='image/png', - 932 chunksize=1000, resumable=True) - 933 request = farm.animals().insert( - 934 id='cow', - 935 name='cow.png', - 936 media_body=media) - 937 - 938 response = None - 939 while response is None: - 940 status, response = request.next_chunk() - 941 if status: - 942 print "Upload %d%% complete." % int(status.progress() * 100) - 943 - 944 - 945 Args: - 946 http: httplib2.Http, an http object to be used in place of the - 947 one the HttpRequest request object was constructed with. - 948 num_retries: Integer, number of times to retry with randomized - 949 exponential backoff. If all retries fail, the raised HttpError - 950 represents the last request. If zero (default), we attempt the - 951 request only once. - 952 - 953 Returns: - 954 (status, body): (ResumableMediaStatus, object) - 955 The body will be None until the resumable media is fully uploaded. - 956 - 957 Raises: - 958 googleapiclient.errors.HttpError if the response was not a 2xx. - 959 httplib2.HttpLib2Error if a transport error has occurred. - 960 """ - 961 if http is None: - 962 http = self.http - 963 - 964 if self.resumable.size() is None: - 965 size = "*" - 966 else: - 967 size = str(self.resumable.size()) - 968 - 969 if self.resumable_uri is None: - 970 start_headers = copy.copy(self.headers) - 971 start_headers["X-Upload-Content-Type"] = self.resumable.mimetype() - 972 if size != "*": - 973 start_headers["X-Upload-Content-Length"] = size - 974 start_headers["content-length"] = str(self.body_size) - 975 - 976 resp, content = _retry_request( - 977 http, - 978 num_retries, - 979 "resumable URI request", - 980 self._sleep, - 981 self._rand, - 982 self.uri, - 983 method=self.method, - 984 body=self.body, - 985 headers=start_headers, - 986 ) - 987 - 988 if resp.status == 200 and "location" in resp: - 989 self.resumable_uri = resp["location"] - 990 else: - 991 raise ResumableUploadError(resp, content) - 992 elif self._in_error_state: - 993 # If we are in an error state then query the server for current state of - 994 # the upload by sending an empty PUT and reading the 'range' header in - 995 # the response. - 996 headers = {"Content-Range": "bytes */%s" % size, "content-length": "0"} - 997 resp, content = http.request(self.resumable_uri, "PUT", headers=headers) - 998 status, body = self._process_response(resp, content) - 999 if body: -1000 # The upload was complete. -1001 return (status, body) -1002 -1003 if self.resumable.has_stream(): -1004 data = self.resumable.stream() -1005 if self.resumable.chunksize() == -1: -1006 data.seek(self.resumable_progress) -1007 chunk_end = self.resumable.size() - self.resumable_progress - 1 -1008 else: -1009 # Doing chunking with a stream, so wrap a slice of the stream. -1010 data = _StreamSlice( -1011 data, self.resumable_progress, self.resumable.chunksize() -1012 ) -1013 chunk_end = min( -1014 self.resumable_progress + self.resumable.chunksize() - 1, -1015 self.resumable.size() - 1, -1016 ) -1017 else: -1018 data = self.resumable.getbytes( -1019 self.resumable_progress, self.resumable.chunksize() -1020 ) -1021 -1022 # A short read implies that we are at EOF, so finish the upload. -1023 if len(data) < self.resumable.chunksize(): -1024 size = str(self.resumable_progress + len(data)) -1025 -1026 chunk_end = self.resumable_progress + len(data) - 1 -1027 -1028 headers = { -1029 "Content-Range": "bytes %d-%d/%s" -1030 % (self.resumable_progress, chunk_end, size), -1031 # Must set the content-length header here because httplib can't -1032 # calculate the size when working with _StreamSlice. -1033 "Content-Length": str(chunk_end - self.resumable_progress + 1), -1034 } -1035 -1036 for retry_num in range(num_retries + 1): -1037 if retry_num > 0: -1038 self._sleep(self._rand() * 2 ** retry_num) -1039 LOGGER.warning( -1040 "Retry #%d for media upload: %s %s, following status: %d" -1041 % (retry_num, self.method, self.uri, resp.status) -1042 ) -1043 -1044 try: -1045 resp, content = http.request( -1046 self.resumable_uri, method="PUT", body=data, headers=headers -1047 ) -1048 except: -1049 self._in_error_state = True -1050 raise -1051 if not _should_retry_response(resp.status, content): -1052 break -1053 -1054 return self._process_response(resp, content) -1055 -1057 """Process the response from a single chunk upload. -1058 -1059 Args: -1060 resp: httplib2.Response, the response object. -1061 content: string, the content of the response. -1062 -1063 Returns: -1064 (status, body): (ResumableMediaStatus, object) -1065 The body will be None until the resumable media is fully uploaded. -1066 -1067 Raises: -1068 googleapiclient.errors.HttpError if the response was not a 2xx or a 308. -1069 """ -1070 if resp.status in [200, 201]: -1071 self._in_error_state = False -1072 return None, self.postproc(resp, content) -1073 elif resp.status == 308: -1074 self._in_error_state = False -1075 # A "308 Resume Incomplete" indicates we are not done. -1076 try: -1077 self.resumable_progress = int(resp["range"].split("-")[1]) + 1 -1078 except KeyError: -1079 # If resp doesn't contain range header, resumable progress is 0 -1080 self.resumable_progress = 0 -1081 if "location" in resp: -1082 self.resumable_uri = resp["location"] -1083 else: -1084 self._in_error_state = True -1085 raise HttpError(resp, content, uri=self.uri) -1086 -1087 return ( -1088 MediaUploadProgress(self.resumable_progress, self.resumable.size()), -1089 None, -1090 ) -1091 -1093 """Returns a JSON representation of the HttpRequest.""" -1094 d = copy.copy(self.__dict__) -1095 if d["resumable"] is not None: -1096 d["resumable"] = self.resumable.to_json() -1097 del d["http"] -1098 del d["postproc"] -1099 del d["_sleep"] -1100 del d["_rand"] -1101 -1102 return json.dumps(d) -1103 -1104 @staticmethod -1106 """Returns an HttpRequest populated with info from a JSON object.""" -1107 d = json.loads(s) -1108 if d["resumable"] is not None: -1109 d["resumable"] = MediaUpload.new_from_json(d["resumable"]) -1110 return HttpRequest( -1111 http, -1112 postproc, -1113 uri=d["uri"], -1114 method=d["method"], -1115 body=d["body"], -1116 headers=d["headers"], -1117 methodId=d["methodId"], -1118 resumable=d["resumable"], -1119 ) -1120 -1121 @staticmethod -1127 """Batches multiple HttpRequest objects into a single HTTP request. -1128 -1129 Example: -1130 from googleapiclient.http import BatchHttpRequest -1131 -1132 def list_animals(request_id, response, exception): -1133 \"\"\"Do something with the animals list response.\"\"\" -1134 if exception is not None: -1135 # Do something with the exception. -1136 pass -1137 else: -1138 # Do something with the response. -1139 pass -1140 -1141 def list_farmers(request_id, response, exception): -1142 \"\"\"Do something with the farmers list response.\"\"\" -1143 if exception is not None: -1144 # Do something with the exception. -1145 pass -1146 else: -1147 # Do something with the response. -1148 pass -1149 -1150 service = build('farm', 'v2') -1151 -1152 batch = BatchHttpRequest() -1153 -1154 batch.add(service.animals().list(), list_animals) -1155 batch.add(service.farmers().list(), list_farmers) -1156 batch.execute(http=http) -1157 """ -1158 -1159 @util.positional(1) -1569 -1161 """Constructor for a BatchHttpRequest. -1162 -1163 Args: -1164 callback: callable, A callback to be called for each response, of the -1165 form callback(id, response, exception). The first parameter is the -1166 request id, and the second is the deserialized response object. The -1167 third is an googleapiclient.errors.HttpError exception object if an HTTP error -1168 occurred while processing the request, or None if no error occurred. -1169 batch_uri: string, URI to send batch requests to. -1170 """ -1171 if batch_uri is None: -1172 batch_uri = _LEGACY_BATCH_URI -1173 -1174 if batch_uri == _LEGACY_BATCH_URI: -1175 LOGGER.warning( -1176 "You have constructed a BatchHttpRequest using the legacy batch " -1177 "endpoint %s. This endpoint will be turned down on August 12, 2020. " -1178 "Please provide the API-specific endpoint or use " -1179 "service.new_batch_http_request(). For more details see " -1180 "https://developers.googleblog.com/2018/03/discontinuing-support-for-json-rpc-and.html" -1181 "and https://developers.google.com/api-client-library/python/guide/batch.", -1182 _LEGACY_BATCH_URI, -1183 ) -1184 self._batch_uri = batch_uri -1185 -1186 # Global callback to be called for each individual response in the batch. -1187 self._callback = callback -1188 -1189 # A map from id to request. -1190 self._requests = {} -1191 -1192 # A map from id to callback. -1193 self._callbacks = {} -1194 -1195 # List of request ids, in the order in which they were added. -1196 self._order = [] -1197 -1198 # The last auto generated id. -1199 self._last_auto_id = 0 -1200 -1201 # Unique ID on which to base the Content-ID headers. -1202 self._base_id = None -1203 -1204 # A map from request id to (httplib2.Response, content) response pairs -1205 self._responses = {} -1206 -1207 # A map of id(Credentials) that have been refreshed. -1208 self._refreshed_credentials = {} -1209 -1211 """Refresh the credentials and apply to the request. -1212 -1213 Args: -1214 request: HttpRequest, the request. -1215 http: httplib2.Http, the global http object for the batch. -1216 """ -1217 # For the credentials to refresh, but only once per refresh_token -1218 # If there is no http per the request then refresh the http passed in -1219 # via execute() -1220 creds = None -1221 request_credentials = False -1222 -1223 if request.http is not None: -1224 creds = _auth.get_credentials_from_http(request.http) -1225 request_credentials = True -1226 -1227 if creds is None and http is not None: -1228 creds = _auth.get_credentials_from_http(http) -1229 -1230 if creds is not None: -1231 if id(creds) not in self._refreshed_credentials: -1232 _auth.refresh_credentials(creds) -1233 self._refreshed_credentials[id(creds)] = 1 -1234 -1235 # Only apply the credentials if we are using the http object passed in, -1236 # otherwise apply() will get called during _serialize_request(). -1237 if request.http is None or not request_credentials: -1238 _auth.apply_credentials(creds, request.headers) -1239 -1241 """Convert an id to a Content-ID header value. -1242 -1243 Args: -1244 id_: string, identifier of individual request. -1245 -1246 Returns: -1247 A Content-ID header with the id_ encoded into it. A UUID is prepended to -1248 the value because Content-ID headers are supposed to be universally -1249 unique. -1250 """ -1251 if self._base_id is None: -1252 self._base_id = uuid.uuid4() -1253 -1254 # NB: we intentionally leave whitespace between base/id and '+', so RFC2822 -1255 # line folding works properly on Python 3; see -1256 # https://github.com/googleapis/google-api-python-client/issues/164 -1257 return "<%s + %s>" % (self._base_id, quote(id_)) -1258 -1260 """Convert a Content-ID header value to an id. -1261 -1262 Presumes the Content-ID header conforms to the format that _id_to_header() -1263 returns. -1264 -1265 Args: -1266 header: string, Content-ID header value. -1267 -1268 Returns: -1269 The extracted id value. -1270 -1271 Raises: -1272 BatchError if the header is not in the expected format. -1273 """ -1274 if header[0] != "<" or header[-1] != ">": -1275 raise BatchError("Invalid value for Content-ID: %s" % header) -1276 if "+" not in header: -1277 raise BatchError("Invalid value for Content-ID: %s" % header) -1278 base, id_ = header[1:-1].split(" + ", 1) -1279 -1280 return unquote(id_) -1281 -1283 """Convert an HttpRequest object into a string. -1284 -1285 Args: -1286 request: HttpRequest, the request to serialize. -1287 -1288 Returns: -1289 The request as a string in application/http format. -1290 """ -1291 # Construct status line -1292 parsed = urlparse(request.uri) -1293 request_line = urlunparse( -1294 ("", "", parsed.path, parsed.params, parsed.query, "") -1295 ) -1296 status_line = request.method + " " + request_line + " HTTP/1.1\n" -1297 major, minor = request.headers.get("content-type", "application/json").split( -1298 "/" -1299 ) -1300 msg = MIMENonMultipart(major, minor) -1301 headers = request.headers.copy() -1302 -1303 if request.http is not None: -1304 credentials = _auth.get_credentials_from_http(request.http) -1305 if credentials is not None: -1306 _auth.apply_credentials(credentials, headers) -1307 -1308 # MIMENonMultipart adds its own Content-Type header. -1309 if "content-type" in headers: -1310 del headers["content-type"] -1311 -1312 for key, value in six.iteritems(headers): -1313 msg[key] = value -1314 msg["Host"] = parsed.netloc -1315 msg.set_unixfrom(None) -1316 -1317 if request.body is not None: -1318 msg.set_payload(request.body) -1319 msg["content-length"] = str(len(request.body)) -1320 -1321 # Serialize the mime message. -1322 fp = StringIO() -1323 # maxheaderlen=0 means don't line wrap headers. -1324 g = Generator(fp, maxheaderlen=0) -1325 g.flatten(msg, unixfrom=False) -1326 body = fp.getvalue() -1327 -1328 return status_line + body -1329 -1331 """Convert string into httplib2 response and content. -1332 -1333 Args: -1334 payload: string, headers and body as a string. -1335 -1336 Returns: -1337 A pair (resp, content), such as would be returned from httplib2.request. -1338 """ -1339 # Strip off the status line -1340 status_line, payload = payload.split("\n", 1) -1341 protocol, status, reason = status_line.split(" ", 2) -1342 -1343 # Parse the rest of the response -1344 parser = FeedParser() -1345 parser.feed(payload) -1346 msg = parser.close() -1347 msg["status"] = status -1348 -1349 # Create httplib2.Response from the parsed headers. -1350 resp = httplib2.Response(msg) -1351 resp.reason = reason -1352 resp.version = int(protocol.split("/", 1)[1].replace(".", "")) -1353 -1354 content = payload.split("\r\n\r\n", 1)[1] -1355 -1356 return resp, content -1357 -1359 """Create a new id. -1360 -1361 Auto incrementing number that avoids conflicts with ids already used. -1362 -1363 Returns: -1364 string, a new unique id. -1365 """ -1366 self._last_auto_id += 1 -1367 while str(self._last_auto_id) in self._requests: -1368 self._last_auto_id += 1 -1369 return str(self._last_auto_id) -1370 -1371 @util.positional(2) -1373 """Add a new request. -1374 -1375 Every callback added will be paired with a unique id, the request_id. That -1376 unique id will be passed back to the callback when the response comes back -1377 from the server. The default behavior is to have the library generate it's -1378 own unique id. If the caller passes in a request_id then they must ensure -1379 uniqueness for each request_id, and if they are not an exception is -1380 raised. Callers should either supply all request_ids or never supply a -1381 request id, to avoid such an error. -1382 -1383 Args: -1384 request: HttpRequest, Request to add to the batch. -1385 callback: callable, A callback to be called for this response, of the -1386 form callback(id, response, exception). The first parameter is the -1387 request id, and the second is the deserialized response object. The -1388 third is an googleapiclient.errors.HttpError exception object if an HTTP error -1389 occurred while processing the request, or None if no errors occurred. -1390 request_id: string, A unique id for the request. The id will be passed -1391 to the callback with the response. -1392 -1393 Returns: -1394 None -1395 -1396 Raises: -1397 BatchError if a media request is added to a batch. -1398 KeyError is the request_id is not unique. -1399 """ -1400 -1401 if len(self._order) >= MAX_BATCH_LIMIT: -1402 raise BatchError( -1403 "Exceeded the maximum calls(%d) in a single batch request." -1404 % MAX_BATCH_LIMIT -1405 ) -1406 if request_id is None: -1407 request_id = self._new_id() -1408 if request.resumable is not None: -1409 raise BatchError("Media requests cannot be used in a batch request.") -1410 if request_id in self._requests: -1411 raise KeyError("A request with this ID already exists: %s" % request_id) -1412 self._requests[request_id] = request -1413 self._callbacks[request_id] = callback -1414 self._order.append(request_id) -1415 -1417 """Serialize batch request, send to server, process response. -1418 -1419 Args: -1420 http: httplib2.Http, an http object to be used to make the request with. -1421 order: list, list of request ids in the order they were added to the -1422 batch. -1423 requests: list, list of request objects to send. -1424 -1425 Raises: -1426 httplib2.HttpLib2Error if a transport error has occurred. -1427 googleapiclient.errors.BatchError if the response is the wrong format. -1428 """ -1429 message = MIMEMultipart("mixed") -1430 # Message should not write out it's own headers. -1431 setattr(message, "_write_headers", lambda self: None) -1432 -1433 # Add all the individual requests. -1434 for request_id in order: -1435 request = requests[request_id] -1436 -1437 msg = MIMENonMultipart("application", "http") -1438 msg["Content-Transfer-Encoding"] = "binary" -1439 msg["Content-ID"] = self._id_to_header(request_id) -1440 -1441 body = self._serialize_request(request) -1442 msg.set_payload(body) -1443 message.attach(msg) -1444 -1445 # encode the body: note that we can't use `as_string`, because -1446 # it plays games with `From ` lines. -1447 fp = StringIO() -1448 g = Generator(fp, mangle_from_=False) -1449 g.flatten(message, unixfrom=False) -1450 body = fp.getvalue() -1451 -1452 headers = {} -1453 headers["content-type"] = ( -1454 "multipart/mixed; " 'boundary="%s"' -1455 ) % message.get_boundary() -1456 -1457 resp, content = http.request( -1458 self._batch_uri, method="POST", body=body, headers=headers -1459 ) -1460 -1461 if resp.status >= 300: -1462 raise HttpError(resp, content, uri=self._batch_uri) -1463 -1464 # Prepend with a content-type header so FeedParser can handle it. -1465 header = "content-type: %s\r\n\r\n" % resp["content-type"] -1466 # PY3's FeedParser only accepts unicode. So we should decode content -1467 # here, and encode each payload again. -1468 if six.PY3: -1469 content = content.decode("utf-8") -1470 for_parser = header + content -1471 -1472 parser = FeedParser() -1473 parser.feed(for_parser) -1474 mime_response = parser.close() -1475 -1476 if not mime_response.is_multipart(): -1477 raise BatchError( -1478 "Response not in multipart/mixed format.", resp=resp, content=content -1479 ) -1480 -1481 for part in mime_response.get_payload(): -1482 request_id = self._header_to_id(part["Content-ID"]) -1483 response, content = self._deserialize_response(part.get_payload()) -1484 # We encode content here to emulate normal http response. -1485 if isinstance(content, six.text_type): -1486 content = content.encode("utf-8") -1487 self._responses[request_id] = (response, content) -1488 -1489 @util.positional(1) -1491 """Execute all the requests as a single batched HTTP request. -1492 -1493 Args: -1494 http: httplib2.Http, an http object to be used in place of the one the -1495 HttpRequest request object was constructed with. If one isn't supplied -1496 then use a http object from the requests in this batch. -1497 -1498 Returns: -1499 None -1500 -1501 Raises: -1502 httplib2.HttpLib2Error if a transport error has occurred. -1503 googleapiclient.errors.BatchError if the response is the wrong format. -1504 """ -1505 # If we have no requests return -1506 if len(self._order) == 0: -1507 return None -1508 -1509 # If http is not supplied use the first valid one given in the requests. -1510 if http is None: -1511 for request_id in self._order: -1512 request = self._requests[request_id] -1513 if request is not None: -1514 http = request.http -1515 break -1516 -1517 if http is None: -1518 raise ValueError("Missing a valid http object.") -1519 -1520 # Special case for OAuth2Credentials-style objects which have not yet been -1521 # refreshed with an initial access_token. -1522 creds = _auth.get_credentials_from_http(http) -1523 if creds is not None: -1524 if not _auth.is_valid(creds): -1525 LOGGER.info("Attempting refresh to obtain initial access_token") -1526 _auth.refresh_credentials(creds) -1527 -1528 self._execute(http, self._order, self._requests) -1529 -1530 # Loop over all the requests and check for 401s. For each 401 request the -1531 # credentials should be refreshed and then sent again in a separate batch. -1532 redo_requests = {} -1533 redo_order = [] -1534 -1535 for request_id in self._order: -1536 resp, content = self._responses[request_id] -1537 if resp["status"] == "401": -1538 redo_order.append(request_id) -1539 request = self._requests[request_id] -1540 self._refresh_and_apply_credentials(request, http) -1541 redo_requests[request_id] = request -1542 -1543 if redo_requests: -1544 self._execute(http, redo_order, redo_requests) -1545 -1546 # Now process all callbacks that are erroring, and raise an exception for -1547 # ones that return a non-2xx response? Or add extra parameter to callback -1548 # that contains an HttpError? -1549 -1550 for request_id in self._order: -1551 resp, content = self._responses[request_id] -1552 -1553 request = self._requests[request_id] -1554 callback = self._callbacks[request_id] -1555 -1556 response = None -1557 exception = None -1558 try: -1559 if resp.status >= 300: -1560 raise HttpError(resp, content, uri=request.uri) -1561 response = request.postproc(resp, content) -1562 except HttpError as e: -1563 exception = e -1564 -1565 if callback is not None: -1566 callback(request_id, response, exception) -1567 if self._callback is not None: -1568 self._callback(request_id, response, exception) -1572 """Mock of HttpRequest. -1573 -1574 Do not construct directly, instead use RequestMockBuilder. -1575 """ -1576 -1601 -1578 """Constructor for HttpRequestMock -1579 -1580 Args: -1581 resp: httplib2.Response, the response to emulate coming from the request -1582 content: string, the response body -1583 postproc: callable, the post processing function usually supplied by -1584 the model class. See model.JsonModel.response() as an example. -1585 """ -1586 self.resp = resp -1587 self.content = content -1588 self.postproc = postproc -1589 if resp is None: -1590 self.resp = httplib2.Response({"status": 200, "reason": "OK"}) -1591 if "reason" in self.resp: -1592 self.resp.reason = self.resp["reason"] -1593 -1604 """A simple mock of HttpRequest -1605 -1606 Pass in a dictionary to the constructor that maps request methodIds to -1607 tuples of (httplib2.Response, content, opt_expected_body) that should be -1608 returned when that method is called. None may also be passed in for the -1609 httplib2.Response, in which case a 200 OK response will be generated. -1610 If an opt_expected_body (str or dict) is provided, it will be compared to -1611 the body and UnexpectedBodyError will be raised on inequality. -1612 -1613 Example: -1614 response = '{"data": {"id": "tag:google.c...' -1615 requestBuilder = RequestMockBuilder( -1616 { -1617 'plus.activities.get': (None, response), -1618 } -1619 ) -1620 googleapiclient.discovery.build("plus", "v1", requestBuilder=requestBuilder) -1621 -1622 Methods that you do not supply a response for will return a -1623 200 OK with an empty string as the response content or raise an excpetion -1624 if check_unexpected is set to True. The methodId is taken from the rpcName -1625 in the discovery document. -1626 -1627 For more details see the project wiki. -1628 """ -1629 -1683 -1631 """Constructor for RequestMockBuilder -1632 -1633 The constructed object should be a callable object -1634 that can replace the class HttpResponse. -1635 -1636 responses - A dictionary that maps methodIds into tuples -1637 of (httplib2.Response, content). The methodId -1638 comes from the 'rpcName' field in the discovery -1639 document. -1640 check_unexpected - A boolean setting whether or not UnexpectedMethodError -1641 should be raised on unsupplied method. -1642 """ -1643 self.responses = responses -1644 self.check_unexpected = check_unexpected -1645 -1646 - def __call__( -1647 self, -1648 http, -1649 postproc, -1650 uri, -1651 method="GET", -1652 body=None, -1653 headers=None, -1654 methodId=None, -1655 resumable=None, -1656 ): -1657 """Implements the callable interface that discovery.build() expects -1658 of requestBuilder, which is to build an object compatible with -1659 HttpRequest.execute(). See that method for the description of the -1660 parameters and the expected response. -1661 """ -1662 if methodId in self.responses: -1663 response = self.responses[methodId] -1664 resp, content = response[:2] -1665 if len(response) > 2: -1666 # Test the body against the supplied expected_body. -1667 expected_body = response[2] -1668 if bool(expected_body) != bool(body): -1669 # Not expecting a body and provided one -1670 # or expecting a body and not provided one. -1671 raise UnexpectedBodyError(expected_body, body) -1672 if isinstance(expected_body, str): -1673 expected_body = json.loads(expected_body) -1674 body = json.loads(body) -1675 if body != expected_body: -1676 raise UnexpectedBodyError(expected_body, body) -1677 return HttpRequestMock(resp, content, postproc) -1678 elif self.check_unexpected: -1679 raise UnexpectedMethodError(methodId=methodId) -1680 else: -1681 model = JsonModel(False) -1682 return HttpRequestMock(None, "{}", model.response) -1686 """Mock of httplib2.Http""" -1687 -1725 -1689 """ -1690 Args: -1691 filename: string, absolute filename to read response from -1692 headers: dict, header to return with response -1693 """ -1694 if headers is None: -1695 headers = {"status": "200"} -1696 if filename: -1697 with open(filename, "rb") as f: -1698 self.data = f.read() -1699 else: -1700 self.data = None -1701 self.response_headers = headers -1702 self.headers = None -1703 self.uri = None -1704 self.method = None -1705 self.body = None -1706 self.headers = None -1707 -1708 - def request( -1709 self, -1710 uri, -1711 method="GET", -1712 body=None, -1713 headers=None, -1714 redirections=1, -1715 connection_type=None, -1716 ): -1717 self.uri = uri -1718 self.method = method -1719 self.body = body -1720 self.headers = headers -1721 return httplib2.Response(self.response_headers), self.data -1722 -1727 """Mock of httplib2.Http -1728 -1729 Mocks a sequence of calls to request returning different responses for each -1730 call. Create an instance initialized with the desired response headers -1731 and content and then use as if an httplib2.Http instance. -1732 -1733 http = HttpMockSequence([ -1734 ({'status': '401'}, ''), -1735 ({'status': '200'}, '{"access_token":"1/3w","expires_in":3600}'), -1736 ({'status': '200'}, 'echo_request_headers'), -1737 ]) -1738 resp, content = http.request("http://examples.com") -1739 -1740 There are special values you can pass in for content to trigger -1741 behavours that are helpful in testing. -1742 -1743 'echo_request_headers' means return the request headers in the response body -1744 'echo_request_headers_as_json' means return the request headers in -1745 the response body -1746 'echo_request_body' means return the request body in the response body -1747 'echo_request_uri' means return the request uri in the response body -1748 """ -1749 -1787 -1751 """ -1752 Args: -1753 iterable: iterable, a sequence of pairs of (headers, body) -1754 """ -1755 self._iterable = iterable -1756 self.follow_redirects = True -1757 self.request_sequence = list() -1758 -1759 - def request( -1760 self, -1761 uri, -1762 method="GET", -1763 body=None, -1764 headers=None, -1765 redirections=1, -1766 connection_type=None, -1767 ): -1768 # Remember the request so after the fact this mock can be examined -1769 self.request_sequence.append((uri, method, body, headers)) -1770 resp, content = self._iterable.pop(0) -1771 content = six.ensure_binary(content) -1772 -1773 if content == b"echo_request_headers": -1774 content = headers -1775 elif content == b"echo_request_headers_as_json": -1776 content = json.dumps(headers) -1777 elif content == b"echo_request_body": -1778 if hasattr(body, "read"): -1779 content = body.read() -1780 else: -1781 content = body -1782 elif content == b"echo_request_uri": -1783 content = uri -1784 if isinstance(content, six.text_type): -1785 content = content.encode("utf-8") -1786 return httplib2.Response(resp), content -1790 """Set the user-agent on every request. -1791 -1792 Args: -1793 http - An instance of httplib2.Http -1794 or something that acts like it. -1795 user_agent: string, the value for the user-agent header. -1796 -1797 Returns: -1798 A modified instance of http that was passed in. -1799 -1800 Example: -1801 -1802 h = httplib2.Http() -1803 h = set_user_agent(h, "my-app-name/6.0") -1804 -1805 Most of the time the user-agent will be set doing auth, this is for the rare -1806 cases where you are accessing an unauthenticated endpoint. -1807 """ -1808 request_orig = http.request -1809 -1810 # The closure that will replace 'httplib2.Http.request'. -1811 def new_request( -1812 uri, -1813 method="GET", -1814 body=None, -1815 headers=None, -1816 redirections=httplib2.DEFAULT_MAX_REDIRECTS, -1817 connection_type=None, -1818 ): -1819 """Modify the request headers to add the user-agent.""" -1820 if headers is None: -1821 headers = {} -1822 if "user-agent" in headers: -1823 headers["user-agent"] = user_agent + " " + headers["user-agent"] -1824 else: -1825 headers["user-agent"] = user_agent -1826 resp, content = request_orig( -1827 uri, -1828 method=method, -1829 body=body, -1830 headers=headers, -1831 redirections=redirections, -1832 connection_type=connection_type, -1833 ) -1834 return resp, content -1835 -1836 http.request = new_request -1837 return http -1838 -1841 """Tunnel PATCH requests over POST. -1842 Args: -1843 http - An instance of httplib2.Http -1844 or something that acts like it. -1845 -1846 Returns: -1847 A modified instance of http that was passed in. -1848 -1849 Example: -1850 -1851 h = httplib2.Http() -1852 h = tunnel_patch(h, "my-app-name/6.0") -1853 -1854 Useful if you are running on a platform that doesn't support PATCH. -1855 Apply this last if you are using OAuth 1.0, as changing the method -1856 will result in a different signature. -1857 """ -1858 request_orig = http.request -1859 -1860 # The closure that will replace 'httplib2.Http.request'. -1861 def new_request( -1862 uri, -1863 method="GET", -1864 body=None, -1865 headers=None, -1866 redirections=httplib2.DEFAULT_MAX_REDIRECTS, -1867 connection_type=None, -1868 ): -1869 """Modify the request headers to add the user-agent.""" -1870 if headers is None: -1871 headers = {} -1872 if method == "PATCH": -1873 if "oauth_token" in headers.get("authorization", ""): -1874 LOGGER.warning( -1875 "OAuth 1.0 request made with Credentials after tunnel_patch." -1876 ) -1877 headers["x-http-method-override"] = "PATCH" -1878 method = "POST" -1879 resp, content = request_orig( -1880 uri, -1881 method=method, -1882 body=body, -1883 headers=headers, -1884 redirections=redirections, -1885 connection_type=connection_type, -1886 ) -1887 return resp, content -1888 -1889 http.request = new_request -1890 return http -1891 -1894 """Builds httplib2.Http object -1895 -1896 Returns: -1897 A httplib2.Http object, which is used to make http requests, and which has timeout set by default. -1898 To override default timeout call -1899 -1900 socket.setdefaulttimeout(timeout_in_sec) -1901 -1902 before interacting with this method. -1903 """ -1904 if socket.getdefaulttimeout() is not None: -1905 http_timeout = socket.getdefaulttimeout() -1906 else: -1907 http_timeout = DEFAULT_HTTP_TIMEOUT_SEC -1908 http = httplib2.Http(timeout=http_timeout) -1909 # 308's are used by several Google APIs (Drive, YouTube) -1910 # for Resumable Uploads rather than Permanent Redirects. -1911 # This asks httplib2 to exclude 308s from the status codes -1912 # it treats as redirects -1913 try: -1914 http.redirect_codes = http.redirect_codes - {308} -1915 except AttributeError: -1916 # Apache Beam tests depend on this library and cannot -1917 # currently upgrade their httplib2 version -1918 # http.redirect_codes does not exist in previous versions -1919 # of httplib2, so pass -1920 pass -1921 -1922 return http -1923 -
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class BatchHttpRequest
--object --+ - | - BatchHttpRequest -- -
-
-Batches multiple HttpRequest objects into a single HTTP request.
-
-Example:
- from googleapiclient.http import BatchHttpRequest
-
- def list_animals(request_id, response, exception):
- """Do something with the animals list response."""
- if exception is not None:
- # Do something with the exception.
- pass
- else:
- # Do something with the response.
- pass
-
- def list_farmers(request_id, response, exception):
- """Do something with the farmers list response."""
- if exception is not None:
- # Do something with the exception.
- pass
- else:
- # Do something with the response.
- pass
-
- service = build('farm', 'v2')
-
- batch = BatchHttpRequest()
-
- batch.add(service.animals().list(), list_animals)
- batch.add(service.farmers().list(), list_farmers)
- batch.execute(http=http)
-
-
-
-
-
-
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
-Constructor for a BatchHttpRequest. - -Args: - callback: callable, A callback to be called for each response, of the - form callback(id, response, exception). The first parameter is the - request id, and the second is the deserialized response object. The - third is an googleapiclient.errors.HttpError exception object if an HTTP error - occurred while processing the request, or None if no error occurred. - batch_uri: string, URI to send batch requests to. - --
|
-
-
-
-
-
-
-Refresh the credentials and apply to the request. - -Args: - request: HttpRequest, the request. - http: httplib2.Http, the global http object for the batch. - --
|
-
-
-
-
-
-
-Convert an id to a Content-ID header value. - -Args: - id_: string, identifier of individual request. - -Returns: - A Content-ID header with the id_ encoded into it. A UUID is prepended to - the value because Content-ID headers are supposed to be universally - unique. - --
|
-
-
-
-
-
-
-Convert a Content-ID header value to an id. - -Presumes the Content-ID header conforms to the format that _id_to_header() -returns. - -Args: - header: string, Content-ID header value. - -Returns: - The extracted id value. - -Raises: - BatchError if the header is not in the expected format. - --
|
-
-
-
-
-
-
-Convert an HttpRequest object into a string. - -Args: - request: HttpRequest, the request to serialize. - -Returns: - The request as a string in application/http format. - --
|
-
-
-
-
-
-
-Convert string into httplib2 response and content. - -Args: - payload: string, headers and body as a string. - -Returns: - A pair (resp, content), such as would be returned from httplib2.request. - --
|
-
-
-
-
-
-
-Create a new id. - -Auto incrementing number that avoids conflicts with ids already used. - -Returns: - string, a new unique id. - --
|
-
-
-
-
-
-
-Add a new request. - -Every callback added will be paired with a unique id, the request_id. That -unique id will be passed back to the callback when the response comes back -from the server. The default behavior is to have the library generate it's -own unique id. If the caller passes in a request_id then they must ensure -uniqueness for each request_id, and if they are not an exception is -raised. Callers should either supply all request_ids or never supply a -request id, to avoid such an error. - -Args: - request: HttpRequest, Request to add to the batch. - callback: callable, A callback to be called for this response, of the - form callback(id, response, exception). The first parameter is the - request id, and the second is the deserialized response object. The - third is an googleapiclient.errors.HttpError exception object if an HTTP error - occurred while processing the request, or None if no errors occurred. - request_id: string, A unique id for the request. The id will be passed - to the callback with the response. - -Returns: - None - -Raises: - BatchError if a media request is added to a batch. - KeyError is the request_id is not unique. - --
|
-
-
-
-
-
-
-Serialize batch request, send to server, process response. - -Args: - http: httplib2.Http, an http object to be used to make the request with. - order: list, list of request ids in the order they were added to the - batch. - requests: list, list of request objects to send. - -Raises: - httplib2.HttpLib2Error if a transport error has occurred. - googleapiclient.errors.BatchError if the response is the wrong format. - --
|
-
-
-
-
-
-Execute all the requests as a single batched HTTP request. - -Args: - http: httplib2.Http, an http object to be used in place of the one the - HttpRequest request object was constructed with. If one isn't supplied - then use a http object from the requests in this batch. - -Returns: - None - -Raises: - httplib2.HttpLib2Error if a transport error has occurred. - googleapiclient.errors.BatchError if the response is the wrong format. - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class HttpMock
--object --+ - | - HttpMock -- -
-
Mock of httplib2.Http
- - - -
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
- -Args: - filename: string, absolute filename to read response from - headers: dict, header to return with response - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class HttpMockSequence
--object --+ - | - HttpMockSequence -- -
-
-Mock of httplib2.Http
-
-Mocks a sequence of calls to request returning different responses for each
-call. Create an instance initialized with the desired response headers
-and content and then use as if an httplib2.Http instance.
-
- http = HttpMockSequence([
- ({'status': '401'}, ''),
- ({'status': '200'}, '{"access_token":"1/3w","expires_in":3600}'),
- ({'status': '200'}, 'echo_request_headers'),
- ])
- resp, content = http.request("http://examples.com")
-
-There are special values you can pass in for content to trigger
-behavours that are helpful in testing.
-
-'echo_request_headers' means return the request headers in the response body
-'echo_request_headers_as_json' means return the request headers in
- the response body
-'echo_request_body' means return the request body in the response body
-'echo_request_uri' means return the request uri in the response body
-
-
-
-
-
-
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
- -Args: - iterable: iterable, a sequence of pairs of (headers, body) - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class HttpRequest
--object --+ - | - HttpRequest -- -
-
Encapsulates a single HTTP request.
- - - -
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from |
- |||
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
-Constructor for an HttpRequest. - -Args: - http: httplib2.Http, the transport object to use to make a request - postproc: callable, called on the HTTP response and content to transform - it into a data object before returning, or raising an exception - on an error. - uri: string, the absolute URI to send the request to - method: string, the HTTP method to use - body: string, the request body of the HTTP request, - headers: dict, the HTTP request headers - methodId: string, a unique identifier for the API method being called. - resumable: MediaUpload, None if this is not a resumbale request. - --
|
-
-
-
-
-
-
-Execute the request. - -Args: - http: httplib2.Http, an http object to be used in place of the - one the HttpRequest request object was constructed with. - num_retries: Integer, number of times to retry with randomized - exponential backoff. If all retries fail, the raised HttpError - represents the last request. If zero (default), we attempt the - request only once. - -Returns: - A deserialized object model of the response body as determined - by the postproc. - -Raises: - googleapiclient.errors.HttpError if the response was not a 2xx. - httplib2.HttpLib2Error if a transport error has occurred. - --
|
-
-
-
-
-
-
-add_response_headers_callback - -Args: - cb: Callback to be called on receiving the response headers, of signature: - - def cb(resp): - # Where resp is an instance of httplib2.Response - --
|
-
-
-
-
-
-
-Execute the next step of a resumable upload.
-
-Can only be used if the method being executed supports media uploads and
-the MediaUpload object passed in was flagged as using resumable upload.
-
-Example:
-
- media = MediaFileUpload('cow.png', mimetype='image/png',
- chunksize=1000, resumable=True)
- request = farm.animals().insert(
- id='cow',
- name='cow.png',
- media_body=media)
-
- response = None
- while response is None:
- status, response = request.next_chunk()
- if status:
- print "Upload %d%% complete." % int(status.progress() * 100)
-
-
-Args:
- http: httplib2.Http, an http object to be used in place of the
- one the HttpRequest request object was constructed with.
- num_retries: Integer, number of times to retry with randomized
- exponential backoff. If all retries fail, the raised HttpError
- represents the last request. If zero (default), we attempt the
- request only once.
-
-Returns:
- (status, body): (ResumableMediaStatus, object)
- The body will be None until the resumable media is fully uploaded.
-
-Raises:
- googleapiclient.errors.HttpError if the response was not a 2xx.
- httplib2.HttpLib2Error if a transport error has occurred.
-
-
-
|
-
-
-
-
-
-Process the response from a single chunk upload. - -Args: - resp: httplib2.Response, the response object. - content: string, the content of the response. - -Returns: - (status, body): (ResumableMediaStatus, object) - The body will be None until the resumable media is fully uploaded. - -Raises: - googleapiclient.errors.HttpError if the response was not a 2xx or a 308. - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class HttpRequestMock
--object --+ - | - HttpRequestMock -- -
-
Mock of HttpRequest.
-Do not construct directly, instead use RequestMockBuilder.
- - - -
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
-Constructor for HttpRequestMock - -Args: - resp: httplib2.Response, the response to emulate coming from the request - content: string, the response body - postproc: callable, the post processing function usually supplied by - the model class. See model.JsonModel.response() as an example. - --
|
-
-
-
-
-
Execute the request. -Same behavior as HttpRequest.execute(), but the response is mocked and - not really from an HTTP request/response. -
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class MediaDownloadProgress
--object --+ - | - MediaDownloadProgress -- -
-
Status of a resumable download.
- - - -
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
-Constructor. - -Args: - resumable_progress: int, bytes received so far. - total_size: int, total bytes in complete download. - --
|
-
-
-
-
-
-Percent of download completed, as a float. - -Returns: - the percentage complete as a float, returning 0.0 if the total size of - the download is unknown. - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class MediaFileUpload
-- object --+ - | - MediaUpload --+ - | -MediaIoBaseUpload --+ - | - MediaFileUpload -- -
-
-A MediaUpload for a file.
-
-Construct a MediaFileUpload and pass as the media_body parameter of the
-method. For example, if we had a service that allowed uploading images:
-
- media = MediaFileUpload('cow.png', mimetype='image/png',
- chunksize=1024*1024, resumable=True)
- farm.animals().insert(
- id='cow',
- name='cow.png',
- media_body=media).execute()
-
-Depending on the platform you are working on, you may pass -1 as the
-chunksize, which indicates that the entire file should be uploaded in a single
-request. If the underlying platform supports streams, such as Python 2.6 or
-later, then this can be very efficient as it avoids multiple connections, and
-also avoids loading the entire file into memory before sending it. Note that
-Google App Engine has a 5MB limit on request size, so you should never set
-your chunksize larger than 5MB, or to -1.
-
-
-
-
-
-
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from Inherited from Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
| - - |
-
|
- ||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
-Constructor. - -Args: - filename: string, Name of the file. - mimetype: string, Mime-type of the file. If None then a mime-type will be - guessed from the file extension. - chunksize: int, File will be uploaded in chunks of this many bytes. Only - used if resumable=True. Pass in a value of -1 if the file is to be - uploaded in a single chunk. Note that Google App Engine has a 5MB limit - on request size, so you should never set your chunksize larger than 5MB, - or to -1. - resumable: bool, True if this is a resumable upload. False means upload - in a single request. - --
|
-
-
-
-
-
-Creating a JSON representation of an instance of MediaFileUpload. - -Returns: - string, a JSON representation of this instance, suitable to pass to - from_json(). - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class MediaInMemoryUpload
-- object --+ - | - MediaUpload --+ - | -MediaIoBaseUpload --+ - | - MediaInMemoryUpload -- -
-
MediaUpload for a chunk of bytes.
-DEPRECATED: Use MediaIoBaseUpload with either io.TextIOBase or - StringIO for the stream.
- - - -
-
|
-|||
| - - |
-
|
- ||
|
- Inherited from Inherited from Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-Create a new MediaInMemoryUpload. - -DEPRECATED: Use MediaIoBaseUpload with either io.TextIOBase or StringIO for -the stream. - -Args: - body: string, Bytes of body content. - mimetype: string, Mime-type of the file or default of - 'application/octet-stream'. - chunksize: int, File will be uploaded in chunks of this many bytes. Only - used if resumable=True. - resumable: bool, True if this is a resumable upload. False means upload - in a single request. - - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class MediaIoBaseDownload
--object --+ - | - MediaIoBaseDownload -- -
-
-"Download media resources.
-
-Note that the Python file object is compatible with io.Base and can be used
-with this class also.
-
-
-Example:
- request = farms.animals().get_media(id='cow')
- fh = io.FileIO('cow.png', mode='wb')
- downloader = MediaIoBaseDownload(fh, request, chunksize=1024*1024)
-
- done = False
- while done is False:
- status, done = downloader.next_chunk()
- if status:
- print "Download %d%%." % int(status.progress() * 100)
- print "Download Complete!"
-
-
-
-
-
-
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
-Constructor. - -Args: - fd: io.Base or file object, The stream in which to write the downloaded - bytes. - request: googleapiclient.http.HttpRequest, the media request to perform in - chunks. - chunksize: int, File will be downloaded in chunks of this many bytes. - --
|
-
-
-
-
-
-Get the next chunk of the download. - -Args: - num_retries: Integer, number of times to retry with randomized - exponential backoff. If all retries fail, the raised HttpError - represents the last request. If zero (default), we attempt the - request only once. - -Returns: - (status, done): (MediaDownloadProgress, boolean) - The value of 'done' will be True when the media has been fully - downloaded or the total size of the media is unknown. - -Raises: - googleapiclient.errors.HttpError if the response was not a 2xx. - httplib2.HttpLib2Error if a transport error has occurred. - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class MediaIoBaseUpload
-- object --+ - | -MediaUpload --+ - | - MediaIoBaseUpload -- -
- Known Subclasses: -
- - -
-
-A MediaUpload for a io.Base objects.
-
-Note that the Python file object is compatible with io.Base and can be used
-with this class also.
-
- fh = BytesIO('...Some data to upload...')
- media = MediaIoBaseUpload(fh, mimetype='image/png',
- chunksize=1024*1024, resumable=True)
- farm.animals().insert(
- id='cow',
- name='cow.png',
- media_body=media).execute()
-
-Depending on the platform you are working on, you may pass -1 as the
-chunksize, which indicates that the entire file should be uploaded in a single
-request. If the underlying platform supports streams, such as Python 2.6 or
-later, then this can be very efficient as it avoids multiple connections, and
-also avoids loading the entire file into memory before sending it. Note that
-Google App Engine has a 5MB limit on request size, so you should never set
-your chunksize larger than 5MB, or to -1.
-
-
-
-
-
-
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
-Constructor. - -Args: - fd: io.Base or file object, The source of the bytes to upload. MUST be - opened in blocking mode, do not use streams opened in non-blocking mode. - The given stream must be seekable, that is, it must be able to call - seek() on fd. - mimetype: string, Mime-type of the file. - chunksize: int, File will be uploaded in chunks of this many bytes. Only - used if resumable=True. Pass in a value of -1 if the file is to be - uploaded as a single chunk. Note that Google App Engine has a 5MB limit - on request size, so you should never set your chunksize larger than 5MB, - or to -1. - resumable: bool, True if this is a resumable upload. False means upload - in a single request. - --
|
-
-
-
-
-
-
-Chunk size for resumable uploads. - -Returns: - Chunk size in bytes. - --
|
-
-
-
-
-
-
-Mime type of the body. - -Returns: - Mime type. - --
|
-
-
-
-
-
-
-Size of upload. - -Returns: - Size of the body, or None of the size is unknown. - --
|
-
-
-
-
-
-
-Whether this upload is resumable. - -Returns: - True if resumable upload or False. - --
|
-
-
-
-
-
-
-Get bytes from the media. - -Args: - begin: int, offset from beginning of file. - length: int, number of bytes to read, starting at begin. - -Returns: - A string of bytes read. May be shorted than length if EOF was reached - first. - --
|
-
-
-
-
-
-
-Does the underlying upload support a streaming interface. - -Streaming means it is an io.IOBase subclass that supports seek, i.e. -seekable() returns True. - -Returns: - True if the call to stream() will return an instance of a seekable io.Base - subclass. - --
|
-
-
-
-
-
-
-A stream interface to the data being uploaded. - -Returns: - The returned value is an io.IOBase subclass that supports seek, i.e. - seekable() returns True. - --
|
-
-
-
-
-
This upload type is not serializable. -
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class MediaUpload
--object --+ - | - MediaUpload -- -
- Known Subclasses: -
- - -
-
Describes a media object to upload.
-Base class that defines the interface of MediaUpload subclasses.
-Note that subclasses of MediaUpload may allow you to control the - chunksize when uploading a media object. It is important to keep the size - of the chunk as large as possible to keep the upload efficient. Other - factors may influence the size of the chunk you use, particularly if you - are working in an environment where individual HTTP requests may have a - hardcoded time limit, such as under certain classes of requests under - Google App Engine.
-Streams are io.Base compatible objects that support seek(). Some - MediaUpload subclasses support using streams directly to upload data. - Support for streaming may be indicated by a MediaUpload sub-class and if - appropriate for a platform that stream will be used for uploading the - media object. The support for streaming is indicated by has_stream() - returning True. The stream() method should return an io.Base object that - supports seek(). On platforms where the underlying httplib module - supports streaming, for example Python 2.6 and later, the stream will be - passed into the http library which will result in less memory being used - and possibly faster uploads.
-If you need to upload media that can't be uploaded using any of the - existing MediaUpload sub-class then you can sub-class MediaUpload for - your particular needs.
- - - -
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from |
- |||
-
|
-|||
| - - |
-
|
- ||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
-Chunk size for resumable uploads. - -Returns: - Chunk size in bytes. - --
|
-
-
-
-
-
-
-Mime type of the body. - -Returns: - Mime type. - --
|
-
-
-
-
-
-
-Size of upload. - -Returns: - Size of the body, or None of the size is unknown. - --
|
-
-
-
-
-
-
-Whether this upload is resumable. - -Returns: - True if resumable upload or False. - --
|
-
-
-
-
-
-
-Get bytes from the media. - -Args: - begin: int, offset from beginning of file. - length: int, number of bytes to read, starting at begin. - -Returns: - A string of bytes read. May be shorter than length if EOF was reached - first. - --
|
-
-
-
-
-
-
-Does the underlying upload support a streaming interface. - -Streaming means it is an io.IOBase subclass that supports seek, i.e. -seekable() returns True. - -Returns: - True if the call to stream() will return an instance of a seekable io.Base - subclass. - --
|
-
-
-
-
-
-
-A stream interface to the data being uploaded. - -Returns: - The returned value is an io.IOBase subclass that supports seek, i.e. - seekable() returns True. - --
|
-
-
-
-
-
-
-Utility function for creating a JSON representation of a MediaUpload. - -Args: - strip: array, An array of names of members to not include in the JSON. - -Returns: - string, a JSON representation of this instance, suitable to pass to - from_json(). - --
|
-
-
-
-
-
-
-Create a JSON representation of an instance of MediaUpload. - -Returns: - string, a JSON representation of this instance, suitable to pass to - from_json(). - --
|
-
-
-
-
-
-Utility class method to instantiate a MediaUpload subclass from a JSON -representation produced by to_json(). - -Args: - s: string, JSON from to_json(). - -Returns: - An instance of the subclass of MediaUpload that was serialized with - to_json(). - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class MediaUploadProgress
--object --+ - | - MediaUploadProgress -- -
-
Status of a resumable upload.
- - - -
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
-Constructor. - -Args: - resumable_progress: int, bytes sent so far. - total_size: int, total bytes in complete upload, or None if the total - upload size isn't known ahead of time. - --
|
-
-
-
-
-
-Percent of upload completed, as a float. - -Returns: - the percentage complete as a float, returning 0.0 if the total size of - the upload is unknown. - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class RequestMockBuilder
--object --+ - | - RequestMockBuilder -- -
-
-A simple mock of HttpRequest
-
-Pass in a dictionary to the constructor that maps request methodIds to
-tuples of (httplib2.Response, content, opt_expected_body) that should be
-returned when that method is called. None may also be passed in for the
-httplib2.Response, in which case a 200 OK response will be generated.
-If an opt_expected_body (str or dict) is provided, it will be compared to
-the body and UnexpectedBodyError will be raised on inequality.
-
-Example:
- response = '{"data": {"id": "tag:google.c...'
- requestBuilder = RequestMockBuilder(
- {
- 'plus.activities.get': (None, response),
- }
- )
- googleapiclient.discovery.build("plus", "v1", requestBuilder=requestBuilder)
-
-Methods that you do not supply a response for will return a
-200 OK with an empty string as the response content or raise an excpetion
-if check_unexpected is set to True. The methodId is taken from the rpcName
-in the discovery document.
-
-For more details see the project wiki.
-
-
-
-
-
-
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
-Constructor for RequestMockBuilder - -The constructed object should be a callable object -that can replace the class HttpResponse. - -responses - A dictionary that maps methodIds into tuples - of (httplib2.Response, content). The methodId - comes from the 'rpcName' field in the discovery - document. -check_unexpected - A boolean setting whether or not UnexpectedMethodError - should be raised on unsupplied method. - --
|
-
-
-
-
-
Implements the callable interface that discovery.build() expects of - requestBuilder, which is to build an object compatible with - HttpRequest.execute(). See that method for the description of the - parameters and the expected response. -
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class _StreamSlice
--object --+ - | - _StreamSlice -- -
-
Truncated stream.
-Takes a stream and presents a stream that is a slice of the original - stream. This is used when uploading media in chunks. In later versions of - Python a stream can be passed to httplib in place of the string of data - to send. The problem is that httplib just blindly reads to the end of the - stream. This wrapper presents a virtual stream that only reads to the end - of the chunk.
- - - -
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
-Constructor. - -Args: - stream: (io.Base, file object), the stream to wrap. - begin: int, the seek position the chunk begins at. - chunksize: int, the size of the chunk. - --
|
-
-
-
-
-
-Read n bytes. - -Args: - n, int, the number of bytes to read. - -Returns: - A string of length 'n', or less if EOF is reached. - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Module mimeparse
-
-MIME-Type Parser
-
-This module provides basic functions for handling mime-types. It can handle
-matching mime-types against a list of media-ranges. See section 14.1 of the
-HTTP specification [RFC 2616] for a complete explanation.
-
- http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1
-
-Contents:
- - parse_mime_type(): Parses a mime-type into its component parts.
- - parse_media_range(): Media-ranges are mime-types with wild-cards and a 'q'
- quality parameter.
- - quality(): Determines the quality ('q') of a mime-type when
- compared against a list of media-ranges.
- - quality_parsed(): Just like quality() except the second parameter must be
- pre-parsed.
- - best_match(): Choose the mime-type with the highest quality ('q')
- from a list of candidates.
-
-
-
--
Version: - 0.1.3 -
-Author: - Joe Gregorio -
-License: - MIT License -
-
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
-
|
-|||
| - - |
- __email__ = |
- ||
| - - |
- __credits__ = |
- ||
| - - |
- __package__ = None
- |
- ||
-
|
-|||
-
-
-
-
-
-
-Parses a mime-type into its component parts.
-
-Carves up a mime-type and returns a tuple of the (type, subtype, params)
-where 'params' is a dictionary of all the parameters for the media range.
-For example, the media range 'application/xhtml;q=0.5' would get parsed
-into:
-
- ('application', 'xhtml', {'q', '0.5'})
-
-
-
-
|
-
-
-
-
-
-
-Parse a media-range into its component parts.
-
-Carves up a media range and returns a tuple of the (type, subtype,
-params) where 'params' is a dictionary of all the parameters for the media
-range. For example, the media range 'application/*;q=0.5' would get parsed
-into:
-
- ('application', '*', {'q', '0.5'})
-
-In addition this function also guarantees that there is a value for 'q'
-in the params dictionary, filling it in with a proper default if
-necessary.
-
-
-
|
-
-
-
-
-
-
Find the best match for a mime-type amongst parsed media-ranges. -Find the best match for a given mime-type against a list of - media_ranges that have already been parsed by parse_media_range(). - Returns a tuple of the fitness value and the value of the 'q' quality - parameter of the best match, or (-1, 0) if no match was found. Just as - for quality_parsed(), 'parsed_ranges' must be a list of parsed media - ranges. -
|
-
-
-
-
-
-
Find the best match for a mime-type amongst parsed media-ranges. -Find the best match for a given mime-type against a list of - media_ranges that have already been parsed by parse_media_range(). - Returns the 'q' quality parameter of the best match, 0 if no match was - found. This function bahaves the same as quality() except that - 'parsed_ranges' must be a list of parsed media ranges. -
|
-
-
-
-
-
-
Return the quality ('q') of a mime-type against a list of - media-ranges. -Returns the quality 'q' of a mime-type when compared against the - media-ranges in ranges. For example: -->>> quality('text/html','text/*;q=0.3, text/html;q=0.7, - text/html;level=1, text/html;level=2;q=0.4, */*;q=0.5') -0.7-
|
-
-
-
-
-
Return mime-type with the highest quality ('q') from list of - candidates. -Takes a list of supported mime-types and finds the best match for all - the media-ranges listed in header. The value of header must be a string - that conforms to the format of the HTTP Accept: header. The value of - 'supported' is a list of mime-types. The list of supported mime-types - should be sorted in order of increasing desirability, in case of a - situation where there is a tie. -->>> best_match(['application/xbel+xml', 'text/xml'], - 'text/*;q=0.5,*/*; q=0.1') -'text/xml'-
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Source Code for Module googleapiclient.mimeparse
-- 1 # Copyright 2014 Joe Gregorio - 2 # - 3 # Licensed under the MIT License - 4 - 5 """MIME-Type Parser - 6 - 7 This module provides basic functions for handling mime-types. It can handle - 8 matching mime-types against a list of media-ranges. See section 14.1 of the - 9 HTTP specification [RFC 2616] for a complete explanation. - 10 - 11 http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1 - 12 - 13 Contents: - 14 - parse_mime_type(): Parses a mime-type into its component parts. - 15 - parse_media_range(): Media-ranges are mime-types with wild-cards and a 'q' - 16 quality parameter. - 17 - quality(): Determines the quality ('q') of a mime-type when - 18 compared against a list of media-ranges. - 19 - quality_parsed(): Just like quality() except the second parameter must be - 20 pre-parsed. - 21 - best_match(): Choose the mime-type with the highest quality ('q') - 22 from a list of candidates. - 23 """ - 24 from __future__ import absolute_import - 25 from functools import reduce - 26 import six - 27 - 28 __version__ = "0.1.3" - 29 __author__ = "Joe Gregorio" - 30 __email__ = "joe@bitworking.org" - 31 __license__ = "MIT License" - 32 __credits__ = "" - 33 - 34 --36 """Parses a mime-type into its component parts. - 37 - 38 Carves up a mime-type and returns a tuple of the (type, subtype, params) - 39 where 'params' is a dictionary of all the parameters for the media range. - 40 For example, the media range 'application/xhtml;q=0.5' would get parsed - 41 into: - 42 - 43 ('application', 'xhtml', {'q', '0.5'}) - 44 """ - 45 parts = mime_type.split(";") - 46 params = dict( - 47 [tuple([s.strip() for s in param.split("=", 1)]) for param in parts[1:]] - 48 ) - 49 full_type = parts[0].strip() - 50 # Java URLConnection class sends an Accept header that includes a - 51 # single '*'. Turn it into a legal wildcard. - 52 if full_type == "*": - 53 full_type = "*/*" - 54 (type, subtype) = full_type.split("/") - 55 - 56 return (type.strip(), subtype.strip(), params) -57 - 58 -60 """Parse a media-range into its component parts. - 61 - 62 Carves up a media range and returns a tuple of the (type, subtype, - 63 params) where 'params' is a dictionary of all the parameters for the media - 64 range. For example, the media range 'application/*;q=0.5' would get parsed - 65 into: - 66 - 67 ('application', '*', {'q', '0.5'}) - 68 - 69 In addition this function also guarantees that there is a value for 'q' - 70 in the params dictionary, filling it in with a proper default if - 71 necessary. - 72 """ - 73 (type, subtype, params) = parse_mime_type(range) - 74 if ( - 75 "q" not in params - 76 or not params["q"] - 77 or not float(params["q"]) - 78 or float(params["q"]) > 1 - 79 or float(params["q"]) < 0 - 80 ): - 81 params["q"] = "1" - 82 - 83 return (type, subtype, params) -84 - 85 -87 """Find the best match for a mime-type amongst parsed media-ranges. - 88 - 89 Find the best match for a given mime-type against a list of media_ranges - 90 that have already been parsed by parse_media_range(). Returns a tuple of - 91 the fitness value and the value of the 'q' quality parameter of the best - 92 match, or (-1, 0) if no match was found. Just as for quality_parsed(), - 93 'parsed_ranges' must be a list of parsed media ranges. - 94 """ - 95 best_fitness = -1 - 96 best_fit_q = 0 - 97 (target_type, target_subtype, target_params) = parse_media_range(mime_type) - 98 for (type, subtype, params) in parsed_ranges: - 99 type_match = type == target_type or type == "*" or target_type == "*" -100 subtype_match = ( -101 subtype == target_subtype or subtype == "*" or target_subtype == "*" -102 ) -103 if type_match and subtype_match: -104 param_matches = reduce( -105 lambda x, y: x + y, -106 [ -107 1 -108 for (key, value) in six.iteritems(target_params) -109 if key != "q" and key in params and value == params[key] -110 ], -111 0, -112 ) -113 fitness = (type == target_type) and 100 or 0 -114 fitness += (subtype == target_subtype) and 10 or 0 -115 fitness += param_matches -116 if fitness > best_fitness: -117 best_fitness = fitness -118 best_fit_q = params["q"] -119 -120 return best_fitness, float(best_fit_q) -121 -122 -124 """Find the best match for a mime-type amongst parsed media-ranges. -125 -126 Find the best match for a given mime-type against a list of media_ranges -127 that have already been parsed by parse_media_range(). Returns the 'q' -128 quality parameter of the best match, 0 if no match was found. This function -129 bahaves the same as quality() except that 'parsed_ranges' must be a list of -130 parsed media ranges. -131 """ -132 -133 return fitness_and_quality_parsed(mime_type, parsed_ranges)[1] -134 -135 -137 """Return the quality ('q') of a mime-type against a list of media-ranges. -138 -139 Returns the quality 'q' of a mime-type when compared against the -140 media-ranges in ranges. For example: -141 -142 >>> quality('text/html','text/*;q=0.3, text/html;q=0.7, -143 text/html;level=1, text/html;level=2;q=0.4, */*;q=0.5') -144 0.7 -145 -146 """ -147 parsed_ranges = [parse_media_range(r) for r in ranges.split(",")] -148 -149 return quality_parsed(mime_type, parsed_ranges) -150 -151 -153 """Return mime-type with the highest quality ('q') from list of candidates. -154 -155 Takes a list of supported mime-types and finds the best match for all the -156 media-ranges listed in header. The value of header must be a string that -157 conforms to the format of the HTTP Accept: header. The value of 'supported' -158 is a list of mime-types. The list of supported mime-types should be sorted -159 in order of increasing desirability, in case of a situation where there is -160 a tie. -161 -162 >>> best_match(['application/xbel+xml', 'text/xml'], -163 'text/*;q=0.5,*/*; q=0.1') -164 'text/xml' -165 """ -166 split_header = _filter_blank(header.split(",")) -167 parsed_header = [parse_media_range(r) for r in split_header] -168 weighted_matches = [] -169 pos = 0 -170 for mime_type in supported: -171 weighted_matches.append( -172 (fitness_and_quality_parsed(mime_type, parsed_header), pos, mime_type) -173 ) -174 pos += 1 -175 weighted_matches.sort() -176 -177 return weighted_matches[-1][0][1] and weighted_matches[-1][2] or "" -178 -179 -184 -
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Module model
-Model objects for requests and responses.
-Each API may support one or more serializations, such as JSON, Atom, - etc. The model classes are responsible for converting between the wire - format and the Python object representation.
- --
Author: - jcgregorio@google.com (Joe Gregorio) -
-
-
|
-|||
| - - |
- Model - Model base class. - |
- ||
| - - |
- BaseModel - Base model class. - |
- ||
| - - |
- JsonModel - Model class for JSON. - |
- ||
| - - |
- RawModel - Model class for requests that don't return JSON. - |
- ||
| - - |
- MediaModel - Model class for requests that return Media. - |
- ||
| - - |
- ProtocolBufferModel - Model class for protocol buffers. - |
- ||
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
-
|
-|||
| - - |
- _LIBRARY_VERSION = |
- ||
| - - |
- _PY_VERSION = |
- ||
| - - |
- LOGGER = logging.getLogger(__name__)
- |
- ||
| - - |
- dump_request_response = False
- |
- ||
| - - |
- __package__ = None
- |
- ||
-
|
-|||
-
-
-
-
-
-Create a patch object. - -Some methods support PATCH, an efficient way to send updates to a resource. -This method allows the easy construction of patch bodies by looking at the -differences between a resource before and after it was modified. - -Args: - original: object, the original deserialized resource - modified: object, the modified deserialized resource -Returns: - An object that contains only the changes from original to modified, in a - form suitable to pass to a PATCH method. - -Example usage: - item = service.activities().get(postid=postid, userid=userid).execute() - original = copy.deepcopy(item) - item['object']['content'] = 'This is updated.' - service.activities.patch(postid=postid, userid=userid, - body=makepatch(original, item)).execute() - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Source Code for Module googleapiclient.model
-- 1 # Copyright 2014 Google Inc. All Rights Reserved. - 2 # - 3 # Licensed under the Apache License, Version 2.0 (the "License"); - 4 # you may not use this file except in compliance with the License. - 5 # You may obtain a copy of the License at - 6 # - 7 # http://www.apache.org/licenses/LICENSE-2.0 - 8 # - 9 # Unless required by applicable law or agreed to in writing, software - 10 # distributed under the License is distributed on an "AS IS" BASIS, - 11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - 12 # See the License for the specific language governing permissions and - 13 # limitations under the License. - 14 - 15 """Model objects for requests and responses. - 16 - 17 Each API may support one or more serializations, such - 18 as JSON, Atom, etc. The model classes are responsible - 19 for converting between the wire format and the Python - 20 object representation. - 21 """ - 22 from __future__ import absolute_import - 23 import six - 24 - 25 __author__ = "jcgregorio@google.com (Joe Gregorio)" - 26 - 27 import json - 28 import logging - 29 import platform - 30 import pkg_resources - 31 - 32 from six.moves.urllib.parse import urlencode - 33 - 34 from googleapiclient.errors import HttpError - 35 - 36 _LIBRARY_VERSION = pkg_resources.get_distribution("google-api-python-client").version - 37 _PY_VERSION = platform.python_version() - 38 - 39 LOGGER = logging.getLogger(__name__) - 40 - 41 dump_request_response = False - 46 --49 """Model base class. - 50 - 51 All Model classes should implement this interface. - 52 The Model serializes and de-serializes between a wire - 53 format such as JSON and a Python object representation. - 54 """ - 55 -89 -57 """Updates outgoing requests with a serialized body. - 58 - 59 Args: - 60 headers: dict, request headers - 61 path_params: dict, parameters that appear in the request path - 62 query_params: dict, parameters that appear in the query - 63 body_value: object, the request body as a Python object, which must be - 64 serializable. - 65 Returns: - 66 A tuple of (headers, path_params, query, body) - 67 - 68 headers: dict, request headers - 69 path_params: dict, parameters that appear in the request path - 70 query: string, query part of the request URI - 71 body: string, the body serialized in the desired wire format. - 72 """ - 73 _abstract() -74 -76 """Convert the response wire format into a Python object. - 77 - 78 Args: - 79 resp: httplib2.Response, the HTTP response headers and status - 80 content: string, the body of the HTTP response - 81 - 82 Returns: - 83 The body de-serialized as a Python object. - 84 - 85 Raises: - 86 googleapiclient.errors.HttpError if a non 2xx response is received. - 87 """ - 88 _abstract() -92 """Base model class. - 93 - 94 Subclasses should provide implementations for the "serialize" and - 95 "deserialize" methods, as well as values for the following class attributes. - 96 - 97 Attributes: - 98 accept: The value to use for the HTTP Accept header. - 99 content_type: The value to use for the HTTP Content-type header. -100 no_content_response: The value to return when deserializing a 204 "No -101 Content" response. -102 alt_param: The value to supply as the "alt" query parameter for requests. -103 """ -104 -105 accept = None -106 content_type = None -107 no_content_response = None -108 alt_param = None -109 -247 -111 """Logs debugging information about the request if requested.""" -112 if dump_request_response: -113 LOGGER.info("--request-start--") -114 LOGGER.info("-headers-start-") -115 for h, v in six.iteritems(headers): -116 LOGGER.info("%s: %s", h, v) -117 LOGGER.info("-headers-end-") -118 LOGGER.info("-path-parameters-start-") -119 for h, v in six.iteritems(path_params): -120 LOGGER.info("%s: %s", h, v) -121 LOGGER.info("-path-parameters-end-") -122 LOGGER.info("body: %s", body) -123 LOGGER.info("query: %s", query) -124 LOGGER.info("--request-end--") -125 -127 """Updates outgoing requests with a serialized body. -128 -129 Args: -130 headers: dict, request headers -131 path_params: dict, parameters that appear in the request path -132 query_params: dict, parameters that appear in the query -133 body_value: object, the request body as a Python object, which must be -134 serializable by json. -135 Returns: -136 A tuple of (headers, path_params, query, body) -137 -138 headers: dict, request headers -139 path_params: dict, parameters that appear in the request path -140 query: string, query part of the request URI -141 body: string, the body serialized as JSON -142 """ -143 query = self._build_query(query_params) -144 headers["accept"] = self.accept -145 headers["accept-encoding"] = "gzip, deflate" -146 if "user-agent" in headers: -147 headers["user-agent"] += " " -148 else: -149 headers["user-agent"] = "" -150 headers["user-agent"] += "(gzip)" -151 if "x-goog-api-client" in headers: -152 headers["x-goog-api-client"] += " " -153 else: -154 headers["x-goog-api-client"] = "" -155 headers["x-goog-api-client"] += "gdcl/%s gl-python/%s" % ( -156 _LIBRARY_VERSION, -157 _PY_VERSION, -158 ) -159 -160 if body_value is not None: -161 headers["content-type"] = self.content_type -162 body_value = self.serialize(body_value) -163 self._log_request(headers, path_params, query, body_value) -164 return (headers, path_params, query, body_value) -165 -167 """Builds a query string. -168 -169 Args: -170 params: dict, the query parameters -171 -172 Returns: -173 The query parameters properly encoded into an HTTP URI query string. -174 """ -175 if self.alt_param is not None: -176 params.update({"alt": self.alt_param}) -177 astuples = [] -178 for key, value in six.iteritems(params): -179 if type(value) == type([]): -180 for x in value: -181 x = x.encode("utf-8") -182 astuples.append((key, x)) -183 else: -184 if isinstance(value, six.text_type) and callable(value.encode): -185 value = value.encode("utf-8") -186 astuples.append((key, value)) -187 return "?" + urlencode(astuples) -188 -190 """Logs debugging information about the response if requested.""" -191 if dump_request_response: -192 LOGGER.info("--response-start--") -193 for h, v in six.iteritems(resp): -194 LOGGER.info("%s: %s", h, v) -195 if content: -196 LOGGER.info(content) -197 LOGGER.info("--response-end--") -198 -200 """Convert the response wire format into a Python object. -201 -202 Args: -203 resp: httplib2.Response, the HTTP response headers and status -204 content: string, the body of the HTTP response -205 -206 Returns: -207 The body de-serialized as a Python object. -208 -209 Raises: -210 googleapiclient.errors.HttpError if a non 2xx response is received. -211 """ -212 self._log_response(resp, content) -213 # Error handling is TBD, for example, do we retry -214 # for some operation/error combinations? -215 if resp.status < 300: -216 if resp.status == 204: -217 # A 204: No Content response should be treated differently -218 # to all the other success states -219 return self.no_content_response -220 return self.deserialize(content) -221 else: -222 LOGGER.debug("Content from bad request was: %r" % content) -223 raise HttpError(resp, content) -224 -226 """Perform the actual Python object serialization. -227 -228 Args: -229 body_value: object, the request body as a Python object. -230 -231 Returns: -232 string, the body in serialized form. -233 """ -234 _abstract() -235 -237 """Perform the actual deserialization from response string to Python -238 object. -239 -240 Args: -241 content: string, the body of the HTTP response -242 -243 Returns: -244 The body de-serialized as a Python object. -245 """ -246 _abstract() -250 """Model class for JSON. -251 -252 Serializes and de-serializes between JSON and the Python -253 object representation of HTTP request and response bodies. -254 """ -255 -256 accept = "application/json" -257 content_type = "application/json" -258 alt_param = "json" -259 -290 -261 """Construct a JsonModel. -262 -263 Args: -264 data_wrapper: boolean, wrap requests and responses in a data wrapper -265 """ -266 self._data_wrapper = data_wrapper -267 -269 if ( -270 isinstance(body_value, dict) -271 and "data" not in body_value -272 and self._data_wrapper -273 ): -274 body_value = {"data": body_value} -275 return json.dumps(body_value) -276 -278 try: -279 content = content.decode("utf-8") -280 except AttributeError: -281 pass -282 body = json.loads(content) -283 if self._data_wrapper and isinstance(body, dict) and "data" in body: -284 body = body["data"] -285 return body -286 -287 @property -293 """Model class for requests that don't return JSON. -294 -295 Serializes and de-serializes between JSON and the Python -296 object representation of HTTP request, and returns the raw bytes -297 of the response body. -298 """ -299 -300 accept = "*/*" -301 content_type = "application/json" -302 alt_param = None -303 -306 -307 @property -310 -313 """Model class for requests that return Media. -314 -315 Serializes and de-serializes between JSON and the Python -316 object representation of HTTP request, and returns the raw bytes -317 of the response body. -318 """ -319 -320 accept = "*/*" -321 content_type = "application/json" -322 alt_param = "media" -323 -326 -327 @property -330 -333 """Model class for protocol buffers. -334 -335 Serializes and de-serializes the binary protocol buffer sent in the HTTP -336 request and response bodies. -337 """ -338 -339 accept = "application/x-protobuf" -340 content_type = "application/x-protobuf" -341 alt_param = "proto" -342 -364 -344 """Constructs a ProtocolBufferModel. -345 -346 The serialized protocol buffer returned in an HTTP response will be -347 de-serialized using the given protocol buffer class. -348 -349 Args: -350 protocol_buffer: The protocol buffer class used to de-serialize a -351 response from the API. -352 """ -353 self._protocol_buffer = protocol_buffer -354 -357 -360 -361 @property -367 """Create a patch object. -368 -369 Some methods support PATCH, an efficient way to send updates to a resource. -370 This method allows the easy construction of patch bodies by looking at the -371 differences between a resource before and after it was modified. -372 -373 Args: -374 original: object, the original deserialized resource -375 modified: object, the modified deserialized resource -376 Returns: -377 An object that contains only the changes from original to modified, in a -378 form suitable to pass to a PATCH method. -379 -380 Example usage: -381 item = service.activities().get(postid=postid, userid=userid).execute() -382 original = copy.deepcopy(item) -383 item['object']['content'] = 'This is updated.' -384 service.activities.patch(postid=postid, userid=userid, -385 body=makepatch(original, item)).execute() -386 """ -387 patch = {} -388 for key, original_value in six.iteritems(original): -389 modified_value = modified.get(key, None) -390 if modified_value is None: -391 # Use None to signal that the element is deleted -392 patch[key] = None -393 elif original_value != modified_value: -394 if type(original_value) == type({}): -395 # Recursively descend objects -396 patch[key] = makepatch(original_value, modified_value) -397 else: -398 # In the case of simple types or arrays we just replace -399 patch[key] = modified_value -400 else: -401 # Don't add anything to patch if there's no change -402 pass -403 for key in modified: -404 if key not in original: -405 patch[key] = modified[key] -406 -407 return patch -408 -
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class BaseModel
--object --+ - | - Model --+ - | - BaseModel -- -
- Known Subclasses: -
- - -
-
-Base model class. - -Subclasses should provide implementations for the "serialize" and -"deserialize" methods, as well as values for the following class attributes. - -Attributes: - accept: The value to use for the HTTP Accept header. - content_type: The value to use for the HTTP Content-type header. - no_content_response: The value to return when deserializing a 204 "No - Content" response. - alt_param: The value to supply as the "alt" query parameter for requests. - -- - - -
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from |
- |||
-
|
-|||
| - - |
- accept = None
- |
- ||
| - - |
- content_type = None
- |
- ||
| - - |
- no_content_response = None
- |
- ||
| - - |
- alt_param = None
- |
- ||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
-Updates outgoing requests with a serialized body. - -Args: - headers: dict, request headers - path_params: dict, parameters that appear in the request path - query_params: dict, parameters that appear in the query - body_value: object, the request body as a Python object, which must be - serializable by json. -Returns: - A tuple of (headers, path_params, query, body) - - headers: dict, request headers - path_params: dict, parameters that appear in the request path - query: string, query part of the request URI - body: string, the body serialized as JSON - --
|
-
-
-
-
-
-
-Builds a query string. - -Args: - params: dict, the query parameters - -Returns: - The query parameters properly encoded into an HTTP URI query string. - --
|
-
-
-
-
-
-
-Convert the response wire format into a Python object. - -Args: - resp: httplib2.Response, the HTTP response headers and status - content: string, the body of the HTTP response - -Returns: - The body de-serialized as a Python object. - -Raises: - googleapiclient.errors.HttpError if a non 2xx response is received. - --
|
-
-
-
-
-
-
-Perform the actual Python object serialization. - -Args: - body_value: object, the request body as a Python object. - -Returns: - string, the body in serialized form. - --
|
-
-
-
-
-
-Perform the actual deserialization from response string to Python -object. - -Args: - content: string, the body of the HTTP response - -Returns: - The body de-serialized as a Python object. - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class JsonModel
--object --+ - | - Model --+ - | - BaseModel --+ - | - JsonModel -- -
- Known Subclasses: -
- - -
-
Model class for JSON.
-Serializes and de-serializes between JSON and the Python object - representation of HTTP request and response bodies.
- - - -
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from Inherited from Inherited from |
- |||
-
|
-|||
| - - |
- accept = |
- ||
| - - |
- content_type = |
- ||
| - - |
- alt_param = |
- ||
-
|
-|||
| - - | - no_content_response - | -||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
-Construct a JsonModel. - -Args: - data_wrapper: boolean, wrap requests and responses in a data wrapper - --
|
-
-
-
-
-
-
-Perform the actual Python object serialization. - -Args: - body_value: object, the request body as a Python object. - -Returns: - string, the body in serialized form. - --
|
-
-
-
-
-
-Perform the actual deserialization from response string to Python -object. - -Args: - content: string, the body of the HTTP response - -Returns: - The body de-serialized as a Python object. - --
|
- - -
-
|
-|||
-
-
-
-
- no_content_response- -
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class MediaModel
--object --+ - | - Model --+ - | - BaseModel --+ - | - JsonModel --+ - | - MediaModel -- -
-
Model class for requests that return Media.
-Serializes and de-serializes between JSON and the Python object - representation of HTTP request, and returns the raw bytes of the response - body.
- - - -
-
|
-|||
| - - |
-
|
- ||
|
- Inherited from Inherited from Inherited from Inherited from |
- |||
-
|
-|||
| - - |
- accept = |
- ||
| - - |
- content_type = "application/json"
- |
- ||
| - - |
- alt_param = |
- ||
-
|
-|||
| - - | - no_content_response - | -||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-Perform the actual deserialization from response string to Python -object. - -Args: - content: string, the body of the HTTP response - -Returns: - The body de-serialized as a Python object. - --
|
- - -
-
|
-|||
-
-
-
-
- no_content_response- -
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class Model
--object --+ - | - Model -- -
- Known Subclasses: -
- - -
-
Model base class.
-All Model classes should implement this interface. The Model - serializes and de-serializes between a wire format such as JSON and a - Python object representation.
- - - -
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
-Updates outgoing requests with a serialized body. - -Args: - headers: dict, request headers - path_params: dict, parameters that appear in the request path - query_params: dict, parameters that appear in the query - body_value: object, the request body as a Python object, which must be - serializable. -Returns: - A tuple of (headers, path_params, query, body) - - headers: dict, request headers - path_params: dict, parameters that appear in the request path - query: string, query part of the request URI - body: string, the body serialized in the desired wire format. - --
|
-
-
-
-
-
-Convert the response wire format into a Python object. - -Args: - resp: httplib2.Response, the HTTP response headers and status - content: string, the body of the HTTP response - -Returns: - The body de-serialized as a Python object. - -Raises: - googleapiclient.errors.HttpError if a non 2xx response is received. - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class ProtocolBufferModel
--object --+ - | - Model --+ - | - BaseModel --+ - | - ProtocolBufferModel -- -
-
Model class for protocol buffers.
-Serializes and de-serializes the binary protocol buffer sent in the - HTTP request and response bodies.
- - - -
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from Inherited from Inherited from |
- |||
-
|
-|||
| - - |
- accept = |
- ||
| - - |
- content_type = |
- ||
| - - |
- alt_param = |
- ||
-
|
-|||
| - - | - no_content_response - | -||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
-Constructs a ProtocolBufferModel. - -The serialized protocol buffer returned in an HTTP response will be -de-serialized using the given protocol buffer class. - -Args: - protocol_buffer: The protocol buffer class used to de-serialize a - response from the API. - --
|
-
-
-
-
-
-
-Perform the actual Python object serialization. - -Args: - body_value: object, the request body as a Python object. - -Returns: - string, the body in serialized form. - --
|
-
-
-
-
-
-Perform the actual deserialization from response string to Python -object. - -Args: - content: string, the body of the HTTP response - -Returns: - The body de-serialized as a Python object. - --
|
- - -
-
|
-|||
-
-
-
-
- no_content_response- -
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class RawModel
--object --+ - | - Model --+ - | - BaseModel --+ - | - JsonModel --+ - | - RawModel -- -
-
Model class for requests that don't return JSON.
-Serializes and de-serializes between JSON and the Python object - representation of HTTP request, and returns the raw bytes of the response - body.
- - - -
-
|
-|||
| - - |
-
|
- ||
|
- Inherited from Inherited from Inherited from Inherited from |
- |||
-
|
-|||
| - - |
- accept = |
- ||
| - - |
- content_type = "application/json"
- |
- ||
| - - |
- alt_param = None
- |
- ||
-
|
-|||
| - - | - no_content_response - | -||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-Perform the actual deserialization from response string to Python -object. - -Args: - content: string, the body of the HTTP response - -Returns: - The body de-serialized as a Python object. - --
|
- - -
-
|
-|||
-
-
-
-
- no_content_response- -
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Module sample_tools
-Utilities for making samples.
-Consolidates a lot of code commonly repeated in sample - applications.
- --
Author: - jcgregorio@google.com (Joe Gregorio) -
-
-
|
-|||
| - - |
-
|
- ||
-
|
-|||
-
-
-
-
-
-A common initialization routine for samples. - -Many of the sample applications do the same initialization, which has now -been consolidated into this function. This function uses common idioms found -in almost all the samples, i.e. for an API with name 'apiname', the -credentials are stored in a file named apiname.dat, and the -client_secrets.json file is stored in the same directory as the application -main file. - -Args: - argv: list of string, the command-line parameters of the application. - name: string, name of the API. - version: string, version of the API. - doc: string, description of the application. Usually set to __doc__. - file: string, filename of the application. Usually set to __file__. - parents: list of argparse.ArgumentParser, additional command-line flags. - scope: string, The OAuth scope used. - discovery_filename: string, name of local discovery file (JSON). Use when discovery doc not available via URL. - -Returns: - A tuple of (service, flags), where service is the service object and flags - is the parsed command-line flags. - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Source Code for Module googleapiclient.sample_tools
-- 1 # Copyright 2014 Google Inc. All Rights Reserved. - 2 # - 3 # Licensed under the Apache License, Version 2.0 (the "License"); - 4 # you may not use this file except in compliance with the License. - 5 # You may obtain a copy of the License at - 6 # - 7 # http://www.apache.org/licenses/LICENSE-2.0 - 8 # - 9 # Unless required by applicable law or agreed to in writing, software - 10 # distributed under the License is distributed on an "AS IS" BASIS, - 11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - 12 # See the License for the specific language governing permissions and - 13 # limitations under the License. - 14 - 15 """Utilities for making samples. - 16 - 17 Consolidates a lot of code commonly repeated in sample applications. - 18 """ - 19 from __future__ import absolute_import - 20 - 21 __author__ = "jcgregorio@google.com (Joe Gregorio)" - 22 __all__ = ["init"] - 23 - 24 - 25 import argparse - 26 import os - 27 - 28 from googleapiclient import discovery - 29 from googleapiclient.http import build_http - 30 - 31 --32 -def init( - 33 argv, name, version, doc, filename, scope=None, parents=[], discovery_filename=None - 34 ): -35 """A common initialization routine for samples. - 36 - 37 Many of the sample applications do the same initialization, which has now - 38 been consolidated into this function. This function uses common idioms found - 39 in almost all the samples, i.e. for an API with name 'apiname', the - 40 credentials are stored in a file named apiname.dat, and the - 41 client_secrets.json file is stored in the same directory as the application - 42 main file. - 43 - 44 Args: - 45 argv: list of string, the command-line parameters of the application. - 46 name: string, name of the API. - 47 version: string, version of the API. - 48 doc: string, description of the application. Usually set to __doc__. - 49 file: string, filename of the application. Usually set to __file__. - 50 parents: list of argparse.ArgumentParser, additional command-line flags. - 51 scope: string, The OAuth scope used. - 52 discovery_filename: string, name of local discovery file (JSON). Use when discovery doc not available via URL. - 53 - 54 Returns: - 55 A tuple of (service, flags), where service is the service object and flags - 56 is the parsed command-line flags. - 57 """ - 58 try: - 59 from oauth2client import client - 60 from oauth2client import file - 61 from oauth2client import tools - 62 except ImportError: - 63 raise ImportError( - 64 "googleapiclient.sample_tools requires oauth2client. Please install oauth2client and try again." - 65 ) - 66 - 67 if scope is None: - 68 scope = "https://www.googleapis.com/auth/" + name - 69 - 70 # Parser command-line arguments. - 71 parent_parsers = [tools.argparser] - 72 parent_parsers.extend(parents) - 73 parser = argparse.ArgumentParser( - 74 description=doc, - 75 formatter_class=argparse.RawDescriptionHelpFormatter, - 76 parents=parent_parsers, - 77 ) - 78 flags = parser.parse_args(argv[1:]) - 79 - 80 # Name of a file containing the OAuth 2.0 information for this - 81 # application, including client_id and client_secret, which are found - 82 # on the API Access tab on the Google APIs - 83 # Console <http://code.google.com/apis/console>. - 84 client_secrets = os.path.join(os.path.dirname(filename), "client_secrets.json") - 85 - 86 # Set up a Flow object to be used if we need to authenticate. - 87 flow = client.flow_from_clientsecrets( - 88 client_secrets, scope=scope, message=tools.message_if_missing(client_secrets) - 89 ) - 90 - 91 # Prepare credentials, and authorize HTTP object with them. - 92 # If the credentials don't exist or are invalid run through the native client - 93 # flow. The Storage object will ensure that if successful the good - 94 # credentials will get written back to a file. - 95 storage = file.Storage(name + ".dat") - 96 credentials = storage.get() - 97 if credentials is None or credentials.invalid: - 98 credentials = tools.run_flow(flow, storage, flags) - 99 http = credentials.authorize(http=build_http()) -100 -101 if discovery_filename is None: -102 # Construct a service object via the discovery service. -103 service = discovery.build(name, version, http=http) -104 else: -105 # Construct a service object using a local discovery document file. -106 with open(discovery_filename) as discovery_file: -107 service = discovery.build_from_document( -108 discovery_file.read(), base="https://www.googleapis.com/", http=http -109 ) -110 return (service, flags) -111 -
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Module schema
-
-Schema processing for discovery based APIs
-
-Schemas holds an APIs discovery schemas. It can return those schema as
-deserialized JSON objects, or pretty print them as prototype objects that
-conform to the schema.
-
-For example, given the schema:
-
- schema = """{
- "Foo": {
- "type": "object",
- "properties": {
- "etag": {
- "type": "string",
- "description": "ETag of the collection."
- },
- "kind": {
- "type": "string",
- "description": "Type of the collection ('calendar#acl').",
- "default": "calendar#acl"
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token used to access the next
- page of this result. Omitted if no further results are available."
- }
- }
- }
- }"""
-
- s = Schemas(schema)
- print s.prettyPrintByName('Foo')
-
- Produces the following output:
-
- {
- "nextPageToken": "A String", # Token used to access the
- # next page of this result. Omitted if no further results are available.
- "kind": "A String", # Type of the collection ('calendar#acl').
- "etag": "A String", # ETag of the collection.
- },
-
-The constructor takes a discovery document in which to look up named schema.
-
-
-
--
Author: - jcgregorio@google.com (Joe Gregorio) -
-
-
|
-|||
| - - |
- Schemas - Schemas for an API. - |
- ||
| - - |
- _SchemaToStruct - Convert schema to a prototype object. - |
- ||
-
|
-|||
| - - |
- __package__ = None
- |
- ||
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Source Code for Module googleapiclient.schema
-- 1 # Copyright 2014 Google Inc. All Rights Reserved. - 2 # - 3 # Licensed under the Apache License, Version 2.0 (the "License"); - 4 # you may not use this file except in compliance with the License. - 5 # You may obtain a copy of the License at - 6 # - 7 # http://www.apache.org/licenses/LICENSE-2.0 - 8 # - 9 # Unless required by applicable law or agreed to in writing, software - 10 # distributed under the License is distributed on an "AS IS" BASIS, - 11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - 12 # See the License for the specific language governing permissions and - 13 # limitations under the License. - 14 - 15 """Schema processing for discovery based APIs - 16 - 17 Schemas holds an APIs discovery schemas. It can return those schema as - 18 deserialized JSON objects, or pretty print them as prototype objects that - 19 conform to the schema. - 20 - 21 For example, given the schema: - 22 - 23 schema = \"\"\"{ - 24 "Foo": { - 25 "type": "object", - 26 "properties": { - 27 "etag": { - 28 "type": "string", - 29 "description": "ETag of the collection." - 30 }, - 31 "kind": { - 32 "type": "string", - 33 "description": "Type of the collection ('calendar#acl').", - 34 "default": "calendar#acl" - 35 }, - 36 "nextPageToken": { - 37 "type": "string", - 38 "description": "Token used to access the next - 39 page of this result. Omitted if no further results are available." - 40 } - 41 } - 42 } - 43 }\"\"\" - 44 - 45 s = Schemas(schema) - 46 print s.prettyPrintByName('Foo') - 47 - 48 Produces the following output: - 49 - 50 { - 51 "nextPageToken": "A String", # Token used to access the - 52 # next page of this result. Omitted if no further results are available. - 53 "kind": "A String", # Type of the collection ('calendar#acl'). - 54 "etag": "A String", # ETag of the collection. - 55 }, - 56 - 57 The constructor takes a discovery document in which to look up named schema. - 58 """ - 59 from __future__ import absolute_import - 60 import six - 61 - 62 # TODO(jcgregorio) support format, enum, minimum, maximum - 63 - 64 __author__ = "jcgregorio@google.com (Joe Gregorio)" - 65 - 66 import copy - 67 - 68 from googleapiclient import _helpers as util --72 """Schemas for an API.""" - 73 -168 -75 """Constructor. - 76 - 77 Args: - 78 discovery: object, Deserialized discovery document from which we pull - 79 out the named schema. - 80 """ - 81 self.schemas = discovery.get("schemas", {}) - 82 - 83 # Cache of pretty printed schemas. - 84 self.pretty = {} -85 - 86 @util.positional(2) -88 """Get pretty printed object prototype from the schema name. - 89 - 90 Args: - 91 name: string, Name of schema in the discovery document. - 92 seen: list of string, Names of schema already seen. Used to handle - 93 recursive definitions. - 94 - 95 Returns: - 96 string, A string that contains a prototype object with - 97 comments that conforms to the given schema. - 98 """ - 99 if seen is None: -100 seen = [] -101 -102 if name in seen: -103 # Do not fall into an infinite loop over recursive definitions. -104 return "# Object with schema name: %s" % name -105 seen.append(name) -106 -107 if name not in self.pretty: -108 self.pretty[name] = _SchemaToStruct( -109 self.schemas[name], seen, dent=dent -110 ).to_str(self._prettyPrintByName) -111 -112 seen.pop() -113 -114 return self.pretty[name] -115 -117 """Get pretty printed object prototype from the schema name. -118 -119 Args: -120 name: string, Name of schema in the discovery document. -121 -122 Returns: -123 string, A string that contains a prototype object with -124 comments that conforms to the given schema. -125 """ -126 # Return with trailing comma and newline removed. -127 return self._prettyPrintByName(name, seen=[], dent=1)[:-2] -128 -129 @util.positional(2) -131 """Get pretty printed object prototype of schema. -132 -133 Args: -134 schema: object, Parsed JSON schema. -135 seen: list of string, Names of schema already seen. Used to handle -136 recursive definitions. -137 -138 Returns: -139 string, A string that contains a prototype object with -140 comments that conforms to the given schema. -141 """ -142 if seen is None: -143 seen = [] -144 -145 return _SchemaToStruct(schema, seen, dent=dent).to_str(self._prettyPrintByName) -146 -148 """Get pretty printed object prototype of schema. -149 -150 Args: -151 schema: object, Parsed JSON schema. -152 -153 Returns: -154 string, A string that contains a prototype object with -155 comments that conforms to the given schema. -156 """ -157 # Return with trailing comma and newline removed. -158 return self._prettyPrintSchema(schema, dent=1)[:-2] -159 -161 """Get deserialized JSON schema from the schema name. -162 -163 Args: -164 name: string, Schema name. -165 default: object, return value if name not found. -166 """ -167 return self.schemas.get(name, default) -171 """Convert schema to a prototype object.""" -172 -173 @util.positional(3) -316 -175 """Constructor. -176 -177 Args: -178 schema: object, Parsed JSON schema. -179 seen: list, List of names of schema already seen while parsing. Used to -180 handle recursive definitions. -181 dent: int, Initial indentation depth. -182 """ -183 # The result of this parsing kept as list of strings. -184 self.value = [] -185 -186 # The final value of the parsing. -187 self.string = None -188 -189 # The parsed JSON schema. -190 self.schema = schema -191 -192 # Indentation level. -193 self.dent = dent -194 -195 # Method that when called returns a prototype object for the schema with -196 # the given name. -197 self.from_cache = None -198 -199 # List of names of schema already seen while parsing. -200 self.seen = seen -201 -203 """Add text as a line to the output. -204 -205 Args: -206 text: string, Text to output. -207 """ -208 self.value.extend([" " * self.dent, text, "\n"]) -209 -211 """Add text to the output, but with no line terminator. -212 -213 Args: -214 text: string, Text to output. -215 """ -216 self.value.extend([" " * self.dent, text]) -217 -219 """Add text and comment to the output with line terminator. -220 -221 Args: -222 text: string, Text to output. -223 comment: string, Python comment. -224 """ -225 if comment: -226 divider = "\n" + " " * (self.dent + 2) + "# " -227 lines = comment.splitlines() -228 lines = [x.rstrip() for x in lines] -229 comment = divider.join(lines) -230 self.value.extend([text, " # ", comment, "\n"]) -231 else: -232 self.value.extend([text, "\n"]) -233 -237 -241 -243 """Prototype object based on the schema, in Python code with comments. -244 -245 Args: -246 schema: object, Parsed JSON schema file. -247 -248 Returns: -249 Prototype object based on the schema, in Python code with comments. -250 """ -251 stype = schema.get("type") -252 if stype == "object": -253 self.emitEnd("{", schema.get("description", "")) -254 self.indent() -255 if "properties" in schema: -256 for pname, pschema in six.iteritems(schema.get("properties", {})): -257 self.emitBegin('"%s": ' % pname) -258 self._to_str_impl(pschema) -259 elif "additionalProperties" in schema: -260 self.emitBegin('"a_key": ') -261 self._to_str_impl(schema["additionalProperties"]) -262 self.undent() -263 self.emit("},") -264 elif "$ref" in schema: -265 schemaName = schema["$ref"] -266 description = schema.get("description", "") -267 s = self.from_cache(schemaName, seen=self.seen) -268 parts = s.splitlines() -269 self.emitEnd(parts[0], description) -270 for line in parts[1:]: -271 self.emit(line.rstrip()) -272 elif stype == "boolean": -273 value = schema.get("default", "True or False") -274 self.emitEnd("%s," % str(value), schema.get("description", "")) -275 elif stype == "string": -276 value = schema.get("default", "A String") -277 self.emitEnd('"%s",' % str(value), schema.get("description", "")) -278 elif stype == "integer": -279 value = schema.get("default", "42") -280 self.emitEnd("%s," % str(value), schema.get("description", "")) -281 elif stype == "number": -282 value = schema.get("default", "3.14") -283 self.emitEnd("%s," % str(value), schema.get("description", "")) -284 elif stype == "null": -285 self.emitEnd("None,", schema.get("description", "")) -286 elif stype == "any": -287 self.emitEnd('"",', schema.get("description", "")) -288 elif stype == "array": -289 self.emitEnd("[", schema.get("description")) -290 self.indent() -291 self.emitBegin("") -292 self._to_str_impl(schema["items"]) -293 self.undent() -294 self.emit("],") -295 else: -296 self.emit("Unknown type! %s" % stype) -297 self.emitEnd("", "") -298 -299 self.string = "".join(self.value) -300 return self.string -301 -303 """Prototype object based on the schema, in Python code with comments. -304 -305 Args: -306 from_cache: callable(name, seen), Callable that retrieves an object -307 prototype for a schema with the given name. Seen is a list of schema -308 names already seen as we recursively descend the schema definition. -309 -310 Returns: -311 Prototype object based on the schema, in Python code with comments. -312 The lines of the code will all be properly indented. -313 """ -314 self.from_cache = from_cache -315 return self._to_str_impl(self.schema) -
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class Schemas
--object --+ - | - Schemas -- -
-
Schemas for an API.
- - - -
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
-Constructor. - -Args: - discovery: object, Deserialized discovery document from which we pull - out the named schema. - --
|
-
-
-
-
-
-
-Get pretty printed object prototype from the schema name. - -Args: - name: string, Name of schema in the discovery document. - seen: list of string, Names of schema already seen. Used to handle - recursive definitions. - -Returns: - string, A string that contains a prototype object with - comments that conforms to the given schema. - --
|
-
-
-
-
-
-
-Get pretty printed object prototype from the schema name. - -Args: - name: string, Name of schema in the discovery document. - -Returns: - string, A string that contains a prototype object with - comments that conforms to the given schema. - --
|
-
-
-
-
-
-
-Get pretty printed object prototype of schema. - -Args: - schema: object, Parsed JSON schema. - seen: list of string, Names of schema already seen. Used to handle - recursive definitions. - -Returns: - string, A string that contains a prototype object with - comments that conforms to the given schema. - --
|
-
-
-
-
-
-
-Get pretty printed object prototype of schema. - -Args: - schema: object, Parsed JSON schema. - -Returns: - string, A string that contains a prototype object with - comments that conforms to the given schema. - --
|
-
-
-
-
-
-Get deserialized JSON schema from the schema name. - -Args: - name: string, Schema name. - default: object, return value if name not found. - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - - | -
- |
-
Class _SchemaToStruct
--object --+ - | - _SchemaToStruct -- -
-
Convert schema to a prototype object.
- - - -
-
|
-|||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
| - - |
-
|
- ||
|
- Inherited from |
- |||
-
|
-|||
|
- Inherited from |
- |||
-
|
-|||
-
-
-
-
-
-
-Constructor. - -Args: - schema: object, Parsed JSON schema. - seen: list, List of names of schema already seen while parsing. Used to - handle recursive definitions. - dent: int, Initial indentation depth. - --
|
-
-
-
-
-
-
-Add text as a line to the output. - -Args: - text: string, Text to output. - --
|
-
-
-
-
-
-
-Add text to the output, but with no line terminator. - -Args: - text: string, Text to output. - - --
|
-
-
-
-
-
-
-Add text and comment to the output with line terminator. - -Args: - text: string, Text to output. - comment: string, Python comment. - --
|
-
-
-
-
-
-
-Prototype object based on the schema, in Python code with comments. - -Args: - schema: object, Parsed JSON schema file. - -Returns: - Prototype object based on the schema, in Python code with comments. - --
|
-
-
-
-
-
-Prototype object based on the schema, in Python code with comments. - -Args: - from_cache: callable(name, seen), Callable that retrieves an object - prototype for a schema with the given name. Seen is a list of schema - names already seen as we recursively descend the schema definition. - -Returns: - Prototype object based on the schema, in Python code with comments. - The lines of the code will all be properly indented. - --
|
- -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - |
- |
-
API Documentation
- -This document contains the API (Application Programming Interface) -documentation for this project. Documentation for the Python -objects defined by the project is divided into separate pages for each -package, module, and class. The API documentation also includes two -pages containing information about the project as a whole: a trees -page, and an index page.
- -Object Documentation
- -Each Package Documentation page contains:
--
-
- A description of the package. -
- A list of the modules and sub-packages contained by the - package. -
- A summary of the classes defined by the package. -
- A summary of the functions defined by the package. -
- A summary of the variables defined by the package. -
- A detailed description of each function defined by the - package. -
- A detailed description of each variable defined by the - package. -
Each Module Documentation page contains:
--
-
- A description of the module. -
- A summary of the classes defined by the module. -
- A summary of the functions defined by the module. -
- A summary of the variables defined by the module. -
- A detailed description of each function defined by the - module. -
- A detailed description of each variable defined by the - module. -
Each Class Documentation page contains:
--
-
- A class inheritance diagram. -
- A list of known subclasses. -
- A description of the class. -
- A summary of the methods defined by the class. -
- A summary of the instance variables defined by the class. -
- A summary of the class (static) variables defined by the - class. -
- A detailed description of each method defined by the - class. -
- A detailed description of each instance variable defined by the - class. -
- A detailed description of each class (static) variable defined - by the class. -
Project Documentation
- -The Trees page contains the module and class hierarchies:
--
-
- The module hierarchy lists every package and module, with - modules grouped into packages. At the top level, and within each - package, modules and sub-packages are listed alphabetically. -
- The class hierarchy lists every class, grouped by base - class. If a class has more than one base class, then it will be - listed under each base class. At the top level, and under each base - class, classes are listed alphabetically. -
The Index page contains indices of terms and - identifiers:
--
-
- The term index lists every term indexed by any object's - documentation. For each term, the index provides links to each - place where the term is indexed. -
- The identifier index lists the (short) name of every package, - module, class, method, function, variable, and parameter. For each - identifier, the index provides a short description, and a link to - its documentation. -
The Table of Contents
- -The table of contents occupies the two frames on the left side of -the window. The upper-left frame displays the project -contents, and the lower-left frame displays the module -contents:
- -|
- Project Contents ... |
-
- API Documentation Frame - |
-
|
- Module Contents ... - |
-
- -
The project contents frame contains a list of all packages -and modules that are defined by the project. Clicking on an entry -will display its contents in the module contents frame. Clicking on a -special entry, labeled "Everything," will display the contents of -the entire project.
- -The module contents frame contains a list of every -submodule, class, type, exception, function, and variable defined by a -module or package. Clicking on an entry will display its -documentation in the API documentation frame. Clicking on the name of -the module, at the top of the frame, will display the documentation -for the module itself.
- -The "frames" and "no frames" buttons below the top -navigation bar can be used to control whether the table of contents is -displayed or not.
- -The Navigation Bar
- -A navigation bar is located at the top and bottom of every page. -It indicates what type of page you are currently viewing, and allows -you to go to related pages. The following table describes the labels -on the navigation bar. Note that not some labels (such as -[Parent]) are not displayed on all pages.
- -| Label | -Highlighted when... | -Links to... | -
|---|---|---|
| [Parent] | -(never highlighted) | -the parent of the current package |
| [Package] | -viewing a package | -the package containing the current object - |
| [Module] | -viewing a module | -the module containing the current object - |
| [Class] | -viewing a class | -the class containing the current object |
| [Trees] | -viewing the trees page | -the trees page |
| [Index] | -viewing the index page | -the index page |
| [Help] | -viewing the help page | -the help page |
The "show private" and "hide private" buttons below
-the top navigation bar can be used to control whether documentation
-for private objects is displayed. Private objects are usually defined
-as objects whose (short) names begin with a single underscore, but do
-not end with an underscore. For example, "_x",
-"__pprint", and "epydoc.epytext._tokenize"
-are private objects; but "re.sub",
-"__init__", and "type_" are not. However,
-if a module defines the "__all__" variable, then its
-contents are used to decide which objects are private.
A timestamp below the bottom navigation bar indicates when each -page was last updated.
- -| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:21 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - |
- |
-
-Identifier Index- | -[ - A - B - C - D - E - F - G - H - I - J - K - L - M - N - O - P - Q - R - S - T - U - V - W - X - Y - Z - _ -] - |
A |
-
-
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
B |
-
-
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
C |
-
-
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
D |
-
-
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
E |
-
-
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
F |
-
-
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
G |
-
-
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
H |
-
-
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
I |
-
-
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
J |
-
-
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
K |
-
-
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
L |
-
-
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
M |
-
-
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
N |
-
-
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
P |
-
-
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Q |
-
-
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
R |
-
-
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
S |
-
-
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
T |
-
-
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
U |
-
-
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
V |
-
-
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
W |
-
-
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
X |
-
-
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
_ |
-
-
|
-
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:21 2020 - | -- http://epydoc.sourceforge.net - | -
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - |
- |
-
-
Module Hierarchy
--
-
- googleapiclient
-
-
-
- googleapiclient._auth: Helpers for authentication using oauth2client or google-auth. -
- googleapiclient._helpers: Helper functions for commonly used utilities. -
- googleapiclient.channel: Channel notifications support. -
- googleapiclient.discovery: Client for discovery based APIs. -
- googleapiclient.discovery_cache: Caching utility for the discovery document.
-
-
-
- googleapiclient.discovery_cache.appengine_memcache: App Engine memcache based cache for the discovery document. -
- googleapiclient.discovery_cache.base: An abstract class for caching the discovery document. -
- googleapiclient.discovery_cache.file_cache: File based cache for the discovery document. -
- - googleapiclient.errors: Errors for the library. -
- googleapiclient.http: Classes to encapsulate a single HTTP request. -
- googleapiclient.mimeparse: MIME-Type Parser -
- googleapiclient.model: Model objects for requests and responses. -
- googleapiclient.sample_tools: Utilities for making samples. -
- googleapiclient.schema: Schema processing for discovery based APIs -
-
| Home | - - -Trees | - - -Indices | - - -Help | - -- |
|---|
| - Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:21 2020 - | -- http://epydoc.sourceforge.net - | -
Epydoc Auto-redirect page
- -When javascript is enabled, this page will redirect URLs of -the form redirect.html#dotted.name to the -documentation for the object with the given fully-qualified -dotted name.
- - - - - - diff --git a/docs/epy/toc-everything.html b/docs/epy/toc-everything.html deleted file mode 100644 index 3eba82a7c20..00000000000 --- a/docs/epy/toc-everything.html +++ /dev/null @@ -1,346 +0,0 @@ - - - - -Everything
--
All Classes
- googleapiclient.channel.Channelgoogleapiclient.channel.Notification
- - - googleapiclient.discovery_cache.appengine_memcache.Cache
googleapiclient.discovery_cache.base.Cache
googleapiclient.discovery_cache.file_cache.Cache
googleapiclient.errors.BatchError
googleapiclient.errors.Error
googleapiclient.errors.HttpError
googleapiclient.errors.InvalidChunkSizeError
googleapiclient.errors.InvalidJsonError
googleapiclient.errors.InvalidNotificationError
googleapiclient.errors.MediaUploadSizeError
googleapiclient.errors.ResumableUploadError
googleapiclient.errors.UnacceptableMimeTypeError
googleapiclient.errors.UnexpectedBodyError
googleapiclient.errors.UnexpectedMethodError
googleapiclient.errors.UnknownApiNameOrVersion
googleapiclient.errors.UnknownFileType
googleapiclient.errors.UnknownLinkType
googleapiclient.http.BatchHttpRequest
googleapiclient.http.HttpMock
googleapiclient.http.HttpMockSequence
googleapiclient.http.HttpRequest
googleapiclient.http.HttpRequestMock
googleapiclient.http.MediaDownloadProgress
googleapiclient.http.MediaFileUpload
googleapiclient.http.MediaInMemoryUpload
googleapiclient.http.MediaIoBaseDownload
googleapiclient.http.MediaIoBaseUpload
googleapiclient.http.MediaUpload
googleapiclient.http.MediaUploadProgress
googleapiclient.http.RequestMockBuilder
- googleapiclient.model.BaseModel
googleapiclient.model.JsonModel
googleapiclient.model.MediaModel
googleapiclient.model.Model
googleapiclient.model.ProtocolBufferModel
googleapiclient.model.RawModel
googleapiclient.schema.Schemas
-
All Functions
- - - - - - - - - - - - - - googleapiclient.channel.new_webhook_channelgoogleapiclient.channel.notification_from_headers
- - - - - - - - - - - googleapiclient.discovery.build
googleapiclient.discovery.build_from_document
- - googleapiclient.discovery.fix_method_name
googleapiclient.discovery.key2param
googleapiclient.discovery_cache.autodetect
- - - - googleapiclient.http.build_http
googleapiclient.http.set_user_agent
googleapiclient.http.tunnel_patch
- googleapiclient.mimeparse.best_match
googleapiclient.mimeparse.fitness_and_quality_parsed
googleapiclient.mimeparse.parse_media_range
googleapiclient.mimeparse.parse_mime_type
googleapiclient.mimeparse.quality
googleapiclient.mimeparse.quality_parsed
- googleapiclient.model.makepatch
googleapiclient.sample_tools.init
All Variables
- googleapiclient.__package__- - - - - - - - - - - - - - googleapiclient.channel.CHANNEL_PARAMS
googleapiclient.channel.EPOCH
googleapiclient.channel.X_GOOG_CHANNEL_ID
googleapiclient.channel.X_GOOG_MESSAGE_NUMBER
googleapiclient.channel.X_GOOG_RESOURCE_ID
googleapiclient.channel.X_GOOG_RESOURCE_STATE
googleapiclient.channel.X_GOOG_RESOURCE_URI
googleapiclient.channel.__package__
- - - - - - - - - - - - - - - - - - - googleapiclient.discovery_cache.DISCOVERY_DOC_MAX_AGE
googleapiclient.discovery_cache.LOGGER
googleapiclient.discovery_cache.__package__
googleapiclient.discovery_cache.appengine_memcache.LOGGER
googleapiclient.discovery_cache.appengine_memcache.NAMESPACE
googleapiclient.discovery_cache.appengine_memcache.cache
googleapiclient.discovery_cache.base.__package__
googleapiclient.discovery_cache.file_cache.EPOCH
googleapiclient.discovery_cache.file_cache.FILENAME
googleapiclient.discovery_cache.file_cache.LOGGER
googleapiclient.discovery_cache.file_cache.cache
googleapiclient.errors.__package__
googleapiclient.http.ConnectionError
googleapiclient.http.DEFAULT_CHUNK_SIZE
googleapiclient.http.DEFAULT_HTTP_TIMEOUT_SEC
googleapiclient.http.LOGGER
googleapiclient.http.MAX_BATCH_LIMIT
googleapiclient.http.MAX_URI_LENGTH
- - googleapiclient.http.__package__
googleapiclient.mimeparse.__credits__
googleapiclient.mimeparse.__email__
googleapiclient.mimeparse.__package__
googleapiclient.model.LOGGER
- - googleapiclient.model.__package__
googleapiclient.model.dump_request_response
googleapiclient.schema.__package__
- - - - - diff --git a/docs/epy/toc-googleapiclient-module.html b/docs/epy/toc-googleapiclient-module.html deleted file mode 100644 index 864fc0c83a3..00000000000 --- a/docs/epy/toc-googleapiclient-module.html +++ /dev/null @@ -1,31 +0,0 @@ - - - - -
Module googleapiclient
--
Variables
- __package__- - - - - diff --git a/docs/epy/toc-googleapiclient._auth-module.html b/docs/epy/toc-googleapiclient._auth-module.html deleted file mode 100644 index 1329ca1884c..00000000000 --- a/docs/epy/toc-googleapiclient._auth-module.html +++ /dev/null @@ -1,67 +0,0 @@ - - - - -
Module _auth
--
Functions
- - - - - -
- is_valid
-
-
- Variables
- - - - -- - - - - diff --git a/docs/epy/toc-googleapiclient._helpers-module.html b/docs/epy/toc-googleapiclient._helpers-module.html deleted file mode 100644 index 6bacd8fbb34..00000000000 --- a/docs/epy/toc-googleapiclient._helpers-module.html +++ /dev/null @@ -1,73 +0,0 @@ - - - - -
Module _helpers
--
Functions
- - - - -Variables
- - - - - - - - -
- logger
-
-- - - - - diff --git a/docs/epy/toc-googleapiclient.channel-module.html b/docs/epy/toc-googleapiclient.channel-module.html deleted file mode 100644 index 7b78305d0ba..00000000000 --- a/docs/epy/toc-googleapiclient.channel-module.html +++ /dev/null @@ -1,47 +0,0 @@ - - - - -
Module channel
--
Classes
- ChannelNotification
Functions
- - new_webhook_channelnotification_from_headers
Variables
- CHANNEL_PARAMSEPOCH
X_GOOG_CHANNEL_ID
X_GOOG_MESSAGE_NUMBER
X_GOOG_RESOURCE_ID
X_GOOG_RESOURCE_STATE
X_GOOG_RESOURCE_URI
__package__
- - - - - diff --git a/docs/epy/toc-googleapiclient.discovery-module.html b/docs/epy/toc-googleapiclient.discovery-module.html deleted file mode 100644 index e099063d78c..00000000000 --- a/docs/epy/toc-googleapiclient.discovery-module.html +++ /dev/null @@ -1,141 +0,0 @@ - - - - -
Module discovery
--
Classes
-
- Resource
-
-
- Functions
-
- _cast
-
-
-
-
-
-
-
-
-
-
- _urljoin
- buildbuild_from_document
- - fix_method_name
key2param
Variables
- - - - - - - - - - - - - - -
- VARNAME
-
-
-
-
- logger
-- - - - - diff --git a/docs/epy/toc-googleapiclient.discovery_cache-module.html b/docs/epy/toc-googleapiclient.discovery_cache-module.html deleted file mode 100644 index 37ee8f00080..00000000000 --- a/docs/epy/toc-googleapiclient.discovery_cache-module.html +++ /dev/null @@ -1,35 +0,0 @@ - - - - -
Module discovery_cache
--
Functions
- autodetectVariables
- DISCOVERY_DOC_MAX_AGELOGGER
__package__
- - - - - diff --git a/docs/epy/toc-googleapiclient.discovery_cache.appengine_memcache-module.html b/docs/epy/toc-googleapiclient.discovery_cache.appengine_memcache-module.html deleted file mode 100644 index f8a098d7e89..00000000000 --- a/docs/epy/toc-googleapiclient.discovery_cache.appengine_memcache-module.html +++ /dev/null @@ -1,35 +0,0 @@ - - - - -
Module appengine_memcache
--
Classes
- CacheVariables
- LOGGERNAMESPACE
cache
- - - - - diff --git a/docs/epy/toc-googleapiclient.discovery_cache.base-module.html b/docs/epy/toc-googleapiclient.discovery_cache.base-module.html deleted file mode 100644 index 80841a0ec12..00000000000 --- a/docs/epy/toc-googleapiclient.discovery_cache.base-module.html +++ /dev/null @@ -1,33 +0,0 @@ - - - - -
Module base
--
Classes
- CacheVariables
- __package__- - - - - diff --git a/docs/epy/toc-googleapiclient.discovery_cache.file_cache-module.html b/docs/epy/toc-googleapiclient.discovery_cache.file_cache-module.html deleted file mode 100644 index 43bf6a2090e..00000000000 --- a/docs/epy/toc-googleapiclient.discovery_cache.file_cache-module.html +++ /dev/null @@ -1,43 +0,0 @@ - - - - -
Module file_cache
--
Classes
- CacheFunctions
- - -Variables
- EPOCHFILENAME
LOGGER
cache
- - - - - diff --git a/docs/epy/toc-googleapiclient.errors-module.html b/docs/epy/toc-googleapiclient.errors-module.html deleted file mode 100644 index da2af5eb093..00000000000 --- a/docs/epy/toc-googleapiclient.errors-module.html +++ /dev/null @@ -1,46 +0,0 @@ - - - - -
Module errors
--
Classes
- BatchErrorError
HttpError
InvalidChunkSizeError
InvalidJsonError
InvalidNotificationError
MediaUploadSizeError
ResumableUploadError
UnacceptableMimeTypeError
UnexpectedBodyError
UnexpectedMethodError
UnknownApiNameOrVersion
UnknownFileType
UnknownLinkType
Variables
- __package__- - - - - diff --git a/docs/epy/toc-googleapiclient.http-module.html b/docs/epy/toc-googleapiclient.http-module.html deleted file mode 100644 index 2bb0f69fed0..00000000000 --- a/docs/epy/toc-googleapiclient.http-module.html +++ /dev/null @@ -1,70 +0,0 @@ - - - - -
Module http
--
Classes
- BatchHttpRequestHttpMock
HttpMockSequence
HttpRequest
HttpRequestMock
MediaDownloadProgress
MediaFileUpload
MediaInMemoryUpload
MediaIoBaseDownload
MediaIoBaseUpload
MediaUpload
MediaUploadProgress
RequestMockBuilder
-
Functions
- - - build_httpset_user_agent
tunnel_patch
Variables
- ConnectionErrorDEFAULT_CHUNK_SIZE
DEFAULT_HTTP_TIMEOUT_SEC
LOGGER
MAX_BATCH_LIMIT
MAX_URI_LENGTH
- - __package__
- - - - - diff --git a/docs/epy/toc-googleapiclient.mimeparse-module.html b/docs/epy/toc-googleapiclient.mimeparse-module.html deleted file mode 100644 index 020de8a2b50..00000000000 --- a/docs/epy/toc-googleapiclient.mimeparse-module.html +++ /dev/null @@ -1,43 +0,0 @@ - - - - -
Module mimeparse
--
Functions
- - best_matchfitness_and_quality_parsed
parse_media_range
parse_mime_type
quality
quality_parsed
Variables
- __credits____email__
__package__
- - - - - diff --git a/docs/epy/toc-googleapiclient.model-module.html b/docs/epy/toc-googleapiclient.model-module.html deleted file mode 100644 index dc1edcb5a33..00000000000 --- a/docs/epy/toc-googleapiclient.model-module.html +++ /dev/null @@ -1,51 +0,0 @@ - - - - -
Module model
--
Classes
- BaseModelJsonModel
MediaModel
Model
ProtocolBufferModel
RawModel
Functions
- - makepatchVariables
- LOGGER- - __package__
dump_request_response
- - - - - diff --git a/docs/epy/toc-googleapiclient.sample_tools-module.html b/docs/epy/toc-googleapiclient.sample_tools-module.html deleted file mode 100644 index d45c2fa9e95..00000000000 --- a/docs/epy/toc-googleapiclient.sample_tools-module.html +++ /dev/null @@ -1,31 +0,0 @@ - - - - -
Module sample_tools
--
Functions
- init- - - - - diff --git a/docs/epy/toc-googleapiclient.schema-module.html b/docs/epy/toc-googleapiclient.schema-module.html deleted file mode 100644 index 3762e30563e..00000000000 --- a/docs/epy/toc-googleapiclient.schema-module.html +++ /dev/null @@ -1,36 +0,0 @@ - - - - -
Module schema
--
Classes
- Schemas-
Variables
- __package__- - - - - diff --git a/docs/epy/toc.html b/docs/epy/toc.html deleted file mode 100644 index ac8c6d61560..00000000000 --- a/docs/epy/toc.html +++ /dev/null @@ -1,51 +0,0 @@ - - - - -
Table of Contents
-- Everything -
-
Modules
- googleapiclient- - googleapiclient.channel
googleapiclient.discovery
googleapiclient.discovery_cache
googleapiclient.discovery_cache.appengine_memcache
googleapiclient.discovery_cache.base
googleapiclient.discovery_cache.file_cache
googleapiclient.errors
googleapiclient.http
googleapiclient.mimeparse
googleapiclient.model
googleapiclient.sample_tools
googleapiclient.schema
- - - - - diff --git a/docs/epy/uml_class_diagram_for_googleap.gif b/docs/epy/uml_class_diagram_for_googleap.gif deleted file mode 100644 index 55249e0a86284e21c6b46377a607ffeb058025fe..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 13024 zcmcgw^*