Fully Expand a pathlib.Path

full_Path_expand.py

# Brian Blaylock
# August 7, 2021

"""
It is often necessary to fully expand a pathlib.Path object when the
path is given a ~ or environment variables. This custom method
attachs to Path a method that fully expands these to the full path.
For example, Path('${HOME}/this/dir).expand() becomes 
PosixPath('/user/name/this/dir').
"""

from pathlib import Path

def _expand(self):
    """
    Fully expand and resolve the Path given environment variables.

    Example
    -------
    >>> Path('$HOME').expand()
    >>> PosixPath('/p/home/blaylock')
    """
    return Path(os.path.expandvars(self)).expanduser().resolve()


Path.expand = _expand