[ARROW-17047] [Python][Docs] Document how to get field from StructType

• Type: Sub-task
• Status: Closed
• Priority: Major
• Resolution: Resolved
• Affects Version/s: 8.0.0
• Fix Version/s: 9.0.0
• Component/s: Documentation
• Labels: pull-request-available
• External issue URL: https://github.com/apache/arrow/issues/32355
• Assignee: Anja Boskovic
• Reporter: Will Jones
• Created: 12/Jul/22 04:45
• Updated: 11/Jan/23 11:48
• Resolved: 19/Jul/22 04:32

Description

It's not at all obvious how to get a particular field from a StructType from it's API page:

https://arrow.apache.org/docs/python/generated/pyarrow.StructType.html#pyarrow.StructType

We should add an example:

struct_type = pa.struct({"x": pa.int32(), "y": pa.string()})
struct_type[0]
# pyarrow.Field<x: int32>
pa.schema(list(struct_type))
# x: int32
# y: string

Issue Links

• links to: GitHub Pull Request #13642