service_internal_python.h File Reference

#include <Python.h>
#include "service_internal.h"
#include "response_print.h"

Go to the source code of this file.

Functions
PyDictObject *	PyDict_FromMaps (maps *t)
	Convert a maps to a Python dictionary. More...
PyDictObject *	PyDict_FromMap (map *t)
	Convert a map to a Python dictionary. More...
maps *	mapsFromPyDict (PyDictObject *t)
	Convert a Python dictionary to a maps. More...
map *	mapFromPyDict (PyDictObject *t)
	Convert a Python dictionary to a map. More...
int	zoo_python_support (maps **, map *, service *, maps **, maps **)
	Load a Python module then run the function corresponding to the service by passing the conf, inputs and outputs parameters by reference. More...
void	PythonZooReport (maps **, const char *, int)
	Report Python error which may occur on loading the Python module or at runtime. More...
PyObject *	PythonTranslate (PyObject *, PyObject *)
	Use the ZOO-Services messages translation function from the Python environment. More...
PyObject *	PythonUpdateStatus (PyObject *, PyObject *)
	Update the ongoing status of a running service from the Python environment. More...
PyObject *	PythonTraceMessage (PyObject *, PyObject *)
	ZOO-API equivalent to logger.debug() in Python. More...
PyObject *	PythonDebugMessage (PyObject *, PyObject *)
	ZOO-API equivalent to logger.debug() in Python. More...
PyObject *	PythonInfoMessage (PyObject *, PyObject *)
	ZOO-API equivalent to logger.debug() in Python. More...
PyObject *	PythonSuccessMessage (PyObject *, PyObject *)
	ZOO-API equivalent to logger.debug() in Python. More...
PyObject *	PythonWarningMessage (PyObject *, PyObject *)
	ZOO-API equivalent to logger.debug() in Python. More...
PyObject *	PythonErrorMessage (PyObject *, PyObject *)
	ZOO-API equivalent to logger.debug() in Python. More...
PyObject *	PythonCriticalMessage (PyObject *, PyObject *)
	ZOO-API equivalent to logger.debug() in Python. More...

Function Documentation

mapFromPyDict()

map* mapFromPyDict

(

PyDictObject *

t

)

Convert a Python dictionary to a map.

Parameters

t	the PyDictObject to convert

Returns

a new map containing the converted PyDictObject

Warning

make sure to free resources returned by this function

mapsFromPyDict()

maps* mapsFromPyDict

(

PyDictObject *

t

)

Convert a Python dictionary to a maps.

Parameters

t	the PyDictObject to convert

Returns

a new maps containing the converted PyDictObject

Warning

make sure to free resources returned by this function

PyDict_FromMap()

PyDictObject* PyDict_FromMap

(

map *

t

)

Convert a map to a Python dictionary.

Parameters

t	the map to convert

Returns

a new PyDictObject containing the converted maps

Warning

make sure to free resources returned by this function

PyDict_FromMaps()

PyDictObject* PyDict_FromMaps

(

maps *

t

)

Convert a maps to a Python dictionary.

Parameters

t	the maps to convert

Returns

a new PyDictObject containing the converted maps

See also

PyDict_FromMap

Warning

make sure to free resources returned by this function

PythonCriticalMessage()

PyObject* PythonCriticalMessage	(	PyObject *	self,
		PyObject *	args
	)

ZOO-API equivalent to logger.debug() in Python.

Parameters

self	the Python object on which we can run the method
args	the Python arguments given from the Python environment

Returns

a new Python string containing the translated value

See also

_ss

PythonDebugMessage()

PyObject* PythonDebugMessage	(	PyObject *	self,
		PyObject *	args
	)

ZOO-API equivalent to logger.debug() in Python.

Parameters

self	the Python object on which we can run the method
args	the Python arguments given from the Python environment

Returns

a new Python string containing the translated value

See also

_ss

PythonErrorMessage()

PyObject* PythonErrorMessage	(	PyObject *	self,
		PyObject *	args
	)

ZOO-API equivalent to logger.debug() in Python.

Parameters

self	the Python object on which we can run the method
args	the Python arguments given from the Python environment

Returns

a new Python string containing the translated value

See also

_ss

PythonInfoMessage()

PyObject* PythonInfoMessage	(	PyObject *	self,
		PyObject *	args
	)

ZOO-API equivalent to logger.debug() in Python.

Parameters

self	the Python object on which we can run the method
args	the Python arguments given from the Python environment

Returns

a new Python string containing the translated value

See also

_ss

PythonSuccessMessage()

PyObject* PythonSuccessMessage	(	PyObject *	self,
		PyObject *	args
	)

ZOO-API equivalent to logger.debug() in Python.

Parameters

self	the Python object on which we can run the method
args	the Python arguments given from the Python environment

Returns

a new Python string containing the translated value

See also

_ss

PythonTraceMessage()

PyObject* PythonTraceMessage	(	PyObject *	self,
		PyObject *	args
	)

ZOO-API equivalent to logger.debug() in Python.

Parameters

self	the Python object on which we can run the method
args	the Python arguments given from the Python environment

Returns

a new Python string containing the translated value

See also

_ss

PythonTranslate()

PyObject* PythonTranslate	(	PyObject *	self,
		PyObject *	args
	)

Use the ZOO-Services messages translation function from the Python environment.

Parameters

self	the Python object on which we can run the method
args	the Python arguments given from the Python environment

Returns

a new Python string containing the translated value

See also

_ss

PythonUpdateStatus()

PyObject* PythonUpdateStatus	(	PyObject *	self,
		PyObject *	args
	)

Update the ongoing status of a running service from the Python environment.

Parameters

self	the Python object on which we can run the method
args	the Python arguments given from the Python environment

Returns

None to the Python environment

See also

_updateStatus

PythonWarningMessage()

PyObject* PythonWarningMessage	(	PyObject *	self,
		PyObject *	args
	)

ZOO-API equivalent to logger.debug() in Python.

Parameters

self	the Python object on which we can run the method
args	the Python arguments given from the Python environment

Returns

a new Python string containing the translated value

See also

_ss

PythonZooReport()

void PythonZooReport	(	maps **	main_conf,
		const char *	module,
		int	load
	)

Report Python error which may occur on loading the Python module or at runtime.

Parameters

main_conf	the conf maps containing the main.cfg settings
module	the service name
load	1 if the Python module was not loaded yet

zoo_python_support()

int zoo_python_support	(	maps **	main_conf,
		map *	request,
		service *	s,
		maps **	real_inputs,
		maps **	real_outputs
	)

Load a Python module then run the function corresponding to the service by passing the conf, inputs and outputs parameters by reference.

Parameters

main_conf	the conf maps containing the main.cfg settings
request	the map containing the HTTP request
s	the service structure
real_inputs	the maps containing the inputs
real_outputs	the maps containing the outputs