Skip to content

Latest commit

 

History

History
140 lines (98 loc) · 4.67 KB

pyrfc.rst

File metadata and controls

140 lines (98 loc) · 4.67 KB
Raw
.. currentmodule:: pyrfc

:mod:`pyrfc`

The :mod:`pyrfc` package.

.. toctree::
   :maxdepth: 2

Connection

.. autoclass:: Connection

   .. autoattribute:: options
   .. automethod:: call(func_name, options, params)
   .. automethod:: close()
   .. automethod:: confirm_unit(unit)
   .. automethod:: destroy_unit(unit)
   .. automethod:: fill_and_submit_unit(unit, calls[, queue_names=None[, attributes=None]])
   .. automethod:: get_connection_attributes()
   .. automethod:: get_function_description(func_name)
   .. automethod:: get_unit_state(unit)
   .. automethod:: initialize_unit([background=True])
   .. automethod:: ping()
   .. automethod:: reset_server_context()

FunctionDescription

Note

Actually, the FunctionDescription class does not support exceptions.

.. autoclass:: FunctionDescription

   .. automethod:: add_parameter(name, parameter_type, direction, nuc_length, uc_length[, decimals=0[, default_value=""[, parameter_text=""[, optional=False[, type_description=None]]]]])

TypeDescription

.. autoclass:: TypeDescription

   .. automethod:: add_field(name, field_type, nuc_length, uc_length, nuc_offset, uc_offset[, decimals=0[, type_description=None]])

Errors

If a problem occurs in the Python connector or in an underlying component (e.g. C connector, SAP system, ABAP code, ...), an exception is raised. The class of the exception indicates where the problem occurred.

  1. RFCError: This error is raised, if a problem occurred in the Python connector.
  2. RFCLibError: This error is raised, if a problem occurred in the C connector.
  3. All other errors represent errors with the RFC call to the SAP backend system. For these errors, the errorInfo struct of the C connector is wrapped, e.g. for a given exception e, the error code is available in e.code. The class of the error depends on the group of the error.

Inheritance of errors: Exception->RFCError->RFCLibError->specific errors

.. autoexception:: RFCError


.. autoexception:: RFCLibError


.. autoexception:: LogonError


.. autoexception:: CommunicationError


.. autoexception:: ABAPApplicationError


.. autoexception:: ABAPRuntimeError


.. autoexception:: ExternalAuthorizationError


.. autoexception:: ExternalRuntimeError


.. autoexception:: ExternalApplicationError

Error types, codes, groups, and classes

:ref:`Schmidt and Li (2009a)<c09a>` describe four possible error types on the basis of the return code (i.e. error code) of a RFM invocation:

  • ABAP exception,
  • system failure,
  • ABAP messages, and
  • communication failure.

However, there are in total roughly 30 possible return codes that indicate some kind of error. As each error information struct provides an error group information with seven possible groups, which was taken as the basis for the exception classes.

The following table should facilitate the matching between the different error representations.

type (SPJ) code [numeric] (C) group (C) class (Python)
ABAP exception RFC_ABAP_EXCEPTION [5] ABAP_APPLICATION_FAILURE ABAPApplicationError
system failure RFC_ABAP_RUNTIME_FAILURE [3] ABAP_RUNTIME_FAILURE ABAPRuntimeError
ABAP message RFC_ABAP_MESSAGE [4] ABAP_RUNTIME_FAILURE ABAPRuntimeError
communication failure RFC_COMMUNICATION_FAILURE [1] COMMUNICATION_FAILURE CommunicationError
RFC_LOGON_FAILURE [2] LOGON_FAILURE LogonError