annotate scripts/miscellaneous/python.m @ 20214:eba80000fa0d rc-4-0-0-2

maint: Bump version number for 4.0.0-rc2.
author John W. Eaton <jwe@octave.org>
date Fri, 20 Mar 2015 16:19:38 -0400
parents 4197fc428c7d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19898
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19602
diff changeset
1 ## Copyright (C) 2008-2015 Julian Schnidder
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 13859
diff changeset
2 ## Copyright (C) 2012 Carnë Draug
13163
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
3 ##
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
4 ## This file is part of Octave.
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
5 ##
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
7 ## under the terms of the GNU General Public License as published by
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
8 ## the Free Software Foundation; either version 3 of the License, or (at
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
9 ## your option) any later version.
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
10 ##
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
14 ## General Public License for more details.
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
15 ##
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
16 ## You should have received a copy of the GNU General Public License
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
17 ## along with Octave; see the file COPYING. If not, see
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
18 ## <http://www.gnu.org/licenses/>.
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
19
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
20 ## -*- texinfo -*-
14818
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
21 ## @deftypefn {Function File} {@var{output} =} python (@var{scriptfile})
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
22 ## @deftypefnx {Function File} {@var{output} =} python (@var{scriptfile}, @var{argument1}, @var{argument2}, @dots{})
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
23 ## @deftypefnx {Function File} {[@var{output}, @var{status}] =} python (@dots{})
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
24 ## Invoke Python script @var{scriptfile}, possibly with a list of command line
19407
c61deba773ab Add BIST test to perl() and python().
Rik <rik@octave.org>
parents: 17744
diff changeset
25 ## arguments.
c61deba773ab Add BIST test to perl() and python().
Rik <rik@octave.org>
parents: 17744
diff changeset
26 ##
c61deba773ab Add BIST test to perl() and python().
Rik <rik@octave.org>
parents: 17744
diff changeset
27 ## Return output in @var{output} and optional status in @var{status}. If
19602
cbce5d1bcaf9 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 19407
diff changeset
28 ## @var{scriptfile} is not an absolute file name it is searched for in the
19407
c61deba773ab Add BIST test to perl() and python().
Rik <rik@octave.org>
parents: 17744
diff changeset
29 ## current directory and then in the Octave loadpath.
14818
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
30 ## @seealso{system, perl}
13163
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
31 ## @end deftypefn
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
32
13859
6d59b141e65d Add python to manual and respect format rules of copyright block
Carnë Draug <carandraug+dev@gmail.com>
parents: 13163
diff changeset
33 ## Author: Carnë Draug <carandraug+dev@gmail.com>
6d59b141e65d Add python to manual and respect format rules of copyright block
Carnë Draug <carandraug+dev@gmail.com>
parents: 13163
diff changeset
34
13163
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
35 function [output, status] = python (scriptfile = "-c ''", varargin)
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
36
14818
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
37 if (ischar (scriptfile)
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
38 && ( (nargin == 1 && ! isempty (scriptfile))
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
39 || (nargin != 1 && iscellstr (varargin))))
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
40 if (! strcmp (scriptfile(1:2), "-c"))
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
41 ## Attempt to find file in loadpath. No effect for absolute filenames.
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
42 scriptfile = file_in_loadpath (scriptfile);
c6ae30f73946 Look for perl/python scripts in Octave load path (bug #36729)
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
43 endif
13163
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
44
16994
333243133364 Use matrix concatenation for strings, rather than cstrcat(), for clarity and performance.
Rik <rik@octave.org>
parents: 14818
diff changeset
45 [status, output] = system (["python ", scriptfile, ...
333243133364 Use matrix concatenation for strings, rather than cstrcat(), for clarity and performance.
Rik <rik@octave.org>
parents: 14818
diff changeset
46 sprintf(" %s", varargin{:})]);
13163
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
47 else
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
48 error ("python: invalid arguments");
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
49 endif
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
50
2ca9730d35ba python: new function to invoke python scripts from octave code
Carnë Draug <carandraug+dev@gmail.com>
parents:
diff changeset
51 endfunction
17338
1c89599167a6 maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents: 16994
diff changeset
52
19407
c61deba773ab Add BIST test to perl() and python().
Rik <rik@octave.org>
parents: 17744
diff changeset
53
c61deba773ab Add BIST test to perl() and python().
Rik <rik@octave.org>
parents: 17744
diff changeset
54 %!error <invalid arguments> python (123)
c61deba773ab Add BIST test to perl() and python().
Rik <rik@octave.org>
parents: 17744
diff changeset
55