rtctree::utils Namespace Reference

Functions
def	build_attr_string
def	colour_supported
def	dict_to_nvlist
def	filtered
def	get_num_columns_and_rows
def	get_terminal_size
def	nvlist_to_dict
def	trim_filter
Variables
dictionary	term_attributes
	API functions.

---

Function Documentation

def rtctree.utils.build_attr_string	(		attrs,
			supported = True
	)

Build a string that will turn any ANSI shell output the desired
colour.

attrs should be a list of keys into the term_attributes table.

Definition at line 62 of file utils.py.

def rtctree.utils.colour_supported

(

term

)

Definition at line 79 of file utils.py.

def rtctree.utils.dict_to_nvlist

(

dict

)

Convert a dictionary into a CORBA namevalue list.

Definition at line 161 of file utils.py.

def rtctree.utils.filtered	(		path,
			filter
	)

Check if a path is removed by a filter.

Check if a path is in the provided set of paths, @ref filter. If
none of the paths in filter begin with @ref path, then True is
returned to indicate that the path is filtered out. If @ref path is
longer than the filter, and starts with the filter, it is
considered unfiltered (all paths below a filter are unfiltered).

An empty filter ([]) is treated as not filtering any.

Definition at line 177 of file utils.py.

def rtctree.utils.get_num_columns_and_rows	(		widths,
			gap_width,
			term_width
	)

Given a list of string widths, a width of the minimum gap to place
between them, and the maximum width of the output (such as a terminal
width), calculate the number of columns and rows, and the width of each
column, for the optimal layout.

Definition at line 85 of file utils.py.

def rtctree.utils.get_terminal_size

(

)

Finds the width of the terminal, or returns a suitable default value.

Definition at line 126 of file utils.py.

def rtctree.utils.nvlist_to_dict

(

nvlist

)

Convert a CORBA namevalue list into a dictionary.

Definition at line 169 of file utils.py.

def rtctree.utils.trim_filter	(		filter,
			levels = 1
	)

Trim @ref levels levels from the front of each path in @filter.

Definition at line 201 of file utils.py.

---

Variable Documentation

dictionary rtctree::utils::term_attributes

Initial value:

{'reset': '00',
                   'bold': '01',
                   'faint': '02',
                   'underline': '04',
                   'blink': '05',
                   'blinkfast': '06',
                   'negative': '07',
                   'normal': '22',
                   'nounderline': '24',
                   'noblink': '25',
                   'positive': '27',
                   'black': '30',
                   'red': '31',
                   'green': '32',
                   'brown': '33',
                   'blue': '34',
                   'purple': '35',
                   'cyan': '36',
                   'white': '37',
                   'bgblack': '40',
                   'bgred': '41',
                   'bggreen': '42',
                   'bgbrown': '43',
                   'bgblue': '44',
                   'bgpurple': '45',
                   'bgcyan': '46',
                   'bgwhite': '47',
                   }

API functions.

Definition at line 31 of file utils.py.