rename submodule -> subpackage; allow loading submodule without parent

MasonProtter · MasonProtter · commit da115be26ee5 · 2025-04-09T15:11:32.000+02:00
diff --git a/base/exports.jl b/base/exports.jl
@@ -864,7 +864,7 @@ export
     evalfile,
     include_string,
     include_dependency,
-    @submodule_using,
+    @subpackage_using,
 
 # RTS internals
     GC,
diff --git a/base/loading.jl b/base/loading.jl
@@ -1029,15 +1029,15 @@ function explicit_manifest_deps_get(project_file::String, where::PkgId, name::St
                         return identify_package(PkgId(UUID(uuid), dep_name), name)
                     end
                 end
-                # Check for submodules
-                submodules = get(entry, "submodules", nothing)
-                if submodules !== nothing
-                    if haskey(submodules, where.name) && where.uuid == uuid5(UUID(uuid), where.name)
+                # Check for subpackages
+                subpackages = get(entry, "subpackages", nothing)
+                if subpackages !== nothing
+                    if haskey(subpackages, where.name) && where.uuid == uuid5(UUID(uuid), where.name)
                         found_where = true
                         if name == dep_name
                             return PkgId(UUID(uuid), name)
                         end
-                        subs = submodules[where.name]::Union{String, Vector{String}}
+                        subs = subpackages[where.name]::Union{String, Vector{String}}
                         weakdeps = get(entry, "weakdeps", nothing)::Union{Vector{String}, Dict{String, Any}, Nothing}
                         if (subs isa String && name == subs) || (subs isa Vector{String} && name in subs)
                             for deps′ in [weakdeps, deps]
@@ -1057,7 +1057,7 @@ function explicit_manifest_deps_get(project_file::String, where::PkgId, name::St
                                 end
                             end
                         end
-                        # `name` is not a submodule, do standard lookup as if this was the parent
+                        # `name` is not a subpackage, do standard lookup as if this was the parent
                         return identify_package(PkgId(UUID(uuid), dep_name), name)
                     end
                 end
@@ -1110,10 +1110,10 @@ function explicit_manifest_uuid_path(project_file::String, pkg::PkgId)::Union{No
                     return find_ext_path(p, pkg.name)
                 end
             end
-            # Submodules
-            let submodules = get(entry, "submodules", nothing)::Union{Nothing, Dict{String, Any}}
-                if submodules !== nothing
-                    if haskey(submodules, pkg.name) && uuid !== nothing && uuid5(UUID(uuid), pkg.name) == pkg.uuid
+            # Subpackages
+            let subpackages = get(entry, "subpackages", nothing)::Union{Nothing, Dict{String, Any}}
+                if subpackages !== nothing
+                    if haskey(subpackages, pkg.name) && uuid !== nothing && uuid5(UUID(uuid), pkg.name) == pkg.uuid
                         parent_path = locate_package(PkgId(UUID(uuid), name))
                         if parent_path === nothing
                             error("failed to find source of parent package: \"$name\"")
@@ -1722,34 +1722,61 @@ end
 # End extensions
 
 
-##############
-# Submodules #
-##############
-function load_submodule(mod::Module, subname::Union{Symbol, String})
+###############
+# Subpackages #
+###############
+function load_subpackage(into::Module, parentname::Symbol, subname::Union{Symbol, String})
+    str_parentname = string(parentname)
+    str_subname = string(subname)
+    parent_uuid = @lock require_lock begin
+        uuidkey_env = identify_package_env(into, String(parentname))
+        if uuidkey_env === nothing
+            where = PkgId(into)
+            if where.uuid === nothing
+                throw(ArgumentError("Package $parentname not found in current path."))
+            else
+                manifest_warnings = collect_manifest_warnings()
+                throw(ArgumentError("""
+                Package $(where.name) does not have $parentname in its dependencies:
+                $manifest_warnings- You may have a partially installed environment. Try `Pkg.instantiate()`
+                  to ensure all packages in the environment are installed.
+                - Or, if you have $(where.name) checked out for development and have
+                  added $parentname as a dependency but haven't updated your primary
+                  environment's manifest file, try `Pkg.resolve()`.
+                - Otherwise you may need to report an issue with $(where.name)"""))
+            end
+        end
+        uuidkey, env = uuidkey_env
+        uuidkey.uuid
+    end
+    sub_id = PkgId(uuid5(parent_uuid, str_subname), str_subname)
+    __require(sub_id)
+end
+function load_subpackage(mod::Module, subname::Union{Symbol, String})
     parent_id = PkgId(mod)
     str_subname = string(subname)
-    id = PkgId(uuid5(parent_id.uuid, str_subname), str_subname)
-    __require(id)
+    sub_id = PkgId(uuid5(parent_id.uuid, str_subname), str_subname)
+    __require(sub_id)
 end
 
 """
-    @submodule_using Parent.Sub
+    @subpackage_using Parent.Sub
 
-Load the `Sub` submodule from the `Parent` package.
+Load the `Sub` subpackage from the `Parent` package.
 """
-macro submodule_using(parent_sub)
+macro subpackage_using(parent_sub)
     if isexpr(parent_sub, :(.), 2)
         parent, sub = parent_sub.args
         @gensym mod
         esc(quote
-                $mod = $load_submodule($parent, $sub)
+                $mod = $load_subpackage($__module__, $(QuoteNode(parent)), $sub)
                 using .$mod
             end)
     else
-        throw(ArgumentError("Malformed expression, `@submodule_using` only takes expressions of the form `Parent.Submodule`"))
+        throw(ArgumentError("Malformed expression, `@subpackage_using` only takes expressions of the form `Parent.Subpackage`"))
     end
 end
-# End submodules
+# End subpackages
 
 
 struct CacheFlags
diff --git a/test/loading.jl b/test/loading.jl
@@ -1264,35 +1264,44 @@ end
     end
 end
 
-@testset "Submodules" begin
+@testset "Subpackages" begin
     old_depot_path = copy(DEPOT_PATH)
     try
         tmp = mktempdir()
         push!(empty!(DEPOT_PATH), joinpath(tmp, "depot"))
-        proj = joinpath(@__DIR__, "project", "Submodules", "HasDepWithSubmodules")
+        proj = joinpath(@__DIR__, "project", "Subpackages", "HasDepWithSubpackages")
         for i in 1:2 # Once when requiring precomilation, once where it is already precompiled
             cmd = `$(Base.julia_cmd()) --project=$proj --startup-file=no -e '
                     begin
-                    using HasSubmodules
-                    HasSubmodules.sub1_loaded && error("sub1_loaded set")
-                    using HasDepWithSubmodules
-                    HasSubmodules.sub1_loaded || error("sub1_loaded not set")
-                    HasDepWithSubmodules.g(1) == 1 || error("g failed")
+                    using HasSubpackages
+                    HasSubpackages.sub1_loaded && error("sub1_loaded set")
+                    using HasDepWithSubpackages
+                    HasSubpackages.sub1_loaded || error("sub1_loaded not set")
+                    HasDepWithSubpackages.g(1) == 1 || error("g failed")
                     end
                 '`
             @test success(cmd)
         end
         let cmd = `$(Base.julia_cmd()) --project=$proj --startup-file=no -e '
                     begin
-                    using HasSubmodules
+                    using HasSubpackages
                     using ADep
-                    HasSubmodules.sub2_loaded && error("sub2_loaded set!")
-                    @submodule_using HasSubmodules.Submodule2 # currently broken
-                    HasSubmodules.sub2_loaded && error("sub2_loaded set!")
+                    HasSubpackages.sub2_loaded && error("sub2_loaded set!")
+                    @submodule_using HasSubpackages.Subpackage2 # currently broken
+                    HasSubpackages.sub2_loaded && error("sub2_loaded set!")
                     end
                 '`
             @test_broken success(cmd)
         end
+        let cmd = `$(Base.julia_cmd()) --project=$proj --startup-file=no -e '
+                        begin
+                        @subpackage_using HasSubpackages.Subpackage3
+                        Subpackage3.x == 1 || error("Something went wrong with HasSubpackages.Subpackage3")
+                        "HasSubpackages" ∉ string.(values(Base.loaded_modules)) || error("HasSubpackages was loaded when it was not needed!")
+                        end
+                   '`
+            @test success(cmd)
+        end
     finally
         copy!(DEPOT_PATH, old_depot_path)
     end
diff --git a/test/project/Submodules/HasDepWithSubmodules/Project.toml b/test/project/Submodules/HasDepWithSubmodules/Project.toml
diff --git a/test/project/Submodules/HasDepWithSubmodules/src/HasDepWithSubmodules.jl b/test/project/Submodules/HasDepWithSubmodules/src/HasDepWithSubmodules.jl
diff --git a/test/project/Submodules/HasSubmodules/sub/Submodule1.jl b/test/project/Submodules/HasSubmodules/sub/Submodule1.jl
diff --git a/test/project/Subpackages/ADep/Project.toml b/test/project/Subpackages/ADep/Project.toml
@@ -0,0 +1,4 @@
+name = "ADep"
+uuid = "81016d05-d0fa-4c22-8125-5c67d6cf9f2f"
+authors = ["Mason Protter <mason.protter@icloud.com>"]
+version = "0.1.0"
diff --git a/test/project/Subpackages/ADep/src/ADep.jl b/test/project/Subpackages/ADep/src/ADep.jl
@@ -0,0 +1,7 @@
+module ADep
+
+foo(x) = x^2
+
+export foo
+
+end # module ADep
diff --git a/test/project/Subpackages/HasDepWithSubpackages/Manifest.toml b/test/project/Subpackages/HasDepWithSubpackages/Manifest.toml
@@ -2,20 +2,21 @@ julia_version = "1.13.0-DEV"
 manifest_format = "2.0"
 project_hash = "cd51eae9e59902fd893210e4f8a4d4dc2ac81722"
 
-[[deps.HasDepWithSubmodules]]
-deps = ["HasSubmodules"]
+[[deps.HasDepWithSubpackages]]
+deps = ["HasSubpackages"]
 path = "."
 uuid = "0237f425-1828-4bb9-8eeb-a4f4cdb55107"
 version = "0.1.0"
 
-[[deps.HasSubmodules]]
-path = "../HasSubmodules"
+[[deps.HasSubpackages]]
+path = "../HasSubpackages"
 uuid = "0f595f7f-271a-49d7-b31d-0f5ff0a9189a"
 version = "0.1.0"
 
-    [deps.HasSubmodules.submodules]
-    Submodule1 = ""
-    Submodule2 = "ADep"
+    [deps.HasSubpackages.subpackages]
+    Subpackage1 = "HasSubpackages"
+    Subpackage2 = "ADep"
+    Subpackage3 = ""
 
 [[deps.ADep]]
 path = "../ADep"
diff --git a/test/project/Subpackages/HasDepWithSubpackages/Project.toml b/test/project/Subpackages/HasDepWithSubpackages/Project.toml
@@ -0,0 +1,7 @@
+name = "HasDepWithSubpackages"
+uuid = "0237f425-1828-4bb9-8eeb-a4f4cdb55107"
+version = "0.1.0"
+
+[deps]
+HasSubpackages = "0f595f7f-271a-49d7-b31d-0f5ff0a9189a"
+ADep = "81016d05-d0fa-4c22-8125-5c67d6cf9f2f"
diff --git a/test/project/Subpackages/HasDepWithSubpackages/src/HasDepWithSubpackages.jl b/test/project/Subpackages/HasDepWithSubpackages/src/HasDepWithSubpackages.jl
@@ -0,0 +1,10 @@
+module HasDepWithSubpackages
+
+using HasSubpackages
+@subpackage_using HasSubpackages.Subpackage1
+
+g(x) = f(x) - 1
+
+export g
+
+end
diff --git a/test/project/Subpackages/HasSubpackages/Project.toml b/test/project/Subpackages/HasSubpackages/Project.toml
@@ -1,10 +1,11 @@
-name = "HasSubmodules"
+name = "HasSubpackages"
 uuid = "0f595f7f-271a-49d7-b31d-0f5ff0a9189a"
 version = "0.1.0"
 
 [weakdeps]
 ADep = "81016d05-d0fa-4c22-8125-5c67d6cf9f2f"
 
-[submodules]
-Submodule1 = ""
-Submodule2 = "ADep"
+[subpackages]
+Subpackage1 = "HasSubpackages"
+Subpackage2 = "HasSubpackages, ADep"
+Subpackage3 = ""
diff --git a/test/project/Subpackages/HasSubpackages/src/HasSubpackages.jl b/test/project/Subpackages/HasSubpackages/src/HasSubpackages.jl
@@ -1,4 +1,4 @@
-module HasSubmodules
+module HasSubpackages
 
 sub1_loaded = false
 sub2_loaded = false
diff --git a/test/project/Subpackages/HasSubpackages/sub/Subpackage1.jl b/test/project/Subpackages/HasSubpackages/sub/Subpackage1.jl
@@ -0,0 +1,12 @@
+module Subpackage1
+using HasSubpackages
+
+function __init__()
+    HasSubpackages.sub1_loaded = true
+end
+
+f(x) = x + 1
+
+export f
+
+end
diff --git a/test/project/Subpackages/HasSubpackages/sub/Subpackage2.jl b/test/project/Subpackages/HasSubpackages/sub/Subpackage2.jl
@@ -0,0 +1,14 @@
+module Subpackage2
+
+using ADep
+using HasSubpackages
+
+bar(x) = foo(x) + 1
+
+export bar
+
+function __init__()
+    HasSubpackages.sub2_loaded = true
+end
+
+end
