How to Use Black Args in VS Code

Sometimes when working with large projects in python we would prefer to format the file per Python styling standards, now although this can seem like a tediously manual task, there are tools out there that can help us automate part of this process. In my case, I used it to auto-format long lines in Python to be a certain length. I used black-args in Visual Studio code to do this. 

Step 1-) Pip install Black Args

> pip install black

Step 2-) Modify your settings.json file

Access your settings.json file in VS Code. To do this I just type in Command + Shift + P (Mac), Control + Shift + P (Windows). Type in "settings" in the prompt and select Preferences: Open Settings (JSON) shown below:

Step 3-) Add the arguments to the settings.json file

You can add many arguments to the settings.json file, in this case, I am adding a rule for line length per PEP 8:

https://peps.python.org/pep-0008/

PEP 8 is the standard for styling Python files and I highly recommend reading it and going over it if you are tasked with this challenge. I added the following code to the settings.json file:

{
    "python.formatting.provider": "black",
    "python.formatting.blackArgs": [
        "--line-length=79"
    ],
    "python.linting.enabled": true,
    "editor.formatOnSave": true,
}

Notice there is the "editor.formatOnSave". This setting allows us to auto-format existing files after hitting the save button, which can be convenient if you are working with a large legacy project that needs to be refactored. Once this is done you should be able to go to any Python file you have in the project and hit save to see the results. If you have very long lines this will save you a significant amount of time. 

Conclusion

Black Args in VS Code is a great way to save you time in refactoring Python files. This came in handy for me in one of my own projects and I hope it helps others out there as well. It was not necessarily straightforward at first, hence why I came up with this tutorial. Thanks for reading everyone!

Create a free account to access full content.

All access to code and resources on ShillehTek.

Signup Now

Already a member? Sign In

Explore More on Our Blog

How to Use ADS1115 with the Raspberry Pi (Part 1)

How to Use ADS1115 with the Raspberry Pi (Part 1)

Discover how to expand your Raspberry Pi projects by integrating the ADS1115 ADC for precise analog signal reading....

How to Install Pip Packages in AWS Lambda Using Docker and ECR

How to Install Pip Packages in AWS Lambda Using Docker and ECR

Learn how to streamline AWS Lambda deployments by using Docker and Amazon Elastic Container Registry (ECR) to package...

Create Tabular Product Descriptions on Your Shopify Store

Create Tabular Product Descriptions on Your Shopify Store

Enhance your Shopify store's product pages with our comprehensive guide on implementing tabular descriptions. Learn how to add a...

SSH Into Raspberry Pi with Tailscale VPN

SSH Into Raspberry Pi with Tailscale VPN

Effortlessly access and manage your Raspberry Pi from anywhere using Tailscale's secure mesh VPN.

Send Email with Lua and the ESP32

Send Email with Lua and the ESP32

In this tutorial, we delve into sending emails with the ESP32-S3 using Lua, focusing on the Xedge IDE's built-in SMTP...

How to Code with Lua on ESP32 with XEdge32

How to Code with Lua on ESP32 with XEdge32

Learn how to set up Xedge32 and start coding on the ESP32-S3 with Lua programming!

Stream Audio From Raspberry Pi to Local Computer

Stream Audio From Raspberry Pi to Local Computer

Discover the simplicity of streaming live audio directly from a USB microphone connected to your Raspberry Pi to...

SSH Raspberry Pi via Cell Phone

SSH Raspberry Pi via Cell Phone

This beginner-friendly guide will walk you through remotely controlling your Raspberry Pi using SSH through your cell phone.

Remotely Control Raspberry Pi via SSH from External Network

Remotely Control Raspberry Pi via SSH from External Network

Learn how to SSH into your Raspberry Pi from any network. This is critical in IoT since you can control...

Stream Video from Raspberry Pi Camera to YouTube Live

Stream Video from Raspberry Pi Camera to YouTube Live

Learn how to stream to YouTube from a Raspberry Pi Camera.

Back to blog

Leave a comment

Please note, comments need to be approved before they are published.