Skip to content

Commit

Permalink
DOC: Fix DataFrame.query contradiction on use of Python keywords as i…
Browse files Browse the repository at this point in the history
…dentifiers (pandas-dev#36311)
  • Loading branch information
ezebunandu committed Sep 12, 2020
1 parent 4729d8f commit bed9656
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions pandas/core/frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -3238,11 +3238,12 @@ def query(self, expr, inplace=False, **kwargs):
in the environment by prefixing them with an '@' character like
``@a + b``.
You can refer to column names that contain spaces or operators by
surrounding them in backticks. This way you can also escape
names that start with a digit, or those that are a Python keyword.
Basically when it is not valid Python identifier. See notes down
for more details.
You can refer to column names that are not valid Python variable names
by surrounding them in backticks. Thus, column names containing spaces
or punctuations (besides underscores) or starting with digits must be
surrounded by backticks. (For example, a column named "Area (cm^2) would
be referenced as `Area (cm^2)`). Column names which are Python keywords
(like "list", "for", "import", etc) cannot be used.
For example, if one of your columns is called ``a a`` and you want
to sum it with ``b``, your query should be ```a a` + b``.
Expand Down

0 comments on commit bed9656

Please sign in to comment.