pip._vendor.distlib.util.FileOperator Class Reference

Inheritance diagram for pip._vendor.distlib.util.FileOperator:

Collaboration diagram for pip._vendor.distlib.util.FileOperator:

Public Member Functions
	__init__ (self, dry_run=False)
	record_as_written (self, path)
	newer (self, source, target)
	copy_file (self, infile, outfile, check=True)
	copy_stream (self, instream, outfile, encoding=None)
	write_binary_file (self, path, data)
	write_text_file (self, path, data, encoding)
	set_mode (self, bits, mask, files)
	ensure_dir (self, path)
	byte_compile (self, path, optimize=False, force=False, prefix=None, hashed_invalidation=False)
	ensure_removed (self, path)
	is_writable (self, path)
	commit (self)
	rollback (self)

Public Attributes
	dry_run
	ensured
	record
	files_written
	dirs_created

Static Public Attributes
s	set_executable_mode = lambda s, f.set_mode(0o555, 0o7777, f)

Protected Member Functions
	_init_record (self)

Member Function Documentation

commit()

pip._vendor.distlib.util.FileOperator.commit

(

self

)

Commit recorded changes, turn off recording, return
changes.

copy_file()

pip._vendor.distlib.util.FileOperator.copy_file	(		self,
			infile,
			outfile,
			check = True
	)

Copy a file respecting dry-run and force flags.

newer()

pip._vendor.distlib.util.FileOperator.newer	(		self,
			source,
			target
	)

Tell if the target is newer than the source.

Returns true if 'source' exists and is more recently modified than
'target', or if 'source' exists and 'target' doesn't.

Returns false if both exist and 'target' is the same age or younger
than 'source'. Raise PackagingFileError if 'source' does not exist.

Note that this test is not very accurate: files created in the same
second will have the same "age".

---

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

• docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/distlib/util.py