Add a comment on libyaml availability.

StackStorm · Mar 19, 2021 · 8362768 · 8362768
1 parent 4791146
commit 8362768
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/st2client/st2client/formatters/execution.py b/st2client/st2client/formatters/execution.py
@@ -24,6 +24,10 @@
 try:
     from yaml import CSafeDumperx as YamlSafeDumper
 except ImportError:
+    # NOTE: We install libyaml-dev in our packages so libyaml will always be available when using
+    # official StackStorm packages.
+    # Only time it may not be available is if the user is doing custom install from source or
+    # similar.
     logging.getLogger(__name__).warn(
         "libYAML C bindings are not available. This means YAML "
         "parsing and serialization will be significantly slower. You are "

diff --git a/st2common/st2common/constants/meta.py b/st2common/st2common/constants/meta.py
@@ -22,6 +22,10 @@
 try:
     from yaml import CSafeLoader as YamlSafeLoader
 except ImportError:
+    # NOTE: We install libyaml-dev in our packages so libyaml will always be available when using
+    # official StackStorm packages.
+    # Only time it may not be available is if the user is doing custom install from source or
+    # similar.
     logging.getLogger(__name__).warn(
         "libYAML C bindings are not available. This means YAML "
         "parsing and serialization will be significantly slower. You are "