ctdb-recovery: Refactor banning a node into separate computation
[amitay/samba.git] / python / py3compat.h
1 /*
2    Unix SMB/CIFS implementation.
3    Python 3 compatibility macros
4    Copyright (C) Petr Viktorin <pviktori@redhat.com> 2015
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #ifndef _SAMBA_PY3COMPAT_H_
21 #define _SAMBA_PY3COMPAT_H_
22 #include <Python.h>
23
24 /* Quick docs:
25  *
26  * "PyStr_*" works like PyUnicode_* on Python 3, but uses bytestrings (str)
27  * under Python 2.
28  *
29  * "PyBytes_*" work like in Python 3; on Python 2 they are aliased to their
30  * PyString_* names.
31  *
32  * "PyInt_*" works like PyLong_*
33  *
34  * Syntax for module initialization is as in Python 3, except the entrypoint
35  * function definition and declaration:
36  *     PyMODINIT_FUNC PyInit_modulename(void);
37  *     PyMODINIT_FUNC PyInit_modulename(void)
38  *     {
39  *         ...
40  *     }
41  * is replaced by:
42  *     MODULE_INIT_FUNC(modulename)
43  *     {
44  *         ...
45  *     }
46  *
47  * In the entrypoint, create a module using PyModule_Create and PyModuleDef,
48  * and return it. See Python 3 documentation for details.
49  * For Python 2 compatibility, always set PyModuleDef.m_size to -1.
50  *
51  */
52
53 /***** Python 3 *****/
54
55 /* Strings */
56
57 /* description of bytes objects */
58 #define PY_DESC_PY3_BYTES "bytes"
59
60 /* Determine if object is really bytes, for code that runs
61  * in python2 & python3 (note: PyBytes_Check is replaced by
62  * PyString_Check in python2) so care needs to be taken when
63  * writing code that will check if incoming type is bytes that
64  * will work as expected in python2 & python3
65  */
66
67 #define IsPy3Bytes PyBytes_Check
68
69 #define IsPy3BytesOrString(pystr) \
70     (PyUnicode_Check(pystr) || PyBytes_Check(pystr))
71
72
73 /* Ints */
74
75 #define PyInt_Type PyLong_Type
76 #define PyInt_Check PyLong_Check
77 #define PyInt_FromLong PyLong_FromLong
78 #define PyInt_AsLong PyLong_AsLong
79
80 /* Module init */
81
82 #define MODULE_INIT_FUNC(name) \
83     PyMODINIT_FUNC PyInit_ ## name(void); \
84     PyMODINIT_FUNC PyInit_ ## name(void)
85
86 /* PyArg_ParseTuple/Py_BuildValue argument */
87
88 #define PYARG_BYTES_LEN "y#"
89 #define PYARG_STR_UNI "es"
90
91 #endif