Python/indentation error long docs (#5764)

fixes Azure/autorest.python#2916 --------- Co-authored-by: iscai-msft <[email protected]>
microsoft · Jan 28, 2025 · 34eb706 · 34eb706
1 parent 8e7dd77
commit 34eb706
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 12 deletions.
diff --git a/.chronus/changes/python-indentationErrorLongDocs-2025-0-27-13-1-49.md b/.chronus/changes/python-indentationErrorLongDocs-2025-0-27-13-1-49.md
@@ -0,0 +1,7 @@
+---
+changeKind: fix
+packages:
+  - "@typespec/http-client-python"
+---
+
+Fix bug in indentation for wrapping a property description that includes a long url
diff --git a/packages/http-client-python/generator/pygen/codegen/templates/macros.jinja2 b/packages/http-client-python/generator/pygen/codegen/templates/macros.jinja2
@@ -2,11 +2,12 @@
 {% set original_result = doc_string | wordwrap(width=95, break_long_words=False, break_on_hyphens=False, wrapstring=wrap_string) %}
 {% set list_result = original_result.split('\n') %}
 {% for line in list_result %}
+    {% set prefix = "" if loop.index == 1 else " " %}
     {% set suffix = suffix_string if list_result | length == loop.index %}
     {% if line | length > 120 %}
-{{ line + "  # pylint: disable=line-too-long" }}{{ suffix }}
+{{ prefix }}{{ line + "  # pylint: disable=line-too-long" }}{{ suffix }}
     {% else %}
-{{ line }}{{ suffix }}
+{{ prefix }}{{ line }}{{ suffix }}
     {% endif %}
 {% endfor %}
 {% endmacro %}
diff --git a/packages/http-client-python/generator/pygen/codegen/templates/model_dpg.py.jinja2 b/packages/http-client-python/generator/pygen/codegen/templates/model_dpg.py.jinja2
@@ -22,9 +22,7 @@
     {% if model.properties != None %}
         {% for p in model.properties %}
             {% for line in serializer.variable_documentation_string(p) %}
-                {% for doc_string in line.replace('\n', '\n ').split('\n') %}
-    {{ macros.wrap_model_string(doc_string, '\n     ') -}}
-                {% endfor %}
+    {{ macros.wrap_model_string(line, '\n    ') -}}
             {% endfor %}
         {% endfor %}
     {% endif %}
@@ -37,7 +35,7 @@
     {{ serializer.declare_property(p) }}
         {% set prop_description = p.description(is_operation_file=False).replace('"', '\\"') %}
         {% if prop_description %}
-    """{{ macros.wrap_model_string(prop_description, '\n     ', '\"\"\"') -}}
+    """{{ macros.wrap_model_string(prop_description, '\n    ', '\"\"\"') -}}
         {% endif %}
     {% endfor %}
 

diff --git a/packages/http-client-python/generator/pygen/codegen/templates/model_msrest.py.jinja2 b/packages/http-client-python/generator/pygen/codegen/templates/model_msrest.py.jinja2
@@ -21,9 +21,7 @@
     {% if model.properties != None %}
         {% for p in model.properties %}
             {% for line in serializer.variable_documentation_string(p) %}
-                {% for doc_string in line.replace('\n', '\n ').split('\n') %}
-    {{ macros.wrap_model_string(doc_string, '\n     ') -}}
-                {% endfor %}
+    {{ macros.wrap_model_string(line, '\n    ') -}}
             {% endfor %}
         {% endfor %}
     {% endif %}
@@ -75,9 +73,7 @@
         {% for p in model.properties %}
             {% if p.is_input %}
                 {% for line in serializer.input_documentation_string(p) %}
-                    {% for doc_string in line.replace('\n', '\n ').split('\n') %}
-        {{ macros.wrap_model_string(doc_string, '\n         ') -}}
-                    {% endfor %}
+        {{ macros.wrap_model_string(line, '\n        ') -}}
                 {% endfor %}
             {% endif %}
         {% endfor %}