/usr/share/doc/python-django-modeltranslation/html/caveats.html is in python-django-modeltranslation-doc 0.12.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 | <!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>Caveats — django-modeltranslation 0.12.2 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.12.2',
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="next" title="How to Contribute" href="contribute.html" />
<link rel="prev" title="Management Commands" href="commands.html" />
</head>
<body>
<div class="related" role="navigation" aria-label="related navigation">
<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="contribute.html" title="How to Contribute"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="commands.html" title="Management Commands"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">django-modeltranslation 0.12.2 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="caveats">
<span id="id1"></span><h1>Caveats<a class="headerlink" href="#caveats" title="Permalink to this headline">¶</a></h1>
<div class="section" id="accessing-translated-fields-outside-views">
<h2>Accessing Translated Fields Outside Views<a class="headerlink" href="#accessing-translated-fields-outside-views" title="Permalink to this headline">¶</a></h2>
<p>Since the modeltranslation mechanism relies on the current language as it
is returned by the <code class="docutils literal"><span class="pre">get_language</span></code> function care must be taken when accessing
translated fields outside a view function.</p>
<p>Within a view function the language is set by Django based on a flexible model
described at <a class="reference external" href="https://docs.djangoproject.com/en/dev/topics/i18n/translation/#how-django-discovers-language-preference">How Django discovers language preference</a> which is normally used
only by Django’s static translation system.</p>
<p>When a translated field is accessed in a view function or in a template, it
uses the <code class="docutils literal"><span class="pre">django.utils.translation.get_language</span></code> function to determine the
current language and return the appropriate value.</p>
<p>Outside a view (or a template), i.e. in normal Python code, a call to the
<code class="docutils literal"><span class="pre">get_language</span></code> function still returns a value, but it might not what you
expect. Since no request is involved, Django’s machinery for discovering the
user’s preferred language is not activated. For this reason modeltranslation
adds a thin wrapper (<code class="docutils literal"><span class="pre">modeltranslation.utils.get_language</span></code>) around the function
which guarantees that the returned language is listed in the <code class="docutils literal"><span class="pre">LANGUAGES</span></code> setting.</p>
<p>The unittests use the <code class="docutils literal"><span class="pre">django.utils.translation.trans_real</span></code> functions to
activate and deactive a specific language outside a view function.</p>
</div>
<div class="section" id="using-in-combination-with-django-audit-log">
<h2>Using in combination with <code class="docutils literal"><span class="pre">django-audit-log</span></code><a class="headerlink" href="#using-in-combination-with-django-audit-log" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal"><span class="pre">django-audit-log</span></code> is a package that allows you to track changes to your
model instances (<a class="reference external" href="https://django-audit-log.readthedocs.io/">documentation</a>). As <code class="docutils literal"><span class="pre">django-audit-log</span></code> behind the scenes
automatically creates “shadow” models for your tracked models, you have to
remember to register these shadow models for translation as well as your
regular models. Here’s an example:</p>
<div class="code python highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">modeltranslation.translator</span> <span class="k">import</span> <span class="n">register</span><span class="p">,</span> <span class="n">TranslationOptions</span>
<span class="kn">from</span> <span class="nn">my_app</span> <span class="k">import</span> <span class="n">models</span>
<span class="nd">@register</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">MyModel</span><span class="p">)</span>
<span class="nd">@register</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">MyModel</span><span class="o">.</span><span class="n">audit_log</span><span class="o">.</span><span class="n">model</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">MyModelTranslationOptions</span><span class="p">(</span><span class="n">TranslationOptions</span><span class="p">):</span>
<span class="sd">"""Translation options for MyModel."""</span>
<span class="n">fields</span> <span class="o">=</span> <span class="p">(</span>
<span class="s1">'text'</span><span class="p">,</span>
<span class="s1">'title'</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
<p>If you forget to register the shadow models, you will get an error like:</p>
<div class="code highlight-default"><div class="highlight"><pre><span></span><span class="ne">TypeError</span><span class="p">:</span> <span class="s1">'text_es'</span> <span class="ow">is</span> <span class="n">an</span> <span class="n">invalid</span> <span class="n">keyword</span> <span class="n">argument</span> <span class="k">for</span> <span class="n">this</span> <span class="n">function</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Caveats</a><ul>
<li><a class="reference internal" href="#accessing-translated-fields-outside-views">Accessing Translated Fields Outside Views</a></li>
<li><a class="reference internal" href="#using-in-combination-with-django-audit-log">Using in combination with <code class="docutils literal"><span class="pre">django-audit-log</span></code></a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="commands.html"
title="previous chapter">Management Commands</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="contribute.html"
title="next chapter">How to Contribute</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/caveats.rst.txt"
rel="nofollow">Show Source</a></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="related" role="navigation" aria-label="related navigation">
<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="contribute.html" title="How to Contribute"
>next</a> |</li>
<li class="right" >
<a href="commands.html" title="Management Commands"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">django-modeltranslation 0.12.2 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2009-2018, Peter Eschler, Dirk Eschler, Jacek Tomaszewski.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.7.
</div>
</body>
</html>
|