Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix automatic reader table not listing readers with missing dependencies #2191

Merged
merged 6 commits into from Aug 25, 2022
Merged

Fix automatic reader table not listing readers with missing dependencies #2191

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b751649
refactor: add yaml loader as argument to available_readers
Aug 23, 2022
ec971f9
refactor: move table summary to top of table
Aug 23, 2022
80f2a1d
refactor: bump required pyyaml version
Aug 23, 2022
86448f4
test: add test for available_readers with BaseLoader
Aug 24, 2022
361263c
refactor: add another reader name to check
Aug 24, 2022
3406026
doc: add loader type argument to docstring
Aug 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 6 additions & 1 deletion doc/source/reader_table.py
View file
Open in desktop
Expand Up @@ -20,6 +20,11 @@

from satpy.readers import available_readers

try:
from yaml import BaseLoader
except ImportError:
from yaml import BaseLoader # type: ignore
djhoese marked this conversation as resolved.
Show resolved Hide resolved


def rst_table_row(columns=None):
"""Create one row for a rst table.
Expand Down Expand Up @@ -72,7 +77,7 @@ def generate_reader_table():
table = [rst_table_header("Satpy Readers", header=["Description", "Reader name", "Status", "fsspec support"],
widths=[45, 25, 30, 30])]

reader_configs = available_readers(as_dict=True)
reader_configs = available_readers(as_dict=True, yaml_loader=BaseLoader)
for rc in reader_configs:
table.append(rst_table_row([rc.get("long_name", "").rstrip("\n"), rc.get("name", ""),
rc.get("status", ""), rc.get("supports_fsspec", "false")]))
Expand Down
4 changes: 2 additions & 2 deletions satpy/readers/__init__.py
View file
Open in desktop
Expand Up @@ -370,7 +370,7 @@ def get_valid_reader_names(reader):
return new_readers


def available_readers(as_dict=False):
def available_readers(as_dict=False, yaml_loader=UnsafeLoader):
djhoese marked this conversation as resolved.
Show resolved Hide resolved
djhoese marked this conversation as resolved.
Show resolved Hide resolved
"""Available readers based on current configuration.

Args:
Expand All @@ -385,7 +385,7 @@ def available_readers(as_dict=False):
readers = []
for reader_configs in configs_for_reader():
try:
reader_info = read_reader_config(reader_configs)
reader_info = read_reader_config(reader_configs, loader=yaml_loader)
except (KeyError, IOError, yaml.YAMLError):
LOG.debug("Could not import reader config from: %s", reader_configs)
LOG.debug("Error loading YAML", exc_info=True)
Expand Down