campy.io.filelib module

This file exports a standardized set of tools for working with files. The library offers at least some portability across the file systems used in the three supported platforms: Mac OSX, Windows, and Linux. Directory and search paths are allowed to contain separators in any of the supported styles, which usually makes it possible to use the same code on different platforms.

Note: Several of the functions that lived in CPP’s version of this library are removed, to force students to learn the proper builtin pathlib library. The compatability is listed here:

def create_directory(path):
    _Path(path).mkdir()

def create_directory_path(path):
    _Path(path).mkdir(path, parents=True)

def default_extension(path, ext):
    p = _Path(path)
    if ext.startswith('*') or not p.suffix:
        return p.with_suffix(ext)

def delete_file(path):
    return os.remove(path)

TODO more

campy.io.filelib.expand_pathname(path)

campy.io.filelib.file_exists(path)

campy.io.filelib.find_on_path(path, filename)

campy.io.filelib.get_current_directory()

campy.io.filelib.get_directory_path_separator()

campy.io.filelib.get_extension(path)

campy.io.filelib.get_head(path)

campy.io.filelib.get_root(path)

campy.io.filelib.get_search_path_separator(path)

campy.io.filelib.get_tail(path)

campy.io.filelib.get_temp_directory()

campy.io.filelib.is_directory(path)

campy.io.filelib.is_file(path)

campy.io.filelib.is_symbolic_link(path)

campy.io.filelib.list_directory(path)

campy.io.filelib.match_filename_pattern(path)

campy.io.filelib.open_file(path)

campy.io.filelib.open_file_dialog(title='Open File', mode='load', path='', binary=False)

Opens a dialog that allows the user to choose the file. The title parameter is displayed in the dialog title. The path parameter is used to set the working directory; if path does not appear, openFileDialog uses the current directory.

@type title: string @param title: title of dialog box @type mode: string @param mode: mode of dialog box @type binary: boolean @param binary: open file in binary mode on windows @rtype: file

campy.io.filelib.open_on_path(path)

campy.io.filelib.prompt_user_for_file(prompt='', reprompt='')

campy.io.filelib.read_entire_file(stream, lines)

campy.io.filelib.rename(old, new)

campy.io.filelib.rewindStream(input)

campy.io.filelib.set_current_directory(path)

campy.io.filelib.write_entire_file(path)