ost::settings Namespace Reference

Data Structures

class  FileNotFound

Functions

def GetPlatform
def GetValue
def Locate

Function Documentation

def ost::settings::GetPlatform (  ) 
Returns platform.system(). If the system call is interrupted, it is repeated.
This function is a workaround for the buggy system call handling in Python.

Definition at line 4 of file settings.py.

def ost::settings::GetValue (   val_key,
  val_default = None,
  prefix = 'OST' 
)
Returns the value of the variable val_key if defined, otherwise returns the 
default value provided by the user (if provided). Search order: 

 * environment variable called $prefix_$val_key 
 * variable called val_key in .ostrc file

Definition at line 17 of file settings.py.

def ost::settings::Locate (   file_name,
  explicit_file_name = None,
  search_paths = [],
  env_name = None,
  search_system_paths = True 
)
Helper function to locate files. To get the full name of an executable, let's 
say qmake, use

.. code-block:: python

  abs_qmake_path=Locate('qmake', env_name='QMAKE_EXECUTABLE')

First the function checks if an environment variable with the name 
QMAKE_EXECUTABLE is set. If so, the value of this variable is returned. Next, 
each directory listed in search_paths is searched. If the executable could 
still not be found and search_system_paths is set to True, the binary search 
paths are searched.

If the file could not be located, a :exc:`~ost.settings.FileNotFound` 
exception will be raised containing a detail description why Locate failed. The 
error message is formatted in such a way that it can directly be presented to 
the user.

Definition at line 52 of file settings.py.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines

Generated on 20 Jun 2016 for OpenStructure by  doxygen 1.6.1