Add vesync debug mode in library

[cdnninja]

Proposed change

Previously debug mode for the logger didn't pass to pyvesync library. The library overrides the settings back to default. Instead it has a flag you can pass in. This takes the debug mode setting and passes to the library allowing the standard debug functions to work. It also has listeners to adjust this on the fly.

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New integration (thank you!)
• New feature (which adds functionality to an existing integration)
• Deprecation (breaking change to happen in the future)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Additional information

• This PR fixes or closes issue: fixes #
• This PR is related to issue:
• Link to documentation pull request:

Checklist

• The code change is tested and works locally.
• Local tests pass. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.
• I have followed the development checklist
• I have followed the perfect PR recommendations
• The code has been formatted using Ruff (ruff format homeassistant tests)
• Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

• The manifest file has all fields filled out correctly.
  Updated and included derived files by running: python3 -m script.hassfest.
• New or updated dependencies have been added to requirements_all.txt.
  Updated by running python3 -m script.gen_requirements_all.
• For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

• I have reviewed two other open pull requests in this repository.

[home-assistant]

Hey there @markperdue, @webdjoe, @TheGardenMonkey, mind taking a look at this pull request as it has been labeled with an integration (vesync) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of vesync can trigger bot actions by commenting:

• @home-assistant close Closes the pull request.
• @home-assistant rename Awesome new title Renames the pull request.
• @home-assistant reopen Reopen the pull request.
• @home-assistant unassign vesync Removes the current integration label and assignees on the pull request, add the integration domain after the command.
• @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
• @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

[iprak]

That will work but it requires restarting the integration. Can we list to the event EVENT_LOGGING_CHANGED like self.hass.bus.async_listen(EVENT_LOGGING_CHANGED, handle_logging_changed) and then update the debug property on the VeSync component? esphome/manager.py has good sample in this direction.

[joostlek]

That's indeed a good point, we should be able to change it on runtime for the best experience. Why do we actually overwrite this in the lib as opposed to just logging in debug?

[cdnninja]

Good question, I'm not sure why the library over writes it. @webdjoe thoughts?

[cdnninja]

I have added listeners to adjust the debug mode on the fly. This is functional in my testing. @iprak @joostlek ready for review.

[joostlek]

There's a merge conflict

[home-assistant]

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

[cdnninja]

Fixed.

[cdnninja]

@joostlek merge conflicts resolved. Thoughts around this one? I dug into try tell the exact code blocking runtime changes in the library but couldn't find it. This would be helpful for the future releases when debug is needed.

[iprak]

I second the useful of this even if it was not perfect. #138004 calls out an issue which I suspect is due to failure reported at vesync web end. I know the web call returns a message but can only be seen if debug logging is enabled in the library.

[webdjoe]

I can remove the logging hooks in the library, but a thought may be not to override by default, only when the property / argument is set. This just makes it easier to debug when developing but I'm open to suggestions.

[cdnninja]

That works for me. Hopefully removes the need for this.

[MartinHjelmare]

Why doesn't the library use the standard Python logging mechanism and best practice with just using a logger per module or package? Why does it need this attribute on the manager?

Eg:

LOGGER = logging.getLogger(__name__)

LOGGER.debug("bla bla")

[cdnninja]

Just how it was written - as webdjoe mentioned a re-write of the library is coming that will solve this. If we merge this current code it gives us debug ability until that happens.

It would get removed on the re-write update.

[MartinHjelmare]

It's ok for now. The library should preferably be updated ASAP so we can remove this.

[MartinHjelmare]

Please press ready for review when we're ready to merge.

[cdnninja]

Ready for review.

Comment addressed