Use natsort to sort trove_classifiers.

Author: domdfcoding

repo_helper/cli/commands/suggest.py

@@ -31,6 +31,7 @@
 # 3rd party
 import click
 from consolekit import CONTEXT_SETTINGS
+from natsort import natsorted
 
 # this package
 from repo_helper.cli import cli_group
@@ -147,7 +148,7 @@ def classifiers(add: bool, status: Optional[int], library: Optional[bool]):
 	# # Lines starting with a # will be discarded.
 	# """
 	# 		)
-	# file_content += "\n".join(sorted(suggested_classifiers))
+	# file_content += "\n".join(natsorted(suggested_classifiers))
 	#
 	# def remove_invalid_entries(line):
 	# 	line = line.strip()
@@ -170,10 +171,10 @@ def classifiers(add: bool, status: Optional[int], library: Optional[bool]):
 
 	if sys.stdout.isatty():
 		click.echo("Based on what you've told me I think the following classifiers are appropriate:")
-		for classifier in sorted(suggested_classifiers):
+		for classifier in natsorted(suggested_classifiers):
 			click.echo(f" - {classifier}")
 	else:
-		for classifier in sorted(suggested_classifiers):
+		for classifier in natsorted(suggested_classifiers):
 			click.echo(classifier)
 
 	if add is None:
@@ -192,7 +193,7 @@ def classifiers(add: bool, status: Optional[int], library: Optional[bool]):
 		data = yaml.load((rh.target_repo / "repo_helper.yml").read_text())
 
 		if "classifiers" in data:
-			data["classifiers"] = sorted({*data["classifiers"], *suggested_classifiers})
+			data["classifiers"] = natsorted({*data["classifiers"], *suggested_classifiers})
 
 			yaml.explicit_start = True  # type: ignore
 
@@ -204,7 +205,7 @@ def classifiers(add: bool, status: Optional[int], library: Optional[bool]):
 
 			with (rh.target_repo / "repo_helper.yml").open('a') as fp:
 				fp.write('\n')
-				yaml.dump({"classifiers": sorted(suggested_classifiers)}, fp)
+				yaml.dump({"classifiers": natsorted(suggested_classifiers)}, fp)
 
 
 # TODO: flags for interactive options, and clean output when piped

repo_helper/configuration/__init__.py

@@ -36,6 +36,7 @@
 from domdf_python_tools.paths import PathPlus
 from domdf_python_tools.typing import PathLike
 from domdf_python_tools.versions import Version
+from natsort import natsorted
 
 # this package
 import repo_helper
@@ -330,16 +331,14 @@ def custom_parsing(
 		parsed_config_vars["tox_travis_versions"] = tox_travis_versions
 		parsed_config_vars["gh_actions_versions"] = tox_travis_versions
 
-		def add_classifier(classifier):
-			if classifier not in parsed_config_vars["classifiers"]:
-				parsed_config_vars["classifiers"].append(classifier)
-
 		if (repo_path / parsed_config_vars["import_name"].replace('.', '/') / "py.typed").is_file():
-			add_classifier("Typing :: Typed")
+			parsed_config_vars["classifiers"].append("Typing :: Typed")
 
 		if parsed_config_vars["use_experimental_backend"]:
 			parsed_config_vars["tox_build_requirements"].append("repo_helper")
 
+		parsed_config_vars["classifiers"] = natsorted(set(parsed_config_vars["classifiers"]))
+
 		return parsed_config_vars
 
 

repo_helper/configuration/metadata.py

@@ -30,6 +30,7 @@
 # 3rd party
 from configconfig.configvar import ConfigVar
 from configconfig.utils import optional_getter
+from natsort import natsorted
 from packaging.version import Version
 from shippinglabel.classifiers import validate_classifiers
 
@@ -376,7 +377,7 @@ def add_classifier(c):
 
 		validate_classifiers(classifier_list)
 
-		return sorted(classifier_list)
+		return natsorted(classifier_list)
 
 
 class keywords(ConfigVar):  # noqa

repo_helper/configuration/utils.py

@@ -27,6 +27,9 @@
 import pathlib
 from typing import Any, Dict, Iterable, List, Mapping, Tuple
 
+# 3rd party
+from natsort import natsorted
+
 __all__ = [
 		"get_tox_python_versions",
 		"get_tox_travis_python_versions",
@@ -105,7 +108,7 @@ def get_version_classifiers(python_versions: Iterable[str]) -> List[str]:
 	version_classifiers.append("Programming Language :: Python")
 	version_classifiers.append("Programming Language :: Python :: 3 :: Only")
 
-	return sorted(set(version_classifiers))
+	return natsorted(set(version_classifiers))
 
 
 def parse_extras(raw_config_vars: Mapping[str, Any], repo_path: pathlib.Path) -> Tuple[Dict, List[str]]:

requirements.txt

@@ -10,6 +10,7 @@ dulwich>=0.19.16
 email-validator==1.1.2
 isort>=5.0.0
 jinja2>=2.11.2
+natsort>=7.1.0
 packaging>=20.4
 pre-commit>=2.7.1
 requests>=2.25.0

tests/test_config_vars.py

@@ -40,6 +40,7 @@
 		test_list_int,
 		test_list_str
 		)
+from pytest_regressions.data_regression import DataRegressionFixture
 
 # this package
 from repo_helper.configuration import *  # pylint: disable=wildcard-import
@@ -309,46 +310,51 @@ def test_import_name_errors(wrong_value, match):
 		import_name.get(wrong_value)
 
 
-def test_classifiers():
+@pytest.mark.parametrize(
+		"config_dict",
+		[
+				pytest.param({"classifiers": ["Environment :: Console"]}, id="environment_console"),
+				pytest.param({"classifiers": []}, id="empty"),
+				pytest.param({"username": "domdfcoding"}, id="not_given_1"),
+				pytest.param({}, id="not_given_2"),
+				pytest.param({
+						"classifiers": ["Environment :: Console"],
+						"python_versions": [3.6, 3.7, 3.8],
+						},
+								id="environment_console_simple_versions"),
+				pytest.param({
+						"classifiers": ["Environment :: Console"],
+						"python_versions": [3.6, 3.7, 3.8, "3.10"],
+						},
+								id="environment_console_complex_versions"),
+				pytest.param({
+						"classifiers": ["Environment :: Console"],
+						"python_versions": [3.7, "3.10", 3.8, 3.6],
+						},
+								id="environment_console_unordered_versions"),
+				pytest.param({
+						"classifiers": ["Environment :: Console"],
+						"python_versions": [3.6, 3.7, 3.8, "pypy3"],
+						},
+								id="environment_console_pypy_versions"),
+				pytest.param({
+						"classifiers": ["Environment :: Console"],
+						"license": "MIT",
+						},
+								id="environment_console_license_mit"),
+				]
+		)
+def test_classifiers(config_dict: Dict[str, Any], data_regression: DataRegressionFixture):
+	data_regression.check(classifiers.get(config_dict))
 
-	default_classifiers = [
+	assert classifiers.get() == [
 			"Operating System :: OS Independent",
 			"Programming Language :: Python",
 			"Programming Language :: Python :: 3 :: Only",
 			"Programming Language :: Python :: 3.6",
 			"Programming Language :: Python :: Implementation :: CPython",
 			]
 
-	assert classifiers.get({"classifiers": ["Environment :: Console"]}) == [
-			"Environment :: Console",
-			*default_classifiers,
-			]
-	assert classifiers.get({
-			"classifiers": ["Environment :: Console"],
-			"python_versions": [3.6, 3.7, 3.8],
-			}) == [
-					"Environment :: Console",
-					"Operating System :: OS Independent",
-					"Programming Language :: Python",
-					"Programming Language :: Python :: 3 :: Only",
-					"Programming Language :: Python :: 3.6",
-					"Programming Language :: Python :: 3.7",
-					"Programming Language :: Python :: 3.8",
-					"Programming Language :: Python :: Implementation :: CPython",
-					]
-	assert classifiers.get({
-			"classifiers": ["Environment :: Console"],
-			"license": "MIT",
-			}) == [
-					"Environment :: Console",
-					"License :: OSI Approved :: MIT License",
-					*default_classifiers,
-					]
-	assert classifiers.get({"classifiers": []}) == default_classifiers
-	assert classifiers.get({"username": "domdfcoding"}) == default_classifiers
-	assert classifiers.get() == default_classifiers
-	assert classifiers.get({}) == default_classifiers
-
 
 @pytest.mark.parametrize(
 		"wrong_value",

tests/test_config_vars_/test_classifiers_empty_.yml

@@ -0,0 +1,5 @@
+- 'Operating System :: OS Independent'
+- 'Programming Language :: Python'
+- 'Programming Language :: Python :: 3 :: Only'
+- 'Programming Language :: Python :: 3.6'
+- 'Programming Language :: Python :: Implementation :: CPython'

tests/test_config_vars_/test_classifiers_environment_console_.yml

@@ -0,0 +1,6 @@
+- 'Environment :: Console'
+- 'Operating System :: OS Independent'
+- 'Programming Language :: Python'
+- 'Programming Language :: Python :: 3 :: Only'
+- 'Programming Language :: Python :: 3.6'
+- 'Programming Language :: Python :: Implementation :: CPython'

tests/test_config_vars_/test_classifiers_environment_console_complex_versions_.yml

@@ -0,0 +1,9 @@
+- 'Environment :: Console'
+- 'Operating System :: OS Independent'
+- 'Programming Language :: Python'
+- 'Programming Language :: Python :: 3 :: Only'
+- 'Programming Language :: Python :: 3.6'
+- 'Programming Language :: Python :: 3.7'
+- 'Programming Language :: Python :: 3.8'
+- 'Programming Language :: Python :: 3.10'
+- 'Programming Language :: Python :: Implementation :: CPython'

tests/test_config_vars_/test_classifiers_environment_console_license_mit_.yml

@@ -0,0 +1,7 @@
+- 'Environment :: Console'
+- 'License :: OSI Approved :: MIT License'
+- 'Operating System :: OS Independent'
+- 'Programming Language :: Python'
+- 'Programming Language :: Python :: 3 :: Only'
+- 'Programming Language :: Python :: 3.6'
+- 'Programming Language :: Python :: Implementation :: CPython'