pydata / pydata/xarray

Formatting data array as strings?

Open
#5,985 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API design contrib-good-first-issue
Dominant language
Python
Stars
4.2k
Forks
1.4k
Avg merge
2d 15h
Merged PRs (30d)
14

Description

https://github.com/pydata/xarray/discussions/5865#discussioncomment-1636647

I wonder if it's possible to implement a built-in function like:
da.str.format("%.2f") or xr.string_format(da, "%.2f)

To wrap:

import xarray as xr

da = xr.DataArray([5., 6., 7.])
das = xr.DataArray("%.2f")
das.str % da

<xarray.DataArray (dim_0: 3)>
array(['5.00', '6.00', '7.00'], dtype='<U4')
Dimensions without coordinates: dim_0

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked discussion and the proposed DataArray string-formatting examples. Compare the suggested da.str.format and xr.string_format APIs, then determine the intended behavior and scope before identifying the relevant xarray implementation and tests; done means a supported formatting API with coverage for the shown example.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.