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.

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

Require Cython >= 0.29.14 to avoid tp_print problem on Read the Docs #2753

Merged
merged 2 commits into from
May 2, 2023

Conversation

heplesser
Copy link
Contributor

a4673ce broke sphinx_rtd testing. This PR fixes that.

Python 3.9 removed tp_print deep in the system, which requires extra care on Cython's part when handling different Python versions. This is only handled properly from 0.29.14 onwards (https://cython.readthedocs.io/en/latest/src/changes.html#id106), so this PR hikes that requirement. Otherwise, sphinx_rtd tests fail because Cython cannot be built, see, e.g., https://github.com/nest/nest-simulator/actions/runs/4831505004/jobs/8609059706?pr=2749#step:4:845

What was anyways the rationale behind fixing all packages to exact versions? When should they be updated?

@heplesser heplesser added T: Bug Wrong statements in the code or documentation S: Critical Needs to be addressed immediately I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Apr 28, 2023
@heplesser heplesser requested review from jougs and Helveg April 28, 2023 20:55
@Helveg
Copy link
Contributor

Helveg commented Apr 29, 2023

The rationale is the RTD environment, it supports only Python 3.8, and the first packages have started appearing whose bleeding edge versions are incompatible with Python 3.8

Our docs/requirements.txt, when pinned, don't need to be updated, until we decide to change vendor, or when RTD supports a newer environment and we want to utilize it.

Copy link
Contributor

@Helveg Helveg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great!

Copy link
Contributor

@jougs jougs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly fine by me. See comment.

doc/requirements.txt Outdated Show resolved Hide resolved
Co-authored-by: Jochen Martin Eppler <jougs@gmx.net>
Copy link
Contributor

@jougs jougs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@jougs jougs merged commit c113aa3 into nest:master May 2, 2023
18 checks passed
@jougs jougs changed the title Require Cython >= 0.29.14 to avoid tp_print problem Require Cython >= 0.29.14 to avoid tp_print problem on Read the Docs May 2, 2023
@heplesser heplesser deleted the fix_cython_version branch September 15, 2023 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Critical Needs to be addressed immediately T: Bug Wrong statements in the code or documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants