Validators

Validator functions in the craft_platforms.validators module can be used as standalone functional validators or in combination with Pydantic to validate parts of a platform.

craft_platforms.validators.validate_strict_platform_name(name, *, allow_app_characters=True)

Validate a strictly-defined platform name.

Parameters:

• name (str) – the platform name to validate.

• allow_app_characters (bool, default: True) – Whether to allow characters that are reserved for use by applications. If False, an app-generated platform name can raise an error.

Returns:

str – the platform name, if valid.

Raises:

InvalidPlatformName if the platform name is invalid.