A schema definition and validation library
Project description
schema-markdown
schema-markdown is a schema definition and validation library.
Links
Define a Schema
Schemas are defined using the Schema Markdown language, which is parsed by the parse_schema_markdown function. For example:
from schema_markdown import parse_schema_markdown
model_types = parse_schema_markdown('''\
# An aggregate numerical operation
struct Aggregation
# The aggregation function - default is "Sum"
optional AggregationFunction aggregation
# The numbers to aggregate on
int[len > 0] numbers
# An aggregation function
enum AggregationFunction
Average
Sum
''')
Validate using a Schema
To validate an object using the schema, use the validate_type function. For example:
from schema_markdown import validate_type
validate_type(model_types, 'Aggregation', {'numbers': [1, 2, '3', 4]})
{'numbers': [1, 2, 3, 4]}
Notice that the numerical input '3' above is type-massaged to the integer 3 by validation.
Validation fails if the object does not match the schema:
from schema_markdown import ValidationError
try:
validate_type(model_types, 'Aggregation', {'numbers': [1, 2, 'asdf', 4]})
except ValidationError as exc:
str(exc)
'Invalid value "asdf" (type "str") for member "numbers.2", expected type "int"'
Validation also fails if a member constraint is violated:
try:
validate_type(model_types, 'Aggregation', {'numbers': []})
except ValidationError as exc:
str(exc)
'Invalid value [] (type "list") for member "numbers", expected type "array" [len > 0]'
validate_type validates JSON-like values. In this Python implementation, date values are
datetime.date, datetime values are datetime.datetime, and uuid strings remain strings.
datetime.date, datetime.datetime, and uuid.UUID inputs are left unchanged. See
The Schema Markdown Language - Built-in Types
for accepted JSON input formats and host-runtime behavior.
Schema Documentation
You can document a schema with BareScript's schemaDoc application running on the MarkdownUp application.
If your
type model JSON file
or
Schema Markdown file
is publicly visible, you can use the BareScript model application with the var.vURL query argument:
Note: Schema Markdown files use the .smd file extension.
Self-Hosting Schema Documentation
You can host the schemaDoc application yourself by adding a schemaDoc HTML stub:
<!DOCTYPE html>
<html lang="en">
<head>
<title>MarkdownUp</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="https://craigahobbs.github.io/markdown-up/app.css">
<link rel="preload" href="https://craigahobbs.github.io/markdown-up/bare-script/static/markdown.css" as="style">
<link rel="modulepreload" href="https://craigahobbs.github.io/markdown-up/lib/appImports.js" as="script">
</head>
<script type="module">
import {MarkdownUp} from 'https://craigahobbs.github.io/markdown-up/lib/appImports.js';
const app = new MarkdownUp(window, {
'markdownText': `\
~~~markdown-script
include <schemaDoc.bare>
schemaDocMain('model.json', 'My Model')
~~~
`
});
app.run();
</script>
</html>
To view locally, start a local static web server:
python3 -m http.server
Development
This package is developed using python-build. It was started using python-template as follows:
template-specialize python-template/template/ schema-markdown/ -k package schema-markdown -k name 'Craig A. Hobbs' -k email 'craigahobbs@gmail.com' -k github 'craigahobbs' -k nomain 1
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file schema_markdown-1.3.0.tar.gz.
File metadata
- Download URL: schema_markdown-1.3.0.tar.gz
- Upload date:
- Size: 18.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
024a58f33147ee04593995837ce96267636c8e63ee5898c3e0a352eba836f8a4
|
|
| MD5 |
de68e8b652a71905740b147e5529bd11
|
|
| BLAKE2b-256 |
010f865a19f663508d63352554c54a77afbb251ca5875fcd0ce6c85cd00fe67f
|
File details
Details for the file schema_markdown-1.3.0-py3-none-any.whl.
File metadata
- Download URL: schema_markdown-1.3.0-py3-none-any.whl
- Upload date:
- Size: 18.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0b5cfa85308333f8819309ec54756499075944d3efe4e557d04534e657801fa3
|
|
| MD5 |
0963aa2f2f53c5673bbfc0ab0df37a8e
|
|
| BLAKE2b-256 |
63629fca01e8b46484710df3d4dcd5909e739eefa7912f543e1a83b5aa462e17
|
