Просмотр исходного кода

Merge pull request #3360 from bfirsh/better-validation-error-messages

Make validation errors less robotic
Daniel Nephin 10 лет назад
Родитель
Сommit
ac82597ac1
2 измененных файлов с 8 добавлено и 7 удалено
  1. 5 4
      compose/config/errors.py
  2. 3 3
      compose/config/validation.py

+ 5 - 4
compose/config/errors.py

@@ -3,10 +3,11 @@ from __future__ import unicode_literals
 
 
 
 
 VERSION_EXPLANATION = (
 VERSION_EXPLANATION = (
-    'Either specify a version of "2" (or "2.0") and place your service '
-    'definitions under the `services` key, or omit the `version` key and place '
-    'your service definitions at the root of the file to use version 1.\n'
-    'For more on the Compose file format versions, see '
+    'You might be seeing this error because you\'re using the wrong Compose '
+    'file version. Either specify a version of "2" (or "2.0") and place your '
+    'service definitions under the `services` key, or omit the `version` key '
+    'and place your service definitions at the root of the file to use '
+    'version 1.\nFor more on the Compose file format versions, see '
     'https://docs.docker.com/compose/compose-file/')
     'https://docs.docker.com/compose/compose-file/')
 
 
 
 

+ 3 - 3
compose/config/validation.py

@@ -219,7 +219,7 @@ def handle_error_for_schema_with_id(error, path):
             return get_unsupported_config_msg(path, invalid_config_key)
             return get_unsupported_config_msg(path, invalid_config_key)
 
 
         if not error.path:
         if not error.path:
-            return '{}\n{}'.format(error.message, VERSION_EXPLANATION)
+            return '{}\n\n{}'.format(error.message, VERSION_EXPLANATION)
 
 
 
 
 def handle_generic_error(error, path):
 def handle_generic_error(error, path):
@@ -416,6 +416,6 @@ def handle_errors(errors, format_error_func, filename):
 
 
     error_msg = '\n'.join(format_error_func(error) for error in errors)
     error_msg = '\n'.join(format_error_func(error) for error in errors)
     raise ConfigurationError(
     raise ConfigurationError(
-        "Validation failed{file_msg}, reason(s):\n{error_msg}".format(
-            file_msg=" in file '{}'".format(filename) if filename else "",
+        "The Compose file{file_msg} is invalid because:\n{error_msg}".format(
+            file_msg=" '{}'".format(filename) if filename else "",
             error_msg=error_msg))
             error_msg=error_msg))