Skip to content

feat: rename batching delay to request_delay - #42

Merged
cvigilv merged 4 commits into
mainfrom
cv/fix30-request-delay
Sep 15, 2026
Merged

cvigilv merged 4 commits into
mainfrom
cv/fix30-request-delay

Conversation

@cvigilv

@cvigilv cvigilv commented Sep 15, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • add request_delay to batched kegg_conv, kegg_get, kegg_link, and kegg_list calls
  • retain timeout as a deprecated compatibility alias with conflict and value validation
  • partition inputs lazily and sleep only between requests
  • centralize the KEGG rate-limit warning and make request timing deterministic in tests
  • update API documentation, README examples, and the Julia benchmark runner

Validation

  • julia --project -e 'using Pkg; Pkg.test()'
  • julia --project=docs docs/make.jl
  • package doctests
  • Runic checks for src/, test/, and docs/

Fixes #30.

Validate delay values and emit the KEGG rate-limit warning from one helper. Add an iterator-based batch runner that sleeps only between requests and accepts an injectable sleep callback for deterministic tests.
Migrate conversion, retrieval, link, and list batching to the shared iterator helper. Keep timeout as a deprecated alias, avoid final sleeps, and update the Julia benchmark to use the accurately named keyword.
Exercise the deprecated timeout alias, conflicting and invalid delay values, lazy partition URLs, and per-wrapper sleep counts with injected request and sleep callbacks.
Document request_delay, the deprecated timeout alias, validation failures, and between-request timing. Update the README example, stale conversion names, benchmark instructions, and rate-limit warning wording.
@codecov

codecov Bot commented Sep 15, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Files with missing lines Coverage Δ
src/Conv.jl 100.00% <100.00%> (ø)
src/Get.jl 93.02% <100.00%> (+0.16%) ⬆️
src/KEGGAPI.jl 100.00% <ø> (ø)
src/Link.jl 96.42% <100.00%> (+0.27%) ⬆️
src/List.jl 100.00% <100.00%> (+63.15%) ⬆️
src/utils.jl 100.00% <100.00%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@cvigilv
cvigilv force-pushed the cv/fix30-request-delay branch from 14f8fa8 to ffa769c Compare September 15, 2026 16:23
@cvigilv
cvigilv merged commit b7490bc into main Sep 15, 2026
5 checks passed
@cvigilv
cvigilv deleted the cv/fix30-request-delay branch September 15, 2026 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rename timeout to request_delay for batched calls

1 participant