solve length for str fields

jord/__init__.py

@@ -8,7 +8,7 @@
 
 __project__ = "Jord"
 __author__ = "Christian Heider Lindbjerg"
-__version__ = "0.7.9"
+__version__ = "0.8.0"
 __doc__ = r"""
 .. module:: jord
    :platform: Unix, Windows
@@ -28,7 +28,7 @@
 PROJECT_VERSION = __version__
 PROJECT_YEAR = 2018
 PROJECT_AUTHOR = clean_string(__author__)
-PROJECT_ORGANISATION = clean_string("Automaps")
+PROJECT_ORGANISATION = clean_string("MapsPeople")
 PROJECT_APP_PATH = AppPath(app_name=PROJECT_NAME, app_author=PROJECT_AUTHOR)
 INCLUDE_PROJECT_READMES = False
 VERBOSE = False

jord/qgis_utilities/fields.py

@@ -0,0 +1,261 @@
+import logging
+from typing import Any, Iterable, Sequence
+
+# noinspection PyUnresolvedReferences
+from qgis.core import QgsDefaultValue, QgsEditorWidgetSetup, QgsFieldConstraints
+
+__all__ = [
+    "add_dropdown_widget",
+    "make_field_unique",
+    "HIDDEN_WIDGET",
+    "make_field_not_null",
+    "make_field_default",
+    "make_field_boolean",
+    "make_field_reuse_last_entered_value",
+]
+
+IGNORE_THIS_STRING = """
+
+Line edit – a simple edit box
+Classification – displays a combo box with the values used for “unique value” classification (symbology tab)
+Range – allows numeric values within a given range, the widget can be either slider or spin box
+Unique values
+    editable – displays a line edit widget with auto-completion suggesting values already used in the
+    attribute table
+    not editable – displays a combo box with already used values
+File name – adds a file chooser dialog
+Value map – shows a combo box with predefined description/value items
+Enumeration – a combo box with values that can be used within the columns type
+Immutable – read-only
+Hidden – makes the attribute invisible for the user
+CheckBox – a checkbox with customizable representation for both checked and unchecked state
+Text edit – an edit box that allow multiple input lines
+Calendar – a calendar widget to input dates
+"""
+
+IGNORE_THIS_STRING2 = """
+QGIS Widget Types
+_________________
+
+Binary
+
+Checkbox
+
+Classification
+
+Color
+
+DateTime
+
+Enumeration
+
+Attachment
+
+Geometry
+
+Hidden
+
+JsonView
+
+KeyValue
+
+List
+
+Range
+
+RelationReference
+
+TextEdit
+
+UniqueValues
+
+UuidGenerator
+
+ValueMap
+
+ValueRelation
+
+"""
+
+HIDDEN_WIDGET = QgsEditorWidgetSetup("Hidden", {})
+CHECKBOX_WIDGET = QgsEditorWidgetSetup(
+    "CheckBox",
+    {
+        "Checked state": "True",
+        "Unchecked state": "False",
+    },
+)
+UNIQUE_VALUES_WIDGET = QgsEditorWidgetSetup(
+    "UniqueValues",
+    {"Editable": True},
+)
+
+logger = logging.getLogger(__name__)
+
+
+def add_dropdown_widget(layer: Any, field_name: str, widget: Any) -> None:
+    # https://gis.stackexchange.com/questions/470963/setting-dropdown-on-feature-attribute-form-using-plugin
+    for layers_inner in layer:
+        if layers_inner:
+            if isinstance(layers_inner, Iterable):
+                for layer in layers_inner:
+                    if layer:
+                        layer.setEditorWidgetSetup(
+                            layer.fields().indexFromName(field_name),
+                            widget,
+                        )
+            else:
+                layers_inner.setEditorWidgetSetup(
+                    layers_inner.fields().indexFromName(field_name),
+                    widget,
+                )
+
+
+def make_field_unique(
+    layers: Sequence[Any], field_name: str = "admin_id", auto_generate: bool = True
+) -> None:
+    unique_widget = None
+    default_value_generator = None
+
+    if False:
+        unique_widget = QgsEditorWidgetSetup(
+            "UuidGenerator",
+            {},
+        )
+        if False:
+            logger.error(unique_widget.config())
+    elif auto_generate:
+        default_value_generator = QgsDefaultValue()
+        default_value_generator.setExpression("rtrim( ltrim( uuid(), '{'), '}')")
+    else:
+        unique_widget = UNIQUE_VALUES_WIDGET
+
+    for layers_inner in layers:
+        if layers_inner:
+            if isinstance(layers_inner, Iterable):
+                for layer in layers_inner:
+                    if layer:
+                        idx = layer.fields().indexFromName(field_name)
+                        if unique_widget:
+                            layer.setEditorWidgetSetup(
+                                idx,
+                                unique_widget,
+                            )
+                        elif default_value_generator:
+                            layer.setDefaultValueDefinition(
+                                idx, default_value_generator
+                            )
+                        else:
+                            raise NotImplementedError
+
+                        layer.setFieldConstraint(
+                            idx, QgsFieldConstraints.ConstraintNotNull
+                        )
+                        layer.setFieldConstraint(
+                            idx, QgsFieldConstraints.ConstraintUnique
+                        )
+            else:
+                idx = layers_inner.fields().indexFromName(field_name)
+                if unique_widget:
+                    layers_inner.setEditorWidgetSetup(
+                        idx,
+                        unique_widget,
+                    )
+                elif default_value_generator:
+                    layers_inner.setDefaultValueDefinition(idx, default_value_generator)
+                else:
+                    raise NotImplementedError
+
+                layers_inner.setFieldConstraint(
+                    idx, QgsFieldConstraints.ConstraintNotNull
+                )
+                layers_inner.setFieldConstraint(
+                    idx, QgsFieldConstraints.ConstraintUnique
+                )
+
+
+def make_field_not_null(layers: Sequence[Any], field_name: str = "name") -> None:
+    for layers_inner in layers:
+        if layers_inner:
+            if isinstance(layers_inner, Iterable):
+                for layers in layers_inner:
+                    if layers:
+                        idx = layers.fields().indexFromName(field_name)
+
+                        layers.setFieldConstraint(
+                            idx, QgsFieldConstraints.ConstraintNotNull
+                        )
+            else:
+                idx = layers_inner.fields().indexFromName(field_name)
+
+                layers_inner.setFieldConstraint(
+                    idx, QgsFieldConstraints.ConstraintNotNull
+                )
+
+
+def make_field_default(
+    layers: Sequence[Any], field_name: str, default_expression: str = "'None'"
+) -> None:
+    default_value = QgsDefaultValue()
+    default_value.setExpression(default_expression)
+
+    for layers_inner in layers:
+        if layers_inner:
+            if isinstance(layers_inner, Iterable):
+                for layers in layers_inner:
+                    if layers:
+                        layers.setDefaultValueDefinition(
+                            layers.fields().indexFromName(field_name), default_value
+                        )
+            else:
+                layers_inner.setDefaultValueDefinition(
+                    layers_inner.fields().indexFromName(field_name), default_value
+                )
+
+
+def make_field_boolean(layers: Sequence[Any], field_name: str) -> None:
+    for layers_inner in layers:
+        if layers_inner:
+            if isinstance(layers_inner, Iterable):
+                for layers in layers_inner:
+                    if layers:
+                        layers.setDefaultValueDefinition(
+                            layers.fields().indexFromName(field_name), CHECKBOX_WIDGET
+                        )
+            else:
+                layers_inner.setEditorWidgetSetup(
+                    layers_inner.fields().indexFromName(field_name),
+                    CHECKBOX_WIDGET,
+                )
+
+
+def make_field_reuse_last_entered_value(layers: Sequence[Any], field_name: str) -> None:
+    for layers_inner in layers:
+        if layers_inner:
+            if isinstance(layers_inner, Iterable):
+                for layer in layers_inner:
+                    if layer:
+                        layer_form_config = layer.editFormConfig()
+                        layer_form_config.setReuseLastValue(
+                            layers.fields().indexFromName(field_name), True
+                        )
+                        layer.setEditFormConfig(layer_form_config)
+            else:
+                layer_form_config = layers_inner.editFormConfig()
+                layer_form_config.setReuseLastValue(
+                    layers_inner.fields().indexFromName(field_name), True
+                )
+                layers_inner.setEditFormConfig(layer_form_config)
+
+
+def fit_field_to_length(layers: Sequence[Any], field_name: str, length: int) -> None:
+    for layers_inner in layers:
+        if layers_inner:
+            if isinstance(layers_inner, Iterable):
+                for layer in layers_inner:
+                    if layer:
+                        fields = layer.fields()
+                        fields[fields.indexFromName(field_name)].setLength(length)
+            else:
+                fields = layers_inner.fields()
+                fields[fields.indexFromName(field_name)].setLength(length)

jord/qgis_utilities/helpers/actions.py

@@ -2,7 +2,10 @@
 
 from typing import Any
 
+# noinspection PyUnresolvedReferences
 from qgis.PyQt.QtGui import QIcon
+
+# noinspection PyUnresolvedReferences
 from qgis.PyQt.QtWidgets import QAction, QWidget
 
 from jord.qgis_utilities.helpers.signals import reconnect_signal

jord/qgis_utilities/helpers/garbage_collection.py

@@ -1,4 +1,4 @@
-def gc_layers():
+def gc_layers() -> None:
     # noinspection PyUnresolvedReferences
     import qgis
 

jord/qgis_utilities/helpers/groups.py

@@ -1,5 +1,5 @@
 import logging
-from typing import Optional, Any, Union
+from typing import Any, Optional, Union
 
 # noinspection PyUnresolvedReferences
 from qgis.core import QgsLayerTreeGroup, QgsLayerTreeLayer, QgsProject
@@ -20,7 +20,7 @@
 
 
 def duplicate_groups(
-    group_to_duplicate,
+    group_to_duplicate: Any,
     *,
     group_parent: Optional[Any] = None,
     new_name: Union[str, EllipsisType, None] = None,
@@ -62,7 +62,7 @@ def duplicate_groups(
     return new_group_parent, sub_items
 
 
-def duplicate_tree_node(new_group_parent, original_group_child):
+def duplicate_tree_node(new_group_parent: Any, original_group_child: Any) -> Any:
     original_layer = original_group_child.layer()
     new_layer_copy = deepcopy_layer(original_layer)
     QgsProject.instance().addMapLayer(new_layer_copy, False)
@@ -98,14 +98,14 @@ def duplicate_tree_node(new_group_parent, original_group_child):
     return new_layer_copy
 
 
-def select_layer_in_group(layer_name, group_name):
+def select_layer_in_group(layer_name: Any, group_name: Any) -> None:
     group = QgsProject.instance().layerTreeRoot().findGroup(group_name)
     if group is not None:
         for child in group.children():
             if child.name() == layer_name:
                 iface.setActiveLayer(child.layer())
 
 
-def is_group_selected(group_name):
+def is_group_selected(group_name: Any) -> Any:
     group = QgsProject.instance().layerTreeRoot().findGroup(group_name)
     return group in iface.layerTreeView().selectedNodes()