Skip to content

[SPARK-12094][SQL] Prettier tree string for TreeNode #10099

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
liancheng wants to merge 2 commits into from
Closed

[SPARK-12094][SQL] Prettier tree string for TreeNode #10099

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
90b46d9
Prettier tree string for TreeNode
liancheng Nov 26, 2015
31a1c22
Minor styling changes and comments
liancheng Dec 2, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 19 additions & 6 deletions sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/trees/TreeNode.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ abstract class TreeNode[BaseType <: TreeNode[BaseType]] extends Product {
override def toString: String = treeString

/** Returns a string representation of the nodes in this tree */
def treeString: String = generateTreeString(0, new StringBuilder).toString
def treeString: String = generateTreeString(0, Nil, new StringBuilder).toString

/**
* Returns a string representation of the nodes in this tree, where each operator is numbered.
Expand All @@ -395,11 +395,24 @@ abstract class TreeNode[BaseType <: TreeNode[BaseType]] extends Product {
}

/** Appends the string represent of this node and its children to the given StringBuilder. */
protected def generateTreeString(depth: Int, builder: StringBuilder): StringBuilder = {
builder.append(" " * depth)
builder.append(simpleString)
builder.append("\n")
children.foreach(_.generateTreeString(depth + 1, builder))
protected def generateTreeString(
depth: Int, lastChildren: Seq[Boolean], builder: StringBuilder): StringBuilder = {
val prefix = if (depth == 0) {
""
} else {
(lastChildren.init.map { isLast =>
if (isLast) " " else ": "
} :+ (if (lastChildren.last) s"+- " else ":- ")).mkString
Copy link
Contributor

@cloud-fan cloud-fan Dec 2, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this may be arguably more readable:

lastChildren.init.map { isLast =>
  if (isLast) "   " else ":  "
}.mkString + (if (lastChildren.last) "+- " else ":- ")

}

val head = prefix + simpleString
Copy link
Contributor

@cloud-fan cloud-fan Dec 2, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: should we follow the original style? i.e.

builder.append(prefix)
builder.append(simpleString)
builder.append("\n")

builder.append(head + "\n")

if (children.nonEmpty) {
children.init.foreach(_.generateTreeString(depth + 1, lastChildren :+ false, builder))
children.last.generateTreeString(depth + 1, lastChildren :+ true, builder)
}

builder
}

Expand Down