org.python.core
Class ArgParser
java.lang.Object
org.python.core.ArgParser
public class ArgParser
extends java.lang.Object
A utility class for handling mixed positional and keyword arguments.
A typical usage:
public MatchObject search(PyObject[] args, String[] kws) {
ArgParser ap = new ArgParser("search", args, kws,
"pattern", "pos", "endpos");
String string = ap.getString(0);
int start = ap.getInt(1, 0);
int end = ap.getInt(2, string.length());
...
ArgParser(String funcname, PyObject[] args, String[] kws, String p0) - Create an ArgParser with one method argument
|
ArgParser(String funcname, PyObject[] args, String[] kws, String p0, String p1) - Create an ArgParser with two method argument
|
ArgParser(String funcname, PyObject[] args, String[] kws, String p0, String p1, String p2) - Create an ArgParser with three method argument
|
ArgParser(String funcname, PyObject[] args, String[] kws, String[] paramnames) - Create an ArgParser with three method argument
|
ArgParser(String funcname, PyObject[] args, String[] kws, String[] paramnames, int minargs)
|
int | getInt(int pos) - Return a required argument as an int.
|
int | getInt(int pos, int def) - Return an optional argument as an int.
|
PyObject | getList(int pos) - Return the remaining arguments as a tuple.
|
PyObject | getPyObject(int pos) - Return a required argument as a PyObject.
|
PyObject | getPyObject(int pos, PyObject def) - Return an optional argument as a PyObject.
|
String | getString(int pos) - Return a required argument as a String.
|
String | getString(int pos, String def) - Return an optional argument as a String.
|
ArgParser
public ArgParser(String funcname,
PyObject[] args,
String[] kws,
String p0)
Create an ArgParser with one method argument
funcname
- Name of the method. Used in error messages.args
- The actual call arguments supplied in the call.kws
- The actual keyword names supplied in the call.p0
- The expected argument in the method definition.
ArgParser
public ArgParser(String funcname,
PyObject[] args,
String[] kws,
String p0,
String p1)
Create an ArgParser with two method argument
funcname
- Name of the method. Used in error messages.args
- The actual call arguments supplied in the call.kws
- The actual keyword names supplied in the call.p0
- The first expected argument in the method definition.p1
- The second expected argument in the method definition.
ArgParser
public ArgParser(String funcname,
PyObject[] args,
String[] kws,
String p0,
String p1,
String p2)
Create an ArgParser with three method argument
funcname
- Name of the method. Used in error messages.args
- The actual call arguments supplied in the call.kws
- The actual keyword names supplied in the call.p0
- The first expected argument in the method definition.p1
- The second expected argument in the method definition.p2
- The third expected argument in the method definition.
ArgParser
public ArgParser(String funcname,
PyObject[] args,
String[] kws,
String[] paramnames)
Create an ArgParser with three method argument
funcname
- Name of the method. Used in error messages.args
- The actual call arguments supplied in the call.kws
- The actual keyword names supplied in the call.paramnames
- The list of expected argument in the method definition.
ArgParser
public ArgParser(String funcname,
PyObject[] args,
String[] kws,
String[] paramnames,
int minargs)
getInt
public int getInt(int pos)
Return a required argument as an int.
pos
- The position of the argument. First argument is numbered 0.
getInt
public int getInt(int pos,
int def)
Return an optional argument as an int.
pos
- The position of the argument. First argument is numbered 0.
getList
public PyObject getList(int pos)
Return the remaining arguments as a tuple.
pos
- The position of the argument. First argument is numbered 0.
getPyObject
public PyObject getPyObject(int pos)
Return a required argument as a PyObject.
pos
- The position of the argument. First argument is numbered 0.
getPyObject
public PyObject getPyObject(int pos,
PyObject def)
Return an optional argument as a PyObject.
pos
- The position of the argument. First argument is numbered 0.
getString
public String getString(int pos)
Return a required argument as a String.
pos
- The position of the .. First argument is numbered 0.
getString
public String getString(int pos,
String def)
Return an optional argument as a String.
pos
- The position of the argument. First argument is numbered 0.
Jython homepage