MCPcopy Create free account
hub / github.com/apache/arrow / _decorate_compute_function

Function _decorate_compute_function

python/pyarrow/compute.py:130–210  ·  view source on GitHub ↗
(wrapper, exposed_name, func, options_class)

Source from the content-addressed store, hash-verified

128
129
130def _decorate_compute_function(wrapper, exposed_name, func, options_class):
131 # Decorate the given compute function wrapper with useful metadata
132 # and documentation.
133 cpp_doc = func._doc
134
135 wrapper.__arrow_compute_function__ = dict(
136 name=func.name,
137 arity=func.arity,
138 options_class=cpp_doc.options_class,
139 options_required=cpp_doc.options_required)
140 wrapper.__name__ = exposed_name
141 wrapper.__qualname__ = exposed_name
142
143 doc_pieces = []
144
145 # 1. One-line summary
146 summary = cpp_doc.summary
147 if not summary:
148 arg_str = "arguments" if func.arity > 1 else "argument"
149 summary = f"Call compute function {func.name!r} with the given {arg_str}"
150
151 doc_pieces.append(f"{summary}.\n\n")
152
153 # 2. Multi-line description
154 description = cpp_doc.description
155 if description:
156 doc_pieces.append(f"{description}\n\n")
157
158 doc_addition = _compute_docstrings.function_doc_additions.get(func.name)
159
160 # 3. Parameter description
161 doc_pieces.append(dedent("""\
162 Parameters
163 ----------
164 """))
165
166 # 3a. Compute function parameters
167 arg_names = _get_arg_names(func)
168 for arg_name in arg_names:
169 if func.kind in ('vector', 'scalar_aggregate'):
170 arg_type = 'Array-like'
171 else:
172 arg_type = 'Array-like or scalar-like'
173 doc_pieces.append(f"{arg_name} : {arg_type}\n")
174 doc_pieces.append(" Argument to compute function.\n")
175
176 # 3b. Compute function option values
177 if options_class is not None:
178 options_class_doc = _scrape_options_class_doc(options_class)
179 if options_class_doc:
180 for p in options_class_doc.params:
181 doc_pieces.append(f"{p.name} : {p.type}\n")
182 for s in p.desc:
183 doc_pieces.append(f" {s}\n")
184 else:
185 warnings.warn(f"Options class {options_class.__name__} "
186 f"does not have a docstring", RuntimeWarning)
187 options_sig = inspect.signature(options_class)

Callers 1

_wrap_functionFunction · 0.85

Calls 7

_get_arg_namesFunction · 0.85
appendMethod · 0.45
getMethod · 0.45
signatureMethod · 0.45
valuesMethod · 0.45
joinMethod · 0.45

Tested by

no test coverage detected