mirror of
https://github.com/apache/arrow.git
synced 2026-10-28 16:47:19 +08:00
ca1a0eb2dd
### Rationale for this change The Cython 3.0.0 upgrade https://github.com/apache/arrow/pull/37097 is triggering numpydoc errors for these missing docstrings. ### What changes are included in this PR? * Docstrings added to Cython functions that omitted them ### Are these changes tested? Yes, locally. ### Are there any user-facing changes? User-facing documentation is added. * Closes: #37217 Lead-authored-by: Dane Pitkin <dane@voltrondata.com> Co-authored-by: Dane Pitkin <48041712+danepitkin@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Sutou Kouhei <kou@cozmixng.org> Signed-off-by: Sutou Kouhei <kou@clear-code.com>
52 lines
1.5 KiB
Cython
52 lines
1.5 KiB
Cython
# 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.
|
|
|
|
# cython: language_level = 3
|
|
|
|
"""Dataset support for ORC file format."""
|
|
|
|
from pyarrow.lib cimport *
|
|
from pyarrow.includes.libarrow cimport *
|
|
from pyarrow.includes.libarrow_dataset cimport *
|
|
|
|
from pyarrow._dataset cimport FileFormat
|
|
|
|
|
|
cdef class OrcFileFormat(FileFormat):
|
|
|
|
def __init__(self):
|
|
self.init(shared_ptr[CFileFormat](new COrcFileFormat()))
|
|
|
|
def equals(self, OrcFileFormat other):
|
|
"""
|
|
Parameters
|
|
----------
|
|
other : pyarrow.dataset.OrcFileFormat
|
|
|
|
Returns
|
|
-------
|
|
True
|
|
"""
|
|
return True
|
|
|
|
@property
|
|
def default_extname(self):
|
|
return "orc"
|
|
|
|
def __reduce__(self):
|
|
return OrcFileFormat, tuple()
|