Thanks to visit codestin.com
Credit goes to github.com

Skip to content

gh-126615: Make COMError public and add to ctypes doc. #126686

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.

Sign up for GitHub

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

Merged
encukou merged 20 commits into from
Nov 20, 2024
Merged

gh-126615: Make COMError public and add to ctypes doc. #126686

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
e70aa54
add `COMError` exception to `Doc/library/ctypes.rst`.
junkmd Nov 16, 2024
181f512
Add a mention of the difference in exceptions that can be raised.
junkmd Nov 16, 2024
857fef5
Add a dot to refer to the object within the same module.
junkmd Nov 16, 2024
90fb47f
Simplify descriptions of attributes.
junkmd Nov 16, 2024
1f9d4ee
Align with the docstring defined in the C implementation:
junkmd Nov 16, 2024
b71e310
Apply suggestions from code review
junkmd Nov 16, 2024
dafb5b2
Add the dot to make the reflink.
junkmd Nov 16, 2024
49d5e5f
Add the `availability`.
junkmd Nov 16, 2024
1fa159a
Create the "Exceptions" section.
junkmd Nov 16, 2024
934c36a
Remove the `availability` directive
junkmd Nov 16, 2024
9461642
`WindowsError` -> `OSError`
junkmd Nov 18, 2024
705ffcc
details of `details`.
junkmd Nov 18, 2024
b5a2170
Small fix.
junkmd Nov 18, 2024
a16f1e2
Make `COMError` public.
junkmd Nov 19, 2024
e2617f3
Update docs.
junkmd Nov 19, 2024
57d76c5
Update `test_COMError`.
junkmd Nov 19, 2024
36f1607
Update the NEWS.
junkmd Nov 20, 2024
068ea2a
`.. versionchanged::` -> `.. versionadded::`
junkmd Nov 20, 2024
3da9e15
Update the `prototype` section.
junkmd Nov 20, 2024
920bccc
Merge branch 'main' into gh_126615_comerror_doc
junkmd Nov 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update docs.
  • Loading branch information
@junkmd
junkmd committed Nov 19, 2024
commit e2617f3aa2eaf05c6cb052d1e12ca14d516c77bf
8 changes: 6 additions & 2 deletions Doc/library/ctypes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2754,8 +2754,7 @@ Exceptions

.. exception:: COMError(hresult, text, details)

Windows only: This non-public exception is raised when a COM method call
failed.
Windows only: This exception is raised when a COM method call failed.

.. attribute:: hresult

Expand All @@ -2774,3 +2773,8 @@ Exceptions
is the path of the help file. *helpcontext* is the help context
identifier. *progid* is the ``ProgID`` of the interface that defined the
error.

.. versionchanged:: 3.14

This exception is now public.
Previously, this was private and only available in ``_ctypes``.
Copy link
Copy Markdown
Member

@encukou encukou Nov 20, 2024

Choose a reason for hiding this comment

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

Let's not expose private API in the docs.

Suggested change
.. versionchanged:: 3.14
This exception is now public.
Previously, this was private and only available in ``_ctypes``.
.. versionadded:: next

Copy link
Copy Markdown
Contributor Author

@junkmd junkmd Nov 20, 2024

Choose a reason for hiding this comment

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

You’re right, this information isn’t particularly useful in the documentation.

I’ll move it to the NEWS file as a supplement.

3 changes: 3 additions & 0 deletions Doc/whatsnew/3.14.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,9 @@ ctypes
to help match a non-default ABI.
(Contributed by Petr Viktorin in :gh:`97702`.)

* The :exc:`~ctypes.COMError` exception is now public.
(Contributed by Jun Komoda in :gh:`126686`.)

decimal
-------

Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Library/2024-11-19-14-34-05.gh-issue-126615.LOskwi.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The :exc:`~ctypes.COMError` exception is now public.