Settlement Periods

UK-specific settlement functions

Exceptions

exception xocto.exceptions.SettlementPeriodError

Bases: Exception

Basic exception raised while converting tz-aware datetime.

Constants

xocto.settlement_periods.GB_TZ = 'Europe/London'

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

xocto.settlement_periods.UTC_TZ = 'UTC'

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

API Reference

xocto.settlement_periods.convert_sp_and_date_to_utc(sp: int, date: date, timezone_str: str = 'Europe/London', is_wholesale: bool = False) → datetime

Return an UTC-aware datetime for the start of a given settlement period.

xocto.settlement_periods.convert_utc_to_sp_and_date(utc_time: datetime, timezone_str: str = 'Europe/London', is_wholesale: bool = False) → Tuple[int, date]

Return the local date and settlement period from a given UTC-aware datetime.

xocto.settlement_periods.number_of_periods_in_timedelta(delta: timedelta) → float

Return the number of half-hourly settlement periods in the given timedelta