NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
PyPI, #1896 most downloaded on PyPI
Adaptive API testing for OpenAPI, GraphQL, and gRPC
Latest stable
4.33.1
Last release 18 days ago
04 Nov 2026
Ships fairly regularly
a new release about every 2 weeks
Nearly every release is documented
notes for 60 of the last 60 stable releases
Nothing withdrawn
no release was ever pulled
7 years old
507 releases · first in 2019
Drag across the ruler to compare, or tap a release to open it.
Improve error message for failing Hypothesis deadline healthcheck in CLI. #880
Support for disabling ANSI color escape codes via the NO_COLOR \ environment variable or the --no-color CLI option. #1153
NO_COLOR \<https://no-color.org/\>
environment variable or the --no-color CLI option. #1153Your coding agent can read these notes before it upgrades. Set up the MCP server →
Bump minimum hypothesis-graphql version to 0.5.0. It brings support for interfaces and unions and fixes a couple of bugs in query generation.
hypothesis-graphql version to 0.5.0. It brings
support for interfaces and unions and fixes a couple of bugs in
query generation.Bump minimum hypothesis-graphql version to 0.4.1. It fixes a problem with generating queries with surrogate characters.
Windows: UnicodeDecodeError during schema loading via the from_path loader if it contains certain Unicode symbols. from_path loader defaults to UTF-8
UnicodeDecodeError during schema loading via the
from_path loader if it contains certain Unicode symbols.
from_path loader defaults to UTF-8
from now on.Using parametrized pytest fixtures with the from_pytest_fixture loader. #1121
pytest fixtures with the from_pytest_fixture
loader. #1121Custom keyword arguments to schemathesis.graphql.from_url that are proxied to requests.post.
schemathesis.graphql.from_url that are
proxied to requests.post.from_wsgi, from_asgi, from_path and from_file loaders for
GraphQL apps. #1097, #1100data_generation_methods and code_sample_style in all
GraphQL loaders.app & base_url arguments for the
from_pytest_fixture runner.import schemathesis
# Load schema
schema = schemathesis.graphql.from_url("http://127.0.0.1:8000/graphql")
# Initialize runner
runner = schemathesis.runner.from_schema(schema)
# Emit events
for event in runner.execute():
...
Breaking
# BEFORE
schema = schemathesis.from_uri("http://example.com/openapi.json", "http://127.0.0.1:8000/", "GET")
# NOW
schema = schemathesis.from_uri("http://example.com/openapi.json", base_url="http://127.0.0.1:8000/", method="GET")
Query type. It makes the testing process unified for both
Open API and GraphQL schemas.Query field instead of
HTTP method & path.schemathesis.graphql.from_url loader now uses the usual
Schemathesis User-Agent.schemathesis.loaders is moved to
schemathesis.specs.openapi.loaders.from_path
loader in the Schemathesis runner.schemathesis.runner.prepare will be removed in Schemathesis 4.0.
Use schemathesis.runner.from_schema instead. With this change, the
schema loading part goes to your code, similar to using the regular
Schemathesis Python API. It leads to a unified user experience where
the starting point is API schema loading, which is much clearer than
passing a callback & keyword arguments to the prepare function.@schema.given implementation for schemas created
via the from_pytest_fixture loader. #1093@schema.given.make_case for GraphQL schemas.operation_id argument in from_asgi loader.fixups argument for
schemathesis.runner.prepare is removed.Do not use importlib-metadata==3.8 in dependencies as it causes RuntimeError. Ref:
importlib-metadata==3.8 in
dependencies as it causes RuntimeError. Ref:
https://github.com/python/importlib_metadata/issues/293Prefix worker thread names with schemathesis_.
schemathesis_.Encoding for response payloads displayed in the CLI output. #1073
flask.Response.mimetype_params) when
storing WSGI responses rather than defaulting to
flask.Response.charset.before_generate_case hook, that allows the user to modify or filter generated Case instances. #1067
event_type field to the debug output.
event_type field to the debug output.--debug-output-file CLI option to enable storing the underlying runner events in the JSON Lines format in a separate file for debugging purposes. #105
--debug-output-file CLI option to enable storing the underlying
runner events in the JSON Lines format in a separate file for
debugging purposes. #1059Request.body, Response.body and Response.encoding
internal attributes optional. For Request, it means that absent
body will lead to Request.body to be None. For Response,
body will be None if the app response did not have any payload.
Previously these values were empty strings, which was not
distinguishable from the cases described above. For the end-user, it
means that in VCR cassettes, fields request.body and
response.body may be absent.models.Status enum now has string values for more readable
representation.Displaying wrong headers in the FAILURES block of the CLI output. #792
FAILURES block of the CLI output. #792Display failing response payload in the CLI output, similarly to the pytest plugin output. #1050
UnicodeDecodeError when generating cURL commands for failed test
case reproduction if the request's body contains non-UTF8
characters.Internal
Support for Hypothesis 6. #1013
Wrong test results in some cases when the tested schema contains a media type that Schemathesis doesn't know how to work with. #1046
Add an internal caching layer for data generation strategies. It relies on the fact that the internal BaseSchema structure is not mutated over time. I
BaseSchema structure is not
mutated over time. It is not directly possible through the public
API and is discouraged from doing through hook functions.APIOperation and subclasses of Parameter are now compared by
their identity rather than by value.count_operations boolean flag to runner.prepare. In case of False value, Schemathesis won't count the total number of operations upfront. It improves
count_operations boolean flag to runner.prepare. In case of
False value, Schemathesis won't count the total number of
operations upfront. It improves performance for the direct runner
usage, especially on large schemas. Schemathesis CLI will still use
these calculations to display the progress during execution, but
this behavior may become configurable in the future.Percent-encode the generated . and .. strings in path parameters to avoid resolving relative paths and changing the tested path structure. #1036
. and .. strings in path parameters
to avoid resolving relative paths and changing the tested path
structure. #1036Loosen importlib-metadata version constraint and update pyproject.toml. #1039
importlib-metadata version constraint and update pyproject.toml. #1039Support for external examples via the externalValue keyword. #884
Return a default terminal size to prevent crashes on systems with zero-width terminals (some CI/CD servers).
This release updates the documentation to be in-line with the current state.
Docker tags for Buster-based images.
Packaging-only release for Docker images based on Debian Buster. #1028
Allow to use any iterable type for checks and additional_checks arguments to Case.validate_response.
checks and additional_checks
arguments to Case.validate_response.Generating stateful tests, with common parameters behind a reference. #1020
add_link when schema
validation is disabled and response status codes are noted as
integers. #1022operationId then the same
reference resolving logic is applied as in other cases. This change
leads to less reference inlining and lower memory consumption for
deeply nested schemas. #945Flaky Hypothesis error during explicit examples generation. #1018
Flaky Hypothesis error during explicit examples generation. #1018Processing parameters common for multiple API operations if they are behind a reference. #1015
YAML serialization for text/yaml, text/x-yaml, application/x-yaml and text/vnd.yaml media types. #1010.
text/yaml, text/x-yaml,
application/x-yaml and text/vnd.yaml media types. #1010.--skip-deprecated-endpoints is renamed to --skip-deprecated-operations. #869
text/plain payload as test data. Including
variants with non-default charset. #850, #939application/json).response_schema_conformance check
now runs on media types that are encoded with JSON. For example,
application/problem+json. #920--dry-run CLI option. When applied, Schemathesis won't send any
data to the server and won't perform any response checks. #963required: true in path parameters definition is now
automatically enforced if schema validation is disabled. According
to the Open API spec, the required keyword value should be true
for path parameters. This change allows Schemathesis to generate
test cases even for endpoints containing optional path parameters
(which is not compliant with the spec). #941--auth together with --header that sets the
Authorization header causes a validation error. Before, the
--header value was ignored in such cases, and the basic auth
passed in --auth was used. #911hypothesis-jsonschema fails to resolve recursive references,
the test is skipped with an error message that indicates why it
happens.{"type": "integer", "minimum": 5, "maximum": 4}.--operations instead of
--endpoints.Collected API operations instead of collected endpoints
in the CLI. #869--skip-deprecated-endpoints is renamed to
--skip-deprecated-operations. #869endpoint in
their names. #869hypothesis-jsonschema version to 0.19.0. This version
improves the handling of unsupported regular expression syntax and
can generate data for a subset of schemas containing such regular
expressions.null as request payload if the schema expects it. #919GET and has payload examples. #925--exitfirst CLI option trims the progress bar output when a
failure occurs. #951Unsatisfiable errors. #904Unsatisfiable error in stateful testing caused by all API
operations having inbound links. #965, #822APIStateMachine.step. #970TypeError on nullable parameters during Open API specific
serialization. #980x-examples. #982HookContext.endpoint. Use HookContext.operation instead.Case.endpoint. Use Case.operation instead.Case.form_data. Use Case.body instead.Endpoint.form_data. Use Endpoint.body instead.before_generate_form_data hook. Use before_generate_body
instead.pytest plugin.[!NOTE] This release features multiple backward-incompatible changes. The first one is removing
form_dataand hooks related to it -all payload related actions can be done viabodyand its hooks. The second one involves renaming the so-called "endpoint" to "operation". The main reason for this is to generalize terminology and make it applicable to GraphQL schemas, as all Schemathesis internals are more suited to work with semantically different API operations rather than with endpoints that are often connected with URLs and HTTP methods. It brings the possibility to reuse the same concepts for Open API and GraphQL - in the future, unit tests will cover individual API operations in GraphQL, rather than everything available under the same "endpoint".
Support for Werkzeug\>=2.1.0. #1410
auto variant for the --workers CLI option that automatically detects the number of available CPU cores to run tests on. #917
auto variant for the --workers CLI option that automatically
detects the number of available CPU cores to run tests on. #917Use --request-tls-verify during schema loading as well. #897
--request-tls-verify during schema loading as well. #897Display failed response payload in the error output for the pytest plugin. #895
pytest
plugin. #895CheckFailed name. Before, they had
not readable "internal" names.Case
attributes with default values to improve readability. #886Internal error in CLI, when the base_url is an invalid IPv6. #890
--force-schema-version CLI option to force Schemathesis to use the specific Open API spec version when parsing the schema. #876
--force-schema-version CLI option to force Schemathesis to use the
specific Open API spec version when parsing the schema. #876content_type_conformance check now raises a well-formed error
message when encounters a malformed media type value. #877value key. #882In the 3.0 release, you'll need to use relevant body attributes instead. This change includes deprecation of the before_generate_form_data hook, use b…
--request-tls-verify CLI option, that controls whether
Schemathesis verifies the server's TLS certificate. You can also
pass the path to a CA_BUNDLE file for private certs. #830--validate-schema CLI option. #855response_schema_conformance
check. Before, all responses were required to have the
Content-Type header. #844OverflowError when an invalid regex is passed to -E / -M
/ -T / -O CLI options. #870Case.form_data and Endpoint.form_data. In the 3.0
release, you'll need to use relevant body attributes instead. This
change includes deprecation of the before_generate_form_data hook,
use before_generate_body instead. The reason for this is the
upcoming unification of parameter handling and their serialization.--stateful-recursion-limit. It will be removed in 3.0 as a part
of removing the old stateful testing approach. This parameter is
no-op.Missed headers in Endpoint.partial_deepcopy.
headers in Endpoint.partial_deepcopy.An option to set data generation methods. At the moment, it includes only "positive", which means that Schemathesis will generate data that matches th
attrs that caused an error on fresh
installations. #858Invalid keyword in code samples that Schemathesis suggests to run to reproduce errors. #851
New relative_path property for BeforeExecution and AfterExecution events. It represents an operation path as it is in the schema definition.
relative_path property for BeforeExecution and
AfterExecution events. It represents an operation path as it is in
the schema definition.Internal error on malformed JSON when the response_conformance check is used. #832
response_conformance
check is used. #832Shortcut for response validation when Schemathesis's data generation is not used. #485
--app command-line option. #836Adding new Open API links via the add_link method, when the related PathItem contains a reference. #824
add_link method, when the
related PathItem contains a reference. #824New approach to stateful testing, based on the Hypothesis's RuleBasedStateMachine. #737
RuleBasedStateMachine. #737Case.validate_response accepts the new additional_checks
argument. It provides a way to execute additional checks in addition
to existing ones.response_schema_conformance and content_type_conformance
checks fail unconditionally if the input response has no
Content-Type header. #816call_* methods during testing. #814stateful=Stateful.links in schema loaders and parametrize.
Use schema.as_state_machine().TestCase instead. The old approach
to stateful testing will be removed in 3.0. See the
Stateful testing section of our documentation for more
information.New method as_curl_command added to the Case class. #689
as_curl_command added to the Case class. #689Ability to skip deprecated endpoints with --skip-deprecated-endpoints CLI option and skip_deprecated_operations=True argument to schema loaders. #715
schema.parametrize by using schema.given decorator. #768rstcheck, as well as updates to
documentation based on rstcheck. #734--max-response-time. #716response_headers_conformance check that verifies the presence
of all headers defined for a response. #742port parameter added to from_uri() method. #706--skip-deprecated-endpoints CLI option and
skip_deprecated_operations=True argument to schema loaders. #715User-Agent header overriding the passed one. #757User-Agent header in Case.call. #717Case.as_requests_kwargs and Case.as_werkzeug_kwargs now return
the User-Agent header. This change also affects code snippets for
failure reproduction - all snippets will include the User-Agent
header.headers, cookies, and formData
parameters when their schemas do not define the type keyword. #795This release contains only documentation updates which are necessary to upload to PyPI.
This release contains only documentation updates which are necessary to upload to PyPI.
Stateful testing via Open API links for the pytest runner. #616
pytest runner. #616pytest runner. #649stateful argument type in the runner.prepare is
Optional[Stateful] instead of Optional[str]. Use
schemathesis.Stateful enum.Hide Case.endpoint from representation. Its representation decreases the usability of the pytest's output. #719
Case.endpoint from representation. Its representation
decreases the usability of the pytest's output. #719register_target and
register_check decorators. #721IndexError when a user-defined check raises an exception
without a message. #718Ability to register custom targets for targeted testing. #686
AfterExecution event now has path and method fields,
similar to the BeforeExecution one. The goal is to make these
events self-contained, which improves their usability.The default Hypothesis's deadline setting for tests with schema.parametrize is set to 500 ms for consistency with the CLI behavior. #705
KeyError during the content_type_conformance check if the response has no Content-Type header. #692
KeyError during the content_type_conformance check if the
response has no Content-Type header. #692### :rocket: Added - Run checks conditionally.
IndexError when examples list is empty.
IndexError when examples list is empty.Possibility to generate values for in: formData parameters that are non-bytes or contain non-bytes (e.g., inside an array). #665
in: formData parameters that
are non-bytes or contain non-bytes (e.g., inside an array). #665required: true in
its definition. #667hypothesis-jsonschema version to
0.17.0. This allows Schemathesis to
use the custom_formats argument in from_schema calls and avoid
using its private API. #684ValueError during sending a request with test payload if the
endpoint defines a parameter with type: array and in: formData. #661KeyError while processing a schema with nullable parameters and
in: body. #660StopIteration during requestBody processing if it has empty
"content" value. #673AttributeError during generation of "multipart/form-data"
parameters that have no "type" defined. #675TypeError. #672graphql-server-core package. #658Possible UnicodeEncodeError during generation of Authorization header values for endpoints with basic security scheme. #656
UnicodeEncodeError during generation of Authorization
header values for endpoints with basic security scheme. #656schemathesis.graphql.from_dict loader allows you to use GraphQL schemas represented as a dictionary for testing.
schemathesis.graphql.from_dict loader allows you to use GraphQL
schemas represented as a dictionary for testing.before_load_schema hook for GraphQL schemas.One column per quarter.