zepben.ewb 1.0.0b3__py3-none-any.whl → 1.0.0b5__py3-none-any.whl

zepben/ewb/database/sqlite/tables/iec61970/base/wires/table_static_var_compensator.py

@@ -6,7 +6,7 @@
 __all__ = ["TableStaticVarCompensators"]
 
 from zepben.ewb import TableRegulatingCondEq
-from zepben.ewb.database.sqlite.tables.column import Column, Nullable
+from zepben.ewb.database.sql.column import Column, Nullable
 
 
 class TableStaticVarCompensators(TableRegulatingCondEq):

zepben/ewb/database/sqlite/tables/iec61970/base/wires/table_switches.py

@@ -7,7 +7,7 @@ __all__ = ["TableSwitches"]
 
 from abc import ABC
 
-from zepben.ewb.database.sqlite.tables.column import Column, Nullable
+from zepben.ewb.database.sql.column import Column, Nullable
 from zepben.ewb.database.sqlite.tables.iec61970.base.core.table_conducting_equipment import TableConductingEquipment
 
 

zepben/ewb/database/sqlite/tables/iec61970/base/wires/table_synchronous_machines.py

@@ -5,7 +5,7 @@
 
 __all__ = ["TableSynchronousMachines"]
 
-from zepben.ewb.database.sqlite.tables.column import Column, Nullable
+from zepben.ewb.database.sql.column import Column, Nullable
 from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_rotating_machines import TableRotatingMachines
 
 

zepben/ewb/database/sqlite/tables/iec61970/base/wires/table_tap_changer_controls.py

@@ -5,7 +5,7 @@
 
 __all__ = ["TableTapChangerControls"]
 
-from zepben.ewb.database.sqlite.tables.column import Column, Nullable
+from zepben.ewb.database.sql.column import Column, Nullable
 from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_regulating_controls import TableRegulatingControls
 
 

zepben/ewb/database/sqlite/tables/iec61970/base/wires/table_tap_changers.py

@@ -7,7 +7,7 @@ __all__ = ["TableTapChangers"]
 
 from abc import ABC
 
-from zepben.ewb.database.sqlite.tables.column import Column, Nullable
+from zepben.ewb.database.sql.column import Column, Nullable
 from zepben.ewb.database.sqlite.tables.iec61970.base.core.table_power_system_resources import TablePowerSystemResources
 
 

zepben/ewb/database/sqlite/tables/iec61970/base/wires/table_transformer_ends.py

@@ -8,7 +8,7 @@ __all__ = ["TableTransformerEnds"]
 from abc import ABC
 from typing import List, Generator
 
-from zepben.ewb.database.sqlite.tables.column import Column, Nullable
+from zepben.ewb.database.sql.column import Column, Nullable
 from zepben.ewb.database.sqlite.tables.iec61970.base.core.table_identified_objects import TableIdentifiedObjects
 
 

zepben/ewb/database/sqlite/tables/iec61970/base/wires/table_transformer_star_impedances.py

@@ -7,7 +7,7 @@ __all__ = ["TableTransformerStarImpedances"]
 
 from typing import List, Generator
 
-from zepben.ewb.database.sqlite.tables.column import Column, Nullable
+from zepben.ewb.database.sql.column import Column, Nullable
 from zepben.ewb.database.sqlite.tables.iec61970.base.core.table_identified_objects import TableIdentifiedObjects
 
 

zepben/ewb/database/sqlite/tables/iec61970/infiec61970/feeder/table_circuits.py

@@ -7,7 +7,7 @@ __all__ = ["TableCircuits"]
 
 from typing import List, Generator
 
-from zepben.ewb.database.sqlite.tables.column import Column, Nullable
+from zepben.ewb.database.sql.column import Column, Nullable
 from zepben.ewb.database.sqlite.tables.iec61970.base.wires.table_lines import TableLines
 
 

zepben/ewb/database/sqlite/tables/sqlite_table.py

@@ -7,136 +7,39 @@ from __future__ import annotations
 
 __all__ = ["SqliteTable"]
 
-from abc import abstractmethod
-from typing import List, Optional, Type, Any, Generator
+from abc import ABC
+from typing import List, Generator
 
-from zepben.ewb.database.sqlite.tables.column import Column, Nullable
+from zepben.ewb.database.sql.column import Column
+from zepben.ewb.database.sql.sql_table import SqlTable
 
 
-# @dataclass(slots=True)
-class SqliteTable(object):
+class SqliteTable(SqlTable, ABC):
     """
-    Represents a table in an Sqlite Database. This class should be extended and initialised to build the DDL for a Table.
-    Methods that need to be overridden are those marked @abstractmethod.
-    Methods that can be optionally overridden are unique_index_columns() and non_unique_index_columns().
-    Columns must be assigned in __init__ and column_index must be incremented for each Column created.
-    See existing implementations such as TableVersion for examples.
+    Represents a table in an Sqlite Database.
     """
 
-    column_index: int = 0
-    """Used to specify index of the column in the table during initialisation. Always increment BEFORE creating a Column. Indices start from 1."""
-
-    _column_set: Optional[List[Column]] = None
-    _create_table_sql: Optional[str] = None
-    _prepared_insert_sql: Optional[str] = None
-    _prepared_update_sql: Optional[str] = None
-    _create_indexes_sql: Optional[List[str]] = None
-    _select_sql: Optional[str] = None
-
-    @property
-    @abstractmethod
-    def name(self) -> str:
-        pass
-
-    #
-    # NOTE: This function is called `description` in teh JVM SDK, but in the python SDK this
-    #       conflicts with the `description` column of `TableIdentifiedObjects`.
-    #
-    def describe(self) -> str:
-        return self.name.replace("_", " ")
-
     @property
     def create_table_sql(self):
-        return self._create_table_sql if self._create_table_sql else self._build_create_table_sql()
-
-    @property
-    def prepared_insert_sql(self):
-        return self._prepared_insert_sql if self._prepared_insert_sql else self._build_prepared_insert_sql()
+        if self._create_table_sql is None:
+            self._create_table_sql = self._build_create_table_sql()
+        return self._create_table_sql
 
     @property
     def create_indexes_sql(self):
-        return self._create_indexes_sql if self._create_indexes_sql else self._build_indexes_sql()
-
-    @property
-    def select_sql(self):
-        return self._select_sql if self._select_sql else self._build_select_sql()
-
-    @property
-    def prepared_update_sql(self):
-        return self._prepared_update_sql if self._prepared_update_sql else self._build_prepared_update_sql()
-
-    @property
-    def unique_index_columns(self) -> Generator[List[Column], None, None]:
-        # To make this a generator we need to `yield`, but we have nothing to yield by default, so trick it by yielding from an empty for-loop.
-        for it in []:
-            yield it
-
-    @property
-    def non_unique_index_columns(self) -> Generator[List[Column], None, None]:
-        # To make this a generator we need to `yield`, but we have nothing to yield by default, so trick it by yielding from an empty for-loop.
-        for it in []:
-            yield it
-
-    @property
-    def column_set(self) -> List[Column]:
-        return self._column_set if self._column_set else self._build_column_set(self.__class__, self)
-
-    def _build_column_set(self, clazz: Type[Any], instance: SqliteTable) -> List[Column]:
-        """
-        Builds the list of columns for use in DDL statements for this table.
-
-        :param clazz: The class of this table.
-        :param instance:
-        :return:
-        """
-        cols = list()
-        for field, x in instance.__dict__.items():
-            if isinstance(x, Column):
-                if x.query_index != len(cols) + 1:
-                    raise ValueError(
-                        f"Field {field} in SQL Table class {clazz.__name__} is using an invalid column index. "
-                        f"Did you forget to increment column_index, or did you skip one?"
-                    )
-                cols.append(x)
-
-        if len(set([c.name for c in cols])) != len(cols):
-            raise ValueError("You have a duplicate column names, go fix that.")
-
-        self._column_set = sorted(cols, key=lambda it: it.query_index)
-        return self._column_set
-
-    def _build_create_table_sql(self) -> str:
-        self._create_table_sql = f"CREATE TABLE {self.name} ({', '.join([str(c) for c in self.column_set])})"
-        return self._create_table_sql
-
-    def _build_prepared_insert_sql(self) -> str:
-        self._prepared_insert_sql = f"INSERT INTO {self.name} ({', '.join([c.name for c in self.column_set])}) " \
-                                    f"VALUES ({', '.join(['?' for _ in self.column_set])})"
-        return self._prepared_insert_sql
-
-    def _build_indexes_sql(self) -> List[str]:
-        statements = []
-        for index_col in self.unique_index_columns:
-            statements.append(self._build_index_sql(index_col, True))
-        for index_col in self.non_unique_index_columns:
-            statements.append(self._build_index_sql(index_col, False))
-        self._create_indexes_sql = statements
+        if self._create_indexes_sql is None:
+            self._create_indexes_sql = list(self._build_indexes_sql())
         return self._create_indexes_sql
 
-    def _build_index_sql(self, index_col: List[Column], is_unique: bool):
-        id_string = f"{self.name}_{'_'.join(map(lambda c: c.name, index_col))}"
-        col_string = ', '.join(map(lambda c: c.name, index_col))
-        return f"CREATE {'UNIQUE ' if is_unique else ''}INDEX {id_string} ON {self.name} ({col_string})"
-
-    def _build_select_sql(self) -> str:
-        self._select_sql = f"SELECT {', '.join([c.name for c in self.column_set])} FROM {self.name}"
-        return self._select_sql
+    def _build_create_table_sql(self) -> str:
+        return f"CREATE TABLE {self.name} ({', '.join(str(c) for c in self.column_set)})"
 
-    def _build_prepared_update_sql(self) -> str:
-        self._prepared_update_sql = f"UPDATE {self.name} SET {', '.join([f'{c.name} = ?' for c in self.column_set])}"
-        return self._prepared_update_sql
+    def _build_indexes_sql(self) -> Generator[str, None, None]:
+        yield from (self._build_index_sql(index_col, True) for index_col in self.unique_index_columns)
+        yield from (self._build_index_sql(index_col, False) for index_col in self.non_unique_index_columns)
 
-    def _create_column(self, name: str, type_: str, nullable: Nullable = Nullable.NONE) -> Column:
-        self.column_index += 1
-        # noinspection PyArgumentList
-        return Column(self.column_index, name, type_, nullable)
+    def _build_index_sql(self, index_col: List[Column], is_unique: bool) -> str:
+        index_col_names = [c.name for c in index_col]
+        return (f"CREATE {'UNIQUE ' if is_unique else ''}INDEX "
+                f"{self.name}_{'_'.join(index_col_names)}"  # id string
+                f" ON {self.name} ({', '.join(index_col_names)})")  # col string

zepben/ewb/database/sqlite/tables/table_metadata_data_sources.py

@@ -5,7 +5,7 @@
 
 __all__ = ["TableMetadataDataSources"]
 
-from zepben.ewb.database.sqlite.tables.column import Column, Nullable
+from zepben.ewb.database.sql.column import Column, Nullable
 from zepben.ewb.database.sqlite.tables.sqlite_table import SqliteTable
 
 

zepben/ewb/database/sqlite/tables/table_version.py

@@ -9,7 +9,7 @@ import sqlite3
 from sqlite3 import Cursor
 from typing import Optional
 
-from zepben.ewb.database.sqlite.tables.column import Column, Nullable
+from zepben.ewb.database.sql.column import Column, Nullable
 from zepben.ewb.database.sqlite.tables.sqlite_table import SqliteTable
 
 
@@ -17,6 +17,7 @@ class TableVersion(SqliteTable):
     SUPPORTED_VERSION = 59
 
     def __init__(self):
+        super().__init__()
         self.version: Column = self._create_column("version", "TEXT", Nullable.NOT_NULL)
 
     @property

zepben/ewb/model/cim/extensions/iec61970/base/protection/power_direction_kind.py

@@ -8,9 +8,11 @@ __all__ = ["PowerDirectionKind"]
 from enum import Enum
 
 from zepben.ewb.model.cim.extensions.zbex import zbex
+from zepben.ewb.util import unique
 
 
 @zbex
+@unique
 class PowerDirectionKind(Enum):
     """
     [ZBEX]

zepben/ewb/model/cim/extensions/iec61970/base/wires/battery_control_mode.py

@@ -7,10 +7,12 @@ __all__ = ["BatteryControlMode"]
 
 from enum import Enum
 
+from zepben.ewb import unique
 from zepben.ewb.model.cim.extensions.zbex import zbex
 
 
 @zbex
+@unique
 class BatteryControlMode(Enum):
     """
     [ZBEX]

zepben/ewb/model/cim/extensions/iec61970/base/wires/transformer_cooling_type.py

@@ -7,10 +7,12 @@ __all__ = ["TransformerCoolingType"]
 
 from enum import Enum
 
+from zepben.ewb import unique
 from zepben.ewb.model.cim.extensions.zbex import zbex
 
 
 @zbex
+@unique
 class TransformerCoolingType(Enum):
     """
     [ZBEX]

zepben/ewb/model/cim/extensions/iec61970/base/wires/vector_group.py

@@ -7,10 +7,12 @@ __all__ = ["VectorGroup"]
 
 from enum import Enum
 
+from zepben.ewb import unique
 from zepben.ewb.model.cim.extensions.zbex import zbex
 
 
 @zbex
+@unique
 class VectorGroup(Enum):
     """
     [ZBEX]

zepben/ewb/model/cim/iec61968/assetinfo/wire_material_kind.py

@@ -7,7 +7,10 @@ __all__ = ["WireMaterialKind"]
 
 from enum import Enum
 
+from zepben.ewb import unique
 
+
+@unique
 class WireMaterialKind(Enum):
     """
     Kind of wire material.

zepben/ewb/model/cim/iec61968/customers/customer_kind.py

@@ -7,7 +7,10 @@ __all__ = ["CustomerKind"]
 
 from enum import Enum
 
+from zepben.ewb import unique
 
+
+@unique
 class CustomerKind(Enum):
     """
     Kind of customer.

zepben/ewb/model/cim/iec61968/infiec61968/infassetinfo/transformer_construction_kind.py

@@ -7,7 +7,10 @@ __all__ = ["TransformerConstructionKind"]
 
 from enum import Enum
 
+from zepben.ewb import unique
 
+
+@unique
 class TransformerConstructionKind(Enum):
     """
     Kind of transformer construction.

zepben/ewb/model/cim/iec61968/infiec61968/infassetinfo/transformer_function_kind.py

@@ -7,7 +7,10 @@ __all__ = ["TransformerFunctionKind"]
 
 from enum import Enum
 
+from zepben.ewb import unique
 
+
+@unique
 class TransformerFunctionKind(Enum):
     """
     Function of a transformer.

zepben/ewb/model/cim/iec61968/infiec61968/infassets/streetlight_lamp_kind.py

@@ -7,7 +7,10 @@ __all__ = ["StreetlightLampKind"]
 
 from enum import Enum
 
+from zepben.ewb import unique
 
+
+@unique
 class StreetlightLampKind(Enum):
     """
     Kind of lamp for a `Streetlight`

zepben/ewb/model/cim/iec61968/metering/controlled_appliance.py

@@ -11,7 +11,10 @@ from dataclasses import dataclass
 from enum import Enum
 from typing import List, Union
 
+from zepben.ewb import unique
 
+
+@unique
 class Appliance(Enum):
     """
     The type of appliance.

zepben/ewb/model/cim/iec61968/metering/end_device_function_kind.py

@@ -7,7 +7,10 @@ __all__ = ["EndDeviceFunctionKind"]
 
 from enum import Enum
 
+from zepben.ewb import unique
 
+
+@unique
 class EndDeviceFunctionKind(Enum):
     """
     Kind of end device function.

zepben/ewb/model/cim/iec61970/base/auxiliaryequipment/potential_transformer_kind.py

@@ -7,7 +7,10 @@ __all__ = ["PotentialTransformerKind"]
 
 from enum import Enum
 
+from zepben.ewb import unique
 
+
+@unique
 class PotentialTransformerKind(Enum):
     """
     The construction kind of the potential transformer.

zepben/ewb/model/cim/iec61970/base/core/phase_code.py

@@ -8,6 +8,7 @@ __all__ = ["PhaseCode", "phase_code_by_id", "phase_code_from_single_phases"]
 from enum import Enum
 from typing import List, Set, Union
 
+from zepben.ewb import unique
 from zepben.ewb.model.cim.iec61970.base.wires.single_phase_kind import SinglePhaseKind
 
 
@@ -21,6 +22,7 @@ def phase_code_by_id(value: int):
     return _PHASE_CODE_VALUES[value]
 
 
+@unique
 class PhaseCode(Enum):
     """
     An unordered enumeration of phase identifiers.  Allows designation of phases for both transmission and distribution equipment,

zepben/ewb/model/cim/iec61970/base/diagramlayout/diagram_style.py

@@ -7,7 +7,10 @@ __all__ = ["DiagramStyle"]
 
 from enum import Enum
 
+from zepben.ewb import unique
 
+
+@unique
 class DiagramStyle(Enum):
     """
     The diagram style refer to a style used by the originating system for a diagram.  A diagram style describes

zepben/ewb/model/cim/iec61970/base/diagramlayout/orientation_kind.py

@@ -7,7 +7,10 @@ __all__ = ["OrientationKind"]
 
 from enum import Enum
 
+from zepben.ewb import unique
 
+
+@unique
 class OrientationKind(Enum):
     """
     The orientation of the coordinate system with respect to top, left, and the coordinate number system.

zepben/ewb/model/cim/iec61970/base/domain/unit_symbol.py

@@ -7,6 +7,8 @@ __all__ = ["UnitSymbol", "unit_symbol_from_id", "unit_symbol_from_cim_name"]
 
 from enum import Enum
 
+from zepben.ewb import unique
+
 
 def unit_symbol_from_cim_name(value: str):
     return _unitsymbol_by_cim_name[value]
@@ -16,6 +18,7 @@ def unit_symbol_from_id(value: int):
     return _unitsymbol_members_by_id[value]
 
 
+# NOTE: We can't use `@unique` here, as there are duplicate unit strings.
 class UnitSymbol(Enum):
     """
     The derived units defined for usage in the CIM. In some cases, the derived unit is equal to an SI unit. Whenever possible, the standard derived symbol is

zepben/ewb/model/cim/iec61970/base/generation/production/battery_state_kind.py

@@ -7,7 +7,10 @@ __all__ = ["BatteryStateKind"]
 
 from enum import Enum
 
+from zepben.ewb import unique
 
+
+@unique
 class BatteryStateKind(Enum):
     """
     Battery state.

zepben/ewb/model/cim/iec61970/base/wires/phase_shunt_connection_kind.py

@@ -7,7 +7,10 @@ __all__ = ["PhaseShuntConnectionKind"]
 
 from enum import Enum
 
+from zepben.ewb.util import unique
 
+
+@unique
 class PhaseShuntConnectionKind(Enum):
     """
     The configuration of phase connections for a single terminal device such as a load or capacitor.

zepben/ewb/model/cim/iec61970/base/wires/regulating_control_mode_kind.py

@@ -7,7 +7,10 @@ __all__ = ["RegulatingControlModeKind"]
 
 from enum import Enum
 
+from zepben.ewb import unique
 
+
+@unique
 class RegulatingControlModeKind(Enum):
     """
     The kind of regulation model. For example regulating voltage, reactive power, active power, etc.

zepben/ewb/model/cim/iec61970/base/wires/single_phase_kind.py

@@ -8,6 +8,8 @@ __all__ = ["SinglePhaseKind", "single_phase_kind_by_id", "SINGLE_PHASE_KIND_VALU
 from enum import Enum
 from typing import Union
 
+from zepben.ewb import unique
+
 
 #
 # NOTE: The following import is actually at the bottom of this file to avoid cyclic imports.
@@ -25,6 +27,7 @@ def single_phase_kind_by_id(value):
     return SINGLE_PHASE_KIND_VALUES[value]
 
 
+@unique
 class SinglePhaseKind(Enum):
     """
     Enumeration of single phase identifiers. Allows designation of single phases for both transmission and distribution equipment, circuits and loads.

zepben/ewb/model/cim/iec61970/base/wires/svc_control_mode.py

@@ -7,7 +7,10 @@ __all__ = ["SVCControlMode"]
 
 from enum import Enum
 
+from zepben.ewb import unique
 
+
+@unique
 class SVCControlMode(Enum):
     """
     Static VAr Compensator control mode.

zepben/ewb/model/cim/iec61970/base/wires/synchronous_machine_kind.py

@@ -7,7 +7,10 @@ __all__ = ["SynchronousMachineKind"]
 
 from enum import Enum
 
+from zepben.ewb import unique
 
+
+@unique
 class SynchronousMachineKind(Enum):
     """
     Synchronous machine type.

zepben/ewb/model/cim/iec61970/base/wires/winding_connection.py

@@ -7,7 +7,10 @@ __all__ = ["WindingConnection"]
 
 from enum import Enum
 
+from zepben.ewb import unique
 
+
+@unique
 class WindingConnection(Enum):
     """
     Winding connection type.

zepben/ewb/services/network/network_state.py

@@ -7,7 +7,10 @@ __all__ = ["NetworkState"]
 
 from enum import Enum
 
+from zepben.ewb import unique
 
+
+@unique
 class NetworkState(Enum):
     """
     Indicates which state of the network an operation should be performed on.

zepben/ewb/streaming/get/included_energized_containers.py

@@ -7,7 +7,10 @@ __all__ = ["IncludedEnergizedContainers"]
 
 from enum import Enum
 
+from zepben.ewb import unique
 
+
+@unique
 class IncludedEnergizedContainers(Enum):
     """
     Indicates which energized contains should be included when fetching a container.

zepben/ewb/streaming/get/included_energizing_containers.py

@@ -7,7 +7,10 @@ __all__ = ["IncludedEnergizingContainers"]
 
 from enum import Enum
 
+from zepben.ewb.util import unique
 
+
+@unique
 class IncludedEnergizingContainers(Enum):
     """
     Indicates which energizing contains should be included when fetching a container.

zepben/ewb/util.py

@@ -19,12 +19,14 @@ __all__ = [
     "datetime_to_timestamp",
     "none",
     "classproperty",
+    "unique",
 ]
 
 import os
 import re
 from collections.abc import Sized
 from datetime import datetime
+from enum import unique as enum_unique
 from typing import List, Optional, Iterable, Callable, Any, TypeVar, Generator, Dict, Collection
 from typing import TYPE_CHECKING
 from uuid import UUID
@@ -187,3 +189,12 @@ def datetime_to_timestamp(date_time: datetime) -> PBTimestamp:
     timestamp = PBTimestamp()
     timestamp.FromDatetime(date_time)
     return timestamp
+
+
+def unique(enumeration: T) -> T:
+    """
+    A wrapper for the enum.unique() wrapper to preserve typing so that undefined members are correctly
+    flagged by the linter.
+    """
+    enum_unique(enumeration)
+    return enumeration

{zepben_ewb-1.0.0b3.dist-info → zepben_ewb-1.0.0b5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zepben.ewb
-Version: 1.0.0b3
+Version: 1.0.0b5
 Summary: Python SDK for interacting with the Energy Workbench platform
 Home-page: https://github.com/zepben/evolve-sdk-python
 Author: Kurt Greaves