Test the new black formatter extension

[karthiknadig]

Refs: #18890

• anyOS @lszomoru
• anyOS @karrtikr
• anyOS @roblourens

Complexity: 1

Create Issue

---

Requirements

Install the following extension: https://marketplace.visualstudio.com/items?itemName=ms-python.black-formatter
NOTE: Currently only pre-release version in available.

Verification

You should not have to install black in your environment. Try this for example:

Create a python file with following content:

import unittest
import re
class TestSum(unittest.TestCase):
    def test_sum(self):
        self.assertEqual(sum([1, 2, 3]), 6, "Should be 6")
    def test_sum_tuple(self):
        self.assertEqual(sum((1, 2, 3)), 6, "Should be 6")
if __name__ == "__main__":
    unittest.main()
    print(x)

Right click in the document and select "Format Document With ...":

You should see two formatters, Select "Black Formatter":

That is it! If you want this to happen automatically, set Black as the default formatter, and enable format on save. Then on save the content will be formatted.

If you run into any problems, you should be able to see logs under Output > Black Formatter.

[lszomoru]

You should not have to install black in your environment. Try this for example:

This should read, "You should install black in your environment.", correct?

[karthiknadig]

black python library is bundled with the Black Formatter extension. So, you don't have to install black using pip or conda in your environment. You can always install it in your environment, but it is not needed.