.. _context:

==============
Script Context
==============

Your script is handed a context object with which you will make your post-processing status and comment recommendations. It is always named
`ctx` and is either a check-level context or a command-level context. Both share most of the same functionality in :mod:`context.Context`.

Check-Level Context
-------------------
.. autoclass:: context.CheckItemContext
   :members:
   :show-inheritance:


Command-Level Context
---------------------
.. autoclass:: context.CommandValueContext
   :members:
   :show-inheritance:


Common Context
--------------
.. autoclass:: context.Context
   :members:
   :show-inheritance:


Additional Helpers and Constants
--------------------------------
.. automodule:: context
   :members:
   :exclude-members: Context, CheckItemContext, CommandValueContext