Skip to content

feat: add __all__ to hvplot/__init__.py to define public API#1718

Closed
toroleapinc wants to merge 2 commits into
holoviz:mainfrom
toroleapinc:feat/issue-1626-add-all-exports
Closed

feat: add __all__ to hvplot/__init__.py to define public API#1718
toroleapinc wants to merge 2 commits into
holoviz:mainfrom
toroleapinc:feat/issue-1626-add-all-exports

Conversation

@toroleapinc

@toroleapinc toroleapinc commented Mar 3, 2026

Copy link
Copy Markdown

Summary

Add __all__ to hvplot/__init__.py to explicitly define the public API.

Closes (partial) #1626 (partial: main __init__.py only, other submodules can be done in follow-up PRs)

What's included

All publicly documented functions, classes, and modules:

  • Plot functions: andrews_curves, lag_plot, parallel_coordinates, scatter_matrix, plot
  • Core classes: HoloViewsConverter, hvPlot, hvPlotTabular, Interactive
  • Utilities: help, hvplot_extension, output, save, show, bind, post_patch
  • UI: explorer
  • Re-exports: render, extension
  • Data: sampledata

Private utilities (prefixed with _) are intentionally excluded.

Define the public API by adding __all__ to the main hvplot package.
This includes all publicly documented functions, classes and modules
that are intended for user consumption.

Closes #1626 (partial: main __init__.py only)

Signed-off-by: edvatar <88481784+toroleapinc@users.noreply.github.com>
@hoxbro

hoxbro commented Mar 4, 2026

Copy link
Copy Markdown
Member

Thank you for the PR.

Two things:
You need to fix the lint and add __version__ as we treat this as public.

Signed-off-by: edvatar <88481784+toroleapinc@users.noreply.github.com>
@toroleapinc

Copy link
Copy Markdown
Author

Thanks for the review! __version__ is already included in __all__ (line 22). Ruff passes clean locally — could you let me know which lint issue you're seeing? Happy to fix.

@hoxbro

hoxbro commented Mar 4, 2026

Copy link
Copy Markdown
Member

Please give me an AI disclosure. You have applied the changes yourself after my comment...

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.

2 participants