sio3pack.exceptions
===================

.. py:module:: sio3pack.exceptions






Package Contents
----------------

.. py:exception:: SIO3PackException(message, full_message = None)

   Bases: :py:obj:`Exception`


   A base class for all custom exceptions raised by SIO3Pack.

   :param str message: A short description of the error.
   :param str full_message: A detailed description of the error, if available.


   .. py:property:: full_message


.. py:exception:: ImproperlyConfigured(message, full_message = None)

   Bases: :py:obj:`sio3pack.exceptions.general.SIO3PackException`


   Exception raised when the package is improperly configured, i.e., using Django features
   without Django being installed.


.. py:exception:: PackageAlreadyExists(problem_id)

   Bases: :py:obj:`sio3pack.exceptions.general.SIO3PackException`


   Exception raised when trying to create a package for a problem that already has a package.

   :param int problem_id: The ID of the problem for which the package already exists.


.. py:exception:: ProcessPackageError(message, full_message = None)

   Bases: :py:obj:`sio3pack.exceptions.general.SIO3PackException`


   Exception raised when there is an error processing a package.


.. py:exception:: UnknownPackageType(arg)

   Bases: :py:obj:`sio3pack.exceptions.general.SIO3PackException`


   Exception raised when trying to load a package of an unknown type.
   This can happen when the package file is not recognized or when the package
   is not a valid package type in the database.

   :param str | int arg: The path to the package file or the problem ID.


.. py:class:: ParsingFailedOn(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Enum to represent the part of the workflow that failed to parse.


.. py:exception:: WorkflowCreationError(message, full_message = None)

   Bases: :py:obj:`sio3pack.exceptions.general.SIO3PackException`


   Raised when there is an error creating a workflow.


.. py:exception:: WorkflowParsingError(message, failed_on, extra_msg = None, data = None, full_message = None)

   Bases: :py:obj:`sio3pack.exceptions.general.SIO3PackException`


   Raised when there is an error parsing a workflow configuration.

   :param str message: A short description of the error.
   :param ParsingFailedOn failed_on: The part of the workflow that failed to parse.
   :param str extra_msg: Additional message to append to the error message.
   :param dict data: Additional data related to the error.
   :param str full_message: A full message describing the error, if available.


   .. py:method:: set_data(key, value)

      Set additional data for the exception.

      :param key: The key for the data.
      :param value: The value for the data.