Add plugin support by MrIndeciso · Pull Request #291 · libdebug/libdebug

MrIndeciso · 2025-11-27T22:27:23Z

No description provided.

Copilot

Pull request overview

This pull request refactors the monolithic Debugger class into a mixin-based architecture to enable plugin-style extensions. The refactor maintains backward compatibility while allowing advanced users to subclass Debugger and add custom mixins. The main changes include:

Split the Debugger class into 9 focused mixins (ExecutionMixin, BreakpointMixin, ConfigurationMixin, etc.)
Introduced a DebuggerMeta metaclass that detects method name collisions across mixins and creates aliased methods
Updated the debugger() factory function to accept a cls parameter for custom subclasses
Changed initialization from a two-step pattern (__init__ + post_init_) to direct constructor injection of InternalDebugger

Reviewed changes

Copilot reviewed 22 out of 22 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
libdebug/debugger/debugger.py	Replaced 1160+ lines with ~40 lines composing mixins using DebuggerMeta metaclass
libdebug/debugger/debugger_meta.py	New metaclass that detects and warns about mixin method collisions, creating aliased methods
libdebug/debugger/mixins/base.py	Base mixin class declaring _internal_debugger dependency
libdebug/debugger/mixins/core.py	Core initialization mixin accepting InternalDebugger in constructor
libdebug/debugger/mixins/execution.py	Process lifecycle controls (run, attach, kill, step, etc.)
libdebug/debugger/mixins/breakpoints.py	Breakpoint, watchpoint, signal and syscall handling
libdebug/debugger/mixins/configuration.py	Configuration properties (argv, env, arch, etc.)
libdebug/debugger/mixins/introspection.py	Read-only state accessors (threads, maps, symbols, etc.)
libdebug/debugger/mixins/thread_state.py	Main thread state properties (regs, syscall args, etc.)
libdebug/debugger/mixins/display.py	Pretty-print methods and representation
libdebug/debugger/mixins/gdb.py	GDB migration functionality
libdebug/debugger/mixins/snapshot.py	Snapshot creation and loading
libdebug/debugger/mixins/init.py	Exports all mixin classes
libdebug/debugger/init.py	Exports Debugger and all mixins for public use
libdebug/libdebug.py	Updated debugger() factory to accept cls parameter and use new constructor pattern
libdebug/debugger/internal_debugger.py	Updated child debugger creation to use new constructor
libdebug/init.py	Updated docstring to reflect mixin architecture
test/scripts/debugger_mixin_test.py	New test validating metaclass collision detection and aliasing
test/scripts/init.py	Added DebuggerMixinTest to test exports
test/run_suite.py	Added DebuggerMixinTest to fast test suite
newsfragments/291.improvement.md	Release note documenting the refactor
README.md	Added section explaining how to extend Debugger with custom mixins

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

libdebug/debugger/internal_debugger.py

libdebug/debugger/mixins/thread_state.py

libdebug/debugger/mixins/display.py

README.md

libdebug/debugger/__init__.py

test/scripts/__init__.py

test/scripts/debugger_mixin_test.py

Copilot

Pull request overview

Copilot reviewed 23 out of 23 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

libdebug/debugger/mixins/execution.py

…port

…method

Should not have committed that file

Copilot

Pull request overview

Copilot reviewed 24 out of 24 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

libdebug/debugger/mixins/thread_state.py

Copilot · 2025-11-29T00:02:39Z

test/scripts/__init__.py



-__all__ = ["AliasTest", "AntidebugEscapingTest", "ArgumentListTest", "AtexitHandlerTest", "AttachDetachTest", "AutoWaitingTest", "BacktraceTest", "BreakpointTest", "BruteTest", "CallbackTest", "ControlFlowTest", "CorruptedELFTest", "CursedBinariesTest", "DeathTest", "DebuggerArgumentTest", "DeepDiveDivisionTest", "ELFUtilsUnitTest", "FinishTest", "FloatingPointTest", "JumpoutTest", "JumpstartTest", "LargeBinarySymTest", "MemoryTest", "MemoryNoFastTest", "MultipleDebuggersTest", "NextTest", "NlinksTest", "PPrintSyscallsTest", "RegisterTest", "RunPipesTest", "SignalCatchTest", "SignalMultithreadTest", "SpeedTest", "SyscallHandleTest", "SyscallHijackTest", "TimeoutTest", "ThreadTest", "Vmwhere1Test", "WatchpointTest", "FindPointersTest", "SymbolTest", "SnapshotsTest", "MultiprocessingTest", "MemoryLeakTest"]
+__all__ = ["AliasTest", "AntidebugEscapingTest", "ArgumentListTest", "AtexitHandlerTest", "AttachDetachTest", "AutoWaitingTest", "BacktraceTest", "BreakpointTest", "BruteTest", "CallbackTest", "ControlFlowTest", "CorruptedELFTest", "CursedBinariesTest", "DebuggerMixinTest", "DeathTest", "DebuggerArgumentTest", "DeepDiveDivisionTest", "ELFUtilsUnitTest", "FinishTest", "FloatingPointTest", "JumpoutTest", "JumpstartTest", "LargeBinarySymTest", "MemoryTest", "MemoryNoFastTest", "MultipleDebuggersTest", "NextTest", "NlinksTest", "PPrintSyscallsTest", "RegisterTest", "RunPipesTest", "SignalCatchTest", "SignalMultithreadTest", "SpeedTest", "SyscallHandleTest", "SyscallHijackTest", "TimeoutTest", "ThreadTest", "Vmwhere1Test", "WatchpointTest", "FindPointersTest", "SymbolTest", "SnapshotsTest", "MultiprocessingTest", "MemoryLeakTest"]


The name 'JumpstartTest' is exported by all but is not defined.

Suggested change

__all__ = ["AliasTest", "AntidebugEscapingTest", "ArgumentListTest", "AtexitHandlerTest", "AttachDetachTest", "AutoWaitingTest", "BacktraceTest", "BreakpointTest", "BruteTest", "CallbackTest", "ControlFlowTest", "CorruptedELFTest", "CursedBinariesTest", "DebuggerMixinTest", "DeathTest", "DebuggerArgumentTest", "DeepDiveDivisionTest", "ELFUtilsUnitTest", "FinishTest", "FloatingPointTest", "JumpoutTest", "JumpstartTest", "LargeBinarySymTest", "MemoryTest", "MemoryNoFastTest", "MultipleDebuggersTest", "NextTest", "NlinksTest", "PPrintSyscallsTest", "RegisterTest", "RunPipesTest", "SignalCatchTest", "SignalMultithreadTest", "SpeedTest", "SyscallHandleTest", "SyscallHijackTest", "TimeoutTest", "ThreadTest", "Vmwhere1Test", "WatchpointTest", "FindPointersTest", "SymbolTest", "SnapshotsTest", "MultiprocessingTest", "MemoryLeakTest"]

__all__ = ["AliasTest", "AntidebugEscapingTest", "ArgumentListTest", "AtexitHandlerTest", "AttachDetachTest", "AutoWaitingTest", "BacktraceTest", "BreakpointTest", "BruteTest", "CallbackTest", "ControlFlowTest", "CorruptedELFTest", "CursedBinariesTest", "DebuggerMixinTest", "DeathTest", "DebuggerArgumentTest", "DeepDiveDivisionTest", "ELFUtilsUnitTest", "FinishTest", "FloatingPointTest", "JumpoutTest", "LargeBinarySymTest", "MemoryTest", "MemoryNoFastTest", "MultipleDebuggersTest", "NextTest", "NlinksTest", "PPrintSyscallsTest", "RegisterTest", "RunPipesTest", "SignalCatchTest", "SignalMultithreadTest", "SpeedTest", "SyscallHandleTest", "SyscallHijackTest", "TimeoutTest", "ThreadTest", "Vmwhere1Test", "WatchpointTest", "FindPointersTest", "SymbolTest", "SnapshotsTest", "MultiprocessingTest", "MemoryLeakTest"]

MrIndeciso added a commit that referenced this pull request Nov 27, 2025

chore: add newsfragment for PR #291

fdb78aa

MrIndeciso requested a review from Copilot November 28, 2025 01:08

Copilot started reviewing on behalf of MrIndeciso November 28, 2025 01:09 View session

Copilot finished reviewing on behalf of MrIndeciso November 28, 2025 01:12

Copilot AI reviewed Nov 28, 2025

View reviewed changes

MrIndeciso requested a review from Copilot November 28, 2025 19:57

Copilot started reviewing on behalf of MrIndeciso November 28, 2025 19:58 View session

Copilot finished reviewing on behalf of MrIndeciso November 28, 2025 19:59

Copilot AI reviewed Nov 28, 2025

View reviewed changes

libdebug/debugger/mixins/execution.py Show resolved Hide resolved

MrIndeciso added 11 commits November 28, 2025 17:42

feat: rework Debugger into separate, small mixin classes

58c531b

fix: make all mixins depend on a base EngineBoundMixin for typing sup…

3d8ff42

…port

chore: add newsfragment for PR #291

5ca2f1f

feat: enable custom classes to be inflated through the debugger(...) …

6b44c04

…method

feat: add metaclass for conflict detection and resolution

479011e

test: check that the debugger metaclass works as expected

7d19a33

fix: correctly instantiate child debugger with the correct class

2a8c2d9

style: fix wrong return type and pydoc for a few methods

9377af5

docs: remove README changes

8026db2

Should not have committed that file

fix: d.tid was a bady copy-paste from ThreadContext

7998896

fix: correct DebuggerMeta to support mixins

7ec0a2f

MrIndeciso force-pushed the add-plugin-support branch from 2780b6a to 7ec0a2f Compare November 28, 2025 23:57

MrIndeciso requested a review from Copilot November 29, 2025 00:00

Copilot started reviewing on behalf of MrIndeciso November 29, 2025 00:00 View session

Copilot finished reviewing on behalf of MrIndeciso November 29, 2025 00:01

Copilot AI reviewed Nov 29, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add plugin support#291

Add plugin support#291
MrIndeciso wants to merge 11 commits intodevfrom
add-plugin-support

MrIndeciso commented Nov 27, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI Nov 29, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants



		__all__ = ["AliasTest", "AntidebugEscapingTest", "ArgumentListTest", "AtexitHandlerTest", "AttachDetachTest", "AutoWaitingTest", "BacktraceTest", "BreakpointTest", "BruteTest", "CallbackTest", "ControlFlowTest", "CorruptedELFTest", "CursedBinariesTest", "DeathTest", "DebuggerArgumentTest", "DeepDiveDivisionTest", "ELFUtilsUnitTest", "FinishTest", "FloatingPointTest", "JumpoutTest", "JumpstartTest", "LargeBinarySymTest", "MemoryTest", "MemoryNoFastTest", "MultipleDebuggersTest", "NextTest", "NlinksTest", "PPrintSyscallsTest", "RegisterTest", "RunPipesTest", "SignalCatchTest", "SignalMultithreadTest", "SpeedTest", "SyscallHandleTest", "SyscallHijackTest", "TimeoutTest", "ThreadTest", "Vmwhere1Test", "WatchpointTest", "FindPointersTest", "SymbolTest", "SnapshotsTest", "MultiprocessingTest", "MemoryLeakTest"]
		__all__ = ["AliasTest", "AntidebugEscapingTest", "ArgumentListTest", "AtexitHandlerTest", "AttachDetachTest", "AutoWaitingTest", "BacktraceTest", "BreakpointTest", "BruteTest", "CallbackTest", "ControlFlowTest", "CorruptedELFTest", "CursedBinariesTest", "DebuggerMixinTest", "DeathTest", "DebuggerArgumentTest", "DeepDiveDivisionTest", "ELFUtilsUnitTest", "FinishTest", "FloatingPointTest", "JumpoutTest", "JumpstartTest", "LargeBinarySymTest", "MemoryTest", "MemoryNoFastTest", "MultipleDebuggersTest", "NextTest", "NlinksTest", "PPrintSyscallsTest", "RegisterTest", "RunPipesTest", "SignalCatchTest", "SignalMultithreadTest", "SpeedTest", "SyscallHandleTest", "SyscallHijackTest", "TimeoutTest", "ThreadTest", "Vmwhere1Test", "WatchpointTest", "FindPointersTest", "SymbolTest", "SnapshotsTest", "MultiprocessingTest", "MemoryLeakTest"]

Uh oh!

Conversation

MrIndeciso commented Nov 27, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI Nov 29, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants