[python] Review fixes

* Fixup property type definitions
* Fixup property descriptions
  * Descriptions inlined where possible
  * Property descriptions are placed after properties per se
* Remove redundant double-quotes at type definitions
* Split enums and model templates
* Simplify gh-action test matrix
* Fixup empty project.toml settings

Author: elchupanebrej

.github/workflows/test-python.yml

@@ -18,36 +18,18 @@ jobs:
     strategy:
       matrix:
         include:
-          - os: ubuntu-latest
-            python-version: "3.9"
-          - os: ubuntu-latest
-            python-version: "3.10"
-          - os: ubuntu-latest
-            python-version: "3.11"
-          - os: ubuntu-latest
-            python-version: "3.12"
-          - os: ubuntu-latest
-            python-version: "3.13"
-          - os: ubuntu-latest
-            python-version: "pypy3.9"
-          - os: ubuntu-latest
-            python-version: "pypy3.10"
-          - os: windows-latest
-            python-version: "3.13"
-          - os: macos-latest
-            python-version: "3.13"
+          # Test latest python on Windows / macOS
+          - { os: 'windows-latest', python-version: '3.13' }
+          - { os: 'macos-latest', python-version: '3.13' }
+        os: ['ubuntu-latest']
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13', 'pypy3.9', 'pypy3.10']
 
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Generate code
-        working-directory: ./python
-        run: |
-          make clean
-          make generate
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip

codegen/generators/python.rb

@@ -21,29 +21,21 @@ def format_property(parent_type_name, property_name, property, required_fields)
       property_type = get_property_type(parent_type_name, property_name, property)
       is_required = required_fields.include?(property_name)
 
+      property_description = if property['description'] && !property['description'].include?("\n")
+        "  # #{property['description']}"
+      else
+        ''
+      end
       if is_required
-        "#{snake_name}: #{property_type}"
+        "#{snake_name}: #{property_type}#{property_description}"
       else
-        "#{snake_name}: Optional[#{property_type}] = None"
+        "#{snake_name}: Optional[#{property_type}] = None#{property_description}"
       end
     end
 
     def get_property_type(parent_type_name, property_name, property)
       type = type_for(parent_type_name, property_name, property)
-
-      if type.start_with?('list[')
-        list_type = type.match(/list\[(.*?)\]/)
-        inner_type = list_type[1]
-        if inner_type =~ /^[A-Z]/
-          "list[\"#{class_name(inner_type)}\"]"
-        else
-          "list[#{inner_type}]"
-        end
-      elsif type =~ /^[A-Z]/
-        "\"#{class_name(type)}\""
-      else
-        type
-      end
+      type.match?(/\A[A-Z]/) ? class_name(type) : type
     end
 
     def array_type_for(type_name)
@@ -52,7 +44,7 @@ def array_type_for(type_name)
       else
         class_name(type_name)  # CamelCase for complex types
       end
-      "list[#{inner_type}]"
+      inner_type
     end
 
     def format_description(raw_description, indent_string: '    ')
@@ -117,7 +109,9 @@ def type_for(parent_type_name, property_name, property)
 
     def property_type_from_type(parent_type_name, property_name, property, type:)
       if type == 'array'
-        array_type_for(type_for(parent_type_name, nil, property['items']))
+        type = type_for(parent_type_name, nil, property['items'])
+        inner_type = array_type_for(type)
+        "list[#{inner_type}]"
       elsif property['enum']
         enum_name(parent_type_name, property_name, property['enum'])
       else

codegen/templates/python.enum.py.erb

@@ -0,0 +1,17 @@
+# This code was generated using the code generator from cucumber-messages.
+# Manual changes will be lost if the code is regenerated.
+# Generator: cucumber-messages-python
+
+from enum import Enum
+
+
+<%- @enums.each_with_index do |enum, index| -%>
+class <%= enum[:name] %>(Enum):
+    <%- enum[:values].each do |value| -%>
+    <%= format_enum_value(value) %> = "<%= value %>"
+    <%- end -%>
+<%- if index < @enums.length - 1 -%>
+
+
+<%- end -%>
+<%- end -%>

codegen/templates/python.py.erb

@@ -4,18 +4,10 @@
 
 from __future__ import annotations
 from dataclasses import dataclass
-from enum import Enum
 from typing import Optional
 
+from ._message_enums import *
 
-<%- @enums.each do |enum| -%>
-class <%= enum[:name] %>(Enum):
-    <%- enum[:values].each do |value| -%>
-    <%= format_enum_value(value) %> = "<%= value %>"
-    <%- end -%>
-
-
-<%- end -%>
 <%- @schemas.each_with_index do |schema_pair, index| -%>
 <%- key, definition = schema_pair -%>
 @dataclass
@@ -26,10 +18,11 @@ class <%= class_name(key) %>:
     <%- if definition['properties'].any? -%>
     <%- required_fields = definition['required'] || [] -%>
     <%- get_sorted_properties(definition).each do |property_name, property| -%>
-    <%- if property['description'] -%>
+    <%= format_property(key, property_name, property, required_fields) %>
+    <%- if property['description'] && property['description'].include?("\n") -%>
     <%= format_description(property['description']) %>
+
     <%- end -%>
-    <%= format_property(key, property_name, property, required_fields) %>
     <%- end -%>
     <%- else -%>
     pass

python/Makefile

@@ -5,13 +5,17 @@ schemas = $(shell find ../jsonschema -name "*.json")
 help: ## Show this help
 	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make <target>\n\nWhere <target> is one of:\n"} /^[$$()% a-zA-Z_-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
 
-generate: require src/cucumber_messages/_messages.py
+generate: require src/cucumber_messages/_messages.py src/cucumber_messages/_message_enums.py
 
 require: ## Check requirements for the code generation (ruby is required)
 	@ruby --version >/dev/null 2>&1 || (echo "ERROR: ruby is required."; exit 1)
 
 clean: ## Remove automatically generated files and related artifacts
 	rm -f src/cucumber_messages/_messages.py
+	rm -f src/cucumber_messages/_message_enums.py
 
 src/cucumber_messages/_messages.py: $(schemas) ../codegen/codegen.rb ../codegen/templates/python.py.erb
 	ruby ../codegen/codegen.rb Generator::Python python.py.erb > $@
+
+src/cucumber_messages/_message_enums.py: $(schemas) ../codegen/codegen.rb ../codegen/templates/python.enum.py.erb
+	ruby ../codegen/codegen.rb Generator::Python python.enum.py.erb > $@

python/pyproject.toml

@@ -34,8 +34,6 @@ requires-python = ">=3.9"
 urls = {Repository = "https://github.com/cucumber/messages"}
 version = "0.1.0"
 
-[project.entry-points]
-
 [project.optional-dependencies]
 test = [
   # local
@@ -52,8 +50,6 @@ test-coverage = [
   "pytest"
 ]
 
-[project.scripts]
-
 [tool.black]
 # Don't include autogenerated file
 force-exclude = ".*\\/src\\/cucumber_messages\\/_messages\\.py"

python/src/cucumber_messages/_message_enums.py

@@ -0,0 +1,54 @@
+# This code was generated using the code generator from cucumber-messages.
+# Manual changes will be lost if the code is regenerated.
+# Generator: cucumber-messages-python
+
+from enum import Enum
+
+
+class AttachmentContentEncoding(Enum):
+    identity = "IDENTITY"
+    base64 = "BASE64"
+
+
+class HookType(Enum):
+    before_test_run = "BEFORE_TEST_RUN"
+    after_test_run = "AFTER_TEST_RUN"
+    before_test_case = "BEFORE_TEST_CASE"
+    after_test_case = "AFTER_TEST_CASE"
+    before_test_step = "BEFORE_TEST_STEP"
+    after_test_step = "AFTER_TEST_STEP"
+
+
+class PickleStepType(Enum):
+    unknown = "Unknown"
+    context = "Context"
+    action = "Action"
+    outcome = "Outcome"
+
+
+class SourceMediaType(Enum):
+    text_x_cucumber_gherkin_plain = "text/x.cucumber.gherkin+plain"
+    text_x_cucumber_gherkin_markdown = "text/x.cucumber.gherkin+markdown"
+
+
+class StepDefinitionPatternType(Enum):
+    cucumber_expression = "CUCUMBER_EXPRESSION"
+    regular_expression = "REGULAR_EXPRESSION"
+
+
+class StepKeywordType(Enum):
+    unknown = "Unknown"
+    context = "Context"
+    action = "Action"
+    outcome = "Outcome"
+    conjunction = "Conjunction"
+
+
+class TestStepResultStatus(Enum):
+    unknown = "UNKNOWN"
+    passed = "PASSED"
+    skipped = "SKIPPED"
+    pending = "PENDING"
+    undefined = "UNDEFINED"
+    ambiguous = "AMBIGUOUS"
+    failed = "FAILED"