python-docs-samples icon indicating copy to clipboard operation
python-docs-samples copied to clipboard

Columns and DataType Not Explicitly Set on line 62 of data_utils.py

Open CodeSmileBot opened this issue 2 years ago • 2 comments

Hello!

I found an AI-Specific Code smell in your project. The smell is called: Columns and DataType Not Explicitly Set

You can find more information about it in this paper: https://dl.acm.org/doi/abs/10.1145/3522664.3528620.

According to the paper, the smell is described as follows:

Problem If the columns are not selected explicitly, it is not easy for developers to know what to expect in the downstream data schema. If the datatype is not set explicitly, it may silently continue the next step even though the input is unexpected, which may cause errors later. The same applies to other data importing scenarios.
Solution It is recommended to set the columns and DataType explicitly in data processing.
Impact Readability

Example:


### Pandas Column Selection
import pandas as pd
df = pd.read_csv('data.csv')
+ df = df[['col1', 'col2', 'col3']]

### Pandas Set DataType
import pandas as pd
- df = pd.read_csv('data.csv')
+ df = pd.read_csv('data.csv', dtype={'col1': 'str', 'col2': 'int', 'col3': 'float'})

You can find the code related to this smell in this link: https://github.com/GoogleCloudPlatform/python-docs-samples/blob/161448f276cd6fbe697c83e2ec55c4828e9143fa/people-and-planet-ai/timeseries-classification/data_utils.py#L52-L72.

I also found instances of this smell in other files, such as:

File: https://github.com/GoogleCloudPlatform/python-docs-samples/blob/master/composer/2022_airflow_summit/data_analytics_process_expansion.py#L140-L150 Line: 145 .

I hope this information is helpful!

CodeSmileBot avatar Nov 21 '23 14:11 CodeSmileBot

Please assign it to me

magar51 avatar Mar 12 '24 15:03 magar51

@magar51 if you want to take a stab at contributing a fix, please feel free to do so. Thanks!

iennae avatar Mar 27 '24 04:03 iennae