Engine: Improve error message when submitting without broker #6465
Conversation
|
Perhaps the error message would be even better with a link to the docs which gives even more background information and tells users how they can configure the broker. That would require #6455 to be merged before that, because currently those docs don't exist yet. Still, I am always a bit hesitant to add docs links in error messages since they can easily go stale. I know that SQLalchemy solves this somewhat by using shortened urls the referent of which can then be updated with redirects in case the documentation links change. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6465 +/- ##
==========================================
+ Coverage 77.51% 77.76% +0.26%
==========================================
Files 560 561 +1
Lines 41444 41796 +352
==========================================
+ Hits 32120 32500 +380
+ Misses 9324 9296 -28 ☔ View full report in Codecov by Sentry. |
The `aiida.engine.launch.submit` method was just raising a vague `AssertionError` in case the runner did not have a communicator, which is the case if it was constructed without a communicator which in turn happens for profiles that do not configure a broker. Since profiles without brokers are now supported and users are bound to try to submit anyway, the error message should be clearer.
sphuber
force-pushed
the
fix/6374/improve-error-submit-no-broker
branch
from
351c671 to
0d6397f
Compare
…am#6465) The `aiida.engine.launch.submit` method was just raising a vague `AssertionError` in case the runner did not have a communicator, which is the case if it was constructed without a communicator which in turn happens for profiles that do not configure a broker. Since profiles without brokers are now supported and users are bound to try to submit anyway, the error message should be clearer.
Fixes #6374
The
aiida.engine.launch.submitmethod was just raising a vagueAssertionErrorin case the runner did not have a communicator, which is the case if it was constructed without a communicator which in turn happens for profiles that do not configure a broker.Since profiles without brokers are now supported and users are bound to try to submit anyway, the error message should be clearer.