Skip to content

Document AppFramework Python interception settings #768

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
sylvesterkaczmarek wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document AppFramework Python interception settings #768

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 11 additions & 1 deletion source/standalone_examples/api/omni.kit.app/app_framework.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,13 @@
# See the License for the specific language governing permissions and
# limitations under the License.

"""Demonstrate AppFramework usage for running asynchronous Kit applications."""
"""Demonstrate AppFramework usage for running asynchronous Kit applications.

Kit intercepts ``sys.stdout``/``sys.stderr`` and ``sys.exit`` by default. This is useful for
normal Kit applications, but it can interfere with notebook output capture and Python tooling.
Set ``/app/python/interceptSysStdOutput`` and ``/app/python/interceptSysExit`` to ``false``
when the host Python environment should retain ownership of those objects.
"""

import asyncio
import os
Expand All @@ -27,6 +33,10 @@
"--no-window",
"--/app/asyncRendering=False",
"--/app/fastShutdown=True",
# Uncomment these when embedding Kit in an environment that must preserve
# Python's original stdout/stderr streams and sys.exit behavior, such as Jupyter.
# "--/app/python/interceptSysStdOutput=false",
# "--/app/python/interceptSysExit=false",
"--enable",
"omni.usd",
"--enable",
Expand Down