Package PyFoam :: Package Infrastructure :: Module Hardcoded
[hide private]
[frames] | no frames]

Module Hardcoded

source code

Hardcoded values

Functions [hide private]
  globalDirectory()
  globalConfigFile()
  userDirectory()
  userConfigFile()
  userName()
  logDirectory()
Path to the log directory that this user may write to.
  assertDirectory(name)
Makes sure that the directory exists

Variables [hide private]
  _pyFoamDirName = 'pyFoam'
  _pyFoamConfigName = 'pyfoamrc'

Imports: os.path, os.makedirs, os.environ


Function Details [hide private]

globalDirectory()

source code 
Returns:
the global directory

globalConfigFile()

source code 
Returns:
The name of the global configuration File

userDirectory()

source code 
Returns:
the user directory

userConfigFile()

source code 
Returns:
The name of the user configuration File

userName()

source code 
Returns:
name of the current user

logDirectory()

source code 
Path to the log directory that this user may write to. /var/log/pyFoam for root, ~/.pyFoam/log for all others
Returns:
path to the log directory.

assertDirectory(name)

source code 
Makes sure that the directory exists
Parameters:
  • name - the directory

Variables Details [hide private]

_pyFoamDirName

None
Value:
'pyFoam'                                                               
      

_pyFoamConfigName

None
Value:
'pyfoamrc'