OPSI.Types module

Typeforcing and Exceptions.

This module contains various methods to ensure force a special type on an object.

It also is home to various exception classes.

copyright:uib GmbH <info@uib.de> author:Jan Schneider <j.schneider@uib.de> author:Niko Wenselowski <n.wenselowski@uib.de> license:GNU Affero General Public License version 3

exception OPSI.Types.BackendAuthenticationError(message='')

Bases: OPSI.Types.OpsiAuthenticationError

Exception raised if authentication failes.

ExceptionShortDescription = u'Backend authentication error'

exception OPSI.Types.BackendBadValueError(message='')

Bases: OPSI.Types.OpsiError

Exception raised if a malformed value is found.

ExceptionShortDescription = u'Backend bad value error'

exception OPSI.Types.BackendConfigurationError(message='')

Bases: OPSI.Types.OpsiError

Exception raised if a configuration error occurs in the backend.

ExceptionShortDescription = u'Backend configuration error'

exception OPSI.Types.BackendError(message='')

Bases: OPSI.Types.OpsiError

Exception raised if there is an error in the backend.

ExceptionShortDescription = u'Backend error'

exception OPSI.Types.BackendIOError(message='')

Bases: OPSI.Types.OpsiError

Exception raised if there is a read or write error in the backend.

ExceptionShortDescription = u'Backend I/O error'

exception OPSI.Types.BackendMissingDataError(message='')

Bases: OPSI.Types.OpsiError

Exception raised if expected data not found.

ExceptionShortDescription = u'Backend missing data error'

exception OPSI.Types.BackendModuleDisabledError(message='')

Bases: OPSI.Types.OpsiError

Exception raised if a needed module is disabled.

ExceptionShortDescription = u'Backend module disabled error'

exception OPSI.Types.BackendPermissionDeniedError(message='')

Bases: OPSI.Types.OpsiError

Exception raised if a permission is denied.

ExceptionShortDescription = u'Backend permission denied error'

exception OPSI.Types.BackendReferentialIntegrityError(message='')

Bases: OPSI.Types.OpsiError

Exception raised if there is a referential integration error occurs in the backend.

ExceptionShortDescription = u'Backend referential integrity error'

exception OPSI.Types.BackendTemporaryError(message='')

Bases: OPSI.Types.OpsiError

Exception raised if a temporary error occurs.

ExceptionShortDescription = u'Backend temporary error'

exception OPSI.Types.BackendUnaccomplishableError(message='')

Bases: OPSI.Types.OpsiError

Exception raised if an unaccomplishable situation appears

ExceptionShortDescription = u'Backend unaccomplishable error'

exception OPSI.Types.CanceledException

Bases: exceptions.Exception

ExceptionShortDescription = u'CanceledException'

exception OPSI.Types.LicenseConfigurationError(message='')

Bases: OPSI.Types.OpsiError

Exception raised if a configuration error occurs in the license data base.

ExceptionShortDescription = u'License configuration error'

exception OPSI.Types.LicenseMissingError(message='')

Bases: OPSI.Types.OpsiError

Exception raised if a license is requested but cannot be found.

ExceptionShortDescription = u'License missing error'

exception OPSI.Types.OpsiAuthenticationError(message='')

Bases: OPSI.Types.OpsiError

ExceptionShortDescription = u'Opsi authentication error'

exception OPSI.Types.OpsiBackupBackendNotFound(message='')

Bases: OPSI.Types.OpsiBackupFileError

ExceptionShortDescription = u'Opsi backend not found in backup'

exception OPSI.Types.OpsiBackupFileError(message='')

Bases: OPSI.Types.OpsiError

ExceptionShortDescription = u'Opsi backup file error'

exception OPSI.Types.OpsiBackupFileNotFound(message='')

Bases: OPSI.Types.OpsiBackupFileError

ExceptionShortDescription = u'Opsi backup file not found'

exception OPSI.Types.OpsiBadRpcError(message='')

Bases: OPSI.Types.OpsiError

ExceptionShortDescription = u'Opsi bad rpc error'

exception OPSI.Types.OpsiConnectionError(message='')

Bases: OPSI.Types.OpsiError

ExceptionShortDescription = u'Opsi connection error'

exception OPSI.Types.OpsiError(message='')

Bases: exceptions.Exception

Base class for OPSI Backend exceptions.

ExceptionShortDescription = 'Opsi error'

complete_message()

message()

exception OPSI.Types.OpsiProductOrderingError(message='', problematicRequirements=None)

Bases: OPSI.Types.OpsiError

ExceptionShortDescription = u'A condition for ordering cannot be fulfilled'

exception OPSI.Types.OpsiRpcError(message='')

Bases: OPSI.Types.OpsiError

ExceptionShortDescription = u'Opsi rpc error'

exception OPSI.Types.OpsiServiceVerificationError(message='')

Bases: OPSI.Types.OpsiError

ExceptionShortDescription = u'Opsi service verification error'

exception OPSI.Types.OpsiTimeoutError(message='')

Bases: OPSI.Types.OpsiError

ExceptionShortDescription = u'Opsi timeout error'

exception OPSI.Types.OpsiVersionError(message='')

Bases: OPSI.Types.OpsiError

ExceptionShortDescription = u'Opsi version error'

exception OPSI.Types.RepositoryError(message='')

Bases: OPSI.Types.OpsiError

ExceptionShortDescription = u'Repository error'

OPSI.Types.args(*vars, **typeVars)

Function to populate an object with passed on keyword args. This is intended to be used as a decorator. Classes using this decorator must explicitly inherit from object or a subclass of object.

@args()                 #works
class Foo(object):
        pass

@args()                 #works
class Bar(Foo):
        pass

@args()                 #does not work
class Foo():
        pass

@args()                 #does not work
class Foo:
        pass

OPSI.Types.forceActionProgress(var)

OPSI.Types.forceActionRequest(var)

OPSI.Types.forceActionRequestList(var)

OPSI.Types.forceActionResult(var)

OPSI.Types.forceArchitecture(var)

OPSI.Types.forceArchitectureList(var)

OPSI.Types.forceAuditState(var)

OPSI.Types.forceBool(var)

OPSI.Types.forceBoolList(var)

OPSI.Types.forceBootConfigurationPriority(var)

OPSI.Types.forceConfigId(var)

OPSI.Types.forceDict(var)

OPSI.Types.forceDictList(var)

OPSI.Types.forceDomain(var)

OPSI.Types.forceEmailAddress(var)

OPSI.Types.forceFilename(var)

OPSI.Types.forceFloat(var)

OPSI.Types.forceFqdn(var)

OPSI.Types.forceGroupId(var)

OPSI.Types.forceGroupIdList(var)

OPSI.Types.forceGroupType(var)

OPSI.Types.forceGroupTypeList(var)

OPSI.Types.forceHardwareAddress(var)

OPSI.Types.forceHardwareDeviceId(var)

OPSI.Types.forceHardwareVendorId(var)

OPSI.Types.forceHostAddress(var)

OPSI.Types.forceHostId(var)

OPSI.Types.forceHostIdList(var)

OPSI.Types.forceHostname(var)

OPSI.Types.forceIPAddress(var)

OPSI.Types.forceInstallationStatus(var)

OPSI.Types.forceInt(var)

OPSI.Types.forceIntList(var)

OPSI.Types.forceIpAddress(var)

OPSI.Types.forceLanguageCode(var)

OPSI.Types.forceLanguageCodeList(var)

OPSI.Types.forceLicenseContractId(var)

OPSI.Types.forceLicenseContractIdList(var)

OPSI.Types.forceLicensePoolId(var)

OPSI.Types.forceLicensePoolIdList(var)

OPSI.Types.forceList(var)

OPSI.Types.forceNetmask(var)

OPSI.Types.forceNetworkAddress(var)

OPSI.Types.forceObjectClass(var, objectClass)

OPSI.Types.forceObjectClassList(var, objectClass)

OPSI.Types.forceObjectId(var)

OPSI.Types.forceObjectIdList(var)

OPSI.Types.forceOct(var)

OPSI.Types.forceOpsiHostKey(var)

OPSI.Types.forceOpsiTimestamp(var)

Make var an opsi-compatible timestamp.

This is a string with the format “YYYY-MM-DD HH:MM:SS”.

If a conversion is not possible a ValueError will be raised.

OPSI.Types.forcePackageCustomName(var)

OPSI.Types.forcePackageVersion(var)

OPSI.Types.forcePackageVersionList(var)

OPSI.Types.forceProductId(var)

OPSI.Types.forceProductIdList(var)

OPSI.Types.forceProductPriority(var)

OPSI.Types.forceProductPropertyId(var)

OPSI.Types.forceProductPropertyType(var)

OPSI.Types.forceProductTargetConfiguration(var)

OPSI.Types.forceProductType(var)

OPSI.Types.forceProductVersion(var)

OPSI.Types.forceProductVersionList(var)

OPSI.Types.forceRequirementType(var)

OPSI.Types.forceSoftwareLicenseId(var)

OPSI.Types.forceSoftwareLicenseIdList(var)

OPSI.Types.forceTime(var)

Convert var to a time.struct_time.

If no conversion is possible a ValueError will be raised.

OPSI.Types.forceUnicode(var)

OPSI.Types.forceUnicodeList(var)

OPSI.Types.forceUnicodeLower(var)

OPSI.Types.forceUnicodeLowerList(var)

OPSI.Types.forceUnicodeUpper(var)

OPSI.Types.forceUniqueList(_list)

OPSI.Types.forceUnsignedInt(var)

OPSI.Types.forceUrl(var)

Forces var to be an valid URL.

Return type:unicode