Skip to content

Add note about limitation of the plugin. #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gipi wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add note about limitation of the plugin. #119

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f58aac3
Add note about limitation of the plugin.
gipi Apr 8, 2023
b4ceb7b
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,23 @@ This will prevent a real subprocess execution.
assert process.returncode == 0


**Note:** because of the way the mechanism is implemented, in order for this
plugin to be able to "fake" ``Popen()``, your code needs to use it directly
from the ``subprocess`` module and not by direct import, i.e. your implementation
must be something like

.. code-block:: python

import subprocess


def my_function(*args):
...
proc = subprocess.Popen(CMDLINE)
...



Table of contents
-----------------

Expand Down