GeofabrikDownloader.get_default_filename¶

GeofabrikDownloader.get_default_filename(subregion_name, osm_file_format, update=False)[source]¶

get a default filename for a geograpic (sub)region.

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

Parameters:

subregion_name (str) – name of a (sub)region available on Geofabrik free download server
osm_file_format (str) – file format/extension of the OSM data available on the download server
update (bool) – whether to (check on and) update the prepacked data, defaults to False

Returns:

default OSM filename for the subregion_name

Return type:

str | None

Examples:

>>> from pydriosm.downloader import GeofabrikDownloader
>>> gfd = GeofabrikDownloader()
>>> # Default filename of the PBF data of London
>>> gfd.get_default_filename(subregion_name='london', osm_file_format=".pbf")
'greater-london-latest.osm.pbf'
>>> # Default filename of the shapefile data of Great Britain
>>> gfd.get_default_filename(subregion_name='britain', osm_file_format=".gpkg")
No ".gpkg.zip" data is available to download for "Great Britain".