sampotools.api.save_asd

sampotools.api.save_asd(asd_object, file_path)

Saves an ASD (Attribute Schema Description) Object to ASD File.

Parameters
asd_objectOrderedDict

ASD Object to save.

file_pathstr

ASD file path to be saved.

Raises
ValidationError
  • If asd_object is not OrderedDict.

  • If file_path is not str.

Examples

>>> from collections import OrderedDict
>>> from sampotools.api import save_asd
>>> asd = OrderedDict((('_sid', {'scale': 'INTEGER'}),
...                    ('col1', {'scale': 'INTEGER'}),
...                    ('_datetime', {'scale': 'DATE'}),
...                    ('col3', {'scale': 'DATE'}),
...                    ('col4', {'scale': 'REAL'}),
...                    ('col5', {'scale': 'NOMINAL', 'domain': ['aaa', 'bbb', 'ccc']}),
...                    ('col6', {'scale': 'NOMINAL', 'domain': ['ccc', 'ddd']}),
...                    ('col7', {'scale': 'DATE'})))
>>> save_asd(asd, './output_dir/my_data.asd')
  • my_data.asd:

    _sid: {scale: INTEGER}
    col1: {scale: INTEGER}
    _datetime: {scale: DATE}
    col3: {scale: DATE}
    col4: {scale: REAL}
    col5: {domain: [aaa, bbb, ccc], scale: NOMINAL}
    col6: {domain: [ccc, ddd], scale: NOMINAL}
    col7: {scale: DATE}