arcaflow_plugin_sdk package

Submodules

• arcaflow_plugin_sdk.annotations module
• arcaflow_plugin_sdk.jsonschema module
  • step_input()
  • step_outputs()
• arcaflow_plugin_sdk.plugin module
  • build_schema()
  • run()
  • signal_handler()
  • step()
  • step_with_signals()
• arcaflow_plugin_sdk.schema module
  • Using
  • Contributing
    • Exceptions
    • Annotations
    • Type aliases
    • Schema
    • Types
    • Build
    • Schema schemas
  • AbstractType
    • AbstractType.serialize()
    • AbstractType.unserialize()
    • AbstractType.validate()
  • AnySchema
  • AnyType
    • AnyType.serialize()
    • AnyType.unserialize()
    • AnyType.validate()
  • BadArgumentException
    • BadArgumentException.msg
  • BoolSchema
  • BoolType
    • BoolType.serialize()
    • BoolType.unserialize()
    • BoolType.validate()
  • ConstraintException
    • ConstraintException.msg
    • ConstraintException.path
  • DisplayValue
    • DisplayValue.description
    • DisplayValue.icon
    • DisplayValue.name
  • FloatSchema
    • FloatSchema.max
    • FloatSchema.min
    • FloatSchema.units
  • FloatType
    • FloatType.serialize()
    • FloatType.unserialize()
    • FloatType.validate()
  • IntEnumSchema
    • IntEnumSchema.units
    • IntEnumSchema.valid_values()
    • IntEnumSchema.values
  • IntEnumType
  • IntSchema
    • IntSchema.max
    • IntSchema.min
    • IntSchema.units
  • IntType
    • IntType.serialize()
    • IntType.unserialize()
    • IntType.validate()
  • InvalidAnnotationException
    • InvalidAnnotationException.annotation
    • InvalidAnnotationException.msg
  • InvalidInputException
    • InvalidInputException.constraint
  • InvalidOutputException
    • InvalidOutputException.constraint
  • ListSchema
    • ListSchema.items
    • ListSchema.max
    • ListSchema.min
  • ListType
    • ListType.items
    • ListType.serialize()
    • ListType.unserialize()
    • ListType.validate()
  • MapSchema
    • MapSchema.keys
    • MapSchema.max
    • MapSchema.min
    • MapSchema.values
  • MapType
    • MapType.keys
    • MapType.serialize()
    • MapType.unserialize()
    • MapType.validate()
    • MapType.values
  • NoSuchSignalException
    • NoSuchSignalException.signal
    • NoSuchSignalException.step
  • NoSuchStepException
    • NoSuchStepException.step
  • ObjectSchema
    • ObjectSchema.id
    • ObjectSchema.properties
  • ObjectType
    • ObjectType.cls
    • ObjectType.properties
    • ObjectType.serialize()
    • ObjectType.unserialize()
    • ObjectType.validate()
  • OneOfIntSchema
    • OneOfIntSchema.discriminator_field_name
    • OneOfIntSchema.types
  • OneOfIntType
    • OneOfIntType.types
  • OneOfStringSchema
    • OneOfStringSchema.discriminator_field_name
    • OneOfStringSchema.types
  • OneOfStringType
    • OneOfStringType.types
  • PatternSchema
  • PatternType
    • PatternType.serialize()
    • PatternType.unserialize()
    • PatternType.validate()
  • PropertySchema
    • PropertySchema.conflicts
    • PropertySchema.default
    • PropertySchema.display
    • PropertySchema.examples
    • PropertySchema.required
    • PropertySchema.required_if
    • PropertySchema.required_if_not
    • PropertySchema.type
  • PropertyType
    • PropertyType.field_override
  • RefSchema
    • RefSchema.display
    • RefSchema.id
  • RefType
    • RefType.properties
    • RefType.serialize()
    • RefType.unserialize()
    • RefType.validate()
  • SCHEMA_SCHEMA
  • SCOPE_SCHEMA
  • Schema
    • Schema.steps
  • SchemaBuildException
  • SchemaType
    • SchemaType.call_step()
    • SchemaType.call_step_signal()
    • SchemaType.get_signal()
    • SchemaType.get_step()
    • SchemaType.serialize_output()
    • SchemaType.steps
    • SchemaType.unserialize_signal_handler_input()
    • SchemaType.unserialize_step_input()
  • ScopeSchema
    • ScopeSchema.objects
    • ScopeSchema.root
    • ScopeSchema.to_jsonschema()
    • ScopeSchema.to_openapi()
  • ScopeType
    • ScopeType.cls
    • ScopeType.id
    • ScopeType.objects
    • ScopeType.properties
    • ScopeType.serialize()
    • ScopeType.unserialize()
    • ScopeType.validate()
  • SignalHandlerType
  • SignalSchema
    • SignalSchema.data_schema
    • SignalSchema.display
    • SignalSchema.id
  • StepOutputSchema
    • StepOutputSchema.display
    • StepOutputSchema.error
    • StepOutputSchema.schema
    • StepOutputSchema.to_jsonschema()
    • StepOutputSchema.to_openapi()
  • StepOutputType
    • StepOutputType.display
    • StepOutputType.error
    • StepOutputType.schema
    • StepOutputType.serialize()
    • StepOutputType.unserialize()
    • StepOutputType.validate()
  • StepSchema
    • StepSchema.display
    • StepSchema.id
    • StepSchema.input
    • StepSchema.outputs
    • StepSchema.signal_emitters
    • StepSchema.signal_handlers
  • StepType
    • StepType.initialized_object_data
    • StepType.input
    • StepType.inspect_methods()
    • StepType.object_cv
    • StepType.object_data_ready
    • StepType.outputs
    • StepType.signal_handler_method_names
  • StringEnumSchema
    • StringEnumSchema.valid_values()
    • StringEnumSchema.values
  • StringEnumType
  • StringSchema
    • StringSchema.max
    • StringSchema.min
    • StringSchema.pattern
  • StringType
    • StringType.serialize()
    • StringType.unserialize()
    • StringType.validate()
  • Unit
    • Unit.format_long()
    • Unit.format_short()
    • Unit.name_long_plural
    • Unit.name_long_singular
    • Unit.name_short_plural
    • Unit.name_short_singular
  • UnitParseException
    • UnitParseException.msg
  • Units
    • Units.base_unit
    • Units.format_long()
    • Units.format_short()
    • Units.multipliers
    • Units.parse()
  • build_object_schema()
  • conflicts()
  • description()
  • discriminator()
  • discriminator_value()
  • example()
  • icon()
  • id()
  • max()
  • min()
  • name()
  • pattern()
  • required_if()
  • required_if_not()
  • test_object_serialization()
  • units()
• arcaflow_plugin_sdk.serialization module
  • LoadFromFileException
    • LoadFromFileException.msg
  • LoadFromStdinException
    • LoadFromStdinException.msg
  • load_from_file()
  • load_from_stdin()
• arcaflow_plugin_sdk.test_jsonschema module
  • JSONSchemaTest
    • JSONSchemaTest.test_step_input()
    • JSONSchemaTest.test_step_outputs()
• arcaflow_plugin_sdk.test_plugin module
  • StdoutTest
    • StdoutTest.test_capture_stdout()
  • StdoutTestInput
  • StdoutTestOutput
• arcaflow_plugin_sdk.test_schema module
  • AnyTest
    • AnyTest.test_unserialize()
    • AnyTest.test_validate()
  • BoolTest
    • BoolTest.test_serialize()
    • BoolTest.test_unserialize()
    • BoolTest.test_validate()
  • Color
    • Color.GREEN
    • Color.RED
  • EnumTest
    • EnumTest.test_unserialize()
  • IntTest
    • IntTest.test_assignment()
    • IntTest.test_unserialize()
    • IntTest.test_validation_max()
    • IntTest.test_validation_min()
    • IntTest.unserialize()
  • JSONSchemaTest
    • JSONSchemaTest.test_bool()
    • JSONSchemaTest.test_enum()
    • JSONSchemaTest.test_float()
    • JSONSchemaTest.test_int()
    • JSONSchemaTest.test_list()
    • JSONSchemaTest.test_map()
    • JSONSchemaTest.test_object()
    • JSONSchemaTest.test_one_of()
    • JSONSchemaTest.test_string()
  • ListTest
    • ListTest.test_assignement()
    • ListTest.test_validation()
    • ListTest.test_validation_elements()
    • ListTest.test_validation_max()
    • ListTest.test_validation_min()
  • MapTest
    • MapTest.test_assignment()
    • MapTest.test_type_validation()
    • MapTest.test_validation_max()
    • MapTest.test_validation_min()
  • ObjectTest
    • ObjectTest.t
    • ObjectTest.test_baseclass_field()
    • ObjectTest.test_field_override()
    • ObjectTest.test_init_mismatches()
    • ObjectTest.test_serialize()
    • ObjectTest.test_unserialize()
    • ObjectTest.test_validate()
  • OneOfTest
    • OneOfTest.test_assignment()
    • OneOfTest.test_object()
    • OneOfTest.test_serialize()
    • OneOfTest.test_unserialize()
    • OneOfTest.test_unserialize_embedded()
    • OneOfTest.test_validation()
  • SchemaBuilderTest
    • SchemaBuilderTest.test_annotated()
    • SchemaBuilderTest.test_annotated_required_if()
    • SchemaBuilderTest.test_any()
    • SchemaBuilderTest.test_class()
    • SchemaBuilderTest.test_different_id()
    • SchemaBuilderTest.test_float()
    • SchemaBuilderTest.test_int()
    • SchemaBuilderTest.test_int_enum()
    • SchemaBuilderTest.test_list()
    • SchemaBuilderTest.test_map()
    • SchemaBuilderTest.test_non_dataclass()
    • SchemaBuilderTest.test_optional()
    • SchemaBuilderTest.test_regexp()
    • SchemaBuilderTest.test_string()
    • SchemaBuilderTest.test_string_enum()
    • SchemaBuilderTest.test_unclear_error_message()
    • SchemaBuilderTest.test_union()
    • SchemaBuilderTest.test_union_custom_discriminator()
  • SerializationTest
    • SerializationTest.test_build_object_schema_wrapping()
    • SerializationTest.test_default_value()
    • SerializationTest.test_float_optional()
    • SerializationTest.test_int_optional()
    • SerializationTest.test_required_if()
    • SerializationTest.test_required_if_not()
    • SerializationTest.test_serialization_cycle()
  • StringTest
    • StringTest.test_unserialize()
    • StringTest.test_validation()
    • StringTest.test_validation_max_length()
    • StringTest.test_validation_min_length()
    • StringTest.test_validation_pattern()
    • StringTest.test_validator_assignment()
  • TestClass
    • TestClass.a
    • TestClass.b
    • TestClass.c
    • TestClass.d
  • load_tests()
• arcaflow_plugin_sdk.validation module

Module contents