python / python/typeshed

Invalid overloads in `asyncio.(base_)events`

Open
#9,652 0 comments 0 reactions 1 assignee View on GitHub

@JelleZijlstra is already working on this.

Since Feb 1, 2023.

topic: asyncio
Dominant language
Python
Stars
5.1k
Forks
2.1k
Avg merge
1d 19h
Merged PRs (30d)
82

Description

Stubdefaulter would like us to apply this diff to our asyncio stubs. Stubdefaulter is correct about what the defaults are for these functions at runtime, but mypy correctly points out that applying this diff as-is would be invalid: a parameter annotated with str cannot have a None default, etc. etc.

Plainly, these overloads are incorrect in some way. Unfortunately, I'm not sure what the correct fix is. I'd appreciate it if somebody who knows their asyncio better than I do would be able to take a look :)

(This is a followup issue to #9608, which is completed other than this remaining issue.)

The affected functions are:

  • asyncio.base_events.create_connection
  • asyncio.base_events.create_server
  • asyncio.events.create_connection
  • asyncio.events.create_server
diff --git a/stdlib/asyncio/base_events.pyi b/stdlib/asyncio/base_events.pyi
index 3b8f28671..7e0601863 100644
--- a/stdlib/asyncio/base_events.pyi
+++ b/stdlib/asyncio/base_events.pyi
@@ -156,8 +156,8 @@ class BaseEventLoop(AbstractEventLoop):
         async def create_connection(
             self,
             protocol_factory: Callable[[], _ProtocolT],
-            host: str = ...,
-            port: int = ...,
+            host: str = None,
+            port: int = None,
             *,
             ssl: _SSLContext = None,
             family: int = 0,
@@ -284,7 +284,7 @@ class BaseEventLoop(AbstractEventLoop):
             self,
             protocol_factory: _ProtocolFactory,
             host: str | Sequence[str] | None = None,
-            port: int = ...,
+            port: int = None,
             *,
             family: int = ...,
             flags: int = ...,
@@ -305,7 +305,7 @@ class BaseEventLoop(AbstractEventLoop):
             *,
             family: int = ...,
             flags: int = ...,
-            sock: socket = ...,
+            sock: socket = None,
             backlog: int = 100,
             ssl: _SSLContext = None,
             reuse_address: bool | None = None,
diff --git a/stdlib/asyncio/events.pyi b/stdlib/asyncio/events.pyi
index b2292801e..cff0775d6 100644
--- a/stdlib/asyncio/events.pyi
+++ b/stdlib/asyncio/events.pyi
@@ -250,8 +250,8 @@ class AbstractEventLoop:
         async def create_connection(
             self,
             protocol_factory: Callable[[], _ProtocolT],
-            host: str = ...,
-            port: int = ...,
+            host: str = None,
+            port: int = None,
             *,
             ssl: _SSLContext = None,
             family: int = 0,
@@ -388,7 +388,7 @@ class AbstractEventLoop:
             self,
             protocol_factory: _ProtocolFactory,
             host: str | Sequence[str] | None = None,
-            port: int = ...,
+            port: int = None,
             *,
             family: int = ...,
             flags: int = ...,
@@ -410,7 +410,7 @@ class AbstractEventLoop:
             *,
             family: int = ...,
             flags: int = ...,
-            sock: socket = ...,
+            sock: socket = None,
             backlog: int = 100,
             ssl: _SSLContext = None,
             reuse_address: bool | None = None,

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.