view pyexec.cc @ 316:a140160b2319

doc: clean up pyeval and pyexec doc strings * pyeval.cc: Fix Texinfo syntax and optional argument description. Fix dict example to reflect recent changes. * pyexec.cc: Fix Texinfo syntax and optional argument description.
author Mike Miller <mtmiller@octave.org>
date Tue, 09 Aug 2016 21:51:28 -0700
parents b4e56f7255f7
children cee203ea6245
line wrap: on
line source

/*

Copyright (C) 2016 Colin B. Macdonald

This file is part of Pytave.

Pytave is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 3 of the License, or (at your
option) any later version.

Pytave is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with Pytave; see the file COPYING.  If not, see
<http://www.gnu.org/licenses/>.

*/

#if defined (HAVE_CONFIG_H)
#  include <config.h>
#endif

#include <dlfcn.h>
#include <boost/python.hpp>
#include <boost/python/numeric.hpp>

#include <oct.h>

#define PYTAVE_DO_DECLARE_SYMBOL
#include "arrayobjectdefs.h"
#include "exceptions.h"
#include "python_to_octave.h"
#include "pytave_utils.h"

using namespace boost::python;

DEFUN_DLD (pyexec, args, nargout,
           "-*- texinfo -*-\n\
@deftypefn  {} {} pyexec (@var{expr})\n\
@deftypefnx {} {} pyexec (@var{expr}, @var{localns})\n\
Execute a Python expression or block of code.\n\
\n\
When called with an optional second argument, @var{localns} is a\n\
@code{py.dict} that acts as the namespace for any assignments or other\n\
side effects of the expression.\n\
\n\
Examples:\n\
@example\n\
@group\n\
pyexec (\"print(42)\")\n\
  @print{} 42\n\
@end group\n\
@end example\n\
@seealso{pycall, pyeval}\n\
@end deftypefn")
{
  octave_value_list retval;

  int nargin = args.length ();

  if (nargin < 1 || nargin > 2)
    {
      print_usage ();
      return retval;
    }

  std::string code = args(0).string_value ();

  Py_Initialize ();

  object main_module = import ("__main__");
  object main_namespace = main_module.attr ("__dict__");
  object local_namespace;
  if (nargin > 1)
  {
    pytave::get_object_from_python (args(1), local_namespace);
    if (local_namespace.is_none ())
      error ("pyexec: NAMESPACE must be a string or a Python reference");
  }
  else
    local_namespace = main_namespace;

  try
    {
      // FIXME: figure out exec return code:
      // http://www.boost.org/doc/libs/1_38_0/libs/python/doc/v2/exec.html
      exec (code.c_str (), main_namespace, local_namespace);
    }
  catch (pytave::object_convert_exception const &)
    {
      error ("pyexec: error in return value type conversion");
    }
  catch (error_already_set const &)
    {
      std::string message = pytave::fetch_exception_message ();
      error ("pyexec: %s", message.c_str ());
    }
  return retval;
}

/*
%!error <NameError>
%! pyexec ("raise NameError ('oops')")

%!error <AttributeError>
%! pyexec ("import sys")
%! pyexec ("sys.no_such_thing")
*/