django_analyses.models.input.types package

Submodules

django_analyses.models.input.types.boolean_input module

class django_analyses.models.input.types.boolean_input.BooleanInput(id, run, input_ptr, value, definition)

Bases: django_analyses.models.input.input.Input

definition

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

definition_id
get_type() → django_analyses.models.input.types.input_types.InputTypes
input_ptr

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

input_ptr_id
value

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

django_analyses.models.input.types.directory_input module

class django_analyses.models.input.types.directory_input.DirectoryInput(id, run, input_ptr, value, definition)

Bases: django_analyses.models.input.input.Input

default_output_directory
definition

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

definition_id
fix_output_path() → str
get_type() → django_analyses.models.input.types.input_types.InputTypes
input_ptr

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

input_ptr_id
pre_save() → None

If this input class’s value is a ForeignKey field, fix it in cases it is provided as int (the instance’s primary key).

Note

This method may be overridden by subclasses to implement custom functionality before saving. However, be sure to include:

super().pre_save()

within your custom function.

required_path
value

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

django_analyses.models.input.types.file_input module

class django_analyses.models.input.types.file_input.FileInput(id, run, input_ptr, value, definition)

Bases: django_analyses.models.input.input.Input

definition

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

definition_id
get_type() → django_analyses.models.input.types.input_types.InputTypes
input_ptr

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

input_ptr_id
value

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

django_analyses.models.input.types.float_input module

class django_analyses.models.input.types.float_input.FloatInput(id, run, input_ptr, numberinput_ptr, value, definition)

Bases: django_analyses.models.input.types.number_input.NumberInput

definition

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

definition_id
get_type() → django_analyses.models.input.types.input_types.InputTypes
numberinput_ptr

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

numberinput_ptr_id
value

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

django_analyses.models.input.types.input_types module

class django_analyses.models.input.types.input_types.InputTypes

Bases: django_analyses.utils.choice_enum.ChoiceEnum

An enumeration.

BLN = 'Boolean'
DIR = 'Directory'
FIL = 'File'
FLT = 'Float'
INT = 'Integer'
LST = 'List'
STR = 'String'

django_analyses.models.input.types.integer_input module

class django_analyses.models.input.types.integer_input.IntegerInput(id, run, input_ptr, numberinput_ptr, value, definition)

Bases: django_analyses.models.input.types.number_input.NumberInput

definition

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

definition_id
get_type() → django_analyses.models.input.types.input_types.InputTypes
numberinput_ptr

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

numberinput_ptr_id
value

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

django_analyses.models.input.types.list_input module

class django_analyses.models.input.types.list_input.ListInput(id, run, input_ptr, value, definition)

Bases: django_analyses.models.input.input.Input

definition

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

definition_id
expected_type
expected_type_definition
get_argument_value()

Returns the input’s value after applying any manipulations specified by the associated definition. This method is used to bridge database-compatible values with non-database-compatible values required by interfaces.

Returns:Input value as expected by the interface
Return type:Any
get_html_repr(index: int) → str
get_type() → django_analyses.models.input.types.input_types.InputTypes
input_ptr

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

input_ptr_id

If this input’s definition points to a related model’s field, returns the related instance (i.e. the instance in which the field’s value is this input’s value).

Returns:related instance
Return type:Any
raise_incorrect_type_error() → None
raise_max_length_error() → None
raise_min_length_error() → None
raise_not_list_error() → None
valid_elements
valid_max_length
valid_min_length
validate() → None

Run any custom validations before saving the model.

Note

This method may be overridden by subclasses to implement custom functionality before saving. However, be sure to include:

super().pre_save()

within your custom function.

classmethod validate_element_types(value: list, expected_type: type) → bool
validate_max_length() → bool
validate_min_length() → bool
value

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

django_analyses.models.input.types.number_input module

class django_analyses.models.input.types.number_input.NumberInput(id, run, input_ptr)

Bases: django_analyses.models.input.input.Input

floatinput

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Place.restaurant is a ReverseOneToOneDescriptor instance.

input_ptr

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

input_ptr_id
integerinput

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Place.restaurant is a ReverseOneToOneDescriptor instance.

raise_max_value_error() → None
raise_min_value_error() → None
valid_max_value
valid_min_value
validate() → None

Run any custom validations before saving the model.

Note

This method may be overridden by subclasses to implement custom functionality before saving. However, be sure to include:

super().pre_save()

within your custom function.

validate_max_value() → bool
validate_min_value() → bool

django_analyses.models.input.types.string_input module

class django_analyses.models.input.types.string_input.StringInput(id, run, input_ptr, value, definition)

Bases: django_analyses.models.input.input.Input

default_output_directory
default_value_formatting_dict
definition

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

definition_id
fix_output_path() → str
get_default_value_formatting_dict() → dict
get_type() → django_analyses.models.input.types.input_types.InputTypes
input_ptr

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

input_ptr_id
pre_save() → None

If this input class’s value is a ForeignKey field, fix it in cases it is provided as int (the instance’s primary key).

Note

This method may be overridden by subclasses to implement custom functionality before saving. However, be sure to include:

super().pre_save()

within your custom function.

raise_invalid_choice_error() → None
raise_max_length_error() → None
raise_min_length_error() → None
required_path
valid_choice
valid_max_length
valid_min_length
validate() → None

Run any custom validations before saving the model.

Note

This method may be overridden by subclasses to implement custom functionality before saving. However, be sure to include:

super().pre_save()

within your custom function.

validate_from_choices() → bool
validate_max_length() → bool
validate_min_length() → bool
value

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

Module contents