@@ -15,6 +15,7 @@ typedef struct {
1515 PyObject * name ;
1616 PyObject * module ;
1717 PyObject * repr ;
18+ PyObject * doc ;
1819} sentinelobject ;
1920
2021#define sentinelobject_CAST (op ) \
@@ -47,7 +48,8 @@ caller(void)
4748}
4849
4950static PyObject *
50- sentinel_new_with_module (PyTypeObject * type , PyObject * name , PyObject * module , PyObject * repr )
51+ sentinel_new_with_module (PyTypeObject * type , PyObject * name , PyObject * module ,
52+ PyObject * repr , PyObject * doc )
5153{
5254 assert (PyUnicode_Check (name ));
5355
@@ -58,6 +60,7 @@ sentinel_new_with_module(PyTypeObject *type, PyObject *name, PyObject *module, P
5860 self -> name = Py_NewRef (name );
5961 self -> module = Py_NewRef (module );
6062 self -> repr = Py_XNewRef (repr );
63+ self -> doc = Py_NewRef (doc );
6164 _PyObject_GC_TRACK (self );
6265 return (PyObject * )self ;
6366}
@@ -70,11 +73,13 @@ sentinel.__new__ as sentinel_new
7073 /
7174 *
7275 repr: object = None
76+ doc: object = None
7377[clinic start generated code]*/
7478
7579static PyObject *
76- sentinel_new_impl (PyTypeObject * type , PyObject * name , PyObject * repr )
77- /*[clinic end generated code: output=1eb7fab52e57d8c8 input=28cab6c468997b35]*/
80+ sentinel_new_impl (PyTypeObject * type , PyObject * name , PyObject * repr ,
81+ PyObject * doc )
82+ /*[clinic end generated code: output=bd628ad189d4a277 input=162bd94d3cd2f6bf]*/
7883{
7984 if (repr == Py_None ) {
8085 repr = NULL ;
@@ -84,7 +89,7 @@ sentinel_new_impl(PyTypeObject *type, PyObject *name, PyObject *repr)
8489 return NULL ;
8590 }
8691 PyObject * module = caller ();
87- PyObject * self = sentinel_new_with_module (type , name , module , repr );
92+ PyObject * self = sentinel_new_with_module (type , name , module , repr , doc );
8893 Py_DECREF (module );
8994 return self ;
9095}
@@ -114,7 +119,7 @@ PySentinel_New(const char *name, const char *module_name, const char *repr)
114119 }
115120
116121 PyObject * sentinel = sentinel_new_with_module (
117- & PySentinel_Type , name_obj , module_obj , repr_obj );
122+ & PySentinel_Type , name_obj , module_obj , repr_obj , Py_None );
118123 Py_DECREF (module_obj );
119124 Py_DECREF (name_obj );
120125 Py_XDECREF (repr_obj );
@@ -128,6 +133,7 @@ sentinel_clear(PyObject *op)
128133 Py_CLEAR (self -> name );
129134 Py_CLEAR (self -> module );
130135 Py_CLEAR (self -> repr );
136+ Py_CLEAR (self -> doc );
131137 return 0 ;
132138}
133139
@@ -146,6 +152,7 @@ sentinel_traverse(PyObject *op, visitproc visit, void *arg)
146152 Py_VISIT (self -> name );
147153 Py_VISIT (self -> module );
148154 Py_VISIT (self -> repr );
155+ Py_VISIT (self -> doc );
149156 return 0 ;
150157}
151158
@@ -188,6 +195,7 @@ static PyMethodDef sentinel_methods[] = {
188195static PyMemberDef sentinel_members [] = {
189196 {"__name__" , Py_T_OBJECT_EX , offsetof(sentinelobject , name ), Py_READONLY },
190197 {"__module__" , Py_T_OBJECT_EX , offsetof(sentinelobject , module ), 0 },
198+ {"__doc__" , Py_T_OBJECT_EX , offsetof(sentinelobject , doc ), Py_READONLY },
191199 {NULL }
192200};
193201
@@ -196,7 +204,7 @@ static PyNumberMethods sentinel_as_number = {
196204};
197205
198206PyDoc_STRVAR (sentinel_doc ,
199- "sentinel(name, /, *, repr=None)\n"
207+ "sentinel(name, /, *, repr=None, doc=None )\n"
200208"--\n\n"
201209"Create a unique sentinel object with the given name." );
202210
0 commit comments