Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

validate including the key values in another list

See original GitHub issue

Issue Description

I’m looking to ways to validate that certain keys are included in a predefined list, an example can be

---
teachers:
  - Mike
  - Anna
  - Smith

And I want to add students where each student need to have a teacher str value which should be part of the given list above

---
students:
  - name: studentA
    teacher: Mike
  - name: StudentB
    teacher: NonExistingTeacher

going through the docs and examples it is not clear if this is even possible to do using yamale

Issue Analytics

State:
Created 3 years ago
Comments:5 (2 by maintainers)

Top GitHub Comments

1reaction

modsaidcommented, Jan 26, 2021

Thank you @mildebrandt @mechie 🙏

1reaction

mechiecommented, Oct 18, 2020

If the list of teachers can be defined within the schema, then you could rewrite it as an enum (e.g. teacher: enum('Mike', 'Anna', 'Smith')), that will work with yamale as-is.

So the schema would look like one of the two below:

students: list(include('student'))
---
student:
  name: str()
  teacher: enum('Mike', 'Anna', 'Smith')

students: list(include('student'))
---
student:
  name: str()
  teacher: enum(
    'Mike',
    'Anna',
    'Smith'
    )

Otherwise (if it must be formatted as a list, and/or will be provided as part of the file to validate) there’s a lot of routes available, but they’d require tinkering:

Expand or inherit from the Enum validator to accept include() statements that correspond to lists of primitives (this sounds useful in general).
Override multiple places (probably Schema._validate, and adding a custom validator) to handle loading in the teachers from the data before/during validation.
Write a script that runs before yamale and fills in the teacher enum using a list from the data (which could be validated beforehand, something like yamale(doc, first schema) -> script(doc, incomplete second schema) -> yamale(doc, second schema)).