if the folder doesn't exist

[AminTorabi-NOAA]

In the current implementation, if the user specifies a directory for stream_output_directory (e.g., output/) that doesn't exist, it results in an error. With the new PR, the code automatically creates the specified directory if it doesn't exist, allowing the output to be saved in that folder without any issues.

Additions

Removals

Changes

Testing

Screenshots

Notes

Todos

Checklist

• PR has an informative and human-readable title
• Changes are limited to a single goal (no scope creep)
• Code can be automatically merged (no conflicts)
• Code follows project standards (link if applicable)
• Passes all existing automated tests
• Any change in functionality is tested
• New functions are documented (with a description, list of inputs, and expected output)
• Placeholder code is flagged / future todos are captured in comments
• Visually tested in supported browsers and devices (see checklist below 👇)
• Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
• Reviewers requested with the Reviewers tool ➡️

Testing checklist

Target Environment support

• Windows
• Linux
• Browser

Accessibility

• Keyboard friendly
• Screen reader friendly

Other

• Is useable without CSS
• Is useable without JS
• Flexible from small to large screens
• No linting errors or warnings
• JavaScript tests are passing

[aaraney]

Thanks for writing this up, @AminTorabi-NOAA! I left a few change requests that cover a few possible edge cases. Once these have been added, we should be good to go! Thanks again!

[aaraney]

Let's still require if this exists, that it is a pathlib.Path object.

Suggested change

	stream_output_directory: Optional[str] = None
	stream_output_directory: Optional[Path] = None

[aaraney]

A few minor improvements:

• We only need to validate after pydantic has coerced the input into a pathlib.Path (drop pre=True and always=True)
• Handle if we got an unexpanded path (e.g. ~/output/dir)
• Raise if we got a file
• Create dir if it doesn't exist, and all intermediate directories

    @validator('stream_output_directory')
    def validate_stream_output_directory(cls, value):
        if value is None:
            return None
            
        # expand ~/output/dir -> /home/user/output/dir
        value = value.expanduser()
        
        if value.exists() and not value.is_dir():
            raise ValueError(f"'stream_output_directory'={value!s} is a file, expected directory.")

        # make directory (and intermediates) if they don't exist
        value.mkdir(parents=True, exist_ok=True)
        return value

[aaraney]

This can be dropped.

[AminTorabi-NOAA]

I addressed all. Thanks for the comments @aaraney

[aaraney]

Looks great! Thanks @AminTorabi-NOAA! 🎉