pip._vendor.colorama.ansitowin32.AnsiToWin32 Class Reference

Inheritance diagram for pip._vendor.colorama.ansitowin32.AnsiToWin32:

Collaboration diagram for pip._vendor.colorama.ansitowin32.AnsiToWin32:

Public Member Functions
	__init__ (self, wrapped, convert=None, strip=None, autoreset=False)
	should_wrap (self)
	get_win32_calls (self)
	write (self, text)
	reset_all (self)
	write_and_convert (self, text)
	write_plain_text (self, text, start, end)
	convert_ansi (self, paramstring, command)
	extract_params (self, command, paramstring)
	call_win32 (self, command, params)
	convert_osc (self, text)
	flush (self)

Public Attributes
	wrapped
	autoreset
	stream
	strip
	convert
	win32_calls
	on_stderr

Static Public Attributes
	ANSI_CSI_RE = re.compile('\001?\033\\[((?:\\d|;)*)([a-zA-Z])\002?')
	ANSI_OSC_RE = re.compile('\001?\033\\]([^\a]*)(\a)\002?')

Detailed Description

Implements a 'write()' method which, on Windows, will strip ANSI character
sequences from the text, and if outputting to a tty, will convert them into
win32 function calls.

Member Function Documentation

should_wrap()

pip._vendor.colorama.ansitowin32.AnsiToWin32.should_wrap

(

self

)

True if this class is actually needed. If false, then the output
stream will not be affected, nor will win32 calls be issued, so
wrapping stdout is not actually required. This will generally be
False on non-Windows platforms, unless optional functionality like
autoreset has been requested using kwargs to init()

write_and_convert()

pip._vendor.colorama.ansitowin32.AnsiToWin32.write_and_convert	(		self,
			text
	)

Write the given text to our wrapped stream, stripping any ANSI
sequences from the text, and optionally converting them into win32
calls.

---

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

• docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/colorama/ansitowin32.py