zv,zn: manually implement Debug for Str, *Name and ObjectPath #394

MaxVerevkin · 2023-06-27T19:21:55Z

Before:

[src/main.rs:24] event = Msg {
    type: Signal,
    sender: UniqueName(
        Str(
            Borrowed(
                "org.freedesktop.DBus",
            ),
        ),
    ),
    path: ObjectPath(
        "/org/freedesktop/DBus",
    ),
    iface: InterfaceName(
        Str(
            Borrowed(
                "org.freedesktop.DBus",
            ),
        ),
    ),
    member: MemberName(
        Str(
            Borrowed(
                "NameOwnerChanged",
            ),
        ),
    ),
    body: Signature(
        "sss",
    ),
}

After:

[src/main.rs:24] event = Msg {
    type: Signal,
    sender: "org.freedesktop.DBus",
    path: "/org/freedesktop/DBus",
    iface: "org.freedesktop.DBus",
    member: "NameOwnerChanged",
    body: Signature(
        "sss",
    ),
}

Fixes #431.

MaxVerevkin · 2023-06-28T06:50:42Z

As a follow-up PR, I think Message's Debug impl can be further improved to be

[src/main.rs:24] event = Msg {
    type: Signal,
    sender: "org.freedesktop.DBus",
    path: "/org/freedesktop/DBus",
    iface: "org.freedesktop.DBus",
    member: "NameOwnerChanged",
    body_signature: "sss",
}

zeenix · 2023-06-28T13:36:06Z

As a follow-up PR, I think Message's Debug impl can be further improved to be

Nice but:

these are related so should ideally get it all done in the same PR.
~~Message's impl seems a lot more condensed. We should keep it consistent.~~

MaxVerevkin · 2023-06-28T13:43:52Z

Message's impl seems a lot more condensed. We should keep it consistent.

Could you explain what you mean?

zeenix · 2023-06-28T14:09:27Z

Message's impl seems a lot more condensed. We should keep it consistent.

Could you explain what you mean?

Good that you asked. I totally missed how that both outputs are of Message, and that the second one will be an improvement on the first. :) So nm that point.

MaxVerevkin · 2023-06-28T14:53:26Z

As a follow-up PR, I think Message's Debug impl can be further improved to be

[src/main.rs:24] event = Msg {
    type: Signal,
    sender: "org.freedesktop.DBus",
    path: "/org/freedesktop/DBus",
    iface: "org.freedesktop.DBus",
    member: "NameOwnerChanged",
    body_signature: "sss",
}

Actually I think it's better to achieve this by manually implementing Debug for *Name, ObjectPath and Signature. Note that it does not interfere with #379.

zeenix · 2023-06-28T15:21:26Z

Actually I think it's better to achieve this by manually implementing Debug for *Name, ObjectPath and Signature.

Sure.

Note that it does not interfere with #379.

I thought so. Was just linking the PRs for their close similarity.

zeenix · 2023-06-28T17:18:10Z

@MaxVerevkin btw, did I mention our newest strong recommendation to have emoji prefixes on git commits? They also make for good release notes: https://github.com/dbus2/zbus/releases/tag/zvariant-3.15.0 (I also rollod out zbus_names release but most commits there were lacking the emojis so the release notes don't look at good).

I added recently to our contributions guide, with recommendations for tools to use for doing it easily.

MaxVerevkin · 2023-06-28T20:03:52Z

btw, did I mention our newest strong recommendation to have emoji prefixes on git commits?

No, I noticed the use of emojis in the git log, but I wasn't aware it is a strong recommendation to use them. Personally not a fan, but I'll add them to my commit messages.

zeenix · 2023-06-28T21:25:55Z

No, I noticed the use of emojis in the git log, but I wasn't aware it is a strong recommendation to use them.

I think it adds more than just aesthetics. It's easier to browse through the history with them. A picture is worth a thousand words they say. :)

Personally not a fan, but I'll add them to my commit messages.

Thank you! 🙏 If nothing else than you'll be doing it for consistency. Maybe you'll learn to like them, who knows. :)

MaxVerevkin · 2023-07-01T08:19:41Z

Also some emojis don't work with ~~some editors~~ vim that well:

zeenix · 2023-07-01T10:55:31Z

Also some emojis don't work with ~~some editors~~ vim that well:

I also use vim so this affects me too, just that I never used that emoji. :) A couple of things:

This is a gimoji issue and since the it has its own emoji db (copied over from gitmoji project but now separate), we can replace it with one that works.
There are other emojis that will fit the purpose here:

🚸 :children_crossing: Improve user experience / usability. 
🏷️ :label:                        Add or update types.

zeenix

Mostly just commit message improvements left. LGTM otherwise.

zeenix · 2023-07-01T11:09:59Z

zbus_names/src/bus_name.rs

@@ -120,6 +120,12 @@ impl Display for BusName<'_> {
    }
 }

+impl Debug for BusName<'_> {


The commit log (manually implement Debug for *Name) doesn't mention the rationale. Manual impl is an (no pun intended) implementation detail, not the summary of the change. How about:

zn: Improved debug repr for *Name Improve debug representation of *Name through a manual impl of `Debug`. Before: <output> After: <output>

similar for the other Debug impl commits.

I think "transparent impl" is a good term to explain this change?

Perhaps? or go with my suggestion.

Should I repeat it in each commit msg?

Should I repeat it in each commit msg?

repeating is fine (atomic commits).

zvariant/src/object_path.rs

zeenix · 2023-07-01T11:12:56Z

zvariant/src/object_path.rs

    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-        f.debug_tuple("ObjectPath").field(&self.as_str()).finish()
+        Debug::fmt(self.as_str(), f)


Would be nice to document briefly in the commit description, what was removed.

zvariant/src/str.rs

zeenix · 2023-07-26T14:12:24Z

@MaxVerevkin is this still Draft?

MaxVerevkin · 2023-07-26T21:30:56Z

It is draft is a sense that I haven't addressed review feedback. I'll try to do it soon.

zeenix · 2023-08-06T09:20:29Z

@SeaDve seems @MaxVerevkin doesn't have time to finish this. Feel free to do that in a separate PR if you want to work on this.

Since git doesn't allow multiple authors, when you modify a commit you can either:

override the author of the commit with your name and put Based on a patch from NAME <EMAIL>. Or
Put Co-authored by: YOUR_NAME <YOUR_EMAIL> at the bottom of the commit.

Based on how much you had to modify the commit.

zeenix · 2023-08-17T10:32:20Z

@SeaDve do you think you'll have time to do this soon?

SeaDve · 2023-08-17T13:58:25Z

@SeaDve do you think you'll have time to do this soon?

Possibly on friday or saturday this week

SeaDve · 2023-08-19T13:21:45Z

I opened a separate PR with different implementation

zeenix · 2023-08-19T16:05:36Z

closing in favour of #450

zeenix mentioned this pull request Jun 28, 2023

✨ zv: impl Display for Value, Array, Structure, Dict & Maybe #379

Merged

MaxVerevkin changed the title ~~zv: manually implement Debug for Str~~ zv: manually implement Debug for Str, *Name and ObjectPath Jun 28, 2023

MaxVerevkin changed the title ~~zv: manually implement Debug for Str, *Name and ObjectPath~~ zv,zn: manually implement Debug for Str, *Name and ObjectPath Jun 28, 2023

MaxVerevkin force-pushed the str-debug branch 2 times, most recently from 38a30e7 to a3889ee Compare July 1, 2023 08:17

zeenix requested changes Jul 1, 2023

View reviewed changes

MaxVerevkin marked this pull request as draft July 4, 2023 21:15

MaxVerevkin commented Jul 25, 2023

View reviewed changes

zvariant/src/str.rs Show resolved Hide resolved

MaxVerevkin added 2 commits July 30, 2023 16:33

🧑‍💻 zv: transparent Debug impl for Str

f05e77b

🧑‍💻 zn: transparent Debug impl for *Name

8f42bb5

MaxVerevkin force-pushed the str-debug branch from a3889ee to c444d71 Compare July 30, 2023 13:36

MaxVerevkin marked this pull request as ready for review July 30, 2023 13:38

MaxVerevkin added 2 commits July 30, 2023 17:03

🧑‍💻 zv: transparent Debug impl for ObjectPath

23875aa

🧑‍💻 zv: transparent Debug impl for OwnedObjectPath

1509646

MaxVerevkin force-pushed the str-debug branch from c444d71 to 1509646 Compare July 30, 2023 14:08

zeenix mentioned this pull request Aug 6, 2023

Simplify/Improve Debug implementations #431

Closed

SeaDve mentioned this pull request Aug 19, 2023

🧑‍💻 zv, zn: Improve Str, Owned*Name, BusName Debug impls #450

Merged

zeenix closed this Aug 19, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

zv,zn: manually implement Debug for Str, *Name and ObjectPath #394

zv,zn: manually implement Debug for Str, *Name and ObjectPath #394

MaxVerevkin commented Jun 27, 2023 •

edited by zeenix

MaxVerevkin commented Jun 28, 2023

zeenix commented Jun 28, 2023 •

edited

MaxVerevkin commented Jun 28, 2023

zeenix commented Jun 28, 2023 •

edited

MaxVerevkin commented Jun 28, 2023

zeenix commented Jun 28, 2023 •

edited

zeenix commented Jun 28, 2023 •

edited

MaxVerevkin commented Jun 28, 2023

zeenix commented Jun 28, 2023

MaxVerevkin commented Jul 1, 2023 •

edited

zeenix commented Jul 1, 2023 •

edited

zeenix left a comment

zeenix Jul 1, 2023

zeenix Jul 1, 2023

MaxVerevkin Jul 30, 2023

zeenix Jul 30, 2023

MaxVerevkin Jul 30, 2023

zeenix Jul 30, 2023 •

edited

zeenix Jul 1, 2023

zeenix commented Jul 26, 2023

MaxVerevkin commented Jul 26, 2023

zeenix commented Aug 6, 2023

zeenix commented Aug 17, 2023

SeaDve commented Aug 17, 2023

SeaDve commented Aug 19, 2023

zeenix commented Aug 19, 2023

zv,zn: manually implement Debug for Str, *Name and ObjectPath #394

zv,zn: manually implement Debug for Str, *Name and ObjectPath #394

Conversation

MaxVerevkin commented Jun 27, 2023 • edited by zeenix

MaxVerevkin commented Jun 28, 2023

zeenix commented Jun 28, 2023 • edited

MaxVerevkin commented Jun 28, 2023

zeenix commented Jun 28, 2023 • edited

MaxVerevkin commented Jun 28, 2023

zeenix commented Jun 28, 2023 • edited

zeenix commented Jun 28, 2023 • edited

MaxVerevkin commented Jun 28, 2023

zeenix commented Jun 28, 2023

MaxVerevkin commented Jul 1, 2023 • edited

zeenix commented Jul 1, 2023 • edited

zeenix left a comment

Choose a reason for hiding this comment

zeenix Jul 1, 2023

Choose a reason for hiding this comment

zeenix Jul 1, 2023

Choose a reason for hiding this comment

MaxVerevkin Jul 30, 2023

Choose a reason for hiding this comment

zeenix Jul 30, 2023

Choose a reason for hiding this comment

MaxVerevkin Jul 30, 2023

Choose a reason for hiding this comment

zeenix Jul 30, 2023 • edited

Choose a reason for hiding this comment

zeenix Jul 1, 2023

Choose a reason for hiding this comment

zeenix commented Jul 26, 2023

MaxVerevkin commented Jul 26, 2023

zeenix commented Aug 6, 2023

zeenix commented Aug 17, 2023

SeaDve commented Aug 17, 2023

SeaDve commented Aug 19, 2023

zeenix commented Aug 19, 2023

MaxVerevkin commented Jun 27, 2023 •

edited by zeenix

zeenix commented Jun 28, 2023 •

edited

zeenix commented Jun 28, 2023 •

edited

zeenix commented Jun 28, 2023 •

edited

zeenix commented Jun 28, 2023 •

edited

MaxVerevkin commented Jul 1, 2023 •

edited

zeenix commented Jul 1, 2023 •

edited

zeenix Jul 30, 2023 •

edited