Coverage for acspsuedo / source / shpfile_fmt.py: 100%

3 statements  

« prev     ^ index     » next       coverage.py v7.13.5, created at 2026-05-11 16:02 +0000

1""" 

2Data/shapefile formatting. 

3""" 

4 

5import typing as t 

6 

7 

8 

9GEO_SPEC_METADATA: t.Dict[ 

10 str, t.Tuple[t.Optional[str], 

11 t.List, 

12 t.Optional[str], 

13 t.Optional[t.List[str]], 

14 t.Optional[str] 

15 ] 

16] = { 

17 'us': ( 

18 '010', 

19 ['US'], 

20 None, 

21 None, 

22 None 

23 ), 

24 'region': ( 

25 '020', 

26 ['REGION'], 

27 None, 

28 None, 

29 None 

30 ), 

31 'division': ( 

32 '030', 

33 ['DIVISION'], 

34 'STATE', 

35 None, 

36 None 

37 ), 

38 'state': ( 

39 '040', 

40 ['STATE'], 

41 'STATE', 

42 ['STATEFP'], 

43 'us' 

44 ), 

45 'county': ( 

46 '050', 

47 ['STATE', 'COUNTY'], 

48 'COUNTY', 

49 ['STATEFP', 'COUNTYFP'], 

50 'us', 

51 ), 

52 'county_subdivision': ( 

53 '060', 

54 ['STATE', 'COUNTY', 'COUNTY_SUBDIVISION'], 

55 'COUSUB', 

56 ['STATEFP', 'COUNTYFP', 'COUSUBFP'], 

57 'state' 

58 ), 

59 'subminor_civil_division': ( 

60 '067', 

61 ['STATE', 'COUNTY', 'COUNTY_SUBDIVISION', 'SUBMINOR_CIVIL_DIVISION'], 

62 'SUBMCD', 

63 ['STATEFP', 'COUNTYFP', 'COUSUBFP', 'SUBMCDFP'], 

64 'state' 

65 ), 

66 'place_remainder_or_part': ( 

67 '070', 

68 ['STATE', 'COUNTY', 'PLACE'], 

69 None, 

70 None, 

71 None 

72 ), 

73 'tract': ( 

74 '140', 

75 ['STATE', 'COUNTY', 'TRACT'], 

76 'TRACT', 

77 ['STATEFP', 'COUNTYFP', 'TRACTCE'], 

78 'state' 

79 ), 

80 'block_group': ( 

81 '150', 

82 ['STATE', 'COUNTY', 'TRACT', 'BLOCK_GROUP'], 

83 'BG', 

84 ['STATEFP', 'COUNTYFP', 'TRACTCE', 'BLKGRPCE'], 

85 'state' 

86 ), 

87 'county_or_part': ( 

88 '155', 

89 ['STATE', 'COUNTY'], 

90 None, 

91 None, 

92 None 

93 ), 

94 'place': ( 

95 '160', 

96 ['STATE', 'PLACE'], 

97 'PLACE', 

98 ['STATEFP', 'PLACEFP'], 

99 'state' 

100 ), 

101 'consolidated_city': ( 

102 '170', 

103 ['STATE', 'CONSOLIDATED_CITY'], 

104 'CONCITY', 

105 ['STATEFP', 'CONCTYFP'], 

106 'state' 

107 ), 

108 'place_or_part': ( 

109 '172', 

110 ['STATE', 'PLACE'], 

111 None, 

112 None, 

113 None 

114 ), 

115 'alaska_native_regional_corporation': ( 

116 '230', 

117 ['STATE', 'ALASKA_NATIVE_REGIONAL_CORPORATION'], 

118 'ANRC', 

119 ['STATEFP', 'ANRCFP'], 

120 'state' 

121 ), 

122 'american_indian_area_alaska_native_area_hawaiian_home_land': ( 

123 '250', 

124 ['AMERICAN_INDIAN_AREA_ALASKA_NATIVE_AREA_HAWAIIAN_HOME_LAND'], 

125 'AIANNH', 

126 ['AIANNHCE'], 

127 'us' 

128 ), 

129 'tribal_subdivision_remainder': ( 

130 '251', 

131 ['AMERICAN_INDIAN_AREA_ALASKA_NATIVE_AREA_HAWAIIAN_HOME_LAND', 'TRIBAL_SUBDIVISION_REMAINDER'], 

132 None, 

133 None, 

134 None 

135 ), 

136 'american_indian_area_alaska_native_area_reservation_or_statistical_entity_only': ( 

137 '252', 

138 ['AMERICAN_INDIAN_AREA_ALASKA_NATIVE_AREA_RESERVATION_OR_STATISTICAL_ENTITY_ONLY'], 

139 None, 

140 None, 

141 None 

142 ), 

143 'american_indian_area_off_reservation_trust_land_only_hawaiian_home_land': ( 

144 '254', 

145 ['AMERICAN_INDIAN_AREA_OFF_RESERVATION_TRUST_LAND_ONLY_HAWAIIAN_HOME_LAND'], 

146 None, 

147 None, 

148 None 

149 ), 

150 'tribal_census_tract': ( 

151 '256', 

152 ['AMERICAN_INDIAN_AREA_ALASKA_NATIVE_AREA_HAWAIIAN_HOME_LAND', 'TRIBAL_CENSUS_TRACT'], 

153 'TTRACT', 

154 ['AIANNHCE', 'TTRACTCE'], 

155 'us' 

156 ), 

157 'tribal_block_group': ( 

158 '258', 

159 ['AMERICAN_INDIAN_AREA_ALASKA_NATIVE_AREA_HAWAIIAN_HOME_LAND', 'TRIBAL_CENSUS_TRACT', 'TRIBAL_BLOCK_GROUP'], 

160 'TBG', 

161 ['AIANNHCE', 'TTRACTCE', 'TBLKGPCE'], 

162 'us' 

163 ), 

164 'state_or_part': ( 

165 '260', 

166 ['STATE_OR_PART'], 

167 None, 

168 None, 

169 None 

170 ), 

171 'american_indian_area_alaska_native_area_hawaiian_home_land_or_part': ( 

172 '280', 

173 ['STATE', 'AMERICAN_INDIAN_AREA_ALASKA_NATIVE_AREA_HAWAIIAN_HOME_LAND_OR_PART'], 

174 None, 

175 None, 

176 None 

177 ), 

178 'american_indian_area_alaska_native_area_reservation_or_statistical_entity_only_or_part': ( 

179 '283', 

180 ['STATE', 'american_indian_area_alaska_native_area_reservation_or_statistical_entity_only_or_part'], 

181 None, 

182 None, 

183 None 

184 ), 

185 'tribal_census_tract_or_part': ( 

186 '283', 

187 ['TRIBAL_CENSUS_TRACT_OR_PART'], 

188 None, 

189 None, 

190 None 

191 ), 

192 'tribal_block_group_or_part': ( 

193 '286', 

194 ['TRIBAL_BLOCK_GROUP_OR_PART'], 

195 None, 

196 None, 

197 None 

198 ), 

199 'metropolitan_statistical_area_micropolitan_statistical_area': ( 

200 '310', 

201 ['METROPOLITAN_STATISTICAL_AREA_MICROPOLITAN_STATISTICAL_AREA'], 

202 'CBSA', 

203 ['CBSAFP'], 

204 'us' 

205 ), 

206 'principal_city_or_part': ( 

207 '312', 

208 ['PRINCIPAL_CITY_OR_PART'], 

209 None, 

210 None, 

211 None 

212 ), 

213 'metropolitan_division': ( 

214 '314', 

215 ['METROPOLITAN_DIVISION'], 

216 'METDIV', 

217 ['METDIVFP'], 

218 'us' 

219 ), 

220 'metropolitan_statistical_area_micropolitan_statistical_area_or_part': ( 

221 '320', 

222 ['METROPOLITAN_STATISTICAL_AREA_MICROPOLITAN_STATISTICAL_AREA_OR_PART'], 

223 None, 

224 None, 

225 None 

226 ), 

227 'metropolitan_division_or_part': ( 

228 '323', 

229 ['METROPOLITAN_DIVISION_OR_PART'], 

230 None, 

231 None, 

232 'us' 

233 ), 

234 'combined_statistical_area': ( 

235 '330', 

236 ['COMBINED_STATISTICAL_AREA'], 

237 'CSA', 

238 ['CSAFP'], 

239 'us' 

240 ), 

241 'combined_new_england_city_and_town_area': ( 

242 '335', 

243 ['COMBINED_NEW_ENGLAND_CITY_AND_TOWN_AREA'], 

244 'CNECTA', 

245 ['CNECTAFP'], 

246 'us' 

247 ), 

248 'new_england_city_and_town_area': ( 

249 '350', 

250 ['NEW_ENGLAND_CITY_AND_TOWN_AREA'], 

251 'NECTA', 

252 ['NECTAFP'], 

253 'us' 

254 ), 

255 'combined_statistical_area_or_part': ( 

256 '340', 

257 ['STATE', 'COMBINED_STATISTICAL_AREA_OR_PART'], 

258 None, 

259 None, 

260 None 

261 ), 

262 'combined_new_england_city_and_town_area_or_part': ( 

263 '', 

264 ['COMBINED_NEW_ENGLAND_CITY_AND_TOWN_AREA_OR_PART'], 

265 None, 

266 None, 

267 None 

268 ), 

269 'new_england_city_and_town_area_or_part': ( 

270 '', 

271 ['NEW_ENGLAND_CITY_AND_TOWN_AREA_OR_PART'], 

272 None, 

273 None, 

274 None 

275 ), 

276 'principal_city': ( 

277 '352', 

278 ['PRINCIPAL_CITY'], 

279 None, 

280 None, 

281 None 

282 ), 

283 'necta_division': ( 

284 '355', 

285 ['NECTA_DIVISION'], 

286 'NECTADIV', 

287 ['NCTADVFP'], 

288 'us' 

289 ), 

290 'necta_division_or_part': ( 

291 '', 

292 ['NECTA_DIVISION_OR_PART'], 

293 None, 

294 None, 

295 None 

296 ), 

297 'urban_area': ( 

298 '400', 

299 ['URBAN_AREA'], 

300 'UAC', 

301 ['UACE'], 

302 'us' 

303 ), 

304 'congressional_district': ( 

305 '500', 

306 ['STATE', 'CONGRESSIONAL_DISTRICT'], 

307 'CD', 

308 ['STATEFP', 'CDFP'], 

309 'us' 

310 ), 

311 'state_legislative_district_upper_chamber': ( 

312 '610', 

313 ['STATE', 'STATE_LEGISLATIVE_DISTRICT_UPPER_CHAMBER'], 

314 'SLDU', 

315 ['STATEFP', 'SLDUST'], 

316 'state' 

317 ), 

318 'state_legislative_district_lower_chamber': ( 

319 '620', 

320 ['STATE', 'STATE_LEGISLATIVE_DISTRICT_LOWER_CHAMBER'], 

321 'SLDL', 

322 ['STATEFP', 'SLDLST'], 

323 'state' 

324 ), 

325 'public_use_microdata_area': ( 

326 '795', 

327 ['STATE', 'PUBLIC_USE_MICRODATA_AREA'], 

328 'PUMA', 

329 ['STATEFP', 'PUMACE'], 

330 'state' 

331 ), 

332 'zip_code_tabulation_area': ( 

333 '860', 

334 ['ZIP_CODE_TABULATION_AREA'], 

335 'ZCTA', 

336 ['ZCTACE'], 

337 'us' 

338 ), 

339 'school_district_elementary': ( 

340 '950', 

341 ['STATE', 'SCHOOL_DISTRICT_ELEMENTARY'], 

342 'ELSD', 

343 ['STATEFP', 'ELSDLEA'], 

344 'state' 

345 ), 

346 'school_district_secondary': ( 

347 '960', 

348 ['STATE', 'SCHOOL_DISTRICT_SECONDARY'], 

349 'SCSD', 

350 ['STATEFP', 'SCSDLEA'], 

351 'state' 

352 ), 

353 'school_district_unified': ( 

354 '970', 

355 ['STATE', 'SCHOOL_DISTRICT_UNIFIED'], 

356 'UNSD', 

357 ['STATEFP', 'UNSDLEA'], 

358 'state' 

359 ) 

360} 

361""" 

362Custom dictionary specifying metadata on geographic specifiers. 

363 

364 Key -> (reference_code, df_columns, shpfile_scope_indicator, shpfile_columns, outer_scope_reference) 

365"""