Changes to support edit tsv for digital schedules

Author: Arshadwaqas115

docs/digital-schedules-issue.py

@@ -1,8 +1,8 @@
 from ipyautoui.automapschema import pydantic_model_from_json_schema
 from ipyautoui.automapschema import pydantic_model_file_from_json_schema
 from ipyautoui.custom.edittsv import EditTsvWithDiff
+from ipyautoui.custom.edittsv_with_diff_and_key_mapping import EditTsvWithDiffAndKeyMapping
 import pathlib
-import numpy as np
 
 
 json_schema = {
@@ -413,6 +413,11 @@
 from IPython.display import display
 
 class Test(BaseModel):
+    a_int: int = Field(
+        1,
+        title="A Int",
+    )
+    
     a_string: str = Field(
         "empty",
         title="A String",
@@ -436,15 +441,265 @@ class TestArray(RootModel[List[Test]]):
 edit_tsv_w_diff = EditTsvWithDiff(
     model=TestArray,
     transposed=False,
-    primary_key_name="a_string",
+    primary_key_name="a_int",
     header_depth=1,
     exclude_metadata=True,
-    value=[{"a_string": "hm", "a_list": "['Hello', 'Hey']"}]
+    value=[{"a_int": 1, "a_string": "hm", "a_list": "['Hello', 'Hey']"}]
 )
 display(edit_tsv_w_diff)
 
-display(edit_tsv_w_diff.value)
+print(edit_tsv_w_diff.changes)
+print(f'\n\n\nValue:{edit_tsv_w_diff.value}')
 
 eval(edit_tsv_w_diff.value[0]["a_list"])
 
+# +
+"""Issue with Date Validation (Project Building Area in Digital Schedules)"""
+from __future__ import annotations
+
+from enum import Enum, IntEnum
+from typing import List, Optional
+
+from pydantic import BaseModel, Field, RootModel
+
+
+class Abbreviation(Enum):
+    BLDG = 'BLDG'
+
+
+class TargetYear(IntEnum):
+    INTEGER_2025 = 2025
+    INTEGER_2026 = 2026
+    INTEGER_2027 = 2027
+    INTEGER_2028 = 2028
+    INTEGER_2029 = 2029
+    INTEGER_2030 = 2030
+    INTEGER_2031 = 2031
+    INTEGER_2032 = 2032
+    INTEGER_2033 = 2033
+    INTEGER_2034 = 2034
+    INTEGER_2035 = 2035
+    INTEGER_2036 = 2036
+    INTEGER_2037 = 2037
+    INTEGER_2038 = 2038
+    INTEGER_2039 = 2039
+    INTEGER_2040 = 2040
+    INTEGER_2050 = 2050
+
+
+class ProjectBuildingAreaItem(BaseModel):
+    Abbreviation_1: Optional[Abbreviation] = Field(
+        'BLDG',
+        alias='Abbreviation',
+        description='equipment type abbreviation, alphabetic characters only, variable length, between 2 and 6 characters',
+        title='Abbreviation',
+    )
+    TypeReference: Optional[int] = Field(
+        1,
+        description='equipment type reference, integer only. Refers to equipment type, there may be multiple instances of the same type',
+        title='Type Reference',
+    )
+    TargetYear_1: Optional[TargetYear] = Field(
+        None,
+        alias='TargetYear',
+        description='Net Zero Carbon targets change annually. This defined what year the Benchmark Targets should be defined by.',
+        title='Target Year',
+    )
+    Name: Optional[str] = Field(
+        None,
+        description='Optional. Add a building name as used in the project for easier identification.',
+        title='Building Name',
+    )
+    Id: Optional[int] = Field(None, description='', title='Id')
+
+
+class ProjectBuildingArea(RootModel[List[ProjectBuildingAreaItem]]):
+    root: List[ProjectBuildingAreaItem] = Field(..., title='ProjectBuildingArea')
+
+model = ProjectBuildingArea
+
+pbas_edt=EditTsvWithDiffAndKeyMapping(
+    model=model,
+    transposed=True,
+    primary_key_name="a_int",
+    header_depth=1,
+    exclude_metadata=True,
+    value=[{'Abbreviation': 'BLDG',
+  'TypeReference': 1,
+  'TargetYear': 2025,
+  'Name': 'Block A'},
+ {'Abbreviation': 'BLDG',
+  'TypeReference': 3,
+  'TargetYear': 2026,
+  'Name': 'Block B'}]
+)
+display(pbas_edt)
+# +
+from __future__ import annotations
+
+from datetime import date
+from enum import Enum
+from typing import List, Optional
+
+from pydantic import BaseModel, Field, RootModel
+
+
+class EnergyEndUse(Enum):
+    HEATING = 'Heating'
+    DOMESTIC_HOT_WATER = 'Domestic Hot Water'
+    HEATING___DOMESTIC_HOT_WATER = 'Heating & Domestic Hot Water'
+    COOLING = 'Cooling'
+    AUXILIARY = 'Auxiliary'
+    LIGHTING = 'Lighting'
+    SMALL_POWER = 'Small Power'
+    IT_SERVERS = 'IT/Servers'
+    PV_GENERATION = 'PV Generation'
+    LIFTS = 'Lifts'
+    CATERING = 'Catering'
+    OTHER = 'Other'
+    UNKNOWN = 'Unknown'
+
+
+class EnergyEndUseTag(Enum):
+    HEATING = 'Heating'
+    HEATING___DISTRIBUTION_LOSS = 'Heating - Distribution Loss'
+    DOMESTIC_HOT_WATER = 'Domestic Hot Water'
+    COOLING = 'Cooling'
+    AUXILIARY = 'Auxiliary'
+    LIGHTING = 'Lighting'
+    LIGHTING___EXTERNAL = 'Lighting - External'
+    SMALL_POWER = 'Small Power'
+    IT_SERVERS = 'IT/Servers'
+    PV_GENERATION = 'PV Generation'
+    POOL = 'Pool'
+    LIFTS = 'Lifts'
+    CATERING = 'Catering'
+    OTHER = 'Other'
+    UNKNOWN = 'Unknown'
+
+
+class FuelType(Enum):
+    ELECTRICITY = 'Electricity'
+    GAS___NG = 'Gas - NG'
+    GAS___BIOGAS = 'Gas - Biogas'
+    GAS___LPG = 'Gas - LPG'
+    GAS___OTHER = 'Gas - Other'
+    UNKNOWN = 'Unknown'
+    UNSET = 'Unset'
+
+
+class OperationalEnergyAnalysisType(Enum):
+    PART_L = 'Part L'
+    SCOTTISH_PART_L = 'Scottish Part L'
+    TM54 = 'TM54'
+    PASSIVHAUS = 'Passivhaus'
+    CUSTOM = 'Custom'
+
+
+class PredictedEnergyUseItem(BaseModel):
+    InstanceReference: Optional[int] = Field(
+        1,
+        description='equipment instance reference, integer only. Refers to equipment instance.',
+        title='Instance Reference',
+    )
+    BuildingID: Optional[str] = Field(
+        None,
+        description='A unique identifier within the project assigned to a building',
+        title='Building ID',
+    )
+    AssessmentDate: Optional[date] = Field(
+        None,
+        description='Date on which the overall condition is assessed',
+        title='Assessment Date',
+    )
+    Notes: Optional[str] = Field(None, description='', title='Notes')
+    OperationalEnergyAnalysisType_1: Optional[OperationalEnergyAnalysisType] = Field(
+        None,
+        alias='OperationalEnergyAnalysisType',
+        description='defines the type of analysis',
+        title='Operational Energy Analysis Type',
+    )
+    FuelType_1: Optional[FuelType] = Field(
+        None, alias='FuelType', description='', title='Fuel Type'
+    )
+    EnergyConsumption: Optional[float] = Field(
+        None,
+        description='Annual energy consumption requirement. NOTE: PV Generation should be a -ve value.',
+        title='Energy Consumption',
+    )
+    EnergyEndUse_1: Optional[EnergyEndUse] = Field(
+        None,
+        alias='EnergyEndUse',
+        description='The end-use of the energy consumption within a building. Pick the most appropriate.',
+        title='Energy End Use',
+    )
+    EnergyEndUseTags: Optional[List[EnergyEndUseTag]] = Field(
+        None,
+        description='Avoid where possible. Use only when the "Energy End Use" does not correctly describe usage (e.g. mostly DHW, but add a lighting tag to indicate some lights).',
+        title='Energy End Use Tags',
+    )
+    TypeMark: Optional[str] = Field(None, description='', title='Type Mark')
+    TypeSpecId: Optional[int] = Field(None, description='', title='Type Spec Id')
+    Id: Optional[int] = Field(None, description='', title='Id')
+
+
+class PredictedEnergyUse(RootModel[List[PredictedEnergyUseItem]]):
+    root: List[PredictedEnergyUseItem] = Field(..., title='PredictedEnergyUse')
+
+
+# -
+
+
+"""Date format null warning (Predicted Energy Use in Digital Schedules)"""
+value = [{'InstanceReference': 1,
+  'BuildingID': 'BLDG-1',
+  'AssessmentDate': None,
+  'Notes': None,
+  'OperationalEnergyAnalysisType': 'Part L',
+  'FuelType': 'Electricity',
+  'EnergyConsumption': 50.0,
+  'EnergyEndUse': 'Heating',
+  'EnergyEndUseTags': [],
+  'TypeMark': None},
+ {'InstanceReference': 2,
+  'BuildingID': 'BLDG-1',
+  'AssessmentDate': None,
+  'Notes': None,
+  'OperationalEnergyAnalysisType': 'Part L',
+  'FuelType': 'Electricity',
+  'EnergyConsumption': 25.0,
+  'EnergyEndUse': 'Cooling',
+  'EnergyEndUseTags': [],
+  'TypeMark': None},
+ {'InstanceReference': 3,
+  'BuildingID': 'BLDG-1',
+  'AssessmentDate': None,
+  'Notes': None,
+  'OperationalEnergyAnalysisType': 'Part L',
+  'FuelType': 'Electricity',
+  'EnergyConsumption': -30.0,
+  'EnergyEndUse': 'PV Generation',
+  'EnergyEndUseTags': [],
+  'TypeMark': None},
+ {'InstanceReference': 4,
+  'BuildingID': 'BLDG-3',
+  'AssessmentDate': None,
+  'Notes': None,
+  'OperationalEnergyAnalysisType': 'TM54',
+  'FuelType': 'Electricity',
+  'EnergyConsumption': 200.0,
+  'EnergyEndUse': 'Heating',
+  'EnergyEndUseTags': [],
+  'TypeMark': None}]
+peu_edt=EditTsvWithDiffAndKeyMapping(
+    model=PredictedEnergyUse,
+    primary_key_name=["", ""],
+    header_depth=1,
+    exclude_metadata=True,
+    value=value
+)
+display(peu_edt)
+
+peu_edt.model.model_fields['root'].annotation.__args__[0].model_fields
+