Skip to content

add type-annotated completions in jupyter; closes #136 #169

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jan 31, 2021
Merged

add type-annotated completions in jupyter; closes #136 #169

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6844b15
add type-annotated completions in jupyter; closes #136
rsokl Jan 31, 2021
8cd2333
Update Python/Module5_OddsAndEnds/Writing_Good_Code.md
rsokl Jan 31, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 37 additions & 3 deletions Python/Module5_OddsAndEnds/Writing_Good_Code.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,13 @@ jupyter:
extension: .md
format_name: markdown
format_version: '1.2'
jupytext_version: 1.3.0rc1
jupytext_version: 1.5.0
kernelspec:
display_name: Python 3
language: python
name: python3
---


<!-- #raw raw_mimetype="text/restructuredtext" -->
.. meta::
:description: Topic: Writing good code, Difficulty: Easy, Category: Section
Expand Down Expand Up @@ -446,6 +445,32 @@ These tools are especially useful for large-scale code bases. Companies like Dro
If you are using [VSCode as your IDE](https://www.pythonlikeyoumeanit.com/Module1_GettingStartedWithPython/Getting_Started_With_IDEs_and_Notebooks.html), you can install the [PyLance VSCode extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) to leverage pyright's type checking within your IDE.
<!-- #endregion -->

<!-- #region -->
<div class="alert alert-info">

**Reading Comprehension: Type-Assisted Code Completion**

The `jedi` package, which is installed by default alongside Jupyter and IPython, enables type-informed code completion.
This means that we can benefit from type-hints even when we are working in a Jupyter notebook!

In a Jupyter notebook, write the following type-annotated signature for a function: `def f(x: str):`.
Now in the body of the function (i.e. on the next line, and indented inwards), try typing `x.` and then hit `<TAB>`.

```python

def f(x: str):
x.#hit <TAB> here

```

You should see a list of methods appear for `x`.
What are the first three methods that appear?
Do these make sense based on the annotation associated with `x`?
Now change the annotation for `x` to be `list` and trigger the auto-completion in the editor again; do you see an updated list of methods?

</div>
<!-- #endregion -->

<div class="alert alert-info">

**Takeaway:**
Expand Down Expand Up @@ -962,8 +987,17 @@ Take some time to review the NumPy and Google docstring specifications, pick one

## Reading Comprehension Solutions


**Type-Assisted Code Completion: Solution**

The tab-completion reveals methods like "capitalize", "casefold", and "center" – all of which are string methods.
These are made available despite the fact that `x` did not yet refer to a specific string.
Instead, the type-hint was able to tell the editor that `x` _will_ refer to a string, and this was enough to inform these type completions.

Revising the type-annotation for `x` to be `list` affects the auto-completion options accordingly: the editor will now suggest list methods like "append", "clear", and "copy".

<!-- #region -->
**Type Hinting: Solutions**
**Type Hinting: Solution**

The following is a well-annotated version of `get_first_and_last`:

Expand Down