python-uvloop/uvloop/loop.pyi at master · sysfce2/python-uvloop · GitHub

History

316 lines (314 loc) · 10.9 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

import asyncio

import contextvars

import ssl

import sys

from socket import AddressFamily, SocketKind, _Address, _RetAddress, socket

from typing import (

IO,

Any,

Awaitable,

Callable,

Dict,

Generator,

List,

Optional,

Sequence,

Tuple,

TypeVar,

Union,

overload,

)

_T = TypeVar('_T')

_Context = Dict[str, Any]

_ExceptionHandler = Callable[[asyncio.AbstractEventLoop, _Context], Any]

_SSLContext = Union[bool, None, ssl.SSLContext]

_ProtocolT = TypeVar("_ProtocolT", bound=asyncio.BaseProtocol)

class Loop:

def call_soon(

self, callback: Callable[..., Any], *args: Any, context: Optional[Any] = ...

) -> asyncio.Handle: ...

def call_soon_threadsafe(

self, callback: Callable[..., Any], *args: Any, context: Optional[Any] = ...

) -> asyncio.Handle: ...

def call_later(

self, delay: float, callback: Callable[..., Any], *args: Any, context: Optional[Any] = ...

) -> asyncio.TimerHandle: ...

def call_at(

self, when: float, callback: Callable[..., Any], *args: Any, context: Optional[Any] = ...

) -> asyncio.TimerHandle: ...

def time(self) -> float: ...

def stop(self) -> None: ...

def run_forever(self) -> None: ...

def close(self) -> None: ...

def get_debug(self) -> bool: ...

def set_debug(self, enabled: bool) -> None: ...

def is_running(self) -> bool: ...

def is_closed(self) -> bool: ...

def create_future(self) -> asyncio.Future[Any]: ...

if sys.version_info >= (3, 13):

def create_task(

self,

coro: Union[Awaitable[_T], Generator[Any, None, _T]],

context: Optional[contextvars.Context] = ...,

eager_start: Optional[bool] = ...,

) -> asyncio.Task[_T]: ...

elif sys.version_info >= (3, 11):

def create_task(

self,

coro: Union[Awaitable[_T], Generator[Any, None, _T]],

context: Optional[contextvars.Context] = ...,

) -> asyncio.Task[_T]: ...

else:

def create_task(

self,

coro: Union[Awaitable[_T], Generator[Any, None, _T]],

) -> asyncio.Task[_T]: ...

def set_task_factory(

self,

factory: Optional[

Callable[[asyncio.AbstractEventLoop, Generator[Any, None, _T]], asyncio.Future[_T]]

) -> None: ...

def get_task_factory(

self,

) -> Optional[

Callable[[asyncio.AbstractEventLoop, Generator[Any, None, _T]], asyncio.Future[_T]]

]: ...

@overload

def run_until_complete(self, future: Generator[Any, None, _T]) -> _T: ...

@overload

def run_until_complete(self, future: Awaitable[_T]) -> _T: ...

async def getaddrinfo(

self,

host: Optional[Union[str, bytes]],

port: Optional[Union[str, bytes, int]],

family: int = ...,

type: int = ...,

proto: int = ...,

flags: int = ...,

) -> List[

Tuple[

AddressFamily,

SocketKind,

int,

str,

Union[Tuple[str, int], Tuple[str, int, int, int]],

]

]: ...

async def getnameinfo(

self,

sockaddr: Union[

Tuple[str, int],

Tuple[str, int, int],

Tuple[str, int, int, int]

flags: int = ...,

) -> Tuple[str, str]: ...

async def start_tls(

self,

transport: asyncio.BaseTransport,

protocol: asyncio.BaseProtocol,

sslcontext: ssl.SSLContext,

server_side: bool = ...,

server_hostname: Optional[str] = ...,

ssl_handshake_timeout: Optional[float] = ...,

ssl_shutdown_timeout: Optional[float] = ...,

) -> asyncio.BaseTransport: ...

@overload

async def create_server(

self,

protocol_factory: asyncio.events._ProtocolFactory,

host: Optional[Union[str, Sequence[str]]] = ...,

port: int = ...,

family: int = ...,

flags: int = ...,

sock: None = ...,

backlog: int = ...,

ssl: _SSLContext = ...,

reuse_address: Optional[bool] = ...,

reuse_port: Optional[bool] = ...,

ssl_handshake_timeout: Optional[float] = ...,

ssl_shutdown_timeout: Optional[float] = ...,

start_serving: bool = ...,

) -> asyncio.AbstractServer: ...

@overload

async def create_server(

self,

protocol_factory: asyncio.events._ProtocolFactory,

host: None = ...,

port: None = ...,

family: int = ...,

flags: int = ...,

sock: socket = ...,

backlog: int = ...,

ssl: _SSLContext = ...,

reuse_address: Optional[bool] = ...,

reuse_port: Optional[bool] = ...,

ssl_handshake_timeout: Optional[float] = ...,

ssl_shutdown_timeout: Optional[float] = ...,

start_serving: bool = ...,

) -> asyncio.AbstractServer: ...

@overload

async def create_connection(

self,

protocol_factory: Callable[[], _ProtocolT],

host: str = ...,

port: int = ...,

ssl: _SSLContext = ...,

family: int = ...,

proto: int = ...,

flags: int = ...,

sock: None = ...,

local_addr: Optional[Tuple[str, int]] = ...,

server_hostname: Optional[str] = ...,

ssl_handshake_timeout: Optional[float] = ...,

ssl_shutdown_timeout: Optional[float] = ...,

) -> tuple[asyncio.BaseProtocol, _ProtocolT]: ...

@overload

async def create_connection(

self,

protocol_factory: Callable[[], _ProtocolT],

host: None = ...,

port: None = ...,

ssl: _SSLContext = ...,

family: int = ...,

proto: int = ...,

flags: int = ...,

sock: socket,

local_addr: None = ...,

server_hostname: Optional[str] = ...,

ssl_handshake_timeout: Optional[float] = ...,

ssl_shutdown_timeout: Optional[float] = ...,

) -> tuple[asyncio.BaseProtocol, _ProtocolT]: ...

async def create_unix_server(

self,

protocol_factory: asyncio.events._ProtocolFactory,

path: Optional[str] = ...,

backlog: int = ...,

sock: Optional[socket] = ...,

ssl: _SSLContext = ...,

ssl_handshake_timeout: Optional[float] = ...,

ssl_shutdown_timeout: Optional[float] = ...,

start_serving: bool = ...,

) -> asyncio.AbstractServer: ...

async def create_unix_connection(

self,

protocol_factory: Callable[[], _ProtocolT],

path: Optional[str] = ...,

ssl: _SSLContext = ...,

sock: Optional[socket] = ...,

server_hostname: Optional[str] = ...,

ssl_handshake_timeout: Optional[float] = ...,

ssl_shutdown_timeout: Optional[float] = ...,

) -> tuple[asyncio.BaseProtocol, _ProtocolT]: ...

def default_exception_handler(self, context: _Context) -> None: ...

def get_exception_handler(self) -> Optional[_ExceptionHandler]: ...

def set_exception_handler(self, handler: Optional[_ExceptionHandler]) -> None: ...

def call_exception_handler(self, context: _Context) -> None: ...

def add_reader(self, fd: Any, callback: Callable[..., Any], *args: Any) -> None: ...

def remove_reader(self, fd: Any) -> None: ...

def add_writer(self, fd: Any, callback: Callable[..., Any], *args: Any) -> None: ...

def remove_writer(self, fd: Any) -> None: ...

async def sock_recv(self, sock: socket, nbytes: int) -> bytes: ...

async def sock_recv_into(self, sock: socket, buf: bytearray) -> int: ...

async def sock_sendall(self, sock: socket, data: bytes) -> None: ...

async def sock_accept(self, sock: socket) -> Tuple[socket, _RetAddress]: ...

async def sock_connect(self, sock: socket, address: _Address) -> None: ...

async def sock_recvfrom(self, sock: socket, bufsize: int) -> bytes: ...

async def sock_recvfrom_into(self, sock: socket, buf: bytearray, nbytes: int = ...) -> int: ...

async def sock_sendto(self, sock: socket, data: bytes, address: _Address) -> None: ...

async def connect_accepted_socket(

self,

protocol_factory: Callable[[], _ProtocolT],

sock: socket,

ssl: _SSLContext = ...,

ssl_handshake_timeout: Optional[float] = ...,

ssl_shutdown_timeout: Optional[float] = ...,

) -> tuple[asyncio.BaseProtocol, _ProtocolT]: ...

async def run_in_executor(

self, executor: Any, func: Callable[..., _T], *args: Any

) -> _T: ...

def set_default_executor(self, executor: Any) -> None: ...

async def subprocess_shell(

self,

protocol_factory: Callable[[], _ProtocolT],

cmd: Union[bytes, str],

stdin: Any = ...,

stdout: Any = ...,

stderr: Any = ...,

**kwargs: Any,

) -> tuple[asyncio.BaseProtocol, _ProtocolT]: ...

async def subprocess_exec(

self,

protocol_factory: Callable[[], _ProtocolT],

*args: Any,

stdin: Any = ...,

stdout: Any = ...,

stderr: Any = ...,

**kwargs: Any,

) -> tuple[asyncio.BaseProtocol, _ProtocolT]: ...

async def connect_read_pipe(

self, protocol_factory: Callable[[], _ProtocolT], pipe: Any

) -> tuple[asyncio.BaseProtocol, _ProtocolT]: ...

async def connect_write_pipe(

self, protocol_factory: Callable[[], _ProtocolT], pipe: Any

) -> tuple[asyncio.BaseProtocol, _ProtocolT]: ...

def add_signal_handler(

self, sig: int, callback: Callable[..., Any], *args: Any

) -> None: ...

def remove_signal_handler(self, sig: int) -> bool: ...

async def create_datagram_endpoint(

self,

protocol_factory: Callable[[], _ProtocolT],

local_addr: Optional[Tuple[str, int]] = ...,

remote_addr: Optional[Tuple[str, int]] = ...,

family: int = ...,

proto: int = ...,

flags: int = ...,

reuse_address: Optional[bool] = ...,

reuse_port: Optional[bool] = ...,

allow_broadcast: Optional[bool] = ...,

sock: Optional[socket] = ...,

) -> tuple[asyncio.BaseProtocol, _ProtocolT]: ...

async def shutdown_asyncgens(self) -> None: ...

async def shutdown_default_executor(

self,

timeout: Optional[float] = ...,

) -> None: ...

# Loop doesn't implement these, but since they are marked as abstract in typeshed,

# we have to put them in so mypy thinks the base methods are overridden

async def sendfile(

self,

transport: asyncio.BaseTransport,

file: IO[bytes],

offset: int = ...,

fallback: bool = ...,

) -> int: ...

async def sock_sendfile(

self,

sock: socket,

file: IO[bytes],

offset: int = ...,

fallback: bool = ...

) -> int: ...

python-uvloop/uvloop/loop.pyi at master · sysfce2/python-uvloop · GitHub

Expand file tree

Breadcrumbs

loop.pyi

Latest commit

History

Breadcrumbs

loop.pyi

File metadata and controls