GeofabrikDownloader.get_default_osm_filename

GeofabrikDownloader.get_default_osm_filename(subregion_name, osm_file_format, update=False)

get a default filename for a geograpic region.

The default filename is derived from the relevant download URL for the requested data file.

Parameters

• subregion_name (str) – name of a geographic region available on Geofabrik free download server

• osm_file_format (str) – file format of the OSM data available on the free download server

• update (bool) – whether to (check on and) update the package data, defaults to False

Returns

default OSM filename for the subregion_name

Return type

str or None

Examples:

>>> from pydriosm.downloader import GeofabrikDownloader

>>> geofabrik_downloader = GeofabrikDownloader()

>>> geo_region_name = 'london'
>>> file_format = ".pbf"

>>> # Default filename of the PBF data of London
>>> fn = geofabrik_downloader.get_default_osm_filename(geo_region_name, file_format)

>>> print(fn)
greater-london-latest.osm.pbf

>>> geo_region_name = 'britain'
>>> file_format = ".shp"

>>> # Default filename of the shapefile data of Great Britain
>>> fn = geofabrik_downloader.get_default_osm_filename(geo_region_name, file_format)
No .shp.zip data for Great Britain is available to download.

>>> print(fn)
None