alteryx/featuretools

Update allowed types for instance_vals in query_by_values

Open

#1,272 opened on Dec 10, 2020

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (6,895 stars) (853 forks)batch import
good first issuetech debt

Description

Currently the query_by_values method lists four allowable input types for the instance_vals parameter: pd.Dataframe, pd.Series, list[str] or str

The current Featuretools code will only call this method with a pd.Series input during normal operation, although there are several unit tests that call the method with a list used to specify instance_vals. There is code in the _vals_to_series method that handles the conversion of these different types. As there is no current need in Featuretools for this code to handle pd.DataFrame or str inputs, these types could be removed.

Optionally, support for list input could be dropped if the corresponding unit tests are updated, which would leave only pd.Series as a valid input type for instance_vals.

Making these changed would simplify the code base and test suite. Any users that might be calling query_by_values directly with one of the dropped types, would simply have to convert their values to a pd.Series before the call, but otherwise the functionality and output would remain unchanged.

Contributor guide

Tech stack
python
Domain
databackend
Issue type
refactor
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
Pythonpandas
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue suggests removing support for pd.DataFrame, str, and optionally list inputs from the instance vals parameter in the query by values method. Review the method definition and the vals to series helper to identify the code to simplify. Also examine the unit tests that call query by values with list inputs to decide whether to update them. The change is localized and well scoped, with clear instructions on what to drop.
Update allowed types for instance_vals in query_by_values · alteryx/featuretools#1272 | Good First Issue