Files

Utility classes for handling different type of files.

AudioFile

File class to read audio files. Currently supports wav and flac formats.

Usage examples:

# Example 1
data, fs = AudioFile(filename='test.wav', fs=22050).load()
# Example 2
data, fs = AudioFile().load(filename='test.wav', fs=44100, mono=False)

AudioFile(\*args, \*\*kwargs)	File class for audio files, valid file formats [wav, flac]
AudioFile.load(\*args, \*\*kwargs)	Load file
AudioFile.save([filename, bitdepth])	Save audio
AudioFile.exists()	Checks that file exists
AudioFile.empty()	Check if file is empty

ParameterFile

File class to read and write dict based parameter files in YAML format.

Usage examples:

# Example 1
params = ParameterFile(filename='parameters.yaml')
params.load()
params.save()
# Example 2
params = ParameterFile(filename='parameters.yaml').load()
params.save()
# Example 3
params = ParameterFile({'test':'value'}).save(filename='parameters.yaml')

ParameterFile(\*args, \*\*kwargs)	File class for parameter files, Inherited from DictFile, valid file formats [yaml]
ParameterFile.load(\*args, \*\*kwargs)	Load file
ParameterFile.save(\*args, \*\*kwargs)	Save file
ParameterFile.exists()	Checks that file exists
ParameterFile.empty()	Check if file is empty

FeatureFile

File class to read and write dict based feature files in cpickle format.

Usage examples:

# Example 1
feat = FeatureFile(filename='features.cpickle')
feat.load()
feat.save()
# Example 2
feat = FeatureFile(filename='features.cpickle').load()
feat.save()
# Example 3
feat = FeatureFile({'feature':[1,2,3,4]}).save(filename='features.cpickle')

FeatureFile(\*args, \*\*kwargs)	File class for feature files, Inherited from DictFile, valid file formats [cpickle]
FeatureFile.load(\*args, \*\*kwargs)	Load file
FeatureFile.save(\*args, \*\*kwargs)	Save file
FeatureFile.exists()	Checks that file exists
FeatureFile.empty()	Check if file is empty

DataFile

Generic file class to read and write dict based data files in cpickle format.

Usage examples:

# Example 1
data = DataFile(filename='data.cpickle')
data.load()
data.save()
# Example 2
data = DataFile(filename='data.cpickle').load()
data.save()
# Example 3
data = DataFile({'data':[1,2,3,4]}).save(filename='data.cpickle')

DataFile(\*args, \*\*kwargs)	File class for data files, Inherited from DictFile, valid file formats [cpickle]
DataFile.load(\*args, \*\*kwargs)	Load file
DataFile.save(\*args, \*\*kwargs)	Save file
DataFile.exists()	Checks that file exists
DataFile.empty()	Check if file is empty

RepositoryFile

File class to read and write dict based repositories in cpickle format.

RepositoryFile(\*args, \*\*kwargs)	File class for repository files, Inherited from DictFile, valid file formats [cpickle]
RepositoryFile.load(\*args, \*\*kwargs)	Load file
RepositoryFile.exists()	Checks that file exists
RepositoryFile.empty()	Check if file is empty

TextFile

File class to read and write text files, rows in the text file is stored as items in a list.

TextFile(\*args, \*\*kwargs)	File class for text files, Inherited from ListFile, valid file formats [txt]
TextFile.load(\*args, \*\*kwargs)	Load file
TextFile.save(\*args, \*\*kwargs)	Save file
TextFile.exists()	Checks that file exists
TextFile.empty()	Check if file is empty

DictFile

Base class for all dict based file classes.

DictFile(\*args, \*\*kwargs)	File class inherited from dict, valid file formats [yaml, json, cpickle, marshal, msgpack, txt]
DictFile.load(\*args, \*\*kwargs)	Load file
DictFile.save(\*args, \*\*kwargs)	Save file
DictFile.exists()	Checks that file exists
DictFile.empty()	Check if file is empty

ListFile

Base class for all list based file classes.

ListFile(\*args, \*\*kwargs)	File class inherited from list, valid file formats [txt]
ListFile.load(\*args, \*\*kwargs)	Load file
ListFile.save(\*args, \*\*kwargs)	Save file
ListFile.exists()	Checks that file exists
ListFile.empty()	Check if file is empty

Mixins

FileMixin

Generic file mixin