fix(examples): make_code.py contradicts the documented UI import order
I maintainer di solito rispondono entro 2 giorni
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 1/5
- Tempo stimato
- Meno di un'ora
- Idoneità per principianti
- 85/100
- Tipo di issue
- Bug
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- python
- Ambito
- developer-experience
Direzione di ricerca
Leggi docs/dev/plugins.md nella sezione “UI Plugins” insieme a python/examples/README.md, quindi esamina gli import in python/examples/make_code.py:10–11. Aggiorna l’esempio affinché segua l’ordine degli import documentato, preservando l’azione “Make Code” e il comportamento del renderer. Il lavoro è completato quando l’esempio mostra l’ordine documentato; questo issue non stabilisce alcun errore in fase di esecuzione né una correzione necessaria.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Summary
The make_code.py GUI plugin example imports PySide6.QtGui before binaryninjaui, reversing the order that the UI plugin guide tells Python UI plugins to always use. This report concerns the example's inconsistency with that guidance. It does not claim that this example crashes or that it loads an incorrect Qt library in a current installation.
Runtime or environment
- Binary Ninja source: latest published release
stable/6.0.10905, commit775c3b5eed8598217b20e1087afe7aa092a9b4b1; current default branchdev, commit74749a72a606532e3984b605518bd49094020699. - Edition, OS, OS version, CPU architecture: not applicable to this source/documentation comparison. No Binary Ninja runtime was executed for this report.
Steps to reproduce
- At either source baseline, read the Python UI plugin import-order rule in
docs/dev/plugins.md, under “UI Plugins.” - Read
python/examples/README.md, which listsmake_code.pyunder “GUI Plugins” and says these plugins require the UI to be running. - Compare the rule with the consecutive imports at
python/examples/make_code.py:10–11.
These source-inspection steps were performed on both baselines. No GUI or headless execution steps are asserted as reproduced.
Expected behavior
An official example identified as a Python GUI plugin demonstrates the import order documented for Python UI plugins: binaryninjaui before PySide6. The guide states this rule for UI plugins themselves; it does not document a GUI-context exemption.
Actual behavior
Both source baselines contain the same example bytes, including:
import sys
from PySide6.QtGui import QKeySequence
from binaryninjaui import UIActionHandler, UIAction, UIActionContext
The example is intended to run in the GUI. Whether binaryninjaui or the appropriate PySide bindings have already been imported in any particular GUI session was not measured. No resulting runtime failure, incorrect library selection, or crash is established here.
Evidence
- Expected source: UI Plugins guidance, which requires the opposite order for Python UI plugins.
- Failure source: make_code.py imports.
- Evidence provenance: static
- Local verification: static-proof
- Reproduction completeness: complete
Runtime reproduction was not run. This is a direct comparison of the release and default-branch source artifacts. The examples README identifies this file as a GUI plugin, establishing the scope of the documented convention. An AST inspection confirmed the consecutive import order in both source baselines. The proof establishes the example/guidance discrepancy only.
Restoration check
Compare this example with the UI plugin guide again: the example should demonstrate the documented import order, or the guidance should state an applicable supported exception. Preserve the example's “Make Code” action and renderer behavior. A successful comparison should not be presented as proof that a runtime crash has been fixed.
References
Issue #3196 introduced the UI plugin best-practice documentation and is closed as completed. This report concerns the example that still uses the contrary order, not missing best-practice documentation or a reproduced recurrence of an old crash.
Triage assessment
- Impact level: P3
- Assessment status: supported
- Impact basis: The official GUI plugin example contradicts an explicit documentation convention. This is an example consistency/cleanup defect; consequential runtime impact has not been demonstrated.
- Workaround status: available
- Workaround basis: Readers can follow the documented import order when adapting the example. The documented order is directly available in the same repository; no runtime fix or crash workaround is claimed.
- Lingua principale
- C++
- Stelle
- 1.3k
- Fork
- 304
- Merge medio
- 2g 20h
- PR unite (30g)
- 10
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di Vector35/binaryninja-api
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 84/100
Vector35/binaryninja-api#8715 ·
I maintainer di solito rispondono entro 2 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
Vector35/binaryninja-api#8714 ·
I maintainer di solito rispondono entro 2 giorni
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 78/100
Vector35/binaryninja-api#8689 ·
I maintainer di solito rispondono entro 2 giorni
-
Component: Python API
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
Vector35/binaryninja-api#8649 ·
I maintainer di solito rispondono entro 2 giorni
-
Hexagon lifting issuesAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
Vector35/binaryninja-api#8621 · 1 commento ·
I maintainer di solito rispondono entro 2 giorni
Tutte le issue di Vector35/binaryninja-api
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 80/100
ESPresense/ESPresense#2680 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 Meno di un'ora Idoneità per principianti 75/100
stew675/llama-cpp-rdna-boosts#348 ·
I maintainer di solito rispondono entro 1 giorno
-
Documentation: Add comprehensive newcomer onboarding guide, project structure, and local usage to READMEForse già presa @Ash-Blanc l’ha presa oggi. Apertaarea/other status/bot-triaged status/need-triage
Difficoltà 2/5 Mezza giornata Idoneità per principianti 85/100
-
bug
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno