Python shebang

4. Using Python on Windows¶

This document aims to give an overview of Windows-specific behaviour you should know about when using Python on Microsoft Windows.

Unlike most Unix systems and services, Windows does not include a system supported installation of Python. To make Python available, the CPython team has compiled Windows installers (MSI packages) with every release for many years. These installers are primarily intended to add a per-user installation of Python, with the core interpreter and library being used by a single user. The installer is also able to install for all users of a single machine, and a separate ZIP file is available for application-local distributions.

As specified in PEP 11, a Python release only supports a Windows platform while Microsoft considers the platform under extended support. This means that Python 3.10 supports Windows 8.1 and newer. If you require Windows 7 support, please install Python 3.8.

There are a number of different installers available for Windows, each with certain benefits and downsides.

The full installer contains all components and is the best option for developers using Python for any kind of project.

The Microsoft Store package is a simple installation of Python that is suitable for running scripts and packages, and using IDLE or other development environments. It requires Windows 10, but can be safely installed without corrupting other programs. It also provides many convenient commands for launching Python and its tools.

The nuget.org packages are lightweight installations intended for continuous integration systems. It can be used to build Python packages or run scripts, but is not updateable and has no user interface tools.

The embeddable package is a minimal package of Python suitable for embedding into a larger application.

4.1. The full installer¶

4.1.1. Installation steps¶

Four Python 3.10 installers are available for download - two each for the 32-bit and 64-bit versions of the interpreter. The web installer is a small initial download, and it will automatically download the required components as necessary. The offline installer includes the components necessary for a default installation and only requires an internet connection for optional features. See Installing Without Downloading for other ways to avoid downloading during installation.

After starting the installer, one of two options may be selected:

../_images/win_installer.png

If you select “Install Now”:

  • You will not need to be an administrator (unless a system update for the C Runtime Library is required or you install the Python Launcher for Windows for all users)

  • Python will be installed into your user directory

  • The Python Launcher for Windows will be installed according to the option at the bottom of the first page

  • The standard library, test suite, launcher and pip will be installed

  • If selected, the install directory will be added to your

  • Shortcuts will only be visible for the current user

Selecting “Customize installation” will allow you to select the features to install, the installation location and other options or post-install actions. To install debugging symbols or binaries, you will need to use this option.

To perform an all-users installation, you should select “Customize installation”. In this case:

  • You may be required to provide administrative credentials or approval

  • Python will be installed into the Program Files directory

  • The Python Launcher for Windows will be installed into the Windows directory

  • Optional features may be selected during installation

  • The standard library can be pre-compiled to bytecode

  • If selected, the install directory will be added to the system

  • Shortcuts are available for all users

4.1.2. Removing the MAX_PATH Limitation¶

Windows historically has limited path lengths to 260 characters. This meant that paths longer than this would not resolve and errors would result.

In the latest versions of Windows, this limitation can be expanded to approximately 32,000 characters. Your administrator will need to activate the “Enable Win32 long paths” group policy, or set to in the registry key .

This allows the function, the module and most other path functionality to accept and return paths longer than 260 characters.

After changing the above option, no further configuration is required.

Changed in version 3.6: Support for long paths was enabled in Python.

4.1.3. Installing Without UI¶

All of the options available in the installer UI can also be specified from the command line, allowing scripted installers to replicate an installation on many machines without user interaction. These options may also be set without suppressing the UI in order to change some of the defaults.

To completely hide the installer UI and install Python silently, pass the option. To skip past the user interaction but still display progress and errors, pass the option. The option may be passed to immediately begin removing Python - no prompt will be displayed.

All other options are passed as , where the value is usually to disable a feature, to enable a feature, or a path. The full list of available options is shown below.

Name

Description

Default

InstallAllUsers

Perform a system-wide installation.

0

TargetDir

The installation directory

Selected based on InstallAllUsers

DefaultAllUsersTargetDir

The default installation directory for all-user installs

or

DefaultJustForMeTargetDir

The default install directory for just-for-me installs

or or

DefaultCustomTargetDir

The default custom install directory displayed in the UI

(empty)

AssociateFiles

Create file associations if the launcher is also installed.

1

CompileAll

Compile all files to .

0

PrependPath

Add install and Scripts directories to and to

0

Shortcuts

Create shortcuts for the interpreter, documentation and IDLE if installed.

1

Include_doc

Install Python manual

1

Include_debug

Install debug binaries

0

Include_dev

Install developer headers and libraries

1

Include_exe

Install and related files

1

Include_launcher

Install Python Launcher for Windows.

1

InstallLauncherAllUsers

Installs Python Launcher for Windows for all users.

1

Include_lib

Install standard library and extension modules

1

Include_pip

Install bundled pip and setuptools

1

Include_symbols

Install debugging symbols (*.pdb)

0

Include_tcltk

Install Tcl/Tk support and IDLE

1

Include_test

Install standard library test suite

1

Include_tools

Install utility scripts

1

LauncherOnly

Only installs the launcher. This will override most other options.

0

SimpleInstall

Disable most install UI

0

SimpleInstallDescription

A custom message to display when the simplified install UI is used.

(empty)

For example, to silently install a default, system-wide Python installation, you could use the following command (from an elevated command prompt):

python-3.9.0.exe /quiet InstallAllUsers=1 PrependPath=1 Include_test=0

To allow users to easily install a personal copy of Python without the test suite, you could provide a shortcut with the following command. This will display a simplified initial page and disallow customization:

python-3.9.0.exe InstallAllUsers=0 Include_launcher=0 Include_test=0 SimpleInstall=1 SimpleInstallDescription="Just for me, no test suite."

(Note that omitting the launcher also omits file associations, and is only recommended for per-user installs when there is also a system-wide installation that included the launcher.)

The options listed above can also be provided in a file named alongside the executable. This file specifies a list of options and values. When a value is provided as an attribute, it will be converted to a number if possible. Values provided as element text are always left as strings. This example file sets the same options as the previous example:

<Options><OptionName="InstallAllUsers"Value="no"/><OptionName="Include_launcher"Value="0"/><OptionName="Include_test"Value="no"/><OptionName="SimpleInstall"Value="yes"/><OptionName="SimpleInstallDescription">Just for me, no test suite</Option></Options>

4.1.4. Installing Without Downloading¶

As some features of Python are not included in the initial installer download, selecting those features may require an internet connection. To avoid this need, all possible components may be downloaded on-demand to create a complete layout that will no longer require an internet connection regardless of the selected features. Note that this download may be bigger than required, but where a large number of installations are going to be performed it is very useful to have a locally cached copy.

Execute the following command from Command Prompt to download all possible required files. Remember to substitute for the actual name of your installer, and to create layouts in their own directories to avoid collisions between files with the same name.

python-3.9.0.exe /layout [optional target directory]

You may also specify the option to hide the progress display.

4.1.5. Modifying an install¶

Once Python has been installed, you can add or remove features through the Programs and Features tool that is part of Windows. Select the Python entry and choose “Uninstall/Change” to open the installer in maintenance mode.

“Modify” allows you to add or remove features by modifying the checkboxes - unchanged checkboxes will not install or remove anything. Some options cannot be changed in this mode, such as the install directory; to modify these, you will need to remove and then reinstall Python completely.

“Repair” will verify all the files that should be installed using the current settings and replace any that have been removed or modified.

“Uninstall” will remove Python entirely, with the exception of the Python Launcher for Windows, which has its own entry in Programs and Features.

4.2. The Microsoft Store package¶

The Microsoft Store package is an easily installable Python interpreter that is intended mainly for interactive use, for example, by students.

To install the package, ensure you have the latest Windows 10 updates and search the Microsoft Store app for “Python 3.10”. Ensure that the app you select is published by the Python Software Foundation, and install it.

Warning

Python will always be available for free on the Microsoft Store. If you are asked to pay for it, you have not selected the correct package.

After installation, Python may be launched by finding it in Start. Alternatively, it will be available from any Command Prompt or PowerShell session by typing . Further, pip and IDLE may be used by typing or . IDLE can also be found in Start.

All three commands are also available with version number suffixes, for example, as and as well as (where is the specific version you want to launch, such as 3.10). Open “Manage App Execution Aliases” through Start to select which version of Python is associated with each command. It is recommended to make sure that and are consistent with whichever version of is selected.

Virtual environments can be created with and activated and used as normal.

If you have installed another version of Python and added it to your variable, it will be available as rather than the one from the Microsoft Store. To access the new installation, use or .

The launcher will detect this Python installation, but will prefer installations from the traditional installer.

To remove Python, open Settings and use Apps and Features, or else find Python in Start and right-click to select Uninstall. Uninstalling will remove all packages you installed directly into this Python installation, but will not remove any virtual environments

4.2.1. Known Issues¶

Because of restrictions on Microsoft Store apps, Python scripts may not have full write access to shared locations such as and the registry. Instead, it will write to a private copy. If your scripts must modify the shared locations, you will need to install the full installer.

For more detail on the technical basis for these limitations, please consult Microsoft’s documentation on packaged full-trust apps, currently available at docs.microsoft.com/en-us/windows/msix/desktop/desktop-to-uwp-behind-the-scenes

4.3. The nuget.org packages¶

The nuget.org package is a reduced size Python environment intended for use on continuous integration and build systems that do not have a system-wide install of Python. While nuget is “the package manager for .NET”, it also works perfectly fine for packages containing build-time tools.

Visit nuget.org for the most up-to-date information on using nuget. What follows is a summary that is sufficient for Python developers.

The command line tool may be downloaded directly from , for example, using curl or PowerShell. With the tool, the latest version of Python for 64-bit or 32-bit machines is installed using:

nuget.exe install python -ExcludeVersion -OutputDirectory . nuget.exe install pythonx86 -ExcludeVersion -OutputDirectory .

To select a particular version, add a . The output directory may be changed from , and the package will be installed into a subdirectory. By default, the subdirectory is named the same as the package, and without the option this name will include the specific version installed. Inside the subdirectory is a directory that contains the Python installation:

# Without -ExcludeVersion > .\python.3.5.2\tools\python.exe -V Python 3.5.2 # With -ExcludeVersion > .\python\tools\python.exe -V Python 3.5.2

In general, nuget packages are not upgradeable, and newer versions should be installed side-by-side and referenced using the full path. Alternatively, delete the package directory manually and install it again. Many CI systems will do this automatically if they do not preserve files between builds.

Alongside the directory is a directory. This contains a MSBuild properties file that can be used in a C++ project to reference the Python install. Including the settings will automatically use the headers and import libraries in your build.

The package information pages on nuget.org are www.nuget.org/packages/python for the 64-bit version and www.nuget.org/packages/pythonx86 for the 32-bit version.

4.4. The embeddable package¶

The embedded distribution is a ZIP file containing a minimal Python environment. It is intended for acting as part of another application, rather than being directly accessed by end-users.

When extracted, the embedded distribution is (almost) fully isolated from the user’s system, including environment variables, system registry settings, and installed packages. The standard library is included as pre-compiled and optimized files in a ZIP, and , , and are all provided. Tcl/tk (including all dependants, such as Idle), pip and the Python documentation are not included.

Note

The embedded distribution does not include the Microsoft C Runtime and it is the responsibility of the application installer to provide this. The runtime may have already been installed on a user’s system previously or automatically via Windows Update, and can be detected by finding in the system directory.

Third-party packages should be installed by the application installer alongside the embedded distribution. Using pip to manage dependencies as for a regular Python installation is not supported with this distribution, though with some care it may be possible to include and use pip for automatic updates. In general, third-party packages should be treated as part of the application (“vendoring”) so that the developer can ensure compatibility with newer versions before providing updates to users.

The two recommended use cases for this distribution are described below.

4.4.1. Python Application¶

An application written in Python does not necessarily require users to be aware of that fact. The embedded distribution may be used in this case to include a private version of Python in an install package. Depending on how transparent it should be (or conversely, how professional it should appear), there are two options.

Using a specialized executable as a launcher requires some coding, but provides the most transparent experience for users. With a customized launcher, there are no obvious indications that the program is running on Python: icons can be customized, company and version information can be specified, and file associations behave properly. In most cases, a custom launcher should simply be able to call with a hard-coded command line.

The simpler approach is to provide a batch file or generated shortcut that directly calls the or with the required command-line arguments. In this case, the application will appear to be Python and not its actual name, and users may have trouble distinguishing it from other running Python processes or file associations.

With the latter approach, packages should be installed as directories alongside the Python executable to ensure they are available on the path. With the specialized launcher, packages can be located in other locations as there is an opportunity to specify the search path before launching the application.

4.4.2. Embedding Python¶

Applications written in native code often require some form of scripting language, and the embedded Python distribution can be used for this purpose. In general, the majority of the application is in native code, and some part will either invoke or directly use . For either case, extracting the embedded distribution to a subdirectory of the application installation is sufficient to provide a loadable Python interpreter.

As with the application use, packages can be installed to any location as there is an opportunity to specify search paths before initializing the interpreter. Otherwise, there is no fundamental differences between using the embedded distribution and a regular installation.

4.5. Alternative bundles¶

Besides the standard CPython distribution, there are modified packages including additional functionality. The following is a list of popular versions and their key features:

ActivePython

Installer with multi-platform compatibility, documentation, PyWin32

Anaconda

Popular scientific modules (such as numpy, scipy and pandas) and the package manager.

Canopy

A “comprehensive Python analysis environment” with editors and other development tools.

WinPython

Windows-specific distribution with prebuilt scientific packages and tools for building packages.

Note that these packages may not include the latest versions of Python or other libraries, and are not maintained or supported by the core Python team.

4.6. Configuring Python¶

To run Python conveniently from a command prompt, you might consider changing some default environment variables in Windows. While the installer provides an option to configure the PATH and PATHEXT variables for you, this is only reliable for a single, system-wide installation. If you regularly use multiple versions of Python, consider using the Python Launcher for Windows.

4.6.1. Excursus: Setting environment variables¶

Windows allows environment variables to be configured permanently at both the User level and the System level, or temporarily in a command prompt.

To temporarily set environment variables, open Command Prompt and use the set command:

C:\>setPATH=C:\Program Files\Python 3.9;%PATH%C:\>setPYTHONPATH=%PYTHONPATH%;C:\My_python_lib C:\>python

These changes will apply to any further commands executed in that console, and will be inherited by any applications started from the console.

Including the variable name within percent signs will expand to the existing value, allowing you to add your new value at either the start or the end. Modifying by adding the directory containing python.exe to the start is a common way to ensure the correct version of Python is launched.

To permanently modify the default environment variables, click Start and search for ‘edit environment variables’, or open System properties, Advanced system settings and click the Environment Variables button. In this dialog, you can add or modify User and System variables. To change System variables, you need non-restricted access to your machine (i.e. Administrator rights).

Note

Windows will concatenate User variables after System variables, which may cause unexpected results when modifying .

The variable is used by all versions of Python 2 and Python 3, so you should not permanently configure this variable unless it only includes code that is compatible with all of your installed Python versions.

4.6.2. Finding the Python executable¶

Besides using the automatically created start menu entry for the Python interpreter, you might want to start Python in the command prompt. The installer has an option to set that up for you.

On the first page of the installer, an option labelled “Add Python to PATH” may be selected to have the installer add the install location into the . The location of the folder is also added. This allows you to type python to run the interpreter, and pip for the package installer. Thus, you can also execute your scripts with command line options, see Command line documentation.

If you don’t enable this option at install time, you can always re-run the installer, select Modify, and enable it. Alternatively, you can manually modify the using the directions in Excursus: Setting environment variables. You need to set your environment variable to include the directory of your Python installation, delimited by a semicolon from other entries. An example variable could look like this (assuming the first two entries already existed):

C:\WINDOWS\system32;C:\WINDOWS;C:\Program Files\Python 3.9

4.7. UTF-8 mode¶

Windows still uses legacy encodings for the system encoding (the ANSI Code Page). Python uses it for the default encoding of text files (e.g. ).

This may cause issues because UTF-8 is widely used on the internet and most Unix systems, including WSL (Windows Subsystem for Linux).

You can use the Python UTF-8 Mode to change the default text encoding to UTF-8. You can enable the Python UTF-8 Mode via the command line option, or the environment variable. See for enabling UTF-8 mode, and Excursus: Setting environment variables for how to modify environment variables.

When the Python UTF-8 Mode is enabled, you can still use the system encoding (the ANSI Code Page) via the “mbcs” codec.

Note that adding to the default environment variables will affect all Python 3.7+ applications on your system. If you have any Python 3.7+ applications which rely on the legacy system encoding, it is recommended to set the environment variable temporarily or use the command line option.

Note

Even when UTF-8 mode is disabled, Python uses UTF-8 by default on Windows for:

4.8. Python Launcher for Windows¶

The Python launcher for Windows is a utility which aids in locating and executing of different Python versions. It allows scripts (or the command-line) to indicate a preference for a specific Python version, and will locate and execute that version.

Unlike the variable, the launcher will correctly select the most appropriate version of Python. It will prefer per-user installations over system-wide ones, and orders by language version rather than using the most recently installed version.

The launcher was originally specified in PEP 397.

4.8.1. Getting started¶

4.8.1.1. From the command-line¶

System-wide installations of Python 3.3 and later will put the launcher on your . The launcher is compatible with all available versions of Python, so it does not matter which version is installed. To check that the launcher is available, execute the following command in Command Prompt:

You should find that the latest version of Python you have installed is started - it can be exited as normal, and any additional command-line arguments specified will be sent directly to Python.

If you have multiple versions of Python installed (e.g., 2.7 and 3.10) you will have noticed that Python 3.10 was started - to launch Python 2.7, try the command:

If you want the latest version of Python 2.x you have installed, try the command:

You should find the latest version of Python 2.x starts.

If you see the following error, you do not have the launcher installed:

'py' is not recognized as an internal or external command, operable program or batch file.

Per-user installations of Python do not add the launcher to unless the option was selected on installation.

4.8.1.2. Virtual environments¶

If the launcher is run with no explicit Python version specification, and a virtual environment (created with the standard library module or the external tool) active, the launcher will run the virtual environment’s interpreter rather than the global one. To run the global interpreter, either deactivate the virtual environment, or explicitly specify the global Python version.

4.8.1.3. From a script¶

Let’s create a test Python script - create a file called with the following contents

#! pythonimportsyssys.stdout.write("hello from Python %s\n"%(sys.version,))

From the directory in which hello.py lives, execute the command:

You should notice the version number of your latest Python 2.x installation is printed. Now try changing the first line to be:

Re-executing the command should now print the latest Python 3.x information. As with the above command-line examples, you can specify a more explicit version qualifier. Assuming you have Python 2.6 installed, try changing the first line to and you should find the 2.6 version information printed.

Note that unlike interactive use, a bare “python” will use the latest version of Python 2.x that you have installed. This is for backward compatibility and for compatibility with Unix, where the command typically refers to Python 2.

4.8.1.4. From file associations¶

The launcher should have been associated with Python files (i.e. , , files) when it was installed. This means that when you double-click on one of these files from Windows explorer the launcher will be used, and therefore you can use the same facilities described above to have the script specify the version which should be used.

The key benefit of this is that a single launcher can support multiple Python versions at the same time depending on the contents of the first line.

4.8.2. Shebang Lines¶

If the first line of a script file starts with , it is known as a “shebang” line. Linux and other Unix like operating systems have native support for such lines and they are commonly used on such systems to indicate how a script should be executed. This launcher allows the same facilities to be used with Python scripts on Windows and the examples above demonstrate their use.

To allow shebang lines in Python scripts to be portable between Unix and Windows, this launcher supports a number of ‘virtual’ commands to specify which interpreter to use. The supported virtual commands are:

For example, if the first line of your script starts with

The default Python will be located and used. As many Python scripts written to work on Unix will already have this line, you should find these scripts can be used by the launcher without modification. If you are writing a new script on Windows which you hope will be useful on Unix, you should use one of the shebang lines starting with .

Any of the above virtual commands can be suffixed with an explicit version (either just the major version, or the major and minor version). Furthermore the 32-bit version can be requested by adding “-32” after the minor version. I.e. will request usage of the 32-bit python 2.7.

New in version 3.7: Beginning with python launcher 3.7 it is possible to request 64-bit version by the “-64” suffix. Furthermore it is possible to specify a major and architecture without minor (i.e. ).

The form of shebang line has one further special property. Before looking for installed Python interpreters, this form will search the executable for a Python executable. This corresponds to the behaviour of the Unix program, which performs a search.

4.8.3. Arguments in shebang lines¶

The shebang lines can also specify additional options to be passed to the Python interpreter. For example, if you have a shebang line:

Then Python will be started with the option

4.8.4. Customization¶

4.8.4.1. Customization via INI files¶

Two .ini files will be searched by the launcher - in the current user’s “application data” directory (i.e. the directory returned by calling the Windows function with ) and in the same directory as the launcher. The same .ini files are used for both the ‘console’ version of the launcher (i.e. py.exe) and for the ‘windows’ version (i.e. pyw.exe).

Customization specified in the “application directory” will have precedence over the one next to the executable, so a user, who may not have write access to the .ini file next to the launcher, can override commands in that global .ini file.

4.8.4.2. Customizing default Python versions¶

In some cases, a version qualifier can be included in a command to dictate which version of Python will be used by the command. A version qualifier starts with a major version number and can optionally be followed by a period (‘.’) and a minor version specifier. Furthermore it is possible to specify if a 32 or 64 bit implementation shall be requested by adding “-32” or “-64”.

For example, a shebang line of has no version qualifier, while has a version qualifier which specifies only a major version.

If no version qualifiers are found in a command, the environment variable can be set to specify the default version qualifier. If it is not set, the default is “3”. The variable can specify any value that may be passed on the command line, such as “3”, “3.7”, “3.7-32” or “3.7-64”. (Note that the “-64” option is only available with the launcher included with Python 3.7 or newer.)

If no minor version qualifiers are found, the environment variable (where is the current major version qualifier as determined above) can be set to specify the full version. If no such option is found, the launcher will enumerate the installed Python versions and use the latest minor release found for the major version, which is likely, although not guaranteed, to be the most recently installed version in that family.

On 64-bit Windows with both 32-bit and 64-bit implementations of the same (major.minor) Python version installed, the 64-bit version will always be preferred. This will be true for both 32-bit and 64-bit implementations of the launcher - a 32-bit launcher will prefer to execute a 64-bit Python installation of the specified version if available. This is so the behavior of the launcher can be predicted knowing only what versions are installed on the PC and without regard to the order in which they were installed (i.e., without knowing whether a 32 or 64-bit version of Python and corresponding launcher was installed last). As noted above, an optional “-32” or “-64” suffix can be used on a version specifier to change this behaviour.

Examples:

  • If no relevant options are set, the commands and will use the latest Python 2.x version installed and the command will use the latest Python 3.x installed.

  • The commands and will not consult any options at all as the versions are fully specified.

  • If , the commands and will both use the latest installed Python 3 version.

  • If , the command will use the 32-bit implementation of 3.1 whereas the command will use the latest installed Python (PY_PYTHON was not considered at all as a major version was specified.)

  • If and , the commands and will both use specifically 3.1

In addition to environment variables, the same settings can be configured in the .INI file used by the launcher. The section in the INI file is called and the key name will be the same as the environment variables without the leading prefix (and note that the key names in the INI file are case insensitive.) The contents of an environment variable will override things specified in the INI file.

For example:

  • Setting is equivalent to the INI file containing:

  • Setting and is equivalent to the INI file containing:

[defaults]python=3python3=3.1

4.8.5. Diagnostics¶

If an environment variable is set (to any value), the launcher will print diagnostic information to stderr (i.e. to the console). While this information manages to be simultaneously verbose and terse, it should allow you to see what versions of Python were located, why a particular version was chosen and the exact command-line used to execute the target Python.

4.9. Finding modules¶

Python usually stores its library (and thereby your site-packages folder) in the installation directory. So, if you had installed Python to , the default library would reside in and third-party modules should be stored in .

To completely override , create a file with the same name as the DLL () or the executable () and specify one line for each path to add to . The file based on the DLL name overrides the one based on the executable, which allows paths to be restricted for any program loading the runtime if desired.

When the file exists, all registry and environment variables are ignored, isolated mode is enabled, and is not imported unless one line in the file specifies . Blank paths and lines starting with are ignored. Each path may be absolute or relative to the location of the file. Import statements other than to are not permitted, and arbitrary code cannot be specified.

Note that files (without leading underscore) will be processed normally by the module when has been specified.

When no file is found, this is how is populated on Windows:

  • An empty entry is added at the start, which corresponds to the current directory.

  • If the environment variable exists, as described in Environment variables, its entries are added next. Note that on Windows, paths in this variable must be separated by semicolons, to distinguish them from the colon used in drive identifiers ( etc.).

  • Additional “application paths” can be added in the registry as subkeys of under both the and hives. Subkeys which have semicolon-delimited path strings as their default value will cause each path to be added to . (Note that all known installers only use HKLM, so HKCU is typically empty.)

  • If the environment variable is set, it is assumed as “Python Home”. Otherwise, the path of the main Python executable is used to locate a “landmark file” (either or ) to deduce the “Python Home”. If a Python home is found, the relevant sub-directories added to (, , etc) are based on that folder. Otherwise, the core Python path is constructed from the PythonPath stored in the registry.

  • If the Python Home cannot be located, no is specified in the environment, and no registry entries can be found, a default path with relative entries is used (e.g. , etc).

If a file is found alongside the main executable or in the directory one level above the executable, the following variations apply:

  • If is an absolute path and is not set, this path is used instead of the path to the main executable when deducing the home location.

The end result of all this is:

  • When running , or any other .exe in the main Python directory (either an installed version, or directly from the PCbuild directory), the core path is deduced, and the core paths in the registry are ignored. Other “application paths” in the registry are always read.

  • When Python is hosted in another .exe (different directory, embedded via COM, etc), the “Python Home” will not be deduced, so the core path from the registry is used. Other “application paths” in the registry are always read.

  • If Python can’t find its home and there are no registry value (frozen .exe, some very strange installation setup) you get a path with some default, but relative, paths.

For those who want to bundle Python into their application or distribution, the following advice will prevent conflicts with other installations:

  • Include a file alongside your executable containing the directories to include. This will ignore paths listed in the registry and environment variables, and also ignore unless is listed.

  • If you are loading or in your own executable, explicitly call or (at least) before .

  • Clear and/or overwrite and set before launching from your application.

  • If you cannot use the previous suggestions (for example, you are a distribution that allows people to run directly), ensure that the landmark file () exists in your install directory. (Note that it will not be detected inside a ZIP file, but a correctly named ZIP file will be detected instead.)

These will ensure that the files in a system-wide installation will not take precedence over the copy of the standard library bundled with your application. Otherwise, your users may experience problems using your application. Note that the first suggestion is the best, as the others may still be susceptible to non-standard paths in the registry and user site-packages.

Changed in version 3.6:
  • Adds file support and removes option from .

  • Adds as a potential landmark when directly adjacent to the executable.

Deprecated since version 3.6:

Modules specified in the registry under (not ) may be imported by . This finder is enabled on Windows in 3.6.0 and earlier, but may need to be explicitly added to in the future.

4.10. Additional modules¶

Even though Python aims to be portable among all platforms, there are features that are unique to Windows. A couple of modules, both in the standard library and external, and snippets exist to use these features.

The Windows-specific standard modules are documented in MS Windows Specific Services.

4.10.1. PyWin32¶

The PyWin32 module by Mark Hammond is a collection of modules for advanced Windows-specific support. This includes utilities for:

PythonWin is a sample MFC application shipped with PyWin32. It is an embeddable IDE with a built-in debugger.

4.10.2. cx_Freeze¶

cx_Freeze is a extension (see Extending Distutils) which wraps Python scripts into executable Windows programs ( files). When you have done this, you can distribute your application without requiring your users to install Python.

4.10.3. WConio¶

Since Python’s advanced terminal handling layer, , is restricted to Unix-like systems, there is a library exclusive to Windows as well: Windows Console I/O for Python.

WConio is a wrapper for Turbo-C’s , used to create text user interfaces.

4.11. Compiling Python on Windows¶

If you want to compile CPython yourself, first thing you should do is get the source. You can download either the latest release’s source or just grab a fresh checkout.

The source tree contains a build solution and project files for Microsoft Visual Studio 2015, which is the compiler used to build the official Python releases. These files are in the directory.

Check for general information on the build process.

For extension modules, consult Building C and C++ Extensions on Windows.

See also

Python + Windows + distutils + SWIG + gcc MinGW

or “Creating Python extensions in C/C++ with SWIG and compiling them with MinGW gcc under Windows” or “Installing Python extension with distutils and without Microsoft Visual C++” by Sébastien Sauvage, 2003

4.12. Other Platforms¶

With ongoing development of Python, some platforms that used to be supported earlier are no longer supported (due to the lack of users or developers). Check PEP 11 for details on all unsupported platforms.

See Python for Windows for detailed information about platforms with pre-compiled installers.

Sours: https://docs.python.org/3/using/windows.html

How to make python shebang use python3?

I have a third party script that uses the shebang .

According to the python documentation, this is the correct form for scripts that are suitable for both Python v2 and Python v3 (https://docs.python.org/3/using/windows.html#shebang-lines).

My Ubuntu (WSL) has only Python 3 installed:

I have added this to the path, by adding the following in my and sourcing it

Yet when I run this script it complains that it cannot find Python. I have created a short test file that contains the same shebang and a :

What else can I do to make use python3?

PS: I do not have python 2, nor do I wish to install it. The third party script's README specifically mentions supporting both Python v2 and v3, and the shebang indicates this, as mentioned, according to the Python docs themselves.

PPS: Adding aliases does not resolve this as they are only effective when the user is calling python at the prompt, not when the bash itself is running a script. This answer to a similar question explicitly cites this behaviour: https://askubuntu.com/a/351380/333103

PPPS: The received wisdom from other questions is that symlinking is not the correct solution to issues (don't have link to hand just ATM)

Sours: https://askubuntu.com/questions/1189360/how-to-make-python-shebang-use-python3
  1. Dirt on dirt live schedule
  2. Mechanics set
  3. Craigslist nwga

Should I put #! (shebang) in Python scripts, and what form should it take?

The shebang line in any script determines the script's ability to be executed like a standalone executable without typing beforehand in the terminal or when double clicking it in a file manager (when configured properly). It isn't necessary but generally put there so when someone sees the file opened in an editor, they immediately know what they're looking at. However, which shebang line you use IS important.

Correct usage for Python 3 scripts is:

This defaults to version 3.latest. For Python 2.7.latest use in place of .

The following should NOT be used (except for the rare case that you are writing code which is compatible with both Python 2.x and 3.x):

The reason for these recommendations, given in PEP 394, is that can refer either to or on different systems. It currently refers to on most distributions, but that is likely to change at some point.

Also, DO NOT Use:

"python may be installed at /usr/bin/python or /bin/python in those cases, the above #! will fail."

--"#!/usr/bin/env python" vs "#!/usr/local/bin/python"


It's really just a matter of taste. Adding the shebang means people can invoke the script directly if they want (assuming it's marked as executable); omitting it just means has to be invoked manually.

The end result of running the program isn't affected either way; it's just options of the means.


Should I put the shebang in my Python scripts?

Put a shebang into a Python script to indicate:

  • this module can be run as a script
  • whether it can be run only on python2, python3 or is it Python 2/3 compatible
  • on POSIX, it is necessary if you want to run the script directly without invoking executable explicitly

Are these equally portable? Which form is used most?

If you write a shebang manually then always use unless you have a specific reason not to use it. This form is understood even on Windows (Python launcher).

Note: installed scripts should use a specific python executable e.g., or . It is bad if some tool breaks if you activate a virtualenv in your shell. Luckily, the correct shebang is created automatically in most cases by or your distribution package tools (on Windows, can generate wrapper scripts automatically).

In other words, if the script is in a source checkout then you will probably see . If it is installed then the shebang is a path to a specific python executable such as (NOTE: you should not write the paths from the latter category manually).

To choose whether you should use , , or in the shebang, see PEP 394 - The "python" Command on Unix-Like Systems:

  • ... should be used in the shebang line only for scripts that are source compatible with both Python 2 and 3.

  • in preparation for an eventual change in the default version of Python, Python 2 only scripts should either be updated to be source compatible with Python 3 or else to use in the shebang line.

Sours: https://newbedev.com/should-i-put-shebang-in-python-scripts-and-what-form-should-it-take

Should I put #! (shebang) in Python scripts, and what form should it take?

Sometimes, if the answer is not very clear (I mean you cannot decide if yes or no), then it does not matter too much, and you can ignore the problem until the answer is clear.

The only purpose is for launching the script. Django loads the sources on its own and uses them. It never needs to decide what interpreter should be used. This way, the actually makes no sense here.

Generally, if it is a module and cannot be used as a script, there is no need for using the . On the other hand, a module source often contains with at least some trivial testing of the functionality. Then the makes sense again.

One good reason for using is when you use both Python 2 and Python 3 scripts -- they must be interpreted by different versions of Python. This way, you have to remember what must be used when launching the script manually (without the inside). If you have a mixture of such scripts, it is a good idea to use the inside, make them executable, and launch them as executables (chmod ...).

When using MS-Windows, the had no sense -- until recently. Python 3.3 introduces a Windows Python Launcher (py.exe and pyw.exe) that reads the line, detects the installed versions of Python, and uses the correct or explicitly wanted version of Python. As the extension can be associated with a program, you can get similar behaviour in Windows as with execute flag in Unix-based systems.

answered Jan 30 '13 at 7:52

peprpepr

18.5k1212 gold badges6868 silver badges124124 bronze badges

Sours: https://stackoverflow.com/questions/6908143/should-i-put-shebang-in-python-scripts-and-what-form-should-it-take?rq=1

Shebang python

pantsbuild / pex Public

1st, correcting your example: should fail on most systems since Python tends to install its binaries as , and where [MAJ] is the major version (like 3 for Python 3.8.6) and [MIN] is the minor version (like 8 for Pyhton 3.8.6). Note that your example is missing the dot between major and minor version.

For convenient reference, the help for the option:

On to shebang questions, with the help again for convenient reference:

The fundamental missing context appears to be how binaries get executed on Unix; so I'll lead with that:

Traditionally, on Unix, a file is executable if the appropriate mode bits are set and the contents is either a known executable file format (ELF, COFF, ... depends on the Unix) or else its a script. A script is denoted by as the leading bytes with the path to the interpreter to use to execute the script following that and ending in a newline. That line as a holw is commonly referred to as a "shebang" line (https://en.wikipedia.org/wiki/Shebang_(Unix)). So to make a script executable you need to set its mode to executable and insert a 1st line that is an appropriate shebang. Examples:

    The only special thing here with respect to Python is the Python interpreter knows how to "run" a zip file and zipfiles allow arbitrary leading content to be inserted at the head of the zipfile; so Python scripts can be packaged as a zipfile and a PEX is a zipfile that leverages all this:

    Now, you may have noticed that the shebang is host-dependant in that you must know the exact absolute path to the script interpreter to run. In example 4, reliance on the path of the program is used so that the exact location of need not be known ( looks it up in the at runtime). Still though, this is fairly non-portable and depends on uniform paths with uniform meanings across machines. To stress the latter point, a given path could have two different meanings on different machines. The path could refer to a Python 3.6 interpreter on one machine and a Python 3.9 interpreter on another.

    You edged up on many of these points in your questions above, but I think the following should now be answered:

    • I think the intent was to allow this pex to work with multiple versions of python, what should the python-shebang value be?
      It needs to be the common denominator. If you build the PEX to run with various Python 3's, say 3.6 through 3.9, then you'd want a shebang of or .
    • Is the python-shebang mandatory? If so why?:
      Yes, since a PEX is just a zipapp and not a valid ELF, COFF, etc executable file.
    • What happens if you set the python-shebang to be python3 as opposed to /usr/local/bin/python3:
      The OS will reject a relative path for the shebang interpreter.
    • Is there a recommended value for python-shebang?
      Not when customizing - no. Since a shebang relies on the setup of a target machine, you need to take that into account when picking a custom shebang. When you let Pex pick the shebang, of course its pick should suffice.
    • If I'm putting requirements together to run this pex for an end user, does the user have to ensure the python-shebang matches their installation location?:
      Yes - sortof. The shebang must match a path on the target machine.

    The final question though has little to do with the shebang:

    • If they only have python39 installed, will it still work? If I set the shebang to python3 does that means it might still work as it launches any python3 environment so provided we're backward compatible it'll work?
      It depends. If the PEX includes platform-specific wheels, say , then it will not work. The and wheels installed in the PEX file will not be usable for Python 3.9 regardless of shebang.

    Resetting and explaining at a high level in sequence of execution:

    1. The shebang is required by the operating system and it is used to run the PEX zipfile.
    2. The PEX main is a bit of Pex code that 1st finds an appropriate interpreter to use if the current one selected by the shebang is not appropriate. If a new interpreter is selected, the PEX file is re-executed with that interpreter.
    3. The PEX main extracts all wheels installed inside the PEX file to the filesystem (under ~/.pex) and adds these locations to before handing off execution to user code.

    Currently step 2 only happens if you use to select interpreters when building the PEX. It does not happend when you use to select interpreters. Fixing that will come in #1020.

    Sours: https://github.com/pantsbuild/pex/issues/1095

    Only at school I was afraid of my math teacher, but this is a completely different matter. And what should I do now. - it was in my head - to score and go home or go to her apartment. But, I immediately remembered that Asiyat still has my passport.

    You will also like:

    In the end, she lay on the bed and cried for an hour. Finally, she cleared herself completely, made dinner and waited in fear for Tom to go home. When he entered the house, he met her quickly and then sat in his EZ chair and read the newspaper.



    585 586 587 588 589