add_slashes¶

pyhelpers.dirs.add_slashes(pathname, normalized=True, surrounded_by='"')[source]¶

Adds leading and/or trailing slashes to a given pathname for formatting or display purposes.

Parameters:

pathname (str | bytes | os.PathLike) – The pathname of a file or directory.
normalized (bool) – Whether to normalize the returned pathname; defaults to True.
surrounded_by (str) – A string by which the returned pathname is surrounded; defaults to '"'.

Returns:

A formatted pathname with added slashes.

Return type:

str

Examples:

>>> from pyhelpers._cache import _add_slashes
>>> _add_slashes("pyhelpers\data")
'"./pyhelpers/data/"'
>>> _add_slashes("pyhelpers\data", normalized=False)  # on Windows
'".\pyhelpers\data\"'
>>> _add_slashes("pyhelpers\data\pyhelpers.dat")  # on Windows
'"./pyhelpers/data/pyhelpers.dat"'
>>> _add_slashes("C:\Windows")  # on Windows
'"C:/Windows/"'