Fix bug with markup in GroupBox widget

[blackgolyb]

Description

Hi! There was a bug in the groupbox widget related to markup option. The markup option did not work in it.

Images

Bug preview:

After fixing:

[github-actions]

Thank you for opening your first PR into Qtile!
If you have not heard from us in a while, please feel free to ping one of the devs or anyone who has commented on the PR, as sometimes things fall through the cracks.
You can also join the chat room for real-time discussion, see the community links.
For details on what PRs might need to include before we will merge them please see the docs.

[elParaguayo]

Thanks for submitting this.

I think adding the ability to have this widget support markup is a nice addition. Have made a minor comment below.

[elParaguayo]

I think this change makes sense but could you also edit the TaskList widget (which is the only other widget that uses this method). Currently, if markup is applies, it uses regex to remove that markup from the text before calculating the width. I don't think that's the right approach as the markup can change the size of the text.

[blackgolyb]

I made some edits to the TaskList. Did I understand this task correctly?

[elParaguayo]

Yes, you did.

For the GroupBox, where are you specifying the markup? Is this done when creating the group in your config?

[blackgolyb]

Yes, I can set a markup parameter in the configuration to change the markup in the GroupBox widget. Also it is True by default as written in the documentation

[elParaguayo]

I think markup should be False by default so it doesn't change any existing behaviour.

I was actually asking where you set your markup formatting (e.g. <sup>). Was that part of your group name in your config?

[blackgolyb]

Yes, the markup was part of the group name. EX: DEV<sup>1</sup>

[blackgolyb]

Hi! What should I do next?

[elParaguayo]

We should add a test for this. Here you go:

diff --git a/test/widgets/test_groupbox.py b/test/widgets/test_groupbox.py
new file mode 100644
index 00000000..1dd0f191
--- /dev/null
+++ b/test/widgets/test_groupbox.py
@@ -0,0 +1,46 @@
+# Copyright (c) 2023 elParaguayo
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+import pytest
+
+from libqtile import config, widget
+from libqtile.bar import Bar
+from test.helpers import BareConfig
+
+
+class GroupBoxConfig(BareConfig):
+    screens = [
+        config.Screen(
+            top=Bar([widget.GroupBox(), widget.GroupBox(name="has_markup", markup=True)], 24)
+        )
+    ]
+    groups = [config.Group("1", label="<sup>1</sup>")]
+
+
+groupbox_config = pytest.mark.parametrize("manager", [GroupBoxConfig], indirect=True)
+
+
+@groupbox_config
+def test_groupbox_markup(manager):
+    """Group labels can support markup but this is disabled by default."""
+    no_markup = manager.c.widget["groupbox"]
+    has_markup = manager.c.widget["has_markup"]
+
+    # If markup is disabled, text will include markup tags so widget will be wider
+    assert no_markup.info()["width"] > has_markup.info()["width"]

[github-actions]

This PR is stale because it has been open 90 days with no activity. Remove the status: stale label or comment, or this will be closed in 30 days.

[elParaguayo]

@blackgolyb I've rebased, added the test, tidied up a couple of bits and set this to merge once tests pass.

Thanks for your help.