fields package

Submodules

fields.test_deprecated module

class fields.test_deprecated.OptionSchema(only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

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
input_json	file path of input json file	NA	InputFile	str
output_json	file path to output json file	NA	OutputFile	str
log_level	set the logging level of the module	ERROR	LogLevel	str
a	one of 1,2,3	(REQUIRED)	OptionList	?

opts = <marshmallow.schema.SchemaOpts object>

fields.test_deprecated.test_bad_option()

fields.test_deprecated.test_option_list()

fields.test_files module

class fields.test_files.BasicInputDir(only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

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_json	file path of input json file	NA	InputFile	str
output_json	file path to output json file	NA	OutputFile	str
log_level	set the logging level of the module	ERROR	LogLevel	str
input_dir	a simple file	(REQUIRED)	InputDir	str

opts = <marshmallow.schema.SchemaOpts object>

class fields.test_files.BasicInputFile(only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

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
input_json	file path of input json file	NA	InputFile	str
output_json	file path to output json file	NA	OutputFile	str
log_level	set the logging level of the module	ERROR	LogLevel	str
input_file	a simple file	(REQUIRED)	InputFile	str

opts = <marshmallow.schema.SchemaOpts object>

class fields.test_files.BasicOutputDir(only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

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
input_json	file path of input json file	NA	InputFile	str
output_json	file path to output json file	NA	OutputFile	str
log_level	set the logging level of the module	ERROR	LogLevel	str
output_dir	basic output dir	(REQUIRED)	OutputDir	str

opts = <marshmallow.schema.SchemaOpts object>

class fields.test_files.BasicOutputFile(only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

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
input_json	file path of input json file	NA	InputFile	str
output_json	file path to output json file	NA	OutputFile	str
log_level	set the logging level of the module	ERROR	LogLevel	str
output_file	a simple output file	(REQUIRED)	OutputFile	str

opts = <marshmallow.schema.SchemaOpts object>

class fields.test_files.ModeOutputDirSchema(only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

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
input_json	file path of input json file	NA	InputFile	str
output_json	file path to output json file	NA	OutputFile	str
log_level	set the logging level of the module	ERROR	LogLevel	str
output_dir	775 output directory	(REQUIRED)	OutputDir	str

opts = <marshmallow.schema.SchemaOpts object>

fields.test_files.test_access_inputfile_failed()

fields.test_files.test_bad_inputdir()

fields.test_files.test_basic_inputdir(tmpdir)

fields.test_files.test_enoent_outputfile_failed()

fields.test_files.test_failed_mode(tmpdir)

fields.test_files.test_inputdir_no_access(tmpdir)

fields.test_files.test_mode_output_osdir(tmpdir)

fields.test_files.test_output_dir_bad_location()

fields.test_files.test_output_dir_bad_permission(tmpdir)

fields.test_files.test_output_dir_basic(tmpdir)

fields.test_files.test_output_file_relative()

fields.test_files.test_output_path(tmpdir)

fields.test_files.test_output_path_cannot_write()

fields.test_files.test_output_path_noapath()

fields.test_files.test_outputfile_no_write(tmpdir)

fields.test_files.test_outputfile_not_a_path()

fields.test_files.test_relative_file_input()

fields.test_files.test_relative_file_input_failed()

fields.test_files.test_windows_outdir_mode_fail()

fields.test_loglevel module

fields.test_loglevel.test_bad_option()

fields.test_loglevel.test_option_list()

fields.test_numpyarray module

class fields.test_numpyarray.NumpyFileuint16(only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

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
input_json	file path of input json file	NA	InputFile	str
output_json	file path to output json file	NA	OutputFile	str
log_level	set the logging level of the module	ERROR	LogLevel	str
a	list of lists representing a uint16 numpy array	(REQUIRED)	unknown	unknown

opts = <marshmallow.schema.SchemaOpts object>

fields.test_numpyarray.test_bad_data()

fields.test_numpyarray.test_bad_shape()

fields.test_numpyarray.test_numpy()

fields.test_numpyarray.test_serialize()

fields.test_slice module

class fields.test_slice.SliceSchema(only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

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
input_json	file path of input json file	NA	InputFile	str
output_json	file path to output json file	NA	OutputFile	str
log_level	set the logging level of the module	ERROR	LogLevel	str
a	slice the dataset	slice(None, None, None)	Slice	str

opts = <marshmallow.schema.SchemaOpts object>

fields.test_slice.test_bad_slice()

fields.test_slice.test_slice()

Module contents