Gracefully handle the case of missing facets required by esmvalcore.io.local.LocalDataSource

[bouweandela]

Description

Do not raise an exception if a facet required by esmvalcore.io.local.LocalDataSource is missing, but log the problem and continue. Maybe the data can be found using some other data source and if not, the user will see the log message.

Closes #2995

Link to documentation:

---

Before you get started

• ☝ Create an issue to discuss what you are going to do

Checklist

It is the responsibility of the author to make sure the pull request is ready to review. The icons indicate whether the item will be subject to the 🛠 Technical or 🧪 Scientific review.

• 🧪 The new functionality is relevant and scientifically sound
• 🛠 This pull request has a descriptive title and labels
• 🛠 Code is written according to the code quality guidelines
• 🧪 and 🛠 Documentation is available
• 🛠 Unit tests have been added
• 🛠 Changes are backward compatible
• 🛠 The list of authors is up to date
• 🛠 All checks below this pull request were successful

---

To help with the number pull requests:

• 🙏 We kindly ask you to review two other open pull requests in this repository

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.70%. Comparing base (69f2019) to head (c64c373).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3021   +/-   ##
=======================================
  Coverage   95.70%   95.70%           
=======================================
  Files         267      267           
  Lines       15768    15786   +18     
=======================================
+ Hits        15090    15108   +18     
  Misses        678      678           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[schlunma]

Great, thanks Bouwe! Works exactly as expected.

I just have some minor comments on the code.

[schlunma]

Any particular reason why you're not putting this into esmvalcore.exceptions?

[bouweandela]

It is intended for internal use in this module. I made it private in c8d9225.

[schlunma]

Is there any public function that raises this exception? I find it always nice when packages make exceptions public in order to catch them.

[bouweandela]

Good point, it's also used by the (deprecated) functionality to get the preprocessor output file name in esmvalcore.local. Let me make sure it's caught there too.

[bouweandela]

Solved in c64c373. There are no more functions left that do not catch the exception if it is raised.

[schlunma]

Are you sure? It looks like _get_glob_patterns is still used in 3 other places (partly deprecated), which can probably be accessed with public functions:

• https://github.com/ESMValGroup/ESMValCore/blob/relax-local-data-source-facet-requirement/esmvalcore/local.py#L167
• https://github.com/ESMValGroup/ESMValCore/blob/relax-local-data-source-facet-requirement/esmvalcore/local.py#L276
• https://github.com/ESMValGroup/ESMValCore/blob/relax-local-data-source-facet-requirement/esmvalcore/cmor/_fixes/icon/_base_fixes.py#L333