langchain_core: add file_type option to make file type default as png
#27855
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
langchain_core.runnables.graph_mermaid.draw_mermaid_png calls this function, but the Mermaid API returns JPEG as default. Add option `file_type` with default `png` type to be consistent. Also background_color default was wrong and fixed with `!`
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Skipped Deployment
|
dosubot
bot
added
size:XS
I mistakenly thought there was an error in the `background_color` option and added a `!` for correction. However, the `!` was already correctly added further down. This commit reverts the incorrect fix.
The `file_type` option was added as the second option, but the other function calling the function `_render_mermaid_using_api` without option names crashes. The `file_type` option was added as the last option, so the effect is controlled locally.
vbarda
reviewed
Nov 5, 2024
| @@ -306,6 +306,7 @@ def _render_mermaid_using_api( | |||
| mermaid_syntax: str, | |||
| output_file_path: Optional[str] = None, | |||
| background_color: Optional[str] = "white", | |||
| file_type: Optional[str] = "png", | |||
There was a problem hiding this comment.
could you make the type Optional[Literal["jpeg", "png", "webp"]]
There was a problem hiding this comment.
Thank you for the review.
typing.Literal is imported and type annotation is updated as suggested.
vbarda
approved these changes
Nov 5, 2024
dosubot
bot
added
the
lgtm
I have updated the type annotations to be more stringent. `Optional[str]` to `Optional[Literal["jpeg", "png", "webp"]]`.
`Literal` has not been imported. Fixed.
vbarda
approved these changes
Nov 6, 2024
yanomaly
pushed a commit
to yanomaly/langchain
that referenced
this pull request
Nov 8, 2024
…png` (langchain-ai#27855) Thank you for contributing to LangChain! - [ ] **PR title**: "package: description" - Where "package" is whichever of langchain, community, core, etc. is being modified. Use "docs: ..." for purely docs changes, "templates: ..." for template changes, "infra: ..." for CI changes. - Example: "community: add foobar LLM" - [ ] **description** langchain_core.runnables.graph_mermaid.draw_mermaid_png calls this function, but the Mermaid API returns JPEG by default. To be consistent, add the option `file_type` with the default `png` type. - [ ] **Add tests and docs**: If you're adding a new integration, please include With this small change, I didn't add tests and docs. - [ ] **Lint and test**: Run `make format`, `make lint` and `make test` from the root of the package(s) you've modified. See contribution guidelines for more: One long sentence was divided into two. Additional guidelines: - Make sure optional dependencies are imported within a function. - Please do not add dependencies to pyproject.toml files (even optional ones) unless they are required for unit tests. - Most PRs should not touch more than one package. - Changes should be backwards compatible. - If you are adding something to community, do not re-import it in langchain. If no one reviews your PR within a few days, please @-mention one of baskaryan, efriis, eyurtsev, ccurme, vbarda, hwchase17.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Thank you for contributing to LangChain!
PR title: "package: description"
description
langchain_core.runnables.graph_mermaid.draw_mermaid_png calls this function, but the Mermaid API returns JPEG by default. To be consistent, add the option
file_typewith the defaultpngtype.Add tests and docs: If you're adding a new integration, please include
With this small change, I didn't add tests and docs.
Lint and test: Run
make format,make lintandmake testfrom the root of the package(s) you've modified. See contribution guidelines for more:One long sentence was divided into two.
Additional guidelines:
If no one reviews your PR within a few days, please @-mention one of baskaryan, efriis, eyurtsev, ccurme, vbarda, hwchase17.