spark-instrumented-optimizer/python/pyspark/sql/window.pyi
HyukjinKwon 3959f0d987 [SPARK-33250][PYTHON][DOCS] Migration to NumPy documentation style in SQL (pyspark.sql.*)
### What changes were proposed in this pull request?

This PR proposes to migrate to [NumPy documentation style](https://numpydoc.readthedocs.io/en/latest/format.html), see also SPARK-33243.
While I am migrating, I also fixed some Python type hints accordingly.

### Why are the changes needed?

For better documentation as text itself, and generated HTMLs

### Does this PR introduce _any_ user-facing change?

Yes, they will see a better format of HTMLs, and better text format. See SPARK-33243.

### How was this patch tested?

Manually tested via running `./dev/lint-python`.

Closes #30181 from HyukjinKwon/SPARK-33250.

Authored-by: HyukjinKwon <gurwls223@apache.org>
Signed-off-by: HyukjinKwon <gurwls223@apache.org>
2020-11-03 10:00:49 +09:00

42 lines
1.7 KiB
Python

#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
from typing import List, Union
from pyspark.sql._typing import ColumnOrName
from py4j.java_gateway import JavaObject # type: ignore[import]
class Window:
unboundedPreceding: int
unboundedFollowing: int
currentRow: int
@staticmethod
def partitionBy(*cols: Union[ColumnOrName, List[ColumnOrName]]) -> WindowSpec: ...
@staticmethod
def orderBy(*cols: Union[ColumnOrName, List[ColumnOrName]]) -> WindowSpec: ...
@staticmethod
def rowsBetween(start: int, end: int) -> WindowSpec: ...
@staticmethod
def rangeBetween(start: int, end: int) -> WindowSpec: ...
class WindowSpec:
def __init__(self, jspec: JavaObject) -> None: ...
def partitionBy(self, *cols: Union[ColumnOrName, List[ColumnOrName]]) -> WindowSpec: ...
def orderBy(self, *cols: Union[ColumnOrName, List[ColumnOrName]]) -> WindowSpec: ...
def rowsBetween(self, start: int, end: int) -> WindowSpec: ...
def rangeBetween(self, start: int, end: int) -> WindowSpec: ...