Merge pull request #58 from jgeewax/gh-pages

Automatic update of documentation.

Author: jgeewax

_modules/gcloud/connection.html

@@ -108,6 +108,10 @@ <h1>Source code for gcloud.connection</h1><div class="highlight"><pre>
 
     <span class="bp">self</span><span class="o">.</span><span class="n">_credentials</span> <span class="o">=</span> <span class="n">credentials</span>
 
+  <span class="nd">@property</span>
+<div class="viewcode-block" id="Connection.credentials"><a class="viewcode-back" href="../../common-api.html#gcloud.connection.Connection.credentials">[docs]</a>  <span class="k">def</span> <span class="nf">credentials</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+    <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_credentials</span>
+</div>
   <span class="nd">@property</span>
 <div class="viewcode-block" id="Connection.http"><a class="viewcode-back" href="../../common-api.html#gcloud.connection.Connection.http">[docs]</a>  <span class="k">def</span> <span class="nf">http</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;A getter for the HTTP transport used in talking to the API.</span>

_modules/gcloud/datastore/helpers.html

@@ -82,6 +82,7 @@ <h3>All API Docs</h3>
 
   <h1>Source code for gcloud.datastore.helpers</h1><div class="highlight"><pre>
 <span class="sd">&quot;&quot;&quot;Helper methods for dealing with Cloud Datastore&#39;s Protobuf API.&quot;&quot;&quot;</span>
+<span class="kn">import</span> <span class="nn">calendar</span>
 <span class="kn">from</span> <span class="nn">datetime</span> <span class="kn">import</span> <span class="n">datetime</span>
 
 <span class="kn">import</span> <span class="nn">pytz</span>
@@ -119,7 +120,15 @@ <h1>Source code for gcloud.datastore.helpers</h1><div class="highlight"><pre>
 <span class="sd">  &quot;&quot;&quot;</span>
 
   <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="n">datetime</span><span class="p">):</span>
-    <span class="n">name</span><span class="p">,</span> <span class="n">value</span> <span class="o">=</span> <span class="s">&#39;timestamp_microseconds&#39;</span><span class="p">,</span> <span class="n">time</span><span class="o">.</span><span class="n">mktime</span><span class="p">(</span><span class="n">val</span><span class="o">.</span><span class="n">timetuple</span><span class="p">())</span>
+    <span class="n">name</span> <span class="o">=</span> <span class="s">&#39;timestamp_microseconds&#39;</span>
+    <span class="c"># If the datetime is naive (no timezone), consider that it was</span>
+    <span class="c"># intended to be UTC and replace the tzinfo to that effect.</span>
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">val</span><span class="o">.</span><span class="n">tzinfo</span><span class="p">:</span>
+      <span class="n">val</span> <span class="o">=</span> <span class="n">val</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">tzinfo</span><span class="o">=</span><span class="n">pytz</span><span class="o">.</span><span class="n">utc</span><span class="p">)</span>
+    <span class="c"># Regardless of what timezone is on the value, convert it to UTC.</span>
+    <span class="n">val</span> <span class="o">=</span> <span class="n">val</span><span class="o">.</span><span class="n">astimezone</span><span class="p">(</span><span class="n">pytz</span><span class="o">.</span><span class="n">utc</span><span class="p">)</span>
+    <span class="c"># Convert the datetime to a microsecond timestamp.</span>
+    <span class="n">value</span> <span class="o">=</span> <span class="nb">long</span><span class="p">(</span><span class="n">calendar</span><span class="o">.</span><span class="n">timegm</span><span class="p">(</span><span class="n">val</span><span class="o">.</span><span class="n">timetuple</span><span class="p">())</span> <span class="o">*</span> <span class="mf">1e6</span><span class="p">)</span> <span class="o">+</span> <span class="n">val</span><span class="o">.</span><span class="n">microsecond</span>
   <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="n">Key</span><span class="p">):</span>
     <span class="n">name</span><span class="p">,</span> <span class="n">value</span> <span class="o">=</span> <span class="s">&#39;key&#39;</span><span class="p">,</span> <span class="n">val</span><span class="o">.</span><span class="n">to_protobuf</span><span class="p">()</span>
   <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="nb">bool</span><span class="p">):</span>
@@ -151,8 +160,9 @@ <h1>Source code for gcloud.datastore.helpers</h1><div class="highlight"><pre>
 <span class="sd">  &quot;&quot;&quot;</span>
 
   <span class="k">if</span> <span class="n">pb</span><span class="o">.</span><span class="n">value</span><span class="o">.</span><span class="n">HasField</span><span class="p">(</span><span class="s">&#39;timestamp_microseconds_value&#39;</span><span class="p">):</span>
-    <span class="n">timestamp</span> <span class="o">=</span> <span class="n">pb</span><span class="o">.</span><span class="n">value</span><span class="o">.</span><span class="n">timestamp_microseconds_value</span> <span class="o">/</span> <span class="mf">1e6</span>
-    <span class="k">return</span> <span class="n">datetime</span><span class="o">.</span><span class="n">fromtimestamp</span><span class="p">(</span><span class="n">timestamp</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">tzinfo</span><span class="o">=</span><span class="n">pytz</span><span class="o">.</span><span class="n">utc</span><span class="p">)</span>
+    <span class="n">microseconds</span> <span class="o">=</span> <span class="n">pb</span><span class="o">.</span><span class="n">value</span><span class="o">.</span><span class="n">timestamp_microseconds_value</span>
+    <span class="k">return</span> <span class="p">(</span><span class="n">datetime</span><span class="o">.</span><span class="n">utcfromtimestamp</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> <span class="o">+</span>
+            <span class="n">datetime</span><span class="o">.</span><span class="n">timedelta</span><span class="p">(</span><span class="n">microseconds</span><span class="o">=</span><span class="n">microseconds</span><span class="p">))</span>
 
   <span class="k">elif</span> <span class="n">pb</span><span class="o">.</span><span class="n">value</span><span class="o">.</span><span class="n">HasField</span><span class="p">(</span><span class="s">&#39;key_value&#39;</span><span class="p">):</span>
     <span class="k">return</span> <span class="n">Key</span><span class="o">.</span><span class="n">from_protobuf</span><span class="p">(</span><span class="n">pb</span><span class="o">.</span><span class="n">value</span><span class="o">.</span><span class="n">key_value</span><span class="p">)</span>

_modules/gcloud/datastore/key.html

@@ -132,14 +132,18 @@ <h1>Source code for gcloud.datastore.key</h1><div class="highlight"><pre>
 <div class="viewcode-block" id="Key.to_protobuf"><a class="viewcode-back" href="../../../datastore-api.html#gcloud.datastore.key.Key.to_protobuf">[docs]</a>  <span class="k">def</span> <span class="nf">to_protobuf</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
     <span class="n">key</span> <span class="o">=</span> <span class="n">datastore_pb</span><span class="o">.</span><span class="n">Key</span><span class="p">()</span>
 
-    <span class="c"># Apparently &#39;s~&#39; is a prefix for High-Replication and is necessary here.</span>
-    <span class="c"># Another valid preflix is &#39;e~&#39; indicating EU datacenters.</span>
-    <span class="n">dataset_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">dataset</span><span class="p">()</span><span class="o">.</span><span class="n">id</span><span class="p">()</span>
-    <span class="k">if</span> <span class="n">dataset_id</span><span class="p">:</span>
-      <span class="k">if</span> <span class="n">dataset_id</span><span class="p">[:</span><span class="mi">2</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s">&#39;s~&#39;</span><span class="p">,</span> <span class="s">&#39;e~&#39;</span><span class="p">]:</span>
-        <span class="n">dataset_id</span> <span class="o">=</span> <span class="s">&#39;s~&#39;</span> <span class="o">+</span> <span class="n">dataset_id</span>
-
-      <span class="n">key</span><span class="o">.</span><span class="n">partition_id</span><span class="o">.</span><span class="n">dataset_id</span> <span class="o">=</span> <span class="n">dataset_id</span>
+    <span class="c"># Technically a dataset is required to do anything with the key,</span>
+    <span class="c"># but we shouldn&#39;t throw a cryptic error if one isn&#39;t provided</span>
+    <span class="c"># in the initializer.</span>
+    <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">dataset</span><span class="p">():</span>
+      <span class="c"># Apparently &#39;s~&#39; is a prefix for High-Replication and is necessary here.</span>
+      <span class="c"># Another valid preflix is &#39;e~&#39; indicating EU datacenters.</span>
+      <span class="n">dataset_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">dataset</span><span class="p">()</span><span class="o">.</span><span class="n">id</span><span class="p">()</span>
+      <span class="k">if</span> <span class="n">dataset_id</span><span class="p">:</span>
+        <span class="k">if</span> <span class="n">dataset_id</span><span class="p">[:</span><span class="mi">2</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s">&#39;s~&#39;</span><span class="p">,</span> <span class="s">&#39;e~&#39;</span><span class="p">]:</span>
+          <span class="n">dataset_id</span> <span class="o">=</span> <span class="s">&#39;s~&#39;</span> <span class="o">+</span> <span class="n">dataset_id</span>
+
+        <span class="n">key</span><span class="o">.</span><span class="n">partition_id</span><span class="o">.</span><span class="n">dataset_id</span> <span class="o">=</span> <span class="n">dataset_id</span>
 
     <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_namespace</span><span class="p">:</span>
       <span class="n">key</span><span class="o">.</span><span class="n">partition_id</span><span class="o">.</span><span class="n">namespace</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_namespace</span>