ecourts.entities.court

  1from dataclasses import dataclass
  2from typing import Optional
  3import json
  4
  5
  6@dataclass
  7class Court:
  8    """
  9    Represents a court entity with state, district, and court codes.
 10    """
 11
 12    # This is same as the data in courts.csv
 13    __ALL_COURTS__ = [
 14        ("1", None),
 15        ("1", "2"),
 16        ("1", "3"),
 17        ("1", "4"),
 18        ("1", "5"),
 19        ("1", "6"),
 20        ("2", None),
 21        ("3", None),
 22        ("3", "2"),
 23        ("3", "3"),
 24        ("4", None),
 25        ("5", None),
 26        ("6", None),
 27        ("6", "2"),
 28        ("6", "3"),
 29        ("6", "4"),
 30        ("7", None),
 31        ("8", None),
 32        ("9", None),
 33        ("9", "2"),
 34        ("10", None),
 35        ("10", "2"),
 36        ("11", None),
 37        ("12", None),
 38        ("12", "2"),
 39        ("13", None),
 40        ("13", "2"),
 41        ("15", None),
 42        ("16", None),
 43        ("16", "2"),
 44        ("16", "3"),
 45        ("16", "4"),
 46        ("17", None),
 47        ("18", None),
 48        ("20", None),
 49        ("21", None),
 50        ("24", None),
 51        ("25", None),
 52        ("29", None),
 53    ]
 54    state_code: str
 55    """The state code of the court."""
 56
 57    district_code: str = "1"
 58    """The district code of the court."""
 59
 60    court_code: Optional[str] = None
 61    """The court code, if applicable."""
 62
 63    # These two are part of presentation links, but unused otherwise
 64    state_name: Optional[str] = None
 65    """The name of the state, if available."""
 66
 67    name: Optional[str] = None
 68    """The name of the court, if available."""
 69
 70    def __post_init__(self):
 71        """
 72        Post-initialization processing to validate the court.
 73        """
 74        """
 75        Raise an error if the court is not valid
 76        """
 77        lcc = self.court_code
 78        if self.court_code == "1":
 79            lcc = None
 80        if (self.state_code,  lcc) not in Court.__ALL_COURTS__:
 81            if self.court_code:
 82                raise ValueError(
 83                    f"Invalid court: state_code={self.state_code}, court_code={self.court_code}"
 84                )
 85            else:
 86                raise ValueError(f"Invalid court: state_code={self.state_code}")
 87
 88        if self.district_code == None:
 89            self.district_code = "1"
 90
 91    @classmethod
 92    def enumerate(cls):
 93        """
 94        Enumerate all known valid courts.
 95
 96        Yields:
 97            Court: A court object for each valid court.
 98        """
 99        for c in cls.__ALL_COURTS__:
100            yield Court(state_code=c[0], court_code=c[1], state_name=None, name=None)
101
102    def queryParams(self):
103        """
104        Generate query parameters for the court.
105
106        Returns:
107            dict: A dictionary containing the query parameters.
108        """
109        r = {"state_code": self.state_code, "dist_code": self.district_code}
110        
111        r["court_code"] = self.court_code or "1"
112        return r
113
114    def json(self):
115        """
116        Generate a JSON representation of the court.
117
118        Returns:
119            dict: A dictionary containing the JSON representation.
120        """
121        return {
122            "state_code": self.state_code,
123            "district_code": self.district_code,
124            "court_code": self.court_code,
125        }
126
127
128    def __eq__(self, other):
129        """
130        Compare two courts for equality.
131
132        Args:
133            other (Court): The other court to compare against.
134
135        Returns:
136            bool: True if the courts are equal, False otherwise.
137        """
138        return self.state_code == other.state_code and self.district_code == other.district_code and (self.court_code or "1") == (other.court_code or "1")
139
140    def __iter__(self):
141        for key in ["state_code", "district_code", "court_code"]:
142            yield key, getattr(self, key)