From 5ae24891b4c0b972e1e502f51a547681fa8b2b7e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20tom=20W=C3=B6rden?= <h.tomwoerden@indiscale.com>
Date: Mon, 4 Mar 2024 13:57:46 +0100
Subject: [PATCH] DOC: fix doc strings
---
.../table_json_conversion/table_generator.py | 17 +++++++++--------
1 file changed, 9 insertions(+), 8 deletions(-)
diff --git a/src/caosadvancedtools/table_json_conversion/table_generator.py b/src/caosadvancedtools/table_json_conversion/table_generator.py
index 1e8f9392..f0e8f6c6 100644
--- a/src/caosadvancedtools/table_json_conversion/table_generator.py
+++ b/src/caosadvancedtools/table_json_conversion/table_generator.py
@@ -38,6 +38,7 @@ class ColumnType(Enum):
SCALAR = 1
LIST = 2
FOREIGN = 3
+ IGNORE = 3
class RowType(Enum):
@@ -62,20 +63,20 @@ class TableTemplateGenerator(ABC):
elements of the path within the JSON where the key is needed. Suppose we want
to distinguis Persons that are referenced by Trainings, foreign_keys must at
least contain the following: {"Training": {"Person": [key1, key2]}}.
- Values wihtin the dicts can be a list representing the keys, a tuple where
- the first element is the list representing the keys and the second elment is
- a dict that allows to set further foreign keys at lower depth. The third
- possibility is a dict. In that case no foreign keys exist at that level (
- e.g. in the above example there is no foreign key for the path ["Training"].
+ Values wihtin the dicts can be a list representing the keys or
+ a dict that allows to set further foreign keys at lower depth.
+ In latter case if foreign keys exist at that level (
+ e.g. in the above example there might be further levels below "Person".),
+ then the keys can be set using the special "__this__" key.
+ Example: {"Training": {"__this__": ["date"], "Person": [key1, key2]}}
+ Here, "date" is the sole key for Training.
"""
pass
def _generate_sheets_from_schema(self, schema: dict, foreign_keys: dict = None
- ) -> dict[str, dict[str, tuple[str, list]]]:
+ ) -> dict[str, dict[str, list]]:
""" generates a sheet definition from a given JSON schema
-
-
Parameters
----------
schema: dict
--
GitLab