Skip to content

Commit b9797e8

Browse files
pcisarpcisar
committed
Documentation
1 parent 8238593 commit b9797e8

39 files changed

+3782
-16069
lines changed

‎docs/changelog.txt‎

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

5+
Version 1.4.0
6+
=============
7+
8+
* Initial support for Firebird 5 (new items in `schema` and `monitor` modules).
9+
* Finally, Firebird 4 support was added (new items in `schema` and `monitor` modules).
10+
* Potentially breaking changes:
11+
12+
- Enum `firebird.lib.monitor.ShutdownMode` was removed and replaced with
13+
`firebird.driver.types.ShutdownMode`. They are basically the same, but differ in value
14+
name ONLINE->NORMAL.
15+
- `~firebird.lib.schema.ObjectType` value `PACKAGE` was renamed to `PACKAGE_HEADER`
16+
17+
* Updated dependencies: firebird-driver>=1.9.0 and firebird-base>=1.6.1
18+
* Note: The list of reserved words (used internally to correctly quote identifiers) is
19+
not hardcoded in Firebird 5, but is instead read from RDB$KEYWORDS.
20+
521
Version 1.3.0
622
=============
723

‎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-lib'
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.3.0'
26+
version = '1.4.0'
2727

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

3131

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

‎docs/firebird-lib.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: 5833a633ea9786ec9ba3238b9a1dc38e
3+
config: 93cad2c915fc7a3a4d268156505ab238
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/firebird-lib.docset/Contents/Resources/Documents/_modules/firebird/lib/gstat.html‎

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

‎docs/firebird-lib.docset/Contents/Resources/Documents/_modules/firebird/lib/log.html‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,10 @@
44
<head>
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>firebird.lib.log &#8212; firebird-lib 1.2.1 documentation</title>
7+
<title>firebird.lib.log &#8212; firebird-lib 1.4.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>
11-
<script src="../../../_static/jquery.js"></script>
12-
<script src="../../../_static/underscore.js"></script>
13-
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
1411
<script src="../../../_static/doctools.js"></script>
1512
<script src="../../../_static/sphinx_highlight.js"></script>
1613
<link rel="index" title="Index" href="../../../genindex.html" />
@@ -38,7 +35,7 @@
3835

3936
<a class="brand" href="../../../index.html">
4037
firebird-lib</a>
41-
<span class="navbar-text pull-left"><b>1.2.1</b></span>
38+
<span class="navbar-text pull-left"><b>1.4.0</b></span>
4239

4340
<div class="nav-collapse">
4441
<ul class="nav">
@@ -103,6 +100,9 @@
103100
</ul>
104101
</li>
105102
<li class="toctree-l1"><a class="reference internal" href="../../../changelog.html">Changelog</a><ul>
103+
<li class="toctree-l2"><a class="reference internal" href="../../../changelog.html#version-1-4-0">Version 1.4.0</a></li>
104+
<li class="toctree-l2"><a class="reference internal" href="../../../changelog.html#version-1-3-0">Version 1.3.0</a></li>
105+
<li class="toctree-l2"><a class="reference internal" href="../../../changelog.html#version-1-2-2">Version 1.2.2</a></li>
106106
<li class="toctree-l2"><a class="reference internal" href="../../../changelog.html#version-1-2-1">Version 1.2.1</a></li>
107107
<li class="toctree-l2"><a class="reference internal" href="../../../changelog.html#version-1-2-0">Version 1.2.0</a></li>
108108
<li class="toctree-l2"><a class="reference internal" href="../../../changelog.html#version-1-0-1">Version 1.0.1</a></li>
@@ -197,11 +197,11 @@ <h1>Source code for firebird.lib.log</h1><div class="highlight"><pre>
197197
<span class="kn">from</span> <span class="nn">dataclasses</span> <span class="kn">import</span> <span class="n">dataclass</span>
198198
<span class="kn">from</span> <span class="nn">contextlib</span> <span class="kn">import</span> <span class="n">suppress</span>
199199
<span class="kn">from</span> <span class="nn">firebird.base.types</span> <span class="kn">import</span> <span class="n">Error</span><span class="p">,</span> <span class="n">STOP</span><span class="p">,</span> <span class="n">Sentinel</span>
200-
<span class="kn">from</span> <span class="nn">firebird.lib.logmsgs</span> <span class="kn">import</span> <span class="n">identify_msg</span><span class="p">,</span> <span class="n">Severity</span><span class="p">,</span> <span class="n">Facility</span>
200+
<span class="kn">from</span> <span class="nn">.logmsgs</span> <span class="kn">import</span> <span class="n">identify_msg</span><span class="p">,</span> <span class="n">Severity</span><span class="p">,</span> <span class="n">Facility</span>
201201

202202
<div class="viewcode-block" id="LogMessage"><a class="viewcode-back" href="../../../ref-log.html#firebird.lib.log.LogMessage">[docs]</a><span class="nd">@dataclass</span><span class="p">(</span><span class="n">order</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">frozen</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
203203
<span class="k">class</span> <span class="nc">LogMessage</span><span class="p">:</span>
204-
<span class="sd">&quot;&quot;&quot;Firebird log message.</span>
204+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Firebird log message.</span>
205205
<span class="sd"> &quot;&quot;&quot;</span>
206206
<span class="c1">#: Firebird server identification</span>
207207
<span class="n">origin</span><span class="p">:</span> <span class="nb">str</span>
@@ -220,12 +220,12 @@ <h1>Source code for firebird.lib.log</h1><div class="highlight"><pre>
220220
<span class="n">params</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></div>
221221

222222
<div class="viewcode-block" id="LogParser"><a class="viewcode-back" href="../../../ref-log.html#firebird.lib.log.LogParser">[docs]</a><span class="k">class</span> <span class="nc">LogParser</span><span class="p">:</span>
223-
<span class="sd">&quot;&quot;&quot;Parser for firebird.log files.</span>
223+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Parser for firebird.log files.</span>
224224
<span class="sd"> &quot;&quot;&quot;</span>
225225
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
226226
<span class="bp">self</span><span class="o">.</span><span class="n">__buffer</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">=</span> <span class="p">[]</span>
227227
<div class="viewcode-block" id="LogParser.push"><a class="viewcode-back" href="../../../ref-log.html#firebird.lib.log.LogParser.push">[docs]</a> <span class="k">def</span> <span class="nf">push</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">line</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="n">Sentinel</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">LogMessage</span><span class="p">]:</span>
228-
<span class="sd">&quot;&quot;&quot;Push parser.</span>
228+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Push parser.</span>
229229

230230
<span class="sd"> Arguments:</span>
231231
<span class="sd"> line: Single line from Firebird log, or `~firebird.base.types.STOP` sentinel.</span>
@@ -260,7 +260,7 @@ <h1>Source code for firebird.lib.log</h1><div class="highlight"><pre>
260260
<span class="bp">self</span><span class="o">.</span><span class="n">__buffer</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
261261
<span class="k">return</span> <span class="n">result</span></div>
262262
<div class="viewcode-block" id="LogParser.parse_entry"><a class="viewcode-back" href="../../../ref-log.html#firebird.lib.log.LogParser.parse_entry">[docs]</a> <span class="k">def</span> <span class="nf">parse_entry</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">log_entry</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">LogMessage</span><span class="p">:</span>
263-
<span class="sd">&quot;&quot;&quot;Parse single log entry.</span>
263+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Parse single log entry.</span>
264264

265265
<span class="sd"> Arguments:</span>
266266
<span class="sd"> log_entry: List with log entry lines.</span>
@@ -280,7 +280,7 @@ <h1>Source code for firebird.lib.log</h1><div class="highlight"><pre>
280280
<span class="n">log_msg</span><span class="o">.</span><span class="n">facility</span><span class="p">,</span> <span class="n">log_msg</span><span class="o">.</span><span class="n">get_pattern</span><span class="p">(</span><span class="n">found</span><span class="p">[</span><span class="mi">2</span><span class="p">]),</span> <span class="n">found</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
281281
<span class="k">return</span> <span class="n">LogMessage</span><span class="p">(</span><span class="n">origin</span><span class="p">,</span> <span class="n">timestamp</span><span class="p">,</span> <span class="n">Severity</span><span class="o">.</span><span class="n">UNKNOWN</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">Facility</span><span class="o">.</span><span class="n">UNKNOWN</span><span class="p">,</span> <span class="n">msg</span><span class="p">,</span> <span class="p">{})</span></div>
282282
<div class="viewcode-block" id="LogParser.parse"><a class="viewcode-back" href="../../../ref-log.html#firebird.lib.log.LogParser.parse">[docs]</a> <span class="k">def</span> <span class="nf">parse</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">lines</span><span class="p">:</span> <span class="n">Iterable</span><span class="p">):</span>
283-
<span class="sd">&quot;&quot;&quot;Parse output from Firebird log.</span>
283+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Parse output from Firebird log.</span>
284284

285285
<span class="sd"> Arguments:</span>
286286
<span class="sd"> lines: Iterable that returns Firebird log lines.</span>
@@ -311,8 +311,8 @@ <h1>Source code for firebird.lib.log</h1><div class="highlight"><pre>
311311

312312
</p>
313313
<p>
314-
&copy; Copyright 2020-2022, The Firebird Project.<br/>
315-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 5.2.3.<br/>
314+
&copy; Copyright 2020-2023, The Firebird Project.<br/>
315+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.0.1.<br/>
316316
</p>
317317
</div>
318318
</footer>

0 commit comments

Comments
 (0)