diff --git a/.buildinfo b/.buildinfo new file mode 100644 index 00000000..de6cefdf --- /dev/null +++ b/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file records the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 340e5b7baec8bbb707c6dbbb166fbb2d +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/_sources/acknowledgements.rst.txt b/_sources/acknowledgements.rst.txt new file mode 100644 index 00000000..664352fb --- /dev/null +++ b/_sources/acknowledgements.rst.txt @@ -0,0 +1,3 @@ +.. include:: ../README.rst + :start-after: inclusion-marker-acknowledgements-begin + :end-before: inclusion-marker-acknowledgements-end diff --git a/_sources/api_documentation.rst.txt b/_sources/api_documentation.rst.txt new file mode 100644 index 00000000..b011d3e4 --- /dev/null +++ b/_sources/api_documentation.rst.txt @@ -0,0 +1,35 @@ +API documentation +================= + +django_structlog +^^^^^^^^^^^^^^^^ + +.. automodule:: django_structlog + :members: + :undoc-members: + :show-inheritance: + +.. automodule:: django_structlog.middlewares + :members: RequestMiddleware + :undoc-members: + :show-inheritance: + +.. automodule:: django_structlog.signals + :members: bind_extra_request_metadata, bind_extra_request_finished_metadata, bind_extra_request_failed_metadata, update_failure_response + + +django_structlog.celery +^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: django_structlog.celery + :members: + :undoc-members: + :show-inheritance: + +.. automodule:: django_structlog.celery.steps + :members: DjangoStructLogInitStep + :undoc-members: + :show-inheritance: + +.. automodule:: django_structlog.celery.signals + :members: bind_extra_task_metadata, modify_context_before_task_publish, pre_task_succeeded diff --git a/_sources/authors.rst.txt b/_sources/authors.rst.txt new file mode 100644 index 00000000..714c69f6 --- /dev/null +++ b/_sources/authors.rst.txt @@ -0,0 +1,3 @@ +.. include:: ../README.rst + :start-after: inclusion-marker-authors-begin + :end-before: inclusion-marker-authors-end diff --git a/_sources/celery.rst.txt b/_sources/celery.rst.txt new file mode 100644 index 00000000..8b08fa5f --- /dev/null +++ b/_sources/celery.rst.txt @@ -0,0 +1,181 @@ +.. _celery_integration: + +Celery Integration +================== + +Getting Started with Celery +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +In order to be able to support celery you need to configure both your webapp and your workers + +.. warning:: + If json is used to serialize your celery tasks, the log context in use when executing a task (through ``apply_async`` or ``delay``) should only contain JSON-serializable data. You can use modify_context_before_task_publish_ to ensure this is the case. + +Replace your requirements +------------------------- + +First of all, make sure your ``django-structlog`` installation knows you use ``celery`` in order to validate compatibility with your installed version. See `Installing “Extras” `_ for more information. + +Replace ``django-structlog`` with ``django-structlog[celery]`` in your ``requirements.txt``. + +.. code-block:: python + + django-structlog[celery]==X.Y.Z + +Enable celery integration in your web app +----------------------------------------- + +In your settings.py + +.. code-block:: python + + MIDDLEWARE = [ + # ... + 'django_structlog.middlewares.RequestMiddleware', + ] + + DJANGO_STRUCTLOG_CELERY_ENABLED = True + + +Initialize Celery Worker with DjangoStructLogInitStep +----------------------------------------------------- + +In your celery AppConfig's module. + +.. code-block:: python + + import logging + + import structlog + from celery import Celery + from celery.signals import setup_logging + from django_structlog.celery.steps import DjangoStructLogInitStep + + app = Celery("your_celery_project") + + # A step to initialize django-structlog + app.steps['worker'].add(DjangoStructLogInitStep) + + +.. warning:: + If you use ``celery``'s `task_protocol v1 `_, ``django-structlog`` will not be able to transfer metadata to child task. + + Ex: + + .. code-block:: python + + app = Celery("your_celery_project", task_protocol=1) + +Configure celery's logger +------------------------- + +In the same file as before + +.. code-block:: python + + @setup_logging.connect + def receiver_setup_logging(loglevel, logfile, format, colorize, **kwargs): # pragma: no cover + logging.config.dictConfig( + { + "version": 1, + "disable_existing_loggers": False, + "formatters": { + "json_formatter": { + "()": structlog.stdlib.ProcessorFormatter, + "processor": structlog.processors.JSONRenderer(), + }, + "plain_console": { + "()": structlog.stdlib.ProcessorFormatter, + "processor": structlog.dev.ConsoleRenderer(), + }, + "key_value": { + "()": structlog.stdlib.ProcessorFormatter, + "processor": structlog.processors.KeyValueRenderer(key_order=['timestamp', 'level', 'event', 'logger']), + }, + }, + "handlers": { + "console": { + "class": "logging.StreamHandler", + "formatter": "plain_console", + }, + "json_file": { + "class": "logging.handlers.WatchedFileHandler", + "filename": "logs/json.log", + "formatter": "json_formatter", + }, + "flat_line_file": { + "class": "logging.handlers.WatchedFileHandler", + "filename": "logs/flat_line.log", + "formatter": "key_value", + }, + }, + "loggers": { + "django_structlog": { + "handlers": ["console", "flat_line_file", "json_file"], + "level": "INFO", + }, + "django_structlog_demo_project": { + "handlers": ["console", "flat_line_file", "json_file"], + "level": "INFO", + }, + } + } + ) + + structlog.configure( + processors=[ + structlog.contextvars.merge_contextvars, + structlog.stdlib.filter_by_level, + structlog.processors.TimeStamper(fmt="iso"), + structlog.stdlib.add_logger_name, + structlog.stdlib.add_log_level, + structlog.stdlib.PositionalArgumentsFormatter(), + structlog.processors.StackInfoRenderer(), + structlog.processors.format_exc_info, + structlog.processors.UnicodeDecoder(), + structlog.stdlib.ProcessorFormatter.wrap_for_formatter, + ], + logger_factory=structlog.stdlib.LoggerFactory(), + cache_logger_on_first_use=True, + ) + + +.. _celery_signals: + +Signals +^^^^^^^ + +.. _modify_context_before_task_publish: + +modify_context_before_task_publish +---------------------------------- + +You can connect to ``modify_context_before_task_publish`` signal in order to modify the metadata before it is stored in the task's message. + +By example you can strip down the ``context`` to keep only some of the keys: + +.. code-block:: python + + @receiver(signals.modify_context_before_task_publish) + def receiver_modify_context_before_task_publish(sender, signal, context, task_routing_key=None, task_properties=None, **kwargs): + keys_to_keep = {"request_id", "parent_task_id"} + new_dict = {key_to_keep: context[key_to_keep] for key_to_keep in keys_to_keep if key_to_keep in context} + context.clear() + context.update(new_dict) + + +bind_extra_task_metadata +------------------------ + +You can optionally connect to ``bind_extra_task_metadata`` signal in order to bind more metadata to the logger or override existing bound metadata. This is called +in celery's ``receiver_task_pre_run``. + +.. code-block:: python + + from django_structlog.celery import signals + import structlog + + @receiver(signals.bind_extra_task_metadata) + def receiver_bind_extra_request_metadata(sender, signal, task=None, logger=None, **kwargs): + structlog.contextvars.bind_contextvars(correlation_id=task.request.correlation_id) + diff --git a/_sources/changelog.rst.txt b/_sources/changelog.rst.txt new file mode 100644 index 00000000..5eb2df54 --- /dev/null +++ b/_sources/changelog.rst.txt @@ -0,0 +1,544 @@ +Change Log +========== + +9.0.0 (November 26, 2024) +------------------------- + +See: :ref:`upgrade_9.0` + +*New:* + - Add type definitions for the project. See `#697 `_ and `#696 `_. Special thanks to `@j00bar `_ and `@MaxDude132 `_ for the review. + +*Changes:* + - ``RequestMiddleware`` now relies on django signal `got_request_exception `_ instead of Middleware `process_exception `_ method. See `#705 `_, `#658 `_ and :ref:`upgrade_9.0`. Special thanks to `@sshishov `_. + - Add python 3.13 support. See `#674 `_. + - Drop python 3.8 support. See `#674 `_. + - Django 5.1 and celery 5.4 support. See `#617 `_. + +*Other:* + - Migrated project to use python 3.13 along with readthedocs generation. + - now use `isort `_ + - fixed ``codecov`` github action that was not properly configured and therefore not properly reporting coverage. + + +8.1.0 (May 24, 2024) +-------------------- + +*New:* + - Add a :ref:`setting ` ``DJANGO_STRUCTLOG_USER_ID_FIELD = 'pk'`` to customize what user field to use as ``user_id`` in the logs. See `#546 `_ and `#545 `_. Special thanks to `@sshishov `_. + +*Changes:* + - Drop support of python 3.7 + - Drop support of django 3.2, and 4.1 + + +8.0.0 (March 13, 2024) +---------------------- + +See: :ref:`upgrade_8.0` + +*New:* + - add ``log_kwargs`` to :class:`django_structlog.signals.bind_extra_request_metadata`, :class:`django_structlog.signals.bind_extra_request_finished_metadata`, and :class:`django_structlog.signals.bind_extra_request_failed_metadata`. See `#484 `_. Special thanks to `@shtoltz `_. + + +7.1.0 (December 20, 2023) +------------------------- + +*New:* + - add ``asgi``'s async view cancellation event ``request_cancelled``. See `#413 `_ and and :ref:`request_events`. + + +7.0.0 (December 13, 2023) +------------------------- + +See: :ref:`upgrade_7.0` + +*New:* + - (celery) add ``priority`` (if available) and ``routing_key`` to ``task_enqueued``. See `#345 `_ and `#341 `_. Special thanks to `badziyoussef `_. + - Django 5.0 support. See `#350 `_. Take note async view cancellation when using ``asgi`` does not work yet, see `#351 `_. + - Add streaming response support (for both sync and async) and Django 5's async cancellation. See `#353 `_ and :ref:`streaming_response_events`. + +*Changes:* + - Supports django-ipware 6+ only. See `#403 `_. Special thanks to the maintainer `@un33k `_. + - Drop support of django 4.0. See `#338 `_. Special thanks to `@jairhenrique `_. + +*Other:* + - Improved demo project + - Better UI + - Easy switch between ``runserver_plus``, ``wsgi`` an ``asgi`` + - Front-end request feedbacks using ``toasts`` + + +6.0.1 (November 29, 2023) +------------------------- +*Fixes:* + - freeze ``django-ipware<6`` for now due to breaking changes. See `#388 `_ + + +6.0 (October 3, 2023) +--------------------- + +See: :ref:`upgrade_6.0` + +*New:* + - Python 3.12 support + - Add support of logging :ref:`commands` + - ``task_revoked`` has now a ``signame`` metadata. See `#323 `_. + - ``task_not_found`` has now a ``task_id`` and a ``task`` metadata. See `#323 `_. + +*Fixes:* + - Add missing metadata when a task is revoked. See `#317 `_. Special thanks to `@badziyoussef `_. + +*Changes:* + - Drop support of python 3.7 + - Drop legacy code still supporting celery < 4 + - Removal of deprecated: + - :class:`django_structlog.middlewares.CeleryMiddleware` + - :class:`django_structlog.middlewares.SyncRequestMiddleware` + - :class:`django_structlog.middlewares.AsyncRequestMiddleware` + - :class:`django_structlog.middlewares.request_middleware_router` + - ``4XX`` status codes now log by default as ``WARNING`` and ``5XX`` as ``ERROR``. The behaviour of ``4XX`` can be customized with :ref:`configuration`. See `#308 `_. Special thanks to `@adinhodovic `_. + - ``task_revoked``'s ``signum`` is now an integer instead of an object. See `#323 `_. + - ``task_not_found``'s ``message`` was removed and replaced by ``task_id`` and ``task``. See `#323 `_. + - ``task_rejected``'s ``message`` was removed and replaced by ``task_id``. See `#323 `_. + - Switched from ``git``'s ``master`` to ``main`` branch + +*Other:* + - Add new :ref:`how_tos` section in the documentation. + + +5.3.0 (June 30, 2023) +--------------------- + +*New:* + - django setting ``DJANGO_STRUCTLOG_CELERY_ENABLED = True`` replacing :class:`django_structlog.middlewares.CeleryMiddleware`. See :ref:`upgrade_6.0` and `#265 `_. Also introduce new internal `app_settings` that may come handy for future configurations. + + +*Deprecations:* + - :class:`django_structlog.middlewares.CeleryMiddleware` (see above). + + +5.2.0 (June 29, 2023) +--------------------- + +*New:* + - Add new event ``task_started``. See `#260 `_. Special thanks to `@adrenaline681 `_. + + +5.1.0 (April 22, 2023) +---------------------- + +*New:* + - Add new signal :class:`django_structlog.signals.update_failure_response` allowing to modify the response in case of failure. See `#231 `_. Special thanks to `@HMaker `_. + +5.0.2 (April 16, 2023) +---------------------- + +See: :ref:`upgrade_5.0` + +*Fixes:* + - Fix regression in 5.0.0 and 5.0.1 where exceptions were not logged as ``error`` but as ``info``. See `#226 `_. Special thanks to `@ntap-fge `_. + +*Rollbacks from 5.0.0:* + - Rollback removal of ``django_structlog.signals.bind_extra_request_failed_metadata``. Relates the above fix. + + +5.0.1 (March 24, 2023) +---------------------- + +See: :ref:`upgrade_5.0` + +*Changes:* + - minimum requirements change for ``asgiref`` to 3.6.0. See `#209 `_. Special thanks to `@adinsoon `_. + + +5.0.0 (March 23, 2023) +---------------------- + +See: :ref:`upgrade_5.0` + +*Changes:* + - ``RequestMiddleware`` and ``CeleryMiddleware`` now properly support async views + +*Removed:* + - *(Rolled back in 5.0.2)* ``django_structlog.signals.bind_extra_request_failed_metadata`` + +*Deprecates:* + - :class:`django_structlog.middlewares.request_middleware_router` + - :class:`django_structlog.middlewares.requests.AsyncRequestMiddleware` + - :class:`django_structlog.middlewares.requests.SyncRequestMiddleware` + + +4.1.1 (February 7, 2023) +------------------------ + +*New:* + - Add :class:`django_structlog.middlewares.request_middleware_router` to choose automatically between Async or Sync middleware + +*Rollbacks from 4.1.0:* + - Rollback ``RequestMiddleware`` not being a class anymore, its an internal ``SyncRequestMiddleware`` + +*Others:* + - Migrate project to ``pyproject.toml`` instead of ``setup.py`` + - Add `asgi` server to demo project see :ref:`development`. + + +4.1.0 (February 4, 2023) +------------------------ + +*New:* + - Add `async view `_ support. See `#180 `_. Special thanks to `@DamianMel `_. + +*Changes:* + - ``RequestMiddleware`` is no longer a class but a function due to async view support. This should only affect projects using the middleware not as intended. If this cause you problems, please refer to this issue `#183 `_, `the documentation `_ or feel free to open a new issue. Special thanks to `@gvangool `_ for pointing that out. + +*Others:* + - Add colours in log in the demo project. See `63bdb4d `_ to update your projects. Special thanks to `@RoscoeTheDog `_. + - Upgrade or remove various development packages + + +4.0.1 (October 25, 2022) +------------------------ + +*New:* + - Add support to ``python`` 3.11. See `#142 `_. Special thanks to `@jairhenrique `_. + + +4.0.0 (October 22, 2022) +------------------------ + +See: :ref:`upgrade_4.0` + +*Changes:* + - ``django-structlog`` will now on follow LTS versions of Python, Django, and Celery. See `#110 `_. Special thanks to `@jairhenrique `_ for his convincing arguments. + +*New:* + - You can now install ``django-structlog`` with ``celery`` extra. Specifying ``django-structlog[celery]==4.0.0`` in ``requirements.txt`` will make sure your ``celery``'s version is compatible. + +*Others:* + - Upgrade or remove various development packages + - Upgrade local development environment from python 3.7 to 3.10 and from django 3.2 to django 4.1 + - Added a `gh-pages `_ + + +3.0.1 (August 2, 2022) +---------------------- + +*Fixes:* + - ``AttributeError`` with custom User without ``pk``. See `#80 `_. Special thanks to `@mlegner `_. + +*Others:* + - Add ``dependabot`` to manage dependencies. See `#83 `_. Special thanks to `@jairhenrique `_. + - Upgrade various development packages + + +3.0.0 (August 1, 2022) +---------------------- + +See: :ref:`upgrade_3.0` + +*Changes:* + - ``django-structlog`` now uses ``structlog.contextvars`` instead of ``structlog.threadlocal``. See the upgrade guide for more information (:ref:`upgrade_3.0`) and `#78 `_. Special thanks to `@AndrewGuenther `_ and `@shimizukawa `_. + - removed ``django_structlog.processors.inject_context_dict`` + - minimum requirements change to ``python`` 3.7+ + - minimum requirements change to ``structlog`` 21.5 + +*New:* + - Add python 3.10, celery 5.2 and django 4.0 to the test matrix. + +*Others:* + - Remove ``wrapper_class`` from the configuration + + +2.2.0 (November 18, 2021) +------------------------- + +*Changes:* + - Requests were logged as ```` (as an object) and now they are logged like this ``GET /`` (as a string). See `#72 `_. Special thanks to `@humitos `_. + + +2.1.3 (September 28, 2021) +-------------------------- + +*Fixes:* + - Implement `Celery Task.throws `_' behaviour of logging expected exception as ``INFO`` with no tracebacks. See `#62 `_ and `#70 `_. Special thanks to `@meunomemauricio `_. + + +2.1.2 (August 31, 2021) +----------------------- + +*Fixes:* + - ``django.core.exceptions.PermissionDenied`` is no longer logged as 500 but 403. See `#68 `_. Special thanks to `@rabbit-aaron `_. + + +2.1.1 (June 22, 2021) +------------------------- + +*Others:* + - Add ``django`` 3.2 and ``python`` 3.9 to the test matrix and ``pypi`` metadata. See `#65 `_. Special thanks to `@kashewnuts `_. + + +2.1.0 (November 26, 2020) +------------------------- + +*New:* + - :class:`django_structlog.processors.inject_context_dict` for standard python loggers. See `#24 `_. Special thanks to `@debfx `_. + + +2.0.0 (November 25, 2020) +------------------------- + +*Upgrade:* + - There are necessary configuration changes needed. See :ref:`upgrade_2.0` for the details. + +*Changes:* + - No longer add ``error`` and ``error_traceback``. See `#55 `_ and :ref:`upgrade_2.0`. Special thanks to `@debfx `_. + +*Fixes:* + - Fix crash when request's user is ``None`` for `django-oauth-toolkit `_. See `#56 `_. Special thanks to `@nicholasamorim `_. + + +1.6.3 (November 11, 2020) +------------------------- + +*Improvements:* + - Call stack of exception in log is now an appropriate string. See `#54 `_. Special thanks to `@debfx `_. + + +1.6.2 (October 4, 2020) +----------------------- + +*Fixes:* + - Fix UUID as User pk causing issues. See `#52 `_ `#45 `_ and `#51 `_. Special thanks to `@fadedDexofan `_. + + +1.6.1 (August 13, 2020) +----------------------- + +*Fixes:* + - Removed ``providing_args`` from signals to fix django 4.0 deprecation warnings introduced by django 3.1. See `#44 `_. Special thanks to `@ticosax `_. + - Fix ``sender`` of ``signals.pre_task_succeeded`` + - Documented signal parameters in doc strings and ``API documentation`` to replace ``providing_args`` + +*Others:* + - Add ``django`` 3.0 and 3.1 to the test matrix and ``pypi`` supported frameworks metadata + - Fix reference of the previous ci in the documentation + + +1.6.0 (June 17, 2020) +--------------------- + +*Changes:* + - ``task_succeed`` is now ``task_succeeded``. Special thanks to `@PawelMorawian `_. + - Remove ``result`` from ``task_succeeded`` log (may be added back, see below). Special thanks to `@PawelMorawian `_ as well. + - Add ``django_structlog.celery.signals.pre_task_succeeded``. To be able to bind ``result`` if someone really needs it. + + +1.5.5 (June 16, 2020) +--------------------- + +*New:* + - Add ``bind_extra_request_finished_metadata`` and ``bind_extra_request_failed_metadata``. See `#39 `_. Special thanks to `@prik2693 `_. + + +1.5.4 (June 15, 2020) +--------------------- + +*Improvements:* + - Remove redundant ``DJANGO_STRUCTLOG_LOG_USER_IN_REQUEST_FINISHED`` setting and just always make sure ``user_id`` is in ``request_finished`` and ``request_failed`` instead. See `#37 `_. + + +1.5.3 (June 15, 2020) +--------------------- + +*New:* + - Add ``DJANGO_STRUCTLOG_LOG_USER_IN_REQUEST_FINISHED`` setting to support `Django REST framework `_. See `#37 `_. Special thanks to `@immortaleeb `_. + + +1.5.2 (April 2, 2020) +--------------------- + +*New:* + - Add ``modify_context_before_task_publish`` signal. + + +1.5.1 (March 18, 2020) +---------------------- + +*Improvements:* + - Allow to override celery task metadata from binding. See `#32 `_ and `#33 `_. Special thanks to `@chiragjn `_ + + +1.5.0 (March 6, 2020) +--------------------- + +*Improvements:* + - Add support for celery 3. See `#26 `_ and `#31 `_. Special thanks to `@chiragjn `_ and `@prik2693 `_ + + +1.4.1 (February 8, 2020) +------------------------ + +*New:* + - Bind ``X-Correlation-ID`` HTTP header's value as ``correlation_id`` when provided in request. + + +1.4.0 (February 7, 2020) +------------------------ + +*New:* + - Use ``X-Request-ID`` HTTP header's value as ``request_id`` when provided in request. See `#22 `_. Special thanks to `@jairhenrique `_ + + +1.3.5 (December 23, 2019) +------------------------- + +*New:* + - Add python 3.8, celery 4.4 and django 3.0 to the test matrix. + +*Improvements:* + - Extract ``test_app`` from ``django_structlog_demo_app`` in order to test ``django_structlog`` all by itself + - Improve CI execution speed by merging stages + - Upgrade a few development depencencies + + +1.3.4 (November 27, 2019) +------------------------- + +*Bugfix:* + - Exception logging not working properly with ``DEBUG = False``. See `#19 `_. Special thanks to `@danpalmer `_ + + +1.3.3 (October 6, 2019) +----------------------- + +*Bugfix:* + - Fix support of different primary key for ``User`` model. See `#13 `_. Special thanks to `@dhararon `_ + + +1.3.2 (September 21, 2019) +-------------------------- + +*Improvements:* + - Add support of projects without ``AuthenticationMiddleware``. See `#9 `_. Special thanks to `@dhararon `_ + + +1.3.1 (September 4, 2019) +------------------------- + +*Bugfixes:* + - Remove extraneous ``rest-framework`` dependency introduced by `#7 `_. See `#8 `_ . Special thanks to `@ghickman `_ + + +1.3.0 (September 3, 2019) +------------------------- + +*Improvements:* + - Improve django uncaught exception formatting. See `#7 `_. Special thanks to `@paulstuartparker `_ + + +1.2.3 (May 18, 2019) +-------------------- + +*Bugfixes:* + - Fix ``structlog`` dependency not being installed + +*Improvements:* + - Use `black `_ code formatter + + +1.2.2 (May 13, 2019) +-------------------- + +*Improvements:* + - Use appropriate packaging + + +1.2.1 (May 8, 2019) +------------------- + +*Bugfixes:* + - Fix missing license file to be included in distribution + + +1.2.0 (May 8, 2019) +------------------- + +*Changes:* + - In the event ``task_enqueued``, ``task_id`` and ``task_name`` are renamed ``child_task_id`` and ``child_task_name`` respectively to avoid override of ``task_id`` in nested tasks. + + +1.1.6 (May 8, 2019) +------------------- + +*New:* + - Add ``task_name`` when a task is enqueued + + +1.1.5 (May 8, 2019) +------------------- + +*New:* + - Add support of tasks calling other tasks (introducing ``parent_task_id``) + +*Bugfixes:* + - Fix missing packages + + +1.1.4 (April 22, 2019) +---------------------- + +*Improvements:* + - Wheel distribution + + +1.1.3 (April 22, 2019) +---------------------- + +*Improvements:* + - api documentation + - code documentation + +1.1.2 (April 19, 2019) +---------------------- + +*Changes:* + - Rewrite the log texts as events + +1.1.1 (April 18, 2019) +---------------------- + +*New:* + - Add ``celery`` signal ``signals.bind_extra_task_metadata`` + + +1.1 (April 16, 2019) +-------------------- + +*New:* + - Add ``celery`` tasks support + + +1.0.4 to 1.0.7 (April 14, 2019) +------------------------------- + +*New:* + - Automated releases with tags on ``travis`` + +1.0.3 (April 14, 2019) +---------------------- + +*Bugfixes:* + - Add ``bind_extra_request_metadata`` documentation + +1.0.2 (April 13, 2019) +---------------------- + +*Bugfixes:* + - Tweaked documentation. + +1.0.0 (April 13, 2019) +---------------------- + +*New*: + - Fist public release. diff --git a/_sources/commands.rst.txt b/_sources/commands.rst.txt new file mode 100644 index 00000000..2434b2dd --- /dev/null +++ b/_sources/commands.rst.txt @@ -0,0 +1,74 @@ +.. _commands: + +Commands +======== + +Prerequisites +^^^^^^^^^^^^^ + +Install ``django-structlog`` with command support (it will install `django-extensions `_). + +.. code-block:: bash + + pip install django-structlog[commands] + +Alternatively install `django-extensions `_ directly: + +.. code-block:: bash + + pip install django-extensions + +Configuration +^^^^^^^^^^^^^ + +Enable ``django-structlog``'s command logging: + +.. code-block:: python + + DJANGO_STRUCTLOG_COMMAND_LOGGING_ENABLED = True + +Add ``django-extensions``'s `@signalcommand `_ to your commands + +.. code-block:: python + + import structlog + from django.core.management import BaseCommand + from django_extensions.management.utils import signalcommand # <- add this + + logger = structlog.getLogger(__name__) + + + class Command(BaseCommand): + def add_arguments(self, parser): + parser.add_argument("foo", type=str) + + @signalcommand # <- add this + def handle(self, foo, *args, **options): + logger.info("my log", foo=foo) + return 0 + +Results +^^^^^^^ + +Log will add ``command_name`` and ``command_id`` to the logs: + +.. code-block:: bash + + $ python manage.py example_command bar + 2023-09-13T21:10:50.084368Z [info ] command_started [django_structlog.commands] command_name=django_structlog_demo_project.users.example_command command_id=be723d34-59f5-468e-9258-24232aa4cedd + 2023-09-13T21:10:50.085325Z [info ] my log [django_structlog_demo_project.users.management.commands.example_command] command_id=be723d34-59f5-468e-9258-24232aa4cedd foo=bar + 2023-09-13T21:10:50.085877Z [info ] command_finished [django_structlog.commands] command_id=be723d34-59f5-468e-9258-24232aa4cedd + + +It also supports nested commands which will keep track of parent commands through ``parent_id``: + +.. code-block:: bash + + $ python manage.py example_command bar + 2023-09-15T00:10:10.466616Z [info ] command_started [django_structlog.commands] command_id=f2a8c9a8-5aa3-4e22-b11c-f387449a34ed command_name=django_structlog_demo_project.users.example_command + 2023-09-15T00:10:10.467250Z [info ] my log [django_structlog_demo_project.users.management.commands.example_command] command_id=f2a8c9a8-5aa3-4e22-b11c-f387449a34ed foo=bar + 2023-09-15T00:10:10.468176Z [info ] command_started [django_structlog.commands] baz=2 command_id=57524ccb-a8eb-4d30-a989-4e83ffdca9c0 command_name=django_structlog_demo_project.users.example_nested_command parent_command_id=f2a8c9a8-5aa3-4e22-b11c-f387449a34ed + 2023-09-15T00:10:10.468871Z [info ] my nested log [django_structlog_demo_project.users.management.commands.example_nested_command] command_id=57524ccb-a8eb-4d30-a989-4e83ffdca9c0 parent_command_id=f2a8c9a8-5aa3-4e22-b11c-f387449a34ed + 2023-09-15T00:10:10.469418Z [info ] command_finished [django_structlog.commands] command_id=57524ccb-a8eb-4d30-a989-4e83ffdca9c0 parent_command_id=f2a8c9a8-5aa3-4e22-b11c-f387449a34ed + 2023-09-15T00:10:10.469964Z [info ] my log 2 [django_structlog_demo_project.users.management.commands.example_command] command_id=f2a8c9a8-5aa3-4e22-b11c-f387449a34ed + 2023-09-15T00:10:10.470585Z [info ] command_finished [django_structlog.commands] command_id=f2a8c9a8-5aa3-4e22-b11c-f387449a34ed diff --git a/_sources/configuration.rst.txt b/_sources/configuration.rst.txt new file mode 100644 index 00000000..721827a3 --- /dev/null +++ b/_sources/configuration.rst.txt @@ -0,0 +1,30 @@ +.. _configuration: + +Configuration +============= + +In your ``settings.py`` you can customize ``django-structlog``. + +Example: + +.. code-block:: python + + import logging + DJANGO_STRUCTLOG_STATUS_4XX_LOG_LEVEL = logging.INFO + + +.. _settings: +Settings +-------- + ++------------------------------------------+---------+-----------------+-------------------------------------------------------------------------------+ +| Key | Type | Default | Description | ++==========================================+=========+=================+===============================================================================+ +| DJANGO_STRUCTLOG_CELERY_ENABLED | boolean | False | See :ref:`celery_integration` | ++------------------------------------------+---------+-----------------+-------------------------------------------------------------------------------+ +| DJANGO_STRUCTLOG_STATUS_4XX_LOG_LEVEL | int | logging.WARNING | Log level of 4XX status codes | ++------------------------------------------+---------+-----------------+-------------------------------------------------------------------------------+ +| DJANGO_STRUCTLOG_COMMAND_LOGGING_ENABLED | boolean | False | See :ref:`commands` | ++------------------------------------------+---------+-----------------+-------------------------------------------------------------------------------+ +| DJANGO_STRUCTLOG_USER_ID_FIELD | boolean | ``"pk"`` | Change field used to identify user in logs, ``None`` to disable user binding | ++------------------------------------------+---------+-----------------+-------------------------------------------------------------------------------+ diff --git a/_sources/demo.rst.txt b/_sources/demo.rst.txt new file mode 100644 index 00000000..cae27f24 --- /dev/null +++ b/_sources/demo.rst.txt @@ -0,0 +1,3 @@ +.. include:: ../README.rst + :start-after: inclusion-marker-demo-begin + :end-before: inclusion-marker-demo-end diff --git a/_sources/development.rst.txt b/_sources/development.rst.txt new file mode 100644 index 00000000..58741373 --- /dev/null +++ b/_sources/development.rst.txt @@ -0,0 +1,48 @@ +.. _development: + +Development +=========== + +Prerequisites +------------- + +- `docker `_ + + +Installation +------------ + +.. code-block:: bash + + $ git clone https://github.com/jrobichaud/django-structlog.git + $ cd django-structlog + $ pip install -r requirements.txt + $ pre-commit install + + +Start Demo App +-------------- + +.. code-block:: bash + + $ docker compose up --build + +- ``runserver_plus`` server: http://127.0.0.1:8000/ +- ``WSGI`` server: http://127.0.0.1:8001/ +- ``ASGI`` server: http://127.0.0.1:8002/ + +Use ``RabbitMQ`` broker instead of ``redis`` +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: bash + + $ docker compose -f ./docker-compose.yml -f ./docker-compose.amqp.yml up --build + + +Building, Serving and Testing the Documentation Locally +------------------------------------------------------- + +.. code-block:: bash + + $ docker compose -p django-structlog-docs -f docker-compose.docs.yml up --build + Serving on http://127.0.0.1:8080 diff --git a/_sources/events.rst.txt b/_sources/events.rst.txt new file mode 100644 index 00000000..47d5372b --- /dev/null +++ b/_sources/events.rst.txt @@ -0,0 +1,180 @@ +Events and Metadata +=================== + +Django's RequestMiddleware +-------------------------- + +.. _request_events: + +Request Events +^^^^^^^^^^^^^^ + ++-------------------+--------------------+-----------------------------------------------------+ +| Event | Type | Description | ++===================+====================+=====================================================+ +| request_started | INFO | Django received a request | ++-------------------+--------------------+-----------------------------------------------------+ +| request_finished | INFO/WARNING/ERROR | request completed with status (2XX or 3XX)/4XX/5XX | ++-------------------+--------------------+-----------------------------------------------------+ +| request_cancelled | WARNING | request cancelled during an async request with asgi | ++-------------------+--------------------+-----------------------------------------------------+ +| request_failed | ERROR | unhandled exception occurred | ++-------------------+--------------------+-----------------------------------------------------+ + +.. _streaming_response_events: + +StreamingHttpResponse Events +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Specific to `StreamingHttpResponse `_ + ++---------------------+--------------------+-------------------------------------+ +| Event | Type | Description | ++=====================+====================+=====================================+ +| streaming_started | INFO | Streaming of response started | ++---------------------+--------------------+-------------------------------------+ +| streaming_finished | INFO | Streaming of response finished | ++---------------------+--------------------+-------------------------------------+ +| streaming_cancelled | WARNING | Streaming of response was cancelled | ++---------------------+--------------------+-------------------------------------+ +| streaming_failed | ERROR | Streaming of response failed | ++---------------------+--------------------+-------------------------------------+ + + +Request Bound Metadata +^^^^^^^^^^^^^^^^^^^^^^ + +These metadata are repeated on each log of the current request and will be also be repeated in all children Celery tasks. + ++------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| Key | Value | ++==================+=================================================================================================================================+ +| request_id | UUID for the request or value of ``X-Request-ID`` HTTP header when provided | ++------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| correlation_id | value of ``X-Correlation-ID`` HTTP header when provided | ++------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| user_id | user's id or None (requires `django.contrib.auth.middleware.AuthenticationMiddleware`_) | +| | | +| | `DRF `_: it will only be in ``request_finished`` and ``request_failed`` events | +| | | +| | If you need to override the bound ``user_id``, it has to be done in all three signals: | +| | - :attr:`django_structlog.signals.bind_extra_request_metadata` | +| | - :attr:`django_structlog.signals.bind_extra_request_finished_metadata` | +| | - :attr:`django_structlog.signals.bind_extra_request_failed_metadata` | ++------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| ip | request's ip | ++------------------+---------------------------------------------------------------------------------------------------------------------------------+ + +To bind more metadata or override existing metadata from request see :ref:`django_signals` + +.. _`django.contrib.auth.middleware.AuthenticationMiddleware`: https://docs.djangoproject.com/en/dev/ref/middleware/#module-django.contrib.auth.middleware + + +Request Events Metadata +^^^^^^^^^^^^^^^^^^^^^^^ + +These metadata appear once along with their associated event + ++------------------+------------------+--------------------------------------------------------------+ +| Event | Key | Value | ++==================+==================+==============================================================+ +| request_started | request | request as string | ++------------------+------------------+--------------------------------------------------------------+ +| request_started | user_agent | request's user agent | ++------------------+------------------+--------------------------------------------------------------+ +| request_finished | code | request's status code | ++------------------+------------------+--------------------------------------------------------------+ +| request_failed | exception | exception traceback (requires format_exc_info_) | ++------------------+------------------+--------------------------------------------------------------+ + +.. _format_exc_info: https://www.structlog.org/en/stable/api.html#structlog.processors.format_exc_info + +Celery +------ + +Task Events +^^^^^^^^^^^ + ++--------------------+-------------+------------------------------------------------+ +| Event | Type | Description | ++====================+=============+================================================+ +| task_enqueued | INFO | A task was enqueued by request or another task | ++--------------------+-------------+------------------------------------------------+ +| task_retrying | WARNING | Worker retry task | ++--------------------+-------------+------------------------------------------------+ +| task_started | INFO | task just started executing | ++--------------------+-------------+------------------------------------------------+ +| task_succeeded | INFO | Task completed successfully | ++--------------------+-------------+------------------------------------------------+ +| task_failed | ERROR/INFO* | Task failed | ++--------------------+-------------+------------------------------------------------+ +| task_revoked | WARNING | Task was canceled | ++--------------------+-------------+------------------------------------------------+ +| task_not_found | ERROR | Celery app did not discover the requested task | ++--------------------+-------------+------------------------------------------------+ +| task_rejected | ERROR | Task could not be enqueued | ++--------------------+-------------+------------------------------------------------+ + +\* if task threw an expected exception, it will logged as ``INFO``. See `Celery's Task.throws `_ + +Task Bound Metadata +^^^^^^^^^^^^^^^^^^^ + +These metadata are repeated on each log of the current task and will be also be repeated in all children Celery tasks. +Take note that all the caller's logger bound metadata are also bound to the task's logger. + ++------------------+------------------------------------+ +| Key | Value | ++==================+====================================+ +| task_id | UUID of the current task | ++------------------+------------------------------------+ +| parent_task_id | UUID of the parent's task (if any) | ++------------------+------------------------------------+ + +To bind more metadata or override existing metadata from task see :ref:`celery_signals` + + +Task Event Metadata +^^^^^^^^^^^^^^^^^^^ + +These metadata appear once along with their associated event + ++------------------+------------------+----------------------------------------+ +| Event | Key | Value | ++==================+==================+========================================+ +| task_enqueued | child_task_id | id of the task being enqueued | ++------------------+------------------+----------------------------------------+ +| task_enqueued | child_task_name | name of the task being enqueued | ++------------------+------------------+----------------------------------------+ +| task_enqueued | routing_key | task's routing key | ++------------------+------------------+----------------------------------------+ +| task_enqueued | priority | priority of task (if any) | ++------------------+------------------+----------------------------------------+ +| task_retrying | reason | reason for retry | ++------------------+------------------+----------------------------------------+ +| task_started | task | name of the task | ++------------------+------------------+----------------------------------------+ +| task_failed | error | exception as string | ++------------------+------------------+----------------------------------------+ +| task_failed | exception* | exception's traceback | ++------------------+------------------+----------------------------------------+ +| task_revoked | terminated | Set to True if the task was terminated | ++------------------+------------------+----------------------------------------+ +| task_revoked | signum | python termination signal's number | ++------------------+------------------+----------------------------------------+ +| task_revoked | signame | python termination signal's name | ++------------------+------------------+----------------------------------------+ +| task_revoked | expired | see Celery's documentation | ++------------------+------------------+----------------------------------------+ +| task_revoked | task_id | id of the task being revoked | ++------------------+------------------+----------------------------------------+ +| task_revoked | task | name of the task being revoked | ++------------------+------------------+----------------------------------------+ +| task_not_found | task_id | id of the task not found | ++------------------+------------------+----------------------------------------+ +| task_not_found | task | name of the task not found | ++------------------+------------------+----------------------------------------+ +| task_rejected | task_id | id of the task being rejected | ++------------------+------------------+----------------------------------------+ + +\* if task threw an expected exception, ``exception`` will be omitted. See `Celery's Task.throws `_ diff --git a/_sources/example_outputs.rst.txt b/_sources/example_outputs.rst.txt new file mode 100644 index 00000000..eba3f796 --- /dev/null +++ b/_sources/example_outputs.rst.txt @@ -0,0 +1,3 @@ +.. include:: ../README.rst + :start-after: inclusion-marker-example-outputs-begin + :end-before: inclusion-marker-example-outputs-end diff --git a/_sources/getting_started.rst.txt b/_sources/getting_started.rst.txt new file mode 100644 index 00000000..91d1505f --- /dev/null +++ b/_sources/getting_started.rst.txt @@ -0,0 +1,3 @@ +.. include:: ../README.rst + :start-after: inclusion-marker-getting-started-begin + :end-before: inclusion-marker-getting-started-end diff --git a/_sources/how_tos.rst.txt b/_sources/how_tos.rst.txt new file mode 100644 index 00000000..c581ba3f --- /dev/null +++ b/_sources/how_tos.rst.txt @@ -0,0 +1,134 @@ +.. _how_tos: + +How Tos +======= + +These are code snippets on how to achieve some specific use cases. + +.. warning:: + Be aware they are untested. Please `open an issue `_ if there are bugs in these examples or if you want to share some great examples that should be there. + + +Bind ``request_id`` to response's header +---------------------------------------- + +You can add the ``request_id`` to a custom response header ``X-Request-ID`` in order to trace the request by the caller. + +Origin: `#231 `_ + +.. code-block:: python + + from django.dispatch import receiver + from django_structlog import signals + import structlog + + + @receiver(signals.update_failure_response) + @receiver(signals.bind_extra_request_finished_metadata) + def add_request_id_to_error_response(response, logger, **kwargs): + context = structlog.contextvars.get_merged_contextvars(logger) + response['X-Request-ID'] = context["request_id"] + +Bind ``rest_framework_simplejwt`` token's user id +------------------------------------------------- + +Bind token's user_id from `rest_framework_simplejwt `_ to the request. + +It is a workaround for ``restframework``'s non-standard authentication system. +It prevents access of the user in middlewares, therefore ``django-structlog`` cannot bind the ``user_id`` by default. + +.. code-block:: python + + import structlog + from django.dispatch import receiver + from django_structlog.signals import bind_extra_request_metadata + from rest_framework_simplejwt.tokens import UntypedToken + + @receiver(bind_extra_request_metadata) + def bind_token_user_id(request, logger, **kwargs): + try: + header = request.META.get("HTTP_AUTHORIZATION") + if header: + raw_token = header.split()[1] + token = UntypedToken(raw_token) + user_id = token["user_id"] + structlog.contextvars.bind_contextvars(user_id=user_id) + except Exception: + pass + +Bind AWS's ``X-Amzn-Trace-Id`` +------------------------------ + +See `Request tracing for your Application Load Balancer `_ + +Origin: `#324 `_ + +.. code-block:: python + + from django.dispatch import receiver + from django_structlog import signals + from django_structlog.middlewares.request import get_request_header + import structlog + + @receiver(signals.bind_extra_request_metadata) + def bind_trace_id(request, logger, **kwargs): + trace_id = get_request_header( + request, "x-amzn-trace-id", "HTTP_X_AMZN_TRACE_ID" + ) + if trace_id: + structlog.contextvars.bind_contextvars(trace_id=trace_id) + +Filter logs from being recorded +------------------------------- + +You can add a custom filter to prevent some specific logs from being recorded, based on your criteria + +See `Django logging documentation `_ + + +Origin: `#412 `_ + +.. code-block:: python + + # your_project/logging/filters.py + + import logging + + class ExcludeEventsFilter(logging.Filter): + def __init__(self, excluded_event_type=None): + super().__init__() + self.excluded_event_type = excluded_event_type + + def filter(self, record): + if not isinstance(record.msg, dict) or self.excluded_event_type is None: + return True # Include the log message if msg is not a dictionary or excluded_event_type is not provided + + if record.msg.get('event') in self.excluded_event_type: + return False # Exclude the log message + return True # Include the log message + + + # in your settings.py + + LOGGING = { + 'version': 1, + 'disable_existing_loggers': False, + 'handlers': { + 'console': { + 'class': 'logging.StreamHandler', + 'filters': ['exclude_request_started'] + }, + }, + 'filters': { + 'exclude_request_started': { + '()': 'your_project.logging.filters.ExcludeEventsFilter', + 'excluded_event_type': ['request_started'] # Example excluding request_started event + }, + }, + 'loggers': { + 'django': { + 'handlers': ['console'], + 'level': 'DEBUG', + }, + }, + } diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt new file mode 100644 index 00000000..9334f2ff --- /dev/null +++ b/_sources/index.rst.txt @@ -0,0 +1,31 @@ +.. include:: ../README.rst + :start-after: introduction-begin + :end-before: introduction-end + + +Contents, indices and tables +============================ + +.. toctree:: + :maxdepth: 2 + + getting_started + configuration + celery + commands + api_documentation + events + example_outputs + how_tos + running_tests + development + demo + changelog + upgrade_guide + authors + acknowledgements + licence + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/_sources/licence.rst.txt b/_sources/licence.rst.txt new file mode 100644 index 00000000..455509b9 --- /dev/null +++ b/_sources/licence.rst.txt @@ -0,0 +1,4 @@ +Licence +======= + +.. include:: ../LICENSE.rst diff --git a/_sources/running_tests.rst.txt b/_sources/running_tests.rst.txt new file mode 100644 index 00000000..58b19429 --- /dev/null +++ b/_sources/running_tests.rst.txt @@ -0,0 +1,3 @@ +.. include:: ../README.rst + :start-after: inclusion-marker-running-tests-begin + :end-before: inclusion-marker-running-tests-end diff --git a/_sources/upgrade_guide.rst.txt b/_sources/upgrade_guide.rst.txt new file mode 100644 index 00000000..8edff608 --- /dev/null +++ b/_sources/upgrade_guide.rst.txt @@ -0,0 +1,3 @@ +.. include:: ../README.rst + :start-after: inclusion-marker-upgrade-guide-begin + :end-before: inclusion-marker-upgrade-guide-end diff --git a/_static/_sphinx_javascript_frameworks_compat.js b/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 00000000..81415803 --- /dev/null +++ b/_static/_sphinx_javascript_frameworks_compat.js @@ -0,0 +1,123 @@ +/* Compatability shim for jQuery and underscores.js. + * + * Copyright Sphinx contributors + * Released under the two clause BSD licence + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} diff --git a/_static/basic.css b/_static/basic.css new file mode 100644 index 00000000..7ebbd6d0 --- /dev/null +++ b/_static/basic.css @@ -0,0 +1,914 @@ +/* + * Sphinx stylesheet -- basic theme. + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin-top: 10px; +} + +ul.search li { + padding: 5px 0; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/_static/css/badge_only.css b/_static/css/badge_only.css new file mode 100644 index 00000000..88ba55b9 --- /dev/null +++ b/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions .rst-other-versions .rtd-current-item{font-weight:700}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}#flyout-search-form{padding:6px} \ No newline at end of file diff --git a/_static/css/fonts/Roboto-Slab-Bold.woff b/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/_static/css/fonts/Roboto-Slab-Bold.woff2 b/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/_static/css/fonts/Roboto-Slab-Regular.woff b/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/_static/css/fonts/Roboto-Slab-Regular.woff2 b/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/_static/css/fonts/fontawesome-webfont.eot b/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/_static/css/fonts/fontawesome-webfont.svg b/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/_static/css/fonts/fontawesome-webfont.ttf b/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/_static/css/fonts/fontawesome-webfont.woff b/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/_static/css/fonts/fontawesome-webfont.woff2 b/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/_static/css/fonts/lato-bold-italic.woff b/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/_static/css/fonts/lato-bold-italic.woff differ diff --git a/_static/css/fonts/lato-bold-italic.woff2 b/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/_static/css/fonts/lato-bold.woff b/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/_static/css/fonts/lato-bold.woff differ diff --git a/_static/css/fonts/lato-bold.woff2 b/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/_static/css/fonts/lato-bold.woff2 differ diff --git a/_static/css/fonts/lato-normal-italic.woff b/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/_static/css/fonts/lato-normal-italic.woff differ diff --git a/_static/css/fonts/lato-normal-italic.woff2 b/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/_static/css/fonts/lato-normal.woff b/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/_static/css/fonts/lato-normal.woff differ diff --git a/_static/css/fonts/lato-normal.woff2 b/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/_static/css/fonts/lato-normal.woff2 differ diff --git a/_static/css/theme.css b/_static/css/theme.css new file mode 100644 index 00000000..0f14f106 --- /dev/null +++ b/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search .wy-dropdown>aactive,.wy-side-nav-search .wy-dropdown>afocus,.wy-side-nav-search>a:hover,.wy-side-nav-search>aactive,.wy-side-nav-search>afocus{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon,.wy-side-nav-search>a.icon{display:block}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.switch-menus{position:relative;display:block;margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-side-nav-search>div.switch-menus>div.language-switch,.wy-side-nav-search>div.switch-menus>div.version-switch{display:inline-block;padding:.2em}.wy-side-nav-search>div.switch-menus>div.language-switch select,.wy-side-nav-search>div.switch-menus>div.version-switch select{display:inline-block;margin-right:-2rem;padding-right:2rem;max-width:240px;text-align-last:center;background:none;border:none;border-radius:0;box-shadow:none;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-size:1em;font-weight:400;color:hsla(0,0%,100%,.3);cursor:pointer;appearance:none;-webkit-appearance:none;-moz-appearance:none}.wy-side-nav-search>div.switch-menus>div.language-switch select:active,.wy-side-nav-search>div.switch-menus>div.language-switch select:focus,.wy-side-nav-search>div.switch-menus>div.language-switch select:hover,.wy-side-nav-search>div.switch-menus>div.version-switch select:active,.wy-side-nav-search>div.switch-menus>div.version-switch select:focus,.wy-side-nav-search>div.switch-menus>div.version-switch select:hover{background:hsla(0,0%,100%,.1);color:hsla(0,0%,100%,.5)}.wy-side-nav-search>div.switch-menus>div.language-switch select option,.wy-side-nav-search>div.switch-menus>div.version-switch select option{color:#000}.wy-side-nav-search>div.switch-menus>div.language-switch:has(>select):after,.wy-side-nav-search>div.switch-menus>div.version-switch:has(>select):after{display:inline-block;width:1.5em;height:100%;padding:.1em;content:"\f0d7";font-size:1em;line-height:1.2em;font-family:FontAwesome;text-align:center;pointer-events:none;box-sizing:border-box}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions .rst-other-versions .rtd-current-item{font-weight:700}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}#flyout-search-form{padding:6px}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/_static/doctools.js b/_static/doctools.js new file mode 100644 index 00000000..0398ebb9 --- /dev/null +++ b/_static/doctools.js @@ -0,0 +1,149 @@ +/* + * Base JavaScript utilities for all Sphinx HTML documentation. + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/_static/documentation_options.js b/_static/documentation_options.js new file mode 100644 index 00000000..0f0cd601 --- /dev/null +++ b/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '9.0.0', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/_static/file.png b/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/_static/file.png differ diff --git a/_static/fonts/Lato/lato-bold.eot b/_static/fonts/Lato/lato-bold.eot new file mode 100644 index 00000000..3361183a Binary files /dev/null and b/_static/fonts/Lato/lato-bold.eot differ diff --git a/_static/fonts/Lato/lato-bold.ttf b/_static/fonts/Lato/lato-bold.ttf new file mode 100644 index 00000000..29f691d5 Binary files /dev/null and b/_static/fonts/Lato/lato-bold.ttf differ diff --git a/_static/fonts/Lato/lato-bold.woff b/_static/fonts/Lato/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/_static/fonts/Lato/lato-bold.woff differ diff --git a/_static/fonts/Lato/lato-bold.woff2 b/_static/fonts/Lato/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/_static/fonts/Lato/lato-bold.woff2 differ diff --git a/_static/fonts/Lato/lato-bolditalic.eot b/_static/fonts/Lato/lato-bolditalic.eot new file mode 100644 index 00000000..3d415493 Binary files /dev/null and b/_static/fonts/Lato/lato-bolditalic.eot differ diff --git a/_static/fonts/Lato/lato-bolditalic.ttf b/_static/fonts/Lato/lato-bolditalic.ttf new file mode 100644 index 00000000..f402040b Binary files /dev/null and b/_static/fonts/Lato/lato-bolditalic.ttf differ diff --git a/_static/fonts/Lato/lato-bolditalic.woff b/_static/fonts/Lato/lato-bolditalic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/_static/fonts/Lato/lato-bolditalic.woff differ diff --git a/_static/fonts/Lato/lato-bolditalic.woff2 b/_static/fonts/Lato/lato-bolditalic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/_static/fonts/Lato/lato-bolditalic.woff2 differ diff --git a/_static/fonts/Lato/lato-italic.eot b/_static/fonts/Lato/lato-italic.eot new file mode 100644 index 00000000..3f826421 Binary files /dev/null and b/_static/fonts/Lato/lato-italic.eot differ diff --git a/_static/fonts/Lato/lato-italic.ttf b/_static/fonts/Lato/lato-italic.ttf new file mode 100644 index 00000000..b4bfc9b2 Binary files /dev/null and b/_static/fonts/Lato/lato-italic.ttf differ diff --git a/_static/fonts/Lato/lato-italic.woff b/_static/fonts/Lato/lato-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/_static/fonts/Lato/lato-italic.woff differ diff --git a/_static/fonts/Lato/lato-italic.woff2 b/_static/fonts/Lato/lato-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/_static/fonts/Lato/lato-italic.woff2 differ diff --git a/_static/fonts/Lato/lato-regular.eot b/_static/fonts/Lato/lato-regular.eot new file mode 100644 index 00000000..11e3f2a5 Binary files /dev/null and b/_static/fonts/Lato/lato-regular.eot differ diff --git a/_static/fonts/Lato/lato-regular.ttf b/_static/fonts/Lato/lato-regular.ttf new file mode 100644 index 00000000..74decd9e Binary files /dev/null and b/_static/fonts/Lato/lato-regular.ttf differ diff --git a/_static/fonts/Lato/lato-regular.woff b/_static/fonts/Lato/lato-regular.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/_static/fonts/Lato/lato-regular.woff differ diff --git a/_static/fonts/Lato/lato-regular.woff2 b/_static/fonts/Lato/lato-regular.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/_static/fonts/Lato/lato-regular.woff2 differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot new file mode 100644 index 00000000..79dc8efe Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf new file mode 100644 index 00000000..df5d1df2 Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot new file mode 100644 index 00000000..2f7ca78a Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf new file mode 100644 index 00000000..eb52a790 Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff differ diff --git a/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 differ diff --git a/_static/jquery.js b/_static/jquery.js new file mode 100644 index 00000000..c4c6022f --- /dev/null +++ b/_static/jquery.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t a.language.name.localeCompare(b.language.name)); + + const languagesHTML = ` +
+
Languages
+ ${languages + .map( + (translation) => ` +
+ ${translation.language.code} +
+ `, + ) + .join("\n")} +
+ `; + return languagesHTML; + } + + function renderVersions(config) { + if (!config.versions.active.length) { + return ""; + } + const versionsHTML = ` +
+
Versions
+ ${config.versions.active + .map( + (version) => ` +
+ ${version.slug} +
+ `, + ) + .join("\n")} +
+ `; + return versionsHTML; + } + + function renderDownloads(config) { + if (!Object.keys(config.versions.current.downloads).length) { + return ""; + } + const downloadsNameDisplay = { + pdf: "PDF", + epub: "Epub", + htmlzip: "HTML", + }; + + const downloadsHTML = ` +
+
Downloads
+ ${Object.entries(config.versions.current.downloads) + .map( + ([name, url]) => ` +
+ ${downloadsNameDisplay[name]} +
+ `, + ) + .join("\n")} +
+ `; + return downloadsHTML; + } + + document.addEventListener("readthedocs-addons-data-ready", function (event) { + const config = event.detail.data(); + + const flyout = ` +
+ + Read the Docs + v: ${config.versions.current.slug} + + +
+
+ ${renderLanguages(config)} + ${renderVersions(config)} + ${renderDownloads(config)} +
+
On Read the Docs
+
+ Project Home +
+
+ Builds +
+
+ Downloads +
+
+
+
Search
+
+
+ +
+
+
+
+ + Hosted by Read the Docs + +
+
+ `; + + // Inject the generated flyout into the body HTML element. + document.body.insertAdjacentHTML("beforeend", flyout); + + // Trigger the Read the Docs Addons Search modal when clicking on the "Search docs" input from inside the flyout. + document + .querySelector("#flyout-search-form") + .addEventListener("focusin", () => { + const event = new CustomEvent("readthedocs-search-show"); + document.dispatchEvent(event); + }); + }) +} + +if (themeLanguageSelector || themeVersionSelector) { + function onSelectorSwitch(event) { + const option = event.target.selectedIndex; + const item = event.target.options[option]; + window.location.href = item.dataset.url; + } + + document.addEventListener("readthedocs-addons-data-ready", function (event) { + const config = event.detail.data(); + + const versionSwitch = document.querySelector( + "div.switch-menus > div.version-switch", + ); + if (themeVersionSelector) { + let versions = config.versions.active; + if (config.versions.current.hidden || config.versions.current.type === "external") { + versions.unshift(config.versions.current); + } + const versionSelect = ` + + `; + + versionSwitch.innerHTML = versionSelect; + versionSwitch.firstElementChild.addEventListener("change", onSelectorSwitch); + } + + const languageSwitch = document.querySelector( + "div.switch-menus > div.language-switch", + ); + + if (themeLanguageSelector) { + if (config.projects.translations.length) { + // Add the current language to the options on the selector + let languages = config.projects.translations.concat( + config.projects.current, + ); + languages = languages.sort((a, b) => + a.language.name.localeCompare(b.language.name), + ); + + const languageSelect = ` + + `; + + languageSwitch.innerHTML = languageSelect; + languageSwitch.firstElementChild.addEventListener("change", onSelectorSwitch); + } + else { + languageSwitch.remove(); + } + } + }); +} + +document.addEventListener("readthedocs-addons-data-ready", function (event) { + // Trigger the Read the Docs Addons Search modal when clicking on "Search docs" input from the topnav. + document + .querySelector("[role='search'] input") + .addEventListener("focusin", () => { + const event = new CustomEvent("readthedocs-search-show"); + document.dispatchEvent(event); + }); +}); \ No newline at end of file diff --git a/_static/language_data.js b/_static/language_data.js new file mode 100644 index 00000000..c7fe6c6f --- /dev/null +++ b/_static/language_data.js @@ -0,0 +1,192 @@ +/* + * This script contains the language-specific data used by searchtools.js, + * namely the list of stopwords, stemmer, scorer and splitter. + */ + +var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; + + +/* Non-minified version is copied as a separate JS file, if available */ + +/** + * Porter Stemmer + */ +var Stemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/_static/minus.png b/_static/minus.png new file mode 100644 index 00000000..d96755fd Binary files /dev/null and b/_static/minus.png differ diff --git a/_static/plus.png b/_static/plus.png new file mode 100644 index 00000000..7107cec9 Binary files /dev/null and b/_static/plus.png differ diff --git a/_static/pygments.css b/_static/pygments.css new file mode 100644 index 00000000..84ab3030 --- /dev/null +++ b/_static/pygments.css @@ -0,0 +1,75 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #f8f8f8; } +.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #008000; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #9C6500 } /* Comment.Preproc */ +.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +.highlight .gr { color: #E40000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #008400 } /* Generic.Inserted */ +.highlight .go { color: #717171 } /* Generic.Output */ +.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0044DD } /* Generic.Traceback */ +.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #008000 } /* Keyword.Pseudo */ +.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #B00040 } /* Keyword.Type */ +.highlight .m { color: #666666 } /* Literal.Number */ +.highlight .s { color: #BA2121 } /* Literal.String */ +.highlight .na { color: #687822 } /* Name.Attribute */ +.highlight .nb { color: #008000 } /* Name.Builtin */ +.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ +.highlight .no { color: #880000 } /* Name.Constant */ +.highlight .nd { color: #AA22FF } /* Name.Decorator */ +.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #0000FF } /* Name.Function */ +.highlight .nl { color: #767600 } /* Name.Label */ +.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #19177C } /* Name.Variable */ +.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mb { color: #666666 } /* Literal.Number.Bin */ +.highlight .mf { color: #666666 } /* Literal.Number.Float */ +.highlight .mh { color: #666666 } /* Literal.Number.Hex */ +.highlight .mi { color: #666666 } /* Literal.Number.Integer */ +.highlight .mo { color: #666666 } /* Literal.Number.Oct */ +.highlight .sa { color: #BA2121 } /* Literal.String.Affix */ +.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ +.highlight .sc { color: #BA2121 } /* Literal.String.Char */ +.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */ +.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #BA2121 } /* Literal.String.Double */ +.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ +.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */ +.highlight .sx { color: #008000 } /* Literal.String.Other */ +.highlight .sr { color: #A45A77 } /* Literal.String.Regex */ +.highlight .s1 { color: #BA2121 } /* Literal.String.Single */ +.highlight .ss { color: #19177C } /* Literal.String.Symbol */ +.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #0000FF } /* Name.Function.Magic */ +.highlight .vc { color: #19177C } /* Name.Variable.Class */ +.highlight .vg { color: #19177C } /* Name.Variable.Global */ +.highlight .vi { color: #19177C } /* Name.Variable.Instance */ +.highlight .vm { color: #19177C } /* Name.Variable.Magic */ +.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/_static/searchtools.js b/_static/searchtools.js new file mode 100644 index 00000000..2c774d17 --- /dev/null +++ b/_static/searchtools.js @@ -0,0 +1,632 @@ +/* + * Sphinx JavaScript utilities for the full-text search. + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename, kind] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +// Global search result kind enum, used by themes to style search results. +class SearchResultKind { + static get index() { return "index"; } + static get object() { return "object"; } + static get text() { return "text"; } + static get title() { return "title"; } +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename, kind] = item; + + let listItem = document.createElement("li"); + // Add a class representing the item's type: + // can be used by a theme's CSS selector for styling + // See SearchResultKind for the class names. + listItem.classList.add(`kind-${kind}`); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms, anchor) + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = Documentation.ngettext( + "Search finished, found one page matching the search query.", + "Search finished, found ${resultCount} pages matching the search query.", + resultCount, + ).replace('${resultCount}', resultCount); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; +// Helper function used by query() to order search results. +// Each input is an array of [docname, title, anchor, descr, score, filename, kind]. +// Order the results by score (in opposite order of appearance, since the +// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. +const _orderResultsByScoreThenName = (a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString, anchor) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + for (const removalQuery of [".headerlink", "script", "style"]) { + htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); + } + if (anchor) { + const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`); + if (anchorContent) return anchorContent.textContent; + + console.warn( + `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.` + ); + } + + // if anchor not specified or not found, fall back to main content + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent) return docContent.textContent; + + console.warn( + "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.setAttribute("role", "list"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + _parseQuery: (query) => { + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + return [query, searchTerms, excludedTerms, highlightTerms, objectTerms]; + }, + + /** + * execute search (requires search index to be loaded) + */ + _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // Collect multiple result groups to be sorted separately and then ordered. + // Each is an array of [docname, title, anchor, descr, score, filename, kind]. + const normalResults = []; + const nonMainIndexResults = []; + + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase().trim(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + const score = Math.round(Scorer.title * queryLower.length / title.length); + const boost = titles[file] === title ? 1 : 0; // add a boost for document titles + normalResults.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score + boost, + filenames[file], + SearchResultKind.title, + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id, isMain] of foundEntries) { + const score = Math.round(100 * queryLower.length / entry.length); + const result = [ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + SearchResultKind.index, + ]; + if (isMain) { + normalResults.push(result); + } else { + nonMainIndexResults.push(result); + } + } + } + } + + // lookup as object + objectTerms.forEach((term) => + normalResults.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) { + normalResults.forEach((item) => (item[4] = Scorer.score(item))); + nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item))); + } + + // Sort each group of results by score and then alphabetically by name. + normalResults.sort(_orderResultsByScoreThenName); + nonMainIndexResults.sort(_orderResultsByScoreThenName); + + // Combine the result groups in (reverse) order. + // Non-main index entries are typically arbitrary cross-references, + // so display them after other results. + let results = [...nonMainIndexResults, ...normalResults]; + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + return results.reverse(); + }, + + query: (query) => { + const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query); + const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + SearchResultKind.object, + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + if (!terms.hasOwnProperty(word)) { + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + } + if (!titleTerms.hasOwnProperty(word)) { + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: titleTerms[term], score: Scorer.partialTitle }); + }); + } + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (!fileMap.has(file)) fileMap.set(file, [word]); + else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + SearchResultKind.text, + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords, anchor) => { + const text = Search.htmlToText(htmlText, anchor); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/_static/sphinx_highlight.js b/_static/sphinx_highlight.js new file mode 100644 index 00000000..8a96c69a --- /dev/null +++ b/_static/sphinx_highlight.js @@ -0,0 +1,154 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '

' + + '' + + _("Hide Search Matches") + + "

" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/acknowledgements.html b/acknowledgements.html new file mode 100644 index 00000000..344b81f8 --- /dev/null +++ b/acknowledgements.html @@ -0,0 +1,129 @@ + + + + + + + + + Acknowledgments — django-structlog 9.0.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Acknowledgments

+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/api_documentation.html b/api_documentation.html new file mode 100644 index 00000000..77a4bc83 --- /dev/null +++ b/api_documentation.html @@ -0,0 +1,407 @@ + + + + + + + + + API documentation — django-structlog 9.0.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

API documentation

+
+

django_structlog

+

django-structlog is a structured logging integration for Django project using structlog.

+
+
+class django_structlog.middlewares.RequestMiddleware(get_response: Callable[[HttpRequest], HttpResponse | Awaitable[HttpResponse]])
+

Bases: object

+

RequestMiddleware adds request metadata to structlog’s logger context automatically.

+
>>> MIDDLEWARE = [
+...     # ...
+...     'django_structlog.middlewares.RequestMiddleware',
+... ]
+
+
+
+
+async_capable = True
+
+ +
+
+static bind_user_id(request: HttpRequest) → None
+
+ +
+
+static format_request(request: HttpRequest) → str
+
+ +
+
+handle_response(request: HttpRequest, response: HttpResponse) → None
+
+ +
+
+prepare(request: HttpRequest) → None
+
+ +
+
+process_got_request_exception(sender: Type[Any], request: HttpRequest, **kwargs: Any) → None
+
+ +
+
+sync_capable = True
+
+ +
+ +
+
+django_structlog.signals.bind_extra_request_failed_metadata = <django.dispatch.dispatcher.Signal object>
+

Signal to add extra structlog bindings from django’s failed request and exception.

+
+
Parameters:
+
    +

  • logger – the logger

    • +

  • exception – the exception resulting of the request

    • +

  • log_kwargs – dictionary of log metadata for the request_failed event. It contains request and code keys. You may modify it to add extra information.

    • +
+
+
+
>>> from django.contrib.sites.shortcuts import get_current_site
+>>> from django.dispatch import receiver
+>>> from django_structlog import signals
+>>> import structlog
+>>>
+>>> @receiver(signals.bind_extra_request_failed_metadata)
+... def bind_domain(request, logger, exception, log_kwargs, **kwargs):
+...     current_site = get_current_site(request)
+...     structlog.contextvars.bind_contextvars(domain=current_site.domain)
+
+
+
+ +
+
+django_structlog.signals.bind_extra_request_finished_metadata = <django.dispatch.dispatcher.Signal object>
+

Signal to add extra structlog bindings from django’s finished request and response.

+
+
Parameters:
+
    +

  • logger – the logger

    • +

  • response – the response resulting of the request

    • +

  • log_kwargs – dictionary of log metadata for the request_finished event. It contains request and code keys. You may modify it to add extra information.

    • +
+
+
+
>>> from django.contrib.sites.shortcuts import get_current_site
+>>> from django.dispatch import receiver
+>>> from django_structlog import signals
+>>> import structlog
+>>>
+>>> @receiver(signals.bind_extra_request_finished_metadata)
+... def bind_domain(request, logger, response, log_kwargs, **kwargs):
+...     current_site = get_current_site(request)
+...     structlog.contextvars.bind_contextvars(domain=current_site.domain)
+
+
+
+ +
+
+django_structlog.signals.bind_extra_request_metadata = <django.dispatch.dispatcher.Signal object>
+

Signal to add extra structlog bindings from django’s request.

+
+
Parameters:
+
    +

  • request – the request returned by the view

    • +

  • logger – the logger

    • +

  • log_kwargs – dictionary of log metadata for the request_started event. It contains request and user_agent keys. You may modify it to add extra information.

    • +
+
+
+
>>> from django.contrib.sites.shortcuts import get_current_site
+>>> from django.dispatch import receiver
+>>> from django_structlog import signals
+>>> import structlog
+>>>
+>>> @receiver(signals.bind_extra_request_metadata)
+... def bind_domain(request, logger, log_kwargs, **kwargs):
+...     current_site = get_current_site(request)
+...     structlog.contextvars.bind_contextvars(domain=current_site.domain)
+
+
+
+ +
+
+django_structlog.signals.update_failure_response = <django.dispatch.dispatcher.Signal object>
+

Signal to update response failure response before it is returned.

+
+
Parameters:
+
    +

  • request – the request returned by the view

    • +

  • response – the response resulting of the request

    • +

  • logger – the logger

    • +

  • exception – the exception

    • +
+
+
+
>>> from django.dispatch import receiver
+>>> from django_structlog import signals
+>>> import structlog
+>>>
+>>> @receiver(signals.update_failure_response)
+... def add_request_id_to_error_response(request, response, logger, exception, **kwargs):
+...     context = structlog.contextvars.get_merged_contextvars(logger)
+...     response['X-Request-ID'] = context["request_id"]
+
+
+
+ +
+
+

django_structlog.celery

+

celery integration for django_structlog.

+
+
+class django_structlog.celery.steps.DjangoStructLogInitStep(parent: Any, **kwargs: Any)
+

Bases: Step

+

celery worker boot step to initialize django_structlog.

+
>>> from celery import Celery
+>>> from django_structlog.celery.steps import DjangoStructLogInitStep
+>>>
+>>> app = Celery("django_structlog_demo_project")
+>>> app.steps['worker'].add(DjangoStructLogInitStep)
+
+
+
+
+name = 'django_structlog.celery.steps.DjangoStructLogInitStep'
+
+ +
+ +
+
+django_structlog.celery.signals.bind_extra_task_metadata = <django.dispatch.dispatcher.Signal object>
+

Signal to add extra structlog bindings from celery’s task.

+
+
Parameters:
+
    +

  • task – the celery task being run

    • +

  • logger – the logger to bind more metadata or override existing bound metadata

    • +
+
+
+
>>> from django.dispatch import receiver
+>>> from django_structlog.celery import signals
+>>> import structlog
+>>>
+>>> @receiver(signals.bind_extra_task_metadata)
+... def receiver_bind_extra_task_metadata(sender, signal, task=None, logger=None, **kwargs):
+...     structlog.contextvars.bind_contextvars(correlation_id=task.request.correlation_id)
+
+
+
+ +
+
+django_structlog.celery.signals.modify_context_before_task_publish = <django.dispatch.dispatcher.Signal object>
+

Signal to modify context passed over to celery task’s context. You must modify the context dict.

+
+
Parameters:
+
    +

  • context – the context dict that will be passed over to the task runner’s logger

    • +

  • task_routing_key – routing key of the task

    • +

  • task_properties – task’s message properties

    • +
+
+
+
>>> from django.dispatch import receiver
+>>> from django_structlog.celery import signals
+>>>
+>>> @receiver(signals.modify_context_before_task_publish)
+... def receiver_modify_context_before_task_publish(sender, signal, context, task_routing_key=None, task_properties=None, **kwargs):
+...     keys_to_keep = {"request_id", "parent_task_id"}
+...     new_dict = {
+...         key_to_keep: context[key_to_keep]
+...         for key_to_keep in keys_to_keep
+...         if key_to_keep in context
+...     }
+...     context.clear()
+...     context.update(new_dict)
+
+
+
+ +
+
+django_structlog.celery.signals.pre_task_succeeded = <django.dispatch.dispatcher.Signal object>
+

Signal to add structlog bindings from celery’s successful task.

+
+
Parameters:
+
    +

  • logger – the logger to bind more metadata or override existing bound metadata

    • +

  • result – result of the succeeding task

    • +
+
+
+
>>> from django.dispatch import receiver
+>>> from django_structlog.celery import signals
+>>> import structlog
+>>>
+>>> @receiver(signals.pre_task_succeeded)
+... def receiver_pre_task_succeeded(sender, signal, logger=None, result=None, **kwargs):
+...     structlog.contextvars.bind_contextvars(result=str(result))
+
+
+
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/authors.html b/authors.html new file mode 100644 index 00000000..4d0cd029 --- /dev/null +++ b/authors.html @@ -0,0 +1,127 @@ + + + + + + + + + Authors — django-structlog 9.0.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Authors

+
    +

  • Jules Robichaud-Gagnon - Initial work - jrobichaud

    • +
+

See also the list of contributors who participated in this project.

+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/celery.html b/celery.html new file mode 100644 index 00000000..0061db6c --- /dev/null +++ b/celery.html @@ -0,0 +1,290 @@ + + + + + + + + + Celery Integration — django-structlog 9.0.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Celery Integration

+
+

Getting Started with Celery

+

In order to be able to support celery you need to configure both your webapp and your workers

+
+

Warning

+

If json is used to serialize your celery tasks, the log context in use when executing a task (through apply_async or delay) should only contain JSON-serializable data. You can use modify_context_before_task_publish to ensure this is the case.

+
+
+

Replace your requirements

+

First of all, make sure your django-structlog installation knows you use celery in order to validate compatibility with your installed version. See Installing “Extras” for more information.

+

Replace django-structlog with django-structlog[celery] in your requirements.txt.

+
django-structlog[celery]==X.Y.Z
+
+
+
+
+

Enable celery integration in your web app

+

In your settings.py

+
MIDDLEWARE = [
+    # ...
+    'django_structlog.middlewares.RequestMiddleware',
+]
+
+DJANGO_STRUCTLOG_CELERY_ENABLED = True
+
+
+
+
+

Initialize Celery Worker with DjangoStructLogInitStep

+

In your celery AppConfig’s module.

+
import logging
+
+import structlog
+from celery import Celery
+from celery.signals import setup_logging
+from django_structlog.celery.steps import DjangoStructLogInitStep
+
+app = Celery("your_celery_project")
+
+# A step to initialize django-structlog
+app.steps['worker'].add(DjangoStructLogInitStep)
+
+
+
+

Warning

+

If you use celery’s task_protocol v1, django-structlog will not be able to transfer metadata to child task.

+

Ex:

+
app = Celery("your_celery_project", task_protocol=1)
+
+
+
+
+
+

Configure celery’s logger

+

In the same file as before

+
@setup_logging.connect
+def receiver_setup_logging(loglevel, logfile, format, colorize, **kwargs):  # pragma: no cover
+    logging.config.dictConfig(
+        {
+           "version": 1,
+           "disable_existing_loggers": False,
+           "formatters": {
+               "json_formatter": {
+                   "()": structlog.stdlib.ProcessorFormatter,
+                   "processor": structlog.processors.JSONRenderer(),
+               },
+               "plain_console": {
+                   "()": structlog.stdlib.ProcessorFormatter,
+                   "processor": structlog.dev.ConsoleRenderer(),
+               },
+               "key_value": {
+                   "()": structlog.stdlib.ProcessorFormatter,
+                   "processor": structlog.processors.KeyValueRenderer(key_order=['timestamp', 'level', 'event', 'logger']),
+               },
+           },
+           "handlers": {
+               "console": {
+                   "class": "logging.StreamHandler",
+                   "formatter": "plain_console",
+               },
+               "json_file": {
+                   "class": "logging.handlers.WatchedFileHandler",
+                   "filename": "logs/json.log",
+                   "formatter": "json_formatter",
+               },
+               "flat_line_file": {
+                   "class": "logging.handlers.WatchedFileHandler",
+                   "filename": "logs/flat_line.log",
+                   "formatter": "key_value",
+               },
+           },
+           "loggers": {
+               "django_structlog": {
+                   "handlers": ["console", "flat_line_file", "json_file"],
+                   "level": "INFO",
+               },
+               "django_structlog_demo_project": {
+                   "handlers": ["console", "flat_line_file", "json_file"],
+                   "level": "INFO",
+               },
+           }
+       }
+    )
+
+    structlog.configure(
+        processors=[
+            structlog.contextvars.merge_contextvars,
+            structlog.stdlib.filter_by_level,
+            structlog.processors.TimeStamper(fmt="iso"),
+            structlog.stdlib.add_logger_name,
+            structlog.stdlib.add_log_level,
+            structlog.stdlib.PositionalArgumentsFormatter(),
+            structlog.processors.StackInfoRenderer(),
+            structlog.processors.format_exc_info,
+            structlog.processors.UnicodeDecoder(),
+            structlog.stdlib.ProcessorFormatter.wrap_for_formatter,
+        ],
+        logger_factory=structlog.stdlib.LoggerFactory(),
+        cache_logger_on_first_use=True,
+    )
+
+
+
+
+
+

Signals

+
+

modify_context_before_task_publish

+

You can connect to modify_context_before_task_publish signal in order to modify the metadata before it is stored in the task’s message.

+

By example you can strip down the context to keep only some of the keys:

+
@receiver(signals.modify_context_before_task_publish)
+def receiver_modify_context_before_task_publish(sender, signal, context, task_routing_key=None, task_properties=None, **kwargs):
+    keys_to_keep = {"request_id", "parent_task_id"}
+    new_dict = {key_to_keep: context[key_to_keep] for key_to_keep in keys_to_keep if key_to_keep in context}
+    context.clear()
+    context.update(new_dict)
+
+
+
+
+

bind_extra_task_metadata

+

You can optionally connect to bind_extra_task_metadata signal in order to bind more metadata to the logger or override existing bound metadata. This is called +in celery’s receiver_task_pre_run.

+
from django_structlog.celery import signals
+import structlog
+
+@receiver(signals.bind_extra_task_metadata)
+def receiver_bind_extra_request_metadata(sender, signal, task=None, logger=None, **kwargs):
+    structlog.contextvars.bind_contextvars(correlation_id=task.request.correlation_id)
+
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/changelog.html b/changelog.html new file mode 100644 index 00000000..adc2d061 --- /dev/null +++ b/changelog.html @@ -0,0 +1,881 @@ + + + + + + + + + Change Log — django-structlog 9.0.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Change Log

+
+

9.0.0 (November 26, 2024)

+

See: Upgrading to 9.0+

+
+
New:
+
+
Changes:
+
+
Other:
    +

  • Migrated project to use python 3.13 along with readthedocs generation.

    • +

  • now use isort

    • +

  • fixed codecov github action that was not properly configured and therefore not properly reporting coverage.

    • +
+
+
+
+
+

8.1.0 (May 24, 2024)

+
+
New:
    +

  • Add a setting DJANGO_STRUCTLOG_USER_ID_FIELD = 'pk' to customize what user field to use as user_id in the logs. See #546 and #545. Special thanks to @sshishov.

    • +
+
+
Changes:
    +

  • Drop support of python 3.7

    • +

  • Drop support of django 3.2, and 4.1

    • +
+
+
+
+
+

8.0.0 (March 13, 2024)

+

See: Upgrading to 8.0+

+
+
New:
+
+
+
+
+

7.1.0 (December 20, 2023)

+
+
New:
    +

  • add asgi’s async view cancellation event request_cancelled. See #413 and and Request Events.

    • +
+
+
+
+
+

7.0.0 (December 13, 2023)

+

See: Upgrading to 7.0+

+
+
New:
    +

  • (celery) add priority (if available) and routing_key to task_enqueued. See #345 and #341. Special thanks to badziyoussef.

    • +

  • Django 5.0 support. See #350. Take note async view cancellation when using asgi does not work yet, see #351.

    • +

  • Add streaming response support (for both sync and async) and Django 5’s async cancellation. See #353 and StreamingHttpResponse Events.

    • +
+
+
Changes:
    +

  • Supports django-ipware 6+ only. See #403. Special thanks to the maintainer @un33k.

    • +

  • Drop support of django 4.0. See #338. Special thanks to @jairhenrique.

    • +
+
+
Other:
    +
  • +
    Improved demo project
      +

    • Better UI

      • +

    • Easy switch between runserver_plus, wsgi an asgi

      • +

    • Front-end request feedbacks using toasts

      • +
    +
    +
    +
    • +
+
+
+
+
+

6.0.1 (November 29, 2023)

+
+
Fixes:
    +

  • freeze django-ipware<6 for now due to breaking changes. See #388

    • +
+
+
+
+
+

6.0 (October 3, 2023)

+

See: Upgrading to 6.0+

+
+
New:
    +

  • Python 3.12 support

    • +

  • Add support of logging Commands

    • +

  • task_revoked has now a signame metadata. See #323.

    • +

  • task_not_found has now a task_id and a task metadata. See #323.

    • +
+
+
Fixes:
    +

  • Add missing metadata when a task is revoked. See #317. Special thanks to @badziyoussef.

    • +
+
+
Changes:
    +

  • Drop support of python 3.7

    • +

  • Drop legacy code still supporting celery < 4

    • +
  • +
    Removal of deprecated:
      +

    • django_structlog.middlewares.CeleryMiddleware

      • +

    • django_structlog.middlewares.SyncRequestMiddleware

      • +

    • django_structlog.middlewares.AsyncRequestMiddleware

      • +

    • django_structlog.middlewares.request_middleware_router

      • +
    +
    +
    +
    • +

  • 4XX status codes now log by default as WARNING and 5XX as ERROR. The behaviour of 4XX can be customized with Configuration. See #308. Special thanks to @adinhodovic.

    • +

  • task_revoked’s signum is now an integer instead of an object. See #323.

    • +

  • task_not_found’s message was removed and replaced by task_id and task. See #323.

    • +

  • task_rejected’s message was removed and replaced by task_id. See #323.

    • +

  • Switched from git’s master to main branch

    • +
+
+
Other:
    +

  • Add new How Tos section in the documentation.

    • +
+
+
+
+
+

5.3.0 (June 30, 2023)

+
+
New:
    +

  • django setting DJANGO_STRUCTLOG_CELERY_ENABLED = True replacing django_structlog.middlewares.CeleryMiddleware. See Upgrading to 6.0+ and #265. Also introduce new internal app_settings that may come handy for future configurations.

    • +
+
+
Deprecations:
    +

  • django_structlog.middlewares.CeleryMiddleware (see above).

    • +
+
+
+
+
+

5.2.0 (June 29, 2023)

+
+
New:
+
+
+
+
+

5.1.0 (April 22, 2023)

+
+
New:
+
+
+
+
+

5.0.2 (April 16, 2023)

+

See: Upgrading to 5.0+

+
+
Fixes:
    +

  • Fix regression in 5.0.0 and 5.0.1 where exceptions were not logged as error but as info. See #226. Special thanks to @ntap-fge.

    • +
+
+
Rollbacks from 5.0.0:
    +

  • Rollback removal of django_structlog.signals.bind_extra_request_failed_metadata. Relates the above fix.

    • +
+
+
+
+
+

5.0.1 (March 24, 2023)

+

See: Upgrading to 5.0+

+
+
Changes:
    +

  • minimum requirements change for asgiref to 3.6.0. See #209. Special thanks to @adinsoon.

    • +
+
+
+
+
+

5.0.0 (March 23, 2023)

+

See: Upgrading to 5.0+

+
+
Changes:
    +

  • RequestMiddleware and CeleryMiddleware now properly support async views

    • +
+
+
Removed:
    +

  • (Rolled back in 5.0.2) django_structlog.signals.bind_extra_request_failed_metadata

    • +
+
+
Deprecates:
    +

  • django_structlog.middlewares.request_middleware_router

    • +

  • django_structlog.middlewares.requests.AsyncRequestMiddleware

    • +

  • django_structlog.middlewares.requests.SyncRequestMiddleware

    • +
+
+
+
+
+

4.1.1 (February 7, 2023)

+
+
New:
    +

  • Add django_structlog.middlewares.request_middleware_router to choose automatically between Async or Sync middleware

    • +
+
+
Rollbacks from 4.1.0:
    +

  • Rollback RequestMiddleware not being a class anymore, its an internal SyncRequestMiddleware

    • +
+
+
Others:
    +

  • Migrate project to pyproject.toml instead of setup.py

    • +

  • Add asgi server to demo project see Development.

    • +
+
+
+
+
+

4.1.0 (February 4, 2023)

+
+
New:
+
+
Changes:
    +

  • RequestMiddleware is no longer a class but a function due to async view support. This should only affect projects using the middleware not as intended. If this cause you problems, please refer to this issue #183, the documentation or feel free to open a new issue. Special thanks to @gvangool for pointing that out.

    • +
+
+
Others:
    +

  • Add colours in log in the demo project. See 63bdb4d to update your projects. Special thanks to @RoscoeTheDog.

    • +

  • Upgrade or remove various development packages

    • +
+
+
+
+
+

4.0.1 (October 25, 2022)

+
+
New:
+
+
+
+
+

4.0.0 (October 22, 2022)

+

See: Upgrading to 4.0+

+
+
Changes:
    +

  • django-structlog will now on follow LTS versions of Python, Django, and Celery. See #110. Special thanks to @jairhenrique for his convincing arguments.

    • +
+
+
New:
    +

  • You can now install django-structlog with celery extra. Specifying django-structlog[celery]==4.0.0 in requirements.txt will make sure your celery’s version is compatible.

    • +
+
+
Others:
    +

  • Upgrade or remove various development packages

    • +

  • Upgrade local development environment from python 3.7 to 3.10 and from django 3.2 to django 4.1

    • +

  • Added a gh-pages

    • +
+
+
+
+
+

3.0.1 (August 2, 2022)

+
+
Fixes:
    +

  • AttributeError with custom User without pk. See #80. Special thanks to @mlegner.

    • +
+
+
Others:
    +

  • Add dependabot to manage dependencies. See #83. Special thanks to @jairhenrique.

    • +

  • Upgrade various development packages

    • +
+
+
+
+
+

3.0.0 (August 1, 2022)

+

See: Upgrading to 3.0+

+
+
Changes:
    +
  • +
    django-structlog now uses structlog.contextvars instead of structlog.threadlocal. See the upgrade guide for more information (Upgrading to 3.0+) and #78. Special thanks to @AndrewGuenther and @shimizukawa.
      +

    • removed django_structlog.processors.inject_context_dict

      • +

    • minimum requirements change to python 3.7+

      • +

    • minimum requirements change to structlog 21.5

      • +
    +
    +
    +
    • +
+
+
New:
    +

  • Add python 3.10, celery 5.2 and django 4.0 to the test matrix.

    • +
+
+
Others:
    +

  • Remove wrapper_class from the configuration

    • +
+
+
+
+
+

2.2.0 (November 18, 2021)

+
+
Changes:
    +

  • Requests were logged as <WSGIRequest: GET '/'> (as an object) and now they are logged like this GET / (as a string). See #72. Special thanks to @humitos.

    • +
+
+
+
+
+

2.1.3 (September 28, 2021)

+
+
Fixes:
+
+
+
+
+

2.1.2 (August 31, 2021)

+
+
Fixes:
    +

  • django.core.exceptions.PermissionDenied is no longer logged as 500 but 403. See #68. Special thanks to @rabbit-aaron.

    • +
+
+
+
+
+

2.1.1 (June 22, 2021)

+
+
Others:
    +

  • Add django 3.2 and python 3.9 to the test matrix and pypi metadata. See #65. Special thanks to @kashewnuts.

    • +
+
+
+
+
+

2.1.0 (November 26, 2020)

+
+
New:
    +

  • django_structlog.processors.inject_context_dict for standard python loggers. See #24. Special thanks to @debfx.

    • +
+
+
+
+
+

2.0.0 (November 25, 2020)

+
+
Upgrade:
    +

  • There are necessary configuration changes needed. See Upgrading to 2.0+ for the details.

    • +
+
+
Changes:
+
+
Fixes:
+
+
+
+
+

1.6.3 (November 11, 2020)

+
+
Improvements:
    +

  • Call stack of exception in log is now an appropriate string. See #54. Special thanks to @debfx.

    • +
+
+
+
+
+

1.6.2 (October 4, 2020)

+
+
Fixes:
+
+
+
+
+

1.6.1 (August 13, 2020)

+
+
Fixes:
    +

  • Removed providing_args from signals to fix django 4.0 deprecation warnings introduced by django 3.1. See #44. Special thanks to @ticosax.

    • +

  • Fix sender of signals.pre_task_succeeded

    • +

  • Documented signal parameters in doc strings and API documentation to replace providing_args

    • +
+
+
Others:
    +

  • Add django 3.0 and 3.1 to the test matrix and pypi supported frameworks metadata

    • +

  • Fix reference of the previous ci in the documentation

    • +
+
+
+
+
+

1.6.0 (June 17, 2020)

+
+
Changes:
    +

  • task_succeed is now task_succeeded. Special thanks to @PawelMorawian.

    • +

  • Remove result from task_succeeded log (may be added back, see below). Special thanks to @PawelMorawian as well.

    • +

  • Add django_structlog.celery.signals.pre_task_succeeded. To be able to bind result if someone really needs it.

    • +
+
+
+
+
+

1.5.5 (June 16, 2020)

+
+
New:
    +

  • Add bind_extra_request_finished_metadata and bind_extra_request_failed_metadata. See #39. Special thanks to @prik2693.

    • +
+
+
+
+
+

1.5.4 (June 15, 2020)

+
+
Improvements:
    +

  • Remove redundant DJANGO_STRUCTLOG_LOG_USER_IN_REQUEST_FINISHED setting and just always make sure user_id is in request_finished and request_failed instead. See #37.

    • +
+
+
+
+
+

1.5.3 (June 15, 2020)

+
+
New:
+
+
+
+
+

1.5.2 (April 2, 2020)

+
+
New:
    +

  • Add modify_context_before_task_publish signal.

    • +
+
+
+
+
+

1.5.1 (March 18, 2020)

+
+
Improvements:
    +

  • Allow to override celery task metadata from binding. See #32 and #33. Special thanks to @chiragjn

    • +
+
+
+
+
+

1.5.0 (March 6, 2020)

+
+
Improvements:
+
+
+
+
+

1.4.1 (February 8, 2020)

+
+
New:
    +

  • Bind X-Correlation-ID HTTP header’s value as correlation_id when provided in request.

    • +
+
+
+
+
+

1.4.0 (February 7, 2020)

+
+
New:
    +

  • Use X-Request-ID HTTP header’s value as request_id when provided in request. See #22. Special thanks to @jairhenrique

    • +
+
+
+
+
+

1.3.5 (December 23, 2019)

+
+
New:
    +

  • Add python 3.8, celery 4.4 and django 3.0 to the test matrix.

    • +
+
+
Improvements:
    +

  • Extract test_app from django_structlog_demo_app in order to test django_structlog all by itself

    • +

  • Improve CI execution speed by merging stages

    • +

  • Upgrade a few development depencencies

    • +
+
+
+
+
+

1.3.4 (November 27, 2019)

+
+
Bugfix:
    +

  • Exception logging not working properly with DEBUG = False. See #19. Special thanks to @danpalmer

    • +
+
+
+
+
+

1.3.3 (October 6, 2019)

+
+
Bugfix:
    +

  • Fix support of different primary key for User model. See #13. Special thanks to @dhararon

    • +
+
+
+
+
+

1.3.2 (September 21, 2019)

+
+
Improvements:
    +

  • Add support of projects without AuthenticationMiddleware. See #9. Special thanks to @dhararon

    • +
+
+
+
+
+

1.3.1 (September 4, 2019)

+
+
Bugfixes:
    +

  • Remove extraneous rest-framework dependency introduced by #7. See #8 . Special thanks to @ghickman

    • +
+
+
+
+
+

1.3.0 (September 3, 2019)

+
+
Improvements:
+
+
+
+
+

1.2.3 (May 18, 2019)

+
+
Bugfixes:
    +

  • Fix structlog dependency not being installed

    • +
+
+
Improvements:
    +

  • Use black code formatter

    • +
+
+
+
+
+

1.2.2 (May 13, 2019)

+
+
Improvements:
    +

  • Use appropriate packaging

    • +
+
+
+
+
+

1.2.1 (May 8, 2019)

+
+
Bugfixes:
    +

  • Fix missing license file to be included in distribution

    • +
+
+
+
+
+

1.2.0 (May 8, 2019)

+
+
Changes:
    +

  • In the event task_enqueued, task_id and task_name are renamed child_task_id and child_task_name respectively to avoid override of task_id in nested tasks.

    • +
+
+
+
+
+

1.1.6 (May 8, 2019)

+
+
New:
    +

  • Add task_name when a task is enqueued

    • +
+
+
+
+
+

1.1.5 (May 8, 2019)

+
+
New:
    +

  • Add support of tasks calling other tasks (introducing parent_task_id)

    • +
+
+
Bugfixes:
    +

  • Fix missing packages

    • +
+
+
+
+
+

1.1.4 (April 22, 2019)

+
+
Improvements:
    +

  • Wheel distribution

    • +
+
+
+
+
+

1.1.3 (April 22, 2019)

+
+
Improvements:
    +

  • api documentation

    • +

  • code documentation

    • +
+
+
+
+
+

1.1.2 (April 19, 2019)

+
+
Changes:
    +

  • Rewrite the log texts as events

    • +
+
+
+
+
+

1.1.1 (April 18, 2019)

+
+
New:
    +

  • Add celery signal signals.bind_extra_task_metadata

    • +
+
+
+
+
+

1.1 (April 16, 2019)

+
+
New:
    +

  • Add celery tasks support

    • +
+
+
+
+
+

1.0.4 to 1.0.7 (April 14, 2019)

+
+
New:
    +

  • Automated releases with tags on travis

    • +
+
+
+
+
+

1.0.3 (April 14, 2019)

+
+
Bugfixes:
    +

  • Add bind_extra_request_metadata documentation

    • +
+
+
+
+
+

1.0.2 (April 13, 2019)

+
+
Bugfixes:
    +

  • Tweaked documentation.

    • +
+
+
+
+
+

1.0.0 (April 13, 2019)

+
+
New:
    +

  • Fist public release.

    • +
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/commands.html b/commands.html new file mode 100644 index 00000000..d2c88384 --- /dev/null +++ b/commands.html @@ -0,0 +1,185 @@ + + + + + + + + + Commands — django-structlog 9.0.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Commands

+
+

Prerequisites

+

Install django-structlog with command support (it will install django-extensions).

+
pip install django-structlog[commands]
+
+
+

Alternatively install django-extensions directly:

+
pip install django-extensions
+
+
+
+
+

Configuration

+

Enable django-structlog’s command logging:

+
DJANGO_STRUCTLOG_COMMAND_LOGGING_ENABLED = True
+
+
+

Add django-extensions’s @signalcommand to your commands

+
import structlog
+from django.core.management import BaseCommand
+from django_extensions.management.utils import signalcommand # <- add this
+
+logger = structlog.getLogger(__name__)
+
+
+class Command(BaseCommand):
+    def add_arguments(self, parser):
+        parser.add_argument("foo", type=str)
+
+    @signalcommand # <- add this
+    def handle(self, foo, *args, **options):
+        logger.info("my log", foo=foo)
+        return 0
+
+
+
+
+

Results

+

Log will add command_name and command_id to the logs:

+
$ python manage.py example_command bar
+2023-09-13T21:10:50.084368Z [info     ] command_started                [django_structlog.commands] command_name=django_structlog_demo_project.users.example_command command_id=be723d34-59f5-468e-9258-24232aa4cedd
+2023-09-13T21:10:50.085325Z [info     ] my log                         [django_structlog_demo_project.users.management.commands.example_command] command_id=be723d34-59f5-468e-9258-24232aa4cedd foo=bar
+2023-09-13T21:10:50.085877Z [info     ] command_finished               [django_structlog.commands] command_id=be723d34-59f5-468e-9258-24232aa4cedd
+
+
+

It also supports nested commands which will keep track of parent commands through parent_id:

+
$ python manage.py example_command bar
+2023-09-15T00:10:10.466616Z [info     ] command_started                [django_structlog.commands] command_id=f2a8c9a8-5aa3-4e22-b11c-f387449a34ed command_name=django_structlog_demo_project.users.example_command
+2023-09-15T00:10:10.467250Z [info     ] my log                         [django_structlog_demo_project.users.management.commands.example_command] command_id=f2a8c9a8-5aa3-4e22-b11c-f387449a34ed foo=bar
+2023-09-15T00:10:10.468176Z [info     ] command_started                [django_structlog.commands] baz=2 command_id=57524ccb-a8eb-4d30-a989-4e83ffdca9c0 command_name=django_structlog_demo_project.users.example_nested_command parent_command_id=f2a8c9a8-5aa3-4e22-b11c-f387449a34ed
+2023-09-15T00:10:10.468871Z [info     ] my nested log                  [django_structlog_demo_project.users.management.commands.example_nested_command] command_id=57524ccb-a8eb-4d30-a989-4e83ffdca9c0 parent_command_id=f2a8c9a8-5aa3-4e22-b11c-f387449a34ed
+2023-09-15T00:10:10.469418Z [info     ] command_finished               [django_structlog.commands] command_id=57524ccb-a8eb-4d30-a989-4e83ffdca9c0 parent_command_id=f2a8c9a8-5aa3-4e22-b11c-f387449a34ed
+2023-09-15T00:10:10.469964Z [info     ] my log 2                       [django_structlog_demo_project.users.management.commands.example_command] command_id=f2a8c9a8-5aa3-4e22-b11c-f387449a34ed
+2023-09-15T00:10:10.470585Z [info     ] command_finished               [django_structlog.commands] command_id=f2a8c9a8-5aa3-4e22-b11c-f387449a34ed
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/configuration.html b/configuration.html new file mode 100644 index 00000000..7477d4d9 --- /dev/null +++ b/configuration.html @@ -0,0 +1,166 @@ + + + + + + + + + Configuration — django-structlog 9.0.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Configuration

+

In your settings.py you can customize django-structlog.

+

Example:

+
import logging
+DJANGO_STRUCTLOG_STATUS_4XX_LOG_LEVEL = logging.INFO
+
+
+
+

Settings

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key

Type

Default

Description

DJANGO_STRUCTLOG_CELERY_ENABLED

boolean

False

See Celery Integration

DJANGO_STRUCTLOG_STATUS_4XX_LOG_LEVEL

int

logging.WARNING

Log level of 4XX status codes

DJANGO_STRUCTLOG_COMMAND_LOGGING_ENABLED

boolean

False

See Commands

DJANGO_STRUCTLOG_USER_ID_FIELD

boolean

"pk"

Change field used to identify user in logs, None to disable user binding

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/demo.html b/demo.html new file mode 100644 index 00000000..8d624fe1 --- /dev/null +++ b/demo.html @@ -0,0 +1,128 @@ + + + + + + + + + Demo app — django-structlog 9.0.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Demo app

+
docker compose up --build
+
+
+

Open http://127.0.0.1:8000/ in your browser.

+

Navigate while looking into the log files and shell’s output.

+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/development.html b/development.html new file mode 100644 index 00000000..10123c7f --- /dev/null +++ b/development.html @@ -0,0 +1,171 @@ + + + + + + + + + Development — django-structlog 9.0.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Development

+
+

Prerequisites

+ +
+
+

Installation

+
$ git clone https://github.com/jrobichaud/django-structlog.git
+$ cd django-structlog
+$ pip install -r requirements.txt
+$ pre-commit install
+
+
+
+
+

Start Demo App

+
$ docker compose up --build
+
+
+ +
+

Use RabbitMQ broker instead of redis

+
$ docker compose -f ./docker-compose.yml -f ./docker-compose.amqp.yml up --build
+
+
+
+
+
+

Building, Serving and Testing the Documentation Locally

+
$ docker compose -p django-structlog-docs -f docker-compose.docs.yml up --build
+Serving on http://127.0.0.1:8080
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/events.html b/events.html new file mode 100644 index 00000000..37f032ac --- /dev/null +++ b/events.html @@ -0,0 +1,419 @@ + + + + + + + + + Events and Metadata — django-structlog 9.0.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Events and Metadata

+
+

Django’s RequestMiddleware

+
+

Request Events

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Event

Type

Description

request_started

INFO

Django received a request

request_finished

INFO/WARNING/ERROR

request completed with status (2XX or 3XX)/4XX/5XX

request_cancelled

WARNING

request cancelled during an async request with asgi

request_failed

ERROR

unhandled exception occurred

+
+
+

StreamingHttpResponse Events

+

Specific to StreamingHttpResponse

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Event

Type

Description

streaming_started

INFO

Streaming of response started

streaming_finished

INFO

Streaming of response finished

streaming_cancelled

WARNING

Streaming of response was cancelled

streaming_failed

ERROR

Streaming of response failed

+
+
+

Request Bound Metadata

+

These metadata are repeated on each log of the current request and will be also be repeated in all children Celery tasks.

+ + + + + + + + + + + + + + + + + + + + +

Key

Value

request_id

UUID for the request or value of X-Request-ID HTTP header when provided

correlation_id

value of X-Correlation-ID HTTP header when provided

user_id

user’s id or None (requires django.contrib.auth.middleware.AuthenticationMiddleware)

+

DRF: it will only be in request_finished and request_failed events

+
+
If you need to override the bound user_id, it has to be done in all three signals:
+
+
+

ip

request’s ip

+

To bind more metadata or override existing metadata from request see Extending Request Log Metadata

+
+
+

Request Events Metadata

+

These metadata appear once along with their associated event

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Event

Key

Value

request_started

request

request as string

request_started

user_agent

request’s user agent

request_finished

code

request’s status code

request_failed

exception

exception traceback (requires format_exc_info)

+
+
+
+

Celery

+
+

Task Events

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Event

Type

Description

task_enqueued

INFO

A task was enqueued by request or another task

task_retrying

WARNING

Worker retry task

task_started

INFO

task just started executing

task_succeeded

INFO

Task completed successfully

task_failed

ERROR/INFO*

Task failed

task_revoked

WARNING

Task was canceled

task_not_found

ERROR

Celery app did not discover the requested task

task_rejected

ERROR

Task could not be enqueued

+

* if task threw an expected exception, it will logged as INFO. See Celery’s Task.throws

+
+
+

Task Bound Metadata

+

These metadata are repeated on each log of the current task and will be also be repeated in all children Celery tasks. +Take note that all the caller’s logger bound metadata are also bound to the task’s logger.

+ + + + + + + + + + + + + + +

Key

Value

task_id

UUID of the current task

parent_task_id

UUID of the parent’s task (if any)

+

To bind more metadata or override existing metadata from task see Signals

+
+
+

Task Event Metadata

+

These metadata appear once along with their associated event

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Event

Key

Value

task_enqueued

child_task_id

id of the task being enqueued

task_enqueued

child_task_name

name of the task being enqueued

task_enqueued

routing_key

task’s routing key

task_enqueued

priority

priority of task (if any)

task_retrying

reason

reason for retry

task_started

task

name of the task

task_failed

error

exception as string

task_failed

exception*

exception’s traceback

task_revoked

terminated

Set to True if the task was terminated

task_revoked

signum

python termination signal’s number

task_revoked

signame

python termination signal’s name

task_revoked

expired

see Celery’s documentation

task_revoked

task_id

id of the task being revoked

task_revoked

task

name of the task being revoked

task_not_found

task_id

id of the task not found

task_not_found

task

name of the task not found

task_rejected

task_id

id of the task being rejected

+

* if task threw an expected exception, exception will be omitted. See Celery’s Task.throws

+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/example_outputs.html b/example_outputs.html new file mode 100644 index 00000000..15b6736d --- /dev/null +++ b/example_outputs.html @@ -0,0 +1,153 @@ + + + + + + + + + Example outputs — django-structlog 9.0.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Example outputs

+
+

Flat lines file (logs/flat_lines.log)

+
timestamp='2019-04-13T19:39:29.321453Z' level='info' event='request_started' logger='django_structlog.middlewares.request' request_id='c53dff1d-3fc5-4257-a78a-9a567c937561' user_id=1 ip='0.0.0.0' request=GET / user_agent='Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.86 Safari/537.36'
+timestamp='2019-04-13T19:39:29.345207Z' level='info' event='request_finished' logger='django_structlog.middlewares.request' request_id='c53dff1d-3fc5-4257-a78a-9a567c937561' user_id=1 ip='0.0.0.0' code=200
+timestamp='2019-04-13T19:39:31.086155Z' level='info' event='request_started' logger='django_structlog.middlewares.request' request_id='3a8f801c-072b-4805-8f38-e1337f363ed4' user_id=1 ip='0.0.0.0' request=POST /success_task user_agent='Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.86 Safari/537.36'
+timestamp='2019-04-13T19:39:31.089925Z' level='info' event='Enqueuing successful task' logger='django_structlog_demo_project.home.views' request_id='3a8f801c-072b-4805-8f38-e1337f363ed4' user_id=1 ip='0.0.0.0'
+timestamp='2019-04-13T19:39:31.147590Z' level='info' event='task_enqueued' logger='django_structlog.middlewares.celery' request_id='3a8f801c-072b-4805-8f38-e1337f363ed4' user_id=1 ip='0.0.0.0' child_task_id='6b11fd80-3cdf-4de5-acc2-3fd4633aa654'
+timestamp='2019-04-13T19:39:31.153081Z' level='info' event='This is a successful task' logger='django_structlog_demo_project.taskapp.celery' task_id='6b11fd80-3cdf-4de5-acc2-3fd4633aa654' request_id='3a8f801c-072b-4805-8f38-e1337f363ed4' user_id=1 ip='0.0.0.0'
+timestamp='2019-04-13T19:39:31.160043Z' level='info' event='request_finished' logger='django_structlog.middlewares.request' request_id='3a8f801c-072b-4805-8f38-e1337f363ed4' user_id=1 ip='0.0.0.0' code=201
+timestamp='2019-04-13T19:39:31.162372Z' level='info' event='task_succeed' logger='django_structlog.middlewares.celery' task_id='6b11fd80-3cdf-4de5-acc2-3fd4633aa654' request_id='3a8f801c-072b-4805-8f38-e1337f363ed4' user_id=1 ip='0.0.0.0' result='None'
+
+
+
+
+

Json file (logs/json.log)

+
{"request_id": "c53dff1d-3fc5-4257-a78a-9a567c937561", "user_id": 1, "ip": "0.0.0.0", "request": "GET /", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.86 Safari/537.36", "event": "request_started", "timestamp": "2019-04-13T19:39:29.321453Z", "logger": "django_structlog.middlewares.request", "level": "info"}
+{"request_id": "c53dff1d-3fc5-4257-a78a-9a567c937561", "user_id": 1, "ip": "0.0.0.0", "code": 200, "event": "request_finished", "timestamp": "2019-04-13T19:39:29.345207Z", "logger": "django_structlog.middlewares.request", "level": "info"}
+{"request_id": "3a8f801c-072b-4805-8f38-e1337f363ed4", "user_id": 1, "ip": "0.0.0.0", "request": "POST /success_task", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.86 Safari/537.36", "event": "request_started", "timestamp": "2019-04-13T19:39:31.086155Z", "logger": "django_structlog.middlewares.request", "level": "info"}
+{"request_id": "3a8f801c-072b-4805-8f38-e1337f363ed4", "user_id": 1, "ip": "0.0.0.0", "event": "Enqueuing successful task", "timestamp": "2019-04-13T19:39:31.089925Z", "logger": "django_structlog_demo_project.home.views", "level": "info"}
+{"request_id": "3a8f801c-072b-4805-8f38-e1337f363ed4", "user_id": 1, "ip": "0.0.0.0", "child_task_id": "6b11fd80-3cdf-4de5-acc2-3fd4633aa654", "event": "task_enqueued", "timestamp": "2019-04-13T19:39:31.147590Z", "logger": "django_structlog.middlewares.celery", "level": "info"}
+{"task_id": "6b11fd80-3cdf-4de5-acc2-3fd4633aa654", "request_id": "3a8f801c-072b-4805-8f38-e1337f363ed4", "user_id": 1, "ip": "0.0.0.0", "event": "This is a successful task", "timestamp": "2019-04-13T19:39:31.153081Z", "logger": "django_structlog_demo_project.taskapp.celery", "level": "info"}
+{"request_id": "3a8f801c-072b-4805-8f38-e1337f363ed4", "user_id": 1, "ip": "0.0.0.0", "code": 201, "event": "request_finished", "timestamp": "2019-04-13T19:39:31.160043Z", "logger": "django_structlog.middlewares.request", "level": "info"}
+{"task_id": "6b11fd80-3cdf-4de5-acc2-3fd4633aa654", "request_id": "3a8f801c-072b-4805-8f38-e1337f363ed4", "user_id": 1, "ip": "0.0.0.0", "result": "None", "event": "task_succeed", "timestamp": "2019-04-13T19:39:31.162372Z", "logger": "django_structlog.middlewares.celery", "level": "info"}
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/genindex.html b/genindex.html new file mode 100644 index 00000000..68ae342a --- /dev/null +++ b/genindex.html @@ -0,0 +1,295 @@ + + + + + + + + Index — django-structlog 9.0.0 documentation + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Index
    • +
  • +
    • +
+
+
+
+
+ + +

Index

+ +
+ A + | B + | D + | F + | H + | M + | N + | P + | R + | S + | U + +
+

A

+ + +
+ +

B

+ + + +
+ +

D

+ + + +
    +
  • + django_structlog + +
    • +
  • + django_structlog.celery + +
    • +
  • + django_structlog.celery.signals + +
    • +
+ +

F

+ + +
+ +

H

+ + +
+ +

M

+ + +
+ +

N

+ + +
+ +

P

+ + + +
+ +

R

+ + +
+ +

S

+ + +
+ +

U

+ + +
+ + + +
+
+
+ +
+ +
+

© Copyright 2019, Jules Robichaud-Gagnon.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/getting_started.html b/getting_started.html new file mode 100644 index 00000000..9eb15c59 --- /dev/null +++ b/getting_started.html @@ -0,0 +1,276 @@ + + + + + + + + + Getting Started — django-structlog 9.0.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Getting Started

+

These steps will show how to integrate the middleware to your awesome application.

+
+

Installation

+

Install the library

+
pip install django-structlog
+
+
+

Add app

+
INSTALLED_APP = [
+    # ...
+    "django_structlog",
+    # ...
+]
+
+
+

Add middleware

+
MIDDLEWARE = [
+    # ...
+    "django_structlog.middlewares.RequestMiddleware",
+]
+
+
+

Add appropriate structlog configuration to your settings.py

+
import structlog
+
+LOGGING = {
+    "version": 1,
+    "disable_existing_loggers": False,
+    "formatters": {
+        "json_formatter": {
+            "()": structlog.stdlib.ProcessorFormatter,
+            "processor": structlog.processors.JSONRenderer(),
+        },
+        "plain_console": {
+            "()": structlog.stdlib.ProcessorFormatter,
+            "processor": structlog.dev.ConsoleRenderer(),
+        },
+        "key_value": {
+            "()": structlog.stdlib.ProcessorFormatter,
+            "processor": structlog.processors.KeyValueRenderer(key_order=['timestamp', 'level', 'event', 'logger']),
+        },
+    },
+    "handlers": {
+        # Important notes regarding handlers.
+        #
+        # 1. Make sure you use handlers adapted for your project.
+        # These handlers configurations are only examples for this library.
+        # See python's logging.handlers: https://docs.python.org/3/library/logging.handlers.html
+        #
+        # 2. You might also want to use different logging configurations depending of the environment.
+        # Different files (local.py, tests.py, production.py, ci.py, etc.) or only conditions.
+        # See https://docs.djangoproject.com/en/dev/topics/settings/#designating-the-settings
+        "console": {
+            "class": "logging.StreamHandler",
+            "formatter": "plain_console",
+        },
+        "json_file": {
+            "class": "logging.handlers.WatchedFileHandler",
+            "filename": "logs/json.log",
+            "formatter": "json_formatter",
+        },
+        "flat_line_file": {
+            "class": "logging.handlers.WatchedFileHandler",
+            "filename": "logs/flat_line.log",
+            "formatter": "key_value",
+        },
+    },
+    "loggers": {
+        "django_structlog": {
+            "handlers": ["console", "flat_line_file", "json_file"],
+            "level": "INFO",
+        },
+        # Make sure to replace the following logger's name for yours
+        "django_structlog_demo_project": {
+            "handlers": ["console", "flat_line_file", "json_file"],
+            "level": "INFO",
+        },
+    }
+}
+
+structlog.configure(
+    processors=[
+        structlog.contextvars.merge_contextvars,
+        structlog.stdlib.filter_by_level,
+        structlog.processors.TimeStamper(fmt="iso"),
+        structlog.stdlib.add_logger_name,
+        structlog.stdlib.add_log_level,
+        structlog.stdlib.PositionalArgumentsFormatter(),
+        structlog.processors.StackInfoRenderer(),
+        structlog.processors.format_exc_info,
+        structlog.processors.UnicodeDecoder(),
+        structlog.stdlib.ProcessorFormatter.wrap_for_formatter,
+    ],
+    logger_factory=structlog.stdlib.LoggerFactory(),
+    cache_logger_on_first_use=True,
+)
+
+
+

Start logging with structlog instead of logging.

+
import structlog
+logger = structlog.get_logger(__name__)
+
+
+
+
+

Extending Request Log Metadata

+

By default only a request_id and the user_id are bound from the request but pertinent log metadata may vary from a project to another.

+

If you need to add more metadata from the request you can implement a convenient signal receiver to bind them. You can also override existing bound metadata the same way.

+
from django.contrib.sites.shortcuts import get_current_site
+from django.dispatch import receiver
+from django_structlog import signals
+import structlog
+
+
+@receiver(signals.bind_extra_request_metadata)
+def bind_domain(request, logger, **kwargs):
+    current_site = get_current_site(request)
+    structlog.contextvars.bind_contextvars(domain=current_site.domain)
+
+
+
+
+

Standard Loggers

+

It is also possible to log using standard python logger.

+

In your formatters, add the foreign_pre_chain section, and then add structlog.contextvars.merge_contextvars:

+
LOGGING = {
+    "version": 1,
+    "disable_existing_loggers": False,
+    "formatters": {
+        "json_formatter": {
+            "()": structlog.stdlib.ProcessorFormatter,
+            "processor": structlog.processors.JSONRenderer(),
+            # Add this section:
+            "foreign_pre_chain": [
+                structlog.contextvars.merge_contextvars, # <---- add this
+                # customize the rest as you need
+                structlog.processors.TimeStamper(fmt="iso"),
+                structlog.stdlib.add_logger_name,
+                structlog.stdlib.add_log_level,
+                structlog.stdlib.PositionalArgumentsFormatter(),
+            ],
+        },
+    },
+    ...
+ }
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/how_tos.html b/how_tos.html new file mode 100644 index 00000000..1d2e431d --- /dev/null +++ b/how_tos.html @@ -0,0 +1,244 @@ + + + + + + + + + How Tos — django-structlog 9.0.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

How Tos

+

These are code snippets on how to achieve some specific use cases.

+
+

Warning

+

Be aware they are untested. Please open an issue if there are bugs in these examples or if you want to share some great examples that should be there.

+
+
+

Bind request_id to response’s header

+

You can add the request_id to a custom response header X-Request-ID in order to trace the request by the caller.

+

Origin: #231

+
from django.dispatch import receiver
+from django_structlog import signals
+import structlog
+
+
+@receiver(signals.update_failure_response)
+@receiver(signals.bind_extra_request_finished_metadata)
+def add_request_id_to_error_response(response, logger, **kwargs):
+    context = structlog.contextvars.get_merged_contextvars(logger)
+    response['X-Request-ID'] = context["request_id"]
+
+
+
+
+

Bind rest_framework_simplejwt token’s user id

+

Bind token’s user_id from rest_framework_simplejwt to the request.

+

It is a workaround for restframework’s non-standard authentication system. +It prevents access of the user in middlewares, therefore django-structlog cannot bind the user_id by default.

+
import structlog
+from django.dispatch import receiver
+from django_structlog.signals import bind_extra_request_metadata
+from rest_framework_simplejwt.tokens import UntypedToken
+
+@receiver(bind_extra_request_metadata)
+def bind_token_user_id(request, logger, **kwargs):
+    try:
+        header = request.META.get("HTTP_AUTHORIZATION")
+        if header:
+            raw_token = header.split()[1]
+            token = UntypedToken(raw_token)
+            user_id = token["user_id"]
+            structlog.contextvars.bind_contextvars(user_id=user_id)
+    except Exception:
+        pass
+
+
+
+
+

Bind AWS’s X-Amzn-Trace-Id

+

See Request tracing for your Application Load Balancer

+

Origin: #324

+
from django.dispatch import receiver
+from django_structlog import signals
+from django_structlog.middlewares.request import get_request_header
+import structlog
+
+@receiver(signals.bind_extra_request_metadata)
+def bind_trace_id(request, logger, **kwargs):
+    trace_id = get_request_header(
+         request, "x-amzn-trace-id", "HTTP_X_AMZN_TRACE_ID"
+    )
+    if trace_id:
+        structlog.contextvars.bind_contextvars(trace_id=trace_id)
+
+
+
+
+

Filter logs from being recorded

+

You can add a custom filter to prevent some specific logs from being recorded, based on your criteria

+

See Django logging documentation

+

Origin: #412

+
# your_project/logging/filters.py
+
+import logging
+
+class ExcludeEventsFilter(logging.Filter):
+    def __init__(self, excluded_event_type=None):
+        super().__init__()
+        self.excluded_event_type = excluded_event_type
+
+    def filter(self, record):
+        if not isinstance(record.msg, dict) or self.excluded_event_type is None:
+            return True  # Include the log message if msg is not a dictionary or excluded_event_type is not provided
+
+        if record.msg.get('event') in self.excluded_event_type:
+            return False  # Exclude the log message
+        return True  # Include the log message
+
+
+# in your settings.py
+
+LOGGING = {
+    'version': 1,
+    'disable_existing_loggers': False,
+    'handlers': {
+        'console': {
+            'class': 'logging.StreamHandler',
+            'filters': ['exclude_request_started']
+        },
+    },
+    'filters': {
+        'exclude_request_started': {
+            '()': 'your_project.logging.filters.ExcludeEventsFilter',
+            'excluded_event_type': ['request_started']  # Example excluding request_started event
+        },
+    },
+    'loggers': {
+        'django': {
+            'handlers': ['console'],
+            'level': 'DEBUG',
+        },
+    },
+}
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 00000000..ac735e97 --- /dev/null +++ b/index.html @@ -0,0 +1,329 @@ + + + + + + + + + django-structlog — django-structlog 9.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

django-structlog

+
+
PyPI version PyPI - Wheel Build Status Documentation Status codecov GitHub issues GitHub pull requests
+
PyPI - Django Version Supported Python versions License Black Ruff
+
Published on Django Packages
+
GitHub watchers GitHub stars GitHub forks
+
+

django-structlog is a structured logging integration for Django project using structlog

+

Logging will then produce additional cohesive metadata on each logs that makes it easier to track events or incidents.

+ +
+

Logging comparison

+
+

Standard logging:

+
>>> import logging
+>>> logger = logging.get_logger(__name__)
+>>> logger.info("An error occurred")
+
+
+
An error occurred
+
+
+

Well… ok

+
+
+

With django-structlog and flat_line:

+
>>> import structlog
+>>> logger = structlog.get_logger(__name__)
+>>> logger.info("an_error_occurred", bar="Buz")
+
+
+
timestamp='2019-04-13T19:39:31.089925Z' level='info' event='an_error_occurred' logger='my_awesome_project.my_awesome_module' request_id='3a8f801c-072b-4805-8f38-e1337f363ed4' user_id=1 ip='0.0.0.0' bar='Buz'
+
+
+

Then you can search with commands like:

+
$ cat logs/flat_line.log | grep request_id='3a8f801c-072b-4805-8f38-e1337f363ed4'
+
+
+
+
+

With django-structlog and json

+
>>> import structlog
+>>> logger = structlog.get_logger(__name__)
+>>> logger.info("an_error_occurred", bar="Buz")
+
+
+
{"request_id": "3a8f801c-072b-4805-8f38-e1337f363ed4", "user_id": 1, "ip": "0.0.0.0", "event": "an_error_occurred", "timestamp": "2019-04-13T19:39:31.089925Z", "logger": "my_awesome_project.my_awesome_module", "level": "info", "bar": "Buz"}
+
+
+

Then you can search with commands like:

+
$ cat logs/json.log | jq '.[] | select(.request_id="3a8f801c-072b-4805-8f38-e1337f363ed4")' -s
+
+
+
+
+
+
+

Contents, indices and tables

+
+ +
+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/licence.html b/licence.html new file mode 100644 index 00000000..0834514b --- /dev/null +++ b/licence.html @@ -0,0 +1,138 @@ + + + + + + + + + Licence — django-structlog 9.0.0 documentation + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Licence

+

MIT License

+

Copyright (c) 2020 Jules Robichaud-Gagnon

+

Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the “Software”), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions:

+

The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE.

+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/objects.inv b/objects.inv new file mode 100644 index 00000000..182872dd Binary files /dev/null and b/objects.inv differ diff --git a/py-modindex.html b/py-modindex.html new file mode 100644 index 00000000..e5eece3b --- /dev/null +++ b/py-modindex.html @@ -0,0 +1,159 @@ + + + + + + + + Python Module Index — django-structlog 9.0.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Python Module Index
    • +
  • +
    • +
+
+
+
+
+ + +

Python Module Index

+ +
+ d +
+ + + + + + + + + + + + + + + + + + + + + + +
 
+ d
+ django_structlog +
    + django_structlog.celery +
    + django_structlog.celery.signals +
    + django_structlog.celery.steps +
    + django_structlog.middlewares +
    + django_structlog.signals +
+ + +
+
+
+ +
+ +
+

© Copyright 2019, Jules Robichaud-Gagnon.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/running_tests.html b/running_tests.html new file mode 100644 index 00000000..fc28c590 --- /dev/null +++ b/running_tests.html @@ -0,0 +1,131 @@ + + + + + + + + + Running the tests — django-structlog 9.0.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Running the tests

+

Note: For the moment redis is needed to run the tests. The easiest way is to start docker demo’s redis.

+
docker compose up -d redis
+pip install -r requirements.txt
+env CELERY_BROKER_URL=redis://0.0.0.0:6379 DJANGO_SETTINGS_MODULE=config.settings.test pytest test_app
+env CELERY_BROKER_URL=redis://0.0.0.0:6379 DJANGO_SETTINGS_MODULE=config.settings.test_demo_app pytest django_structlog_demo_project
+docker compose stop redis
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/search.html b/search.html new file mode 100644 index 00000000..8fe1e425 --- /dev/null +++ b/search.html @@ -0,0 +1,134 @@ + + + + + + + + Search — django-structlog 9.0.0 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Search
    • +
  • +
    • +
+
+
+
+
+ + + + +
+ +
+ +
+
+
+ +
+ +
+

© Copyright 2019, Jules Robichaud-Gagnon.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/searchindex.js b/searchindex.js new file mode 100644 index 00000000..7203666c --- /dev/null +++ b/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"alltitles": {"(If you use celery) Make sure you use DJANGO_STRUCTLOG_CELERY_ENABLED = True": [[16, "if-you-use-celery-make-sure-you-use-django-structlog-celery-enabled-true"]], "1. Update structlog settings": [[16, "update-structlog-settings"]], "1.0.0 (April 13, 2019)": [[4, "id83"]], "1.0.2 (April 13, 2019)": [[4, "april-13-2019"]], "1.0.3 (April 14, 2019)": [[4, "april-14-2019"]], "1.0.4 to 1.0.7 (April 14, 2019)": [[4, "to-1-0-7-april-14-2019"]], "1.1 (April 16, 2019)": [[4, "april-16-2019"]], "1.1.1 (April 18, 2019)": [[4, "april-18-2019"]], "1.1.2 (April 19, 2019)": [[4, "april-19-2019"]], "1.1.3 (April 22, 2019)": [[4, "id82"]], "1.1.4 (April 22, 2019)": [[4, "april-22-2019"]], "1.1.5 (May 8, 2019)": [[4, "id81"]], "1.1.6 (May 8, 2019)": [[4, "id80"]], "1.2.0 (May 8, 2019)": [[4, "id79"]], "1.2.1 (May 8, 2019)": [[4, "may-8-2019"]], "1.2.2 (May 13, 2019)": [[4, "may-13-2019"]], "1.2.3 (May 18, 2019)": [[4, "may-18-2019"]], "1.3.0 (September 3, 2019)": [[4, "september-3-2019"]], "1.3.1 (September 4, 2019)": [[4, "september-4-2019"]], "1.3.2 (September 21, 2019)": [[4, "september-21-2019"]], "1.3.3 (October 6, 2019)": [[4, "october-6-2019"]], "1.3.4 (November 27, 2019)": [[4, "november-27-2019"]], "1.3.5 (December 23, 2019)": [[4, "december-23-2019"]], "1.4.0 (February 7, 2020)": [[4, "february-7-2020"]], "1.4.1 (February 8, 2020)": [[4, "february-8-2020"]], "1.5.0 (March 6, 2020)": [[4, "march-6-2020"]], "1.5.1 (March 18, 2020)": [[4, "march-18-2020"]], "1.5.2 (April 2, 2020)": [[4, "april-2-2020"]], "1.5.3 (June 15, 2020)": [[4, "id62"]], "1.5.4 (June 15, 2020)": [[4, "june-15-2020"]], "1.5.5 (June 16, 2020)": [[4, "june-16-2020"]], "1.6.0 (June 17, 2020)": [[4, "june-17-2020"]], "1.6.1 (August 13, 2020)": [[4, "august-13-2020"]], "1.6.2 (October 4, 2020)": [[4, "october-4-2020"]], "1.6.3 (November 11, 2020)": [[4, "november-11-2020"]], "2. Replace all logger.bind with structlog.contextvars.bind_contextvars": [[16, "replace-all-logger-bind-with-structlog-contextvars-bind-contextvars"]], "2.0.0 (November 25, 2020)": [[4, "november-25-2020"]], "2.1.0 (November 26, 2020)": [[4, "november-26-2020"]], "2.1.1 (June 22, 2021)": [[4, "june-22-2021"]], "2.1.2 (August 31, 2021)": [[4, "august-31-2021"]], "2.1.3 (September 28, 2021)": [[4, "september-28-2021"]], "2.2.0 (November 18, 2021)": [[4, "november-18-2021"]], "3.0.0 (August 1, 2022)": [[4, "august-1-2022"]], "3.0.1 (August 2, 2022)": [[4, "august-2-2022"]], "4.0.0 (October 22, 2022)": [[4, "october-22-2022"]], "4.0.1 (October 25, 2022)": [[4, "october-25-2022"]], "4.1.0 (February 4, 2023)": [[4, "february-4-2023"]], "4.1.1 (February 7, 2023)": [[4, "february-7-2023"]], "5.0.0 (March 23, 2023)": [[4, "march-23-2023"]], "5.0.1 (March 24, 2023)": [[4, "march-24-2023"]], "5.0.2 (April 16, 2023)": [[4, "april-16-2023"]], "5.1.0 (April 22, 2023)": [[4, "april-22-2023"]], "5.2.0 (June 29, 2023)": [[4, "june-29-2023"]], "5.3.0 (June 30, 2023)": [[4, "june-30-2023"]], "6.0 (October 3, 2023)": [[4, "october-3-2023"]], "6.0.1 (November 29, 2023)": [[4, "november-29-2023"]], "7.0.0 (December 13, 2023)": [[4, "december-13-2023"]], "7.1.0 (December 20, 2023)": [[4, "december-20-2023"]], "8.0.0 (March 13, 2024)": [[4, "march-13-2024"]], "8.1.0 (May 24, 2024)": [[4, "may-24-2024"]], "9.0.0 (November 26, 2024)": [[4, "november-26-2024"]], "API documentation": [[1, null]], "Acknowledgments": [[0, null]], "Add django_structlog to installed app": [[16, "add-django-structlog-to-installed-app"]], "Additional Popular Integrations": [[13, "additional-popular-integrations"]], "Authors": [[2, null]], "Bind AWS\u2019s X-Amzn-Trace-Id": [[12, "bind-aws-s-x-amzn-trace-id"]], "Bind request_id to response\u2019s header": [[12, "bind-request-id-to-response-s-header"]], "Bind rest_framework_simplejwt token\u2019s user id": [[12, "bind-rest-framework-simplejwt-token-s-user-id"]], "Building, Serving and Testing the Documentation Locally": [[8, "building-serving-and-testing-the-documentation-locally"]], "Celery": [[9, "celery"], [13, "id4"]], "Celery Integration": [[3, null]], "Change Log": [[4, null]], "Changes if you use celery": [[16, "changes-if-you-use-celery"]], "Changes to do": [[16, "changes-to-do"]], "Changes you need to do": [[16, "changes-you-need-to-do"]], "Commands": [[5, null]], "Configuration": [[5, "configuration"], [6, null]], "Configure celery\u2019s logger": [[3, "configure-celery-s-logger"]], "Contents, indices and tables": [[13, "contents-indices-and-tables"]], "Demo app": [[7, null]], "Development": [[8, null]], "Django REST framework": [[13, "id1"]], "Django\u2019s RequestMiddleware": [[9, "django-s-requestmiddleware"]], "Enable celery integration in your web app": [[3, "enable-celery-integration-in-your-web-app"]], "Events and Metadata": [[9, null]], "Example outputs": [[10, null]], "Extending Request Log Metadata": [[11, "extending-request-log-metadata"]], "Filter logs from being recorded": [[12, "filter-logs-from-being-recorded"]], "Flat lines file (logs/flat_lines.log)": [[10, "flat-lines-file-logs-flat-lines-log"]], "For drf-standardized-errors users": [[16, "for-drf-standardized-errors-users"]], "Getting Started": [[11, null]], "Getting Started with Celery": [[3, "getting-started-with-celery"]], "How Tos": [[12, null]], "Initialize Celery Worker with DjangoStructLogInitStep": [[3, "initialize-celery-worker-with-djangostructloginitstep"]], "Installation": [[8, "installation"], [11, "installation"]], "Internal changes in how RequestMiddleware handles exceptions": [[16, "internal-changes-in-how-requestmiddleware-handles-exceptions"]], "Json file (logs/json.log)": [[10, "json-file-logs-json-log"]], "Licence": [[14, null]], "Logging comparison": [[13, "logging-comparison"]], "Make sure you use django_structlog.middlewares.RequestMiddleware": [[16, "make-sure-you-use-django-structlog-middlewares-requestmiddleware"]], "Minimum requirements": [[16, "minimum-requirements"], [16, "id1"], [16, "id2"], [16, "id3"], [16, "id4"]], "Prerequisites": [[5, "prerequisites"], [8, "prerequisites"]], "Replace your requirements": [[3, "replace-your-requirements"]], "Request Bound Metadata": [[9, "request-bound-metadata"]], "Request Events": [[9, "request-events"]], "Request Events Metadata": [[9, "request-events-metadata"]], "Results": [[5, "results"]], "Running the tests": [[15, null]], "Settings": [[6, "settings"]], "Signals": [[3, "signals"]], "Standard Loggers": [[11, "standard-loggers"]], "Standard logging:": [[13, "standard-logging"]], "Start Demo App": [[8, "start-demo-app"]], "StreamingHttpResponse Events": [[9, "streaminghttpresponse-events"]], "Task Bound Metadata": [[9, "task-bound-metadata"]], "Task Event Metadata": [[9, "task-event-metadata"]], "Task Events": [[9, "task-events"]], "Type hints": [[16, "type-hints"]], "Upgrade Guide": [[16, null]], "Upgrading to 2.0+": [[16, "upgrading-to-2-0"]], "Upgrading to 3.0+": [[16, "upgrading-to-3-0"]], "Upgrading to 4.0+": [[16, "upgrading-to-4-0"]], "Upgrading to 5.0+": [[16, "upgrading-to-5-0"]], "Upgrading to 6.0+": [[16, "upgrading-to-6-0"]], "Upgrading to 7.0+": [[16, "upgrading-to-7-0"]], "Upgrading to 8.0+": [[16, "upgrading-to-8-0"]], "Upgrading to 9.0+": [[16, "upgrading-to-9-0"]], "Use RabbitMQ broker instead of redis": [[8, "use-rabbitmq-broker-instead-of-redis"]], "With django-structlog and flat_line:": [[13, "with-django-structlog-and-flat-line"]], "With django-structlog and json": [[13, "with-django-structlog-and-json"]], "bind_extra_task_metadata": [[3, "bind-extra-task-metadata"]], "django-ninja": [[13, "id3"]], "django-structlog": [[13, null]], "django_structlog": [[1, "module-django_structlog"]], "django_structlog.celery": [[1, "module-django_structlog.celery"]], "modify_context_before_task_publish": [[3, "modify-context-before-task-publish"]]}, "docnames": ["acknowledgements", "api_documentation", "authors", "celery", "changelog", "commands", "configuration", "demo", "development", "events", "example_outputs", "getting_started", "how_tos", "index", "licence", "running_tests", "upgrade_guide"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["acknowledgements.rst", "api_documentation.rst", "authors.rst", "celery.rst", "changelog.rst", "commands.rst", "configuration.rst", "demo.rst", "development.rst", "events.rst", "example_outputs.rst", "getting_started.rst", "how_tos.rst", "index.rst", "licence.rst", "running_tests.rst", "upgrade_guide.rst"], "indexentries": {"async_capable (django_structlog.middlewares.requestmiddleware attribute)": [[1, "django_structlog.middlewares.RequestMiddleware.async_capable", false]], "bind_extra_request_failed_metadata (in module django_structlog.signals)": [[1, "django_structlog.signals.bind_extra_request_failed_metadata", false]], "bind_extra_request_finished_metadata (in module django_structlog.signals)": [[1, "django_structlog.signals.bind_extra_request_finished_metadata", false]], "bind_extra_request_metadata (in module django_structlog.signals)": [[1, "django_structlog.signals.bind_extra_request_metadata", false]], "bind_extra_task_metadata (in module django_structlog.celery.signals)": [[1, "django_structlog.celery.signals.bind_extra_task_metadata", false]], "bind_user_id() (django_structlog.middlewares.requestmiddleware static method)": [[1, "django_structlog.middlewares.RequestMiddleware.bind_user_id", false]], "django_structlog": [[1, "module-django_structlog", false]], "django_structlog.celery": [[1, "module-django_structlog.celery", false]], "django_structlog.celery.signals": [[1, "module-django_structlog.celery.signals", false]], "django_structlog.celery.steps": [[1, "module-django_structlog.celery.steps", false]], "django_structlog.middlewares": [[1, "module-django_structlog.middlewares", false]], "django_structlog.signals": [[1, "module-django_structlog.signals", false]], "djangostructloginitstep (class in django_structlog.celery.steps)": [[1, "django_structlog.celery.steps.DjangoStructLogInitStep", false]], "format_request() (django_structlog.middlewares.requestmiddleware static method)": [[1, "django_structlog.middlewares.RequestMiddleware.format_request", false]], "handle_response() (django_structlog.middlewares.requestmiddleware method)": [[1, "django_structlog.middlewares.RequestMiddleware.handle_response", false]], "modify_context_before_task_publish (in module django_structlog.celery.signals)": [[1, "django_structlog.celery.signals.modify_context_before_task_publish", false]], "module": [[1, "module-django_structlog", false], [1, "module-django_structlog.celery", false], [1, "module-django_structlog.celery.signals", false], [1, "module-django_structlog.celery.steps", false], [1, "module-django_structlog.middlewares", false], [1, "module-django_structlog.signals", false]], "name (django_structlog.celery.steps.djangostructloginitstep attribute)": [[1, "django_structlog.celery.steps.DjangoStructLogInitStep.name", false]], "pre_task_succeeded (in module django_structlog.celery.signals)": [[1, "django_structlog.celery.signals.pre_task_succeeded", false]], "prepare() (django_structlog.middlewares.requestmiddleware method)": [[1, "django_structlog.middlewares.RequestMiddleware.prepare", false]], "process_got_request_exception() (django_structlog.middlewares.requestmiddleware method)": [[1, "django_structlog.middlewares.RequestMiddleware.process_got_request_exception", false]], "requestmiddleware (class in django_structlog.middlewares)": [[1, "django_structlog.middlewares.RequestMiddleware", false]], "sync_capable (django_structlog.middlewares.requestmiddleware attribute)": [[1, "django_structlog.middlewares.RequestMiddleware.sync_capable", false]], "update_failure_response (in module django_structlog.signals)": [[1, "django_structlog.signals.update_failure_response", false]]}, "objects": {"": [[1, 0, 0, "-", "django_structlog"]], "django_structlog": [[1, 0, 0, "-", "celery"], [1, 0, 0, "-", "middlewares"], [1, 0, 0, "-", "signals"]], "django_structlog.celery": [[1, 0, 0, "-", "signals"], [1, 0, 0, "-", "steps"]], "django_structlog.celery.signals": [[1, 1, 1, "", "bind_extra_task_metadata"], [1, 1, 1, "", "modify_context_before_task_publish"], [1, 1, 1, "", "pre_task_succeeded"]], "django_structlog.celery.steps": [[1, 2, 1, "", "DjangoStructLogInitStep"]], "django_structlog.celery.steps.DjangoStructLogInitStep": [[1, 3, 1, "", "name"]], "django_structlog.middlewares": [[1, 2, 1, "", "RequestMiddleware"]], "django_structlog.middlewares.RequestMiddleware": [[1, 3, 1, "", "async_capable"], [1, 4, 1, "", "bind_user_id"], [1, 4, 1, "", "format_request"], [1, 4, 1, "", "handle_response"], [1, 4, 1, "", "prepare"], [1, 4, 1, "", "process_got_request_exception"], [1, 3, 1, "", "sync_capable"]], "django_structlog.signals": [[1, 1, 1, "", "bind_extra_request_failed_metadata"], [1, 1, 1, "", "bind_extra_request_finished_metadata"], [1, 1, 1, "", "bind_extra_request_metadata"], [1, 1, 1, "", "update_failure_response"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "data", "Python data"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "method", "Python method"]}, "objtypes": {"0": "py:module", "1": "py:data", "2": "py:class", "3": "py:attribute", "4": "py:method"}, "terms": {"": [1, 4, 5, 7, 11, 13, 15, 16], "0": [5, 7, 8, 10, 13, 15], "04": [10, 13], "072b": [10, 13], "084368z": 5, "085325z": 5, "085877z": 5, "086155z": 10, "089925z": [10, 13], "09": 5, "1": [3, 7, 8, 10, 11, 12, 13], "10": [4, 5], "10_14_4": 10, "11": 13, "110": 4, "12": 4, "127": [7, 8], "13": 13, "13t19": [10, 13], "13t21": 5, "14": 13, "142": 4, "147590z": 10, "15": 13, "153081z": 10, "15t00": 5, "16": 13, "160043z": 10, "162372z": 10, "17": 13, "18": 13, "180": 4, "183": 4, "19": 13, "2": [5, 11, 13], "20": 13, "200": 10, "201": 10, "2019": [10, 13], "2020": [13, 14], "2021": 13, "2022": 13, "2023": [5, 13], "2024": 13, "209": 4, "21": [13, 16], "22": 13, "226": 4, "23": 13, "231": [4, 12], "24": 13, "24232aa4cedd": 5, "25": 13, "26": 13, "260": 4, "265": 4, "27": 13, "28": 13, "29": [10, 13], "2xx": 9, "3": [11, 13], "30": 13, "308": 4, "31": [10, 13], "317": 4, "32": 4, "321453z": 10, "323": 4, "324": 12, "33": 4, "338": 4, "341": 4, "345": 4, "345207z": 10, "350": 4, "351": 4, "353": 4, "36": 10, "3683": 10, "37": [4, 13], "388": 4, "39": [4, 10, 13], "3a8f801c": [10, 13], "3cdf": 10, "3fc5": 10, "3fd4633aa654": 10, "3xx": 9, "4": 13, "403": 4, "412": 12, "413": 4, "4257": 10, "44": 4, "45": 4, "466616z": 5, "467250z": 5, "468176z": 5, "468871z": 5, "468e": 5, "469418z": 5, "469964z": 5, "470585z": 5, "4805": [10, 13], "484": 4, "4d30": 5, "4de5": 10, "4e22": 5, "4e83ffdca9c0": 5, "4xx": [4, 6, 9], "5": [10, 13], "50": 5, "500": 4, "51": 4, "52": 4, "537": 10, "54": 4, "545": 4, "546": 4, "55": 4, "56": 4, "57524ccb": 5, "59f5": 5, "5aa3": 5, "5xx": [4, 9], "6": 13, "617": 4, "62": 4, "6379": 15, "63bdb4d": 4, "65": 4, "658": 4, "674": 4, "68": 4, "696": 4, "697": 4, "6b11fd80": 10, "7": 13, "70": 4, "705": 4, "72": 4, "73": 10, "78": 4, "8": 13, "80": 4, "8000": [7, 8], "8001": 8, "8002": 8, "8080": 8, "83": 4, "86": 10, "8f38": [10, 13], "9": 13, "9258": 5, "9a567c937561": 10, "A": [3, 9, 14, 16], "AND": 14, "AS": 14, "BE": 14, "BUT": 14, "Be": 12, "But": 13, "By": [3, 11], "FOR": 14, "For": 15, "IN": 14, "If": [3, 4, 9, 11], "In": [3, 4, 6, 11], "It": [1, 5, 11, 12, 16], "NO": 14, "NOT": 14, "No": 4, "OF": 14, "OR": 14, "THE": 14, "TO": 14, "The": [4, 14, 15, 16], "Then": 13, "There": 4, "These": [9, 11, 12], "To": [4, 9], "Tos": [4, 13], "WITH": 14, "__init__": 12, "__name__": [5, 11, 13], "_process_except": 16, "a78a": 10, "a8eb": 5, "a989": 5, "aaron": 4, "abl": [3, 4], "about": 16, "abov": [4, 14], "acc2": 10, "accept": 16, "access": 12, "achiev": 12, "acknowledg": 13, "action": [4, 14], "ad": [4, 16], "adapt": 11, "add": [1, 3, 4, 5, 11, 12], "add_argu": 5, "add_log_level": [3, 11, 16], "add_logger_nam": [3, 11, 16], "add_request_id_to_error_respons": [1, 12], "address": 16, "adinhodov": 4, "adinsoon": 4, "adrenaline681": 4, "affect": [4, 16], "agent": 9, "alik": 16, "all": [3, 4, 9, 14], "allow": 4, "along": [4, 9], "also": [0, 2, 4, 5, 9, 11, 16], "altern": 5, "alwai": 4, "amqp": 8, "amzn": 13, "an": [4, 9, 12, 13, 14], "an_error_occur": 13, "andrewguenth": 4, "ani": [1, 9, 14, 16], "anoth": [9, 11], "anymor": [4, 16], "api": [4, 13], "app": [1, 9, 11, 13], "app_set": 4, "appconfig": 3, "appear": 9, "applewebkit": 10, "applic": [11, 12, 16], "apply_async": 3, "appropri": [4, 11, 16], "april": 13, "ar": [4, 9, 11, 12, 16], "arg": 5, "argument": [4, 16], "aris": 14, "asgi": [4, 8, 9], "asgiref": [4, 16], "associ": [9, 14], "async": [4, 9, 16], "async_cap": 1, "asyncrequestmiddlewar": [4, 16], "attributeerror": 4, "august": 13, "auth": 9, "authent": [12, 13], "authenticationmiddlewar": [4, 9], "author": [0, 13, 14], "autom": 4, "automat": [1, 4], "avail": 4, "avoid": 4, "aw": 13, "await": 1, "awar": 12, "awesom": [0, 11], "b11c": 5, "back": 4, "bad": 0, "badziyoussef": 4, "balanc": 12, "bar": [5, 13], "base": [1, 12], "basecommand": 5, "baz": 5, "be723d34": 5, "becaus": 0, "been": 16, "befor": [1, 3], "behaviour": 4, "being": [1, 4, 9, 13, 16], "believ": 0, "below": [4, 16], "better": 4, "between": 4, "big": 0, "bind": [1, 3, 4, 6, 9, 11, 13], "bind_contextvar": [1, 3, 11, 12], "bind_domain": [1, 11, 16], "bind_extra_request_failed_metadata": [1, 4, 9, 16], "bind_extra_request_finished_metadata": [1, 4, 9, 12, 16], "bind_extra_request_metadata": [1, 4, 9, 11, 12, 16], "bind_extra_task_metadata": [1, 4], "bind_token_user_id": 12, "bind_trace_id": 12, "bind_user_id": 1, "black": 4, "boolean": 6, "boot": 1, "both": [3, 4], "bound": [1, 3, 11], "branch": 4, "break": [4, 16], "browser": 7, "bug": 12, "bugfix": 4, "build": [7, 13], "buz": 13, "c": 14, "c53dff1d": 10, "cache_logger_on_first_us": [3, 11, 16], "call": [3, 4], "callabl": 1, "caller": [9, 12], "can": [3, 4, 6, 11, 12, 13, 16], "cancel": [4, 9], "cannot": 12, "case": [3, 4, 12], "cat": 13, "caus": 4, "cd": 8, "celeri": [4, 6, 10], "celery_broker_url": 15, "celerymiddlewar": [4, 16], "chang": [6, 13], "charg": 14, "child": 3, "child_task_id": [4, 9, 10], "child_task_nam": [4, 9], "children": 9, "chiragjn": 4, "choos": 4, "chrome": 10, "ci": [4, 11], "claim": 14, "class": [1, 3, 4, 5, 11, 12], "clear": [1, 3], "clone": 8, "code": [1, 4, 6, 9, 10, 12], "codecov": 4, "cohes": 13, "color": 3, "colour": 4, "com": [8, 11], "come": 4, "command": [4, 6, 13], "command_finish": 5, "command_id": 5, "command_nam": 5, "command_start": 5, "comment": 16, "commit": 8, "compat": [3, 4, 16], "complet": 9, "compos": [7, 8, 15], "condit": [11, 14], "config": [3, 15], "configur": [4, 11, 13, 16], "connect": [3, 14], "consol": [3, 11, 12], "consolerender": [3, 11], "contain": [1, 3, 16], "context": [1, 3, 12], "context_class": 16, "contextvar": [1, 3, 4, 11, 12], "contract": 14, "contrib": [1, 9, 11, 16], "contributor": 2, "conveni": 11, "convinc": 4, "copi": 14, "copyright": 14, "core": [4, 5], "correl": [4, 9], "correlation_id": [1, 3, 4, 9], "could": 9, "cover": 3, "coverag": 4, "crash": 4, "criteria": 12, "current": 9, "current_sit": [1, 11, 16], "custom": [4, 6, 11, 12, 16], "d": 15, "damag": 14, "damianmel": 4, "danpalm": 4, "data": 3, "deal": 14, "debfx": 4, "debug": [4, 12, 16], "decemb": 13, "def": [1, 3, 5, 11, 12, 16], "default": [4, 6, 11, 12, 13], "definit": 4, "delai": 3, "demo": [4, 13, 15], "depenc": 4, "depend": [4, 11, 16], "dependabot": 4, "deprec": 4, "descript": [6, 9], "design": 11, "detail": [4, 13], "dev": [3, 11], "develop": [4, 13, 16], "dhararon": 4, "dict": [1, 12, 16], "dictconfig": 3, "dictionari": [1, 12, 16], "did": [9, 16], "differ": [4, 11], "directli": 5, "disabl": 6, "disable_existing_logg": [3, 11, 12, 16], "discov": 9, "dispatch": [1, 11, 12, 16], "distribut": [4, 14], "django": [0, 1, 3, 4, 5, 6, 8, 11, 12, 16], "django_extens": 5, "django_settings_modul": 15, "django_structlog": [3, 4, 5, 9, 10, 11, 12, 13], "django_structlog_celery_en": [3, 4, 6], "django_structlog_command_logging_en": [5, 6], "django_structlog_demo_app": 4, "django_structlog_demo_project": [1, 3, 5, 10, 11, 15], "django_structlog_log_user_in_request_finish": 4, "django_structlog_status_4xx_log_level": 6, "django_structlog_user_id_field": [4, 6], "djangoproject": 11, "djangostructloginitstep": 1, "do": 14, "doc": [4, 8, 11], "docker": [7, 8, 15], "document": [4, 9, 12, 13, 14], "doe": 4, "domain": [1, 11, 16], "done": 9, "down": 3, "drf": [9, 13], "drop": [4, 16], "due": 4, "dure": 9, "e1337f363ed4": [10, 13], "each": [9, 13], "easi": 4, "easier": 13, "easiest": 15, "employ": 0, "en": 11, "enabl": 5, "end": 4, "enough": 0, "enqueu": [4, 9, 10], "ensur": 3, "env": 15, "environ": [4, 11], "error": [4, 9, 13], "error_traceback": 4, "etc": 11, "event": [1, 3, 4, 10, 11, 12, 13, 14], "ex": 3, "exampl": [3, 6, 11, 12, 13], "example_command": 5, "example_nested_command": 5, "except": [1, 4, 9, 12], "exceptionprettyprint": 16, "exclud": 12, "exclude_request_start": 12, "excluded_event_typ": 12, "excludeeventsfilt": 12, "execut": [3, 4, 9], "exist": [1, 3, 9, 11], "expect": [4, 9, 16], "experiment": 16, "expir": 9, "explicitli": 16, "express": 14, "extend": [9, 13], "extens": 5, "extra": [1, 3, 4, 16], "extract": 4, "extran": 4, "f": 8, "f2a8c9a8": 5, "f387449a34": 5, "fadeddexofan": 4, "fail": [1, 9], "failur": [1, 4], "fals": [3, 4, 6, 11, 12, 16], "favor": 16, "featur": 16, "februari": 13, "feedback": 4, "feel": 4, "ferd": 0, "few": 4, "fge": 4, "field": [4, 6], "figur": 0, "file": [3, 4, 7, 11, 13, 14], "filenam": [3, 11], "filter": 13, "filter_by_level": [3, 11, 16], "finish": [1, 9], "first": [3, 16], "fist": 4, "fit": 14, "fix": 4, "flat": 13, "flat_lin": [3, 11], "flat_line_fil": [3, 11], "fmt": [3, 11, 16], "follow": [4, 11, 14], "foo": 5, "foreign_pre_chain": [11, 16], "format": [3, 4], "format_exc_info": [3, 9, 11, 16], "format_request": 1, "formatt": [3, 4, 11, 16], "found": 9, "framework": 4, "free": [4, 14], "freez": 4, "from": [1, 3, 4, 5, 9, 11, 13, 14, 16], "front": 4, "function": 4, "furnish": 14, "futur": 4, "gagnon": [2, 14], "gecko": 10, "gener": [0, 4], "get": [4, 10, 12, 13], "get_current_sit": [1, 11, 16], "get_logg": [11, 13], "get_merged_contextvar": [1, 12], "get_request_head": 12, "get_respons": 1, "getlogg": 5, "gh": 4, "ghickman": 4, "git": [4, 8], "github": [4, 8], "got_request_except": 4, "grant": 14, "great": 12, "grep": 13, "guid": [4, 13], "gvangool": 4, "ha": [4, 9, 16], "handi": 4, "handl": 5, "handle_respons": 1, "handler": [3, 11, 12], "have": 16, "header": [4, 9, 13], "help": 0, "herebi": 14, "hi": [0, 4], "hmaker": 4, "holder": 14, "home": 10, "hour": 0, "how": [0, 4, 11, 13], "html": 11, "http": [4, 7, 8, 9, 11], "http_author": 12, "http_x_amzn_trace_id": 12, "httprequest": 1, "httprespons": 1, "huge": 0, "humito": 4, "i": [1, 3, 4, 10, 11, 12, 13, 14, 15, 16], "id": [1, 4, 9, 13], "identifi": 6, "immortaleeb": 4, "implement": [4, 11, 16], "impli": 14, "import": [1, 3, 5, 6, 11, 12, 13, 16], "improv": 4, "incid": 13, "includ": [4, 12, 14], "incorrect": 16, "index": 13, "info": [3, 4, 5, 6, 9, 10, 11, 13], "inform": [1, 3, 4, 16], "inherit": 16, "initi": [1, 2], "inject_context_dict": [4, 16], "inspir": 0, "instal": [3, 4, 5, 13, 15], "installed_app": [11, 16], "instead": [4, 11, 13, 16], "int": 6, "integ": 4, "integr": [0, 1, 6, 11, 16], "intel": 10, "intend": 4, "intercept": 16, "intern": 4, "introduc": 4, "ip": [9, 10, 13, 16], "ipwar": [4, 16], "isinst": 12, "iso": [3, 11, 16], "isort": 4, "issu": [0, 4, 12], "its": 4, "itself": 4, "j00bar": 4, "jairhenriqu": 4, "jq": 13, "jrobichaud": [2, 8], "json": [3, 11], "json_fil": [3, 11], "json_formatt": [3, 11, 16], "jsonrender": [3, 11, 16], "jule": [2, 14], "june": 13, "just": [4, 9], "kashewnut": 4, "keep": [3, 5], "kei": [1, 3, 4, 6, 9], "key_ord": [3, 11], "key_to_keep": [1, 3], "key_valu": [3, 11], "keys_to_keep": [1, 3], "keyvaluerender": [3, 11], "keyword": 16, "khtml": 10, "kind": 14, "know": 3, "kwarg": [1, 3, 11, 12, 16], "led": 16, "legaci": 4, "let": 0, "level": [3, 6, 10, 11, 12, 13], "liabil": 14, "liabl": 14, "librari": [0, 11, 16], "licenc": 13, "licens": [4, 14], "like": [4, 10, 13], "limit": 14, "line": 13, "list": 2, "load": 12, "local": [4, 11, 13], "log": [1, 3, 5, 6, 7, 9, 16], "log_kwarg": [1, 4, 16], "logfil": 3, "logger": [1, 4, 5, 9, 10, 12, 13], "logger_factori": [3, 11, 16], "loggerfactori": [3, 11, 16], "loglevel": 3, "longer": 4, "look": 7, "lt": 4, "mac": 10, "macintosh": 10, "mai": [1, 11, 13, 16], "main": 4, "maintain": [0, 4], "make": [3, 4, 11, 13], "manag": [4, 5], "march": 13, "master": 4, "matrix": 4, "maxdude132": 4, "me": 0, "merchant": 14, "merg": [4, 14], "merge_contextvar": [3, 11, 16], "messag": [1, 3, 4, 12], "meta": 12, "metadata": [1, 3, 4, 13, 16], "method": [4, 16], "meunomemauricio": 4, "middlewar": [1, 3, 4, 9, 10, 11, 12], "might": [11, 16], "migrat": 4, "minimum": 4, "miss": 4, "mit": 14, "mlegner": 4, "model": 4, "modifi": [1, 3, 4, 14], "modify_context_before_task_publish": [1, 4], "modul": [3, 13], "moment": 15, "more": [1, 3, 4, 9, 11, 16], "most": 16, "mozilla": 10, "msg": 12, "must": 1, "my": [0, 5], "my_awesome_modul": 13, "my_awesome_project": 13, "my_receiv": 16, "my_receiver_fail": 16, "my_receiver_finish": 16, "mypi": 16, "name": [1, 9, 11], "navig": 7, "necessari": [4, 16], "need": [3, 4, 9, 11, 15], "nest": [4, 5], "new": [4, 16], "new_dict": [1, 3], "nicholasamorim": 4, "non": 12, "none": [1, 3, 4, 6, 9, 10, 12], "noninfring": 14, "note": [4, 9, 11, 15], "notic": 14, "novemb": 13, "now": [4, 16], "ntap": 4, "number": 9, "o": 10, "oauth": 4, "object": [1, 4], "obtain": 14, "occur": [9, 13], "octob": 13, "ok": 13, "omit": 9, "onc": 9, "one": 16, "onli": [3, 4, 9, 11, 13, 16], "open": [0, 4, 7, 12], "opinion": 0, "option": [3, 5, 16], "order": [3, 4, 12, 16], "org": 11, "origin": [12, 16], "other": [4, 13, 14, 16], "otherwis": 14, "out": [0, 4, 14], "output": [7, 13], "over": 1, "overflow": 0, "overrid": [1, 3, 4, 9, 11, 16], "p": 8, "packag": 4, "page": [4, 13], "paramet": [1, 4], "parent": [1, 5, 9], "parent_command_id": 5, "parent_id": 5, "parent_task_id": [1, 3, 4, 9], "parser": 5, "particip": 2, "particular": 14, "pass": [1, 12], "paulstuartpark": 4, "pawelmorawian": 4, "permiss": 14, "permissiondeni": 4, "permit": 14, "person": 14, "pertin": 11, "pip": [5, 8, 11, 15, 16], "pk": [4, 6], "plain_consol": [3, 11], "pleas": [4, 12], "point": 4, "portion": 14, "positionalargumentsformatt": [3, 11, 16], "possibl": 11, "post": 10, "pragma": 3, "pre": 8, "pre_task_succeed": [1, 4], "prepar": 1, "prerequisit": 13, "prevent": 12, "previou": 4, "prik2693": 4, "primari": 4, "prioriti": [4, 9], "problem": 4, "process_except": [4, 16], "process_got_request_except": 1, "processor": [3, 4, 11, 16], "processorformatt": [3, 11, 16], "produc": 13, "product": 11, "project": [0, 1, 2, 4, 11, 13], "propag": 16, "properli": [4, 16], "properti": 1, "provid": [4, 9, 12, 14], "providing_arg": 4, "public": 4, "publish": 14, "purpos": 14, "py": [3, 4, 5, 6, 11, 12], "pypi": 4, "pyproject": 4, "pytest": 15, "python": [4, 5, 9, 11, 16], "question": 0, "r": [8, 15], "rabbit": 4, "raw_token": 12, "readthedoc": 4, "realli": 4, "reason": 9, "receiv": [1, 3, 9, 11, 12, 16], "receiver_bind_extra_request_metadata": 3, "receiver_bind_extra_task_metadata": 1, "receiver_modify_context_before_task_publish": [1, 3], "receiver_pre_task_succeed": 1, "receiver_setup_log": 3, "receiver_task_pre_run": 3, "record": 13, "redi": 15, "redund": 4, "refer": 4, "regard": 11, "regress": 4, "reject": 9, "relat": 4, "releas": 4, "reli": 4, "remov": [4, 16], "renam": [4, 16], "repeat": 9, "replac": [4, 11], "report": 4, "request": [1, 3, 4, 10, 12, 13, 16], "request_cancel": [4, 9], "request_fail": [1, 4, 9, 13, 16], "request_finish": [1, 4, 9, 10, 13, 16], "request_id": [1, 3, 4, 9, 10, 11, 13], "request_middleware_rout": [4, 16], "request_start": [1, 9, 10, 12, 16], "requestmiddlewar": [1, 3, 4, 11, 13], "requir": [4, 8, 9, 13, 15], "respect": [4, 16], "respons": [1, 4, 9, 13, 16], "rest": [4, 11], "rest_framework": 13, "rest_framework_simplejwt": 13, "restframework": 12, "restrict": 14, "result": [1, 4, 10, 13], "retri": 9, "retriev": 16, "return": [1, 5, 12], "review": 4, "revok": [4, 9], "rewrit": 4, "right": 14, "robichaud": [2, 14], "roll": 4, "rollback": 4, "roscoethedog": 4, "rout": [1, 9], "routing_kei": [4, 9], "run": [1, 13], "runner": 1, "runserver_plu": [4, 8], "safari": 10, "same": [3, 11, 16], "search": 13, "section": [4, 11], "see": [2, 3, 4, 6, 9, 11, 12, 13, 16], "select": 13, "self": [5, 12], "sell": 14, "sender": [1, 3, 4], "sentri": 16, "septemb": 13, "serial": 3, "serializ": 3, "serv": 13, "server": [4, 8], "set": [3, 4, 9, 11, 12, 13, 15], "setup": 4, "setup_log": 3, "shall": 14, "share": 12, "shell": 7, "shimizukawa": 4, "shortcut": [1, 11, 16], "should": [3, 4, 12, 16], "show": 11, "shtoltz": 4, "signal": [1, 4, 9, 11, 12, 13, 16], "signalcommand": 5, "signam": [4, 9], "signatur": 16, "signum": [4, 9], "site": [1, 11, 16], "snippet": 12, "so": [14, 16], "softwar": 14, "some": [3, 12, 16], "someon": 4, "sourc": 0, "special": 4, "specif": [9, 12], "specifi": 4, "speed": 4, "spend": 0, "split": 12, "sshishov": 4, "stack": [0, 4], "stackinforender": [3, 11, 16], "stage": 4, "standard": [4, 12], "start": [9, 13, 15], "static": 1, "statu": [4, 6, 9], "stdlib": [3, 11, 16], "step": [1, 3, 11], "still": 4, "stop": 15, "store": 3, "str": [1, 5], "stream": [4, 9], "streamhandl": [3, 11, 12], "streaming_cancel": 9, "streaming_fail": 9, "streaming_finish": 9, "streaming_start": 9, "streaminghttprespons": 4, "strict": 16, "string": [4, 9], "strip": 3, "structlog": [0, 1, 3, 4, 5, 6, 8, 11, 12], "structur": [1, 13], "subject": 14, "sublicens": 14, "substanti": 14, "succeed": 1, "success": [1, 10], "success_task": 10, "successfulli": 9, "super": 12, "support": [3, 4, 5, 13, 16], "sure": [3, 4, 11], "switch": 4, "sync": [4, 16], "sync_cap": 1, "syncrequestmiddlewar": [4, 16], "system": 12, "tag": 4, "take": [4, 9], "task": [1, 3, 4, 10, 13], "task_enqueu": [4, 9, 10], "task_fail": 9, "task_id": [4, 9, 10], "task_nam": 4, "task_not_found": [4, 9], "task_properti": [1, 3], "task_protocol": 3, "task_reject": [4, 9], "task_retri": 9, "task_revok": [4, 9], "task_routing_kei": [1, 3], "task_start": [4, 9], "task_succe": [4, 10], "task_succeed": [4, 9], "taskapp": 10, "termin": 9, "test": [4, 11, 13], "test_app": [4, 15], "test_demo_app": 15, "text": 4, "thank": [0, 4], "thei": [4, 12], "them": 11, "therefor": [4, 12], "thi": [0, 2, 3, 4, 5, 10, 11, 14, 16], "threadloc": [4, 16], "three": 9, "threw": 9, "through": [3, 5], "throw": [4, 9], "ticosax": 4, "time": 0, "timestamp": [3, 10, 11, 13, 16], "tlm": 0, "toast": 4, "token": 13, "tokenauthent": 13, "toml": 4, "toolkit": 4, "topic": 11, "tort": 14, "trace": 13, "trace_id": 12, "traceback": [4, 9], "track": [5, 13], "transfer": 3, "travi": 4, "true": [1, 3, 4, 5, 9, 11, 12], "try": 12, "tweak": 4, "txt": [3, 4, 8, 15], "type": [1, 4, 5, 6, 9], "ui": 4, "un33k": 4, "uncaught": 4, "unhandl": [9, 16], "unicodedecod": [3, 11, 16], "untest": 12, "untypedtoken": 12, "up": [7, 8, 15], "updat": [1, 3, 4], "update_failure_respons": [1, 4, 12], "upgrad": [4, 13], "us": [1, 3, 4, 6, 11, 12, 13, 14], "user": [4, 5, 6, 9, 13], "user_ag": [1, 9, 10], "user_id": [4, 9, 10, 11, 12, 13], "util": 5, "uuid": [4, 9], "v1": 3, "valid": [3, 16], "valu": [4, 9], "vari": 11, "variou": 4, "veri": 0, "version": [3, 4, 11, 12, 16], "view": [1, 4, 10], "wa": [0, 4, 9, 16], "wai": [11, 15], "want": [11, 12, 16], "warn": [4, 6, 9], "warranti": 14, "watchedfilehandl": [3, 11], "webapp": 3, "well": [4, 13], "were": 4, "what": 4, "wheel": 4, "when": [3, 4, 9, 13, 16], "where": 4, "whether": 14, "which": [5, 16], "while": 7, "who": 2, "whom": 14, "without": [4, 14], "work": [0, 2, 4], "workaround": 12, "worker": [1, 9], "wrap_dict": 16, "wrap_for_formatt": [3, 11, 16], "wrapper_class": 4, "wsgi": [4, 8], "wsgirequest": 4, "x": [1, 3, 4, 9, 10, 13], "y": 3, "yet": 4, "yml": 8, "you": [1, 3, 4, 6, 9, 11, 12, 13], "your": [4, 5, 6, 7, 11, 12, 16], "your_celery_project": 3, "your_project": 12, "z": 3}, "titles": ["Acknowledgments", "API documentation", "Authors", "Celery Integration", "Change Log", "Commands", "Configuration", "Demo app", "Development", "Events and Metadata", "Example outputs", "Getting Started", "How Tos", "django-structlog", "Licence", "Running the tests", "Upgrade Guide"], "titleterms": {"": [3, 9, 12], "0": [4, 16], "1": [4, 16], "11": 4, "13": 4, "14": 4, "15": 4, "16": 4, "17": 4, "18": 4, "19": 4, "2": [4, 16], "20": 4, "2019": 4, "2020": 4, "2021": 4, "2022": 4, "2023": 4, "2024": 4, "21": 4, "22": 4, "23": 4, "24": 4, "25": 4, "26": 4, "27": 4, "28": 4, "29": 4, "3": [4, 16], "30": 4, "31": 4, "4": [4, 16], "5": [4, 16], "6": [4, 16], "7": [4, 16], "8": [4, 16], "9": [4, 16], "For": 16, "If": 16, "Tos": 12, "With": 13, "acknowledg": 0, "add": 16, "addit": 13, "all": 16, "amzn": 12, "api": 1, "app": [3, 7, 8, 16], "april": 4, "august": 4, "author": 2, "aw": 12, "being": 12, "bind": [12, 16], "bind_contextvar": 16, "bind_extra_task_metadata": 3, "bound": 9, "broker": 8, "build": 8, "celeri": [1, 3, 9, 13, 16], "chang": [4, 16], "command": 5, "comparison": 13, "configur": [3, 5, 6], "content": 13, "contextvar": 16, "decemb": 4, "demo": [7, 8], "develop": 8, "django": [9, 13], "django_structlog": [1, 16], "django_structlog_celery_en": 16, "djangostructloginitstep": 3, "do": 16, "document": [1, 8], "drf": 16, "enabl": 3, "error": 16, "event": 9, "exampl": 10, "except": 16, "extend": 11, "februari": 4, "file": 10, "filter": 12, "flat": 10, "flat_lin": [10, 13], "framework": 13, "from": 12, "get": [3, 11], "guid": 16, "handl": 16, "header": 12, "hint": 16, "how": [12, 16], "id": 12, "indic": 13, "initi": 3, "instal": [8, 11, 16], "instead": 8, "integr": [3, 13], "intern": 16, "json": [10, 13], "june": 4, "licenc": 14, "line": 10, "local": 8, "log": [4, 10, 11, 12, 13], "logger": [3, 11, 16], "mai": 4, "make": 16, "march": 4, "metadata": [9, 11], "middlewar": 16, "minimum": 16, "modify_context_before_task_publish": 3, "need": 16, "ninja": 13, "novemb": 4, "octob": 4, "output": 10, "popular": 13, "prerequisit": [5, 8], "rabbitmq": 8, "record": 12, "redi": 8, "replac": [3, 16], "request": [9, 11], "request_id": 12, "requestmiddlewar": [9, 16], "requir": [3, 16], "respons": 12, "rest": 13, "rest_framework_simplejwt": 12, "result": 5, "run": 15, "septemb": 4, "serv": 8, "set": [6, 16], "signal": 3, "standard": [11, 13, 16], "start": [3, 8, 11], "streaminghttprespons": 9, "structlog": [13, 16], "sure": 16, "tabl": 13, "task": 9, "test": [8, 15], "token": 12, "trace": 12, "true": 16, "type": 16, "updat": 16, "upgrad": 16, "us": [8, 16], "user": [12, 16], "web": 3, "worker": 3, "x": 12, "you": 16, "your": 3}}) \ No newline at end of file diff --git a/upgrade_guide.html b/upgrade_guide.html new file mode 100644 index 00000000..e8b4acf3 --- /dev/null +++ b/upgrade_guide.html @@ -0,0 +1,391 @@ + + + + + + + + + Upgrade Guide — django-structlog 9.0.0 documentation + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Upgrade Guide

+
+

Upgrading to 9.0+

+
+

Minimum requirements

+
    +

  • requires python 3.9+

    • +

  • django 4.2 and 5.0+ are supported

    • +
+
+
+

Type hints

+

django-structlog now uses python type hints and is being validated with mypy --strict.

+
+
+

For drf-standardized-errors users

+

Now unhandled exceptions when using drf-standardized-errors will be intercepted and the exception logged properly.

+

If you also use structlog-sentry, the exception will now be propagated as expected.

+

Other libraries alike may be affected by this change.

+
+
+

Internal changes in how RequestMiddleware handles exceptions

+

This only affects you if you implemented a middleware inheriting from RequestMiddleware and you overrided the process_exception method.

+

Did you?

+

If so:

+
+
    +

  • RequestMiddleware.process_exception was renamed to RequestMiddleware._process_exception, you should to the same in the middleware.

    • +
+
+
+
+
+

Upgrading to 8.0+

+
+
A new keyword argument log_kwargs was added to the the optional signals:
    +

  • django_structlog.signals.bind_extra_request_metadata;

    • +

  • django_structlog.signals.bind_extra_request_finished_metadata;

    • +

  • django_structlog.signals.bind_extra_request_failed_metadata.

    • +
+
+
+

It should not affect you if you have a **kwargs in the signature of your receivers.

+

log_kwargs is a dictionary containing the log metadata that will be added to their respective logs ("request_started", "request_finished", "request_failed").

+

If you use any of these signals, you may need to update your receiver to accept this new argument:

+
from django.contrib.sites.shortcuts import get_current_site
+from django.dispatch import receiver
+from django_structlog import signals
+import structlog
+
+@receiver(signals.bind_extra_request_metadata)
+def my_receiver(request, logger, log_kwargs, **kwargs): # <- add `log_kwargs` if necessary
+    ...
+
+@receiver(signals.bind_extra_request_finished_metadata)
+def my_receiver_finished(request, logger, response, log_kwargs, **kwargs): # <- add `log_kwargs` if necessary
+    ...
+
+@receiver(signals.bind_extra_request_failed_metadata)
+def my_receiver_failed(request, logger, exception, log_kwargs, **kwargs): # <- add `log_kwargs` if necessary
+    ...
+
+
+
+
+

Upgrading to 7.0+

+

The dependency django-ipware was upgraded to version 6. This library is used to retrieve the request’s ip address.

+

Version 6 may have some breaking changes if you did customizations.

+

It should not affect most of the users but if you did some customizations, you might need to update your configurations.

+
+
+

Upgrading to 6.0+

+
+

Minimum requirements

+
    +

  • requires python 3.8+

    • +
+
+
+

Changes to do

+
+

Add django_structlog to installed app

+
INSTALLED_APP = [
+    # ...
+    "django_structlog",
+    # ...
+]
+
+
+
+
+

Make sure you use django_structlog.middlewares.RequestMiddleware

+

If you used any of the experimental async or sync middlewares, you do not need to anymore. +Make sure you use django_structlog.middlewares.RequestMiddleware instead of any of the other request middlewares commented below:

+
MIDDLEWARE += [
+    # "django_structlog.middlewares.request_middleware_router", # <- remove
+    # "django_structlog.middlewares.requests.SyncRequestMiddleware", # <- remove
+    # "django_structlog.middlewares.requests.AsyncRequestMiddleware", # <- remove
+    "django_structlog.middlewares.RequestMiddleware", # <- make sure you use this one
+]
+
+
+
+
+

(If you use celery) Make sure you use DJANGO_STRUCTLOG_CELERY_ENABLED = True

+

It is only applicable if you use celery integration.

+

django_structlog.middlewares.CeleryMiddleware has been remove in favor of a django settings.

+
MIDDLEWARE += [
+    "django_structlog.middlewares.RequestMiddleware",
+    # "django_structlog.middlewares.CeleryMiddleware",  # <- remove this
+]
+
+DJANGO_STRUCTLOG_CELERY_ENABLED = True # <-- add this
+
+
+
+
+
+
+

Upgrading to 5.0+

+
+

Minimum requirements

+
    +

  • requires asgiref 3.6+

    • +
+
+
+
+

Upgrading to 4.0+

+

django-structlog drops support of django below 3.2.

+
+

Minimum requirements

+
    +

  • requires django 3.2+

    • +

  • requires python 3.7+

    • +

  • requires structlog 21.4.0+

    • +

  • (optionally) requires celery 5.1+

    • +
+
+
+

Changes if you use celery

+

You can now install django-structlog explicitly with celery extra in order to validate the compatibility with your version of celery.

+
django-structlog[celery]==4.0.0
+
+
+

See Installing “Extras” for more information about this pip feature.

+
+
+
+

Upgrading to 3.0+

+

django-structlog now use structlog.contextvars.bind_contextvars instead of threadlocal.

+
+

Minimum requirements

+
    +

  • requires python 3.7+

    • +

  • requires structlog 21.4.0+

    • +
+
+
+

Changes you need to do

+
+

1. Update structlog settings

+
    +

  • add structlog.contextvars.merge_contextvars as first processors

    • +

  • remove context_class=structlog.threadlocal.wrap_dict(dict),

    • +

  • (if you use standard loggers) add structlog.contextvars.merge_contextvars in foreign_pre_chain

    • +

  • (if you use standard loggers) remove django_structlog.processors.inject_context_dict,

    • +
+
structlog.configure(
+    processors=[
+        structlog.contextvars.merge_contextvars, # <---- add this
+        structlog.stdlib.filter_by_level,
+        structlog.processors.TimeStamper(fmt="iso"),
+        structlog.stdlib.add_logger_name,
+        structlog.stdlib.add_log_level,
+        structlog.stdlib.PositionalArgumentsFormatter(),
+        structlog.processors.StackInfoRenderer(),
+        structlog.processors.format_exc_info,
+        structlog.processors.UnicodeDecoder(),
+        structlog.stdlib.ProcessorFormatter.wrap_for_formatter,
+    ],
+    # context_class=structlog.threadlocal.wrap_dict(dict), # <---- remove this
+    logger_factory=structlog.stdlib.LoggerFactory(),
+    cache_logger_on_first_use=True,
+)
+
+# If you use standard logging
+LOGGING = {
+    "version": 1,
+    "disable_existing_loggers": False,
+    "formatters": {
+        "json_formatter": {
+            "()": structlog.stdlib.ProcessorFormatter,
+            "processor": structlog.processors.JSONRenderer(),
+            "foreign_pre_chain": [
+                structlog.contextvars.merge_contextvars, # <---- add this
+                # django_structlog.processors.inject_context_dict, # <---- remove this
+                structlog.processors.TimeStamper(fmt="iso"),
+                structlog.stdlib.add_logger_name,
+                structlog.stdlib.add_log_level,
+                structlog.stdlib.PositionalArgumentsFormatter(),
+            ],
+        },
+    },
+    ...
+ }
+
+
+
+
+

2. Replace all logger.bind with structlog.contextvars.bind_contextvars

+
@receiver(bind_extra_request_metadata)
+def bind_domain(request, logger, **kwargs):
+    current_site = get_current_site(request)
+    # logger.bind(domain=current_site.domain)
+    structlog.contextvars.bind_contextvars(domain=current_site.domain)
+
+
+
+
+
+
+

Upgrading to 2.0+

+

django-structlog was originally developed using the debug configuration ExceptionPrettyPrinter which led to incorrect handling of exception.

+
    +

  • remove structlog.processors.ExceptionPrettyPrinter(), of your processors.

    • +

  • make sure you have structlog.processors.format_exc_info, in your processors if you want appropriate exception logging.

    • +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file