BeginPackage

✖
`BeginPackage`

✖

BeginPackage["context`"]

makes context` and System` the only active contexts.

✖

BeginPackage["context`",{"need₁`","need₂`",…}]

calls Needs on the need_i.

Details

BeginPackage is typically used at the beginning of a Wolfram Language package.
BeginPackage resets the values of both $Context and $ContextPath.
The interpretation of symbol names depends on context. BeginPackage thus affects the parsing of input expressions.

Examples

open allclose all

Basic Examples (1)Summary of the most common use cases

Commands to define a simple package:

In[1]:=1

✖

https://wolfram.com/xid/0rs93ewhe-dvbuxu

The context for symbol creation has been changed to square`:

In[2]:=2

✖

https://wolfram.com/xid/0rs93ewhe-sbw2h

Out[2]=2

The context path for symbol lookup includes square`:

In[3]:=3

✖

https://wolfram.com/xid/0rs93ewhe-dtgtny

Out[3]=3

Here are the commands defining the function in the package:

In[4]:=4

✖

https://wolfram.com/xid/0rs93ewhe-dphcwo

In[5]:=5

✖

https://wolfram.com/xid/0rs93ewhe-cbhno5

Restore the context, but leave square` on the context path for symbol lookup:

In[6]:=6

✖

https://wolfram.com/xid/0rs93ewhe-if3el5

Since EndPackage leaves square`square on the context path, the function defined is visible:

In[7]:=7

✖

https://wolfram.com/xid/0rs93ewhe-b5wc41

Get the square of 12:

In[8]:=8

✖

https://wolfram.com/xid/0rs93ewhe-cnd08v

Out[8]=8

Scope (1)Survey of the scope of standard use cases

Use BeginPackage and EndPackage to start and end a package in a file:

In[1]:=1

✖

https://wolfram.com/xid/0rs93ewhe-mzdi2z

The package can be loaded with Get:

In[2]:=2

✖

https://wolfram.com/xid/0rs93ewhe-f9dwb4

Once loaded, the definitions work:

In[3]:=3

✖

https://wolfram.com/xid/0rs93ewhe-fe7xaf

Out[3]=3

Properties & Relations (3)Properties of the function, and connections to other functions

BeginPackage["cont`"] sets $Context to "cont`":

In[1]:=1

✖

https://wolfram.com/xid/0rs93ewhe-7m7isf

Out[3]=3

EndPackage restores $Context to its value before the matching BeginPackage:

In[1]:=1

✖

https://wolfram.com/xid/0rs93ewhe-cly9h7

Out[4]=4

BeginPackage["cont`"] sets $ContextPath to {"cont`","System`"}:

In[1]:=1

✖

https://wolfram.com/xid/0rs93ewhe-p3oqhg

Out[1]=1

EndPackage restores $ContextPath to its value before BeginPackage with "cont`" prepended:

In[2]:=2

✖

https://wolfram.com/xid/0rs93ewhe-0ji1c8

Out[2]=2

BeginPackage does not alter the value of $ContextAliases:

In[1]:=1

✖

https://wolfram.com/xid/0rs93ewhe-c4es0g

Out[1]=1

EndPackage restores $ContextAliases to its value before the matching BeginPackage:

In[2]:=2

✖

https://wolfram.com/xid/0rs93ewhe-8614wm

Out[2]=2

Top