bpo-33591: Fix CDLL to accept PathLike objects #7032

mrh1997 · 2018-05-21T14:01:50Z

CDLL (and WinDLL, OleDLL, ...) accept now not only str objects but also PathLike objects.

https://bugs.python.org/issue33591

the-knights-who-say-ni · 2018-05-21T14:01:52Z

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA).

Unfortunately our records indicate you have not signed the CLA. For legal reasons we need you to sign this before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

When your account is ready, please add a comment in this pull request
and a Python core developer will remove the CLA not signed label
to make the bot check again.

Thanks again to your contribution and we look forward to looking at it!

mrh1997 · 2018-05-21T17:04:04Z

I signed the CLA (my bugtracker name is "mrh1997").
Please remove the "CLA not signed label"

Due to issue23606 (find msvct does not work any more) test_load did not work any more, as it used MSVCRT for testing DLL loading. Now it uses _ctypes_test library, which is explicitly generated for testing purposes.

CDLL accepts now not only paths of type 'str' but also of type PathLike (like Path()).

JelleZijlstra

I'm sorry this PR took so long to review. I dug it up from page 57 of the open PR list, but I think it's pretty close to ready.

I do have some comments:

https://docs.python.org/3.10/library/ctypes.html#ctypes.CDLL should have a "versionchanged" notice saying that starting in version 3.11, PathLike objects are also supported. A similar example note is the one in https://docs.python.org/3.10/library/shutil.html#shutil.move for 3.9. The note should also be added to the other *DLL classes.
I'd suggest rewording the NEWS entry as:

:class:`ctypes.CDLL`, :class:`ctypes.OleDLL`, :class:`ctypes.WinDLL`,
and :class:`ctypes.PyDLL` now accept :term:`path-like objects
<path-like object>` as their ``name`` argument. Patch by Robert Hoelzl.

Lib/ctypes/test/test_loading.py

iritkatriel

This has merge conflicts now.

bedevere-bot · 2022-11-27T21:25:57Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

cpython-cla-bot · 2023-02-03T17:44:23Z

All commit authors signed the Contributor License Agreement.

arhadthedev · 2023-02-03T17:49:52Z

@mrh1997 Could you sign the new CLA by clicking not signed button in the cpython-cla-bot's message, please?

No longer has merge conflicts

arhadthedev · 2023-02-03T18:21:23Z

Non-Linux tests failed with the following error:

======================================================================
ERROR: test_load (test.test_ctypes.test_loading.LoaderTest.test_load)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "D:\a\cpython\cpython\Lib\test\test_ctypes\test_loading.py", line 44, in test_load
    CDLL(CTypesTestPathLikeCls())
  File "D:\a\cpython\cpython\Lib\ctypes\__init__.py", line 367, in __init__
    if '/' in name or '\\' in name:
       ^^^^^^^^^^^
TypeError: argument of type 'CTypesTestPathLikeCls' is not iterable

I'm investigating it.

arhadthedev · 2023-02-03T18:37:29Z

Fixed; there were two missed lines that continued to use name function argument directly instead of stringified self._name.

Lib/ctypes/__init__.py

bedevere-bot · 2023-02-05T10:09:31Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

arhadthedev · 2023-02-05T11:38:02Z

I have made the requested changes; please review again.

the-knights-who-say-ni added the CLA not signed label May 21, 2018

bedevere-bot added the awaiting review label May 21, 2018

mrh1997 force-pushed the fix-issue-33591 branch 3 times, most recently from 7970e84 to abe38c6 Compare May 21, 2018 16:37

mrh1997 force-pushed the fix-issue-33591 branch from abe38c6 to 1c1642e Compare May 22, 2018 09:55

the-knights-who-say-ni added CLA signed and removed CLA not signed labels May 22, 2018

mrh1997 force-pushed the fix-issue-33591 branch 2 times, most recently from 1c1642e to 461bc92 Compare June 1, 2018 22:10

mrh1997 added 2 commits June 2, 2018 00:52

On windows ctypes.test.test_loading.test_load was always skipped

f9e65fd

Due to issue23606 (find msvct does not work any more) test_load did not work any more, as it used MSVCRT for testing DLL loading. Now it uses _ctypes_test library, which is explicitly generated for testing purposes.

bpo-33591: Fix CDLL to accept PathLike objects

73fd01c

CDLL accepts now not only paths of type 'str' but also of type PathLike (like Path()).

mrh1997 force-pushed the fix-issue-33591 branch from 461bc92 to f9e65fd Compare June 1, 2018 22:54

JelleZijlstra requested changes Jan 24, 2022

View changes

Lib/ctypes/test/test_loading.py Outdated Show resolved Hide resolved

bedevere-bot added awaiting core review and removed awaiting review labels Jan 24, 2022

ezio-melotti removed the CLA signed label Jul 13, 2022

iritkatriel previously requested changes Nov 27, 2022

View changes

bedevere-bot added awaiting changes and removed awaiting core review labels Nov 27, 2022

arhadthedev added 2 commits February 3, 2023 21:19

Merge branch 'main' into fix-issue-33591

bfff674

Address the review

cf03812

arhadthedev added expert-ctypes stdlib Python modules in the Lib dir labels Feb 3, 2023

arhadthedev requested a review from JelleZijlstra February 3, 2023 17:50

AlexWaygood added awaiting change review and removed awaiting changes labels Feb 3, 2023

Port the NEWS entry to GitHub numbering

bd48fb8

Fix the failing tests (by not using the raw name argument anymore)

cccd41d

kumaraditya303 reviewed Feb 4, 2023

View changes

Lib/ctypes/__init__.py Outdated Show resolved Hide resolved

arhadthedev added 2 commits February 4, 2023 09:57

Reassign _os.fspath(name) back to name

ea1eae5

Move self._name to the end

d3fdfd4

kumaraditya303 requested changes Feb 5, 2023

View changes

Lib/ctypes/__init__.py Show resolved Hide resolved

bedevere-bot added awaiting changes and removed awaiting change review labels Feb 5, 2023

kumaraditya303 self-assigned this Feb 5, 2023

Move self._name = name to the top

373be1d

arhadthedev requested a review from kumaraditya303 February 5, 2023 11:39

kumaraditya303 approved these changes Feb 5, 2023

View changes

bedevere-bot added awaiting merge and removed awaiting changes labels Feb 5, 2023

kumaraditya303 merged commit f7e9fba into python:main Feb 5, 2023
17 checks passed

bedevere-bot removed the awaiting merge label Feb 5, 2023

mrh1997 mannequin mentioned this pull request Apr 10, 2022

ctypes does not support fspath protocol #77772

Closed

bpo-33591: Fix CDLL to accept PathLike objects #7032

bpo-33591: Fix CDLL to accept PathLike objects #7032

mrh1997 commented May 21, 2018 •

edited by bedevere-bot

the-knights-who-say-ni commented May 21, 2018

mrh1997 commented May 21, 2018

JelleZijlstra left a comment

iritkatriel left a comment

bedevere-bot commented Nov 27, 2022

cpython-cla-bot bot commented Feb 3, 2023 •

edited

arhadthedev commented Feb 3, 2023 •

edited

arhadthedev commented Feb 3, 2023

arhadthedev commented Feb 3, 2023

bedevere-bot commented Feb 5, 2023

arhadthedev commented Feb 5, 2023

bpo-33591: Fix CDLL to accept PathLike objects #7032

bpo-33591: Fix CDLL to accept PathLike objects #7032

Conversation

mrh1997 commented May 21, 2018 • edited by bedevere-bot

the-knights-who-say-ni commented May 21, 2018

mrh1997 commented May 21, 2018

JelleZijlstra left a comment

Choose a reason for hiding this comment

iritkatriel left a comment

Choose a reason for hiding this comment

bedevere-bot commented Nov 27, 2022

cpython-cla-bot bot commented Feb 3, 2023 • edited

arhadthedev commented Feb 3, 2023 • edited

arhadthedev commented Feb 3, 2023

arhadthedev commented Feb 3, 2023

bedevere-bot commented Feb 5, 2023

arhadthedev commented Feb 5, 2023

mrh1997 commented May 21, 2018 •

edited by bedevere-bot

cpython-cla-bot bot commented Feb 3, 2023 •

edited

arhadthedev commented Feb 3, 2023 •

edited