Release v1.4.2

Author: pcisar

docs/_static/basic.css

@@ -641,3 +641,43 @@ 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;
+}
+

docs/buffer.txt

@@ -19,17 +19,12 @@ MemoryBuffer
 Buffer factories
 ================
 
-Buffer factory protocol
------------------------
-
 .. autoclass:: BufferFactory
 
-bytes factory
 -------------
 
 .. autoclass:: BytesBufferFactory
 
-ctypes factory
 --------------
 
 .. autoclass:: CTypesBufferFactory

docs/changelog.txt

@@ -2,6 +2,21 @@
 Changelog
 #########
 
+Version 1.4.2
+=============
+
+* Optimizations.
+* Cleanup of pylint warnings.
+* Updated documentation.
+* Fixed unregistered bugs:
+
+  - Signature in `firebird.base.config.IntOption.clear`.
+  - Signature in `firebird.base.trace.TraceManager.add_trace`. Keyword argument `decorator`
+    (with default) could not be used with args/kwargs, so it was removed. New
+    `~firebird.base.trace.TraceManager.decorator` attribute was added to
+    `~firebird.base.trace.TraceManager` that could be used to change trace decorator used
+    for intrumentation.
+
 Version 1.4.1
 =============
 
@@ -32,7 +47,7 @@ Version 1.3.0
 
 * `~firebird.base.config` module:
 
-  - Layout produced by `.get_config()` was changed.
+  - Layout produced by `~firebird.base.config.get_config()` was changed.
   - `.Config` has new constructor keyword-only argument `description`.
   - Fix: uregistered bug in config.ListOption - value and default was the same instance
 

docs/collections.txt

@@ -41,23 +41,19 @@ Types for type hints & annotations
 Collections
 ===========
 
-BaseObjectCollection
---------------------
 .. autoclass:: BaseObjectCollection
 
-DataList
 --------
+
 .. autoclass:: DataList
 
-Registry
 --------
+
 .. autoclass:: Registry
 
 Functions
 =========
 
-make_lambda
------------
 .. autofunction:: make_lambda
 
 

docs/conf.py

@@ -23,10 +23,10 @@
 author = 'Pavel Císař'
 
 # The short X.Y version
-version = '1.4.1'
+version = '1.4.2'
 
 # The full version, including alpha/beta/rc tags
-release = '1.4.1'
+release = '1.4.2'
 
 
 # -- General configuration ---------------------------------------------------
@@ -35,12 +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',
+    #'sphinx.ext.coverage',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -61,6 +63,8 @@
 
 # -- Options for HTML output -------------------------------------------------
 
+html_favicon = '_static/fb-favicon.png'
+
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
@@ -158,6 +162,8 @@
 
 # -- Extension configuration -------------------------------------------------
 
+autosectionlabel_prefix_document = True
+
 # Autodoc options
 # ---------------
 autodoc_default_options = {
@@ -170,17 +176,33 @@
     'no-inherited-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'
+
+autodoc_type_aliases = {'Item': '~firebird.base.collections.Item',
+                        'TypeSpec': '~firebird.base.collections.TypeSpec',
+                        'ItemExpr': '~firebird.base.collections.ItemExpr',
+                        'FilterExpr': '~firebird.base.collections.FilterExpr',
+                        'CheckExpr': '~firebird.base.collections.CheckExpr',
+                        }
 
 # Napoleon options
 # ----------------
 napoleon_include_init_with_doc = True
 napoleon_include_private_with_doc = True
 napoleon_include_special_with_doc = True
-napoleon_use_admonition_for_examples = True
+napoleon_use_admonition_for_examples = False
 napoleon_use_admonition_for_notes = True
 napoleon_use_admonition_for_references = True
-#napoleon_use_ivar = 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 ---------------------------------------
 

docs/config.txt

@@ -89,7 +89,7 @@ First, you need to define your own configuration.
            self.master_db: DbConfig = DbConfig('master-db')
            self.backup_db: DbConfig = DbConfig('backup-db')
 
-.. note::
+.. important::
 
    Option must be assigned to Config attributes with the same name as option name.
 
@@ -306,14 +306,17 @@ The protobuf message is defined in :file:`/proto/config.proto`.
 
    .. seealso:: `.ConfigOption`, `.ConfigListOption`
 
+Constants
+=========
+
+.. data:: PROTO_CONFIG
+   :annotation: Fully qualified name for `ConfigProto`_ protobuf.
+
 .. tip::
 
    To address `ConfigProto`_ in functions like `~firebird.base.protobuf.create_message()`,
    use `PROTO_CONFIG` constant.
 
-.. data:: PROTO_CONFIG
-   :annotation: Fully qualified name for `ConfigProto`_ protobuf.
-
 
 Application Directory Scheme
 ============================
@@ -324,104 +327,106 @@ Application Directory Scheme
 
 .. autoclass:: DirectoryScheme
 
+-----
+
 .. autoclass:: WindowsDirectoryScheme
 
+-----
+
 .. autoclass:: LinuxDirectoryScheme
 
+-----
+
 .. autoclass:: MacOSDirectoryScheme
 
+-----
+
 .. autofunction:: get_directory_scheme
 
 Config
 ======
 
-Config
-------
 .. autoclass:: Config
 
 Options
 =======
 
-Option
-------
 .. autoclass:: Option
 
-StrOption
----------
+-----
+
 .. autoclass:: StrOption
 
-IntOption
----------
+-----
+
 .. autoclass:: IntOption
 
-FloatOption
------------
+-----
+
 .. autoclass:: FloatOption
 
-DecimalOption
--------------
+-----
+
 .. autoclass:: DecimalOption
 
-BoolOption
-----------
+-----
+
 .. autoclass:: BoolOption
 
-ZMQAddressOption
-----------------
+-----
+
 .. autoclass:: ZMQAddressOption
 
-EnumOption
-----------
+-----
+
 .. autoclass:: EnumOption
 
-FlagOption
-----------
+-----
+
 .. autoclass:: FlagOption
 
-UUIDOption
-----------
+-----
+
 .. autoclass:: UUIDOption
 
-MIMEOption
-----------
+-----
+
 .. autoclass:: MIMEOption
 
-ListOption
-----------
+-----
+
 .. autoclass:: ListOption
 
-DataclassOption
----------------
+-----
+
 .. autoclass:: DataclassOption
 
-PathOption
-----------
+-----
+
 .. autoclass:: PathOption
 
-PyExprOption
-------------
+-----
+
 .. autoclass:: PyExprOption
 
-PyCodeOption
-------------
+-----
+
 .. autoclass:: PyCodeOption
 
-PyCallableOption
-----------------
+-----
+
 .. autoclass:: PyCallableOption
 
-ConfigOption
-------------
+-----
+
 .. autoclass:: ConfigOption
 
-ConfigListOption
-----------------
+-----
+
 .. autoclass:: ConfigListOption
 
 Functions
 =========
 
-create_config
--------------
 .. autofunction:: create_config
 

docs/firebird-base.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: 9305cd2bf6ad568008c57dfe7bbf87a0
+config: 17c3c05c66ed7574c1d99f328dd94484
 tags: 645f666f9bcd5a90fca523b33c5a78b7