Skip to content

Switch Plottable to a Protocol #667

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

Merged
exrhizo merged 3 commits into from
Jun 20, 2025
Merged

Switch Plottable to a Protocol #667

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
71fec5e
Switch Plottable to a Protocol
exrhizo Jun 18, 2025
dd258f4
update changelog, comment, docs
exrhizo Jun 19, 2025
2bfc6bf
add overloads for transform
exrhizo Jun 19, 2025
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
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ All notable changes to the PyGraphistry are documented in this file. The PyGraph
The changelog format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and all PyGraphistry-specific breaking changes are explictly noted here.

## Dev

### Breaking
* Plottable is now a Protocol
* py.typed added, type checking active on PyGraphistry!

## [0.38.0 - 2025-06-17]

### Changed
Expand Down
1 change: 0 additions & 1 deletion docs/source/api/ai.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,5 +58,4 @@ HeterographEmbedModuleMixin
.. automodule:: graphistry.embed_utils
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/source/api/compute.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ ComputeMixin module
.. automodule:: graphistry.compute.ComputeMixin
:members:
:undoc-members:
:inherited-members:
:show-inheritance:

Collapse
Expand Down
1 change: 0 additions & 1 deletion docs/source/api/layout/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,4 @@ LayoutsMixin
.. automodule:: graphistry.layouts.LayoutsMixin
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
12 changes: 7 additions & 5 deletions docs/source/api/plotter.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,20 @@ Plotter Class
:inherited-members:
:show-inheritance:

Plottable Interface

PlotterBase Class
----------------------
.. automodule:: graphistry.Plottable
.. automodule:: graphistry.PlotterBase
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
Comment thread
exrhizo marked this conversation as resolved.

PlotterBase Class

Plottable Interface
----------------------
.. automodule:: graphistry.PlotterBase
.. automodule:: graphistry.Plottable
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/source/api/plugins/compute/cugraph.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ cuGraph is a GPU-accelerated graph library that leverages the Nvidia RAPIDS ecos
.. automodule:: graphistry.plugins.cugraph
:members:
:undoc-members:
:inherited-members:
:show-inheritance:

.. rubric:: Constants
Expand Down
1 change: 0 additions & 1 deletion docs/source/api/plugins/compute/graphviz.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ graphviz is a popular graph visualization library that PyGraphistry can interfac
.. automodule:: graphistry.plugins.graphviz
:members:
:undoc-members:
:inherited-members:
:show-inheritance:

.. rubric:: Constants
Expand Down
1 change: 0 additions & 1 deletion docs/source/api/plugins/compute/igraph.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ igraph is a popular graph library that PyGraphistry can interface with. This all
.. automodule:: graphistry.plugins.igraph
:members:
:undoc-members:
:inherited-members:
:show-inheritance:

.. rubric:: Constants
Expand Down
1 change: 0 additions & 1 deletion docs/source/api/plugins/db/cosmos.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,4 @@ Azure Cosmos DB supports Gremlin graph queries
.. autoclass:: graphistry.gremlin.CosmosMixin
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/source/api/plugins/db/gremlin.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,4 @@ As an open source technology, multiple databases support it.
.. autoclass:: graphistry.gremlin.GremlinMixin
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/source/api/plugins/db/neptune.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,4 @@ Amazon Neptune is a managed graph database by Amazon. It supports OpenCypher, RD
.. autoclass:: graphistry.gremlin.NeptuneMixin
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
2 changes: 0 additions & 2 deletions graphistry/Engine.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ def resolve_engine(
return Engine(engine.value)

if g_or_df is not None:
# work around circular dependency
from graphistry.Plottable import Plottable
if isinstance(g_or_df, Plottable):
if g_or_df._nodes is not None and g_or_df._edges is not None:
Expand All @@ -48,7 +47,6 @@ def resolve_engine(
warnings.warn(f'Edges and nodes must be same type for auto engine selection, got: {type(g_or_df._edges)} and {type(g_or_df._nodes)}')
g_or_df = g_or_df._edges if g_or_df._edges is not None else g_or_df._nodes

if g_or_df is not None:
if isinstance(g_or_df, pd.DataFrame):
return Engine.PANDAS

Expand Down
Loading
Loading