move logging configuration behind function call

[untzag]

After this change users would need to call pymodbus.apply_pymodbus_logging_config() to enable logging as before. This way logs are not injected into my application in an unexpected way.

Happy to change if maintainers wish, or feel free to reject if another option is prefered. A change to this behavior would be really great as my application has carefully formatted logs that will not be parsed correctly due to this injection.

fixes #1119

[janiversen]

Small but important changes. I like the principle of the PR.

[janiversen]

You need to add documentation of the call at highlevel in doc/source/library.

[untzag]

I personally prefer to keep functionality cleanly separated into different files, which is why I prefer the private file with import * pattern. This is just a preference however so I will defer to maintainers 😄

[janiversen]

I have no problem having it a file ! but the file contains a public function so naming it _logging is at least confusing. If you just rename the file (and the function to keep the naming standard) I am happy.

[janiversen]

Please solve the pylint/flake8 problems.

[untzag]

Happy to write docs, let me know more details please. You need me to edit doc/source/library/pymodbus.rst?

[janiversen]

Yeah I think that would be a good place to mention this function.

Please write something like:

• Use this function to activate debug in the library in a standard format
• Remark you can activate debug with logging.setlevel("DEBUG") without using this function, but will get another format
• Please use this function if you create an issue and supply a log, since the maintainers need the information to reproduce/verify your problem.

Do not use my words but the idea :-) I am a hard core programmer and have to torture myself to write documentation.

Thanks for taking care of this.

[janiversen]

Apart from the doc, this PR is good to be merged.

[untzag]

OK I added a docstring which should be rendered in autodoc and put mention of the function in a few places that made sense to me. Let me know what you think and if I should add more elsewhere.

[janiversen]

All good apart from the pylint/flake8 error.

[janiversen]

LGTM