Add changes for 0c3b391

Contribution/Philosophy/AboutTime.ipynb

@@ -41,10 +41,10 @@
    "id": "703ed5c2",
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-02-02T14:03:11.757609Z",
-     "iopub.status.busy": "2024-02-02T14:03:11.757027Z",
-     "iopub.status.idle": "2024-02-02T14:03:11.759462Z",
-     "shell.execute_reply": "2024-02-02T14:03:11.759079Z"
+     "iopub.execute_input": "2024-02-02T14:52:12.284252Z",
+     "iopub.status.busy": "2024-02-02T14:52:12.283700Z",
+     "iopub.status.idle": "2024-02-02T14:52:12.286041Z",
+     "shell.execute_reply": "2024-02-02T14:52:12.285660Z"
     }
    },
    "outputs": [],
@@ -67,10 +67,10 @@
    "id": "5c1a4040",
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-02-02T14:03:11.761916Z",
-     "iopub.status.busy": "2024-02-02T14:03:11.761560Z",
-     "iopub.status.idle": "2024-02-02T14:03:11.763828Z",
-     "shell.execute_reply": "2024-02-02T14:03:11.763467Z"
+     "iopub.execute_input": "2024-02-02T14:52:12.288393Z",
+     "iopub.status.busy": "2024-02-02T14:52:12.288045Z",
+     "iopub.status.idle": "2024-02-02T14:52:12.290194Z",
+     "shell.execute_reply": "2024-02-02T14:52:12.289873Z"
     }
    },
    "outputs": [],

Reference/code.html

@@ -929,7 +929,7 @@
 
 <dl class="py data">
 <dt class="sig sig-object py" id="sarracenia.config.str_options">
-<span class="sig-prename descclassname"><span class="pre">sarracenia.config.</span></span><span class="sig-name descname"><span class="pre">str_options</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['action',</span> <span class="pre">'admin',</span> <span class="pre">'baseDir',</span> <span class="pre">'broker',</span> <span class="pre">'cluster',</span> <span class="pre">'directory',</span> <span class="pre">'exchange',</span> <span class="pre">'exchange_suffix',</span> <span class="pre">'feeder',</span> <span class="pre">'filename',</span> <span class="pre">'flatten',</span> <span class="pre">'flowMain',</span> <span class="pre">'header',</span> <span class="pre">'identity',</span> <span class="pre">'logLevel',</span> <span class="pre">'pollUrl',</span> <span class="pre">'post_baseUrl',</span> <span class="pre">'post_baseDir',</span> <span class="pre">'post_broker',</span> <span class="pre">'post_exchange',</span> <span class="pre">'post_exchangeSuffix',</span> <span class="pre">'post_format',</span> <span class="pre">'post_topic',</span> <span class="pre">'queueName',</span> <span class="pre">'sendTo',</span> <span class="pre">'rename',</span> <span class="pre">'report_exchange',</span> <span class="pre">'source',</span> <span class="pre">'strip',</span> <span class="pre">'timezone',</span> <span class="pre">'nodupe_ttl',</span> <span class="pre">'nodupe_driver',</span> <span class="pre">'nodupe_basis',</span> <span class="pre">'tlsRigour',</span> <span class="pre">'topic']</span></em><a class="headerlink" href="#sarracenia.config.str_options" title="Link to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">sarracenia.config.</span></span><span class="sig-name descname"><span class="pre">str_options</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['action',</span> <span class="pre">'admin',</span> <span class="pre">'baseDir',</span> <span class="pre">'broker',</span> <span class="pre">'cluster',</span> <span class="pre">'directory',</span> <span class="pre">'exchange',</span> <span class="pre">'exchange_suffix',</span> <span class="pre">'feeder',</span> <span class="pre">'filename',</span> <span class="pre">'flatten',</span> <span class="pre">'flowMain',</span> <span class="pre">'header',</span> <span class="pre">'identity',</span> <span class="pre">'inlineEncoding',</span> <span class="pre">'logLevel',</span> <span class="pre">'pollUrl',</span> <span class="pre">'post_baseUrl',</span> <span class="pre">'post_baseDir',</span> <span class="pre">'post_broker',</span> <span class="pre">'post_exchange',</span> <span class="pre">'post_exchangeSuffix',</span> <span class="pre">'post_format',</span> <span class="pre">'post_topic',</span> <span class="pre">'queueName',</span> <span class="pre">'sendTo',</span> <span class="pre">'rename',</span> <span class="pre">'report_exchange',</span> <span class="pre">'source',</span> <span class="pre">'strip',</span> <span class="pre">'timezone',</span> <span class="pre">'nodupe_ttl',</span> <span class="pre">'nodupe_driver',</span> <span class="pre">'nodupe_basis',</span> <span class="pre">'tlsRigour',</span> <span class="pre">'topic']</span></em><a class="headerlink" href="#sarracenia.config.str_options" title="Link to this definition"></a></dt>
 <dd><p>for backward compatibility,</p>
 <p>convert some old plugins that are hard to get working with
 v2wrapper, into v3 plugin.</p>

Reference/sr3_options.7.html

@@ -944,7 +944,15 @@ <h4>inline &lt;flag&gt; (default: False)<a class="headerlink" href="#inline-flag
 </section>
 <section id="inlinebytemax-size">
 <h4>inlineByteMax &lt;size&gt;<a class="headerlink" href="#inlinebytemax-size" title="Link to this heading"></a></h4>
-<p>the maximums size of messages to inline.</p>
+<p>The maximum size of messages to inline.</p>
+<p>when inlining file content, what sort of encoding should be done? Three choices:</p>
+<blockquote>
+<div><ul class="simple">
+<li><p>text: the file content is assumed to be utf-8 text and encoded as such.</p></li>
+<li><p>binary: the file content is unconditionally converted to base64 binary encoding.</p></li>
+<li><p>guess: try making text, if that fails fall back to binary.</p></li>
+</ul>
+</div></blockquote>
 </section>
 <section id="inlineonly">
 <h4>inlineOnly<a class="headerlink" href="#inlineonly" title="Link to this heading"></a></h4>

_modules/sarracenia/config.html

@@ -249,7 +249,8 @@ <h1>Source code for sarracenia.config</h1><div class="highlight"><pre>
 
 <span class="n">str_options</span> <span class="o">=</span> <span class="p">[</span>
     <span class="s1">&#39;action&#39;</span><span class="p">,</span> <span class="s1">&#39;admin&#39;</span><span class="p">,</span> <span class="s1">&#39;baseDir&#39;</span><span class="p">,</span> <span class="s1">&#39;broker&#39;</span><span class="p">,</span> <span class="s1">&#39;cluster&#39;</span><span class="p">,</span> <span class="s1">&#39;directory&#39;</span><span class="p">,</span> <span class="s1">&#39;exchange&#39;</span><span class="p">,</span>
-    <span class="s1">&#39;exchange_suffix&#39;</span><span class="p">,</span> <span class="s1">&#39;feeder&#39;</span><span class="p">,</span> <span class="s1">&#39;filename&#39;</span><span class="p">,</span> <span class="s1">&#39;flatten&#39;</span><span class="p">,</span> <span class="s1">&#39;flowMain&#39;</span><span class="p">,</span> <span class="s1">&#39;header&#39;</span><span class="p">,</span> <span class="s1">&#39;identity&#39;</span><span class="p">,</span> <span class="s1">&#39;logLevel&#39;</span><span class="p">,</span> 
+    <span class="s1">&#39;exchange_suffix&#39;</span><span class="p">,</span> <span class="s1">&#39;feeder&#39;</span><span class="p">,</span> <span class="s1">&#39;filename&#39;</span><span class="p">,</span> <span class="s1">&#39;flatten&#39;</span><span class="p">,</span> <span class="s1">&#39;flowMain&#39;</span><span class="p">,</span> <span class="s1">&#39;header&#39;</span><span class="p">,</span> <span class="s1">&#39;identity&#39;</span><span class="p">,</span> 
+    <span class="s1">&#39;inlineEncoding&#39;</span><span class="p">,</span> <span class="s1">&#39;logLevel&#39;</span><span class="p">,</span> 
     <span class="s1">&#39;pollUrl&#39;</span><span class="p">,</span> <span class="s1">&#39;post_baseUrl&#39;</span><span class="p">,</span> <span class="s1">&#39;post_baseDir&#39;</span><span class="p">,</span> <span class="s1">&#39;post_broker&#39;</span><span class="p">,</span> <span class="s1">&#39;post_exchange&#39;</span><span class="p">,</span>
     <span class="s1">&#39;post_exchangeSuffix&#39;</span><span class="p">,</span> <span class="s1">&#39;post_format&#39;</span><span class="p">,</span> <span class="s1">&#39;post_topic&#39;</span><span class="p">,</span> <span class="s1">&#39;queueName&#39;</span><span class="p">,</span> <span class="s1">&#39;sendTo&#39;</span><span class="p">,</span> <span class="s1">&#39;rename&#39;</span><span class="p">,</span>
     <span class="s1">&#39;report_exchange&#39;</span><span class="p">,</span> <span class="s1">&#39;source&#39;</span><span class="p">,</span> <span class="s1">&#39;strip&#39;</span><span class="p">,</span> <span class="s1">&#39;timezone&#39;</span><span class="p">,</span> <span class="s1">&#39;nodupe_ttl&#39;</span><span class="p">,</span> <span class="s1">&#39;nodupe_driver&#39;</span><span class="p">,</span> 
@@ -2067,6 +2068,10 @@ <h1>Source code for sarracenia.config</h1><div class="highlight"><pre>
             <span class="bp">self</span><span class="o">.</span><span class="n">_resolve_exchange</span><span class="p">()</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">_resolveQueueName</span><span class="p">(</span><span class="n">component</span><span class="p">,</span><span class="n">cfg</span><span class="p">)</span>
 
+        <span class="n">valid_inlineEncodings</span> <span class="o">=</span> <span class="p">[</span> <span class="s1">&#39;guess&#39;</span><span class="p">,</span> <span class="s1">&#39;text&#39;</span><span class="p">,</span> <span class="s1">&#39;binary&#39;</span> <span class="p">]</span>
+        <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s1">&#39;inlineEncoding&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">inlineEncoding</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">valid_inlineEncodings</span><span class="p">:</span>
+            <span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span> <span class="sa">f</span><span class="s2">&quot;invalid inlineEncoding: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">inlineEncoding</span><span class="si">}</span><span class="s2"> must be one of: </span><span class="si">{</span><span class="s1">&#39;,&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">valid_inlineEncodings</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span> <span class="p">)</span>
+
         <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s1">&#39;no&#39;</span><span class="p">):</span>
             <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">statehost</span><span class="p">:</span>
                 <span class="n">hostdir</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">hostdir</span>

_sources/Reference/sr3_options.7.rst.txt

@@ -941,7 +941,17 @@ will not be posted.
 inlineByteMax <size>
 --------------------
 
-the maximums size of messages to inline.
+The maximum size of messages to inline.
+
+inlineEncoding text|binary|guess (default: guess)
+_________________________________________________
+
+when inlining file content, what sort of encoding should be done? Three choices:
+
+ * text: the file content is assumed to be utf-8 text and encoded as such.
+ * binary: the file content is unconditionally converted to base64 binary encoding.
+ * guess: try making text, if that fails fall back to binary.
+
 
 inlineOnly
 ----------

_sources/fr/Reference/sr3_options.7.rst.txt

@@ -926,6 +926,18 @@ inlineByteMax <taille>
 
 la taille maximale des fichiers dont le contenu est à inclure dans un messages d'annonce (envoyé inline.)
 
+
+
+inlineEncoding text|binary|guess (défaut: guess)
+_________________________________________________
+
+Quand on inclut les données dans le message on l'encode dans un format choisi:
+
+ * text: le fichier doit être du utf-8 valide (ou érreur.) 
+ * binary:  le fichier peut être encodé n'importe comment, il sera en format base64.
+ * guess: essaie le format text en premier, utilise binary en cas d'erreur.
+
+
 inlineOnly
 ----------
 ignorer les messages d´annonce si les données ne sont pas inline.

api-documentation.html

@@ -358,7 +358,7 @@ <h2>Config<a class="headerlink" href="#config" title="Link to this heading"><
 
 <dl class="py data">
 <dt class="sig sig-object py">
-<span class="sig-prename descclassname"><span class="pre">sarracenia.config.</span></span><span class="sig-name descname"><span class="pre">str_options</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['action',</span> <span class="pre">'admin',</span> <span class="pre">'baseDir',</span> <span class="pre">'broker',</span> <span class="pre">'cluster',</span> <span class="pre">'directory',</span> <span class="pre">'exchange',</span> <span class="pre">'exchange_suffix',</span> <span class="pre">'feeder',</span> <span class="pre">'filename',</span> <span class="pre">'flatten',</span> <span class="pre">'flowMain',</span> <span class="pre">'header',</span> <span class="pre">'identity',</span> <span class="pre">'logLevel',</span> <span class="pre">'pollUrl',</span> <span class="pre">'post_baseUrl',</span> <span class="pre">'post_baseDir',</span> <span class="pre">'post_broker',</span> <span class="pre">'post_exchange',</span> <span class="pre">'post_exchangeSuffix',</span> <span class="pre">'post_format',</span> <span class="pre">'post_topic',</span> <span class="pre">'queueName',</span> <span class="pre">'sendTo',</span> <span class="pre">'rename',</span> <span class="pre">'report_exchange',</span> <span class="pre">'source',</span> <span class="pre">'strip',</span> <span class="pre">'timezone',</span> <span class="pre">'nodupe_ttl',</span> <span class="pre">'nodupe_driver',</span> <span class="pre">'nodupe_basis',</span> <span class="pre">'tlsRigour',</span> <span class="pre">'topic']</span></em></dt>
+<span class="sig-prename descclassname"><span class="pre">sarracenia.config.</span></span><span class="sig-name descname"><span class="pre">str_options</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['action',</span> <span class="pre">'admin',</span> <span class="pre">'baseDir',</span> <span class="pre">'broker',</span> <span class="pre">'cluster',</span> <span class="pre">'directory',</span> <span class="pre">'exchange',</span> <span class="pre">'exchange_suffix',</span> <span class="pre">'feeder',</span> <span class="pre">'filename',</span> <span class="pre">'flatten',</span> <span class="pre">'flowMain',</span> <span class="pre">'header',</span> <span class="pre">'identity',</span> <span class="pre">'inlineEncoding',</span> <span class="pre">'logLevel',</span> <span class="pre">'pollUrl',</span> <span class="pre">'post_baseUrl',</span> <span class="pre">'post_baseDir',</span> <span class="pre">'post_broker',</span> <span class="pre">'post_exchange',</span> <span class="pre">'post_exchangeSuffix',</span> <span class="pre">'post_format',</span> <span class="pre">'post_topic',</span> <span class="pre">'queueName',</span> <span class="pre">'sendTo',</span> <span class="pre">'rename',</span> <span class="pre">'report_exchange',</span> <span class="pre">'source',</span> <span class="pre">'strip',</span> <span class="pre">'timezone',</span> <span class="pre">'nodupe_ttl',</span> <span class="pre">'nodupe_driver',</span> <span class="pre">'nodupe_basis',</span> <span class="pre">'tlsRigour',</span> <span class="pre">'topic']</span></em></dt>
 <dd><p>for backward compatibility,</p>
 <p>convert some old plugins that are hard to get working with
 v2wrapper, into v3 plugin.</p>

fr/Reference/sr3_options.7.html

@@ -945,6 +945,14 @@ <h4>inline &lt;flag&gt; (défaut: False)<a class="headerlink" href="#inline-flag
 <section id="inlinebytemax-taille">
 <h4>inlineByteMax &lt;taille&gt;<a class="headerlink" href="#inlinebytemax-taille" title="Link to this heading"></a></h4>
 <p>la taille maximale des fichiers dont le contenu est à inclure dans un messages d’annonce (envoyé inline.)</p>
+<p>Quand on inclut les données dans le message on l’encode dans un format choisi:</p>
+<blockquote>
+<div><ul class="simple">
+<li><p>text: le fichier doit être du utf-8 valide (ou érreur.)</p></li>
+<li><p>binary:  le fichier peut être encodé n’importe comment, il sera en format base64.</p></li>
+<li><p>guess: essaie le format text en premier, utilise binary en cas d’erreur.</p></li>
+</ul>
+</div></blockquote>
 </section>
 <section id="inlineonly">
 <h4>inlineOnly<a class="headerlink" href="#inlineonly" title="Link to this heading"></a></h4>