Fix comments

Author: perseoGI

conan/tools/cmake/toolchain/blocks.py

@@ -1030,22 +1030,23 @@ class ExtraVariablesBlock(Block):
     CMAKE_CACHE_TYPES = ["BOOL","FILEPATH", "PATH", "STRING", "INTERNAL"]
 
     def get_exact_type(self, key, value):
-        if type(value) == str:
+        if isinstance(value, str):
             return f"\"{value}\""
-        elif type(value) == int or type(value) == float:
+        elif isinstance(value, (int, float)):
             return value
-        elif type(value) == dict:
+        elif isinstance(value, dict):
             var_value = self.get_exact_type(key, value.get("value"))
             is_cache = value.get("cache")
-            if is_cache == True or str(is_cache).lower() == 'true':
+            if is_cache:
+                if not isinstance(is_cache, bool):
+                    raise ConanException(f'tools.cmake.cmaketoolchain:extra_variables "cache" must be a boolean (True/False)')
                 var_type = value.get("type")
                 if not var_type:
-                    raise ConanException(f'CMakeToolchain needs type defined for cache variable "{key}"')
+                    raise ConanException(f'tools.cmake.cmaketoolchain:extra_variables needs "type" defined for cache variable "{key}"')
                 if var_type not in self.CMAKE_CACHE_TYPES:
-                    raise ConanException(f'CMakeToolchain invalid type "{var_type}" for cache variable "{key}". Possible types: {', '.join(self.CMAKE_CACHE_TYPES)}')
-                docstring = value.get("docstring")
-                if not docstring:
-                    raise ConanException(f'CMakeToolchain needs docstring defined for cache variable "{key}"')
+                    raise ConanException(f'tools.cmake.cmaketoolchain:extra_variables invalid type "{var_type}" for cache variable "{key}". Possible types: {", ".join(self.CMAKE_CACHE_TYPES)}')
+                # Set docstring as variable name if not defined
+                docstring = value.get("docstring") or key
                 return f"{var_value} CACHE {var_type} \"{docstring}\""
             else:
                 return var_value

test/integration/toolchains/cmake/test_cmaketoolchain.py

@@ -1585,19 +1585,19 @@ def test_toolchain_extra_variables():
         tools.cmake.cmaketoolchain:extra_variables={'CMAKE_GENERATOR_INSTANCE': '${GENERATOR_INSTANCE}/buildTools/', 'FOO': '42' }
         """)
 
-    client = TestClient(path_with_spaces=False)
+    client = TestClient()
     client.save({"conanfile.txt": "[generators]\nCMakeToolchain",
                  "windows": windows_profile})
 
     # Test passing extra_variables from pro ile
-    client.run("install . --profile:build=windows --profile:host=windows")
+    client.run("install . --profile:host=windows")
     toolchain = client.load("conan_toolchain.cmake")
     assert 'set(CMAKE_GENERATOR_INSTANCE "${GENERATOR_INSTANCE}/buildTools/")' in toolchain
     assert 'set(FOO "42")' in toolchain
 
     # Test input from command line passing dict between doble quotes
     client.run(textwrap.dedent(r"""
-        install . -c tools.cmake.cmaketoolchain:extra_variables="{'CMAKE_GENERATOR_INSTANCE': '${GENERATOR_INSTANCE}/buildTools/', 'FOO': 42.2, 'DICT': {'value': 1}, 'CACHE_VAR': {'value': 'hello world', 'cache': 'true', 'type': 'BOOL', 'docstring': 'test variable'}}"
+        install . -c tools.cmake.cmaketoolchain:extra_variables="{'CMAKE_GENERATOR_INSTANCE': '${GENERATOR_INSTANCE}/buildTools/', 'FOO': 42.2, 'DICT': {'value': 1}, 'CACHE_VAR': {'value': 'hello world', 'cache': True, 'type': 'BOOL', 'docstring': 'test variable'}}"
     """)
     )
 
@@ -1608,19 +1608,25 @@ def test_toolchain_extra_variables():
     assert 'set(CACHE_VAR "hello world" CACHE BOOL "test variable")' in toolchain
 
 
-    # Test invalid cache variable
     client.run(textwrap.dedent("""
         install . -c tools.cmake.cmaketoolchain:extra_variables="{'invalid': {'value': 'hello world', 'cache': 'true'}}"
     """) , assert_error=True)
-    assert 'CMakeToolchain needs type defined for cache variable "invalid"' in client.out
+    assert 'tools.cmake.cmaketoolchain:extra_variables "cache" must be a boolean (True/False)' in client.out
 
+    # Test invalid cache variable
     client.run(textwrap.dedent("""
-        install . -c tools.cmake.cmaketoolchain:extra_variables="{'invalid': {'value': 'hello world', 'cache': 'true', 'type': 'INVALID_TYPE'}}"
+        install . -c tools.cmake.cmaketoolchain:extra_variables="{'invalid': {'value': 'hello world', 'cache': True}}"
     """) , assert_error=True)
-    assert 'CMakeToolchain invalid type "INVALID_TYPE" for cache variable "invalid". Possible types: BOOL, FILEPATH, PATH, STRING, INTERNAL' in client.out
+    assert 'tools.cmake.cmaketoolchain:extra_variables needs "type" defined for cache variable "invalid"' in client.out
 
     client.run(textwrap.dedent("""
-        install . -c tools.cmake.cmaketoolchain:extra_variables="{'invalid': {'value': 'hello world', 'cache': 'true', 'type': 'PATH'}}"
+        install . -c tools.cmake.cmaketoolchain:extra_variables="{'invalid': {'value': 'hello world', 'cache': True, 'type': 'INVALID_TYPE'}}"
     """) , assert_error=True)
-    assert 'CMakeToolchain needs docstring defined for cache variable "invalid"' in client.out
+    assert 'tools.cmake.cmaketoolchain:extra_variables invalid type "INVALID_TYPE" for cache variable "invalid". Possible types: BOOL, FILEPATH, PATH, STRING, INTERNAL' in client.out
+
+    client.run(textwrap.dedent("""
+        install . -c tools.cmake.cmaketoolchain:extra_variables="{'CACHE_VAR_DEFAULT_DOC': {'value': 'hello world', 'cache': True, 'type': 'PATH'}}"
+    """))
+    toolchain = client.load("conan_toolchain.cmake")
+    assert 'set(CACHE_VAR_DEFAULT_DOC "hello world" CACHE PATH "CACHE_VAR_DEFAULT_DOC")' in toolchain