Alias agreement for imports can reduce costs

This code insight counts one violation each time a one of the following library is not imported with the conventionnal alias.

Library -> Alias
numpy -> np
scipy -> sp
pandas -> pd
matplotlib -> mpl
matplotlib.pyplot -> plt
seaborn -> sns
datetime -> dt

bad

import numpy as my_numpy_import

good

import numpy as np

import numpy

Why you should care

Many well-known libraries have a conventions regarding which alias to use. Choosing a different one will not break the code but makes it less readable and harder to maintain for other developers.

Business Impacts

It is recommended to avoid these in order to ensure the code is more readable and cost effective.

Cost

CAST recommendations

References

https://www.quantifiedcode.com/knowledge-base/readability/Consider%20using%20%27dt%27%20as%20alias%20for%20datetime%20imports/2c6u8cbQhttps://www.quantifiedcode.com/knowledge-base/readability/Use%20common%20abbreviations%20for%20libraries/7jRPIvMK

About CAST and Highlight’s Code Insights

Over the last 25 years, CAST has leveraged unique knowledge on software quality measurement by analyzing thousands of applications and billions of lines of code. Based on this experience and community standards on programming best practices, Highlight implements hundreds of code insights across 15+ technologies to calculate health factors of a software.

See features How it works