MatterMiners/cobald

Add basic yaml math evaluation tag

Open

#73 opened on Feb 28, 2020

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Python (13 forks)auto 404
enhancementgood first issue

Repository metrics

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

Description

The YAML format does not allow for math or other convenience syntax. cobald could provide a YAML tag plugin for basic evaluation and unit replacement.

Before:

maxBytes: 10485760

After:

maxBytes: !eval 10 MiB

maxBytes: !eval 10 * 1024 * 1024

Possible to use ast.literal_eval for the evaluation part.

Contributor guide

Research direction
Investigate how to register custom YAML tags in Python using PyYAML or similar libraries, and use ast.literal eval for safe evaluation.
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.
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonYAML
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70