docs: add documentation for Series.struct.field and Series.struct.explode (#114)

Author: tswast

bigframes/core/indexers.py

@@ -225,7 +225,7 @@ def __getitem__(self, key: tuple) -> bigframes.core.scalar.Scalar:
  raise ValueError(error_message)
  if len(key) != 2:
  raise TypeError(error_message)
- block: bigframes.core.blocks.Block = self._dataframe._block
+ block: bigframes.core.blocks.Block = self._dataframe._block # type: ignore
  column_block = block.select_columns([block.value_columns[key[1]]])
  column = bigframes.series.Series(column_block)
  return column.iloc[key[0]]

bigframes/operations/structs.py

@@ -25,7 +25,7 @@
 import third_party.bigframes_vendored.pandas.core.arrays.arrow.accessors as vendoracessors
 
 
-class StructField(bigframes.operations.UnaryOp):
+class _StructField(bigframes.operations.UnaryOp):
  def __init__(self, name_or_index: str | int):
  self._name_or_index = name_or_index
 
@@ -44,7 +44,7 @@ class StructAccessor(
  __doc__ = vendoracessors.StructAccessor.__doc__
 
  def field(self, name_or_index: str | int) -> bigframes.series.Series:
- series = self._apply_unary_op(StructField(name_or_index))
+ series = self._apply_unary_op(_StructField(name_or_index))
  if isinstance(name_or_index, str):
  name = name_or_index
  else:

docs/reference/bigframes.pandas/series.rst

@@ -34,3 +34,11 @@ String handling
  :members:
  :inherited-members:
  :undoc-members:
+
+Struct handling
+^^^^^^^^^^^^^^^
+
+.. automodule:: bigframes.operations.structs
+ :members:
+ :inherited-members:
+ :undoc-members:

docs/templates/toc.yml

@@ -39,6 +39,8 @@
  uid: bigframes.operations.datetimes.DatetimeMethods
  - name: StringMethods
  uid: bigframes.operations.strings.StringMethods
+ - name: StructAccessor
+ uid: bigframes.operations.structs.StructAccessor
  name: Series
  - name: Window
  uid: bigframes.core.window.Window

third_party/bigframes_vendored/pandas/core/series.py

@@ -22,6 +22,23 @@ class Series(NDFrame): # type: ignore[misc]
  def dt(self):
  """
  Accessor object for datetime-like properties of the Series values.
+
+ Returns:
+ bigframes.operations.datetimes.DatetimeMethods:
+ An accessor containing datetime methods.
+
+ """
+ raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)
+
+ @property
+ def struct(self):
+ """
+ Accessor object for struct properties of the Series values.
+
+ Returns:
+ bigframes.operations.structs.StructAccessor:
+ An accessor containing struct methods.
+
  """
  raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)
 
@@ -1733,6 +1750,10 @@ def str(self):
 
  NAs stay NA unless handled otherwise by a particular method. Patterned
  after Python’s string methods, with some inspiration from R’s stringr package.
+
+ Returns:
+ bigframes.operations.strings.StringMethods:
+ An accessor containing string methods.
  """
  raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)