types-WebTest 3.0.0.20260612__py3-none-any.whl

types_webtest-3.0.0.20260612.dist-info/METADATA

@@ -0,0 +1,41 @@
+Metadata-Version: 2.4
+Name: types-WebTest
+Version: 3.0.0.20260612
+Summary: Typing stubs for WebTest
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/python/typeshed
+Project-URL: GitHub, https://github.com/python/typeshed
+Project-URL: Changes, https://github.com/typeshed-internal/stub_uploader/blob/main/data/changelogs/WebTest.md
+Project-URL: Issue tracker, https://github.com/python/typeshed/issues
+Project-URL: Chat, https://gitter.im/python/typing
+Classifier: Programming Language :: Python :: 3
+Classifier: Typing :: Stubs Only
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: types-waitress
+Requires-Dist: types-WebOb
+Requires-Dist: beautifulsoup4
+Dynamic: license-file
+
+## Typing stubs for WebTest
+
+This is a [type stub package](https://typing.python.org/en/latest/tutorials/external_libraries.html)
+for the [`WebTest`](https://github.com/Pylons/webtest) package. It can be used by type checkers
+to check code that uses `WebTest`. This version of
+`types-WebTest` aims to provide accurate annotations for
+`WebTest==3.0.*`.
+
+This package is part of the [typeshed project](https://github.com/python/typeshed).
+All fixes for types and metadata should be contributed there.
+See [the README](https://github.com/python/typeshed/blob/main/README.md)
+for more details. The source for this package can be found in the
+[`stubs/WebTest`](https://github.com/python/typeshed/tree/main/stubs/WebTest)
+directory.
+
+This package was tested with the following type checkers:
+* [mypy](https://github.com/python/mypy/) 2.1.0
+* [pyright](https://github.com/microsoft/pyright) 1.1.410
+
+It was generated from typeshed commit
+[`7e1dfd9d2db07c7c846b1cb7235cda67f30878d2`](https://github.com/python/typeshed/commit/7e1dfd9d2db07c7c846b1cb7235cda67f30878d2).

types_webtest-3.0.0.20260612.dist-info/RECORD

@@ -0,0 +1,13 @@
+types_webtest-3.0.0.20260612.dist-info/licenses/LICENSE,sha256=KV-FOMlK5cMEMwHPfP8chS2ranhqjd7kceBhtA1eyr4,12657
+webtest-stubs/METADATA.toml,sha256=djZ2LE8VQbEY1-EH2dsmfuP9CfonkqMBMJhghUKmQ8g,143
+webtest-stubs/__init__.pyi,sha256=K38SsaQvUe5yYAn0dBHG_6PWAYNbtsnDpbx1KTE5KoA,397
+webtest-stubs/app.pyi,sha256=t-MebZdl4d4P9Wl8kcFOd_1_IRF23nIqdk3-t9vOPCE,7560
+webtest-stubs/debugapp.pyi,sha256=_J00HKt4GoSzV9meZTO6qZLHbCz1-f-WThoFquhQ-1k,769
+webtest-stubs/forms.pyi,sha256=Iz9KQMG2rcgi_uUWZUBULHTpb8LhvSYGb-Qd9ZZk0oY,6887
+webtest-stubs/http.pyi,sha256=EEJ0CgXRIfi3cedcJYcx2J55R5MlsEcD8DPmrSURU6Q,1288
+webtest-stubs/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+webtest-stubs/response.pyi,sha256=xWejO5yvd4qPuEqxCZsznJeafNu4HSbRah6Kxxas-xo,3276
+types_webtest-3.0.0.20260612.dist-info/METADATA,sha256=5GhH3SMQnDp8tznkdTSS6WwN1gQCD33Qc4nEnGzJvRM,1814
+types_webtest-3.0.0.20260612.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+types_webtest-3.0.0.20260612.dist-info/top_level.txt,sha256=Q8NAC4miPkn0sFqhHmWVaM7UBwpXG2jeh9oJuZylVB4,14
+types_webtest-3.0.0.20260612.dist-info/RECORD,,

types_webtest-3.0.0.20260612.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

types_webtest-3.0.0.20260612.dist-info/licenses/LICENSE

@@ -0,0 +1,237 @@
+The "typeshed" project is licensed under the terms of the Apache license, as
+reproduced below.
+
+= = = = =
+
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+= = = = =
+
+Parts of typeshed are licensed under different licenses (like the MIT
+license), reproduced below.
+
+= = = = =
+
+The MIT License
+
+Copyright (c) 2015 Jukka Lehtosalo and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+
+= = = = =

types_webtest-3.0.0.20260612.dist-info/top_level.txt

@@ -0,0 +1 @@
+webtest-stubs

webtest-stubs/METADATA.toml

@@ -0,0 +1,3 @@
+version = "3.0.*"
+upstream-repository = "https://github.com/Pylons/webtest"
+dependencies = ["beautifulsoup4", "types-waitress", "types-WebOb"]

webtest-stubs/__init__.pyi

@@ -0,0 +1,14 @@
+from webtest.app import AppError as AppError, TestApp as TestApp, TestRequest as TestRequest
+from webtest.forms import (
+    Checkbox as Checkbox,
+    Field as Field,
+    Form as Form,
+    Hidden as Hidden,
+    Radio as Radio,
+    Select as Select,
+    Submit as Submit,
+    Text as Text,
+    Textarea as Textarea,
+    Upload as Upload,
+)
+from webtest.response import TestResponse as TestResponse

webtest-stubs/app.pyi

@@ -0,0 +1,206 @@
+import json
+from _typeshed import SupportsItems, SupportsKeysAndGetItem
+from _typeshed.wsgi import WSGIApplication, WSGIEnvironment
+from collections.abc import Iterable, Sequence
+from http.cookiejar import CookieJar, DefaultCookiePolicy
+from typing import Any, Generic, Literal, TypeAlias, TypeVar
+
+from webob.request import BaseRequest
+from webtest.forms import File, Upload
+from webtest.response import TestResponse
+
+# NOTE: While it is possible to pass different kinds of values depending on
+#       the exact configuration of the request, it seems more robust to
+#       restrict them to the types that are supported by all code paths.
+#       I don't expect anyone to try to pass different kinds of values
+#       in a non-JSON request.
+_ParamValue: TypeAlias = File | Upload | int | bytes | str
+_Params: TypeAlias = SupportsItems[str | bytes, _ParamValue] | Sequence[tuple[str | bytes, _ParamValue]]
+# NOTE: Using `Collection` rather than `Iterable` would probably be slightly
+#       safer since WebTest will check this parameter for truthyness. But since
+#       objects are truthy by default, this should only lead to issues in truly
+#       exotic cases.
+_ExtraEnviron: TypeAlias = SupportsKeysAndGetItem[str, Any] | Iterable[tuple[str, Any]]
+_Files: TypeAlias = Sequence[tuple[str, str] | tuple[str, str, bytes]]
+_AppT = TypeVar("_AppT", bound=WSGIApplication, default=WSGIApplication)
+
+__all__ = ["TestApp", "TestRequest"]
+
+class AppError(Exception):
+    def __init__(self, message: str, *args: object) -> None: ...
+
+class CookiePolicy(DefaultCookiePolicy): ...
+
+class TestRequest(BaseRequest):
+    ResponseClass: type[TestResponse]
+    __test__: Literal[False]
+
+class TestApp(Generic[_AppT]):
+    RequestClass: type[TestRequest]
+    app: _AppT
+    lint: bool
+    relative_to: str | None
+    extra_environ: WSGIEnvironment
+    use_unicode: bool
+    cookiejar: CookieJar
+    JSONEncoder: json.JSONEncoder
+    __test__: Literal[False]
+    def __init__(
+        self,
+        app: _AppT,
+        # NOTE: this extra_environ is different from the others and needs to
+        #       support __delitem__, it seems easiest to just treat this like
+        #       a regular WSGIEnvironment. The docs also say that this should
+        #       be a dictionary.
+        extra_environ: WSGIEnvironment | None = None,
+        relative_to: str | None = None,
+        use_unicode: bool = True,
+        cookiejar: CookieJar | None = None,
+        parser_features: Sequence[str] | str | None = None,
+        json_encoder: json.JSONEncoder | None = None,
+        lint: bool = True,
+    ) -> None: ...
+    def get_authorization(self) -> tuple[str, str | tuple[str, str]]: ...
+    def set_authorization(self, value: tuple[str, str | tuple[str, str]]) -> None: ...
+
+    @property
+    def authorization(self) -> tuple[str, str | tuple[str, str]]: ...
+    @authorization.setter
+    def authorization(self, value: tuple[str, str | tuple[str, str]]) -> None: ...
+
+    @property
+    def cookies(self) -> dict[str, str | None]: ...
+    def set_cookie(self, name: str, value: str | None) -> None: ...
+    def reset(self) -> None: ...
+    def set_parser_features(self, parser_features: Sequence[str] | str) -> None: ...
+    def get(
+        self,
+        url: str,
+        params: _Params | str | None = None,
+        headers: dict[str, str] | None = None,
+        extra_environ: _ExtraEnviron | None = None,
+        status: int | str | None = None,
+        expect_errors: bool = False,
+        xhr: bool = False,
+    ) -> TestResponse: ...
+    def post(
+        self,
+        url: str,
+        params: _Params | str = "",
+        headers: dict[str, str] | None = None,
+        extra_environ: _ExtraEnviron | None = None,
+        status: int | str | None = None,
+        upload_files: _Files | None = None,
+        expect_errors: bool = False,
+        content_type: str | None = None,
+        xhr: bool = False,
+    ) -> TestResponse: ...
+    def put(
+        self,
+        url: str,
+        params: _Params | str = "",
+        headers: dict[str, str] | None = None,
+        extra_environ: _ExtraEnviron | None = None,
+        status: int | str | None = None,
+        upload_files: _Files | None = None,
+        expect_errors: bool = False,
+        content_type: str | None = None,
+        xhr: bool = False,
+    ) -> TestResponse: ...
+    def patch(
+        self,
+        url: str,
+        params: _Params | str = "",
+        headers: dict[str, str] | None = None,
+        extra_environ: _ExtraEnviron | None = None,
+        status: int | str | None = None,
+        upload_files: _Files | None = None,
+        expect_errors: bool = False,
+        content_type: str | None = None,
+        xhr: bool = False,
+    ) -> TestResponse: ...
+    def delete(
+        self,
+        url: str,
+        params: _Params | str = "",
+        headers: dict[str, str] | None = None,
+        extra_environ: _ExtraEnviron | None = None,
+        status: int | str | None = None,
+        expect_errors: bool = False,
+        content_type: str | None = None,
+        xhr: bool = False,
+    ) -> TestResponse: ...
+    def options(
+        self,
+        url: str,
+        headers: dict[str, str] | None = None,
+        extra_environ: _ExtraEnviron | None = None,
+        status: int | str | None = None,
+        expect_errors: bool = False,
+        xhr: bool = False,
+    ) -> TestResponse: ...
+    def head(
+        self,
+        url: str,
+        params: _Params | str | None = None,
+        headers: dict[str, str] | None = None,
+        extra_environ: _ExtraEnviron | None = None,
+        status: int | str | None = None,
+        expect_errors: bool = False,
+        xhr: bool = False,
+    ) -> TestResponse: ...
+    def post_json(
+        self,
+        url: str,
+        params: Any = ...,
+        *,
+        headers: dict[str, str] | None = None,
+        extra_environ: _ExtraEnviron | None = None,
+        status: int | str | None = None,
+        expect_errors: bool = False,
+        content_type: str | None = None,
+        xhr: bool = False,
+    ) -> TestResponse: ...
+    def put_json(
+        self,
+        url: str,
+        params: Any = ...,
+        *,
+        headers: dict[str, str] | None = None,
+        extra_environ: _ExtraEnviron | None = None,
+        status: int | str | None = None,
+        expect_errors: bool = False,
+        content_type: str | None = None,
+        xhr: bool = False,
+    ) -> TestResponse: ...
+    def patch_json(
+        self,
+        url: str,
+        params: Any = ...,
+        *,
+        headers: dict[str, str] | None = None,
+        extra_environ: _ExtraEnviron | None = None,
+        status: int | str | None = None,
+        expect_errors: bool = False,
+        content_type: str | None = None,
+        xhr: bool = False,
+    ) -> TestResponse: ...
+    def delete_json(
+        self,
+        url: str,
+        params: Any = ...,
+        *,
+        headers: dict[str, str] | None = None,
+        extra_environ: _ExtraEnviron | None = None,
+        status: int | str | None = None,
+        expect_errors: bool = False,
+        content_type: str | None = None,
+        xhr: bool = False,
+    ) -> TestResponse: ...
+    def encode_multipart(self, params: Iterable[tuple[str | bytes, _ParamValue]], files: _Files) -> tuple[str, bytes]: ...
+    def request(
+        self, url_or_req: str | TestRequest, status: int | str | None = None, expect_errors: bool = False, **req_params: Any
+    ) -> TestResponse: ...
+    def do_request(
+        self, req: TestRequest, status: int | str | None = None, expect_errors: bool | None = None
+    ) -> TestResponse: ...

webtest-stubs/debugapp.pyi

@@ -0,0 +1,22 @@
+from _typeshed import StrOrBytesPath
+from _typeshed.wsgi import StartResponse, WSGIEnvironment
+from collections.abc import Iterable
+from typing import TypedDict, type_check_only
+from typing_extensions import Unpack
+
+@type_check_only
+class _DebugAppParams(TypedDict, total=False):
+    form: StrOrBytesPath | bytes | None
+    show_form: bool
+
+__all__ = ["DebugApp", "make_debug_app"]
+
+class DebugApp:
+    form: bytes | None
+    show_form: bool
+    def __init__(self, form: StrOrBytesPath | bytes | None = None, show_form: bool = False) -> None: ...
+    def __call__(self, environ: WSGIEnvironment, start_response: StartResponse) -> Iterable[bytes]: ...
+
+debug_app: DebugApp
+
+def make_debug_app(global_conf: object, **local_conf: Unpack[_DebugAppParams]) -> DebugApp: ...

webtest-stubs/forms.pyi

@@ -0,0 +1,191 @@
+from collections.abc import Collection, Generator, Iterable, Sequence
+from typing import Any, TypeAlias, TypedDict, TypeVar, overload, type_check_only
+
+from bs4 import BeautifulSoup
+from webtest.response import TestResponse
+
+_T = TypeVar("_T")
+
+@type_check_only
+class _Classes(TypedDict):
+    submit: type[Submit]
+    button: type[Submit]
+    image: type[Submit]
+    multiple_select: type[MultipleSelect]
+    select: type[Select]
+    hidden: type[Hidden]
+    file: type[File]
+    text: type[Text]
+    search: type[Text]
+    email: type[Email]
+    password: type[Text]
+    checkbox: type[Checkbox]
+    textarea: type[Textarea]
+    radio: type[Radio]
+
+# NOTE: It seems unergonomic having to put isinstance checks everywhere
+#       in your test code where you're accessing a form field, so we
+#       return `Any` for now. What we would really like to use here is
+#       `AnyOf`, but that doesn't exist yet.
+_AnyField: TypeAlias = Any
+
+class NoValue: ...
+
+class Upload:
+    filename: str
+    content: bytes | None
+    content_type: str | None
+    def __init__(self, filename: str, content: bytes | None = None, content_type: str | None = None) -> None: ...
+    def __iter__(self) -> Generator[str | bytes]: ...
+
+class Field:
+    classes: _Classes
+    form: Form
+    tag: str
+    name: str
+    pos: int
+    id: str
+    attrs: dict[str, str]
+    def __init__(
+        self, form: Form, tag: str, name: str, pos: int, value: str | None = None, id: str | None = None, **attrs: str
+    ) -> None: ...
+    def value__get(self) -> str: ...
+    def value__set(self, value: str | None) -> None: ...
+
+    @property
+    def value(self) -> str: ...
+    @value.setter
+    def value(self, value: str | None) -> None: ...
+
+    def force_value(self, value: str | None) -> None: ...
+
+class Select(Field):
+    options: list[tuple[str, bool, str]]
+    optionPositions: list[int]
+    selectedIndex: int | None
+
+    # NOTE: Even though it's safe to pass any object into text, I don't
+    #       think that follows the spirit of this argument and is more
+    #       likely a consequence of reusing the same utility function
+    #       in order to handle bytes for Py2 compat.
+    @overload
+    def select(self, value: None, text: str | bytes) -> None: ...
+    @overload
+    def select(self, value: None = None, *, text: str | bytes) -> None: ...
+    @overload
+    def select(self, value: object, text: None = None) -> None: ...
+
+    def value__get(self) -> str: ...
+    def value__set(self, value: object | None) -> None: ...
+
+    @property
+    def value(self) -> str: ...
+    @value.setter
+    def value(self, value: object | None) -> None: ...
+
+class MultipleSelect(Field):
+    options: list[tuple[str, bool, str]]
+    selectedIndices: list[int]
+
+    @overload
+    def select_multiple(self, value: None, texts: Iterable[str | bytes]) -> None: ...
+    @overload
+    def select_multiple(self, value: None = None, *, texts: Iterable[str | bytes]) -> None: ...
+    @overload
+    def select_multiple(self, value: Collection[object], texts: None = None) -> None: ...
+
+    def value__get(self) -> list[str] | None: ...  # type: ignore[override]
+    def value__set(self, values: Collection[object] | None) -> None: ...
+
+    @property  # type: ignore[override]
+    def value(self) -> list[str] | None: ...
+    @value.setter
+    def value(self, value: Collection[object] | None) -> None: ...
+
+    # NOTE: Since unlike setting the value normally this doesn't perform
+    #       any kind of type conversion, we're better off only allowing
+    #       what `value__get` is supposed to be able to return.
+    def force_value(self, values: list[str] | None) -> None: ...  # type: ignore[override]
+
+class Radio(Select): ...
+
+class Checkbox(Field):
+    def value__get(self) -> str | None: ...  # type: ignore[override]
+    def value__set(self, value: object) -> None: ...
+
+    @property  # type: ignore[override]
+    def value(self) -> str | None: ...
+    @value.setter
+    def value(self, value: object) -> None: ...
+
+    def checked__get(self) -> bool: ...
+    def checked__set(self, value: object) -> None: ...
+
+    @property
+    def checked(self) -> bool: ...
+    @checked.setter
+    def checked(self, value: object) -> None: ...
+
+class Text(Field): ...
+class Email(Field): ...
+class File(Field): ...
+class Textarea(Text): ...
+class Hidden(Text): ...
+
+class Submit(Field):
+    def value__get(self) -> None: ...  # type: ignore[override]
+    @property  # type: ignore[misc]
+    def value(self) -> None: ...  # type: ignore[override]
+    def value_if_submitted(self) -> str: ...
+
+class Form:
+    FieldClass: type[Field]
+    response: TestResponse
+    text: str
+    html: BeautifulSoup
+    action: str
+    method: str
+    id: str | None
+    enctype: str
+    field_order: list[tuple[str, Field]]
+    fields: dict[str, list[Field]]
+    def __init__(self, response: TestResponse, text: str, parser_features: Sequence[str] | str = "html.parser") -> None: ...
+    # NOTE: Technically it is only safe to pass `str | None` for most fields
+    #       but this method is not really usable if we don't lift this
+    #       restriction, we just have to assume people know what they
+    #       are doing
+    def __setitem__(self, name: str, value: Any | None) -> None: ...
+    def set(self, name: str, value: Any | None, index: int | None = None) -> None: ...
+    def __getitem__(self, name: str) -> _AnyField: ...
+
+    @overload
+    def get(self, name: str, index: int | None = None) -> _AnyField: ...
+    @overload
+    def get(self, name: str, index: int | None, default: _T) -> _AnyField | _T: ...
+    @overload
+    def get(self, name: str, index: int | None = None, *, default: _T) -> _AnyField | _T: ...
+
+    @overload
+    def select(self, name: str, value: None, text: str | bytes, index: int | None = None) -> None: ...
+    @overload
+    def select(self, name: str, value: None = None, *, text: str | bytes, index: int | None = None) -> None: ...
+    @overload
+    def select(self, name: str, value: object, text: None = None, index: int | None = None) -> None: ...
+
+    @overload
+    def select_multiple(self, name: str, value: None, texts: Iterable[str | bytes], index: int | None = None) -> None: ...
+    @overload
+    def select_multiple(
+        self, name: str, value: None = None, *, texts: Iterable[str | bytes], index: int | None = None
+    ) -> None: ...
+    @overload
+    def select_multiple(self, name: str, value: Iterable[object], texts: None = None, index: int | None = None) -> None: ...
+
+    def submit(
+        self, name: str | None = None, index: int | None = None, value: str | None = None, **args: Any
+    ) -> TestResponse: ...
+    def lint(self) -> None: ...
+    def upload_fields(self) -> list[tuple[str, str] | tuple[str, str, bytes]]: ...
+    def submit_fields(
+        self, name: str | None = None, index: int | None = None, submit_value: str | None = None
+    ) -> list[tuple[str, str]]: ...

webtest-stubs/http.pyi

@@ -0,0 +1,30 @@
+from _typeshed import Incomplete
+from _typeshed.wsgi import StartResponse, WSGIApplication, WSGIEnvironment
+from collections.abc import Iterable
+from threading import Thread
+from typing import Literal, TypeAlias
+from typing_extensions import Self
+
+from waitress.server import TcpWSGIServer
+
+# NOTE: We may never really be able to complete this, since `create`
+#       invokes `cls.__init__` which is exempt from LSP violations
+#       unless we get something like `KwArgsOf[cls.__init__]`.
+_WSGIServerParams: TypeAlias = Incomplete
+
+def get_free_port() -> tuple[str, int]: ...
+def check_server(host: str, port: int, path_info: str = "/", timeout: float = 3, retries: int = 30) -> int: ...
+
+class StopableWSGIServer(TcpWSGIServer):
+    was_shutdown: bool
+    runner: Thread
+    test_app: WSGIApplication
+    application_url: str
+    def wrapper(self, environ: WSGIEnvironment, start_response: StartResponse) -> Iterable[bytes]: ...
+    def run(self) -> None: ...
+    def shutdown(self, debug: bool = False) -> Literal[True]: ...
+    # NOTE: This has the same keyword arguments as cls.__init__, which
+    #       we can't express
+    @classmethod
+    def create(cls, application: WSGIApplication, **kwargs: _WSGIServerParams) -> Self: ...
+    def wait(self, retries: int = 30) -> bool: ...

webtest-stubs/response.pyi

@@ -0,0 +1,93 @@
+import re
+from _typeshed.wsgi import WSGIApplication
+from collections.abc import Callable, Mapping, Sequence
+from typing import Any, Literal, TypeAlias, TypedDict, overload, type_check_only
+from typing_extensions import Unpack
+from xml.etree import ElementTree
+
+from bs4 import BeautifulSoup
+from webob import Response
+from webtest.app import TestApp, TestRequest, _Files
+from webtest.forms import Form
+
+_Pattern: TypeAlias = str | bytes | re.Pattern[str] | Callable[[str], bool]
+# NOTE: These are optional dependencies, so we don't want to depend on them
+#       in the stubs either. Also there are no stubs for pyquery anyways.
+_PyQuery: TypeAlias = Any
+_PyQueryParams: TypeAlias = Any
+_LxmlElement: TypeAlias = Any
+
+@type_check_only
+class _GetParams(TypedDict, total=False):
+    params: Mapping[str, str] | str
+    headers: Mapping[str, str]
+    extra_environ: Mapping[str, Any]
+    status: int | str | None
+    expect_errors: bool
+    xhr: bool
+
+@type_check_only
+class _PostParams(_GetParams, total=False):
+    upload_files: _Files
+    content_type: str
+
+class TestResponse(Response):
+    # NOTE: The way WebTest creates reponses the request is always set
+    #       we could've used `MaybeNone`, but it seems more pragmatic
+    #       to just assume that this is always set.
+    request: TestRequest  # type: ignore[assignment]
+    app: WSGIApplication
+    test_app: TestApp
+    parser_features: str | Sequence[str]
+    __test__: Literal[False]
+    @property
+    def forms(self) -> dict[str | int, Form]: ...
+    @property
+    def form(self) -> Form: ...
+    @property
+    def testbody(self) -> str: ...
+    def follow(self, **kw: Unpack[_GetParams]) -> TestResponse: ...
+    def maybe_follow(self, **kw: Unpack[_GetParams]) -> TestResponse: ...
+    def click(
+        self,
+        description: _Pattern | None = None,
+        linkid: _Pattern | None = None,
+        href: _Pattern | None = None,
+        index: int | None = None,
+        verbose: bool = False,
+        extra_environ: dict[str, Any] | None = None,
+    ) -> TestResponse: ...
+    def clickbutton(
+        self,
+        description: _Pattern | None = None,
+        buttonid: _Pattern | None = None,
+        href: _Pattern | None = None,
+        onclick: str | None = None,
+        index: int | None = None,
+        verbose: bool = False,
+    ) -> TestResponse: ...
+
+    @overload
+    def goto(self, href: str, method: Literal["get"] = "get", **args: Unpack[_GetParams]) -> TestResponse: ...
+    @overload
+    def goto(self, href: str, method: Literal["post"], **args: Unpack[_PostParams]) -> TestResponse: ...
+
+    @property
+    def normal_body(self) -> bytes: ...
+    @property
+    def unicode_normal_body(self) -> str: ...
+    def __contains__(self, s: str) -> bool: ...
+    def mustcontain(self, *strings: str, no: Sequence[str] | str = ...) -> None: ...
+    @property
+    def html(self) -> BeautifulSoup: ...
+    @property
+    def xml(self) -> ElementTree.Element: ...
+    @property
+    def lxml(self) -> _LxmlElement: ...
+    @property
+    def json(self) -> Any: ...
+    @property
+    def pyquery(self) -> _PyQuery: ...
+    def PyQuery(self, **kwargs: _PyQueryParams) -> _PyQuery: ...
+    def showbrowser(self) -> None: ...
+    def __str__(self) -> str: ...  # type: ignore[override]  # noqa: Y029