Skip to content

fire 0.7.1

Download JSON

  • PyPI https://pypi.org/project/fire/
    Repository https://github.com/google/python-fire

  • py.typed

  • Coverage

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

  • Typables

    %%{init: {"pie": {"textPosition": 0.85}, "theme": "neutral", "themeVariables": {"pieStrokeWidth": "1px"}}}%%
pie title
    "functions" : 176
    "classes" : 189
    "other" : 1
    • 61 functions (+0 overloads)
      • 115 parameters
    • 31 classes
      • 84 methods (+0 overloads)
        • 100 parameters
      • 5 properties
    • 21 modules
      • 1 attrs

Modules

Module Coverage Coverage (strict) Typables Ignores
fire.completion 0.0% 0.0% 18 0
fire.console.console_attr 0.0% 0.0% 72 0
fire.console.console_attr_os 0.0% 0.0% 2 0
fire.console.console_io 0.0% 0.0% 9 0
fire.console.console_pager 0.0% 0.0% 10 0
fire.console.encoding 0.0% 0.0% 18 0
fire.console.files 0.0% 0.0% 5 0
fire.console.platforms 0.0% 0.0% 43 0
fire.console.text 0.0% 0.0% 17 0
fire.core 0.0% 0.0% 16 0
fire.custom_descriptions 0.0% 0.0% 18 0
fire.decorators 20.0% 20.0% 10 0
fire.docstrings 0.0% 0.0% 9 0
fire.formatting 0.0% 0.0% 25 0
fire.formatting_windows 0.0% 0.0% 1 0
fire.helptext 0.0% 0.0% 19 0
fire.inspectutils 0.0% 0.0% 29 0
fire.interact 0.0% 0.0% 3 0
fire.parser 0.0% 0.0% 5 0
fire.trace 0.0% 0.0% 62 0
fire.value_types 0.0% 0.0% 11 0

Incomplete Annotations

fire.completion (18 missing, 0 any)

Symbol Typable Typed Any
func VisibleMembers 4 0 0
func Script 5 0 0
func Completions 3 0 0
func MemberVisible 6 0 0

fire.console.console_attr (72 missing, 0 any)

Symbol Typable Typed Any
func Decode 3 0 0
func SafeText 4 0 0
meth Colorizer.init 4 0 0
meth Colorizer.eq 2 0 0
meth Colorizer.ne 2 0 0
meth Colorizer.gt 2 0 0
meth Colorizer.lt 2 0 0
meth Colorizer.ge 2 0 0
meth Colorizer.le 2 0 0
meth Colorizer.len 1 0 0
meth Colorizer.str 1 0 0
meth Colorizer.Render 3 0 0
prop ProgressTrackerSymbolsAscii.spin_marks 1 0 0
meth ConsoleAttr.init 3 0 0
meth ConsoleAttr._GetConsoleEncoding 1 0 0
meth ConsoleAttr.Colorize 4 0 0
meth ConsoleAttr.ConvertOutputToUnicode 2 0 0
meth ConsoleAttr.GetBoxLineCharacters 1 0 0
meth ConsoleAttr.GetBullets 1 0 0
meth ConsoleAttr.GetProgressTrackerSymbols 1 0 0
meth ConsoleAttr.GetControlSequenceIndicator 1 0 0
meth ConsoleAttr.GetControlSequenceLen 2 0 0
meth ConsoleAttr.GetEncoding 1 0 0
meth ConsoleAttr.GetFontCode 3 0 0
meth ConsoleAttr.GetRawKey 1 0 0
meth ConsoleAttr.GetTermIdentifier 1 0 0
meth ConsoleAttr.GetTermSize 1 0 0
meth ConsoleAttr.DisplayWidth 2 0 0
meth ConsoleAttr.SplitIntoNormalAndControl 2 0 0
meth ConsoleAttr.SplitLine 3 0 0
meth ConsoleAttr.SupportsAnsi 1 0 0
func EncodeToBytes 2 0 0
prop ProgressTrackerSymbolsUnicode.spin_marks 1 0 0
attr ProgressTrackerSymbolsUnicode.success 1 0 0
attr ProgressTrackerSymbolsUnicode.failed 1 0 0
func GetCharacterDisplayWidth 2 0 0
func GetConsoleAttr 3 0 0
func ResetConsoleAttr 2 0 0

fire.console.console_attr_os (2 missing, 0 any)

Symbol Typable Typed Any
func GetRawKeyFunction 1 0 0
func GetTermSize 1 0 0

fire.console.console_io (9 missing, 0 any)

Symbol Typable Typed Any
func More 5 0 0
func IsInteractive 4 0 0

fire.console.console_pager (10 missing, 0 any)

Symbol Typable Typed Any
meth Pager.init 4 0 0
meth Pager._Write 2 0 0
meth Pager._GetSearchCommand 2 0 0
meth Pager._Help 1 0 0
meth Pager.Run 1 0 0

fire.console.encoding (18 missing, 0 any)

Symbol Typable Typed Any
func Encode 3 0 0
func Decode 3 0 0
func EncodeEnv 3 0 0
func SetEncodedValue 5 0 0
func GetEncodedValue 4 0 0

fire.console.files (5 missing, 0 any)

Symbol Typable Typed Any
func FindExecutableOnPath 5 0 0

fire.console.platforms (43 missing, 0 any)

Symbol Typable Typed Any
meth OperatingSystem.AllValues 1 0 0
meth OperatingSystem.FromId 3 0 0
meth OperatingSystem.Current 1 0 0
meth OperatingSystem.IsWindows 1 0 0
attr OperatingSystem.WINDOWS 1 0 0
attr OperatingSystem.MACOSX 1 0 0
attr OperatingSystem.LINUX 1 0 0
attr OperatingSystem.CYGWIN 1 0 0
attr OperatingSystem.MSYS 1 0 0
meth Architecture.AllValues 1 0 0
meth Architecture.FromId 3 0 0
meth Architecture.Current 1 0 0
attr Architecture.x86 1 0 0
attr Architecture.x86_64 1 0 0
attr Architecture.ppc 1 0 0
attr Architecture.arm 1 0 0
meth Platform.init 3 0 0
meth Platform.str 1 0 0
meth Platform.Current 3 0 0
meth Platform.UserAgentFragment 1 0 0
meth Platform.AsyncPopenArgs 1 0 0
attr Platform.operating_system 1 0 0
attr Platform.architecture 1 0 0
meth InvalidEnumValue.init 4 0 0
meth PythonVersion.init 2 0 0
meth PythonVersion.SupportedVersionMessage 2 0 0
meth PythonVersion.IsCompatible 3 0 0
attr PythonVersion.version 1 0 0

fire.console.text (17 missing, 0 any)

Symbol Typable Typed Any
meth TextAttributes.init 4 0 0
prop TextAttributes.format_str 1 0 0
prop TextAttributes.color 1 0 0
prop TextAttributes.attrs 1 0 0
meth TypedText.init 3 0 0
meth TypedText.len 1 0 0
meth TypedText.add 2 0 0
meth TypedText.radd 2 0 0
attr TypedText.texts 1 0 0
attr TypedText.text_type 1 0 0

fire.core (16 missing, 0 any)

Symbol Typable Typed Any
func Fire 5 0 0
func CompletionScript 4 0 0
meth FireExit.init 3 0 0
attr FireExit.trace 1 0 0
func Display 3 0 0

fire.custom_descriptions (18 missing, 0 any)

Symbol Typable Typed Any
func NeedsCustomDescription 2 0 0
func GetStringTypeSummary 4 0 0
func GetStringTypeDescription 4 0 0
func GetDescription 4 0 0
func GetSummary 4 0 0

fire.decorators (8 missing, 0 any)

Symbol Typable Typed Any
func SetParseFns 3 0 0
func SetParseFn 3 0 0
func GetParseFns 2 1 0
func GetMetadata 2 1 0

fire.docstrings (9 missing, 0 any)

Symbol Typable Typed Any
meth Namespace.getattr 2 0 0
meth Namespace.setattr 3 0 0
meth Namespace.delattr 2 0 0
func parse 2 0 0

fire.formatting (25 missing, 0 any)

Symbol Typable Typed Any
func Indent 3 0 0
func DoubleQuote 2 0 0
func EllipsisMiddleTruncate 4 0 0
func Underline 2 0 0
func EllipsisTruncate 4 0 0
func WrappedJoin 4 0 0
func BoldUnderline 2 0 0
func Error 2 0 0
func Bold 2 0 0

fire.formatting_windows (1 missing, 0 any)

Symbol Typable Typed Any
func initialize_or_disable 1 0 0

fire.helptext (19 missing, 0 any)

Symbol Typable Typed Any
func HelpText 4 0 0
meth ActionGroup.init 3 0 0
meth ActionGroup.Add 3 0 0
meth ActionGroup.GetItems 1 0 0
attr ActionGroup.name 1 0 0
attr ActionGroup.plural 1 0 0
attr ActionGroup.names 1 0 0
attr ActionGroup.members 1 0 0
func UsageText 4 0 0

fire.inspectutils (29 missing, 0 any)

Symbol Typable Typed Any
func Py3GetFullArgSpec 2 0 0
func IsCoroutineFunction 2 0 0
meth FullArgSpec.init 8 0 0
attr FullArgSpec.args 1 0 0
attr FullArgSpec.varargs 1 0 0
attr FullArgSpec.varkw 1 0 0
attr FullArgSpec.defaults 1 0 0
attr FullArgSpec.kwonlyargs 1 0 0
attr FullArgSpec.kwonlydefaults 1 0 0
attr FullArgSpec.annotations 1 0 0
func GetFileAndLine 2 0 0
func GetClassAttrsDict 2 0 0
func IsNamedTuple 2 0 0
func Info 2 0 0
func GetFullArgSpec 2 0 0

fire.interact (3 missing, 0 any)

Symbol Typable Typed Any
func Embed 3 0 0

fire.parser (5 missing, 0 any)

Symbol Typable Typed Any
func CreateParser 1 0 0
func DefaultParseValue 2 0 0
func SeparateFlagArgs 2 0 0

fire.trace (62 missing, 0 any)

Symbol Typable Typed Any
meth FireTrace.init 7 0 0
meth FireTrace.GetResult 1 0 0
meth FireTrace.GetLastHealthyElement 1 0 0
meth FireTrace.HasError 1 0 0
meth FireTrace.AddAccessedProperty 6 0 0
meth FireTrace.AddCalledComponent 8 0 0
meth FireTrace.AddCompletionScript 2 0 0
meth FireTrace.AddInteractiveMode 1 0 0
meth FireTrace.AddError 3 0 0
meth FireTrace.AddSeparator 1 0 0
meth FireTrace._Quote 2 0 0
meth FireTrace.GetCommand 2 0 0
meth FireTrace.NeedsSeparator 1 0 0
meth FireTrace.str 1 0 0
meth FireTrace.NeedsSeparatingHyphenHyphen 2 0 0
attr FireTrace.name 1 0 0
attr FireTrace.separator 1 0 0
attr FireTrace.elements 1 0 0
attr FireTrace.verbose 1 0 0
attr FireTrace.show_help 1 0 0
attr FireTrace.show_trace 1 0 0
meth FireTraceElement.init 9 0 0
meth FireTraceElement.HasError 1 0 0
meth FireTraceElement.HasCapacity 1 0 0
meth FireTraceElement.HasSeparator 1 0 0
meth FireTraceElement.AddSeparator 1 0 0
meth FireTraceElement.ErrorAsStr 1 0 0
meth FireTraceElement.str 1 0 0
attr FireTraceElement.component 1 0 0
attr FireTraceElement.args 1 0 0

fire.value_types (11 missing, 0 any)

Symbol Typable Typed Any
func IsSimpleGroup 2 0 0
func IsGroup 2 0 0
func IsValue 2 0 0
func HasCustomStr 2 0 0
attr VALUE_TYPES 1 0 0
func IsCommand 2 0 0

Type-Ignore Comments

No type-ignore comments.