Swift Archival & Serialization API #8124

itaiferber · 2017-03-15T22:21:46Z

What's in this pull request?
This PR integrates preliminary work in introducing a new Swift-focused archival and serialization API as part of the Foundation framework.

This PR focuses on what is available as external public API. As such, it provides new types for consumers of the API and developers wishing to provide their own encoders and decoders with the API.

A swift-evolution proposal will be introduced momentarily and will link to this PR.

This work is not complete. Remaining top-level features which will be iterated upon:

Extensive unit tests for JSONEncoder and JSONDecoder
Integration of PropertyListEncoder and PropertyListDecoder
Unit tests for PropertyListEncoder and PropertyListDecoder

Add the * Codable protocol * CodingKey protocol * Encoder & Decoder protocols * SingleValueEncodingContainer & SingleValueDecodingContainer protocols * KeyedEncodingContainer & KeyedDecodingContainer classes * Extensions on primitive Codable types * Extensions on RawRepresentable types whose RawValue is a primitive Codable type * New NSError codes for failure modes

Integrate preliminary implementations of the JSONEncoder and JSONDecoder classes

slavapestov

There's a lot of repetitive code here - please consider using gyb

slavapestov · 2017-03-16T08:14:16Z

stdlib/public/SDK/Foundation/Codable.swift

+    ///
+    /// - parameter type: The type to decode as.
+    /// - returns: A value of the requested type.
+


Can you use gyb to generate these extensions?

slavapestov · 2017-03-16T08:14:41Z

stdlib/public/SDK/Foundation/Codable.swift

+    ///
+    /// - parameter type: The type to decode as.
+    /// - returns: A value of the requested type.
+


Stray space before self

I think this comment refers to a different line than what's showing up for me here on Github? The referenced doc comment does not contain self

slavapestov · 2017-03-16T08:15:22Z

stdlib/public/SDK/Foundation/Codable.swift

+    ///
+    /// - parameter type: The type to decode as.
+    /// - returns: A value of the requested type.
+


Can you use gyb here?

For readability, we'd like to avoid the introduction of an additional gyb file. We're willing to allow the repetition inline

I think it's less readable to have dozens of copy and pasted versions of the same piece of code. What if you have to change all of them, but forget to change one place?

slavapestov · 2017-03-16T08:18:00Z

stdlib/public/SDK/Foundation/JSONEncoder.swift

+    case string(String)
+
+    /// An array container.
+    case array(NSMutableArray)


Why are these Foundation arrays and not Swift arrays?

We need the reference semantics of the Foundation collection types

slavapestov · 2017-03-16T08:19:34Z

stdlib/public/SDK/Foundation/JSONEncoder.swift

+
+    // MARK: - SingleValueDecodingContainer Methods
+
+    func decode(_ type: Bool.Type) throws -> Bool {


You can overload on return value in Swift - no need to take the metatype parameter

It's true, but we'd like to avoid the potential ambiguity. It's also consistent with the keyed encoding and decoding methods.

slavapestov · 2017-03-16T08:32:49Z

Actually instead of special casing everything on Int8/Int16/Int32 etc can we use the new integer protocols instead?

dabrahams · 2017-03-16T14:26:14Z

on Thu Mar 16 2017, Slava Pestov <notifications-AT-i.8713187.xyz> wrote:

Actually instead of special casing everything on Int8/Int16/Int32 etc can we use the new integer protocols instead?

Yes please.

…

-- -Dave

parkera · 2017-03-16T16:59:54Z

Hey @dabrahams @slavapestov - thanks for your feedback. If it's ok with you I'd like to keep the API part of the discussion on the swift-evolution list. Thanks!

slavapestov · 2017-03-16T20:37:19Z

stdlib/public/SDK/Foundation/Codable.swift

+    ///
+    /// - parameter type: The type to decode as.
+    /// - returns: A value of the requested type.
+


Sorry, the stray space is here (and in the other 10000 copies of this method :-) )

This is so weird. Github is showing this comment on the same exact line as before... 😕 Which line number are you referring to?

Search for " self)"

Fixed, thanks!

* Split Codable protocol into Encodable and Decodable * Make CodingKey.stringValue non-optional * Make KeyedEncodingContainer no longer a class * Add UnkeyedEncodingContainers * Rename codingKeyContext to codingPath

…ultiple incorrect values

…ListEncoder and Decoder

* Remove Data as an encoding primitive * Move core Codable.swift file into stdlib * Introduce EncodingError and DecodingError as Swift errors * Add extensions in Foundation overlay to bridge to NSErrors

itaiferber · 2017-04-25T18:14:10Z

BTW, I'm currently working on shuffling PRs (this and #8125) so that all the Swift stdlib/derived conformance stuff will be part of one PR and can land together, and the Foundation bits can land separately. This should NOT be merged.

itaiferber · 2017-04-25T20:20:36Z

The work put up here has been subsumed into #9004.

Itai Ferber added 2 commits March 15, 2017 14:46

Add JSONEncoder & JSONDecoder

3102694

Integrate preliminary implementations of the JSONEncoder and JSONDecoder classes

itaiferber mentioned this pull request Mar 15, 2017

Explicit Codable & CodingKey Derived Conformance #8125

Closed

8 tasks

slavapestov reviewed Mar 16, 2017

View reviewed changes

Itai Ferber added 8 commits March 16, 2017 16:00

Add missing '.deferToDate' → '.deferredToDate' change

79ef41b

' self)' → 'self)'

c8a142c

Update with feedback from swift-evolution

3c59bfa

* Split Codable protocol into Encodable and Decodable * Make CodingKey.stringValue non-optional * Make KeyedEncodingContainer no longer a class * Add UnkeyedEncodingContainers * Rename codingKeyContext to codingPath

Always push keys to codingPath on decode for debugging

08605ad

Strengthen assertions about requesting multiple containers/encoding m…

dbb0d74

…ultiple incorrect values

Add PropertyListEncoder and PropertyListDecoder

9224db7

Clean up JSONEncoder and JSONDecoder implementation to match Property…

53dbc7f

…ListEncoder and Decoder

Sink core protocols and types into the Swift stdlib

ba0f09a

* Remove Data as an encoding primitive * Move core Codable.swift file into stdlib * Introduce EncodingError and DecodingError as Swift errors * Add extensions in Foundation overlay to bridge to NSErrors

itaiferber mentioned this pull request Apr 25, 2017

Swift Archival & Serialization API #9004

Merged

itaiferber closed this Apr 25, 2017

itaiferber mentioned this pull request Apr 25, 2017

Foundation Encoders #9005

Merged


		// MARK: - SingleValueDecodingContainer Methods

		func decode(_ type: Bool.Type) throws -> Bool {

Swift Archival & Serialization API #8124

Swift Archival & Serialization API #8124

Uh oh!

Conversation

itaiferber commented Mar 15, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

slavapestov left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

slavapestov commented Mar 16, 2017

Uh oh!

dabrahams commented Mar 16, 2017 via email

Uh oh!

parkera commented Mar 16, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

itaiferber commented Apr 25, 2017

Uh oh!

itaiferber commented Apr 25, 2017

Uh oh!

Uh oh!

itaiferber commented Mar 15, 2017 •

edited

Loading