Skip to content

Use type hints instead of var_type #161

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

Open
johnkershaw wants to merge 2 commits into
base: master
Choose a base branch
from
+2 −2
Open

Use type hints instead of var_type #161

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1b071f
Use type hint
johnkershaw May 15, 2026
02da6a5
Merge pull request #1 from johnkershaw/type-hint
johnkershaw May 15, 2026
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
4 changes: 2 additions & 2 deletions src/readability/putting_type_information_in_a_variable_name.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ The code below demonstrates the dangers of variables whose names include type no
Best practice
-------------

Remove type notation
Use type hint
....................

Although the modifed code below does not fix the underlying problem of attempting to divide a number by a string, the code is generally less misleading, because there is no misleading description in the variable name ``n`` that ``n`` is a number.

.. code:: python

n = "Hello, World!"
n: str = "Hello, World!"

# still a problem, but less misleading now
4 / n
Expand Down