fix(examples): make_code.py contradicts the documented UI import order

Đang mở Phù hợp với người mới
#8,713 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 2 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức phù hợp với người mới
85/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
developer-experience

Hướng nghiên cứu

Đọc docs/dev/plugins.md trong mục “UI Plugins” cùng với python/examples/README.md, sau đó kiểm tra các import tại python/examples/make_code.py:10–11. Cập nhật ví dụ để làm theo thứ tự import được ghi trong tài liệu, đồng thời giữ nguyên hành động “Make Code” và cách renderer hoạt động. Công việc được xem là hoàn tất khi ví dụ thể hiện thứ tự được ghi trong tài liệu; issue này không xác định có lỗi khi chạy hay cần sửa lỗi.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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, commit 775c3b5eed8598217b20e1087afe7aa092a9b4b1; current default branch dev, commit 74749a72a606532e3984b605518bd49094020699.
  • 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

  1. At either source baseline, read the Python UI plugin import-order rule in docs/dev/plugins.md, under “UI Plugins.”
  2. Read python/examples/README.md, which lists make_code.py under “GUI Plugins” and says these plugins require the UI to be running.
  3. 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.
Ngôn ngữ chính
C++
Star
1.3k
Fork
304
Merge trung bình
2 ngày 20 giờ
Pull request đã merge (30 ngày)
10

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Vector35/binaryninja-api

Tất cả issue của Vector35/binaryninja-api

Issue tương tự

Thêm issue về C++

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.