Skip to content

Python Library filehandlers

filehandlers is a library for working with files.

Installation

The name of the package on PyPI is filehandlers.

Installing Packages

See this guide for how to install packages.

Usage

See the subpages for more information.

Concept

filehandlers is built on a simple model.

File

A file is represented with an instance of filehandlers.AbstractFile.

Initializing an AbstractFile

The file doesn't need to exist when creating an instance of AbstractFile.

Manipulation

Now, say you want to change that file... that is where filehandlers.FileManipulator comes in. You need to pass the AbstractFile instance when creating a FileManipulator so filehandlers knows exactly which file it is controlling.

The manipulator includes code for a number of common functions that you may find handy.

Simple Example

Here is a quick example that shows how to use filehandlers to write to a file:

from filehandlers import FileManipulator, AbstractFile

# define the file
my_cool_file = AbstractFile("log.txt")

# create FileManipulator
my_cool_files_changer = FileManipulator(my_cool_file)

# write data to file 5 times
for i in range(5):
    my_cool_files_changer.write_to_file("Message #" + i + ": " + debug_message)

You can see the full API documentation here.

Source

The source can be found on GitHub.


Last update: 2020-06-06