Vector35 / Vector35/binaryninja-api
Add nullability annotations to `binaryninjacore.h`
Open
Nobody has claimed this yet.
Component: API
Component: Python API
Effort: Medium
Impact: Medium
- Dominant language
- C++
- Stars
- 1.3k
- Forks
- 298
- Avg merge
- 5d 5h
- Merged PRs (30d)
- 19
Description
In addition to the obvious DX improvements, this would:
- Fix type errors/inaccuracies in the python API
- Instead of always having to type return values
Optional[foo]for core APIs that return a pointer we can just type it as returningfooif they're marked as returning non-null - Check at runtime that
Noneisn't passed to core APIs that don't take a nullable parameter
- Instead of always having to type return values
- Allow adding nullability annotations to the C++ API
- Probably expose a lot of bugs in existing code using the API where there are potential null derefs
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing binaryninjacore.h and tracing how its pointer declarations feed the Python and C++ APIs. Done means the relevant core APIs have accurate nullability annotations, nullable parameters are distinguished from non-null ones, and the resulting type and runtime checks reflect those annotations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, cpp, python
- Domain
- api, developer-experience
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100