pyqt_reactive.services.parameter_help_service

Qt-free parameter help introspection shared by forms, help windows, and agents.

Functions

class_docstring_text(dataclass_type)	Return a human-authored dataclass docstring when one is available.
dataclass_field_description(description, ...)	Return displayable docs for one dataclass field.
dataclass_parameter_descriptions(dataclass_type)	Return field descriptions for a dataclass using the shared introspection path.
dataclass_type_for_target(target)	Return the dataclass type represented by a help target.
dataclass_type_from_annotation(annotation)	Return a dataclass type represented by a field annotation.
docstring_info_for_target(target)	Return help-window documentation, using field docs for dataclass targets.
is_signature_docstring(text, type_name)	Return whether a dataclass docstring is just the generated constructor signature.
parameter_description_body(description)	Split CellProfiler setting metadata from the prose body.
parameter_description_from_target(...)	Return parsed documentation for one parameter from a callable/class target.
parameter_help_content(*, param_name, ...)	Build compact popup content without leaking raw Python annotations.
parameter_type_display(param_type)	Return the compact type label used by parameter help.
parse_parameter_description(description)	Parse the type/default prefix emitted by DocstringExtractor parameter docs.
remove_duplicate_default_sentence(...)	Remove body-level default sentence already shown in the default section.
resolved_parameter_description(*, ...)	Resolve parameter help text from target docs, then explicit widget metadata.
source_class_docstring_resolution(dataclass_type)	Extract the authored class docstring instead of dataclass' rendered signature.
source_dataclass_type(dataclass_type)	Return the source-authored dataclass for generated lazy dataclass types.
split_default_prefix(text)	Split a rendered default literal from the following sentence body.
split_docstring_summary(docstring, fallback)	Split a docstring into summary and optional remaining description.

Classes

DataclassDocstringResolution(kind, docstring)	Result of resolving a source-authored dataclass docstring.
DataclassDocstringResolutionKind(*values)	Provenance for source-authored dataclass docstring resolution.
ParameterDescriptionBody(setting_name, ...)	Formatted body fields for one parsed parameter description.
ParameterDescriptionFormatter()	Display formatter for compact parameter help prose.
ParameterHelpContent(summary, description)	Display-ready content for one parameter help popup.
ParsedParameterDescription(type_name, ...)	Structured projection of the generated parameter documentation prefix.

class pyqt_reactive.services.parameter_help_service.ParameterHelpContent(summary: str, description: str)

Display-ready content for one parameter help popup.

summary: str

description: str

__init__(summary: str, description: str) → None

class pyqt_reactive.services.parameter_help_service.ParsedParameterDescription(type_name: str | None, default_value: str | None, description: str)

Structured projection of the generated parameter documentation prefix.

type_name: str | None

default_value: str | None

description: str

__init__(type_name: str | None, default_value: str | None, description: str) → None

class pyqt_reactive.services.parameter_help_service.ParameterDescriptionBody(setting_name: str | None, description: str)

Formatted body fields for one parsed parameter description.

setting_name: str | None

description: str

__init__(setting_name: str | None, description: str) → None

class pyqt_reactive.services.parameter_help_service.DataclassDocstringResolutionKind(*values)

Provenance for source-authored dataclass docstring resolution.

FOUND = 'found'

CLASS_NOT_FOUND = 'class_not_found'

DOCSTRING_MISSING = 'docstring_missing'

class pyqt_reactive.services.parameter_help_service.DataclassDocstringResolution(kind: DataclassDocstringResolutionKind, docstring: str | None)

Result of resolving a source-authored dataclass docstring.

kind: DataclassDocstringResolutionKind

docstring: str | None

__init__(kind: DataclassDocstringResolutionKind, docstring: str | None) → None

class pyqt_reactive.services.parameter_help_service.ParameterDescriptionFormatter

Display formatter for compact parameter help prose.

strip_rst_directives(text: str) → str

Remove inline RST directives that are not useful in a compact popup.

format_inline_list_markers(text: str) → str

Give flattened CellProfiler list markers paragraph breaks.

format_body(text: str) → str

Return display-ready body prose for parameter help.

__init__() → None

pyqt_reactive.services.parameter_help_service.dataclass_type_for_target(target: Callable | type | None) → type | None

Return the dataclass type represented by a help target.

pyqt_reactive.services.parameter_help_service.source_dataclass_type(dataclass_type: type) → type

Return the source-authored dataclass for generated lazy dataclass types.

pyqt_reactive.services.parameter_help_service.source_class_docstring_resolution(dataclass_type: type) → DataclassDocstringResolution

Extract the authored class docstring instead of dataclass’ rendered signature.

pyqt_reactive.services.parameter_help_service.is_signature_docstring(text: str | None, type_name: str) → bool

Return whether a dataclass docstring is just the generated constructor signature.

pyqt_reactive.services.parameter_help_service.class_docstring_text(dataclass_type: type) → str | None

Return a human-authored dataclass docstring when one is available.

pyqt_reactive.services.parameter_help_service.split_docstring_summary(docstring: str | None, fallback: str) → tuple[str, str | None]

Split a docstring into summary and optional remaining description.

pyqt_reactive.services.parameter_help_service.dataclass_type_from_annotation(annotation) → type | None

Return a dataclass type represented by a field annotation.

pyqt_reactive.services.parameter_help_service.dataclass_field_description(description: str | None, annotation) → str | None

Return displayable docs for one dataclass field.

pyqt_reactive.services.parameter_help_service.dataclass_parameter_descriptions(dataclass_type: type) → dict[str, str]

Return field descriptions for a dataclass using the shared introspection path.

pyqt_reactive.services.parameter_help_service.docstring_info_for_target(target: Callable | type) → DocstringInfo

Return help-window documentation, using field docs for dataclass targets.

pyqt_reactive.services.parameter_help_service.parameter_description_from_target(help_target: Callable | type | None, param_name: str) → str | None

Return parsed documentation for one parameter from a callable/class target.

pyqt_reactive.services.parameter_help_service.resolved_parameter_description(*, help_target: Callable | type | None, param_name: str, widget_description: str) → str

Resolve parameter help text from target docs, then explicit widget metadata.

pyqt_reactive.services.parameter_help_service.parameter_type_display(param_type: type | None) → str

Return the compact type label used by parameter help.

pyqt_reactive.services.parameter_help_service.split_default_prefix(text: str) → tuple[str, str]

Split a rendered default literal from the following sentence body.

pyqt_reactive.services.parameter_help_service.parse_parameter_description(description: str) → ParsedParameterDescription

Parse the type/default prefix emitted by DocstringExtractor parameter docs.

pyqt_reactive.services.parameter_help_service.parameter_description_body(description: str) → ParameterDescriptionBody

Split CellProfiler setting metadata from the prose body.

pyqt_reactive.services.parameter_help_service.remove_duplicate_default_sentence(description: str, default_value: str | None) → str

Remove body-level default sentence already shown in the default section.

pyqt_reactive.services.parameter_help_service.parameter_help_content(*, param_name: str, param_type: type | None, description: str) → ParameterHelpContent

Build compact popup content without leaking raw Python annotations.