twisted.python.util : API documentation

module documentation

(source)

Undocumented

Variable	pwd	Undocumented
Variable	grp	Undocumented
Variable	setgroups	Undocumented
Variable	getgroups	Undocumented
Class	InsensitiveDict	Dictionary, that has case-insensitive keys.
Function	uniquify	Make the elements of a list unique by inserting them into a dictionary. This must not change the order of the input lst.
Function	padTo	Pads a sequence out to n elements,
Function	getPluginDirs	Undocumented
Function	addPluginDir	Undocumented
Function	sibpath	Return the path to a sibling of a file in the filesystem.
Function	getPassword	Obtain a password by prompting or from stdin.
Function	println	Undocumented
Function	str_xor	Undocumented
Function	makeStatBar	Creates a function that will return a string representing a progress bar.
Function	spewer	A trace function for sys.settrace that prints every function or method call.
Function	searchupwards	Walk upwards from start, looking for a directory containing all files and directories given as arguments:: >>> searchupwards('.', ['foo.txt'], ['bar', 'bam'])
Class	LineLog	A limited-size line-based log, useful for logging line-based protocols such as SMTP.
Function	raises	Determine whether the given call raises the given exception.
Class	IntervalDifferential	Given a list of intervals, generate the amount of time to sleep between "instants".
Class	FancyStrMixin	Mixin providing a flexible implementation of `__str__`.
Class	FancyEqMixin	Mixin that implements `__eq__` and `__ne__`.
Function	initgroups	Initializes the group access list.
Function	switchUID	Attempts to switch the uid/euid and gid/egid for the current process.
Function	untilConcludes	Call `f` with the given arguments, handling `EINTR` by retrying.
Function	mergeFunctionMetadata	Overwrite `g`'s name and docstring with values from `f`. Update `g`'s instance dictionary with `f`'s.
Function	nameToLabel	Convert a string like a variable name into a slightly more human-friendly string with spaces and capitalized letters.
Function	uidFromString	Convert a user identifier, as a string, into an integer UID.
Function	gidFromString	Convert a group identifier, as a string, into an integer GID.
Function	runAsEffectiveUser	Run the given function wrapped with seteuid/setegid calls.
Function	runWithWarningsSuppressed	Run `f(args, *kwargs)`, but with some warnings suppressed.
Function	_getpass	Helper to turn IOErrors into KeyboardInterrupts.
Class	_IntervalDifferentialIterator	Undocumented
Variable	_initgroups	Undocumented

pwd = (source)

Undocumented

grp = (source)

Undocumented

setgroups = (source)

Undocumented

getgroups = (source)

Undocumented

def uniquify(lst): (source)

Make the elements of a list unique by inserting them into a dictionary. This must not change the order of the input lst.

def padTo(n, seq, default=None): (source)

Pads a sequence out to n elements,

filling in with a default value if it is not long enough.

If the input sequence is longer than n, raises ValueError.

Details, details: This returns a new list; it does not extend the original sequence. The new list contains the values of the original sequence, not copies.

def getPluginDirs(): (source)

Undocumented

def addPluginDir(): (source)

Undocumented

def sibpath(path, sibling): (source)

Return the path to a sibling of a file in the filesystem.

This is useful in conjunction with the special __file__ attribute that Python provides for modules, so modules can load associated resource files.

def _getpass(prompt): (source)

Helper to turn IOErrors into KeyboardInterrupts.

def getPassword(prompt='Password: ', confirm=0, forceTTY=0, confirmPrompt='Confirm password: ', mismatchMessage="Passwords don't match."): (source)

Obtain a password by prompting or from stdin.

If stdin is a terminal, prompt for a new password, and confirm (if confirm is true) by asking again to make sure the user typed the same thing, as keystrokes will not be echoed.

If stdin is not a terminal, and forceTTY is not true, read in a line and use it as the password, less the trailing newline, if any. If forceTTY is true, attempt to open a tty and prompt for the password using it. Raise a RuntimeError if this is not possible.

Returns str

def println(*a): (source)

Undocumented

def str_xor(s, b): (source)

Undocumented

def makeStatBar(width, maxPosition, doneChar='=', undoneChar='-', currentChar='>'): (source)

Creates a function that will return a string representing a progress bar.

def spewer(frame, s, ignored): (source)

A trace function for sys.settrace that prints every function or method call.

def searchupwards(start, files=[], dirs=[]): (source)

Walk upwards from start, looking for a directory containing all files and directories given as arguments:

>>> searchupwards('.', ['foo.txt'], ['bar', 'bam'])

If not found, return None

def raises(exception, f, *args, **kwargs): (source)

Determine whether the given call raises the given exception.

_initgroups = (source)

Undocumented

def initgroups(uid, primaryGid): (source)

Initializes the group access list.

This uses the stdlib support which calls initgroups(3) under the hood.

If the given user is a member of more than NGROUPS, arbitrary groups will be silently discarded to bring the number below that limit.

Parameters	uid	The UID for which to look up group information. (type: `int`)
	primaryGid	The GID to include when setting the groups. (type: `int`)

def switchUID(uid, gid, euid=False): (source)

Attempts to switch the uid/euid and gid/egid for the current process.

If uid is the same value as os.getuid (or os.geteuid), this function will issue a UserWarning and not raise an exception.

Parameters	uid	the UID (or EUID) to switch the current process to. This parameter will be ignored if the value is `None`. (type: `int` or `None`)
	gid	the GID (or EGID) to switch the current process to. This parameter will be ignored if the value is `None`. (type: `int` or `None`)
	euid	if True, set only effective user-id rather than real user-id. (This option has no effect unless the process is running as root, in which case it means not to shed all privileges, retaining the option to regain privileges in cases such as spawning processes. Use with caution.) (type: `bool`)

def untilConcludes(f, *a, **kw): (source)

Call f with the given arguments, handling EINTR by retrying.

Parameters	f	A function to call.
	a	Positional arguments to pass to `f`.
	kw	Keyword arguments to pass to `f`.
Returns	Whatever `f` returns.
Raises	Exception	Whatever `f` raises, except for `OSError` with `errno` set to `EINTR`.

def mergeFunctionMetadata(f, g): (source)

Overwrite g's name and docstring with values from f. Update g's instance dictionary with f's.

Returns A function that has g's behavior and metadata merged from f.

def nameToLabel(mname): (source)

Convert a string like a variable name into a slightly more human-friendly string with spaces and capitalized letters.

Parameters	mname	The name to convert to a label. This must be a string which could be used as a Python identifier. Strings which do not take this form will result in unpredictable behavior. (type: `str`)
Returns	Undocumented (type: `str`)

def uidFromString(uidString): (source)

Convert a user identifier, as a string, into an integer UID.

Parameters	uidString	A string giving the base-ten representation of a UID or the name of a user which can be converted to a UID via `pwd.getpwnam`. (type: `str`)
Returns	The integer UID corresponding to the given string. (type: `int`)
Raises	ValueError	If the user name is supplied and `pwd` is not available.

def gidFromString(gidString): (source)

Convert a group identifier, as a string, into an integer GID.

Parameters	gidString	A string giving the base-ten representation of a GID or the name of a group which can be converted to a GID via `grp.getgrnam`. (type: `str`)
Returns	The integer GID corresponding to the given string. (type: `int`)
Raises	ValueError	If the group name is supplied and `grp` is not available.

def runAsEffectiveUser(euid, egid, function, *args, **kwargs): (source)

Run the given function wrapped with seteuid/setegid calls.

This will try to minimize the number of seteuid/setegid calls, comparing current and wanted permissions

Parameters	euid	effective UID used to call the function. (type: `int`)
	egid	`int` (type: effective GID used to call the function.)
	function	the function run with the specific permission. (type: any callable)
	args	arguments passed to `function`
	kwargs	keyword arguments passed to `function`

def runWithWarningsSuppressed(suppressedWarnings, f, *args, **kwargs): (source)

Run f(*args, **kwargs), but with some warnings suppressed.

Unlike twisted.internet.utils.runWithWarningsSuppressed, it has no special support for twisted.internet.defer.Deferred.

Parameters	suppressedWarnings	A list of arguments to pass to filterwarnings. Must be a sequence of 2-tuples (args, kwargs).
	f	A callable.
	args	Arguments for `f`.
	kwargs	Keyword arguments for `f`
Returns	The result of `f(args, *kwargs)`.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.