pyiron / pyiron/executorlib

[Documentation] Document the error handling of the standard library

Open
#581 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
77
Forks
7
Avg merge
10h 32m
Merged PRs (30d)
12

Description

The following example executes fine without raising an error:

from concurrent.futures import ProcessPoolExecutor


def raise_error():
    raise ValueError()

if __name__ == "__main__":
    with ProcessPoolExecutor() as exe:
        fs = exe.submit(raise_error)
        print(fs.done())
        print(fs.exception() is not None)
        # print(fs.result())
    print("done")

Only, when the fs.result() call is not commented out, then the ValueError() is raised. The print out here is False, True, done.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the ProcessPoolExecutor example in the issue and inspect the repository's existing documentation structure to find the appropriate location. Document when the submitted exception is exposed through Future.exception() versus raised by Future.result(), including the observed output and behavior shown in the example.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.