Skip to content
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

Jump to bottom

Export to file-like object #938

Merged
merged 20 commits into from
Dec 18, 2023
Merged

Export to file-like object #938

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
d725a25
Add to_svg, to_html, to_png, to_pdf functions to PlotSpec and SupPlot…
RYangazov Nov 17, 2023
33a8327
Minor fixes in code
RYangazov Nov 17, 2023
3d54e4f
Move functions to core. Remove docs, examples.
RYangazov Nov 21, 2023
1538f11
Add note to future_changes.md
RYangazov Nov 21, 2023
0e7e4e9
Fix format code
RYangazov Nov 21, 2023
41afa88
Refactoring and add demo notebook
RYangazov Nov 22, 2023
9b0f7c9
Fix notebook
RYangazov Nov 23, 2023
8914b98
Refactoring notebook
RYangazov Nov 23, 2023
db92e85
Change import place
RYangazov Nov 24, 2023
120d814
Fix path description in doc string
RYangazov Nov 24, 2023
38ab1d6
Changing the ggsave() function to use functions from core.py
RYangazov Nov 28, 2023
b9d2773
Returns path string in functions
RYangazov Nov 28, 2023
38552ad
Clearing not necessary imports
RYangazov Nov 29, 2023
12c01ea
Some minor fixes
RYangazov Dec 1, 2023
b791080
Some code changes
RYangazov Dec 4, 2023
a93455e
Modifying _makedirs function
RYangazov Dec 5, 2023
066c85a
Modifying demo notebook
RYangazov Dec 7, 2023
7a1ced0
Merging _to_pdf and _to_png to new function _export_as_raster
RYangazov Dec 12, 2023
6741bff
Fix path name
RYangazov Dec 13, 2023
2185a7c
Fix relative path for linux using cases
RYangazov Dec 15, 2023
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
Prev Previous commit
Next Next commit
Move functions to core. Remove docs, examples.
  • Loading branch information
@RYangazov
RYangazov committed Dec 5, 2023
commit 3d54e4fb6e6798a6298d7db4009e95246759cbf3
144 changes: 0 additions & 144 deletions python-package/lets_plot/frontend_context/_configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
# Copyright (c) 2019. JetBrains s.r.o.
# Use of this source code is governed by the MIT license that can be found in the LICENSE file.
#
import io
from typing import Dict, Any

from ._frontend_ctx import FrontendContext
Expand Down Expand Up @@ -120,146 +119,3 @@ def _as_html(plot_spec: Dict) -> str:
"""

return _frontend_contexts[TEXT_HTML].as_str(plot_spec)


def to_svg(spec: Any, path):
"""
Export plot to a file in SVG format.

Parameters
----------
spec : `PlotSpec` or `SupPlotsSpec`
Plot specification to export.
path : file-like object
File-like object to write SVG to.
"""
if not (isinstance(spec, PlotSpec) or isinstance(spec, SupPlotsSpec)):
raise ValueError("PlotSpec or SupPlotsSpec expected but was: {}".format(type(spec)))

from .. import _kbridge as kbr

svg = kbr._generate_svg(spec.as_dict())
if isinstance(path, str):
with io.open(path, mode="w", encoding="utf-8") as f:
f.write(svg)
else:
path.write(svg.encode())


def to_html(spec: Any, path, iframe: bool):
"""
Export plot to a file in HTML format.

Parameters
----------
spec : `PlotSpec` or `SupPlotsSpec`
Plot specification to export.
path : str, file-like object
Filename to save HTML under,
or file-like object to write HTML to.
iframe : bool, default=False
Whether to wrap HTML page into a iFrame.
"""
if iframe is None:
iframe = False
if not (isinstance(spec, PlotSpec) or isinstance(spec, SupPlotsSpec)):
raise ValueError("PlotSpec or SupPlotsSpec expected but was: {}".format(type(spec)))

from .. import _kbridge as kbr

html_page = kbr._generate_static_html_page(spec.as_dict(), iframe)
if isinstance(path, str):
with io.open(path, mode="w", encoding="utf-8") as f:
f.write(html_page)
else:
path.write(html_page.encode())


def to_png(spec: Any, path, scale: float):
"""
Export plot to a file in PNG format.

Parameters
----------
spec : `PlotSpec` or `SupPlotsSpec`
Plot specification to export.
path : str, file-like object
Filename to save PNG under,
or file-like object to write PNG to.
scale : float, default=2.0
Scaling factor for raster output.

Notes
-----
Export to PNG file uses the CairoSVG library.
CairoSVG is free and distributed under the LGPL-3.0 license.
For more details visit: https://cairosvg.org/documentation/

"""
if scale is None:
scale = 2.0
if not (isinstance(spec, PlotSpec) or isinstance(spec, SupPlotsSpec)):
raise ValueError("PlotSpec or SupPlotsSpec expected but was: {}".format(type(spec)))

try:
import cairosvg


except ImportError:
import sys
print("\n"
"To export Lets-Plot figure to a PNG file please install CairoSVG library to your Python environment.\n"
"CairoSVG is free and distributed under the LGPL-3.0 license.\n"
"For more details visit: https://cairosvg.org/documentation/\n", file=sys.stderr)
return None

from .. import _kbridge
# Use SVG image-rendering style as Cairo doesn't support CSS image-rendering style,
svg = _kbridge._generate_svg(spec.as_dict(), use_css_pixelated_image_rendering=False)

cairosvg.svg2png(bytestring=svg, write_to=path, scale=scale)


def to_pdf(spec: Any, path, scale: float):
"""
Export plot to a file in PDF format.

Parameters
----------
spec : `PlotSpec` or `SupPlotsSpec`
Plot specification to export.
path : str, file-like object
Filename to save PDF under,
or file-like object to write PDF to.
scale : float, default=2.0
Scaling factor for raster output.

Notes
-----
Export to PDF file uses the CairoSVG library.
CairoSVG is free and distributed under the LGPL-3.0 license.
For more details visit: https://cairosvg.org/documentation/

"""
if scale is None:
scale = 2.0
if not (isinstance(spec, PlotSpec) or isinstance(spec, SupPlotsSpec)):
raise ValueError("PlotSpec or SupPlotsSpec expected but was: {}".format(type(spec)))

try:
import cairosvg


except ImportError:
import sys
print("\n"
"To export Lets-Plot figure to a PDF file please install CairoSVG library to your Python environment.\n"
"CairoSVG is free and distributed under the LGPL-3.0 license.\n"
"For more details visit: https://cairosvg.org/documentation/\n", file=sys.stderr)
return None

from .. import _kbridge
# Use SVG image-rendering style as Cairo doesn't support CSS image-rendering style,
svg = _kbridge._generate_svg(spec.as_dict(), use_css_pixelated_image_rendering=False)

cairosvg.svg2pdf(bytestring=svg, write_to=path, scale=scale)
170 changes: 65 additions & 105 deletions python-package/lets_plot/plot/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
# Copyright (c) 2019. JetBrains s.r.o.
# Use of this source code is governed by the MIT license that can be found in the LICENSE file.
#
import io
import json

__all__ = ['aes', 'layer']
Expand Down Expand Up @@ -473,117 +474,76 @@ def show(self):
from ..frontend_context._configuration import _display_plot
_display_plot(self)

def to_svg(self, path):
"""
Save a plot in SVG format.

Examples
--------
.. jupyter-execute::
:linenos:
:emphasize-lines: 13

import numpy as np
import io
import os
from lets_plot import *
from IPython import display
LetsPlot.setup_html()
n = 60
np.random.seed(42)
x = np.random.choice(list('abcde'), size=n)
y = np.random.normal(size=n)
p = ggplot({'x': x, 'y': y}, aes(x='x', y='y')) + geom_jitter()
file_like = io.BytesIO()
p.to_svg(file_like)
display.SVG(file_like.getvalue())
"""
from ..frontend_context._configuration import to_svg
to_svg(self, path)

def to_html(self, path, iframe: bool):
"""
Save a plot in HTML format.

Examples
--------
.. jupyter-execute::
:linenos:
:emphasize-lines: 4

import numpy as np
import io
from lets_plot import *
LetsPlot.setup_html()
n = 60
np.random.seed(42)
x = np.random.choice(list('abcde'), size=n)
y = np.random.normal(size=n)
p = ggplot({'x': x, 'y': y}, aes(x='x', y='y')) + \
geom_jitter()
file_like = io.BytesIO()
p.to_html(file_like)
with open("out.html", "wb") as f:
f.write(file_like.getbuffer())
"""
from ..frontend_context._configuration import to_html
to_html(self, path, iframe)
def _to_svg(self, path):
if not isinstance(self, PlotSpec):
raise ValueError("PlotSpec expected but was: {}".format(type(self)))

def to_png(self, path, scale: float):
"""
Save a plot in PNG format.
from .. import _kbridge as kbr

Examples
--------
.. jupyter-execute::
:linenos:
:emphasize-lines: 12
svg = kbr._generate_svg(self.as_dict())
if isinstance(path, str):
with io.open(path, mode="w", encoding="utf-8") as f:
f.write(svg)
else:
path.write(svg.encode())

import numpy as np
import io
from lets_plot import *
LetsPlot.setup_html()
n = 60
np.random.seed(42)
x = np.random.choice(list('abcde'), size=n)
y = np.random.normal(size=n)
p = ggplot({'x': x, 'y': y}, aes(x='x', y='y')) + \
geom_jitter()
file_like = io.BytesIO()
p.to_png(file_like)
with open("out.html", "wb") as f:
f.write(file_like.getbuffer())
"""
from ..frontend_context._configuration import to_png
to_png(self, path, scale)
def _to_html(self, path, iframe: bool):
if iframe is None:
iframe = False
if not isinstance(self, PlotSpec):
raise ValueError("PlotSpec expected but was: {}".format(type(self)))

def to_pdf(self, path, scale: float):
"""
Save a plot in PDF format.
from .. import _kbridge as kbr

Examples
--------
.. jupyter-execute::
:linenos:
:emphasize-lines: 12
html_page = kbr._generate_static_html_page(self.as_dict(), iframe)
if isinstance(path, str):
with io.open(path, mode="w", encoding="utf-8") as f:
f.write(html_page)
else:
path.write(html_page.encode())

def _to_png(self, path, scale: float):
if scale is None:
scale = 2.0
if not isinstance(self, PlotSpec):
raise ValueError("PlotSpec expected but was: {}".format(type(self)))

try:
import cairosvg
except ImportError:
import sys
print("\n"
"To export Lets-Plot figure to a PNG file please install CairoSVG library to your Python environment.\n"
"CairoSVG is free and distributed under the LGPL-3.0 license.\n"
"For more details visit: https://cairosvg.org/documentation/\n", file=sys.stderr)
return None

from .. import _kbridge
# Use SVG image-rendering style as Cairo doesn't support CSS image-rendering style,
svg = _kbridge._generate_svg(self.as_dict(), use_css_pixelated_image_rendering=False)
cairosvg.svg2png(bytestring=svg, write_to=path, scale=scale)

def _to_pdf(self, path, scale: float):
if scale is None:
scale = 2.0
if not isinstance(self, PlotSpec):
raise ValueError("PlotSpec expected but was: {}".format(type(self)))

try:
import cairosvg
except ImportError:
import sys
print("\n"
"To export Lets-Plot figure to a PDF file please install CairoSVG library to your Python environment.\n"
"CairoSVG is free and distributed under the LGPL-3.0 license.\n"
"For more details visit: https://cairosvg.org/documentation/\n", file=sys.stderr)
return None

from .. import _kbridge
# Use SVG image-rendering style as Cairo doesn't support CSS image-rendering style,
svg = _kbridge._generate_svg(self.as_dict(), use_css_pixelated_image_rendering=False)
cairosvg.svg2pdf(bytestring=svg, write_to=path, scale=scale)

import numpy as np
import io
from lets_plot import *
LetsPlot.setup_html()
n = 60
np.random.seed(42)
x = np.random.choice(list('abcde'), size=n)
y = np.random.normal(size=n)
p = ggplot({'x': x, 'y': y}, aes(x='x', y='y')) + \
geom_jitter()
file_like = io.BytesIO()
p.to_pdf(file_like)
with open("out.html", "wb") as f:
f.write(file_like.getbuffer())
"""
from ..frontend_context._configuration import to_pdf
to_pdf(self, path, scale)

class LayerSpec(FeatureSpec):
"""
Expand Down
27 changes: 0 additions & 27 deletions python-package/lets_plot/plot/subplots.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,30 +114,3 @@ def show(self):
from ..frontend_context._configuration import _display_plot
_display_plot(self)

def to_svg(self, path):
"""
Save all plots currently in SVG.
"""
from ..frontend_context._configuration import to_svg
to_svg(self, path)

def to_html(self, path, iframe: bool):
"""
Save all plots currently in SVG.
"""
from ..frontend_context._configuration import to_html
to_html(self, path, iframe)

def to_png(self, path, scale: float):
"""
Save all plots currently in SVG.
"""
from ..frontend_context._configuration import to_png
to_png(self, path, scale)

def to_pdf(self, path, scale: float):
"""
Save all plots currently in SVG.
"""
from ..frontend_context._configuration import to_pdf
to_pdf(self, path, scale)