boromir674/so-magic

View on GitHub
docs/so_magic.utils.rst

Summary

Maintainability
Test Coverage
so\_magic.utils package
=======================

The utils package provides a set of useful classes (and functions) that are commonly used
by multiple SoMagic components. These classes serve as building blocks for the SoMagic library
and they have been implemented following well-known and established software engineering patterns
and best-practices. After all we want our Magic software to be based on solid foundations.


Submodules Overview
-------------------

so\_magic.utils.command\_factory\_interface module
--------------------------------------------------

.. automodule:: so_magic.utils.command_factory_interface


so\_magic.utils.command\_interface module
-----------------------------------------

.. automodule:: so_magic.utils.command_interface


so\_magic.utils.commands module
-------------------------------

.. automodule:: so_magic.utils.commands
   :noindex:


so\_magic.utils.linear\_mapping module
--------------------------------------

.. automodule:: so_magic.utils.linear_mapping
   :noindex:


so\_magic.utils.mediator module
-------------------------------

.. automodule:: so_magic.utils.mediator
   :noindex:


so\_magic.utils.memoize module
------------------------------

.. automodule:: so_magic.utils.memoize
   :noindex:


so\_magic.utils.notification module
-----------------------------------

.. automodule:: so_magic.utils.notification
   :noindex:


so\_magic.utils.registry module
-------------------------------

.. automodule:: so_magic.utils.registry
   :noindex:


so\_magic.utils.singleton module
--------------------------------

.. automodule:: so_magic.utils.singleton
   :noindex:


so\_magic.utils.transformations module
--------------------------------------

.. automodule:: so_magic.utils.transformations
   :noindex:


Modules of utils package
------------------------

.. toctree::
   :maxdepth: 4

   utils/commands
   utils/linear_mapping
   utils/mediator
   utils/memoize
   utils/notification
   utils/registry
   utils/singleton
   utils/transformations


Exposed python objects (package's public interface)
---------------------------------------------------

.. automodule:: so_magic.utils
   :members:
   :undoc-members:
   :show-inheritance:
   :noindex: