uber / uber/h3-py

v4 error handling

Open
#243 1 comment 0 reactions 1 assignee View on GitHub

@ajfriend is already working on this.

Since May 25, 2022.

v4
Dominant language
Python
Stars
1k
Forks
144
Avg merge
7d 14h
Merged PRs (30d)
2

Description

We'd like to simplify the error checking and handling in h3-py v4 by:

  • doing fewer correctness tests in Python/Cython code (as long as that won't allow for segfaults), deferring those correctness tests to the user (with the idea that they'd know better when those checks are and are not necessary)
  • pass through the H3 core error values and messages, rather than using custom Python error types and messages

For the initial v4.0 release, we might do something simple like have only a single H3 error type (as opposed to a class hierarchy of errors) that can take on various messages, and might programmatically expose the H3 core error enum.

PRs or Issues providing examples to consider

  • #241

Contributor guide

Open the contributing guide

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.