epydoc.cli._Progress

Package epydoc :: Module cli :: Class _Progress |
[show private | hide private]
[frames | no frames]

## Class _Progress

The progress meter that is used by `cli` to report its progress. It prints the status to `stderrr`. Depending on the verbosity, setting it will produce different outputs.

To update the progress meter, call `report` with the name of the object that is about to be processed.

Method Summary
| ``__init__`(self, action, verbosity, total_items, html_file)` Create a new progress meter.
| ``report`(self, argument)` Update the progress meter.

Method Details

### __init__(self, action, verbosity, total_items, html_file=0) (Constructor) Create a new progress meter. Parameters: `action` - A string indicating what action is performed on each objcet. Examples are `"writing"` and `"building docs for"`. `verbosity` - The verbosity level. This controls what the progress meter output looks like. `total_items` - The total number of items that will be processed with this progress meter. This is used to let the user know how much progress epydoc has made. `html_file` - Whether to assume that arguments are html file names, and munge them appropriately.

### report(self, argument) Update the progress meter. Parameters: `argument` - The object that is about to be processed.

Generated by Epydoc 2.1 on Sat Mar 20 17:46:14 2004 | http://epydoc.sf.net