Skip to content

feat: add verbose option to get_data #11

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
Beforerr merged 1 commit into from
Aug 7, 2025
Merged

feat: add verbose option to get_data #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 7 additions & 3 deletions src/data.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@

Get data and metadata from a HAPI `server` for a given `dataset` and `parameters` within a time range `[tmin, tmax]`.

Supported data formats: "csv", "binary", "json".
Supported optional keyword arguments:
- `format`: Data format, default is "csv" (other options: "binary", "json").
- `verbose`: Verbosity level (passed to `HTTP.get`), default is 0 (other options: 1, 2).
"""
function get_data(server, dataset, parameters, tmin, tmax; format = format(server))
function get_data(server, dataset, parameters, tmin, tmax; format = format(server), verbose = 0, kw...)

# Validate time format
tmin = HAPIDateTime(tmin)
Expand All @@ -21,7 +23,8 @@ function get_data(server, dataset, parameters, tmin, tmax; format = format(serve
"format" => format
)
uri = HTTP.request_uri(url, query)
response = HTTP.get(uri)
verbose > 0 && @info "Getting data from $uri"
response = HTTP.get(uri; verbose, kw...)

data = if format == "csv"
CSV.File(response.body; header = false, dateformat = DEFAULT_DATE_FORMAT)
Expand All @@ -36,6 +39,7 @@ function get_data(server, dataset, parameters, tmin, tmax; format = format(serve
meta["uri"] = uri
params = meta["parameters"]
n = length(params) - 1
verbose > 0 && @info "Got $n parameters"
return n == 1 ? _merge_meta!(HAPIVariable(data, params, 1), meta) : HAPIVariables(data, params, meta)
end

Expand Down
17 changes: 11 additions & 6 deletions test/data.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
# Reference: https://github.com/hapi-server/client-matlab/blob/master/hapi_test.m

@testitem "get_data" begin
id = "CDAWeb/AC_H0_MFI/Magnitude,BGSEc"
tmin = "2001-01-01T05"
tmax = "2001-01-01T06"
data = get_data(id, [tmin, tmax]; verbose=1)
@test data.Magnitude == data[1]
@test length(data) == 2
@test length(times(data)) == 225
@test meta(data[1])["name"] == "Magnitude"
@test_nowarn display(data)

for fmt in ["csv", "json"]
data = get_data("CDAWeb/AC_H0_MFI/Magnitude,BGSEc", ["2001-01-01T05", "2001-01-01T06"]; format = fmt)
@test data.Magnitude == data[1]
@test length(data) == 2
@test length(times(data)) == 225
@test meta(data[1])["name"] == "Magnitude"
@test_nowarn display(data)
@test_nowarn get_data(id, [tmin, tmax]; format = fmt)
end
end
@testitem "TestData2.0" begin
Expand Down
Loading