-
Notifications
You must be signed in to change notification settings - Fork 4
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.
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
Add functions to check enabled checkpoints #26
Merged
Merged
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||
---|---|---|---|---|
|
@@ -68,6 +68,22 @@ Returns a vector of all available (registered) checkpoints. | |||
""" | ||||
available() = collect(keys(CHECKPOINTS)) | ||||
|
||||
""" | ||||
enabled() -> Vector{String} | ||||
|
||||
Returns a vector of all enabled ([`config`](@ref)ured) checkpoints. | ||||
""" | ||||
enabled() = filter(is_enabled, available()) | ||||
|
||||
""" | ||||
is_enabled(name) -> Bool | ||||
is_enabled(names...) -> Bool | ||||
|
||||
Returns `true` if the checkpoint `name`(s) are [`config`](@ref)ured. | ||||
""" | ||||
is_enabled(name) = haskey(CHECKPOINTS, name) && CHECKPOINTS[name] !== nothing | ||||
is_enabled(names...) = all(is_enabled.(names)) | ||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Do we need that? Also, it is probably confusing to see |
||||
|
||||
""" | ||||
checkpoint([prefix], name, data) | ||||
checkpoint([prefix], name, data::Pair...) | ||||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i.e. no
_
to be consistent with julia convention, e.g.isa isqrt isone isodd isnan isinf isdir iszero isreal
.My preference is usually to keep the API as small as possible, because that reduces the probability of having to make a breaking change. So in this case I would just go with exporting
enabled()
. We can always export_isenabled
later if there is a need.p.s. we should
export enabled
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That makes sense, I was thinking that we may as well make it "available" (not exported but not
_
'd either). But it's not needed yet.I didn't
export enabled
by analogy toavailable
not being exported. Does that change your view at all?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like
config
is not exported either (I think we should export it).Let's export
enabled
, but notavailable
(since there seems to be no use case foravailable
outside of the package, but there is forenabled
).@oxinabox thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A reason I see for not exporting these functions is readability in user code. It's not obvious that
config
is about checkpoints if the call is e.g.config(["value1", "value2"], path)
. Even more so forenabled()
on its own. If we exported it, I would prefer to call itenabled_checkpoints
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mzgubic let me know if it looks good now
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!