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

Allow to use paths with extensions in image exporter #277

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Allow to use paths with extensions in image exporter #277

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
20 changes: 17 additions & 3 deletions src/Plotly.NET.ImageExport/PuppeteerSharpRenderer.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ module PuppeteerSharpRendererOptions =

let mutable localBrowserExecutablePath = None

module internal Path =

/// checks whether provided path has correct extension and sets if no extension provided
let ensureFileExtension (ext: string) (path: string) =
match Path.GetExtension(path) with
| "" -> sprintf "%s%s" path ext
| e when String.Compare(e, ext, StringComparison.OrdinalIgnoreCase) = 0 -> path
| _ as e -> failwithf "Provided path contains wrong file extension. Expected '%s' got '%s'." ext e
Comment on lines +22 to +26
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Honestly, I'd just write wherever the user wants to. I think it's not smart to dictate the user what extension should be. Why can't we just write a jpg to a txt file? It would make it transparent


type PuppeteerSharpRenderer() =

Expand Down Expand Up @@ -135,8 +143,10 @@ type PuppeteerSharpRenderer() =
let! rendered =
(this :> IGenericChartRenderer)
.RenderJPGAsync(width, height, gChart)

let path = Path.ensureFileExtension ".jpg" path

return rendered |> getBytesFromBase64String |> fun base64 -> File.WriteAllBytes($"{path}.jpg", base64)
return rendered |> getBytesFromBase64String |> fun base64 -> File.WriteAllBytes(path, base64)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I 💯 agree with this change. Adding silent .jpg is imo not a good idea.

}

member this.SaveJPG(path: string, width: int, height: int, gChart: GenericChart.GenericChart) =
Expand All @@ -162,7 +172,9 @@ type PuppeteerSharpRenderer() =
(this :> IGenericChartRenderer)
.RenderPNGAsync(width, height, gChart)

return rendered |> getBytesFromBase64String |> fun base64 -> File.WriteAllBytes($"{path}.png", base64)
let path = Path.ensureFileExtension ".png" path

return rendered |> getBytesFromBase64String |> fun base64 -> File.WriteAllBytes(path, base64)
}

member this.SavePNG(path: string, width: int, height: int, gChart: GenericChart.GenericChart) =
Expand Down Expand Up @@ -190,8 +202,10 @@ type PuppeteerSharpRenderer() =
let! rendered =
(this :> IGenericChartRenderer)
.RenderSVGAsync(width, height, gChart)

let path = Path.ensureFileExtension ".svg" path

return rendered |> fun svg -> File.WriteAllText($"{path}.svg", svg)
return rendered |> fun svg -> File.WriteAllText(path, svg)
}

member this.SaveSVG(path: string, width: int, height: int, gChart: GenericChart.GenericChart) =
Expand Down