ssb-dash-framework 0.2.0a1__tar.gz → 0.2.2__tar.gz

{ssb_dash_framework-0.2.0a1 → ssb_dash_framework-0.2.2}/PKG-INFO

@@ -1,34 +1,38 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: ssb-dash-framework
-Version: 0.2.0a1
+Version: 0.2.2
 Summary: SSB Dash Framework
-License: GPL-3.0
+License-Expression: GPL-3.0
+License-File: LICENSE
 Author: Magnus Theodor Engh
 Author-email: dor@ssb.no
 Requires-Python: >=3.10,<4.0
 Classifier: Development Status :: 4 - Beta
-Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: click (>=8.0.1)
 Requires-Dist: dapla-toolbelt (>=2.0.8,<5.0.0)
-Requires-Dist: dash (==2.18.2)
-Requires-Dist: dash-ag-grid (>=32.3.1,<33.0.0)
-Requires-Dist: dash-bootstrap-components (==1.7.1)
-Requires-Dist: dash-bootstrap-templates (>=1.2.4)
+Requires-Dist: dash (>=3.3.0,<4.0.0)
+Requires-Dist: dash-ag-grid (>=32.3.2,<33.0.0)
+Requires-Dist: dash-bootstrap-components (>=2.0.4,<3.0.0)
+Requires-Dist: dash-bootstrap-templates (>=2.1.0,<3.0.0)
+Requires-Dist: duckdb (==1.3.2)
 Requires-Dist: geopandas (>=1.1.1,<2.0.0)
-Requires-Dist: ibis-framework[postgres] (>=11.0.0,<12.0.0)
+Requires-Dist: ibis-framework[polars,postgres] (>=11.0.0,<12.0.0)
 Requires-Dist: ipykernel (>=6.29.5,<7.0.0)
 Requires-Dist: mpmath (>=1.3.0)
 Requires-Dist: orjson (>=3.10.16,<4.0.0)
 Requires-Dist: pandas (>=2.3.1,<3.0.0)
 Requires-Dist: psycopg2-binary (>=2.9.10,<3.0.0)
+Requires-Dist: rpy2 (>=3.6.4,<4.0.0)
 Requires-Dist: rwrapr (>=0.9.1,<0.10.0)
 Requires-Dist: sqlalchemy (>=2.0.43,<3.0.0)
-Requires-Dist: ssb-eimerdb (>=0.2.5,<0.3.0)
+Requires-Dist: ssb-eimerdb (>=0.2.6,<0.3.0)
+Requires-Dist: ssb-poc-statlog-model (>=1.0.0,<2.0.0)
 Project-URL: Changelog, https://github.com/statisticsnorway/ssb-dash-framework/releases
 Project-URL: Documentation, https://statisticsnorway.github.io/ssb-dash-framework
 Project-URL: Homepage, https://github.com/statisticsnorway/ssb-dash-framework

{ssb_dash_framework-0.2.0a1 → ssb_dash_framework-0.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ssb-dash-framework"
-version = "0.2.0a1"
+version = "0.2.2"
 description = "SSB Dash Framework"
 authors = [{ name = "Magnus Theodor Engh", email = "dor@ssb.no" }]
 license = "GPL-3.0"
@@ -10,20 +10,23 @@ dynamic = ["classifiers"]
 dependencies = [
     "click>=8.0.1",
     "pandas (>=2.3.1,<3.0.0)",
-    "dash (==2.18.2)",
-    "dash-bootstrap-components (==1.7.1)",
-    "dash-ag-grid (>=32.3.1,<33.0.0)",
-    "dash-bootstrap-templates (>=1.2.4)",
     "dapla-toolbelt (>=2.0.8, <5.0.0)",  # Used for reading pdf's
     "mpmath>=1.3.0", # Pimemorizer uses this
     "orjson (>=3.10.16,<4.0.0)",
     "ipykernel (>=6.29.5,<7.0.0)",
     "psycopg2-binary (>=2.9.10,<3.0.0)",
     "geopandas (>=1.1.1,<2.0.0)",
-    "ssb-eimerdb (>=0.2.5,<0.3.0)",
+    "ssb-eimerdb (>=0.2.6,<0.3.0)",
     "sqlalchemy (>=2.0.43,<3.0.0)",
-    "ibis-framework[postgres] (>=11.0.0,<12.0.0)",
+    "ibis-framework[polars,postgres] (>=11.0.0,<12.0.0)",
     "rwrapr (>=0.9.1,<0.10.0)",
+    "dash-ag-grid (>=32.3.2,<33.0.0)",
+    "dash (>=3.3.0,<4.0.0)",
+    "dash-bootstrap-components (>=2.0.4,<3.0.0)",
+    "rpy2 (>=3.6.4,<4.0.0)",
+    "dash-bootstrap-templates (>=2.1.0,<3.0.0)",
+    "duckdb (==1.3.2)",
+    "ssb-poc-statlog-model (>=1.0.0,<2.0.0)",
 ]
 
 [project.urls]
@@ -43,7 +46,6 @@ requires-poetry = ">=2.0"
 pygments = ">=2.10.0"
 black = { extras = ["jupyter"], version = ">=23.1.0" }
 coverage = { extras = ["toml"], version = ">=6.2" }
-darglint = ">=1.8.1"
 furo = ">=2021.11.12"
 mypy = ">=0.930"
 pre-commit = ">=2.16.0"
@@ -58,6 +60,8 @@ typeguard = ">=2.13.3"
 xdoctest = { extras = ["colors"], version = ">=0.15.10" }
 myst-parser = { version = ">=0.16.1" }
 deptry = ">=0.23.0"
+pydoclint = ">=0.8.3"
+pandas-stubs = ">=2.3.1"
 
 [tool.poetry.requires-plugins]
 poetry-plugin-export = ">=1.9"
@@ -89,6 +93,16 @@ show_column_numbers = true
 show_error_context = true
 ignore_missing_imports = true
 
+[tool.pydoclint]
+style = "google"
+exclude = '\.git|\.nox'
+arg-type-hints-in-docstring = false
+check-return-types = false
+check-yield-types = false
+allow-init-docstring = true
+# native-mode-noqa-location = "definition"
+quiet = true
+
 [tool.ruff]
 force-exclude = true  # Apply excludes to pre-commit
 show-fixes = true
@@ -127,6 +141,7 @@ ignore = [
     "E501",   # Supress line-too-long warnings: trust black's judgement on this one.
     "PLR2004", # Allow to compare with unnamed numerical constants.
 ]
+external = ["DOC"]  ## Avoiding removing any codes starting with `DOC` from any `# noqa` directives.
 
 [tool.ruff.lint.isort]
 force-single-line = true

{ssb_dash_framework-0.2.0a1 → ssb_dash_framework-0.2.2}/src/ssb_dash_framework/__init__.py

@@ -1,26 +1,32 @@
 """SSB Dash Framework."""
 
 from .control import ControlFrameworkBase
+from .control import register_control
 from .modules import Aarsregnskap
 from .modules import AarsregnskapTab
 from .modules import AarsregnskapWindow
 from .modules import AggDistPlotter
 from .modules import AggDistPlotterTab
 from .modules import AggDistPlotterWindow
-from .modules import AltinnControlView
+from .modules import AltinnControlViewTab
 from .modules import AltinnControlViewWindow
 from .modules import AltinnDataCapture
 from .modules import AltinnDataCaptureTab
 from .modules import AltinnDataCaptureWindow
 from .modules import AltinnSkjemadataEditor
+from .modules import AltinnSupportTable
+from .modules import Bedriftstabell
+from .modules import BedriftstabellTab
+from .modules import BedriftstabellWindow
 from .modules import BofInformation
 from .modules import BofInformationTab
 from .modules import BofInformationWindow
 from .modules import Canvas
 from .modules import CanvasTab
 from .modules import CanvasWindow
-from .modules import Control
-from .modules import ControlWindow
+from .modules import ControlView
+from .modules import ControlViewTab
+from .modules import ControlViewWindow
 from .modules import EditingTable
 from .modules import EditingTableTab
 from .modules import EditingTableWindow
@@ -32,18 +38,30 @@ from .modules import FreeSearchTab
 from .modules import FreeSearchWindow
 from .modules import HBMethod
 from .modules import HBMethodWindow
+from .modules import MacroModule
+from .modules import MacroModuleTab
+from .modules import MacroModuleWindow
 from .modules import MapDisplay
 from .modules import MapDisplayTab
 from .modules import MapDisplayWindow
 from .modules import MultiModule
 from .modules import MultiModuleTab
 from .modules import MultiModuleWindow
+from .modules import Naeringsspesifikasjon
+from .modules import NaeringsspesifikasjonTab
+from .modules import NaeringsspesifikasjonWindow
+from .modules import ParquetEditor
+from .modules import ParquetEditorChangelog
 from .modules import PimemorizerTab
 from .modules import SkjemapdfViewer
 from .modules import SkjemapdfViewerTab
 from .modules import SkjemapdfViewerWindow
 from .modules import VisualizationBuilder
 from .modules import VisualizationBuilderWindow
+from .modules import apply_edits
+from .modules import export_from_parqueteditor
+from .modules import get_export_log_path
+from .modules import get_log_path
 from .setup import VariableSelector
 from .setup import VariableSelectorOption
 from .setup import app_setup
@@ -57,13 +75,13 @@ from .utils import TabImplementation
 from .utils import WindowImplementation
 from .utils import _get_kostra_r
 from .utils import active_no_duplicates_refnr_list
-from .utils import apply_edits
 from .utils import conn_is_ibis
 from .utils import create_alert
 from .utils import create_database
 from .utils import create_database_engine
 from .utils import enable_app_logging
 from .utils import hb_method
+from .utils import ibis_filter_with_dict
 from .utils import module_validator
 from .utils import sidebar_button
 
@@ -77,21 +95,26 @@ __all__ = [
     "AggDistPlotterTab",
     "AggDistPlotterWindow",
     "AlertHandler",
-    "AltinnControlView",
+    "AltinnControlViewTab",
     "AltinnControlViewWindow",
     "AltinnDataCapture",
     "AltinnDataCaptureTab",
     "AltinnDataCaptureWindow",
     "AltinnSkjemadataEditor",
+    "AltinnSupportTable",
+    "Bedriftstabell",
+    "BedriftstabellTab",
+    "BedriftstabellWindow",
     "BofInformation",
     "BofInformationTab",
     "BofInformationWindow",
     "Canvas",
     "CanvasTab",
     "CanvasWindow",
-    "Control",
     "ControlFrameworkBase",
-    "ControlWindow",
+    "ControlView",
+    "ControlViewTab",
+    "ControlViewWindow",
     "DatabaseBuilderAltinnEimerdb",
     "DebugInspector",
     "DemoDataCreator",
@@ -106,6 +129,9 @@ __all__ = [
     "FreeSearchWindow",
     "HBMethod",
     "HBMethodWindow",
+    "MacroModule",
+    "MacroModuleTab",
+    "MacroModuleWindow",
     "MapDisplay",
     "MapDisplayTab",
     "MapDisplayWindow",
@@ -116,6 +142,11 @@ __all__ = [
     "MultiModuleWindow",
     "MultiModuleWindow",
     "MultiModuleWindow",
+    "Naeringsspesifikasjon",
+    "NaeringsspesifikasjonTab",
+    "NaeringsspesifikasjonWindow",
+    "ParquetEditor",
+    "ParquetEditorChangelog",
     "PimemorizerTab",
     "SkjemapdfViewer",
     "SkjemapdfViewerTab",
@@ -128,13 +159,19 @@ __all__ = [
     "WindowImplementation",
     "active_no_duplicates_refnr_list",
     "app_setup",
+    "apply_edits",
     "conn_is_ibis",
     "create_alert",
     "create_database",
     "create_database_engine",
     "enable_app_logging",
+    "export_from_parqueteditor",
+    "get_export_log_path",
+    "get_log_path",
+    "ibis_filter_with_dict",
     "main_layout",
     "module_validator",
+    "register_control",
     "set_variables",
     "sidebar_button",
     #    "hb_method",

ssb_dash_framework-0.2.2/src/ssb_dash_framework/assets/dashAgGridFunctions.js

@@ -0,0 +1,260 @@
+window.dashAgGridFunctions = window.dashAgGridFunctions || {};
+
+// MacroModule
+window.dashAgGridFunctions.MacroModule = {
+
+    // === Function formatHeatmapValue (Format values based on row type) ===
+    formatHeatmapValue(params, isPercentage) {
+        const value = params.value;
+
+        if (value === null || value === undefined) {
+            return '';
+        }
+
+        // Special handling for count row - just show number with thousand separator
+        if (params.data && params.data.id === 'count_row') {
+            return value.toLocaleString('nb-NO', {
+                minimumFractionDigits: 0,
+                maximumFractionDigits: 0
+            });
+        }
+
+        // Regular cells - format as percentage or number
+        if (isPercentage) {
+            return value.toLocaleString('nb-NO', {
+                style: 'percent',
+                minimumFractionDigits: 1,
+                maximumFractionDigits: 1
+            });
+        } else {
+            return value.toLocaleString('nb-NO', {
+                minimumFractionDigits: 0,
+                maximumFractionDigits: 0
+            });
+        }
+    },
+
+    // === Function formatDetailGridValue (Format numeric values in detail grid) ===
+    formatDetailGridValue(params) {
+        const value = params.value;
+
+        if (value === null || value === undefined || value === '') {
+            return '';
+        }
+
+        // Format as number with thousand separator
+        return value.toLocaleString('nb-NO', {
+            minimumFractionDigits: 0,
+            maximumFractionDigits: 0
+        });
+    },
+
+    // === Function displayDiffHeatMap (Heatmap colouring for a matrix-table with +/- 30% diff threshold) ===
+    displayDiffHeatMap(props) {
+
+        // Special handling for count row
+        if (props.data && props.data.id === 'count_row') {
+            return {
+                color: 'black',
+            };
+        }
+
+        const val = props.value;
+
+        if (val === null || val === undefined || isNaN(val)) {
+            return {};
+        }
+
+        const threshold = 0.3;
+        const normalized = val / threshold;
+
+        // base colors
+        const red = [252, 195, 174];     // normal red
+        const blue = [180, 213, 250];    // normal blue
+        const white = [255, 255, 255];   // white background
+
+        // darker shades for beyond 30% threshold
+        const darkRed = [252, 142, 104];
+        const darkBlue = [126, 165, 252];
+
+        let r, g, b;
+
+        if (normalized >= 1) {
+            // beyond positive threshold — dark blue
+            r = darkBlue[0];
+            g = darkBlue[1];
+            b = darkBlue[2];
+        } else if (normalized <= -1) {
+            // below negative threshold — use dark red
+            r = darkRed[0];
+            g = darkRed[1];
+            b = darkRed[2];
+        } else if (normalized >= 0) {
+            // normal range: interpolate white to blue
+            let clamped = Math.min(normalized, 1);
+            r = white[0] * (1 - clamped) + blue[0] * clamped;
+            g = white[1] * (1 - clamped) + blue[1] * clamped;
+            b = white[2] * (1 - clamped) + blue[2] * clamped;
+        } else {
+            // normal range: interpolate white to red
+            let clamped = Math.max(normalized, -1);
+            r = white[0] * (1 + clamped) + red[0] * -clamped;
+            g = white[1] * (1 + clamped) + red[1] * -clamped;
+            b = white[2] * (1 + clamped) + red[2] * -clamped;
+        }
+
+        return {
+            backgroundColor: `rgb(${Math.round(r)}, ${Math.round(g)}, ${Math.round(b)})`,
+            color: 'black',
+        };
+    },
+
+    // === Function displaySimpleHeatMap (Simple 2-choice (cold/warm for neg/pos) heatmap) ===
+    displaySimpleHeatMap(props) {
+
+        // Special handling for count row
+        if (props.data && props.data.id === 'count_row') {
+            return {
+                color: 'black',
+            };
+        }
+
+        const val = props.value;
+
+        if (val === null || val === undefined || isNaN(val)) {
+            return {};
+        }
+
+        // clamp value to [-1, 1] for interpolation
+        const clamped = Math.max(-1, Math.min(1, val));
+
+        // base colors
+        const red = [252, 195, 174];
+        const blue = [180, 213, 250];
+        const white = [255, 255, 255];
+
+        let r, g, b;
+
+        if (clamped >= 0) {
+            // interpolate from white to blue
+            r = white[0] * (1 - clamped) + blue[0] * clamped;
+            g = white[1] * (1 - clamped) + blue[1] * clamped;
+            b = white[2] * (1 - clamped) + blue[2] * clamped;
+        } else {
+            // interpolate from white to red
+            r = white[0] * (1 + clamped) + red[0] * -clamped;
+            g = white[1] * (1 + clamped) + red[1] * -clamped;
+            b = white[2] * (1 + clamped) + red[2] * -clamped;
+        }
+
+        return {
+            backgroundColor: `rgb(${Math.round(r)}, ${Math.round(g)}, ${Math.round(b)})`,
+            color: 'black',
+        };
+    },
+
+    // === Function displayDiffHighlight (Compare current cell's value to previous year, highlight if different) ===
+    displayDiffHighlight(props) {
+
+    if (!props.data) return {};
+
+    const field = props.colDef.field;
+    const value = props.value;
+
+    const normalize = (v) =>
+        v !== null && v !== undefined ? String(v).trim() : "";
+
+    // special handling for naring_b / naring_f
+    if (field === "naring_b" || field === "naring_f") {
+        const currentVal = normalize(value);
+        const prevVal = normalize(props.data[field + "_x"]);
+
+        const currentPrefix = currentVal.substring(0, 2); // first 2 digits
+        const prevPrefix = prevVal.substring(0, 2);
+
+        // CASE A: prefix changed → darker yellow
+        if (currentPrefix && prevPrefix && currentPrefix !== prevPrefix) {
+            return {
+                backgroundColor: "#ffe491ff",
+                color: "black",
+            };
+        }
+
+        // CASE B: prefix same → normal diff behaviour
+        if (prevVal && currentVal && prevVal !== currentVal) {
+            return {
+                backgroundColor: "#fff8c7ff", // light yellow
+                color: "black"
+            };
+        }
+
+        return {}; // no change
+    }
+
+    const prevField = field + "_x";
+    const prevValue = normalize(props.data[prevField]);
+    const currentValue = normalize(value);
+
+    if (prevValue && currentValue && prevValue !== currentValue) {
+        return {
+            backgroundColor: "#fff8c7ff",
+            color: "black"
+        };
+    }
+
+    return {};
+
+    },
+
+     // === Function displayNaringRowMismatch (Grey out row if first 2 digits of naring_b and naring_f differ) ===
+    displayNaringRowMismatch(props) {
+        if (!props.data) return false;
+
+        const naringB = props.data.naring_b;
+        const naringF = props.data.naring_f;
+
+        // if either value is missing, no styling
+        if (!naringB || !naringF) return false;
+
+        // compare first 2 digits
+        const prefixB = String(naringB).substring(0, 2);
+        const prefixF = String(naringF).substring(0, 2);
+
+        return prefixB !== prefixF;
+    },
+
+    // === Function displayDiffColumnHighlight (Mark tilgang & avgang on the diff-column) ===
+    displayDiffColumnHighlight(props) {
+        if (!props.data) return {};
+
+        const field = props.colDef.field;
+
+        const isDiffColumn = field.endsWith("_diff");
+        const isExitHighlightField =
+            (field === "orgnr_b" || field === "navn") &&
+            props.data.is_avgang &&
+            props.data.is_exiter;
+
+        // Guard: only apply to allowed columns
+        if (!isDiffColumn && !isExitHighlightField) return {};
+
+        // tilgang (still only for diff columns)
+        if (isDiffColumn && props.data.is_tilgang) {
+            return {
+                backgroundColor: "#c7f5c7",
+                color: "black",
+            };
+        }
+
+        // avgang (diff columns OR exiter name/orgnr)
+        if (props.data.is_avgang) {
+            return {
+                backgroundColor: "#ffc7c7",
+                color: "black",
+            };
+        }
+
+        return {};
+    }
+
+};