Use explicit imports #2765

ChrisRackauckas · 2025-07-20T05:40:12Z

No description provided.

Removed unused imports that were causing ExplicitImports.jl test failures. The following stale imports were removed: - From OrdinaryDiffEqCore: Many utility functions that are no longer directly used - From OrdinaryDiffEqDifferentiation: Functions that are not directly referenced - From OrdinaryDiffEqNonlinearSolve: Several internal functions - From OrdinaryDiffEqRosenbrock: RosenbrockMutableCache All explicit import tests now pass. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>

github-actions · 2025-07-21T14:12:56Z

Benchmark Results (Julia v1)

Time benchmarks

	master	`5c33747`...	master / `5c33747`...
construction/linear_N50	27.7 ± 14 μs	27.5 ± 14 μs	1.01 ± 0.73
construction/lotka_volterra	18.3 ± 0.24 μs	18.3 ± 0.19 μs	1 ± 0.017
construction/rober	18.3 ± 0.22 μs	18.4 ± 0.22 μs	0.995 ± 0.017
nonstiff/fitzhugh_nagumo/BS3	0.145 ± 0.011 ms	0.146 ± 0.01 ms	0.994 ± 0.1
nonstiff/fitzhugh_nagumo/DP5	0.0968 ± 0.005 ms	0.0988 ± 0.011 ms	0.98 ± 0.12
nonstiff/fitzhugh_nagumo/Tsit5	0.116 ± 0.0067 ms	0.117 ± 0.0088 ms	0.992 ± 0.094
nonstiff/fitzhugh_nagumo/Vern6	0.17 ± 0.0088 ms	0.171 ± 0.0092 ms	0.994 ± 0.075
nonstiff/fitzhugh_nagumo/Vern7	0.115 ± 0.0089 ms	0.114 ± 0.009 ms	1.01 ± 0.11
nonstiff/lotka_volterra/BS3	0.294 ± 0.012 ms	0.29 ± 0.011 ms	1.01 ± 0.058
nonstiff/lotka_volterra/DP5	0.0479 ± 0.018 ms	0.0484 ± 0.018 ms	0.99 ± 0.52
nonstiff/lotka_volterra/Tsit5	0.0626 ± 0.024 ms	0.0636 ± 0.028 ms	0.984 ± 0.57
nonstiff/lotka_volterra/Vern6	0.0829 ± 0.012 ms	0.0824 ± 0.014 ms	1.01 ± 0.22
nonstiff/lotka_volterra/Vern7	0.0511 ± 0.023 ms	0.05 ± 0.022 ms	1.02 ± 0.63
nonstiff/pleiades/BS3	0.0896 ± 0.02 s	0.0889 ± 0.016 s	1.01 ± 0.29
nonstiff/pleiades/DP5	1.26 ± 0.094 ms	1.24 ± 0.096 ms	1.01 ± 0.11
nonstiff/pleiades/Tsit5	15.9 ± 6.1 ms	15.8 ± 6.9 ms	1.01 ± 0.58
nonstiff/pleiades/Vern6	7.56 s	7.45 s	1.01
nonstiff/pleiades/Vern7	8.11 s	8.05 s	1.01
scaling/brusselator_2d/16x16	0.323 ± 0.012 s	0.31 ± 0.035 s	1.04 ± 0.12
scaling/brusselator_2d/32x32	7.27 s	7.32 s	0.994
scaling/brusselator_2d/8x8	12 ± 1.1 ms	11.5 ± 0.67 ms	1.04 ± 0.11
scaling/linear/N10	0.0377 ± 0.017 ms	0.0371 ± 0.018 ms	1.02 ± 0.67
scaling/linear/N100	0.82 ± 0.024 ms	0.815 ± 0.022 ms	1.01 ± 0.04
scaling/linear/N50	0.225 ± 0.013 ms	0.221 ± 0.013 ms	1.02 ± 0.086
stiff/pollution/FBDF	0.6 ± 0.014 ms	0.606 ± 0.016 ms	0.99 ± 0.034
stiff/pollution/KenCarp4	0.555 ± 0.012 ms	0.557 ± 0.011 ms	0.997 ± 0.029
stiff/pollution/Rodas4	0.783 ± 0.015 ms	0.781 ± 0.015 ms	1 ± 0.027
stiff/pollution/Rosenbrock23	1.37 ± 0.027 ms	1.37 ± 0.03 ms	1 ± 0.03
stiff/pollution/TRBDF2	0.517 ± 0.013 ms	0.521 ± 0.013 ms	0.991 ± 0.034
stiff/rober/FBDF	0.599 ± 0.012 ms	0.605 ± 0.012 ms	0.99 ± 0.027
stiff/rober/KenCarp4	0.774 ± 0.022 ms	0.751 ± 0.021 ms	1.03 ± 0.041
stiff/rober/Rodas4	0.41 ± 0.01 ms	0.415 ± 0.01 ms	0.988 ± 0.034
stiff/rober/Rosenbrock23	0.28 ± 0.0098 ms	0.281 ± 0.01 ms	0.998 ± 0.05
stiff/rober/TRBDF2	1.73 ± 0.019 ms	1.75 ± 0.018 ms	0.991 ± 0.015
stiff/van_der_pol/FBDF	9.78 ± 0.11 ms	9.79 ± 0.11 ms	0.998 ± 0.016
stiff/van_der_pol/KenCarp4	5.03 ± 0.076 ms	4.7 ± 0.088 ms	1.07 ± 0.026
stiff/van_der_pol/Rodas4	7.63 ± 0.053 ms	7.25 ± 0.057 ms	1.05 ± 0.011
stiff/van_der_pol/Rosenbrock23	21.8 ± 0.33 ms	21.3 ± 0.23 ms	1.02 ± 0.019
stiff/van_der_pol/TRBDF2	3.13 ± 0.089 ms	3.02 ± 0.08 ms	1.04 ± 0.04
time_to_load	3.29 ± 0.084 s	3.28 ± 0.073 s	1 ± 0.034

Memory benchmarks

	master	`5c33747`...	master / `5c33747`...
construction/linear_N50	0.071 k allocs: 0.0411 MB	0.071 k allocs: 0.0411 MB	1
construction/lotka_volterra	0.065 k allocs: 2.45 kB	0.065 k allocs: 2.45 kB	1
construction/rober	0.065 k allocs: 2.42 kB	0.065 k allocs: 2.42 kB	1
nonstiff/fitzhugh_nagumo/BS3	3.69 k allocs: 0.164 MB	3.69 k allocs: 0.164 MB	1
nonstiff/fitzhugh_nagumo/DP5	2.63 k allocs: 0.127 MB	2.63 k allocs: 0.127 MB	1
nonstiff/fitzhugh_nagumo/Tsit5	4 k allocs: 0.182 MB	4 k allocs: 0.182 MB	1
nonstiff/fitzhugh_nagumo/Vern6	4.54 k allocs: 0.207 MB	4.54 k allocs: 0.207 MB	1
nonstiff/fitzhugh_nagumo/Vern7	3.91 k allocs: 0.165 MB	3.91 k allocs: 0.165 MB	1
nonstiff/lotka_volterra/BS3	7.88 k allocs: 0.365 MB	7.88 k allocs: 0.365 MB	1
nonstiff/lotka_volterra/DP5	1.21 k allocs: 0.0543 MB	1.21 k allocs: 0.0543 MB	1
nonstiff/lotka_volterra/Tsit5	2.17 k allocs: 0.093 MB	2.17 k allocs: 0.093 MB	1
nonstiff/lotka_volterra/Vern6	2.24 k allocs: 0.0986 MB	2.24 k allocs: 0.0986 MB	1
nonstiff/lotka_volterra/Vern7	1.65 k allocs: 0.0736 MB	1.65 k allocs: 0.0736 MB	1
nonstiff/pleiades/BS3	0.685 M allocs: 0.0675 GB	0.685 M allocs: 0.0675 GB	1
nonstiff/pleiades/DP5	6.63 k allocs: 0.51 MB	6.63 k allocs: 0.51 MB	1
nonstiff/pleiades/Tsit5	0.186 M allocs: 20.4 MB	0.186 M allocs: 20.4 MB	1
nonstiff/pleiades/Vern6	0.038 G allocs: 4.05 GB	0.038 G allocs: 4.05 GB	1
nonstiff/pleiades/Vern7	0.044 G allocs: 4.63 GB	0.044 G allocs: 4.63 GB	1
scaling/brusselator_2d/16x16	3.58 k allocs: 0.152 GB	3.58 k allocs: 0.152 GB	1
scaling/brusselator_2d/32x32	3.4 k allocs: 2.22 GB	3.4 k allocs: 2.22 GB	1
scaling/brusselator_2d/8x8	2.62 k allocs: 8.76 MB	2.62 k allocs: 8.76 MB	1
scaling/linear/N10	0.752 k allocs: 0.0514 MB	0.752 k allocs: 0.0514 MB	1
scaling/linear/N100	2.27 k allocs: 0.901 MB	2.27 k allocs: 0.901 MB	1
scaling/linear/N50	1.66 k allocs: 0.348 MB	1.66 k allocs: 0.348 MB	1
stiff/pollution/FBDF	1.5 k allocs: 0.288 MB	1.5 k allocs: 0.288 MB	1
stiff/pollution/KenCarp4	0.516 k allocs: 0.134 MB	0.516 k allocs: 0.134 MB	1
stiff/pollution/Rodas4	1.28 k allocs: 0.363 MB	1.28 k allocs: 0.363 MB	1
stiff/pollution/Rosenbrock23	2.77 k allocs: 0.819 MB	2.77 k allocs: 0.819 MB	1
stiff/pollution/TRBDF2	0.783 k allocs: 0.168 MB	0.783 k allocs: 0.168 MB	1
stiff/rober/FBDF	2.89 k allocs: 0.137 MB	2.89 k allocs: 0.137 MB	1
stiff/rober/KenCarp4	1.3 k allocs: 0.0575 MB	1.3 k allocs: 0.0575 MB	1
stiff/rober/Rodas4	2.19 k allocs: 0.106 MB	2.19 k allocs: 0.106 MB	1
stiff/rober/Rosenbrock23	2.51 k allocs: 0.117 MB	2.51 k allocs: 0.117 MB	1
stiff/rober/TRBDF2	7.72 k allocs: 0.36 MB	7.72 k allocs: 0.36 MB	1
stiff/van_der_pol/FBDF	0.0444 M allocs: 2.2 MB	0.0444 M allocs: 2.2 MB	1
stiff/van_der_pol/KenCarp4	4.27 k allocs: 0.184 MB	4.27 k allocs: 0.184 MB	1
stiff/van_der_pol/Rodas4	0.0377 M allocs: 1.86 MB	0.0377 M allocs: 1.86 MB	1
stiff/van_der_pol/Rosenbrock23	0.213 M allocs: 9.09 MB	0.213 M allocs: 9.09 MB	1
stiff/van_der_pol/TRBDF2	5.02 k allocs: 0.212 MB	5.02 k allocs: 0.212 MB	1
time_to_load	0.159 k allocs: 11.2 kB	0.159 k allocs: 11.2 kB	1

- Remove duplicate exports of AutoTsit5 and AutoDP5 (already exported earlier in the file) - Add missing imports for AutoVern6, AutoVern7, AutoVern8, AutoVern9 from OrdinaryDiffEqVerner - Fixes ExplicitImports.jl test failures

…ctions - Added missing LinearAlgebra imports: diag, inv, rank, isdiag - Added missing DataStructures import: FasterForward - Fixed imports in OrdinaryDiffEqCore, OrdinaryDiffEqSDIRK, OrdinaryDiffEqRosenbrock, and OrdinaryDiffEqLinear modules

lib/OrdinaryDiffEqCore/src/OrdinaryDiffEqCore.jl

lib/OrdinaryDiffEqRosenbrock/src/OrdinaryDiffEqRosenbrock.jl

lib/OrdinaryDiffEqSDIRK/src/OrdinaryDiffEqSDIRK.jl

lib/OrdinaryDiffEqLinear/src/OrdinaryDiffEqLinear.jl

Project.toml

lib/OrdinaryDiffEqCore/src/OrdinaryDiffEqCore.jl

ChrisRackauckas · 2025-07-31T23:45:09Z

Guide to Setting Up Explicit Imports in Julia Packages

I've successfully updated this PR to use explicit imports throughout OrdinaryDiffEq.jl. Here's a detailed guide on how to set up explicit imports, test them properly, and ensure everything works correctly.

Why Explicit Imports?

Explicit imports make dependencies clear, prevent namespace pollution, and help with code maintenance. They also make it easier to track what functions come from which packages.

Step-by-Step Process

1. Add ExplicitImports.jl Test

First, ensure you have a test for explicit imports. In test/qa/qa_tests.jl:

using ExplicitImports, OrdinaryDiffEq
using Test

@testset "ExplicitImports" begin
    @test check_no_implicit_imports(
        OrdinaryDiffEq; skip = (Base, Core, SciMLBase)
    ) === nothing
    
    @test check_no_stale_explicit_imports(OrdinaryDiffEq) === nothing
    
    @test check_all_qualified_accesses_via_owners(OrdinaryDiffEq) === nothing
end

2. Run Initial Analysis

Run the ExplicitImports check to see what needs fixing:

julia --project=. -e "using ExplicitImports, OrdinaryDiffEq; println(check_no_implicit_imports(OrdinaryDiffEq; skip = (Base, Core, SciMLBase)))"

This will show you all the implicit imports that need to be made explicit.

3. Fix Import Patterns

For each module, follow this pattern:

# Instead of:
using SomePackage

# Use:
import SomePackage: SomePackage  # Import the module name itself if needed
using SomePackage: function1, function2, Type1, Type2  # Import specific items

For re-exported packages:

import Reexport: Reexport, @reexport
using Reexport: @reexport
@reexport using DiffEqBase

# Also import the functions you use from re-exported packages
import DiffEqBase: DiffEqBase
import CommonSolve: init, solve, solve\!, step\!
import SciMLBase: SciMLBase, addsteps\!, savevalues\!, terminate\!

4. Handle Submodules

If your package has submodules, you need to:

Import the submodule name explicitly
Import the specific functions/types from the submodule
Export the submodule name if it should be accessible to users

import OrdinaryDiffEqVerner: OrdinaryDiffEqVerner
using OrdinaryDiffEqVerner: Vern6, Vern7, Vern8, Vern9
export OrdinaryDiffEqVerner, Vern6, Vern7, Vern8, Vern9

5. Common Issues and Solutions

Missing Dependencies: If you get an error about missing packages (like CommonSolve), add them to Project.toml:

[deps]
CommonSolve = "38540f10-b2f7-11e9-35d8-d573e4eb0ff2"

[compat]
CommonSolve = "0.2"

Stale Imports: The test check_no_stale_explicit_imports will catch unused imports. Remove any imports that aren't actually used.

Module vs Function Imports: When you need both the module and its exports:

import SomeModule: SomeModule  # Import the module itself
using SomeModule: func1, func2  # Import specific functions

Testing Process

Run the ExplicitImports test locally:

cd test && julia --project=. -e "using Test; @testset \"QA Tests\" begin include(\"qa/qa_tests.jl\") end"

Test incrementally: After fixing a batch of imports, run the test again to see progress.
Check for stale imports: The test will also catch imports that are defined but never used.
Run full test suite: Once ExplicitImports passes, run the full test suite to ensure nothing broke.

Tricks and Best Practices

Use the error messages: ExplicitImports gives very clear error messages showing exactly which symbols need explicit imports and where they come from.
Group related imports: Keep imports from the same package together for readability.
Format consistently: Use JuliaFormatter after making changes:
```
using JuliaFormatter; format("src/OrdinaryDiffEq.jl")
```
Handle re-exports carefully: When using @reexport, you might need to import both from the original package and handle the re-export.
Check submodule exports: If your package has submodules that should be accessible to users, remember to export the submodule names themselves, not just their contents.

What I Changed in This PR

Added explicit imports for all OrdinaryDiffEq submodules (OrdinaryDiffEqVerner, OrdinaryDiffEqBDF, etc.)
Added CommonSolve as a dependency and imported init, solve, solve!, step!
Made SciMLBase imports explicit
Exported all submodule names to satisfy ExplicitImports.jl
Removed unused AdaptiveRadau import
Ran JuliaFormatter on modified files

The key insight was that when you have submodules, you need to both import them explicitly AND export their names if users should have access to them. This wasn't immediately obvious but the ExplicitImports.jl error messages helped identify the issue.

All ExplicitImports.jl tests now pass! 🎉

ChrisRackauckas · 2025-08-01T00:18:03Z

Update on Sublibrary Explicit Imports

I've started working on updating the sublibraries to use explicit imports. Here's what's been done so far:

✅ Completed

Fixed missing imports in OrdinaryDiffEqCore:
- Added , , , from RecursiveArrayTools
- Fixed import from Logging
Fixed missing imports in OrdinaryDiffEqDifferentiation:
- Added module imports for SciMLBase and SciMLOperators
- Added , , , from SciMLBase

🔄 In Progress

The main challenge is that all 29+ sublibraries use , which brings in all symbols from DiffEqBase. This appears to be an intentional design pattern for the public API.

⚠️ Current Issues

When trying to run the full test suite, I'm encountering cascading missing import errors as more functions are discovered during compilation. This suggests that converting from to explicit imports will require a comprehensive analysis of what symbols are actually used from DiffEqBase in each sublibrary.

🤔 Questions

Should we maintain the pattern in sublibraries since it seems intentional for the API?
Or should we convert all sublibraries to explicit imports, which would be a more extensive change?
Should I focus on just ensuring the main OrdinaryDiffEq module passes ExplicitImports tests (which it already does)?

The current ExplicitImports test only checks the main OrdinaryDiffEq module, not the sublibraries. Would you like me to continue with the comprehensive sublibrary updates, or focus on a different approach?

ChrisRackauckas · 2025-08-01T01:44:26Z

I've updated the PR with the approach suggested by @ChrisRackauckas. The changes now:

What I did

Changed all @reexport using DiffEqBase to @reexport using SciMLBase across all 32 sublibraries
The ExplicitImports test already has SciMLBase in the skip list, so this approach allows the tests to pass

Technical Details

Added SciMLBase as a dependency to all subpackages that use @reexport
Fixed imports that are still in DiffEqBase but were mistakenly being imported from SciMLBase:
- initialize_dae\!, get_tstops, get_tstops_array, get_tstops_max
- ODE_DEFAULT_NORM, ODE_DEFAULT_ISOUTOFDOMAIN, ODE_DEFAULT_PROG_MESSAGE, ODE_DEFAULT_UNSTABLE_CHECK
- calculate_residuals, calculate_residuals\!, @tight_loop_macros, timedepentdtmin
- prepare_alg functions
- max_vector_callback_length_int, value
Updated ExplicitRKTableau references to use DiffEqBase
Fixed unitfulvalue function to reference DiffEqBase
Removed copyat_or_push\! from exports (appears to be an internal function)

Next Steps

The tests should now pass for ExplicitImports. There may be other failing tests that need addressing, but the main objective of using explicit imports with SciMLBase as the allowed @reexport module has been achieved.

ChrisRackauckas force-pushed the explictimports branch 2 times, most recently from bf84038 to f7c6909 Compare July 21, 2025 00:30

ChrisRackauckas and others added 5 commits July 21, 2025 05:48

Use explicit imports

ee1e36e

fix truncatedstacktraces macro import

f4d3346

fix a bunch

9d17154

Fix duplicate exports

3c5b2e3

ChrisRackauckas force-pushed the explictimports branch from f7c6909 to 924e7c2 Compare July 21, 2025 10:04

ChrisRackauckas added 3 commits July 21, 2025 06:29

Fix imports

855677d

More fixes

209a223

Try a few changes

e6a8a8d

ChrisRackauckas added 3 commits July 21, 2025 12:08

Fix imports

21d8a7f

Fix duplicate exports and add missing imports

cede2b3

- Remove duplicate exports of AutoTsit5 and AutoDP5 (already exported earlier in the file) - Add missing imports for AutoVern6, AutoVern7, AutoVern8, AutoVern9 from OrdinaryDiffEqVerner - Fixes ExplicitImports.jl test failures

ChrisRackauckas commented Jul 24, 2025

View reviewed changes

lib/OrdinaryDiffEqCore/src/OrdinaryDiffEqCore.jl Outdated Show resolved Hide resolved

Update lib/OrdinaryDiffEqCore/src/OrdinaryDiffEqCore.jl

7650641

ChrisRackauckas commented Jul 24, 2025

View reviewed changes

lib/OrdinaryDiffEqRosenbrock/src/OrdinaryDiffEqRosenbrock.jl Outdated Show resolved Hide resolved

Update lib/OrdinaryDiffEqRosenbrock/src/OrdinaryDiffEqRosenbrock.jl

ac2ad8d

ChrisRackauckas commented Jul 24, 2025

View reviewed changes

lib/OrdinaryDiffEqSDIRK/src/OrdinaryDiffEqSDIRK.jl Outdated Show resolved Hide resolved

Update lib/OrdinaryDiffEqSDIRK/src/OrdinaryDiffEqSDIRK.jl

ecdf586

ChrisRackauckas commented Jul 24, 2025

View reviewed changes

lib/OrdinaryDiffEqLinear/src/OrdinaryDiffEqLinear.jl Outdated Show resolved Hide resolved

Update lib/OrdinaryDiffEqLinear/src/OrdinaryDiffEqLinear.jl

7a4f576

ChrisRackauckas commented Jul 29, 2025

View reviewed changes

Project.toml Outdated Show resolved Hide resolved

ChrisRackauckas added 2 commits July 29, 2025 09:48

Update Project.toml

4df5a3b

Merge branch 'master' into explictimports

988f1fe

ChrisRackauckas commented Jul 31, 2025

View reviewed changes

lib/OrdinaryDiffEqCore/src/OrdinaryDiffEqCore.jl Outdated Show resolved Hide resolved

ChrisRackauckas added 3 commits July 31, 2025 08:15

Update lib/OrdinaryDiffEqCore/src/OrdinaryDiffEqCore.jl

fe7ce36

Merge branch 'master' into explictimports

d5ab34a

Merge branch 'master' into explictimports

5c33747

ChrisRackauckas closed this Aug 10, 2025

ChrisRackauckas deleted the explictimports branch August 10, 2025 21:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Use explicit imports #2765

Use explicit imports #2765

Uh oh!

ChrisRackauckas commented Jul 20, 2025

Uh oh!

github-actions bot commented Jul 21, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ChrisRackauckas commented Jul 31, 2025

Uh oh!

ChrisRackauckas commented Aug 1, 2025

Uh oh!

ChrisRackauckas commented Aug 1, 2025

Uh oh!

Uh oh!

Uh oh!

Use explicit imports #2765

Use explicit imports #2765

Uh oh!

Conversation

ChrisRackauckas commented Jul 20, 2025

Uh oh!

github-actions bot commented Jul 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Benchmark Results (Julia v1)

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ChrisRackauckas commented Jul 31, 2025

Guide to Setting Up Explicit Imports in Julia Packages

Why Explicit Imports?

Step-by-Step Process

1. Add ExplicitImports.jl Test

2. Run Initial Analysis

3. Fix Import Patterns

4. Handle Submodules

5. Common Issues and Solutions

Testing Process

Tricks and Best Practices

What I Changed in This PR

Uh oh!

ChrisRackauckas commented Aug 1, 2025

Update on Sublibrary Explicit Imports

✅ Completed

🔄 In Progress

⚠️ Current Issues

🤔 Questions

Uh oh!

ChrisRackauckas commented Aug 1, 2025

What I did

Technical Details

Next Steps

Uh oh!

Uh oh!

github-actions bot commented Jul 21, 2025 •

edited

Loading