Skip to content

Commit

Permalink
Improving Printf error messages (#45366)
Browse files Browse the repository at this point in the history
  • Loading branch information
@Seelengrab
Seelengrab committed Jul 8, 2022
1 parent 51bb968 commit 60219d6
Show file tree
Hide file tree
Showing 3 changed files with 82 additions and 33 deletions.
3 changes: 3 additions & 0 deletions NEWS.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,9 @@ Standard library changes

#### Printf

* Error messages for bad format strings have been improved, to make it clearer what & where in the
format string is wrong. ([#45366])

#### Random

* `randn` and `randexp` now work for any `AbstractFloat` type defining `rand` ([#44714]).
Expand Down
82 changes: 61 additions & 21 deletions stdlib/Printf/src/Printf.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,18 +77,50 @@ end
base(T) = T <: HexBases ? 16 : T <: Val{'o'} ? 8 : 10
char(::Type{Val{c}}) where {c} = c

struct InvalidFormatStringError <: Exception
message::String
format::String
start_color::Int
end_color::Int
end

function Base.showerror(io::IO, err::InvalidFormatStringError)
io_has_color = get(io, :color, false)

println(io, "InvalidFormatStringError: ", err.message)
print(io, " \"", @view(err.format[begin:prevind(err.format, err.start_color)]))
invalid_text = @view err.format[err.start_color:err.end_color]

printstyled(io, invalid_text, color=:red)

# +1 is okay, since all format characters are single bytes
println(io, @view(err.format[err.end_color+1:end]), "\"")

arrow_error = '-'^(length(invalid_text)-1)
arrow = " " * ' '^err.start_color * arrow_error * "^\n"
if io_has_color
printstyled(io, arrow, color=:red)
else
print(io, arrow)
end
end

# parse format string
function Format(f::AbstractString)
isempty(f) && throw(ArgumentError("empty format string"))
isempty(f) && throw(InvalidFormatStringError("Format string must not be empty", f, 1, 1))
bytes = codeunits(f)
len = length(bytes)
pos = 1
b = 0x00
local last_percent_pos

# skip ahead to first format specifier
while pos <= len
b = bytes[pos]
pos += 1
if b == UInt8('%')
pos > len && throw(ArgumentError("invalid format string: '$f'"))
last_percent_pos = pos-1
pos > len && throw(InvalidFormatStringError("Format specifier is incomplete", f, last_percent_pos, last_percent_pos))
if bytes[pos] == UInt8('%')
# escaped '%'
b = bytes[pos]
Expand Down Expand Up @@ -120,7 +152,7 @@ function Format(f::AbstractString)
else
break
end
pos > len && throw(ArgumentError("incomplete format string: '$f'"))
pos > len && throw(InvalidFormatStringError("Format specifier is incomplete", f, last_percent_pos, pos-1))
b = bytes[pos]
pos += 1
end
Expand All @@ -139,7 +171,7 @@ function Format(f::AbstractString)
precision = 0
parsedprecdigits = false
if b == UInt8('.')
pos > len && throw(ArgumentError("incomplete format string: '$f'"))
pos > len && throw(InvalidFormatStringError("Precision specifier is missing precision", f, last_percent_pos, pos-1))
parsedprecdigits = true
b = bytes[pos]
pos += 1
Expand All @@ -155,19 +187,21 @@ function Format(f::AbstractString)
# parse length modifier (ignored)
if b == UInt8('h') || b == UInt8('l')
prev = b
pos > len && throw(InvalidFormatStringError("Length modifier is missing type specifier", f, last_percent_pos, pos-1))
b = bytes[pos]
pos += 1
if b == prev
pos > len && throw(ArgumentError("invalid format string: '$f'"))
pos > len && throw(InvalidFormatStringError("Length modifier is missing type specifier", f, last_percent_pos, pos-1))
b = bytes[pos]
pos += 1
end
elseif b in b"Ljqtz"
elseif b in b"Ljqtz" # q was a synonym for ll above, see `man 3 printf`. Not to be used.
pos > len && throw(InvalidFormatStringError("Length modifier is missing type specifier", f, last_percent_pos, pos-1))
b = bytes[pos]
pos += 1
end
# parse type
!(b in b"diouxXDOUeEfFgGaAcCsSpn") && throw(ArgumentError("invalid format string: '$f', invalid type specifier: '$(Char(b))'"))
!(b in b"diouxXDOUeEfFgGaAcCsSpn") && throw(InvalidFormatStringError("'$(Char(b))' is not a valid type specifier", f, last_percent_pos, pos-1))
type = Val{Char(b)}
if type <: Ints && precision > 0
zero = false
Expand All @@ -184,7 +218,8 @@ function Format(f::AbstractString)
b = bytes[pos]
pos += 1
if b == UInt8('%')
pos > len && throw(ArgumentError("invalid format string: '$f'"))
last_percent_pos = pos-1
pos > len && throw(InvalidFormatStringError("Format specifier is incomplete", f, last_percent_pos, last_percent_pos))
if bytes[pos] == UInt8('%')
# escaped '%'
b = bytes[pos]
Expand Down Expand Up @@ -394,6 +429,10 @@ _snprintf(ptr, siz, str, arg) =
@ccall "libmpfr".mpfr_snprintf(ptr::Ptr{UInt8}, siz::Csize_t, str::Ptr{UInt8};
arg::Ref{BigFloat})::Cint

# Arbitrary constant for a maximum number of bytes we want to output for a BigFloat.
# 8KiB seems like a reasonable default. Larger BigFloat representations should probably
# use a custom printing routine. Printing values with results larger than this ourselves
# seems like a dangerous thing to do.
const __BIG_FLOAT_MAX__ = 8192

@inline function fmt(buf, pos, arg, spec::Spec{T}) where {T <: Floats}
Expand All @@ -405,17 +444,15 @@ const __BIG_FLOAT_MAX__ = 8192
GC.@preserve buf begin
siz = length(buf) - pos + 1
str = string(spec; modifier="R")
len = _snprintf(pointer(buf, pos), siz, str, x)
if len > siz
maxout = max(__BIG_FLOAT_MAX__,
ceil(Int, precision(x) * log(2) / log(10)) + 25)
len > maxout &&
error("Over $maxout bytes $len needed to output BigFloat $x")
resize!(buf, len + 1)
len = _snprintf(pointer(buf, pos), len + 1, str, x)
required_length = _snprintf(pointer(buf, pos), siz, str, x)
if required_length > siz
required_length > __BIG_FLOAT_MAX__ &&
throw(ArgumentError("The given BigFloat requires $required_length bytes to be printed, which is more than the maximum of $__BIG_FLOAT_MAX__ bytes supported."))
resize!(buf, required_length + 1)
required_length = _snprintf(pointer(buf, pos), required_length + 1, str, x)
end
len > 0 || throw(ArgumentError("invalid printf formatting $str for BigFloat"))
return pos + len
required_length > 0 || throw(ArgumentError("The given BigFloat would produce less than the maximum allowed number of bytes $__BIG_FLOAT_MAX__, but still couldn't be printed fully for an unknown reason."))
return pos + required_length
end
end
x = Float64(x)
Expand Down Expand Up @@ -805,7 +842,7 @@ plength(::Spec{PositionCounter}, x) = 0
end

@noinline argmismatch(a, b) =
throw(ArgumentError("mismatch between # of format specifiers and provided args: $a != $b"))
throw(ArgumentError("Number of format specifiers and number of provided args differ: $a != $b"))

"""
Printf.format(f::Printf.Format, args...) => String
Expand Down Expand Up @@ -892,8 +929,10 @@ macro printf(io_or_fmt, args...)
return esc(:($Printf.format(stdout, $fmt, $(args...))))
else
io = io_or_fmt
isempty(args) && throw(ArgumentError("must provide required format string"))
fmt = Format(args[1])
isempty(args) && throw(ArgumentError("No format string provided to `@printf` - use like `@printf [io] <format string> [<args...>]."))
fmt_str = first(args)
fmt_str isa String || throw(ArgumentError("First argument to `@printf` after `io` must be a format string"))
fmt = Format(fmt_str)
return esc(:($Printf.format($io, $fmt, $(Base.tail(args)...))))
end
end
Expand All @@ -910,6 +949,7 @@ julia> @sprintf "this is a %s %15.1f" "test" 34.567
```
"""
macro sprintf(fmt, args...)
fmt isa String || throw(ArgumentError("First argument to `@sprintf` must be a format string."))
f = Format(fmt)
return esc(:($Printf.format($f, $(args...))))
end
Expand Down
30 changes: 18 additions & 12 deletions stdlib/Printf/test/runtests.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -339,10 +339,10 @@ end
@test Printf.@sprintf("1%%2%%3") == "1%2%3"
@test Printf.@sprintf("GAP[%%]") == "GAP[%]"
@test Printf.@sprintf("hey there") == "hey there"
@test_throws ArgumentError Printf.Format("")
@test_throws ArgumentError Printf.Format("%+")
@test_throws ArgumentError Printf.Format("%.")
@test_throws ArgumentError Printf.Format("%.0")
@test_throws Printf.InvalidFormatStringError Printf.Format("")
@test_throws Printf.InvalidFormatStringError Printf.Format("%+")
@test_throws Printf.InvalidFormatStringError Printf.Format("%.")
@test_throws Printf.InvalidFormatStringError Printf.Format("%.0")
@test isempty(Printf.Format("%%").formats)
@test Printf.@sprintf("%d%d", 1, 2) == "12"
@test (Printf.@sprintf "%d%d" [1 2]...) == "12"
Expand All @@ -355,10 +355,10 @@ end
@test (Printf.@sprintf("%d\u0f00%d", 1, 2)) == "1\u0f002"
@test (Printf.@sprintf("%d\U0001ffff%d", 1, 2)) == "1\U0001ffff2"
@test (Printf.@sprintf("%d\u2203%d\u0203", 1, 2)) == "1\u22032\u0203"
@test_throws ArgumentError Printf.Format("%y%d")
@test_throws ArgumentError Printf.Format("%\u00d0%d")
@test_throws ArgumentError Printf.Format("%\u0f00%d")
@test_throws ArgumentError Printf.Format("%\U0001ffff%d")
@test_throws Printf.InvalidFormatStringError Printf.Format("%y%d")
@test_throws Printf.InvalidFormatStringError Printf.Format("%\u00d0%d")
@test_throws Printf.InvalidFormatStringError Printf.Format("%\u0f00%d")
@test_throws Printf.InvalidFormatStringError Printf.Format("%\U0001ffff%d")
@test Printf.@sprintf("%10.5d", 4) == " 00004"
@test (Printf.@sprintf "%d" typemax(Int64)) == "9223372036854775807"

Expand Down Expand Up @@ -444,8 +444,8 @@ end
@test (Printf.@sprintf("%f", parse(BigFloat, "1e400"))) ==
"10000000000000000000000000000000000000000000000000000000000000000000000000000025262527574416492004687051900140830217136998040684679611623086405387447100385714565637522507383770691831689647535911648520404034824470543643098638520633064715221151920028135130764414460468236314621044034960475540018328999334468948008954289495190631358190153259681118693204411689043999084305348398480210026863210192871358464.000000"

# Check that does not attempt to output incredibly large amounts of digits
@test_throws ErrorException Printf.@sprintf("%f", parse(BigFloat, "1e99999"))
# Check that Printf does not attempt to output more than 8KiB worth of digits
@test_throws ArgumentError Printf.@sprintf("%f", parse(BigFloat, "1e99999"))

# Check bug with precision > length of string
@test Printf.@sprintf("%4.2s", "a") == " a"
Expand Down Expand Up @@ -528,13 +528,13 @@ end
@test Printf.@sprintf( "%0-5d", -42) == "-42 "
@test Printf.@sprintf( "%0-15d", 42) == "42 "
@test Printf.@sprintf( "%0-15d", -42) == "-42 "
@test_throws ArgumentError Printf.Format("%d %")
@test_throws Printf.InvalidFormatStringError Printf.Format("%d %")

@test Printf.@sprintf("%lld", 18446744065119617025) == "18446744065119617025"
@test Printf.@sprintf("%+8lld", 100) == " +100"
@test Printf.@sprintf("%+.8lld", 100) == "+00000100"
@test Printf.@sprintf("%+10.8lld", 100) == " +00000100"
@test_throws ArgumentError Printf.Format("%_1lld")
@test_throws Printf.InvalidFormatStringError Printf.Format("%_1lld")
@test Printf.@sprintf("%-1.5lld", -100) == "-00100"
@test Printf.@sprintf("%5lld", 100) == " 100"
@test Printf.@sprintf("%5lld", -100) == " -100"
Expand Down Expand Up @@ -782,4 +782,10 @@ end
@test (Printf.@sprintf("%s%n", "1234", x); x[] == 4)
end

@testset "length modifiers" begin
@test_throws Printf.InvalidFormatStringError Printf.Format("%h")
@test_throws Printf.InvalidFormatStringError Printf.Format("%hh")
@test_throws Printf.InvalidFormatStringError Printf.Format("%z")
end

end # @testset "Printf"

0 comments on commit 60219d6

Please sign in to comment.