จะรับชื่อพารามิเตอร์วิธีได้อย่างไร


236

รับฟังก์ชั่น Python:

def a_method(arg1, arg2):
    pass

ฉันจะแยกจำนวนและชื่อของอาร์กิวเมนต์ได้อย่างไร คือให้ที่ฉันมีการอ้างอิงถึงfuncผมต้องการที่จะกลับมาfunc.[something]("arg1", "arg2")

สถานการณ์การใช้งานสำหรับสิ่งนี้คือฉันมีมัณฑนากรและฉันต้องการใช้อาร์กิวเมนต์เมธอดตามลำดับเดียวกับที่ปรากฏสำหรับฟังก์ชันจริงเป็นคีย์ คือมัณฑนากรจะพิมพ์ออกมา"a,b"เมื่อฉันโทรได้a_method("a", "b")อย่างไร


1
สำหรับรายการคำตอบต่าง ๆ สำหรับคำถามที่เหมือนกันเกือบดูโพสต์ส
แต็คโฟลว์

1
ชื่อของคุณทำให้เข้าใจผิด: เมื่อมีคนพูดว่า 'วิธีการ' wrt คำว่า 'ฟังก์ชั่น' หนึ่งมักจะคิดว่าวิธีการเรียน สำหรับฟังก์ชั่นคำตอบที่คุณเลือก (จาก Jouni K. Seppanen) นั้นดี แต่สำหรับวิธีการเรียน (class) มันไม่ทำงานและควรใช้วิธีการตรวจสอบ (จาก Brian)
Juh_

คำตอบ:


351

ลองดูที่inspectโมดูลซึ่งจะทำการตรวจสอบคุณสมบัติของรหัสวัตถุต่างๆสำหรับคุณ

>>> inspect.getfullargspec(a_method)
(['arg1', 'arg2'], None, None, None)

ผลลัพธ์อื่นคือชื่อของตัวแปร * args และ ** kwargs และค่าเริ่มต้นที่ให้ไว้ กล่าวคือ

>>> def foo(a, b, c=4, *arglist, **keywords): pass
>>> inspect.getfullargspec(foo)
(['a', 'b', 'c'], 'arglist', 'keywords', (4,))

โปรดทราบว่าบาง callables อาจไม่สามารถเข้าใจได้ในการใช้งานบางอย่างของ Python ตัวอย่างเช่นใน CPython ฟังก์ชันในตัวบางอย่างที่กำหนดใน C ไม่ได้ให้ข้อมูลเมตาเกี่ยวกับข้อโต้แย้ง เป็นผลให้คุณจะได้รับValueErrorถ้าคุณใช้inspect.getfullargspec()ในฟังก์ชั่นในตัว

ตั้งแต่ Python 3.3 คุณสามารถใช้inspect.signature()เพื่อดูลายเซ็นการโทรของวัตถุที่เรียกได้:

>>> inspect.signature(foo)
<Signature (a, b, c=4, *arglist, **keywords)>

29
รหัสอาจทราบได้อย่างไรว่าพารามิเตอร์เริ่มต้น(4,)สอดคล้องกับพารามิเตอร์คำหลักcโดยเฉพาะ
fatuhoku

63
@Fatuhoku ฉันสงสัยในสิ่งเดียวกัน ปรากฎว่ามันไม่ชัดเจนเนื่องจากคุณสามารถเพิ่มอาร์กิวเมนต์เริ่มต้นที่ส่วนท้ายในบล็อกที่ต่อเนื่องกันเท่านั้น จากเอกสาร: "ถ้า tuple นี้มีองค์ประกอบ n พวกเขาสอดคล้องกับองค์ประกอบ n ล่าสุดที่ระบุไว้ใน args"
Soverman

9
ฉันคิดว่าตั้งแต่ Python 3.x getargspec (... ) ถูกแทนที่ด้วย inspector.signature (func)
Diego AndrésDíaz Espinoza

2
เปลี่ยนเป็นเวอร์ชั่น 2.6: ส่งคืน tuple ArgSpec ที่มีชื่อ (args, varargs, คำหลัก, ค่าเริ่มต้น)
theannouncer

4
นั่นเป็นสิทธิ @ DiegoAndrésDíazEspinoza - ในหลาม 3 inspect.getargspecจะเลิกinspect.getfullargspecแต่เปลี่ยนเป็น
j08lue

100

ใน CPython จำนวนอาร์กิวเมนต์คือ

a_method.func_code.co_argcount

และชื่อของพวกเขาอยู่ในจุดเริ่มต้นของ

a_method.func_code.co_varnames

นี่เป็นรายละเอียดการใช้งานของ CPython ดังนั้นอาจไม่สามารถใช้งานได้กับการใช้งานอื่น ๆ ของ Python เช่น IronPython และ Jython

วิธีการหนึ่งที่พกพาที่จะยอมรับ "ผ่าน" func(*args, **kwargs)ข้อโต้แย้งคือการกำหนดฟังก์ชั่นของคุณที่มีลายเซ็น มีการใช้สิ่งนี้เป็นจำนวนมากเช่นmatplotlibโดยที่เลเยอร์ API ภายนอกส่งผ่านอาร์กิวเมนต์คำหลักจำนวนมากไปยัง API ระดับล่าง


co_varnames ทำงานร่วมกับ Python มาตรฐานได้ แต่วิธีนี้ไม่เป็นที่นิยมเนื่องจากมันจะแสดงอาร์กิวเมนต์ภายในด้วย
MattK

11
ทำไมไม่ใช้ aMethod.func_code.co_varnames [: aMethod.func_code.co_argcount]?
hochl

ไม่ทำงานกับข้อโต้แย้งหลังจาก*argsเช่น:def foo(x, *args, y, **kwargs): # foo.__code__.co_argcount == 1
Nikolay Makhalin


โปรดใช้การตรวจสอบแทน มิฉะนั้นรหัสของคุณจะทำงานได้ไม่ดีกับ functools.wraps ใน 3.4+ ดูstackoverflow.com/questions/147816/…
Brian McCutchon

22

ในวิธีการมัณฑนากรคุณสามารถแสดงรายการอาร์กิวเมนต์ของวิธีดั้งเดิมด้วยวิธีนี้:

import inspect, itertools 

def my_decorator():

        def decorator(f):

            def wrapper(*args, **kwargs):

                # if you want arguments names as a list:
                args_name = inspect.getargspec(f)[0]
                print(args_name)

                # if you want names and values as a dictionary:
                args_dict = dict(itertools.izip(args_name, args))
                print(args_dict)

                # if you want values as a list:
                args_values = args_dict.values()
                print(args_values)

หาก**kwargsสิ่งที่สำคัญสำหรับคุณก็จะค่อนข้างซับซ้อน:

        def wrapper(*args, **kwargs):

            args_name = list(OrderedDict.fromkeys(inspect.getargspec(f)[0] + kwargs.keys()))
            args_dict = OrderedDict(list(itertools.izip(args_name, args)) + list(kwargs.iteritems()))
            args_values = args_dict.values()

ตัวอย่าง:

@my_decorator()
def my_function(x, y, z=3):
    pass


my_function(1, y=2, z=3, w=0)
# prints:
# ['x', 'y', 'z', 'w']
# {'y': 2, 'x': 1, 'z': 3, 'w': 0}
# [1, 2, 3, 0]

คำตอบนี้ล้าสมัยบางส่วนและควรได้รับการปรับปรุง
Imago

15

ฉันคิดว่าสิ่งที่คุณกำลังมองหาคือวิธีการในท้องถิ่น -


In [6]: def test(a, b):print locals()
   ...: 

In [7]: test(1,2)              
{'a': 1, 'b': 2}

7
นี่คือสิ่งที่ไร้ประโยชน์นอกฟังก์ชั่นซึ่งเป็นบริบทที่น่าสนใจที่นี่ (มัณฑนากร)
Piotr Dobrogost

8
จริงๆแล้วสิ่งที่ฉันกำลังมองหาแม้ว่ามันจะไม่ใช่คำตอบสำหรับคำถามที่นี่
javabeangrinder

15

เวอร์ชั่น Python 3 คือ:

def _get_args_dict(fn, args, kwargs):
    args_names = fn.__code__.co_varnames[:fn.__code__.co_argcount]
    return {**dict(zip(args_names, args)), **kwargs}

เมธอดส่งคืนพจนานุกรมที่มีทั้ง args และ kwargs


โปรดสังเกตว่า[:fn.__code__.co_argcount]สิ่งสำคัญมากถ้าคุณกำลังมองหาอาร์กิวเมนต์ของฟังก์ชัน - มิฉะนั้นจะมีชื่อที่สร้างขึ้นภายในฟังก์ชันด้วย
Soren

13

นี่คือสิ่งที่ฉันคิดว่าจะใช้ได้กับสิ่งที่คุณต้องการโดยใช้มัณฑนากร

class LogWrappedFunction(object):
    def __init__(self, function):
        self.function = function

    def logAndCall(self, *arguments, **namedArguments):
        print "Calling %s with arguments %s and named arguments %s" %\
                      (self.function.func_name, arguments, namedArguments)
        self.function.__call__(*arguments, **namedArguments)

def logwrap(function):
    return LogWrappedFunction(function).logAndCall

@logwrap
def doSomething(spam, eggs, foo, bar):
    print "Doing something totally awesome with %s and %s." % (spam, eggs)


doSomething("beans","rice", foo="wiggity", bar="wack")

เรียกใช้มันจะให้ผลลัพธ์ต่อไปนี้:

C:\scripts>python decoratorExample.py
Calling doSomething with arguments ('beans', 'rice') and named arguments {'foo':
 'wiggity', 'bar': 'wack'}
Doing something totally awesome with beans and rice.

11

Python 3.5+:

DeprecationWarning: inspect.getargspec () เลิกใช้แล้วใช้ inspect.signature () แทน

ดังนั้นก่อนหน้านี้:

func_args = inspect.getargspec(function).args

ขณะนี้:

func_args = list(inspect.signature(function).parameters.keys())

ทดสอบ:

'arg' in list(inspect.signature(function).parameters.keys())

เนื่องจากเรามีฟังก์ชั่น 'ฟังก์ชั่น' ซึ่งรับอาร์กิวเมนต์ 'หาเรื่อง' สิ่งนี้จะประเมินว่าเป็นจริงมิฉะนั้นจะเป็นเท็จ

ตัวอย่างจากคอนโซล Python:

Python 3.6.0 (v3.6.0:41df79263a11, Dec 23 2016, 07:18:10) [MSC v.1900 32 bit (Intel)] on win32
>>> import inspect
>>> 'iterable' in list(inspect.signature(sum).parameters.keys())
True

8

ใน Python 3 + กับSignatureวัตถุในมือวิธีง่ายๆในการรับการแมประหว่างชื่ออาร์กิวเมนต์กับค่าใช้bind()วิธีของลายเซ็น!

ตัวอย่างเช่นนี่คือมัณฑนากรสำหรับพิมพ์แผนที่แบบนั้น:

import inspect

def decorator(f):
    def wrapper(*args, **kwargs):
        bound_args = inspect.signature(f).bind(*args, **kwargs)
        bound_args.apply_defaults()
        print(dict(bound_args.arguments))

        return f(*args, **kwargs)

    return wrapper

@decorator
def foo(x, y, param_with_default="bars", **kwargs):
    pass

foo(1, 2, extra="baz")
# This will print: {'kwargs': {'extra': 'baz'}, 'param_with_default': 'bars', 'y': 2, 'x': 1}

6

นี่เป็นอีกวิธีในการรับพารามิเตอร์ฟังก์ชั่นโดยไม่ต้องใช้โมดูลใด ๆ

def get_parameters(func):
    keys = func.__code__.co_varnames[:func.__code__.co_argcount][::-1]
    sorter = {j: i for i, j in enumerate(keys[::-1])} 
    values = func.__defaults__[::-1]
    kwargs = {i: j for i, j in zip(keys, values)}
    sorted_args = tuple(
        sorted([i for i in keys if i not in kwargs], key=sorter.get)
    )
    sorted_kwargs = {}
    for i in sorted(kwargs.keys(), key=sorter.get):
        sorted_kwargs[i] = kwargs[i]      
    return sorted_args, sorted_kwargs


def f(a, b, c="hello", d="world"): var = a


print(get_parameters(f))

เอาท์พุท:

(('a', 'b'), {'c': 'hello', 'd': 'world'})

2

ส่งคืนรายการชื่ออาร์กิวเมนต์ดูแลส่วนต่างๆและฟังก์ชันปกติ:

def get_func_args(f):
    if hasattr(f, 'args'):
        return f.args
    else:
        return list(inspect.signature(f).parameters)

2

อัปเดตสำหรับคำตอบของ Brian :

หากฟังก์ชันใน Python 3 มีอาร์กิวเมนต์ที่เป็นคำหลักเท่านั้นคุณต้องใช้inspect.getfullargspec:

def yay(a, b=10, *, c=20, d=30):
    pass
inspect.getfullargspec(yay)

อัตราผลตอบแทนนี้:

FullArgSpec(args=['a', 'b'], varargs=None, varkw=None, defaults=(10,), kwonlyargs=['c', 'd'], kwonlydefaults={'c': 20, 'd': 30}, annotations={})

2

ใน python 3 ด้านล่างคือการสร้าง*argsและ**kwargsเข้าสู่ a dict(ใช้OrderedDictสำหรับ python <3.6 เพื่อรักษาdictคำสั่งซื้อ):

from functools import wraps

def display_param(func):
    @wraps(func)
    def wrapper(*args, **kwargs):

        param = inspect.signature(func).parameters
        all_param = {
            k: args[n] if n < len(args) else v.default
            for n, (k, v) in enumerate(param.items()) if k != 'kwargs'
        }
        all_param .update(kwargs)
        print(all_param)

        return func(**all_param)
    return wrapper

1

inspect.signatureช้ามาก วิธีที่เร็วที่สุดคือ

def f(a, b=1, *args, c, d=1, **kwargs):
   pass

f_code = f.__code__
f_code.co_varnames[:f_code.co_argcount + f_code.co_kwonlyargcount]  # ('a', 'b', 'c', 'd')

0

ปรับปรุงเล็กน้อยคำตอบของไบรอัน , มีตอนนี้ย้ายกลับที่ดีของการที่คุณสามารถใช้ในรุ่นเก่าหลาม:inspect.signature funcsigsดังนั้นการตั้งค่าส่วนตัวของฉันจะไป

try:  # python 3.3+
    from inspect import signature
except ImportError:
    from funcsigs import signature

def aMethod(arg1, arg2):
    pass

sig = signature(aMethod)
print(sig)

เพื่อความสนุกหากคุณสนใจที่จะเล่นกับSignatureวัตถุและแม้แต่สร้างฟังก์ชั่นด้วยลายเซ็นแบบสุ่มคุณสามารถดูmakefunโครงการของฉันได้


-3

สิ่งที่เกี่ยวกับdir()และvars()ตอนนี้หรือไม่

ดูเหมือนว่ากำลังทำสิ่งที่ถูกถามอย่างง่ายสุด ๆ ...

ต้องถูกเรียกจากภายในขอบเขตฟังก์ชัน

แต่ระวังให้ดีว่าจะส่งคืนตัวแปรท้องถิ่นทั้งหมดดังนั้นให้แน่ใจว่าได้ทำที่จุดเริ่มต้นของฟังก์ชันหากจำเป็น

นอกจากนี้โปรดทราบว่าตามที่ระบุไว้ในความคิดเห็นสิ่งนี้ไม่อนุญาตให้ทำจากนอกขอบเขต ดังนั้นจึงไม่ตรงกับสถานการณ์ของ OP แต่ยังคงตรงกับชื่อคำถาม ดังนั้นคำตอบของฉัน


dir () ส่งคืนรายการชื่อตัวแปรทั้งหมด ['var1', 'var2'], vars () ส่งคืนพจนานุกรมในรูปแบบ {'var1': 0, 'var2': 'some'} จากภายในขอบเขตท้องถิ่นปัจจุบัน หากมีคนต้องการใช้ชื่อตัวแปรอากิวเมนต์ในฟังก์ชั่นในภายหลังพวกเขาควรบันทึกในตัวแปรท้องถิ่นอื่นเนื่องจากการเรียกในภายหลังในฟังก์ชันที่พวกเขาสามารถประกาศตัวแปรท้องถิ่นอื่นจะ "ปนเปื้อน" รายการนี้ ในกรณีที่พวกเขาต้องการใช้มันนอกฟังก์ชั่นพวกเขาจะต้องเรียกใช้ฟังก์ชั่นอย่างน้อยหนึ่งครั้งและบันทึกไว้ในตัวแปรทั่วโลก ดังนั้นจะดีกว่าถ้าใช้โมดูลตรวจสอบ
Peter Majko
โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.