Skip to content

add colmetadata support #311

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

Merged
merged 2 commits into from
Nov 17, 2024
Merged

add colmetadata support #311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
518e843
add colmetadata support
aplavin Jun 14, 2024
a50af8f
fix & add tests
aplavin Jun 15, 2024
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
13 changes: 13 additions & 0 deletions src/StructArrays.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,19 @@ function refvalue(s::StructArray{T}, v::Tup) where {T}
createinstance(T, map(refvalue, components(s), v)...)
end

# implement colmetadata for StructArray based on metadata of individual columns
import DataAPI: metadata, metadatasupport, colmetadata, colmetadatasupport

colmetadatasupport(::Type{T}) where {T<:StructArray} = (
read=any(col -> metadatasupport(col).read, array_types(T).parameters),
write=false, # not implemented
)
colmetadata(sa::StructArray, col::Symbol) = metadata(getproperty(sa, col))
colmetadata(sa::StructArray) =
map(Tables.columns(sa)) do col
metadatasupport(typeof(col)).read ? metadata(col) : nothing
end

@static if !isdefined(Base, :get_extension)
include("../ext/StructArraysAdaptExt.jl")
include("../ext/StructArraysGPUArraysCoreExt.jl")
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 @@ -1189,6 +1189,24 @@ end
end
end

@testset "metadata" begin
using DataAPI: colmetadatasupport, colmetadata, metadata, DataAPI

struct MyArray <: AbstractVector{Int} end
Base.size(::MyArray) = (2,)
DataAPI.metadatasupport(::Type{<:MyArray}) = (read=true, write=false)
DataAPI.metadata(::MyArray) = (x=1, y="2")

sa = StructArray(a=[1,2], b=[1,2])
@test colmetadatasupport(typeof(sa)) == (read=false, write=false)

sa = StructArray(a=MyArray(), b=[1,2])
@test metadata(sa.a) == (x=1, y="2")
@test colmetadatasupport(typeof(sa)) == (read=true, write=false)
@test colmetadata(sa, :a) == (x=1, y="2")
@test colmetadata(sa) == (a=(x=1, y="2"), b=nothing)
end

struct ArrayConverter end

Adapt.adapt_storage(::ArrayConverter, xs::AbstractArray) = convert(Array, xs)
Expand Down