Skip to content

Conversation

@llucax
Copy link
Contributor

@llucax llucax commented Jul 22, 2024

This function will return a logger for the public module containing the given module name. This is useful to make sure that logger name only reference public modules, which are the ones that the user imports and interacts with.

Implements the function suggested in frequenz-floss/frequenz-sdk-python#1009.

@llucax llucax requested a review from a team as a code owner July 22, 2024 09:55
@llucax llucax requested a review from shsms July 22, 2024 09:55
@github-actions github-actions bot added the part:tests Affects the unit, integration and performance (benchmarks) tests label Jul 22, 2024
@llucax llucax added the cmd:skip-release-notes It is not necessary to update release notes for this PR label Jul 22, 2024
This function will return a logger for the public module containing the
given module name. This is useful to make sure that logger name only
reference public modules, which are the ones that the user imports and
interacts with.

Signed-off-by: Leandro Lucarella <[email protected]>
@llucax llucax changed the title Add a function to get a *public* logger for a module Add a function to get a public logger for a module Jul 22, 2024
@llucax llucax added this to the v1.0.0 milestone Jul 22, 2024
@llucax llucax added the part:logging Affects the logging module label Jul 22, 2024
@github-actions github-actions bot added the part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) label Jul 22, 2024
@llucax
Copy link
Contributor Author

llucax commented Jul 22, 2024

Enabled auto-merge.

@llucax llucax enabled auto-merge July 22, 2024 10:01
@llucax llucax self-assigned this Jul 22, 2024
@llucax
Copy link
Contributor Author

llucax commented Jul 22, 2024

Skipping release notes because since this is unreleased, I will write some special release notes for the initial release.

@@ -0,0 +1,38 @@
# License: MIT
# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2024!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably remove these copyright years, from the legal perspective they seem to be useless and we always get them wrong, and it makes testing templates harder, as we need to make the test change every year...

@llucax llucax added this pull request to the merge queue Jul 24, 2024
Merged via the queue into frequenz-floss:v1.x.x with commit e4c02f4 Jul 24, 2024
@llucax llucax deleted the log branch July 24, 2024 17:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cmd:skip-release-notes It is not necessary to update release notes for this PR part:logging Affects the logging module part:tests Affects the unit, integration and performance (benchmarks) tests part:tooling Affects the development tooling (CI, deployment, dependency management, etc.)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants