Add `throw` option to `Workflow.create_dispatch` to raise exceptions by dblanchette · Pull Request #2966 · PyGithub/PyGithub

dblanchette · 2024-05-07T18:55:55Z

When using Workflow.create_dispatch(), we only get a boolean response even though the GitHub API returns detailed error messages.

This adds an option to the method to throw exceptions with the error data when it fails.

We've been having issues with creating workflow dispatch with missing/too many arguments.

EnricoMi · 2024-05-21T08:49:07Z

See #2760 as the general design issue.

EnricoMi · 2024-05-21T08:51:27Z

Maybe we should add attribute throw: bool = False to create_dispatch, which when False exhibits the current (flawed) behaviour (return status == 204), and when set True calls into requestJsonAndCheck, which will raise errors when status is not 2xx.

In v3, throw will be set to True as the default (breaking change) and will eventually be removed.

ngc92 · 2025-01-14T13:55:33Z

this would have saved me quite a bit of time.

…-with-exception

dblanchette · 2025-01-27T15:28:13Z

Maybe we should add attribute throw: bool = False to create_dispatch, which when False exhibits the current (flawed) behaviour (return status == 204), and when set True calls into requestJsonAndCheck, which will raise errors when status is not 2xx.

In v3, throw will be set to True as the default (breaking change) and will eventually be removed.

I agree. The changes are made.

EnricoMi

Please merge _create_dispatch back into create_dispatch where only

self._requester.requestJsonAndCheck

is inside they try branch.

EnricoMi · 2025-02-03T20:44:41Z

github/Workflow.py

+            if throw:
+                raise
+            return False
+        return True


Shouldn't we still check for 202 status?

Suggested change

return True

return status == 204

The doc says the only possible return status is 204 https://docs.github.com/en/rest/actions/workflows?apiVersion=2022-11-28#create-a-workflow-dispatch-event

The status == 204 is for consistency with other methods.

github/Workflow.py

github-actions · 2025-02-26T16:13:27Z

Test Results

7 files ±0 7 suites ±0 2m 34s ⏱️ -5s
1 032 tests +1 1 032 ✅ +1 0 💤 ±0 0 ❌ ±0
11 529 runs +7 11 528 ✅ +7 1 💤 ±0 0 ❌ ±0

Results for commit 3c30ac0. ± Comparison against base commit 9e1c2bf.

♻️ This comment has been updated with latest results.

github/Workflow.py

EnricoMi

Happy to approve, please consider the suggestions.

Co-authored-by: Enrico Minack <github@enrico.minack.dev>

dblanchette · 2025-10-31T15:51:16Z

Happy to approve, please consider the suggestions.

@EnricoMi I applied the suggestions, is it all good?

EnricoMi

LGTM!

This PR contains the following updates: | Package | Change | [Age](https://docs.renovatebot.com/merge-confidence/) | [Confidence](https://docs.renovatebot.com/merge-confidence/) | |---|---|---|---| | [PyGithub](https://redirect.github.com/pygithub/pygithub) | `==2.8.1` → `==2.9.0` | ![age](https://developer.mend.io/api/mc/badges/age/pypi/pygithub/2.9.0?slim=true) | ![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/pygithub/2.8.1/2.9.0?slim=true) | | [pygithub](https://redirect.github.com/pygithub/pygithub) | `==2.8.1` → `==2.9.0` | ![age](https://developer.mend.io/api/mc/badges/age/pypi/pygithub/2.9.0?slim=true) | ![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/pygithub/2.8.1/2.9.0?slim=true) | --- ### Release Notes <details> <summary>pygithub/pygithub (PyGithub)</summary> ### [`v2.9.0`](https://redirect.github.com/PyGithub/PyGithub/releases/tag/v2.9.0) [Compare Source](https://redirect.github.com/pygithub/pygithub/compare/v2.8.1...v2.9.0) ##### Notable changes ##### Lazy PyGithub objects The notion of lazy objects has been added to some PyGithub classes in version 2.6.0. This release now makes all `CompletableGithubObject`s optionally lazy (if useful). See [PyGithub/PyGithub#3403](https://redirect.github.com/PyGithub/PyGithub/pull/3403) for a complete list. In lazy mode, getting a PyGithub object does not send a request to the GitHub API. Only accessing methods and properties sends the necessary requests to the GitHub API: ```python # Use lazy mode g = Github(auth=auth, lazy=True) # these method calls do not send requests to the GitHub API user = g.get_user("PyGithub") # get the user repo = user.get_repo("PyGithub") # get the user's repo pull = repo.get_pull(3403) # get a known pull request issue = pull.as_issue() # turn the pull request into an issue # these method and property calls send requests to Github API issue.create_reaction("rocket") # create a reaction created = repo.created_at # get property of lazy object repo # once a lazy object has been fetched, all properties are available (no more requests) licence = repo.license ``` All PyGithub classes that implement `CompletableGithubObject` support lazy mode (if useful). This is only useful for classes that have methods creating, changing, or getting objects. By default, PyGithub objects are not lazy. ##### PyGithub objects with a paginated property The GitHub API has the "feature" of paginated properties. Some objects returned by the API have a property that allows for pagination. Fetching subsequent pages of that property means fetching the entire object (with all other properties) and the specified page of the paginated property. Iterating over the paginated property means fetching all other properties multiple times. Fortunately, the allowed size of each page (`per_page` is usually 300, in contrast to the "usual" `per_page` maximum of 100). Objects with paginated properties: - Commit.files - Comparison.commits - EnterpriseConsumedLicenses.users This PR makes iterating those paginated properties use the configured `per_page` setting. It further allows to specify an individual `per_page` when either retrieving such objects, or fetching paginated properties. See [Classes with paginated properties](https://pygithub.readthedocs.io/en/stable/utilities.html#utilities-classes-with-paginated-properties) for details. ##### Drop Python 3.8 support due to End-of-Life Python 3.8 reached its end-of-life September 6, 2024. Support has been removed with this release. ##### Deprecations - Method `delete` of `Reaction` is deprecated, use `IssueComment.delete_reaction`, `PullRequestComment.delete_reaction`, `CommitComment.delete_reaction` or `Issue.delete_reaction` instead. - Method `Issue.assignee` and parameter `Issue.edit(assignee=…)` are deprecated, use `Issue.assignees` and `Issue.edit(assignees=…)` instead. - Method `Organization.edit_hook` is deprecated, use `Organization.get_hook(id).edit(…)` instead. If you need to avoid `Organization.get_hook(id)` to fetch the `Hook` object from Github API, use a lazy Github instance: ```python Github(…, lazy=True).get_organization(…).get_hook(id).edit(…) ``` - Methods `Team.add_to_members` and `Team.remove_from_members` are deprecated, use `Team.add_membership` or `Team.remove_membership` instead. ##### New Features - Consider per-page settings when iterating paginated properties by [@EnricoMi](https://redirect.github.com/EnricoMi) in [PyGithub/PyGithub#3377](https://redirect.github.com/PyGithub/PyGithub/pull/3377) - Add Secret Scanning Alerts and Improve Code Scan Alerts by [@matt-davis27](https://redirect.github.com/matt-davis27) in [PyGithub/PyGithub#3307](https://redirect.github.com/PyGithub/PyGithub/pull/3307) ##### Improvements - More lazy objects by [@EnricoMi](https://redirect.github.com/EnricoMi) in [PyGithub/PyGithub#3403](https://redirect.github.com/PyGithub/PyGithub/pull/3403) - Allow for enterprise base url prefixed with `api.` by [@EnricoMi](https://redirect.github.com/EnricoMi) in [PyGithub/PyGithub#3419](https://redirect.github.com/PyGithub/PyGithub/pull/3419) - Add `throw` option to `Workflow.create_dispatch` to raise exceptions by [@dblanchette](https://redirect.github.com/dblanchette) in [PyGithub/PyGithub#2966](https://redirect.github.com/PyGithub/PyGithub/pull/2966) - Use `GET` url or `_links.self` as object url by [@EnricoMi](https://redirect.github.com/EnricoMi) in [PyGithub/PyGithub#3421](https://redirect.github.com/PyGithub/PyGithub/pull/3421) - Add support for `type` parameter to get\_issues by [@nrysk](https://redirect.github.com/nrysk) in [PyGithub/PyGithub#3381](https://redirect.github.com/PyGithub/PyGithub/pull/3381) - Align implemented paths with OpenAPI spec by [@EnricoMi](https://redirect.github.com/EnricoMi) in [PyGithub/PyGithub#3413](https://redirect.github.com/PyGithub/PyGithub/pull/3413) - Add suggested OpenAPI schemas by [@EnricoMi](https://redirect.github.com/EnricoMi) in [PyGithub/PyGithub#3411](https://redirect.github.com/PyGithub/PyGithub/pull/3411) - Apply OpenAPI schemas by [@EnricoMi](https://redirect.github.com/EnricoMi) in [PyGithub/PyGithub#3412](https://redirect.github.com/PyGithub/PyGithub/pull/3412) ##### Bug Fixes - Fix `PaginatedList.totalCount` returning 0 with GitHub deprecation notices by [@odedperezcodes](https://redirect.github.com/odedperezcodes) in [PyGithub/PyGithub#3382](https://redirect.github.com/PyGithub/PyGithub/pull/3382) - Use default type if known type is not supported by [@EnricoMi](https://redirect.github.com/EnricoMi) in [PyGithub/PyGithub#3365](https://redirect.github.com/PyGithub/PyGithub/pull/3365) ##### Maintenance - Deprecate `Reaction.delete` by [@iarspider](https://redirect.github.com/iarspider) in [PyGithub/PyGithub#3435](https://redirect.github.com/PyGithub/PyGithub/pull/3435) - Deprecate `Issue.assignee` by [@EnricoMi](https://redirect.github.com/EnricoMi) in [PyGithub/PyGithub#3366](https://redirect.github.com/PyGithub/PyGithub/pull/3366) - Deprecate `Orginization.edit_hook` by [@EnricoMi](https://redirect.github.com/EnricoMi) in [PyGithub/PyGithub#3404](https://redirect.github.com/PyGithub/PyGithub/pull/3404) - Deprecate `Team.add_to_members` and `Team.remove_from_members` by [@EnricoMi](https://redirect.github.com/EnricoMi) in [PyGithub/PyGithub#3368](https://redirect.github.com/PyGithub/PyGithub/pull/3368) - Various minor OpenAPI fixes by [@EnricoMi](https://redirect.github.com/EnricoMi) in [PyGithub/PyGithub#3375](https://redirect.github.com/PyGithub/PyGithub/pull/3375) - Update test key pair by [@EnricoMi](https://redirect.github.com/EnricoMi) in [PyGithub/PyGithub#3453](https://redirect.github.com/PyGithub/PyGithub/pull/3453) - Pin CI lint Python version to 3.13 by [@EnricoMi](https://redirect.github.com/EnricoMi) in [PyGithub/PyGithub#3406](https://redirect.github.com/PyGithub/PyGithub/pull/3406) - Improve error message on replay data mismatch by [@EnricoMi](https://redirect.github.com/EnricoMi) in [PyGithub/PyGithub#3385](https://redirect.github.com/PyGithub/PyGithub/pull/3385) and [PyGithub/PyGithub#3386](https://redirect.github.com/PyGithub/PyGithub/pull/3386) - Disable sleeps in tests by [@EnricoMi](https://redirect.github.com/EnricoMi) in [PyGithub/PyGithub#3383](https://redirect.github.com/PyGithub/PyGithub/pull/3383) - Update autodoc defaults by [@Aidan-McNay](https://redirect.github.com/Aidan-McNay) in [PyGithub/PyGithub#3369](https://redirect.github.com/PyGithub/PyGithub/pull/3369) - Add Python 3.14 to CI and tox by [@EnricoMi](https://redirect.github.com/EnricoMi) in [PyGithub/PyGithub#3429](https://redirect.github.com/PyGithub/PyGithub/pull/3429) - Restrict PyPi release workflow permissions by [@JLLeitschuh](https://redirect.github.com/JLLeitschuh) in [PyGithub/PyGithub#3418](https://redirect.github.com/PyGithub/PyGithub/pull/3418) - Fix OpenApi workflow by [@EnricoMi](https://redirect.github.com/EnricoMi) in [PyGithub/PyGithub#3389](https://redirect.github.com/PyGithub/PyGithub/pull/3389) - Bump codecov/codecov-action from 3 to 5 by [@dependabot](https://redirect.github.com/dependabot)\[bot] in [PyGithub/PyGithub#3284](https://redirect.github.com/PyGithub/PyGithub/pull/3284) - Bump actions/setup-python from 5 to 6 by [@dependabot](https://redirect.github.com/dependabot)\[bot] in [PyGithub/PyGithub#3370](https://redirect.github.com/PyGithub/PyGithub/pull/3370) - Bump dawidd6/action-download-artifact from 3.0.0 to 3.1.4 by [@dependabot](https://redirect.github.com/dependabot)\[bot] in [PyGithub/PyGithub#3282](https://redirect.github.com/PyGithub/PyGithub/pull/3282) - Bump github/codeql-action from 3 to 4 by [@dependabot](https://redirect.github.com/dependabot)\[bot] in [PyGithub/PyGithub#3391](https://redirect.github.com/PyGithub/PyGithub/pull/3391) - Bump actions/upload-artifact from 4 to 5 by [@dependabot](https://redirect.github.com/dependabot)\[bot] in [PyGithub/PyGithub#3394](https://redirect.github.com/PyGithub/PyGithub/pull/3394) - Bump actions/download-artifact from 5 to 6 by [@dependabot](https://redirect.github.com/dependabot)\[bot] in [PyGithub/PyGithub#3393](https://redirect.github.com/PyGithub/PyGithub/pull/3393) - Drop Python 3.8 support due to EOL by [@hugovk](https://redirect.github.com/hugovk) in [PyGithub/PyGithub#3191](https://redirect.github.com/PyGithub/PyGithub/pull/3191) - Merge changelog updates from v2.8 release branch by [@EnricoMi](https://redirect.github.com/EnricoMi) in [PyGithub/PyGithub#3367](https://redirect.github.com/PyGithub/PyGithub/pull/3367) #### New Contributors - [@odedperezcodes](https://redirect.github.com/odedperezcodes) made their first contribution in [PyGithub/PyGithub#3382](https://redirect.github.com/PyGithub/PyGithub/pull/3382) - [@Aidan-McNay](https://redirect.github.com/Aidan-McNay) made their first contribution in [PyGithub/PyGithub#3369](https://redirect.github.com/PyGithub/PyGithub/pull/3369) - [@nrysk](https://redirect.github.com/nrysk) made their first contribution in [PyGithub/PyGithub#3381](https://redirect.github.com/PyGithub/PyGithub/pull/3381) - [@matt-davis27](https://redirect.github.com/matt-davis27) made their first contribution in [PyGithub/PyGithub#3307](https://redirect.github.com/PyGithub/PyGithub/pull/3307) **Full Changelog**: <PyGithub/PyGithub@v2.8.0...v2.9.0> </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/lettuce-financial/github-bot-signed-commit).

…2966) When using Workflow.create_dispatch(), we only get a boolean response even though the GitHub API returns detailed error messages. This adds an option to the method to throw exceptions with the error data when it fails. We've been having issues with creating workflow dispatch with missing/too many arguments. --------- Co-authored-by: Enrico Minack <github@enrico.minack.dev> Co-authored-by: EnricoMi <44700269+EnricoMi@users.noreply.github.com>

Add workflow create_dispatch method that raises exceptions

5fed9a5

This was referenced May 7, 2024

Add workflow create_dispatch method that raises exceptions #2965

Closed

when running workflow.create_dispatch , the class returns "False" without any explanation #2416

Open

github-actions bot added the ⭐ top pull request Top pull request. label Jan 15, 2025

github-actions bot mentioned this pull request Jan 15, 2025

Top Issues Dashboard #3050

Open

dblanchette added 3 commits January 24, 2025 17:22

Merge remote-tracking branch 'origin/main' into fix/workflow-dispatch…

b5bbc6d

…-with-exception

fix(ErrorHandling): Add throw parameter instead of a different function

00842f6

fix(ci): Fix a test

d3a4fd5

EnricoMi requested changes Feb 3, 2025

View reviewed changes

EnricoMi changed the title ~~Add workflow create_dispatch method that raises exceptions~~ Add throw option to Workflow.create_dispatch to raise exceptions Feb 3, 2025

EnricoMi reviewed Feb 3, 2025

View reviewed changes

github/Workflow.py Outdated Show resolved Hide resolved

dblanchette added 2 commits February 26, 2025 09:56

fix: Apply code review changes

ad2eeed

Merge branch 'main' into fix/workflow-dispatch-with-exception

89b9e36

fix: Fix test

ac0b6d1

dblanchette requested a review from EnricoMi February 26, 2025 18:15

EnricoMi reviewed Mar 17, 2025

View reviewed changes

github/Workflow.py Outdated Show resolved Hide resolved

github/Workflow.py Outdated Show resolved Hide resolved

EnricoMi reviewed Aug 14, 2025

View reviewed changes

github/Workflow.py Outdated Show resolved Hide resolved

EnricoMi requested changes Aug 14, 2025

View reviewed changes

EnricoMi added the improvement label Aug 14, 2025

dblanchette and others added 4 commits October 6, 2025 10:05

doc: Harmonize docstring

993fab8

Co-authored-by: Enrico Minack <github@enrico.minack.dev>

fix: Simplify request call

6f7c9a7

Co-authored-by: Enrico Minack <github@enrico.minack.dev>

Merge branch 'main' into fix/workflow-dispatch-with-exception

e7773e1

chore: Remove unused import

3c30ac0

dblanchette requested a review from EnricoMi October 30, 2025 14:01

EnricoMi approved these changes Jan 6, 2026

View reviewed changes

EnricoMi added this pull request to the merge queue Jan 6, 2026

Merged via the queue into PyGithub:main with commit 19e1c50 Jan 6, 2026
22 checks passed

Uh oh!

Conversation

dblanchette commented May 7, 2024 • edited by EnricoMi Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

EnricoMi commented May 21, 2024

Uh oh!

EnricoMi commented May 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ngc92 commented Jan 14, 2025

Uh oh!

dblanchette commented Jan 27, 2025

Uh oh!

EnricoMi left a comment

Choose a reason for hiding this comment

Uh oh!

EnricoMi Feb 3, 2025

Choose a reason for hiding this comment

Uh oh!

dblanchette Feb 26, 2025

Choose a reason for hiding this comment

Uh oh!

EnricoMi Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Feb 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

Uh oh!

Uh oh!

Uh oh!

EnricoMi left a comment

Choose a reason for hiding this comment

Uh oh!

dblanchette commented Oct 31, 2025

Uh oh!

EnricoMi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

dblanchette commented May 7, 2024 •

edited by EnricoMi

Loading

EnricoMi commented May 21, 2024 •

edited

Loading

github-actions bot commented Feb 26, 2025 •

edited

Loading