MarginCallModelPythonWrapper

QuantConnect.Python.MarginCallModelPythonWrapper

MarginCallModelPythonWrapper(model: Any)

Bases: BasePythonWrapper[IMarginCallModel], IMarginCallModel

Provides a margin call model that wraps a PyObject object that represents the model responsible for picking which orders should be executed during a margin call

Constructor for initialising the MarginCallModelPythonWrapper class with wrapped PyObject object

Parameters:

Name	Type	Description	Default
model	Any	Represents the model responsible for picking which orders should be executed during a margin call	required

instance

instance: Any

Gets the underlying python instance

This codeEntityType is protected.

PythonRuntimeChecker

Bases: Object

Set of helper methods to invoke Python methods with runtime checks for return values and out parameter's conversions.

execute_margin_call

execute_margin_call(
    generated_margin_call_orders: List[SubmitOrderRequest],
) -> List[OrderTicket]

Executes synchronous orders to bring the account within margin requirements.

Parameters:

Name	Type	Description	Default
generated_margin_call_orders	List[SubmitOrderRequest]	These are the margin call orders that were generated by individual security margin models.	required

Returns:

Type	Description
List[OrderTicket]	The list of orders that were actually executed.

get_margin_call_orders

get_margin_call_orders(
    issue_margin_call_warning: Optional[bool],
) -> Tuple[List[SubmitOrderRequest], bool]

Scan the portfolio and the updated data for a potential margin call situation which may get the holdings below zero! If there is a margin call, liquidate the portfolio immediately before the portfolio gets sub zero.

Parameters:

Name	Type	Description	Default
issue_margin_call_warning	Optional[bool]	Set to true if a warning should be issued to the algorithm	required

Returns:

Type	Description
Tuple[List[SubmitOrderRequest], bool]	True for a margin call on the holdings.

equals

equals(obj: Any) -> bool

equals(
    other: BasePythonWrapper[
        QuantConnect_Python_BasePythonWrapper_TInterface
    ],
) -> bool

Signature descriptions:

• Determines whether the specified object is an instance of BasePythonWrapper{TInterface} and wraps the same Python object reference as this instance, which would indicate that they are equal.

• Determines whether the specified instance wraps the same Python object reference as this instance, which would indicate that they are equal.

Parameters:

Name	Type	Description	Default
obj	Optional[Any]	The other object to compare this with	None
other	Optional[BasePythonWrapper[QuantConnect_Python_BasePythonWrapper_TInterface]]	The other object to compare this with	None

Returns:

Type	Description
bool	True if both instances are equal, that is if both wrap the same Python object reference.

set_python_instance

set_python_instance(instance: Any) -> None

set_python_instance(
    instance: Any, validate_interface: bool
) -> None

Signature descriptions:

• Sets the python instance

• Sets the python instance and sets the validate interface flag

Parameters:

Name	Type	Description	Default
instance	Any	The underlying python instance	required
validate_interface	Optional[bool]	Whether to perform validations for interface implementation	None

dispose

dispose() -> None

Dispose of this instance

get_event

get_event(name: str) -> Any

Gets the Python instance event with the specified name

Parameters:

Name	Type	Description	Default
name	str	The name of the event	required

get_hash_code

get_hash_code() -> int

Gets the hash code for the current instance

Returns:

Type	Description
int	The hash code of the current instance.

get_method

get_method(
    method_name: str, python_only: bool = False
) -> Any

Gets the Python instances method with the specified name and caches it

Parameters:

Name	Type	Description	Default
method_name	str	The name of the method	required
python_only	bool	Whether to only return python methods	False

Returns:

Type	Description
Any	The matched method.

get_property

get_property(property_name: str) -> Any

Gets the Python instance property with the specified name

Parameters:

Name	Type	Description	Default
property_name	str	The name of the property	required

has_attr

has_attr(name: str) -> bool

Determines whether the Python instance has the specified attribute

Parameters:

Name	Type	Description	Default
name	str	The attribute name	required

Returns:

Type	Description
bool	Whether the Python instance has the specified attribute.

invoke_method

invoke_method(
    method_name: str, *args: Union[Object, Iterable[Object]]
) -> Any

Invokes the specified method with the specified arguments

Parameters:

Name	Type	Description	Default
method_name	str	The name of the method	required
args	Union[Object, Iterable[Object]]	The arguments to call the method with	()

invoke_void_method

invoke_void_method(
    method_name: str, *args: Union[Object, Iterable[Object]]
) -> None

Invokes the specified method with the specified arguments without returning a value

Parameters:

Name	Type	Description	Default
method_name	str	The name of the method	required
args	Union[Object, Iterable[Object]]	The arguments to call the method with	()

set_property

set_property(property_name: str, value: Any) -> None

Sets the Python instance property with the specified name

Parameters:

Name	Type	Description	Default
property_name	str	The name of the property	required
value	Any	The property value	required