twisted.python.util : API documentation

Class	InsensitiveDict	Dictionary, that has case-insensitive keys.
Class	OrderedDict	A UserDict that preserves insert order whenever possible.
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	Set showAttributes to a sequence of strings naming attributes, OR sequences of `(attributeName, displayName, formatCharacter)`.
Class	FancyEqMixin	Undocumented
Function	initgroups 0	Do nothing.
Function	initgroups	Initializes the group access list.
Function	switchUID	Attempts to switch the uid/euid and gid/egid for the current process.
Class	SubclassableCStringIO	A wrapper around cStringIO to allow for subclassing.
Function	untilConcludes	Undocumented
Function	setIDFunction	Change the function used by `unsignedID` to determine the integer id value of an object. This is largely useful for testing to give `unsignedID` deterministic, easily-controlled behavior.
Function	unsignedID	Return the id of an object as an unsigned number so that its hex representation makes sense.
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	_getpass	Helper to turn IOErrors into KeyboardInterrupts.
Class	_IntervalDifferentialIterator	Undocumented
Function	_setgroups_until_success	Undocumented

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 initgroups(uid, primaryGid): (source)

Initializes the group access list.

If the C extension is present, we're calling it, which in turn calls initgroups(3).

If not, this is done by reading the group database /etc/group and using all groups of which uid is a member. The additional group primaryGid is also added to the list.

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	If provided, an additional GID to include when setting the groups. (type: `int` or `NoneType`)

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 `NoneType`)
	gid	the GID (or EGID) to switch the current process to. This parameter will be ignored if the value is `None`. (type: `int` or `NoneType`)
	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 setIDFunction(idFunction): (source)

Change the function used by unsignedID to determine the integer id value of an object. This is largely useful for testing to give unsignedID deterministic, easily-controlled behavior.

Parameters	idFunction	A function with the signature of `id`.
Returns	The previous function being used by `unsignedID`.

def unsignedID(obj): (source)

Return the id of an object as an unsigned number so that its hex representation makes sense.

This is mostly necessary in Python 2.4 which implements id to sometimes return a negative value. Python 2.3 shares this behavior, but also implements hex and the %x format specifier to represent negative values as though they were positive ones, obscuring the behavior of id. Python 2.5's implementation of id always returns positive values.

def mergeFunctionMetadata(f, g): (source)

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

To use this function safely you must use the return value. In Python 2.3, mergeFunctionMetadata will create a new function. In later versions of Python, g will be mutated and returned.

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

def uidFromString(uidString): (source)

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

Parameters	uid	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	uid	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`

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	(type: `str`)

t.p.util : module documentation