Skip to content

Show load and file_extensions in accessors #27

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 4 commits into from
Oct 8, 2024
Merged

Show load and file_extensions in accessors #27

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
709a5cb
make accessors show load and filename_extensions
oxinabox Oct 8, 2024
722911a
move to a helper function
oxinabox Oct 8, 2024
86a1e15
make required_accessors show load and filename_extensions
oxinabox Oct 8, 2024
8073ccb
upd comment
exaexa Oct 8, 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
4 changes: 2 additions & 2 deletions docs/src/utilities.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ import AbstractFBCModels as A

A.accessors()

@test length(A.accessors()) == 35 #src
@test length(A.accessors()) == 37 #src

@test length(A.required_accessors()) == 11 #src
@test length(A.required_accessors()) == 13 #src

# You do not need to overload all of them (e.g., if you model does not have any
# genes you can completely omit all gene-related functions). The main required
Expand Down
28 changes: 22 additions & 6 deletions src/utils.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,12 @@ end
unimplemented(t::Type, x::Symbol) =
error("AbstractFBCModels interface method $x is not implemented for type $t")


"""
$(TYPEDSIGNATURES)

Provide a `methodswith`-style listing of accessors that the model implementors
may implement.

For typesystem reasons, the list **will not contain** methods for
[`load`](@ref) and [`filename_extensions`](@ref) that dispatch on type objects.
You should implement these as well.

See also [`required_accessors`](@ref) for the minimal list that must be implemented.
"""
function accessors()
ms = Method[]
Expand All @@ -48,9 +43,29 @@ function accessors()
methodswith(AbstractFBCModels.AbstractFBCModel, f, ms)
end
end

append!(ms, _type_accessors())
return ms
end

function _type_accessors()
# special case these as they take the type not the instance
ms = Method[]
for f in (AbstractFBCModels.load, AbstractFBCModels.filename_extensions)
for m in methods(f)
m.sig isa UnionAll || continue
# Deep magic: basically this matches on `f(::Type{A},...) where A<:AbstractFBCModel`
type_param = Base.unwrap_unionall(m.sig).parameters[2].parameters[1].ub
if type_param == AbstractFBCModels.AbstractFBCModel
push!(ms, m)
end
end
end

return ms
end


"""
$(TYPEDSIGNATURES)

Expand All @@ -70,6 +85,7 @@ function required_accessors()
for f in REQUIRED_ACCESSORS
methodswith(AbstractFBCModels.AbstractFBCModel, f, ms)
end
append!(ms, _type_accessors())
return ms
end

Expand Down
Loading