Skip to content

Commit

Permalink
declare cleanup_name before generated function (#39)
Browse files Browse the repository at this point in the history 
* declare cleanup_name before generated function, close #36

* Update src/StableHashTraits.jl

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Bump patch version

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
@SimonDanisch @github-actions
SimonDanisch and github-actions[bot] authored Dec 10, 2023
1 parent c9ea959 commit 1447160
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 41 deletions.
2 changes: 1 addition & 1 deletion Project.toml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "StableHashTraits"
uuid = "c5dd0088-6c3f-4803-b00e-f31a60c170fa"
authors = ["Beacon Biosignals, Inc."]
version = "1.1.2"
version = "1.1.3"

[deps]
Compat = "34da2185-b29b-5c13-b0c7-acf172513d20"
Expand Down
81 changes: 41 additions & 40 deletions src/StableHashTraits.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ using SHA: SHA, sha256
HashVersion{V}()
The default `hash_context` used by `stable_hash`. There are currently two versions
(1 and 2). Version 2 is far more optimized than 1 and should generally be used in newly
(1 and 2). Version 2 is far more optimized than 1 and should generally be used in newly
written code. Version 1 is the default version, so as to avoid changing the hash computed
by existing code.
By explicitly passing this hash version in `stable_hash` you ensure that hash values for
these fallback methods will not change even if new fallbacks are defined.
By explicitly passing this hash version in `stable_hash` you ensure that hash values for
these fallback methods will not change even if new fallbacks are defined.
"""
struct HashVersion{V}
function HashVersion{V}() where {V}
Expand Down Expand Up @@ -45,7 +45,7 @@ set the context to `HashVersion{version}()`.
To change the hash algorithm used, pass a different function to `alg`. It accepts any `sha`
related function from `SHA` or any function of the form `hash(x::AbstractArray{UInt8},
[old_hash])`.
[old_hash])`.
The `context` value gets passed as the second argument to [`hash_method`](@ref), and as the
third argument to [`StableHashTraits.write`](@ref)
Expand Down Expand Up @@ -202,7 +202,7 @@ HashState(x::SHA.SHA_CTX, ctx) = x
similar_hash_state(::T) where {T<:SHA.SHA_CTX} = T()

#####
##### RecursiveHashState: handles a function of the form hash(bytes, [old_hash])
##### RecursiveHashState: handles a function of the form hash(bytes, [old_hash])
#####

function HashState(fn::Function, context)
Expand Down Expand Up @@ -231,7 +231,7 @@ HashState(x::RecursiveHashState) = x
similar_hash_state(x::RecursiveHashState) = RecursiveHashState(x.fn, x.init, x.init)

#####
##### BufferedHashState: wrapper that buffers bytes before passing them to the hash algorithm
##### BufferedHashState: wrapper that buffers bytes before passing them to the hash algorithm
#####

mutable struct BufferedHashState{T} <: HashState
Expand Down Expand Up @@ -306,7 +306,7 @@ end
#####

#####
##### WriteHash
##### WriteHash
#####

struct WriteHash end
Expand All @@ -320,8 +320,8 @@ Fall back methods are defined as follows:
write(io, x, context) = write(io, x)
write(io, x) = Base.write(io, x)
Users of `StableHashTraits` can overwrite either the 2 or 3 argument version for
their types to customize the behavior of `stable_hash`.
Users of `StableHashTraits` can overwrite either the 2 or 3 argument version for
their types to customize the behavior of `stable_hash`.
See also: [`StableHashTraits.hash_method`](@ref).
"""
Expand All @@ -333,7 +333,7 @@ function stable_hash_helper(x, hash_state, context, ::WriteHash)
end

#####
##### IterateHash
##### IterateHash
#####

struct IterateHash end
Expand Down Expand Up @@ -369,7 +369,7 @@ function hash_foreach_new(fn, hash_state, context, xs)
end

#####
##### StructHash
##### StructHash
#####

struct StructHash{P,S}
Expand Down Expand Up @@ -414,6 +414,26 @@ end
##### Stable values for types
#####

function cleanup_name(str)
# We treat all uses of the `Core` namespace as `Base` across julia versions. What is in
# `Core` changes, e.g. Base.Pair in 1.6, becomes Core.Pair in 1.9; also see
# https://discourse.julialang.org/t/difference-between-base-and-core/37426
str = replace(str, r"^Core\." => "Base.")
str = replace(str, ", " => ",") # spacing in type names vary across minor julia versions
# in 1.6 and older AbstractVector and AbstractMatrix types get a `where` clause, but in
# later versions of julia, they do not
str = replace(str, "AbstractVector{T} where T" => "AbstractVector")
str = replace(str, "AbstractMatrix{T} where T" => "AbstractMatrix")
return str
end

function validate_name(str)
if occursin(r"\.#[^.]*$", str)
throw(ArgumentError("Anonymous types (those containing `#`) cannot be hashed to a reliable value"))
end
return str
end

qname_(T, name) = validate_name(cleanup_name(string(parentmodule(T), '.', name(T))))
qualified_name_(fn::Function) = qname_(fn, nameof)
qualified_type_(fn::Function) = qname_(fn, string)
Expand Down Expand Up @@ -464,7 +484,7 @@ end
stable_typename_id(x)
Returns a 64 bit hash that is the same for a given type so long as the name and the module
of the type doesn't change.
of the type doesn't change.
## Example
Expand Down Expand Up @@ -511,7 +531,7 @@ julia> stable_type_id(["a", "b"])
If the module of a type is `Core` it is renamed to `Base` before hashing because the
location of some types changes between `Core` to `Base` across julia versions.
Likewise, the type names of AbstractArray types are made uniform
as their printing changes from Julia 1.6 -> 1.7.
as their printing changes from Julia 1.6 -> 1.7.
"""
stable_type_id(x) = stable_id_helper(x, Val(:type))

Expand All @@ -527,27 +547,8 @@ stable_typefields_id(::Type{T}) where {T} = hash64(sort_(fieldnames(T)))
return :(return $number)
end

function cleanup_name(str)
# We treat all uses of the `Core` namespace as `Base` across julia versions. What is in
# `Core` changes, e.g. Base.Pair in 1.6, becomes Core.Pair in 1.9; also see
# https://discourse.julialang.org/t/difference-between-base-and-core/37426
str = replace(str, r"^Core\." => "Base.")
str = replace(str, ", " => ",") # spacing in type names vary across minor julia versions
# in 1.6 and older AbstractVector and AbstractMatrix types get a `where` clause, but in
# later versions of julia, they do not
str = replace(str, "AbstractVector{T} where T" => "AbstractVector")
str = replace(str, "AbstractMatrix{T} where T" => "AbstractMatrix")
return str
end
function validate_name(str)
if occursin(r"\.#[^.]*$", str)
throw(ArgumentError("Anonymous types (those containing `#`) cannot be hashed to a reliable value"))
end
return str
end

#####
##### FnHash
##### FnHash
#####

struct FnHash{F,H}
Expand Down Expand Up @@ -584,7 +585,7 @@ function stable_hash_helper(x, hash_state, context,
new_method = @something(method.result_method, hash_method(y, context))
if typeof(x) == typeof(y) && method == new_method
methodstr = nameof(typeof(method))
msg = """`$methodstr` is incorrectly called inside
msg = """`$methodstr` is incorrectly called inside
`hash_method(::$(typeof(x)), ::$(typeof(context))). Applying
it would lead to infinite recursion. This can usually be
fixed by passing a second argument to `$methodstr`."""
Expand All @@ -595,7 +596,7 @@ function stable_hash_helper(x, hash_state, context,
end

#####
##### Tuples
##### Tuples
#####

function stable_hash_helper(x, hash_state, context, methods::Tuple)
Expand All @@ -605,7 +606,7 @@ function stable_hash_helper(x, hash_state, context, methods::Tuple)
end

#####
##### HashAndContext
##### HashAndContext
#####

"""
Expand Down Expand Up @@ -645,7 +646,7 @@ function stable_hash_helper(x, hash_state, context, method::HashAndContext)
end

#####
##### Deprecations
##### Deprecations
#####

# deprecations
Expand Down Expand Up @@ -707,7 +708,7 @@ end
StableHashTraits.root_version(context)
Return the version of the root context: an integer in the range (1, 2). The default
fallback method value returns 1.
fallback method value returns 1.
In almost all cases, a root hash context should return 2. The optimizations used in
HashVersion{2} include a number of changes to the hash-trait implementations that do not
Expand Down Expand Up @@ -794,7 +795,7 @@ hash_method(fn::Base.Fix1, c::HashVersion) = (@ConstantHash("Base.Fix1"), Struct
hash_method(fn::Base.Fix2, c::HashVersion) = (@ConstantHash("Base.Fix2"), StructHash())

#####
##### TablesEq
##### TablesEq
#####

"""
Expand Down Expand Up @@ -822,7 +823,7 @@ function hash_method(x::T, m::TablesEq) where {T}
end

#####
##### ViewsEq
##### ViewsEq
#####

"""
Expand Down

2 comments on commit 1447160

@ericphanson
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/96830

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.1.3 -m "<description of version>" 14471608ee0c25a69fa6ba32256a3e0845bcc23b
git push origin v1.1.3

Please sign in to comment.