mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2026-08-06 08:56:12 +00:00
Bobby NoelteandGitHub
1905682113
Change PDF visualization to be created on demand and per optimization algorithm. The PDF for the GENETIC0 optimization is provided by the /visualization_results.pdf endpoint. There is no change in the interface. By this the optimization algorithm is offloaded from the PDF generation which spares some time. To cope with several users may call the /visualization_results.pdf endpoint at the same time the PDF is generated on the fly without any intermediate file taking the stored GENETIC0 solution as an input. SVG picture generation is removed as this would again create intermediate files. Chart pictures can easily be taken from the PDF. To allow on demand creation of the optimization results visualization the optimisation solution stored is extended by several new attributes. To keep the deprecated /optimize endpoint compatible the optimization solution is stripped to the legacy content before returned. Due to the extension of the solution the optimization tests were adapted to cover the extended content. The optimization tests are adapted to test the generated visualization report by the pypdf reader. Pypdf is added to the development dependencies. Besides the adaptation several fixes and improvements are added: * feat: extend /v1/prediction/series endpoint by resampling and filling Add parameters for resampling and filling. Add the processing parameter to control wether raw data or resampled data shall be returned. * feat: extend /v1/measurement/series endpoint by resampling and filling Add parameters for resampling and filling: Add the processing parameter to control wether raw data or resampled data shall be returned. * feat: standardize and improve API error response Use FASTApi exception handlers to provide a standardized API exception handling. All exceptions are logged. Exception traces are only returned if the new logging configuration parameter logging.api_logging_level is set to "DEBUG" or "TRACE". Avoids unwanted leackage of server internals on exceptions. * fix: align to intervall when resampling Ensure resampling is aligned to interval also when the buckets are shifted due to the align_to_intervall parameter is set. * chore: make dropna mandatory and default to True * chore: refactor key_to_xxx data management methods Make key_to_series the central method for data resampling and fill. Add a new key_to_raw_series to retrieve the data as it is stored (without resampling and filling). Users of key_to_series were mostly moved to key_to_raw_series as this resembles the former interface. Especially in predictions and tests this was done. * chore: create test data sub-directory for each optimization algorithm To prevent cluttering the test data directory and ease test data management for optimization algorithms each algorithm got it's own sub-directory. The current test data was moved to these sub-directories. * chore: update version Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
199 lines
5.3 KiB
Python
199 lines
5.3 KiB
Python
import html
|
|
import traceback
|
|
from dataclasses import dataclass
|
|
|
|
from fastapi import FastAPI, Request
|
|
from fastapi.exceptions import HTTPException, RequestValidationError
|
|
from fastapi.responses import JSONResponse
|
|
from loguru import logger
|
|
|
|
from akkudoktoreos.core.coreabc import get_config
|
|
|
|
|
|
@dataclass(slots=True)
|
|
class EOSProblem(Exception):
|
|
"""Application exception returned as RFC 7807 Problem Details."""
|
|
|
|
status: int
|
|
title: str
|
|
detail: str
|
|
type: str = "about:blank"
|
|
cause: Exception | None = None
|
|
|
|
def __str__(self) -> str:
|
|
return self.detail
|
|
|
|
|
|
def _problem_response(
|
|
*,
|
|
request: Request,
|
|
status: int,
|
|
title: str,
|
|
detail: str,
|
|
type: str,
|
|
cause: Exception | None = None,
|
|
) -> JSONResponse:
|
|
body = {
|
|
"type": type,
|
|
"title": title,
|
|
"status": status,
|
|
"detail": detail,
|
|
"instance": request.url.path,
|
|
}
|
|
|
|
if cause is not None:
|
|
logger.exception(cause)
|
|
|
|
if get_config().logging.api_level in ("TRACE", "DEBUG"):
|
|
body["traceback"] = traceback.format_exception(cause)
|
|
|
|
return JSONResponse(
|
|
status_code=status,
|
|
media_type="application/problem+json",
|
|
content=body,
|
|
)
|
|
|
|
|
|
async def eos_problem_handler(request: Request, exc: EOSProblem) -> JSONResponse:
|
|
return _problem_response(
|
|
request=request,
|
|
status=exc.status,
|
|
title=exc.title,
|
|
detail=exc.detail,
|
|
cause=exc.cause,
|
|
type=exc.type,
|
|
)
|
|
|
|
|
|
async def http_exception_handler(request: Request, exc: HTTPException) -> JSONResponse:
|
|
return _problem_response(
|
|
request=request,
|
|
status=exc.status_code,
|
|
title="HTTP Error",
|
|
detail=str(exc.detail),
|
|
cause=exc,
|
|
type="about:blank",
|
|
)
|
|
|
|
|
|
async def unexpected_exception_handler(request: Request, exc: Exception) -> JSONResponse:
|
|
return _problem_response(
|
|
request=request,
|
|
status=500,
|
|
title="Internal Server Error",
|
|
detail=str(exc),
|
|
cause=exc,
|
|
type="/problems/internal-server-error",
|
|
)
|
|
|
|
|
|
async def validation_handler(request: Request, exc: RequestValidationError) -> JSONResponse:
|
|
return _problem_response(
|
|
request=request,
|
|
status=422,
|
|
title="Validation Error",
|
|
detail="Request validation failed.",
|
|
cause=exc,
|
|
type="/problems/validation",
|
|
)
|
|
|
|
|
|
def register_problem_handlers(app: FastAPI) -> None:
|
|
app.add_exception_handler(EOSProblem, eos_problem_handler)
|
|
app.add_exception_handler(HTTPException, http_exception_handler)
|
|
app.add_exception_handler(Exception, unexpected_exception_handler)
|
|
app.add_exception_handler(RequestValidationError, validation_handler)
|
|
|
|
|
|
ERROR_PAGE_TEMPLATE = """
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>Energy Optimization System (EOS) Error</title>
|
|
<style>
|
|
body {
|
|
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, sans-serif;
|
|
background-color: #f5f5f5;
|
|
display: flex;
|
|
justify-content: center;
|
|
align-items: center;
|
|
height: 100vh;
|
|
margin: 0;
|
|
padding: 20px;
|
|
box-sizing: border-box;
|
|
}
|
|
.error-container {
|
|
background: white;
|
|
padding: 2rem;
|
|
border-radius: 8px;
|
|
box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
|
|
max-width: 500px;
|
|
width: 100%;
|
|
text-align: center;
|
|
}
|
|
.error-code {
|
|
font-size: 4rem;
|
|
font-weight: bold;
|
|
color: #e53e3e;
|
|
margin: 0;
|
|
}
|
|
.error-title {
|
|
font-size: 1.5rem;
|
|
color: #2d3748;
|
|
margin: 1rem 0;
|
|
}
|
|
.error-message {
|
|
color: #4a5568;
|
|
margin-bottom: 1.5rem;
|
|
}
|
|
.error-details {
|
|
background: #f7fafc;
|
|
padding: 1rem;
|
|
border-radius: 4px;
|
|
margin-bottom: 1.5rem;
|
|
text-align: center;
|
|
font-family: monospace;
|
|
white-space: pre-wrap;
|
|
word-break: break-word;
|
|
}
|
|
.back-button {
|
|
background: #3182ce;
|
|
color: white;
|
|
border: none;
|
|
padding: 0.75rem 1.5rem;
|
|
border-radius: 4px;
|
|
text-decoration: none;
|
|
display: inline-block;
|
|
transition: background-color 0.2s;
|
|
}
|
|
.back-button:hover {
|
|
background: #2c5282;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<div class="error-container">
|
|
<h1 class="error-code">STATUS_CODE</h1>
|
|
<h2 class="error-title">ERROR_TITLE</h2>
|
|
<p class="error-message">ERROR_MESSAGE</p>
|
|
<div class="error-details">ERROR_DETAILS</div>
|
|
<a href="/docs" class="back-button">Back to Home</a>
|
|
</div>
|
|
</body>
|
|
</html>
|
|
"""
|
|
|
|
|
|
def create_error_page(
|
|
status_code: str, error_title: str, error_message: str, error_details: str
|
|
) -> str:
|
|
"""Create an error page by replacing placeholders in the template."""
|
|
return (
|
|
ERROR_PAGE_TEMPLATE.replace("STATUS_CODE", status_code)
|
|
.replace("ERROR_TITLE", error_title)
|
|
.replace("ERROR_MESSAGE", html.escape(error_message))
|
|
.replace("ERROR_DETAILS", html.escape(error_details))
|
|
)
|