PyO3/pyo3

Expand performance section of the guide

Open

#3,310 opened on Jul 11, 2023

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

Description

  • Overhead of conversions (i.e. PyList vs Vec etc.)
  • String intern!
  • Vec<u8> becoming list[int] (and thus being very slow), usage of Cow<[u8]> as an alternative
  • #[pyo3(get)] deep-cloning non-Py data
  • dictionary dispatch, i.e. look-up based on type object identity

Contributor guide

Tech stack
rustpython
Domain
documentation
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.
mostly clear
Prerequisites
Rust programmingPython programmingPyO3 library basicsPerformance optimization concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Examine the existing guide structure in the `guide/` directory of the PyO3 repository. Look at the 'Performance' section to understand the current content and formatting. Read the referenced items, such as the overhead of conversions between PyList and Vec, and the use of `Cow<[u8]>` for zero copy data. Consider consulting comments or asking maintainers for preferred depth and examples. Finally, write concise explanations with code snippets and performance benchmarks where applicable.