tbapi.api.interfaces.iscript 

 1from __future__ import annotations
 2from typing import TYPE_CHECKING
 3from tbapi.common.decorators import tb_interface
 4from tbapi.common.converters import to_python_datetime, to_net_datetime
 5from datetime import datetime
 6from Tickblaze.Scripts.Api.Interfaces import IScript as _IScript
 7from typing import Any, overload
 8from abc import ABC, abstractmethod
 9if TYPE_CHECKING:
10    from tbapi.api.models.metadata import Metadata
11    from tbapi.api.parameters import Parameters
12    from tbapi.api.optimization_parameters import OptimizationParameters
13
14@tb_interface(_IScript)
15class IScript():
16    """Defines properties and methods for a script, including initialization and metadata."""
17
18    @property
19    def metadata(self) -> Metadata:
20        """The metadata associated with the script."""
21        from tbapi.api.models.metadata import Metadata
22        val = self._value.Metadata
23        return Metadata(_existing=val)
24    @property
25    def parameters(self) -> Parameters:
26        """The parameters for the script."""
27        from tbapi.api.parameters import Parameters
28        val = self._value.Parameters
29        return Parameters(_existing=val)
30    @property
31    def is_initialized(self) -> bool:
32        """Indicates whether the script has been initialized."""
33        val = self._value.IsInitialized
34        return val
35
36    def initialize(self) -> None:
37        """Initializes the script."""
38        result = self._value.Initialize()
39        return result
40  
41    @abstractmethod
42    def get_parameters(self) -> Parameters:
43        """Gets the parameters of the script for the UI."""
44        result = self._value.GetParameters()
45        from tbapi.api.parameters import Parameters
46        return Parameters(_existing=result)
47  
48    @abstractmethod
49    def get_optimization_parameters(self, parameter_values: OptimizationParameters) -> Parameters:
50        """Gets the parameters of the script for the UI in an optimization context."""
51        result = self._value.GetOptimizationParameters(parameter_values._value)
52        from tbapi.api.parameters import Parameters
53        return Parameters(_existing=result)
54
@tb_interface(_IScript)
class IScript: 
20@tb_interface(_IScript)
21class IScript():
22    """Defines properties and methods for a script, including initialization and metadata."""
23
24    @property
25    def metadata(self) -> Metadata:
26        """The metadata associated with the script."""
27        from tbapi.api.models.metadata import Metadata
28        val = self._value.Metadata
29        return Metadata(_existing=val)
30    @property
31    def parameters(self) -> Parameters:
32        """The parameters for the script."""
33        from tbapi.api.parameters import Parameters
34        val = self._value.Parameters
35        return Parameters(_existing=val)
36    @property
37    def is_initialized(self) -> bool:
38        """Indicates whether the script has been initialized."""
39        val = self._value.IsInitialized
40        return val
41
42    def initialize(self) -> None:
43        """Initializes the script."""
44        result = self._value.Initialize()
45        return result
46  
47    @abstractmethod
48    def get_parameters(self) -> Parameters:
49        """Gets the parameters of the script for the UI."""
50        result = self._value.GetParameters()
51        from tbapi.api.parameters import Parameters
52        return Parameters(_existing=result)
53  
54    @abstractmethod
55    def get_optimization_parameters(self, parameter_values: OptimizationParameters) -> Parameters:
56        """Gets the parameters of the script for the UI in an optimization context."""
57        result = self._value.GetOptimizationParameters(parameter_values._value)
58        from tbapi.api.parameters import Parameters
59        return Parameters(_existing=result)

Defines properties and methods for a script, including initialization and metadata.

IScript(*args, **kwargs) 
199        def __init__(self, *args, **kwargs):
200            pass
metadata: tbapi.api.models.metadata.Metadata 
24    @property
25    def metadata(self) -> Metadata:
26        """The metadata associated with the script."""
27        from tbapi.api.models.metadata import Metadata
28        val = self._value.Metadata
29        return Metadata(_existing=val)

The metadata associated with the script.

parameters: tbapi.api.parameters.Parameters 
30    @property
31    def parameters(self) -> Parameters:
32        """The parameters for the script."""
33        from tbapi.api.parameters import Parameters
34        val = self._value.Parameters
35        return Parameters(_existing=val)

The parameters for the script.

is_initialized: bool 
36    @property
37    def is_initialized(self) -> bool:
38        """Indicates whether the script has been initialized."""
39        val = self._value.IsInitialized
40        return val

Indicates whether the script has been initialized.

def initialize(self) -> None: 
42    def initialize(self) -> None:
43        """Initializes the script."""
44        result = self._value.Initialize()
45        return result

Initializes the script.

@abstractmethod
def get_parameters(self) -> tbapi.api.parameters.Parameters: 
47    @abstractmethod
48    def get_parameters(self) -> Parameters:
49        """Gets the parameters of the script for the UI."""
50        result = self._value.GetParameters()
51        from tbapi.api.parameters import Parameters
52        return Parameters(_existing=result)

Gets the parameters of the script for the UI.

@abstractmethod
def get_optimization_parameters( self, parameter_values: tbapi.api.optimization_parameters.OptimizationParameters) -> tbapi.api.parameters.Parameters: 
54    @abstractmethod
55    def get_optimization_parameters(self, parameter_values: OptimizationParameters) -> Parameters:
56        """Gets the parameters of the script for the UI in an optimization context."""
57        result = self._value.GetOptimizationParameters(parameter_values._value)
58        from tbapi.api.parameters import Parameters
59        return Parameters(_existing=result)

Gets the parameters of the script for the UI in an optimization context.