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.

Sign up for GitHub

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

Jump to bottom

required keyword arguments #586

Merged
merged 8 commits into from
Jul 18, 2018
Merged

required keyword arguments #586

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a9da698
required keyword arguments working
Jul 4, 2018
c6c4be8
using @test_throws and UndeKeywordError now
Jul 4, 2018
51bb759
defining UndefKeywordError only if not yet in Base
Jul 4, 2018
35a2e6c
corrected UndefKeywordError message
Jul 4, 2018
01727dd
added README entry for required keyword arguments
Jul 6, 2018
b9465b2
Merge branch 'master' into master
timziebart Jul 11, 2018
e4dbb1d
Update README.md
timziebart Jul 13, 2018
af801ee
updated README with link
Jul 13, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ Currently, the `@compat` macro supports the following syntaxes:
`foo(::CartesianRange{CartesianIndex{N}})` ([#20974]). Note that
`CartesianRange` now has two type parameters, so using them as
fields in other `struct`s requires manual intervention.

* required keyword arguments: e.g. `@compat foo(;x, y)` makes `x` and `y` required keyword arguments. When calling `foo` an error is thrown if `x` and `y` are not explictly provided
Copy link
Member

@stevengj stevengj Jul 11, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Some fixes:

* Required keyword arguments ([#25830]). For example, `@compat foo(; x, y)` makes `x` and `y` required keyword arguments: when calling `foo`, an error is thrown if `x` or `y` is not explicitly provided.

Copy link
Member

@stevengj stevengj Jul 11, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

(The link to JuliaLang/julia#25830 is added if you run julia /path/to/julia/doc/NEWS-update.jl README.jl to run https://github.com/JuliaLang/julia/blob/master/doc/NEWS-update.jl)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I just pushed the update README.md.


## Module Aliases

Expand Down
18 changes: 18 additions & 0 deletions src/compatmacro.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,31 @@ else
new_style_typealias(ex) = false
end

if !isdefined(Base, :UndefKeywordError)
struct UndefKeywordError <: Exception
kw
end
Base.showerror(io::IO, e::UndefKeywordError) = print(io, "UndefKeywordError: keyword argument $(e.kw) not assigned")
export UndefKeywordError
end

"Convert a functions symbol argument to the corresponding required keyword argument."
function symbol2kw(sym::Symbol)
Expr(:kw, sym, Expr(:call, throw, UndefKeywordError(sym)))
end
symbol2kw(arg) = arg
Copy link
Member

@stevengj stevengj Oct 19, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

This doesn't handle the case where the argument has a type. It should probably be:

arg2kw(arg, sym) = Expr(:kw, arg, Expr(:call, throw, UndefKeywordError(sym)))
symbol2kw(arg::Symbol) = arg2kw(arg, arg)
symbol2kw(arg::Expr) = isexpr(arg, :(::)) ? arg2kw(arg, arg.args[1]) : arg
symbol2kw(arg) = arg

Copy link
Member

Choose a reason for hiding this comment

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

(See https://discourse.julialang.org/t/make-function-arguments-positional-or-keyword/2984/35)


function _compat(ex::Expr)
if ex.head === :call
f = ex.args[1]
if VERSION < v"0.6.0-dev.826" && length(ex.args) == 3 && # julia#18510
istopsymbol(withincurly(ex.args[1]), :Base, :Nullable)
ex = Expr(:call, f, ex.args[2], Expr(:call, :(Compat._Nullable_field2), ex.args[3]))
end
if !isdefined(Base, :UndefKeywordError) && length(ex.args) > 1 && isexpr(ex.args[2], :parameters)
params = ex.args[2]
params.args = map(symbol2kw, params.args)
end
elseif ex.head === :curly
f = ex.args[1]
if VERSION < v"0.6.0-dev.2575" #20414
Expand Down
18 changes: 18 additions & 0 deletions test/runtests.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1896,6 +1896,24 @@ let
@test Compat.split(str, r"\.+:\.+"; limit=3, keepempty=true) == ["a","ba","cba.:.:.dcba.:."]
end

let
# test required keyword arguments
@compat func1() = 1
@test func1() == 1 # using the function works
@compat func2(x) = x
@test func2(3) == 3 # using the function works
@compat func3(;y) = y
@test func3(y=2) == 2 # using the function works
@test_throws UndefKeywordError func3()
@compat func4(x; z) = x*z
@test func4(2,z=3) == 6 # using the function works
@test_throws UndefKeywordError func4(2)
@compat func5(;x=1, y) = x*y
@test func5(y=3) == 3
@test func5(y=3, x=2) == 6
@test_throws UndefKeywordError func5(x=2)
end

# 0.7.0-beta.73
let a = rand(5,5)
s = mapslices(sort, a, dims=[1])
Expand Down