python / python/cpython

Allow passing creationflags to `multiprocessing` Process implementations to be used to set process creation flags on Windows

Open
#140,970 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

OS-windows stdlib topic-multiprocessing type-feature
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

Feature or enhancement

Proposal:

On Windows, there are various process creation flags that control the behavior of spawned processes that can control important behavior such as whether they can receive interrupt signals (and who can send them interrupt signals). A common flag to pass to child process on Windows is CREATE_NEW_PROCESS_GROUP as that allows the child process to receive signals (Ctrl+Break) from the parent process without requiring those signals to be sent to all processes in the console group. Without CREATE_NEW_PROCESS_GROUP, the only way to send an interrupt to a child process on Windows is to send Ctrl+C to all processes in the current console group (creating a new console group is another creationflags option) which would potentially include the current process and one or more parents that may not gracefully handle the interrupt.

The low level subprocess.Popen API includes an optional creationflags argument that is passed to the internal _winapi.CreateProcess call that spawns the actual child process (a ValueError is raised if creationflags is set on a posix OS). I'd like to propose implementing the same behavior in multiprocessing.process.BaseProcess (or in the win32 implementation of multiprocessing.context.SpawnProcess). Accept an optional creationflags member that can be set with a Windows creation flag when running on win32 and apply that value in the call to _winapi.CreateProcess in multiprocessing.popen_spawn_win32.Popen.

This would be a relatively minor API change, but would give much greater control over sub-process behavior on Windows when using the multiprocessing APIs, including better ability to signal spawned processes.

class BaseProcess(object):
    '''
    Process objects represent activity that is run in a separate process

    The class is analogous to `threading.Thread`
    '''
    def _Popen(self):
        raise NotImplementedError

    def __init__(self, group=None, target=None, name=None, args=(), kwargs=None,
                 *, daemon=None, creationflags=0):
        # omitting existing code
        self.creationflags = creationflags

    @property
    def creationflags(self):
        return self._creationflags

    @creationflags.setter
    def creationflags(self, creationflags):
        # Match the behavior of subprocess.Popen creationflags
        assert isinstance(creationflags, int), 'creationflags must be an integer'
        assert creationflags == 0 or sys.platform == 'win32', "creationflags is only supported on Windows platforms"
        self._creationflags = creationflags
class Popen(object):
    '''
    Start a subprocess to run the code of a process object
    '''
    method = 'spawn'

    def __init__(self, process_obj):
        # omitting existing code
        hp, ht, pid, tid = _winapi.CreateProcess(
                    python_exe, cmd,
                    None, None, False, process_obj.creationflags, env, None,
                    STARTUPINFO(dwFlags=STARTF_FORCEOFFFEEDBACK))
Has this already been discussed elsewhere?

This is a minor feature, which does not need previous discussion elsewhere

Links to previous discussion of this feature:

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with multiprocessing.process.BaseProcess or the Windows SpawnProcess implementation, then follow how multiprocessing.popen_spawn_win32.Popen calls _winapi.CreateProcess. Check how subprocess.Popen validates creationflags on Windows and POSIX, and verify that the requested flag reaches Windows-created child processes while non-Windows behavior remains rejected.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
operating-systems
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.