Example on how to add multiple custom validators

[ryanmerolle]

First of all, thanks so much for the amazing tool and library!

My goal is to publish a ton of validators for network engineers to use.

With regards to defining custom validators, I’m sort of lost how to to add ALL my validators to be included with the base validation. I can figure out how to add one validator but not many. I’m just looking for an example beyond what’s in the docs.

My current set of validators include:

from jsonschema.exceptions import ValidationError

ASN_MIN = 0
ASN_MAX_LEGACY = 65535
ASN_MAX = 4294967295


def asn_to_int(instance) -> int:
    """Converts an ASN in dot notation to its integer representation."""
    asn_error = f"'{instance}' is not a valid ASN."
    if "." not in instance:
        try:
            return int(instance)
        except ValueError:
            yield ValidationError(asn_error)

    asn_parts = instance.split(".")
    if len(asn_parts) != 2:
        yield ValidationError(asn_error)

    try:
        high_part, low_part = int(asn_parts[0]), int(asn_parts[1])
    except ValueError:
        yield ValidationError(asn_error)

    if not (ASN_MIN <= high_part <= ASN_MAX_LEGACY) or not (
        ASN_MIN <= low_part <= ASN_MAX_LEGACY
    ):
        yield ValidationError(asn_error)


# Custom ASN Validators
def is_public(instance) -> None:
    """Returns True if the ASN is a public/global ASN, False otherwise."""
    asn_int = asn_to_int(instance)
    if not (ASN_MIN <= asn_int <= 23455 or 23457 <= asn_int <= 64495 or 131072 <= asn_int <= 4199999999):
        yield ValidationError(f"'{instance}' is not a public ASN.")


def is_private(instance) -> None:
    """Returns True if the ASN is a private ASN, False otherwise."""
    asn_int = asn_to_int(instance)
    if not (64512 <= asn_int <= 65534 or 4200000000 <= asn_int <= 4294967294):
        yield ValidationError(f"'{instance}' is not a private ASN.")


def is_reserved(instance) -> None:
    """Returns True if the ASN is a reserved ASN, False otherwise."""
    asn_int = asn_to_int(instance)
    if not (asn_int in {ASN_MIN, 23456, ASN_MAX_LEGACY} or 65552 <= asn_int <= 131071 or asn_int == ASN_MAX):
        yield ValidationError(f"'{instance}' is not a reserved ASN.")


def is_documentation(instance) -> None:
    """Returns True if the ASN is a documentation ASN, False otherwise."""
    asn_int = asn_to_int(instance)
    if not (64496 <= asn_int <= 64511 or 65536 <= instance <= 65551):
        yield ValidationError(f"'{instance}' is not a documentation ASN.")


def is_2byte_asn(instance) -> None:
    """Returns True if the ASN is a 2-byte ASN, False otherwise."""
    asn_int = asn_to_int(instance)
    if not (ASN_MIN <= asn_int <= ASN_MAX_LEGACY):
        yield ValidationError(f"'{instance}' is not a 2-byte ASN.")


def is_4byte_asn(instance) -> None:
    """Returns True if the ASN is a 4-byte ASN, False otherwise."""
    asn_int = asn_to_int(instance)
    if not (ASN_MIN <= asn_int <= ASN_MAX):
        yield ValidationError(f"'{instance}' is not a 4-byte ASN.")


def is_asn(instance) -> None:
    """Returns True if the ASN is a valid ASN, False otherwise."""
    asn_int = asn_to_int(instance)
    if not (ASN_MIN <= asn_to_int(asn_int) <= ASN_MAX):
        yield ValidationError(f"'{instance}' is not a valid ASN.")


def is_asn_dot_notation(instance) -> None:
    """Returns True if the ASN is a valid ASN in dot notation, False otherwise."""
    asn_int = asn_to_int(instance)
    if "." in instance and isinstance(asn_int, int):
        yield ValidationError(f"'{instance}' is not a valid ASN in dot notation.")


def is_asn_int_notation(instance) -> None:
    """Returns True if the ASN is a valid ASN in integer notation, False otherwise."""
    if instance == asn_to_int(instance):
        yield ValidationError(f"'{instance}' is not a valid ASN in integer notation.")


#from jsonschema import Draft7Validator
#from jsonschema.validators import extend
## Integrate custom validators to jsonschema's Draft7
#asn_validators = {
#    "public-asn": is_public,
#    "private-asn": is_private,
#    "reserved-asn": is_reserved,
#    "documentation-asn": is_documentation,
#    "2byte-asn": is_2byte_asn,
#    "4byte-asn": is_4byte_asn,
#    "asn": is_asn,
#    "asn-dot-notation": is_asn_dot_notation,
#    "asn-int-notatiaon": is_asn_int_notation,
#}
#ASNValidator = extend(Draft7Validator, validators=asn_validators)

[Julian]

Hey, thanks for the kind words. I haven't tried to run it, but that initially looks fine from just scanning it. What issue are you having?

[ryanmerolle]

@Julian thanks for even scanning the validators. My question is more on how can I add all those validators for use during validation of dataset vs a schema. I know how to add one validtor. The pseudo code I commented out does not seem valid.

[Julian]

Can you elaborate? What schema do you have which uses your custom validators, what data are you validating against it, what result do you get, and what result do you expect?

The only obvious thing from your example is that your validator functions have the wrong signature -- they need to take exactly 4 arguments -- a validator instance (of ASNValidator), the keyword's value in a schema, the instance, and the full schema. I.e. if you write the schema {"public-asn": 37} and validate some instance "foobar", you'll get passed a validator object of type ASNValidator, the value is 37, the instance is "foobar"and the schema is the full {"public-asn": 37}.