PyYAML requires Loader to be specified #5554

New Issue

adam · 2025-12-29T19:29:22+01:00

adam commented

2025-12-29 19:29:22 +01:00

Originally created by @hagbarddenstore on GitHub (Oct 25, 2021).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v3.0.8

Python version

3.9

Steps to Reproduce

Run any script that calls load_yaml

Expected Behavior

The script should run without raising exceptions.

Observed Behavior

The script raises the following exception:

Traceback (most recent call last):
  File "/opt/netbox/netbox-0266ed5ce49534a388966caff5a7c0a2a47f23bd/netbox/extras/scripts.py", line 425, in _run_script
    script.output = script.run(data=data, commit=commit)
  File "/opt/netbox/netbox-0266ed5ce49534a388966caff5a7c0a2a47f23bd/netbox/scripts/my_script.py", line 145, in run
    config = self.load_yaml('my_script.yml')
  File "/opt/netbox/netbox-0266ed5ce49534a388966caff5a7c0a2a47f23bd/netbox/extras/scripts.py", line 350, in load_yaml
    data = yaml.load(datafile)
TypeError: load() missing 1 required positional argument: 'Loader'

Originally created by @hagbarddenstore on GitHub (Oct 25, 2021). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v3.0.8 ### Python version 3.9 ### Steps to Reproduce 1. Run any script that calls load_yaml ### Expected Behavior The script should run without raising exceptions. ### Observed Behavior The script raises the following exception: ``` Traceback (most recent call last): File "/opt/netbox/netbox-0266ed5ce49534a388966caff5a7c0a2a47f23bd/netbox/extras/scripts.py", line 425, in _run_script script.output = script.run(data=data, commit=commit) File "/opt/netbox/netbox-0266ed5ce49534a388966caff5a7c0a2a47f23bd/netbox/scripts/my_script.py", line 145, in run config = self.load_yaml('my_script.yml') File "/opt/netbox/netbox-0266ed5ce49534a388966caff5a7c0a2a47f23bd/netbox/extras/scripts.py", line 350, in load_yaml data = yaml.load(datafile) TypeError: load() missing 1 required positional argument: 'Loader' ```

adam added the type: bug status: accepted labels 2025-12-29 19:29:22 +01:00

adam closed this issue

2025-12-29 19:29:22 +01:00

adam commented

2025-12-29 19:29:22 +01:00

@hagbarddenstore commented on GitHub (Oct 25, 2021):

Version 6.0 of PyYAML now requires that Loader be specified.

See this: c2743653bc (diff-642dbe3636af0ba5a6a20f0c346eeef2304a98ec91a7f609f6b29894a77127a8L103)

@hagbarddenstore commented on GitHub (Oct 25, 2021): Version 6.0 of PyYAML now requires that Loader be specified. See this: https://github.com/yaml/pyyaml/commit/c2743653bc89e42679ba097b4f9888db47c61d63#diff-642dbe3636af0ba5a6a20f0c346eeef2304a98ec91a7f609f6b29894a77127a8L103

adam commented

2025-12-29 19:29:22 +01:00

@hagbarddenstore commented on GitHub (Oct 25, 2021):

A workaround is to add the following at the top of netbox/extras/scripts.py:

try:
    from yaml import CLoader as Loader
except ImportError:
    from yaml import Loader

Then modify load_yaml to this:

def load_yaml(self, filename):
    """
    Return data from a YAML file
    """
    file_path = os.path.join(settings.SCRIPTS_ROOT, filename)
    with open(file_path, 'r') as datafile:
        data = yaml.load(datafile, Loader=Loader)

    return data

@hagbarddenstore commented on GitHub (Oct 25, 2021): A workaround is to add the following at the top of `netbox/extras/scripts.py`: ```python try: from yaml import CLoader as Loader except ImportError: from yaml import Loader ``` Then modify `load_yaml` to this: ```python def load_yaml(self, filename): """ Return data from a YAML file """ file_path = os.path.join(settings.SCRIPTS_ROOT, filename) with open(file_path, 'r') as datafile: data = yaml.load(datafile, Loader=Loader) return data ```

adam commented

2025-12-29 19:29:23 +01:00

@jeremystretch commented on GitHub (Oct 25, 2021):

Thanks @hagbarddenstore, not sure how I missed that in the package's release notes. 😞

* https://github.com/yaml/pyyaml/pull/561 -- always require `Loader` arg to `yaml.load()`

Also, we need to add a test for this.

@jeremystretch commented on GitHub (Oct 25, 2021): Thanks @hagbarddenstore, not sure how I missed that in the package's release notes. :disappointed: ``` * https://github.com/yaml/pyyaml/pull/561 -- always require `Loader` arg to `yaml.load()` ``` Also, we need to add a test for this.

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#5554