[stdlib] 0-ary tuples should be equatable #8354

anayini · Mar 26, 2017

Add an == method for comparing two empty tuples.

Resolves: SR-4172 (https://bugs.swift.org/browse/SR-4172)

anayini · Mar 26, 2017

@swift-ci Please smoke test

CodaFi · Mar 26, 2017

CodaFi requested changes Mar 26, 2017

View changes

May as well do the full monty and edit the gyb template to make tuples quasi-Comparable too. This is also missing !=.

anayini · Mar 26, 2017

@CodaFi - Thanks. Just to clarify edit the .gyb to add !=, <, <=, >, >=? Does the bug need to be edited to include that?

CodaFi · Mar 26, 2017

You should edit the GYB template to account for the non-generic 0-ary tuple. It should be possible to do this "in GYB's terms" so we don't litter this file with just this specific conformance.

anayini · Mar 26, 2017

Gotcha - was considering that adding extra logic for the 0 case in the existing templated methods might actually be less readable / more complicated (both the impls and comment generation will have to fork based on arity) than having a specific extra section for 0 outside of that, but can do that if preferred since it would litter less.

practicalswift · Mar 27, 2017

👍 for the initiative/idea!

moiseev · Mar 27, 2017

Thanks @anayini! I agree that trying to incorporate the () into an existing gyb is not worth the effort, especially given that the one-tuple case will still be missing.
Please add the missing != and Comparable operators with doc comments.

moiseev · Mar 27, 2017

moiseev reviewed Mar 27, 2017

View changes

moiseev · Mar 27, 2017

stdlib/public/core/Tuple.swift.gyb

@@ -23,6 +23,14 @@ comparableOperators = [

 }%

+/// Two tuples each of arity 0 are equal


I would copy the heading from the 'generic' == on tuples, and later add a sentence that all empty-tuples are equal to each other as a note.

/// Returns a Boolean value indicating whether the corresponding components of /// two tuples are equal. /// /// All zero-arity tuples are equal.

Similarly for the < etc...

anayini · Mar 28, 2017

@moiseev - Updated to address your comments. Could also roll up the Comparable operators for the () into gyb format. Would probably separate out the comparableOperators list into two separate lists (one with the strict operators, one with the others) so that the template code could return true or false based on if they are unstrict operators or not for the () case.

moiseev · Mar 28, 2017

moiseev reviewed Mar 28, 2017

View changes

moiseev · Mar 28, 2017

stdlib/public/core/Tuple.swift.gyb

+/// Returns a Boolean value indicating whether any corresponding components of
+/// the two tuples are not equal.
+///
+/// Two tuples each of arity zero are never unequal


'never unequal' is a bit hard to understand (and there is a period missing ;-)). I'd go with the same note as for the ==.

Makes sense

moiseev · Mar 28, 2017

I don't mind the non-gybbed version. @CodaFi , @airspeedswift what do you think?

CodaFi · Mar 28, 2017

CodaFi approved these changes Mar 28, 2017

View changes

CodaFi · Mar 28, 2017

I don't have any qualms with not using GYB here - my thinking was that the file would be more resilient to future interface changes/tuple changes and we could update everything all at once. But that's a lot of work that can be done later. For now, LGTM.

anayini · Mar 28, 2017

There a bit of more discussion here: https://bugs.swift.org/browse/SR-4172, regarding the size of this code and whether the Comparable operators are needed. It also includes a helpful example for why the == operator could be useful to someone.

CodaFi · Mar 29, 2017

@swift-ci please smoke test

anayini · Mar 29, 2017

Welp, I suck. Looks like a failure in IDE/complete_operators.swift, which I guess I didn't run locally. Will investigate at some point today

moiseev · Mar 29, 2017

@anayini that's why we have CI ;-) Few people have enough resources and patience to run all the tests locally.

anayini · Apr 24, 2017

Long time since last update, sorry about that. - @moiseev I'm actually still pretty confused about how the IDE code completion tests run using FileCheck. I've got something that I believe passes, but I'm definitely still confused about the semantics of the file.

I basically have a pseudo understanding of how it works, but would like a deeper understanding so that I can update my commit to make sense.

anayini · Apr 24, 2017

anayini reviewed Apr 24, 2017

View changes

anayini · Apr 24, 2017

test/IDE/complete_operators.swift

@@ -40,7 +40,7 @@
 // RUN: %target-swift-ide-test -code-completion -source-filename=%s -code-completion-token=INFIX_14 | %FileCheck %s -check-prefix=NO_OPERATORS
 // RUN: %target-swift-ide-test -code-completion -source-filename=%s -code-completion-token=INFIX_15 | %FileCheck %s -check-prefix=NO_OPERATORS
 // RUN: %target-swift-ide-test -code-completion -source-filename=%s -code-completion-token=INFIX_16 | %FileCheck %s -check-prefix=NO_OPERATORS
-// RUN: %target-swift-ide-test -code-completion -source-filename=%s -code-completion-token=INFIX_17 | %FileCheck %s -check-prefix=NO_OPERATORS
+// RUN: %target-swift-ide-test -code-completion -source-filename=%s -code-completion-token=INFIX_17 | %FileCheck %s -check-prefix=VOID_OPERATORS


Should maybe rename VOID_OPERATORS to VOID_INFIX_OPERATORS?

anayini · Apr 24, 2017

anayini reviewed Apr 24, 2017

View changes

anayini · Apr 24, 2017

test/IDE/complete_operators.swift

 func testInfix17(x: Void) {
  x#^INFIX_17^#
 }
+
+// VOID_OPERATORS: Begin completions


Generally want some feedback as to where the CHECK: lines need to go. Even before this PR seems like the NO_OPERATORS-NOT was in a strange place, but could be my misunderstanding.

FileCheck is part of LLVM. See here for the documentation.

Oh, I see how this is related to the change. () is same as Void, and therefore we get all the equality/comparison ops on the value of type Void. This might have other consequences...

Yup. Took me a bit to figure out, but yeah SourceKit code completion was offering suggestions of all the equality/comparison ops that were added, but it wasn't expecting any suggestions so this test was failing.

/cc @airspeedswift

moiseev · Apr 25, 2017

@swift-ci Please smoke test

moiseev · Apr 25, 2017

moiseev reviewed Apr 25, 2017

View changes

moiseev · Apr 25, 2017

test/IDE/complete_operators.swift

@@ -244,6 +244,7 @@ func testInfix11() {
  S2#^INFIX_11^#
 }
 // NO_OPERATORS-NOT: Decl[InfixOperatorFunction]
+


Why the newline?

Ah sorry - I can remove that.

anayini · May 1, 2017

bump @airspeedswift

I can fix the newline nits, but wanted to see if you had any other feedback if you have some time
:)

anayini · May 5, 2017

@moiseev - anyone else we can get feedback from :)

I'll push up the whitespace fix, but was going to wait for other feedback in case its needed.

moiseev · May 6, 2017

@anayini Sorry for the silence. Last I remember there were some discussions about it. We'll get back to you once things clear up. Thanks for your patience!

anayini · May 18, 2017

@moiseev - Just checking in again :)

anayini · Jun 3, 2017

@moiseev - Did ya'll come to a conclusion? Should I close for now?

moiseev · Jun 7, 2017

@swift-ci please smoke test

moiseev · Jun 7, 2017

@swift-ci Please Test Source Compatibility

anayini · Jun 13, 2017

@moiseev - Can dive into the Source Compatibility Suite error log - do these tests ever flake? If so, can you rerun?

jrose-apple · Jun 13, 2017

This one's a known issue that we just XFAILed. I'll kick off another run for you.

@swift-ci Please test source compatibility

anayini · Jun 14, 2017

Hm seems like this time its an IndexError: list index out of range from
xfail['branch'][swift_branch].split()[0]

jrose-apple · Jun 14, 2017

Finally back to normal!

@swift-ci Please test source compatibility

anayini · Jun 14, 2017

😄 . All green!

anayini · Jun 15, 2017

@moiseev - Are we good to merge?

moiseev · Jun 15, 2017

@anayini, do you mind sending an email to swift-evolution with a proposal to refine https://github.com/apple/swift-evolution/blob/master/proposals/0015-tuple-comparison-operators.md to cover the empty tuple case?

anayini · Jul 9, 2017

@moiseev - Sorry for the delay - was getting ready for a long OOTO and am now out of the country until the end of the month. Will be able to check in on this periodically. Sent the email.

anayini · Jul 12, 2017

@moiseev - Looks like it was accepted to be posted on swift-evolution. What are the next steps?

moiseev · Jul 12, 2017

@anayini Thanks for the contribution and your patience!

[stdlib] 0-ary tuples should be equatable
Add an == method for comparing two empty tuples. Resolves: SR-4172 (https://bugs.swift.org/browse/SR-4172)

Loading status checks…

e1a5a81

CodaFi requested a review from airspeedswift Mar 26, 2017

jrose-apple requested a review from moiseev Mar 27, 2017

[stdlib] Add other comparison operators to 0-ary tuples
Add `!=`, `<`, `<=`, `>`, `>=` to 0-ary tuples Resolves: SR-4172 (https://bugs.swift.org/browse/SR-4172)

3af43b6

[stdlib] Address PR style comments

Loading status checks…

a7059ba

[stdlib] Update IDE tests

Loading status checks…

c76c039

Merge branch 'master' into bugfix/SR-4172

Loading status checks…

a3e94cc

moiseev merged commit ce53a65 into apple:master Jul 12, 2017
3 checks passed

3 checks passed

Swift Source Compatibility Suite on macOS Platform Build finished.
Details

Swift Test Linux Platform (smoke test)
Details

Swift Test OS X Platform (smoke test)
Details

jessesquires referenced this pull request Jul 13, 2017
Closed
[78] Issue #78 - July 13, 2017 #288

apple/swift

Join GitHub today

[stdlib] 0-ary tuples should be equatable #8354

Conversation

anayini commented Mar 26, 2017

This comment has been minimized.

anayini commented Mar 26, 2017

CodaFi requested changes Mar 26, 2017 View changes

CodaFi left a comment

CodaFi requested a review from airspeedswift Mar 26, 2017

This comment has been minimized.

anayini commented Mar 26, 2017 • edited

This comment has been minimized.

CodaFi commented Mar 26, 2017 • edited

This comment has been minimized.

anayini commented Mar 26, 2017 • edited

This comment has been minimized.

practicalswift commented Mar 27, 2017

jrose-apple requested a review from moiseev Mar 27, 2017

This comment has been minimized.

moiseev commented Mar 27, 2017

moiseev reviewed Mar 27, 2017 View changes

This comment has been minimized.

moiseev Mar 27, 2017 • edited

This comment has been minimized.

This comment has been minimized.

anayini commented Mar 28, 2017 • edited

moiseev reviewed Mar 28, 2017 View changes

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

moiseev commented Mar 28, 2017

CodaFi approved these changes Mar 28, 2017 View changes

This comment has been minimized.

CodaFi commented Mar 28, 2017 • edited

This comment has been minimized.

anayini commented Mar 28, 2017

This comment has been minimized.

CodaFi commented Mar 29, 2017

This comment has been minimized.

anayini commented Mar 29, 2017

This comment has been minimized.

moiseev commented Mar 29, 2017

This comment has been minimized.

anayini commented Apr 24, 2017 • edited

anayini reviewed Apr 24, 2017 View changes

This comment has been minimized.

anayini reviewed Apr 24, 2017 View changes

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

anayini Apr 25, 2017 • edited

This comment has been minimized.

This comment has been minimized.

moiseev commented Apr 25, 2017

moiseev reviewed Apr 25, 2017 View changes

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

anayini commented May 1, 2017

This comment has been minimized.

anayini commented May 5, 2017

This comment has been minimized.

moiseev commented May 6, 2017

This comment has been minimized.

anayini commented May 18, 2017

This comment has been minimized.

anayini commented Jun 3, 2017

This comment has been minimized.

moiseev commented Jun 7, 2017

This comment has been minimized.

moiseev commented Jun 7, 2017

This comment has been minimized.

anayini commented Jun 13, 2017

This comment has been minimized.

jrose-apple commented Jun 13, 2017

This comment has been minimized.

anayini commented Jun 14, 2017

This comment has been minimized.

CodaFi requested changes Mar 26, 2017

View changes

anayini commented Mar 26, 2017 •

edited

CodaFi commented Mar 26, 2017 •

edited

anayini commented Mar 26, 2017 •

edited

moiseev reviewed Mar 27, 2017

View changes

moiseev Mar 27, 2017 •

edited

anayini commented Mar 28, 2017 •

edited

moiseev reviewed Mar 28, 2017

View changes

CodaFi approved these changes Mar 28, 2017

View changes

CodaFi commented Mar 28, 2017 •

edited

anayini commented Apr 24, 2017 •

edited

anayini reviewed Apr 24, 2017

View changes

anayini reviewed Apr 24, 2017

View changes

anayini Apr 25, 2017 •

edited

moiseev reviewed Apr 25, 2017

View changes

anayini commented Jun 14, 2017 •

edited

anayini commented Jul 9, 2017 •

edited

moiseev merged commit `ce53a65` into apple:master Jul 12, 2017
3 checks passed