Documentation
Classes
EfficiencyWarning

EfficiencyWarning

Warning used to notify the user of inefficient computation.

This warning notifies the user that the efficiency may not be optimal due to some reason which may be included as a part of the warning message. This may be subclassed into a more specific Warning class.

Python Reference (opens in a new tab)

Constructors

constructor()

Signature

new EfficiencyWarning(opts?: object): EfficiencyWarning;

Parameters

NameType
opts?object
opts.args?any

Returns

EfficiencyWarning

Defined in: generated/exceptions/EfficiencyWarning.ts:23 (opens in a new tab)

Properties

_isDisposed

boolean = false

Defined in: generated/exceptions/EfficiencyWarning.ts:21 (opens in a new tab)

_isInitialized

boolean = false

Defined in: generated/exceptions/EfficiencyWarning.ts:20 (opens in a new tab)

_py

PythonBridge

Defined in: generated/exceptions/EfficiencyWarning.ts:19 (opens in a new tab)

id

string

Defined in: generated/exceptions/EfficiencyWarning.ts:16 (opens in a new tab)

opts

any

Defined in: generated/exceptions/EfficiencyWarning.ts:17 (opens in a new tab)

Accessors

py

Signature

py(): PythonBridge;

Returns

PythonBridge

Defined in: generated/exceptions/EfficiencyWarning.ts:28 (opens in a new tab)

Signature

py(pythonBridge: PythonBridge): void;

Parameters

NameType
pythonBridgePythonBridge

Returns

void

Defined in: generated/exceptions/EfficiencyWarning.ts:32 (opens in a new tab)

Methods

dispose()

Disposes of the underlying Python resources.

Once dispose() is called, the instance is no longer usable.

Signature

dispose(): Promise<void>;

Returns

Promise<void>

Defined in: generated/exceptions/EfficiencyWarning.ts:83 (opens in a new tab)

init()

Initializes the underlying Python resources.

This instance is not usable until the Promise returned by init() resolves.

Signature

init(py: PythonBridge): Promise<void>;

Parameters

NameType
pyPythonBridge

Returns

Promise<void>

Defined in: generated/exceptions/EfficiencyWarning.ts:41 (opens in a new tab)

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

Signature

with_traceback(opts: object): Promise<any>;

Parameters

NameType
optsobject

Returns

Promise<any>

Defined in: generated/exceptions/EfficiencyWarning.ts:100 (opens in a new tab)