Skip to main content

Convenience tool: wrapper around regular/gzip files, Logger, text colors

Project description

Convenience

Tools for everyday use.

Source and install files are available under BSD License here: https://gitlab.com/sylvainraybaud/convenience

This package HAS NOT been tested with Python 2.

API

  • xopen: a wrapper around open and gzip.open returning an XFile object, which is a wrapper around File and gzip.GzipFile. XFile implements methods open, close, read, readline, readlines, write with the same parameters as File methods. It also implements __iter__ and __next__ to make it iterable and __enter__ and __exit__ to make it usable in with statements. Files whose names end with .gz are treated as gzip files, all other files are treated as uncompressed files.

  • Logger: a wrapper around logging module. A Logger object is intialized with a verbosity parameter which is translated into a logging value (WARNING, INFO or DEBUG). It implements debug, info, warning and error methods. They all take a string as first argument argument. error takes an extra argument, code. When called, error print its first parameter then calls exit(code).

  • header, blue, green, yellow, orange, red, bold, underline: apply decoration to string (see example.py)

Using

A good example being worth a thousand words, please see example.py

Installing

pip install convenience

TODO

  • Use magic number instead of file extension to detected gzipped files, when applicable.
  • Handle more compression format.
  • Double check handling of various text encodings.
  • Python 2 compatibility.
  • Add more magic.

Contributing

Please make a pull request on gitlab. You can mail me at

first_name [dot] family_name [at] crans [dot] org

Project details


Release history Release notifications | RSS feed

This version

0.2

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for convenience, version 0.2
Filename, size File type Python version Upload date Hashes
Filename, size convenience-0.2-py3-none-any.whl (4.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size convenience-0.2.tar.gz (3.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page