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.

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

Jump to bottom

The term "typechecks" is confusingly used as an adjective #96130

Closed
ketozhang opened this issue Aug 19, 2022 · 5 comments
Closed

The term "typechecks" is confusingly used as an adjective #96130

ketozhang opened this issue Aug 19, 2022 · 5 comments
Labels
docs Documentation in the Doc dir topic-typing

Comments

@ketozhang
Copy link

Documentation

Arguably to new eyes, you can mistaken "typecheck" to be a verb meaning "to do type checking". I understand this term came from the C function TypeCheck that returns a boolean.
@ketozhang ketozhang added the docs Documentation in the Doc dir label Aug 19, 2022
@ketozhang
Copy link
Author

It's particular confusing in NewType https://docs.python.org/3.10/library/typing.html#newtype

The static type checker will treat the new type as if it were a subclass of the original type. This is useful in helping catch logical errors:

def get_user_name(user_id: UserId) -> str:
    ...

# typechecks
user_a = get_user_name(UserId(42351))

# does not typecheck; an int is not a UserId
user_b = get_user_name(-1)

The last two line may mean, the type checker skips checking this line.

@ericvsmith
Copy link
Member

Do you have a proposal to improve this? I think it’s okay as-is, but if you can make it better that would be good.

@ketozhang
Copy link
Author

I believe "Passes type checking" and "Fails type checking" is very clear.

@ericvsmith
Copy link
Member

I believe "Passes type checking" and "Fails type checking" is very clear.

Agreed!

hauntsaninja added a commit to hauntsaninja/cpython that referenced this issue Oct 10, 2022
@hauntsaninja
pythongh-96130: Rephrase use of "typecheck" verb for clarity
48ddbb2 
I'm sympathetic to the issue report, especially in case this helps
clarify to new users that Python itself does not do type checking at runtime
@bedevere-bot bedevere-bot mentioned this issue Oct 10, 2022
Merged
JelleZijlstra pushed a commit that referenced this issue Oct 12, 2022
@hauntsaninja
gh-96130: Rephrase use of "typecheck" verb for clarity (#98144)
ed6344e 
I'm sympathetic to the issue report, especially in case this helps
clarify to new users that Python itself does not do type checking at runtime
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 12, 2022
@hauntsaninja @miss-islington
pythongh-96130: Rephrase use of "typecheck" verb for clarity (pythonG…
3b5faf6 
…H-98144)

I'm sympathetic to the issue report, especially in case this helps
clarify to new users that Python itself does not do type checking at runtime
(cherry picked from commit ed6344e)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
This was referenced Oct 12, 2022
Merged
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 12, 2022
@hauntsaninja @miss-islington
pythongh-96130: Rephrase use of "typecheck" verb for clarity (pythonG…
816d6b6 
…H-98144)

I'm sympathetic to the issue report, especially in case this helps
clarify to new users that Python itself does not do type checking at runtime
(cherry picked from commit ed6344e)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
@JelleZijlstra
Copy link
Member

Thanks @ketozhang for the report and @hauntsaninja for the fix!

miss-islington added a commit that referenced this issue Oct 12, 2022
@miss-islington @hauntsaninja
gh-96130: Rephrase use of "typecheck" verb for clarity (GH-98144)
d22c35d 
I'm sympathetic to the issue report, especially in case this helps
clarify to new users that Python itself does not do type checking at runtime
(cherry picked from commit ed6344e)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
miss-islington added a commit that referenced this issue Oct 12, 2022
@miss-islington @hauntsaninja
gh-96130: Rephrase use of "typecheck" verb for clarity (GH-98144)
48447d4 
I'm sympathetic to the issue report, especially in case this helps
clarify to new users that Python itself does not do type checking at runtime
(cherry picked from commit ed6344e)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
carljm added a commit to carljm/cpython that referenced this issue Oct 14, 2022
@carljm
Merge branch 'main' into typewatch
6e53514 
* main: (38 commits)
  pythongh-98251: Allow venv to pass along PYTHON* variables to pip and ensurepip when they do not impact path resolution (pythonGH-98259)
  Bpo-41246: IOCP Proactor avoid callback code duplication (python#21399)
  bpo-46364: Use sockets for stdin of asyncio only on AIX (python#30596)
  pythongh-98178: syslog() is not thread-safe on macOS (python#98213)
  Mark all targets in `Doc/Makefile` as `PHONY` (pythonGH-98189)
  pythongh-97982: Factorize PyUnicode_Count() and unicode_count() code (python#98025)
  pythongh-96265: Formatting changes for faq/general (python#98129)
  tutorial: remove "with single quotes" (python#98204)
  pythongh-97669: Remove Tools/scripts/startuptime.py (python#98214)
  signalmodule.c uses _PyErr_WriteUnraisableMsg() (python#98217)
  pythongh-97669: Fix test_tools reference leak (python#98216)
  pythongh-97669: Create Tools/patchcheck/ directory (python#98186)
  pythongh-65046: Link to logging cookbook from asyncio docs (python#98207)
  Formatting fixes in contextlib docs (python#98111)
  pythongh-95276: Add callable entry to the glossary (python#95738)
  pythongh-96130: Rephrase use of "typecheck" verb for clarity (python#98144)
  Fix some incorrect indentation around the main switch (python#98177)
  pythongh-98172: Fix formatting in `except*` docs (python#98173)
  pythongh-97982: Remove asciilib_count() (python#98164)
  pythongh-95756: Free and NULL-out code caches when needed (pythonGH-98181)
  ...
carljm added a commit to carljm/cpython that referenced this issue Oct 14, 2022
@carljm
Merge branch 'main' into cached_property
0bb0c69 
* main: (37 commits)
  pythongh-98251: Allow venv to pass along PYTHON* variables to pip and ensurepip when they do not impact path resolution (pythonGH-98259)
  Bpo-41246: IOCP Proactor avoid callback code duplication (python#21399)
  bpo-46364: Use sockets for stdin of asyncio only on AIX (python#30596)
  pythongh-98178: syslog() is not thread-safe on macOS (python#98213)
  Mark all targets in `Doc/Makefile` as `PHONY` (pythonGH-98189)
  pythongh-97982: Factorize PyUnicode_Count() and unicode_count() code (python#98025)
  pythongh-96265: Formatting changes for faq/general (python#98129)
  tutorial: remove "with single quotes" (python#98204)
  pythongh-97669: Remove Tools/scripts/startuptime.py (python#98214)
  signalmodule.c uses _PyErr_WriteUnraisableMsg() (python#98217)
  pythongh-97669: Fix test_tools reference leak (python#98216)
  pythongh-97669: Create Tools/patchcheck/ directory (python#98186)
  pythongh-65046: Link to logging cookbook from asyncio docs (python#98207)
  Formatting fixes in contextlib docs (python#98111)
  pythongh-95276: Add callable entry to the glossary (python#95738)
  pythongh-96130: Rephrase use of "typecheck" verb for clarity (python#98144)
  Fix some incorrect indentation around the main switch (python#98177)
  pythongh-98172: Fix formatting in `except*` docs (python#98173)
  pythongh-97982: Remove asciilib_count() (python#98164)
  pythongh-95756: Free and NULL-out code caches when needed (pythonGH-98181)
  ...
pablogsal pushed a commit that referenced this issue Oct 22, 2022
@miss-islington @hauntsaninja @pablogsal
gh-96130: Rephrase use of "typecheck" verb for clarity (GH-98144)
7b1be2a 
I'm sympathetic to the issue report, especially in case this helps
clarify to new users that Python itself does not do type checking at runtime
(cherry picked from commit ed6344e)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir topic-typing
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@ericvsmith @JelleZijlstra @ketozhang @AlexWaygood