Incorrect signature of CodeType.replace()

[serhiy-storchaka]

BPO	42291
Nosy	@vstinner, @larryhastings, @serhiy-storchaka, @1st1
PRs	gh-86457: Fix signature for code.replace(). #23199

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2020-11-08.10:38:14.301>
labels = ['type-bug', '3.8', '3.9', '3.10', 'library', 'expert-argument-clinic']
title = 'Incorrect signature of CodeType.replace()'
updated_at = <Date 2020-11-09.14:46:09.424>
user = 'https://github.com/serhiy-storchaka'

bugs.python.org fields:

activity = <Date 2020-11-09.14:46:09.424>
actor = 'vstinner'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)', 'Argument Clinic']
creation = <Date 2020-11-08.10:38:14.301>
creator = 'serhiy.storchaka'
dependencies = []
files = []
hgrepos = []
issue_num = 42291
keywords = ['patch']
message_count = 2.0
messages = ['380545', '380587']
nosy_count = 4.0
nosy_names = ['vstinner', 'larry', 'serhiy.storchaka', 'yselivanov']
pr_nums = ['23199']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue42291'
versions = ['Python 3.8', 'Python 3.9', 'Python 3.10']

Linked PRs

• [3.12] gh-86457: Fix signature for code.replace() (GH-23199) #107744
• [3.11] gh-86457: Fix signature for code.replace() (GH-23199) #107746
• gh-86457: Add docs for Argument Clinic @text_signature directive #107747
• [3.11] gh-86457: Add docs for Argument Clinic @text_signature directive (#107747) #107799

[serhiy-storchaka]

Currently the signature of types.CodeType.replace() is

replace(self, /, *, co_argcount=-1, co_posonlyargcount=-1, co_kwonlyargcount=-1, co_nlocals=-1, co_stacksize=-1, co_flags=-1, co_firstlineno=-1, co_code=None, co_consts=None, co_names=None, co_varnames=None, co_freevars=None, co_cellvars=None, co_filename=None, co_name=None, co_lnotab=None)

But -1 and None are incorrect values for many parameters, and even if they would be correct, they are not default values. By default, if you do not specify some argument, the value of the corresponding attribute would not be changed.

Argument Clinic and the inspect module do not support this case.

[vstinner]

Argument Clinic and the inspect module do not support this case.

That's why I used -1 and None.

But -1 and None are incorrect values for many parameters, and even if they would be correct, they are not default values. By default, if you do not specify some argument, the value of the corresponding attribute would not be changed.

If you consider that this issue matters, you may hack the code to accept None as if no parameter was passed (pass NULL).