获取Python中内置函数的参数(arg)计数

时间:2018-02-01 16:54:20

标签: python python-3.x python-2.7 parameters

我为Python编写了自己的c-module,在文档中编写了自定义表我需要运行时内置函数的参数数量

Python 2中有一些函数,如inspect.getargspec或Python 3中的函数,如inspect.signature,它们支持普通的Python函数,但不支持内置函数。

到目前为止,还有其他两种社区解决方案:

  • 解析doc-strings
  • 解析原始* .c文件
  • 查看第三种方法的答案

在某些情况下,文档字符串已过时和/或提取参数计数很困难,因为docstring可以是任何纯字符串。解析原始* .c文件也是一种很好的方法,但您可能无法访问它。

1 个答案:

答案 0 :(得分:2)

以下是我为Python 2和3提出的工作解决方案。

它做了什么?

在运行期间,99 None对象的列表将传递给相应的函数。内部解析函数PyArg_ParseTuple中的第一个检查之一检查参数的数量是否与传递的参数数量相匹配 - 如果不匹配则会失败。这意味着我们将调用该函数,但我们也可以确定它没有真正执行。

技术背景:

为什么要获取内置函数的参数计数如此困难?问题是参数列表是在运行时评估的,而不是编译时。 C中内置函数的一个非常简单的示例如下所示:

static PyObject* example(PyObject *self, PyObject *args)
{
    int myFirstParam;
    if(!PyArg_ParseTuple(args, "i", &myFirstParam))
        return NULL;
    ...
}

复制并粘贴解决方案:

import inspect
import time
import re
import types
import sys


def get_parameter_count(func):
    """Count parameter of a function.

    Supports Python functions (and built-in functions).
    If a function takes *args, then -1 is returned

    Example:
        import os
        arg = get_parameter_count(os.chdir)
        print(arg)  # Output: 1

    -- For C devs:
    In CPython, some built-in functions defined in C provide
    no metadata about their arguments. That's why we pass a
    list with 999 None objects (randomly choosen) to it and
    expect the underlying PyArg_ParseTuple fails with a
    corresponding error message.
    """

    # If the function is a builtin function we use our
    # approach. If it's an ordinary Python function we
    # fallback by using the the built-in extraction
    # functions (see else case), otherwise
    if isinstance(func, types.BuiltinFunctionType):
        try:
            arg_test = 999
            s = [None] * arg_test
            func(*s)
        except TypeError as e:
            message = str(e)
            found = re.match(
                r"[\w]+\(\) takes ([0-9]{1,3}) positional argument[s]* but " +
                str(arg_test) + " were given", message)
            if found:
                return int(found.group(1))

            if "takes no arguments" in message:
                return 0
            elif "takes at most" in message:
                found = re.match(
                    r"[\w]+\(\) takes at most ([0-9]{1,3}).+", message)
                if found:
                    return int(found.group(1))
            elif "takes exactly" in message:
                # string can contain 'takes 1' or 'takes one',
                # depending on the Python version
                found = re.match(
                    r"[\w]+\(\) takes exactly ([0-9]{1,3}|[\w]+).+", message)
                if found:
                    return 1 if found.group(1) == "one" \
                            else int(found.group(1))
        return -1  # *args
    else:
        try:
            if (sys.version_info > (3, 0)):
                argspec = inspect.getfullargspec(func)
            else:
                argspec = inspect.getargspec(func)
        except:
            raise TypeError("unable to determine parameter count")

        return -1 if argspec.varargs else len(argspec.args)



def print_get_parameter_count(mod):
    for x in dir(mod):
        e = mod.__dict__.get(x)
        if isinstance(e, types.BuiltinFunctionType):
            print("{}.{} takes {} argument(s)".format(mod.__name__, e.__name__, get_parameter_count(e)))

import os
print_get_parameter_count(os)

<强>输出:

os._exit takes 1 argument(s)
os.abort takes 0 argument(s)
os.access takes 2 argument(s)
os.chdir takes 1 argument(s)
os.chmod takes 2 argument(s)
os.close takes 1 argument(s)
...