robotpy / robotpy/semiwrap

Add runtime warning to deprecated things

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

Nobody has claimed this yet.

enhancement good first issue
Dominant language
Python
Stars
7
Forks
3
Avg merge
18h 33m
Merged PRs (30d)
7

Description

Info about what is deprecated is in the headers. We should use that info, reusing the message if possible.

For the classes intended for subclassing in particular, we should add a __init_subclass__ to spit out that warning so that the warning points to where the class is subclassed. Other classes we'd have to add a thing before __init__.

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 by reading the deprecation information in the headers and tracing how that metadata reaches the generated Python wrappers. The work is done when deprecated subclassable classes warn from init_subclass at the subclass location, and other deprecated classes warn before init, reusing the existing message where possible.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, python
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.