Skip to content

humanfriendly 10.0

Download JSON

  • PyPI https://pypi.org/project/humanfriendly/

  • py.typed

  • Coverage

    %%{init: {"pie": {"textPosition": 0.85}, "theme": "neutral", "themeVariables": {"pieStrokeWidth": "1px"}}}%%
pie title
    "Typed" : 0
    "Any" : 0
    "Untyped" : 406
    • 0.0% coverage
    • 0.0% coverage (strict)
    • 406 typable
      • 0 typed
      • 406 untyped
      • 0 Any

  • Typables

    %%{init: {"pie": {"textPosition": 0.85}, "theme": "neutral", "themeVariables": {"pieStrokeWidth": "1px"}}}%%
pie title
    "functions" : 269
    "classes" : 107
    "other" : 9
    • 98 functions (+0 overloads)
      • 171 parameters
    • 12 classes
      • 47 methods (+0 overloads)
        • 57 parameters
      • 3 properties
    • 14 modules
      • 9 attrs

Modules

Module Coverage Coverage (strict) Typables Ignores
humanfriendly 0.0% 0.0% 57 0
humanfriendly.case 0.0% 0.0% 34 0
humanfriendly.cli 0.0% 0.0% 23 0
humanfriendly.compat 0.0% 0.0% 8 0
humanfriendly.decorators 0.0% 0.0% 2 0
humanfriendly.deprecation 0.0% 0.0% 18 0
humanfriendly.prompts 0.0% 0.0% 20 0
humanfriendly.sphinx 0.0% 0.0% 50 0
humanfriendly.tables 0.0% 0.0% 14 0
humanfriendly.terminal 0.0% 0.0% 54 0
humanfriendly.terminal.html 0.0% 0.0% 37 0
humanfriendly.terminal.spinners 0.0% 0.0% 34 0
humanfriendly.text 0.0% 0.0% 45 0
humanfriendly.usage 0.0% 0.0% 10 0

Incomplete Annotations

humanfriendly (57 missing, 0 any)

Symbol Typable Typed Any
func format_number 3 0 0
func coerce_boolean 2 0 0
func coerce_pattern 3 0 0
attr time_units 1 0 0
func coerce_seconds 2 0 0
func format_length 3 0 0
func parse_timespan 2 0 0
func format_size 4 0 0
func parse_size 3 0 0
func round_number 3 0 0
attr disk_size_units 1 0 0
func format_path 2 0 0
func parse_date 2 0 0
attr length_size_units 1 0 0
func parse_path 2 0 0
meth Timer.init 3 0 0
meth Timer.enter 1 0 0
meth Timer.exit 4 0 0
meth Timer.sleep 2 0 0
meth Timer.str 1 0 0
prop Timer.elapsed_time 1 0 0
prop Timer.rounded 1 0 0
attr Timer.monotonic 1 0 0
attr Timer.resumable 1 0 0
attr Timer.start_time 1 0 0
attr Timer.total_time 1 0 0
func parse_length 2 0 0
func format_timespan 4 0 0

humanfriendly.case (34 missing, 0 any)

Symbol Typable Typed Any
meth CaseInsensitiveDict.init 3 0 0
meth CaseInsensitiveDict.coerce_key 2 0 0
meth CaseInsensitiveDict.fromkeys 3 0 0
meth CaseInsensitiveDict.get 3 0 0
meth CaseInsensitiveDict.pop 3 0 0
meth CaseInsensitiveDict.setdefault 3 0 0
meth CaseInsensitiveDict.update 3 0 0
meth CaseInsensitiveDict.contains 2 0 0
meth CaseInsensitiveDict.delitem 2 0 0
meth CaseInsensitiveDict.getitem 2 0 0
meth CaseInsensitiveDict.setitem 3 0 0
meth CaseInsensitiveKey.new 2 0 0
meth CaseInsensitiveKey.hash 1 0 0
meth CaseInsensitiveKey.eq 2 0 0

humanfriendly.cli (23 missing, 0 any)

Symbol Typable Typed Any
func demonstrate_ansi_formatting 1 0 0
func print_formatted_timespan 2 0 0
func print_parsed_length 2 0 0
func demonstrate_256_colors 4 0 0
func print_formatted_table 2 0 0
func run_command 2 0 0
func print_formatted_size 3 0 0
func print_formatted_length 2 0 0
func print_parsed_size 2 0 0
func print_formatted_number 2 0 0
func main 1 0 0

humanfriendly.compat (8 missing, 0 any)

Symbol Typable Typed Any
func is_unicode 2 0 0
func is_string 2 0 0
func on_macos 1 0 0
func coerce_string 2 0 0
func on_windows 1 0 0

humanfriendly.decorators (2 missing, 0 any)

Symbol Typable Typed Any
func cached 2 0 0

humanfriendly.deprecation (18 missing, 0 any)

Symbol Typable Typed Any
meth DeprecationProxy.init 3 0 0
meth DeprecationProxy.getattr 2 0 0
meth DeprecationProxy.resolve 2 0 0
attr DeprecationProxy.module 1 0 0
attr DeprecationProxy.aliases 1 0 0
func is_method 2 0 0
func deprecated_args 2 0 0
func get_aliases 2 0 0
func define_aliases 3 0 0

humanfriendly.prompts (20 missing, 0 any)

Symbol Typable Typed Any
func prepare_friendly_prompts 1 0 0
func prompt_for_confirmation 4 0 0
func retry_limit 2 0 0
func prompt_for_input 5 0 0
func prepare_prompt_text 3 0 0
func prompt_for_choice 4 0 0
attr logger 1 0 0

humanfriendly.sphinx (50 missing, 0 any)

Symbol Typable Typed Any
func setup 2 0 0
func enable_special_methods 2 0 0
func special_methods_callback 7 0 0
func enable_man_role 2 0 0
func man_role 8 0 0
func enable_deprecation_notes 2 0 0
func pypi_role 8 0 0
func usage_message_callback 7 0 0
func enable_usage_formatting 2 0 0
func enable_pypi_role 2 0 0
attr logger 1 0 0
func deprecation_note_callback 7 0 0

humanfriendly.tables (14 missing, 0 any)

Symbol Typable Typed Any
func format_robust_table 3 0 0
func format_rst_table 3 0 0
func format_pretty_table 5 0 0
func format_smart_table 3 0 0

humanfriendly.terminal (54 missing, 0 any)

Symbol Typable Typed Any
func ansi_style 2 0 0
func usage 2 0 0
func find_terminal_size_using_ioctl 2 0 0
func ansi_width 2 0 0
func ansi_wrap 3 0 0
func terminal_supports_colors 2 0 0
func enable_ansi_support 1 0 0
func readline_wrap 2 0 0
attr HIGHLIGHT_COLOR 1 0 0
func output 4 0 0
func ansi_strip 3 0 0
func have_windows_native_ansi_support 1 0 0
func auto_encode 5 0 0
func find_terminal_size 1 0 0
func show_pager 3 0 0
func clean_terminal_output 2 0 0
func connected_to_terminal 2 0 0
func readline_strip 2 0 0
func message 4 0 0
attr ANSI_COLOR_CODES 1 0 0
attr ANSI_TEXT_STYLES 1 0 0
func find_terminal_size_using_stty 1 0 0
attr CLEAN_OUTPUT_PATTERN 1 0 0
func warning 4 0 0
func get_pager_command 2 0 0

humanfriendly.terminal.html (37 missing, 0 any)

Symbol Typable Typed Any
meth HTMLConverter.init 3 0 0
meth HTMLConverter.call 2 0 0
meth HTMLConverter.close 1 0 0
meth HTMLConverter.emit_style 2 0 0
meth HTMLConverter.handle_charref 2 0 0
meth HTMLConverter.handle_data 2 0 0
meth HTMLConverter.handle_endtag 2 0 0
meth HTMLConverter.handle_entityref 2 0 0
meth HTMLConverter.handle_starttag 3 0 0
meth HTMLConverter.normalize_url 2 0 0
meth HTMLConverter.parse_color 2 0 0
meth HTMLConverter.push_styles 2 0 0
meth HTMLConverter.render_url 2 0 0
meth HTMLConverter.reset 1 0 0
meth HTMLConverter.urls_match 3 0 0
prop HTMLConverter.current_style 1 0 0
attr HTMLConverter.callback 1 0 0
attr HTMLConverter.output 1 0 0
func html_to_ansi 3 0 0

humanfriendly.terminal.spinners (34 missing, 0 any)

Symbol Typable Typed Any
meth AutomaticSpinner.init 3 0 0
meth AutomaticSpinner.enter 1 0 0
meth AutomaticSpinner.exit 4 0 0
meth AutomaticSpinner._target 1 0 0
attr AutomaticSpinner.label 1 0 0
attr AutomaticSpinner.show_time 1 0 0
attr AutomaticSpinner.shutdown_event 1 0 0
attr AutomaticSpinner.subprocess 1 0 0
meth Spinner.init 2 0 0
meth Spinner.step 3 0 0
meth Spinner.sleep 1 0 0
meth Spinner.clear 1 0 0
meth Spinner.enter 1 0 0
meth Spinner.exit 4 0 0
attr Spinner.interactive 1 0 0
attr Spinner.interval 1 0 0
attr Spinner.label 1 0 0
attr Spinner.states 1 0 0
attr Spinner.stream 1 0 0
attr Spinner.timer 1 0 0
attr Spinner.total 1 0 0
attr Spinner.counter 1 0 0
attr Spinner.last_update 1 0 0

humanfriendly.text (45 missing, 0 any)

Symbol Typable Typed Any
func dedent 4 0 0
func compact_empty_lines 2 0 0
func pluralize_raw 4 0 0
func pluralize 4 0 0
func compact 4 0 0
func is_empty_line 2 0 0
func join_lines 2 0 0
func format 4 0 0
func concatenate 4 0 0
func trim_empty_lines 2 0 0
func split 3 0 0
func random_string 3 0 0
func split_paragraphs 2 0 0
func tokenize 2 0 0
func generate_slug 3 0 0

humanfriendly.usage (10 missing, 0 any)

Symbol Typable Typed Any
func find_meta_variables 2 0 0
func parse_usage 2 0 0
func inject_usage 2 0 0
func render_usage 2 0 0
func format_usage 2 0 0

Type-Ignore Comments

No type-ignore comments.