Metadata-Version: 2.0
Name: openfile
Version: 0.0.2
Summary: A convenience function that delegates to the appropriate standard library function.
Home-page: https://github.com/luismsgomes/openfile
Author: Luís Gomes
Author-email: luismsgomes@gmail.com
License: MIT
Keywords: convenience
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5

==========
 openfile
==========

``openfile`` is a trivial Python module that implements a single convenience
function ``openfile(filename, mode="rt", **kwargs)`` wich delegates the real
work to one of the following standard library functions:

``gzip.open(filename, mode, **kwargs)``
    if the file ends with suffix ``.gz``;
``bz2.open(filename, mode, **kwargs)``
    if the file ends with suffix ``.bz2``;
``lzma.open(filename, mode, **kwargs)``
    if the file ends with suffix ``.xz`` or ``.lzma``;
``open(filename, mode, **kwargs)``
    if the file does not end with any suffix mentioned above.

If the ``filename`` is a single dash ``-`` then ``sys.stdin`` or ``sys.stdout``
is returned, depending on ``mode`` being ``r`` or ``w``, respectively.


