Collapsible Widget API v1.1

[IgorTatarnikov]

Description

What is this PR

• Bug fix
• Addition of a new feature
• Other

Why is this PR needed?

The API for the collapsible widget was awkward to use.

What does this PR do?

The CollapsibleWidgetContainer now takes any QWidget and if the collapsible flag is True instantiates a CollapsibleWidget and replaces the content with the input QWidget. Before, the user had to instantiate a CollapsibleWidget and pass that to the CollapsibleWidgetContainer if they wanted to widget to be collapsible.

How has this PR been tested?

Tests have been added to cover the new functionality.

Checklist:

• The code has been tested locally
• Tests have been added to cover all new functionality (unit & integration)
• The code has been formatted with pre-commit

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (cb48329) 83.00% compared to head (3ae2145) 83.30%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #23      +/-   ##
==========================================
+ Coverage   83.00%   83.30%   +0.30%     
==========================================
  Files          20       20              
  Lines         606      617      +11     
==========================================
+ Hits          503      514      +11     
  Misses        103      103              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[alessandrofelder]

LGTM - thanks!
Made a few tiny suggestions

[alessandrofelder]

Do we need issues for these, so we keep track of TODO's in one place?

[adamltyson]

I would say always have issues rather than TODOs

[IgorTatarnikov]

I think the following covers the first TODO.

brainglobe-utils/tests/tests/test_qtpy/test_collapsible_widget.py

Lines 162 to 196 in 20960e8

	@pytest.mark.parametrize(
	"layout, collapsible",
	[
	(QVBoxLayout(), True),
	(QHBoxLayout(), True),
	(QFormLayout(), True),
	(QVBoxLayout(), False),
	(QHBoxLayout(), False),
	(QFormLayout(), False),
	],
	)
	def test_collapsible_widget_container_add_remove_widgets(
	qtbot, collapsible_widget_container, generic_widget, layout, collapsible
	):
	qtbot.addWidget(collapsible_widget_container)
	generic_widget.setLayout(layout)
	generic_widget.layout().addWidget(QLabel("test"))
	generic_widget.layout().addWidget(QPushButton("test"))
	collapsible_widget_container.add_widget(
	generic_widget, collapsible=collapsible, widget_title=WIDGET_TITLE
	)
	assert collapsible_widget_container.layout().count() == 1
	# Convert collapsible to int (False -> 0, True -> 1)
	# to check if collapsible_widgets is empty
	assert len(collapsible_widget_container.collapsible_widgets) == int(
	collapsible
	)
	collapsible_widget_container.remove_widget(generic_widget)
	assert collapsible_widget_container.layout().count() == 0
	assert len(collapsible_widget_container.collapsible_widgets) == 0

And I've just added a test to check an exception is thrown when trying to remove a widget that hasn't been added to the container.