Mercurial > cpython-lru_cache-weakref

annotate Doc/using/windows.rst @ 79675:c0a2294de787 2.7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Issue #16199: Backport 2to3 typo fix from 3.2.
author Chris Jerdonek <chris.jerdonek@gmail.com>
date Thu, 11 Oct 2012 16:15:46 -0700
parents 7ce3b719306e
children 231e4889b117
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
1 .. highlightlang:: none
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
2
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
3 .. _using-on-windows:
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
4
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
5 *************************
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
6 Using Python on Windows
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
7 *************************
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
8
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
9 .. sectionauthor:: Robert Lehmann <lehmannro@gmail.com>
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
10
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
11 This document aims to give an overview of Windows-specific behaviour you should
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
12 know about when using Python on Microsoft Windows.
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
13
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
14
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
15 Installing Python
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
16 =================
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
17
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
18 Unlike most Unix systems and services, Windows does not require Python natively
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
19 and thus does not pre-install a version of Python. However, the CPython team
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
20 has compiled Windows installers (MSI packages) with every `release
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
21 <http://www.python.org/download/releases/>`_ for many years.
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
22
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
23 With ongoing development of Python, some platforms that used to be supported
45538
ffdd31f1cd20 #2194: fix some typos.
Georg Brandl <georg@python.org>
parents: 44604
diff changeset
24 earlier are no longer supported (due to the lack of users or developers).
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
25 Check :pep:`11` for details on all unsupported platforms.
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
26
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
27 * DOS and Windows 3.x are deprecated since Python 2.0 and code specific to these
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
28 systems was removed in Python 2.1.
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
29 * Up to 2.5, Python was still compatible with Windows 95, 98 and ME (but already
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
30 raised a deprecation warning on installation). For Python 2.6 (and all
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
31 following releases), this support was dropped and new releases are just
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
32 expected to work on the Windows NT family.
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
33 * `Windows CE <http://pythonce.sourceforge.net/>`_ is still supported.
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
34 * The `Cygwin <http://cygwin.com/>`_ installer offers to install the `Python
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
35 interpreter <http://cygwin.com/packages/python>`_ as well; it is located under
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
36 "Interpreters." (cf. `Cygwin package source
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
37 <ftp://ftp.uni-erlangen.de/pub/pc/gnuwin32/cygwin/mirrors/cygnus/
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
38 release/python>`_, `Maintainer releases
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
39 <http://www.tishler.net/jason/software/python/>`_)
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
40
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
41 See `Python for Windows (and DOS) <http://www.python.org/download/windows/>`_
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
42 for detailed information about platforms with precompiled installers.
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
43
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
44 .. seealso::
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
45
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
46 `Python on XP <http://www.richarddooling.com/index.php/2006/03/14/python-on-xp-7-minutes-to-hello-world/>`_
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
47 "7 Minutes to "Hello World!""
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
48 by Richard Dooling, 2006
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
49
73253
7ce3b719306e use diveintopython.net now that DIP.org returns 410; thanks to Josh Gachnang from docs@
Sandro Tosi <sandro.tosi@gmail.com>
parents: 72938
diff changeset
50 `Installing on Windows <http://diveintopython.net/installing_python/windows.html>`_
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
51 in "`Dive into Python: Python from novice to pro
73253
7ce3b719306e use diveintopython.net now that DIP.org returns 410; thanks to Josh Gachnang from docs@
Sandro Tosi <sandro.tosi@gmail.com>
parents: 72938
diff changeset
52 <http://diveintopython.net/index.html>`_"
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
53 by Mark Pilgrim, 2004,
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
54 ISBN 1-59059-356-1
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
55
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
56 `For Windows users <http://swaroopch.com/text/Byte_of_Python:Installing_Python#For_Windows_users>`_
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
57 in "Installing Python"
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
58 in "`A Byte of Python <http://www.byteofpython.info>`_"
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
59 by Swaroop C H, 2003
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
60
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
61
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
62 Alternative bundles
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
63 ===================
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
64
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
65 Besides the standard CPython distribution, there are modified packages including
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
66 additional functionality. The following is a list of popular versions and their
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
67 key features:
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
68
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
69 `ActivePython <http://www.activestate.com/Products/activepython/>`_
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
70 Installer with multi-platform compatibility, documentation, PyWin32
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
71
56824
b7b8970cd5a5 Merged revisions 75363,75365,75376,75392,75394,75403,75418,75484,75572,75580,75590,75592,75594-75596,75600,75602-75603,75605-75607,75610-75613,75616-75617,75623,75627,75647 via svnmerge from
Georg Brandl <georg@python.org>
parents: 50522
diff changeset
72 `Enthought Python Distribution <http://www.enthought.com/products/epd.php>`_
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
73 Popular modules (such as PyWin32) with their respective documentation, tool
57796
89996755cf39 Merged revisions 76904 via svnmerge from
Ezio Melotti <ezio.melotti@gmail.com>
parents: 56824
diff changeset
74 suite for building extensible Python applications
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
75
44226
aad65a2424e3 Merged revisions 59376-59406 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44155
diff changeset
76 Notice that these packages are likely to install *older* versions of Python.
aad65a2424e3 Merged revisions 59376-59406 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44155
diff changeset
77
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
78
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
79
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
80 Configuring Python
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
81 ==================
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
82
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
83 In order to run Python flawlessly, you might have to change certain environment
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
84 settings in Windows.
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
85
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
86
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
87 Excursus: Setting environment variables
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
88 ---------------------------------------
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
89
44226
aad65a2424e3 Merged revisions 59376-59406 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44155
diff changeset
90 Windows has a built-in dialog for changing environment variables (following
50522
ee9ced92843a Merged revisions 68133-68134,68141-68142,68145-68146,68148-68149,68159-68162,68166,68171-68174,68179,68195-68196,68210,68214-68215,68217-68222 via svnmerge from
Georg Brandl <georg@python.org>
parents: 49243
diff changeset
91 guide applies to XP classical view): Right-click the icon for your machine
ee9ced92843a Merged revisions 68133-68134,68141-68142,68145-68146,68148-68149,68159-68162,68166,68171-68174,68179,68195-68196,68210,68214-68215,68217-68222 via svnmerge from
Georg Brandl <georg@python.org>
parents: 49243
diff changeset
92 (usually located on your Desktop and called "My Computer") and choose
ee9ced92843a Merged revisions 68133-68134,68141-68142,68145-68146,68148-68149,68159-68162,68166,68171-68174,68179,68195-68196,68210,68214-68215,68217-68222 via svnmerge from
Georg Brandl <georg@python.org>
parents: 49243
diff changeset
93 :menuselection:`Properties` there. Then, open the :guilabel:`Advanced` tab
44226
aad65a2424e3 Merged revisions 59376-59406 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44155
diff changeset
94 and click the :guilabel:`Environment Variables` button.
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
95
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
96 In short, your path is:
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
97
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
98 :menuselection:`My Computer
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
99 --> Properties
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
100 --> Advanced
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
101 --> Environment Variables`
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
102
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
103 In this dialog, you can add or modify User and System variables. To change
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
104 System variables, you need non-restricted access to your machine
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
105 (i.e. Administrator rights).
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
106
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
107 Another way of adding variables to your environment is using the :command:`set`
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
108 command::
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
109
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
110 set PYTHONPATH=%PYTHONPATH%;C:\My_python_lib
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
111
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
112 To make this setting permanent, you could add the corresponding command line to
44226
aad65a2424e3 Merged revisions 59376-59406 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44155
diff changeset
113 your :file:`autoexec.bat`. :program:`msconfig` is a graphical interface to this
aad65a2424e3 Merged revisions 59376-59406 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44155
diff changeset
114 file.
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
115
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
116 Viewing environment variables can also be done more straight-forward: The
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
117 command prompt will expand strings wrapped into percent signs automatically::
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
118
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
119 echo %PATH%
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
120
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
121 Consult :command:`set /?` for details on this behaviour.
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
122
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
123 .. seealso::
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
124
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
125 http://support.microsoft.com/kb/100843
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
126 Environment variables in Windows NT
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
127
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
128 http://support.microsoft.com/kb/310519
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
129 How To Manage Environment Variables in Windows XP
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
130
44226
aad65a2424e3 Merged revisions 59376-59406 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44155
diff changeset
131 http://www.chem.gla.ac.uk/~louis/software/faq/q1.html
aad65a2424e3 Merged revisions 59376-59406 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44155
diff changeset
132 Setting Environment variables, Louis J. Farrugia
aad65a2424e3 Merged revisions 59376-59406 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44155
diff changeset
133
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
134
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
135 Finding the Python executable
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
136 -----------------------------
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
137
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
138 Besides using the automatically created start menu entry for the Python
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
139 interpreter, you might want to start Python in the DOS prompt. To make this
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
140 work, you need to set your :envvar:`%PATH%` environment variable to include the
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
141 directory of your Python distribution, delimited by a semicolon from other
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
142 entries. An example variable could look like this (assuming the first two
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
143 entries are Windows' default)::
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
144
49243
61c68e2c571b #3916: fixes for docs wrt. Windows directory layout
Georg Brandl <georg@python.org>
parents: 47937
diff changeset
145 C:\WINDOWS\system32;C:\WINDOWS;C:\Python25
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
146
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
147 Typing :command:`python` on your command prompt will now fire up the Python
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
148 interpreter. Thus, you can also execute your scripts with command line options,
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
149 see :ref:`using-on-cmdline` documentation.
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
150
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
151
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
152 Finding modules
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
153 ---------------
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
154
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
155 Python usually stores its library (and thereby your site-packages folder) in the
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
156 installation directory. So, if you had installed Python to
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
157 :file:`C:\\Python\\`, the default library would reside in
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
158 :file:`C:\\Python\\Lib\\` and third-party modules should be stored in
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
159 :file:`C:\\Python\\Lib\\site-packages\\`.
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
160
66456
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
161 This is how :data:`sys.path` is populated on Windows:
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
162
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
163 * An empty entry is added at the start, which corresponds to the current
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
164 directory.
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
165
66456
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
166 * If the environment variable :envvar:`PYTHONPATH` exists, as described in
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
167 :ref:`using-on-envvars`, its entries are added next. Note that on Windows,
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
168 paths in this variable must be separated by semicolons, to distinguish them
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
169 from the colon used in drive identifiers (``C:\`` etc.).
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
170
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
171 * Additional "application paths" can be added in the registry as subkeys of
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
172 :samp:`\\SOFTWARE\\Python\\PythonCore\\{version}\\PythonPath` under both the
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
173 ``HKEY_CURRENT_USER`` and ``HKEY_LOCAL_MACHINE`` hives. Subkeys which have
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
174 semicolon-delimited path strings as their default value will cause each path
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
175 to be added to :data:`sys.path`. (Note that all known installers only use
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
176 HKLM, so HKCU is typically empty.)
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
177
66456
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
178 * If the environment variable :envvar:`PYTHONHOME` is set, it is assumed as
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
179 "Python Home". Otherwise, the path of the main Python executable is used to
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
180 locate a "landmark file" (``Lib\os.py``) to deduce the "Python Home". If a
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
181 Python home is found, the relevant sub-directories added to :data:`sys.path`
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
182 (``Lib``, ``plat-win``, etc) are based on that folder. Otherwise, the core
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
183 Python path is constructed from the PythonPath stored in the registry.
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
184
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
185 * If the Python Home cannot be located, no :envvar:`PYTHONPATH` is specified in
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
186 the environment, and no registry entries can be found, a default path with
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
187 relative entries is used (e.g. ``.\Lib;.\plat-win``, etc).
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
188
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
189 The end result of all this is:
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
190
66456
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
191 * When running :file:`python.exe`, or any other .exe in the main Python
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
192 directory (either an installed version, or directly from the PCbuild
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
193 directory), the core path is deduced, and the core paths in the registry are
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
194 ignored. Other "application paths" in the registry are always read.
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
195
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
196 * When Python is hosted in another .exe (different directory, embedded via COM,
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
197 etc), the "Python Home" will not be deduced, so the core path from the
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
198 registry is used. Other "application paths" in the registry are always read.
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
199
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
200 * If Python can't find its home and there is no registry (eg, frozen .exe, some
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
201 very strange installation setup) you get a path with some default, but
77771b085eca Merged revisions 85548,85572-85573,85606,85609-85612,85614-85616 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58190
diff changeset
202 relative, paths.
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
203
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
204
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
205 Executing scripts
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
206 -----------------
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
207
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
208 Python scripts (files with the extension ``.py``) will be executed by
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
209 :program:`python.exe` by default. This executable opens a terminal, which stays
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
210 open even if the program uses a GUI. If you do not want this to happen, use the
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
211 extension ``.pyw`` which will cause the script to be executed by
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
212 :program:`pythonw.exe` by default (both executables are located in the top-level
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
213 of your Python installation directory). This suppresses the terminal window on
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
214 startup.
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
215
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
216 You can also make all ``.py`` scripts execute with :program:`pythonw.exe`,
47937
38d3a50defec fix various doc typos #3320
Benjamin Peterson <benjamin@python.org>
parents: 45538
diff changeset
217 setting this through the usual facilities, for example (might require
44604
94ab572ed6dd Merged revisions 59843-59863 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44396
diff changeset
218 administrative rights):
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
219
44604
94ab572ed6dd Merged revisions 59843-59863 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44396
diff changeset
220 #. Launch a command prompt.
94ab572ed6dd Merged revisions 59843-59863 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44396
diff changeset
221 #. Associate the correct file group with ``.py`` scripts::
50522
ee9ced92843a Merged revisions 68133-68134,68141-68142,68145-68146,68148-68149,68159-68162,68166,68171-68174,68179,68195-68196,68210,68214-68215,68217-68222 via svnmerge from
Georg Brandl <georg@python.org>
parents: 49243
diff changeset
222
44604
94ab572ed6dd Merged revisions 59843-59863 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44396
diff changeset
223 assoc .py=Python.File
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
224
44604
94ab572ed6dd Merged revisions 59843-59863 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44396
diff changeset
225 #. Redirect all Python files to the new executable::
50522
ee9ced92843a Merged revisions 68133-68134,68141-68142,68145-68146,68148-68149,68159-68162,68166,68171-68174,68179,68195-68196,68210,68214-68215,68217-68222 via svnmerge from
Georg Brandl <georg@python.org>
parents: 49243
diff changeset
226
44604
94ab572ed6dd Merged revisions 59843-59863 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44396
diff changeset
227 ftype Python.File=C:\Path\to\pythonw.exe "%1" %*
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
228
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
229
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
230 Additional modules
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
231 ==================
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
232
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
233 Even though Python aims to be portable among all platforms, there are features
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
234 that are unique to Windows. A couple of modules, both in the standard library
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
235 and external, and snippets exist to use these features.
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
236
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
237 The Windows-specific standard modules are documented in
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
238 :ref:`mswin-specific-services`.
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
239
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
240
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
241 PyWin32
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
242 -------
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
243
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
244 The `PyWin32 <http://python.net/crew/mhammond/win32/>`_ module by Mark Hammond
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
245 is a collection of modules for advanced Windows-specific support. This includes
47937
38d3a50defec fix various doc typos #3320
Benjamin Peterson <benjamin@python.org>
parents: 45538
diff changeset
246 utilities for:
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
247
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
248 * `Component Object Model <http://www.microsoft.com/com/>`_ (COM)
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
249 * Win32 API calls
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
250 * Registry
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
251 * Event log
56824
b7b8970cd5a5 Merged revisions 75363,75365,75376,75392,75394,75403,75418,75484,75572,75580,75590,75592,75594-75596,75600,75602-75603,75605-75607,75610-75613,75616-75617,75623,75627,75647 via svnmerge from
Georg Brandl <georg@python.org>
parents: 50522
diff changeset
252 * `Microsoft Foundation Classes <http://msdn.microsoft.com/en-us/library/fe1cf721%28VS.80%29.aspx>`_ (MFC)
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
253 user interfaces
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
254
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
255 `PythonWin <http://web.archive.org/web/20060524042422/
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
256 http://www.python.org/windows/pythonwin/>`_ is a sample MFC application
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
257 shipped with PyWin32. It is an embeddable IDE with a built-in debugger.
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
258
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
259 .. seealso::
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
260
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
261 `Win32 How Do I...? <http://timgolden.me.uk/python/win32_how_do_i.html>`_
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
262 by Tim Golden
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
263
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
264 `Python and COM <http://www.boddie.org.uk/python/COM.html>`_
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
265 by David and Paul Boddie
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
266
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
267
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
268 Py2exe
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
269 ------
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
270
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
271 `Py2exe <http://www.py2exe.org/>`_ is a :mod:`distutils` extension (see
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
272 :ref:`extending-distutils`) which wraps Python scripts into executable Windows
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
273 programs (:file:`{*}.exe` files). When you have done this, you can distribute
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
274 your application without requiring your users to install Python.
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
275
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
276
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
277 WConio
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
278 ------
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
279
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
280 Since Python's advanced terminal handling layer, :mod:`curses`, is restricted to
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
281 Unix-like systems, there is a library exclusive to Windows as well: Windows
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
282 Console I/O for Python.
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
283
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
284 `WConio <http://newcenturycomputers.net/projects/wconio.html>`_ is a wrapper for
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
285 Turbo-C's :file:`CONIO.H`, used to create text user interfaces.
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
286
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
287
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
288
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
289 Compiling Python on Windows
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
290 ===========================
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
291
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
292 If you want to compile CPython yourself, first thing you should do is get the
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
293 `source <http://python.org/download/source/>`_. You can download either the
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
294 latest release's source or just grab a fresh `checkout
72938
ebf3f2a4c61a Update dead references from py.org/dev/faq to the devguide (#13176)
Éric Araujo <merwok@netwok.org>
parents: 66456
diff changeset
295 <http://docs.python.org/devguide/setup#checking-out-the-code>`_.
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
296
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
297 For Microsoft Visual C++, which is the compiler with which official Python
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
298 releases are built, the source tree contains solutions/project files. View the
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
299 :file:`readme.txt` in their respective directories:
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
300
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
301 +--------------------+--------------+-----------------------+
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
302 | Directory | MSVC version | Visual Studio version |
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
303 +====================+==============+=======================+
44329
75c6bfd3b1f3 Merged revisions 59512-59540 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents: 44226
diff changeset
304 | :file:`PC/VC6/` | 6.0 | 97 |
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
305 +--------------------+--------------+-----------------------+
49243
61c68e2c571b #3916: fixes for docs wrt. Windows directory layout
Georg Brandl <georg@python.org>
parents: 47937
diff changeset
306 | :file:`PC/VS7.1/` | 7.1 | 2003 |
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
307 +--------------------+--------------+-----------------------+
49243
61c68e2c571b #3916: fixes for docs wrt. Windows directory layout
Georg Brandl <georg@python.org>
parents: 47937
diff changeset
308 | :file:`PC/VS8.0/` | 8.0 | 2005 |
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
309 +--------------------+--------------+-----------------------+
49243
61c68e2c571b #3916: fixes for docs wrt. Windows directory layout
Georg Brandl <georg@python.org>
parents: 47937
diff changeset
310 | :file:`PCbuild/` | 9.0 | 2008 |
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
311 +--------------------+--------------+-----------------------+
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
312
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
313 Note that not all of these build directories are fully supported. Read the
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
314 release notes to see which compiler version the official releases for your
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
315 version are built with.
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
316
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
317 Check :file:`PC/readme.txt` for general information on the build process.
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
318
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
319
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
320 For extension modules, consult :ref:`building-on-windows`.
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
321
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
322 .. seealso::
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
323
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
324 `Python + Windows + distutils + SWIG + gcc MinGW <http://sebsauvage.net/python/mingw.html>`_
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
325 or "Creating Python extensions in C/C++ with SWIG and compiling them with
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
326 MinGW gcc under Windows" or "Installing Python extension with distutils
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
327 and without Microsoft Visual C++" by Sébastien Sauvage, 2003
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
328
56824
b7b8970cd5a5 Merged revisions 75363,75365,75376,75392,75394,75403,75418,75484,75572,75580,75590,75592,75594-75596,75600,75602-75603,75605-75607,75610-75613,75616-75617,75623,75627,75647 via svnmerge from
Georg Brandl <georg@python.org>
parents: 50522
diff changeset
329 `MingW -- Python extensions <http://oldwiki.mingw.org/index.php/Python%20extensions>`_
44104
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
330 by Trent Apted et al, 2007
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
331
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
332
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
333 Other resources
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
334 ===============
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
335
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
336 .. seealso::
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
337
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
338 `Python Programming On Win32 <http://www.oreilly.com/catalog/pythonwin32/>`_
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
339 "Help for Windows Programmers"
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
340 by Mark Hammond and Andy Robinson, O'Reilly Media, 2000,
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
341 ISBN 1-56592-621-8
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
342
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
343 `A Python for Windows Tutorial <http://www.imladris.com/Scripts/PythonForWindows.html>`_
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
344 by Amanda Birmingham, 2004
ff1766eb2fce Merged revisions 59259-59274 via svnmerge from
Christian Heimes <christian@cheimes.de>
parents:
diff changeset
345