Merge pull request #1 from IFRCGo/feat/setup-pre-commit-hooks

Setup pre-commit hooks for black, isort, flake8 and ruff

Author: samshara

.flake8

@@ -0,0 +1,5 @@
+[flake8]
+extend-ignore = C901, E203, E701
+max-line-length = 130
+exclude = .git,__pycache__,old,build,dist,
+max-comlpexity = 10

.github/workflows/lint.yml

@@ -0,0 +1,17 @@
+name: Lints
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+
+jobs:
+  pre_commit_checks:
+    name: Pre-Commit checks
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@main
+      - uses: pre-commit/action@main

.pre-commit-config.yaml

@@ -0,0 +1,38 @@
+default_language_version:
+  python: python3
+
+# NOTE: Update in .flake8 pyproject.toml as well
+exclude: |
+    (?x)^(
+      \.git|
+      __pycache__|
+      \.venv
+    )
+
+repos:
+  - repo: https://github.com/psf/black
+    rev: 24.3.0
+    hooks:
+      - id: black
+        # args: ["--check"]
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        # args: ["--check"]
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 7.0.0
+    hooks:
+      - id: flake8
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.8.4
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format

pyproject.toml

@@ -65,7 +65,7 @@ module = ["jinja2"]
 ignore_missing_imports = true
 
 [tool.ruff]
-line-length = 88
+line-length = 130
 lint.select = ["E", "F", "I"]
 
 [tool.pytest.ini_options]
@@ -78,6 +78,35 @@ exclude = ["tests*"]
 [tool.setuptools.dynamic]
 version = { attr = "pystac_monty.extension.__version__" }
 
+[tool.black]
+line-length = 130
+target-version = ['py39']
+include = '\.pyi?$'
+exclude = '''
+/(
+    \.git
+  | \.tox
+  | \.venv
+  | \.db
+  | _build
+  | buck-out
+  | build
+  | dist
+  | docs
+)/
+'''
+# NOTE: Update in .pre-commit-config.yaml as well
+extend-exclude = "^.*\\b(migrations)\\b.*$ (__pycache__|.+/+.+/+migrations/+.*)"
+
+[tool.isort]
+profile = "black"
+multi_line_output = 3
+# NOTE: Update in .pre-commit-config.yaml as well
+skip = [
+    "**/__pycache__",
+    ".venv/",
+]
+
 [tool.uv]
 dev-dependencies = [
     "codespell<2.3",

pystac_monty/extension.py

@@ -4,25 +4,22 @@
 
 from abc import ABC
 from collections.abc import Mapping
-from datetime import datetime
-from typing import Any, Dict, Generic, Iterator, Literal, TypeVar, Union, cast
+from typing import Any, Generic, Iterator, Literal, TypeVar, Union, cast
 
 import pystac
 import pystac.extensions
 import pystac.extensions.ext
 from pystac.extensions import item_assets
 from pystac.extensions.base import ExtensionManagementMixin, PropertiesExtension
 from pystac.extensions.hooks import ExtensionHooks
-from pystac.utils import StringEnum, get_opt, get_required, map_opt, str_to_datetime
+from pystac.utils import StringEnum, get_opt, get_required, map_opt
 
 from pystac_monty.hazard_profiles import HazardProfiles
 from pystac_monty.paring import Pairing
 
 __version__ = "0.1.0"
 
-T = TypeVar(
-    "T", pystac.Collection, pystac.Item, pystac.Asset, item_assets.AssetDefinition
-)
+T = TypeVar("T", pystac.Collection, pystac.Item, pystac.Asset, item_assets.AssetDefinition)
 
 SCHEMA_URI = "https://ifrcgo.github.io/monty/v0.1.0/schema.json"
 
@@ -158,8 +155,8 @@ def __init__(self) -> None:
             MontyImpactExposureCategory.AID_CONTRIBUTIONS_NON_INFLATION_ADJUSTED: "Aid Contributions Non-Inflation-Adjusted",
             MontyImpactExposureCategory.AID_CONTRIBUTIONS_UNSPECIFIED: "Aid Contributions (Unspecified-Inflation-Adjustment)",
             MontyImpactExposureCategory.RECONSTRUCTION_COSTS_INFLATION_ADJUSTED: "Reconstruction Costs Inflation-Adjusted",
-            MontyImpactExposureCategory.RECONSTRUCTION_COSTS_NON_INFLATION_ADJUSTED: "Reconstruction Costs Non-Inflation-Adjusted",
-            MontyImpactExposureCategory.RECONSTRUCTION_COSTS_UNSPECIFIED: "Reconstruction Costs (Unspecified-Inflation-Adjustment)",
+            MontyImpactExposureCategory.RECONSTRUCTION_COSTS_NON_INFLATION_ADJUSTED: "Reconstruction Costs Non-Inflation-Adjusted",  # noqa: E501
+            MontyImpactExposureCategory.RECONSTRUCTION_COSTS_UNSPECIFIED: "Reconstruction Costs (Unspecified-Inflation-Adjustment)",  # noqa: E501
             MontyImpactExposureCategory.INSURED_COSTS_INFLATION_ADJUSTED: "Insured Costs Inflation-Adjusted",
             MontyImpactExposureCategory.INSURED_COSTS_NON_INFLATION_ADJUSTED: "Insured Costs Non-Inflation-Adjusted",
             MontyImpactExposureCategory.INSURED_COSTS_UNSPECIFIED: "Insured Costs (Unspecified-Inflation-Adjustment)",
@@ -173,11 +170,11 @@ def __init__(self) -> None:
             MontyImpactExposureCategory.TOTAL_DIRECT_COSTS_NON_INFLATION_ADJUSTED: "Total Direct Costs Non-Inflation-Adjusted",
             MontyImpactExposureCategory.TOTAL_DIRECT_COSTS_UNSPECIFIED: "Total Direct Costs (Unspecified-Inflation-Adjustment)",
             MontyImpactExposureCategory.TOTAL_INDIRECT_COSTS_INFLATION_ADJUSTED: "Total Indirect Costs Inflation-Adjusted",
-            MontyImpactExposureCategory.TOTAL_INDIRECT_COSTS_NON_INFLATION_ADJUSTED: "Total Indirect Costs Non-Inflation-Adjusted",
-            MontyImpactExposureCategory.TOTAL_INDIRECT_COSTS_UNSPECIFIED: "Total Indirect Costs (Unspecified-Inflation-Adjustment)",
+            MontyImpactExposureCategory.TOTAL_INDIRECT_COSTS_NON_INFLATION_ADJUSTED: "Total Indirect Costs Non-Inflation-Adjusted",  # noqa: E501
+            MontyImpactExposureCategory.TOTAL_INDIRECT_COSTS_UNSPECIFIED: "Total Indirect Costs (Unspecified-Inflation-Adjustment)",  # noqa: E501
             MontyImpactExposureCategory.CATTLE: "Cattle",
             MontyImpactExposureCategory.ALERTSCORE: "Alertscore",
-            MontyImpactExposureCategory.IFRC_AID_CONTRIBUTIONS_UNSPECIFIED: "IFRC Aid Contributions (Unspecified-Inflation-Adjustment)",
+            MontyImpactExposureCategory.IFRC_AID_CONTRIBUTIONS_UNSPECIFIED: "IFRC Aid Contributions (Unspecified-Inflation-Adjustment)",  # noqa: E501
         }
 
     def __getitem__(self, key: MontyImpactExposureCategory) -> str:
@@ -245,7 +242,7 @@ def __init__(self) -> None:
             MontyImpactType.LOSS_COST: "Loss (Cost)",
             MontyImpactType.HOMELESS: "Homeless",
             MontyImpactType.INTERNALLY_DISPLACED_PERSONS: "Internally Displaced Persons (IDPs)",
-            MontyImpactType.REFUGEES_ASYLUM_SEEKERS_EXTERNALLY_DISPLACED_PERSONS: "Refugees, Asylum Seekers and Externally Displaced Persons",
+            MontyImpactType.REFUGEES_ASYLUM_SEEKERS_EXTERNALLY_DISPLACED_PERSONS: "Refugees, Asylum Seekers and Externally Displaced Persons",  # noqa: E501
             MontyImpactType.DISPLACED_PERSONS: "Displaced Persons (Internal & External)",
             MontyImpactType.ALERTSCORE: "Alertscore",
         }
@@ -340,9 +337,7 @@ def to_dict(self) -> dict[str, Any]:
 
     @staticmethod
     def from_dict(d: dict[str, Any]) -> HazardDetail:
-        cluster: str = get_required(
-            d.get(HAZDET_CLUSTER_PROP), "hazard_detail", HAZDET_CLUSTER_PROP
-        )
+        cluster: str = get_required(d.get(HAZDET_CLUSTER_PROP), "hazard_detail", HAZDET_CLUSTER_PROP)
 
         return HazardDetail(cluster)
 
@@ -405,7 +400,7 @@ def value(self) -> float:
             ITEM_IMPACT_DETAIL_PROP,
             IMPDET_VALUE_PROP,
         )
-        
+
     @value.setter
     def value(self, v: float) -> None:
         self.properties[IMPDET_VALUE_PROP] = v
@@ -433,18 +428,13 @@ def to_dict(self) -> dict[str, Any]:
 
     @staticmethod
     def from_dict(d: dict[str, Any]) -> ImpactDetail:
-        category: str = get_required(
-            d.get(IMPDET_CATEGORY_PROP), "impact_detail", IMPDET_CATEGORY_PROP
-        )
-        type: str = get_required(
-            d.get(IMPDET_TYPE_PROP), "impact_detail", IMPDET_TYPE_PROP
-        )
-        value: float = get_required(
-            d.get(IMPDET_VALUE_PROP), "impact_detail", IMPDET_VALUE_PROP
-        )
+        category: str = get_required(d.get(IMPDET_CATEGORY_PROP), "impact_detail", IMPDET_CATEGORY_PROP)
+        type: str = get_required(d.get(IMPDET_TYPE_PROP), "impact_detail", IMPDET_TYPE_PROP)
+        value: float = get_required(d.get(IMPDET_VALUE_PROP), "impact_detail", IMPDET_VALUE_PROP)
 
         return ImpactDetail(category, type, value)
 
+
 class MontyExtension(
     Generic[T],
     PropertiesExtension,
@@ -492,9 +482,7 @@ def apply(
     @property
     def correlation_id(self) -> str:
         """A unique correlation identifier for the event of the data."""
-        result = get_required(
-            self._get_property(ITEM_CORR_ID_PROP, str), self, ITEM_CORR_ID_PROP
-        )
+        result = get_required(self._get_property(ITEM_CORR_ID_PROP, str), self, ITEM_CORR_ID_PROP)
         return result
 
     @correlation_id.setter
@@ -529,23 +517,19 @@ def hazard_codes(self, v: list[str] | None) -> None:
     @property
     def hazard_detail(self) -> HazardDetail | None:
         """The details of the hazard."""
-        result = map_opt(
-            self._get_property(ITEM_HAZARD_DETAIL_PROP, dict), HazardDetail
-        )
+        result = map_opt(self._get_property(ITEM_HAZARD_DETAIL_PROP, dict), HazardDetail)
         return result
 
     @hazard_detail.setter
     def hazard_detail(self, v: HazardDetail | None) -> None:
         self._set_property(ITEM_HAZARD_DETAIL_PROP, map_opt(lambda x: x.to_dict(), v))
-        
+
     @property
     def impact_detail(self) -> ImpactDetail | None:
         """The details of the impact."""
-        result = map_opt(
-            self._get_property(ITEM_IMPACT_DETAIL_PROP, dict), ImpactDetail
-        )
+        result = map_opt(self._get_property(ITEM_IMPACT_DETAIL_PROP, dict), ImpactDetail)
         return result
-    
+
     @impact_detail.setter
     def impact_detail(self, v: ImpactDetail | None) -> None:
         self._set_property(ITEM_IMPACT_DETAIL_PROP, map_opt(lambda x: x.to_dict(), v))
@@ -560,9 +544,7 @@ def episode_number(self, v: int) -> None:
         self.properties[ITEM_EPISODE_NUMBER_PROP] = v
 
     def compute_and_set_correlation_id(self, hazard_profiles: HazardProfiles) -> None:
-        correlation_id = self.pairing.generate_correlation_id(
-            self.item, hazard_profiles
-        )
+        correlation_id = self.pairing.generate_correlation_id(self.item, hazard_profiles)
         self.correlation_id = correlation_id
 
     @classmethod
@@ -595,9 +577,7 @@ def ext(cls, obj: T, add_if_missing: bool = False) -> MontyExtension[T]:
 
     @staticmethod
     def enable_extension() -> None:
-        pystac.extensions.ext.ItemExt.monty = property(
-            lambda self: MontyExtension.ext(self)
-        )
+        pystac.extensions.ext.ItemExt.monty = property(lambda self: MontyExtension.ext(self))
 
 
 class CollectionMontyExtension(MontyExtension[pystac.Collection]):
@@ -638,24 +618,15 @@ def __init__(self, item: pystac.Item):
 
     def is_source_event(self) -> bool:
         """Indicates if the item is a source event."""
-        return (
-            MontyRoles.SOURCE in self.item.properties["roles"]
-            and MontyRoles.EVENT in self.item.properties["roles"]
-        )
+        return MontyRoles.SOURCE in self.item.properties["roles"] and MontyRoles.EVENT in self.item.properties["roles"]
 
     def is_source_hazard(self) -> bool:
         """Indicates if the item is a source hazard."""
-        return (
-            MontyRoles.SOURCE in self.item.properties["roles"]
-            and MontyRoles.HAZARD in self.item.properties["roles"]
-        )
-        
+        return MontyRoles.SOURCE in self.item.properties["roles"] and MontyRoles.HAZARD in self.item.properties["roles"]
+
     def is_source_impact(self) -> bool:
         """Indicates if the item is a source impact."""
-        return (
-            MontyRoles.SOURCE in self.item.properties["roles"]
-            and MontyRoles.IMPACT in self.item.properties["roles"]
-        )
+        return MontyRoles.SOURCE in self.item.properties["roles"] and MontyRoles.IMPACT in self.item.properties["roles"]
 
     def __repr__(self) -> str:
         return f"<ItemMontyExtension Item id={self.item.id}>"

pystac_monty/hazard_profiles.py

@@ -6,7 +6,7 @@
 class HazardProfiles:
     impact_information_profile_path = "ImpactInformationProfiles.csv"
     impact_information_profile_data = None
-    
+
     # free impact_information_profile_data when the object is destroyed
     def __del__(self):
         if self.impact_information_profile_data:
@@ -16,7 +16,7 @@ def __del__(self):
 
     def get_profiles(self) -> df.DataFrame:
         if self.impact_information_profile_data is None:
-            with importlib.resources.open_binary('pystac_monty', self.impact_information_profile_path) as f:
+            with importlib.resources.open_binary("pystac_monty", self.impact_information_profile_path) as f:
                 self.impact_information_profile_data = df.read_csv(f)
         return self.impact_information_profile_data
 
@@ -28,7 +28,7 @@ def get_cluster_code(self, hazard_code: str | list[str]) -> str:
         for c in codes:
             cluster_code = None
             try:
-                cluster_code = profiles.loc[profiles['name'] == c, "link_group"].values[-1]
+                cluster_code = profiles.loc[profiles["name"] == c, "link_group"].values[-1]
             except IndexError:
                 if not cluster_code and c.__len__() == 2:
                     cluster_code = c
@@ -38,5 +38,3 @@ def get_cluster_code(self, hazard_code: str | list[str]) -> str:
             raise ValueError("No cluster code found for hazard code")
         # return the majority item cluster code in the list
         return max(set(cluster_codes), key=cluster_codes.count)
-
-   

pystac_monty/paring.py

@@ -4,7 +4,6 @@
 
 
 class Pairing:
-    
     def generate_correlation_id(self, item: Item, hazard_profiles: HazardProfiles) -> str:
         # Get the necessary properties for creating the correlation id
         hazards = item.properties.get("monty:hazard_codes", [])

pystac_monty/sources/common.py

@@ -1,19 +1,17 @@
-
 from dataclasses import dataclass
 from typing import Any
 
 
 @dataclass
 class MontyDataSource:
-    
-    source_url : str
-    data : Any
-    
+    source_url: str
+    data: Any
+
     def __init__(self, source_url: str, data: Any):
         self.source_url = source_url
 
     def get_source_url(self) -> str:
         return self.source_url
-    
+
     def get_data(self) -> Any:
-        return self.data
+        return self.data