mirror of
https://github.com/ceph/ceph
synced 2026-08-02 07:03:18 +00:00
91de0e1933
Replace 'setup.py install' with 'pip install --use-pep517' to fix
Cython compilation failures and eliminate deprecation warnings.
Problem Statement:
The build process for Cython modules involves preprocessing .pyx files
(e.g., generating rbd_processed.pyx from rbd.pyx) and then cythonizing
with specific compiler_directives. The previous approach using separate
'setup.py build' and 'setup.py install' commands caused this failure:
```
Error compiling Cython file:
------------------------------------------------------------
...
"""
name = cstr(name, 'name')
cdef:
rados_ioctx_t _ioctx = convert_ioctx(ioctx)
char *_name = name
librbd_progress_fn_t _prog_cb = &no_op_progress_callback
^
------------------------------------------------------------
rbd_processed.pyx:781:44: Cannot assign type 'int (*)(uint64_t, uint64_t, void *) except? -1' to 'librbd_progress_fn_t'. Exception values are incompatible. Suggest adding 'noexcept' to type 'int (uint64_t, uint64_t, void *) except? -1'.
```
This occurs because:
1. 'setup.py build build_ext' successfully preprocesses and cythonizes
with compiler_directives from setup.py's cythonize() call
2. 'setup.py install' internally triggers a rebuild that:
- Regenerates the preprocessed .pyx files
- Re-runs cythonize() through Cython.Distutils.build_ext
- Does NOT apply the compiler_directives from setup.py
- Fails on the regenerated files missing required directives
New Options Explained:
`--use-pep517`:
Addresses deprecation warning:
```
DEPRECATION: Building 'rados' using the legacy setup.py bdist_wheel
mechanism, which will be removed in a future version. pip 25.3 will
enforce this behaviour change.
```
Uses the modern PEP 517 build backend which:
- Performs a single build pass with all compiler_directives applied
- Prevents the implicit rebuild that caused CompileError
- Future-proofs against pip 25.3+ which will require this
`--no-build-isolation`:
Ensures that environment variables set by CMake are respected:
- CC, LDSHARED (compiler toolchain)
- CPPFLAGS, LDFLAGS (compilation flags)
- CYTHON_BUILD_DIR, CEPH_LIBDIR (build paths)
Without this flag, pip would create an isolated build environment
that ignores these critical build settings.
`--no-deps`:
Prevents pip from attempting to install Python dependencies listed
in setup.py's install_requires. All dependencies are managed by
CMake and the distribution's package manager, not pip.
`--ignore-installed`:
Addresses installation error when DESTDIR is set:
```
ERROR: Could not install packages due to an OSError: [Errno 13]
Permission denied: '/usr/lib/python3/dist-packages/rados-2.0.0.egg-info'
OSError: [Errno 18] Invalid cross-device link:
'/usr/lib/python3/dist-packages/rados-2.0.0.egg-info' -> '/tmp/pip-uninstall-...'
```
This error occurs because pip detects an existing system installation
and tries to uninstall it before installing to DESTDIR. With
--ignore-installed, pip skips the uninstall step and directly installs
to the DESTDIR staging directory, which is the correct behavior for
packaging.
Removed Options:
`--install-layout=deb`:
This Debian-specific patch to 'setup.py install' is no longer needed.
Modern pip automatically detects the distribution and uses the correct
layout (dist-packages on Debian, site-packages on RPM distros).
`--single-version-externally-managed`:
This option was specific to 'setup.py install' to prevent egg
installation. With pip, this is handled automatically.
`--record /dev/null`:
No longer needed as pip manages installation records internally.
`egg_info --egg-base`:
Not needed with pip as metadata is generated automatically during
the build process.
Not added option:
`--root-user-action=ignore`: not added
In this change, we installing a python module using pip with
`fakeroot` before packaging it. But pip warned:
```
Error: WARNING: Running pip as the 'root' user can result in broken permissions and conflicting behavior with the system package manager. It is recommended to use a virtual environment instead: https://pip.pypa.io/warnings/venv
```
But we use fakeroot on purpose, this option could have been added to
silence this warning. But it is not available in all supported pip
versions. see
|
||
|---|---|---|
| .. | ||
| code_tests | ||
| FindPython | ||
| AddCephTest.cmake | ||
| BuildArrow.cmake | ||
| BuildBoost.cmake | ||
| Buildc-ares.cmake | ||
| BuildDPDK.cmake | ||
| BuildFIO.cmake | ||
| BuildISAL.cmake | ||
| BuildISALCrypto.cmake | ||
| BuildOpentelemetry.cmake | ||
| Buildpmdk.cmake | ||
| BuildQAT.cmake | ||
| BuildQATzip.cmake | ||
| BuildRocksDB.cmake | ||
| BuildSPDK.cmake | ||
| Builduadk.cmake | ||
| BuildUBBD.cmake | ||
| Builduring.cmake | ||
| BuildUtf8proc.cmake | ||
| BuildZstd.cmake | ||
| CephCheck_link.c | ||
| CephCheck_link.map | ||
| CephChecks.cmake | ||
| CheckCxxAtomic.cmake | ||
| CheckNasm.cmake | ||
| CPM.cmake | ||
| CTags.cmake | ||
| Distutils.cmake | ||
| Findaio.cmake | ||
| FindArrow.cmake | ||
| Findbabeltrace.cmake | ||
| FindBacktrace.cmake | ||
| Findblkid.cmake | ||
| Findc-ares.cmake | ||
| Findcap.cmake | ||
| FindCUnit.cmake | ||
| FindCython.cmake | ||
| FindDAOS.cmake | ||
| Finddaxctl.cmake | ||
| Finddml.cmake | ||
| Finddpdk.cmake | ||
| FindFUSE.cmake | ||
| FindGMock.cmake | ||
| Findgperftools.cmake | ||
| FindGSSApi.cmake | ||
| FindJeMalloc.cmake | ||
| Findkeyutils.cmake | ||
| Findlibcryptsetup.cmake | ||
| Findlibnbd.cmake | ||
| FindLinuxZNS.cmake | ||
| FindLMDB.cmake | ||
| FindLTTngUST.cmake | ||
| FindLZ4.cmake | ||
| FindMake.cmake | ||
| Findmotr.cmake | ||
| Findndctl.cmake | ||
| Findnl.cmake | ||
| FindNUMA.cmake | ||
| FindOATH.cmake | ||
| FindOpenLDAP.cmake | ||
| FindParquet.cmake | ||
| Findpmdk.cmake | ||
| FindPython3.cmake | ||
| FindQAT.cmake | ||
| FindQatDrv.cmake | ||
| FindQATzip.cmake | ||
| FindRabbitMQ.cmake | ||
| FindRDKafka.cmake | ||
| Findrdmacm.cmake | ||
| FindRocksDB.cmake | ||
| FindSanitizers.cmake | ||
| Findsnappy.cmake | ||
| FindSQLite3.cmake | ||
| FindStdFilesystem_test.cc | ||
| FindStdFilesystem.cmake | ||
| Findthrift.cmake | ||
| Findudev.cmake | ||
| Finduring.cmake | ||
| Findutf8proc.cmake | ||
| Finduuid.cmake | ||
| Findverbs.cmake | ||
| Findxfs.cmake | ||
| Findyaml-cpp.cmake | ||
| Findzbd.cmake | ||
| FindZstd.cmake | ||
| GetGitRevisionDescription.cmake | ||
| GetGitRevisionDescription.cmake.in | ||
| LimitJobs.cmake | ||
| patch-dpdk-conf.sh | ||
| SIMDExt.cmake | ||
