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.

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

New API: ProgressLogging.implementedby(logger) #24

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 18 additions & 0 deletions src/ProgressLogging.jl
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,8 @@ function Logging.handle_message(logger::MyLogger, args...; kwargs...)
# handle normal log record
end
```

Progress monitors also should define [`implementedby`](@ref).
"""
asprogress(_level, progress::Progress, _args...; _...) = progress
function asprogress(
Expand Down Expand Up @@ -506,4 +508,20 @@ function make_count_to_frac(iterators...)
return count_to_frac
end

"""
ProgressLogging.implementedby(logger::AbstractLogger) :: Bool

Check if ProgressLogging protocol is supported by `logger`.

# Implementation

A progress monitor `CustomLogger <: AbstractLogger` should define

```julia
ProgressLogging.implementedby(::CustomLogger) = true
```
"""
implementedby
implementedby(@nospecialize(logger::Logging.AbstractLogger)) = false

end # module
11 changes: 11 additions & 0 deletions test/test_misc.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
module TestMisc

using ProgressLogging
using Test
using Logging

@testset "implementedby" begin
@test ProgressLogging.implementedby(NullLogger()) == false
end

end # module