gh-128688 Introduce qualname in extra parameters providing qualified name including classname.

[NN---]

• Issue: Introduce qualified name instead of function name in logging #128688

[ghost]

All commit authors signed the Contributor License Agreement.

[bedevere-app]

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

[bedevere-app]

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

[bedevere-app]

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

[bedevere-app]

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

[bedevere-app]

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

[bedevere-app]

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

[picnixz]

This requires a NEWS entry though. This is a new feature so we need a blurb and a What's New entry (in Doc/whatsnew/3.14.rst). This also requires the logging documentation to be updated.

[StanFromIreland]

Maybe update the docstring with this change?

- Find the stack frame of the caller so that we can note the source
- file name, line number and function name.
+ Find the stack frame of the caller so that we can note the source
+ file name, line number and function name (qualified name if
+ `self.use_qualname`  is ``True`` , otherwise simple name).

[vsajip]

Well, it's not enough to update the docstring - the documentation should be updated (lots of people using the package wouldn't be looking at the source code), and also unit tests are needed.

[vsajip]

Also, I noticed that the title of this PR, and the discussion on DPO ( discuss.python.org) (which got no traction), both mention passing the qualname as an extra parameter - but that's not what this PR does. Also, your code only works at an instance level, which means that you'd have to set it for every logger instance individually - doesn't seem very friendly. You'd need to ensure that the attribute can also be set by configuration rather than only programmatically.

To my mind, the process of proposing a new feature by a non-maintainer should be:

1. Propose the feature on DPO and see if people think it will be generally useful.
2. If deemed useful by enough people, raise an issue and optionally a PR.

Although the qualified name isn't provided (I guess as it wasn't available in Python < 3.11), it's not strictly necessary, as the line number and pathname in log output can locate the logging location exactly. It might be seen as more friendly, but then people have to worry about what happens when their code runs on Python < 3.11.

Have you thought these kinds of things through? If so, what have you concluded?

[NN---]

Sorry for not answering, was too busy.
You have good points.
The change log is indeed important.
I wanted to understand whether this feature is useful not just for me and my colleagues.

The line unfortunately is not enough and the function name too as we have sometimes big files with different classes implementing same interface so all the function names are the same.

Regarding the per instance vs per class setting is a good point as well.
Probably both are useful to maintain backward compatibility while allowing gradually log change.

Everything will be addressed in the near time.

Thank you for your comments.

[vsajip]

The line unfortunately is not enough and the function name too as we have sometimes big files with different classes implementing same interface so all the function names are the same.

This sounds like a problem with your codebase rather than a more general problem, and the standard library is for general improvements rather than things which only benefit a narrow category of use cases. Anyway, I still don't see why a combination of pathname and line number don't pinpoint the code location exactly in your situation.

[NN---]

It does pinpoint to the place in the code.
Having qualified name in log makes it much easier for many people.

The proposed feature is opt-in, so only ones who need it will turn it on.

[vsajip]

The proposed feature is opt-in, so only ones who need it will turn it on.

The bar for adding features to the stdlib is high, even for opt-in features. It's got to be useful for a fair number of people and maintain backwards compatibility.

[NN---]

What is the best way to understand whether many people enough find this useful?

[picnixz]

What is the best way to understand whether many people enough find this useful?

Open a thread on https://discuss.python.org/c/ideas/6. If there's enough support, we can accept it. Otherwise, if there's no consensus, it's generally something that shouldn't be part of the standard library.

My 2c: adding the qualname in addition to the filename + lineno is sometimes easier because you can CTRL+F the qualname. I personally don't need it though.

[NN---]

https://discuss.python.org/t/add-ability-to-log-qualified-name-in-logging-package/76560