Fix Colab import error and suppress hdbscan SyntaxWarning #269
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add robust version parsing in _get_jupyter_frontend() with try-except to handle unexpected output formats (e.g., paths instead of versions) - Initialize working_backend='inline' before _get_jupyter_frontend() call to prevent UnboundLocalError if version parsing fails - Add notebook_version_tup None check before tuple comparison - Add tests/test_backend.py with regression tests for Colab edge case Fixes ValueError/UnboundLocalError when importing hypertools in Colab: ValueError: invalid literal for int() with base 10: '/usr/local/lib/python3' UnboundLocalError: cannot access local variable 'working_backend'
The hdbscan package has unescaped LaTeX backslashes in docstrings that trigger SyntaxWarning in Python 3.12+. Suppress this warning during import since it's harmless and outside our control.
Filter must be set before any imports to suppress compile-time warnings from hdbscan (imported transitively via umap-learn).
Use message='invalid escape sequence' pattern which reliably matches the hdbscan warnings regardless of module name resolution.
Set MPLBACKEND=Agg for pytest runs to avoid Tcl/Tk dependencies on headless CI environments. This is standard practice for CI systems that don't have display servers.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
ValueError/UnboundLocalErrorwhen importing hypertools in Google ColabSyntaxWarningfrom hdbscan's unescaped LaTeX docstrings in Python 3.12+Problem
When importing hypertools in Google Colab, users encountered:
This occurred because
jupyter notebook --versionin Colab returns a path instead of a version number, and the version parsing code didn't handle this edge case.Additionally, hdbscan (a dependency via umap-learn) has unescaped LaTeX backslashes in docstrings that trigger
SyntaxWarningin Python 3.12+.Changes
hypertools/plot/backend.py:working_backendbefore any code that could raise exceptionshypertools/__init__.py:SyntaxWarningon importtests/test_backend.py(new):Testing