pola-rs/polars

Add add_filename to pl.read_csv (and read operations others)

Open

#19,266 opened on Oct 16, 2024

View on GitHub
 (6 comments) (3 reactions) (0 assignees)Rust (2,826 forks)batch import
enhancementgood first issue

Repository metrics

Stars
 (38,496 stars)
PR merge metrics
 (Avg merge 8d 3h) (156 merged PRs in 30d)

Description

Description

It is ocasionaly true that the filename of a data file is fairly critical information

Illustratively

Users/
   Alice.csv
   Bob.csv
   Charlie.csv

When using glob patterns to read this data, the file name itself is lost - which all but forces the user to loop over the files and read them manually.


# This does not preserve what row is for what user
df = pl.read_csv('Users/*.csv') 

 # This is a bit long
df = (pl.concat([
                pl.read_csv(file).with_columns(filename=pl.lit(file) 
                for file in glob('Users/*.csv')
            ])
        )

A parameter to add a column with the specific file name when reading data via a glob pattern would be a nice to have.

Contributor guide

Research direction
Add a parameter to the CSV reading function in the Python bindings, then pass it to the Rust core to include the filename as a column.
Tech stack
pythonrust
Domain
data
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75