fields package

Submodules

fields.test_deprecated module

class fields.test_deprecated.OptionSchema(extra=None, only=(), exclude=(), prefix=u'', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: argschema.schemas.ArgSchema

This schema is designed to be a schema_type for an ArgSchemaParser object
OptionSchema
key description default field_type json_type
a one of 1,2,3 (REQUIRED) OptionList ?
log_level set the logging level of the module ERROR LogLevel unicode
opts = <marshmallow.schema.SchemaOpts object>
fields.test_deprecated.test_bad_option()[source]
fields.test_deprecated.test_option_list()[source]

fields.test_files module

class fields.test_files.BasicInputDir(extra=None, only=(), exclude=(), prefix=u'', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: argschema.schemas.ArgSchema

This schema is designed to be a schema_type for an ArgSchemaParser object
BasicInputDir
key description default field_type json_type
input_dir a simple file (REQUIRED) InputDir unicode
log_level set the logging level of the module ERROR LogLevel unicode
opts = <marshmallow.schema.SchemaOpts object>
class fields.test_files.BasicInputFile(extra=None, only=(), exclude=(), prefix=u'', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: argschema.schemas.ArgSchema

This schema is designed to be a schema_type for an ArgSchemaParser object
BasicInputFile
key description default field_type json_type
log_level set the logging level of the module ERROR LogLevel unicode
input_file a simple file (REQUIRED) InputFile unicode
opts = <marshmallow.schema.SchemaOpts object>
class fields.test_files.BasicOutputDir(extra=None, only=(), exclude=(), prefix=u'', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: argschema.schemas.ArgSchema

This schema is designed to be a schema_type for an ArgSchemaParser object
BasicOutputDir
key description default field_type json_type
log_level set the logging level of the module ERROR LogLevel unicode
output_dir basic output dir (REQUIRED) OutputDir unicode
opts = <marshmallow.schema.SchemaOpts object>
class fields.test_files.BasicOutputFile(extra=None, only=(), exclude=(), prefix=u'', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: argschema.schemas.ArgSchema

This schema is designed to be a schema_type for an ArgSchemaParser object
BasicOutputFile
key description default field_type json_type
output_file a simple output file (REQUIRED) OutputFile unicode
log_level set the logging level of the module ERROR LogLevel unicode
opts = <marshmallow.schema.SchemaOpts object>
class fields.test_files.ModeOutputDirSchema(extra=None, only=(), exclude=(), prefix=u'', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: argschema.schemas.ArgSchema

This schema is designed to be a schema_type for an ArgSchemaParser object
ModeOutputDirSchema
key description default field_type json_type
log_level set the logging level of the module ERROR LogLevel unicode
output_dir 775 output directory (REQUIRED) OutputDir unicode
opts = <marshmallow.schema.SchemaOpts object>
fields.test_files.test_access_inputfile_failed()[source]
fields.test_files.test_bad_inputdir()[source]
fields.test_files.test_basic_inputdir(tmpdir)[source]
fields.test_files.test_enoent_outputfile_failed()[source]
fields.test_files.test_failed_mode(tmpdir)[source]
fields.test_files.test_inputdir_no_access(tmpdir)[source]
fields.test_files.test_mode_output_osdir(tmpdir)[source]
fields.test_files.test_output_dir_bad_location()[source]
fields.test_files.test_output_dir_bad_permission()[source]
fields.test_files.test_output_dir_basic()[source]
fields.test_files.test_output_file_relative()[source]
fields.test_files.test_output_path(tmpdir)[source]
fields.test_files.test_output_path_cannot_write()[source]
fields.test_files.test_output_path_noapath()[source]
fields.test_files.test_outputfile_no_write(tmpdir)[source]
fields.test_files.test_outputfile_not_a_path()[source]
fields.test_files.test_relative_file_input()[source]
fields.test_files.test_relative_file_input_failed()[source]

fields.test_loglevel module

fields.test_loglevel.test_bad_option()[source]
fields.test_loglevel.test_option_list()[source]

fields.test_numpyarray module

class fields.test_numpyarray.NumpyFileuint16(extra=None, only=(), exclude=(), prefix=u'', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: argschema.schemas.ArgSchema

This schema is designed to be a schema_type for an ArgSchemaParser object
NumpyFileuint16
key description default field_type json_type
a list of lists representing a uint16 numpy array (REQUIRED) NumpyArray ?
log_level set the logging level of the module ERROR LogLevel unicode
opts = <marshmallow.schema.SchemaOpts object>
fields.test_numpyarray.test_bad_data()[source]
fields.test_numpyarray.test_bad_shape()[source]
fields.test_numpyarray.test_numpy()[source]
fields.test_numpyarray.test_serialize()[source]

fields.test_slice module

class fields.test_slice.SliceSchema(extra=None, only=(), exclude=(), prefix=u'', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]

Bases: argschema.schemas.ArgSchema

This schema is designed to be a schema_type for an ArgSchemaParser object
SliceSchema
key description default field_type json_type
a slice the dataset slice(None, None, None) Slice unicode
log_level set the logging level of the module ERROR LogLevel unicode
opts = <marshmallow.schema.SchemaOpts object>
fields.test_slice.test_bad_slice()[source]
fields.test_slice.test_slice()[source]

Module contents