How are Package `Private` variables accessed? 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?How to pass rules to packagesPackage Loading: How to get rid of Needs::nocont?Is there any harm or benefit to Removing unneeded private symbols in packages?Where does a package have to be loaded?Information (??) of function defined in Package return the function with long name of variablesHow to handle package dependencies?
What is the closest word meaning "respect for time / mindful"
Solar radiation data
Can someone be penalized for an "unlawful" act if no penalty is specified?
Is "plugging out" electronic devices an American expression?
What did it mean to "align" a radio?
What could be the right powersource for 15 seconds lifespan disposable giant chainsaw?
Does a dangling wire really electrocute me if I'm standing in water?
For what reasons would an animal species NOT cross a *horizontal* land bridge?
Return to UK after being refused entry years previously
Is this app Icon Browser Safe/Legit?
Why can Shazam fly?
Earliest use of the term "Galois extension"?
Why was M87 targetted for the Event Horizon Telescope instead of Sagittarius A*?
Am I thawing this London Broil safely?
Resizing object distorts it (Illustrator CC 2018)
Shouldn't "much" here be used instead of "more"?
Identify boardgame from Big movie
Origin of "cooter" meaning "vagina"
Statement true because not provable
Is bread bad for ducks?
"as much details as you can remember"
Falsification in Math vs Science
Loose spokes after only a few rides
How are Package `Private` variables accessed?
How are Package `Private` variables accessed?
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?How to pass rules to packagesPackage Loading: How to get rid of Needs::nocont?Is there any harm or benefit to Removing unneeded private symbols in packages?Where does a package have to be loaded?Information (??) of function defined in Package return the function with long name of variablesHow to handle package dependencies?
$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
functions 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
functions 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
functions 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
functions packages core-language scoping contexts
functions packages core-language scoping contexts
edited 1 hour ago
Henrik Schumacher
59.6k582166
59.6k582166
asked 1 hour ago
w1resw1res
1934
1934
add a comment |
add a comment |
3 Answers
3
active
oldest
votes
$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
abcwill 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
abcis created, namely in the current$Contextwhich 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$
So how does
MyFunctionknow the value ofabcat 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 |
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%2fhow-are-package-private-variables-accessed%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$
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 1 hour 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
abcwill 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
abcis created, namely in the current$Contextwhich 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
abcwill 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
abcis created, namely in the current$Contextwhich 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
abcwill 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
abcis created, namely in the current$Contextwhich 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
abcwill 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
abcis created, namely in the current$Contextwhich 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 1 hour ago
answered 1 hour ago
Henrik SchumacherHenrik Schumacher
59.6k582166
59.6k582166
add a comment |
add a comment |
$begingroup$
So how does
MyFunctionknow the value ofabcat 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
MyFunctionknow the value ofabcat 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
MyFunctionknow the value ofabcat 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
MyFunctionknow the value ofabcat 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 42 mins ago
answered 1 hour ago
SzabolcsSzabolcs
164k14448946
164k14448946
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%2fhow-are-package-private-variables-accessed%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