python: Switch to pyproject.toml

CHANGELOG.md

@@ -10,6 +10,7 @@ This document is formatted according to the principles of [Keep A CHANGELOG](htt
 ### Added
 - [PHP, Java, Ruby, JavaScript] update dependency messages up to v26
 - [Python] Added type annotations ([#283](https://github.com/cucumber/gherkin/pull/283))
+- [Python] Switch to pyproject.toml ([#290](https://github.com/cucumber/gherkin/pull/290))
 
 ### Changed
 - [.NET] Drop unsupported frameworks. Now supported target frameworks are .NET 8, .NET Standard 2.0 ([#265](https://github.com/cucumber/gherkin/pull/265))
@@ -22,6 +23,7 @@ This document is formatted according to the principles of [Keep A CHANGELOG](htt
 
 ### Removed
 - [Python] Drop compatibility for python 2. Supported python versions are 3.8, 3.9, 3.10, 3.12
+- [Python] Removed installation of `gherkin` script. It was used for internal acceptance tests only.
 
 ## [29.0.0] - 2024-08-12
 ### Added

python/Makefile

@@ -5,8 +5,8 @@ GHERKIN_PARSER = gherkin/parser.py
 GHERKIN_RAZOR = gherkin-python.razor
 SOURCE_FILES = $(shell find . -name "*.py" | grep -v $(GHERKIN_PARSER))
 
-GHERKIN = bin/gherkin
-GHERKIN_GENERATE_TOKENS = bin/gherkin-generate-tokens
+GHERKIN_GENERATE_EVENTS = python -m scripts.generate_events
+GHERKIN_GENERATE_TOKENS = python -m scripts.generate_tokens
 
 GOOD_FEATURE_FILES = $(shell find ../testdata/good -name "*.feature")
 BAD_FEATURE_FILES  = $(shell find ../testdata/bad -name "*.feature")
@@ -56,20 +56,20 @@ acceptance/testdata/%.tokens: ../testdata/% ../testdata/%.tokens
 
 acceptance/testdata/%.ast.ndjson: ../testdata/% ../testdata/%.ast.ndjson
 	mkdir -p $(@D)
-	$(GHERKIN) --no-source --no-pickles $< | jq --sort-keys --compact-output "." > $@
+	$(GHERKIN_GENERATE_EVENTS) --no-source --no-pickles $< | jq --sort-keys --compact-output "." > $@
 	diff --unified <(jq "." $<.ast.ndjson) <(jq "." $@)
 
 acceptance/testdata/%.pickles.ndjson: ../testdata/% ../testdata/%.pickles.ndjson
 	mkdir -p $(@D)
-	$(GHERKIN) --no-source --no-ast $< | jq --sort-keys --compact-output "." > $@
+	$(GHERKIN_GENERATE_EVENTS) --no-source --no-ast $< | jq --sort-keys --compact-output "." > $@
 	diff --unified <(jq "." $<.pickles.ndjson) <(jq "." $@)
 
 acceptance/testdata/%.source.ndjson: ../testdata/% ../testdata/%.source.ndjson
 	mkdir -p $(@D)
-	$(GHERKIN) --no-ast --no-pickles $< | jq --sort-keys --compact-output "." > $@
+	$(GHERKIN_GENERATE_EVENTS) --no-ast --no-pickles $< | jq --sort-keys --compact-output "." > $@
 	diff --unified <(jq "." $<.source.ndjson) <(jq "." $@)
 
 acceptance/testdata/%.errors.ndjson: ../testdata/% ../testdata/%.errors.ndjson
 	mkdir -p $(@D)
-	$(GHERKIN) --no-source $< | jq --sort-keys --compact-output "." > $@
+	$(GHERKIN_GENERATE_EVENTS) --no-source $< | jq --sort-keys --compact-output "." > $@
 	diff --unified <(jq "." $<.errors.ndjson) <(jq "." $@)

python/pyproject.toml

@@ -1,3 +1,47 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "gherkin-official"
+version = "29.0.0"
+description = "Gherkin parser (official, by Cucumber team)"
+readme = "README.md"
+requires-python = ">=3.8"
+authors = [
+    { name = "Cucumber Ltd and Björn Rasmusson", email = "[email protected]" }
+]
+
+dependencies = [
+  "typing_extensions>=4",
+]
+keywords = ["gherkin", "cucumber", "bdd"]
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12"
+]
+
+[project.urls]
+Homepage = "https://github.com/cucumber/gherkin"
+Repository = "https://github.com/cucumber/gherkin.git"
+Download = "https://pypi.python.org/pypi/gherkin-official"
+Issues = "https://github.com/cucumber/gherkin/issues"
+Changelog = "https://github.com/cucumber/gherkin/releases"
+
+[tool.setuptools.packages.find]
+include = ["gherkin", "gherkin.*"]
+
+[tool.mypy]
+disallow_untyped_defs = true
+packages = ["gherkin"]
+
+
 [tool.black]
 # Using `(python/)?` to match both `gherkin/parser.py` and `python/gherkin/parser.py`.
 # This is needed to be able to run `black` as a pre-commit hook, and also to run it manually.

python/scripts/generate_events.py

@@ -0,0 +1,54 @@
+from optparse import OptionParser
+import json
+
+from gherkin.stream.gherkin_events import GherkinEvents
+from gherkin.stream.source_events import SourceEvents
+
+
+def create_arg_parser() -> OptionParser:
+    parser = OptionParser()
+    parser.add_option(
+        "--no-source",
+        action="store_false",
+        dest="print_source",
+        default=True,
+        help="don't print source events",
+    )
+    parser.add_option(
+        "--no-ast",
+        action="store_false",
+        dest="print_ast",
+        default=True,
+        help="don't print ast events",
+    )
+    parser.add_option(
+        "--no-pickles",
+        action="store_false",
+        dest="print_pickles",
+        default=True,
+        help="don't print pickle events",
+    )
+    return parser
+
+
+def main() -> None:
+    arg_parser = create_arg_parser()
+
+    options, args = arg_parser.parse_args()
+
+    source_events = SourceEvents(args)
+    gherkin_events = GherkinEvents(
+        GherkinEvents.Options(
+            print_source=options.print_source,
+            print_ast=options.print_ast,
+            print_pickles=options.print_pickles,
+        )
+    )
+
+    for source_event in source_events.enum():
+        for event in gherkin_events.enum(source_event):
+            print(json.dumps(event))
+
+
+if __name__ == "__main__":
+    main()

python/scripts/generate_tokens.py

@@ -0,0 +1,17 @@
+import sys
+
+from gherkin.token_scanner import TokenScanner
+from gherkin.token_formatter_builder import TokenFormatterBuilder
+from gherkin.parser import Parser
+
+
+def main() -> None:
+    files = sys.argv[1:]
+    parser = Parser(TokenFormatterBuilder())
+    for file in files:
+        scanner = TokenScanner(file)
+        print(parser.parse(scanner))
+
+
+if __name__ == "__main__":
+    main()