MCPcopy Create free account
hub / github.com/MacHu-GWU/uszipcode-project / query

Method query

uszipcode/search.py:305–565  ·  view source on GitHub ↗

Query zipcode the simple way. :param zipcode: int or str, find the exactly matched zipcode. Will be automatically zero padding to 5 digits :param prefix: str, zipcode prefix. :param pattern: str, zipcode wildcard. :param city: str, city name.

(self,
              zipcode=None,
              prefix=None,
              pattern=None,
              city=None,
              state=None,
              lat=None,
              lng=None,
              radius=None,

              population_lower=None,
              population_upper=None,
              population_density_lower=None,
              population_density_upper=None,

              land_area_in_sqmi_lower=None,
              land_area_in_sqmi_upper=None,
              water_area_in_sqmi_lower=None,
              water_area_in_sqmi_upper=None,

              housing_units_lower=None,
              housing_units_upper=None,
              occupied_housing_units_lower=None,
              occupied_housing_units_upper=None,

              median_home_value_lower=None,
              median_home_value_upper=None,
              median_household_income_lower=None,
              median_household_income_upper=None,

              zipcode_type=ZipcodeType.Standard,
              sort_by=SimpleZipcode.zipcode.name,
              ascending=True,
              returns=DEFAULT_LIMIT)

Source from the content-addressed store, hash-verified

303 return sort_by
304
305 def query(self,
306 zipcode=None,
307 prefix=None,
308 pattern=None,
309 city=None,
310 state=None,
311 lat=None,
312 lng=None,
313 radius=None,
314
315 population_lower=None,
316 population_upper=None,
317 population_density_lower=None,
318 population_density_upper=None,
319
320 land_area_in_sqmi_lower=None,
321 land_area_in_sqmi_upper=None,
322 water_area_in_sqmi_lower=None,
323 water_area_in_sqmi_upper=None,
324
325 housing_units_lower=None,
326 housing_units_upper=None,
327 occupied_housing_units_lower=None,
328 occupied_housing_units_upper=None,
329
330 median_home_value_lower=None,
331 median_home_value_upper=None,
332 median_household_income_lower=None,
333 median_household_income_upper=None,
334
335 zipcode_type=ZipcodeType.Standard,
336 sort_by=SimpleZipcode.zipcode.name,
337 ascending=True,
338 returns=DEFAULT_LIMIT):
339 """
340 Query zipcode the simple way.
341
342 :param zipcode: int or str, find the exactly matched zipcode. Will be
343 automatically zero padding to 5 digits
344 :param prefix: str, zipcode prefix.
345 :param pattern: str, zipcode wildcard.
346 :param city: str, city name.
347 :param state: str, state name, two letter abbr or state full name.
348 :param lat: latitude.
349 :param lng: longitude.
350 :param radius: number, only returns zipcodes within a specific circle.
351 :param population_lower:
352 :param population_upper:
353 :param population_density_lower:
354 :param population_density_upper:
355 :param land_area_in_sqmi_lower:
356 :param land_area_in_sqmi_upper:
357 :param water_area_in_sqmi_lower:
358 :param water_area_in_sqmi_upper:
359 :param housing_units_lower:
360 :param housing_units_upper:
361 :param occupied_housing_units_lower:
362 :param occupied_housing_units_upper:

Callers 15

by_zipcodeMethod · 0.95
by_prefixMethod · 0.95
by_patternMethod · 0.95
by_cityMethod · 0.95
by_stateMethod · 0.95
by_city_and_stateMethod · 0.95
by_coordinatesMethod · 0.95
by_populationMethod · 0.95
by_population_densityMethod · 0.95
by_land_area_in_sqmiMethod · 0.95
by_water_area_in_sqmiMethod · 0.95
by_housing_unitsMethod · 0.95

Calls 4

find_stateMethod · 0.95
find_cityMethod · 0.95
_resolve_sort_byMethod · 0.95
dist_fromMethod · 0.80

Tested by 1

test_bad_paramMethod · 0.64