Deploying to gh-pages from @ ba386c2 🚀

Author: eemeli

fluent.runtime/dev/_modules/fluent/runtime/fallback.html

@@ -53,6 +53,7 @@ <h1>Source code for fluent.runtime.fallback</h1><div class="highlight"><pre>
 <span class="p">)</span>
 
 <span class="kn">from</span> <span class="nn">fluent.syntax</span> <span class="kn">import</span> <span class="n">FluentParser</span>
+<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">NamedTuple</span>
 
 <span class="kn">from</span> <span class="nn">.bundle</span> <span class="kn">import</span> <span class="n">FluentBundle</span>
 
@@ -62,6 +63,11 @@ <h1>Source code for fluent.runtime.fallback</h1><div class="highlight"><pre>
     <span class="kn">from</span> <span class="nn">.types</span> <span class="kn">import</span> <span class="n">FluentType</span>
 
 
+<div class="viewcode-block" id="FormattedMessage"><a class="viewcode-back" href="../../../reference.html#fluent.runtime.FormattedMessage">[docs]</a><span class="k">class</span> <span class="nc">FormattedMessage</span><span class="p">(</span><span class="n">NamedTuple</span><span class="p">):</span>
+    <span class="n">value</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="kc">None</span><span class="p">]</span>
+    <span class="n">attributes</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span></div>
+
+
 <div class="viewcode-block" id="FluentLocalization"><a class="viewcode-back" href="../../../reference.html#fluent.runtime.FluentLocalization">[docs]</a><span class="k">class</span> <span class="nc">FluentLocalization</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Generic API for Fluent applications.</span>
@@ -88,20 +94,47 @@ <h1>Source code for fluent.runtime.fallback</h1><div class="highlight"><pre>
         <span class="bp">self</span><span class="o">.</span><span class="n">_bundle_cache</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">FluentBundle</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_bundle_it</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_iterate_bundles</span><span class="p">()</span>
 
+    <span class="k">def</span> <span class="nf">format_message</span><span class="p">(</span>
+        <span class="bp">self</span><span class="p">,</span> <span class="n">msg_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">args</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">],</span> <span class="kc">None</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
+    <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">FormattedMessage</span><span class="p">:</span>
+        <span class="n">bundle</span><span class="p">,</span> <span class="n">msg</span> <span class="o">=</span> <span class="nb">next</span><span class="p">((</span>
+            <span class="p">(</span><span class="n">bundle</span><span class="p">,</span> <span class="n">bundle</span><span class="o">.</span><span class="n">get_message</span><span class="p">(</span><span class="n">msg_id</span><span class="p">))</span>
+            <span class="k">for</span> <span class="n">bundle</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_bundles</span><span class="p">()</span>
+            <span class="k">if</span> <span class="n">bundle</span><span class="o">.</span><span class="n">has_message</span><span class="p">(</span><span class="n">msg_id</span><span class="p">)</span>
+        <span class="p">),</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">))</span>
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">bundle</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">msg</span><span class="p">:</span>
+            <span class="k">return</span> <span class="n">FormattedMessage</span><span class="p">(</span><span class="n">msg_id</span><span class="p">,</span> <span class="p">{})</span>
+        <span class="n">formatted_attrs</span> <span class="o">=</span> <span class="p">{</span>
+            <span class="n">attr</span><span class="p">:</span> <span class="n">cast</span><span class="p">(</span>
+                <span class="nb">str</span><span class="p">,</span>
+                <span class="n">bundle</span><span class="o">.</span><span class="n">format_pattern</span><span class="p">(</span><span class="n">msg</span><span class="o">.</span><span class="n">attributes</span><span class="p">[</span><span class="n">attr</span><span class="p">],</span> <span class="n">args</span><span class="p">)[</span><span class="mi">0</span><span class="p">],</span>
+            <span class="p">)</span>
+            <span class="k">for</span> <span class="n">attr</span> <span class="ow">in</span> <span class="n">msg</span><span class="o">.</span><span class="n">attributes</span>
+        <span class="p">}</span>
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">msg</span><span class="o">.</span><span class="n">value</span><span class="p">:</span>
+            <span class="n">val</span> <span class="o">=</span> <span class="kc">None</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="n">val</span><span class="p">,</span> <span class="n">_errors</span> <span class="o">=</span> <span class="n">bundle</span><span class="o">.</span><span class="n">format_pattern</span><span class="p">(</span><span class="n">msg</span><span class="o">.</span><span class="n">value</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span>
+        <span class="k">return</span> <span class="n">FormattedMessage</span><span class="p">(</span>
+            <span class="c1"># Never FluentNone when format_pattern called externally</span>
+            <span class="n">cast</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">val</span><span class="p">),</span>
+            <span class="n">formatted_attrs</span><span class="p">,</span>
+        <span class="p">)</span>
+
     <span class="k">def</span> <span class="nf">format_value</span><span class="p">(</span>
         <span class="bp">self</span><span class="p">,</span> <span class="n">msg_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">args</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">],</span> <span class="kc">None</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
     <span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
-        <span class="k">for</span> <span class="n">bundle</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_bundles</span><span class="p">():</span>
-            <span class="k">if</span> <span class="ow">not</span> <span class="n">bundle</span><span class="o">.</span><span class="n">has_message</span><span class="p">(</span><span class="n">msg_id</span><span class="p">):</span>
-                <span class="k">continue</span>
-            <span class="n">msg</span> <span class="o">=</span> <span class="n">bundle</span><span class="o">.</span><span class="n">get_message</span><span class="p">(</span><span class="n">msg_id</span><span class="p">)</span>
-            <span class="k">if</span> <span class="ow">not</span> <span class="n">msg</span><span class="o">.</span><span class="n">value</span><span class="p">:</span>
-                <span class="k">continue</span>
-            <span class="n">val</span><span class="p">,</span> <span class="n">_errors</span> <span class="o">=</span> <span class="n">bundle</span><span class="o">.</span><span class="n">format_pattern</span><span class="p">(</span><span class="n">msg</span><span class="o">.</span><span class="n">value</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span>
-            <span class="k">return</span> <span class="n">cast</span><span class="p">(</span>
-                <span class="nb">str</span><span class="p">,</span> <span class="n">val</span>
-            <span class="p">)</span>  <span class="c1"># Never FluentNone when format_pattern called externally</span>
-        <span class="k">return</span> <span class="n">msg_id</span>
+        <span class="n">bundle</span><span class="p">,</span> <span class="n">msg</span> <span class="o">=</span> <span class="nb">next</span><span class="p">((</span>
+            <span class="p">(</span><span class="n">bundle</span><span class="p">,</span> <span class="n">bundle</span><span class="o">.</span><span class="n">get_message</span><span class="p">(</span><span class="n">msg_id</span><span class="p">))</span>
+            <span class="k">for</span> <span class="n">bundle</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_bundles</span><span class="p">()</span>
+            <span class="k">if</span> <span class="n">bundle</span><span class="o">.</span><span class="n">has_message</span><span class="p">(</span><span class="n">msg_id</span><span class="p">)</span>
+        <span class="p">),</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">))</span>
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">bundle</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">msg</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">msg</span><span class="o">.</span><span class="n">value</span><span class="p">:</span>
+            <span class="k">return</span> <span class="n">msg_id</span>
+        <span class="n">val</span><span class="p">,</span> <span class="n">_errors</span> <span class="o">=</span> <span class="n">bundle</span><span class="o">.</span><span class="n">format_pattern</span><span class="p">(</span><span class="n">msg</span><span class="o">.</span><span class="n">value</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span>
+        <span class="k">return</span> <span class="n">cast</span><span class="p">(</span>
+            <span class="nb">str</span><span class="p">,</span> <span class="n">val</span>
+        <span class="p">)</span>  <span class="c1"># Never FluentNone when format_pattern called externally</span>
 
     <span class="k">def</span> <span class="nf">_create_bundle</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">locales</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">FluentBundle</span><span class="p">:</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">bundle_class</span><span class="p">(</span>

fluent.runtime/dev/_sources/usage.rst.txt

@@ -272,6 +272,41 @@ instances to indicate an error or missing data. Otherwise they should
 return unicode strings, or instances of a ``FluentType`` subclass as
 above.
 
+Attributes
+~~~~~~~~~~
+When rendering UI elements, it's handy to have a single translation that
+contains everything you need in one variable. For example, a HTML
+form input may have a value, but also a placeholder attribute, aria-label
+attribute, and maybe a title attribute.
+
+.. code-block:: python
+
+    >>> l10n = DemoLocalization("""
+    ... login-input = Predefined value
+    ...     .placeholder = { $email }
+    ...     .aria-label = Login input value
+    ...     .title = Type your login email
+    ... """)
+    >>> value, attributes = l10n.format_message(
+    ...     "login-input", {"email": "email@example.com"}
+    ... )
+    >>> value
+    'Predefined value'
+    >>> attributes
+    {'placeholder': 'email@example.com', 'aria-label': 'Login input value', 'title': 'Type your login email'}
+  
+You can also use the formatted message without unpacking it.
+
+.. code-block:: python
+
+    >>> fmt_msg = l10n.format_message(
+    ...     "login-input", {"email": "email@example.com"}
+    ... )
+    >>> fmt_msg.value
+    'Predefined value'
+    >>> fmt_msg.attributes
+    {'placeholder': 'email@example.com', 'aria-label': 'Login input value', 'title': 'Type your login email'}
+
 Known limitations and bugs
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 

fluent.runtime/dev/genindex.html

@@ -44,12 +44,17 @@ <h1 id="index">Index</h1>
  | <a href="#F"><strong>F</strong></a>
  | <a href="#M"><strong>M</strong></a>
  | <a href="#R"><strong>R</strong></a>
+ | <a href="#V"><strong>V</strong></a>
 
 </div>
 <h2 id="A">A</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="reference.html#fluent.runtime.AbstractResourceLoader">AbstractResourceLoader (class in fluent.runtime)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="reference.html#fluent.runtime.FormattedMessage.attributes">attributes (fluent.runtime.FormattedMessage attribute)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -64,13 +69,15 @@ <h2 id="F">F</h2>
         <li><a href="reference.html#module-fluent.runtime">module</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="reference.html#fluent.runtime.FluentBundle">FluentBundle (class in fluent.runtime)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="reference.html#fluent.runtime.FluentLocalization">FluentLocalization (class in fluent.runtime)</a>
 </li>
       <li><a href="reference.html#fluent.runtime.FluentResourceLoader">FluentResourceLoader (class in fluent.runtime)</a>
+</li>
+      <li><a href="reference.html#fluent.runtime.FormattedMessage">FormattedMessage (class in fluent.runtime)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -100,6 +107,14 @@ <h2 id="R">R</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="V">V</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="reference.html#fluent.runtime.FormattedMessage.value">value (fluent.runtime.FormattedMessage attribute)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 
 
             <div class="clearer"></div>

fluent.runtime/dev/objects.inv

@@ -2,4 +2,4 @@
 # Project: fluent.runtime
 # Version: 
 # The remainder of this file is compressed using zlib.
-xڥR�j�0��+��W��[Z(R0)�gEZ?`-�uO���^���e7V4m/B���g�"���k�v�~��	�,VhQK,��u��ȳ*�;+��"o%n�Ph^�3,N�.�(���3t�Q�=�;����ʍ���7�Z����O�.�F�j���N-I� _��<X�YӲ3����m�"��F2uv4y3�$i��8�|�0��8y��	�k�wħ�H�9�Z����T'�dau�d���-���tf�de��S��`��ӂU���e���&�T�"�)�KQc�9�s�
��gnu}�HEj(
+xڥ�AN�0E�9�l�mw	�R+UE��kOK�]yƈ��\����IG�(e����e2�ڃ��yC�
�o獕^�gJp`55�6��˳2	��ザ��;
+�%�Kh��fS�Ō��%v�
�V^�{��o���5�++�V��5���3�s��a]É@�
�W�$]�©���DZ��ƃ�NF	�I�5߁f��j�c��cV+$���(�8�z)�kn*ж�N��7b��6\�,����/d�� v�q@H\�)	�-��#p�kL3�8�-'�d�6��ɾ͇��X���3:�%�iÂ�4}�1�ӿ��%�R�����WE-����&�B���;!�^P�j:����]

fluent.runtime/dev/reference.html

@@ -106,6 +106,23 @@ <h3>Navigation</h3>
 See the documentation of the Fluent syntax for more information.</p>
 </dd></dl>
 
+<dl class="py class">
+<dt id="fluent.runtime.FormattedMessage">
+<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">fluent.runtime.</span></code><code class="sig-name descname"><span class="pre">FormattedMessage</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attributes</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/fluent/runtime/fallback.html#FormattedMessage"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#fluent.runtime.FormattedMessage" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="py attribute">
+<dt id="fluent.runtime.FormattedMessage.value">
+<code class="sig-name descname"><span class="pre">value</span></code><em class="property"><span class="pre">:</span> <span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#fluent.runtime.FormattedMessage.value" title="Permalink to this definition">¶</a></dt>
+<dd><p>Alias for field number 0</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt id="fluent.runtime.FormattedMessage.attributes">
+<code class="sig-name descname"><span class="pre">attributes</span></code><em class="property"><span class="pre">:</span> <span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#fluent.runtime.FormattedMessage.attributes" title="Permalink to this definition">¶</a></dt>
+<dd><p>Alias for field number 1</p>
+</dd></dl>
+
+</dd></dl>
+
 </div>