PyO3/pyo3

Review conversions and ensure consistency

Open

#3,226 opened on Jun 11, 2023

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Rust (10,152 stars) (668 forks)batch import
Good First Issue

Description

Continued from https://github.com/PyO3/pyo3/pull/3197#discussion_r1225910628

We would like to ensure that we're consistent in how conversions from Python objects to Rust objects select for what's allowed.

I think the right approach would be to do something like https://github.com/PyO3/pyo3/blob/main/guide/src/conversions/tables.md where for each Rust type we state what Python types will convert to it (i.e. FromPyObject), and what Python type(s) it will convert back into (i.e. IntoPy<PyObject>).

That information does live on that page, but perhaps it can benefit from being rearranged.

In general we seem to be preferring conversions which are allow the user to be a bit loose with typing (e.g. string for IP address). So I think we should ensure we stick to this philosophy everywhere (e.g. maybe we should accept int for bool, or even all truthy types)?

We may also wish to consider a "strict" mode where only the exact Python type can be input (e.g. Python bool <-> Rust bool).

Contributor guide

Tech stack
rustpython
Domain
documentationdeveloper experienceapi
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Rust programmingPython programmingPyO3 conversion API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Review the existing conversion tables at https://github.com/PyO3/pyo3/blob/main/guide/src/conversions/tables.md and the discussion in PR #3197. Identify inconsistencies in conversion behavior (e.g., which Python types convert to which Rust types). Propose a consistent approach following the loose typing philosophy mentioned in the issue. Update the tables to reflect the chosen consistency.
Review conversions and ensure consistency · PyO3/pyo3#3226 | Good First Issue