Module text

Try to match a name against a list.

This function will try to match a name like test1 against a list like ['test1.example.com', 'test2.example.com', ...]. Against this list, 'test1' as well as 'test1.example' will match, but not 'test1.ex'. A multiple match will be considered as no match at all (e.g. 'test1' against ['test1.example.com', 'test1.example.org']), except when the key fully matches an entry (e.g. 'test1' against ['test1', 'test1.example.com']).

Parameters:

• key (str) - the name to be searched
• name_list (list) - the list of strings against which to search the key
• case_sensitive (boolean) - whether to provide a case-sensitive match

Returns: None or str

None if there is no match or if there are multiple matches, otherwise the element from the list which matches

Generates regular expression from DNS name globbing pattern.

A DNS name globbing pattern (e.g. *.site) is converted to a regular expression. Escape sequences or ranges (e.g. [a-z]) are not supported.

Matching always starts at the leftmost part. An asterisk (*) matches all characters except the dot (.) separating DNS name parts. A question mark (?) matches a single character except the dot (.).

Parameters:

• pattern (string) - DNS name globbing pattern

Returns: string

Regular expression

Formats an incoming number of MiB with the appropriate unit.

Parameters:

• value (int) - integer representing the value in MiB (1048576)
• units (char) - the type of formatting we should do:
  • 'h' for automatic scaling
  • 'm' for MiBs
  • 'g' for GiBs
  • 't' for TiBs

Returns: str

the formatted value (with suffix)

Tries to extract number and scale from the given string.

Input must be in the format NUMBER+ [DOT NUMBER+] SPACE* [UNIT]. If no unit is specified, it defaults to MiB. Return value is always an int in MiB.

Quotes shell argument according to POSIX.

Parameters:

• value (str) - the argument to be quoted

Returns: str

the quoted value

Quotes a list of shell arguments.

Parameters:

• args (list) - list of arguments to be quoted

Returns: str

the quoted arguments concatenated with spaces

Generates a random secret.

This will generate a pseudo-random secret returning an hex string (so that it can be used where an ASCII string is needed).

Parameters:

• numbytes - the number of bytes which will be represented by the returned string (defaulting to 20, the length of a SHA1 hash)

Returns: str

an hex representation of the pseudo-random sequence

Normalizes and check if a MAC address is valid.

Checks whether the supplied MAC address is formally correct, only accepts colon separated format. Normalize it to all lower.

Parameters:

• mac (str) - the MAC to be validated

Returns: str

returns the normalized and validated MAC.

Raises:

• errors.OpPrereqError - If the MAC isn't valid

Return a 'safe' version of a source string.

This function mangles the input string and returns a version that should be safe to display/encode as ASCII. To this end, we first convert it to ASCII using the 'backslashreplace' encoding which should get rid of any non-ASCII chars, and then we process it through a loop copied from the string repr sources in the python; we don't use string_escape anymore since that escape single quotes and backslashes too, and that is too much; and that escaping is not stable, i.e. string_escape(string_escape(x)) != string_escape(x).

Parameters:

• text (str or unicode) - input data

Returns: str

a safe version of text

Split and unescape a string based on a given separator.

This function splits a string based on a separator where the separator itself can be escape in order to be an element of the elements. The escaping rules are (assuming coma being the separator):

• a plain , separates the elements
• a sequence \\, (double backslash plus comma) is handled as a backslash plus a separator comma
• a sequence \, (backslash plus comma) is handled as a non-separator comma

Parameters:

• text (string) - the string to split
• text (string) - the separator
• sep (string)

Returns: string

a list of strings

Nicely join a set of identifiers.

Parameters:

• names - set, list or tuple

Returns:

a string with the formatted results

Formats a time value.

Parameters:

• val (float or None) - Timestamp as returned by time.time() (seconds since Epoch, 1970-01-01 00:00:00 UTC)

Returns:

a string value or N/A if we don't have a valid timestamp

Formats seconds for easier reading.

Parameters:

• secs (number) - Number of seconds

Returns: string

Formatted seconds (e.g. "2d 9h 19m 49s")

Verifies is the given word is safe from the shell's p.o.v.

This means that we can pass this to a command via the shell and be sure that it doesn't alter the command line and is passed as such to the actual command.

Note that we are overly restrictive here, in order to be on the safe side.

Parameters:

• word (str) - the word to check

Returns: boolean

True if the word is 'safe'

Build a safe shell command line from the given arguments.

This function will check all arguments in the args list so that they are valid shell parameters (i.e. they don't contain shell metacharacters). If everything is ok, it will return the result of template % args.

Parameters:

• template (str) - the string holding the template for the string formatting

Returns: str

the expanded command line

Formats a number as an ordinal in the English language.

E.g. the number 1 becomes "1st", 22 becomes "22nd".

Parameters:

• value (integer) - Number

Returns: string

Truncate string and add ellipsis if needed.

Parameters:

• text (string) - Text
• length (integer) - Desired length

Returns: string

Truncated text

Formats a dictionary as "key=value" parameters.

The keys are sorted to have a stable order.

Parameters:

• data (dict)

Returns: list of string