diff options
| author | Christian Tismer <tismer@stackless.com> | 2023-01-13 11:38:40 +0100 |
|---|---|---|
| committer | Christian Tismer <tismer@stackless.com> | 2023-01-17 15:07:14 +0100 |
| commit | ee35c071ed8493cc5e3a80f19d9e2c2348160d56 (patch) | |
| tree | c753d9252e8f5460ad41e637ba6d48093b55a754 /sources/pyside6/doc/developer/extras.rst | |
| parent | 6626277ee7337fc71b4d76e494927d9a764ef4a0 (diff) | |
shiboken: optionally de-virtualize the Python files
The Python files in Shiboken are completely virtualized. That
means: There is no interaction with the external world that
could create interferences.
For debugging purposes or to modify the embedded files, it
is anyway useful to have an option to materialize these files
in the file system, again.
We add an environment variable `SBK_EMBED` that explicitly
unpacks the Python files (SBK_EMBED=0) or explicitly removes
the unpacked files (SBK_EMBED=1).
Without this variable, the state of embedding remains the same.
Change-Id: I1081b0f910482fb4b80a02f72c6bcce060db38e6
Fixes: PYSIDE-1994
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/pyside6/doc/developer/extras.rst')
| -rw-r--r-- | sources/pyside6/doc/developer/extras.rst | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/sources/pyside6/doc/developer/extras.rst b/sources/pyside6/doc/developer/extras.rst index 6b34ea4db..eb668712a 100644 --- a/sources/pyside6/doc/developer/extras.rst +++ b/sources/pyside6/doc/developer/extras.rst @@ -22,3 +22,20 @@ Build on the command line ========================= - Consider using ``build_scripts/qp5_tool.py``. + +De-Virtualize the Python Files +============================== + +The Python files in the Shiboken module are completely virtual, i.E. +they are nowhere existent in the file system for security reasons. + +For debugging purposes or to change something, it might be desirable +to move these files into the normal file system, again. + +- Setting the environment variable "SBK_EMBED" once to false unpacks these + files when PySide6 or shiboken6 are imported. The files are written + into "side-packages/shiboken6/files.dir" and are used from then on. + +- Setting the variable to true removes "files.dir". + +- Without the "SBK_EMBED" variable, the embedding status remains sticky. |