ScriptedStringSummary

class lldb.plugins.scripted_string_summary.ScriptedStringSummary

The base class for a scripted string summary provider.

A summary provider produces the one-line string shown next to a value in frame variable/expression output. Register it with type summary add -l.

Most of the base class methods are @abstractmethod that need to be overwritten by the inheriting class.

Methods Summary

get_summary(valobj, options)

Get the summary string for a value.

Methods Documentation

abstract get_summary(valobj: SBValue, options: SBTypeSummaryOptions) → str

Get the summary string for a value.

Parameters:

• valobj (lldb.SBValue) – The value to summarize.

• options (lldb.SBTypeSummaryOptions) – The options to use when producing the summary.

Returns:

The summary string for valobj.

Return type:

str