Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Compat for Serialization stdlib #473

Merged
merged 2 commits into from
Jan 29, 2018
Merged

Compat for Serialization stdlib #473

merged 2 commits into from
Jan 29, 2018

Conversation

omus
Copy link
Member

@omus omus commented Jan 24, 2018

No description provided.

@omus
Copy link
Member Author

omus commented Jan 25, 2018

Ack, I do need tests! I'm not looking forward to being put back in the Travis queue...

@omus omus force-pushed the cv/stdlib-serialization branch from e8a8e0f to fd698a1 Compare January 25, 2018 21:24
@omus
Copy link
Member Author

omus commented Jan 25, 2018

Tests added. Feel free to squash.

@omus
Copy link
Member Author

omus commented Jan 26, 2018

Failures look unrelated:

Error During Test at /home/travis/.julia/v0.7/Compat/test/runtests.jl:1079
  Test threw an exception of type MethodError
  Expression: Compat.IteratorSize(v) == Base.HasShape()
  MethodError: no method matching Base.HasShape()
  Stacktrace:
   [1] top-level scope at /home/travis/.julia/v0.7/Compat/test/runtests.jl:1079
   [2] include at ./boot.jl:292 [inlined]
   [3] include_relative(::Module, ::String) at ./loading.jl:1012
   [4] include(::Module, ::String) at ./sysimg.jl:26
   [5] process_options(::Base.JLOptions) at ./client.jl:334
   [6] _start() at ./client.jl:386
ERROR: LoadError: There was an error during testing
in expression starting at /home/travis/.julia/v0.7/Compat/test/runtests.jl:1079

@omus omus force-pushed the cv/stdlib-serialization branch from fd698a1 to 41eb20f Compare January 28, 2018 03:25
@omus
Copy link
Member Author

omus commented Jan 29, 2018

@ararslan I think we're ready here.

@fredrikekre
Copy link
Member

Out of curiousity, what was wrong with the first version:

if VERSION < v"0.7.0-DEV.3476"
    const Serialization = Base.Serializer
else
    import Serialization
end

@omus
Copy link
Member Author

omus commented Jan 29, 2018

If I remember correctly since the module name is different you wouldn't be able to do:

import Compat: Serialization
using Serialization

You can see this on Julia 0.6 with this example:

julia> const Serialization = Base.Serializer
Base.Serializer

julia> using Serialization
ERROR: UndefVarError: Serialization not defined

@omus omus merged commit 791ea60 into master Jan 29, 2018
@omus omus deleted the cv/stdlib-serialization branch January 29, 2018 23:15
@fredrikekre
Copy link
Member

But using Compat.Serialization would work, right? That is the way (most) of the other stdlibs in Compat work. The problem with the approach in this PR is that only the names explicitly imported into the Compat.Serialization module can be used.

@omus
Copy link
Member Author

omus commented Jan 31, 2018

But using Compat.Serialization would work, right?

Yes, it does work. I originally used const implementation but unfortunately that approach did not have Serialization defined which is the primary way we test for module compatibility. For example:

julia> VERSION
v"0.6.2"

julia> module Compat
       const Serialization = Base.Serializer
       end
Compat

julia> using Compat.Serialization

julia> isdefined(:Serialization)
false

The problem with the approach in this PR is that only the names explicitly imported into the Compat.Serialization module can be used.

I understand this concern and it is also a concern for me. That said some of the internals of Serialization have changed from Base.Serializer which means that there are some features available in 0.7 which are not available earlier (AbstractSerializer). Only exporting the shared features means that using what Compat provides is consistent for different Julia versions.

Looking at the code again I just noticed that SerializationState is deprecated so we'll need to do an update like:

@eval module Serialization
    import Base.Serializer: serialize, deserialize, SerializationState
    const Serializer = SerializationState
    export serialize, deserialize, Serializer
end

(provided that the SerializationState deprecation was just a rename)

martinholters added a commit that referenced this pull request Oct 4, 2019
martinholters added a commit that referenced this pull request Oct 8, 2019
martinholters added a commit that referenced this pull request Oct 13, 2019
* Bump required Julia version to 1.0

* Remove compatibility support code for:
  * `at-__MODULE__` (from #363)
  * `devnull`, `stdin`, `stdout`, and `stderr` from #499
  * `at-nospecialize` (from #385 and #409)
  * `isabstracttype` and `isconcretetype` (from #477)
  * `invokelatest` from #424
  * array-like access to `Cmd` from #379
  * `Val(n)` and `ntuple`/`reshape` with `Val` from #381 and #399
  * `logdet(::Any)` fallback from #382
  * `chol(::UniformScaling)` from #382
  * `pushfirst!`, `popfirst!` from #444
  * `fieldcount` from #386
  * `read(obj, ::Type{String})` from #385 and #580
  * `InexactError`, `DomainError`, and `OverflowError` constructors from #393
  * `corrected` kw arg to `cov` from #401
  * `adjoint` from #401
  * `partialsort` from #401
  * `pairs` from #428
  * `AbstractRange` from #400
  * `rtoldefault` from #401
  * `Dates.Period` rounding from #462
  * `IterativeEigensolvers` from #435
  * `occursin` from #520
  * `Char` concatenation from #406
  * `BitSet` from #407
  * `diagm` and `spdiagm` with pairs from #408
  * `Array` c'tors from `UniformScaling` from #412 and #438
  * `IOContext` ctor taking pairs from #427
  * `undef` from #417 and #514
  * `get` on `ENV` from #430
  * `ComplexF...` from #431
  * `tr` from #614
  * `textwidth` from #644
  * `isnumeric` from #543
  * `AbstractDict` from #435
  * `axes` #435 and #442
  * `Nothing` and `Cvoid` from #435
  * `Compat.SuiteSparse` from #435
  * `invpermute!` from #445
  * `replace` with a pair from #445
  * `copyto!` from #448
  * `contains` from #452
  * `CartesianIndices` and `LinearIndices` from #446, #455, and #524
  * `findall` from #466 (and #467).
  * `argmin` and `argmax` from #470, #472, and #622
  * `parentmodule` from #461
  * `codeunits` from #474
  * `nameof` from #471
  * `GC` from #477
  * `AbstractDisplay` from #482
  * `bytesavailable` from #483
  * `firstindex` and `lastindex` from #480 and #494
  * `printstyled` from #481
  * `hasmethod` from #486
  * `objectid` from #486
  * `Compat.find*` from #484 and #513
  * `repr` and `showable` from #497
  * `Compat.names` from #493 and #505
  * `Compat.round` and friends #500, #530, and #537
  * `IOBuffer` from #501 and #504
  * `range` with kw args and `LinRange` from #511
  * `cp` and `mv` from #512
  * `indexin` from #515
  * `isuppercase` and friends from #516
  * `dims` and `init` kwargs from #518, #528, #590, #592, and #613
  * `selectdim` from #522 and #531
  * `repeat` from #625
  * `fetch(::Task)` from #549
  * `isletter` from #542
  * `isbitstype` from #560
  * `at-cfunction` from #553 and #566
  * `codeunit` and `thisind` and friends from #573
  * `something` from #562
  * `permutedims` from #582
  * `atan` from #574
  * `split` and `rsplit` from #572
  * `mapslices` from #588
  * `floatmin` and `floatmax` from #607
  * `dropdims` from #618
  * required keyword arguments from #586
  * `CartesianRange` in `at-compat` from #377
  * `finalizer` from #416
  * `readline`, `eachline`, and `readuntil` from #477, #541, and #575
  * curried `isequal`, `==`, and `in` from #517
  * `Some` from #435 and #563
  * `at-warn` and friends from #458

* Remove old deprecations

* Deprecate:
  * `Compat.Sockets` from #545 and #594
  * `TypeUtils` from #304
  * `macros_have_sourceloc` from #355
  * `Compat.Sys` from #380, #433, and #552
  * `Compat.MathConstants` from #401
  * `Compat.Test`, `Compat.SharedArrays`, `Compat.Mmap`, and `Compat.DelimitedFiles` from #404
  * `Compat.Dates` from #413
  * `Compat.Libdl` from #465 (and #467)
  * `AbstractDateTime` from #443
  * `Compat.Printf` from #435
  * `Compat.LinearAlgebra` from #463
  * `Compat.SparseArrays` from #459
  * `Compat.Random` from #460, #601, and #647
  * `Compat.Markdown` from #492
  * `Compat.REPL` from #469
  * `Compat.Serialization` from #473
  * `Compat.Statistics` from #583
  * `Fix2` from #517
  * `Compat.Base64` from #418
  * `Compat.Unicode` from #432 and #507
  * `notnothing` from #435 and #563
  * `Compat.IteratorSize` and `Compat.IteratorEltype` from #451
  * `enable_debug(::Bool)` from #458
  * `Compat.Distributed` from #477
  * `Compat.Pkg` from #485
  * `Compat.InteractiveUtils` from #485
  * `Compat.LibGit2` from #487
  * `Compat.UUIDs` from #490
  * `Compat.qr` from #534
  * `Compat.rmul!` from #546
  * `Compat.norm` abd friends from #577

* Remove obsolete README entry, missed in #385

* Remove obsolete tests (e.g. missed in #372)

* Remove obsolete `VERSION` conditionals and some minor clean-up
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants