flood-adapt 0.3.8__py3-none-any.whl → 0.3.10__py3-none-any.whl

flood_adapt/objects/object_model.py

@@ -1,68 +1,74 @@
-import os
-from pathlib import Path
-
-import tomli
-import tomli_w
-from pydantic import BaseModel, Field
-
-
-class Object(BaseModel):
-    """Base class for FloodAdapt objects.
-
-    Attributes
-    ----------
-    name : str
-        Name of the object.
-    description : str
-        Description of the object. defaults to "".
-    """
-
-    name: str = Field(
-        ...,
-        description="Name of the object.",
-        min_length=1,
-        pattern='^[^<>:"/\\\\|?* ]*$',
-    )
-    description: str = Field(default="", description="Description of the object.")
-
-    @classmethod
-    def load_file(cls, file_path: Path | str | os.PathLike) -> "Object":
-        """Load object from file.
-
-        Parameters
-        ----------
-        file_path : Path | str | os.PathLike
-            Path to the file to load.
-
-        """
-        with open(file_path, mode="rb") as fp:
-            toml = tomli.load(fp)
-        return cls.model_validate(toml)
-
-    def save(self, toml_path: Path | str | os.PathLike) -> None:
-        """Save object to disk.
-
-        Parameters
-        ----------
-        toml_path : Path | str | os.PathLike
-            Path to the file to save.
-
-        """
-        self.save_additional(output_dir=Path(toml_path).parent)
-        with open(toml_path, "wb") as f:
-            tomli_w.dump(self.model_dump(exclude_none=True), f)
-
-    def save_additional(self, output_dir: Path | str | os.PathLike) -> None:
-        """Save additional files to database if the object has any and update attrs to reflect the change in file location.
-
-        This method should be overridden if the object has additional files.
-        """
-        pass
-
-    def __eq__(self, value):
-        if not isinstance(value, self.__class__):
-            # don't attempt to compare against unrelated types
-            return False
-        _self = self.model_dump(exclude={"name", "description"}, exclude_none=True)
-        _other = value.model_dump(exclude={"name", "description"}, exclude_none=True)
-        return _self == _other
+import os
+import re
+from pathlib import Path
+
+import tomli
+import tomli_w
+from pydantic import BaseModel, Field, field_validator
+
+
+class Object(BaseModel):
+    """Base class for FloodAdapt objects.
+
+    Attributes
+    ----------
+    name : str
+        Name of the object.
+    description : str
+        Description of the object. defaults to "".
+    """
+
+    name: str = Field(..., description="Name of the object.")
+    description: str = Field(default="", description="Description of the object.")
+
+    @field_validator("name")
+    def validate_name(cls, value: str) -> str:
+        if not len(value) > 0:
+            raise ValueError("Name must be at least one character long.")
+        if not re.match(r"^[A-Za-z0-9_-]+$", value):
+            raise ValueError(
+                "Name can only contain letters, numbers, underscores (_), and hyphens (-)."
+            )
+        return value
+
+    @classmethod
+    def load_file(cls, file_path: Path | str | os.PathLike) -> "Object":
+        """Load object from file.
+
+        Parameters
+        ----------
+        file_path : Path | str | os.PathLike
+            Path to the file to load.
+
+        """
+        with open(file_path, mode="rb") as fp:
+            toml = tomli.load(fp)
+        return cls.model_validate(toml)
+
+    def save(self, toml_path: Path | str | os.PathLike) -> None:
+        """Save object to disk.
+
+        Parameters
+        ----------
+        toml_path : Path | str | os.PathLike
+            Path to the file to save.
+
+        """
+        self.save_additional(output_dir=Path(toml_path).parent)
+        with open(toml_path, "wb") as f:
+            tomli_w.dump(self.model_dump(exclude_none=True), f)
+
+    def save_additional(self, output_dir: Path | str | os.PathLike) -> None:
+        """Save additional files to database if the object has any and update attrs to reflect the change in file location.
+
+        This method should be overridden if the object has additional files.
+        """
+        pass
+
+    def __eq__(self, value):
+        if not isinstance(value, self.__class__):
+            # don't attempt to compare against unrelated types
+            return False
+        _self = self.model_dump(exclude={"name", "description"}, exclude_none=True)
+        _other = value.model_dump(exclude={"name", "description"}, exclude_none=True)
+        return _self == _other

flood_adapt/objects/projections/projections.py

@@ -1,89 +1,103 @@
-import os
-from pathlib import Path
-from typing import Optional
-
-from pydantic import BaseModel, Field
-
-from flood_adapt.misc.utils import resolve_filepath, save_file_to_database
-from flood_adapt.objects.forcing import unit_system as us
-from flood_adapt.objects.object_model import Object
-
-
-class PhysicalProjection(BaseModel):
-    """The accepted input for a physical projection in FloodAdapt.
-
-    Attributes
-    ----------
-    sea_level_rise : us.UnitfulLength
-        The sea level rise in meters. Default=us.UnitfulLength(0.0, us.UnitTypesLength.meters).
-    subsidence : us.UnitfulLength
-        The subsidence in meters. Default=us.UnitfulLength(0.0, us.UnitTypesLength.meters).
-    rainfall_multiplier : float
-        The rainfall multiplier. Default = 1.0.
-    storm_frequency_increase : float
-        The storm frequency increase as a percentage. Default = 0.0.
-    """
-
-    sea_level_rise: us.UnitfulLength = us.UnitfulLength(
-        value=0.0, units=us.UnitTypesLength.meters
-    )
-    subsidence: us.UnitfulLength = us.UnitfulLength(
-        value=0.0, units=us.UnitTypesLength.meters
-    )
-    rainfall_multiplier: float = Field(default=1.0, ge=0.0)
-    storm_frequency_increase: float = 0.0
-
-
-class SocioEconomicChange(BaseModel):
-    """The accepted input for socio-economic change in FloodAdapt.
-
-    Attributes
-    ----------
-    population_growth_existing : float
-        The existing population growth rate. default=0.0
-    economic_growth : float
-        The economic growth rate. default=0.0.
-    population_growth_new : float
-        The population growth rate for new developments. default=0.0.
-    new_development_elevation : Optional[us.UnitfulLengthRefValue]
-        The elevation of new developments. default=None.
-    new_development_shapefile : Optional[str]
-        The path to the shapefile of new developments. default=None.
-    """
-
-    population_growth_existing: Optional[float] = 0.0
-    economic_growth: Optional[float] = 0.0
-
-    population_growth_new: Optional[float] = 0.0
-    new_development_elevation: Optional[us.UnitfulLengthRefValue] = None
-    new_development_shapefile: Optional[str] = None
-
-
-class Projection(Object):
-    """The accepted input for a projection in FloodAdapt.
-
-    A projection is a combination of a physical projection and a socio-economic change.
-
-    Attributes
-    ----------
-    physical_projection : PhysicalProjection
-        The physical projection model. Contains information about hazard drivers.
-    socio_economic_change : SocioEconomicChange
-        The socio-economic change model. Contains information about impact drivers.
-
-    """
-
-    physical_projection: PhysicalProjection
-    socio_economic_change: SocioEconomicChange
-
-    def save_additional(self, output_dir: Path | str | os.PathLike) -> None:
-        if self.socio_economic_change.new_development_shapefile:
-            src_path = resolve_filepath(
-                "projections",
-                self.name,
-                self.socio_economic_change.new_development_shapefile,
-            )
-            path = save_file_to_database(src_path, Path(output_dir))
-
-            # Update the shapefile path in the object so it is saved in the toml file as well
-            self.socio_economic_change.new_development_shapefile = path.name
+import math
+import os
+from pathlib import Path
+from typing import Optional
+
+from pydantic import BaseModel, Field, model_validator
+
+from flood_adapt.misc.utils import resolve_filepath, save_file_to_database
+from flood_adapt.objects.forcing import unit_system as us
+from flood_adapt.objects.object_model import Object
+
+
+class PhysicalProjection(BaseModel):
+    """The accepted input for a physical projection in FloodAdapt.
+
+    Attributes
+    ----------
+    sea_level_rise : us.UnitfulLength
+        The sea level rise in meters. Default=us.UnitfulLength(0.0, us.UnitTypesLength.meters).
+    subsidence : us.UnitfulLength
+        The subsidence in meters. Default=us.UnitfulLength(0.0, us.UnitTypesLength.meters).
+    rainfall_multiplier : float
+        The rainfall multiplier. Default = 1.0.
+    storm_frequency_increase : float
+        The storm frequency increase as a percentage. Default = 0.0.
+    """
+
+    sea_level_rise: us.UnitfulLength = us.UnitfulLength(
+        value=0.0, units=us.UnitTypesLength.meters
+    )
+    subsidence: us.UnitfulLength = us.UnitfulLength(
+        value=0.0, units=us.UnitTypesLength.meters
+    )
+    rainfall_multiplier: float = Field(default=1.0, ge=0.0)
+    storm_frequency_increase: float = 0.0
+
+
+class SocioEconomicChange(BaseModel):
+    """The accepted input for socio-economic change in FloodAdapt.
+
+    Attributes
+    ----------
+    population_growth_existing : float
+        The population growth percentage of the existing area. default=0.0
+    economic_growth : float
+        The economic growth percentage. default=0.0.
+    population_growth_new : float
+        The population growth percentage for the new development areas. default=0.0.
+    new_development_elevation : Optional[us.UnitfulLengthRefValue]
+        The elevation of the new development areas. default=None.
+    new_development_shapefile : Optional[str]
+        The path to the shapefile of the new development areas. default=None.
+    """
+
+    population_growth_existing: Optional[float] = 0.0
+    economic_growth: Optional[float] = 0.0
+
+    population_growth_new: Optional[float] = 0.0
+    new_development_elevation: Optional[us.UnitfulLengthRefValue] = None
+    new_development_shapefile: Optional[str] = None
+
+    @model_validator(mode="after")
+    def validate_selection_type(self) -> "SocioEconomicChange":
+        if not math.isclose(self.population_growth_new or 0.0, 0.0, abs_tol=1e-8):
+            if self.new_development_shapefile is None:
+                raise ValueError(
+                    "If `population_growth_new` is non-zero, then `new_development_shapefile` must also be provided."
+                )
+        return self
+
+
+class Projection(Object):
+    """The accepted input for a projection in FloodAdapt.
+
+    A projection is a combination of a physical projection and a socio-economic change.
+
+    Attributes
+    ----------
+    name : str
+        Name of the object.
+    description : str
+        Description of the object. defaults to "".
+    physical_projection : PhysicalProjection
+        The physical projection model. Contains information about hazard drivers.
+    socio_economic_change : SocioEconomicChange
+        The socio-economic change model. Contains information about impact drivers.
+
+    """
+
+    physical_projection: PhysicalProjection = PhysicalProjection()
+    socio_economic_change: SocioEconomicChange = SocioEconomicChange()
+
+    def save_additional(self, output_dir: Path | str | os.PathLike) -> None:
+        if self.socio_economic_change.new_development_shapefile:
+            src_path = resolve_filepath(
+                "projections",
+                self.name,
+                self.socio_economic_change.new_development_shapefile,
+            )
+            path = save_file_to_database(src_path, Path(output_dir))
+
+            # Update the shapefile path in the object so it is saved in the toml file as well
+            self.socio_economic_change.new_development_shapefile = path.name

flood_adapt/objects/scenarios/scenarios.py

@@ -1,22 +1,22 @@
-from flood_adapt.objects.object_model import Object
-
-
-class Scenario(Object):
-    """BaseModel describing the expected variables and data types of a scenario.
-
-    A scenario is a combination of an event, a projection, and a strategy, that all should be saved in the database.
-
-    Attributes
-    ----------
-    event : str
-        The name of the event.
-    projection : str
-        The name of the projection.
-    strategy : str
-        The name of the strategy.
-
-    """
-
-    event: str
-    projection: str
-    strategy: str
+from flood_adapt.objects.object_model import Object
+
+
+class Scenario(Object):
+    """BaseModel describing the expected variables and data types of a scenario.
+
+    A scenario is a combination of an event, a projection, and a strategy, that all should be saved in the database.
+
+    Attributes
+    ----------
+    event : str
+        The name of the event.
+    projection : str
+        The name of the projection.
+    strategy : str
+        The name of the strategy.
+
+    """
+
+    event: str
+    projection: str
+    strategy: str

flood_adapt/objects/strategies/strategies.py

@@ -1,89 +1,89 @@
-from flood_adapt.objects.measures.measures import (
-    HazardMeasure,
-    ImpactMeasure,
-    Measure,
-)
-from flood_adapt.objects.object_model import Object
-
-
-class Strategy(Object):
-    """
-    Class representing a strategy in FloodAdapt.
-
-    A strategy is a collection of measures that can be applied to a model.
-
-    Attributes
-    ----------
-    measures : list[str]
-        A list of measures associated with the strategy. Should be a list of measure names that are saved in the database.
-
-    """
-
-    measures: list[str]
-
-    _measure_objects: list[Measure] | None = None
-
-    def initialize_measure_objects(self, measures: list[Measure]) -> None:
-        """Initialize the measure objects associated with this strategy.
-
-        Parameters
-        ----------
-        measures : list[Measure]
-            A list of measure objects to be associated with this strategy. Should be a list of measure objects that are saved in the database.
-        """
-        self._measure_objects = measures
-
-    def get_measures(self) -> list[Measure]:
-        """Get the measures associated with this strategy.
-
-        Note that this method will return the measure objects, not just their names.
-        The measure objects are initialized using the `initialize_measure_objects` method.
-
-        Returns
-        -------
-        measures : list[Measure]
-            The list of measure objects associated with this strategy.
-
-        Raises
-        ------
-        ValueError
-            If the measure objects have not been initialized.
-        """
-        # Get measure paths using a database structure
-        if self._measure_objects is None:
-            raise ValueError(
-                "Measure objects have not been initialized. Call `initialize_measure_objects()` first."
-            )
-        return self._measure_objects
-
-    def get_impact_measures(self) -> list[ImpactMeasure]:
-        return [
-            measure
-            for measure in self.get_measures()
-            if isinstance(measure, ImpactMeasure)
-        ]
-
-    def get_impact_strategy(self) -> "Strategy":
-        impact_measures = self.get_impact_measures()
-        impact_strategy = Strategy(
-            name=self.name,
-            measures=[m.name for m in impact_measures],
-        )
-        impact_strategy.initialize_measure_objects(impact_measures)
-        return impact_strategy
-
-    def get_hazard_measures(self) -> list[HazardMeasure]:
-        return [
-            measure
-            for measure in self.get_measures()
-            if isinstance(measure, HazardMeasure)
-        ]
-
-    def get_hazard_strategy(self) -> "Strategy":
-        hazard_measures = self.get_hazard_measures()
-        hazard_strategy = Strategy(
-            name=self.name,
-            measures=[m.name for m in hazard_measures],
-        )
-        hazard_strategy.initialize_measure_objects(hazard_measures)
-        return hazard_strategy
+from flood_adapt.objects.measures.measures import (
+    HazardMeasure,
+    ImpactMeasure,
+    Measure,
+)
+from flood_adapt.objects.object_model import Object
+
+
+class Strategy(Object):
+    """
+    Class representing a strategy in FloodAdapt.
+
+    A strategy is a collection of measures that can be applied to a model.
+
+    Attributes
+    ----------
+    measures : list[str]
+        A list of measures associated with the strategy. Should be a list of measure names that are saved in the database.
+
+    """
+
+    measures: list[str]
+
+    _measure_objects: list[Measure] | None = None
+
+    def initialize_measure_objects(self, measures: list[Measure]) -> None:
+        """Initialize the measure objects associated with this strategy.
+
+        Parameters
+        ----------
+        measures : list[Measure]
+            A list of measure objects to be associated with this strategy. Should be a list of measure objects that are saved in the database.
+        """
+        self._measure_objects = measures
+
+    def get_measures(self) -> list[Measure]:
+        """Get the measures associated with this strategy.
+
+        Note that this method will return the measure objects, not just their names.
+        The measure objects are initialized using the `initialize_measure_objects` method.
+
+        Returns
+        -------
+        measures : list[Measure]
+            The list of measure objects associated with this strategy.
+
+        Raises
+        ------
+        ValueError
+            If the measure objects have not been initialized.
+        """
+        # Get measure paths using a database structure
+        if self._measure_objects is None:
+            raise ValueError(
+                "Measure objects have not been initialized. Call `initialize_measure_objects()` first."
+            )
+        return self._measure_objects
+
+    def get_impact_measures(self) -> list[ImpactMeasure]:
+        return [
+            measure
+            for measure in self.get_measures()
+            if isinstance(measure, ImpactMeasure)
+        ]
+
+    def get_impact_strategy(self) -> "Strategy":
+        impact_measures = self.get_impact_measures()
+        impact_strategy = Strategy(
+            name=self.name,
+            measures=[m.name for m in impact_measures],
+        )
+        impact_strategy.initialize_measure_objects(impact_measures)
+        return impact_strategy
+
+    def get_hazard_measures(self) -> list[HazardMeasure]:
+        return [
+            measure
+            for measure in self.get_measures()
+            if isinstance(measure, HazardMeasure)
+        ]
+
+    def get_hazard_strategy(self) -> "Strategy":
+        hazard_measures = self.get_hazard_measures()
+        hazard_strategy = Strategy(
+            name=self.name,
+            measures=[m.name for m in hazard_measures],
+        )
+        hazard_strategy.initialize_measure_objects(hazard_measures)
+        return hazard_strategy