Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix example and docs typos for objmode context manager. #3577

Merged
merged 2 commits into from
Dec 12, 2018
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 9 additions & 9 deletions numba/withcontexts.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,15 +120,15 @@ def mutate_with_body(self, func_ir, blocks, blk_start, blk_end,
class _ObjModeContextType(WithContext):
"""Creates a contextmanager to be used inside jitted functions to enter
*object-mode* for using interpreter features. The body of the with-context
is lifted into a function that is compiled into *object-mode*. This
transformation process is limitated and cannot process all possible
is lifted into a function that is compiled in *object-mode*. This
transformation process is limited and cannot process all possible
Python code. However, users can wrap complicated logic in another
Python function, which will then be executed by the interpreter.

Use this as a function that takes keyword arguments only.
The argument names must correspond to the output variables from the
with-block. Their respective values are strings representing the expected
types. When exiting the with-context, the output variables are casted
types. When exiting the with-context, the output variables are cast
to the expected nopython types according to the annotation. This process
is the same as passing Python objects into arguments of a nopython
function.
Expand All @@ -140,20 +140,20 @@ class _ObjModeContextType(WithContext):

def bar(x):
# This code is executed by the interpreter.
return np.asarray(list(reversed(x.tolist()))
return np.asarray(list(reversed(x.tolist())))

@njit
def foo():
x = np.arange(5)
y = np.arange(5)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should change it so that we allocate y = np.zeros_like(x) and leave x as is. We want to show that input arrays do not need to be annotated.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yes, thanks, fixed in eacd307

with objmode(y='intp[:]'): # annotate return type
# this region is executed by object-mode.
y += bar(x)
y += bar(y)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we don't have to change this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in eacd307

return y

.. note:: Known limitation:
.. note:: Known limitations:

- with-block cannot use incoming list object.
- with-block cannot use incoming function object.
- with-block cannot use incoming list objects.
- with-block cannot use incoming function objects.
- with-block cannot ``yield``, ``break``, ``return`` or ``raise`` \
such that the execution will leave the with-block immediately.
- with-block cannot contain `with` statements.
Expand Down