server.collection
=================

.. py:module:: server.collection


Classes
-------

.. autoapisummary::

   server.collection.CachedApplication
   server.collection.ApplicationCollection


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

.. py:class:: CachedApplication(application_class: type[server.application.Application], namespace: str, configuration: dict[str, Any] | None = None)

   Wraps an application class with a configuration, returning a new
   instance the first time `get()` is called and the same instance very
   time after that.



   .. py:attribute:: instance
      :type:  server.application.Application | None


   .. py:attribute:: application_class


   .. py:attribute:: configuration


   .. py:attribute:: namespace


   .. py:method:: get() -> server.application.Application


.. py:class:: ApplicationCollection(applications: collections.abc.Iterable[server.config.ApplicationConfig] | None = None)

   Keeps a list of applications and their roots.

   The applications are registered lazily and only instantiated/configured
   once the `get()` is called.


   .. py:attribute:: applications
      :type:  dict[str, CachedApplication]


   .. py:method:: register(root: str, application_class: type[server.application.Application], namespace: str, configuration: dict[str, Any] | None = None) -> None

      Registers the given path for the given application_class and
      configuration.




   .. py:method:: get(root: str) -> server.application.Application | None

      Returns the applicaton for the given path, creating a new instance
      if none exists already.




   .. py:method:: morepath_applications() -> collections.abc.Iterator[CachedApplication]

      Iterates through the applications that depend on morepath.