fix(examples): make_code.py contradicts the documented UI import order
Mantenedores costumam responder em até 2 dias
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 1/5
- Tempo estimado
- Menos de uma hora
- Facilidade para iniciantes
- 85/100
- Tipo de issue
- Bug
- Clareza
- Claramente especificada
- Status de atividade
- Ativa
- Stack de tecnologia
- python
- Domínio
- developer-experience
Direção de pesquisa
Leia docs/dev/plugins.md em “UI Plugins” junto com python/examples/README.md e, em seguida, inspecione os imports em python/examples/make_code.py:10–11. Atualize o exemplo para seguir a ordem de imports documentada, preservando sua ação “Make Code” e o comportamento do renderer. O trabalho estará concluído quando o exemplo demonstrar a ordem documentada; esta issue não estabelece nenhuma falha em tempo de execução nem a necessidade de uma correção.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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.
- Linguagem predominante
- C++
- Estrelas
- 1.3k
- Forks
- 304
- Merge médio
- 2d 20h
- PRs com merge (30d)
- 10
Preparar o ambiente
Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de Vector35/binaryninja-api
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 84/100
Vector35/binaryninja-api#8715 ·
Mantenedores costumam responder em até 2 dias
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
Vector35/binaryninja-api#8714 ·
Mantenedores costumam responder em até 2 dias
-
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 78/100
Vector35/binaryninja-api#8689 ·
Mantenedores costumam responder em até 2 dias
-
Component: Python API
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
Vector35/binaryninja-api#8649 ·
Mantenedores costumam responder em até 2 dias
-
Hexagon lifting issuesAberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
Vector35/binaryninja-api#8621 · 1 comentário ·
Mantenedores costumam responder em até 2 dias
Todas as issues de Vector35/binaryninja-api
Issues semelhantes
-
Bug Core VIF
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 80/100
ESPresense/ESPresense#2680 · 2 comentários ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 Menos de uma hora Facilidade para iniciantes 75/100
stew675/llama-cpp-rdna-boosts#348 ·
Mantenedores costumam responder em até 1 dia
-
Documentation: Add comprehensive newcomer onboarding guide, project structure, and local usage to READMETalvez já em andamento @Ash-Blanc assumiu hoje. Abertaarea/other status/bot-triaged status/need-triage
Dificuldade 2/5 Meio dia Facilidade para iniciantes 85/100
-
bug
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 85/100
Mantenedores costumam responder em até 1 dia