Hopiu/django-select2
1
0
Fork 0
mirror of https://github.com/Hopiu/django-select2.git synced 2026-03-20 07:10:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
django-select2/docs/_build/html/_modules/django_select2/util.html
AppleGrew (applegrew) be760d69c0 Version 3.1.2 doc n version no. update
2012-10-04 23:23:21 +05:30

365 lines
No EOL
28 KiB
HTML
Raw Blame History

<!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>django_select2.util &mdash; Django-Select2 3.1.2 documentation</title>
<link rel="stylesheet" href="../../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '3.1.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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="top" title="Django-Select2 3.1.2 documentation" href="../../index.html" />
<link rel="up" title="Module code" href="../index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../index.html">Django-Select2 3.1.2 documentation</a> &raquo;</li>
<li><a href="../index.html" accesskey="U">Module code</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for django_select2.util</h1><div class="highlight"><pre>
<span class="kn">import</span> <span class="nn">types</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">from</span> <span class="nn">django.utils.html</span> <span class="kn">import</span> <span class="n">escape</span>
<span class="kn">from</span> <span class="nn">django.utils.encoding</span> <span class="kn">import</span> <span class="n">force_unicode</span>
<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="n">__name__</span><span class="p">)</span>
<div class="viewcode-block" id="JSVar"><a class="viewcode-back" href="../../ref_util.html#django_select2.util.JSVar">[docs]</a><span class="k">class</span> <span class="nc">JSVar</span><span class="p">(</span><span class="nb">unicode</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> A JS variable.</span>
<span class="sd"> This is a simple unicode string. This class type acts as a marker that this string is a JS variable name,</span>
<span class="sd"> so it must not be quoted by :py:func:`.convert_py_to_js_data` while rendering the JS code.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">pass</span>
</div>
<div class="viewcode-block" id="JSFunction"><a class="viewcode-back" href="../../ref_util.html#django_select2.util.JSFunction">[docs]</a><span class="k">class</span> <span class="nc">JSFunction</span><span class="p">(</span><span class="n">JSVar</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> A JS function name.</span>
<span class="sd"> From rendering point of view, rendering this is no different from :py:class:`JSVar`. After all, a JS varible</span>
<span class="sd"> can refer a function instance, primitive constant or any other object. They are still all varibles.</span>
<span class="sd"> .. tip:: Do use this marker for JS functions. This will make the code clearer, and the purpose more easier to</span>
<span class="sd"> understand.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">pass</span>
</div>
<div class="viewcode-block" id="JSFunctionInContext"><a class="viewcode-back" href="../../ref_util.html#django_select2.util.JSFunctionInContext">[docs]</a><span class="k">class</span> <span class="nc">JSFunctionInContext</span><span class="p">(</span><span class="n">JSVar</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> A JS function name to run in context of some other Html DOM element.</span>
<span class="sd"> Like :py:class:JSFunction`, this too flags the string as JS function, but with a special requirement. The JS function</span>
<span class="sd"> needs to be invoked in the context of a Html DOM, such that, ``this`` inside the function refers to that DOM instead of</span>
<span class="sd"> ``window``.</span>
<span class="sd"> .. tip:: JS functions of this type are warapped inside special another JS function -- ``django_select2.runInContextHelper``.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">pass</span>
</div>
<div class="viewcode-block" id="render_js_script"><a class="viewcode-back" href="../../ref_util.html#django_select2.util.render_js_script">[docs]</a><span class="k">def</span> <span class="nf">render_js_script</span><span class="p">(</span><span class="n">inner_code</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> This wraps ``inner_code`` string inside the following code block::</span>
<span class="sd"> &lt;script&gt;</span>
<span class="sd"> $(function () {</span>
<span class="sd"> // inner_code here</span>
<span class="sd"> });</span>
<span class="sd"> &lt;/script&gt;</span>
<span class="sd"> :rtype: :py:obj:`unicode`</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="s">u&quot;&quot;&quot;</span>
<span class="s"> &lt;script&gt;</span>
<span class="s"> $(function () {</span>
<span class="s"> </span><span class="si">%s</span><span class="s"></span>
<span class="s"> });</span>
<span class="s"> &lt;/script&gt;&quot;&quot;&quot;</span> <span class="o">%</span> <span class="n">inner_code</span>
</div>
<div class="viewcode-block" id="extract_some_key_val"><a class="viewcode-back" href="../../ref_util.html#django_select2.util.extract_some_key_val">[docs]</a><span class="k">def</span> <span class="nf">extract_some_key_val</span><span class="p">(</span><span class="n">dct</span><span class="p">,</span> <span class="n">keys</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Gets a sub-set of a :py:obj:`dict`.</span>
<span class="sd"> :param dct: Source dictionary.</span>
<span class="sd"> :type dct: :py:obj:`dict`</span>
<span class="sd"> :param keys: List of subset keys, which to extract from ``dct``.</span>
<span class="sd"> :type keys: :py:obj:`list` or any iterable.</span>
<span class="sd"> :rtype: :py:obj:`dict`</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">edct</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">keys</span><span class="p">:</span>
<span class="n">v</span> <span class="o">=</span> <span class="n">dct</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">v</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">edct</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">v</span>
<span class="k">return</span> <span class="n">edct</span>
</div>
<div class="viewcode-block" id="convert_py_to_js_data"><a class="viewcode-back" href="../../ref_util.html#django_select2.util.convert_py_to_js_data">[docs]</a><span class="k">def</span> <span class="nf">convert_py_to_js_data</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="n">id_</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Converts Python data type to JS data type.</span>
<span class="sd"> Practically what this means is, convert ``False`` to ``false``, ``True`` to ``true`` and so on.</span>
<span class="sd"> It also takes care of the conversion of :py:class:`.JSVar`, :py:class:`.JSFunction`</span>
<span class="sd"> and :py:class:`.JSFunctionInContext`. It takes care of recursively converting lists and dictionaries</span>
<span class="sd"> too.</span>
<span class="sd"> :param val: The Python data to convert.</span>
<span class="sd"> :type val: Any</span>
<span class="sd"> :param id_: The DOM id of the element in which context :py:class:`.JSFunctionInContext` functions</span>
<span class="sd"> should run. (This is not needed if ``val`` contains no :py:class:`.JSFunctionInContext`)</span>
<span class="sd"> :type id_: :py:obj:`str`</span>
<span class="sd"> :rtype: :py:obj:`unicode`</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">val</span><span class="p">)</span> <span class="o">==</span> <span class="n">types</span><span class="o">.</span><span class="n">BooleanType</span><span class="p">:</span>
<span class="k">return</span> <span class="s">u&#39;true&#39;</span> <span class="k">if</span> <span class="n">val</span> <span class="k">else</span> <span class="s">u&#39;false&#39;</span>
<span class="k">elif</span> <span class="nb">type</span><span class="p">(</span><span class="n">val</span><span class="p">)</span> <span class="ow">in</span> <span class="p">[</span><span class="n">types</span><span class="o">.</span><span class="n">IntType</span><span class="p">,</span> <span class="n">types</span><span class="o">.</span><span class="n">LongType</span><span class="p">,</span> <span class="n">types</span><span class="o">.</span><span class="n">FloatType</span><span class="p">]:</span>
<span class="k">return</span> <span class="n">force_unicode</span><span class="p">(</span><span class="n">val</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="n">JSFunctionInContext</span><span class="p">):</span>
<span class="k">return</span> <span class="s">u&quot;django_select2.runInContextHelper(</span><span class="si">%s</span><span class="s">, &#39;</span><span class="si">%s</span><span class="s">&#39;)&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="n">id_</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="n">JSVar</span><span class="p">):</span>
<span class="k">return</span> <span class="n">val</span> <span class="c"># No quotes here</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">dict</span><span class="p">):</span>
<span class="k">return</span> <span class="n">convert_dict_to_js_map</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="n">id_</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">list</span><span class="p">):</span>
<span class="k">return</span> <span class="n">convert_to_js_arr</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="n">id_</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="s">u&quot;&#39;</span><span class="si">%s</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="n">force_unicode</span><span class="p">(</span><span class="n">val</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="convert_dict_to_js_map"><a class="viewcode-back" href="../../ref_util.html#django_select2.util.convert_dict_to_js_map">[docs]</a><span class="k">def</span> <span class="nf">convert_dict_to_js_map</span><span class="p">(</span><span class="n">dct</span><span class="p">,</span> <span class="n">id_</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Converts a Python dictionary to JS map.</span>
<span class="sd"> :param dct: The Python dictionary to convert.</span>
<span class="sd"> :type dct: :py:obj:`dict`</span>
<span class="sd"> :param id_: The DOM id of the element in which context :py:class:`.JSFunctionInContext` functions</span>
<span class="sd"> should run. (This is not needed if ``dct`` contains no :py:class:`.JSFunctionInContext`)</span>
<span class="sd"> :type id_: :py:obj:`str`</span>
<span class="sd"> :rtype: :py:obj:`unicode`</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">out</span> <span class="o">=</span> <span class="s">u&#39;{&#39;</span>
<span class="n">is_first</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">dct</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">is_first</span><span class="p">:</span>
<span class="n">out</span> <span class="o">+=</span> <span class="s">u&quot;, &quot;</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">is_first</span> <span class="o">=</span> <span class="bp">False</span>
<span class="n">out</span> <span class="o">+=</span> <span class="s">u&quot;&#39;</span><span class="si">%s</span><span class="s">&#39;: &quot;</span> <span class="o">%</span> <span class="n">name</span>
<span class="n">out</span> <span class="o">+=</span> <span class="n">convert_py_to_js_data</span><span class="p">(</span><span class="n">dct</span><span class="p">[</span><span class="n">name</span><span class="p">],</span> <span class="n">id_</span><span class="p">)</span>
<span class="k">return</span> <span class="n">out</span> <span class="o">+</span> <span class="s">u&#39;}&#39;</span>
</div>
<div class="viewcode-block" id="convert_to_js_arr"><a class="viewcode-back" href="../../ref_util.html#django_select2.util.convert_to_js_arr">[docs]</a><span class="k">def</span> <span class="nf">convert_to_js_arr</span><span class="p">(</span><span class="n">lst</span><span class="p">,</span> <span class="n">id_</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Converts a Python list (or any iterable) to JS array.</span>
<span class="sd"> :param lst: The Python iterable to convert.</span>
<span class="sd"> :type lst: :py:obj:`list` or Any iterable</span>
<span class="sd"> :param id_: The DOM id of the element in which context :py:class:`.JSFunctionInContext` functions</span>
<span class="sd"> should run. (This is not needed if ``lst`` contains no :py:class:`.JSFunctionInContext`)</span>
<span class="sd"> :type id_: :py:obj:`str`</span>
<span class="sd"> :rtype: :py:obj:`unicode`</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">out</span> <span class="o">=</span> <span class="s">u&#39;[&#39;</span>
<span class="n">is_first</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">for</span> <span class="n">val</span> <span class="ow">in</span> <span class="n">lst</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">is_first</span><span class="p">:</span>
<span class="n">out</span> <span class="o">+=</span> <span class="s">u&quot;, &quot;</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">is_first</span> <span class="o">=</span> <span class="bp">False</span>
<span class="n">out</span> <span class="o">+=</span> <span class="n">convert_py_to_js_data</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="n">id_</span><span class="p">)</span>
<span class="k">return</span> <span class="n">out</span> <span class="o">+</span> <span class="s">u&#39;]&#39;</span>
</div>
<div class="viewcode-block" id="convert_to_js_string_arr"><a class="viewcode-back" href="../../ref_util.html#django_select2.util.convert_to_js_string_arr">[docs]</a><span class="k">def</span> <span class="nf">convert_to_js_string_arr</span><span class="p">(</span><span class="n">lst</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Converts a Python list (or any iterable) of strings to JS array.</span>
<span class="sd"> :py:func:`convert_to_js_arr` can always be used instead of this. However, since it</span>
<span class="sd"> knows that it only contains strings, it cuts down on unnecessary computations.</span>
<span class="sd"> :rtype: :py:obj:`unicode`</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">lst</span> <span class="o">=</span> <span class="p">[</span><span class="s">u&#39;&quot;</span><span class="si">%s</span><span class="s">&quot;&#39;</span> <span class="o">%</span> <span class="n">force_unicode</span><span class="p">(</span><span class="n">l</span><span class="p">)</span> <span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">lst</span><span class="p">]</span>
<span class="k">return</span> <span class="s">u&quot;[</span><span class="si">%s</span><span class="s">]&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="s">&quot;,&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">lst</span><span class="p">))</span>
<span class="c">### Auto view helper utils ###</span>
</div>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">import</span> <span class="nn">threading</span>
<span class="kn">import</span> <span class="nn">datetime</span>
<div class="viewcode-block" id="synchronized"><a class="viewcode-back" href="../../ref_util.html#django_select2.util.synchronized">[docs]</a><span class="k">def</span> <span class="nf">synchronized</span><span class="p">(</span><span class="n">f</span><span class="p">):</span>
<span class="s">&quot;Decorator to synchronize multiple calls to a functions.&quot;</span>
<span class="n">f</span><span class="o">.</span><span class="n">__lock__</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Lock</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">synced_f</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">with</span> <span class="n">f</span><span class="o">.</span><span class="n">__lock__</span><span class="p">:</span>
<span class="k">return</span> <span class="n">f</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="n">synced_f</span><span class="o">.</span><span class="n">__doc__</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">__doc__</span>
<span class="k">return</span> <span class="n">synced_f</span>
</div>
<span class="n">__id_store</span> <span class="o">=</span> <span class="p">{}</span> <span class="c"># Generated Id to field instance mapping.</span>
<span class="n">__field_store</span> <span class="o">=</span> <span class="p">{}</span> <span class="c"># Field&#39;s key to generated Id mapping.</span>
<span class="n">ID_PATTERN</span> <span class="o">=</span> <span class="s">r&quot;[0-9_a-zA-Z.:+\- ]+&quot;</span>
<div class="viewcode-block" id="is_valid_id"><a class="viewcode-back" href="../../ref_util.html#django_select2.util.is_valid_id">[docs]</a><span class="k">def</span> <span class="nf">is_valid_id</span><span class="p">(</span><span class="n">val</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Checks if ``val`` is a valid generated Id.</span>
<span class="sd"> :param val: The value to check.</span>
<span class="sd"> :type val: :py:obj:`str`</span>
<span class="sd"> :rtype: :py:obj:`bool`</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">regex</span> <span class="o">=</span> <span class="s">&quot;^</span><span class="si">%s</span><span class="s">$&quot;</span> <span class="o">%</span> <span class="n">ID_PATTERN</span>
<span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">regex</span><span class="p">,</span> <span class="n">val</span><span class="p">)</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">True</span>
</div>
<span class="nd">@synchronized</span>
<div class="viewcode-block" id="register_field"><a class="viewcode-back" href="../../ref_util.html#django_select2.util.register_field">[docs]</a><span class="k">def</span> <span class="nf">register_field</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">field</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Registers an Auto field for use with :py:class:`.views.AutoResponseView`.</span>
<span class="sd"> :param key: The key to use while registering this field.</span>
<span class="sd"> :type key: :py:obj:`unicode`</span>
<span class="sd"> :param field: The field to register.</span>
<span class="sd"> :type field: :py:class:`AutoViewFieldMixin`</span>
<span class="sd"> :return: The generated Id for this field. If given ``key`` was already registered then the</span>
<span class="sd"> Id generated that time, would be returned.</span>
<span class="sd"> :rtype: :py:obj:`unicode`</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">global</span> <span class="n">__id_store</span><span class="p">,</span> <span class="n">__field_store</span>
<span class="kn">from</span> <span class="nn">fields</span> <span class="kn">import</span> <span class="n">AutoViewFieldMixin</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">field</span><span class="p">,</span> <span class="n">AutoViewFieldMixin</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">&#39;Field must extend AutoViewFieldMixin&#39;</span><span class="p">)</span>
<span class="k">if</span> <span class="n">key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">__field_store</span><span class="p">:</span>
<span class="c"># Generating id</span>
<span class="n">id_</span> <span class="o">=</span> <span class="s">u&quot;</span><span class="si">%d</span><span class="s">:</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">__id_store</span><span class="p">),</span> <span class="nb">unicode</span><span class="p">(</span><span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()))</span>
<span class="n">__field_store</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">id_</span>
<span class="n">__id_store</span><span class="p">[</span><span class="n">id_</span><span class="p">]</span> <span class="o">=</span> <span class="n">field</span>
<span class="k">if</span> <span class="n">logger</span><span class="o">.</span><span class="n">isEnabledFor</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">):</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;Registering new field: </span><span class="si">%s</span><span class="s">; With actual id: </span><span class="si">%s</span><span class="s">&quot;</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">id_</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">id_</span> <span class="o">=</span> <span class="n">__field_store</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
<span class="k">if</span> <span class="n">logger</span><span class="o">.</span><span class="n">isEnabledFor</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">):</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s">&quot;Field already registered: </span><span class="si">%s</span><span class="s">; With actual id: </span><span class="si">%s</span><span class="s">&quot;</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">id_</span><span class="p">)</span>
<span class="k">return</span> <span class="n">id_</span>
</div>
<div class="viewcode-block" id="get_field"><a class="viewcode-back" href="../../ref_util.html#django_select2.util.get_field">[docs]</a><span class="k">def</span> <span class="nf">get_field</span><span class="p">(</span><span class="n">id_</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Returns an Auto field instance registered with the given Id.</span>
<span class="sd"> :param id_: The generated Id the field is registered with.</span>
<span class="sd"> :type id_: :py:obj:`unicode`</span>
<span class="sd"> :rtype: :py:class:`AutoViewFieldMixin` or None</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">__id_store</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">id_</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
</pre></div></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../index.html">Django-Select2 3.1.2 documentation</a> &raquo;</li>
<li><a href="../index.html" >Module code</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2012, Nirupam Biswas.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink