feat: add archive label and active status to ReviewModel

Author: banesullivan

src/pyosmeta/models/base.py

@@ -279,6 +279,7 @@ class ReviewModel(BaseModel):
     partners: Optional[list[Partnerships]] = None
     gh_meta: Optional[GhMeta] = None
     labels: list[str] = Field(default_factory=list)
+    active: bool = True  # To indicate if package is maintained or archived
 
     @field_validator(
         "date_accepted",

src/pyosmeta/models/github.py

@@ -17,9 +17,10 @@
 from __future__ import annotations
 
 from datetime import datetime
+from enum import Enum
 from typing import Any, List, Literal, Optional, Union
 
-from pydantic import AnyUrl, BaseModel, ConfigDict, Field
+from pydantic import AnyUrl, BaseModel, ConfigDict, Field, model_validator
 
 
 class User(BaseModel):
@@ -61,6 +62,12 @@ class ClosedBy(User): ...
 class Owner(User): ...
 
 
+class LabelType(str, Enum):
+    ARCHIVED = "archived"
+    PYOS_APPROVED = "6/pyOS-approved"
+    JOSS_APPROVED = "9/joss-approved"
+
+
 class Labels(BaseModel):
     id: Optional[int] = None
     node_id: Optional[str] = None
@@ -69,6 +76,17 @@ class Labels(BaseModel):
     description: Optional[str] = None
     color: Optional[str] = None
     default: Optional[bool] = None
+    type: Optional[LabelType] = None
+
+    @model_validator(mode="before")
+    def parse_label_type(cls, data):
+        """Parse the label type from the name before validation."""
+        if "name" in data:
+            try:
+                data["type"] = LabelType(data["name"])
+            except ValueError:
+                pass
+        return data
 
 
 class Issue(BaseModel):

src/pyosmeta/parse_issues.py

@@ -7,7 +7,7 @@
 from pydantic import ValidationError
 
 from pyosmeta.models import ReviewModel, ReviewUser
-from pyosmeta.models.github import Issue
+from pyosmeta.models.github import Issue, Labels, LabelType
 
 from .github_api import GitHubAPI
 from .utils_clean import clean_date_accepted_key
@@ -221,6 +221,25 @@ def _postprocess_meta(self, meta: dict, body: List[str]) -> dict:
 
         return meta
 
+    def _postprocess_labels(self, meta: dict) -> dict:
+        """
+        Handle specific labels that are model properties
+        """
+
+        def _is_archived(label: str) -> bool:
+            if isinstance(label, str):
+                return "archived" in label.lower()
+            elif isinstance(label, Labels):
+                return label.type == LabelType.ARCHIVED
+            raise ValueError("Invalid label type")
+
+        # Check if the review has the "archived" label
+        if "labels" in meta and [
+            label for label in meta["labels"] if _is_archived(label)
+        ]:
+            meta["active"] = False
+        return meta
+
     def _parse_field(self, key: str, val: str) -> Any:
         """
         Method dispatcher for parsing specific header fields.
@@ -277,6 +296,7 @@ def parse_issue(self, issue: Issue | str) -> ReviewModel:
 
         # Finalize review model before casting
         model = self._postprocess_meta(model, body)
+        model = self._postprocess_labels(model)
 
         return ReviewModel(**model)
 

tests/integration/test_parse_issues.py

@@ -69,3 +69,20 @@ def test_parse_labels(issue_list, process_issues):
         issue.labels = labels
         review = process_issues.parse_issue(issue)
         assert review.labels == ["6/pyOS-approved", "another_label"]
+        assert review.active
+
+    # Now add an archive label
+    label_inst = Labels(
+        id=1196238794,
+        node_id="MDU6TGFiZWwxMTk2MjM4Nzk0",
+        url="https://api.github.com/repos/pyOpenSci/software-submission/labels/archived",
+        name="archived",
+        description="",
+        color="006B75",
+        default=False,
+    )
+    labels = [label_inst, "another_label"]
+    for issue in issue_list:
+        issue.labels = labels
+        review = process_issues.parse_issue(issue)
+        assert not review.active