zhengruifeng commented on code in PR #37761:
URL: https://github.com/apache/spark/pull/37761#discussion_r980958358
##########
python/pyspark/sql/dataframe.py:
##########
@@ -4430,6 +4430,50 @@ def withColumnRenamed(self, existing: str, new: str) ->
"DataFrame":
"""
return DataFrame(self._jdf.withColumnRenamed(existing, new),
self.sparkSession)
+ def withColumnsRenamed(self, *colsMap: Dict[str, str]) -> "DataFrame":
+ """
+ Returns a new :class:`DataFrame` by renaming multiple columns.
+ This is a no-op if schema doesn't contain the given column names.
+
+ .. versionadded:: 3.4.0
+ Added support for multiple columns renaming
+
+ Parameters
+ ----------
+ colsMap : dict
+ a dict of existing column names and corresponding desired column
names.
+ Currently, only single map is supported.
+
+ Returns
+ -------
+ :class:`DataFrame`
+ DataFrame with renamed columns.
+
+ See Also
+ --------
+ :meth:`withColumnRenamed`
+
+ Examples
+ --------
+ >>> df = spark.createDataFrame([(2, "Alice"), (5, "Bob")],
schema=["age", "name"])
+ >>> df = df.withColumns({'age2': df.age + 2, 'age3': df.age + 3})
+ >>> df.withColumnsRenamed({'age2': 'age4', 'age3': 'age5'}).show()
+ +---+-----+----+----+
+ |age| name|age4|age5|
+ +---+-----+----+----+
+ | 2|Alice| 4| 5|
+ | 5| Bob| 7| 8|
+ +---+-----+----+----+
+ """
+ # Below code is to help enable kwargs in future.
Review Comment:
I think we do not need a list of Dict `*colsMap` here, if we need more
parameters in the future, we can just append them after `colsMap`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
