I cannot import `global variable::Type`

General Usage
1

Hi there,

I am using submodules and am surprised that I cannot import a globally defined config value which is not yet initialized.

While julia has a special syntax for such undefined globals

global variable::Type

I am unable import this undefined variable inside a submodule using TopLevelProject: variable. I get an error

ERROR: LoadError: UndefVarError: `variable` not defined

I guess the workaround arround is to use a const Ref, still I am very surprised that such typed globals cannot replace const Ref.

2

I think you should get the same error within the defining module if you haven’t assigned a value to it yet (like regularly trying to access the varable).
To avoid this, you check with @isdefined first or assign a sentinel value initially.

Another way would be to define

variable() = TopLevelProject.variable

which should also avoid the issue.

1 Like
3

I am only using this inside Functions, so there is no need to really access the variable in precompile/macroexpand time.

4

I am not sure I follow - do my suggestions solve your problem?

I think the misconception may arise from what a variable in Julia is, conceptually:

julia> global g

julia> @isdefined g
false

julia> g = 2
2

julia> @isdefined g
true

In Julia, variables are bindings and to create a binding, there needs to be an object to create a binding to.

Whereas, for example in C, variables can be seen as boxes, so if you do declare a variable

int i;

then you already get the box - you just don’t know what’s in it, meaning i has the value of whatever bits were at this place in memory before.

To achieve the behaviour you want in Julia, you could:

  1. Just use a Ref - like you suggested.

  2. Depending on what Type actually is, choose a “placeholder” value that you can assign immediately.

  3. Only refer to the variable once it actually has a value (which you can check via @isdefined).

1 Like
5

I think a const Ref is probably the way you want to go if you cannot initialize the global for some reason. With a Ref you can at least have an #undef.

What kind of Type were you considering this for?

2 Likes
6

I’m a little confused: what would you do after you’ve imported the undefined global? The only thing you could theoretically do is assign to it. But Julia doesn’t let you do that, either:

julia> module M
           global var = 1
           export var
       end
Main.M

julia> using .M: var

julia> var = 2
ERROR: cannot assign a value to imported variable Main.var

You’ve gotta explicitly fully-qualify the thing:

julia> M.var = 2
2

And at that point, it also works if it’s not defined!

julia> module M2
           global var2
           export var2
       end
Main.M2

julia> using .M2

julia> var2
ERROR: UndefVarError: `var2` not defined

julia> M2.var2 = 3
3

julia> var2
3
1 Like
7

I believe the idea here is that the imported variable is used inside functions, which will only be called once the variable is assigned a value.

As you’ve pointed out, one solution would be to not import the variable, and use the module-qualified name for it in the function. A Ref is another viable option here.

The best one is probably to restructure things so that this isn’t necessary. It’s usually possible to do that.

4 Likes
8

Or do foo = Foo.foo in the function, so that you only have to qualify it once. (Essentially a “local import”)

3 Likes
9

While often you don’t need to initialize variables on runtime, often you do need to do so.

In my case, which also answers your question @mkitti, I am using a global Configurations.jl @option struct to gather all my variables. Concretely there are some secrets which I need to initialize. I don’t want to write the secrets into the code, so this a classical example where you need runtime initialization of the concrete Configuration object.

Thank you for the workarounds! It is good to know that referencing it via the module name actually works.

For my intuition it is a bug that referencing it directly does not work.
Does someone know about Julia’s variable importing system whether this should work?

2 Likes
10

I created an issue for this uninitialized typed global can only be imported qualified and not directly · Issue #54954 · JuliaLang/julia · GitHub

1 Like
11

After all this discussion I still don’t understand what it is you’re trying to do, why do you want a global variable, and why are the suggested solutions not good enough for you. Please provide a minimal working example, then we can help you improve it.

BTW, yet another potential solution to look into could be ScopedValues.

12

Yeah, this seems like a use case for a scoped value.

13

Yeah, ScopedValues look nice too.

I guess my wish is to somehow get rid of the brackets [] which I need to use when using Ref. My current workaround is to define a custom RefType which actually forwards dot access. It is just because the typed unitialized global variable look like they can do exactly this, but they don’t do it yet. Hence my mind thinks again and again “come on, this workaround shouldn’t be needed as we have such globals”.

14

Resolved already!