Commit ffc5a14d authored by Sanyam Khurana's avatar Sanyam Khurana Committed by Carol Willing

bpo-33014: Clarify str.isidentifier docstring (GH-6088)

* bpo-33014: Clarify str.isidentifier docstring

* bpo-33014: Add code example in isidentifier documentation
parent 656d52db
...@@ -1700,8 +1700,19 @@ expression support in the :mod:`re` module). ...@@ -1700,8 +1700,19 @@ expression support in the :mod:`re` module).
Return true if the string is a valid identifier according to the language Return true if the string is a valid identifier according to the language
definition, section :ref:`identifiers`. definition, section :ref:`identifiers`.
Use :func:`keyword.iskeyword` to test for reserved identifiers such as Call :func:`keyword.iskeyword` to test whether string ``s`` is a reserved
:keyword:`def` and :keyword:`class`. identifier, such as :keyword:`def` and :keyword:`class`.
Example:
::
>>> from keyword import iskeyword
>>> 'hello'.isidentifier(), iskeyword('hello')
True, False
>>> 'def'.isidentifier(), iskeyword('def')
True, True
.. method:: str.islower() .. method:: str.islower()
......
...@@ -381,8 +381,8 @@ PyDoc_STRVAR(unicode_isidentifier__doc__, ...@@ -381,8 +381,8 @@ PyDoc_STRVAR(unicode_isidentifier__doc__,
"\n" "\n"
"Return True if the string is a valid Python identifier, False otherwise.\n" "Return True if the string is a valid Python identifier, False otherwise.\n"
"\n" "\n"
"Use keyword.iskeyword() to test for reserved identifiers such as \"def\" and\n" "Call keyword.iskeyword(s) to test whether string s is a reserved identifier,\n"
"\"class\"."); "such as \"def\" or \"class");
#define UNICODE_ISIDENTIFIER_METHODDEF \ #define UNICODE_ISIDENTIFIER_METHODDEF \
{"isidentifier", (PyCFunction)unicode_isidentifier, METH_NOARGS, unicode_isidentifier__doc__}, {"isidentifier", (PyCFunction)unicode_isidentifier, METH_NOARGS, unicode_isidentifier__doc__},
...@@ -951,4 +951,4 @@ unicode_sizeof(PyObject *self, PyObject *Py_UNUSED(ignored)) ...@@ -951,4 +951,4 @@ unicode_sizeof(PyObject *self, PyObject *Py_UNUSED(ignored))
{ {
return unicode_sizeof_impl(self); return unicode_sizeof_impl(self);
} }
/*[clinic end generated code: output=561c88c912b8fe3b input=a9049054013a1b77]*/ /*[clinic end generated code: output=c9476bf19f13c286 input=a9049054013a1b77]*/
...@@ -12100,13 +12100,13 @@ str.isidentifier as unicode_isidentifier ...@@ -12100,13 +12100,13 @@ str.isidentifier as unicode_isidentifier
Return True if the string is a valid Python identifier, False otherwise. Return True if the string is a valid Python identifier, False otherwise.
Use keyword.iskeyword() to test for reserved identifiers such as "def" and Call keyword.iskeyword(s) to test whether string s is a reserved identifier,
"class". such as "def" or "class
[clinic start generated code]*/ [clinic start generated code]*/
static PyObject * static PyObject *
unicode_isidentifier_impl(PyObject *self) unicode_isidentifier_impl(PyObject *self)
/*[clinic end generated code: output=fe585a9666572905 input=916b0a3c9f57e919]*/ /*[clinic end generated code: output=fe585a9666572905 input=2fb643aafbcf0e1c]*/
{ {
return PyBool_FromLong(PyUnicode_IsIdentifier(self)); return PyBool_FromLong(PyUnicode_IsIdentifier(self));
} }
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment