Skip to content
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

Implement eval-able AnnotatedString 2-arg show #54308

Merged
merged 1 commit into from
Apr 30, 2024

Conversation

tecosaur
Copy link
Contributor

Resolves #54193, which see.

More details in the commit message 🙂

@tecosaur tecosaur added strings "Strings!" backport 1.11 Change should be backported to release-1.11 labels Apr 29, 2024
@tecosaur tecosaur requested a review from LilithHafner April 29, 2024 13:50
@LilithHafner
Copy link
Member

Should also define the 3-arg method to keep using the AbstractString method

julia> @eval Base function show(io::IO, s::A) where {A <: AnnotatedString}
           show(io, A)
           print(io, '(')
           show(io, s.string)
           print(io, ", ")
           show(IOContext(io, :typeinfo => typeof(annotations(s))), annotations(s))
           print(io, ')')
       end
show (generic function with 319 methods)

julia> using StyledStrings

julia> styled"{red:hi}"
Base.AnnotatedString{String}("hi", [(1:2, :face => :red)])

julia> @eval Base show(io::IO, ::MIME"text/plain", s::A) where {A <: AnnotatedString} = invoke(show, Tuple{IO, AbstractString}, io, s)
show (generic function with 320 methods)

julia> styled"{red:hi}"
"hi" # this is red

julia> @test ans == "hi"
Test Failed at REPL[13]:1
  Expression: ans == "hi"
   Evaluated: Base.AnnotatedString{String}("hi", [(1:2, :face => :red)]) == "hi"

ERROR: There was an error during testing

@tecosaur tecosaur force-pushed the repr-eval-annotstr branch from 9e9c7d6 to c96ea43 Compare April 29, 2024 14:35
@tecosaur
Copy link
Contributor Author

Ah yep, thanks for catching that.

@tecosaur tecosaur force-pushed the repr-eval-annotstr branch from c96ea43 to 5903b66 Compare April 29, 2024 14:44
@LilithHafner LilithHafner added the merge me PR is reviewed. Merge when all tests are passing label Apr 29, 2024
@tecosaur
Copy link
Contributor Author

Thanks for giving this a look so quickly 😍

@tecosaur tecosaur force-pushed the repr-eval-annotstr branch from 5903b66 to b86fa13 Compare April 30, 2024 01:41
@tecosaur
Copy link
Contributor Author

Ah, I see the test introduced here will have to be adjusted in #54289.

The generic/fallback AbstractString 2-arg show omits the annotations,
meaning that eval(Meta.parse(repr(::AnnotatedString))) doesn't
round-trip.

The resolution to this is fairly simple, we just need to implement a
specialised show method. The implementation is fairly obvious, we're
just also able to get away with hiding the vector type annotation since
the constructor is fine without it.
@tecosaur tecosaur force-pushed the repr-eval-annotstr branch from b86fa13 to 74b64b1 Compare April 30, 2024 02:59
@tecosaur tecosaur merged commit cc26f4a into JuliaLang:master Apr 30, 2024
7 checks passed
@tecosaur tecosaur deleted the repr-eval-annotstr branch April 30, 2024 11:03
KristofferC pushed a commit that referenced this pull request May 6, 2024
The generic/fallback AbstractString 2-arg show omits the annotations,
meaning that eval(Meta.parse(repr(::AnnotatedString))) doesn't
round-trip.

The resolution to this is fairly simple, we just need to implement a
specialised show method. The implementation is fairly obvious, we're
just also able to get away with hiding the vector type annotation since
the constructor is fine without it.

(cherry picked from commit cc26f4a)
@inkydragon inkydragon removed the merge me PR is reviewed. Merge when all tests are passing label May 17, 2024
KristofferC added a commit that referenced this pull request May 28, 2024
Backported PRs:
- [x] #53665 <!-- use afoldl instead of tail recursion for tuples -->
- [x] #53976 <!-- LinearAlgebra: LazyString in interpolated error
messages -->
- [x] #54005 <!-- make `view(::Memory, ::Colon)` produce a Vector -->
- [x] #54010 <!-- Overload `Base.literal_pow` for `AbstractQ` -->
- [x] #54069 <!-- Allow PrecompileTools to see MI's inferred by foreign
abstract interpreters -->
- [x] #53750 <!-- inference correctness: fields and globals can revert
to undef -->
- [x] #53984 <!-- Profile: fix heap snapshot is valid char check -->
- [x] #54102 <!-- Explicitly compute stride in unaliascopy for SubArray
-->
- [x] #54070 <!-- Fix integer overflow in `skip(s::IOBuffer,
typemax(Int64))` -->
- [x] #54013 <!-- Support case-changes to Annotated{String,Char}s -->
- [x] #53941 <!-- Fix writing of AnnotatedChars to AnnotatedIOBuffer -->
- [x] #54137 <!-- Fix typo in docs for `partialsortperm` -->
- [x] #54129 <!-- use correct size when creating output data from an
IOBuffer -->
- [x] #54153 <!-- Fixup IdSet docstring -->
- [x] #54143 <!-- Fix `make install` from tarballs -->
- [x] #54151 <!-- LinearAlgebra: Correct zero element in
`_generic_matvecmul!` for block adj/trans -->
- [x] #54213 <!-- Add `public` statement to `Base.GC` -->
- [x] #54222 <!-- Utilize correct tbaa when emitting stores of unions.
-->
- [x] #54233 <!-- set MAX_OS_WRITE on unix -->
- [x] #54255 <!-- fix `_checked_mul_dims` in the presence of 0s and
overflow. -->
- [x] #54259 <!-- Fix typo in `readuntil` -->
- [x] #54251 <!-- fix typo in gc_mark_memory8 when chunking a large
array -->
- [x] #54276 <!-- Fix solve for complex `Hermitian` with non-vanishing
imaginary part on diagonal -->
- [x] #54248 <!-- ensure package callbacks are invoked when no valid
precompile file exists for an "auto loaded" stdlib -->
- [x] #54308 <!-- Implement eval-able AnnotatedString 2-arg show -->
- [x] #54302 <!-- Specialised substring equality for annotated strs -->
- [x] #54243 <!-- prevent `package_callbacks` to run multiple time for a
single package -->
- [x] #54350 <!-- add a precompile signature to Artifacts code that is
used by JLLs -->
- [x] #54331 <!-- correctly track freed bytes in
jl_genericmemory_to_string -->
- [x] #53509 <!-- revert moving "creating packages" from Pkg.jl -->
- [x] #54335 <!-- When accessing the data pointer for an array, first
decay it to a Derived Pointer -->
- [x] #54239 <!-- Make sure `fieldcount` constant-folds for `Tuple{...}`
-->
- [x] #54288
- [x] #54067
- [x] #53715 <!-- Add read/write specialisation for IOContext{AnnIO} -->
- [x] #54289 <!-- Rework annotation ordering/optimisations -->
- [x] #53815 <!-- create phantom task for GC threads -->
- [x] #54130 <!-- inference: handle `LimitedAccuracy` in
`handle_global_assignment!` -->
- [x] #54428 <!-- Move ConsoleLogging.jl into Base -->
- [x] #54332 <!-- Revert "add unsetindex support to more copyto methods
(#51760)" -->
- [x] #53826 <!-- Make all command-line options documented in all
related files -->
- [x] #54465 <!-- typeintersect: conservative typevar subtitution during
`finish_unionall` -->
- [x] #54514 <!-- typeintersect: followup cleanup for the nothrow path
of type instantiation -->
- [x] #54499 <!-- make `@doc x` work without REPL loaded -->
- [x] #54210 <!-- attach finalizer in `mmap` to the correct object -->
- [x] #54359 <!-- Pkg REPL: cache `pkg_mode` lookup -->

Non-merged PRs with backport label:
- [ ] #54471 <!-- Actually setup jit targets when compiling
packageimages instead of targeting only one -->
- [ ] #54457 <!-- Make `String(::Memory)` copy -->
- [ ] #54323 <!-- inference: fix too conservative effects for recursive
cycles -->
- [ ] #54322 <!-- effects: add new `@consistent_overlay` macro -->
- [ ] #54191 <!-- make `AbstractPipe` public -->
- [ ] #53957 <!-- tweak how filtering is done for what packages should
be precompiled -->
- [ ] #53882 <!-- Warn about cycles in extension precompilation -->
- [ ] #53707 <!-- Make ScopedValue public -->
- [ ] #53452 <!-- RFC: allow Tuple{Union{}}, returning Union{} -->
- [ ] #53402 <!-- Add `jl_getaffinity` and `jl_setaffinity` -->
- [ ] #53286 <!-- Raise an error when using `include_dependency` with
non-existent file or directory -->
- [ ] #52694 <!-- Reinstate similar for AbstractQ for backward
compatibility -->
- [ ] #51479 <!-- prevent code loading from lookin in the versioned
environment when building Julia -->
@KristofferC KristofferC removed the backport 1.11 Change should be backported to release-1.11 label May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
strings "Strings!"
Projects
None yet
Development

Successfully merging this pull request may close these issues.

AnnotatedStrings are not repr-eval-able.
4 participants