8000 Updated documentation · FirebirdSQL/python3-base@e1c189c · GitHub
[go: up one dir, main page]
Skip to content

Commit e1c189c

Browse files
pcisarpcisar
committed
Updated documentation
1 parent edac9a6 commit e1c189c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+1481
-1482
lines changed

‎docs/changelog.txt

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

5-
[Development] Version 1.4.3
6-
===========================
5+
Version 1.4.3
6+
=============
77

88
* `~firebird.base.types` module:
99

‎docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@
2323
author = 'Pavel Císař'
2424

2525
# The short X.Y version
26-
version = '1.4.2'
26+
version = '1.4.3'
2727

2828
# The full version, including alpha/beta/rc tags
29-
release = '1.4.2'
29+
release = '1.4.3'
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: 17c3c05c66ed7574c1d99f328dd94484
3+
config: d491a3356d606352098328ffb472d336
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

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

Lines changed: 2 additions & 2 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.buffer &#8212; Firebird-base 1.4.1 documentation</title>
7+
<title>firebird.base.buffer &#8212; Firebird-base 1.4.2 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.1</b></span>
42+
<span class="navbar-text pull-left"><b>1.4.2</b></span>
4343

4444
<div class="nav-collapse">
4545
<ul class="nav">

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

Lines changed: 2 additions & 2 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.collections &#8212; Firebird-base 1.4.1 documentation</title>
7+
<title>firebird.base.collections &#8212; Firebird-base 1.4.2 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.1</b></span>
42+
<span class="navbar-text pull-left"><b>1.4.2</b></span>
4343

4444
<div class="nav-collapse">
4545
<ul class="nav">

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

Lines changed: 4 additions & 4 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.config &#8212; Firebird-base 1.4.1 documentation</title>
7+
<title>firebird.base.config &#8212; Firebird-base 1.4.2 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.1</b></span>
42+
<span class="navbar-text pull-left"><b>1.4.2</b></span>
4343

4444
<div class="nav-collapse">
4545
<ul class="nav">
@@ -158,10 +158,10 @@ <h1>Source code for firebird.base.config</h1><div class="highlight"><pre>
158158
<span class="kn">from</span> <span class="nn">decimal</span> <span class="kn">import</span> <span class="n">Decimal</span><span class="p">,</span> <span class="n">DecimalException</span>
159159
<span class="kn">from</span> <span class="nn">configparser</span> <span class="kn">import</span> <span class="n">ConfigParser</span><span class="p">,</span> <span class="n">DEFAULTSECT</span>
160160
<span class="kn">from</span> <span class="nn">inspect</span> <span class="kn">import</span> <span class="n">signature</span><span class="p"> F438 ;,</span> <span class="n">Signature</span><span class="p">,</span> <span class="n">Parameter</span>
161-
<span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span><span class="p">,</span> <span class="n">Flag</span><span class="p">,</span> <span class="n">_decompose</span>
161+
<span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span><span class="p">,</span> <span class="n">Flag</span>
162162
<span class="kn">import</span> <span class="nn">os</span>
163163
<span class="kn">from</span> <span class="nn">.config_pb2</span> <span class="kn">import</span> <span class="n">ConfigProto</span>
164-
<span class="kn">from</span> <span class="nn">.types</span> <span class="kn">import</span> <span class="n">Error</span><span class="p">,</span> <span class="n">MIME</span><span class="p">,</span> <span class="n">ZMQAddress</span><span class="p">,</span> <span class="n">PyExpr</span><span class="p">,</span> <span class="n">PyCode</span><span class="p">,</span> <span class="n">PyCallable</span>
164+
<span class="kn">from</span> <span class="nn">.types</span> <span class="kn">import</span> <span class="n">Error</span><span class="p">,</span> <span class="n">MIME</span><span class="p">,</span> <span class="n">ZMQAddress</span><span class="p">,</span> <span class="n">PyExpr</span><span class="p">,</span> <span class="n">PyCode</span><span class="p">,</span> <span class="n">PyCallable</span><span class="p">,</span> <span class="n">_decompose</span>
165165
<span class="kn">from</span> <span class="nn">.strconv</span> <span class="kn">import</span> <span class="n">get_convertor</span><span class="p">,</span> <span class="n">convert_to_str</span><span class="p">,</span> <span class="n">Convertor</span>
166166

167167
<span class="n">PROTO_CONFIG</span> <span class="o">=</span> <span class="s1">&#39;firebird.base.ConfigProto&#39;</span>

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

Lines changed: 2 additions & 2 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.hooks &#8212; Firebird-base 1.4.1 documentation</title>
7+
<title>firebird.base.hooks &#8212; Firebird-base 1.4.2 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.1</b></span>
42+
<span class="navbar-text pull-left"><b>1.4.2</b></span>
4343

4444
<div class="nav-collapse">
4545
<ul class="nav">

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

Lines changed: 2 additions & 2 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.logging &#8212; Firebird-base 1.4.1 documentation</title>
7+
<title>firebird.base.logging &#8212; Firebird-base 1.4.2 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.1</b></span>
42+
<span class="navbar-text pull-left"><b>1.4.2</b></span>
4343

4444
<div class="nav-collapse">
4545
<ul class="nav">

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

Lines changed: 12 additions & 4 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.1 documentation</title>
7+
<title>firebird.base.protobuf &#8212; Firebird-base 1.4.2 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.1</b></span>
42+
<span class="navbar-text pull-left"><b>1.4.2</b></span>
4343

4444
<div class="nav-collapse">
4545
<ul class="nav">
@@ -140,7 +140,7 @@ <h1>Source code for firebird.base.protobuf</h1><div class="highlight"><pre>
140140
<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
141141
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">cast</span>
142142
<span class="kn">from</span> <span class="nn">dataclasses</span> <span class="kn">import</span> <span class="n">dataclass</span>
143-
<span class="kn">from</span> <span class="nn">pkg_resources</span> <span class="kn">import</span> <span class="n">iter_entry_points</span>
143+
<span class="kn">from</span> <span class="nn">importlib.metadata</span> <span class="kn">import</span> <span class="n">entry_points</span>
144144
<span class="kn">from</span> <span class="nn">google.protobuf.message</span> <span class="kn">import</span> <span class="n">Message</span> <span class="k">as</span> <span class="n">ProtoMessage</span>
145145
<span class="kn">from</span> <span class="nn">google.protobuf.descriptor</span> <span class="kn">import</span> <span class="n">EnumDescriptor</span>
146146
<span class="kn">from</span> <span class="nn">google.protobuf.struct_pb2</span> <span class="kn">import</span> <span class="n">Struct</span> <span class="k">as</span> <span class="n">StructProto</span> <span class="c1"># pylint: disable=[E0611]</span>
@@ -149,13 +149,21 @@ <h1>Source code for firebird.base.protobuf</h1><div class="highlight"><pre>
149149
<span class="kn">from</span> <span class="nn">.types</span> <span class="kn">import</span> <span class="n">Distinct</span>
150150
<span class="kn">from</span> <span class="nn">.collections</span> <span class="kn">import</span> <span class="n">Registry</span>
151151

152+
<span class="c1">#: Name of well-known EMPTY protobuf message (for use with `.create_message()`)</span>
152153
<span class="n">PROTO_EMPTY</span> <span class="o">=</span> <span class="s1">&#39;google.protobuf.Empty&#39;</span>
154+
<span class="c1">#: Name of well-known ANY protobuf message (for use with `.create_message()`)</span>
153155
<span class="n">PROTO_ANY</span> <span class="o">=</span> <span class="s1">&#39;google.protobuf.Any&#39;</span>
156+
<span class="c1">#: Name of well-known DURATION protobuf message (for use with `.create_message()`)</span>
154157
<span class="n">PROTO_DURATION</span> <span class="o">=</span> <span class="s1">&#39;google.protobuf.Duration&#39;</span>
158+
<span class="c1">#: Name of well-known TIMESTAMP protobuf message (for use with `.create_message()`)</span>
155159
<span class="n">PROTO_TIMESTAMP</span> <span class="o">=</span> <span class="s1">&#39;google.protobuf.Timestamp&#39;</span>
160+
<span class="c1">#: Name of well-known STRUCT protobuf message (for use with `.create_message()`)</span>
156161
<span class="n">PROTO_STRUCT</span> <span class="o">=</span> <span class="s1">&#39;google.protobuf.Struct&#39;</span>
162+
<span class="c1">#: Name of well-known VALUE protobuf message (for use with `.create_message()`)</span>
157163
<span class="n">PROTO_VALUE</span> <span class="o">=</span> <span class="s1">&#39;google.protobuf.Value&#39;</span>
164+
<span class="c1">#: Name of well-known LISTVALUE protobuf message (for use with `.create_message()`)</span>
158165
<span class="n">PROTO_LISTVALUE</span> <span class="o">=</span> <span class="s1">&#39;google.protobuf.ListValue&#39;</span>
166+
<span class="c1">#: Name of well-known FIELDMASK protobuf message (for use with `.create_message()`)</span>
159167
<span class="n">PROTO_FIELDMASK</span> <span class="o">=</span> <span class="s1">&#39;google.protobuf.FieldMask&#39;</span>
160168

161169
<span class="c1"># Classes</span>
@@ -332,7 +340,7 @@ <h1>Source code for firebird.base.protobuf</h1><div class="highlight"><pre>
332340

333341
<span class="sd"> load_registered(&#39;firebird.base.protobuf&#39;)</span>
334342
<span class="sd"> &quot;&quot;&quot;</span>
335-
<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">iter_entry_points</span><span class="p">(</span><span class="n">group</span><span class="p">)):</span>
343+
<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>
336344
<span class="n">register_decriptor</span><span class="p">(</span><span class="n">desc</span><span class="p">)</span></div>
337345

338346

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

Lines changed: 2 additions & 2 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.signal &#8212; Firebird-base 1.4.1 documentation</title>
7+
<title>firebird.base.signal &#8212; Firebird-base 1.4.2 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.1</b></span>
42+
<span class="navbar-text pull-left"><b>1.4.2</b></span>
4343

4444
<div class="nav-collapse">
4545
<ul class="nav">

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

Lines changed: 2 additions & 2 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.strconv &#8212; Firebird-base 1.4.1 documentation</title>
7+
<title>firebird.base.strconv &#8212; Firebird-base 1.4.2 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.1</b></span>
42+
<span class="navbar-text pull-left"><b>1.4.2</b></span>
4343

4444
<div class="nav-collapse">
4545
<ul class="nav">

0 commit comments

Comments
 (0)
0