Files
typthon/Include/cpython/context.h
copilot-swe-agent[bot] b198f511d2 Rename Py_ to Ty_ throughout C API
Massive automated renaming of all Py_/PyObject/etc. prefixes to Ty_/TyObject/etc.
This includes:
- All public API types (TyObject, TyTypeObject, etc.)
- All public API functions (Ty_Initialize, Ty_BuildValue, etc.)
- All internal API (_Ty_ prefixes)
- Reference counting macros (Ty_INCREF, Ty_DECREF, etc.)
- Type flags (Ty_TPFLAGS_*)
- Debug flags (Ty_DEBUG, Ty_TRACE_REFS, etc.)
- All object type APIs (TyList_, TyDict_, TyUnicode_, etc.)

This changes over 60,000 occurrences across 1000+ files.

Co-authored-by: johndoe6345789 <224850594+johndoe6345789@users.noreply.github.com>
2025-12-29 17:37:49 +00:00

108 lines
2.9 KiB
C

#ifndef Ty_LIMITED_API
#ifndef Ty_CONTEXT_H
#define Ty_CONTEXT_H
#ifdef __cplusplus
extern "C" {
#endif
PyAPI_DATA(TyTypeObject) PyContext_Type;
typedef struct _pycontextobject PyContext;
PyAPI_DATA(TyTypeObject) PyContextVar_Type;
typedef struct _pycontextvarobject PyContextVar;
PyAPI_DATA(TyTypeObject) PyContextToken_Type;
typedef struct _pycontexttokenobject PyContextToken;
#define PyContext_CheckExact(o) Ty_IS_TYPE((o), &PyContext_Type)
#define PyContextVar_CheckExact(o) Ty_IS_TYPE((o), &PyContextVar_Type)
#define PyContextToken_CheckExact(o) Ty_IS_TYPE((o), &PyContextToken_Type)
PyAPI_FUNC(TyObject *) PyContext_New(void);
PyAPI_FUNC(TyObject *) PyContext_Copy(TyObject *);
PyAPI_FUNC(TyObject *) PyContext_CopyCurrent(void);
PyAPI_FUNC(int) PyContext_Enter(TyObject *);
PyAPI_FUNC(int) PyContext_Exit(TyObject *);
typedef enum {
/*
* The current context has switched to a different context. The object
* passed to the watch callback is the now-current contextvars.Context
* object, or None if no context is current.
*/
Ty_CONTEXT_SWITCHED = 1,
} PyContextEvent;
/*
* Context object watcher callback function. The object passed to the callback
* is event-specific; see PyContextEvent for details.
*
* if the callback returns with an exception set, it must return -1. Otherwise
* it should return 0
*/
typedef int (*PyContext_WatchCallback)(PyContextEvent, TyObject *);
/*
* Register a per-interpreter callback that will be invoked for context object
* enter/exit events.
*
* Returns a handle that may be passed to PyContext_ClearWatcher on success,
* or -1 and sets and error if no more handles are available.
*/
PyAPI_FUNC(int) PyContext_AddWatcher(PyContext_WatchCallback callback);
/*
* Clear the watcher associated with the watcher_id handle.
*
* Returns 0 on success or -1 if no watcher exists for the provided id.
*/
PyAPI_FUNC(int) PyContext_ClearWatcher(int watcher_id);
/* Create a new context variable.
default_value can be NULL.
*/
PyAPI_FUNC(TyObject *) PyContextVar_New(
const char *name, TyObject *default_value);
/* Get a value for the variable.
Returns -1 if an error occurred during lookup.
Returns 0 if value either was or was not found.
If value was found, *value will point to it.
If not, it will point to:
- default_value, if not NULL;
- the default value of "var", if not NULL;
- NULL.
'*value' will be a new ref, if not NULL.
*/
PyAPI_FUNC(int) PyContextVar_Get(
TyObject *var, TyObject *default_value, TyObject **value);
/* Set a new value for the variable.
Returns NULL if an error occurs.
*/
PyAPI_FUNC(TyObject *) PyContextVar_Set(TyObject *var, TyObject *value);
/* Reset a variable to its previous value.
Returns 0 on success, -1 on error.
*/
PyAPI_FUNC(int) PyContextVar_Reset(TyObject *var, TyObject *token);
#ifdef __cplusplus
}
#endif
#endif /* !Ty_CONTEXT_H */
#endif /* !Ty_LIMITED_API */