pip._internal.utils.temp_dir.AdjacentTempDirectory Class Reference

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

Collaboration diagram for pip._internal.utils.temp_dir.AdjacentTempDirectory:

Public Member Functions
None	__init__ (self, str original, Optional[bool] delete=None)
Public Member Functions inherited from pip._internal.utils.temp_dir.TempDirectory
str	path (self)
str	__repr__ (self)
_T	__enter__ (_T self)
None	__exit__ (self, Any exc, Any value, Any tb)
None	cleanup (self)

Public Attributes
	original
	LEADING_CHARS
Public Attributes inherited from pip._internal.utils.temp_dir.TempDirectory
	delete
	kind
	ignore_cleanup_errors

Static Public Attributes
str	LEADING_CHARS = "-~.=%0123456789"

Protected Member Functions
Generator[str, None, None]	_generate_names (cls, str name)
str	_create (self, str kind)

Additional Inherited Members
Protected Attributes inherited from pip._internal.utils.temp_dir.TempDirectory
	_path
	_deleted

Detailed Description

Helper class that creates a temporary directory adjacent to a real one.

Attributes:
    original
        The original directory to create a temp directory for.
    path
        After calling create() or entering, contains the full
        path to the temporary directory.
    delete
        Whether the directory should be deleted when exiting
        (when used as a contextmanager)

Constructor & Destructor Documentation

__init__()

None pip._internal.utils.temp_dir.AdjacentTempDirectory.__init__	(		self,
		str	original,
		Optional[bool]	delete = None
	)

Reimplemented from pip._internal.utils.temp_dir.TempDirectory.

Member Function Documentation

_create()

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

protected

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

Reimplemented from pip._internal.utils.temp_dir.TempDirectory.

_generate_names()

Generator[str, None, None] pip._internal.utils.temp_dir.AdjacentTempDirectory._generate_names (   cls, str  name  )

protected

Generates a series of temporary names.

The algorithm replaces the leading characters in the name
with ones that are valid filesystem characters, but are not
valid package names (for both Python and pip definitions of
package).

---

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