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

update porting guide #96

Merged
merged 3 commits into from
Oct 29, 2024
Merged

Conversation

ngoldbaum
Copy link
Collaborator

Fixes #92.

Ping @ogrisel.

I added discussion about working with thread-unsafe tests and expanded the discussion about PyMutex and the critical section API to discuss the interaction with the GIL.

Also re-organized a little bit and changed the ToC hierarchy to make it flow better IMO.

Copy link
Member

@lysnikolaou lysnikolaou left a comment

Choose a reason for hiding this comment

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

Great work! This is a much needed explanation of thread-safety issues around testing.

I left a few copy-editing comments.

docs/porting.md Outdated Show resolved Hide resolved
docs/porting.md Outdated Show resolved Hide resolved
docs/porting.md Outdated Show resolved Hide resolved
docs/porting.md Outdated Show resolved Hide resolved
docs/porting.md Outdated Show resolved Hide resolved
docs/porting.md Outdated Show resolved Hide resolved
docs/porting.md Outdated Show resolved Hide resolved
docs/porting.md Outdated Show resolved Hide resolved
docs/porting.md Outdated Show resolved Hide resolved
docs/porting.md Outdated
thread-safe, please do not open issues asking to fix thread safety issues in
PyTest itself.

#### The `warnings` module is not thread safe
Copy link
Member

Choose a reason for hiding this comment

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

We should probably be consistent in using either thread safe or thread-safe. No preference on my side.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ended up going with "thread-safe" and "thread safety", which follows wikipedia's style.

@ngoldbaum ngoldbaum force-pushed the update-porting-guide branch from cb1f819 to ae17365 Compare October 18, 2024 19:53
Copy link
Member

@lysnikolaou lysnikolaou left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks @ngoldbaum!

@ngoldbaum ngoldbaum merged commit a09652e into Quansight-Labs:main Oct 29, 2024
2 checks passed
@rgommers rgommers added the documentation Improvements or additions to documentation label Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add discussion of pytest thread safety
3 participants