This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Freeze support documentation is misleading.
Type: Stage:
Components: Documentation Versions: Python 3.7, Python 3.6, Python 3.4, Python 3.5, Python 2.7
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Sridhar Iyer, Windson Yang, davin, docs@python, pitrou, samschott
Priority: normal Keywords:

Created on 2019-03-01 00:49 by Sridhar Iyer, last changed 2022-04-11 14:59 by admin.

Files
File name Uploaded Description Edit
run_server_min.py Sridhar Iyer, 2019-03-01 17:01 Python code to reproduce the issue.
Messages (4)
msg336881 - (view) Author: Sridhar Iyer (Sridhar Iyer) Date: 2019-03-01 00:49
The documentation on freeze_support listed on https://docs.python.org/3/library/multiprocessing.html need to be fixed

This mentions:
"Calling freeze_support() has no effect when invoked on any operating system other than Windows. In addition, if the module is being run normally by the Python interpreter on Windows (the program has not been frozen), then freeze_support() has no effect."

This is not true. Sklearn/tensorflow libraries tend to cause an infinite loop when frozen with pyinstaller (tested on python 3.6 on ubuntu 14.04). freeze_support is the only way to get around the situation and should be included before including any other module that includes a multiprocessing library (not just in main).
msg336885 - (view) Author: Windson Yang (Windson Yang) * Date: 2019-03-01 02:14
IIUC, your script (using Sklearn/tensorflow) will cause an infinite loop when building with pyinstaller. Would you mind upload an example script so I can try to reproduce it?
msg336932 - (view) Author: Sridhar Iyer (Sridhar Iyer) Date: 2019-03-01 17:01
Please find the attached python file where the issue is seen.
The cli to create an executable was:
$pyinstaller run_server_min.spec

Here are the contents of the file (this doesn't support multiple file uploads):
================
# -*- mode: python ; coding: utf-8 -*-

block_cipher = None


a = Analysis(['run_server_min.py'],
             pathex=['<PUT ABSOLUTE PATH OF ABOVE FILE HERE>'],
             binaries=[],
             datas=[],
             hiddenimports=['sklearn.neighbors.typedefs', 'sklearn.neighbors.quad_tree', 'sklearn.tree._utils', 'xgboost', 'xgboost.libpath'],
             hookspath=['pyhooks'],
             runtime_hooks=[],
             excludes=[],
             win_no_prefer_redirects=False,
             win_private_assemblies=False,
             cipher=block_cipher,
             noarchive=False)
pyz = PYZ(a.pure, a.zipped_data,
             cipher=block_cipher)
exe = EXE(pyz,
          a.scripts,
          a.binaries,
          a.zipfiles,
          a.datas,
          [],
          name='run_server_min',
          debug=False,
          bootloader_ignore_signals=False,
          strip=False,
          upx=False,
          runtime_tmpdir=None,
          console=True )
=========

$ pyinstaller run_server_min.spec
69 INFO: PyInstaller: 3.5.dev0+cb8d10af6
69 INFO: Python: 3.6.7
70 INFO: Platform: Linux-3.16.0-77-generic-x86_64-with-debian-jessie-sid
...

When your run ./dist/run_server_min that is generated, it'll spawn the process multiple times. The issue goes away when you add freeze_support on the top.
msg393809 - (view) Author: Sam Schott (samschott) Date: 2021-05-17 12:10
I think freeze_support becomes relevant always when the start method is spawn since `sys.executable` will point to the frozen app bundle instead of the Python interpreter. Spawn was historically only used on Windows (therefore the note in the docs) but now also is the default for macOS. The start method can of course also be set manually and it might therefore make more sense to specify the start method instead of the platform in the docs.
History
Date User Action Args
2022-04-11 14:59:11adminsetgithub: 80334
2021-05-17 12:10:25samschottsetnosy: + samschott
messages: + msg393809
2019-03-01 20:32:53brett.cannonsetnosy: + pitrou, davin
2019-03-01 17:01:12Sridhar Iyersetfiles: + run_server_min.py

messages: + msg336932
2019-03-01 02:14:29Windson Yangsetnosy: + Windson Yang
messages: + msg336885
2019-03-01 00:49:32Sridhar Iyercreate