server.core
===========

.. py:module:: server.core


Attributes
----------

.. autoapisummary::

   server.core.local_hostnames


Classes
-------

.. autoapisummary::

   server.core._OptionalDictConfigArgs
   server.core.Request
   server.core.Server


Module Contents
---------------

.. py:class:: _OptionalDictConfigArgs

   Bases: :py:obj:`TypedDict`


   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)


   .. py:attribute:: version
      :type:  Literal[1]


   .. py:attribute:: formatters
      :type:  dict[str, logging.config._FormatterConfiguration]


   .. py:attribute:: filters
      :type:  dict[str, logging.config._FilterConfiguration]


   .. py:attribute:: handlers
      :type:  dict[str, logging.config._HandlerConfiguration]


   .. py:attribute:: loggers
      :type:  dict[str, logging.config._LoggerConfiguration]


   .. py:attribute:: root
      :type:  logging.config._RootLoggerConfiguration


   .. py:attribute:: incremental
      :type:  bool


   .. py:attribute:: disable_existing_loggers
      :type:  bool


.. py:data:: local_hostnames

.. py:class:: Request(environ, charset=None, unicode_errors=None, decode_param_names=None, **kw)

   Bases: :py:obj:`webob.request.BaseRequest`


   .. py:attribute:: hostname_keys
      :value: ('HTTP_HOST', 'HTTP_X_VHM_HOST')



   .. py:property:: hostnames
      :type: collections.abc.Iterator[str]


      Iterates through the hostnames of the request. 



.. py:class:: Server(config: server.config.Config, configure_morepath: bool = True, configure_logging: bool = True, post_mortem: bool = False, environ_overrides: dict[str, Any] | None = None, exception_hook: collections.abc.Callable[[_typeshed.wsgi.WSGIEnvironment], Any] | None = None)

   A WSGI application that hosts multiple WSGI applications in the
   same process.

   Not to be confused with Morepath's mounting functionality. The morepath
   applications hosted by this WSGI application are root applications, not
   mounted applications.

   See `Morepath's way of nesting applications
   <https://morepath.readthedocs.org/en/latest/app_reuse.html
   #nesting-applications>`_

   Applications are hosted in two ways:

   1. As static applications under a base path (`/app`)
   2. As wildcard applications under a base path with wildcard (`/sites/*`)

   There is no further nesting and there is no way to run an application
   under `/`.

   The idea for this server is to run a number of WSGI applications that
   are relatively independent, but share a common framework. Though thought
   to be used with Morepath this module does not try to assume anything but
   a WSGI application.

   Since most of the time we *will* be running morepath applications, this
   server automatically configures morepath for the applications that depend
   on it.

   If morepath autoconfig is not desired, set ``configure_morepath`` to False.



   .. py:attribute:: applications


   .. py:attribute:: wildcard_applications


   .. py:attribute:: post_mortem
      :value: False



   .. py:attribute:: environ_overrides
      :value: None



   .. py:attribute:: exception_hook
      :value: None



   .. py:method:: configure_logging(config: _OptionalDictConfigArgs | logging.config._DictConfigArgs) -> None

      Configures the python logging.

      :config:
          A dictionary that is understood by python's
          `logging.config.dictConfig` method.




   .. py:method:: configure_morepath() -> None

      Configures morepath automatically, if any application uses it. 



   .. py:method:: handle_request(environ: _typeshed.wsgi.WSGIEnvironment, start_response: _typeshed.wsgi.StartResponse) -> collections.abc.Iterable[bytes]


   .. py:method:: __call__(environ: _typeshed.wsgi.WSGIEnvironment, start_response: _typeshed.wsgi.StartResponse) -> collections.abc.Iterable[bytes]