Import
From HaskellWiki
(Difference between revisions)
BrettGiles (Talk | contribs) m (Add language category) |
(explicitely say multiple imports are allowed; do some minor reorganizing) |
||
(9 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
[[Category:Language]] | [[Category:Language]] | ||
− | The <hask>import</hask> statement is used to import functions and other definitions from another module. | + | [[Category:Glossary]] |
+ | The <hask>import</hask> statement is used to import functions and other definitions from another module. The shortest form of the import statement is | ||
<haskell> | <haskell> | ||
import Data.Maybe | import Data.Maybe | ||
</haskell> | </haskell> | ||
− | + | that imports the named module (in this case <hask>Data.Maybe</hask>). | |
− | However, | + | However, there are more options: |
− | + | # Modules can be imported '''qualified''' (forcing an obligatory namespace qualifier to imported identifiers). | |
+ | # Some identifiers can be skipped via the '''hiding''' clause. | ||
+ | # The module namespace can be renamed, with an '''as''' clause. | ||
+ | |||
+ | Getting all of this straight in your head is quite tricky, so here is a table (lifted directly from the language reference manual) that roughly summarises the various possibilities: | ||
+ | |||
+ | Supposing that the module <hask>Mod</hask> exports three functions named <hask>x</hask>, <hask>y</hask> and <hask>z</hask>... | ||
{| | {| | ||
Line 22: | Line 29: | ||
| <hask>import Mod ()</hask> | | <hask>import Mod ()</hask> | ||
| (Nothing!) | | (Nothing!) | ||
− | | ( | + | | (Useful for only importing instances of typeclasses and nothing else) |
|- | |- | ||
− | | <hask>import Mod (x)</hask> | + | | <hask>import Mod (x,y)</hask> |
− | | <hask>x, Mod.x</hask> | + | | <hask>x, y, Mod.x, Mod.y</hask> |
− | | (Only <hask>x</hask> | + | | (Only <hask>x</hask> and <hask>y</hask>, no <hask>z</hask>.) |
|- | |- | ||
| <hask>import qualified Mod</hask> | | <hask>import qualified Mod</hask> | ||
Line 32: | Line 39: | ||
| (Only qualified versions; no unqualified versions.) | | (Only qualified versions; no unqualified versions.) | ||
|- | |- | ||
− | | <hask>import qualified Mod (x)</hask> | + | | <hask>import qualified Mod (x,y)</hask> |
− | | <hask>Mod.x</hask> | + | | <hask>Mod.x, Mod.y</hask> |
− | | (Only <hask>x</hask>, only qualified.) | + | | (Only <hask>x</hask> and <hask>y</hask>, only qualified.) |
|- | |- | ||
− | | <hask>import Mod hiding ()</hask> | + | | <hask>import Mod hiding (x,y)</hask> |
− | | <hask> | + | | <hask>z, Mod.z</hask> |
− | | ( | + | | (<hask>x</hask> and <hask>y</hask> are hidden.) |
|- | |- | ||
− | | <hask>import Mod hiding (x | + | | <hask>import qualified Mod hiding (x,y)</hask> |
− | + | | <hask>Mod.z</hask> | |
− | + | | (<hask>x</hask> and <hask>y</hask> are hidden.) | |
− | + | ||
− | + | ||
− | | <hask> | + | |
− | | ( | + | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
|- | |- | ||
| <hask>import Mod as Foo</hask> | | <hask>import Mod as Foo</hask> | ||
Line 56: | Line 55: | ||
| (Unqualified names as before. Qualified names use <hask>Foo</hask> instead of <hask>Mod</hask>.) | | (Unqualified names as before. Qualified names use <hask>Foo</hask> instead of <hask>Mod</hask>.) | ||
|- | |- | ||
− | | <hask>import Mod as Foo (x)</hask> | + | | <hask>import Mod as Foo (x,y)</hask> |
− | | <hask>x, Foo.x</hask> | + | | <hask>x, y, Foo.x, Foo.y</hask> |
− | | (Only import <hask>x</hask>.) | + | | (Only import <hask>x</hask> and <hask>y</hask>.) |
|- | |- | ||
| <hask>import qualified Mod as Foo</hask> | | <hask>import qualified Mod as Foo</hask> | ||
Line 64: | Line 63: | ||
| (Only qualified names, using new qualifier.) | | (Only qualified names, using new qualifier.) | ||
|} | |} | ||
+ | |||
+ | Note that multiple import statements for the same module are also allowed, so it is possible to mix and match styles if its so desired (for example, importing operators directly and functions qualified) | ||
+ | |||
+ | ===Hiding Prelude=== | ||
+ | |||
+ | By default, ''every module'' implicitly imports <hask>Prelude</hask>. However, if you add an ''explicit'' import declaration for the prelude, this turns off the implicit one. Thus, if you wanted (for example) to write a module that redefines <hask>zip</hask> you could do | ||
+ | <haskell> | ||
+ | module Mod where | ||
+ | |||
+ | import Prelude hiding (zip) | ||
+ | |||
+ | zip = {- ... -} | ||
+ | </haskell> | ||
+ | Without the <hask>import</hask> statement, you could receive a compile-time error about an 'ambiguous use of <hask>zip</hask>'. A slightly more messy alternative is to do | ||
+ | <haskell> | ||
+ | module Mod where | ||
+ | |||
+ | import qualified Prelude as P | ||
+ | |||
+ | zip = {- ... -} | ||
+ | </haskell> | ||
+ | This has the disadvantage that (say) '<hask>P.show (2 P.+ 3 P.* 3) P.++ "abc"</hask>' is very messy to read. Typically a module only redefines a few prelude functions, and it's simpler to just hide the ones you don't want to clash with. | ||
+ | |||
+ | Note that any module ''using'' a module that redefines prelude functions will need to import either the prelude or the other module (or maybe both) qualified and/or with hiding for the same reason. | ||
+ | |||
+ | == See also == | ||
+ | |||
+ | * [[Import modules properly]] - Some thoughts that may help to decide what form of the import statement to use. |
Revision as of 14:16, 28 January 2012
Theimport
import Data.Maybe
Data.Maybe
However, there are more options:
- Modules can be imported qualified (forcing an obligatory namespace qualifier to imported identifiers).
- Some identifiers can be skipped via the hiding clause.
- The module namespace can be renamed, with an as clause.
Getting all of this straight in your head is quite tricky, so here is a table (lifted directly from the language reference manual) that roughly summarises the various possibilities:
Supposing that the moduleMod
x
y
z
Import command | What is brought into scope | Notes |
---|---|---|
import Mod |
x, y, z, Mod.x, Mod.y, Mod.z |
(By default, qualified and unqualified names.) |
import Mod () |
(Nothing!) | (Useful for only importing instances of typeclasses and nothing else) |
import Mod (x,y) |
x, y, Mod.x, Mod.y |
(Only x y z |
import qualified Mod |
Mod.x, Mod.y, Mod.z |
(Only qualified versions; no unqualified versions.) |
import qualified Mod (x,y) |
Mod.x, Mod.y |
(Only x y |
import Mod hiding (x,y) |
z, Mod.z |
( x y |
import qualified Mod hiding (x,y) |
Mod.z |
( x y |
import Mod as Foo |
x, y, z, Foo.x, Foo.y, Foo.z |
(Unqualified names as before. Qualified names use Foo Mod |
import Mod as Foo (x,y) |
x, y, Foo.x, Foo.y |
(Only import x y |
import qualified Mod as Foo |
Foo.x, Foo.y, Foo.z |
(Only qualified names, using new qualifier.) |
Note that multiple import statements for the same module are also allowed, so it is possible to mix and match styles if its so desired (for example, importing operators directly and functions qualified)
1 Hiding Prelude
By default, every module implicitly importsPrelude
zip
module Mod where import Prelude hiding (zip) zip = {- ... -}
import
zip
module Mod where import qualified Prelude as P zip = {- ... -}
P.show (2 P.+ 3 P.* 3) P.++ "abc"
Note that any module using a module that redefines prelude functions will need to import either the prelude or the other module (or maybe both) qualified and/or with hiding for the same reason.
2 See also
- Import modules properly - Some thoughts that may help to decide what form of the import statement to use.