swig/Examples/test-suite/python/autodoc_runme.py

from autodoc import *
import commentVerifier
import sys

def check(got, expected, expected_builtin=None, skip=False):
    if not skip:
        expect = expected
        if is_python_builtin() and expected_builtin != None:
            expect = expected_builtin
        commentVerifier.check(got, expect)

def is_new_style_class(cls):
    return hasattr(cls, "__class__")

if not is_new_style_class(A):
    # Missing static methods make this hard to test... skip if -classic is
    # used!
    sys.exit(0)

# skip builtin check - the autodoc is missing, but it probably should not be
skip = True

check(A.__doc__, "Proxy of C++ A class", "::A")
check(A.funk.__doc__, "just a string")
check(A.func0.__doc__, "func0(self, arg2, hello) -> int")
check(A.func1.__doc__, "func1(A self, short arg2, Tuple hello) -> int")
check(A.func2.__doc__,
      "func2(self, arg2, hello) -> int\n"
      "\n"
      "Parameters:\n"
      "    arg2: short\n"
      "    hello: int tuple[2]\n"
      )
check(A.func3.__doc__,
      "func3(A self, short arg2, Tuple hello) -> int\n"
      "\n"
      "Parameters:\n"
      "    arg2: short\n"
      "    hello: int tuple[2]\n"
      )

check(A.func0default.__doc__,
      "func0default(self, e, arg3, hello, f=2) -> int\n"
      "func0default(self, e, arg3, hello) -> int"
      )
check(A.func1default.__doc__,
      "func1default(A self, A e, short arg3, Tuple hello, double f=2) -> int\n"
      "func1default(A self, A e, short arg3, Tuple hello) -> int"
      )
check(A.func2default.__doc__,
      "func2default(self, e, arg3, hello, f=2) -> int\n"
      "\n"
      "Parameters:\n"
      "    e: A *\n"
      "    arg3: short\n"
      "    hello: int tuple[2]\n"
      "    f: double\n"
      "\n"
      "func2default(self, e, arg3, hello) -> int\n"
      "\n"
      "Parameters:\n"
      "    e: A *\n"
      "    arg3: short\n"
      "    hello: int tuple[2]\n"
      )
check(A.func3default.__doc__,
      "func3default(A self, A e, short arg3, Tuple hello, double f=2) -> int\n"
      "\n"
      "Parameters:\n"
      "    e: A *\n"
      "    arg3: short\n"
      "    hello: int tuple[2]\n"
      "    f: double\n"
      "\n"
      "func3default(A self, A e, short arg3, Tuple hello) -> int\n"
      "\n"
      "Parameters:\n"
      "    e: A *\n"
      "    arg3: short\n"
      "    hello: int tuple[2]\n"
      )

check(A.func0static.__doc__,
      "func0static(e, arg2, hello, f=2) -> int\n"
      "func0static(e, arg2, hello) -> int"
      )
check(A.func1static.__doc__,
      "func1static(A e, short arg2, Tuple hello, double f=2) -> int\n"
      "func1static(A e, short arg2, Tuple hello) -> int"
      )
check(A.func2static.__doc__,
      "func2static(e, arg2, hello, f=2) -> int\n"
      "\n"
      "Parameters:\n"
      "    e: A *\n"
      "    arg2: short\n"
      "    hello: int tuple[2]\n"
      "    f: double\n"
      "\n"
      "func2static(e, arg2, hello) -> int\n"
      "\n"
      "Parameters:\n"
      "    e: A *\n"
      "    arg2: short\n"
      "    hello: int tuple[2]\n"
      )
check(A.func3static.__doc__,
      "func3static(A e, short arg2, Tuple hello, double f=2) -> int\n"
      "\n"
      "Parameters:\n"
      "    e: A *\n"
      "    arg2: short\n"
      "    hello: int tuple[2]\n"
      "    f: double\n"
      "\n"
      "func3static(A e, short arg2, Tuple hello) -> int\n"
      "\n"
      "Parameters:\n"
      "    e: A *\n"
      "    arg2: short\n"
      "    hello: int tuple[2]\n"
      )

if sys.version_info[0:2] > (2, 4):
    # Python 2.4 does not seem to work
    check(A.variable_a.__doc__,
          "A_variable_a_get(self) -> int",
          "A.variable_a"
          )
    check(A.variable_b.__doc__,
          "A_variable_b_get(A self) -> int",
          "A.variable_b"
          )
    check(A.variable_c.__doc__,
          "A_variable_c_get(self) -> int\n"
          "\n"
          "Parameters:\n"
          "    self: A *\n",
          "A.variable_c"
          )
    check(A.variable_d.__doc__,
          "A_variable_d_get(A self) -> int\n"
          "\n"
          "Parameters:\n"
          "    self: A *\n",
          "A.variable_d"
          )

check(B.__doc__,
      "Proxy of C++ B class",
      "::B"
      )
check(C.__init__.__doc__, "__init__(self, a, b, h) -> C", None, skip)
check(D.__init__.__doc__,
      "__init__(D self, int a, int b, Hola h) -> D", None, skip)
check(E.__init__.__doc__,
      "__init__(self, a, b, h) -> E\n"
      "\n"
      "Parameters:\n"
      "    a: special comment for parameter a\n"
      "    b: another special comment for parameter b\n"
      "    h: enum Hola\n",
      None, skip
      )
check(F.__init__.__doc__,
      "__init__(F self, int a, int b, Hola h) -> F\n"
      "\n"
      "Parameters:\n"
      "    a: special comment for parameter a\n"
      "    b: another special comment for parameter b\n"
      "    h: enum Hola\n",
      None, skip
      )

check(B.funk.__doc__, "funk(B self, int c, int d) -> int")
check(funk.__doc__, "funk(A e, short arg2, int c, int d) -> int")
check(funkdefaults.__doc__,
      "funkdefaults(A e, short arg2, int c, int d, double f=2) -> int\n"
      "funkdefaults(A e, short arg2, int c, int d) -> int"
      )

check(func_input.__doc__, "func_input(int * INPUT) -> int")
check(func_output.__doc__, "func_output() -> int")
check(func_inout.__doc__, "func_inout(int * INOUT) -> int")
check(banana.__doc__, "banana(S a, S b, int c, Integer d)")