Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Alustava arkkitehtuurisuunnitelma #1

Merged
merged 4 commits into from
Sep 18, 2024
Merged

Alustava arkkitehtuurisuunnitelma #1

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cbfafc3
Class drafting, added JSON for testing
nmaarnio Sep 12, 2024
6582d43
architecture planning continued
nmaarnio Sep 13, 2024
a87a047
add __init__.py files
nmaarnio Sep 13, 2024
17cb25e
Changes based on review
nmaarnio Sep 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file added arho_feature_template/core/__init__.py
View file
Open in desktop
Empty file.
31 changes: 31 additions & 0 deletions arho_feature_template/core/feature_template.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
from __future__ import annotations

from dataclasses import dataclass
from typing import TYPE_CHECKING, Sequence

if TYPE_CHECKING:
from qgis.core import QgsMapLayer, QgsVectorLayer
from qgis.gui import QgsDoubleSpinBox, QgsSpinBox
from qgis.PyQt.QtGui import QIcon
from qgis.PyQt.QtWidgets import QLineEdit


@dataclass
class FeatureAttribute:
name: str
display_name: str
feature_attribte_group: str
attribute_layer: QgsMapLayer # Is this correct type?
additional_information: str
input_field_type: QLineEdit | QgsSpinBox | QgsDoubleSpinBox | None
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should probably be read at form rendering time from the layer settings.

modifiable: bool = False
hidden: bool = False


@dataclass
class FeatureTemplate:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is now missing possible child features. But that's totally fine for now! Let's first try to get this working with the most simple one feature case. Probably the library config should be updated accordingly.

name: str
description: str
feature_layer: QgsVectorLayer
feature_attributes: Sequence[FeatureAttribute]
display_icon: QIcon | None = None
36 changes: 36 additions & 0 deletions arho_feature_template/core/feature_template_library.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
from __future__ import annotations

import json
from typing import TYPE_CHECKING, Sequence

if TYPE_CHECKING:
from os import PathLike

from arho_feature_template.core.feature_template import FeatureTemplate


class FeatureTemplateLibrary:
"""Class for storing FeatureTemplates and loading them from a JSON (or other conf. file)."""

def __init__(self, json_path: str | PathLike):
self.templates = []
library_dict = self.read_json(json_path)
self.build_templates(library_dict)

def read_json(self, json_path: str | PathLike) -> dict:
self.source_json = json_path
with open(json_path) as f:
return json.load(f)

def build_templates(self, library_dict: dict):
templates = []

_templates_raw = library_dict["templates"]
# for template_raw in templates_raw:
## ... build FeatureTemplate from dict here, in FeatureTemplate class or elsewhere?
# template = FeatureTemplate()
# templates.append(template)
self.templates = templates

def get_templates(self) -> Sequence[FeatureTemplate]:
return self.templates
Empty file added arho_feature_template/core/forms/__init__.py
View file
Open in desktop
Empty file.
17 changes: 17 additions & 0 deletions arho_feature_template/core/forms/add_feature_form.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
from arho_feature_template.core.feature_template import FeatureTemplate
from arho_feature_template.core.forms.feature_attribute_form import FeatureAttributeForm


class AddFeatureForm(FeatureAttributeForm):
"""Dialog for filling and saving attribute data that opens when a new feature has been digitized."""

def __init__(self, feature_template: FeatureTemplate):
super().__init__(feature_template)

def _init_feature_attributes(self):
# for feature_attribute in self.feature_template.feature_attributes:
# # Create the form here, add rows with labels and input fields
pass

def save(self):
pass
13 changes: 13 additions & 0 deletions arho_feature_template/core/forms/feature_attribute_form.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
from qgis.PyQt.QtWidgets import QDialog

from arho_feature_template.core.feature_template import FeatureTemplate
from arho_feature_template.qgis_plugin_tools.tools.resources import load_ui


class FeatureAttributeForm(QDialog, load_ui("feature_attribute_form.ui")):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not a fan of using the load_ui util from the plugin_tools. IMHO it is cleaner to have the ui files next to the corresponding python module than in a fixed arbitrary location. What do you think?

I would to suggest something like this:

from importlib import resources
from qgis.PyQt import uic

ui_path = resources.files() / "feature_attribute_form.ui"  # files() without arguments looks resources adjacent to the caller module
FormClass, _ = uic.loadUiType(ui_path)

class FeatureAttributeForm(QDialog, FormClass):
    ...

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have strong preference for the UI loading, but I like the idea that the ui files are next to the python module. Changed to this (but gave __package__ as an argument for files() since it seems to be needed in older Python versions).

"""Parent class for feature forms for adding and modifying feature attribute data."""

def __init__(self, feature_template: FeatureTemplate):
super().__init__()
self.setupUi(self)
self.feature_template = feature_template
Empty file added arho_feature_template/core/panels/__init__.py
View file
Open in desktop
Empty file.
17 changes: 17 additions & 0 deletions arho_feature_template/core/panels/add_feature_panel.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
from qgis.PyQt.QtWidgets import QWidget

from arho_feature_template.core.feature_template_library import FeatureTemplateLibrary
from arho_feature_template.qgis_plugin_tools.tools.resources import load_ui


class AddFeaturePanel(QWidget, load_ui("add_feature_panel.ui")):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would rename to something like TemplateLibraryPanel

"""Dock widget for selecting a feature template."""

def __init__(self, feature_template_library: FeatureTemplateLibrary):
super().__init__()
self.setupUi(self)
self.initialize_from_library(feature_template_library)

def initialize_from_library(self, feature_template_library: FeatureTemplateLibrary):
# Initialization logic
self.library = feature_template_library
21 changes: 16 additions & 5 deletions arho_feature_template/plugin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,19 @@

from typing import Callable

from qgis.PyQt.QtCore import QCoreApplication, QTranslator
from qgis.gui import QgsDockWidget
from qgis.PyQt.QtCore import QCoreApplication, Qt, QTranslator
from qgis.PyQt.QtGui import QIcon
from qgis.PyQt.QtWidgets import QAction, QWidget
from qgis.utils import iface

from arho_feature_template.core.feature_template_library import FeatureTemplateLibrary
from arho_feature_template.core.panels.add_feature_panel import AddFeaturePanel
from arho_feature_template.qgis_plugin_tools.tools.custom_logging import setup_logger, teardown_logger
from arho_feature_template.qgis_plugin_tools.tools.i18n import setup_translation
from arho_feature_template.qgis_plugin_tools.tools.resources import plugin_name
from arho_feature_template.qgis_plugin_tools.tools.resources import plugin_name, resources_path

LIBRARY_JSON = resources_path("asemakaava-template-library-test.json")

class Plugin:
"""QGIS Plugin Implementation."""
Expand All @@ -33,6 +37,9 @@ def __init__(self) -> None:
self.actions: list[QAction] = []
self.menu = Plugin.name

# Create and initialize default feature template library
self.active_library = FeatureTemplateLibrary(LIBRARY_JSON)

def add_action(
self,
icon_path: str,
Expand Down Expand Up @@ -107,7 +114,7 @@ def initGui(self) -> None: # noqa N802
text=Plugin.name,
callback=self.run,
parent=iface.mainWindow(),
add_to_toolbar=False,
add_to_toolbar=True,
)

def onClosePlugin(self) -> None: # noqa N802
Expand All @@ -121,5 +128,9 @@ def unload(self) -> None:
teardown_logger(Plugin.name)

def run(self) -> None:
"""Run method that performs all the real work"""
print("Hello QGIS plugin") # noqa: T201
self.feature_template_dock= QgsDockWidget()
self.add_feature_panel = AddFeaturePanel(self.active_library)
self.feature_template_dock.setWidget(self.add_feature_panel)
self.feature_template_dock.setWindowTitle("ARHO") # NOTE: Placeholder name

iface.addDockWidget(Qt.RightDockWidgetArea, self.feature_template_dock)
131 changes: 131 additions & 0 deletions arho_feature_template/resources/asemakaava-template-library-test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
{
"version": 1,
"name": "Asemakaava-kaavamääräyskirjasto",
"templates": [
{
"name": "Asuin-, liike- ja toimistorakennusten alue",
"description": "Aluella kuvataan ...",
"feature": {
"layer": "land_use_area",
"fields": [
{
"field": "name"
},
{
"field": "type_of_underground_id",
"value": 1
}
],
"children": [
{
"layer": "plan_requlation_group",
"fields": [
{
"field": "name",
"value": "Asuin-, liike- ja toimistorakennusten alue",
"allow_user_input": false
}
],
"children": [
{
"layer": "plan_requlation",
"fields": [
{
"field": "type_of_plan_regulation_id",
"value": "asumisenAlue",
"hidden": true
}
],
"children": {
"layer": "additional_information_of_plan_regulation",
"fields": [
{
"field": "type_of_additional_information_id",
"value": "paakayttotarkoitus",
"hidden": true
}
]
}
},
{
"layer": "plan_requlation",
"fields": [
{
"field": "type_of_plan_regulation_id",
"value": "liikerakennustenAlue",
"hidden": true
}
],
"children": {
"layer": "additional_information_of_plan_regulation",
"fields": [
{
"field": "type_of_additional_information_id",
"value": "paakayttotarkoitus",
"hidden": true
}
]
}
},
{
"layer": "plan_requlation",
"fields": [
{
"field": "type_of_plan_regulation_id",
"value": "toimitilojenAlue",
"hidden": true
}
],
"children": {
"layer": "additional_information_of_plan_regulation",
"fields": [
{
"field": "type_of_additional_information_id",
"value": "paakayttotarkoitus",
"hidden": true
}
]
}
}
]
},
{
"layer": "plan_requlation_group",
"fields": [
{
"field": "name",
"value": "Korttelin numero",
"allow_user_input": false
}
],
"children": [
{
"layer": "plan_requlation",
"fields": [
{
"field": "type_of_plan_regulation_id",
"value": "korttelinNumero"
},
{
"field": "numeric_value",
"required": true
}
]
}
]
}
]
}
},
{
"name": "Asuinrakennusten alue",
"description": "Asuinrakennusten alue ...",
"fields": [
{
"field": "",
"required": true
}
]
}
]
}
19 changes: 19 additions & 0 deletions arho_feature_template/resources/ui/add_feature_panel.ui
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<ui version="4.0">
<class>Form</class>
<widget class="QWidget" name="Form">
<property name="geometry">
<rect>
<x>0</x>
<y>0</y>
<width>640</width>
<height>480</height>
</rect>
</property>
<property name="windowTitle">
<string>Form</string>
</property>
</widget>
<resources/>
<connections/>
</ui>
68 changes: 68 additions & 0 deletions arho_feature_template/resources/ui/feature_attribute_form.ui
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
<?xml version="1.0" encoding="UTF-8"?>
<ui version="4.0">
<class>Dialog</class>
<widget class="QDialog" name="Dialog">
<property name="geometry">
<rect>
<x>0</x>
<y>0</y>
<width>640</width>
<height>480</height>
</rect>
</property>
<property name="windowTitle">
<string>Dialog</string>
</property>
<widget class="QDialogButtonBox" name="buttonBox">
<property name="geometry">
<rect>
<x>10</x>
<y>440</y>
<width>621</width>
<height>32</height>
</rect>
</property>
<property name="orientation">
<enum>Qt::Horizontal</enum>
</property>
<property name="standardButtons">
<set>QDialogButtonBox::Cancel|QDialogButtonBox::Ok</set>
</property>
</widget>
</widget>
<resources/>
<connections>
<connection>
<sender>buttonBox</sender>
<signal>accepted()</signal>
<receiver>Dialog</receiver>
<slot>accept()</slot>
<hints>
<hint type="sourcelabel">
<x>248</x>
<y>254</y>
</hint>
<hint type="destinationlabel">
<x>157</x>
<y>274</y>
</hint>
</hints>
</connection>
<connection>
<sender>buttonBox</sender>
<signal>rejected()</signal>
<receiver>Dialog</receiver>
<slot>reject()</slot>
<hints>
<hint type="sourcelabel">
<x>316</x>
<y>260</y>
</hint>
<hint type="destinationlabel">
<x>286</x>
<y>274</y>
</hint>
</hints>
</connection>
</connections>
</ui>
Loading