What is the accessibility of a package's `Private` context variables? The 2019 Stack Overflow Developer Survey Results Are InHow symbol lookup actually worksWhat are recommended guidelines for developing packages?How to properly handle mutual imports of multiple packages?How can Private functions be made completely opaque?Does one need to be careful about loading multiple (many) contexts or packages in the same session?WebServices context problemHow to pass rules to packagesA question regarding shadowed symbolsIs there any harm or benefit to Removing unneeded private symbols in packages?Information (??) of function defined in Package return the function with long name of variablesHow to resolve a context shadow problem (revised)
Is there any way to tell whether the shot is going to hit you or not?
Do these rules for Critical Successes and Critical Failures seem Fair?
Time travel alters history but people keep saying nothing's changed
What does "fetching by region is not available for SAM files" means?
What do the Banks children have against barley water?
Why isn't airport relocation done gradually?
If a Druid sees an animal’s corpse, can they wild shape into that animal?
What do hard-Brexiteers want with respect to the Irish border?
Earliest use of the term "Galois extension"?
What is the meaning of the verb "bear" in this context?
Protecting Dualbooting Windows from dangerous code (like rm -rf)
How to save as into a customized destination on macOS?
One word riddle: Vowel in the middle
Are there any other methods to apply to solving simultaneous equations?
Apparent duplicates between Haynes service instructions and MOT
A poker game description that does not feel gimmicky
Why isn't the circumferential light around the M87 black hole's event horizon symmetric?
Is three citations per paragraph excessive for undergraduate research paper?
Why hard-Brexiteers don't insist on a hard border to prevent illegal immigration after Brexit?
Return to UK after being refused entry years previously
Why do we hear so much about the Trump administration deciding to impose and then remove tariffs?
Why do UK politicians seemingly ignore opinion polls on Brexit?
Resizing object distorts it (Illustrator CC 2018)
The difference between dialogue marks
What is the accessibility of a package's `Private` context variables?
The 2019 Stack Overflow Developer Survey Results Are InHow symbol lookup actually worksWhat are recommended guidelines for developing packages?How to properly handle mutual imports of multiple packages?How can Private functions be made completely opaque?Does one need to be careful about loading multiple (many) contexts or packages in the same session?WebServices context problemHow to pass rules to packagesA question regarding shadowed symbolsIs there any harm or benefit to Removing unneeded private symbols in packages?Information (??) of function defined in Package return the function with long name of variablesHow to resolve a context shadow problem (revised)
$begingroup$
I've been reading up on how Mathematica handles contexts, $Context
, $ContextPath
, and a few of the tutorials they have on Packages.
What I'm wondering about is how the functions defined in, say, CustomPackage`
are able to access the variables in CustomPackage`Private`
.
For example,
BeginPackage["CustomPackage`"]
MyFunction::usage = "MyFunction[arg1] adds 5 to arg1."
Begin["`Private`"]
abc=5;
MyFunction[arg1_] := arg1 + abc;
End[]
EndPackage[]
When I load the package <<CustomPackage`
the $ContextPath
will have CustomPackage`
on it, but not CustomPackage`Private`
So how does MyFunction
know the value of abc
at the delayed function call (when it is called) if the Private`
context isn't on the $ContextPath
packages core-language scoping contexts
$endgroup$
add a comment |
$begingroup$
I've been reading up on how Mathematica handles contexts, $Context
, $ContextPath
, and a few of the tutorials they have on Packages.
What I'm wondering about is how the functions defined in, say, CustomPackage`
are able to access the variables in CustomPackage`Private`
.
For example,
BeginPackage["CustomPackage`"]
MyFunction::usage = "MyFunction[arg1] adds 5 to arg1."
Begin["`Private`"]
abc=5;
MyFunction[arg1_] := arg1 + abc;
End[]
EndPackage[]
When I load the package <<CustomPackage`
the $ContextPath
will have CustomPackage`
on it, but not CustomPackage`Private`
So how does MyFunction
know the value of abc
at the delayed function call (when it is called) if the Private`
context isn't on the $ContextPath
packages core-language scoping contexts
$endgroup$
add a comment |
$begingroup$
I've been reading up on how Mathematica handles contexts, $Context
, $ContextPath
, and a few of the tutorials they have on Packages.
What I'm wondering about is how the functions defined in, say, CustomPackage`
are able to access the variables in CustomPackage`Private`
.
For example,
BeginPackage["CustomPackage`"]
MyFunction::usage = "MyFunction[arg1] adds 5 to arg1."
Begin["`Private`"]
abc=5;
MyFunction[arg1_] := arg1 + abc;
End[]
EndPackage[]
When I load the package <<CustomPackage`
the $ContextPath
will have CustomPackage`
on it, but not CustomPackage`Private`
So how does MyFunction
know the value of abc
at the delayed function call (when it is called) if the Private`
context isn't on the $ContextPath
packages core-language scoping contexts
$endgroup$
I've been reading up on how Mathematica handles contexts, $Context
, $ContextPath
, and a few of the tutorials they have on Packages.
What I'm wondering about is how the functions defined in, say, CustomPackage`
are able to access the variables in CustomPackage`Private`
.
For example,
BeginPackage["CustomPackage`"]
MyFunction::usage = "MyFunction[arg1] adds 5 to arg1."
Begin["`Private`"]
abc=5;
MyFunction[arg1_] := arg1 + abc;
End[]
EndPackage[]
When I load the package <<CustomPackage`
the $ContextPath
will have CustomPackage`
on it, but not CustomPackage`Private`
So how does MyFunction
know the value of abc
at the delayed function call (when it is called) if the Private`
context isn't on the $ContextPath
packages core-language scoping contexts
packages core-language scoping contexts
edited 3 hours ago
m_goldberg
88.5k873200
88.5k873200
asked 6 hours ago
w1resw1res
20314
20314
add a comment |
add a comment |
3 Answers
3
active
oldest
votes
$begingroup$
So how does
MyFunction
know the value ofabc
at the delayed function call (when it is called) if thePrivate`
context isn't on the$ContextPath
There is a misunderstanding here. You are assuming that abc
is searched for in some context only when MyFunction[something]
is evaluated. This is not the case.
$Context
and $ContextPath
only affect how source code is parsed (not how expressions are evaluated). In other words, they only affect how the text you write in the package file is interpreted and converted into in-memory expressions. Once the package has been loaded with Get
, this interpretation has already happened. MyFunction
has been interpreted as the symbol CustomPackage`MyFunction
and abc
has been interpreted as CustomPackage`Private`abc
, according to the value of $Context
and $ContextPath
at the time each was read. These are the full names of these symbols and this is how they exist in memory.
Load the package and try this:
Block[$ContextPath,
Print@Definition[MyFunction]
]
You'll see the following printed:
CustomPackage`MyFunction[CustomPackage`Private`arg1_] :=
CustomPackage`Private`arg1+CustomPackage`Private`abc
As you can see, a context is always associated with every symbol.
$endgroup$
add a comment |
$begingroup$
All symbols are created at load time, so when you do:
BeginPackage["X`"];
x::usage="Declaring x as an exported symbol in the X` context";
Begin["`SomePrivateContext`"];
x[a_]:=b
End[];
EndPackage[];
x
was created as X`x
but the DownValues
of x
reference X`SomePrivateContext`a
and X`SomePrivateContext`b
which were created at the time the function was defined. These symbols are unique, so that reference only ever points that a single object.
$endgroup$
add a comment |
$begingroup$
Begin["`Private`"];
sets the current $Context
to "CustomPackage `Private`"
. This causes two things:
The symbol
abc
will be searched in the current context first, thus in"CustomPackage`Private`"
. Only if it is not found there, the search goes on along$ContextPath
.If no matching symbol is found this way, a new symbol
abc
is created, namely in the current$Context
which is"CustomPackage`Private`"
. So the full symbol name is"CustomPackage`Private`abc"
.
For example, running your code in a fresh kernel and executing
??MyFunction
reveals that the full definition of MyFunction
is
MyFunction[CustomPackage`Private`arg1_]:=CustomPackage`Private`arg1+CustomPackage`Private`abc
Moreover, with
?*`abc
you see that the only symbol in all contexts that matches abc
is CustomPackage`Private`abc
and has the value 5
assigned to it.
$endgroup$
add a comment |
Your Answer
StackExchange.ifUsing("editor", function ()
return StackExchange.using("mathjaxEditing", function ()
StackExchange.MarkdownEditor.creationCallbacks.add(function (editor, postfix)
StackExchange.mathjaxEditing.prepareWmdForMathJax(editor, postfix, [["$", "$"], ["\\(","\\)"]]);
);
);
, "mathjax-editing");
StackExchange.ready(function()
var channelOptions =
tags: "".split(" "),
id: "387"
;
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function()
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled)
StackExchange.using("snippets", function()
createEditor();
);
else
createEditor();
);
function createEditor()
StackExchange.prepareEditor(
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: false,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: null,
bindNavPrevention: true,
postfix: "",
imageUploader:
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
,
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
);
);
Sign up or log in
StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function ()
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fmathematica.stackexchange.com%2fquestions%2f194963%2fwhat-is-the-accessibility-of-a-packages-private-context-variables%23new-answer', 'question_page');
);
Post as a guest
Required, but never shown
3 Answers
3
active
oldest
votes
3 Answers
3
active
oldest
votes
active
oldest
votes
active
oldest
votes
$begingroup$
So how does
MyFunction
know the value ofabc
at the delayed function call (when it is called) if thePrivate`
context isn't on the$ContextPath
There is a misunderstanding here. You are assuming that abc
is searched for in some context only when MyFunction[something]
is evaluated. This is not the case.
$Context
and $ContextPath
only affect how source code is parsed (not how expressions are evaluated). In other words, they only affect how the text you write in the package file is interpreted and converted into in-memory expressions. Once the package has been loaded with Get
, this interpretation has already happened. MyFunction
has been interpreted as the symbol CustomPackage`MyFunction
and abc
has been interpreted as CustomPackage`Private`abc
, according to the value of $Context
and $ContextPath
at the time each was read. These are the full names of these symbols and this is how they exist in memory.
Load the package and try this:
Block[$ContextPath,
Print@Definition[MyFunction]
]
You'll see the following printed:
CustomPackage`MyFunction[CustomPackage`Private`arg1_] :=
CustomPackage`Private`arg1+CustomPackage`Private`abc
As you can see, a context is always associated with every symbol.
$endgroup$
add a comment |
$begingroup$
So how does
MyFunction
know the value ofabc
at the delayed function call (when it is called) if thePrivate`
context isn't on the$ContextPath
There is a misunderstanding here. You are assuming that abc
is searched for in some context only when MyFunction[something]
is evaluated. This is not the case.
$Context
and $ContextPath
only affect how source code is parsed (not how expressions are evaluated). In other words, they only affect how the text you write in the package file is interpreted and converted into in-memory expressions. Once the package has been loaded with Get
, this interpretation has already happened. MyFunction
has been interpreted as the symbol CustomPackage`MyFunction
and abc
has been interpreted as CustomPackage`Private`abc
, according to the value of $Context
and $ContextPath
at the time each was read. These are the full names of these symbols and this is how they exist in memory.
Load the package and try this:
Block[$ContextPath,
Print@Definition[MyFunction]
]
You'll see the following printed:
CustomPackage`MyFunction[CustomPackage`Private`arg1_] :=
CustomPackage`Private`arg1+CustomPackage`Private`abc
As you can see, a context is always associated with every symbol.
$endgroup$
add a comment |
$begingroup$
So how does
MyFunction
know the value ofabc
at the delayed function call (when it is called) if thePrivate`
context isn't on the$ContextPath
There is a misunderstanding here. You are assuming that abc
is searched for in some context only when MyFunction[something]
is evaluated. This is not the case.
$Context
and $ContextPath
only affect how source code is parsed (not how expressions are evaluated). In other words, they only affect how the text you write in the package file is interpreted and converted into in-memory expressions. Once the package has been loaded with Get
, this interpretation has already happened. MyFunction
has been interpreted as the symbol CustomPackage`MyFunction
and abc
has been interpreted as CustomPackage`Private`abc
, according to the value of $Context
and $ContextPath
at the time each was read. These are the full names of these symbols and this is how they exist in memory.
Load the package and try this:
Block[$ContextPath,
Print@Definition[MyFunction]
]
You'll see the following printed:
CustomPackage`MyFunction[CustomPackage`Private`arg1_] :=
CustomPackage`Private`arg1+CustomPackage`Private`abc
As you can see, a context is always associated with every symbol.
$endgroup$
So how does
MyFunction
know the value ofabc
at the delayed function call (when it is called) if thePrivate`
context isn't on the$ContextPath
There is a misunderstanding here. You are assuming that abc
is searched for in some context only when MyFunction[something]
is evaluated. This is not the case.
$Context
and $ContextPath
only affect how source code is parsed (not how expressions are evaluated). In other words, they only affect how the text you write in the package file is interpreted and converted into in-memory expressions. Once the package has been loaded with Get
, this interpretation has already happened. MyFunction
has been interpreted as the symbol CustomPackage`MyFunction
and abc
has been interpreted as CustomPackage`Private`abc
, according to the value of $Context
and $ContextPath
at the time each was read. These are the full names of these symbols and this is how they exist in memory.
Load the package and try this:
Block[$ContextPath,
Print@Definition[MyFunction]
]
You'll see the following printed:
CustomPackage`MyFunction[CustomPackage`Private`arg1_] :=
CustomPackage`Private`arg1+CustomPackage`Private`abc
As you can see, a context is always associated with every symbol.
edited 5 hours ago
answered 6 hours ago
SzabolcsSzabolcs
164k14448946
164k14448946
add a comment |
add a comment |
$begingroup$
All symbols are created at load time, so when you do:
BeginPackage["X`"];
x::usage="Declaring x as an exported symbol in the X` context";
Begin["`SomePrivateContext`"];
x[a_]:=b
End[];
EndPackage[];
x
was created as X`x
but the DownValues
of x
reference X`SomePrivateContext`a
and X`SomePrivateContext`b
which were created at the time the function was defined. These symbols are unique, so that reference only ever points that a single object.
$endgroup$
add a comment |
$begingroup$
All symbols are created at load time, so when you do:
BeginPackage["X`"];
x::usage="Declaring x as an exported symbol in the X` context";
Begin["`SomePrivateContext`"];
x[a_]:=b
End[];
EndPackage[];
x
was created as X`x
but the DownValues
of x
reference X`SomePrivateContext`a
and X`SomePrivateContext`b
which were created at the time the function was defined. These symbols are unique, so that reference only ever points that a single object.
$endgroup$
add a comment |
$begingroup$
All symbols are created at load time, so when you do:
BeginPackage["X`"];
x::usage="Declaring x as an exported symbol in the X` context";
Begin["`SomePrivateContext`"];
x[a_]:=b
End[];
EndPackage[];
x
was created as X`x
but the DownValues
of x
reference X`SomePrivateContext`a
and X`SomePrivateContext`b
which were created at the time the function was defined. These symbols are unique, so that reference only ever points that a single object.
$endgroup$
All symbols are created at load time, so when you do:
BeginPackage["X`"];
x::usage="Declaring x as an exported symbol in the X` context";
Begin["`SomePrivateContext`"];
x[a_]:=b
End[];
EndPackage[];
x
was created as X`x
but the DownValues
of x
reference X`SomePrivateContext`a
and X`SomePrivateContext`b
which were created at the time the function was defined. These symbols are unique, so that reference only ever points that a single object.
answered 6 hours ago
b3m2a1b3m2a1
28.6k359165
28.6k359165
add a comment |
add a comment |
$begingroup$
Begin["`Private`"];
sets the current $Context
to "CustomPackage `Private`"
. This causes two things:
The symbol
abc
will be searched in the current context first, thus in"CustomPackage`Private`"
. Only if it is not found there, the search goes on along$ContextPath
.If no matching symbol is found this way, a new symbol
abc
is created, namely in the current$Context
which is"CustomPackage`Private`"
. So the full symbol name is"CustomPackage`Private`abc"
.
For example, running your code in a fresh kernel and executing
??MyFunction
reveals that the full definition of MyFunction
is
MyFunction[CustomPackage`Private`arg1_]:=CustomPackage`Private`arg1+CustomPackage`Private`abc
Moreover, with
?*`abc
you see that the only symbol in all contexts that matches abc
is CustomPackage`Private`abc
and has the value 5
assigned to it.
$endgroup$
add a comment |
$begingroup$
Begin["`Private`"];
sets the current $Context
to "CustomPackage `Private`"
. This causes two things:
The symbol
abc
will be searched in the current context first, thus in"CustomPackage`Private`"
. Only if it is not found there, the search goes on along$ContextPath
.If no matching symbol is found this way, a new symbol
abc
is created, namely in the current$Context
which is"CustomPackage`Private`"
. So the full symbol name is"CustomPackage`Private`abc"
.
For example, running your code in a fresh kernel and executing
??MyFunction
reveals that the full definition of MyFunction
is
MyFunction[CustomPackage`Private`arg1_]:=CustomPackage`Private`arg1+CustomPackage`Private`abc
Moreover, with
?*`abc
you see that the only symbol in all contexts that matches abc
is CustomPackage`Private`abc
and has the value 5
assigned to it.
$endgroup$
add a comment |
$begingroup$
Begin["`Private`"];
sets the current $Context
to "CustomPackage `Private`"
. This causes two things:
The symbol
abc
will be searched in the current context first, thus in"CustomPackage`Private`"
. Only if it is not found there, the search goes on along$ContextPath
.If no matching symbol is found this way, a new symbol
abc
is created, namely in the current$Context
which is"CustomPackage`Private`"
. So the full symbol name is"CustomPackage`Private`abc"
.
For example, running your code in a fresh kernel and executing
??MyFunction
reveals that the full definition of MyFunction
is
MyFunction[CustomPackage`Private`arg1_]:=CustomPackage`Private`arg1+CustomPackage`Private`abc
Moreover, with
?*`abc
you see that the only symbol in all contexts that matches abc
is CustomPackage`Private`abc
and has the value 5
assigned to it.
$endgroup$
Begin["`Private`"];
sets the current $Context
to "CustomPackage `Private`"
. This causes two things:
The symbol
abc
will be searched in the current context first, thus in"CustomPackage`Private`"
. Only if it is not found there, the search goes on along$ContextPath
.If no matching symbol is found this way, a new symbol
abc
is created, namely in the current$Context
which is"CustomPackage`Private`"
. So the full symbol name is"CustomPackage`Private`abc"
.
For example, running your code in a fresh kernel and executing
??MyFunction
reveals that the full definition of MyFunction
is
MyFunction[CustomPackage`Private`arg1_]:=CustomPackage`Private`arg1+CustomPackage`Private`abc
Moreover, with
?*`abc
you see that the only symbol in all contexts that matches abc
is CustomPackage`Private`abc
and has the value 5
assigned to it.
edited 6 hours ago
answered 6 hours ago
Henrik SchumacherHenrik Schumacher
59.7k582166
59.7k582166
add a comment |
add a comment |
Thanks for contributing an answer to Mathematica Stack Exchange!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
Use MathJax to format equations. MathJax reference.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function ()
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fmathematica.stackexchange.com%2fquestions%2f194963%2fwhat-is-the-accessibility-of-a-packages-private-context-variables%23new-answer', 'question_page');
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown