mainegeo.entities

 1from dataclasses import dataclass
 2from enum import Enum
 3from mainegeo.lookups import CountyData
 4
 5class TownType(Enum):
 6    """
 7    Enumeration of geography types used in `mainegeo.matching.TownReference` objects.
 8    """
 9    TOWN = "Town"
10    CITY = "City"
11    PLANTATION = "Plantation"
12    RESERVATION = "Reservation"
13    UNORGANIZED = "Unorganized Township"
14    ISLAND = "Island Group"
15
16@dataclass(frozen=True)
17class Cousub:
18    """
19    An object representing a U.S. Census Bureau county subdivision (`COUSUB`_).
20
21    Args:
22        geocode: The ten-digit Census code (state FIPS + county FIPS + county subdivision GEOID)
23        name: Census full name for county subdivision (basename + geoclass)
24        basename: Census base name for county subdivision
25        geoclass: Census `CLASSFP`_ code
26
27    .. _COUSUB: https://www.census.gov/library/reference/code-lists/ansi.html#cousub         
28    .. _CLASSFP: https://www.census.gov/library/reference/code-lists/class-codes.html
29    """
30    geocode: str|int = None
31    name: str = None
32    basename: str = None
33    geoclass: str = None
34    
35@dataclass
36class County:
37    """
38    An object representing a county.
39
40    Args:
41        name: Full name of the county
42        code: First three letters of the county name (commonly used by SoS)
43        fips: String or integer FIPS code (used by Census)
44
45    Can be initiated with any argument. If not all arguments are provided,
46    the others will be populated from a lookup table.
47    """
48    name: str = None
49    code: str = None
50    fips: str|int = None
51    
52    def __post_init__(self):
53        if self.fips:
54            self.fips = int(self.fips)
55            
56        if not all((self.name, self.code, self.fips)):
57            lookup = CountyData.get_lookup()
58            fips = self.fips
59            code = self.code
60            name = self.name
61            self.fips = fips or lookup.code_to_fips.get(code) or lookup.name_to_fips.get(name)
62            self.code = code or lookup.fips_to_code.get(fips) or lookup.name_to_code.get(name)
63            self.name = name or lookup.fips_to_name.get(fips) or lookup.code_to_name.get(code)
64            
65    def __hash__(self):
66        return hash(self.fips)