jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add support for Python variable annotations as a feature.

Browse source 
Both function annotations and variable annotations are turned on using the
"python:annotations" feature. Example:

  %feature("python:annotations", "c");

  struct V {
    float val;
  };

The generated code contains a variable annotation containing the C float type:

  class V(object):
      val: "float" = property(_example.V_val_get, _example.V_val_set)
      ...

Python 3.5 and earlier do not support variable annotations, so variable
annotations can be turned off with a "python:annotations:novar" feature flag.
Example turning on function annotations but not variable annotations globally:

  %feature("python:annotations", "c");
  %feature("python:annotations:novar");

or via the command line:

  -features python:annotations=c,python:annotations:novar

Closes #1951
This commit is contained in:
William S Fulton 2022-03-02 19:33:03 +00:00
commit 3159de3e9f
7 changed files with 182 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

44
Examples/test-suite/python_annotations_variable_c.i Normal file
View file

@ -0,0 +1,44 @@
%module python_annotations_variable_c
// Tests Python variable annotations, containing C/C++ types, in C++ member variables wrappers.
// Member variables are wrapped using Python properties.
// This is in a separate test to python_annotations_c.i (which tests function annotations) so that runtime testing
// of variable annotations can be done which requires Python 3.6 and later. A syntax error occurs in earlier
// versions of Python when importing code containing variable annotations.
%feature("python:annotations", "c");
%feature("python:annotations:novar") member_variable_not_annotated;
%inline %{
namespace Space {
template<class T>
struct Template {
int member_variable;
int member_variable_not_annotated;
};
struct StructWithVar{
int member_variable;
};
struct StructWithVarNotAnnotated {
int member_variable_not_annotated;
};
short global_variable;
}
%}
%template(TemplateShort) Space::Template<short>;
%inline %{
#ifdef SWIGPYTHON_BUILTIN
int is_python_builtin() { return 1; }
#else
int is_python_builtin() { return 0; }
#endif
#if defined SWIGPYTHON_FASTPROXY
int is_python_fastproxy() { return 1; }
#else
int is_python_fastproxy() { return 0; }
#endif
%}