Add -require-explicit-sendable to warn about non-Sendable public types
#39550
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@swift-ci please smoke test |
|
This seems quite handy. |
Introduce a compiler flag that warnings about any public types defined in a module that are neither explicitly `Sendable` nor explicitly non-`Sendable` (the latter of which has no spelling currently), which is intended to help with auditing a module for Sendable conformances.
…warning
Becca noticed that one can already write an unavailable `Sendable`
conformance in language:
@available(*, unavailable)
extension MyType: Sendable { ... }
Add tests to verify that this suppresses the "missing Sendable
annotation" warning (it does) and suggest this spelling in a Fix-It to
help users find it.
DougGregor
force-pushed
the
require-explicit-sendable
branch
from
477a30a to
2e81274
Compare
|
@swift-ci please smoke test |
…rage.
When proposing to annotate a public type as `Sendable` due to the
`-require-explicit-sendable` command-line parameter, suggest a
conditional conformance when it can be determined that a generic type
would be `Sendable` when certain type parameters are `Sendable`.
For example, given this type:
public struct DictionaryHolder<T: Hashable, U, V> {
var member: [T: (U, V?)]
}
We will now produce a Fix-It that suggests that one add:
extension DictionaryHolder: Sendable
where T: Sendable, U: Sendable, V: Sendable { }
When a type has provided an unavailable `Sendable` conformance, don't check its instance storage for `Sendable`. Additionally, teach `-require-explicit-sendable` to avoid trying to add a `Sendable` conformance when some of the instance storage relies on unavailable `Sendable` conformances.
|
@swift-ci please smoke test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduce a compiler flag that warnings about any public types defined in
a module that are neither explicitly
Sendablenor explicitlynon-
Sendable(the latter of which has no spelling currently), whichis intended to help with auditing a module for Sendable conformances.
Try to make the Fix-Its smart enough to provide a good workflow. For example,
given this type:
we'll provide a warning like this:
along with two notes. The first note makes the type
Sendablevia a conditional conformance introduced with a Fix-It:and the second note silences the warning using an unavailable extension with the
Sendableconformance: