armi.utils.directoryChangers module

class armi.utils.directoryChangers.DirectoryChanger(destination, filesToMove=None, filesToRetrieve=None)

Bases: object

Utility class to change directory

Use with ‘with’ statements to execute code in a different dir, guaranteeing a clean return to the original directory

>>> with DirectoryChanger(r'C:\whatever')
...     pass

Establish the new and return directories

__enter__()

At the inception of a with command, navigate to a new directory if one is supplied.

__exit__(exc_type, exc_value, traceback)

At the termination of a with command, navigate back to the original directory.

__repr__()

Print the initial and destination paths

open()

User requested open, used to stalling the close from a with statement.

This method has been made for old uses of os.chdir() and is not recommended. Please use the with statements

close()

User requested close.

moveFiles()

retrieveFiles()

Retrieve any desired files.

class armi.utils.directoryChangers.TemporaryDirectoryChanger(root=None, filesToMove=None, filesToRetrieve=None)

Bases: armi.utils.directoryChangers.DirectoryChanger

Create temporary directory, changes into it, and if there is no error/exception generated when using a with statement, it deletes the directory.

Notes

If there is an error/exception generated while in a with statement, the temporary directory contents will be copied to the original directory and then the temporary directory will be deleted.

Establish the new and return directories

classmethod GetRandomDirectory(root)

class armi.utils.directoryChangers.ForcedCreationDirectoryChanger(destination, filesToMove=None, filesToRetrieve=None, clean=False)

Bases: armi.utils.directoryChangers.DirectoryChanger

Creates the directory tree necessary to reach your desired destination

clean

if True and the directory exists, clear all contents on entry.

Type

bool

Establish the new and return directories

armi.utils.directoryChangers.directoryChangerFactory()