Skip to content

Closes OPEN-3851 Add character limit validation to column / feature n… #99

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 13, 2023
Merged

Closes OPEN-3851 Add character limit validation to column / feature n… #99

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 17 additions & 8 deletions openlayer/schemas.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,15 @@
error="`language` of the dataset is not in the ISO 639-1 (alpha-2 code) format.",
)

# -------------------------- Column name validations ------------------------- #
COLUMN_NAME_VALIDATION_LIST = [
ma.validate.Length(
min=1,
max=60,
),
COLUMN_NAME_REGEX,
]

# ---------------------------------- Schemas --------------------------------- #
class BaselineModelSchema(ma.Schema):
"""Schema for baseline models."""
Expand All @@ -42,13 +51,13 @@ class DatasetSchema(ma.Schema):
"""Schema for datasets."""

categoricalFeatureNames = ma.fields.List(
ma.fields.Str(validate=COLUMN_NAME_REGEX),
ma.fields.Str(validate=COLUMN_NAME_VALIDATION_LIST),
allow_none=True,
load_default=[],
)
classNames = ma.fields.List(ma.fields.Str(), required=True)
columnNames = ma.fields.List(
ma.fields.Str(validate=COLUMN_NAME_REGEX),
ma.fields.Str(validate=COLUMN_NAME_VALIDATION_LIST),
required=True,
)
label = ma.fields.Str(
Expand All @@ -61,11 +70,11 @@ class DatasetSchema(ma.Schema):
required=True,
)
featureNames = ma.fields.List(
ma.fields.Str(validate=COLUMN_NAME_REGEX),
ma.fields.Str(validate=COLUMN_NAME_VALIDATION_LIST),
load_default=[],
)
labelColumnName = ma.fields.Str(
validate=COLUMN_NAME_REGEX,
validate=COLUMN_NAME_VALIDATION_LIST,
required=True,
)
language = ma.fields.Str(
Expand All @@ -74,13 +83,13 @@ class DatasetSchema(ma.Schema):
)
metadata = ma.fields.Dict(allow_none=True, load_default={})
predictionsColumnName = ma.fields.Str(
validate=COLUMN_NAME_REGEX,
validate=COLUMN_NAME_VALIDATION_LIST,
allow_none=True,
load_default=None,
)
sep = ma.fields.Str(load_default=",")
textColumnName = ma.fields.Str(
validate=COLUMN_NAME_REGEX,
validate=COLUMN_NAME_VALIDATION_LIST,
allow_none=True,
)

Expand All @@ -97,7 +106,7 @@ class ModelSchema(ma.Schema):
"""Schema for models with artifacts (i.e., model_package)."""

categoricalFeatureNames = ma.fields.List(
ma.fields.Str(validate=COLUMN_NAME_REGEX),
ma.fields.Str(validate=COLUMN_NAME_VALIDATION_LIST),
load_default=[],
)
classNames = ma.fields.List(
Expand All @@ -112,7 +121,7 @@ class ModelSchema(ma.Schema):
),
)
featureNames = ma.fields.List(
ma.fields.Str(validate=COLUMN_NAME_REGEX),
ma.fields.Str(validate=COLUMN_NAME_VALIDATION_LIST),
allow_none=True,
load_default=[],
)
Expand Down