mirror of
https://github.com/netbox-community/netbox.git
synced 2025-07-14 01:41:22 -06:00
Closes #4941: commit argument is now required argument in a custom script's run() method
This commit is contained in:
parent
e02590ac96
commit
2339fe22ae
@ -1 +1 @@
|
|||||||
version-2.9.md
|
version-2.10.md
|
7
docs/release-notes/version-2.10.md
Normal file
7
docs/release-notes/version-2.10.md
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
# NetBox v2.10
|
||||||
|
|
||||||
|
## v2.10-beta1 (FUTURE)
|
||||||
|
|
||||||
|
### Other Changes
|
||||||
|
|
||||||
|
* [#4941](https://github.com/netbox-community/netbox/issues/4941) - `commit` argument is now required argument in a custom script's `run()` method
|
@ -428,24 +428,11 @@ def run_script(data, request, commit=True, *args, **kwargs):
|
|||||||
# Add the current request as a property of the script
|
# Add the current request as a property of the script
|
||||||
script.request = request
|
script.request = request
|
||||||
|
|
||||||
# TODO: Drop backward-compatibility for absent 'commit' argument in v2.10
|
|
||||||
# Determine whether the script accepts a 'commit' argument (this was introduced in v2.7.8)
|
|
||||||
kwargs = {
|
|
||||||
'data': data
|
|
||||||
}
|
|
||||||
if 'commit' in inspect.signature(script.run).parameters:
|
|
||||||
kwargs['commit'] = commit
|
|
||||||
else:
|
|
||||||
warnings.warn(
|
|
||||||
f"The run() method of script {script} should support a 'commit' argument. This will be required beginning "
|
|
||||||
f"with NetBox v2.10."
|
|
||||||
)
|
|
||||||
|
|
||||||
with change_logging(request):
|
with change_logging(request):
|
||||||
|
|
||||||
try:
|
try:
|
||||||
with transaction.atomic():
|
with transaction.atomic():
|
||||||
script.output = script.run(**kwargs)
|
script.output = script.run(data=data, commit=commit)
|
||||||
job_result.set_status(JobResultStatusChoices.STATUS_COMPLETED)
|
job_result.set_status(JobResultStatusChoices.STATUS_COMPLETED)
|
||||||
|
|
||||||
if not commit:
|
if not commit:
|
||||||
|
Loading…
Reference in New Issue
Block a user