remove_osm_file¶

pydriosm.utils.remove_osm_file(path_to_file, verbose=True)[source]¶

Remove a downloaded OpenStreetMap (OSM) data file or directory.

This function deletes a specified file or directory if it exists on disk. When verbosity is enabled, progress and completion status are printed.

Parameters:

path_to_file (str | pathlib.Path) – Absolute or relative path to an OSM data file or directory.
verbose (bool | int) – Whether to print progress messages. Defaults to True.

Returns:

None

Return type:

None

Examples:

>>> from pydriosm.utils import remove_osm_file
>>> from pyhelpers.dirs import cd

>>> pseudo_pbf_file_path = cd('tests', 'pseudo.osm.pbf')

>>> try:
...     pseudo_pbf_file_path.touch(exist_ok=True)
... except OSError:
...     print('Failed to create the file.')
... else:
...     print('File created successfully.')
File created successfully.

>>> pseudo_pbf_file_path.is_file()
True

>>> remove_osm_file(pseudo_pbf_file_path, verbose=True)
Deleting "tests/pseudo.osm.pbf" ... Done.

>>> pseudo_pbf_file_path.is_file()
False