Wrapping a Cplusplus class in Python/fr: Difference between revisions

From FreeCAD Documentation
(Created page with "Après ce préambule, une liste de méthodes et d'attributs est donnée. Le format d'une méthode est le suivant : {{Code|lang=xml|code= <Methode Name="move"> <Docum...")
No edit summary
 
(37 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
<languages/>


{{VeryImportantMessage|Cet article est un article en cours. Merci d'y apporter vos connaissances!}}
{{VeryImportantMessage|Cet article est un article en cours. Merci d'y apporter vos connaissances !}}
{{TOCright}}
{{TOCright}}


<span id="Background"></span>
== Contexte ==
== Contexte ==


Line 16: Line 17:
* {{incode|[YourClass]Py.h}}
* {{incode|[YourClass]Py.h}}


<span id="Class_Description_XML_File"></span>
== Fichier XML de description des classes ==
== Fichier XML de description des classes ==


Line 21: Line 23:


Pour cet exemple, nous allons examiner le wrapper de la classe Axis C++. Le fichier de description XML commence par:
Pour cet exemple, nous allons examiner le wrapper de la classe Axis C++. Le fichier de description XML commence par:

{{Code|lang=xml|code=
{{Code|lang=xml|code=
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
<PythonExport
<PythonExport
Father="PyObjectBase"
Father="PyObjectBase"
Name="AxisPy"
Name="AxisPy"
Twin="Axis"
Twin="Axis"
TwinPointer="Axis"
TwinPointer="Axis"
Include="Base/Axis.h"
Include="Base/Axis.h"
FatherInclude="Base/PyObjectBase.h"
FatherInclude="Base/PyObjectBase.h"
Namespace="Base"
Namespace="Base"
Constructor="true"
Constructor="true"
Delete="true"
Delete="true"
FatherNamespace="Base">
FatherNamespace="Base">
<Documentation>
<Documentation>
<Author Licence="LGPL" Name="Juergen Riegel" EMail="FreeCAD@juergen-riegel.net" />
<Author Licence="LGPL" Name="Juergen Riegel" EMail="FreeCAD@juergen-riegel.net" />
<UserDocu>Axis
<UserDocu>User documentation here
<!-- Lengthy comments removed. See source file. -->
</UserDocu>
<DeveloperDocu>Developer documentation here</DeveloperDocu>
</Documentation>
}}
}}
Et définit une direction et une position (base) dans l'espace 3D.

Les constructeurs suivants sont pris en charge :
* Axis() -- empty constructor
* Axis(Axis) -- copy constructor
* Axis(Base, Direction) -- define position and direction
</UserDocu>
<DeveloperDocu>Axis</DeveloperDocu>
</Documentation>


Après ce préambule, une liste de méthodes et d'attributs est donnée. Le format d'une méthode est le suivant :
Après ce préambule, une liste de méthodes et d'attributs est donnée. Le format d'une méthode est le suivant :

{{Code|lang=xml|code=
{{Code|lang=xml|code=
<Methode Name="move">
<Methode Name="move">
<Documentation>
<Documentation>
<UserDocu>
<UserDocu>
move(Vector)
move(Vector)
Move the axis base along the vector
Move the axis base along the vector
</UserDocu>
</UserDocu>
</Documentation>
</Documentation>
</Methode>
</Methode>
}}
}}


The format of an attribute is:
Le format d'un attribut est :

{{Code|lang=xml|code=
{{Code|lang=xml|code=
<Attribute Name="Direction" ReadOnly="false">
<Attribute Name="Direction" ReadOnly="false">
<Documentation>
<Documentation>
<UserDocu>Direction vector of the Axis</UserDocu>
<UserDocu>Direction vector of the Axis</UserDocu>
</Documentation>
</Documentation>
<Parameter Name="Direction" Type="Object" />
<Parameter Name="Direction" Type="Object" />
</Attribute>
</Attribute>
}}
}}


For an attribute, if "ReadOnly" is false, you will provide both a getter and a setter function. If it is true, only a getter is allowed. In this case we will be required to provide two functions in the implementation C++ file:
Pour un attribut, si "ReadOnly" est faux, vous devez fournir une fonction getter et une fonction setter. Si elle est vraie, seule une fonction getter est autorisée. Dans ce cas, nous devrons fournir deux fonctions dans le fichier C++ d'implémentation :

{{Code|lang=cpp|code=
{{Code|lang=cpp|code=
Py::Object AxisPy::getDirection(void) const
Py::Object AxisPy::getDirection(void) const
}}
}}

and
et :

{{Code|lang=cpp|code=
{{Code|lang=cpp|code=
void AxisPy::setDirection(Py::Object arg)
void AxisPy::setDirection(Py::Object arg)
}}
}}


<span id="Implementation_Cplusplus_File"></span>
== Implementation Cplusplus File ==
== Mise en œuvre du fichier Cplusplus ==


The implementation C++ file {{incode|[YourClass]PyImp.cpp}} provides the "glue" that connects the C++ and Python structures together, effectively translating from one language to the other. The FreeCAD C++-to-Python system provides a number of C++ classes that map to their corresponding Python type. The most fundamental of these is the {{incode|Py::Object}} class -- rarely created directly, this class provides the base of the inheritance tree, and is used as the return type for any function that is returning Python data.
Le fichier d'implémentation C++ {{incode|[YourClass]PyImp.cpp}} fournit la "colle" qui relie les structures C++ et Python ensemble, effectuant la traduction efficacement d'un langage à l'autre. Le système FreeCAD C++ vers Python fournit un certain nombre de classes C++ qui correspondent à leur type Python. La plus fondamentale de ces classes est la classe {{incode|Py::Object}} -- rarement créée directement, cette classe fournit la base de l'arbre d'héritage et est utilisée comme type de retour pour toute fonction qui retourne des données Python.


<span id="Include_Files"></span>
=== Include Files ===
=== Fichiers inclus ===

Votre fichier d'implémentation C++ comprendra les fichiers suivants :


Your C++ implementation file will include the following files:
{{Code|lang=cpp|code=
{{Code|lang=cpp|code=
#include "PreCompiled.h"
#include "PreCompiled.h"
Line 97: Line 103:
}}
}}


Bien entendu, vous pouvez inclure tous les autres en-têtes C++ dont votre code a besoin pour fonctionner.
Of course, you may include whatever other C++ headers your code requires to function as well.


=== Constructor ===
<span id="Constructor"></span>
=== Constructeur ===

Votre implémentation C++ doit contenir la définition de la fonction PyInit : par exemple, pour le wrapper de la classe Axis, c'est


Your C++ implementation must contain the definition of the PyInit function: for example, for the Axis class wrapper, this is
{{Code|lang=cpp|code=
{{Code|lang=cpp|code=
int AxisPy::PyInit(PyObject* args, PyObject* /*kwd*/)
int AxisPy::PyInit(PyObject* args, PyObject* /*kwd*/)
}}
}}


Within this function you will most likely need to parse incoming arguments to the constructor: the most important function for this purpose is the Python-provided {{incode|PyArg_ParseTuple}}. It takes in the passed argument list, a descriptor for the expected arguments that it should parse, and type information and storage locations for the parsed results. For example:
Dans cette fonction, vous aurez probablement besoin d'analyser les arguments entrants du constructeur : la fonction la plus importante à cet effet est la fonction fournie par Python {{incode|PyArg_ParseTuple}}. Elle prend en compte la liste des arguments passés, un descripteur pour les arguments attendus qu'elle doit analyser, ainsi que les informations de type et les emplacements de stockage pour les résultats analysés. Par exemple :

{{Code|lang=cpp|code=
{{Code|lang=cpp|code=
PyObject* d;
PyObject* d;
Line 118: Line 127:
}}
}}


For a complete list of format specifiers see [https://docs.python.org/3/c-api/arg.html Python C API documentation]. Note that several related functions are also defined which allow the use of keywords, etc. The complete set is:
Pour une liste complète des spécificateurs de format, voir [https://docs.python.org/3/c-api/arg.html documentation de l'API Python C]. Notez que plusieurs fonctions connexes sont également définies pour permettre l'utilisation de mots-clés etc... L'ensemble complet est le suivant :


{{Code|lang=cpp|code=
{{Code|lang=cpp|code=
Line 127: Line 136:
PyAPI_FUNC(int) PyArg_VaParseTupleAndKeywords (PyObject *, PyObject *, const char *, char **, va_list);
PyAPI_FUNC(int) PyArg_VaParseTupleAndKeywords (PyObject *, PyObject *, const char *, char **, va_list);
}}
}}

<span id="Links"></span>
== Liens ==

* [[Exposing_Cplusplus_to_Python/fr|Exposer Cplusplus à Python]]
* [https://github.com/FreeCAD/FreeCAD/commit/20b86e55b8dd1873f4c19e036d047528c9ff7f4e Commit 20b86e5, exposer les méthodes de précision d'OCC à Python]




{{Powerdocnavi{{#translation:}}}}
{{Powerdocnavi{{#translation:}}}}
[[Category:Developer{{#translation:}}]]
[[Category:Developer Documentation{{#translation:}}]]

Latest revision as of 02:21, 26 November 2023

Other languages:
Cet article est un article en cours. Merci d'y apporter vos connaissances !

Contexte

FreeCAD utilise un système personnalisé basé sur XML pour créer le wrapper Python d'une classe C++. Pour encapsuler une classe C++ afin de l'utiliser dans Python, deux fichiers doivent être créés manuellement, et deux fichiers sont automatiquement générés par le système de construction CMake (en plus des fichiers d'en-tête et d'implémentation C++ de la classe).

Vous devez créer :

  • [YourClass]Py.xml
  • [YourClass]PyImp.cpp

Editez le fichier approprié CMakeLists.txt pour ajouter des références à ces deux fichiers. A partir du fichier XML, le système de construction créera alors :

  • [YourClass]Py.cpp
  • [YourClass]Py.h

Fichier XML de description des classes

Le fichier XML [YourClass]Py.xml fournit des informations sur les fonctions et attributs que la classe Python implémente ainsi que la documentation utilisateur pour ces éléments qui s'affiche dans la Console Python de FreeCAD.

Pour cet exemple, nous allons examiner le wrapper de la classe Axis C++. Le fichier de description XML commence par:

<?xml version="1.0" encoding="UTF-8"?>
<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
    <PythonExport
        Father="PyObjectBase"
        Name="AxisPy"
        Twin="Axis"
        TwinPointer="Axis"
        Include="Base/Axis.h"
        FatherInclude="Base/PyObjectBase.h"
        Namespace="Base"
        Constructor="true"
        Delete="true"
        FatherNamespace="Base">
    <Documentation>
        <Author Licence="LGPL" Name="Juergen Riegel" EMail="FreeCAD@juergen-riegel.net" />
        <UserDocu>User documentation here
        </UserDocu>
        <DeveloperDocu>Developer documentation here</DeveloperDocu>
    </Documentation>

Après ce préambule, une liste de méthodes et d'attributs est donnée. Le format d'une méthode est le suivant :

<Methode Name="move">
    <Documentation>
        <UserDocu>
        move(Vector)
        Move the axis base along the vector
        </UserDocu>
    </Documentation>
</Methode>

Le format d'un attribut est :

<Attribute Name="Direction" ReadOnly="false">
    <Documentation>
        <UserDocu>Direction vector of the Axis</UserDocu>
    </Documentation>
    <Parameter Name="Direction" Type="Object" />
</Attribute>

Pour un attribut, si "ReadOnly" est faux, vous devez fournir une fonction getter et une fonction setter. Si elle est vraie, seule une fonction getter est autorisée. Dans ce cas, nous devrons fournir deux fonctions dans le fichier C++ d'implémentation :

Py::Object AxisPy::getDirection(void) const

et :

void AxisPy::setDirection(Py::Object arg)

Mise en œuvre du fichier Cplusplus

Le fichier d'implémentation C++ [YourClass]PyImp.cpp fournit la "colle" qui relie les structures C++ et Python ensemble, effectuant la traduction efficacement d'un langage à l'autre. Le système FreeCAD C++ vers Python fournit un certain nombre de classes C++ qui correspondent à leur type Python. La plus fondamentale de ces classes est la classe Py::Object -- rarement créée directement, cette classe fournit la base de l'arbre d'héritage et est utilisée comme type de retour pour toute fonction qui retourne des données Python.

Fichiers inclus

Votre fichier d'implémentation C++ comprendra les fichiers suivants :

#include "PreCompiled.h"

#include "[YourClass].h"

// Inclusion of the generated files (generated out of [YourClass]Py.xml)
#include "[YourClass]Py.h"
#include "[YourClass]Py.cpp"

Bien entendu, vous pouvez inclure tous les autres en-têtes C++ dont votre code a besoin pour fonctionner.

Constructeur

Votre implémentation C++ doit contenir la définition de la fonction PyInit : par exemple, pour le wrapper de la classe Axis, c'est

int AxisPy::PyInit(PyObject* args, PyObject* /*kwd*/)

Dans cette fonction, vous aurez probablement besoin d'analyser les arguments entrants du constructeur : la fonction la plus importante à cet effet est la fonction fournie par Python PyArg_ParseTuple. Elle prend en compte la liste des arguments passés, un descripteur pour les arguments attendus qu'elle doit analyser, ainsi que les informations de type et les emplacements de stockage pour les résultats analysés. Par exemple :

PyObject* d;
    if (PyArg_ParseTuple(args, "O!O", &(Base::VectorPy::Type), &o,
                                      &(Base::VectorPy::Type), &d)) {
        // NOTE: The first parameter defines the base (origin) and the second the direction.
        *getAxisPtr() = Base::Axis(static_cast<Base::VectorPy*>(o)->value(),
                                   static_cast<Base::VectorPy*>(d)->value());
        return 0;
    }

Pour une liste complète des spécificateurs de format, voir documentation de l'API Python C. Notez que plusieurs fonctions connexes sont également définies pour permettre l'utilisation de mots-clés etc... L'ensemble complet est le suivant :

PyAPI_FUNC(int) PyArg_Parse (PyObject *, const char *, ...);
PyAPI_FUNC(int) PyArg_ParseTuple (PyObject *, const char *, ...);
PyAPI_FUNC(int) PyArg_ParseTupleAndKeywords (PyObject *, PyObject *, const char *, char **, ...);
PyAPI_FUNC(int) PyArg_VaParse (PyObject *, const char *, va_list);
PyAPI_FUNC(int) PyArg_VaParseTupleAndKeywords (PyObject *, PyObject *, const char *, char **, va_list);

Liens