Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 1.57 KB

README.rst

File metadata and controls

50 lines (35 loc) · 1.57 KB

filepath 0.2

What is this?

filepath is an object-oriented API for manipulating filesystem paths on POSIX and Windows. Its primary goal is to provide APIs which are less prone to bugs and security issues than the standard Python os.path APIs. Additionally, it offers access to the contents of zip archives via an alternate implementation of the same API used for accessing a normal filesystem.

filepath is an independent package of the twisted.python.filepath module. Therefore, while this is a brand new package, the code is mature and has already seen a great deal of real-world use.

Because of this, all bug reports should be submitted upstream to Twisted.

Compatibility

filepath is intended to be as compatible with twisted.python.filepath as possible. All changes will be made in twisted.python.filepath first and then migrated to filepath.

As a consequence, filepath inherits Twisted's policies regarding backwards compatibility. As an exception, however, filepath will make no backwards compatibility guarantees for its first few releases.

Installing

filepath requires zope.interface and Python 2.6 or 2.7. It can be installed with pip.

pip install filepath

Unit Tests

For simplicity of maintenance, filepath's unit tests depend on Twisted Trial. You will only be able to run them with Twisted installed. This is the only part of filepath which depends on Twisted.

You can run the tests with the Trial runner:

$ trial filepath

You can probably run them with the stdlib unittest runner, but I can't figure out how right now.