API پایش C¶

در نسخه 3.13 افزوده شد.

یک ماژول توسعه‌ای ممکن است نیاز به تعامل با سامانه پایش رویدادها داشته باشد. اشتراک در رویدادها و ثبت کال‌بک‌ها را می‌توان از طریق API پایتون ارائه‌شده در sys.monitoring انجام داد.

تولید رویدادهای اجرا¶

توابع زیر این امکان را فراهم می‌کنند که یک ماژول توسعه‌ای بتواند هنگام شبیه‌سازی اجرای کد پایتون، رویدادهای پایش را ایجاد کند. هر یک از این توابع یک ساختار PyMonitoringState را می‌پذیرد که اطلاعات مختصری درباره‌ی وضعیت فعال‌سازی رویدادها و همچنین آرگومان‌های رویداد را در بر دارد؛ این آرگومان‌ها شامل یک PyObject* که نمایانگر شیء کد است، آفست دستورالعمل و گاهی آرگومان‌های اضافی خاص رویداد هستند (برای جزئیات درباره‌ی امضاهای کال‌بک‌های مختلف رویداد به sys.monitoring مراجعه کنید). آرگومان codelike باید نمونه‌ای از types.CodeType یا از نوعی باشد که آن را شبیه‌سازی می‌کند.

ماشین مجازی هنگام فعال‌سازی رویداد، ردگیری را غیر‌فعال می‌کند، بنابراین نیازی نیست که کد کاربر این کار را انجام دهد.

توابع نظارت نباید در حالی که استثنایی تنظیم شده است فراخوانی شوند، به‌جز مواردی که در ادامه به‌عنوان توابعی که با استثنای جاری کار می‌کنند فهرست شده‌اند.

type PyMonitoringState¶

بازنمایی وضعیت یک نوع رویداد. آن توسط کاربر تخصیص داده می‌شود، در حالی که محتویات آن توسط توابع API پایش که در ادامه توضیح داده شده‌اند، نگهداری می‌شود.

تمام توابع زیر در صورت موفقیت 0 و در صورت خطا -1 (همراه با تنظیم استثنا) را برمی‌گردانند.

برای توضیحات رویدادها به sys.monitoring مراجعه کنید.

int PyMonitoring_FirePyStartEvent(PyMonitoringState *state, PyObject *codelike, int32_t offset)¶

رویداد PY_START را فعال می‌کند.

int PyMonitoring_FirePyResumeEvent(PyMonitoringState *state, PyObject *codelike, int32_t offset)¶

رویداد PY_RESUME را فعال می‌کند.

int PyMonitoring_FirePyReturnEvent(PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *retval)¶

رویداد PY_RETURN فعال می‌شود.

int PyMonitoring_FirePyYieldEvent(PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *retval)¶

رویداد PY_YIELD را فعال می‌کند.

int PyMonitoring_FireCallEvent(PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *callable, PyObject *arg0)¶

رویداد CALL را فراخوانی می‌کند.

int PyMonitoring_FireLineEvent(PyMonitoringState *state, PyObject *codelike, int32_t offset, int lineno)¶

رویداد LINE فعال می‌شود.

int PyMonitoring_FireJumpEvent(PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *target_offset)¶

رویداد JUMP فعال می‌شود.

int PyMonitoring_FireBranchLeftEvent(PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *target_offset)¶

رویداد BRANCH_LEFT را فعال کنید.

int PyMonitoring_FireBranchRightEvent(PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *target_offset)¶

رویداد BRANCH_RIGHT را فعال کنید.

int PyMonitoring_FireCReturnEvent(PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *retval)¶

رویداد C_RETURN فعال می‌شود.

int PyMonitoring_FirePyThrowEvent(PyMonitoringState *state, PyObject *codelike, int32_t offset)¶

رویداد PY_THROW را با استثنای فعلی (همان‌طور که PyErr_GetRaisedException() برمی‌گرداند) فعال می‌کند.

int PyMonitoring_FireRaiseEvent(PyMonitoringState *state, PyObject *codelike, int32_t offset)¶

رویداد RAISE به همراه استثنای فعلی (همان‌طور که توسط PyErr_GetRaisedException() برگردانده می‌شود) شلیک می‌شود.

int PyMonitoring_FireCRaiseEvent(PyMonitoringState *state, PyObject *codelike, int32_t offset)¶

رویداد C_RAISE را همراه با استثنای فعلی (همان‌طور که توسط PyErr_GetRaisedException() برگردانده می‌شود) فعال می‌کند.

int PyMonitoring_FireReraiseEvent(PyMonitoringState *state, PyObject *codelike, int32_t offset)¶

رویداد RERAISE را با استثنای فعلی (که توسط PyErr_GetRaisedException() برگردانده می‌شود) صادر می‌کند.

int PyMonitoring_FireExceptionHandledEvent(PyMonitoringState *state, PyObject *codelike, int32_t offset)¶

رویداد EXCEPTION_HANDLED را همراه با استثنای فعلی (که توسط PyErr_GetRaisedException() برگردانده می‌شود) فعال می‌کند.

int PyMonitoring_FirePyUnwindEvent(PyMonitoringState *state, PyObject *codelike, int32_t offset)¶

رویداد PY_UNWIND را با استثنای فعلی (همان‌طور که توسط PyErr_GetRaisedException() برگردانده می‌شود) فعال کنید.

int PyMonitoring_FireStopIterationEvent(PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *value)¶

رویداد STOP_ITERATION را اجرا می‌کند. اگر value نمونه‌ای از StopIteration باشد، از آن استفاده می‌شود. در غیر این صورت، نمونه‌ی جدیدی از StopIteration با value به‌عنوان آرگومان آن ایجاد می‌شود.