autonomy.analyse.service

Tools for analysing the service for deployment readiness

CustomSchemaValidationError Objects

class CustomSchemaValidationError(SchemaValidationError)

Custom schema validation error to report all errors at once.

``init``

def __init__(extra_properties: Optional[List[str]] = None,
             missing_properties: Optional[List[str]] = None,
             not_having_enough_properties: Optional[List[str]] = None,
             **kwargs: Any) -> None

Initialize object.

CustomSchemaValidator Objects

class CustomSchemaValidator(Draft4Validator)

Custom schema validator to report all missing fields at once.

validate

def validate(*args: Any, **kwargs: Any) -> None

Validate and raise all errors at once.

ServiceValidationFailed Objects

class ServiceValidationFailed(Exception)

Raise when service validation fails.

ServiceAnalyser Objects

class ServiceAnalyser()

Tools to analyse a service

``init``

def __init__(service_config: Service,
             abci_skill_id: PublicId,
             is_on_chain_check: bool = False,
             logger: Optional[logging.Logger] = None,
             skip_warnings: bool = False) -> None

Initialise object.

check`_`on`_`chain`_`state

def check_on_chain_state(ledger_api: LedgerApi, chain_type: ChainType,
                         token_id: int) -> None

Check on-chain state of a service.

check`_`agent`_`dependencies`_`published

def check_agent_dependencies_published(agent_config: AgentConfig,
                                       ipfs_pins: Set[str]) -> None

Check if the agent package is published or not

cross`_`verify`_`overrides

def cross_verify_overrides(agent_config: AgentConfig,
                           skill_config: SkillConfig) -> None

Cross verify overrides between service config and agent config

validate`_`override`_`env`_`vars

@classmethod
def validate_override_env_vars(
        cls,
        overrides: Union[OrderedDict, dict],
        validate_env_var_name: bool = False,
        json_path: Optional[List[str]] = None) -> List[str]

Validate environment variables.

validate`_`agent`_`override`_`env`_`vars

def validate_agent_override_env_vars(agent_config: AgentConfig) -> None

Check if all of the overrides are defined as a env vars in the agent config

validate`_`service`_`override`_`env`_`vars

def validate_service_override_env_vars() -> None

Check if all of the overrides are defined as a env vars in the agent config

validate`_`override

def validate_override(component_id: ComponentId, override: Dict,
                      has_multiple_overrides: bool) -> None

Validate override

validate`_`skill`_`config

def validate_skill_config(skill_config: SkillConfig) -> None

Check required overrides.

validate`_`agent`_`overrides

def validate_agent_overrides(agent_config: AgentConfig) -> None

Check required overrides.

validate`_`service`_`overrides

def validate_service_overrides() -> None

Check required overrides.