I’m working on a project that needs lots of toolbars on screen at once, even though not all of them will be used at the same time. So, I’m modelling this ‘foldable’ dock widget after what I remember Photoshop panels used to be like.

It’s a work in progress, but would like to hear constructive suggestions.

https://blocks.programming.dev/0101100101/42c5d67f86c049baa3500aa38e439f8a

  • FizzyOrange@programming.dev
    link
    fedilink
    arrow-up
    3
    ·
    1 day ago

    Easily above average code for Python. I’m going to pick on one method:

    def _set_float_icon(self, is_floating: bool):
                """ set the float icon depending on the status of the parent dock widget """
                if is_floating:
                    self.float_button.setIcon(self.icon_dock)
                else:
                    self.float_button.setIcon(self.icon_float)
    

    First, Python does have ternary expressions so you can

    self.float_button.setIcon(self.icon_dock if is_floating else self.icon_float)
    

    Second, what does this code do?

    foo._set_float_icon(true)
    

    Kind of surprising that it sets the icon to icon_dock right? There are two easy fixes:

    1. Use *, is_floating: bool so you have to name the parameter when you call it.
    2. I’d probably rename it to _update_float_icon() or something.

    Also use Black or Ruff to auto-format your code (it’s pretty well formatted already but those will still improve it and for zero effort).

    • logging_strict@programming.dev
      link
      fedilink
      arrow-up
      1
      ·
      23 hours ago

      ternary expressions

      Recommend against the ternary expression. coverage might not detect the two code blocks. Would also not be able to apply # pragma: no cover comment to a code block that isn’t important enough to justify testing it. Often use do nothing code blocks.

      self.float_button.setIcon(self.icon_dock if is_floating else self.icon_float) lets say while testing something goes wrong and trying to debug what happened.

      Will not see the value that gets past into self.float_button.setIcon

      I like your idea of having the param be keyword only. Makes it more readable.

      • FizzyOrange@programming.dev
        link
        fedilink
        arrow-up
        1
        ·
        14 hours ago

        If you branch coverage tool can’t handle branches on the same line I would suggest you use a different one! Does it handle if foo or bar?

        Will not see the value that gets past into self.float_button.setIcon

        Uhm, yes you will? Just step into the function.

        • logging_strict@programming.dev
          link
          fedilink
          arrow-up
          1
          ·
          5 hours ago

          self.float_button.setIcon is a Python wrapper around a C++ library. Might not be possible to, or want to, step into the function.

          if foo or bar is part of a if-else condition. The else portion needs # pragma: no cover or coverage may complain.