lint with pre-commit and ruff

Author: seanbudd

README.md

@@ -13,7 +13,7 @@ The Action aims to validate the metadata of add-ons submitted to
     * The `*.nvda-addon` file can be downloaded
   * The Sha256 of the downloaded `*.nvda-addon` file matches.
 * Check data matches the addon's manifest file.
-  * The manifest exists in the downloaded `*.nvda-addon` file and can be loaded by the `AddonManifest` class. 
+  * The manifest exists in the downloaded `*.nvda-addon` file and can be loaded by the `AddonManifest` class.
   * The submission addonName matches the manifest summary field
   * The submission description matches the manifest description field
   * The homepage URL matches the manifest URL field

_tests/test_createJson.py

@@ -11,25 +11,25 @@
 from _validate import (
 	createJson,
 	addonManifest,
-	manifestLoader
+	manifestLoader,
 )
 
 TOP_DIR = os.path.abspath(os.path.dirname(__file__))
 SOURCE_DIR = os.path.dirname(TOP_DIR)
-INPUT_DATA_PATH = os.path.join(SOURCE_DIR, '_tests', 'testData')
+INPUT_DATA_PATH = os.path.join(SOURCE_DIR, "_tests", "testData")
 VALID_JSON = os.path.join(
 	INPUT_DATA_PATH,
 	"addons",
 	"fake",
-	"13.0.0.json"
+	"13.0.0.json",
 )  # json file available in testData/fake
-ADDON_PACKAGE = os.path.join(INPUT_DATA_PATH, 'fake.nvda-addon')
-MANIFEST_FILE = os.path.join(INPUT_DATA_PATH, 'manifest.ini')
+ADDON_PACKAGE = os.path.join(INPUT_DATA_PATH, "fake.nvda-addon")
+MANIFEST_FILE = os.path.join(INPUT_DATA_PATH, "manifest.ini")
 ADDON_CHANNEL = "testChannel"
 ADDON_PUBLISHER = "testPublisher"
 ADDON_SOURCE_URL = "https://example.com/"
 
-OUTPUT_DATA_PATH = os.path.join(SOURCE_DIR, '_tests', 'testOutput')
+OUTPUT_DATA_PATH = os.path.join(SOURCE_DIR, "_tests", "testOutput")
 
 
 def getAddonManifest():
@@ -39,10 +39,11 @@ def getAddonManifest():
 
 
 class IntegrationTestCreateJson(unittest.TestCase):
-	""" Integration tests.
+	"""Integration tests.
 	- The JSON file is created (written to the filesystem).
 	- The output is then loaded and checked for correctness.
 	"""
+
 	def setUp(self):
 		self.outputDir = os.path.join(OUTPUT_DATA_PATH, "createJsonOutput")
 		self.maxDiff = None  # Permit unittest.TestCase (base class) to calculate diffs of any lengths.
@@ -68,12 +69,11 @@ def test_contentsMatchesExampleFile(self):
 		actualJsonPath = os.path.join(self.outputDir, "fake", "13.0.0.json")
 		self.assertTrue(
 			os.path.isfile(actualJsonPath),
-			f"Failed to create json file: {actualJsonPath}"
+			f"Failed to create json file: {actualJsonPath}",
 		)
 		self._assertJsonFilesEqual(actualJsonPath=actualJsonPath, expectedJsonPath=VALID_JSON)
 
 	def _assertJsonFilesEqual(self, actualJsonPath: str, expectedJsonPath: str):
-
 		# Not equal, how are they different?
 		with open(VALID_JSON, encoding="utf-8") as expectedFile:
 			expectedJson = json.load(expectedFile)
@@ -99,17 +99,17 @@ def test_validVersion(self):
 					"major": 1,
 					"minor": 2,
 					"patch": 0,
-				}
+				},
 			},
-			parentDir=self.outputDir
+			parentDir=self.outputDir,
 		)
 
 		dir, filename = os.path.split(outputFilePath)
 		self.assertTrue(os.path.isdir(dir), msg="Directory must exist.")
 		self.assertEqual(
 			filename,
 			"1.2.0.json",
-			msg="Name of the output file should be named based on version number"
+			msg="Name of the output file should be named based on version number",
 		)
 
 

_tests/test_majorMinorPatch.py

@@ -9,16 +9,14 @@
 
 class Test_getVersionNumber(unittest.TestCase):
 	def test_tripleDigitVersion_isValid(self):
-		""" Canonical version (major, minor, patch) expected.
-		"""
+		"""Canonical version (major, minor, patch) expected."""
 		versionNumber = MajorMinorPatch.getFromStr("1.2.3")
 		self.assertEqual(versionNumber.major, 1)
 		self.assertEqual(versionNumber.minor, 2)
 		self.assertEqual(versionNumber.patch, 3)
 
 	def test_doubleDigitVersion_isValid(self):
-		"""patch is optional, assumed to be zero.
-		"""
+		"""patch is optional, assumed to be zero."""
 		versionNumber = MajorMinorPatch.getFromStr("1.02")
 		self.assertEqual(versionNumber.major, 1)
 		self.assertEqual(versionNumber.minor, 2)
@@ -35,5 +33,6 @@ def test_tooManyValues_raises(self):
 	def test_versionWithNonDigit(self):
 		with self.assertRaises(
 			ValueError,
-			msg="Non-digit chars in version number expected as an error."):
+			msg="Non-digit chars in version number expected as an error.",
+		):
 			MajorMinorPatch.getFromStr("1.2.3a")