forked from apache/cassandra-python-driver
-
Notifications
You must be signed in to change notification settings - Fork 50
tests: detect stale Cython .so files at test startup #756
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.
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
mykaul
wants to merge
2
commits into
scylladb:master
Choose a base branch
from
mykaul:fix/detect-stale-cython-extensions
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| # Copyright ScyllaDB, Inc. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| import importlib.machinery | ||
| import os | ||
| import warnings | ||
|
|
||
| # Directory containing the Cython-compiled driver modules. | ||
| _CASSANDRA_DIR = os.path.join(os.path.dirname(__file__), os.pardir, "cassandra") | ||
|
|
||
|
|
||
| def pytest_configure(config): | ||
| """Warn when a compiled Cython extension is older than its .py source. | ||
|
|
||
| Python's import system prefers compiled extensions (.so / .pyd) over pure | ||
| Python (.py) files. If a developer edits a .py file without rebuilding | ||
| the Cython extensions (``python setup.py build_ext --inplace``), the tests | ||
| will silently run the *old* compiled code, masking any regressions in the | ||
| Python source. | ||
|
|
||
| This hook detects such staleness at test-session startup so the developer | ||
| is alerted immediately. | ||
| """ | ||
| stale = [] | ||
| # Iterate over .py sources and, for each module, look for the first | ||
| # existing compiled extension in EXTENSION_SUFFIXES order. This mirrors | ||
| # how Python's import machinery selects an extension module, and avoids | ||
| # globbing patterns like "*{suffix}" that can pick up ABI-tagged | ||
| # extensions built for other Python versions. | ||
| if os.path.isdir(_CASSANDRA_DIR): | ||
| for entry in os.listdir(_CASSANDRA_DIR): | ||
| if not entry.endswith(".py"): | ||
| continue | ||
| module_name, _ = os.path.splitext(entry) | ||
| py_path = os.path.join(_CASSANDRA_DIR, entry) | ||
| # For this module, find the first extension file Python would load. | ||
| for suffix in importlib.machinery.EXTENSION_SUFFIXES: | ||
| ext_path = os.path.join(_CASSANDRA_DIR, module_name + suffix) | ||
| if not os.path.exists(ext_path): | ||
| continue | ||
| if os.path.getmtime(py_path) > os.path.getmtime(ext_path): | ||
| stale.append((module_name, ext_path, py_path)) | ||
| # Only consider the first matching suffix; this is the one | ||
| # the import system would actually use. | ||
| break | ||
|
|
||
| if stale: | ||
| names = ", ".join(m for m, _, _ in stale) | ||
| warnings.warn( | ||
| f"Stale Cython extension(s) detected: {names}. " | ||
| f"The .py source is newer than the compiled extension — tests " | ||
| f"will run the OLD compiled code, not your latest changes. " | ||
| f"Rebuild with: python setup.py build_ext --inplace", | ||
| stacklevel=1, | ||
| ) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.