Skip to content

Use StyledStrings for Logging - #51829

Merged
vtjnash merged 1 commit into
JuliaLang:masterfrom
tecosaur:logging-with-style
Feb 10, 2024
Merged

vtjnash merged 1 commit into
JuliaLang:masterfrom
tecosaur:logging-with-style

Conversation

@tecosaur

@tecosaur tecosaur commented Oct 23, 2023 •

Copy link
Copy Markdown
Member

Transition from printstyled to the new approach to styling provided by StyledStrings.

Along the way, this makes it possible to restyle logging should you desire to do so (for whatever reason), but also means that you can inherit the colours used in logging in other places.

10-24-00:10

This requires JuliaLang/StyledStrings.jl#3 and JuliaLang/StyledStrings.jl#6 to be resolved first.

In the meantime, a bikeshedding opportunity: log.debug (et al.) vs. logging.debug (et al.)?

@tecosaur tecosaur added display and printing Aesthetics and correctness of printed representations of objects. logging The logging framework labels Oct 23, 2023
@tecosaur

Copy link
Copy Markdown
Member Author

Good to merge after #51869.

@tecosaur

Copy link
Copy Markdown
Member Author

Fixed the merge conflict introduced in #52196.

@tecosaur

Copy link
Copy Markdown
Member Author

We could invoke StyledStrings.legacy_color to make @create_log_macro support colour numbers and old names, but since it's new API I'm not sure that this is needed.

@tecosaur

Copy link
Copy Markdown
Member Author

I'm still interested in thoughts on

log.debug (et al.) vs. logging.debug (et al.)?

since I'm on the fence myself

vtjnash added a commit that referenced this pull request Feb 1, 2024
This has some value by itself, but mainly serves as a prerequisite for
#51811, #51816, and #51829, along with two other PRs that have yet to be
made.
@tecosaur

tecosaur commented Feb 1, 2024

Copy link
Copy Markdown
Member Author

Other than the aforementioned bikeshed, I think this is just a review short of merging?

@tecosaur
tecosaur force-pushed the logging-with-style branch 2 times, most recently from ab03c94 to 0c0c385 Compare February 4, 2024 15:25

@vtjnash vtjnash left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Aside from needing to fix some tests, this LGTM

@vtjnash

vtjnash commented Feb 5, 2024

Copy link
Copy Markdown
Member

You have triage permissions, so you can tag your PRs with "merge me" whenever you get them to a point that is ready and with tests passing (which is slightly more prompt at getting noticed than the "awaiting review" tag)

@tecosaur
tecosaur force-pushed the logging-with-style branch 2 times, most recently from da5e9e1 to 4e38ba7 Compare February 7, 2024 20:27
@tecosaur

tecosaur commented Feb 7, 2024

Copy link
Copy Markdown
Member Author
  • I'll bear merge me, in mind, I do like getting someone else's eyes on my code before merging though 🙂
  • I've just pushed an updated runtests.jl for Logging that should be happy now 🤞
  • I noticed that I forgot to update pkgimage.mk, and so have pushed an update to it too

@tecosaur

tecosaur commented Feb 8, 2024

Copy link
Copy Markdown
Member Author

Looking at the test state, it seems like we're good to go? Pkg isn't happy, but that seems to be that it has a bunch of test manifests that don't include StyledStrings as a dep of Logging, and they need to be updated.

I suspect I'm not the best person to take care of this Pkg-side issue.

@vtjnash
vtjnash force-pushed the logging-with-style branch from 4e38ba7 to ac71575 Compare February 8, 2024 19:07
@vtjnash

vtjnash commented Feb 8, 2024

Copy link
Copy Markdown
Member

I think that test was recently deleted from Pkg due to other bugs in that precompile test. But there is a test that you will need to update (it is a list of dependencies of things in some packages, for testing purposes that it can read those lists):

precompile                                        (1) |         failed at 2024-02-07T23:42:02.391
2024-02-07 18:42:02 EST	Test Failed at /cache/build/tester-amdci4-12/julialang/julia-master/julia-4e38ba77bc/share/julia/test/precompile.jl:475
2024-02-07 18:42:02 EST	  Expression: Dict(modules) == modules_ok

@tecosaur

tecosaur commented Feb 8, 2024

Copy link
Copy Markdown
Member Author

Ah right, thanks. I think I've adjusted modules_ok appropriately, we'll see how that goes 🤞.

Transition from printstyled to the new approach to styling provided by
StyledStrings.

This both makes it possible for the styling used to be customised, and
allows for other styled content to inherit/re-use the logging styles.
@vtjnash vtjnash added the merge me PR is reviewed. When all tests are passing merge, making sure commit message is good. label Feb 8, 2024
@vtjnash
vtjnash merged commit 250916f into JuliaLang:master Feb 10, 2024
@oscardssmith oscardssmith removed the merge me PR is reviewed. When all tests are passing merge, making sure commit message is good. label Feb 10, 2024
KristofferC pushed a commit that referenced this pull request Feb 15, 2024
Can be seen as a follow-on from #51829, also wants
JuliaLang/StyledStrings.jl#37
 to behave as expected.
tecosaur added a commit to tecosaur/julia that referenced this pull request Mar 4, 2024
KristofferC pushed a commit that referenced this pull request May 10, 2024
KristofferC pushed a commit that referenced this pull request May 10, 2024
KristofferC pushed a commit that referenced this pull request May 13, 2024
aviatesk pushed a commit that referenced this pull request May 13, 2024
lazarusA pushed a commit to lazarusA/julia that referenced this pull request Jul 12, 2024
@tecosaur
tecosaur deleted the logging-with-style branch August 11, 2024 04:47
@tecosaur tecosaur added the reverted This PR has since been reverted label Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

display and printing Aesthetics and correctness of printed representations of objects. logging The logging framework reverted This PR has since been reverted

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants