philorg/gisaf-backend
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages 6 Wiki Activity Actions

Fix dashboards

Browse source
This commit is contained in:
phil 2024-03-24 11:21:11 +05:30
parent d539a72e6a
commit 5434c7d6ef
6 changed files with 330 additions and 74 deletions
Download patch file Download diff file Expand all files Collapse all files

120
src/gisaf/models/dashboard.py
View file

@ -3,8 +3,10 @@ from pickle import loads
from pathlib import Path
from datetime import datetime
import logging
# from typing import Any
from sqlmodel import Field, Relationship, String
from matplotlib.figure import Figure
from sqlmodel import Field, Relationship, String, JSON
from pydantic import BaseModel
import pandas as pd
@ -13,12 +15,10 @@ from gisaf.models.metadata import gisaf
from gisaf.models.models_base import Model
from gisaf.models.misc import NotADataframeError
import matplotlib.pyplot as plt
logger = logging.getLogger(__name__)
try:
import matplotlib.pyplot as plt
except ImportError:
plt = None # type: ignore
class DashboardPageSource(Model, table=True):
@ -34,17 +34,26 @@ class DashboardPageCommon:
Base class for DashboardPage and DashboardPageSection, where some methods
are common, eg. attachments
"""
name: str
df: bytes
plot: bytes
#plot: dict[str, Any] | None = Field(sa_type=JSON(none_as_null=True)) # type: ignore
attachment: str | None
html: str | None = None
def get_attachment_url(self):
## Serve through web front-end (nginx static file)
if not self.attachment:
return
base_storage_url = conf.dashboard.base_storage_url
if not base_storage_url:
base_storage_url = '/dashboard-attachment/'
return f'{base_storage_url}{self.group}/{self.attachment}'
def ensure_dir_exists(self):
raise NotImplementedError()
def save_plot(self, plot):
def get_plot_file_path(self) -> Path:
raise NotImplementedError()
def get_attachment_file_name(self) -> str:
raise NotImplementedError()
def get_plot_file_name(self):
raise NotImplementedError()
def save_plot(self, plot: plt.Axes | plt.Figure): # type: ignore
"""
Render the matplotlib plot (or figure) and save it in the filesystem
:param plot: matplotlib plot or figure...
@ -53,15 +62,14 @@ class DashboardPageCommon:
self.ensure_dir_exists()
## Different types of figures supported
fig = None
if plt:
if isinstance(plot, plt.Axes):
fig = plot.figure
elif isinstance(plot, plt.Figure):
fig = plot
if fig:
fig.savefig(self.get_plot_file_path(), bbox_inches='tight')
plt.close(fig)
fig: Figure | None = None
if isinstance(plot, plt.Axes): # type: ignore
fig = plot.figure # type: ignore
elif isinstance(plot, plt.Figure): # type: ignore
fig = plot
if fig:
fig.savefig(self.get_plot_file_path(), bbox_inches='tight')
plt.close(fig)
if plot and not fig:
logger.warning('Cannot save dashboard attachment (unknown attachment type)')
@ -71,7 +79,7 @@ class DashboardPageCommon:
#f'in {self.get_attachment_file_name()}')
return self.get_plot_file_name()
def save_attachment(self, attached, name=None):
def save_attachment(self, attached, name=None) -> str | None:
"""
Save the attachment in the filesystem
:param attached: matplotlib plot or figure...
@ -84,11 +92,11 @@ class DashboardPageCommon:
self.ensure_dir_exists()
## Different types of figures supported
fig = None
fig: Figure | None = None
if plt:
if isinstance(attached, plt.Axes):
fig = attached.figure
elif isinstance(attached, plt.Figure):
if isinstance(attached, plt.Axes): # type: ignore
fig = attached.figure # type: ignore
elif isinstance(attached, plt.Figure): # type: ignore
fig = attached
if fig:
fig.savefig(self.get_attachment_file_name(), bbox_inches='tight')
@ -96,7 +104,7 @@ class DashboardPageCommon:
if attached and not fig:
logger.warning('Cannot save dashboard attachment (unknown attachment type)')
return
return None
#logger.info(f'Saved attachment of dashboard page {self.group}/{self.name} '
#f'in {self.get_attachment_file_name()}')
@ -114,10 +122,18 @@ class DashboardPageCommon:
raise NotADataframeError()
def get_plot(self):
return loads(self.plot)
if self.plot is not None:
return loads(self.plot)
class DashboardPage(Model, DashboardPageCommon, table=True):
class DashboardPageMetaData(BaseModel):
name: str
group: str
description: str
viewable_role: str | None = None
class DashboardPage(Model, DashboardPageCommon, DashboardPageMetaData, table=True):
__tablename__ = 'dashboard_page' # type: ignore
__table_args__ = gisaf.table_args
@ -125,19 +141,12 @@ class DashboardPage(Model, DashboardPageCommon, table=True):
menu = 'Dashboard'
id: int = Field(primary_key=True)
name: str
notebook: str
group: str
description: str
attachment: str
html: str
viewable_role: str
df: bytes
plot: bytes
source_id: int = Field(foreign_key=gisaf.table('dashboard_page_source.id'))
time: datetime
expanded_panes: str
time: datetime | None = Field(default_factory=datetime.now)
notebook: str | None = None
source_id: int | None = Field(foreign_key=gisaf.table('dashboard_page_source.id'))
expanded_panes: str | None
source: DashboardPageSource = Relationship()
sections: list['DashboardPageSection'] = Relationship()
def __str__(self):
return f'{self.group:s}/{self.name:s}'
@ -169,6 +178,15 @@ class DashboardPage(Model, DashboardPageCommon, table=True):
else:
raise UserWarning('Cannot save attachment: no notebook/base_storage_dir in gisaf config')
def get_attachment_url(self):
## Serve through web front-end (nginx static file)
if not self.attachment:
return
base_storage_url = conf.dashboard.base_storage_url
if not base_storage_url:
base_storage_url = '/dashboard-attachment/'
return f'{base_storage_url}{self.group}/{self.attachment}'
def get_notebook_url(self):
if self.notebook:
base_url = conf.dashboard.base_source_url
@ -188,13 +206,9 @@ class DashboardPageSection(Model, DashboardPageCommon, table=True):
id: str = Field(primary_key=True)
name: str
dashboard_page_id: int = Field(foreign_key=gisaf.table('dashboard_page.id'))
dashboard_page: DashboardPage = Relationship()
dashboard_page: DashboardPage = Relationship(back_populates='sections')
description: str
attachment: str
html: str
df: bytes
plot: str
def __str__(self):
return f'{self.name} for dashboard page #{self.dashboard_page_id}'
@ -266,28 +280,28 @@ class Widget(Model, table=True):
menu = 'Dashboard'
class DashboadPageSectionType(BaseModel):
class DashboardSection(BaseModel):
name: str
plot: str
class DashboardPage_(BaseModel):
class Dashboard(BaseModel):
name: str
group: str
description: str
time: datetime | None = Field(default_factory=datetime.now)
html: str | None = None
attachment: str | None = None
dfData: str | None = None
dfData: list = []
plotData: str | None = None
notebook: str | None = None
expandedPanes: list[str] | None = None
sections: list[DashboadPageSectionType] | None = None
sections: list[DashboardSection] | None = None
class DashboardGroup(BaseModel):
name: str
pages: list[DashboardPage_]
pages: list[DashboardPageMetaData]
class DashboardHome(BaseModel):