From e3031a9b8383e52cf266ccfde56cb9070a5323b6 Mon Sep 17 00:00:00 2001 From: Matija Date: Mon, 11 Sep 2023 11:38:44 +0200 Subject: [PATCH 1/2] Write docs for convert module --- mage/query-modules/python/convert.md | 78 ++++++++++++++++++++++++++++ mage/templates/_mage_spells.mdx | 1 + sidebars/sidebarsMAGE.js | 1 + 3 files changed, 80 insertions(+) create mode 100644 mage/query-modules/python/convert.md diff --git a/mage/query-modules/python/convert.md b/mage/query-modules/python/convert.md new file mode 100644 index 00000000000..fac7809263d --- /dev/null +++ b/mage/query-modules/python/convert.md @@ -0,0 +1,78 @@ +--- +id: convert +title: convert +sidebar_label: convert +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import RunOnSubgraph from '../../templates/_run_on_subgraph.mdx'; + +export const Highlight = ({children, color}) => ( + + {children} + +); + +Module used for conversion of one data type to another. + +[![docs-source](https://img.shields.io/badge/source-convert-FB6E00?logo=github&style=for-the-badge)](https://github.com/memgraph/mage/blob/main/python/convert.py) + + +| Trait | Value | +| ------------------- | ----------------------------------------------------- | +| **Module type** | **util** | +| **Implementation** | **Python** | +| **Parallelism** | **sequential** | + +## Functins + +### `str2object(string)` + +Inline function that converts the input string to a object the string represents, using pythons `json.dumps` function. + +#### Input: + +- `string: string` ➡ input string that is converted,. + + +#### Output: + +- `mgp.Any` ➡ since the function is inline, the output is not named, and can be of various data types, depending of the content of the string. + +#### Usage: + +In this case, the string will be converted to a list. + +```cypher +RETURN convert.str2object("[1,2,3]") AS result; +``` + +```plaintext ++----------------------------+ +| result | ++----------------------------+ +| [1, 2, 3] | ++----------------------------+ +``` + +In this use case, the string will be converted into a map, containing a list. + + +```cypher +RETURN convert.str2object('{"key": [1,2,3]}') AS result; +``` + +```plaintext ++----------------------------+ +| result | ++----------------------------+ +| {"key": [1,2,3]} | ++----------------------------+ +``` diff --git a/mage/templates/_mage_spells.mdx b/mage/templates/_mage_spells.mdx index d0b89999366..88947072c72 100644 --- a/mage/templates/_mage_spells.mdx +++ b/mage/templates/_mage_spells.mdx @@ -56,6 +56,7 @@ | Algorithms | Lang | Description | | -------------------------------------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [conditional_execution](/mage/query-modules/cpp/conditional-execution) | C++ | Define conditions not expressible in Cypher and and use them to control query execution. | +| [convert](/mage/query-modules/python/convert) | Python | A module used for conversion from one data type to another. | | [export_util](/mage/query-modules/python/export-util) | Python | A module for exporting the graph database in different formats (JSON). | | [graph_analyzer](/mage/query-modules/python/graph-analyzer) | Python | This Graph Analyzer query module offers insights about the stored graph or a subgraph. | | [graph_util](/mage/query-modules/cpp/graph-util) | C++ | A module with common graph algorithms and graph manipulation utilities | diff --git a/sidebars/sidebarsMAGE.js b/sidebars/sidebarsMAGE.js index 229d7e59b8b..cef5e11736b 100644 --- a/sidebars/sidebarsMAGE.js +++ b/sidebars/sidebarsMAGE.js @@ -31,6 +31,7 @@ module.exports = { "query-modules/cpp/community-detection", "query-modules/cpp/community-detection-online", "query-modules/cpp/conditional-execution", + "query-modules/python/convert", "query-modules/cpp/cycles", "query-modules/cuda/cugraph", "query-modules/python/date", From 8dd91d3ac819cd0b53ab22bd5364e1f8eccc49aa Mon Sep 17 00:00:00 2001 From: Vlasta <95473291+vpavicic@users.noreply.github.com> Date: Tue, 12 Sep 2023 14:10:27 +0200 Subject: [PATCH 2/2] Apply suggestions from code review --- mage/query-modules/python/convert.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/mage/query-modules/python/convert.md b/mage/query-modules/python/convert.md index fac7809263d..f5e8c0e574b 100644 --- a/mage/query-modules/python/convert.md +++ b/mage/query-modules/python/convert.md @@ -35,16 +35,15 @@ Module used for conversion of one data type to another. ### `str2object(string)` -Inline function that converts the input string to a object the string represents, using pythons `json.dumps` function. +An inline function that converts the input string to an object the string represents using Python's `json.dumps` function. #### Input: - `string: string` ➡ input string that is converted,. - #### Output: -- `mgp.Any` ➡ since the function is inline, the output is not named, and can be of various data types, depending of the content of the string. +- `mgp.Any` ➡ since the function is inline, the output is not named, and can be of various data types, depending on the content of the string. #### Usage: