Pytest-httpserver

=====

.. _Release Notes_1.0.4_Bug Fixes:

Bug Fixes
---------

- Fixed type hinting of ``HeaderValueMatcher.DEFAULT_MATCHERS``, which did
not allow modifications, however it is explicitly allowed in the documentation.


.. _Release Notes_1.0.4_Other Notes:

Other Notes
-----------

- Version of flake8 library updated to require 4.0.0+ at minimum. This is
required to make flake8 working on recent python versions.


.. _Release Notes_1.0.3:

=====

.. _Release Notes_1.0.3_New Features:

New Features
------------

- Additional type hints improvements to make the library more mypy compliant.
Imports in `__init__.py` have been updated to indicate that this is a
namespace package.


.. _Release Notes_1.0.3_Other Notes:

Other Notes
-----------

- Package deployment and CI has been migrated to poetry. poetry.lock will be kept
up to date. Make target "quick-test" renamed to "test". Also, minor adjustments
were made regarding documentation generation. Make targets should be identical.
Build results like sdist, and wheel are almost identical to the one which was
made by setuptools.


.. _Release Notes_1.0.2:

=====

.. _Release Notes_1.0.2_New Features:

New Features
------------

- Type hints updated to conform to 'mypy' type checking tool.
Also, py.typed file is added as package data according to PEP 561.


.. _Release Notes_1.0.2_Deprecation Notes:

Deprecation Notes
-----------------

- Python 3.4 and 3.5 versions have been deprecated in order to support type
hints in the source code. Users using 3.5 and earlier releases encouraged
to upgrade to later versions. Please node that 3.5 reached EOL in September
of 2020 and no longer receives security fixes.


.. _Release Notes_1.0.1:

=====

.. _Release Notes_1.0.1_New Features:

New Features
------------

- Improved error handling of custom request handlers. Request handlers added
with ``respond_with_handler`` now can use the ``assert`` statement. Those
errors will be reported when a further ``check_assertions()`` call is made.
Also, unhandled exceptions raised in the request handlers can be re-raised
by calling the new ``check_handler_errors()`` method. A new method called
``check()`` has been added which calls these two in sequence.


.. _Release Notes_1.0.0:

=====

.. _Release Notes_1.0.0_Prelude:

Prelude
-------

Functionally the same as 1.0.0rc1. For the list of changes between 0.3.8 and 1.0.0 see the changelist for 1.0.0rc1.


.. _Release Notes_1.0.0rc1:

========

.. _Release Notes_1.0.0rc1_New Features:

New Features
------------

- Added a new session scoped fixture ``make_httpserver`` which creates the
object for the ``httpserver`` fixture. It can be overridden to add further
customizations and it must yield a ``HTTPServer`` object - see
``pytest_plugin.py`` for an implementation. As this fixture is session
scoped, it will be called only once when the first test using httpserver is
started. This addition also deprecates the use of ``PluginHTTPServer`` which was
used in earlier versions as a way to customize server object creation.
``PluginHTTPServer`` can still be used but it may be subject to deprecation
in the future.

- Added a new session scoped fixture ``httpserver_ssl_context`` which provides
the SSL context for the server. By default it returns ``None``, so SSL is
not enabled, but can be overridden to return a valid ``ssl.SSLContext``
object which will be used for SSL connections. See test_ssl.py for example.


.. _Release Notes_1.0.0rc1_Upgrade Notes:

Upgrade Notes
-------------

- **Breaking change**: The scope of ``httpserver_listen_address`` fixture changed from **function**
to **session**. This is a requirement to implement the other features listed
in this release. See the `upgrade guide
<https://pytest-httpserver.readthedocs.io/en/latest/upgrade.html>`_ for the
details.


.. _Release Notes_0.3.8: