From 0a7bcc05b74f256c57798f95bc0746293b00d7ed Mon Sep 17 00:00:00 2001 From: Shmuel Melamud Date: Mon, 30 Oct 2023 20:41:18 +0200 Subject: [PATCH] Changes in Structure class in moeralib 0.14.2. --- development/python-moeralib/index.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/development/python-moeralib/index.md b/development/python-moeralib/index.md index f8c0901..2ebb824 100644 --- a/development/python-moeralib/index.md +++ b/development/python-moeralib/index.md @@ -59,14 +59,9 @@ in JSON, the corresponding field in Python is set to `None`. ## Structures Inputs and outputs of API calls are represented as plain Python classes derived from -`Structure` class. All structures have a constructor with a single parameter that -creates a structure object from a JSON object represented as a `dict` (as returned -from `json.load()`). The constructor automatically converts field names from camel -case to snake case (if needed) and creates nested structures in accordance with fields' -type specifications. - -The constructor is designed to be used internally, but you can also use it to -initialize a structure. These code snippets are equivalent: +`Structure` class. All structures have a constructor with keyword parameters that +correspond to fields of the structure. You can use the constructor to initialize +a structure. These code snippets are equivalent: ```python attrs = DomainAttributes() @@ -74,12 +69,19 @@ attrs.domain = 'dave.moera.club' attrs.node_id = DAVE_NODE_ID ``` ```python -attrs = DomainAttributes({ - 'domain': 'dave.moera.club' - 'node_id': DAVE_NODE_ID -}) +attrs = DomainAttributes( + domain='dave.moera.club', + node_id=DAVE_NODE_ID +) ``` +There are two more methods designed to be used internally. + +`from_json()` method creates a structure object from a JSON object represented as +a `dict` (as returned from `json.load()`). The method automatically converts field +names from camel case to snake case (if needed) and creates nested structures in +accordance with fields' type specifications. + `json()` method converts the structure back to a `dict` representing a JSON structure, converting all field names to camel case.