docs/_modules/contentful/entry.html


<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>contentful.entry &#8212; Contentful 1.11.4 documentation</title>
    <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../../',
        VERSION:     '1.11.4',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true,
        SOURCELINK_SUFFIX: '.txt'
      };
    </script>
    <script type="text/javascript" src="../../_static/jquery.js"></script>
    <script type="text/javascript" src="../../_static/underscore.js"></script>
    <script type="text/javascript" src="../../_static/doctools.js"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
   
  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head>
  <body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <h1>Source code for contentful.entry</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">.resource</span> <span class="k">import</span> <span class="n">FieldsResource</span>
<span class="kn">from</span> <span class="nn">.utils</span> <span class="k">import</span> <span class="n">is_link</span><span class="p">,</span> <span class="n">is_link_array</span><span class="p">,</span> <span class="n">resource_for_link</span><span class="p">,</span> <span class="n">unresolvable</span>
<span class="kn">from</span> <span class="nn">.content_type_cache</span> <span class="k">import</span> <span class="n">ContentTypeCache</span>


<span class="sd">&quot;&quot;&quot;</span>
<span class="sd">contentful.entry</span>
<span class="sd">~~~~~~~~~~~~~~~~</span>

<span class="sd">This module implements the Entry class.</span>

<span class="sd">API Reference: https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/entries</span>

<span class="sd">:copyright: (c) 2016 by Contentful GmbH.</span>
<span class="sd">:license: MIT, see LICENSE for more details.</span>
<span class="sd">&quot;&quot;&quot;</span>


<div class="viewcode-block" id="Entry"><a class="viewcode-back" href="../../contentful.html#contentful.entry.Entry">[docs]</a><span class="k">class</span> <span class="nc">Entry</span><span class="p">(</span><span class="n">FieldsResource</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    API Reference: https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/entries</span>
<span class="sd">    &quot;&quot;&quot;</span>

    <span class="k">def</span> <span class="nf">_coerce</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">field_id</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">localized</span><span class="p">,</span> <span class="n">includes</span><span class="p">,</span> <span class="n">errors</span><span class="p">,</span> <span class="n">resources</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
        <span class="k">if</span> <span class="n">is_link</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">unresolvable</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">errors</span><span class="p">):</span>
            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_build_nested_resource</span><span class="p">(</span>
                <span class="n">value</span><span class="p">,</span>
                <span class="n">localized</span><span class="p">,</span>
                <span class="n">includes</span><span class="p">,</span>
                <span class="n">errors</span><span class="p">,</span>
                <span class="n">resources</span><span class="o">=</span><span class="n">resources</span>
            <span class="p">)</span>
        <span class="k">elif</span> <span class="n">is_link_array</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
            <span class="n">items</span> <span class="o">=</span> <span class="p">[]</span>
            <span class="k">for</span> <span class="n">link</span> <span class="ow">in</span> <span class="n">value</span><span class="p">:</span>
                <span class="k">if</span> <span class="n">unresolvable</span><span class="p">(</span><span class="n">link</span><span class="p">,</span> <span class="n">errors</span><span class="p">):</span>
                    <span class="k">continue</span>
                <span class="n">items</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
                    <span class="bp">self</span><span class="o">.</span><span class="n">_build_nested_resource</span><span class="p">(</span>
                        <span class="n">link</span><span class="p">,</span>
                        <span class="n">localized</span><span class="p">,</span>
                        <span class="n">includes</span><span class="p">,</span>
                        <span class="n">errors</span><span class="p">,</span>
                        <span class="n">resources</span><span class="o">=</span><span class="n">resources</span>
                    <span class="p">)</span>
                <span class="p">)</span>

            <span class="k">return</span> <span class="n">items</span>

        <span class="n">content_type</span> <span class="o">=</span> <span class="n">ContentTypeCache</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">sys</span><span class="p">[</span><span class="s1">&#39;content_type&#39;</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">content_type</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
            <span class="n">content_type_field</span> <span class="o">=</span> <span class="n">content_type</span><span class="o">.</span><span class="n">field_for</span><span class="p">(</span><span class="n">field_id</span><span class="p">)</span>
            <span class="k">if</span> <span class="n">content_type_field</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
                <span class="k">return</span> <span class="n">content_type_field</span><span class="o">.</span><span class="n">coerce</span><span class="p">(</span>
                    <span class="n">value</span><span class="p">,</span>
                    <span class="n">includes</span><span class="o">=</span><span class="n">includes</span><span class="p">,</span>
                    <span class="n">errors</span><span class="o">=</span><span class="n">errors</span><span class="p">,</span>
                    <span class="n">resources</span><span class="o">=</span><span class="n">resources</span><span class="p">,</span>
                    <span class="n">default_locale</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">default_locale</span><span class="p">,</span>
                    <span class="n">locale</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">sys</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;locale&#39;</span><span class="p">,</span> <span class="s1">&#39;*&#39;</span><span class="p">)</span>
                <span class="p">)</span>

        <span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">Entry</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">_coerce</span><span class="p">(</span>
            <span class="n">field_id</span><span class="p">,</span>
            <span class="n">value</span><span class="p">,</span>
            <span class="n">localized</span><span class="p">,</span>
            <span class="n">includes</span><span class="p">,</span>
            <span class="n">errors</span><span class="p">,</span>
            <span class="n">resources</span>
        <span class="p">)</span>

    <span class="k">def</span> <span class="nf">_build_nested_resource</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">localized</span><span class="p">,</span> <span class="n">includes</span><span class="p">,</span> <span class="n">errors</span><span class="p">,</span> <span class="n">resources</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
        <span class="c1"># Maximum include Depth is 10 in the API, but we raise it to 20 (default),</span>
        <span class="c1"># in case one of the included items has a reference in an upper level,</span>
        <span class="c1"># so we can keep the include chain for that object as well</span>
        <span class="c1"># Any included object after the 20th level of depth will be just a Link.</span>
        <span class="c1"># When using reuse_entries, this is not the case if the entry was previously</span>
        <span class="c1"># cached.</span>

        <span class="n">resource</span> <span class="o">=</span> <span class="n">resource_for_link</span><span class="p">(</span>
            <span class="n">value</span><span class="p">,</span>
            <span class="n">includes</span><span class="p">,</span>
            <span class="n">resources</span><span class="o">=</span><span class="n">resources</span><span class="p">,</span>
            <span class="n">locale</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">sys</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;locale&#39;</span><span class="p">,</span> <span class="s1">&#39;*&#39;</span><span class="p">)</span>
        <span class="p">)</span>

        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">resource</span><span class="p">,</span> <span class="n">FieldsResource</span><span class="p">):</span>  <span class="c1"># Resource comes from instance cache</span>
            <span class="k">return</span> <span class="n">resource</span>

        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_depth</span> <span class="o">&lt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">_max_depth</span><span class="p">:</span>
            <span class="k">if</span> <span class="n">resource</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
                <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_resolve_include</span><span class="p">(</span>
                    <span class="n">resource</span><span class="p">,</span>
                    <span class="n">localized</span><span class="p">,</span>
                    <span class="n">includes</span><span class="p">,</span>
                    <span class="n">errors</span><span class="p">,</span>
                    <span class="n">resources</span><span class="o">=</span><span class="n">resources</span>
                <span class="p">)</span>

        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_build_link</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>

    <span class="k">def</span> <span class="nf">_resolve_include</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resource</span><span class="p">,</span> <span class="n">localized</span><span class="p">,</span> <span class="n">includes</span><span class="p">,</span> <span class="n">errors</span><span class="p">,</span> <span class="n">resources</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
        <span class="kn">from</span> <span class="nn">.resource_builder</span> <span class="k">import</span> <span class="n">ResourceBuilder</span>
        <span class="k">return</span> <span class="n">ResourceBuilder</span><span class="p">(</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">default_locale</span><span class="p">,</span>
            <span class="n">localized</span><span class="p">,</span>
            <span class="n">resource</span><span class="p">,</span>
            <span class="n">includes_for_single</span><span class="o">=</span><span class="n">includes</span><span class="p">,</span>
            <span class="n">errors_for_single</span><span class="o">=</span><span class="n">errors</span><span class="p">,</span>
            <span class="n">reuse_entries</span><span class="o">=</span><span class="nb">bool</span><span class="p">(</span><span class="n">resources</span><span class="p">),</span>
            <span class="n">resources</span><span class="o">=</span><span class="n">resources</span><span class="p">,</span>
            <span class="n">depth</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_depth</span> <span class="o">+</span> <span class="mi">1</span><span class="p">,</span>
            <span class="n">max_depth</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_max_depth</span>
        <span class="p">)</span><span class="o">.</span><span class="n">build</span><span class="p">()</span>

<div class="viewcode-block" id="Entry.incoming_references"><a class="viewcode-back" href="../../contentful.html#contentful.entry.Entry.incoming_references">[docs]</a>    <span class="k">def</span> <span class="nf">incoming_references</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">query</span><span class="o">=</span><span class="p">{}):</span>
        <span class="sd">&quot;&quot;&quot;Fetches all entries referencing the entry</span>

<span class="sd">        API Reference: https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters/links-to-asset</span>

<span class="sd">        :param client Client instance</span>
<span class="sd">        :param query: (optional) Dict with API options.</span>
<span class="sd">        :return: List of :class:`Entry &lt;contentful.entry.Entry&gt;` objects.</span>
<span class="sd">        :rtype: List of contentful.entry.Entry</span>

<span class="sd">        Usage:</span>
<span class="sd">            &gt;&gt;&gt; entries = entry.incoming_references(client)</span>
<span class="sd">            [&lt;Entry[cat] id=&#39;happycat&#39;&gt;]</span>
<span class="sd">        &quot;&quot;&quot;</span>

        <span class="k">if</span> <span class="n">client</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
            <span class="k">return</span> <span class="kc">False</span>

        <span class="n">query</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="s1">&#39;links_to_entry&#39;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">})</span>
        <span class="k">return</span> <span class="n">client</span><span class="o">.</span><span class="n">entries</span><span class="p">(</span><span class="n">query</span><span class="p">)</span></div>

    <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="k">return</span> <span class="s2">&quot;&lt;Entry[</span><span class="si">{0}</span><span class="s2">] id=&#39;</span><span class="si">{1}</span><span class="s2">&#39;&gt;&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">sys</span><span class="p">[</span><span class="s1">&#39;content_type&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">sys</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;id&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">),</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">sys</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;id&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span>
        <span class="p">)</span></div>
</pre></div>

          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper"><div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../../index.html">Documentation overview</a><ul>
  <li><a href="../index.html">Module code</a><ul>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="../../search.html" method="get">
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2016, Contentful GmbH.
      
    </div>

    
    <a href="https://github.com/contentful/contentful.py" class="github">
        <img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"  class="github"/>
    </a>
    

  </body>
</html>