Skip to main content

Simple semantic functions for colorfull console messages

Project description

consolemsg

Semantically colorifies console output messages with ANSI codes.

The goal of the module is to centralize how console messages are printed depending on the intent. Instead of print() you can use:

  • step()
  • error()
  • warn()
  • success()
  • out()

Also fail() prints an error and exits.

All consolemsg functions, but out, output to sys.stderr, so they will be separated from your stdout when piping.

Extra arguments, will be inserted into the message with format.

For serious logging you should use the logging standard module. This is a quick and simple solution make the user aware of the relevance of the outputs.

Also those functions are Py2 backwards compatible, so you can use them instead of regular print to make your code portable.

Changelog

consolemsg 0.3.3 2019-07-27

  • Fix: Not incluiding CHANGES into the sdist prevented to install

consolemsg 0.3.2 2019-07-26

  • Minor package metadata fixes
    • Appending changelog properly
    • Added classifiers Python 2 and Console environment

consolemsg 0.3.1 2019-07-26

  • Minor package metadata fixes
    • Added changelog to the description

consolemsg 0.3.0 2019-07-26

  • Dropped support for Python 2 < 2.7.1 and Python 3 < 3.3
  • Two helpers u and b that ensure a nice conversion to unicode and bytes regardles being in Py2 or Py3 and using UTF-8 as default encoding.
  • New out function to send undecorated content, but still portable and unicode safe, to stdout
  • Unicode over pipes without needing PYTHONIOENCODING, defaulting to utf-8 instead of ASCII
    • Respects stdout/stderr encoding when PYTHONIOENCODING or any other local settings sets it
  • When first parameter is a Py2 str's is decoded as unicode using using UTF-8
  • First parameter can be any formatable type instead of text

consolemsg 0.2.1 2018-02-06

  • Minor package metadata fixes

consolemsg 0.2.0 2018-02-06

  • Extra arguments are inserted into the first one using format templating

consolemsg 0.1.0 2016-01-12

  • Backward support for Py2 (avoid using print to stderr)
  • New function success to show up successful end of tasks messages (green)

consolemsg 0.0.0 unreleased

  • First version with step, error, warn and fail
  • As part of GuifiBaix software 'suro'

Project details


Download files

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

Files for consolemsg, version 0.3.3
Filename, size File type Python version Upload date Hashes
Filename, size consolemsg-0.3.3.tar.gz (3.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page