Raise an error on "#" char in config value

Most yo users don't need a "#" character in their configuration, and
raising an error when this is detected will help avoid a common error
for new users. But to be safe, include a config option to bypass this
error when necessary.

Signed-off-by: Stephen Brennan <stephen.s.brennan@oracle.com>

Author: brenns10

doc/guide/configuration.rst

@@ -370,6 +370,18 @@ viewed in the documentation for ``-x`` in :ref:`yo_list`.
 You can override this on the command line with ``yo list -C Col1,Col2`` and you
 can extend the list on the command line with ``yo list -x Col1``.
 
+``allow_hash_in_config_value``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+(Boolean, Optional, Default: false)
+
+By default, Yo detects the '#' character within a configuration value, and
+raises an error, becaues this is a common mistake for users. The '#' character
+can only introduce a comment at the beginning of a line. If you use it after a
+config value, it is included in the resulting value, which is usually not what
+you want. However, if there is some case where you actually want to include a
+hash in the config, set this to true to bypass the error.
+
 .. _regionconf:
 
 Region-Specific Configurations

yo/api.py

@@ -56,6 +56,7 @@
 from yo.util import check_args_dataclass
 from yo.util import current_yo_version
 from yo.util import fmt_allow_deny
+from yo.util import hasherr
 from yo.util import latest_yo_version
 from yo.util import one
 from yo.util import standardize_name
@@ -219,8 +220,14 @@ def create_arg_dict(self, ctx: "YoCtx") -> t.Dict[str, t.Any]:
         }
 
     @staticmethod
-    def from_dict(d: t.Dict[str, t.Any], name: str) -> "InstanceProfile":
+    def from_dict(
+        d: t.Dict[str, t.Any], name: str, allow_hash: bool
+    ) -> "InstanceProfile":
         d = d.copy()
+        if not allow_hash:
+            for k, v in d.items():
+                if isinstance(v, str) and "#" in v:
+                    hasherr(k, v, name)
         check_args_dataclass(
             InstanceProfile, d.keys(), f"~/.oci/yo.ini \\[{name}] section"
         )

yo/data/sample.yo.ini

@@ -134,6 +134,18 @@ vnc_prog = krdc vnc://{host}:{port}
 #
 # list_columns = Name,Shape,Mem,CPU,State,Created
 
+# OPTIONAL: allow_hash_in_config_value
+#
+# (Boolean, Optional, Default: false)
+#
+# By default, Yo detects the '#' character within a configuration value, and
+# raises an error, becaues this is a common mistake for users. The '#' character
+# can only introduce a comment at the beginning of a line. If you use it after
+# a config value, it is included in the resulting value, which is usually not
+# what you want. However, if there is some case where you actually want to
+# include a hash in the config, set this to true to bypass the error.
+#
+# allow_hash_in_config_value = false
 
 ##################################
 # OCI Region Configuration

yo/main.py

@@ -114,6 +114,7 @@
 from yo.api import YoVolumeAttachment
 from yo.util import current_yo_version
 from yo.util import fmt_allow_deny
+from yo.util import hasherr
 from yo.util import latest_yo_version
 from yo.util import natural_sort
 from yo.util import shlex_join
@@ -305,7 +306,10 @@ def load_config(config_file: str = CONFIG_FILE) -> FullYoConfig:
     aliases: t.Dict[str, str] = {}
     if "aliases" in config.sections():
         for key in config["aliases"]:
-            aliases[key] = str(config["aliases"][key])
+            val = str(config["aliases"][key])
+            if "#" in val and not yo_config.allow_hash_in_config_value:
+                hasherr(key, val, "aliases")
+            aliases[key] = val
 
     instance_profiles: t.Dict[str, InstanceProfile] = {}
     expr = re.compile(r"^instances.")
@@ -341,7 +345,7 @@ def load_config(config_file: str = CONFIG_FILE) -> FullYoConfig:
             del config[f"instances.{sec}"]["inherit"]
         keys.update(config[f"instances.{sec}"])
         instance_profiles[sec] = InstanceProfile.from_dict(
-            keys, f"instances.{sec}"
+            keys, f"instances.{sec}", yo_config.allow_hash_in_config_value
         )
         instance_profiles[sec].validate(sec)
     return FullYoConfig(yo_config, instance_profiles, aliases)

yo/util.py

@@ -77,6 +77,17 @@ def filter_keys(
     return output
 
 
+def hasherr(k: str, v: str, sec: str) -> None:
+    raise YoExc(
+        f"There is a '#' character in the config entry within section \\[{sec}]:\n"
+        f"  {k} = {v}\n"
+        "Ini-style configs do not allow comments except on their own line, you\n"
+        "cannot include a comment after a config value. If this was intended,\n"
+        "you can bypass this error by setting 'allow_hash_in_config_value = true'\n"
+        "in the \\[yo] section."
+    )
+
+
 @dataclasses.dataclass
 class YoRegion:
     name: str
@@ -95,6 +106,12 @@ def from_config_section(
         )
         return YoRegion(**d)
 
+    def check_hasherr(self) -> None:
+        for k in ("vcn_id", "subnet_id", "subnet_compartment_id"):
+            v = getattr(self, k)
+            if isinstance(v, str) and "#" in v:
+                hasherr(k, v, "regions." + self.name)
+
 
 @dataclasses.dataclass
 class YoConfig:
@@ -121,6 +138,7 @@ class YoConfig:
     check_for_update_every: t.Optional[int] = 6
     creator_tags: t.List[str] = dataclasses.field(default_factory=list)
     list_columns: str = "Name,Shape,Mem,CPU,State,Created"
+    allow_hash_in_config_value: bool = False
 
     @property
     def vcn_id(self) -> str:
@@ -186,6 +204,7 @@ def from_config_section(
         cls, conf: configparser.SectionProxy, regions: t.Dict[str, YoRegion]
     ) -> "YoConfig":
         d = dict(**conf)
+
         d["regions"] = regions
         region_conf = filter_keys(
             d, ("vcn_id", "subnet_id", "subnet_compartment_id")
@@ -204,10 +223,21 @@ def from_config_section(
             "silence_automatic_tag_warning",
             "exact_name",
             "resource_filtering",
+            "allow_hash_in_config_value",
         ]
         for b in bools:
             if b in d:
                 d[b] = conf.getboolean(b)
+
+        allow_hash = d.get("allow_hash_in_config_value", False)
+        if not allow_hash:
+            for k, v in d.items():
+                if isinstance(v, str) and "#" in v:
+                    hasherr(k, v, "yo")
+            # Region configs are loaded before [yo], so check them once
+            # we know whether we should be raising an error.
+            for v in regions.values():
+                v.check_hasherr()
         if "check_for_update_every" in d:
             d["check_for_update_every"] = int(d["check_for_update_every"])
         # OCI stores email addresses as lower case. While most people write