flexmeasures.api.common.responses

Functions

flexmeasures.api.common.responses.already_received_and_successfully_processed(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.conflicting_resolutions(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.deprecated_api_version(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.fallback_schedule_redirect(message: str, location: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.incomplete_event(requested_event_id, requested_event_type, message) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.invalid_datetime(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.invalid_domain(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.invalid_flex_config(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.invalid_horizon(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.invalid_market() → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.invalid_message_type(message_type: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.invalid_method(request_method) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.invalid_period(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.invalid_ptu_duration(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.invalid_replacement(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.invalid_resolution_str(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.invalid_role(requested_access_role: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.invalid_sender(required_permissions: list[str] | None = None) → ResponseTuple

Signify that the sender is invalid to perform the request. Fits well with 403 errors. Optionally tell the user which permissions they should have.

flexmeasures.api.common.responses.invalid_source(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.invalid_timezone(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.invalid_unit(quantity: str | None, units: Sequence[str] | tuple[str] | None) → ResponseTuple

flexmeasures.api.common.responses.is_response_tuple(value) → bool

Check if an object qualifies as a ResponseTuple

flexmeasures.api.common.responses.no_backup(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.no_message_type(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.outdated_event_id(requested_event_id, existing_event_id) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.pluralize(usef_role_name: str) → str

Adding a trailing ‘s’ works well for USEF roles.

flexmeasures.api.common.responses.power_value_too_big(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.power_value_too_small(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.ptus_incomplete(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.request_processed(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.required_info_missing(fields: Sequence[str], message: str = '') → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.unapplicable_resolution(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.unknown_prices(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.unknown_schedule(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.unrecognized_asset(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.unrecognized_backup(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.unrecognized_connection_group(message: str) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.unrecognized_event(requested_event_id, requested_event_type) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.unrecognized_event_type(requested_event_type) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.unrecognized_market(requested_market) → Tuple[dict, int] | Tuple[dict, int, dict]

flexmeasures.api.common.responses.unrecognized_sensor(lat: float | None = None, lng: float | None = None) → ResponseTuple

Classes

class flexmeasures.api.common.responses.BaseMessage(base_message='')

Set a base message to which extra info can be added by calling the wrapped function with additional string arguments. This is a decorator implemented as a class.

__init__(base_message='')