pdoc-Dockstrings ergänzt

This commit is contained in:
2026-04-20 14:31:16 +02:00
parent 30bfcc597d
commit d2035139d9
8 changed files with 93 additions and 17 deletions
+16
View File
@@ -1,3 +1,19 @@
"""
sn_basis QGIS-Plugin für Basis-Verwaltung und zentrale Koordination.
Orchestriert die Navigation und initialisiert abhängige sn_-Plugins.
"""
def classFactory(iface):
"""
Factory-Funktion für QGIS.
Wird von QGIS aufgerufen, um die Plugin-Instanz zu erstellen.
Args:
iface: QGIS-Schnittstellenobjekt
Returns:
BasisPlugin: Instanziiertes Plugin
"""
from .main import BasisPlugin
return BasisPlugin(iface)
+5
View File
@@ -1,3 +1,8 @@
"""
sn_basis/functions Wrapper und Hilfsfunktionen für QGIS-Kompatibilität.
Bietet abstrahierte Schnittstellen für Qt, QGIS und OS-Operationen.
"""
from .ly_existence_wrapper import layer_exists
from .ly_geometry_wrapper import (
get_layer_geometry_type,
-14
View File
@@ -1,14 +0,0 @@
mermaid´´´
flowchart TD
A[Projekt]
subgraph children[ ]
direction TB
B[src]
C[docs]
D[README.md]
end
A --> B
A --> C
A --> D
+40 -1
View File
@@ -1 +1,40 @@
#Datenbankpruefer.py
"""
sn_basis/modules/Datenbankpruefer.py Prüfung von Datenbanken.
Validiert Datenbank-Verbindungen und -Strukturen.
"""
from typing import Optional, Any
from sn_basis.modules.pruef_ergebnis import pruef_ergebnis
class Datenbankpruefer:
"""
Prüft Datenbankverbindungen und Datenbankstrukturen auf Gültigkeit.
Gibt pruef_ergebnis für die Weiterverarbeitung durch Pruefmanager zurück.
"""
def __init__(self, pfad: Optional[str] = None) -> None:
"""
Initialisiert den Datenbankprüfer.
Args:
pfad: Optional Pfad zur Datenbankdatei (z.B. .gpkg, .sqlite)
"""
self.pfad = pfad
def pruefe(self) -> pruef_ergebnis:
"""
Prüft die Datenbank auf Gültigkeit und Verbindbarkeit.
Returns:
pruef_ergebnis: Ergebnis der Prüfung mit ok-Flag und Aktion
"""
if not self.pfad:
return pruef_ergebnis(
ok=False,
meldung="Kein Datenbankpfad angegeben.",
aktion="kein_dateipfad",
kontext=None,
)
# Implementierung folgt
return pruef_ergebnis(ok=True, meldung="Datenbank OK", aktion="ok", kontext=self.pfad)
+4 -1
View File
@@ -1 +1,4 @@
#Testordner
"""
sn_basis/tests Test-Suite für das sn_basis Plugin.
Enthält Unit-Tests und Integrationstests für alle Module.
"""
+4
View File
@@ -0,0 +1,4 @@
"""
sn_basis/ui Benutzeroberflächen-Module für sn_basis.
Enthält Dock-Manager, Navigation und einzelne Tabs.
"""
+5
View File
@@ -1,3 +1,8 @@
"""
sn_basis/ui/tabs Tab-Widgets für die sn_basis Benutzeroberfläche.
Stellt print_tab und settings_tab bereit.
"""
# from sn_basis.ui.tabs.print_tab import PrintTab
# from sn_basis.ui.tabs.settings_tab import SettingsTab
+19 -1
View File
@@ -1,4 +1,8 @@
#sn_basis/ui/tabs/settings_tab.py
"""
sn_basis/ui/tabs/settings_tab.py Einstellungen-Tab für Projekteinformationen.
Verwaltet benutzerspezifische und projektspezifische Einstellungen.
"""
from sn_basis.functions.qt_wrapper import (
QWidget,
QGridLayout,
@@ -12,9 +16,23 @@ from sn_basis.functions.settings_logic import SettingsLogic
class SettingsTab(QWidget):
"""
Tab-Widget für die Verwaltung von Projekt- und Benutzereinstellungen.
Attributes:
tab_title: Anzeigetitel des Tabs ("Projekteigenschaften")
logic: SettingsLogic-Instanz für persistente Einstellungen
"""
tab_title = "Projekteigenschaften"
def __init__(self, parent=None):
"""
Initialisiert den Settings-Tab mit Eingabefeldern.
Args:
parent: Übergeordnetes Widget (Standard: None)
"""
super().__init__(parent)
self.logic = SettingsLogic()