NWChemEx / NWChemEx/PluginPlay

Extend `run_as` to allow kwargs

Open
#146 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
C++
Stars
13
Forks
1
Avg merge
43m
Merged PRs (30d)
4

Description

Let's say you have a property type that accepts N positional arguments. A lot of times the module actually takes M inputs (M >= N). The (M - N) arguments not set via positional arguments need to be set in the bound input instance. Most of the time these inputs are parameters (thresholds, max numbers of iterations, etc.) and don't need to be explicitly touched. Nonetheless it would be nice if run_as allowed the user to pass a map of key-values for the non-positional arguments.

It should be noted that the need to change parameters like this is usually a sign of bad property type design, but it's useful for testing purposes.

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

Locate the implementation and tests for run_as, since no file or test path is named. Review how positional inputs are currently bound, then verify that key-value arguments can set remaining inputs for testing without changing existing positional behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
backend-api-design
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.