pygauss.file_io module

Created on Mon May 18 21:01:25 2015

@author: chris sewell

class pygauss.file_io.Folder(path, server=None, username=None, passwrd=None)

Bases: object

an object intended to act as an entry point to a folder path

Parameters:

• path (str) – the path to the folder (absolute or relative)
• server (str) – the server name
• username (str) – the username to connect to the server
• passwrd (str) – server password, if not present it will be asked for during initialisation

__enter__()

use with statement to open ssh connection once

__exit__(type, value, traceback)

use with statement to open ssh connection once

active()

if folder is active

get_path()

get folder path

islocal()

if folder is local

list_files(pattern=None, one_file=False)

list files in folder

Parameters:pattern (str) – a pattern the file must match that can include * wildcards

read_file(file_name)

return an open file ready for reading

save_ipyimg(img, img_name)

a function for outputing an IPython Image to a file

Parameters:

• img (IPython.display.Image) – an IPyton image
• img_name (str) – the desired name of the file

save_mplfig(fig, fig_name, dpi=256, format='png')

a function for outputing a matplotlib figure to a file

Parameters:

• fig (matplotlib.figure.Figure) – a Matplotlib figure
• fig_name (str) – the desired name of the file

save_pilimg(img, img_name)

write_file(file_name, overwrite=False)

return an open file ready for writing to

class pygauss.file_io.NoOutputFolder(*args, **kwargs)

Bases: pygauss.file_io.Folder

a folder object which will not output any data

save_ipyimg(*arg, **kwargs)

save_mplfig(*arg, **kwargs)

save_pilimg(*arg, **kwargs)

write_file(*arg, **kwargs)