yt-project/yt

Automatic management of handling sidecar files

Open

#2,730 opened on Jul 6, 2020

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Python (315 forks)auto 404
help wantednew featureyt core

Repository metrics

Stars
 (556 stars)
PR merge metrics
 (PR metrics pending)

Description

After reading through #2645, and also as a result of having to change the EWAH index versions, I think we should evaluate either identifying an external package that can manage sidecar files, or developing something ourselves.

This would need to:

  1. Identify if a sidecar data file exists
  2. Identify if it meets some criteria (i.e., versioning of the method, or versioning with respect to the data file to which it corresponds)
  3. Load if it does exist
  4. Handle if it does not exist by calling a generation routine

We have enough places in the code where sidecar files would be useful that we could use this. We generate them for tipsy binary data, we used to generate them (thanks to @atmyers ) for derived fields, and in the long-long ago we cached projection values in them automatically.

I guess this would be a managed, to-disk memoization system?

Contributor guide

Research direction
Identify existing sidecar file patterns in the codebase and design a generic memoization class.
Tech stack
python
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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.
Mostly clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50