ttystatus-0.23/0000755000175000017500000000000012160413240013377 5ustar jenkinsjenkinsttystatus-0.23/doc/0000755000175000017500000000000012160413240014144 5ustar jenkinsjenkinsttystatus-0.23/doc/_build/0000755000175000017500000000000012160413240015402 5ustar jenkinsjenkinsttystatus-0.23/doc/_static/0000755000175000017500000000000012160413240015572 5ustar jenkinsjenkinsttystatus-0.23/doc/_templates/0000755000175000017500000000000012160413240016301 5ustar jenkinsjenkinsttystatus-0.23/doc/conf.py0000644000175000017500000001440412160413240015446 0ustar jenkinsjenkins# -*- coding: utf-8 -*- # # ttystatus documentation build configuration file, created by # sphinx-quickstart on Fri Jun 24 17:38:08 2011. # # This file is execfile()d with the current directory set to its containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import sys, os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. sys.path.insert(0, os.path.abspath('.')) sys.path.insert(0, os.path.abspath('..')) # -- General configuration ----------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.autodoc'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. #source_encoding = 'utf-8' # The master toctree document. master_doc = 'index' # General information about the project. project = u'ttystatus' copyright = u'2011, Lars Wirzenius' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. import ttystatus version = ttystatus.__version__ # The full version, including alpha/beta/rc tags. release = version # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. #today_fmt = '%B %d, %Y' # List of documents that shouldn't be included in the build. #unused_docs = [] # List of directories, relative to source directory, that shouldn't be searched # for source files. exclude_trees = ['_build'] # The reST default role (used for this markup: `text`) to use for all documents. #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). #add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # -- Options for HTML output --------------------------------------------------- # The theme to use for HTML and HTML Help pages. Major themes that come with # Sphinx are currently 'default' and 'sphinxdoc'. html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. #html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. #html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. #html_additional_pages = {} # If false, no module index is generated. #html_use_modindex = True # If false, no index is generated. #html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. #html_use_opensearch = '' # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = '' # Output file base name for HTML help builder. htmlhelp_basename = 'ttystatusdoc' # -- Options for LaTeX output -------------------------------------------------- # The paper size ('letter' or 'a4'). #latex_paper_size = 'letter' # The font size ('10pt', '11pt' or '12pt'). #latex_font_size = '10pt' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', 'ttystatus.tex', u'ttystatus Documentation', u'Lars Wirzenius', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. #latex_use_parts = False # Additional stuff for the LaTeX preamble. #latex_preamble = '' # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_use_modindex = True ttystatus-0.23/doc/index.rst0000644000175000017500000000460512160413240016012 0ustar jenkinsjenkins`ttystatus` -- a terminal status library ======================================== ``ttystatus`` is a Python library for showing progress reporting and status updates on terminals, for (Unix) command line programs. Output is automatically adapted to the width of the terminal: truncated if it does not fit, and re-sized if the terminal size changes. Output is provided via widgets. Each widgets formats some data into a suitable form for output. It gets the data either via its initializer, or from key/value pairs maintained by the master object. The values are set by the user. Every time a value is updated, widgets get updated (although the terminal is only updated every so often to give user time to actually read the output). Example ------- Here's an example program that searches for symlinks in a directory tree:: import os import sys import ttystatus ts = ttystatus.TerminalStatus(period=0.1) ts.format('%ElapsedTime() Looking for files: %Counter(pathname) found, ' 'currently in %Pathname(dirname)') pathnames = [] for dirname, subdirs, basenames in os.walk(sys.argv[1]): ts['dirname'] = dirname for basename in basenames: pathname = os.path.join(dirname, basename) ts['pathname'] = pathname pathnames.append(pathname) ts.clear() ts.add(ttystatus.ElapsedTime()) ts.add(ttystatus.Literal(' Finding symlinks: ')) ts.add(ttystatus.Counter('symlink')) ts.add(ttystatus.Literal(' found; now at ')) ts.add(ttystatus.Index('pathname', 'pathnames')) ts.add(ttystatus.Literal(' (')) ts.add(ttystatus.PercentDone('done', 'total', decimals=2)) ts.add(ttystatus.Literal(' done) ')) ts.add(ttystatus.RemainingTime('done', 'total')) ts.add(ttystatus.Literal(' ')) ts.add(ttystatus.ProgressBar('done', 'total')) ts['pathnames'] = pathnames ts['done'] = 0 ts['total'] = len(pathnames) for pathname in pathnames: ts['pathname'] = pathname if os.path.islink(pathname): ts['symlink'] = pathname ts.notify('Symlink! %s' % pathname) ts['done'] += 1 ts.finish() (See also the file ``example.py`` in the source distribution.) Reference manual ================ .. automodule:: ttystatus :members: :undoc-members: Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` ttystatus-0.23/doc/Makefile0000644000175000017500000000607412160413240015613 0ustar jenkinsjenkins# Makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = BUILDDIR = _build # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest help: @echo "Please use \`make ' where is one of" @echo " html to make standalone HTML files" @echo " dirhtml to make HTML files named index.html in directories" @echo " pickle to make pickle files" @echo " json to make JSON files" @echo " htmlhelp to make HTML files and a HTML help project" @echo " qthelp to make HTML files and a qthelp project" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " changes to make an overview of all changed/added/deprecated items" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" clean: -rm -rf $(BUILDDIR)/* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." pickle: $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(BUILDDIR)/htmlhelp." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ttystatus.qhcp" @echo "To view the help file:" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ttystatus.qhc" latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ "run these through (pdf)latex." changes: $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." ttystatus-0.23/ttystatus/0000755000175000017500000000000012160413240015463 5ustar jenkinsjenkinsttystatus-0.23/ttystatus/__init__.py0000644000175000017500000000223312160413240017574 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . __version__ = '0.23' from messager import Messager from status import TerminalStatus from widget import Widget from literal import Literal from string import String from integer import Integer from pathname import Pathname from bytesize import ByteSize from counter import Counter from index import Index from percent import PercentDone from progressbar import ProgressBar from remtime import RemainingTime from elapsed import ElapsedTime from bytespeed import ByteSpeed import fmt __all__ = locals() ttystatus-0.23/ttystatus/bytesize.py0000644000175000017500000000263512160413240017701 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import ttystatus class ByteSize(ttystatus.Widget): '''Display data size in bytes, KiB, etc.''' static_width = False def __init__(self, name): self.name = name self._bytes = 0 def update(self, ts): self._bytes = ts[self.name] def render(self, width): units = ( (1024**4, 2, 'TiB'), (1024**3, 2, 'GiB'), (1024**2, 2, 'MiB'), (1024**1, 1, 'KiB'), ) for factor, decimals, unit in units: if self._bytes >= factor: return '%.*f %s' % (decimals, float(self._bytes) / float(factor), unit) return '%d B' % self._bytes ttystatus-0.23/ttystatus/bytesize_tests.py0000644000175000017500000000373012160413240021120 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import unittest import ttystatus class ByteSizeTests(unittest.TestCase): def setUp(self): self.w = ttystatus.ByteSize('foo') def test_is_not_static_width(self): self.assertFalse(self.w.static_width) def test_formats_zero_bytes_without_update(self): self.assertEqual(self.w.render(0), '0 B') def test_formats_zero_bytes_correctly(self): self.w.update({ 'foo': 0 }) self.assertEqual(self.w.render(0), '0 B') def test_formats_one_bytes_correctly(self): self.w.update({ 'foo': 1 }) self.assertEqual(self.w.render(0), '1 B') def test_formats_1023_bytes_correctly(self): self.w.update({ 'foo': 1023 }) self.assertEqual(self.w.render(0), '1023 B') def test_formats_1024_bytes_correctly(self): self.w.update({ 'foo': 1024 }) self.assertEqual(self.w.render(0), '1.0 KiB') def test_formats_1_MiB_bytes_correctly(self): self.w.update({ 'foo': 1024**2 }) self.assertEqual(self.w.render(0), '1.00 MiB') def test_formats_1_GiB_bytes_correctly(self): self.w.update({ 'foo': 1024**3 }) self.assertEqual(self.w.render(0), '1.00 GiB') def test_formats_1_TiB_bytes_correctly(self): self.w.update({ 'foo': 1024**4 }) self.assertEqual(self.w.render(0), '1.00 TiB') ttystatus-0.23/ttystatus/bytespeed.py0000644000175000017500000000445112160413240020025 0ustar jenkinsjenkins# Copyright 2010, 2012 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import time import ttystatus class ByteSpeed(ttystatus.Widget): '''Display data size in bytes, KiB, etc.''' static_width = False def __init__(self, name, duration=None): self.name = name self._duration = None if duration is None else float(duration) self._data_points = [] def now(self): # pragma: no cover '''Wrapper around time.time for unit tests to overrride.''' return time.time() def render(self, width): units = ( (1024**4, 2, 'TiB/s'), (1024**3, 2, 'GiB/s'), (1024**2, 2, 'MiB/s'), (1024**1, 1, 'KiB/s'), ) if len(self._data_points) < 2: return '0 B/s' oldest_bytes, started = self._data_points[0] latest_bytes, dummy = self._data_points[-1] bytes = latest_bytes - oldest_bytes duration = self.now() - started speed = bytes / duration for factor, decimals, unit in units: if speed >= factor: return '%.*f %s' % (decimals, float(speed) / float(factor), unit) return '%.0f B/s' % speed def update(self, master): bytes = master[self.name] now = self.now() self._data_points.append((bytes, now)) if self._duration is None: if len(self._data_points) > 2: del self._data_points[1:-1] else: cutoff = now - self._duration while self._data_points[0][1] < cutoff: del self._data_points[0] ttystatus-0.23/ttystatus/bytespeed_tests.py0000644000175000017500000000507212160413240021247 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import unittest import ttystatus class ByteSpeedTests(unittest.TestCase): def setUp(self): self.w = ttystatus.ByteSpeed('foo') def test_is_not_static_width(self): self.assertFalse(self.w.static_width) def test_formats_zero_speed_without_update(self): self.assertEqual(self.w.render(0), '0 B/s') def test_formats_zero_bytes_correctly(self): self.w.now = lambda: 1 self.w.update({ 'foo': 0 }) self.w.now = lambda: 2 self.w.update({ 'foo': 0 }) self.assertEqual(self.w.render(0), '0 B/s') def test_formats_one_byte_per_second_correctly(self): self.w.now = lambda: 1 self.w.update({ 'foo': 0 }) self.w.now = lambda: 2 self.w.update({ 'foo': 1 }) self.assertEqual(self.w.render(0), '1 B/s') def test_formats_ten_bytes_per_second_correctly(self): self.w.now = lambda: 1 self.w.update({ 'foo': 0 }) self.w.now = lambda: 11 self.w.update({ 'foo': 100 }) self.assertEqual(self.w.render(0), '10 B/s') def test_formats_ten_tibs_per_second_correctly(self): self.w.now = lambda: 1 self.w.update({ 'foo': 0 }) self.w.now = lambda: 2 self.w.update({ 'foo': 10 * 1024**4 }) self.assertEqual(self.w.render(0), '10.00 TiB/s') def test_keeps_only_two_data_points_with_infinite_duration(self): for when in range(100): self.w.now = lambda: when self.w.update({ 'foo': 0 }) self.assertEqual(self.w.render(0), '0 B/s') def test_shows_current_speed_when_requested(self): items = [ (0, 0), (1, 1024), (10, 1024), (11, 1024), ] w = ttystatus.ByteSpeed('foo', duration=5) for when, bytes in items: w.now = lambda: when w.update({ 'foo': bytes }) self.assertEqual(w.render(0), '0 B/s') ttystatus-0.23/ttystatus/counter.py0000644000175000017500000000216312160413240017516 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import ttystatus class Counter(ttystatus.Widget): '''Display a count of how many times a value has changed.''' static_width = False def __init__(self, name): self.name = name self.prev = None self.count = 0 def render(self, width): return str(self.count) def update(self, master): if master[self.name] != self.prev: self.prev = master[self.name] self.count += 1 ttystatus-0.23/ttystatus/counter_tests.py0000644000175000017500000000267212160413240020745 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import unittest import ttystatus class CounterTests(unittest.TestCase): def setUp(self): self.w = ttystatus.Counter('foo') def test_is_not_static_width(self): self.assertFalse(self.w.static_width) def test_counts_zero_initially(self): self.assertEqual(self.w.render(0), '0') def test_counts_one_change(self): self.w.update({ 'foo': 'a' }) self.assertEqual(self.w.render(0), '1') def test_counts_two_changes(self): self.w.update({ 'foo': 'a' }) self.w.update({ 'foo': 'b' }) self.assertEqual(self.w.render(0), '2') def test_does_not_count_if_value_does_not_change(self): self.w.update({ 'foo': 'a' }) self.w.update({ 'foo': 'a' }) self.assertEqual(self.w.render(0), '1') ttystatus-0.23/ttystatus/elapsed.py0000644000175000017500000000257312160413240017461 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import time import ttystatus class ElapsedTime(ttystatus.Widget): '''Display elapsed time since widget was first updated.''' def __init__(self): self.started = None self.secs = 0 def get_time(self): # pragma: no cover '''Wrapper around time.time() for unit tests to override.''' return time.time() def render(self, width): secs = self.secs hours = secs / 3600 secs %= 3600 mins = secs / 60 secs %= 60 return '%02dh%02dm%02ds' % (hours, mins, secs) def update(self, master): if self.started is None: self.started = self.get_time() self.secs = self.get_time() - self.started ttystatus-0.23/ttystatus/elapsed_tests.py0000644000175000017500000000261212160413240020675 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import unittest import ttystatus class ElapsedtimeTests(unittest.TestCase): def setUp(self): self.w = ttystatus.ElapsedTime() def test_is_static_width(self): self.assertTrue(self.w.static_width) def test_shows_zero_initially(self): self.assertEqual(self.w.render(0), '00h00m00s') def test_shows_zero_after_first_update(self): self.w.get_time = lambda: 1 self.w.update({}) self.assertEqual(self.w.render(0), '00h00m00s') def test_shows_one_one_one_after_second_update(self): self.w.get_time = lambda: 0 self.w.update({}) self.w.get_time = lambda: 60*60 + 60 + 1 self.w.update({}) self.assertEqual(self.w.render(0), '01h01m01s') ttystatus-0.23/ttystatus/fmt.py0000644000175000017500000000374012160413240016627 0ustar jenkinsjenkins# Copyright 2011 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import inspect import re import ttystatus def _find_widgets(): names = dir(ttystatus) objs = [getattr(ttystatus, x) for x in names] classes = [o for o in objs if inspect.isclass(o)] widgets = [c for c in classes if issubclass(c, ttystatus.Widget)] subclasses = [w for w in widgets if w != ttystatus.Widget] return subclasses widgets = _find_widgets() def parse(fmt): '''Parse format string.''' names = [x.__name__ for x in widgets] namespat = '|'.join(names) argspat = r'[0-9a-zA-Z,_-]*' pat = r'%%(?P%s)\((?P%s)\)' % (namespat, argspat) pat = re.compile(pat) result = [] prefix = '' while fmt: m = pat.match(fmt) if m: if prefix: result.append(ttystatus.Literal(prefix)) prefix = '' klass = getattr(ttystatus, m.group('class')) argnames = m.group('args').split(',') argnames = [x for x in argnames if x] result.append(klass(*argnames)) fmt = fmt[m.end():] elif fmt.startswith('%%'): prefix += '%' fmt = fmt[2:] else: prefix += fmt[0] fmt = fmt[1:] if prefix: result.append(ttystatus.Literal(prefix)) return result ttystatus-0.23/ttystatus/fmt_tests.py0000644000175000017500000000461612160413240020054 0ustar jenkinsjenkins# Copyright 2011 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import unittest import ttystatus class FormatTests(unittest.TestCase): def test_knows_widgets(self): self.assertEqual(type(ttystatus.fmt.widgets), list) self.assert_(len(ttystatus.fmt.widgets) > 0) for widget in ttystatus.fmt.widgets: self.assert_(issubclass(widget, ttystatus.Widget)) self.assertNotEqual(widget, ttystatus.Widget) def test_parses_string_without_widgets(self): x = ttystatus.fmt.parse('hello, world') self.assertEqual(len(x), 1) self.assertEqual(type(x[0]), ttystatus.Literal) self.assertEqual(x[0].render(0), 'hello, world') def test_parses_escaped_pecent(self): x = ttystatus.fmt.parse('%%') self.assertEqual(len(x), 1) self.assertEqual(type(x[0]), ttystatus.Literal) self.assertEqual(x[0].render(0), '%') def test_parses_parameterless_widget(self): x = ttystatus.fmt.parse('%ElapsedTime()') self.assertEqual(len(x), 1) self.assertEqual(type(x[0]), ttystatus.ElapsedTime) def test_parses_widget_with_one_parameter(self): x = ttystatus.fmt.parse('%String(name)') self.assertEqual(len(x), 1) self.assertEqual(type(x[0]), ttystatus.String) self.assertEqual(x[0]._key, 'name') def test_parses_some_widgets(self): x = ttystatus.fmt.parse('hello, %String(name): %ElapsedTime()') self.assertEqual(len(x), 4) self.assertEqual(type(x[0]), ttystatus.Literal) self.assertEqual(x[0].render(0), 'hello, ') self.assertEqual(type(x[1]), ttystatus.String) self.assertEqual(type(x[2]), ttystatus.Literal) self.assertEqual(x[2].render(0), ': ') self.assertEqual(type(x[3]), ttystatus.ElapsedTime) ttystatus-0.23/ttystatus/index.py0000644000175000017500000000243512160413240017150 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import ttystatus class Index(ttystatus.Widget): '''Display the position of a value in a list of values.''' static_width = False def __init__(self, name, listname): self.name = name self.listname = listname self.value = None self.listvalue = [] def render(self, render): try: index = self.listvalue.index(self.value) + 1 except ValueError: index = 0 return '%d/%d' % (index, len(self.listvalue)) def update(self, master): self.value = master[self.name] self.listvalue = master[self.listname] ttystatus-0.23/ttystatus/index_tests.py0000644000175000017500000000245312160413240020372 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import unittest import ttystatus class IndexTests(unittest.TestCase): def setUp(self): self.w = ttystatus.Index('foo', 'foos') def test_is_not_static_width(self): self.assertFalse(self.w.static_width) def test_is_zero_initially(self): self.assertEqual(self.w.render(0), '0/0') def test_gets_index_right(self): self.w.update({ 'foo': 'x', 'foos': ['a', 'x', 'b'] }) self.assertEqual(self.w.render(0), '2/3') def test_handles_value_not_in_list(self): self.w.update({ 'foo': 'xxx', 'foos': ['a', 'x', 'b'] }) self.assertEqual(self.w.render(0), '0/3') ttystatus-0.23/ttystatus/integer.py0000644000175000017500000000211712160413240017473 0ustar jenkinsjenkins# Copyright 2011 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import ttystatus class Integer(ttystatus.Widget): '''Display a value as an integer.''' static_width = False def __init__(self, key): self._key = key self.value = None def render(self, width): try: return str(int(self.value)) except (TypeError, ValueError): return '#' def update(self, master): self.value = master[self._key] ttystatus-0.23/ttystatus/integer_tests.py0000644000175000017500000000237012160413240020716 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import unittest import ttystatus class IntegerTests(unittest.TestCase): def setUp(self): self.w = ttystatus.Integer('foo') def test_is_not_static_width(self): self.assertFalse(self.w.static_width) def test_is_error_initially(self): self.assertEqual(self.w.render(0), '#') def test_updates(self): self.w.update({'foo': 123}) self.assertEqual(self.w.render(0), '123') def test_becomes_error_symbol_if_value_is_not_integer(self): self.w.update({'foo': 'bar'}) self.assertEqual(self.w.render(0), '#') ttystatus-0.23/ttystatus/literal.py0000644000175000017500000000156412160413240017477 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import ttystatus class Literal(ttystatus.Widget): '''Display a literal string.''' def __init__(self, string): self.value = string def render(self, width): return self.value ttystatus-0.23/ttystatus/literal_tests.py0000644000175000017500000000173312160413240020717 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import unittest import ttystatus class LiteralTests(unittest.TestCase): def setUp(self): self.w = ttystatus.Literal('foo') def test_is_static_width(self): self.assertTrue(self.w.static_width) def test_sets_value_correctly(self): self.assertEqual(self.w.render(0), 'foo') ttystatus-0.23/ttystatus/messager.py0000644000175000017500000001230312160413240017642 0ustar jenkinsjenkins# Copyright 2010, 2011 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import fcntl import struct import sys import termios import time class Messager(object): '''Write messages to the terminal.''' def __init__(self, output=None, period=None, open_tty=None, fake_width=False): self._enabled = True if output: self.output = output else: try: self.output = (open_tty or self._open_tty)() except IOError: self.output = None self._period = 1.0 if period is None else period self._last_msg = '' # What did we write last? self._last_time = 0 # When did we write last? self._cached_msg = '' # Last message from user, to write() method. self._fake_width = fake_width self.set_width(self._get_terminal_width()) # Width of terminal def _open_tty(self): # pragma: no cover return open('/dev/tty', 'w') def set_width(self, actual_width): self.width = actual_width - 1 def _now(self): '''Return current time.''' # This is a wrapper around time.time(), for testing. return time.time() def _get_terminal_width(self): # pragma: no cover '''Return width of terminal in characters. If this fails, assume 80. Borrowed and adapted from bzrlib. ''' default_width = 80 if self._fake_width: if hasattr(self, 'width'): return self.width return default_width if self.output is None: return default_width try: s = struct.pack('HHHH', 0, 0, 0, 0) x = fcntl.ioctl(self.output.fileno(), termios.TIOCGWINSZ, s) return struct.unpack('HHHH', x)[1] except IOError: return default_width except AttributeError: if not hasattr(self.output, 'fileno'): return default_width raise def update_width(self): # pragma: no cover new_width = self._get_terminal_width() if new_width != self.width: # Clear the terminal from old stuff, using the old width. self.clear() # Get new width. self.set_width(new_width) self._overwrite(self._last_msg) def _raw_write(self, string): '''Write raw data if output is terminal.''' if self._enabled and self.output and self.output.isatty(): try: self.output.write(string) self.output.flush() except IOError: # pragma: no cover self._enabled = False def _overwrite(self, string): '''Overwrite current message on terminal.''' if self._last_msg: self._raw_write('\r' + (' ' * len(self._last_msg)) + '\r') self._raw_write(string) self._last_msg = string def time_to_write(self): '''Is it time to write now?''' return self._now() - self._last_time >= self._period def write(self, string): '''Write raw data, always.''' self.update_width() string = string[:self.width] self._overwrite(string) self._last_time = self._now() self._cached_msg = string def clear(self): '''Remove current message from terminal.''' self._overwrite('') def notify(self, string, f, force=False): '''Show a notification message string to the user. Notifications are meant for error messages and other things that do not belong in, say, progress bars. Whatever is currently on the terminal is wiped, then the notification message is shown, a new line is started, and the old message is restored. Notifications are written even when the output is not going to a terminal. ''' if self._enabled or force: old = self._last_msg self.clear() try: f.write('%s\n' % string) f.flush() except IOError: # We ignore these. No point in crashing if terminal is bad. pass self._overwrite(old) def finish(self): '''Finalize output.''' if self._last_msg or self._cached_msg: self._overwrite(self._cached_msg) self._raw_write('\n') def disable(self): '''Disable all output.''' self._enabled = False def enable(self): '''Enable output to happen.''' self._enabled = True ttystatus-0.23/ttystatus/messager_tests.py0000644000175000017500000001033012160413240021062 0ustar jenkinsjenkins# Copyright 2010, 2011 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import StringIO import unittest import ttystatus class DummyTerminal(StringIO.StringIO): def isatty(self): return True class MessagerTests(unittest.TestCase): def setUp(self): self.output = DummyTerminal() self.messager = ttystatus.Messager(output=self.output, fake_width=True) def fast_time(self): return self.messager._last_time + self.messager._period def test_sets_output(self): self.assertEqual(self.messager.output, self.output) def test_handles_no_tty(self): def notty(): raise IOError() m = ttystatus.Messager(open_tty=notty) self.assertEqual(m.output, None) def test_raw_writes_nothing_if_output_is_not_a_terminal(self): self.messager.output = StringIO.StringIO() self.messager._raw_write('foo') self.assertEqual(self.messager.output.getvalue(), '') def test_raw_writes_something_if_output_is_not_a_terminal(self): self.messager._raw_write('foo') self.assertEqual(self.output.getvalue(), 'foo') def test_knows_it_is_time_to_write_at_start(self): self.assert_(self.messager.time_to_write()) def test_knows_it_is_not_time_to_write_right_after_previous_one(self): self.messager._last_time = self.messager._now() self.assertFalse(self.messager.time_to_write()) def test_knows_it_is_time_to_write_after_a_period(self): self.messager._last_time = (self.messager._now() - self.messager._period*2) self.assert_(self.messager.time_to_write()) def test_cached_write_writes_first_thing(self): self.messager.write('foo') self.assertEqual(self.output.getvalue(), 'foo') def test_write_removes_old_message(self): self.messager._now = self.fast_time self.messager.write('foo') self.messager.write('bar') self.assertEqual(self.output.getvalue(), 'foo\r \rbar') def test_clear_removes_message(self): self.messager._now = lambda: self.messager._period + 1 self.messager.write('foo') self.messager.clear() self.assertEqual(self.output.getvalue(), 'foo\r \r') def test_notify_removes_message_and_puts_it_back_afterwards(self): f = StringIO.StringIO() self.messager.write('foo') self.messager.notify('bar', f) self.assertEqual(self.output.getvalue(), 'foo\r \rfoo') self.assertEqual(f.getvalue(), 'bar\n') def test_notify_does_not_mind_ioerror(self): f = open('/dev/full', 'w') self.messager.write('foo') self.messager.notify('bar', f) self.assertEqual(self.output.getvalue(), 'foo\r \rfoo') f.close() def test_finish_flushes_unwritten_message(self): self.messager._now = lambda: 0 self.messager.write('foo') self.messager.finish() self.assertEqual(self.output.getvalue(), 'foo\r \rfoo\n') def test_has_width(self): self.assertEqual(self.messager.width, 79) def test_write_truncates_at_one_less_than_width(self): self.messager.set_width(4) self.messager.write('foobar') self.assertEqual(self.output.getvalue(), 'foo') def test_disables_output(self): self.messager.disable() self.messager.write('foo') self.assertEqual(self.output.getvalue(), '') def test_enables_output(self): self.messager.disable() self.messager.enable() self.messager.write('foo') self.assertEqual(self.output.getvalue(), 'foo') ttystatus-0.23/ttystatus/pathname.py0000644000175000017500000000213512160413240017633 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import ttystatus class Pathname(ttystatus.Widget): '''Display a pathname. If it won't fit completely, truncate from the beginning of the string. ''' static_width = False def __init__(self, key): self._key = key self.pathname = '' def render(self, width): return self.pathname[-width:] def update(self, master): self.pathname = master.get(self._key, '') ttystatus-0.23/ttystatus/pathname_tests.py0000644000175000017500000000257112160413240021061 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import unittest import ttystatus class PathnameTests(unittest.TestCase): def setUp(self): self.w = ttystatus.Pathname('foo') def test_is_not_static_width(self): self.assertFalse(self.w.static_width) def test_is_empty_initially(self): self.assertEqual(self.w.render(10), '') def test_updates(self): self.w.update({'foo': 'bar'}) self.assertEqual(self.w.render(10), 'bar') def test_handles_update_to_other_value(self): self.w.update({'other': 1}) self.assertEqual(self.w.render(10), '') def test_truncates_from_beginning(self): self.w.update({'foo': '/this/is/a/path'}) self.assertEqual(self.w.render(6), 'a/path') ttystatus-0.23/ttystatus/percent.py0000644000175000017500000000264712160413240017506 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import ttystatus class PercentDone(ttystatus.Widget): '''Display percent of task done.''' static_width = False def __init__(self, done_name, total_name, decimals=0): self.done_name = done_name self.total_name = total_name self.decimals = decimals self.done = 0 self.total = 1 def render(self, render): try: done = float(self.done) total = float(self.total) except ValueError: done = 0 total = 1 if total < 0.001: total = 1 return '%.*f %%' % (self.decimals, 100.0 * done / total) def update(self, master): self.done = master[self.done_name] self.total = master[self.total_name] ttystatus-0.23/ttystatus/percent_tests.py0000644000175000017500000000267112160413240020725 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import unittest import ttystatus class PercentDoneTests(unittest.TestCase): def setUp(self): self.w = ttystatus.PercentDone('done', 'total', decimals=1) def test_is_not_static_width(self): self.assertFalse(self.w.static_width) def test_shows_zero_value_initially(self): self.assertEqual(self.w.render(0), '0.0 %') def test_sets_value(self): self.w.update({ 'done': 50, 'total': 100 }) self.assertEqual(self.w.render(0), '50.0 %') def test_handles_empty_strings_as_values(self): self.w.update({ 'done': '', 'total': '' }) self.assertEqual(self.w.render(0), '0.0 %') def test_handles_zero_total(self): self.w.update({ 'done': 0, 'total': 0 }) self.assertEqual(self.w.render(0), '0.0 %') ttystatus-0.23/ttystatus/progressbar.py0000644000175000017500000000274512160413240020376 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import ttystatus class ProgressBar(ttystatus.Widget): '''Display a progress bar.''' static_width = False def __init__(self, done_name, total_name): self.done_name = done_name self.total_name = total_name self.done = 0 self.total = 1 def render(self, width): try: done = float(self.done) total = float(self.total) except ValueError: done = 0 total = 1 if total == 0: fraction = 0 else: fraction = done / total n_stars = int(round(fraction * width)) n_dashes = int(width - n_stars) return ('#' * n_stars) + ('-' * n_dashes) def update(self, master): self.done = master[self.done_name] self.total = master[self.total_name] ttystatus-0.23/ttystatus/progressbar_tests.py0000644000175000017500000000454112160413240021614 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import unittest import ttystatus class ProgressBarTests(unittest.TestCase): def setUp(self): self.w = ttystatus.ProgressBar('done', 'total') self.width = 10 def test_is_not_static_width(self): self.assertFalse(self.w.static_width) def test_sets_initial_value_to_empty(self): self.assertEqual(self.w.render(self.width), '-' * 10) def test_shows_zero_percent_for_empty_string_total(self): self.w.update({ 'done': 1, 'total': '' }) self.assertEqual(self.w.render(self.width), '-' * 10) def test_shows_zero_percent_for_zero_total(self): self.w.update({ 'done': 1, 'total': 0 }) self.assertEqual(self.w.render(self.width), '-' * 10) def test_shows_zero_percent_correctly(self): self.w.update({ 'done': 0, 'total': 100 }) self.assertEqual(self.w.render(self.width), '-' * 10) def test_shows_one_percent_correctly(self): self.w.update({ 'done': 1, 'total': 100 }) self.assertEqual(self.w.render(self.width), '-' * 10) def test_shows_ten_percent_correctly(self): self.w.update({ 'done': 10, 'total': 100 }) self.assertEqual(self.w.render(self.width), '#' + '-' * 9) def test_shows_ninety_percent_correctly(self): self.w.update({ 'done': 90, 'total': 100 }) self.assertEqual(self.w.render(self.width), '#' * 9 + '-') def test_shows_ninety_ine_percent_correctly(self): self.w.update({ 'done': 99, 'total': 100 }) self.assertEqual(self.w.render(self.width), '#' * 10) def test_shows_one_hundred_percent_correctly(self): self.w.update({ 'done': 100, 'total': 100 }) self.assertEqual(self.w.render(self.width), '#' * 10) ttystatus-0.23/ttystatus/remtime.py0000644000175000017500000000371412160413240017504 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import time import ttystatus class RemainingTime(ttystatus.Widget): '''Display an estimate of the remaining time.''' def __init__(self, done_name, total_name): self.done_name = done_name self.total_name = total_name self.started = None self.default = '--h--m--s' self.done = 0 self.total = 1 def get_time(self): # pragma: no cover '''Return current time. This is just a wrapper around time.time() so that it is easier to override during unit tests. ''' return time.time() def render(self, render): if self.started is None: self.started = self.get_time() duration = self.get_time() - self.started if duration >= 1.0: speed = self.done / duration remaining = self.total - self.done if speed > 0: secs = remaining / speed hours = secs / (60 * 60) secs %= (60 * 60) mins = secs / 60 secs %= 60 return '%02dh%02dm%02ds' % (hours, mins, secs) return self.default def update(self, master): self.done = master[self.done_name] self.total = master[self.total_name] ttystatus-0.23/ttystatus/remtime_tests.py0000644000175000017500000000414112160413240020721 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import unittest import ttystatus class RemainingTimeTests(unittest.TestCase): def setUp(self): self.w = ttystatus.RemainingTime('done', 'total') self.w.get_time = lambda: 0.0 def test_is_static_width(self): self.assertTrue(self.w.static_width) def test_is_dashes_initially(self): self.assertEqual(self.w.render(0), '--h--m--s') def test_estimates_and_formats_correctly(self): self.assertEqual(self.w.render(0), '--h--m--s') self.w.update({ 'done': 0, 'total': 100 }) self.w.get_time = lambda: 5.0 self.w.update({ 'done': 5, 'total': 100 }) self.assertEqual(self.w.render(0), '00h01m35s') self.w.get_time = lambda: 10.0 self.w.update({ 'done': 5, 'total': 100 }) self.assertEqual(self.w.render(0), '00h03m10s') self.w.get_time = lambda: 20.0 self.w.update({ 'done': 80, 'total': 100 }) self.assertEqual(self.w.render(0), '00h00m05s') def test_handles_zero_speed(self): self.w.update({ 'done': 0, 'total': 100 }) self.w.get_time = lambda: 5.0 self.w.update({ 'done': 0, 'total': 100 }) self.assertEqual(self.w.render(0), '--h--m--s') def test_handles_empty_strings_for_done_and_total(self): self.w.update({ 'done': '', 'total': '' }) self.w.get_time = lambda: 5.0 self.w.update({ 'done': '', 'total': '' }) self.assertEqual(self.w.render(0), '--h--m--s') ttystatus-0.23/ttystatus/status.py0000644000175000017500000001005512160413240017361 0ustar jenkinsjenkins# Copyright 2010, 2011 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import sys import ttystatus class TerminalStatus(object): '''Show status and progress information on a terminal. All output is provided via widgets of various kinds. Many widgets format data that TerminalStatus stores. TerminalStatus provides a dict interface for setting and retrieving data items. Unlike a real dict, getting a value for a key that has not been set does not result in a KeyError exception, but in the empty string being returned. ''' def __init__(self, output=None, period=None, messager=None): self._m = messager or ttystatus.Messager(output=output, period=period) self.clear() def add(self, widget): '''Add a new widget to the status display.''' self._widgets.append(widget) def format(self, format_string): '''Add new widgets based on format string. The format string is taken literally, except that ``%%`` is a literal percent character, and ``%Foo(a,b,c)`` is a widget of type ``Foo`` with parameters a, b, and c. For example: ``format("hello, %String(name)")``. ''' for widget in ttystatus.fmt.parse(format_string): self.add(widget) def clear(self): '''Remove all widgets.''' self._widgets = [] self._values = dict() self._m.clear() def __getitem__(self, key): '''Return value for key, or the empty string.''' return self._values.get(key, '') def get(self, key, default=None): '''Like dict.get.''' return self._values.get(key, default) def __setitem__(self, key, value): '''Set value for key.''' self._values[key] = value for w in self._widgets: w.update(self) if self._m.time_to_write(): self._write() def flush(self): '''Force an update of current state to the screen. This happens even if it is not yet time to output the screen. ''' self._write() def _render(self): '''Render current state of all widgets.''' remaining = self._m.width texts = [None] * len(self._widgets) for i, w in enumerate(self._widgets): if w.static_width: texts[i] = w.render(0) remaining -= len(texts[i]) for i, w in enumerate(self._widgets): if not w.static_width: texts[i] = w.render(remaining) remaining -= len(texts[i]) return (''.join(texts))[:self._m.width] def _write(self): '''Render and output current state of all widgets.''' self._m.write(self._render()) def increase(self, key, delta): '''Increase value for a key by a given amount.''' self[key] = (self[key] or 0) + delta def notify(self, msg): '''Show a message.''' self._m.notify(msg, sys.stdout) def error(self, msg): '''Write an error message.''' self._m.notify(msg, sys.stderr, force=True) def finish(self): '''Finish status display.''' self._write() self._m.finish() def disable(self): '''Disable all output.''' self._m.disable() def enable(self): '''Enable output if it has been disabled.''' self._m.enable() ttystatus-0.23/ttystatus/status_tests.py0000644000175000017500000001215312160413240020604 0ustar jenkinsjenkins# Copyright 2010, 2011 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import StringIO import unittest import ttystatus class DummyMessager(object): width = 80 def __init__(self): self.written = StringIO.StringIO() self.enabled = True def clear(self): pass def time_to_write(self): return True def write(self, string): self.written.write(string) def notify(self, string, f, force=False): pass def finish(self): pass def enable(self): self.enabled = True def disable(self): self.enabled = False class TerminalStatusTests(unittest.TestCase): def setUp(self): self.ts = ttystatus.TerminalStatus(messager=DummyMessager()) def test_has_no_widgets(self): self.assertEqual(self.ts._widgets, []) def test_adds_widget(self): w = ttystatus.Literal('foo') self.ts.add(w) self.assertEqual(self.ts._widgets, [w]) def test_adds_widgets_from_format_string(self): self.ts.format('hello, %String(name)') self.assertEqual(len(self.ts._widgets), 2) self.assertEqual(type(self.ts._widgets[0]), ttystatus.Literal) self.assertEqual(type(self.ts._widgets[1]), ttystatus.String) def test_removes_all_widgets(self): self.ts.add(ttystatus.Literal('foo')) self.ts.clear() self.assertEqual(self.ts._widgets, []) def test_returns_empty_string_for_unknown_value(self): self.assertEqual(self.ts['foo'], '') def test_sets_value(self): self.ts['foo'] = 'bar' self.assertEqual(self.ts['foo'], 'bar') def test_gets_value(self): self.ts['foo'] = 'bar' self.assertEqual(self.ts.get('foo'), 'bar') def test_gets_default_value_for_nonexistent_key(self): self.assertEqual(self.ts.get('foo', 'bar'), 'bar') def test_gets_None_for_nonexistent_key_without_default_value(self): self.assertEqual(self.ts.get('foo'), None) def test_updates_widgets_when_value_is_set(self): w = ttystatus.String('foo') self.ts.add(w) self.assertEqual(w.render(0), '') self.ts['foo'] = 'bar' self.assertEqual(w.render(0), 'bar') def test_increases_value(self): self.ts['foo'] = 10 self.assertEqual(self.ts['foo'], 10) self.ts.increase('foo', 10) self.assertEqual(self.ts['foo'], 20) def test_has_notify_method(self): self.assertEqual(self.ts.notify('foo'), None) def test_has_error_method(self): self.assertEqual(self.ts.error('foo'), None) def test_has_finish_method(self): self.assertEqual(self.ts.finish(), None) def test_flushes(self): self.ts._m.time_to_write = lambda: False self.ts.format('%String(foo)') self.ts['foo'] = 'foo' self.assertEqual(self.ts._m.written.getvalue(), '') self.ts.flush() self.assertEqual(self.ts._m.written.getvalue(), 'foo') def test_disable_calls_messager_disable(self): self.ts.disable() self.assertFalse(self.ts._m.enabled) def test_enable_calls_messager_enable(self): self.ts.disable() self.ts.enable() self.assert_(self.ts._m.enabled) def test_counts_correctly_even_without_rendering(self): w = ttystatus.Counter('value') n = 42 self.ts.add(w) for i in range(n): self.ts['value'] = i self.assertEqual(w.render(0), str(n)) def test_renders_everything_when_there_is_space(self): w1 = ttystatus.Literal('foo') w2 = ttystatus.ProgressBar('done', 'total') self.ts.add(w1) self.ts.add(w2) text = self.ts._render() self.assertEqual(len(text), self.ts._m.width) def test_renders_from_beginning_if_there_is_not_enough_space(self): w1 = ttystatus.Literal('foo') w2 = ttystatus.Literal('bar') self.ts.add(w1) self.ts.add(w2) self.ts._m.width = 4 text = self.ts._render() self.assertEqual(text, 'foob') def test_renders_variable_size_width_according_to_space_keep_static(self): w1 = ttystatus.Literal('foo') w2 = ttystatus.ProgressBar('done', 'total') w3 = ttystatus.Literal('bar') self.ts.add(w1) self.ts.add(w2) self.ts.add(w3) self.ts._m.width = 9 text = self.ts._render() self.assertEqual(text, 'foo---bar') ttystatus-0.23/ttystatus/string.py0000644000175000017500000000176512160413240017354 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import ttystatus class String(ttystatus.Widget): '''Display a value as a string.''' static_width = False def __init__(self, key): self._key = key self.value = '' def render(self, render): return str(self.value) def update(self, master): self.value = master[self._key] ttystatus-0.23/ttystatus/string_tests.py0000644000175000017500000000234212160413240020566 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import unittest import ttystatus class StringTests(unittest.TestCase): def setUp(self): self.s = ttystatus.String('foo') def test_is_not_static_width(self): self.assertFalse(self.s.static_width) def test_is_empty_initially(self): self.assertEqual(self.s.render(0), '') def test_updates(self): self.s.update({'foo': 'bar'}) self.assertEqual(self.s.render(0), 'bar') def test_handles_non_string_value(self): self.s.update({'foo': 123}) self.assertEqual(self.s.render(0), '123') ttystatus-0.23/ttystatus/widget.py0000644000175000017500000000453412160413240017326 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . class Widget(object): '''Base class for ttystatus widgets. Widgets display stuff on screen. The value may depend on data provided by the user (at creation time), or may be computed from one or more values in the TerminalStatus object to which the widget object belongs. There are two steps: * the widget `update` method is called by TerminalStatus whenever any of the values change * the widget `render` method is called by TerminalStatus when it is time to display things Widgets may have a static size, or their size may vary. The ``static_width`` property reveals this. This affects rendering: static sized widgets are rendered at their one static size; variable sized widgets are shrunk, if necessary, to make everything fit into the available space. If it's not possible to shrink enough, widgets are rendered from beginning until the space is full: variable sized widgets are rendered as small as possible in this case. ''' static_width = True def __str__(self): raise NotImplementedError() def render(self, width): '''Format the current value. ``width`` is the available width for the widget. It need not use all of it. If it's not possible for the widget to render itself small enough to fit into the given width, it may return a larger string, but the caller will probably truncate it. This will be called only when the value actually needs to be formatted. ''' return '' def update(self, terminal_status): '''React to changes in values stored in a TerminalStatus.''' ttystatus-0.23/COPYING0000644000175000017500000010451312160413240014436 0ustar jenkinsjenkins GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . ttystatus-0.23/example.py0000644000175000017500000000423412160413240015407 0ustar jenkinsjenkins# Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . '''An example program for ttystatus.''' import os import sys import ttystatus def main(): ts = ttystatus.TerminalStatus(period=0.1) ts.format('%ElapsedTime() Looking for files: %Counter(pathname) found, ' 'currently in %Pathname(dirname)') pathnames = [] for dirname, subdirs, basenames in os.walk(sys.argv[1]): ts['dirname'] = dirname for basename in basenames: pathname = os.path.join(dirname, basename) ts['pathname'] = pathname pathnames.append(pathname) ts.clear() ts.add(ttystatus.ElapsedTime()) ts.add(ttystatus.Literal(' Finding symlinks: ')) ts.add(ttystatus.Counter('symlink')) ts.add(ttystatus.Literal(' found; now at ')) ts.add(ttystatus.Index('pathname', 'pathnames')) ts.add(ttystatus.Literal(' (')) ts.add(ttystatus.PercentDone('done', 'total', decimals=2)) ts.add(ttystatus.Literal(' done) ')) ts.add(ttystatus.RemainingTime('done', 'total')) ts.add(ttystatus.Literal(' ')) ts.add(ttystatus.ProgressBar('done', 'total')) ts['pathnames'] = pathnames ts['done'] = 0 ts['total'] = len(pathnames) for pathname in pathnames: ts['pathname'] = pathname if os.path.islink(pathname): ts['symlink'] = pathname ts.notify('Symlink! %s' % pathname) elif 'error' in pathname: ts.error('Error in pathname: %s' % pathname) ts['done'] += 1 ts.finish() if __name__ == '__main__': main() ttystatus-0.23/Makefile0000644000175000017500000000030312160413240015033 0ustar jenkinsjenkinsall: $(MAKE) -C doc html check: python -m CoverageTestRunner --ignore-missing-from=without-tests rm .coverage clean: rm -f .coverage ttystatus/*.py[co] rm -rf build $(MAKE) -C doc clean ttystatus-0.23/NEWS0000644000175000017500000001007412160413240014100 0ustar jenkinsjenkinsNEWS file for ttystatus ======================= Version 0.23, released 2013-06-19 --------------------------------- * No longer use the SIGWINCH handler, since that causes problems when applications do certain kinds of I/O and the signal interrupts it. Libraries shouldn't install signal handlers like this. Instead, query the terminal width whenever making updates. Version 0.22, released 2013-03-12 --------------------------------- * When the terminal size changes, ttystatus will now update the display at once. Version 0.21, released 2012-09-29 ----------------------------------- * Updated README with information about where the output goes, and that it is restricted to one line. Version 0.20, released 2012-09-23 --------------------------------- * `TerminalStatus.error` now always outputs. Error messages are too valuable to lose. Version 0.19, released 2012-06-30 --------------------------------- * Added a `TerminalStatus.flush` method, to allow forcing an update. Version 0.18, released 2012-05-08 --------------------------------- * `ByteSpeed` can now show average speed over a short period of time (which approximates current speed), instead of over the whole duration of the program. Version 0.17, released 2012-04-15 --------------------------------- * Committed genocide towards whole civilizations of rendering problems. Version 0.16, released 2012-04-08 --------------------------------- * Speed up by avoiding to format widgets until it's time to update. Version 0.15, released 2011-09-17 --------------------------------- * Bugfix: the String widget now handles non-string values. Version 0.14, released 2011-08-31 --------------------------------- * Notifications are written to the standard output, not the terminal. * A method for printing error messages is provided. They are printed to the standard error. * The `PercentDone` class handles zero total amounts better now. * Widgets may now be added using a simple format string. See `ttystatus.TerminalStatus.format` method. Version 0.13, released 2011-08-18 --------------------------------- * No upstream changes, but released with a new upstream version so that Debian packaging does not need to get convoluted. Version 0.12, released 2011-07-24 --------------------------------- * API documentation is now done with Sphinx. * The SIGWINCH signal is now marked as a re-starting one, so that socket I/O is not interrupted when an application uses ttystatus and the terminal is resized. Version 0.11, released 2011-04-23 --------------------------------- * `pydoc ttystatus` now works better: you no longer need to access modules to see the exported classes. Instead, see all of them directly. * A final newline is no longer written out if there has been no output otherwise. Version 0.10, released 2011-03-23 --------------------------------- * Fix handling of /dev/tty not being avilable. This can happen, e.g., when things are run from cron. Version 0.9, released 2011-02-13 -------------------------------- * Add ttystatus.Integer. Version 0.8.1, released 2011-01-30 -------------------------------- * Do not write notifications if output is disabled. Version 0.8, released 2011-01-30 -------------------------------- * Write status output to /dev/tty by default. Version 0.7, released 2010-10-09 -------------------------------- * Fix bug that failed to show the last few updates when .finish() was called. Version 0.6, released 2010-07-13 -------------------------------- * Add ByteSpeed widget. Version 0.5, released 2010-07-07 -------------------------------- * Speed optimization: widgets are now only updated when the values they're interested are updated, and widgets are now only formatted when the result is actually going to be printed. For long-running processes with frequent updates, this saves a lot of unnecessary computation. * Debian packaging fix: Add Python-Version headers. Version 0.4, released 2010-07-05 -------------------------------- * Bugfix: when the output won't fit, and the last widget is a `Pathname`, the last character is no longer chopped off. ttystatus-0.23/README0000644000175000017500000000464612160413240014271 0ustar jenkinsjenkinsProgress and status updates on terminals ======================================== ttystatus is a Python library for showing progress reporting and status updates on terminals, for (Unix) command line programs. Output is automatically adapted to the width of the terminal: truncated if it does not fit, and re-sized if the terminal size changes. Output is provided via widgets. Each widgets formats some data into a suitable form for output. It gets the data either via its initializer, or from key/value pairs maintained by the master object. The values are set by the user. Every time a value is updated, widgets get updated (although the terminal is only updated every so often to give user time to actually read the output). The output from ttystatus goes to the terminal (`/dev/tty`) and is restricted to a single line. See example.py for an example of how to use the library. Installation ------------ * Use Python distutils (setup.py) as usual. * If possible, use the Debian packaging when you can. You will need some other stuff to run automatic tests: * http://liw.fi/coverage-test-runner/ for unit tests. Hacking ------- See for information about version control trees, etc. Run "make check" for unit tests. If you make any changes, run it first, and don't stop fixing things until coverage is 100% again. If you do make any improvements, I would welcome patches. Send me (see http://liw.fi/contact/ for details) a patch, a bzr bundle, or a link to a bzr branch I can merge from. Thanks! Legalese -------- Copyright 2010-2013 Lars Wirzenius This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . See also -------- * http://pypi.python.org/pypi/progressbar/ is another library for this. It is older and more well-established, but, I think, a bit less flexible. For example, it seems to assume there is only one percentage value that gets reported. ttystatus-0.23/setup.py0000644000175000017500000000322112160413240015107 0ustar jenkinsjenkins#!/usr/bin/python # Copyright (C) 2010, 2011 Lars Wirzenius # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License along # with this program; if not, write to the Free Software Foundation, Inc., # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. from distutils.core import setup import ttystatus setup(name='ttystatus', version=ttystatus.__version__, description='terminal progress bar and status output for command line', long_description='''\ The ttystatus Python library provides a simple widget-based way to show progress and current status in command line programs. ''', classifiers=[ 'Development Status :: 3 - Alpha', 'Environment :: Console', 'Intended Audience :: Developers', 'License :: OSI Approved :: GNU General Public License (GPL)', 'Programming Language :: Python :: 2', 'Topic :: Software Development :: Libraries', 'Topic :: Software Development :: User Interfaces', 'Topic :: Terminals', ], author='Lars Wirzenius', author_email='liw@liw.fi', url='http://liw.fi/ttystatus/', packages=['ttystatus'], ) ttystatus-0.23/speed-test0000755000175000017500000000271612160413240015410 0ustar jenkinsjenkins#!/usr/bin/python # Copyright 2010 Lars Wirzenius # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . '''Profile updating of a value, when there are many unrelated widgets.''' import cProfile import ttystatus class FakeTTY(object): def write(self, string): pass def isatty(self): return True def flush(self): pass output = FakeTTY() ts = ttystatus.TerminalStatus(output=output) ts.add(ttystatus.ElapsedTime()) ts.add(ttystatus.Literal(' ')) ts.add(ttystatus.Counter('current-file')) ts.add(ttystatus.Literal(' files found; ')) ts.add(ttystatus.ByteSize('uploaded-bytes')) ts.add(ttystatus.Literal(' uploaded ')) ts.add(ttystatus.Pathname('current-dir')) ts['uploaded-bytes'] = 0 num_updates = 1000*1000 def loop(): for i in xrange(num_updates): ts['updated-bytes'] = i cProfile.run('loop()', 'ttystatus.prof') ttystatus-0.23/without-tests0000644000175000017500000000012412160413240016162 0ustar jenkinsjenkins./ttystatus/__init__.py ./example.py ./ttystatus/widget.py ./setup.py ./doc/conf.py