ITADN

Replace Mutable Default Parameters

#279Pull Requestcitizenjosh 创建于 2024-02-29
C
citizenjoshcommented
Using mutable values for default arguments is not a safe practice. Look at the following very simple example code: ```python def foo(x, y=[]): y.append(x) print(y) ``` The function `foo` doesn't do anything very interesting; it just prints the result of `x` appended to `y`. Naively we might expect this to simply print an array containing only `x` every time `foo` is called, like this: ```python >>> foo(1) [1] >>> foo(2) [2] ``` But that's not what happens! ```python >>> foo(1) [1] >>> foo(2) [1, 2] ``` The value of `y` is preserved between calls! This might seem surprising, and it is. It's due to the way that scope works for function arguments in Python. The result is that any default argument value will be preserved between function calls. This is problematic for *mutable* types, including things like `list`, `dict`, and `set`. Relying on this behavior is unpredictable and generally considered to be unsafe. Most of us who write code like this were not anticipating the surprising behavior, so it's best to fix it. Our codemod makes an update that looks like this: ```diff - def foo(x, y=[]): + def foo(x, y=None): + y = [] if y is None else y y.append(x) print(y) ``` Using `None` is a much safer default. The new code checks if `None` is passed, and if so uses an empty `list` for the value of `y`. This will guarantee consistent and safe behavior between calls. <details> <summary>More reading</summary> </details> I have additional improvements ready for this repo! If you want to see them, leave the comment: ``` @pixeebot next ``` ... and I will open a new PR right away! Powered by: [pixeebot](https://docs.pixee.ai/) (codemod ID: [pixee:python/fix-mutable-params](https://docs.pixee.ai/codemods/python/pixee_python_fix-mutable-params)) ![](https://d1zaessa2hpsmj.cloudfront.net/pixel/v1/track?writeKey=2PI43jNm7atYvAuK7rJUz3Kcd6A&event=DRIP_PR%7Ccitizenjosh%2FAmpliGraph%7Ceadf9173d3190d1c02abfaa1ca41c5d427e4c116) <!--{"type":"DRIP","codemod":"pixee:python/fix-mutable-params"}-->
合并状态:未合并 关闭于 2024-12-10 0 条评论