diff options
author | 2022-11-05 12:52:07 -0700 | |
---|---|---|
committer | 2022-11-05 12:52:07 -0700 | |
commit | efa1ef32d43ed0f94ff113f6fdd0cc088dc8e39f (patch) | |
tree | b8f47ab95148e5a3281e60d9372c30345ff6df18 /pydis_site | |
parent | Minor improvements to wording and layout (diff) |
Rewrote and added more info to python on ms store article
Diffstat (limited to 'pydis_site')
3 files changed, 56 insertions, 30 deletions
diff --git a/pydis_site/apps/content/resources/guides/python-guides/windows/_info.yml b/pydis_site/apps/content/resources/guides/python-guides/windows/_info.yml index 1bb00d29..96c8eb68 100644 --- a/pydis_site/apps/content/resources/guides/python-guides/windows/_info.yml +++ b/pydis_site/apps/content/resources/guides/python-guides/windows/_info.yml @@ -1,2 +1,2 @@ title: Python on Windows -description: Guides related to installing, managing, and troubleshooting Python on Windows +description: Guides related to installing, managing, and troubleshooting Python on Windows operating systems. diff --git a/pydis_site/apps/content/resources/guides/python-guides/windows/microsoft-store.md b/pydis_site/apps/content/resources/guides/python-guides/windows/microsoft-store.md index 8935163b..daa296de 100644 --- a/pydis_site/apps/content/resources/guides/python-guides/windows/microsoft-store.md +++ b/pydis_site/apps/content/resources/guides/python-guides/windows/microsoft-store.md @@ -1,36 +1,62 @@ --- -title: Why not to install Python from the Microsoft Store +title: Why NOT to install Python from the Microsoft Store description: This guide explains the issues with using Python installed from the Microsoft Store --- -Microsoft provides a Python app on the Microsoft Store as an alternative to -using the [Standard Installer](https://www.python.org/downloads/). We would -recommend that you use the standard installer instead wherever possible. +Microsoft provides versions of Python for Windows +[on the Microsoft Store](https://apps.microsoft.com/store/search/python) as an alternative to using the +[full installer from python.org](https://www.python.org/downloads). **We recommend you install Python on Windows using the +[full installer from python.org](https://www.python.org/downloads), +and not from the Microsoft store wherever possible!** + +You can follow [this guide to install Python from python.org](../install-on-windows.md) and more Python Windows releases +can be found [here](https://www.python.org/downloads/windows). Here are some common issues with using Python from the Microsoft Store: -* ##### Command line tools won't work - Most command line tools, like `black` or `pyinstaller`, won't work directly - (without specifying the full path, or invoking them as a module if they allow - it). This happens because they work by adding an executable to the `Scripts/` directory, - which isn't added to PATH on the Microsoft Store version of Python. - -* ##### It can cause issues with permissions - Some modules and scripts wont work with it because of restricted permissions. - This is explained - [in the Python documentation](https://docs.python.org/3/using/windows.html#redirection-of-local-data-registry-and-temporary-paths) - -* ##### It uses PATH inconsistently - `python.exe` isn't added to PATH, but `pip.exe` is. This makes it easy to have - an inconsistent `pip` and `python`. The `pip` is under the - `C:\Users\username\AppData\Local\Microsoft\WindowsApps` entry, which wouldn't - obviously have anything Python related in it. If you add your normal Python - install path below this one, it's `pip` will be overridden by the `WindowsApps` - one but the `python` one wont as it's overwriting the app execution alias. - -* ##### Confusing App Execution Alias Behaviour - The usage of app execution aliases is confusing. If you use the online - installer and for get to tick the box to to add to path, when you try and use - `python`, you either get no output or the Microsoft Store opens. This hides the - command not found error which would have indicated that their install didn't - work as expected. +- ##### Command line tools won't work + + Most command line tools, like [`black`](https://pypi.org/project/black/) or + [`pyinstaller`](https://pypi.org/project/pyinstaller/), won't work directly (without specifying the full path, or + invoking them as a module if they allow it). This happens because they normally work by adding an executable to the + `\Scripts` directory, which isn't added to Path on the Microsoft Store version of Python. + +- ##### It can cause issues with permissions + + Some modules and scripts wont work with it because of restricted permissions. + This is explained + [in the Python documentation](https://docs.python.org/3/using/windows.html#redirection-of-local-data-registry-and-temporary-paths) + +- ##### It can cause Path confusion + + Path is the Windows environment variable that determine what programs run when you type commands in terminals. + (Actually there are two Paths, a user one and a system one that has precedence, but they get [combined when + used](https://superuser.com/a/878382/935845).) With Python from the Microsoft Store installed, your `python`, `py`, + and `pip` commands may get mixed up with the python.org ones, depending on the order and contents of Path. + + The Path entry for the Microsoft Store is `C:\Users\<user>\AppData\Local\Microsoft\WindowsApps`. The entries for the + full python.org install are commonly `C:\Users\<user>\AppData\Local\Programs\Python\Python311` and + `C:\Users\<user>\AppData\Local\Programs\Python\Python311\Scripts` (for Python 3.11). If for some reason you want + both installed, put the ones you want the commands for higher up in Path. + +- ##### Confusing app execution alias behaviour + + Typing `python` into a terminal when it is not already installed or not properly on Path may open up the Microsoft + Store to the Python app, pushing you to install it and confusingly hiding the command not found error that would + normally happen. + + You can change this behavior by searching "Manage app execution aliases" in the Start menu and toggling off "App + Installer" for python.exe and python3.exe. + +- #### You can't specify or easily see the patch version + + The Microsoft Store Python versions are listed simply like 3.10 rather than 3.10.8 even though it may be 3.10.8 + under the hood. It's uncommon, but if you know you need a different patch version ([aka micro + version](https://peps.python.org/pep-0440/#final-releases)), e.g. 3.10.7, you'll need to [install from + python.org](https://www.python.org/downloads/windows/). + +If you have the Microsoft Store version of Python and want to uninstall it, you can search "uninstall" in the Start menu +to open up the "Apps & features" settings and filter by "python". The Python app that has a console in the icon and +"Python Software Foundation" under the name is the Microsoft Store one (see image below). Click it and hit Uninstall. + + diff --git a/pydis_site/static/images/content/python-on-windows/ms_store_uninstall.png b/pydis_site/static/images/content/python-on-windows/ms_store_uninstall.png Binary files differnew file mode 100644 index 00000000..40ee954c --- /dev/null +++ b/pydis_site/static/images/content/python-on-windows/ms_store_uninstall.png |