GeofabrikDownloader.get_default_osm_filename

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

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 (case-insensitive) available on Geofabrik’s free download server

  • osm_file_format (str) – OSM file format; valid values include ".osm.pbf", ".shp.zip" and ".osm.bz2"

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

Returns

default OSM filename for the subregion_name

Return type

str

Examples:

>>> from pydriosm.downloader import GeofabrikDownloader

>>> geofabrik_downloader = GeofabrikDownloader()

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

>>> sr_filename = geofabrik_downloader.get_default_osm_filename(
...     sr_name, file_format)

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

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

>>> sr_filename = geofabrik_downloader.get_default_osm_filename(
...     sr_name, file_format)
No .shp.zip data is available to download for Great Britain.

>>> print(sr_filename)
None