Coverage for censusdis/states.py: 100%

1# Copyright (c) 2022 Darren Erik Vengroff 

2 

3""" 

4Defines state FIPS codes and some utilities for using them. 

5 

6The US Census identifies states by their 

7`FIPS Codes <https://en.wikipedia.org/wiki/Federal_Information_Processing_Standard_code#FIPS_codes>`_, 

8which are two-digit numeric strings. For convenience, we 

9define identifiers for them. 

10 

11Each identifier corresponds to the two 

12letter abbreviation for the state. For example, NJ 

13is the two letter abbreviation for New Jersey, and the 

14Census state identifier for New Jersey is 34, so:: 

15 

16 from censusdis import states 

17 

18 state = states.NJ 

19 

20would set the value of `state` to the string `"34"`. 

21We can use these values in any of the APIs in 

22`censusdis` that take a state. 

23 

24There is also a dictionary whose keys are the state 

25FIPS codes and whose values are strings naming 

26the states. It is typically used when we want a 

27more human-friendly name for each state. As in:: 

28 

29 from censusdis import states 

30 

31 state = states.CA 

32 

33 print( 

34 f"The name of the state with ID '{state}' " 

35 f"is '{states.NAMES_FROM_IDS[state]}'." 

36 ) 

37 

38Finally, there is a list of all states. It is often useful 

39if we want to perform an operation on all states. For 

40example:: 

41 

42 from censusdis import states 

43 

44 for state in states.ALL_STATES: 

45 do_something_with_a_state(state) 

46 

47There is also a list that includes all states and the 

48District of Columbia. It is called ``ALL_STATES_AND_DC``. 

49And finally, ``ALL_STATES_AND_DC_AND_PR`` includes 

50Puerto Rico as well. 

51""" 

52 

53 

54AL = "01" 

55"""Alabama""" 

56 

57AK = "02" 

58"""Alaska""" 

59 

60AZ = "04" 

61"""Arizona""" 

62 

63AR = "05" 

64"""Arkansas""" 

65 

66CA = "06" 

67"""California""" 

68 

69CO = "08" 

70"""Colorado""" 

71 

72CT = "09" 

73"""Connecticut""" 

74 

75DE = "10" 

76"""Delaware""" 

77 

78DC = "11" 

79"""District of Columbia""" 

80 

81FL = "12" 

82"""Florida""" 

83 

84GA = "13" 

85"""Georgia""" 

86 

87HI = "15" 

88"""Hawaii""" 

89 

90ID = "16" 

91"""Idaho""" 

92 

93IL = "17" 

94"""Illinois""" 

95 

96IN = "18" 

97"""Indiana""" 

98 

99IA = "19" 

100"""Iowa""" 

101 

102KS = "20" 

103"""Kansas""" 

104 

105KY = "21" 

106"""Kentucky""" 

107 

108LA = "22" 

109"""Louisiana""" 

110 

111ME = "23" 

112"""Maine""" 

113 

114MD = "24" 

115"""Maryland""" 

116 

117MA = "25" 

118"""Massachusetts""" 

119 

120MI = "26" 

121"""Michigan""" 

122 

123MN = "27" 

124"""Minnesota""" 

125 

126MS = "28" 

127"""Mississippi""" 

128 

129MO = "29" 

130"""Missouri""" 

131 

132MT = "30" 

133"""Montana""" 

134 

135NE = "31" 

136"""Nebraska""" 

137 

138NV = "32" 

139"""Nevada""" 

140 

141NH = "33" 

142"""New Hampshire""" 

143 

144NJ = "34" 

145"""New Jersey--The Garden State""" 

146 

147NM = "35" 

148"""New Mexico""" 

149 

150NY = "36" 

151"""New York""" 

152 

153NC = "37" 

154"""North Carolina""" 

155 

156ND = "38" 

157"""North Dakota""" 

158 

159OH = "39" 

160"""Ohio""" 

161 

162OK = "40" 

163"""Oklahoma""" 

164 

165OR = "41" 

166"""Oregon""" 

167 

168PA = "42" 

169"""Pennsylvania""" 

170 

171RI = "44" 

172"""Rhode Island""" 

173 

174SC = "45" 

175"""South Carolina""" 

176 

177SD = "46" 

178"""South Dakota""" 

179 

180TN = "47" 

181"""Tennessee""" 

182 

183TX = "48" 

184"""Texas""" 

185 

186UT = "49" 

187"""Utah""" 

188 

189VT = "50" 

190"""Vermont""" 

191 

192VA = "51" 

193"""Virginia""" 

194 

195WA = "53" 

196"""Washington""" 

197 

198WV = "54" 

199"""West Virginia""" 

200 

201WI = "55" 

202"""Wisconsin""" 

203 

204WY = "56" 

205"""Wyoming""" 

206 

207PR = "72" 

208"""Puerto Rico""" 

209 

210 

211NAMES_FROM_IDS = { 

212 AL: "Alabama", 

213 AK: "Alaska", 

214 AZ: "Arizona", 

215 AR: "Arkansas", 

216 CA: "California", 

217 CO: "Colorado", 

218 CT: "Connecticut", 

219 DC: "District of Columbia", 

220 DE: "Delaware", 

221 FL: "Florida", 

222 GA: "Georgia", 

223 HI: "Hawaii", 

224 ID: "Idaho", 

225 IL: "Illinois", 

226 IN: "Indiana", 

227 IA: "Iowa", 

228 KS: "Kansas", 

229 KY: "Kentucky", 

230 LA: "Louisiana", 

231 ME: "Maine", 

232 MD: "Maryland", 

233 MA: "Massachusetts", 

234 MN: "Minnesota", 

235 MS: "Mississippi", 

236 MI: "Michigan", 

237 MO: "Missouri", 

238 MT: "Montana", 

239 NE: "Nebraska", 

240 NV: "Nevada", 

241 NH: "New Hampshire", 

242 NJ: "New Jersey", 

243 NM: "New Mexico", 

244 NY: "New York", 

245 NC: "North Carolina", 

246 ND: "North Dakota", 

247 OH: "Ohio", 

248 OK: "Oklahoma", 

249 OR: "Oregon", 

250 PA: "Pennsylvania", 

251 RI: "Rhode Island", 

252 SC: "South Carolina", 

253 SD: "South Dakota", 

254 TN: "Tennessee", 

255 TX: "Texas", 

256 UT: "Utah", 

257 VT: "Vermont", 

258 VA: "Virginia", 

259 WA: "Washington", 

260 WV: "West Virginia", 

261 WI: "Wisconsin", 

262 WY: "Wyoming", 

263 PR: "Puerto Rico", 

264} 

265""" 

266The names of each state, indexed by FIPS code. 

267 

268For example, ``NAMES_FROM_IDS[NJ]`` 

269is ``"New Jersey"``. 

270""" 

271 

272ABBREVIATIONS_FROM_IDS = { 

273 AL: "AL", 

274 AK: "AK", 

275 AZ: "AZ", 

276 AR: "AR", 

277 CA: "CA", 

278 CO: "CO", 

279 CT: "CT", 

280 DC: "DC", 

281 DE: "DE", 

282 FL: "FL", 

283 GA: "GA", 

284 HI: "HI", 

285 ID: "ID", 

286 IL: "IL", 

287 IN: "IN", 

288 IA: "IA", 

289 KS: "KS", 

290 KY: "KY", 

291 LA: "LA", 

292 ME: "ME", 

293 MD: "MD", 

294 MA: "MA", 

295 MN: "MN", 

296 MS: "MS", 

297 MI: "MI", 

298 MO: "MO", 

299 MT: "MT", 

300 NE: "NE", 

301 NV: "NV", 

302 NH: "NH", 

303 NJ: "NJ", 

304 NM: "NM", 

305 NY: "NY", 

306 NC: "NC", 

307 ND: "ND", 

308 OH: "OH", 

309 OK: "OK", 

310 OR: "OR", 

311 PA: "PA", 

312 RI: "RI", 

313 SC: "SC", 

314 SD: "SD", 

315 TN: "TN", 

316 TX: "TX", 

317 UT: "UT", 

318 VT: "VT", 

319 VA: "VA", 

320 WA: "WA", 

321 WV: "WV", 

322 WI: "WI", 

323 WY: "WY", 

324 PR: "PR", 

325} 

326""" 

327The postal abbreviation of each state, indexed by FIPS code. 

328 

329For example, ``NAMES_FROM_IDS[NJ]`` 

330is ``"NJ"``. 

331""" 

332 

333IDS_FROM_ABBREVIATIONS = {v: k for k, v in ABBREVIATIONS_FROM_IDS.items()} 

334""" 

335The state FIPS code ID for each state abbreviation. 

336 

337For example ``IDS_FROM_ABBREVIATIONS['NJ']`` 

338is ``34``, which is the value of``NJ``. 

339""" 

340 

341IDS_FROM_NAMES = {v: k for k, v in NAMES_FROM_IDS.items()} 

342""" 

343The state FIPS code ID for each state name. 

344 

345For example ``IDS_FROM_ABBREVIATIONS['New Jersey']`` 

346is ``34``, which is the value of``NJ``. 

347""" 

348 

349ALL_STATES = [state for state in NAMES_FROM_IDS if state != DC and state != DC] 

350""" 

351All the state FIPS codes. 

352 

353Includes all 50 states, but not DC. 

354 

355Typically used to iterate over the states, as in:: 

356 

357 from censusdis.states import ALL_STATES 

358 

359 for state in ALL_STATES: 

360 process_state(state) 

361""" 

362 

363ALL_STATES_DC_AND_PR = list(NAMES_FROM_IDS.keys()) 

364""" 

365All the state FIPS codes and DC and PR. 

366 

367Includes all 50 states, DC and PR. 

368 

369Typically used to iterate over the states, as in:: 

370 

371 from censusdis.states import ALL_STATES_DC_AND_PR 

372 

373 for state in ALL_STATES_DC_AND_PR: 

374 process_state(state) 

375""" 

376 

377ALL_STATES_AND_DC = [state for state in ALL_STATES_DC_AND_PR if state != PR] 

378""" 

379All the state FIPS codes and DC. 

380 

381Includes all 50 states and DC. 

382 

383Typically used to iterate over the states, as in:: 

384 

385 from censusdis.states import ALL_STATES_AND_DC 

386 

387 for state in ALL_STATES_AND_DC: 

388 process_state(state) 

389""" 

390 

391# Legacy names. These will go away some time before the 1.0.0 release. 

392 

393STATE_AL = AL 

394STATE_AK = AK 

395STATE_AZ = AZ 

396STATE_AR = AR 

397STATE_CA = CA 

398STATE_CO = CO 

399STATE_CT = CT 

400STATE_DC = DC 

401STATE_DE = DE 

402STATE_FL = FL 

403STATE_GA = GA 

404STATE_HI = HI 

405STATE_ID = ID 

406STATE_IL = IL 

407STATE_IN = IN 

408STATE_IA = IA 

409STATE_KS = KS 

410STATE_KY = KY 

411STATE_LA = LA 

412STATE_ME = ME 

413STATE_MD = MD 

414STATE_MA = MA 

415STATE_MN = MN 

416STATE_MS = MS 

417STATE_MI = MI 

418STATE_MO = MO 

419STATE_MT = MT 

420STATE_NE = NE 

421STATE_NV = NV 

422STATE_NH = NH 

423STATE_NJ = NJ 

424STATE_NM = NM 

425STATE_NY = NY 

426STATE_NC = NC 

427STATE_ND = ND 

428STATE_OH = OH 

429STATE_OK = OK 

430STATE_OR = OR 

431STATE_PA = PA 

432STATE_RI = RI 

433STATE_SC = SC 

434STATE_SD = SD 

435STATE_TN = TN 

436STATE_TX = TX 

437STATE_UT = UT 

438STATE_VT = VT 

439STATE_VA = VA 

440STATE_WA = WA 

441STATE_WV = WV 

442STATE_WI = WI 

443STATE_WY = WY 

444TERRITORY_PR = PR