Skip to content

Define the top-level public API #1742

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

Open
Kkkakania wants to merge 1 commit into
base: main
Choose a base branch
from
+66 −12
Open

Define the top-level public API #1742

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 36 additions & 12 deletions hvplot/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,23 +63,23 @@

import holoviews as _hv
import panel as _pn
from holoviews import render # noqa: F401
from holoviews import render

from . import sampledata # noqa: F401
from .converter import HoloViewsConverter # noqa: F401
from . import sampledata
from .converter import HoloViewsConverter
from .interactive import Interactive
from .plotting import (
andrews_curves, # noqa: F401
hvPlot, # noqa: F401
hvPlotTabular, # noqa: F401
lag_plot, # noqa: F401
parallel_coordinates, # noqa: F401
plot, # noqa: F401
scatter_matrix, # noqa: F401
andrews_curves,
hvPlot,
hvPlotTabular,
lag_plot,
parallel_coordinates,
plot,
scatter_matrix,
)
from .ui import explorer # noqa: F401
from .ui import explorer
from .util import _in_ipython, _PatchHvplotDocstrings
from .utilities import help, hvplot_extension, output, save, show # noqa: F401
from .utilities import help, hvplot_extension, output, save, show

# Define '__version__'
try:
Expand Down Expand Up @@ -116,6 +116,30 @@
# the package.
__version__ = '0.0.0+unknown'

__all__ = [
'HoloViewsConverter',
'Interactive',
'__version__',
'andrews_curves',
'bind',
'explorer',
'extension',
'help',
'hvPlot',
'hvPlotTabular',
'hvplot_extension',
'lag_plot',
'output',
'parallel_coordinates',
'plot',
'post_patch',
'render',
'sampledata',
'save',
'scatter_matrix',
'show',
]

_PATCH_PLOT_SIGNATURES = _in_ipython() or (
os.getenv('HVPLOT_PATCH_PLOT_DOCSTRING_SIGNATURE', 'false').lower() in ('1', 'true')
)
Expand Down
30 changes: 30 additions & 0 deletions hvplot/tests/test_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import hvplot

EXPECTED_PUBLIC_API = [
'HoloViewsConverter',
'Interactive',
'__version__',
'andrews_curves',
'bind',
'explorer',
'extension',
'help',
'hvPlot',
'hvPlotTabular',
'hvplot_extension',
'lag_plot',
'output',
'parallel_coordinates',
'plot',
'post_patch',
'render',
'sampledata',
'save',
'scatter_matrix',
'show',
]


def test_public_api():
assert hvplot.__all__ == EXPECTED_PUBLIC_API
assert all(hasattr(hvplot, name) for name in hvplot.__all__)