QtHttpServer.pyi 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291
  1. # Copyright (C) 2022 The Qt Company Ltd.
  2. # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
  3. """
  4. This file contains the exact signatures for all functions in module
  5. PySide6.QtHttpServer, except for defaults which are replaced by "...".
  6. """
  7. # mypy: disable-error-code="override, overload-overlap"
  8. # Module `PySide6.QtHttpServer`
  9. import PySide6.QtHttpServer
  10. import PySide6.QtCore
  11. import PySide6.QtNetwork
  12. import os
  13. import enum
  14. import typing
  15. import collections.abc
  16. from shiboken6 import Shiboken
  17. class QAbstractHttpServer(PySide6.QtCore.QObject):
  18. def __init__(self, /, parent: PySide6.QtCore.QObject | None = ...) -> None: ...
  19. @typing.overload
  20. def bind(self, server: PySide6.QtNetwork.QLocalServer, /) -> bool: ...
  21. @typing.overload
  22. def bind(self, server: PySide6.QtNetwork.QTcpServer, /) -> bool: ...
  23. def http2Configuration(self, /) -> PySide6.QtNetwork.QHttp2Configuration: ...
  24. def localServers(self, /) -> typing.List[PySide6.QtNetwork.QLocalServer]: ...
  25. def serverPorts(self, /) -> typing.List[int]: ...
  26. def servers(self, /) -> typing.List[PySide6.QtNetwork.QTcpServer]: ...
  27. def setHttp2Configuration(self, configuration: PySide6.QtNetwork.QHttp2Configuration, /) -> None: ...
  28. class QFutureHttpServerResponse(Shiboken.Object):
  29. @typing.overload
  30. def __init__(self, /) -> None: ...
  31. @typing.overload
  32. def __init__(self, QFutureHttpServerResponse: PySide6.QtHttpServer.QFutureHttpServerResponse, /) -> None: ...
  33. def __copy__(self, /) -> typing.Self: ...
  34. def cancel(self, /) -> None: ...
  35. def cancelChain(self, /) -> None: ...
  36. def isCanceled(self, /) -> bool: ...
  37. def isFinished(self, /) -> bool: ...
  38. def isPaused(self, /) -> bool: ...
  39. def isRunning(self, /) -> bool: ...
  40. def isStarted(self, /) -> bool: ...
  41. def isSuspended(self, /) -> bool: ...
  42. def isSuspending(self, /) -> bool: ...
  43. def isValid(self, /) -> bool: ...
  44. def pause(self, /) -> None: ...
  45. def progressMaximum(self, /) -> int: ...
  46. def progressMinimum(self, /) -> int: ...
  47. def progressText(self, /) -> str: ...
  48. def progressValue(self, /) -> int: ...
  49. def resultCount(self, /) -> int: ...
  50. def resume(self, /) -> None: ...
  51. def setPaused(self, paused: bool, /) -> None: ...
  52. def setSuspended(self, suspend: bool, /) -> None: ...
  53. def suspend(self, /) -> None: ...
  54. def togglePaused(self, /) -> None: ...
  55. def toggleSuspended(self, /) -> None: ...
  56. def waitForFinished(self, /) -> None: ...
  57. class QHttpServer(PySide6.QtHttpServer.QAbstractHttpServer):
  58. def __init__(self, /, parent: PySide6.QtCore.QObject | None = ...) -> None: ...
  59. def addAfterRequestHandler(self, context: PySide6.QtCore.QObject, callback: collections.abc.Callable[..., typing.Any], /) -> None: ...
  60. def clearMissingHandler(self, /) -> None: ...
  61. def handleRequest(self, request: PySide6.QtHttpServer.QHttpServerRequest, responder: PySide6.QtHttpServer.QHttpServerResponder, /) -> bool: ...
  62. def missingHandler(self, request: PySide6.QtHttpServer.QHttpServerRequest, responder: PySide6.QtHttpServer.QHttpServerResponder, /) -> None: ...
  63. def route(self, rule: str, callback: collections.abc.Callable[..., typing.Any], /) -> bool: ...
  64. def router(self, /) -> PySide6.QtHttpServer.QHttpServerRouter: ...
  65. class QHttpServerRequest(Shiboken.Object):
  66. class Method(enum.Flag):
  67. Unknown = 0x0
  68. Get = 0x1
  69. Put = 0x2
  70. Delete = 0x4
  71. Post = 0x8
  72. Head = 0x10
  73. Options = 0x20
  74. Patch = 0x40
  75. Connect = 0x80
  76. Trace = 0x100
  77. AnyKnown = 0x1ff
  78. @typing.overload
  79. def __init__(self, /) -> None: ...
  80. @typing.overload
  81. def __init__(self, other: PySide6.QtHttpServer.QHttpServerRequest, /) -> None: ...
  82. def body(self, /) -> PySide6.QtCore.QByteArray: ...
  83. def headers(self, /) -> PySide6.QtNetwork.QHttpHeaders: ...
  84. def localAddress(self, /) -> PySide6.QtNetwork.QHostAddress: ...
  85. def localPort(self, /) -> int: ...
  86. def method(self, /) -> PySide6.QtHttpServer.QHttpServerRequest.Method: ...
  87. def query(self, /) -> PySide6.QtCore.QUrlQuery: ...
  88. def remoteAddress(self, /) -> PySide6.QtNetwork.QHostAddress: ...
  89. def remotePort(self, /) -> int: ...
  90. def sslConfiguration(self, /) -> PySide6.QtNetwork.QSslConfiguration: ...
  91. def swap(self, other: PySide6.QtHttpServer.QHttpServerRequest, /) -> None: ...
  92. def url(self, /) -> PySide6.QtCore.QUrl: ...
  93. def value(self, key: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /) -> PySide6.QtCore.QByteArray: ...
  94. class QHttpServerResponder(Shiboken.Object):
  95. class StatusCode(enum.Enum):
  96. Continue = 0x64
  97. SwitchingProtocols = 0x65
  98. Processing = 0x66
  99. Ok = 0xc8
  100. Created = 0xc9
  101. Accepted = 0xca
  102. NonAuthoritativeInformation = 0xcb
  103. NoContent = 0xcc
  104. ResetContent = 0xcd
  105. PartialContent = 0xce
  106. MultiStatus = 0xcf
  107. AlreadyReported = 0xd0
  108. IMUsed = 0xe2
  109. MultipleChoices = 0x12c
  110. MovedPermanently = 0x12d
  111. Found = 0x12e
  112. SeeOther = 0x12f
  113. NotModified = 0x130
  114. UseProxy = 0x131
  115. TemporaryRedirect = 0x133
  116. PermanentRedirect = 0x134
  117. BadRequest = 0x190
  118. Unauthorized = 0x191
  119. PaymentRequired = 0x192
  120. Forbidden = 0x193
  121. NotFound = 0x194
  122. MethodNotAllowed = 0x195
  123. NotAcceptable = 0x196
  124. ProxyAuthenticationRequired = 0x197
  125. RequestTimeout = 0x198
  126. Conflict = 0x199
  127. Gone = 0x19a
  128. LengthRequired = 0x19b
  129. PreconditionFailed = 0x19c
  130. PayloadTooLarge = 0x19d
  131. UriTooLong = 0x19e
  132. UnsupportedMediaType = 0x19f
  133. RequestRangeNotSatisfiable = 0x1a0
  134. ExpectationFailed = 0x1a1
  135. ImATeapot = 0x1a2
  136. MisdirectedRequest = 0x1a5
  137. UnprocessableEntity = 0x1a6
  138. Locked = 0x1a7
  139. FailedDependency = 0x1a8
  140. UpgradeRequired = 0x1aa
  141. PreconditionRequired = 0x1ac
  142. TooManyRequests = 0x1ad
  143. RequestHeaderFieldsTooLarge = 0x1af
  144. UnavailableForLegalReasons = 0x1c3
  145. InternalServerError = 0x1f4
  146. NotImplemented = 0x1f5
  147. BadGateway = 0x1f6
  148. ServiceUnavailable = 0x1f7
  149. GatewayTimeout = 0x1f8
  150. HttpVersionNotSupported = 0x1f9
  151. VariantAlsoNegotiates = 0x1fa
  152. InsufficientStorage = 0x1fb
  153. LoopDetected = 0x1fc
  154. NotExtended = 0x1fe
  155. NetworkAuthenticationRequired = 0x1ff
  156. NetworkConnectTimeoutError = 0x257
  157. def sendResponse(self, response: PySide6.QtHttpServer.QHttpServerResponse, /) -> None: ...
  158. def swap(self, other: PySide6.QtHttpServer.QHttpServerResponder, /) -> None: ...
  159. @typing.overload
  160. def write(self, data: PySide6.QtCore.QIODevice, headers: PySide6.QtNetwork.QHttpHeaders, /, status: PySide6.QtHttpServer.QHttpServerResponder.StatusCode = ...) -> None: ...
  161. @typing.overload
  162. def write(self, data: PySide6.QtCore.QIODevice, mimeType: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /, status: PySide6.QtHttpServer.QHttpServerResponder.StatusCode = ...) -> None: ...
  163. @typing.overload
  164. def write(self, headers: PySide6.QtNetwork.QHttpHeaders, /, status: PySide6.QtHttpServer.QHttpServerResponder.StatusCode = ...) -> None: ...
  165. @typing.overload
  166. def write(self, document: PySide6.QtCore.QJsonDocument, headers: PySide6.QtNetwork.QHttpHeaders, /, status: PySide6.QtHttpServer.QHttpServerResponder.StatusCode = ...) -> None: ...
  167. @typing.overload
  168. def write(self, document: PySide6.QtCore.QJsonDocument, /, status: PySide6.QtHttpServer.QHttpServerResponder.StatusCode = ...) -> None: ...
  169. @typing.overload
  170. def write(self, /, status: PySide6.QtHttpServer.QHttpServerResponder.StatusCode = ...) -> None: ...
  171. @typing.overload
  172. def write(self, data: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, headers: PySide6.QtNetwork.QHttpHeaders, /, status: PySide6.QtHttpServer.QHttpServerResponder.StatusCode = ...) -> None: ...
  173. @typing.overload
  174. def write(self, data: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, mimeType: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /, status: PySide6.QtHttpServer.QHttpServerResponder.StatusCode = ...) -> None: ...
  175. @typing.overload
  176. def writeBeginChunked(self, headers: PySide6.QtNetwork.QHttpHeaders, /, status: PySide6.QtHttpServer.QHttpServerResponder.StatusCode = ...) -> None: ...
  177. @typing.overload
  178. def writeBeginChunked(self, headers: PySide6.QtNetwork.QHttpHeaders, trailerNames: collections.abc.Sequence[PySide6.QtNetwork.QHttpHeaders.WellKnownHeader], /, status: PySide6.QtHttpServer.QHttpServerResponder.StatusCode = ...) -> None: ...
  179. @typing.overload
  180. def writeBeginChunked(self, mimeType: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /, status: PySide6.QtHttpServer.QHttpServerResponder.StatusCode = ...) -> None: ...
  181. def writeChunk(self, data: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /) -> None: ...
  182. @typing.overload
  183. def writeEndChunked(self, data: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /) -> None: ...
  184. @typing.overload
  185. def writeEndChunked(self, data: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, trailers: PySide6.QtNetwork.QHttpHeaders, /) -> None: ...
  186. class QHttpServerResponse(Shiboken.Object):
  187. @typing.overload
  188. def __init__(self, data: PySide6.QtCore.QJsonArray, /, status: PySide6.QtHttpServer.QHttpServerResponder.StatusCode = ...) -> None: ...
  189. @typing.overload
  190. def __init__(self, statusCode: PySide6.QtHttpServer.QHttpServerResponder.StatusCode, /) -> None: ...
  191. @typing.overload
  192. def __init__(self, data: str, /, status: PySide6.QtHttpServer.QHttpServerResponder.StatusCode = ...) -> None: ...
  193. @typing.overload
  194. def __init__(self, data: typing.Dict[str, PySide6.QtCore.QJsonValue], /, status: PySide6.QtHttpServer.QHttpServerResponder.StatusCode = ...) -> None: ...
  195. @typing.overload
  196. def __init__(self, data: bytes | bytearray | memoryview, /, status: PySide6.QtHttpServer.QHttpServerResponder.StatusCode = ...) -> None: ...
  197. @typing.overload
  198. def __init__(self, data: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /, status: PySide6.QtHttpServer.QHttpServerResponder.StatusCode = ...) -> None: ...
  199. @typing.overload
  200. def __init__(self, mimeType: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, data: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /, status: PySide6.QtHttpServer.QHttpServerResponder.StatusCode = ...) -> None: ...
  201. def data(self, /) -> PySide6.QtCore.QByteArray: ...
  202. @staticmethod
  203. def fromFile(fileName: str, /) -> PySide6.QtHttpServer.QHttpServerResponse: ...
  204. def headers(self, /) -> PySide6.QtNetwork.QHttpHeaders: ...
  205. def mimeType(self, /) -> PySide6.QtCore.QByteArray: ...
  206. def setHeaders(self, newHeaders: PySide6.QtNetwork.QHttpHeaders, /) -> None: ...
  207. def statusCode(self, /) -> PySide6.QtHttpServer.QHttpServerResponder.StatusCode: ...
  208. def swap(self, other: PySide6.QtHttpServer.QHttpServerResponse, /) -> None: ...
  209. class QHttpServerRouter(Shiboken.Object):
  210. def __init__(self, server: PySide6.QtHttpServer.QAbstractHttpServer, /) -> None: ...
  211. def addConverter(self, metaType: PySide6.QtCore.QMetaType | PySide6.QtCore.QMetaType.Type, regexp: str, /) -> None: ...
  212. def clearConverters(self, /) -> None: ...
  213. def converters(self, /) -> typing.Dict[PySide6.QtCore.QMetaType, str]: ...
  214. def handleRequest(self, request: PySide6.QtHttpServer.QHttpServerRequest, responder: PySide6.QtHttpServer.QHttpServerResponder, /) -> bool: ...
  215. def removeConverter(self, metaType: PySide6.QtCore.QMetaType | PySide6.QtCore.QMetaType.Type, /) -> None: ...
  216. class QHttpServerRouterRule(Shiboken.Object):
  217. def contextObject(self, /) -> PySide6.QtCore.QObject: ...
  218. def exec(self, request: PySide6.QtHttpServer.QHttpServerRequest, responder: PySide6.QtHttpServer.QHttpServerResponder, /) -> bool: ...
  219. def hasValidMethods(self, /) -> bool: ...
  220. def matches(self, request: PySide6.QtHttpServer.QHttpServerRequest, match: PySide6.QtCore.QRegularExpressionMatch, /) -> bool: ...
  221. class QHttpServerWebSocketUpgradeResponse(Shiboken.Object):
  222. class ResponseType(enum.Enum):
  223. Accept = 0x0
  224. Deny = 0x1
  225. PassToNext = 0x2
  226. def __init__(self, other: PySide6.QtHttpServer.QHttpServerWebSocketUpgradeResponse, /) -> None: ...
  227. @staticmethod
  228. def accept() -> PySide6.QtHttpServer.QHttpServerWebSocketUpgradeResponse: ...
  229. @typing.overload
  230. @staticmethod
  231. def deny() -> PySide6.QtHttpServer.QHttpServerWebSocketUpgradeResponse: ...
  232. @typing.overload
  233. @staticmethod
  234. def deny(status: int, message: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /) -> PySide6.QtHttpServer.QHttpServerWebSocketUpgradeResponse: ...
  235. def denyMessage(self, /) -> PySide6.QtCore.QByteArray: ...
  236. def denyStatus(self, /) -> int: ...
  237. @staticmethod
  238. def passToNext() -> PySide6.QtHttpServer.QHttpServerWebSocketUpgradeResponse: ...
  239. def swap(self, other: PySide6.QtHttpServer.QHttpServerWebSocketUpgradeResponse, /) -> None: ...
  240. def type(self, /) -> PySide6.QtHttpServer.QHttpServerWebSocketUpgradeResponse.ResponseType: ...
  241. class QIntList: ...
  242. # eof