source: git/Singular/pyobject.cc @ 0227d1

jengelh-datetimespielwiese
Last change on this file since 0227d1 was 0227d1, checked in by Alexander Dreyer <alexander.dreyer@…>, 11 years ago
fix: pyobject's ternary operation
  • Property mode set to 100644
File size: 17.0 KB
Line 
1// -*- c++ -*-
2//*****************************************************************************
3/** @file pyobject.cc
4 *
5 * @author Alexander Dreyer
6 * @date 2010-12-15
7 *
8 * This file defines the @c blackbox operations for the pyobject type.
9 *
10 * @par Copyright:
11 *   (c) 2010 by The Singular Team, see LICENSE file
12**/
13//*****************************************************************************
14
15#include "config.h"
16#include <kernel/mod2.h>
17#include <misc/auxiliary.h>
18#include "newstruct.h"
19
20#include <omalloc/omalloc.h>
21
22#include <kernel/febase.h>
23
24#include "subexpr.h"
25#include "lists.h"
26#include "ipid.h"
27#include "blackbox.h"
28
29#include <Python.h>
30// #include <iterator>             // std::distance
31// #include <stdio.h>
32
33void sync_contexts();
34
35/** @class PythonInterpreter
36 * This class initializes and finalized the python interpreter.
37 *
38 * It also stores the Singular token number, which is assigned to this type on
39 * runtime.
40 **/
41class PythonInterpreter {
42public:
43  typedef int id_type;
44
45  ~PythonInterpreter()  { if(m_owns_python) Py_Finalize();  }
46
47  /// Initialize unique (singleton) python interpreter instance,
48  /// and set Singular type identifier
49  static void init(id_type num ) { instance().m_id = num; }
50
51  /// Get Singular type identitfier
52  static id_type id() { return instance().m_id; }
53
54private:
55  /// Singleton: Only init() is allowed to construct an instance
56  PythonInterpreter():
57    m_id(0), m_owns_python(false)  { start_python(); }
58
59  /// Static initialization -
60  /// safely takes care of destruction on program termination
61  static PythonInterpreter& instance() 
62  {
63    static PythonInterpreter init_interpreter;
64    return init_interpreter;
65  }
66
67  void start_python()
68  {
69    if (!Py_IsInitialized()) init_python();
70    set_python_defaults();
71  }
72 
73  void init_python()
74  {
75    Py_Initialize();
76    m_owns_python = true;
77  }
78
79  void set_python_defaults()
80  {
81    // Sone python modules needs argc, argv set for some reason
82    char* argv = "";
83    PySys_SetArgv(1, &argv);
84    PyRun_SimpleString("from sys import path, modules");
85    PyRun_SimpleString("_SINGULAR_IMPORTED = dict()");
86
87    char cmd[MAXPATHLEN + 20];
88    sprintf(cmd, "path.insert(0, '%s')", feGetResource('b'));
89    PyRun_SimpleString(cmd);
90    PyRun_SimpleString("del path");  // cleanup
91  }   
92
93  id_type m_id;
94  bool m_owns_python;
95};
96
97/** @class PythonObject
98 * This class defines an interface for calling PyObject from Singular.
99 *
100 * @note This class does not take care of the memory mangement, this is done in
101 * the blackbox routines.
102 **/
103class PythonObject
104{
105  typedef PythonObject self;
106
107public:
108  typedef PyObject* ptr_type;
109  struct sequence_tag{};
110
111  PythonObject(): m_ptr(Py_None) { }
112  PythonObject(ptr_type ptr): m_ptr(ptr) { 
113    if (!ptr && handle_exception()) m_ptr = Py_None;
114  }
115
116  ptr_type check_context(ptr_type ptr) const {
117    if(ptr) sync_contexts(); 
118    return ptr;
119  }
120  /// Unary operations
121  self operator()(int op) const
122  {
123    switch(op)
124    {
125    case '(':  return check_context(PyObject_CallObject(*this, NULL));
126    case ATTRIB_CMD: return PyObject_Dir(*this);
127    case PROC_CMD: return *this;
128    }
129
130    if (op == PythonInterpreter::id())
131      return *this;
132
133    return self(NULL);
134  }
135
136  /// Binary and n-ary operations
137  self operator()(int op, const self& arg) const {
138
139    switch(op)
140    {
141      case '+':  return PyNumber_Add(*this, arg);
142      case '-':  return PyNumber_Subtract(*this, arg);
143      case '*':  return PyNumber_Multiply(*this, arg);
144      case '/':  return PyNumber_Divide(*this, arg);
145      case '^':  return PyNumber_Power(*this, arg, Py_None);
146      case '(':  return check_context(PyObject_CallObject(*this, arg));
147      case '[':  return operator[](arg);
148      case KILLATTR_CMD: return del_attr(arg);
149      case LIST_CMD:     return args2list(arg);
150      case '.': case COLONCOLON: case ATTRIB_CMD: return attr(arg);
151    }
152    return self(NULL);
153  }
154
155  /// Ternary operations
156  self operator()(int op, const self& arg1, const self& arg2) const 
157  {
158    switch(op)
159    {
160      case ATTRIB_CMD: 
161        if(PyObject_SetAttr(*this, arg1, arg2) == -1) handle_exception();
162        return self();
163    }
164    return self(NULL);
165  }
166
167  /// Get item
168  self operator[](const self& idx) const { return PyObject_GetItem(*this, idx); }
169  self operator[](long idx) const { return operator[](PyInt_FromLong(idx));  }
170
171  /// Get actual PyObject*
172  operator const ptr_type() const { return m_ptr; }
173
174  /// Get representative as C-style string
175  char* repr() const
176  {
177    return omStrDup(PyString_AsString(PyObject_Repr(*this)));
178  }
179
180  /// Extract C-style string
181  char* str() const { return omStrDup(PyString_AsString(*this)); }
182
183  Py_ssize_t size() const { return PyObject_Size(m_ptr); }
184
185  BOOLEAN assign_to(leftv result)
186  {
187    return (m_ptr? (m_ptr == Py_None? none_to(result): python_to(result)): TRUE);
188  }
189
190  void import_as(const char* name) const {
191    idhdl handle = enterid(omStrDup(name), 0, DEF_CMD, 
192                           &IDROOT, FALSE);
193
194    if (handle)
195    {
196      IDDATA(handle) = (char*)m_ptr;
197      Py_XINCREF(m_ptr); 
198      IDTYP(handle) =  PythonInterpreter::id();
199    }
200    else { Werror("Importing pyobject to Singular failed"); }
201  }
202
203  int compare(int op, const self& arg) const
204  { return PyObject_RichCompareBool(*this, arg, py_opid(op)); }
205
206
207  self attr(const self& arg) const { return PyObject_GetAttr(*this, arg); }
208
209  self del_attr(const self& arg) const 
210  {
211    if (!PyObject_HasAttr(*this, arg)) 
212      Werror("Cannot delete attribute %s.", arg.repr());
213    else
214      PyObject_DelAttr(*this, arg); 
215 
216    return self();
217  }
218
219protected:
220  self args2list(const self& args) const
221  {
222    self pylist(PyList_New(0));
223    PyList_Append(pylist, *this);
224    if(PyTuple_Check(args))  pylist.append_iter(PyObject_GetIter(args));
225    else PyList_Append(pylist, args);
226
227    return pylist;
228  }
229
230  BOOLEAN handle_exception() const {
231
232    if(!PyErr_Occurred()) return FALSE;
233   
234    PyObject *pType, *pMessage, *pTraceback;
235    PyErr_Fetch(&pType, &pMessage, &pTraceback);
236   
237    Werror("pyobject error occured");
238    Werror(PyString_AsString(pMessage));
239   
240    Py_XDECREF(pType);
241    Py_XDECREF(pMessage);
242    Py_XDECREF(pTraceback);
243   
244    PyErr_Clear();
245    return TRUE;
246  }
247
248  void append_iter(self iterator) {
249    ptr_type item;
250    while (item = PyIter_Next(iterator)) {
251      PyList_Append(*this, item);
252      Py_DECREF(item);
253    }
254  }
255
256  int py_opid(int op) const{
257    switch(op)
258    { 
259      case '<':  return Py_LT;
260      case '>':  return Py_GT;
261      case EQUAL_EQUAL:  return Py_EQ;
262      case NOTEQUAL:  return Py_NE;
263      case GE:  return Py_GE; 
264      case LE:  return Py_LE; 
265    }
266    return -1;
267  }
268
269private:
270  BOOLEAN none_to(leftv result) const
271  {
272    result->data = NULL;
273    result->rtyp = NONE;
274    return FALSE;
275  }
276
277  BOOLEAN python_to(leftv result) const
278  {
279    result->data = m_ptr;
280    Py_XINCREF(m_ptr);
281    result->rtyp = PythonInterpreter::id();
282    return !m_ptr;
283  }
284
285  /// The actual pointer
286  ptr_type m_ptr;
287};
288
289
290
291/** @class PythonCastStatic
292 * This template class does conversion of Singular objects to python objects on
293 * compile-time.
294 *
295 * @note The Singular objects are assumed to be equivalent to the template argument.
296 **/
297template <class CastType = PythonObject::ptr_type>
298class PythonCastStatic:
299  public PythonObject {
300public:
301
302  PythonCastStatic(void* value):
303    PythonObject(get(reinterpret_cast<CastType>(value))) {}
304
305  PythonCastStatic(leftv value):
306    PythonObject(get(reinterpret_cast<CastType>(value->Data()))) {}
307
308private:
309  ptr_type get(ptr_type value)       { return value; }
310  ptr_type get(long value)           { return PyInt_FromLong(value); }
311  ptr_type get(const char* value)    { return PyString_FromString(value); }
312  ptr_type get(char* value) { return get(const_cast<const char*>(value)); }
313  ptr_type get(lists value);         // inlined after PythonObjectDynamic
314};
315
316
317
318/** @class PythonCastDynamic
319 * This class does conversion of Singular objects to python objects on runtime.
320 *
321 **/
322class PythonCastDynamic:
323  public PythonObject {
324  typedef PythonCastDynamic self;
325
326public:
327  PythonCastDynamic(leftv value): PythonObject(get(value, value->Typ())) {}
328
329private:
330  PythonObject get(leftv value, int typeId)
331  {
332    if (typeId == PythonInterpreter::id()) return PythonCastStatic<>(value);
333   
334    switch (typeId)
335    {
336    case INT_CMD:    return PythonCastStatic<long>(value);
337    case STRING_CMD: return PythonCastStatic<const char*>(value);
338    case LIST_CMD:   return PythonCastStatic<lists>(value);
339    }
340
341    if (typeId > MAX_TOK)       // custom types
342    {
343      blackbox *bbx = getBlackboxStuff(typeId);
344      sleftv tmp;
345      if (! bbx->blackbox_Op1(PythonInterpreter::id(), &tmp, value) )
346        return PythonCastStatic<>(&tmp);
347    }
348    else
349      Werror("type '%s` incompatible with 'pyobject`", iiTwoOps(typeId));
350
351    return PythonObject();
352  }
353};
354
355template <class CastType>
356inline PythonObject::ptr_type
357PythonCastStatic<CastType>::get(lists value)
358{
359  ptr_type pylist(PyList_New(0));
360  for (int i = 0; i <= value->nr; ++i)
361    PyList_Append(pylist, PythonCastDynamic((value->m) + i));
362
363  return pylist;
364}
365
366/// Template specialization for getting handling sequence
367template <>
368class PythonCastStatic<PythonObject::sequence_tag>:
369public PythonObject
370{
371public:
372
373  PythonCastStatic(leftv value):
374    PythonObject(PyTuple_New(size(value)))  { append_to(value); }
375
376 
377private:
378  size_t size(leftv iter, size_t distance = 0) const 
379  {
380    if (iter) { do { ++distance; } while(iter = iter->next); }; 
381    return distance;
382  }
383 
384  void append_to(leftv iter) const
385  {
386    for(size_t idx = 0; iter != NULL; iter = iter->next)
387      PyTuple_SetItem(*this, idx++, PythonCastDynamic(iter));
388  }
389};
390
391
392PythonObject get_attrib_name(leftv arg)
393{
394  typedef PythonCastStatic<const char*> result_type;
395  if (arg->Typ() == STRING_CMD)
396    return result_type(arg);
397
398  return result_type((void*)arg->Name());
399}
400
401/// Evaluate string in python
402PythonObject python_eval(const char* arg) {
403
404  PyObject* globals = PyModule_GetDict(PyImport_Import(PyString_FromString("__main__")));
405  return PyRun_String(arg, Py_eval_input, globals, globals);
406}
407
408/// Evaluate string in python from Singular
409BOOLEAN python_eval(leftv result, leftv arg) {
410  if ( !arg || (arg->Typ() != STRING_CMD) ) {
411    Werror("expected python_eval('string')");
412    return TRUE;
413  }
414
415  return python_eval(reinterpret_cast<const char*>(arg->Data())).assign_to(result);
416}
417
418
419/// Execute string in python from Singular
420BOOLEAN python_run(leftv result, leftv arg)
421{
422  if ( !arg || (arg->Typ() != STRING_CMD) ) {
423    Werror("expected python_run('string')");
424    return TRUE;
425  }
426
427  PyRun_SimpleString(reinterpret_cast<const char*>(arg->Data()));
428  sync_contexts();
429  return PythonCastStatic<>(Py_None).assign_to(result);
430}
431
432PythonObject names_from_module(const char* module_name)
433{
434  char buffer[strlen(module_name) + 30];
435  sprintf (buffer, "SINGULAR_MODULE_NAME = '%s'", module_name);
436  PyRun_SimpleString(buffer);
437  PyRun_SimpleString("from sys import modules");
438  PyRun_SimpleString("exec('from ' + SINGULAR_MODULE_NAME + ' import *')");
439
440  return python_eval("[str for str in dir(modules[SINGULAR_MODULE_NAME]) if str[0] != '_']");
441}
442
443void from_module_import_all(const char* module_name)
444{
445  char buffer[strlen(module_name) + 20];
446  sprintf (buffer, "from %s import *", module_name);
447  PyRun_SimpleString(buffer);
448}
449
450/// import python module and export identifiers in Singular namespace
451BOOLEAN python_import(leftv result, leftv value) {
452
453  if ((value == NULL) || (value->Typ()!= STRING_CMD)) {
454    Werror("expected python_import('string')");
455    return TRUE;
456  }
457
458  from_module_import_all(reinterpret_cast<const char*>(value->Data()));
459  sync_contexts();
460
461  return PythonCastStatic<>(Py_None).assign_to(result);
462}
463
464/// blackbox support - initialization
465void* pyobject_Init(blackbox*)
466{
467  return Py_None;
468}
469
470/// blackbox support - convert to string representation
471char* pyobject_String(blackbox *b, void* ptr)
472{
473  return PythonCastStatic<>(ptr).repr();
474}
475
476/// blackbox support - copy element
477void* pyobject_Copy(blackbox*b, void* ptr)
478{ 
479    Py_XINCREF(ptr);
480    return ptr;
481}
482
483/// blackbox support - assign element
484BOOLEAN pyobject_Assign(leftv l, leftv r)
485{
486  Py_XDECREF(l->Data());
487  PyObject* result = PythonCastDynamic(r);
488  Py_XINCREF(result);
489
490  if (l->rtyp == IDHDL)
491    IDDATA((idhdl)l->data) = (char *)result;
492  else
493    l->data = (void *)result;
494 
495  return !result;
496}
497                                                                     
498
499/// blackbox support - unary operations
500BOOLEAN pyobject_Op1(int op, leftv res, leftv head)
501{
502  switch(op)
503  {
504    case INT_CMD:               // built-in return types first
505    {
506      long value = PyInt_AsLong(PythonCastStatic<>(head));
507      if( (value == -1) &&  PyErr_Occurred() ) {
508        Werror("'pyobject` cannot be converted to integer");
509        PyErr_Clear();
510        return TRUE;
511      }
512      res->data = (void*) value;
513      res->rtyp = INT_CMD;
514      return FALSE;
515    }
516    case TYPEOF_CMD:
517      res->data = (void*) omStrDup("pyobject");
518      res->rtyp = STRING_CMD; 
519      return FALSE; 
520  }
521
522  if (!PythonCastStatic<>(head)(op).assign_to(res))
523    return FALSE;
524
525  BOOLEAN newstruct_Op1(int, leftv, leftv); // forward declaration
526  return newstruct_Op1(op, res, head);
527}
528
529
530/// blackbox support - binary operations
531BOOLEAN pyobject_Op2(int op, leftv res, leftv arg1, leftv arg2)
532{
533  PythonCastStatic<> lhs(arg1);
534
535  switch(op)                    // built-in return types and special cases first
536  { 
537    case '<': case '>': case EQUAL_EQUAL: case NOTEQUAL: case GE: case LE:
538    {
539      res->data = (void *)lhs.compare(op, PythonCastDynamic(arg2));
540      res->rtyp = INT_CMD;
541      return FALSE;
542    }
543    case '.': case COLONCOLON: case ATTRIB_CMD:
544      return lhs.attr(get_attrib_name(arg2)).assign_to(res);
545  }
546
547  PythonCastDynamic rhs(arg2);
548  if (!lhs(op, rhs).assign_to(res))
549    return FALSE;
550
551  BOOLEAN newstruct_Op2(int, leftv, leftv, leftv); // forward declaration
552  return newstruct_Op2(op, res, arg1, arg2);
553
554}
555
556/// blackbox support - ternary operations
557BOOLEAN pyobject_Op3(int op, leftv res, leftv arg1, leftv arg2, leftv arg3)
558{
559  PythonCastStatic<> lhs(arg1);
560  PythonCastDynamic rhs1(arg2);
561  PythonCastDynamic rhs2(arg3);
562
563  if (!lhs(op, rhs1, rhs2).assign_to(res))
564    return FALSE;
565
566  return blackboxDefaultOp3(op, res, arg1, arg2, arg3);
567}
568
569
570/// blackbox support - n-ary operations
571BOOLEAN pyobject_OpM(int op, leftv res, leftv args)
572{
573  typedef PythonCastStatic<PythonObject::sequence_tag> seq_type;
574
575  switch(op)                    // built-in return types first
576  {
577    case STRING_CMD:
578    {
579      blackbox* a = getBlackboxStuff(args->Typ());
580      res->data = (void *)a->blackbox_String(a, args->Data());
581      res->rtyp = STRING_CMD;
582      return FALSE;
583    }
584  }
585
586  typedef PythonCastStatic<PythonObject::sequence_tag> seq_type;
587  if (! PythonCastStatic<>(args)(op, seq_type(args->next)).assign_to(res))
588    return FALSE;
589
590  BOOLEAN newstruct_OpM(int, leftv, leftv); // forward declaration
591  return newstruct_OpM(op, res, args);
592}
593
594/// blackbox support - destruction
595void pyobject_destroy(blackbox *b, void* ptr)
596{
597  Py_XDECREF(ptr);
598}
599
600PyObject* get_current_definition(const char* name) {
601  idhdl handle =  ggetid(name);
602  if (!handle || (IDTYP(handle) != PythonInterpreter::id()))  return NULL;
603  PythonCastStatic<PyObject*> value(IDDATA(handle));
604  return value;
605}
606
607/// getting stuff from python to Singular namespace
608void sync_contexts()
609{
610  PyRun_SimpleString("_SINGULAR_NEW = modules['__main__'].__dict__.copy()");
611
612  PythonObject newElts = python_eval("[(_k, _e)   \
613    for (_k, _e) in _SINGULAR_NEW.iteritems() \
614    if _k not in _SINGULAR_IMPORTED or not _SINGULAR_IMPORTED[_k] is _e]");
615
616  long len = newElts.size();
617  for (long idx = 0; idx < len; ++idx)
618  {
619    char* name = newElts[idx][0].str();
620    if (name && (*name != '\0') && (*name != '_'))
621    {
622      Py_XDECREF(get_current_definition(name));
623      newElts[idx][1].import_as(name);
624    }
625
626  }
627
628  PythonObject deletedElts = 
629    python_eval("list(set(_SINGULAR_IMPORTED.iterkeys()) - \
630     set(_SINGULAR_NEW.iterkeys()))");
631  len = deletedElts.size();
632
633  for (long idx = 0; idx < len; ++idx)
634  {
635    char* name = deletedElts[idx].str();
636    if (name && (*name != '\0') && (*name != '_'))
637      killid(name, &IDROOT);
638  }
639
640  PyRun_SimpleString("_SINGULAR_IMPORTED =_SINGULAR_NEW");
641  PyRun_SimpleString("del  _SINGULAR_NEW");
642}
643
644
645// forward declaration
646int iiAddCproc(char *libname, char *procname, BOOLEAN pstatic,
647               BOOLEAN(*func)(leftv res, leftv v));
648
649#define ADD_C_PROC(name) iiAddCproc("", (char*)#name, FALSE, name);
650
651
652void pyobject_init() 
653{
654  blackbox *b = (blackbox*)omAlloc0(sizeof(blackbox));
655  b->blackbox_destroy = pyobject_destroy;
656  b->blackbox_String  = pyobject_String;
657  b->blackbox_Init    = pyobject_Init;
658  b->blackbox_Copy    = pyobject_Copy;
659  b->blackbox_Assign  = pyobject_Assign;
660  b->blackbox_Op1     = pyobject_Op1;
661  b->blackbox_Op2     = pyobject_Op2;
662  b->blackbox_Op3     = pyobject_Op3;
663  b->blackbox_OpM     = pyobject_OpM;
664  b->data             = omAlloc0(newstruct_desc_size());
665
666  PythonInterpreter::init(setBlackboxStuff(b,"pyobject"));
667
668  ADD_C_PROC(python_import);
669  ADD_C_PROC(python_eval);
670  ADD_C_PROC(python_run);
671}
672
673extern "C" { void mod_init() { pyobject_init(); } }
674
Note: See TracBrowser for help on using the repository browser.