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.

Sign up for GitHub

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

Jump to bottom

Make _Py_HashDouble public again as "unstable" API #111545

Closed
seberg opened this issue Oct 31, 2023 · 5 comments
Closed

Make _Py_HashDouble public again as "unstable" API #111545

seberg opened this issue Oct 31, 2023 · 5 comments
Labels
topic-C-API type-feature A feature request or enhancement

Comments

@seberg
Copy link
Contributor

seberg commented Oct 31, 2023 •
edited by bedevere-app bot
Loading

In NumPy we use _Py_HashDouble for our floating point hashing needs and that seems like a pretty good candiate for the unstable API to me: #91744 (comment) and #101101 (comment).

However, the function is currently removed rather than made unstable (to my understanding). While it should probably be easy enough to vendor what we needed, I would prefer the unstable API tier, it gives a better sense of having the required identical hashing.

NumPy issue: numpy/numpy#25035

Originally reported by @ngoldbaum in #111418 (comment)

Linked PRs
@AlexWaygood AlexWaygood added type-feature A feature request or enhancement topic-C-API labels Oct 31, 2023
@encukou
Copy link
Member

encukou commented Nov 2, 2023

cc @vstinner, per the What's New

@vstinner vstinner mentioned this issue Nov 2, 2023
Closed
@vstinner
Copy link
Member

vstinner commented Nov 2, 2023

In NumPy we use _Py_HashDouble for our floating point hashing needs and that seems like a pretty good candiate for the unstable API to me: #91744 (comment) and #101101 (comment).

I would prefer a public API rather than a private API. I don't expect Py_HashDouble() API to be unstable.

See also issue #111389.

cc @vstinner, per the What's New

Thanks. I'm trying to keep track of these issues under #111481 meta issue.

@skirpichev skirpichev mentioned this issue Nov 6, 2023
Merged
vstinner added a commit to vstinner/cpython that referenced this issue Nov 14, 2023
@vstinner
pythongh-111545: Add Include/cpython/pyhash.h header file
554780b 
Move non-limited C API to a new Include/cpython/pyhash.h header file.
@bedevere-app bedevere-app bot mentioned this issue Nov 14, 2023
Merged
vstinner added a commit to vstinner/cpython that referenced this issue Nov 14, 2023
@vstinner
pythongh-111545: Add Include/cpython/pyhash.h header file
f436654 
Move non-limited C API to a new Include/cpython/pyhash.h header file.
vstinner added a commit that referenced this issue Nov 15, 2023
@vstinner
gh-111545: Add Include/cpython/pyhash.h header file (#112063)
62802b6 
Move non-limited C API to a new Include/cpython/pyhash.h header file.
vstinner added a commit to vstinner/cpython that referenced this issue Nov 15, 2023
@vstinner
pythongh-111545: Add Py_HashDouble() function
1e132f8 
* Cleanup _Py_HashDouble() implementation.
* Add Lib/test/test_capi/test_hash.py.
* Add Modules/_testcapi/hash.c.
vstinner added a commit to vstinner/cpython that referenced this issue Nov 15, 2023
@vstinner
pythongh-111545: Add PyHash_Double() function
a8c4cb2 
* Cleanup _Py_HashDouble() implementation.
* Add Lib/test/test_capi/test_hash.py.
* Add Modules/_testcapi/hash.c.
vstinner added a commit to vstinner/cpython that referenced this issue Nov 15, 2023
@vstinner
pythongh-111545: Add PyHash_Double() function
96be42d 
* Cleanup _Py_HashDouble() implementation.
* Add tests: Modules/_testcapi/hash.c and
  Lib/test/test_capi/test_hash.py.
vstinner added a commit to vstinner/cpython that referenced this issue Nov 15, 2023
@vstinner
pythongh-111545: Add PyHash_Double() function
3b6ab5f 
* Cleanup PyHash_Double() implementation based _Py_HashDouble():

  * Move variable declaration to their first assignment.
  * Add braces (PEP 7).
  * Cast result to signed Py_hash_t before the final "== -1" test, to
    reduce the number of casts.
  * Add an assertion on Py_IS_NAN(v) in the only code path which can
    return -1.

* Add tests: Modules/_testcapi/hash.c and
  Lib/test/test_capi/test_hash.py.
@bedevere-app bedevere-app bot mentioned this issue Nov 15, 2023
Closed
vstinner added a commit to vstinner/cpython that referenced this issue Nov 15, 2023
@vstinner
pythongh-111545: Add PyHash_Pointer() function
f0a0d5c 
* Keep _Py_HashPointer() function as an alias to PyHash_Pointer().
* Add _Py_rotateright_uintptr() function with tests.
* Add tests on PyHash_Pointer() to test_capi.test_hash.
* Remove _Py_HashPointerRaw() function: inline code in
  _Py_hashtable_hash_ptr().
vstinner added a commit to vstinner/cpython that referenced this issue Nov 15, 2023
@vstinner
pythongh-111545: Add PyHash_Pointer() function
24d08b7 
* Keep _Py_HashPointer() function as an alias to PyHash_Pointer().
* Add _Py_rotateright_uintptr() function with tests.
* Add PyHash_Pointer() tests to test_capi.test_hash.
* Remove _Py_HashPointerRaw() function: inline code in
  _Py_hashtable_hash_ptr().
@bedevere-app bedevere-app bot mentioned this issue Nov 15, 2023
Merged
vstinner added a commit to vstinner/cpython that referenced this issue Nov 15, 2023
@vstinner
pythongh-111545: Test PyHash_GetFuncDef() function
5b4046b 
Add Modules/_testcapi/hash.c and Lib/test/test_capi/test_hash.py.
@bedevere-app bedevere-app bot mentioned this issue Nov 15, 2023
Merged
vstinner added a commit that referenced this issue Nov 15, 2023
@vstinner
gh-111545: Test PyHash_GetFuncDef() function (#112098)
55f3cce 
Add Modules/_testcapi/hash.c and Lib/test/test_capi/test_hash.py.
vstinner added a commit to vstinner/cpython that referenced this issue Nov 15, 2023
@vstinner
pythongh-111545: Add PyHash_Double() function
46fef17 
* Cleanup PyHash_Double() implementation based _Py_HashDouble():

  * Move variable declaration to their first assignment.
  * Add braces (PEP 7).
  * Cast result to signed Py_hash_t before the final "== -1" test, to
    reduce the number of casts.
  * Add an assertion on Py_IS_NAN(v) in the only code path which can
    return -1.

* Add tests: Modules/_testcapi/hash.c and
  Lib/test/test_capi/test_hash.py.
vstinner added a commit to vstinner/cpython that referenced this issue Nov 15, 2023
@vstinner
pythongh-111545: Add PyHash_Pointer() function
3a0752a 
* Keep _Py_HashPointer() function as an alias to PyHash_Pointer().
* Add _Py_rotateright_uintptr() function with tests.
* Add PyHash_Pointer() tests to test_capi.test_hash.
* Remove _Py_HashPointerRaw() function: inline code in
  _Py_hashtable_hash_ptr().
vstinner added a commit to vstinner/cpython that referenced this issue Nov 15, 2023
@vstinner
pythongh-111545: Add PyHash_Pointer() function
8bb71fe 
* Keep _Py_HashPointer() function as an alias to PyHash_Pointer().
* Add _Py_rotateright_uintptr() function with tests.
* Add PyHash_Pointer() tests to test_capi.test_hash.
* Remove _Py_HashPointerRaw() function: inline code in
  _Py_hashtable_hash_ptr().
vstinner added a commit to vstinner/cpython that referenced this issue Nov 15, 2023
@vstinner
pythongh-111545: Add PyHash_Pointer() function
ee4eed7 
* Keep _Py_HashPointer() function as an alias to PyHash_Pointer().
* Add PyHash_Pointer() tests to test_capi.test_hash.
* Remove _Py_HashPointerRaw() function: inline code in
  _Py_hashtable_hash_ptr().
vstinner added a commit to vstinner/cpython that referenced this issue Nov 15, 2023
@vstinner
pythongh-111545: Add PyHash_Pointer() function
147b89e 
* Keep _Py_HashPointer() function as an alias to PyHash_Pointer().
* Add PyHash_Pointer() tests to test_capi.test_hash.
* Remove _Py_HashPointerRaw() function: inline code in
  _Py_hashtable_hash_ptr().
vstinner added a commit to vstinner/cpython that referenced this issue Nov 15, 2023
@vstinner
pythongh-111545: Add PyHash_Pointer() function
992c39e 
* Keep _Py_HashPointer() function as an alias to PyHash_Pointer().
* Add PyHash_Pointer() tests to test_capi.test_hash.
* Remove _Py_HashPointerRaw() function: inline code in
  _Py_hashtable_hash_ptr().
vstinner added a commit to vstinner/cpython that referenced this issue Nov 15, 2023
@vstinner
pythongh-111545: Add PyHash_Pointer() function
f63b726 
* Keep _Py_HashPointer() function as an alias to PyHash_Pointer().
* Add PyHash_Pointer() tests to test_capi.test_hash.
* Remove _Py_HashPointerRaw() function: inline code in
  _Py_hashtable_hash_ptr().
vstinner added a commit to vstinner/cpython that referenced this issue Nov 15, 2023
@vstinner
pythongh-111545: Add PyHash_Double() function
26fc990 
* Add again _PyHASH_NAN constant.
* _Py_HashDouble(NULL, value) now returns _PyHASH_NAN.
* Add tests: Modules/_testcapi/hash.c and
  Lib/test/test_capi/test_hash.py.
vstinner added a commit to vstinner/cpython that referenced this issue Nov 15, 2023
@vstinner
pythongh-111545: Add PyHash_Double() function
24c3f6d 
* Add again _PyHASH_NAN constant.
* _Py_HashDouble(NULL, value) now returns _PyHASH_NAN.
* Add tests: Modules/_testcapi/hash.c and
  Lib/test/test_capi/test_hash.py.
@bedevere-app bedevere-app bot mentioned this issue Nov 27, 2023
Closed
vstinner added a commit to vstinner/cpython that referenced this issue Nov 30, 2023
@vstinner
pythongh-111545: Add Py_HashDouble() function
e69656a 
* Add again the private _PyHASH_NAN constant.
* Add tests: Modules/_testcapi/hash.c and
  Lib/test/test_capi/test_hash.py.
vstinner added a commit to vstinner/cpython that referenced this issue Dec 1, 2023
@vstinner
pythongh-111545: Add Py_HashPointer() function
fb08414 
* Implement _Py_HashPointerRaw() as a static inline function.
* Add Py_HashPointer() tests to test_capi.test_hash.
* Keep _Py_HashPointer() function as an alias to Py_HashPointer().
vstinner added a commit to vstinner/cpython that referenced this issue Dec 1, 2023
@vstinner
pythongh-111545: Add Py_HashPointer() function
ffbdae1 
* Implement _Py_HashPointerRaw() as a static inline function.
* Add Py_HashPointer() tests to test_capi.test_hash.
* Keep _Py_HashPointer() function as an alias to Py_HashPointer().
vstinner added a commit to vstinner/cpython that referenced this issue Dec 1, 2023
@vstinner
pythongh-111545: Add Py_HashPointer() function
cd8849b 
* Implement _Py_HashPointerRaw() as a static inline function.
* Add Py_HashPointer() tests to test_capi.test_hash.
* Keep _Py_HashPointer() function as an alias to Py_HashPointer().
vstinner added a commit to vstinner/cpython that referenced this issue Dec 1, 2023
@vstinner
pythongh-111545: Add Py_HashPointer() function
8031210 
* Implement _Py_HashPointerRaw() as a static inline function.
* Add Py_HashPointer() tests to test_capi.test_hash.
* Keep _Py_HashPointer() function as an alias to Py_HashPointer().
@serhiy-storchaka
Copy link
Member

I wonder whether it is worth to add the PyObject_GenericHash() function that implements object.__hash__. Using PyHash_Pointer() for this is a CPython implementation detail and depends on the fact that id() returns the address of the object. In general, Python objects and pointers can use different hash functions.

vstinner added a commit to vstinner/cpython that referenced this issue Dec 3, 2023
@vstinner
pythongh-111545: Add Py_HashDouble() function
2253114 
* Add again the private _PyHASH_NAN constant.
* Add tests: Modules/_testcapi/hash.c and
  Lib/test/test_capi/test_hash.py.
vstinner added a commit to vstinner/cpython that referenced this issue Dec 3, 2023
@vstinner
pythongh-111545: Mention PEP 456 in PyHash_GetFuncDef() doc
db70d31
@bedevere-app bedevere-app bot mentioned this issue Dec 3, 2023
Merged
vstinner added a commit that referenced this issue Dec 3, 2023
@vstinner
gh-111545: Mention PEP 456 in PyHash_GetFuncDef() doc (#112647)
a971574
vstinner added a commit to vstinner/cpython that referenced this issue Dec 4, 2023
@vstinner
pythongh-111545: Add Py_HashDouble() function
5be68f0 
* Add again the private _PyHASH_NAN constant.
* Add tests: Modules/_testcapi/hash.c and
  Lib/test/test_capi/test_hash.py.
vstinner added a commit to vstinner/cpython that referenced this issue Dec 5, 2023
@vstinner
pythongh-111545: Add Py_HashPointer() function
c0356a2 
* Implement _Py_HashPointerRaw() as a static inline function.
* Add Py_HashPointer() tests to test_capi.test_hash.
* Keep _Py_HashPointer() function as an alias to Py_HashPointer().
@vstinner vstinner mentioned this issue Dec 5, 2023
Closed
4 tasks
vstinner added a commit that referenced this issue Dec 6, 2023
@vstinner
gh-111545: Add Py_HashPointer() function (#112096)
828451d 
* Implement _Py_HashPointerRaw() as a static inline function.
* Add Py_HashPointer() tests to test_capi.test_hash.
* Keep _Py_HashPointer() function as an alias to Py_HashPointer().
vstinner added a commit to vstinner/cpython that referenced this issue Dec 6, 2023
@vstinner
pythongh-111545: Add Py_HashDouble() function
155764a 
* Add again the private _PyHASH_NAN constant.
* Add tests: Modules/_testcapi/hash.c and
  Lib/test/test_capi/test_hash.py.
vstinner added a commit to vstinner/cpython that referenced this issue Dec 12, 2023
@vstinner
pythongh-111545: Add Py_HashDouble() function
250c3e1 
* Add again the private _PyHASH_NAN constant.
* Add tests: Modules/_testcapi/hash.c and
  Lib/test/test_capi/test_hash.py.
vstinner added a commit to vstinner/cpython that referenced this issue Dec 14, 2023
@vstinner
pythongh-111545: Add Py_HashDouble() function
9b00e3e 
Add tests: Modules/_testcapi/hash.c and
Lib/test/test_capi/test_hash.py.
@bedevere-app bedevere-app bot mentioned this issue Dec 14, 2023
Closed
@vstinner vstinner mentioned this issue Dec 15, 2023
Closed
aisk pushed a commit to aisk/cpython that referenced this issue Feb 11, 2024
@vstinner @aisk
pythongh-111545: Add Include/cpython/pyhash.h header file (python#112063
abbd148 
)

Move non-limited C API to a new Include/cpython/pyhash.h header file.
aisk pushed a commit to aisk/cpython that referenced this issue Feb 11, 2024
@vstinner @aisk
pythongh-111545: Test PyHash_GetFuncDef() function (python#112098)
99fb366 
Add Modules/_testcapi/hash.c and Lib/test/test_capi/test_hash.py.
aisk pushed a commit to aisk/cpython that referenced this issue Feb 11, 2024
@vstinner @aisk
pythongh-111545: Mention PEP 456 in PyHash_GetFuncDef() doc (python#1…
9b49671 
…12647)
aisk pushed a commit to aisk/cpython that referenced this issue Feb 11, 2024
@vstinner @aisk
pythongh-111545: Add Py_HashPointer() function (python#112096)
7569396 
* Implement _Py_HashPointerRaw() as a static inline function.
* Add Py_HashPointer() tests to test_capi.test_hash.
* Keep _Py_HashPointer() function as an alias to Py_HashPointer().
@vstinner
Copy link
Member

It was decided to not add a public API for now: capi-workgroup/decisions#2 (comment)

Glyphack pushed a commit to Glyphack/cpython that referenced this issue Sep 2, 2024
@vstinner @Glyphack
pythongh-111545: Add Include/cpython/pyhash.h header file (python#112063
ed7702e 
)

Move non-limited C API to a new Include/cpython/pyhash.h header file.
Glyphack pushed a commit to Glyphack/cpython that referenced this issue Sep 2, 2024
@vstinner @Glyphack
pythongh-111545: Test PyHash_GetFuncDef() function (python#112098)
fb6fb57 
Add Modules/_testcapi/hash.c and Lib/test/test_capi/test_hash.py.
Glyphack pushed a commit to Glyphack/cpython that referenced this issue Sep 2, 2024
@vstinner @Glyphack
pythongh-111545: Mention PEP 456 in PyHash_GetFuncDef() doc (python#1…
0ef2b75 
…12647)
Glyphack pushed a commit to Glyphack/cpython that referenced this issue Sep 2, 2024
@vstinner @Glyphack
pythongh-111545: Add Py_HashPointer() function (python#112096)
c305506 
* Implement _Py_HashPointerRaw() as a static inline function.
* Add Py_HashPointer() tests to test_capi.test_hash.
* Keep _Py_HashPointer() function as an alias to Py_HashPointer().
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
topic-C-API type-feature A feature request or enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@seberg @vstinner @encukou @serhiy-storchaka @AlexWaygood