SG-39809 Bump ruamel.yaml to 0.18.14 (#1049)

* Bump ruamel.yaml to 0.18.14

* Fix import. Remove whitespace from fixture.

* Fix linebreak that broke the `yaml_add_eol_comment`

* Add instructions for upgrading ruamel.yaml

* Control append path to `sys.path`

Author: carlos-villavicencio-adsk

developer/README.md

@@ -15,6 +15,19 @@ cd tk-core/developer
 python upgrade_pyyaml.py
 ```
 
+## How to upgrade ruamel.yaml
+
+Until version `0.10.10`, the contents of the library was located at `tank_vendor/ruamel_yaml`.
+However, starting from `0.18.14`, we had to change it to `tank_vendor/ruamel/yaml`.
+
+Just to confirm, the contents of the PIP package should be placed in `tank_vendor`.
+
+```bash
+pip install ruamel.yaml -t path/to/tank_vendor
+```
+
+Then, let's remove all undesired directories and files, just leave the `ruamel` directory.
+We can automate this task later.
 
 ## The requirements.txt file
 

developer/requirements.txt

@@ -10,5 +10,5 @@
 distro==1.4.0
 ordereddict==1.1
 pyyaml==5.4.1
-ruamel_yaml==0.10.10
+ruamel_yaml==0.18.14
 six==1.13.0

python/tank/platform/environment.py

@@ -833,6 +833,16 @@ def __init__(self, env_path, pipeline_config, context=None):
         self.set_yaml_preserve_mode(True)
         super().__init__(env_path, pipeline_config, context)
 
+    def _get_ruamel_yaml(self):
+        vendor_path  = os.path.join(os.path.dirname(__file__), "../..", "tank_vendor")
+
+        if vendor_path not in sys.path:
+            sys.path.append(vendor_path)
+
+        from tank_vendor.ruamel import yaml as ruamel_yaml
+
+        return ruamel_yaml
+
     def __load_writable_yaml(self, path):
         """
         Loads yaml data from disk.
@@ -857,9 +867,9 @@ def __load_writable_yaml(self, path):
                 # which also holds the additional contextual metadata
                 # required by the parse to maintain the lexical integrity
                 # of the content.
-                from tank_vendor import ruamel_yaml
+                ruamel_yaml = self._get_ruamel_yaml()
 
-                yaml_data = ruamel_yaml.load(fh, ruamel_yaml.RoundTripLoader)
+                yaml_data = ruamel_yaml.YAML(typ="rt").load(fh)
             else:
                 # use pyyaml parser
                 yaml_data = yaml.load(fh, Loader=yaml.FullLoader)
@@ -930,14 +940,9 @@ def __write_data_file(self, fh, data):
                 # note that safe_dump is not needed when using the
                 # roundtrip dumper, it will adopt a 'safe' behaviour
                 # by default.
-                from tank_vendor import ruamel_yaml
+                ruamel_yaml = self._get_ruamel_yaml()
 
-                ruamel_yaml.dump(
-                    data,
-                    fh,
-                    default_flow_style=False,
-                    Dumper=ruamel_yaml.RoundTripDumper,
-                )
+                ruamel_yaml.YAML(typ="rt").dump(data, fh)
             else:
                 # use pyyaml parser
                 #