Typehints etc: Not yet the docstrings, but the base to create docstrings

.docker/docker-compose.gh.yml

@@ -1,4 +1,3 @@
-version: '3'
 services:
   postgres13:
     image: postgis/postgis:13-3.4-alpine

.github/workflows/continuous_integration.yml

@@ -18,7 +18,7 @@ jobs:
     strategy:
       fail-fast: false  # keep for now, since 3.22 and 3.28 have different bases than 3.34+
       matrix:
-        qgis_version: [release-3_22, release-3_28, 3.34, latest]
+        qgis_version: [release-3_22, release-3_28, '3.34', '3.40', latest]
     env:
       QGIS_TEST_VERSION: ${{ matrix.qgis_version }}
     steps:

modelbaker/dataobjects/fields.py

@@ -1,21 +1,16 @@
 """
-/***************************************************************************
-                              -------------------
-        begin                : 2017-04-12
-        git sha              : :%H$
-        copyright            : (C) 2017 by OPENGIS.ch
-        email                : [email protected]
- ***************************************************************************/
+Metadata:
+    Creation Date: 2017-04-12
+    Copyright: (C) 2017 by OPENGIS.ch
+    Contact: [email protected]
 
-/***************************************************************************
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- ***************************************************************************/
+License:
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the **GNU General Public License** as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
 """
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING

modelbaker/dataobjects/form.py

@@ -1,21 +1,16 @@
 """
-/***************************************************************************
-                              -------------------
-        begin                : 08/08/17
-        git sha              : :%H$
-        copyright            : (C) 2017 by OPENGIS.ch
-        email                : [email protected]
- ***************************************************************************/
-
-/***************************************************************************
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- ***************************************************************************/
+Metadata:
+    Creation Date: 2017-08-08
+    Copyright: (C) 2017 by OPENGIS.ch
+    Contact: [email protected]
+
+License:
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the **GNU General Public License** as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
 """
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING, Optional, Union

modelbaker/dataobjects/layers.py

@@ -1,21 +1,16 @@
 """
-/***************************************************************************
-                              -------------------
-        begin                : 2016-11-14
-        git sha              : :%H$
-        copyright            : (C) 2016 by OPENGIS.ch
-        email                : [email protected]
- ***************************************************************************/
-
-/***************************************************************************
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- ***************************************************************************/
+Metadata:
+    Creation Date: 2016-11-14
+    Copyright: (C) 2016 by OPENGIS.ch
+    Contact: [email protected]
+
+License:
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the **GNU General Public License** as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
 """
+
 from __future__ import annotations
 
 import logging
@@ -46,18 +41,18 @@
 class Layer:
     def __init__(
         self,
-        provider: str = None,
-        uri: str = None,
-        name: str = None,
+        provider: Optional[str] = None,
+        uri: Optional[str] = None,
+        name: Optional[str] = None,
         srid: Optional[int] = None,
         extent: Optional[str] = None,
-        geometry_column: str = None,
+        geometry_column: Optional[str] = None,
         wkb_type: QgsWkbTypes = QgsWkbTypes.Type.Unknown,
         alias: Optional[str] = None,
         is_domain: bool = False,  # is enumeration or catalogue
         is_structure: bool = False,
         is_nmrel: bool = False,
-        display_expression: str = None,
+        display_expression: Optional[str] = None,
         coordinate_precision: Optional[float] = None,
         is_basket_table: bool = False,
         is_dataset_table: bool = False,
@@ -73,7 +68,7 @@ def __init__(
         qmlstylefile: Optional[str] = None,
         styles: dict[str, dict[str, str]] = {},
         is_enum: bool = False,
-        base_class: str = None,
+        base_class: Optional[str] = None,
         provider_names_map: dict[
             str, str
         ] = {},  # provider specific column names (e.g. T_Id vs t_id)

modelbaker/dataobjects/legend.py

@@ -1,21 +1,16 @@
 """
-/***************************************************************************
-                              -------------------
-        begin                : 2016-12-21
-        git sha              : :%H$
-        copyright            : (C) 2016 by OPENGIS.ch
-        email                : [email protected]
- ***************************************************************************/
-
-/***************************************************************************
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- ***************************************************************************/
+Metadata:
+    Creation Date: 2021-12-16
+    Copyright: (C) 2016 by OPENGIS.ch
+    Contact: [email protected]
+
+License:
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the **GNU General Public License** as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
 """
+
 from __future__ import annotations
 
 from typing import Any, Optional, Union
@@ -34,9 +29,9 @@
 class LegendGroup:
     def __init__(
         self,
-        name: str = None,
+        name: Optional[str] = None,
         expanded: bool = True,
-        ignore_node_names: bool = None,
+        ignore_node_names: Optional[list[str]] = [],
         static_sorting: bool = False,
     ) -> None:
         self.name = name

modelbaker/dataobjects/project.py

@@ -1,21 +1,16 @@
 """
-/***************************************************************************
-                              -------------------
-        begin                : 2016-12-21
-        git sha              : :%H$
-        copyright            : (C) 2016 by OPENGIS.ch
-        email                : [email protected]
- ***************************************************************************/
-
-/***************************************************************************
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- ***************************************************************************/
+Metadata:
+    Creation Date: 2021-12-16
+    Copyright: (C) 2016 by OPENGIS.ch
+    Contact: [email protected]
+
+License:
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the **GNU General Public License** as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
 """
+
 from __future__ import annotations
 
 from typing import Any, Optional

modelbaker/db_factory/db_command_config_manager.py

@@ -1,23 +1,20 @@
 """
-/***************************************************************************
-    begin                :    13/05/19
-    git sha              :    :%H$
-    copyright            :    (C) 2019 by Yesid Polania
-    email                :    [email protected]
- ***************************************************************************/
-
-/***************************************************************************
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- ***************************************************************************/
+Metadata:
+    Creation Date: 2019-05-13
+    Copyright: (C) 2019 by Yesid Polania
+    Contact: [email protected]
+
+License:
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the **GNU General Public License** as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
 """
+
 from __future__ import annotations
 
 from abc import ABC, abstractmethod
+from typing import Optional
 
 from ..iliwrapper.ili2dbconfig import (
     Ili2DbCommandConfiguration,
@@ -30,55 +27,51 @@ class DbCommandConfigManager(ABC):
 
     Provides database uri, arguments to ili2db and a way to save and load configurations parameters
     based on a object configuration.
-
-    :ivar configuration object that will be managed
     """
 
     def __init__(self, configuration: Ili2DbCommandConfiguration) -> None:
-        """
-        :param configuration: Configuration object that will be managed.
-        :type configuration: :class:`Ili2DbCommandConfiguration`
-        """
         self.configuration = configuration
 
     @abstractmethod
     def get_uri(
-        self, su: bool = False, qgis: bool = False, fallback_user: str = None
+        self, su: bool = False, qgis: bool = False, fallback_user: Optional[str] = None
     ) -> str:
-        """Gets database uri (connection string) for db connectors (:class:`DBConnector`).
+        """Gets database uri (connection string) for db connectors (DBConnector).
 
-        :param bool su: *True* to use super user credentials, *False* otherwise.
-        :param bool qgis: *True* to use qgis specific credentials (e.g. authcfg), *False* otherwise.
-        :param str fallback_user: a username as fallback most possibly used when you want to pass your os account name to connect the database
-        :return: Database uri (connection string).
-        :rtype str
-        """
+        Args:
+            su (bool): *True* to use super user credentials, *False* otherwise.
+            qgis (bool): *True* to use qgis specific credentials (e.g. authcfg), *False* otherwise.
+            fallback_user (str): a username as fallback most possibly used when you want to pass your os account name to connect the database
+
+        Returns:
+            str: Database uri (connection string)."""
 
     @abstractmethod
     def get_db_args(self, hide_password: bool = False, su: bool = False) -> list[str]:
         """Gets a list of ili2db arguments related to database.
 
-        :param bool hide_password: *True* to mask the password, *False* otherwise.
-        :param bool su: *True* to use super user password, *False* otherwise. Default is False.
-        :return: ili2db arguments list.
-        :rtype: list
-        """
+        Args:
+            hide_password (bool): *True* to mask the password, *False* otherwise.
+            su (bool): *True* to use super user password, *False* otherwise. Default is False.
+
+        Returns:
+            list: ili2db arguments list."""
 
     def get_schema_import_args(self) -> list[str]:
         """Gets a list of ili2db arguments to use in operation schema import.
 
-        :return: ili2db arguments list.
-        :rtype: list
-        """
+        Returns:
+            list: ili2db arguments list."""
         return list()
 
     def get_ili2db_args(self, hide_password: bool = False) -> list[str]:
         """Gets a complete list of ili2db arguments in order to execute the app.
 
-        :param bool hide_password: *True* to mask the password, *False* otherwise.
-        :return: ili2db arguments list.
-        :rtype: list
-        """
+        Args:
+            hide_password (bool): *True* to mask the password, *False* otherwise.
+
+        Returns:
+            list: ili2db arguments list."""
         db_args = self.get_db_args(hide_password, self.configuration.db_use_super_login)
 
         if type(self.configuration) is SchemaImportConfiguration:
@@ -90,14 +83,8 @@ def get_ili2db_args(self, hide_password: bool = False) -> list[str]:
 
     @abstractmethod
     def save_config_in_qsettings(self) -> None:
-        """Saves configuration values related to database in QSettings.
-
-        :return: None
-        """
+        """Saves configuration values related to database in QSettings."""
 
     @abstractmethod
     def load_config_from_qsettings(self) -> None:
-        """Loads configuration values related to database from Qsettings.
-
-        :return: None
-        """
+        """Loads configuration values related to database from Qsettings."""