Release 1.6.0

Author: pcisar

docs/_static/basic.css

@@ -641,3 +641,63 @@ dt.field-even:after {
 dd.field-list {
   grid-column-start: 2;
 }
+
+hr.docutils {
+    font-weight: bold;
+/*    border: 2px solid #7a9eec; */
+    border: 2px solid grey;
+    border-left-style: none;
+    border-right-style: none;
+    border-top-style: none;
+}
+
+div.versionadded {
+    color: black;
+/*    padding: 10px 0 0 10px; */
+    font-weight: bold;
+    margin: 5px 0;
+}
+
+div.versionchanged {
+    color: black;
+/*   padding: 0 10px 0 0; */
+    font-weight: bold;
+    margin: 5px 0;
+}
+
+span.added {
+    background: #eeffcc ;
+    border: 2px solid #aacc99;
+    border-left-style: none;
+    border-right-style: none;
+    padding: 5px;
+}
+
+span.changed {
+    background: #fbe3e4 ;
+    border: 2px solid #fbc2c4;
+    border-left-style: none;
+    border-right-style: none;
+    padding: 5px;
+}
+
+dl.class, dl.exception, dl.data, dl.function {
+/*    background: #fbe3e4 ;*/
+    border: 1px solid grey;
+    border-top-style: none;
+    border-left-style: none;
+    border-right-style: none;
+/*    padding: 3px;*/
+}
+
+dt.py {
+    background: #f8f8f8;
+/*    border: 2px solid #aacc99;*/
+/*    border: 2px solid #ffcccc;  /*#ffd324;*/
+/*    border: 2px solid #fbc2c4;*/
+    border: 1px solid #e1e1e8;
+    border-top-style: none;
+    border-left-style: none;
+/*    border-right-style: none; */
+    padding: 2px 5px;
+}

docs/changelog.txt

@@ -2,6 +2,14 @@
 Changelog
 #########
 
+Version 1.6.0
+=============
+
+* Further code optimizations.
+* Addressing issues reported by pylint.
+* Updated Firebird OO API (interface extensions between 3.0.7->3.0.10, 4.0.0->4.0.2)
+* Improved documentation.
+
 Version 1.5.2
 =============
 
@@ -16,8 +24,8 @@ Version 1.5.1
 Version 1.5.0
 =============
 
-* Fix: `.create_database()` now use server configuration user/password if either is not
-  specified in database configuration (like `.connect()`)
+* Fix: `~firebird.driver.core.create_database()` now use server configuration user/password
+  if either is not specified in database configuration (like `.connect()`)
 * Fix: Problem in `.Server` processing incomplete LINE responses.
 * New: `verbint` parameter for `.ServerDbServices3.backup()` and `.ServerDbServices3.restore()`
 
@@ -59,12 +67,13 @@ Version 1.4.0
 Improvements:
 -------------
 
-* Added `role` parameter to `.connect_server` and `.SPB_ATTACH`.
-* Added `encoding` parameter to `.SPB_ATTACH` with default value `ascii` - used to encode
-  `config`, `user`, `password` and `expected_db` values.
-* Added `encoding` parameter to `.TPB` with default value `ascii` - used to encode table names.
-* `.DPB` parameter `charset` is now used to determine encoding for `config`, `user`,
-  `password` and `role` values.
+* Added `role` parameter to `.connect_server` and `~firebird.driver.core.SPB_ATTACH`.
+* Added `encoding` parameter to `~firebird.driver.core.SPB_ATTACH` with default value
+  `ascii` - used to encode `config`, `user`, `password` and `expected_db` values.
+* Added `encoding` parameter to `~firebird.driver.core.TPB` with default value `ascii`
+  - used to encode table names.
+* `~firebird.driver.core..DPB` parameter `charset` is now used to determine encoding for
+  `config`, `user`, `password` and `role` values.
 * `.connect_server` has new `encoding` parameter with default value `ascii` that is passed
   to new `.Server.encoding` attribute. `.Server.encoding` is used to encode/decode various
   string values passed between client and server in parameter buffers (see below), and text
@@ -97,9 +106,12 @@ Version 1.3.4
 * User-defined encoding for string parameter and response values exchanged between driver
   and Firebird engine. This includes TPB, DPB, SPB and various service values:
 
-  - `.TPB`: New `encoding` constructor parameter & attribute. Used for `table names` in table reservation.
-  - `.DPB`: Encoding based on connection charset for `config`, `user name`, `password` and `role`.
-  - `.SPB`: New `encoding` constructor parameter & attribute. Used for `config`, `user name`, `password` and `expected database`.
+  - `~firebird.driver.core.TPB`: New `encoding` constructor parameter & attribute. Used
+    for `table names` in table reservation.
+  - `~firebird.driver.core.DPB`: Encoding based on connection charset for `config`,
+    `user name`, `password` and `role`.
+  - `~firebird.driver.core..SPB`: New `encoding` constructor parameter & attribute. Used
+    for `config`, `user name`, `password` and `expected database`.
   - Connection-related providers: Encoding based on connection charset.
   - Server and Service providers: New `.Server.encoding` attribute.
 * Fixed bug in `.ServerDbServices3.get_statistics` when `tables` are specified.
@@ -152,14 +164,14 @@ Version 1.3.0
     connected server.
   - New `.DatabaseConfig` options `session_time_zone`, `set_bind`, `decfloat_round` and
     `decfloat_traps`.
-  - New `.DPB` parameters `session_time_zone`, `set_db_replica`, `set_bind`, `decfloat_round`
-    and `decfloat_traps`.
+  - New `~firebird.driver.core.DPB` parameters `session_time_zone`, `set_db_replica`,
+    `set_bind`, `decfloat_round` and `decfloat_traps`.
   - New `session_time_zone` keyword parameter for `.connect()`.
   - Added explicit support for READ COMMITTED READ CONSISTENCY isolation (when disabled in
     Firebird configuration).
   - Support for transactions started at specified snapshot number.
     New `.TransactionInfoProvider.snapshot_number` property.
-    The `.TPB` has new `at_snapshot_number` parameter.
+    The `~firebird.driver.core.TPB` has new `at_snapshot_number` parameter.
   - `.backup()` and `.local_backup()` have new optional keyword-only arguments
     `include_data`, `keyhoder`, `keyname` and `crypt`, and `ZIP` value was added to `SrvBackupFlag`.
   - `.restore()` and `.local_restore()` have new optional keyword-only
@@ -180,7 +192,8 @@ Version 1.2.1
 Version 1.2.0
 =============
 
-* Fix unregistered bug: `sql_dialect` is used instead `db_sql_dialect` in `.create_database`.
+* Fix unregistered bug: `sql_dialect` is used instead `db_sql_dialect` in
+  `~firebird.driver.core.create_database`.
 * Fix (#2): error when handling input parameters with value None
 * Added `.Server.mode` attribute to allow fetching service output using LINE or TO_EOF method.
   Default mode is TO_EOF.

docs/conf.py

@@ -23,10 +23,10 @@
 author = 'Pavel Císař'
 
 # The short X.Y version
-version = '1.5.2'
+version = '1.6.0'
 
 # The full version, including alpha/beta/rc tags
-release = '1.5.2'
+release = '1.6.0'
 
 
 # -- General configuration ---------------------------------------------------
@@ -35,11 +35,14 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
+    'sphinx.ext.autodoc',
     'sphinx.ext.napoleon',
-    'sphinx_autodoc_typehints',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.autosectionlabel',
+    #'sphinx_autodoc_typehints',
     'sphinx.ext.todo',
+    #'sphinx.ext.coverage',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -157,6 +160,8 @@
 
 # -- Extension configuration -------------------------------------------------
 
+autosectionlabel_prefix_document = True
+
 # Autodoc options
 # ---------------
 autodoc_default_options = {
@@ -167,9 +172,14 @@
     'exclude-members': '__weakref__',
     'show-inheritance': True,
     'no-inherited-members': True,
+    'no-private-members': True,
 }
 set_type_checking_flag = True
-#always_document_param_types = True
+autodoc_class_signature = 'mixed'
+always_document_param_types = True
+autodoc_typehints = 'both' # default 'signature'
+autodoc_typehints_format = 'short'
+autodoc_typehints_description_target = 'all'
 
 # Napoleon options
 # ----------------
@@ -181,13 +191,18 @@
 napoleon_use_admonition_for_references = True
 napoleon_use_ivar = False
 napoleon_use_rtype = True
+napoleon_use_param = True
+napoleon_use_keyword = True
 napoleon_attr_annotations = True
+napoleon_preprocess_types = True
 
 # -- Options for intersphinx extension ---------------------------------------
 
 # intersphinx
 intersphinx_mapping = {'python': ('https://docs.python.org/3', None),
-                       'base': ('https://firebird-base.rtfd.io/en/latest', None)}
+                       'base': ('https://firebird-base.rtfd.io/en/latest', None),
+                       'lib': ('https://firebird-lib.rtfd.io/en/latest', None),
+                       }
 
 # -- Options for todo extension ----------------------------------------------
 

docs/firebird-driver.docset/Contents/Resources/Documents/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 3c3dc2b06609adf777633065a6873ca0
+config: 85d86d883df12c911984cba0c10182ef
 tags: 645f666f9bcd5a90fca523b33c5a78b7