add docs

chelsea-lin · chelsea-lin · commit e61ddcd73327 · 2024-04-22T20:57:19.000Z
diff --git a/bigframes/bigquery/__init__.py b/bigframes/bigquery/__init__.py
@@ -12,10 +12,41 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import bigframes.bigquery.array as array
 
-array_length = array.array_length
+"""This module integrates BigQuery built-in functions for use with DataFrame objects,
+such as array functions: 
+https://cloud.google.com/bigquery/docs/reference/standard-sql/array_functions. """
 
-__all___ = [
-    "array_length",
-]
+
+from __future__ import annotations
+
+import typing
+
+import bigframes.operations as ops
+
+if typing.TYPE_CHECKING:
+    import bigframes.series as series
+
+
+def array_length(series: series.Series) -> series.Series:
+    """Compute the length of each array element in the Series.
+
+    **Examples:**
+
+        >>> import bigframes.pandas as bpd
+        >>> import bigframes.bigquery as bbq
+        >>> bpd.options.display.progress_bar = None
+
+        >>> s = bpd.Series([[1, 2, 8, 3], [], [3, 4]])
+        >>> bbq.array_length(s)
+        0    4
+        1    0
+        2    2
+        dtype: Int64
+
+    Returns:
+        bigframes.series.Series: A Series of integer values indicating
+            the length of each element in the Series.
+
+    """
+    return series._apply_unary_op(ops.len_op)
diff --git a/bigframes/bigquery/array.py b/bigframes/bigquery/array.py
diff --git a/docs/reference/bigframes.bigquery/index.rst b/docs/reference/bigframes.bigquery/index.rst
@@ -0,0 +1,9 @@
+
+===========================
+BigQuery Built-in Functions
+===========================
+
+.. automodule:: bigframes.bigquery
+    :members:
+    :inherited-members:
+    :undoc-members:
diff --git a/docs/reference/bigframes/index.rst b/docs/reference/bigframes/index.rst
@@ -1,4 +1,5 @@
 
+============
 Core objects
 ============
 
diff --git a/docs/reference/index.rst b/docs/reference/index.rst
@@ -10,3 +10,4 @@ packages.
     bigframes/index
     bigframes.pandas/index
     bigframes.ml/index
+    bigframes.bigquery/index
diff --git a/docs/templates/toc.yml b/docs/templates/toc.yml
@@ -189,5 +189,7 @@
         uid: bigframes.ml.remote.VertexAIModel
       name: remote
     name: bigframes.ml
+  - name: Bigquery Built-in Functions
+    uid: bigframes.bigquery
   name: BigQuery DataFrames
   status: beta
diff --git a/tests/system/small/bigquery/__init__.py b/tests/system/small/bigquery/__init__.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Google LLC
+# Copyright 2024 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
diff --git a/tests/system/small/bigquery/test_array.py b/tests/system/small/bigquery/test_array.py
@@ -1,4 +1,4 @@
-# Copyright 2023 Google LLC
+# Copyright 2024 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`
	`2`	`+============`
`2`	`3`	`Core objects`
`3`	`4`	`============`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Copyright 2023 Google LLC`
	`1`	`+# Copyright 2024 Google LLC`
`2`	`2`	`#`
`3`	`3`	`# Licensed under the Apache License, Version 2.0 (the "License");`
`4`	`4`	`# you may not use this file except in compliance with the License.`