pip._internal.utils.temp_dir.TempDirectory Class Reference

Inheritance diagram for pip._internal.utils.temp_dir.TempDirectory:

Public Member Functions
	__init__ (self, Optional[str] path=None, Union[bool, None, _Default] delete=_default, str kind="temp", bool globally_managed=False, bool ignore_cleanup_errors=True)
str	path (self)
str	__repr__ (self)
_T	__enter__ (_T self)
None	__exit__ (self, Any exc, Any value, Any tb)
None	cleanup (self)

Public Attributes
	delete
	kind
	ignore_cleanup_errors

Protected Member Functions
str	_create (self, str kind)

Protected Attributes
	_path
	_deleted

Detailed Description

Helper class that owns and cleans up a temporary directory.

This class can be used as a context manager or as an OO representation of a
temporary directory.

Attributes:
    path
        Location to the created temporary directory
    delete
        Whether the directory should be deleted when exiting
        (when used as a contextmanager)

Methods:
    cleanup()
        Deletes the temporary directory

When used as a context manager, if the delete attribute is True, on
exiting the context the temporary directory is deleted.

Member Function Documentation

_create()

str pip._internal.utils.temp_dir.TempDirectory._create (   self, str  kind  )

protected

Create a temporary directory and store its path in self.path

Reimplemented in pip._internal.utils.temp_dir.AdjacentTempDirectory.

cleanup()

None pip._internal.utils.temp_dir.TempDirectory.cleanup

(

self

)

Remove the temporary directory created and reset state

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/pip/_internal/utils/temp_dir.py