bugreport ¤

Bases: BaseModel

Base class for bugreport elements.

Attributes:

• id (str) –

  Identifier used to reference the element in templates and widgets.

id: str

Bases: BaseModel

A bugreport form defined in issue-template metadata.

Methods:

• from_github –

  Convert a GitHub form to a Bugreport form.

Attributes:

• body (list[BugreportStep | BugreportMarkdown]) –

  Steps and Markdown instructions in display order.

• subtitle (str | None) –

  Additional text below the title.

• title (str | None) –

  Title of the form.

body: list[BugreportStep | BugreportMarkdown] = Field(
    default_factory=list
)

subtitle: str | None = None

title: str | None = None

from_github(form: GitHubForm) -> BugreportForm

147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181

@classmethod
def from_github(cls, form: GitHubForm) -> BugreportForm:
    """Convert a GitHub form to a Bugreport form."""
    body: list[BugreportStep | BugreportMarkdown] = []
    for element in form.body:
        if isinstance(element, GitHubElementMarkdown):
            body.append(BugreportMarkdown(id=element.id or "", value=element.value))
        elif isinstance(element, GitHubElementInput):
            input_element = BugreportInputString(
                id=element.id or "",
                label=element.label,
                description=element.description,
                placeholder=element.placeholder,
                required=element.required,
            )
            body.append(BugreportStep(body=[input_element]))
        elif isinstance(element, GitHubElementDropdown):
            input_element = BugreportInputChoice(
                id=element.id or "",
                label=element.label,
                description=element.description,
                options={option: option for option in element.options},
                required=element.required,
            )
            body.append(BugreportStep(body=[input_element]))
        elif isinstance(element, GitHubElementCheckboxes):
            input_element = BugreportInputChoices(
                id=element.id or "",
                label=element.label,
                description=element.description,
                options={option.id or option.label: option.label for option in element.options},
                required=element.required,
            )
            body.append(BugreportStep(body=[input_element]))
    return cls(body=body)

Bases: BugreportElement

Common settings for a bugreport input.

Attributes:

• description (str | None) –

  Markdown instructions displayed below the label.

• id (str) –

  Identifier used to reference the element in templates and widgets.

• label (str | None) –

  Label displayed above the input.

• placeholder (str | None) –

  Hint displayed when the input is empty.

• required (bool) –

  Whether the user must provide a value.

description: str | None = None

id: str

label: str | None = None

placeholder: str | None = None

required: bool = False

Bases: BugreportInput

A checkbox in a bugreport form.

Attributes:

• description (str | None) –

  Markdown instructions displayed below the label.

• id (str) –

  Identifier used to reference the element in templates and widgets.

• label (str | None) –

  Label displayed above the input.

• placeholder (str | None) –

  Hint displayed when the input is empty.

• required (bool) –

  Whether the user must provide a value.

• value (bool | None) –

  Initial checkbox state.

description: str | None = None

id: str

label: str | None = None

placeholder: str | None = None

required: bool = False

value: bool | None = None

Bases: BugreportInput

An input for selecting one option.

Attributes:

• description (str | None) –

  Markdown instructions displayed below the label.

• id (str) –

  Identifier used to reference the element in templates and widgets.

• label (str | None) –

  Label displayed above the input.

• options (dict[str, str] | None) –

  Option values mapped to their displayed labels.

• placeholder (str | None) –

  Hint displayed when the input is empty.

• required (bool) –

  Whether the user must provide a value.

• value (str | None) –

  Initially selected option value.

description: str | None = None

id: str

label: str | None = None

options: dict[str, str] | None = None

placeholder: str | None = None

required: bool = False

value: str | None = None

Bases: BugreportInput

An input for selecting several options.

Attributes:

• description (str | None) –

  Markdown instructions displayed below the label.

• id (str) –

  Identifier used to reference the element in templates and widgets.

• label (str | None) –

  Label displayed above the input.

• options (dict[str, str] | None) –

  Option values mapped to their displayed labels.

• placeholder (str | None) –

  Hint displayed when the input is empty.

• required (bool) –

  Whether the user must provide a value.

• value (str | None) –

  Initially selected option values, separated by commas.

description: str | None = None

id: str

label: str | None = None

options: dict[str, str] | None = None

placeholder: str | None = None

required: bool = False

value: str | None = None

Bases: BugreportInput

An input for a filesystem path.

Attributes:

• description (str | None) –

  Markdown instructions displayed below the label.

• id (str) –

  Identifier used to reference the element in templates and widgets.

• label (str | None) –

  Label displayed above the input.

• placeholder (str | None) –

  Hint displayed when the input is empty.

• required (bool) –

  Whether the user must provide a value.

• value (str | None) –

  Initial path value.

description: str | None = None

id: str

label: str | None = None

placeholder: str | None = None

required: bool = False

value: str | None = None

Bases: BugreportInput

A single line of text in a bugreport form.

Attributes:

• description (str | None) –

  Markdown instructions displayed below the label.

• highlight (str | None) –

  Requested syntax highlighting language.

• id (str) –

  Identifier used to reference the element in templates and widgets.

• label (str | None) –

  Label displayed above the input.

• placeholder (str | None) –

  Hint displayed when the input is empty.

• required (bool) –

  Whether the user must provide a value.

• value (str | None) –

  Initial input value.

description: str | None = None

highlight: str | None = None

id: str

label: str | None = None

placeholder: str | None = None

required: bool = False

value: str | None = None

Bases: BugreportInput

Several lines of text in a bugreport form.

Attributes:

• description (str | None) –

  Markdown instructions displayed below the label.

• highlight (str | None) –

  Syntax highlighting language for the text editor.

• id (str) –

  Identifier used to reference the element in templates and widgets.

• label (str | None) –

  Label displayed above the input.

• placeholder (str | None) –

  Hint displayed when the input is empty.

• required (bool) –

  Whether the user must provide a value.

• value (str | None) –

  Initial text content.

description: str | None = None

highlight: str | None = None

id: str

label: str | None = None

placeholder: str | None = None

required: bool = False

value: str | None = None

Bases: BugreportElement

Markdown instructions displayed in a bugreport form.

Attributes:

• id (str) –

  Identifier used to reference the element in templates and widgets.

• value (str) –

  Markdown content to display.

id: str

value: str

Bases: BaseModel

A group of inputs with an optional condition and output templates.

Attributes:

• body (list[TypeBugreportInput | BugreportMarkdown]) –

  Inputs and Markdown instructions in display order.

• condition (str | None) –

  Condition that controls whether the step is displayed.

• description (str | None) –

  Markdown instructions for the step.

• outputs (dict[str, str]) –

  Output names mapped to Jinja templates for their values.

• slug (str | None) –

  Identifier for the step.

• title (str | None) –

  Title displayed above the step.

body: list[TypeBugreportInput | BugreportMarkdown] = Field(
    default_factory=list
)

condition: str | None = Field(default=None, alias='if')

description: str | None = None

outputs: dict[str, str] = Field(default_factory=dict)

slug: str | None = None

title: str | None = None

Bases: App[None]

Display a GitHub issue form and its bugreport metadata in a terminal.

Methods:

• compose –

  Read the issue template and create its form widgets.

Attributes:

• CSS_PATH –

  Stylesheet for the form widgets.

• form_inputs (dict[str, Any]) –

  Current input values, keyed by input identifier.

• form_outputs (dict[str, str]) –

  Rendered output values, keyed by output name.

• issue_template –

  Path to the GitHub issue-template YAML file.

62
63
64
65
66
67
68
69
70
71
72

def __init__(self, issue_template: str = ".github/ISSUE_TEMPLATE/1-bug.yml", **kwargs: Any) -> None:
    """Set the issue-template path and pass other options to the Textual app."""
    super().__init__(**kwargs)
    self.issue_template = issue_template
    """Path to the GitHub issue-template YAML file."""
    self.form_inputs: dict[str, Any] = {}
    """Current input values, keyed by input identifier."""
    self.form_outputs: dict[str, str] = {}
    """Rendered output values, keyed by output name."""
    self._metadata_textareas: dict[str, TextArea] = {}
    self._section_containers: list[tuple[BugreportStep, Vertical]] = []

CSS_PATH = Path(__file__).parent / 'forms.tcss'

form_inputs: dict[str, Any] = {}

form_outputs: dict[str, str] = {}

issue_template = issue_template

compose() -> ComposeResult

74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

def compose(self) -> ComposeResult:
    """Read the issue template and create its form widgets."""
    with Path(self.issue_template).open(encoding="utf-8") as file:
        form_data = yaml.safe_load(file)

    github_form = GitHubForm.from_data(form_data)

    for element in github_form.body:
        yield from self._create_widgets(element)
        if isinstance(element, GitHubElementMarkdown):
            for form in yield_bugreport_forms(element.value):
                for section in form.body:
                    if isinstance(section, BugreportMarkdown):
                        yield Markdown(section.value)
                        continue
                    with Vertical(classes="metadata-section") as container:
                        self._section_containers.append((section, container))
                        yield from self._create_label(section.title)
                        yield from self._create_description(section.description)
                        for metadata_input in section.body:
                            if isinstance(metadata_input, BugreportMarkdown):
                                yield Markdown(metadata_input.value)
                            else:
                                yield from self._create_metadata_input_widgets(metadata_input)

Bases: BaseModel

One checkbox option in a GitHub issue form.

Attributes:

• id (str | None) –

  Optional identifier for the option.

• label (str) –

  Label displayed beside the checkbox.

• required (bool | None) –

  Whether the user must select the checkbox.

id: str | None = None

label: str

required: bool | None = False

Bases: BaseModel

A group of checkbox options in a GitHub issue form.

Attributes:

• description (str | None) –

  Markdown instructions displayed below the label.

• id (str | None) –

  Optional identifier for the group.

• label (str) –

  Label displayed above the checkboxes.

• options (list[GitHubCheckboxOption]) –

  Checkbox options in display order.

• required (bool) –

  Whether the group requires a selection.

description: str | None = ''

id: str | None = None

label: str

options: list[GitHubCheckboxOption]

required: bool = False

Bases: BaseModel

A list of options to select in a GitHub issue form.

Attributes:

• default (int | None) –

  Index of the initially selected option.

• description (str | None) –

  Markdown instructions displayed below the label.

• id (str | None) –

  Optional identifier for the dropdown.

• label (str) –

  Label displayed above the dropdown.

• multiple (bool | None) –

  Whether the form allows several options to be selected.

• options (list[str]) –

  Option labels in display order.

• required (bool) –

  Whether the user must select an option.

default: int | None = None

description: str | None = ''

id: str | None = None

label: str

multiple: bool | None = False

options: list[str]

required: bool = False

Bases: BaseModel

An input for a single line of text in a GitHub issue form.

Attributes:

• description (str | None) –

  Markdown instructions displayed below the label.

• id (str | None) –

  Optional identifier for the input.

• label (str) –

  Label displayed above the input.

• placeholder (str | None) –

  Hint displayed when the input is empty.

• required (bool) –

  Whether the user must provide a value.

• value (str | None) –

  Initial input value.

description: str | None = ''

id: str | None = None

label: str

placeholder: str | None = ''

required: bool = False

value: str | None = ''

Bases: BaseModel

Markdown instructions in a GitHub issue form.

Attributes:

• id (str | None) –

  Optional identifier for the element.

• value (str) –

  Markdown content to display.

id: str | None = None

value: str

Bases: BaseModel

An input for several lines of text in a GitHub issue form.

Attributes:

• description (str | None) –

  Markdown instructions displayed below the label.

• id (str | None) –

  Optional identifier for the input.

• label (str) –

  Label displayed above the input.

• placeholder (str | None) –

  Hint displayed when the input is empty.

• render (str | None) –

  Language used to render the submitted text as a code block.

• required (bool) –

  Whether the user must provide a value.

• value (str | None) –

  Initial text content.

description: str | None = ''

id: str | None = None

label: str

placeholder: str | None = ''

render: str | None = None

required: bool = False

value: str | None = ''

Bases: BaseModel

The supported elements of a GitHub issue form.

Methods:

• from_data –

  Parse an issue-template mapping, logging and skipping unsupported element types.

Attributes:

• body (list[TypeGitHubElement]) –

  Form elements in display order.

body: list[TypeGitHubElement]

from_data(data: dict) -> GitHubForm

130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

@classmethod
def from_data(cls, data: dict) -> GitHubForm:
    """Parse an issue-template mapping, logging and skipping unsupported element types."""
    body = []
    for element_data in data.get("body", []):
        element_type = element_data.get("type")
        required = element_data.get("validations", {}).get("required", False)
        if element_type == "markdown":
            element = GitHubElementMarkdown(**element_data["attributes"])
        elif element_type == "textarea":
            element = GitHubElementTextarea(**element_data["attributes"], required=required)
        elif element_type == "input":
            element = GitHubElementInput(**element_data["attributes"], required=required)
        elif element_type == "dropdown":
            element = GitHubElementDropdown(**element_data["attributes"], required=required)
        elif element_type == "checkbox":
            options = [GitHubCheckboxOption(**option) for option in element_data["attributes"]["options"]]
            element_data["attributes"]["options"] = options
            element = GitHubElementCheckboxes(**element_data["attributes"], required=required)
        else:
            _logger.error(f"Unsupported element type: {element_type}")
            continue
        body.append(element)
    return cls(body=body)