-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Use PPrint to handle printing of REPL output values #23849
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
CC @odersky @hamzaremmal as we discussed this when I visited lausanne
We can't use os-lib or requests while still supporting Java 8, as they require Java 11, so for now I just use java.io/java.nio to do the same thing. It looks super ugly, but when we start requiring Java >=17 we can clean this up
@lihaoyi we already require Java >= 17, the main
branch is already set to 3.8
project/Build.scala
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
...wait, is 0.4.3-M5 a stable version? 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
might want to bring it to stable before we depend on it in the compiler repo 😅
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's almost a year old, so I guess so haha. I can tag a stable version if you would like, but the contents of the sourcejar will be unchanged
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if it's become stabilised, by all means. 👍
I'd rather avoid milestone versions here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with @Gedochao. A stable version should be used here. Also, @lihaoyi what are the versioning scheme these 3 libraries follow? I'm not a fan of cloning the sources and change the package name. I prefer to just have a dependency and use the actual library (which we do for jline and will soon do for asm too).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, others have raised concerns in the past about using Scala libraries in the compiler codebase affecting the bootstrapping process. By building from source, we treat it effectively as Dotty's own source files, removing any divergence in the code paths: they are treated identically to scala3's own sources. If scala3 can compile itself, it should be able to compile these sources without issue
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Why has it been downloaded every time?
- Seems no checkmd5?
- Extract the common version to fields?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should indeed compile these from sources. We can depend on binaries for Java libraries (hence jline and asm are fine), but not for Scala libraries.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should indeed compile these from sources. We can depend on binaries for Java libraries (hence jline and asm are fine), but not for Scala libraries.
Could you explain why? I thought Scala is maintaining backwards binary/tasty compatibility. Doesn't that mean we shohld always be able to depend on older scala 3 jars in the scala3 compiler regardless of how kuch bootstrapping we do?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because circular dependencies are evil. They're not too evil across time (Av2 -> Bv1 -> Av1), but they're still difficult to reason about.
And even though Scala 3 will forever be backward compat, an eventual Scala 4 wouldn't. We shouldn't paint our build into a corner. Scala 2 tried this several times over its lifetime, and rolled back every time. It's a massive pain every time it happens. There would need to be a huge upside to depending on a binary for that to be offset.
@Gedochao the community_build_n
jobs were failing when I was using Java 11 APIs such as the java.net.HttpClient
(transitively via requests-scala)
Looks to me like
This line of test outputs gives us a hint: https://github.com/scala/scala3/actions/runs/17377385477/job/49667379148?pr=23849#step:9:8944
test 'hello world' = 'Building Dotty...
Which is printed for
I bealive the test assumed that ./bin/scala
is ready to use and does not need to require building compiler/runner again.
However, in the logs we can see that it does actually bootstrap the new binary and finishes by printing hello world
as expected.
It might be related to changes made to the build file and introduced source generator.
A workaround can trimming the output to the last lines, but it would not fix the underlying issue - need to build compiler on each usage from ./bin/scala
Shouldn't using bin/scala
build the compiler locally? I assumed that such a script is meant to give you the scala
compiler/REPL representing the compiler sources currently checked out, and not some cached version of the compiler/REPL built from earlier sources. Or is that mistaken?
Shouldn't using
bin/scala
build the compiler locally? I assumed that such a script is meant to give you thescala
compiler/REPL representing the compiler sources currently checked out, and not some cached version of the compiler/REPL built from earlier sources. Or is that mistaken?
bin/scala
runs the official Scala runner... being Scala CLI 😅 So no, it doesn't build the compiler locally.
Thanks @Gedochao ! Looks like adding a caching layer to the source downloader is enough to avoid the noisy logs and make the test pass
@WojciechMazur Another argument for downloading and unpacking sourcejars on the fly v.s. vendoring it statically is that we already do that for a bunch of different source jars in https://github.com/scala/scala3/blob/main/project/Build.scala: mtags-shared
in one case and scalajs-ir
in three other cases. So for PPrint/Fansi/SourceCode to do the same would be in line with the current design patterns
I've cut over the shadedSourceGenerator
implementation to use SBT's IO.*
APIs rather than raw java.net
/java.io
. Now it should look a lot more similar to the code that downloads/unpacks mtags-shared
and scalajs-ir
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the great work! We discussed it during the core meeting today and decided that it should be good to merge. I just have two minor comments to improve the maintainability
In the last commits I set the default pprint dimensions to width=100 height=50, and added a import dotty.shaded.pprint.pprintln
to the predef of every REPL so users have pprintln
available in scope. Users who want to print more than 50 lines can call pprintln
which prints up to 100x500 by default, and can take a custom height=9999
if they want to print more.
The numbers 100x50 and 100x500 are heuristics:
- 100x50 as the default for echo-ed values is a heuristic optimizing for terminal use, where width=100 approximates the common maximum width people tend to format their code to (typically 80-120), and 50 reflects about 0.5 to 1 vertical screenful of text so it doesn't kick previous terminal output off the top of your terminal
- 100x500 as the default for
pprintln
is a heuristic optimizing for non-terminal use: it's about 5-10 vertical screenfuls of text, and about the limit of what we expect people to usefully be able to skim through. Typically, in most cases when the output is larger than this, you'd want to cut it down by selecting a subset of the output programmatically. - If the user really wants to print everything, they can run
pprintln(foo, height=99999)
or similar
The heuristics can be tweaked, but they should provide a decent baseline for printing a useful amount of output to screen without flooding the user's terminal.
Setting the default max width and height based on the users terminal is a TODO, I can submit a follow up PR to do so
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good from my side. That is amazing work and persistance @lihaoyi ! Thanks!
Could we squash all those commits, or at least have reasonable commit messages, please?
@sjrd I assumed you would use the Squash and Merge
button on the Github UI, that will embed the PR description in the commit message which will make it easy to follow understand the commit when going through history later on
If you want I can squash it manually too, if you don't want to use the squash button
he means the . , which will present after squashing merge
There's a button to squash-and-use-PR-description-as-commit-message IIRC? That's what I've been using this whole time the last decade
Done, with so many commits, github took the PR description as the message
Thanks again @lihaoyi !
Uh oh!
There was an error while loading. Please reload this page.
This PR demonstrates using the https://github.com/com-lihaoyi/PPrint library to handle pretty-printing of values in the REPL.
Visible improvements:
Seq("")
andSeq()
is no longer identical (sometimes!)'X'
are properly pretty-printed with quotespprint
's own internal highlighter:StringColor
andLiteralColor
as green rather than red. This should help avoid the red of literals being visually confused with the red of error messages when pretty printing code during compilation errors, which is something I have had problems with in the pastFoo
orSeq
orList
, since the vast majority of these identifiers are likely to be the companion object of types, and highlighting them helps greatly in visually finding your way around pretty-printed data structuresBefore:
Screenshot 2025年09月01日 at 9 42 52 AMAfter:
Screenshot 2025年09月01日 at 1 41 05 PMNotes:
sourceGenerators
. This requires a bit of patching to work around-Xexplicit-nulls
and-Xfatal-warnings
, but otherwise is straightforward and means for all intents and purposes it's just part of the Dotty codebase. We mangle the package paths to make themdotty.shaded.*
packages to avoid conflict with user codePPrint
can be configured, e.g. we can decide whether we want to print field names or not. By default it prints field names for anycase class
with more than1
fieldI set the default pprint dimensions to width=100 height=50, and added a
import dotty.shaded.pprint.pprintln
to the predef of every REPL so users havepprintln
available in scope. Users who want to print more than 50 lines can callpprintln
which prints up to 100x500 by default, and can take a customheight=9999
if they want to print more.The numbers 100x50 and 100x500 are heuristics:
pprintln
is a heuristic optimizing for non-terminal use: it's about 5-10 vertical screenfuls of text, and about the limit of what we expect people to usefully be able to skim through. Typically, in most cases when the output is larger than this, you'd want to cut it down by selecting a subset of the output programmatically.pprintln(foo, height=99999)
or similarThe heuristics can be tweaked, but they should provide a decent baseline for printing a useful amount of output to screen without flooding the user's terminal.
TODO/Future-Work:
show(...)
) to bypass the max height. For now, it's fixed at the default width of 100 columnsos-lib
and other libraries withinscala3-compiler
by building them from sourcefansi
elsewhere in the dotty codebase. e.g. the highlighting of stack traces via the code syntax highlighter is super ugly and could be cleaned up: