Skip to content

Commit d9e2632

Browse files
simeonschaubsimeonschaub
authored
implement property destructuring (#39285)
* implement property destructuring This currently only allows the form `(; a, b) = x` and lowers this to calls to `getproperty`. We could think about whether we want to allow specifying default values for properties as well, or even some kind of property renaming in the lhs. We could even allow slurping unused properties, but all of that sounds more difficult to work out in detail and potentially controversial, so I left this as an error for now. fixes #28579 * add NEWS entry
1 parent ae53238 commit d9e2632

File tree

3 files changed

+108
-59
lines changed

3 files changed

+108
-59
lines changed

‎NEWS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ Julia v1.7 Release Notes
44
New language features
55
---------------------
66

7+
* `(; a, b) = x` can now be used to destructure properties `a` and `b` of `x`. This syntax is equivalent to `a = getproperty(x, :a)`
8+
and similarly for `b`. ([#39285])
9+
710
Language changes
811
----------------
912

‎src/julia-syntax.scm

Lines changed: 76 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1950,6 +1950,66 @@
19501950
,@(map expand-forms (cddr e))))
19511951
(cons (car e) (map expand-forms (cdr e))))))
19521952

1953+
(define (expand-tuple-destruct lhss x)
1954+
(define (sides-match? l r)
1955+
;; l and r either have equal lengths, or r has a trailing ...
1956+
(cond ((null? l) (null? r))
1957+
((vararg? (car l)) #t)
1958+
((null? r) #f)
1959+
((vararg? (car r)) (null? (cdr r)))
1960+
(else (sides-match? (cdr l) (cdr r)))))
1961+
(if (and (pair? x) (pair? lhss) (eq? (car x) 'tuple) (not (any assignment? (cdr x)))
1962+
(not (has-parameters? (cdr x)))
1963+
(sides-match? lhss (cdr x)))
1964+
;; (a, b, ...) = (x, y, ...)
1965+
(expand-forms
1966+
(tuple-to-assignments lhss x))
1967+
;; (a, b, ...) = other
1968+
(begin
1969+
;; like memq, but if last element of lhss is (... sym),
1970+
;; check against sym instead
1971+
(define (in-lhs? x lhss)
1972+
(if (null? lhss)
1973+
#f
1974+
(let ((l (car lhss)))
1975+
(cond ((and (pair? l) (eq? (car l) '|...|))
1976+
(if (null? (cdr lhss))
1977+
(eq? (cadr l) x)
1978+
(error (string "invalid \"...\" on non-final assignment location \""
1979+
(cadr l) "\""))))
1980+
((eq? l x) #t)
1981+
(else (in-lhs? x (cdr lhss)))))))
1982+
;; in-lhs? also checks for invalid syntax, so always call it first
1983+
(let* ((xx (if (or (and (not (in-lhs? x lhss)) (symbol? x))
1984+
(ssavalue? x))
1985+
x (make-ssavalue)))
1986+
(ini (if (eq? x xx) '() (list (sink-assignment xx (expand-forms x)))))
1987+
(n (length lhss))
1988+
;; skip last assignment if it is an all-underscore vararg
1989+
(n (if (> n 0)
1990+
(let ((l (last lhss)))
1991+
(if (and (vararg? l) (underscore-symbol? (cadr l)))
1992+
(- n 1)
1993+
n))
1994+
n))
1995+
(st (gensy)))
1996+
`(block
1997+
,@(if (> n 0) `((local ,st)) '())
1998+
,@ini
1999+
,@(map (lambda (i lhs)
2000+
(expand-forms
2001+
(if (vararg? lhs)
2002+
`(= ,(cadr lhs) (call (top rest) ,xx ,@(if (eq? i 0) '() `(,st))))
2003+
(lower-tuple-assignment
2004+
(if (= i (- n 1))
2005+
(list lhs)
2006+
(list lhs st))
2007+
`(call (top indexed_iterate)
2008+
,xx ,(+ i 1) ,@(if (eq? i 0) '() `(,st)))))))
2009+
(iota n)
2010+
lhss)
2011+
(unnecessary ,xx))))))
2012+
19532013
;; move an assignment into the last statement of a block to keep more statements at top level
19542014
(define (sink-assignment lhs rhs)
19552015
(if (and (pair? rhs) (eq? (car rhs) 'block))
@@ -2102,67 +2162,24 @@
21022162
(call (top setproperty!) ,aa ,bb ,rr)
21032163
(unnecessary ,rr)))))
21042164
((tuple)
2105-
;; multiple assignment
21062165
(let ((lhss (cdr lhs))
21072166
(x (caddr e)))
2108-
(define (sides-match? l r)
2109-
;; l and r either have equal lengths, or r has a trailing ...
2110-
(cond ((null? l) (null? r))
2111-
((vararg? (car l)) #t)
2112-
((null? r) #f)
2113-
((vararg? (car r)) (null? (cdr r)))
2114-
(else (sides-match? (cdr l) (cdr r)))))
2115-
(if (and (pair? x) (pair? lhss) (eq? (car x) 'tuple) (not (any assignment? (cdr x)))
2116-
(not (has-parameters? (cdr x)))
2117-
(sides-match? lhss (cdr x)))
2118-
;; (a, b, ...) = (x, y, ...)
2119-
(expand-forms
2120-
(tuple-to-assignments lhss x))
2121-
;; (a, b, ...) = other
2122-
(begin
2123-
;; like memq, but if last element of lhss is (... sym),
2124-
;; check against sym instead
2125-
(define (in-lhs? x lhss)
2126-
(if (null? lhss)
2127-
#f
2128-
(let ((l (car lhss)))
2129-
(cond ((and (pair? l) (eq? (car l) '|...|))
2130-
(if (null? (cdr lhss))
2131-
(eq? (cadr l) x)
2132-
(error (string "invalid \"...\" on non-final assignment location \""
2133-
(cadr l) "\""))))
2134-
((eq? l x) #t)
2135-
(else (in-lhs? x (cdr lhss)))))))
2136-
;; in-lhs? also checks for invalid syntax, so always call it first
2137-
(let* ((xx (if (or (and (not (in-lhs? x lhss)) (symbol? x))
2138-
(ssavalue? x))
2139-
x (make-ssavalue)))
2140-
(ini (if (eq? x xx) '() (list (sink-assignment xx (expand-forms x)))))
2141-
(n (length lhss))
2142-
;; skip last assignment if it is an all-underscore vararg
2143-
(n (if (> n 0)
2144-
(let ((l (last lhss)))
2145-
(if (and (vararg? l) (underscore-symbol? (cadr l)))
2146-
(- n 1)
2147-
n))
2148-
n))
2149-
(st (gensy)))
2150-
`(block
2151-
,@(if (> n 0) `((local ,st)) '())
2152-
,@ini
2153-
,@(map (lambda (i lhs)
2154-
(expand-forms
2155-
(if (vararg? lhs)
2156-
`(= ,(cadr lhs) (call (top rest) ,xx ,@(if (eq? i 0) '() `(,st))))
2157-
(lower-tuple-assignment
2158-
(if (= i (- n 1))
2159-
(list lhs)
2160-
(list lhs st))
2161-
`(call (top indexed_iterate)
2162-
,xx ,(+ i 1) ,@(if (eq? i 0) '() `(,st)))))))
2163-
(iota n)
2164-
lhss)
2165-
(unnecessary ,xx)))))))
2167+
(if (has-parameters? lhss)
2168+
;; property destructuring
2169+
(if (length= lhss 1)
2170+
(let* ((xx (if (symbol-like? x) x (make-ssavalue)))
2171+
(ini (if (eq? x xx) '() (list (sink-assignment xx (expand-forms x))))))
2172+
`(block
2173+
,@ini
2174+
,@(map (lambda (field)
2175+
(if (not (symbol? field))
2176+
(error (string "invalid assignment location \"" (deparse lhs) "\"")))
2177+
(expand-forms `(= ,field (call (top getproperty) ,xx (quote ,field)))))
2178+
(cdar lhss))
2179+
(unnecessary ,xx)))
2180+
(error (string "invalid assignment location \"" (deparse lhs) "\"")))
2181+
;; multiple assignment
2182+
(expand-tuple-destruct lhss x))))
21662183
((typed_hcat)
21672184
(error "invalid spacing in left side of indexed assignment"))
21682185
((typed_vcat)

‎test/syntax.jl

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2649,3 +2649,32 @@ end
26492649

26502650
# issue #38501
26512651
@test :"a $b $("str") c" == Expr(:string, "a ", :b, " ", Expr(:string, "str"), " c")
2652+
2653+
@testset "property destructuring" begin
2654+
res = begin (; num, den) = 1 // 2 end
2655+
@test res == 1 // 2
2656+
@test num == 1
2657+
@test den == 2
2658+
2659+
res = begin (; b, a) = (a=1, b=2, c=3) end
2660+
@test res == (a=1, b=2, c=3)
2661+
@test b == 2
2662+
@test a == 1
2663+
2664+
# could make this an error instead, but I think this is reasonable
2665+
res = begin (; a, b, a) = (a=5, b=6) end
2666+
@test res == (a=5, b=6)
2667+
@test a == 5
2668+
@test b == 6
2669+
2670+
@test_throws ErrorException (; a, b) = (x=1,)
2671+
2672+
@test Meta.isexpr(Meta.@lower(begin (a, b; c) = x end), :error)
2673+
@test Meta.isexpr(Meta.@lower(begin (a, b; c) = x, y end), :error)
2674+
@test Meta.isexpr(Meta.@lower(begin (; c, a.b) = x end), :error)
2675+
2676+
f((; a, b)) = a, b
2677+
@test f((b=3, a=4)) == (4, 3)
2678+
@test f((b=3, c=2, a=4)) == (4, 3)
2679+
@test_throws ErrorException f((;))
2680+
end

0 commit comments

Comments
 (0)