FEniCS/dolfinx

Generate Python type stubs using nanobind (v2)

Closed

#3,238 opened on May 31, 2024

View on GitHubContributor guide
 (2 comments) (0 reactions) (1 assignee)C++ (255 forks)auto 404
enhancementgood first issuenanobindroadmaptype-hints

Repository metrics

Stars
 (1,158 stars)
PR merge metrics
 (PR metrics pending)

Description

Nanobind can now auto-generate a type stubs for the wrapper code.

This has been used with Basix (https://github.com/FEniCS/basix/pull/829).

Contributor guide

Research direction
Investigate nanobind's type stub generation feature as used in Basix (https://github.com/FEniCS/basix/pull/829) and integrate it into the DOLFINx build system to generate .pyi files for the Python interface.
Tech stack
python
Domain
backendtooling
Issue type
Feature
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.
1-2 days
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
GitPythonC++nanobind
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50