Implement Poetry build system (mainly so we don't have to commit dynamically generated front end bundles to git)

.gitignore

@@ -30,3 +30,5 @@ yarn-error.log
 .venv
 .DS_Store
 .python-version
+poetry.lock
+locust/webui/dist

Makefile

@@ -1,8 +1,15 @@
 test:
 	tox
 
-build:
-	rm -f dist/* && python3 -m pip install --upgrade build && python3 -m build .
+setup_build::
+	python3 -m pip install --upgrade poetry && poetry self add "poetry-dynamic-versioning[plugin]"  
+
+.PHONY: build
+build: setup_build
+	rm -f dist/* && poetry build && ./rename-wheel.sh
+
+install: setup_build
+	poetry install
 
 frontend_build:
 	yarn webui:install && yarn webui:build
@@ -15,9 +22,3 @@ build_docs:
 
 changelog:
 	@echo "Not supported any more. Run ./generate_changelog.py <version_number> instead!"
-
-sass_watch:
-	sass --watch locust/static/sass:locust/static/css
-
-sass_build:
-	sass --update locust/static/sass:locust/static/css

build.py

@@ -0,0 +1,10 @@
+import subprocess
+
+
+def build() -> None:
+    print("Building front end...")
+    subprocess.run(["make", "frontend_build"])
+
+
+if __name__ == "__main__":
+    build()

pyproject.toml

@@ -1,28 +1,20 @@
 [build-system]
-requires = ["setuptools>=61", "wheel", "setuptools_scm>=6.2"]
-build-backend = "setuptools.build_meta"
+requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning>=1.0.0,<2.0.0"]
+build-backend = "poetry_dynamic_versioning.backend"
 
-[project]
+[tool.poetry]
 name = "locust"
-license = { text = "MIT" }
 description = "Developer-friendly load testing framework"
-dynamic = ["version"]
-requires-python = ">=3.9"
-dependencies = [
-    "gevent >=22.10.2",
-    "flask >=2.0.0",
-    "Werkzeug >=2.0.0",
-    "requests >=2.26.0",
-    "msgpack >=1.0.0",
-    "pyzmq >=25.0.0",
-    "geventhttpclient >=2.3.1",
-    "ConfigArgParse >=1.5.5",
-    "tomli >=1.1.0; python_version<'3.11'",
-    "psutil >=5.9.1",
-    "Flask-Login >=0.6.3",
-    "Flask-Cors >=3.0.10",
-    "pywin32; platform_system=='Windows'",
-]
+version = "0.0.0"
+license = "MIT"
+readme = "README.md"
+authors = ["Jonatan Heyman", "Carl Byström", "Joakim Hamrén", "Hugo Heyman"]
+maintainers = ["Lars Holmberg", "Jonatan Heyman"]
+
+homepage = "https://locust.io/"
+repository = "https://github.com/locustio/locust"
+documentation = "https://docs.locust.io/"
+
 classifiers = [
     "Topic :: Software Development :: Testing :: Traffic Generation",
     "Development Status :: 5 - Production/Stable",
@@ -41,22 +33,81 @@ classifiers = [
     "Topic :: System :: Distributed Computing",
 ]
 
-[project.urls]
-Homepage = "https://github.com/locustio/locust"
-Documentation = "https://docs.locust.io/"
-Code = "https://github.com/locustio/locust"
-"Help/Questions" = "https://stackoverflow.com/questions/tagged/locust"
-"Issue tracker" = "https://github.com/locustio/locust/issues"
+packages = [{ include = "locust" }]
+include = [
+    "locust/webui/dist/**/*",
+    "locust/_version.py",
+    { path = "poetry.lock", format = [
+        "sdist",
+    ] },
+]
+exclude = [
+    "locust/webui/public",
+    "locust/webui/src",
+    "locust/webui/*.*",
+    "locust/test",
+]
 
+[tool.poetry.build]
+script = "build.py"
+generate-setup-file = false
 
-[project.readme]
-file = "README.md"
-content-type = "text/markdown"
+[tool.poetry.urls]
+"Help/Questions" = "https://stackoverflow.com/questions/tagged/locust"
+"Issue tracker" = "https://github.com/locustio/locust/issues"
 
-[tool.setuptools]
-zip-safe = false
-license-files = ["LICENSE"]
-include-package-data = false
+[tool.poetry-dynamic-versioning]
+enable = true
+vcs = "git"
+style = "pep440"
+format = "{base}{stage}"
+latest-tag = true
+pattern = "^(?P<base>\\d+\\.\\d+\\.\\d+)(?P<stage>.*)$"
+
+[tool.poetry-dynamic-versioning.files."locust/_version.py"]
+persistent-substitution = true
+initial-content = """
+# file generated by setuptools_scm
+# don't change, don't track in version control
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple, Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+
+__version__ = "0.0.0"
+version = __version__
+__version_tuple__ = (0, 0, 0)
+version_tuple = __version_tuple__
+"""
+
+[tool.poetry.dependencies]
+python = ">=3.9"
+
+gevent = ">=22.10.2"
+flask = ">=2.0.0"
+Werkzeug = ">=2.0.0"
+requests = ">=2.26.0"
+msgpack = ">=1.0.0"
+pyzmq = ">=25.0.0"
+geventhttpclient = ">=2.3.1"
+ConfigArgParse = ">=1.5.5"
+tomli = { version = ">=1.1.0", markers = "python_version < '3.11'" }
+psutil = ">=5.9.1"
+Flask-Login = ">=0.6.3"
+Flask-Cors = ">=3.0.10"
+pywin32 = { version = "*", markers = "sys_platform == 'win32'" }
+
+[tool.poetry.scripts]
+locust = "locust.main:main"
 
 [tool.ruff]
 target-version = "py39"
@@ -73,41 +124,29 @@ lint.select = ["E", "F", "W", "UP", "FA102", "I001"]
 "examples/*" = ["F841"]
 
 [tool.ruff.lint.isort]
-section-order = ["future", "locust", "standard-library", "third-party", "first-party", "local-folder"]
-# Custom selection-order: to ensure locust is imported as first in lucustfiles (for successful gevent monkey patching)
+section-order = [
+    "future",
+    "locust",
+    "standard-library",
+    "third-party",
+    "first-party",
+    "local-folder",
+]
+# Custom selection-order: to ensure locust is imported as first in locustfiles (for successful gevent monkey patching)
 
 [tool.ruff.lint.isort.sections]
 locust = ["locust"]
 
-
-[tool.setuptools_scm]
-write_to = "locust/_version.py"
-local_scheme = "no-local-version"
-
-[options.packages.find]
-namespace = true
-include = ["locust*"]
-exclude = ["examples", "tests"]
-
-[tool.setuptools.package-data]
-locust = ["py.typed"]
-"locust.webui.dist" = ["**/*"]
-
-[project.scripts]
-locust = "locust.main:main"
-
 [tool.mypy]
 # missing type stubs
 ignore_missing_imports = true
 python_version = "3.9"
 
 [[tool.mypy.overrides]]
 module = ["locust.dispatch"]
-no_strict_optional = true
+strict_optional = false
 
 [tool.pyright]
-exclude = [
-    "locust/test",
-]
+exclude = ["locust/test"]
 reportOptionalMemberAccess = "none"
 analyzeUnannotatedFunctions = false

rename-wheel.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+# When using build script in poetry, the wheel file is named with the architecture and python version
+# This script renames the wheel file to a generic, multi-arch name
+# From https://github.com/python-poetry/poetry/issues/3509#issuecomment-1483859472
+
+# Rename the wheel file to match the currently active python version
+python_ver=$(python -c 'import platform; print("".join(platform.python_version_tuple()[:2]))')
+
+wheel_file=$(find dist/ -type f -name '*.whl')
+new_wheel_file=$(echo ${wheel_file} | sed "s/-cp[0-9].*$/-py3-none-any.whl/")
+
+echo "Renaming ${wheel_file} to ${new_wheel_file}"
+mv ${wheel_file} ${new_wheel_file}