BBBikeReader.get_path_to_osm_file

BBBikeReader.get_path_to_osm_file(subregion_name, osm_file_format, data_dir=None)

Get the path to an OSM data file (if available) of a specific file format for a geographic region.

Parameters

• subregion_name (str) – name of a geographic region (case-insensitive) that is available on BBBike free download server

• osm_file_format (str) – format (file extension) of an OSM data

• data_dir (str or None) – directory where the data file is located/saved; if None (default), the default directory

Returns

path to the data file

Return type

str or None

Example:

>>> import os
>>> from pydriosm.reader import BBBikeReader

>>> bbbike_reader = BBBikeReader()

>>> region_name = 'Leeds'
>>> file_format = ".pbf"
>>> dat_dir = "tests"

>>> path_to_leeds_pbf = bbbike_reader.Downloader.download_osm_data(
...     region_name, file_format, dat_dir, verbose=True, ret_download_path=True)
To download .pbf data of the following geographic region(s):
    Leeds
? [No]|Yes: yes
Downloading "Leeds.osm.pbf" to "tests\" ... Done.

>>> path_to_leeds_pbf_ = bbbike_reader.get_path_to_osm_file(
...     region_name, file_format, dat_dir)
>>> print(os.path.relpath(path_to_leeds_pbf_))
tests\Leeds.osm.pbf

>>> print(path_to_leeds_pbf == path_to_leeds_pbf_)
True

>>> # Delete the downloaded PBF data file
>>> os.remove(path_to_leeds_pbf_)