Wrap indent docstring in newlines for UnionSnippet (#777) (#779)

Wrap indent docstring in newlines for UnionSnippet
palantir · Feb 7, 2024 · 71b454c · 71b454c
1 parent d7d1222
commit 71b454c
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 28 deletions.
diff --git a/changelog/@unreleased/pr-777.v2.yml b/changelog/@unreleased/pr-777.v2.yml
@@ -0,0 +1,5 @@
+type: improvement
+improvement:
+  description: Wrap indent docstring in newlines for UnionSnippet
+  links:
+  - https://github.com/palantir/conjure-python/pull/777
diff --git a/conjure-python-core/src/main/java/com/palantir/conjure/python/poet/BeanSnippet.java b/conjure-python-core/src/main/java/com/palantir/conjure/python/poet/BeanSnippet.java
@@ -61,11 +61,7 @@ default String idForSorting() {
     default void emit(PythonPoetWriter poetWriter) {
         poetWriter.writeIndentedLine(String.format("class %s(ConjureBeanType):", className()));
         poetWriter.increaseIndent();
-        docs().ifPresent(docs -> {
-            poetWriter.writeIndentedLine("\"\"\"");
-            poetWriter.writeIndentedLine(docs.get().trim());
-            poetWriter.writeIndentedLine("\"\"\"");
-        });
+        docs().ifPresent(poetWriter::writeDocs);
 
         poetWriter.writeLine();
 
@@ -139,11 +135,7 @@ default void emit(PythonPoetWriter poetWriter) {
 
             poetWriter.increaseIndent();
             poetWriter.writeIndentedLine(String.format("# type: () -> %s", field.myPyType()));
-            field.docs().ifPresent(docs -> {
-                poetWriter.writeIndentedLine("\"\"\"");
-                poetWriter.writeIndentedLine(docs.get().trim());
-                poetWriter.writeIndentedLine("\"\"\"");
-            });
+            field.docs().ifPresent(poetWriter::writeDocs);
             poetWriter.writeIndentedLine(String.format(
                     "return self._%s", PythonIdentifierSanitizer.sanitize(field.attributeName(), PROTECTED_FIELDS)));
             poetWriter.decreaseIndent();

diff --git a/conjure-python-core/src/main/java/com/palantir/conjure/python/poet/EnumSnippet.java b/conjure-python-core/src/main/java/com/palantir/conjure/python/poet/EnumSnippet.java
@@ -51,11 +51,7 @@ default void emit(PythonPoetWriter poetWriter) {
         poetWriter.maintainingIndent(() -> {
             poetWriter.writeIndentedLine(String.format("class %s(ConjureEnumType):", className()));
             poetWriter.increaseIndent();
-            docs().ifPresent(docs -> {
-                poetWriter.writeIndentedLine("\"\"\"");
-                poetWriter.writeIndentedLine(docs.get().trim());
-                poetWriter.writeIndentedLine("\"\"\"");
-            });
+            docs().ifPresent(poetWriter::writeDocs);
 
             poetWriter.writeLine();
 

diff --git a/...-python-core/src/main/java/com/palantir/conjure/python/poet/PythonEndpointDefinition.java b/...-python-core/src/main/java/com/palantir/conjure/python/poet/PythonEndpointDefinition.java
@@ -109,11 +109,7 @@ default void emit(PythonPoetWriter poetWriter) {
                                     .map(PythonEndpointParam::myPyType)
                                     .collect(Collectors.toList())),
                     myPyReturnType().orElse("None"));
-            docs().ifPresent(docs -> {
-                poetWriter.writeIndentedLine("\"\"\"");
-                poetWriter.writeIndentedLine(docs.get().trim());
-                poetWriter.writeIndentedLine("\"\"\"");
-            });
+            docs().ifPresent(poetWriter::writeDocs);
 
             // replace "None" with "[]"
             for (PythonEndpointParam param : paramsWithHeader) {

diff --git a/conjure-python-core/src/main/java/com/palantir/conjure/python/poet/PythonPoetWriter.java b/conjure-python-core/src/main/java/com/palantir/conjure/python/poet/PythonPoetWriter.java
@@ -19,6 +19,7 @@
 import static com.google.common.base.Preconditions.checkState;
 
 import com.google.errorprone.annotations.FormatMethod;
+import com.palantir.conjure.spec.Documentation;
 import java.io.PrintStream;
 
 public final class PythonPoetWriter {
@@ -96,4 +97,11 @@ public PythonPoetWriter emit(Emittable emittable) {
         emittable.emit(this);
         return this;
     }
+
+    public PythonPoetWriter writeDocs(Documentation docs) {
+        writeIndentedLine("\"\"\"");
+        writeIndentedLine(docs.get().trim());
+        writeIndentedLine("\"\"\"");
+        return this;
+    }
 }
diff --git a/conjure-python-core/src/main/java/com/palantir/conjure/python/poet/PythonService.java b/conjure-python-core/src/main/java/com/palantir/conjure/python/poet/PythonService.java
@@ -60,11 +60,7 @@ default void emit(PythonPoetWriter poetWriter) {
         poetWriter.maintainingIndent(() -> {
             poetWriter.writeIndentedLine(String.format("class %s(Service):", className()));
             poetWriter.increaseIndent();
-            docs().ifPresent(docs -> {
-                poetWriter.writeIndentedLine("\"\"\"");
-                poetWriter.writeIndentedLine(docs.get().trim());
-                poetWriter.writeIndentedLine("\"\"\"");
-            });
+            docs().ifPresent(poetWriter::writeDocs);
 
             endpointDefinitions().forEach(endpointDefinition -> {
                 poetWriter.writeLine();

diff --git a/conjure-python-core/src/main/java/com/palantir/conjure/python/poet/UnionSnippet.java b/conjure-python-core/src/main/java/com/palantir/conjure/python/poet/UnionSnippet.java
@@ -87,8 +87,7 @@ default void emit(PythonPoetWriter poetWriter) {
         poetWriter.maintainingIndent(() -> {
             poetWriter.writeIndentedLine(String.format("class %s(ConjureUnionType):", className()));
             poetWriter.increaseIndent();
-            docs().ifPresent(docs -> poetWriter.writeIndentedLine(
-                    String.format("\"\"\"%s\"\"\"", docs.get().trim())));
+            docs().ifPresent(poetWriter::writeDocs);
 
             options()
                     .forEach(option -> poetWriter.writeIndentedLine(

diff --git a/conjure-python-core/src/test/resources/types/expected/package_name/_impl.py b/conjure-python-core/src/test/resources/types/expected/package_name/_impl.py