Write Cleaner, Consistent Code: Can ChatGPT and Autoformatters Help? | by Christabelle Pabalan | Jan, 2024

Editor
2 Min Read


AUTOMATION IN DATA SCIENCE

Refine hastily written code your future self will thank you for with ChatGPT and autoformatters.

DALLE Generated Photo by Author

There are only two things that can happen when you revisit old code: either you cringe with a facepalm-moment-filled-with-regret or you give yourself a silent nod of appreciation and pat on the back for the neat, readable, and well-maintained code.

In this article, we’ll strive for that second scenario.

Using the autoformatting tools and tips in this article will enable you to save unnecessary time and energy on manual formatting and deciphering poorly structured code later.

We will discuss:

  • A prompt that allows you to refine your Python code and adhere to best coding practices
  • Python code formatting libraries like black and autopep
  • The use of ChatGPT as a resource for improving coding practices and not just an automation tool

The prompt below allows me to quickly optimize hastily written code and highlight opportunities for improvement related to best practices. I will emphasize specific segments of the prompt and elaborate on their significance as well as changes to tailor to your preferences.

Please refactor the following Python code to adhere to best coding practices,
including proper naming conventions, indentation, comments, and comprehensive
type hinting. Ensure that the code is clean and maintainable.

```
INSERT CODE
```

Before proceeding with the refactoring, please feel free to ask any necessary
follow-up questions to ensure that you have a clear understanding of the
code's purpose and functionality. Don't give suggestions before I respond
to any questions.

Once you've reviewed the code and obtained any needed clarifications, please
provide suggestions and improvements based on the code itself. Tailor the
coding practices and recommendations to the code's specific context, and
share any additional recommendations for writing high-quality Python code.
Please…

Share this Article
Please enter CoinGecko Free Api Key to get this plugin works.