Source

python-cloudfiles / docs / cloudfiles.fjson-module.html

<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>cloudfiles.fjson</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="cloudfiles-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://www.rackspacecloud.com/">Cloud Files Python API</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="cloudfiles-module.html">Package&nbsp;cloudfiles</a> ::
        Module&nbsp;fjson
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="cloudfiles.fjson-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module fjson</h1><p class="nomargin-top"><span class="codelink"><a href="cloudfiles.fjson-pysrc.html">source&nbsp;code</a></span></p>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Functions</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="cloudfiles.fjson-module.html#json_loads" class="summary-sig-name">json_loads</a>(<span class="summary-sig-arg">s</span>,
        <span class="summary-sig-arg">encoding</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">cls</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">object_hook</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">parse_float</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">parse_int</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">parse_constant</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">object_pairs_hook</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">**kw</span>)</span><br />
      Deserialize ``s`` (a ``str`` or ``unicode`` instance containing a 
      JSON document) to a Python object.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Function Details</span></td>
</tr>
</table>
<a name="json_loads"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">json_loads</span>(<span class="sig-arg">s</span>,
        <span class="sig-arg">encoding</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">cls</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">object_hook</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">parse_float</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">parse_int</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">parse_constant</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">object_pairs_hook</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">**kw</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <p>Deserialize ``s`` (a ``str`` or ``unicode`` instance containing a JSON
  document) to a Python object.</p>
  <p>If ``s`` is a ``str`` instance and is encoded with an ASCII based 
  encoding other than utf-8 (e.g. latin-1) then an appropriate ``encoding``
  name must be specified. Encodings that are not ASCII based (such as 
  UCS-2) are not allowed and should be decoded to ``unicode`` first.</p>
  <p>``object_hook`` is an optional function that will be called with the 
  result of any object literal decode (a ``dict``). The return value of 
  ``object_hook`` will be used instead of the ``dict``. This feature can be
  used to implement custom decoders (e.g. JSON-RPC class hinting).</p>
  <p>``object_pairs_hook`` is an optional function that will be called with
  the result of any object literal decoded with an ordered list of pairs.  
  The return value of ``object_pairs_hook`` will be used instead of the 
  ``dict``. This feature can be used to implement custom decoders that rely
  on the order that the key and value pairs are decoded (for example, 
  collections.OrderedDict will remember the order of insertion). If 
  ``object_hook`` is also defined, the ``object_pairs_hook`` takes 
  priority.</p>
  <p>``parse_float``, if specified, will be called with the string of every
  JSON float to be decoded. By default this is equivalent to 
  float(num_str). This can be used to use another datatype or parser for 
  JSON floats (e.g. decimal.Decimal).</p>
  <p>``parse_int``, if specified, will be called with the string of every 
  JSON int to be decoded. By default this is equivalent to int(num_str). 
  This can be used to use another datatype or parser for JSON integers 
  (e.g. float).</p>
  <p>``parse_constant``, if specified, will be called with one of the 
  following strings: -Infinity, Infinity, NaN, null, true, false. This can 
  be used to raise an exception if invalid JSON numbers are 
  encountered.</p>
  <p>To use a custom ``JSONDecoder`` subclass, specify it with the ``cls`` 
  kwarg; otherwise ``JSONDecoder`` is used.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="cloudfiles-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://www.rackspacecloud.com/">Cloud Files Python API</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Jun  1 13:14:12 2012
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>