pip._internal.utils.filesystem Namespace Reference

Functions
bool	check_path_owner (str path)
Generator[BinaryIO, None, None]	adjacent_tmp_file (str path, **Any kwargs)
bool	test_writable_dir (str path)
bool	_test_writable_dir_win (str path)
List[str]	find_files (str path, str pattern)
Union[int, float]	file_size (str path)
str	format_file_size (str path)
Union[int, float]	directory_size (str path)
str	format_directory_size (str path)

Variables
	_replace_retry = retry(reraise=True, stop=stop_after_delay(1), wait=wait_fixed(0.25))
	replace = _replace_retry(os.replace)

Function Documentation

_test_writable_dir_win()

bool _test_writable_dir_win ( str  path )

protected

Definition at line 94 of file filesystem.py.

def _test_writable_dir_win(path: str) -> bool:
    # os.access doesn't work on Windows: http://bugs.python.org/issue2528
    # and we can't use tempfile: http://bugs.python.org/issue22107
    basename = "accesstest_deleteme_fishfingers_custard_"
    alphabet = "abcdefghijklmnopqrstuvwxyz0123456789"
    for _ in range(10):
        name = basename + "".join(random.choice(alphabet) for _ in range(6))
        file = os.path.join(path, name)
        try:
            fd = os.open(file, os.O_RDWR | os.O_CREAT | os.O_EXCL)
        except FileExistsError:
            pass
        except PermissionError:
            # This could be because there's a directory with the same name.
            # But it's highly unlikely there's a directory called that,
            # so we'll assume it's because the parent dir is not writable.
            # This could as well be because the parent dir is not readable,
            # due to non-privileged user access.
            return False
        else:
            os.close(fd)
            os.unlink(file)
            return True
 
    # This should never be reached
    raise OSError("Unexpected condition testing for writable directory")
 
 

References i.

Referenced by pip._internal.utils.filesystem.test_writable_dir().

Here is the caller graph for this function:

adjacent_tmp_file()

Generator[BinaryIO, None, None] adjacent_tmp_file	(	str	path,
		**Any	kwargs
	)

Return a file-like object pointing to a tmp file next to path.

The file is created securely and is ensured to be written to disk
after the context reaches its end.

kwargs will be passed to tempfile.NamedTemporaryFile to control
the way the temporary file will be opened.

Definition at line 44 of file filesystem.py.

def adjacent_tmp_file(path: str, **kwargs: Any) -> Generator[BinaryIO, None, None]:
    """Return a file-like object pointing to a tmp file next to path.
 
    The file is created securely and is ensured to be written to disk
    after the context reaches its end.
 
    kwargs will be passed to tempfile.NamedTemporaryFile to control
    the way the temporary file will be opened.
    """
    with NamedTemporaryFile(
        delete=False,
        dir=os.path.dirname(path),
        prefix=os.path.basename(path),
        suffix=".tmp",
        **kwargs,
    ) as f:
        result = cast(BinaryIO, f)
        try:
            yield result
        finally:
            result.flush()
            os.fsync(result.fileno())
 
 
# Tenacity raises RetryError by default, explicitly raise the original exception

References i.

check_path_owner()

bool check_path_owner

(

str

path

)

Definition at line 16 of file filesystem.py.

def check_path_owner(path: str) -> bool:
    # If we don't have a way to check the effective uid of this process, then
    # we'll just assume that we own the directory.
    if sys.platform == "win32" or not hasattr(os, "geteuid"):
        return True
 
    assert os.path.isabs(path)
 
    previous = None
    while path != previous:
        if os.path.lexists(path):
            # Check if path is writable by current user.
            if os.geteuid() == 0:
                # Special handling for root user in order to handle properly
                # cases where users use sudo without -H flag.
                try:
                    path_uid = get_path_uid(path)
                except OSError:
                    return False
                return path_uid == 0
            else:
                return os.access(path, os.W_OK)
        else:
            previous, path = path, os.path.dirname(path)
    return False  # assume we don't own the path
 
 
@contextmanager

References i.

directory_size()

Union[int, float] directory_size

(

str

path

)

Definition at line 143 of file filesystem.py.

def directory_size(path: str) -> Union[int, float]:
    size = 0.0
    for root, _dirs, files in os.walk(path):
        for filename in files:
            file_path = os.path.join(root, filename)
            size += file_size(file_path)
    return size
 
 

References pip._internal.utils.filesystem.file_size(), and i.

Referenced by pip._internal.utils.filesystem.format_directory_size().

Here is the call graph for this function:

Here is the caller graph for this function:

file_size()

Union[int, float] file_size

(

str

path

)

Definition at line 132 of file filesystem.py.

def file_size(path: str) -> Union[int, float]:
    # If it's a symlink, return 0.
    if os.path.islink(path):
        return 0
    return os.path.getsize(path)
 
 

References i.

Referenced by pip._internal.utils.filesystem.directory_size(), and pip._internal.utils.filesystem.format_file_size().

Here is the caller graph for this function:

find_files()

List[str] find_files	(	str	path,
		str	pattern
	)

Returns a list of absolute paths of files beneath path, recursively,
with filenames which match the UNIX-style shell glob pattern.

Definition at line 122 of file filesystem.py.

def find_files(path: str, pattern: str) -> List[str]:
    """Returns a list of absolute paths of files beneath path, recursively,
    with filenames which match the UNIX-style shell glob pattern."""
    result: List[str] = []
    for root, _, files in os.walk(path):
        matches = fnmatch.filter(files, pattern)
        result.extend(os.path.join(root, f) for f in matches)
    return result
 
 

References i.

format_directory_size()

str format_directory_size

(

str

path

)

Definition at line 152 of file filesystem.py.

def format_directory_size(path: str) -> str:
    return format_size(directory_size(path))

References pip._internal.utils.filesystem.directory_size().

Here is the call graph for this function:

format_file_size()

str format_file_size

(

str

path

)

Definition at line 139 of file filesystem.py.

def format_file_size(path: str) -> str:
    return format_size(file_size(path))
 
 

References pip._internal.utils.filesystem.file_size().

Here is the call graph for this function:

test_writable_dir()

bool test_writable_dir

(

str

path

)

Check if a directory is writable.

Uses os.access() on POSIX, tries creating files on Windows.

Definition at line 76 of file filesystem.py.

def test_writable_dir(path: str) -> bool:
    """Check if a directory is writable.
 
    Uses os.access() on POSIX, tries creating files on Windows.
    """
    # If the directory doesn't exist, find the closest parent that does.
    while not os.path.isdir(path):
        parent = os.path.dirname(path)
        if parent == path:
            break  # Should never get here, but infinite loops are bad
        path = parent
 
    if os.name == "posix":
        return os.access(path, os.W_OK)
 
    return _test_writable_dir_win(path)
 
 

References pip._internal.utils.filesystem._test_writable_dir_win(), and i.

Here is the call graph for this function:

Variable Documentation

_replace_retry

_replace_retry = retry(reraise=True, stop=stop_after_delay(1), wait=wait_fixed(0.25))

protected

Definition at line 69 of file filesystem.py.

replace

replace = _replace_retry(os.replace)

Definition at line 71 of file filesystem.py.