Skip to content
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

Change OCIO_PYTHON_LOAD_DLLS_FROM_PATH to opt-in #2106

Merged
merged 2 commits into from
Dec 10, 2024
Merged

Change OCIO_PYTHON_LOAD_DLLS_FROM_PATH to opt-in #2106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e018d0
Fix Python wheel macOS workflow and make OCIO_PYTHON_LOAD_DLLS_FROM_P…
remia Dec 10, 2024
44b190b
Merge branch 'main' into fix-wheel-macos
doug-walker Dec 10, 2024
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
10 changes: 5 additions & 5 deletions .github/workflows/wheel_workflow.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ jobs:
platforms: all

- name: Build wheels
uses: pypa/cibuildwheel@v2.21.1
uses: pypa/cibuildwheel@v2.22.0
env:
CIBW_BUILD: ${{ matrix.python }}
CIBW_ARCHS: ${{ matrix.arch }}
Expand All @@ -192,7 +192,7 @@ jobs:

macos:
name: Build wheels on macOS
runs-on: macos-12
runs-on: macos-13
# Don't run on OCIO forks
if: |
github.event_name != 'schedule' ||
Expand Down Expand Up @@ -231,7 +231,7 @@ jobs:
python-version: '3.9'

- name: Build wheels
uses: pypa/cibuildwheel@v2.21.1
uses: pypa/cibuildwheel@v2.22.0
env:
CIBW_BUILD: ${{ matrix.python }}
CIBW_ARCHS: ${{ matrix.arch }}
Expand Down Expand Up @@ -286,7 +286,7 @@ jobs:
python-version: '3.9'

- name: Build wheels
uses: pypa/cibuildwheel@v2.21.1
uses: pypa/cibuildwheel@v2.22.0
env:
CIBW_BUILD: ${{ matrix.python }}
CIBW_ARCHS: ${{ matrix.arch }}
Expand Down Expand Up @@ -341,7 +341,7 @@ jobs:
python-version: '3.9'

- name: Build wheels
uses: pypa/cibuildwheel@v2.21.1
uses: pypa/cibuildwheel@v2.22.0
env:
CIBW_BUILD: ${{ matrix.python }}
CIBW_ARCHS: ${{ matrix.arch }}
Expand Down
8 changes: 4 additions & 4 deletions docs/quick_start/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Required components:
- CMake >= 3.14
- \*Expat >= 2.4.1 (XML parser for CDL/CLF/CTF)
- \*yaml-cpp >= 0.7.0 (YAML parser for Configs)
- \*Imath >= 3.0 (for half domain LUTs)
- \*Imath >= 3.1.1 (for half domain LUTs)
- \*pystring >= 1.1.3
- \*minizip-ng >= 3.0.7 (for config archiving)
- \*ZLIB >= 1.2.13 (for config archiving)
Expand All @@ -135,14 +135,14 @@ Optional OCIO functionality also depends on:

- \*Little CMS >= 2.2 (for ociobakelut ICC profile baking)
- \*OpenGL GLUT & GLEW (for ociodisplay)
- \*OpenEXR >= 3.0 (for apps including ocioconvert)
- OpenImageIO >= 2.1.9 (for apps including ocioconvert)
- \*OpenEXR >= 3.0.5 (for apps including ocioconvert)
- OpenImageIO >= 2.2.14 (for apps including ocioconvert)
- \*OpenFX >= 1.4 (for the OpenFX plug-ins)
- OpenShadingLanguage >= 1.11 (for the OSL unit tests)
- Doxygen (for the docs)
- NumPy (optionally used in the Python test suite)
- \*pybind11 >= 2.9.2 (for the Python binding)
- Python >= 2.7 (for the Python binding only)
- Python >= 3.7 (for the Python binding only)
- Python 3.7 - 3.9 (for building the documentation)

Building the documentation requires the following packages, available via PyPI:
Expand Down
10 changes: 6 additions & 4 deletions src/bindings/python/package/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,15 @@
# 2 - Checking that the directories exist and are not "."
# 3 - Add them to the DLL load path.
#
# The behavior described above is opt-out which means that it is activated by default.
# A user can opt-out and use the default behavior of Python 3.8+ by setting OCIO_PYTHON_LOAD_DLLS_FROM_PATH
# environment variable to 0.
# The behavior described above is opt-in which means that it is deactivated by default.
# A user can opt-in by setting OCIO_PYTHON_LOAD_DLLS_FROM_PATH environment variable to 1.
# Please note that OCIO 2.4.0 and earlier had this behavior opt-out but it was changed
# in 2.4.1 after it was found problematic in uncontrolled environment (causing segfault
# on PyOpenColorIO import) as well as for security reasons.
#

if sys.version_info >= (3, 8) and platform.system() == "Windows":
if os.getenv("OCIO_PYTHON_LOAD_DLLS_FROM_PATH", "1") == "1":
if os.getenv("OCIO_PYTHON_LOAD_DLLS_FROM_PATH", "0") == "1":
for path in os.getenv("PATH", "").split(os.pathsep):
if os.path.exists(path) and path != ".":
os.add_dll_directory(path)
Expand Down
Loading