Converted reSt docstrings to google docstrings - yes, done by AI but checked by real code monkey

Author: signedav

modelbaker/db_factory/db_command_config_manager.py

@@ -24,17 +24,16 @@
 class DbCommandConfigManager(ABC):
     """Manages a configuration object to return specific information of some database. This is a abstract class.
 
-    Provides database uri, arguments to ili2db and a way to save and load configurations parameters
-    based on a object configuration.
+        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
-    """
+    configuration object that will be managed"""
 
     def __init__(self, configuration: Ili2DbCommandConfiguration) -> None:
         """
-        :param configuration: Configuration object that will be managed.
-        :type configuration: :class:`Ili2DbCommandConfiguration`
-        """
+
+        Args:
+            configuration (:class:`Ili2DbCommandConfiguration`): Configuration object that will be managed."""
         self.configuration = configuration
 
     @abstractmethod
@@ -43,38 +42,40 @@ def get_uri(
     ) -> str:
         """Gets database uri (connection string) for db connectors (:class:`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:
+            fallback_user (str): a username as fallback most possibly used when you want to pass your os account name to connect the database
+            qgis (bool): *True* to use qgis specific credentials (e.g. authcfg), *False* otherwise.
+            su (bool): *True* to use super user credentials, *False* otherwise.
+
+        Returns:
+            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:
@@ -88,12 +89,12 @@ def get_ili2db_args(self, hide_password: bool = False) -> list[str]:
     def save_config_in_qsettings(self) -> None:
         """Saves configuration values related to database in QSettings.
 
-        :return: None
-        """
+        Returns:
+            None"""
 
     @abstractmethod
     def load_config_from_qsettings(self) -> None:
         """Loads configuration values related to database from Qsettings.
 
-        :return: None
-        """
+        Returns:
+            None"""

modelbaker/db_factory/db_factory.py

@@ -30,72 +30,71 @@ class DbFactory(ABC):
     def get_db_connector(self, uri: str, schema: Optional[str]) -> DBConnector:
         """Returns an instance of connector to database (:class:`DBConnector`).
 
-        :param str uri: Database connection string.
-        :param str schema: Database schema.
-        :return: A connector to specific database.
-        :rtype: :class:`DBConnector`
-        :raises :class:`DBConnectorError`: when the connection fails.
-        """
+        Args:
+            schema (str): Database schema.
+            uri (str): Database connection string.
+
+        Returns:
+            :class:`DBConnector`: A connector to specific database."""
 
     @abstractmethod
     def get_db_command_config_manager(
         self, configuration: Ili2DbCommandConfiguration
     ) -> DbCommandConfigManager:
         """Returns an instance of a database command config manager.
 
-        :param configuration: Configuration object that will be managed.
-        :type configuration: :class:`Ili2DbCommandConfiguration`
-        :return: Object that manages a configuration object to return specific information of some database.
-        :rtype :class:`DbCommandConfigManager`
-        """
+        Args:
+            configuration (:class:`Ili2DbCommandConfiguration`): Configuration object that will be managed.
+
+        Returns:
+            Object that manages a configuration object to return specific information of some database."""
 
     @abstractmethod
     def get_layer_uri(self, uri: str) -> LayerUri:
         """Returns an instance of a layer uri.
 
-        :param str uri: Database connection string.
-        :return: A object that provides layer uri.
-        :rtype :class:`LayerUri`
-        """
+        Args:
+            uri (str): Database connection string.
+
+        Returns:
+            A object that provides layer uri."""
 
     @abstractmethod
     def pre_generate_project(
         self, configuration: Ili2DbCommandConfiguration
     ) -> tuple[bool, str]:
         """This method will be called before an operation of generate project is executed.
 
-        :param configuration: Configuration parameters with which will be executed the operation of generate project.
-        :type configuration: :class:`Ili2DbCommandConfiguration`
-        :return: *True* and an empty message if the called method was succeeded, *False* and a warning message otherwise.
-        """
+        Args:
+            configuration (:class:`Ili2DbCommandConfiguration`): Configuration parameters with which will be executed the operation of generate project.
+
+        Returns:
+            *True* and an empty message if the called method was succeeded, *False* and a warning message otherwise."""
 
     @abstractmethod
     def post_generate_project_validations(
         self, configuration: Ili2DbCommandConfiguration, fallback_user: str = None
     ) -> tuple[bool, str]:
         """This method will be called after an operation of generate project is executed.
 
-        :param class:`Ili2DbCommandConfiguration` configuration: Configuration parameters with which were executed the operation of generate project.
-        :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: *True* and an empty message if the called method was succeeded, *False* and a warning message otherwise.
-        """
+        Args:
+            class: `Ili2DbCommandConfiguration` configuration: Configuration parameters with which were executed the operation of generate project.
+            fallback_user (str): a username as fallback most possibly used when you want to pass your os account name to connect the database
 
-    def get_specific_messages(self) -> dict[str, str]:
-        """Returns specific words that will be used in warning and error messages.
+        Returns:
+            *True* and an empty message if the called method was succeeded, *False* and a warning message otherwise."""
 
-        :rtype dict
-        """
+    def get_specific_messages(self) -> dict[str, str]:
+        """Returns specific words that will be used in warning and error messages."""
         messages = {"db_or_schema": "schema", "layers_source": "schema"}
 
         return messages
 
     def customize_widget_editor(self, field: Field, data_type: str) -> None:
         """Allows customizing the way a field is shown in the widget editor.
 
-        For instance, a boolean field can be shown as a checkbox.
+                For instance, a boolean field can be shown as a checkbox.
 
-        :param field: The field that will be customized
-        :type field: :class:`Field`
-        :param data_type: The type of field
-        :return None
-        """
+        Args:
+            data_type: The type of field
+            field (:class:`Field`): The field that will be customized"""

modelbaker/db_factory/db_simple_factory.py

@@ -46,10 +46,11 @@ class DbSimpleFactory:
     def create_factory(self, ili_mode: DbIliMode) -> Optional[DbFactory]:
         """Creates an instance of :class:`DbFactory` based on ili_mode parameter.
 
-        :param ili_mode: Value specifying which factory will be instantiated.
-        :type ili_mode: :class:`DbIliMode`
-        :return: A database factory
-        """
+        Args:
+            ili_mode (:class:`DbIliMode`): Value specifying which factory will be instantiated.
+
+        Returns:
+            A database factory"""
         if not ili_mode:
             return None
 
@@ -69,13 +70,14 @@ def create_factory(self, ili_mode: DbIliMode) -> Optional[DbFactory]:
     def get_db_list(self, is_schema_import: bool = False) -> list[DbIliMode]:
         """Gets a list containing the databases available in modelbaker.
 
-        This list can be used to show the available databases in GUI, for example, **QComboBox source**
-        in **Import Data Dialog**.
+                This list can be used to show the available databases in GUI, for example, **QComboBox source**
+                in **Import Data Dialog**.
+
+        Args:
+            is_schema_import (bool): *True* to include interlis operation values, *False* otherwise.
 
-        :param bool is_schema_import: *True* to include interlis operation values, *False* otherwise.
-        :return: A list containing the databases available.
-        :rtype: list
-        """
+        Returns:
+            list: A list containing the databases available."""
         ili = []
         result = available_database_factories.keys()
 
@@ -91,7 +93,6 @@ def get_db_list(self, is_schema_import: bool = False) -> list[DbIliMode]:
     def default_database(self) -> DbIliMode:
         """Gets a default database for modelbaker.
 
-        :return: Default database for modelbaker.
-        :rtype: :class:`DbIliMode`
-        """
+        Returns:
+            :class:`DbIliMode`: Default database for modelbaker."""
         return list(available_database_factories.keys())[0]

modelbaker/db_factory/gpkg_command_config_manager.py

@@ -22,11 +22,10 @@
 class GpkgCommandConfigManager(DbCommandConfigManager):
     """Manages a configuration object to return specific information of Geopackage.
 
-    Provides database uri, arguments to ili2db and a way to save and load configurations parameters
-    based on a object configuration.
+        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
-    """
+    configuration object that will be managed"""
 
     _settings_base_path = "ili2gpkg/"
 

modelbaker/db_factory/gpkg_layer_uri.py

@@ -17,10 +17,9 @@
 class GpkgLayerUri(LayerUri):
     """Provides layer uri based on database uri (connection string) and specific information of the data source.
 
-    This **layer uri** is used to create a Qgis layer.
+        This **layer uri** is used to create a Qgis layer.
 
-    :ivar str uri: Database uri.
-    """
+    str uri: Database uri."""
 
     def __init__(self, uri: str) -> None:
         LayerUri.__init__(self, uri)

modelbaker/db_factory/layer_uri.py

@@ -17,24 +17,24 @@
 class LayerUri(ABC):
     """Provides layer uri based on database uri (connection string) and specific information of the data source. This is a abstract class.
 
-    This **layer uri** is used to create a Qgis layer.
+        This **layer uri** is used to create a Qgis layer.
 
-    :ivar str uri: Database uri.
-    :ivar str provider: Database provider.
-    """
+    str provider: Database provider."""
 
     def __init__(self, uri: str) -> None:
         """
-        :param str uri: Database uri. This is the same database uri of the db connectors.
-        """
+
+        Args:
+            uri (str): Database uri. This is the same database uri of the db connectors."""
         self.uri = uri
         self.provider = None
 
     @abstractmethod
     def get_data_source_uri(self, record: dict) -> str:
         """Provides layer uri based on database uri and specific information of the data source.
 
-        :param str record: Dictionary containing specific information of the data source.
-        :return: Layer uri.
-        :rtype: str
-        """
+        Args:
+            record (str): Dictionary containing specific information of the data source.
+
+        Returns:
+            str: Layer uri."""

modelbaker/db_factory/pg_command_config_manager.py

@@ -23,11 +23,10 @@
 class PgCommandConfigManager(DbCommandConfigManager):
     """Manages a configuration object to return specific information of Postgres/Postgis.
 
-    Provides database uri, arguments to ili2db and a way to save and load configurations parameters
-    based on a object configuration.
+        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
-    """
+    configuration object that will be managed"""
 
     _settings_base_path = "ili2pg/"
 

modelbaker/db_factory/pg_layer_uri.py

@@ -17,10 +17,9 @@
 class PgLayerUri(LayerUri):
     """Provides layer uri based on database uri (connection string) and specific information of the data source.
 
-    This **layer uri** is used to create a Qgis layer.
+        This **layer uri** is used to create a Qgis layer.
 
-    :ivar str uri: Database uri.
-    """
+    str uri: Database uri."""
 
     def __init__(self, uri: str) -> None:
         LayerUri.__init__(self, uri)

modelbaker/generator/generator.py

@@ -52,11 +52,11 @@ def __init__(
         raw_naming=False,
     ) -> None:
         """
-        Creates a new Generator objects.
-        :param uri: The uri that should be used in the resulting project. If authcfg is used, make sure the mgmt_uri is set as well.
-        :param mgmt_uri: The uri that should be used to create schemas, tables and query meta information. Does not support authcfg but a fallback username.
-        :consider_basket_handling: Makes the specific handling of basket tables depending if schema is created with createBasketCol.
-        """
+                Creates a new Generator objects.
+
+        Args:
+            mgmt_uri: The uri that should be used to create schemas, tables and query meta information. Does not support authcfg but a fallback username.
+            uri: The uri that should be used in the resulting project. If authcfg is used, make sure the mgmt_uri is set as well."""
         QObject.__init__(self, parent)
         self.tool = tool
         self.uri = uri

modelbaker/iliwrapper/ili2dbargs.py

@@ -23,10 +23,11 @@
 def get_ili2db_args(configuration, hide_password=False):
     """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 = _get_db_args(configuration, hide_password)
 
     if type(configuration) is SchemaImportConfiguration: