ctlbase

• config module
  • Classes
    • CallerInspector
      • CallerInspector.__init__()
      • CallerInspector.getName()
      • CallerInspector.getPath()
    • FileHelper
      • FileHelper.Type
      • FileHelper.find()
      • FileHelper.findBinary()
      • FileHelper.findConfig()
      • FileHelper.findTranslation()
      • FileHelper.BIN_LOCATIONS
      • FileHelper.CONFIG_LOCATIONS
      • FileHelper.TRANSLATION_LOCATIONS
    • BashHelper
      • BashHelper.Array
      • BashHelper.Scalar
      • BashHelper.parseConfig()
  • Constants and defaults
    • Caller
    • TRUE_VALUE_PATTERN
    • FALSE_VALUE_PATTERN
• translation module
  • Classes
    • TranslationManager
      • TranslationManager.__init__()
      • TranslationManager.changeLanguage()
      • TranslationManager.loadLanguages()
      • TranslationManager.translate()
      • TranslationManager.language
  • Constants and defaults
    • Translation
• message module
  • Classes
    • Message
      • Message.__eq__()
      • Message.__init__()
      • Message.fromDict()
      • Message.fromJson()
      • Message.getTextLngs()
      • Message.toColoredText()
      • Message.toJson()
      • Message.toText()
      • Message.arguments
      • Message.correlationId
      • Message.key
      • Message.ns
      • Message.severity
      • Message.textEn
      • Message.timestamp_iso
    • ErrorMessage
      • ErrorMessage.__init__()
      • ErrorMessage.exitCode
    • MessageBuffer
      • MessageBuffer.__init__()
      • MessageBuffer.addTranslations()
      • MessageBuffer.append()
      • MessageBuffer.appendBuffer()
      • MessageBuffer.appendJson()
      • MessageBuffer.clear()
      • MessageBuffer.getExitCode()
      • MessageBuffer.getJson()
      • MessageBuffer.getList()
      • MessageBuffer.getText()
      • MessageBuffer.hasKey()
      • MessageBuffer.hasSeverity()
      • MessageBuffer.printText()
      • MessageBuffer.isColoringDefault
      • MessageBuffer.lngDefault
      • MessageBuffer.nsDefault
    • LoggingMessageBuffer
      • LoggingMessageBuffer.__init__()
      • LoggingMessageBuffer.append()
      • LoggingMessageBuffer.close()
      • LoggingMessageBuffer.openLog()
      • LoggingMessageBuffer.firstColumnFormatStr
      • LoggingMessageBuffer.isLogImmediately
      • LoggingMessageBuffer.isLogToConsole
      • LoggingMessageBuffer.logPath
    • MessageIterator
      • MessageIterator.Format
      • MessageIterator.__init__()
  • Constants and defaults
    • Severity
      • Severity.DEBUG
      • Severity.ERROR
      • Severity.NORMAL
      • Severity.SUCCESS
      • Severity.VERBOSE
      • Severity.WARNING
    • SEVERITY_FILTER_DEFAULT
    • COLOR_PRINT_ENVKEY
• process module
  • Classes
    • TaskMonitor
      • TaskMonitor.__init__()
      • TaskMonitor.add()
      • TaskMonitor.cancelTasks()
      • TaskMonitor.cancelTasksInLoop()
      • TaskMonitor.remove()
      • TaskMonitor.start()
      • TaskMonitor.stop()
      • TaskMonitor.loop
      • TaskMonitor.taskCheckingInterval_ms
    • CommandExecutor
      • CommandExecutor.SynchronousError
      • CommandExecutor.__init__()
      • CommandExecutor._createProcess()
      • CommandExecutor.executeAsynchronously()
      • CommandExecutor.executeCommands()
      • CommandExecutor.executeSynchronously()
      • CommandExecutor.getOutput()
      • CommandExecutor.ON_ERROR_ONLY
      • CommandExecutor.ON_SUCCESS_ONLY
      • CommandExecutor.isSynchronousDefault
  • Constants and defaults
    • TASK_CHECKING_INTERVAL_MS_DEFAULT
• mode module
  • Classes
    • ModeDirHelper
      • ModeDirHelper.find()
    • FileModeHandler
      • FileModeHandler.__init__()
      • FileModeHandler.activatePending()
      • FileModeHandler.getActive()
      • FileModeHandler.getPending()
      • FileModeHandler.setActive()
      • FileModeHandler.setPending()
      • FileModeHandler.unsetActive()
      • FileModeHandler.unsetPending()
  • Constants and defaults
    • TIMEOUT_DEFAULT_S
    • BASE_DIR_PATH_DEFAULT
• interaction module
  • Classes
    • InteractionManager
      • InteractionManager.__init__()
      • InteractionManager.promptForCredential()
      • InteractionManager.isColoringDefault
  • Constants and defaults
    • COLOR_PRINT_ENVKEY
    • Interaction
• credentials module
  • Classes
    • CredentialReader
      • CredentialReader.__init__()
    • KeyringReader
      • KeyringReader.__init__()
    • Tpm2Reader
      • Tpm2Reader.__init__()
      • Tpm2Reader.PCR_AUTH_DEFAULT
    • FileReader
      • FileReader.__init__()
    • PromptReader
      • PromptReader.__init__()
    • BaseReader
      • BaseReader.__init__()
      • BaseReader._readCredential()
      • BaseReader.readCredential()
      • BaseReader.credentialKeys
    • TemporaryCredentials
      • TemporaryCredentials.Format
      • TemporaryCredentials.__init__()
      • TemporaryCredentials.deleteCredential()
      • TemporaryCredentials.delete
      • TemporaryCredentials.format
      • TemporaryCredentials.mayPrompt
      • TemporaryCredentials.mountpoint
      • TemporaryCredentials.namedTemp
      • TemporaryCredentials.path
      • TemporaryCredentials.purpose
  • Constants and defaults
    • CredentialKey
      • CredentialKey.CRYPTOPHRASE
      • CredentialKey.LOGIN
      • CredentialKey.LOGINNAME
      • CredentialKey.PASSWORD
      • CredentialKey.TOTP
      • CredentialKey.USERNAME
    • CREDENTIALS_DIRECTORY_DEFAULT
• control module
  • Core concepts
    • control
    • action
    • mode
    • property
    • feedback
  • Classes
    • Control
      • Control.__init__()
      • Control._actionToGrammarEn()
      • Control._appendMessageFromActionEn()
      • Control._createExceptionFromActionEn()
      • Control._getPropertiesListsEn()
      • Control._getProperty()
      • Control._invalidateCache()
      • Control._performAction()
      • Control.activatePendingMode()
      • Control.close()
      • Control.getActiveMode()
      • Control.getPendingMode()
      • Control.getPropertiesJson()
      • Control.getPropertiesTextEn()
      • Control.getProperty()
      • Control.performAction()
      • Control.setActiveMode()
      • Control.setPendingMode()
      • Control.unsetActiveMode()
      • Control.unsetPendingMode()
    • ControlEnum
      • ControlEnum.__eq__()
      • ControlEnum.fromAny()
  • Constants and defaults
    • StandardAction
      • StandardAction.MODE_ACTIVATE
      • StandardAction.MODE_SET
      • StandardAction.MODE_UNSET
    • StandardMode
      • StandardMode.__eq__()
      • StandardMode.fromAny()
      • StandardMode.NONE
    • StandardProperty
      • StandardProperty.MODE_ACTIVE
      • StandardProperty.MODE_PENDING
    • ALREADY_OK_SEVERITY
    • ALREADY_NOT_OK_SEVERITY
    • MODE_DIR_NAME_ENVKEY
    • MODE_GROUP_ENVKEY
    • MODE_TIMEOUT_DEFAULT_ENVKEY
• shell module
  • Classes
    • ControlShell
      • ControlShell.__exit__()
      • ControlShell.__init__()
      • ControlShell.addStandardArgs()
      • ControlShell.printOnExit()
      • ControlShell.requestCleanup()
      • ControlShell.setControl()
      • ControlShell.setExitCode()
      • ControlShell.commandExecutor
      • ControlShell.envConfigDict
      • ControlShell.envConfigName
      • ControlShell.msgBuffer
    • DaemonControlShell
      • DaemonControlShell.__exit__()
      • DaemonControlShell.__init__()
      • DaemonControlShell.addStandardArgs()
      • DaemonControlShell.notifyReady()
      • DaemonControlShell.taskMonitor