Validation Mixin

ValidationMixin

The ValidationMixin class enables plugins to perform custom validation of objects within the database.

Any of the methods described below can be implemented in a custom plugin to provide functionality as required.

More Info

For more information on any of the methods described below, refer to the InvenTree source code. A working example is available as a starting point.

Multi Plugin Support

It is possible to have multiple plugins loaded simultaneously which support validation methods. For example when validating a field, if one plugin returns a null value (None) then the next plugin (if available) will be queried.

Model Deletion

Any model which inherits the PluginValidationMixin class is exposed to the plugin system for custom deletion validation. Before the model is deleted from the database, it is first passed to the plugin ecosystem to check if it really should be deleted.

A custom plugin may implement the validate_model_deletion method to perform custom validation on the model instance before it is deleted.

Run custom validation when a model instance is being deleted.

This method is called when a model instance is being deleted. It allows the plugin to raise a ValidationError if the instance cannot be deleted.

Parameters:

Name	Type	Description	Default
instance	Model	The model instance to validate	required

Returns:

Name	Type	Description
None	None	or True (refer to class docstring)

Raises:

Type	Description
ValidationError	if the instance cannot be deleted

Source code in src/backend/InvenTree/plugin/base/integration/ValidationMixin.py

def validate_model_deletion(self, instance: Model) -> None:
    """Run custom validation when a model instance is being deleted.

    This method is called when a model instance is being deleted.
    It allows the plugin to raise a ValidationError if the instance cannot be deleted.

    Arguments:
        instance: The model instance to validate

    Returns:
        None: or True (refer to class docstring)

    Raises:
        ValidationError: if the instance cannot be deleted
    """
    return None

Model Validation

Any model which inherits the PluginValidationMixin mixin class is exposed to the plugin system for custom validation. Before the model is saved to the database (either when created, or updated), it is first passed to the plugin ecosystem for validation.

Any plugin which inherits the ValidationMixin can implement the validate_model_instance method, and run a custom validation routine.

Run custom validation on a database model instance.

This method is called when a model instance is being validated. It allows the plugin to raise a ValidationError on any field in the model.

Parameters:

Name	Type	Description	Default
instance	Model	The model instance to validate	required
deltas	dict	A dictionary of field names and updated values (if the instance is being updated)	None

Returns:

Name	Type	Description
None	None	or True (refer to class docstring)

Raises:

Type	Description
ValidationError	if the instance is invalid

Source code in src/backend/InvenTree/plugin/base/integration/ValidationMixin.py

def validate_model_instance(self, instance: Model, deltas: dict = None) -> None:
    """Run custom validation on a database model instance.

    This method is called when a model instance is being validated.
    It allows the plugin to raise a ValidationError on any field in the model.

    Arguments:
        instance: The model instance to validate
        deltas: A dictionary of field names and updated values (if the instance is being updated)

    Returns:
        None: or True (refer to class docstring)

    Raises:
        ValidationError: if the instance is invalid
    """
    return None

Error Messages

Any error messages must be raised as a ValidationError. The ValidationMixin class provides the raise_error method, which is a simple wrapper method which raises a ValidationError

Instance Errors

To indicate an instance validation error (i.e. the validation error applies to the entire model instance), the body of the error should be either a string, or a list of strings.

Field Errors

To indicate a field validation error (i.e. the validation error applies only to a single field on the model instance), the body of the error should be a dict, where the key(s) of the dict correspond to the model fields.

Note that an error can be which corresponds to multiple model instance fields.

Example Plugin

Presented below is a simple working example for a plugin which implements the validate_model_instance method:

from plugin import InvenTreePlugin
from plugin.mixins import ValidationMixin

import part.models


class MyValidationMixin(Validationixin, InvenTreePlugin):
    """Custom validation plugin."""

    def validate_model_instance(self, instance, deltas=None):
        """Custom model validation example.

        - A part name and category name must have the same starting letter
        - A PartCategory description field cannot be shortened after it has been created
        """

        if isinstance(instance, part.models.Part):
            if category := instance.category:
                if category.name[0] != part.name[0]:
                    self.raise_error({
                        "name": "Part name and category name must start with the same letter"
                    })

        if isinstance(instance, part.models.PartCategory):
            if deltas and 'description' in deltas:
                d_new = deltas['description']['new']
                d_old = deltas['description']['old']

                if len(d_new) < len(d_old):
                    self.raise_error({
                        "description": "Description cannot be shortened"
                    })

Field Validation

In addition to the general purpose model instance validation routine provided above, the following fields support custom validation routines:

Part Name

By default, part names are not subject to any particular naming conventions or requirements. However if custom validation is required, the validate_part_name method can be implemented to ensure that a part name conforms to a required convention.

If the custom method determines that the part name is objectionable, it should throw a ValidationError which will be handled upstream by parent calling methods.

Part IPN

Validation of the Part IPN (Internal Part Number) field is exposed to custom plugins via the validate_part_IPN method. Any plugins which extend the ValidationMixin class can implement this method, and raise a ValidationError if the IPN value does not match a required convention.

Part Parameter Values

Part parameters can also have custom validation rules applied, by implementing the validate_part_parameter method. A plugin which implements this method should raise a ValidationError with an appropriate message if the part parameter value does not match a required convention.

Batch Codes

Batch codes can be generated and/or validated by custom plugins.

The validate_batch_code method allows plugins to raise an error if a batch code input by the user does not meet a particular pattern.

The generate_batch_code method can be implemented to generate a new batch code, based on a set of provided information.

Serial Numbers

Requirements for serial numbers can vary greatly depending on the application. Rather than attempting to provide a "one size fits all" serial number implementation, InvenTree allows custom serial number schemes to be implemented via plugins.

The default InvenTree serial numbering system uses a simple algorithm to validate and increment serial numbers. More complex behaviors can be implemented using the ValidationMixin plugin class and the following custom methods:

Serial Number Validation

Custom serial number validation can be implemented using the validate_serial_number method. A proposed serial number is passed to this method, which then has the opportunity to raise a ValidationError to indicate that the serial number is not valid.

Example

A plugin which requires all serial numbers to be valid hexadecimal values may implement this method as follows:

def validate_serial_number(self, serial: str, part: Part):
    """Validate the supplied serial number

    Arguments:
        serial: The proposed serial number (string)
        part: The Part instance for which this serial number is being validated
    """

    try:
        # Attempt integer conversion
        int(serial, 16)
    except ValueError:
        raise ValidationError("Serial number must be a valid hex value")

Serial Number Sorting

While InvenTree supports arbitrary text values in the serial number fields, behind the scenes it attempts to "coerce" these values into an integer representation for more efficient sorting.

A custom plugin can implement the convert_serial_to_int method to determine how a particular serial number is converted to an integer representation.

Not Required

If this method is not implemented, or the serial number cannot be converted to an integer, then the sorting algorithm falls back to the text (string) value

Serial Number Incrementing

A core component of the InvenTree serial number system is the ability to increment serial numbers - to determine the next serial number value in a sequence.

For custom serial number schemes, it is important to provide a method to generate the next serial number given a current value. The increment_serial_number method can be implemented by a plugin to achieve this.

Invalid Increment

If the provided number cannot be incremented (or an error occurs) the method should return None

Example

Continuing with the hexadecimal example as above, the method may be implemented as follows:

def increment_serial_number(self, serial: str):
    """Provide the next hexadecimal number in sequence"""

    try:
        val = int(serial, 16) + 1
        val = hex(val).upper()[2:]
    except ValueError:
        val = None

    return val

Sample Plugin

A sample plugin which implements custom validation routines is provided in the InvenTree source code:

A sample plugin class for demonstrating custom validation functions.

Simple of examples of custom validator code.

Source code in src/backend/InvenTree/plugin/samples/integration/validation_sample.py

class SampleValidatorPlugin(SettingsMixin, ValidationMixin, InvenTreePlugin):
    """A sample plugin class for demonstrating custom validation functions.

    Simple of examples of custom validator code.
    """

    NAME = 'SampleValidator'
    SLUG = 'validator'
    TITLE = 'Sample Validator Plugin'
    DESCRIPTION = 'A sample plugin for demonstrating custom validation functionality'
    VERSION = '0.3.0'

    SETTINGS = {
        'ILLEGAL_PART_CHARS': {
            'name': 'Illegal Part Characters',
            'description': 'Characters which are not allowed to appear in Part names',
            'default': '!@#$%^&*()~`',
        },
        'IPN_MUST_CONTAIN_Q': {
            'name': 'IPN Q Requirement',
            'description': 'Part IPN field must contain the character Q',
            'default': False,
            'validator': bool,
        },
        'SERIAL_MUST_BE_PALINDROME': {
            'name': 'Palindromic Serials',
            'description': 'Serial numbers must be palindromic',
            'default': False,
            'validator': bool,
        },
        'SERIAL_MUST_MATCH_PART': {
            'name': 'Serial must match part',
            'description': 'First letter of serial number must match first letter of part name',
            'default': False,
            'validator': bool,
        },
        'BATCH_CODE_PREFIX': {
            'name': 'Batch prefix',
            'description': 'Required prefix for batch code',
            'default': 'B',
        },
        'BOM_ITEM_INTEGER': {
            'name': 'Integer Bom Quantity',
            'description': 'Bom item quantity must be an integer',
            'default': False,
            'validator': bool,
        },
    }

    def validate_model_instance(self, instance, deltas=None):
        """Run validation against any saved model.

        - Check if the instance is a BomItem object
        - Test if the quantity is an integer
        """
        import part.models

        # Print debug message to console (intentional)
        print('Validating model instance:', instance.__class__, f'<{instance.pk}>')

        if isinstance(instance, part.models.BomItem):
            if self.get_setting('BOM_ITEM_INTEGER'):
                if float(instance.quantity) != int(instance.quantity):
                    self.raise_error({
                        'quantity': 'Bom item quantity must be an integer'
                    })

        if isinstance(instance, part.models.Part):
            # If the part description is being updated, prevent it from being reduced in length

            if deltas and 'description' in deltas:
                old_desc = deltas['description']['old']
                new_desc = deltas['description']['new']

                if len(new_desc) < len(old_desc):
                    self.raise_error({
                        'description': 'Part description cannot be shortened'
                    })

    def validate_part_name(self, name: str, part):
        """Custom validation for Part name field.

        Rules:
        - Name must be shorter than the description field
        - Name cannot contain illegal characters

        These examples are silly, but serve to demonstrate how the feature could be used.
        """
        if len(part.description) < len(name):
            self.raise_error('Part description cannot be shorter than the name')

        illegal_chars = self.get_setting('ILLEGAL_PART_CHARS')

        for c in illegal_chars:
            if c in name:
                self.raise_error(f"Illegal character in part name: '{c}'")

    def validate_part_ipn(self, ipn: str, part):
        """Validate part IPN.

        These examples are silly, but serve to demonstrate how the feature could be used
        """
        if self.get_setting('IPN_MUST_CONTAIN_Q') and 'Q' not in ipn:
            self.raise_error("IPN must contain 'Q'")

    def validate_part_parameter(self, parameter, data):
        """Validate part parameter data.

        These examples are silly, but serve to demonstrate how the feature could be used
        """
        if parameter.template.name.lower() in ['length', 'width']:
            d = int(data)
            if d >= 100:
                self.raise_error('Value must be less than 100')

    def validate_serial_number(self, serial: str, part):
        """Validate serial number for a given StockItem.

        These examples are silly, but serve to demonstrate how the feature could be used
        """
        if self.get_setting('SERIAL_MUST_BE_PALINDROME'):
            if serial != serial[::-1]:
                self.raise_error('Serial must be a palindrome')

        if self.get_setting('SERIAL_MUST_MATCH_PART'):
            # Serial must start with the same letter as the linked part, for some reason
            if serial[0] != part.name[0]:
                self.raise_error('Serial number must start with same letter as part')

    def validate_batch_code(self, batch_code: str, item):
        """Ensure that a particular batch code meets specification.

        These examples are silly, but serve to demonstrate how the feature could be used
        """
        prefix = self.get_setting('BATCH_CODE_PREFIX')

        if len(batch_code) > 0 and prefix and not batch_code.startswith(prefix):
            self.raise_error(f"Batch code must start with '{prefix}'")

    def generate_batch_code(self, **kwargs):
        """Generate a new batch code."""
        now = datetime.now()
        batch = f'SAMPLE-BATCH-{now.year}:{now.month}:{now.day}'

        # If a Part instance is provided, prepend the part name to the batch code
        if part := kwargs.get('part', None):
            batch = f'{part.name}-{batch}'

        # If a Build instance is provided, prepend the build number to the batch code
        if build := kwargs.get('build_order', None):
            batch = f'{build.reference}-{batch}'

        return batch