Bug 222329 – [check-webkit-style] Fix Contributor sorting in Python 3

• Status: RESOLVED
• Resolution: FIXED
• Component: Tools / Tests

[Jonathan Bedard]

Sorting of contributors is broken in Python 3, making it difficult for new contributors to add themselves to contributors.json.

[Radar WebKit Bug Importer]

<rdar://problem/74656667>

[Jonathan Bedard]

Created attachment 421344 [details]
Patch

[Jonathan Bedard]

Created attachment 421345 [details]
Patch

[Darin Adler]

Comment on attachment 421345 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=421345&action=review

> Tools/Scripts/webkitpy/common/config/committers.py:99
> +            cmp = hash(getattr(self, member)) - hash(getattr(other, member))

Sorting by hashes doesn’t seem like a good idea if we want the sorting to stay stable in the future.

[Jonathan Bedard]

(In reply to Darin Adler from comment #4)
> Comment on attachment 421345 [details]
> Patch
> 
> View in context:
> https://bugs.webkit.org/attachment.cgi?id=421345&action=review
> 
> > Tools/Scripts/webkitpy/common/config/committers.py:99
> > +            cmp = hash(getattr(self, member)) - hash(getattr(other, member))
> 
> Sorting by hashes doesn’t seem like a good idea if we want the sorting to
> stay stable in the future.

Was trying to avoid iterating through the lists, but I guess we probably should.

[Jonathan Bedard]

Created attachment 421346 [details]
Patch

[Jonathan Bedard]

This is the stack trace we get if you modify contributors.json then call check-webkit-style:

  File "/Volumes/Shared/CheckoutBeta/OpenSource/Tools/Scripts/check-webkit-style", line 46, in <module>
    sys.exit(CheckWebKitStyle().main())
  File "/Volumes/Shared/CheckoutBeta/OpenSource/Tools/Scripts/webkitpy/style/main.py", line 159, in main
    patch_checker.check(patch)
  File "/Volumes/Shared/CheckoutBeta/OpenSource/Tools/Scripts/webkitpy/style/patchreader.py", line 86, in check
    self._text_file_reader.process_file(file_path=path, line_numbers=line_numbers)
  File "/Volumes/Shared/CheckoutBeta/OpenSource/Tools/Scripts/webkitpy/style/filereader.py", line 137, in process_file
    self._processor.process(lines, file_path, **kwargs)
  File "/Volumes/Shared/CheckoutBeta/OpenSource/Tools/Scripts/webkitpy/style/checker.py", line 1027, in process
    checker.check(lines)
  File "/Volumes/Shared/CheckoutBeta/OpenSource/Tools/Scripts/webkitpy/style/checkers/contributors.py", line 42, in check
    canonicalized = CommitterList().as_json()
  File "/Volumes/Shared/CheckoutBeta/OpenSource/Tools/Scripts/webkitpy/common/config/committers.py", line 244, in as_json
    result = CommitterList._contributor_list_to_dict(self._contributors)
  File "/Volumes/Shared/CheckoutBeta/OpenSource/Tools/Scripts/webkitpy/common/config/committers.py", line 239, in _contributor_list_to_dict
    for contributor in sorted(list):
TypeError: '<' not supported between instances of 'Contributor' and 'Reviewer'

[Jonathan Bedard]

Committed r273358 (234491@main): <https://commits.webkit.org/234491@main>

[Sam Sneddon [:gsnedders]]

FWIW, in general I'd suggest using functools.total_ordering() rather than manually defining all the comparison operations.