annotate docs/tut/ImportInit.html @ 3172:d1b367fc08bc tests-returncode

Use a return code of 1 when the tests fail.
author Thomas Kluyver <takowl@gmail.com>
date Wed, 09 Jan 2013 10:13:57 +0000
parents 57a4d71f7ce9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
335
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
1 <!--
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
2 TUTORIAL:Import and Initialize
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
3 --><html><head>
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
4
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
5 <title>Pygame Tutorials - Import and Initialize</title>
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
6 </head><body>
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
7
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
8 <h1 align=center><font size=-1>Pygame Tutorials</font><br>Import and Initialize</h1>
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
9 <h2 align=center>by Pete Shinners<br><font size=-1>pete@shinners.org</font></h2>
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
10 <h3 align=center>Revision 1.0, January 28th, 2002</h3>
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
11 <br><br>
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
12
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
13
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
14 Getting pygame imported and initialized is a very simple process. It is also
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
15 flexible enough to give you control over what is happening. Pygame is a
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
16 collection of different modules in a single python package. Some of the
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
17 modules are written in C, and some are written in python. Some modules
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
18 are also optional, and might not always be present.
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
19 <br>&nbsp;<br>
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
20 This is just a quick introduction on what is going on when you import pygame.
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
21 For a clearer explanation definitely see the pygame examples.
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
22
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
23
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
24 <br>&nbsp;<br>&nbsp;<br>
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
25 <h2>Import</h2>
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
26 First we must import the pygame package. Since pygame version 1.4 this
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
27 has been updated to be much easier. Most games will import all of pygame like this.
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
28 <ul><pre>import pygame
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
29 from pygame.locals import *</pre></ul>
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
30 The first line here is the only necessary one. It imports all the available pygame
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
31 modules into the pygame package. The second line is optional, and puts a limited
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
32 set of constants and functions into the global namespace of your script.
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
33 <br>&nbsp;<br>
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
34 An important thing to keep in mind is that several pygame modules are optional.
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
35 For example, one of these is the font module. When you "import pygame", pygame
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
36 will check to see if the font module is available. If the font module is available
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
37 it will be imported as "pygame.font". If the module is not available, "pygame.font"
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
38 will be set to None. This makes it fairly easy to later on test if the font module is available.
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
39
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
40 <br>&nbsp;<br>&nbsp;<br>
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
41 <h2>Init</h2>
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
42 Before you can do much with pygame, you will need to initialize it. The most common
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
43 way to do this is just make one call.
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
44 <ul><pre>pygame.init()</pre></ul>
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
45 This will attempt to initialize all the pygame modules for you. Not all pygame modules
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
46 need to be initialized, but this will automatically initialize the ones that do. You can
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
47 also easily initialize each pygame module by hand. For example to only initialize the
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
48 font module you would just call.
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
49 <ul><pre>pygame.font.init()</pre></ul>
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
50 Note that if there is an error when you initialize with "pygame.init()", it will silently fail.
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
51 When hand initializing modules like this, any errors will raise an exception. Any
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
52 modules that must be initialized also have a "get_init()" function, which will return true
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
53 if the module has been initialized.
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
54 <br>&nbsp;<br>
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
55 It is safe to call the init() function for any module more than once.
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
56
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
57 <br>&nbsp;<br>&nbsp;<br>
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
58 <h2>Quit</h2>
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
59 Modules that are initialized also usually have a quit() function that will clean up.
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
60 There is no need to explicitly call these, as pygame will cleanly quit all the
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
61 initilized modules when python finishes.
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
62
57a4d71f7ce9 docs update
pygame
parents:
diff changeset
63 </body></html>