kwcoco.coco_schema

CommandLine

python -m kwcoco.coco_schema
xdoctest -m kwcoco.coco_schema __doc__

Example

>>> import kwcoco
>>> from kwcoco.coco_schema import COCO_SCHEMA
>>> import jsonschema
>>> dset = kwcoco.CocoDataset.demo('shapes1')
>>> # print('dset.dataset = {}'.format(ub.repr2(dset.dataset, nl=2)))
>>> COCO_SCHEMA.validate(dset.dataset)
>>> try:
>>>     jsonschema.validate(dset.dataset, schema=COCO_SCHEMA)
>>> except jsonschema.exceptions.ValidationError as ex:
>>>     vali_ex = ex
>>>     print('ex = {!r}'.format(ex))
>>>     raise
>>> except jsonschema.exceptions.SchemaError as ex:
>>>     print('ex = {!r}'.format(ex))
>>>     schema_ex = ex
>>>     print('schema_ex.instance = {}'.format(ub.repr2(schema_ex.instance, nl=-1)))
>>>     raise
>>> # Test the multispectral image defintino
>>> import copy
>>> dataset = dset.copy().dataset
>>> img = dataset['images'][0]
>>> img.pop('file_name')
>>> import pytest
>>> with pytest.raises(jsonschema.ValidationError):
>>>     COCO_SCHEMA.validate(dataset)
>>> import pytest
>>> img['auxiliary'] = [{'file_name': 'foobar'}]
>>> with pytest.raises(jsonschema.ValidationError):
>>>     COCO_SCHEMA.validate(dataset)
>>> img['name'] = 'aux-only images must have a name'
>>> COCO_SCHEMA.validate(dataset)

Module Contents

Functions

deprecated(*args)

TUPLE(*args, **kw)

Attributes

elem

ALLOF

ANY

ANYOF

ARRAY

BOOLEAN

INTEGER

NOT

NULL

NUMBER

OBJECT

ONEOF

STRING

UUID

PATH

KWCOCO_KEYPOINT

KWCOCO_POLYGON

ORIG_COCO_KEYPOINTS

KWCOCO_KEYPOINTS

KEYPOINTS

ORIG_COCO_POLYGON

POLYGON

RUN_LENGTH_ENCODING

BBOX

SEGMENTATION

CATEGORY

KEYPOINT_CATEGORY

VIDEO

CHANNELS

IMAGE

ANNOTATION

COCO_SCHEMA

kwcoco.coco_schema.deprecated(*args)[source]
kwcoco.coco_schema.TUPLE(*args, **kw)[source]
kwcoco.coco_schema.elem[source]
kwcoco.coco_schema.ALLOF[source]
kwcoco.coco_schema.ANY[source]
kwcoco.coco_schema.ANYOF[source]
kwcoco.coco_schema.ARRAY[source]
kwcoco.coco_schema.BOOLEAN[source]
kwcoco.coco_schema.INTEGER[source]
kwcoco.coco_schema.NOT[source]
kwcoco.coco_schema.NULL[source]
kwcoco.coco_schema.NUMBER[source]
kwcoco.coco_schema.OBJECT[source]
kwcoco.coco_schema.ONEOF[source]
kwcoco.coco_schema.STRING[source]
kwcoco.coco_schema.UUID[source]
kwcoco.coco_schema.PATH[source]
kwcoco.coco_schema.KWCOCO_KEYPOINT[source]
kwcoco.coco_schema.KWCOCO_POLYGON[source]
kwcoco.coco_schema.ORIG_COCO_KEYPOINTS[source]
kwcoco.coco_schema.KWCOCO_KEYPOINTS[source]
kwcoco.coco_schema.KEYPOINTS[source]
kwcoco.coco_schema.ORIG_COCO_POLYGON[source]
kwcoco.coco_schema.POLYGON[source]
kwcoco.coco_schema.RUN_LENGTH_ENCODING[source]
kwcoco.coco_schema.BBOX[source]
kwcoco.coco_schema.SEGMENTATION[source]
kwcoco.coco_schema.CATEGORY[source]
kwcoco.coco_schema.KEYPOINT_CATEGORY[source]
kwcoco.coco_schema.VIDEO[source]
kwcoco.coco_schema.CHANNELS[source]
kwcoco.coco_schema.IMAGE[source]
kwcoco.coco_schema.ANNOTATION[source]
kwcoco.coco_schema.COCO_SCHEMA[source]