type Info_box

A container storing information about relax.

Instance Methods

__init__(self)
Create the program introduction text stings.

_setup_references(self)
Build a dictionary of all references useful for relax.

str centre(self, string, width=100)
Format the string to be centred to a certain number of spaces.

str file_type(self, path)
Return a string representation of the file type.

int format_max_width(self, data)
Return the text formatting width for the given data.

str intro_text(self)
Create the introductory string for STDOUT printing.

str package_info(self)
Return a string for printing to STDOUT with info from the Python packages used by relax.

str processor_name(self)
Return a string for the processor name.

str ram_info(self, format=' %-25s%s\n')
Return a string for printing to STDOUT with info from the Python packages used by relax.

str relax_module_info(self)
Return a string with info about the relax modules.

str sys_info(self)
Return a string for printing to STDOUT with info about the current relax instance.

str win_arch(self)
Determine the MS Windows architecture.

Static Methods

__new__(self, *args, **kargs)
Replacement function for implementing the singleton design pattern.

Class Variables

instance = None

Method Details

__init__(self)
(Constructor)

Create the program introduction text stings.

This class generates a container with the following objects:

• title: The program title 'relax'
• version: For example 'repository commit' or '1.3.8'.
• desc: The short program description.
• copyright: A list of copyright statements.
• licence: Text pertaining to the licencing.
• errors: A list of import errors.

Overrides: object.__init__

__new__(self, *args, **kargs)
Static Method

Replacement function for implementing the singleton design pattern.

Overrides: object.__new__

centre(self, string, width=100)

Format the string to be centred to a certain number of spaces.

Parameters:

• string (str) - The string to centre.
• width (int) - The number of characters to centre to.

Returns: str

The centred string with leading whitespace added.

file_type(self, path)

Return a string representation of the file type.

Parameters:

• path (str) - The full path of the file to return information about.

Returns: str

The single line file type information string.

format_max_width(self, data)

Return the text formatting width for the given data.

Parameters:

• data (list) - The list of things to print out.

Returns: int

The maximum width of the elements in the list.

intro_text(self)

Create the introductory string for STDOUT printing.

This text is word-wrapped to a fixed width of 100 characters (or 80 on MS Windows).

Returns: str

The introductory string.

package_info(self)

Return a string for printing to STDOUT with info from the Python packages used by relax.

Returns: str

The info string.

processor_name(self)

Return a string for the processor name.

Returns: str

The processor name, in much more detail than platform.processor().

ram_info(self, format=' %-25s%s\n')

Return a string for printing to STDOUT with info from the Python packages used by relax.

Parameters:

• format (str) - The formatting string.

Returns: str

The info string.

relax_module_info(self)

Return a string with info about the relax modules.

Returns: str

The info string.

sys_info(self)

Return a string for printing to STDOUT with info about the current relax instance.

Returns: str

The info string.

win_arch(self)

Determine the MS Windows architecture.

Returns: str

The architecture string.