mirror of
https://github.com/kennethreitz/clint.git
synced 2026-06-05 23:00:18 +00:00
Compare commits
29 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| f651e71093 | |||
| e500773da3 | |||
| 4b9e35c631 | |||
| e85fffdbb6 | |||
| b58f8dccdc | |||
| 3d63ed01f9 | |||
| 81165754a4 | |||
| 6f106e2f12 | |||
| 8adda14a27 | |||
| cc072a18f3 | |||
| c226b6b736 | |||
| 3406ab5329 | |||
| cf0c0bda70 | |||
| a4c2be8865 | |||
| fa2bbf9a0d | |||
| 9736b4cd71 | |||
| 2e68207d0a | |||
| 164d68ce37 | |||
| aa5008b2e0 | |||
| 8b7161b15b | |||
| 763ca94e7b | |||
| 2d200e3709 | |||
| d0f2375a7b | |||
| 2369bc387d | |||
| f12e47fa7c | |||
| 5d733d123d | |||
| 9e1ea1ef91 | |||
| 6d151a0794 | |||
| 13afb11dea |
+3
-1
@@ -1,2 +1,4 @@
|
||||
.idea
|
||||
MANIFEST
|
||||
MANIFEST
|
||||
*.pyc
|
||||
.tox
|
||||
|
||||
@@ -12,4 +12,5 @@ Patches and Suggestions
|
||||
|
||||
- Jeff Forcier
|
||||
- Morgan Goose
|
||||
- Travis Swicegood
|
||||
- Travis Swicegood
|
||||
- Will Thames
|
||||
|
||||
+17
@@ -1,6 +1,23 @@
|
||||
History
|
||||
-------
|
||||
|
||||
0.2.3
|
||||
+++++
|
||||
|
||||
* Only init colors if they are used (iPython compatability)
|
||||
* New progress module
|
||||
* Various bugfixes
|
||||
|
||||
|
||||
0.2.2
|
||||
+++++
|
||||
|
||||
* Auto Color Disabling
|
||||
* Progress Namespace Change
|
||||
* New Progress Bars
|
||||
* textui.puts newline fix
|
||||
|
||||
|
||||
0.2.1 (2011-03-24)
|
||||
++++++++++++++++++
|
||||
|
||||
|
||||
+30
-3
@@ -12,16 +12,43 @@ commandline applications.
|
||||
**T** ools
|
||||
.
|
||||
|
||||
Features:
|
||||
---------
|
||||
|
||||
Clint is awesome. Crazy awesome. It supports colors, but detects if the session is a TTY, so doesn't render the colors if you're piping stuff around. Automagically.
|
||||
|
||||
Awesome nest-able indentation context manager. Example: (``with indent(4): puts('indented text')``). It supports custom email-style quotes. Of course, it supports color too, if and when needed.
|
||||
|
||||
It has an awesome Column printer with optional auto-expanding columns. It detects how wide your current console is and adjusts accordingly. It wraps your words properly to fit the column size. With or without colors mixed in. All with a single function call.
|
||||
|
||||
The world's easiest to use implicit argument system w/ chaining methods for filtering. Seriously.
|
||||
|
||||
|
||||
Run the various executables in examples_ to get a good feel for what Clint offers.
|
||||
|
||||
.. _examples: https://github.com/kennethreitz/clint/tree/develop/examples
|
||||
|
||||
You'll never want to not use it.
|
||||
|
||||
|
||||
|
||||
Current Features:
|
||||
-----------------
|
||||
- Little Documentation (bear with me for now)
|
||||
- CLI Colors and Indents
|
||||
- Extremely Simple + Powerful Column Printer
|
||||
- Iterator-based Progress Bar
|
||||
- Implicit Argument Handling
|
||||
- Simple Support for Unix Pipes
|
||||
- Simple Support for Incoming Unix Pipes
|
||||
- Application Directory management
|
||||
|
||||
|
||||
Future Features:
|
||||
----------------
|
||||
- Documentation!
|
||||
- Simple choice system ``Are you sure? [Yn]``
|
||||
- Default query system ``Installation Path [/usr/local/bin/]``
|
||||
- Suggestions welcome.
|
||||
|
||||
|
||||
Example
|
||||
-------
|
||||
|
||||
|
||||
+2
-2
@@ -19,8 +19,8 @@ from .pipes import piped_in
|
||||
|
||||
|
||||
__title__ = 'clint'
|
||||
__version__ = '0.2.1'
|
||||
__build__ = 0x000201
|
||||
__version__ = '0.2.3'
|
||||
__build__ = 0x000203
|
||||
__author__ = 'Kenneth Reitz'
|
||||
__license__ = 'ISC'
|
||||
__copyright__ = 'Copyright 2011 Kenneth Reitz'
|
||||
|
||||
+8
-8
@@ -39,7 +39,7 @@ class AppDir(object):
|
||||
|
||||
def __repr__(self):
|
||||
return '<app-dir: %s>' % (self.path)
|
||||
|
||||
|
||||
|
||||
def __getattribute__(self, name):
|
||||
|
||||
@@ -53,11 +53,11 @@ class AppDir(object):
|
||||
"""Raises if operations are carried out on an unconfigured AppDir."""
|
||||
if not self.path:
|
||||
raise NotConfigured()
|
||||
|
||||
|
||||
|
||||
def _create(self):
|
||||
"""Creates current AppDir at AppDir.path."""
|
||||
|
||||
|
||||
self._raise_if_none()
|
||||
if not self._exists:
|
||||
mkdir_p(self.path)
|
||||
@@ -66,7 +66,7 @@ class AppDir(object):
|
||||
|
||||
def open(self, filename, mode='r'):
|
||||
"""Returns file object from given filename."""
|
||||
|
||||
|
||||
self._raise_if_none()
|
||||
fn = path_join(self.path, filename)
|
||||
|
||||
@@ -121,11 +121,11 @@ class AppDir(object):
|
||||
else:
|
||||
raise why
|
||||
|
||||
|
||||
|
||||
def read(self, filename, binary=False):
|
||||
"""Returns contents of given file with AppDir.
|
||||
If file doesn't exist, returns None."""
|
||||
|
||||
|
||||
self._raise_if_none()
|
||||
fn = path_join(self.path, filename)
|
||||
|
||||
@@ -161,11 +161,11 @@ log = AppDir()
|
||||
def init(vendor, name):
|
||||
|
||||
global user, site, cache, log
|
||||
|
||||
|
||||
ad = AppDirs(name, vendor)
|
||||
|
||||
user.path = ad.user_data_dir
|
||||
|
||||
|
||||
site.path = ad.site_data_dir
|
||||
cache.path = ad.user_cache_dir
|
||||
log.path = ad.user_log_dir
|
||||
|
||||
@@ -10,4 +10,6 @@ This module provides the text output helper system.
|
||||
|
||||
|
||||
from . import colored
|
||||
from . import progress
|
||||
|
||||
from core import *
|
||||
|
||||
+10
-9
@@ -25,8 +25,8 @@ __all__ = (
|
||||
COLORS = __all__[:-2]
|
||||
DISABLE_COLOR = False
|
||||
|
||||
if sys.stdout.isatty():
|
||||
colorama.init(autoreset=True)
|
||||
if not sys.stdout.isatty():
|
||||
DISABLE_COLOR = True
|
||||
|
||||
|
||||
class ColoredString(object):
|
||||
@@ -39,6 +39,7 @@ class ColoredString(object):
|
||||
@property
|
||||
def color_str(self):
|
||||
if sys.stdout.isatty() and not DISABLE_COLOR:
|
||||
colorama.init(autoreset=True)
|
||||
return '%s%s%s' % (
|
||||
getattr(colorama.Fore, self.color), self.s, colorama.Fore.RESET)
|
||||
else:
|
||||
@@ -47,25 +48,25 @@ class ColoredString(object):
|
||||
|
||||
def __len__(self):
|
||||
return len(self.s)
|
||||
|
||||
|
||||
def __repr__(self):
|
||||
return "<%s-string: '%s'>" % (self.color, self.s)
|
||||
|
||||
|
||||
def __str__(self):
|
||||
return self.__unicode__().encode('utf8')
|
||||
|
||||
|
||||
def __unicode__(self):
|
||||
return self.color_str
|
||||
|
||||
|
||||
def __add__(self, other):
|
||||
return str(self.color_str) + str(other)
|
||||
|
||||
|
||||
def __radd__(self, other):
|
||||
return str(other) + str(self.color_str)
|
||||
|
||||
|
||||
def __mul__(self, other):
|
||||
return (self.color_str * other)
|
||||
|
||||
|
||||
def split(self, x=' '):
|
||||
return map(self._new, self.s.split(x))
|
||||
|
||||
|
||||
@@ -13,13 +13,12 @@ from __future__ import absolute_import
|
||||
|
||||
import sys
|
||||
|
||||
from .progress import progressbar
|
||||
from .formatters import max_width, min_width
|
||||
from .cols import columns
|
||||
from ..utils import tsplit
|
||||
|
||||
|
||||
__all__ = ('puts', 'puts_err', 'indent', 'progressbar', 'columns', 'max_width', 'min_width')
|
||||
__all__ = ('puts', 'puts_err', 'indent', 'columns', 'max_width', 'min_width')
|
||||
|
||||
|
||||
STDOUT = sys.stdout.write
|
||||
@@ -63,14 +62,14 @@ class Writer(object):
|
||||
|
||||
|
||||
def __call__(self, s, newline=True, stream=STDOUT):
|
||||
|
||||
|
||||
if newline:
|
||||
s = tsplit(s, NEWLINES)
|
||||
s = map(str, s)
|
||||
indent = ''.join(self.shared['indent_strings'])
|
||||
|
||||
|
||||
s = (str('\n' + indent)).join(s)
|
||||
|
||||
|
||||
_str = ''.join((
|
||||
''.join(self.shared['indent_strings']),
|
||||
str(s),
|
||||
@@ -79,14 +78,14 @@ class Writer(object):
|
||||
stream(_str)
|
||||
|
||||
|
||||
def puts(s, newline=True):
|
||||
def puts(s='', newline=True, stream=STDOUT):
|
||||
"""Prints given string to stdout via Writer interface."""
|
||||
Writer()(s, stream=STDOUT)
|
||||
Writer()(s, newline, stream=stream)
|
||||
|
||||
|
||||
def puts_err(s, newline=True):
|
||||
def puts_err(s='', newline=True, stream=STDERR):
|
||||
"""Prints given string to stderr via Writer interface."""
|
||||
Writer()(s, stream=STDERR)
|
||||
Writer()(s, newline, stream=stream)
|
||||
|
||||
|
||||
def indent(indent=4, quote=''):
|
||||
|
||||
+46
-10
@@ -12,21 +12,57 @@ from __future__ import absolute_import
|
||||
|
||||
import sys
|
||||
|
||||
STREAM = sys.stderr
|
||||
|
||||
def progressbar(it, prefix='', size=32, hide=False):
|
||||
BAR_TEMPLATE = '%s[%s%s] %i/%i\r'
|
||||
BAR_EMPTY_CHAR = '-'
|
||||
BAR_FILLED_CHAR = '='
|
||||
|
||||
DOTS_CHAR = '.'
|
||||
|
||||
|
||||
def bar(it, label='', width=32, hide=False):
|
||||
"""Progress iterator. Wrap your iterables with it."""
|
||||
count = len(it)
|
||||
if count:
|
||||
def _show(_i):
|
||||
x = int(size*_i/count)
|
||||
if not hide:
|
||||
sys.stdout.write("%s[%s>%s] %i/%i\r" % (prefix, "="*x, "-"*(size-x), _i, count))
|
||||
sys.stdout.flush()
|
||||
|
||||
def _show(_i):
|
||||
x = int(width*_i/count)
|
||||
if not hide:
|
||||
STREAM.write(BAR_TEMPLATE % (
|
||||
label, BAR_FILLED_CHAR*x, BAR_EMPTY_CHAR*(width-x), _i, count))
|
||||
STREAM.flush()
|
||||
|
||||
count = len(it)
|
||||
|
||||
if count:
|
||||
_show(0)
|
||||
|
||||
for i, item in enumerate(it):
|
||||
|
||||
yield item
|
||||
_show(i+1)
|
||||
|
||||
if not hide:
|
||||
sys.stdout.write("\n")
|
||||
sys.stdout.flush()
|
||||
STREAM.write('\n')
|
||||
STREAM.flush()
|
||||
|
||||
|
||||
def dots(it, label='', hide=False):
|
||||
"""Progress iterator. Prints a dot for each item being iterated"""
|
||||
|
||||
count = 0
|
||||
|
||||
if not hide:
|
||||
STREAM.write(label)
|
||||
|
||||
for item in it:
|
||||
if not hide:
|
||||
STREAM.write(DOTS_CHAR)
|
||||
sys.stderr.flush()
|
||||
|
||||
count += 1
|
||||
|
||||
yield item
|
||||
|
||||
STREAM.write('\n')
|
||||
STREAM.flush()
|
||||
|
||||
|
||||
+3
-3
@@ -1,11 +1,11 @@
|
||||
#!/usr/bin/env python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
from __future__ import with_statement
|
||||
|
||||
import sys
|
||||
import os
|
||||
|
||||
from __future__ import with_statement
|
||||
|
||||
sys.path.insert(0, os.path.abspath('..'))
|
||||
|
||||
from clint import piped_in
|
||||
@@ -23,4 +23,4 @@ if __name__ == '__main__':
|
||||
with indent(5, quote=colored.red(' |')):
|
||||
puts(in_data)
|
||||
else:
|
||||
puts(colored.red('Warning: ') + 'No data was piped in.')
|
||||
puts(colored.red('Warning: ') + 'No data was piped in.')
|
||||
|
||||
@@ -8,12 +8,13 @@ sys.path.insert(0, os.path.abspath('..'))
|
||||
|
||||
from time import sleep
|
||||
from random import random
|
||||
from clint.textui import progressbar
|
||||
from clint.textui import progress
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
for i in progressbar(range(100)):
|
||||
for i in progress.bar(range(100)):
|
||||
sleep(random() * 0.2)
|
||||
|
||||
|
||||
for i in progress.dots(range(100)):
|
||||
sleep(random() * 0.2)
|
||||
|
||||
Reference in New Issue
Block a user