Index

_

__call__() (humanfriendly.terminal.HTMLConverter method) __enter__() (humanfriendly.AutomaticSpinner method) (humanfriendly.Spinner method) (humanfriendly.testing.CaptureOutput method) (humanfriendly.testing.ContextManager method) (humanfriendly.testing.CustomSearchPath method) (humanfriendly.testing.MockedProgram method) (humanfriendly.testing.PatchedAttribute method) (humanfriendly.testing.PatchedItem method) (humanfriendly.testing.TemporaryDirectory method) (humanfriendly.Timer method) __exit__() (humanfriendly.AutomaticSpinner method) (humanfriendly.Spinner method) (humanfriendly.testing.CaptureOutput method) (humanfriendly.testing.ContextManager method) (humanfriendly.testing.CustomSearchPath method) (humanfriendly.testing.MockedProgram method) (humanfriendly.testing.PatchedAttribute method) (humanfriendly.testing.PatchedItem method) (humanfriendly.testing.TemporaryDirectory method) (humanfriendly.Timer method) __getnewargs__() (humanfriendly.CombinedUnit method) (humanfriendly.SizeUnit method)

__init__() (humanfriendly.AutomaticSpinner method) (humanfriendly.compat.HTMLParser method) (humanfriendly.Spinner method) (humanfriendly.terminal.HTMLConverter method) (humanfriendly.testing.CaptureOutput method) (humanfriendly.testing.CustomSearchPath method) (humanfriendly.testing.MockedProgram method) (humanfriendly.testing.PatchedAttribute method) (humanfriendly.testing.PatchedItem method) (humanfriendly.testing.TemporaryDirectory method) (humanfriendly.testing.TestCase method) (humanfriendly.Timer method) __new__() (humanfriendly.CombinedUnit static method) (humanfriendly.SizeUnit static method) __repr__() (humanfriendly.CombinedUnit method) (humanfriendly.SizeUnit method) __str__() (humanfriendly.Timer method) _asdict() (humanfriendly.CombinedUnit method) (humanfriendly.SizeUnit method) _make() (humanfriendly.CombinedUnit class method) (humanfriendly.SizeUnit class method) _replace() (humanfriendly.CombinedUnit method) (humanfriendly.SizeUnit method)

A

ANSI_COLOR_CODES (in module humanfriendly.terminal) ANSI_CSI (in module humanfriendly.terminal) ANSI_ERASE_LINE (in module humanfriendly.terminal) ANSI_RESET (in module humanfriendly.terminal) ANSI_SGR (in module humanfriendly.terminal) ansi_strip() (in module humanfriendly.tables) (in module humanfriendly.terminal) ansi_style() (in module humanfriendly.terminal)

ANSI_TEXT_STYLES (in module humanfriendly.terminal) ansi_width() (in module humanfriendly.tables) (in module humanfriendly.terminal) ansi_wrap() (in module humanfriendly.tables) (in module humanfriendly.terminal) assertRaises() (humanfriendly.testing.TestCase method) auto_encode() (in module humanfriendly.terminal) AutomaticSpinner (class in humanfriendly)

B

basestring (in module humanfriendly.compat), [1]

binary (humanfriendly.CombinedUnit attribute) BLOCK_TAGS (humanfriendly.terminal.HTMLConverter attribute)

C

cached() (in module humanfriendly.decorators) CallableTimedOut CaptureOutput (class in humanfriendly.testing) CLEAN_OUTPUT_PATTERN (in module humanfriendly.terminal) clean_terminal_output() (in module humanfriendly.terminal) clear() (humanfriendly.Spinner method) close() (humanfriendly.compat.HTMLParser method) (humanfriendly.compat.StringIO method) (humanfriendly.terminal.HTMLConverter method) coerce_boolean() (in module humanfriendly) coerce_pattern() (in module humanfriendly) coerce_seconds() (in module humanfriendly)

coerce_string() (in module humanfriendly.compat) (in module humanfriendly.tables) CombinedUnit (class in humanfriendly) compact() (in module humanfriendly.testing) (in module humanfriendly.text) compact_empty_lines() (in module humanfriendly.text) concatenate() (in module humanfriendly.text) configure_logging() (in module humanfriendly.testing) connected_to_terminal() (in module humanfriendly.terminal) ContextManager (class in humanfriendly.testing) current_search_path (humanfriendly.testing.CustomSearchPath property) current_style (humanfriendly.terminal.HTMLConverter property) CustomSearchPath (class in humanfriendly.testing)

D

decimal (humanfriendly.CombinedUnit attribute) dedent() (in module humanfriendly.text) (in module humanfriendly.usage) DEFAULT_COLUMNS (in module humanfriendly.terminal)

DEFAULT_ENCODING (in module humanfriendly.terminal) DEFAULT_LINES (in module humanfriendly.terminal) demonstrate_256_colors() (in module humanfriendly.cli) demonstrate_ansi_formatting() (in module humanfriendly.cli) divider (humanfriendly.SizeUnit attribute)

E

elapsed_time (humanfriendly.Timer property) emit_style() (humanfriendly.terminal.HTMLConverter method)

enable_special_methods() (in module humanfriendly.sphinx) enable_usage_formatting() (in module humanfriendly.sphinx) exceptionsToSkip (humanfriendly.testing.TestCase attribute)

F

feed() (humanfriendly.compat.HTMLParser method) find_meta_variables() (in module humanfriendly.usage) find_terminal_size() (in module humanfriendly.tables) (in module humanfriendly.terminal) find_terminal_size_using_ioctl() (in module humanfriendly.terminal) find_terminal_size_using_stty() (in module humanfriendly.terminal) format() (in module humanfriendly.text) format_length() (in module humanfriendly)

format_number() (in module humanfriendly) format_path() (in module humanfriendly) format_pretty_table() (in module humanfriendly.tables) format_robust_table() (in module humanfriendly.tables) format_rst_table() (in module humanfriendly.tables) format_size() (in module humanfriendly) format_smart_table() (in module humanfriendly.tables) format_timespan() (in module humanfriendly) format_usage() (in module humanfriendly.usage)

G

generate_slug() (in module humanfriendly.text) get_pager_command() (in module humanfriendly.terminal)

get_starttag_text() (humanfriendly.compat.HTMLParser method) getvalue() (humanfriendly.compat.StringIO method) (humanfriendly.testing.CaptureOutput method)

H

handle_charref() (humanfriendly.terminal.HTMLConverter method) handle_data() (humanfriendly.terminal.HTMLConverter method) handle_endtag() (humanfriendly.terminal.HTMLConverter method) handle_entityref() (humanfriendly.terminal.HTMLConverter method) handle_starttag() (humanfriendly.terminal.HTMLConverter method) HIGHLIGHT_COLOR (in module humanfriendly.terminal) html_to_ansi() (in module humanfriendly.terminal) HTMLConverter (class in humanfriendly.terminal) HTMLParser (class in humanfriendly.compat) (in module humanfriendly.compat) humanfriendly module humanfriendly.cli module humanfriendly.compat module

humanfriendly.decorators module humanfriendly.prompts module humanfriendly.sphinx module humanfriendly.tables module humanfriendly.terminal module humanfriendly.testing module humanfriendly.text module humanfriendly.usage module

I

import_module() (in module humanfriendly.usage) inject_usage() (in module humanfriendly.usage) interactive_prompt (in module humanfriendly.compat) interactive_prompt() (in module humanfriendly.compat) InvalidDate

InvalidLength InvalidSize InvalidTimespan is_empty_line() (in module humanfriendly.text) is_string() (in module humanfriendly.compat) is_unicode() (in module humanfriendly.compat)

J

join_lines() (in module humanfriendly.text)

M

main() (in module humanfriendly.cli) make_dirs() (in module humanfriendly.testing) MAX_ATTEMPTS (in module humanfriendly.prompts) message() (in module humanfriendly.terminal) MockedProgram (class in humanfriendly.testing) module humanfriendly humanfriendly.cli humanfriendly.compat humanfriendly.decorators humanfriendly.prompts humanfriendly.sphinx humanfriendly.tables humanfriendly.terminal humanfriendly.testing humanfriendly.text humanfriendly.usage

monotonic (in module humanfriendly.compat) monotonic() (in module humanfriendly.compat)

N

name (humanfriendly.SizeUnit attribute)

newlines (humanfriendly.compat.StringIO attribute) normalize_url() (humanfriendly.terminal.HTMLConverter method)

O

output() (in module humanfriendly.terminal)

P

parse_color() (humanfriendly.terminal.HTMLConverter method) parse_date() (in module humanfriendly) parse_length() (in module humanfriendly) parse_path() (in module humanfriendly) parse_size() (in module humanfriendly) parse_timespan() (in module humanfriendly) parse_usage() (in module humanfriendly.usage) PatchedAttribute (class in humanfriendly.testing) PatchedItem (class in humanfriendly.testing) pluralize() (in module humanfriendly.text) prepare_friendly_prompts() (in module humanfriendly.prompts)

prepare_prompt_text() (in module humanfriendly.prompts) print_formatted_length() (in module humanfriendly.cli) print_formatted_number() (in module humanfriendly.cli) print_formatted_size() (in module humanfriendly.cli) print_formatted_table() (in module humanfriendly.cli) print_formatted_timespan() (in module humanfriendly.cli) print_parsed_length() (in module humanfriendly.cli) print_parsed_size() (in module humanfriendly.cli) prompt_for_choice() (in module humanfriendly.prompts) prompt_for_confirmation() (in module humanfriendly.prompts) prompt_for_input() (in module humanfriendly.prompts) push_styles() (humanfriendly.terminal.HTMLConverter method)

R

random_string() (in module humanfriendly.testing) (in module humanfriendly.text) read() (humanfriendly.compat.StringIO method) readable() (humanfriendly.compat.StringIO method) readline() (humanfriendly.compat.StringIO method) readline_strip() (in module humanfriendly.terminal) readline_wrap() (in module humanfriendly.terminal) render_url() (humanfriendly.terminal.HTMLConverter method) render_usage() (in module humanfriendly.usage)

reset() (humanfriendly.compat.HTMLParser method) (humanfriendly.terminal.HTMLConverter method) RESULTS_ATTRIBUTE (in module humanfriendly.decorators) retry() (in module humanfriendly.testing) retry_limit() (in module humanfriendly.prompts) round_number() (in module humanfriendly) rounded (humanfriendly.Timer property) run_cli() (in module humanfriendly.testing) run_command() (in module humanfriendly.cli)

S

seek() (humanfriendly.compat.StringIO method) seekable() (humanfriendly.compat.StringIO method) setUp() (humanfriendly.testing.TestCase method) setup() (in module humanfriendly.sphinx) shouldSkipTest() (humanfriendly.testing.TestCase method) show_pager() (in module humanfriendly.terminal) SizeUnit (class in humanfriendly) skipTest() (humanfriendly.testing.TestCase method) skipTestWrapper() (humanfriendly.testing.TestCase method) sleep() (humanfriendly.Spinner method) (humanfriendly.Timer method)

special_methods_callback() (in module humanfriendly.sphinx) Spinner (class in humanfriendly) split() (in module humanfriendly.text) split_paragraphs() (in module humanfriendly.text) (in module humanfriendly.usage) stderr (humanfriendly.testing.CaptureOutput attribute) stdin (humanfriendly.testing.CaptureOutput attribute) stdout (humanfriendly.testing.CaptureOutput attribute) step() (humanfriendly.Spinner method) StringIO (class in humanfriendly.compat) (in module humanfriendly.compat) symbol (humanfriendly.SizeUnit attribute)

T

tell() (humanfriendly.compat.StringIO method) TemporaryDirectory (class in humanfriendly.testing) terminal_supports_colors() (in module humanfriendly.tables) (in module humanfriendly.terminal) TestCase (class in humanfriendly.testing) Timer (class in humanfriendly)

tokenize() (in module humanfriendly.text) TooManyInvalidReplies touch() (in module humanfriendly.testing) trim_empty_lines() (in module humanfriendly.text) (in module humanfriendly.usage) truncate() (humanfriendly.compat.StringIO method)

U

unichr() (in module humanfriendly.compat) unicode (in module humanfriendly.compat), [1] urls_match() (humanfriendly.terminal.HTMLConverter method)

usage() (in module humanfriendly.terminal) USAGE_MARKER (in module humanfriendly.usage) usage_message_callback() (in module humanfriendly.sphinx)

W

warning() (in module humanfriendly.terminal)

writable() (humanfriendly.compat.StringIO method) write() (humanfriendly.compat.StringIO method)