-
Notifications
You must be signed in to change notification settings - Fork 97
Closes #5216: remove camelCase #5218
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
base: main
Are you sure you want to change the base?
Conversation
b4fa3ef to
ec204ef
Compare
b8aa312 to
308230f
Compare
308230f to
cae187e
Compare
cae187e to
bed84c3
Compare
bed84c3 to
c310474
Compare
1RyanK
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5218 +/- ##
========================================
Coverage ? 100.00%
========================================
Files ? 42
Lines ? 1150
Branches ? 0
========================================
Hits ? 1150
Misses ? 0
Partials ? 0 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Standardize Public API Naming & Add Deprecation Shims
Summary
This PR standardizes Arkouda’s public Python API to PEP 8–compliant snake_case naming, while preserving backward compatibility through explicit deprecation shims. The goal is to modernize the API surface, unblock stricter linting (Ruff N802), and provide a clear, low-risk migration path for users.
No user-facing functionality is removed in this PR.
Key Changes
1. Snake_case canonical APIs
The following camelCase public APIs have been replaced with snake_case equivalents and updated throughout the codebase:
Dtype / scalar helpers
isSupportedInt→is_supported_intisSupportedFloat→is_supported_floatisSupportedNumber→is_supported_numberisSupportedBool→is_supported_boolisSupportedDType/isSupportedDtype→is_supported_dtypeLogger API
getArkoudaLogger→get_arkouda_loggergetArkoudaClientLogger→get_arkouda_client_loggerenableVerbose→enable_verbosedisableVerbose→disable_verboseArkoudaLogger.changeLogLevel→change_log_levelArkoudaLogger.getHandler→get_handlerClient dtypes
BitVectorizer→bit_vectorizerRandom (legacy)
globalGeneratorExists→global_generator_existsgetGlobalGenerator→get_global_generator2. Backward-compatible deprecation shims
All legacy camelCase names are retained as thin wrapper aliases that:
DeprecationWarningThis ensures existing user code continues to work unchanged while providing a clear upgrade signal.
3. Ruff configuration cleanup
N802[lint.pep8-naming].ignore-names4. Internal cleanups (non-user-facing)
_matmul2D → _matmul2dCompatibility & Migration
Rationale
This change:
Closes #5216: remove camelCase