Skip to content

Commit df8e059

Browse files
pcisarpcisar
committed
Zeal Docset
1 parent 6e33b6f commit df8e059

32 files changed

+274
-162
lines changed

‎docs/changelog.txt‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,24 @@
22
Changelog
33
#########
44

5+
Version 1.6.0
6+
=============
7+
8+
* `~firebird.base.protobuf` module:
9+
10+
- Registration of already registered protobuf registration is now ignored instead
11+
raising exception.
12+
13+
* `~firebird.base.config` module:
14+
15+
- `.Config.get_config()` and `.Option.get_config()` now provides `plain` bool argument
16+
to return configuration text without comments. Deafult is False.
17+
18+
* `~firebird.base.trace` module:
19+
20+
- Fixed bug in `.TraceManager.load_config()`.
21+
22+
523
Version 1.5.0
624
=============
725

‎docs/conf.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@
1919
# -- Project information -----------------------------------------------------
2020

2121
project = 'Firebird-base'
22-
copyright = '2020-2022, The Firebird Project'
22+
copyright = '2020-2023, The Firebird Project'
2323
author = 'Pavel Císař'
2424

2525
# The short X.Y version
26-
version = '1.5.0'
26+
version = '1.6.0'
2727

2828
# The full version, including alpha/beta/rc tags
29-
release = '1.5.0'
29+
release = '1.6.0'
3030

3131

3232
# -- General configuration ---------------------------------------------------

‎docs/firebird-base.docset/Contents/Resources/Documents/.buildinfo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: d491a3356d606352098328ffb472d336
3+
config: c6141e70e401315cd341f57590fb931d
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/firebird-base.docset/Contents/Resources/Documents/_modules/firebird/base/config.html‎

Lines changed: 81 additions & 23 deletions
Large diffs are not rendered by default.

‎docs/firebird-base.docset/Contents/Resources/Documents/_modules/firebird/base/protobuf.html‎

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<head>
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>firebird.base.protobuf &#8212; Firebird-base 1.4.2 documentation</title>
7+
<title>firebird.base.protobuf &#8212; Firebird-base 1.6.0 documentation</title>
88
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
99
<link rel="stylesheet" type="text/css" href="../../../_static/bootstrap-sphinx.css" />
1010
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
@@ -39,7 +39,7 @@
3939

4040
<a class="brand" href="../../../index.html">
4141
Firebird-base</a>
42-
<span class="navbar-text pull-left"><b>1.4.2</b></span>
42+
<span class="navbar-text pull-left"><b>1.6.0</b></span>
4343

4444
<div class="nav-collapse">
4545
<ul class="nav">
@@ -307,20 +307,21 @@ <h1>Source code for firebird.base.protobuf</h1><div class="highlight"><pre>
307307
<span class="sd"> &quot;&quot;&quot;</span>
308308
<span class="k">return</span> <span class="n">get_enum_type</span><span class="p">(</span><span class="n">enum_type_name</span><span class="p">)</span><span class="o">.</span><span class="n">get_value_name</span><span class="p">(</span><span class="n">value</span><span class="p">)</span></div>
309309

310-
311310
<div class="viewcode-block" id="register_decriptor"><a class="viewcode-back" href="../../../protobuf.html#firebird.base.protobuf.register_decriptor">[docs]</a><span class="k">def</span> <span class="nf">register_decriptor</span><span class="p">(</span><span class="n">file_descriptor</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
312311
<span class="sd">&quot;&quot;&quot;Registers enums and messages defined by protobuf file DESCRIPTOR.</span>
313312
<span class="sd"> &quot;&quot;&quot;</span>
314313
<span class="k">for</span> <span class="n">msg_desc</span> <span class="ow">in</span> <span class="n">file_descriptor</span><span class="o">.</span><span class="n">message_types_by_name</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
315-
<span class="n">_msgreg</span><span class="o">.</span><span class="n">store</span><span class="p">(</span><span class="n">ProtoMessageType</span><span class="p">(</span><span class="n">msg_desc</span><span class="o">.</span><span class="n">full_name</span><span class="p">,</span> <span class="n">msg_desc</span><span class="o">.</span><span class="n">_concrete_class</span><span class="p">))</span>
314+
<span class="k">if</span> <span class="ow">not</span> <span class="n">msg_desc</span><span class="o">.</span><span class="n">full_name</span> <span class="ow">in</span> <span class="n">_msgreg</span><span class="p">:</span>
315+
<span class="n">_msgreg</span><span class="o">.</span><span class="n">store</span><span class="p">(</span><span class="n">ProtoMessageType</span><span class="p">(</span><span class="n">msg_desc</span><span class="o">.</span><span class="n">full_name</span><span class="p">,</span> <span class="n">msg_desc</span><span class="o">.</span><span class="n">_concrete_class</span><span class="p">))</span>
316316
<span class="k">for</span> <span class="n">enum_desc</span> <span class="ow">in</span> <span class="n">file_descriptor</span><span class="o">.</span><span class="n">enum_types_by_name</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
317-
<span class="n">_enumreg</span><span class="o">.</span><span class="n">store</span><span class="p">(</span><span class="n">ProtoEnumType</span><span class="p">(</span><span class="n">enum_desc</span><span class="p">))</span></div>
317+
<span class="k">if</span> <span class="ow">not</span> <span class="n">enum_desc</span><span class="o">.</span><span class="n">full_name</span> <span class="ow">in</span> <span class="n">_enumreg</span><span class="p">:</span>
318+
<span class="n">_enumreg</span><span class="o">.</span><span class="n">store</span><span class="p">(</span><span class="n">ProtoEnumType</span><span class="p">(</span><span class="n">enum_desc</span><span class="p">))</span></div>
318319

319320
<div class="viewcode-block" id="load_registered"><a class="viewcode-back" href="../../../protobuf.html#firebird.base.protobuf.load_registered">[docs]</a><span class="k">def</span> <span class="nf">load_registered</span><span class="p">(</span><span class="n">group</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span> <span class="c1"># pragma: no cover</span>
320321
<span class="sd">&quot;&quot;&quot;Load registered protobuf packages.</span>
321322

322323
<span class="sd"> Protobuf packages must register the pb2-file DESCRIPTOR in `entry_points` section of</span>
323-
<span class="sd"> `setup.cfg` file.</span>
324+
<span class="sd"> `setup.cfg` or `pyproject.toml` file.</span>
324325

325326
<span class="sd"> Arguments:</span>
326327
<span class="sd"> group: Entry-point group name.</span>
@@ -336,14 +337,20 @@ <h1>Source code for firebird.base.protobuf</h1><div class="highlight"><pre>
336337
<span class="sd"> firebird.base.lib_b = firebird.base.lib_b_pb2:DESCRIPTOR</span>
337338
<span class="sd"> firebird.base.lib_c = firebird.base.lib_c_pb2:DESCRIPTOR</span>
338339

340+
<span class="sd"> # pyproject.toml</span>
341+
342+
<span class="sd"> [project.entry-points.&quot;firebird.base.protobuf&quot;]</span>
343+
<span class="sd"> &quot;firebird.base.lib_a&quot; = &quot;firebird.base.lib_a_pb2:DESCRIPTOR&quot;</span>
344+
<span class="sd"> &quot;firebird.base.lib_b&quot; = &quot;firebird.base.lib_b_pb2:DESCRIPTOR&quot;</span>
345+
<span class="sd"> &quot;firebird.base.lib_c&quot; = &quot;firebird.base.lib_c_pb2:DESCRIPTOR&quot;</span>
346+
339347
<span class="sd"> # will be loaded with:</span>
340348

341349
<span class="sd"> load_registered(&#39;firebird.base.protobuf&#39;)</span>
342350
<span class="sd"> &quot;&quot;&quot;</span>
343351
<span class="k">for</span> <span class="n">desc</span> <span class="ow">in</span> <span class="p">(</span><span class="n">entry</span><span class="o">.</span><span class="n">load</span><span class="p">()</span> <span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="n">entry_points</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">group</span><span class="p">,</span> <span class="p">[])):</span>
344352
<span class="n">register_decriptor</span><span class="p">(</span><span class="n">desc</span><span class="p">)</span></div>
345353

346-
347354
<span class="k">for</span> <span class="n">well_known</span> <span class="ow">in</span> <span class="p">[</span><span class="n">any_pb2</span><span class="p">,</span> <span class="n">struct_pb2</span><span class="p">,</span> <span class="n">duration_pb2</span><span class="p">,</span> <span class="n">empty_pb2</span><span class="p">,</span> <span class="n">timestamp_pb2</span><span class="p">,</span> <span class="n">field_mask_pb2</span><span class="p">]:</span>
348355
<span class="n">register_decriptor</span><span class="p">(</span><span class="n">well_known</span><span class="o">.</span><span class="n">DESCRIPTOR</span><span class="p">)</span>
349356
<span class="k">del</span> <span class="n">any_pb2</span><span class="p">,</span> <span class="n">struct_pb2</span><span class="p">,</span> <span class="n">duration_pb2</span><span class="p">,</span> <span class="n">empty_pb2</span><span class="p">,</span> <span class="n">timestamp_pb2</span><span class="p">,</span> <span class="n">field_mask_pb2</span>
@@ -360,8 +367,8 @@ <h1>Source code for firebird.base.protobuf</h1><div class="highlight"><pre>
360367

361368
</p>
362369
<p>
363-
&copy; Copyright 2020-2022, The Firebird Project.<br/>
364-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 5.2.3.<br/>
370+
&copy; Copyright 2020-2023, The Firebird Project.<br/>
371+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 5.3.0.<br/>
365372
</p>
366373
</div>
367374
</footer>

‎docs/firebird-base.docset/Contents/Resources/Documents/_modules/firebird/base/trace.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<head>
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>firebird.base.trace &#8212; Firebird-base 1.4.2 documentation</title>
7+
<title>firebird.base.trace &#8212; Firebird-base 1.6.0 documentation</title>
88
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
99
<link rel="stylesheet" type="text/css" href="../../../_static/bootstrap-sphinx.css" />
1010
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
@@ -39,7 +39,7 @@
3939

4040
<a class="brand" href="../../../index.html">
4141
Firebird-base</a>
42-
<span class="navbar-text pull-left"><b>1.4.2</b></span>
42+
<span class="navbar-text pull-left"><b>1.6.0</b></span>
4343

4444
<div class="nav-collapse">
4545
<ul class="nav">
@@ -563,14 +563,14 @@ <h1>Source code for firebird.base.trace</h1><div class="highlight"><pre>
563563
<span class="k">if</span> <span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">items</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">)</span> <span class="ow">and</span> <span class="p">(</span><span class="n">items</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;*&#39;</span><span class="p">):</span>
564564
<span class="n">items</span> <span class="o">=</span> <span class="p">[</span><span class="n">i</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">i</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;_&#39;</span><span class="p">)</span> <span class="ow">and</span> <span class="n">isfunction</span><span class="p">(</span><span class="nb">getattr</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">i</span><span class="p">))]</span>
565565
<span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">items</span><span class="p">:</span>
566-
<span class="bp">self</span><span class="o">.</span><span class="n">add_trace</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">item</span><span class="p">,</span> <span class="n">traced</span><span class="p">,</span> <span class="o">*</span><span class="p">[],</span> <span class="o">**</span><span class="n">cls_kwargs</span><span class="p">)</span>
566+
<span class="bp">self</span><span class="o">.</span><span class="n">add_trace</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">item</span><span class="p">,</span> <span class="o">*</span><span class="p">[],</span> <span class="o">**</span><span class="n">cls_kwargs</span><span class="p">)</span>
567567
<span class="k">if</span> <span class="p">(</span><span class="n">items</span> <span class="o">:=</span> <span class="n">cls_cfg</span><span class="o">.</span><span class="n">special</span><span class="o">.</span><span class="n">value</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
568568
<span class="k">for</span> <span class="n">mcfg</span> <span class="ow">in</span> <span class="n">items</span><span class="p">:</span>
569569
<span class="n">method</span> <span class="o">=</span> <span class="n">mcfg</span><span class="o">.</span><span class="n">method</span><span class="o">.</span><span class="n">value</span>
570570
<span class="n">kwargs</span> <span class="o">=</span> <span class="p">{}</span>
571571
<span class="n">kwargs</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">cls_kwargs</span><span class="p">)</span>
572572
<span class="n">kwargs</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">build_kwargs</span><span class="p">(</span><span class="n">mcfg</span><span class="p">))</span>
573-
<span class="bp">self</span><span class="o">.</span><span class="n">add_trace</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">traced</span><span class="p">,</span> <span class="o">*</span><span class="p">[],</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
573+
<span class="bp">self</span><span class="o">.</span><span class="n">add_trace</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="o">*</span><span class="p">[],</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
574574
<span class="k">def</span> <span class="nf">with_name</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">obj</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
575575
<span class="k">return</span> <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">obj</span><span class="o">.</span><span class="n">cls</span><span class="o">.</span><span class="vm">__module__</span><span class="si">}</span><span class="s1">.</span><span class="si">{</span><span class="n">obj</span><span class="o">.</span><span class="n">cls</span><span class="o">.</span><span class="vm">__name__</span><span class="si">}</span><span class="s1">&#39;</span> <span class="o">==</span> <span class="n">name</span>
576576

@@ -646,8 +646,8 @@ <h1>Source code for firebird.base.trace</h1><div class="highlight"><pre>
646646

647647
</p>
648648
<p>
649-
&copy; Copyright 2020-2022, The Firebird Project.<br/>
650-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 5.2.3.<br/>
649+
&copy; Copyright 2020-2023, The Firebird Project.<br/>
650+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 5.3.0.<br/>
651651
</p>
652652
</div>
653653
</footer>

0 commit comments

Comments
 (0)