Python version of the FileObject API. More...

#include "Python.h"
#include "file_object.h"

Classes
struct	PyFileObject
	A pia. More...

Macros
#define	PyFileObject_Type_NUM 0
	index of type

#define	PyFileObject_GetNative_NUM 1
	index of GetNative

#define	PyFileObject_GetNative_RETURN FileObject_t*
	return type for GetNative

#define	PyFileObject_GetNative_PROTO (PyFileObject*)
	arguments for GetNative

#define	PyFileObject_New_NUM 2
	index of New

#define	PyFileObject_New_RETURN PyFileObject*
	return type for New

#define	PyFileObject_New_PROTO (FileObject_t*)
	arguments for New

#define	PyFileObject_API_pointers 3
	number of API pointers

#define	PyFileObject_CAPSULE_NAME "_fileobject._C_API"

#define	PyFileObject_GetNative ((PyFileObject_GetNative_RETURN ()PyFileObject_GetNative_PROTO) PyFileObject_API[PyFileObject_GetNative_NUM])
	Returns a pointer to the internal file object, remember to release the reference when done with the object.

#define	PyFileObject_New ((PyFileObject_New_RETURN ()PyFileObject_New_PROTO) PyFileObject_API[PyFileObject_New_NUM])
	Creates a new file object instance.

#define	PyFileObject_Check(op)
	Checks if the object is a python gra instance.

#define	PyFileObject_Type ((PyTypeObject)PyFileObject_API[PyFileObject_Type_NUM])

#define	import_fileobject()
	Imports the PyFileObject module (like import _pia in python).

Detailed Description

Python version of the FileObject API.

Author: Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)

Date: 2025-12-19

Macro Definition Documentation

◆ import_fileobject

#define import_fileobject ( )

Value:

PyFileObject_API = (void **)PyCapsule_Import(PyFileObject_CAPSULE_NAME, 1);

Imports the PyFileObject module (like import _pia in python).

◆ PyFileObject_API_pointers

#define PyFileObject_API_pointers 3

number of API pointers

◆ PyFileObject_Check

#define PyFileObject_Check ( op )

Value:

(Py_TYPE(op) == &PyFileObject_Type)

Checks if the object is a python gra instance.

◆ PyFileObject_GetNative

#define PyFileObject_GetNative (*(PyFileObject_GetNative_RETURN (*)PyFileObject_GetNative_PROTO) PyFileObject_API[PyFileObject_GetNative_NUM])

Returns a pointer to the internal file object, remember to release the reference when done with the object.

(RAVE_OBJECT_RELEASE).

◆ PyFileObject_GetNative_NUM

#define PyFileObject_GetNative_NUM 1

index of GetNative

◆ PyFileObject_GetNative_PROTO

#define PyFileObject_GetNative_PROTO (PyFileObject*)

arguments for GetNative

◆ PyFileObject_GetNative_RETURN

#define PyFileObject_GetNative_RETURN FileObject_t*

return type for GetNative

◆ PyFileObject_New

#define PyFileObject_New (*(PyFileObject_New_RETURN (*)PyFileObject_New_PROTO) PyFileObject_API[PyFileObject_New_NUM])

Creates a new file object instance.

Release this object with Py_DECREF. If a FileObject_t instance is provided and this instance already is bound to a python instance, this instance will be increfed and returned.

Parameters

[in] pia - the FileObject_t intance.

Returns: the PyFileObject instance.

◆ PyFileObject_New_NUM

#define PyFileObject_New_NUM 2

index of New

◆ PyFileObject_New_PROTO

#define PyFileObject_New_PROTO (FileObject_t*)

arguments for New

◆ PyFileObject_New_RETURN

#define PyFileObject_New_RETURN PyFileObject*

return type for New

◆ PyFileObject_Type_NUM

#define PyFileObject_Type_NUM 0

index of type

Classes

Macros