API Reference

• Synchronous Connection
  • Connection
  • Deadlines
  • Ownership and concurrency
• Protocol and Tool Support
  • Asynchronous connections
  • Tool definitions and commands
  • Streaming calls
  • What the wire layer costs
  • Frame fragmentation
  • Frame compression
  • Protocol internals
• Subprocess helpers
  • async_process()
  • process()
• Platform requirements
  • needs_linux()
  • needs_program()
  • needs_file()
• Immutable snapshots
  • DeepMappingProxy
  • freeze()
• Tool result cache
  • Cache
  • CacheBackend
  • CacheEntry
  • JSONCacheDir
  • JSONEntryCodec
  • SQLiteCache
• Dataclass serialization
  • Dataclass
  • dump_dataclass()
  • json_default()
  • json_object_hook()
  • load_dataclass()
• Shell Client
  • run_shell()
  • run()
  • configure_parser()
  • Local terminal handling
  • Helpers
• Template compiler and interpreter
  • AssignmentTarget
  • AttributeExpression
  • BinaryExpression
  • Branch
  • BreakNode
  • CodeToken
  • CollectionExpression
  • CommandToken
  • CommentToken
  • ComparisonExpression
  • ConditionalExpression
  • ContinueNode
  • DictionaryExpression
  • Expression
  • ExpressionParser
  • ExpressionToken
  • FilterExpression
  • ForNode
  • IfNode
  • LiteralExpression
  • LookupExpression
  • OutputNode
  • RenderContext
  • ResolvableExpression
  • SetNode
  • SliceExpression
  • Template
  • TemplateBreak
  • TemplateContinue
  • TemplateLexer
  • TemplateNode
  • TemplateParser
  • TemplateProgram
  • TemplateSource
  • TemplateSyntaxError
  • TemplateToken
  • TextNode
  • TextToken
  • UnaryExpression
  • VariableExpression
  • checked_filters()
  • named_filters()
  • render_template()
  • template_identifier()
• Template filters
  • CapitalizeFilter
  • DefaultFilter
  • FirstFilter
  • FloatFilter
  • IPAddressFilter
  • IntFilter
  • JoinFilter
  • LastFilter
  • LengthFilter
  • ListFilter
  • LowerFilter
  • ReplaceFilter
  • ReverseFilter
  • SortFilter
  • StringFilter
  • TemplateFilter
  • TemplateUndefined
  • ToJSONFilter
  • TrimFilter
  • UniqueFilter
  • UpperFilter
  • TEMPLATE_FILTERS
• Built-in Tools
  • What a tool needs from its target