xphyle: extraordinarily simple file handling
xphyle is a small python library that makes it easy to open compressed files. Most importantly, xphyle will use the appropriate program (e.g. 'gzip') to compress/decompress a file if it is available on your system; this is almost always faster than using the corresponding python library. xphyle also provides methods that simplify common file I/O operations.
Recent version of xphyle (4.0.0+) require python 3.6. Older versions of xphyle support python 3.4+.
Please note that xphyle may work on Windows, but it is not tested.
Installation
pip install xphyle
Building from source
Clone this repository and run
make
Example usages:
from xphyle import *
from xphyle.paths import STDIN, STDOUT
# Open a compressed file...
myfile = xopen('infile.gz')
# ...or a compressed stream
# e.g. gzip -c afile | python my_program.py
stdin = xopen(STDIN)
# Easily write to the stdin of a subprocess
with open_('|cat', 'wt') as process:
process.write('foo')
# We have to tell xopen what kind of compression
# to use when writing to stdout
stdout = xopen(STDOUT, compression='gz')
# The `open_` method ensures that the file is usable with the `with` keyword.
# Print all lines in a compressed file...
with open_('infile.gz') as myfile:
for line in myfile:
print(line)
# ... or a compressed URL
with open_('http://foo.com/myfile.gz') as myfile:
for line in myfile:
print(line)
# Transparently handle paths and file objects
def dostuff(path_or_file):
with open_(path_or_file) as myfile:
for line in myfile:
print(line)
# Read all lines in a compressed file into a list
from xphyle.utils import read_lines
lines = list(read_lines('infile.gz'))
# Sum the rows in a compressed file where each line is an integer value
total = sum(read_lines('infile.gz', convert=int))
See the Documentation for full usage information.
Supported compression formats
gzip(usesigziporpigzif available)bgzipbzip2(usespbzip2if available)lzmazstd
Issues
Please report bugs and request enhancements using the issue tracker.
Roadmap
Future releases are mapped out using GitHub Projects.
Citing xphyle
Acknowledgements
- Dependencies scanned by PyUp.io
- Thanks to @ctb for reviewing the xphyle paper
1 maintainer
Metadata
1 maintainer
Release files for xphyle 4.4.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| xphyle-4.4.4.tar.gz | 1.4 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| xphyle-4.4.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.4 MB
Release files / xphyle-4.4.4.tar.gz
| Download URL | xphyle-4.4.4.tar.gz |
|---|---|
| Size | 1.4 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2ec69c1e795d0c35ecc0a4572cb1eb6647b79d0f8746646cd3f6159c33e2ce2c
|
|
BLAKE2b-256 checksum How to use checksums |
73497e55ce45b42c91727638e549a8be400606cd1057b0aee0e28b1fffa6b30f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.12
|
Release files / xphyle-4.4.4-py3-none-any.whl
| Download URL | xphyle-4.4.4-py3-none-any.whl |
|---|---|
| Size | 58.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
229accb765621e09b48f67627a46939a902bf26a67338a03d6d20689e78653d2
|
|
BLAKE2b-256 checksum How to use checksums |
a274c17f17b6783651497027d0eee83dcda252657e0a0b1a9f9baf870e5a748d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.12
|
