schrodinger.application.steps.licensing module

class schrodinger.application.steps.licensing.LicenseMixin

Bases: object

A mixin to ensure that a step uses a LICENSE_KEY license.

To be mixed in with a stepper.ReduceStep. Subclasses need to define NO_LICENSE_MSG and LICENSE_KEY.

If no licenses are available when the step is executed an EXCEPTION will be raised.

LICENSE_KEY = None

NO_LICENSE_MSG = None

NO_MORE_LICENSES = 'No license tokens available.'

EXCEPTION

alias of builtins.RuntimeError

validateSettings()

In addition to the regular settings validation check for the license validity.

Returns

a list of validation issues

Return type

List[stepper.ValidationIssue]

reduceFunction(inputs)

Perform the step with checking out (and back in) of the license.

See also stepper.ReduceStep.reduceFunction.

getLicenseRequirements()