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

doc: fix documented winmode argument default in ctypes CDLL classes. #19167

Merged
merged 4 commits into from
Nov 28, 2022

Conversation

carandraug
Copy link
Contributor

The default value for the winmode argument in the ctypes CDLL, OleDll, and WinDLL classes is None and not 0 as currently documented. These have different behaviours. None means ctypes default of LOAD_LIBRARY_SEARCH_DEFAULT_DIRS | LOAD_LIBRARY_SEARCH_DLL_LOAD_DIR while 0 means no LOAD_LIBRARY_SEARCH_* flag which defaults to Windows LoadLibrary behaviour.

I did read the contribution guidelines and started to describe an issue on the Python bug tracker but this seems to me like one of those trivial changes that are described as being exempt of that. Please let me know if I'm wrong.

The default value for the `winmode` argument in the ctypes CDLL,
OleDll, and WinDLL classes is `None` and not `0` and these have
different behaviours. `None` means ctypes default of
LOAD_LIBRARY_SEARCH_DEFAULT_DIRS | LOAD_LIBRARY_SEARCH_DLL_LOAD_DIR
while `0` means no LOAD_LIBRARY_SEARCH flag which defaults to
Windows `LoadLibrary` behaviour.
@the-knights-who-say-ni
Copy link

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

CLA Missing

Our records indicate the following people have not signed the CLA:

@carandraug

For legal reasons we need all the people listed to sign the CLA before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

If you have recently signed the CLA, please wait at least one business day
before our records are updated.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!

Doc/library/ctypes.rst Outdated Show resolved Hide resolved
@carandraug
Copy link
Contributor Author

The only check that this PR seems to be failing is that there's no # issue in title. I think this fix is trivial enough to receive the "skip issue" label (please correct me if I'm wrong). Can someone let me know what else is needed from me?

Doc/library/ctypes.rst Outdated Show resolved Hide resolved
Co-authored-by: Eryk Sun <eryksun@gmail.com>
@zooba zooba merged commit 6541798 into python:main Nov 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants