edsl 0.1.36.dev6__py3-none-any.whl → 0.1.37__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (261) hide show
  1. edsl/Base.py +303 -303
  2. edsl/BaseDiff.py +260 -260
  3. edsl/TemplateLoader.py +24 -24
  4. edsl/__init__.py +48 -47
  5. edsl/__version__.py +1 -1
  6. edsl/agents/Agent.py +855 -804
  7. edsl/agents/AgentList.py +350 -337
  8. edsl/agents/Invigilator.py +222 -222
  9. edsl/agents/InvigilatorBase.py +284 -294
  10. edsl/agents/PromptConstructor.py +353 -312
  11. edsl/agents/__init__.py +3 -3
  12. edsl/agents/descriptors.py +99 -86
  13. edsl/agents/prompt_helpers.py +129 -129
  14. edsl/auto/AutoStudy.py +117 -117
  15. edsl/auto/StageBase.py +230 -230
  16. edsl/auto/StageGenerateSurvey.py +178 -178
  17. edsl/auto/StageLabelQuestions.py +125 -125
  18. edsl/auto/StagePersona.py +61 -61
  19. edsl/auto/StagePersonaDimensionValueRanges.py +88 -88
  20. edsl/auto/StagePersonaDimensionValues.py +74 -74
  21. edsl/auto/StagePersonaDimensions.py +69 -69
  22. edsl/auto/StageQuestions.py +73 -73
  23. edsl/auto/SurveyCreatorPipeline.py +21 -21
  24. edsl/auto/utilities.py +224 -224
  25. edsl/base/Base.py +289 -289
  26. edsl/config.py +149 -149
  27. edsl/conjure/AgentConstructionMixin.py +160 -152
  28. edsl/conjure/Conjure.py +62 -62
  29. edsl/conjure/InputData.py +659 -659
  30. edsl/conjure/InputDataCSV.py +48 -48
  31. edsl/conjure/InputDataMixinQuestionStats.py +182 -182
  32. edsl/conjure/InputDataPyRead.py +91 -91
  33. edsl/conjure/InputDataSPSS.py +8 -8
  34. edsl/conjure/InputDataStata.py +8 -8
  35. edsl/conjure/QuestionOptionMixin.py +76 -76
  36. edsl/conjure/QuestionTypeMixin.py +23 -23
  37. edsl/conjure/RawQuestion.py +65 -65
  38. edsl/conjure/SurveyResponses.py +7 -7
  39. edsl/conjure/__init__.py +9 -9
  40. edsl/conjure/naming_utilities.py +263 -263
  41. edsl/conjure/utilities.py +201 -201
  42. edsl/conversation/Conversation.py +290 -238
  43. edsl/conversation/car_buying.py +58 -58
  44. edsl/conversation/chips.py +95 -0
  45. edsl/conversation/mug_negotiation.py +81 -81
  46. edsl/conversation/next_speaker_utilities.py +93 -93
  47. edsl/coop/PriceFetcher.py +54 -54
  48. edsl/coop/__init__.py +2 -2
  49. edsl/coop/coop.py +958 -849
  50. edsl/coop/utils.py +131 -131
  51. edsl/data/Cache.py +527 -527
  52. edsl/data/CacheEntry.py +228 -228
  53. edsl/data/CacheHandler.py +149 -149
  54. edsl/data/RemoteCacheSync.py +97 -84
  55. edsl/data/SQLiteDict.py +292 -292
  56. edsl/data/__init__.py +4 -4
  57. edsl/data/orm.py +10 -10
  58. edsl/data_transfer_models.py +73 -73
  59. edsl/enums.py +173 -173
  60. edsl/exceptions/BaseException.py +21 -0
  61. edsl/exceptions/__init__.py +54 -50
  62. edsl/exceptions/agents.py +38 -40
  63. edsl/exceptions/configuration.py +16 -16
  64. edsl/exceptions/coop.py +10 -10
  65. edsl/exceptions/data.py +14 -14
  66. edsl/exceptions/general.py +34 -34
  67. edsl/exceptions/jobs.py +33 -33
  68. edsl/exceptions/language_models.py +63 -63
  69. edsl/exceptions/prompts.py +15 -15
  70. edsl/exceptions/questions.py +91 -91
  71. edsl/exceptions/results.py +29 -26
  72. edsl/exceptions/scenarios.py +22 -0
  73. edsl/exceptions/surveys.py +37 -34
  74. edsl/inference_services/AnthropicService.py +87 -87
  75. edsl/inference_services/AwsBedrock.py +120 -115
  76. edsl/inference_services/AzureAI.py +217 -217
  77. edsl/inference_services/DeepInfraService.py +18 -18
  78. edsl/inference_services/GoogleService.py +156 -156
  79. edsl/inference_services/GroqService.py +20 -20
  80. edsl/inference_services/InferenceServiceABC.py +147 -147
  81. edsl/inference_services/InferenceServicesCollection.py +97 -72
  82. edsl/inference_services/MistralAIService.py +123 -123
  83. edsl/inference_services/OllamaService.py +18 -18
  84. edsl/inference_services/OpenAIService.py +224 -224
  85. edsl/inference_services/TestService.py +89 -89
  86. edsl/inference_services/TogetherAIService.py +170 -170
  87. edsl/inference_services/models_available_cache.py +118 -118
  88. edsl/inference_services/rate_limits_cache.py +25 -25
  89. edsl/inference_services/registry.py +39 -39
  90. edsl/inference_services/write_available.py +10 -10
  91. edsl/jobs/Answers.py +56 -56
  92. edsl/jobs/Jobs.py +1347 -1112
  93. edsl/jobs/__init__.py +1 -1
  94. edsl/jobs/buckets/BucketCollection.py +63 -63
  95. edsl/jobs/buckets/ModelBuckets.py +65 -65
  96. edsl/jobs/buckets/TokenBucket.py +248 -248
  97. edsl/jobs/interviews/Interview.py +661 -651
  98. edsl/jobs/interviews/InterviewExceptionCollection.py +99 -99
  99. edsl/jobs/interviews/InterviewExceptionEntry.py +186 -182
  100. edsl/jobs/interviews/InterviewStatistic.py +63 -63
  101. edsl/jobs/interviews/InterviewStatisticsCollection.py +25 -25
  102. edsl/jobs/interviews/InterviewStatusDictionary.py +78 -78
  103. edsl/jobs/interviews/InterviewStatusLog.py +92 -92
  104. edsl/jobs/interviews/ReportErrors.py +66 -66
  105. edsl/jobs/interviews/interview_status_enum.py +9 -9
  106. edsl/jobs/runners/JobsRunnerAsyncio.py +338 -337
  107. edsl/jobs/runners/JobsRunnerStatus.py +332 -332
  108. edsl/jobs/tasks/QuestionTaskCreator.py +242 -242
  109. edsl/jobs/tasks/TaskCreators.py +64 -64
  110. edsl/jobs/tasks/TaskHistory.py +442 -441
  111. edsl/jobs/tasks/TaskStatusLog.py +23 -23
  112. edsl/jobs/tasks/task_status_enum.py +163 -163
  113. edsl/jobs/tokens/InterviewTokenUsage.py +27 -27
  114. edsl/jobs/tokens/TokenUsage.py +34 -34
  115. edsl/language_models/KeyLookup.py +30 -0
  116. edsl/language_models/LanguageModel.py +706 -718
  117. edsl/language_models/ModelList.py +102 -102
  118. edsl/language_models/RegisterLanguageModelsMeta.py +184 -184
  119. edsl/language_models/__init__.py +3 -2
  120. edsl/language_models/fake_openai_call.py +15 -15
  121. edsl/language_models/fake_openai_service.py +61 -61
  122. edsl/language_models/registry.py +137 -137
  123. edsl/language_models/repair.py +156 -156
  124. edsl/language_models/unused/ReplicateBase.py +83 -83
  125. edsl/language_models/utilities.py +64 -64
  126. edsl/notebooks/Notebook.py +259 -259
  127. edsl/notebooks/__init__.py +1 -1
  128. edsl/prompts/Prompt.py +357 -358
  129. edsl/prompts/__init__.py +2 -2
  130. edsl/questions/AnswerValidatorMixin.py +289 -289
  131. edsl/questions/QuestionBase.py +656 -616
  132. edsl/questions/QuestionBaseGenMixin.py +161 -161
  133. edsl/questions/QuestionBasePromptsMixin.py +234 -266
  134. edsl/questions/QuestionBudget.py +227 -227
  135. edsl/questions/QuestionCheckBox.py +359 -359
  136. edsl/questions/QuestionExtract.py +183 -183
  137. edsl/questions/QuestionFreeText.py +114 -113
  138. edsl/questions/QuestionFunctional.py +159 -159
  139. edsl/questions/QuestionList.py +231 -231
  140. edsl/questions/QuestionMultipleChoice.py +286 -286
  141. edsl/questions/QuestionNumerical.py +153 -153
  142. edsl/questions/QuestionRank.py +324 -324
  143. edsl/questions/Quick.py +41 -41
  144. edsl/questions/RegisterQuestionsMeta.py +71 -71
  145. edsl/questions/ResponseValidatorABC.py +174 -174
  146. edsl/questions/SimpleAskMixin.py +73 -73
  147. edsl/questions/__init__.py +26 -26
  148. edsl/questions/compose_questions.py +98 -98
  149. edsl/questions/decorators.py +21 -21
  150. edsl/questions/derived/QuestionLikertFive.py +76 -76
  151. edsl/questions/derived/QuestionLinearScale.py +87 -87
  152. edsl/questions/derived/QuestionTopK.py +91 -91
  153. edsl/questions/derived/QuestionYesNo.py +82 -82
  154. edsl/questions/descriptors.py +413 -418
  155. edsl/questions/prompt_templates/question_budget.jinja +13 -13
  156. edsl/questions/prompt_templates/question_checkbox.jinja +32 -32
  157. edsl/questions/prompt_templates/question_extract.jinja +11 -11
  158. edsl/questions/prompt_templates/question_free_text.jinja +3 -3
  159. edsl/questions/prompt_templates/question_linear_scale.jinja +11 -11
  160. edsl/questions/prompt_templates/question_list.jinja +17 -17
  161. edsl/questions/prompt_templates/question_multiple_choice.jinja +33 -33
  162. edsl/questions/prompt_templates/question_numerical.jinja +36 -36
  163. edsl/questions/question_registry.py +147 -147
  164. edsl/questions/settings.py +12 -12
  165. edsl/questions/templates/budget/answering_instructions.jinja +7 -7
  166. edsl/questions/templates/budget/question_presentation.jinja +7 -7
  167. edsl/questions/templates/checkbox/answering_instructions.jinja +10 -10
  168. edsl/questions/templates/checkbox/question_presentation.jinja +22 -22
  169. edsl/questions/templates/extract/answering_instructions.jinja +7 -7
  170. edsl/questions/templates/likert_five/answering_instructions.jinja +10 -10
  171. edsl/questions/templates/likert_five/question_presentation.jinja +11 -11
  172. edsl/questions/templates/linear_scale/answering_instructions.jinja +5 -5
  173. edsl/questions/templates/linear_scale/question_presentation.jinja +5 -5
  174. edsl/questions/templates/list/answering_instructions.jinja +3 -3
  175. edsl/questions/templates/list/question_presentation.jinja +5 -5
  176. edsl/questions/templates/multiple_choice/answering_instructions.jinja +9 -9
  177. edsl/questions/templates/multiple_choice/question_presentation.jinja +11 -11
  178. edsl/questions/templates/numerical/answering_instructions.jinja +6 -6
  179. edsl/questions/templates/numerical/question_presentation.jinja +6 -6
  180. edsl/questions/templates/rank/answering_instructions.jinja +11 -11
  181. edsl/questions/templates/rank/question_presentation.jinja +15 -15
  182. edsl/questions/templates/top_k/answering_instructions.jinja +8 -8
  183. edsl/questions/templates/top_k/question_presentation.jinja +22 -22
  184. edsl/questions/templates/yes_no/answering_instructions.jinja +6 -6
  185. edsl/questions/templates/yes_no/question_presentation.jinja +11 -11
  186. edsl/results/Dataset.py +293 -293
  187. edsl/results/DatasetExportMixin.py +717 -693
  188. edsl/results/DatasetTree.py +145 -145
  189. edsl/results/Result.py +450 -433
  190. edsl/results/Results.py +1071 -1158
  191. edsl/results/ResultsDBMixin.py +238 -238
  192. edsl/results/ResultsExportMixin.py +43 -43
  193. edsl/results/ResultsFetchMixin.py +33 -33
  194. edsl/results/ResultsGGMixin.py +121 -121
  195. edsl/results/ResultsToolsMixin.py +98 -98
  196. edsl/results/Selector.py +135 -118
  197. edsl/results/__init__.py +2 -2
  198. edsl/results/tree_explore.py +115 -115
  199. edsl/scenarios/FileStore.py +458 -443
  200. edsl/scenarios/Scenario.py +546 -507
  201. edsl/scenarios/ScenarioHtmlMixin.py +64 -59
  202. edsl/scenarios/ScenarioList.py +1112 -1101
  203. edsl/scenarios/ScenarioListExportMixin.py +52 -52
  204. edsl/scenarios/ScenarioListPdfMixin.py +261 -261
  205. edsl/scenarios/__init__.py +4 -2
  206. edsl/shared.py +1 -1
  207. edsl/study/ObjectEntry.py +173 -173
  208. edsl/study/ProofOfWork.py +113 -113
  209. edsl/study/SnapShot.py +80 -80
  210. edsl/study/Study.py +528 -528
  211. edsl/study/__init__.py +4 -4
  212. edsl/surveys/DAG.py +148 -148
  213. edsl/surveys/Memory.py +31 -31
  214. edsl/surveys/MemoryPlan.py +244 -244
  215. edsl/surveys/Rule.py +330 -324
  216. edsl/surveys/RuleCollection.py +387 -387
  217. edsl/surveys/Survey.py +1795 -1772
  218. edsl/surveys/SurveyCSS.py +261 -261
  219. edsl/surveys/SurveyExportMixin.py +259 -259
  220. edsl/surveys/SurveyFlowVisualizationMixin.py +121 -121
  221. edsl/surveys/SurveyQualtricsImport.py +284 -284
  222. edsl/surveys/__init__.py +3 -3
  223. edsl/surveys/base.py +53 -53
  224. edsl/surveys/descriptors.py +56 -56
  225. edsl/surveys/instructions/ChangeInstruction.py +47 -47
  226. edsl/surveys/instructions/Instruction.py +51 -51
  227. edsl/surveys/instructions/InstructionCollection.py +77 -77
  228. edsl/templates/error_reporting/base.html +23 -23
  229. edsl/templates/error_reporting/exceptions_by_model.html +34 -34
  230. edsl/templates/error_reporting/exceptions_by_question_name.html +16 -16
  231. edsl/templates/error_reporting/exceptions_by_type.html +16 -16
  232. edsl/templates/error_reporting/interview_details.html +115 -115
  233. edsl/templates/error_reporting/interviews.html +9 -9
  234. edsl/templates/error_reporting/overview.html +4 -4
  235. edsl/templates/error_reporting/performance_plot.html +1 -1
  236. edsl/templates/error_reporting/report.css +73 -73
  237. edsl/templates/error_reporting/report.html +117 -117
  238. edsl/templates/error_reporting/report.js +25 -25
  239. edsl/tools/__init__.py +1 -1
  240. edsl/tools/clusters.py +192 -192
  241. edsl/tools/embeddings.py +27 -27
  242. edsl/tools/embeddings_plotting.py +118 -118
  243. edsl/tools/plotting.py +112 -112
  244. edsl/tools/summarize.py +18 -18
  245. edsl/utilities/SystemInfo.py +28 -28
  246. edsl/utilities/__init__.py +22 -22
  247. edsl/utilities/ast_utilities.py +25 -25
  248. edsl/utilities/data/Registry.py +6 -6
  249. edsl/utilities/data/__init__.py +1 -1
  250. edsl/utilities/data/scooter_results.json +1 -1
  251. edsl/utilities/decorators.py +77 -77
  252. edsl/utilities/gcp_bucket/cloud_storage.py +96 -96
  253. edsl/utilities/interface.py +627 -627
  254. edsl/utilities/repair_functions.py +28 -28
  255. edsl/utilities/restricted_python.py +70 -70
  256. edsl/utilities/utilities.py +409 -391
  257. {edsl-0.1.36.dev6.dist-info → edsl-0.1.37.dist-info}/LICENSE +21 -21
  258. {edsl-0.1.36.dev6.dist-info → edsl-0.1.37.dist-info}/METADATA +1 -1
  259. edsl-0.1.37.dist-info/RECORD +283 -0
  260. edsl-0.1.36.dev6.dist-info/RECORD +0 -279
  261. {edsl-0.1.36.dev6.dist-info → edsl-0.1.37.dist-info}/WHEEL +0 -0
@@ -1,145 +1,145 @@
1
- from typing import Dict, List, Any, Optional
2
- from docx import Document
3
- from docx.shared import Inches, Pt
4
- from docx.enum.text import WD_ALIGN_PARAGRAPH
5
- from docx.enum.style import WD_STYLE_TYPE
6
-
7
-
8
- class TreeNode:
9
- def __init__(self, key=None, value=None):
10
- self.key = key
11
- self.value = value
12
- self.children = {}
13
-
14
-
15
- class Tree:
16
- def __init__(self, data: "Dataset"):
17
- d = {}
18
- for entry in data:
19
- d.update(entry)
20
- self.data = d
21
- self.root = None
22
-
23
- def unique_values_by_keys(self) -> dict:
24
- unique_values = {}
25
- for key, values in self.data.items():
26
- unique_values[key] = list(set(values))
27
- return unique_values
28
-
29
- def construct_tree(self, node_order: Optional[List[str]] = None):
30
- # Validate node_order
31
- if node_order is None:
32
- unique_values = self.unique_values_by_keys()
33
- # Sort keys by number of unique values
34
- node_order = sorted(
35
- unique_values, key=lambda k: len(unique_values[k]), reverse=True
36
- )
37
- else:
38
- if not set(node_order).issubset(set(self.data.keys())):
39
- invalid_keys = set(node_order) - set(self.data.keys())
40
- raise ValueError(f"Invalid keys in node_order: {invalid_keys}")
41
-
42
- self.root = TreeNode()
43
-
44
- for i in range(len(self.data[node_order[0]])):
45
- current = self.root
46
- for level in node_order[:-1]:
47
- value = self.data[level][i]
48
- if value not in current.children:
49
- current.children[value] = TreeNode(key=level, value=value)
50
- current = current.children[value]
51
-
52
- leaf_key = node_order[-1]
53
- leaf_value = self.data[leaf_key][i]
54
- if leaf_value not in current.children:
55
- current.children[leaf_value] = TreeNode(key=leaf_key, value=leaf_value)
56
-
57
- def print_tree(
58
- self, node: Optional[TreeNode] = None, level: int = 0, print_keys: bool = False
59
- ):
60
- if node is None:
61
- node = self.root
62
- if node is None:
63
- print("Tree has not been constructed yet.")
64
- return
65
-
66
- if node.value is not None:
67
- if print_keys and node.key is not None:
68
- print(" " * level + f"{node.key}: {node.value}")
69
- else:
70
- print(" " * level + str(node.value))
71
- for child in node.children.values():
72
- self.print_tree(child, level + 1, print_keys)
73
-
74
- def to_docx(self, filename: str):
75
- doc = Document()
76
-
77
- # Create styles for headings
78
- for i in range(1, 10): # Up to 9 levels of headings
79
- style_name = f"Heading {i}"
80
- if style_name not in doc.styles:
81
- doc.styles.add_style(style_name, WD_STYLE_TYPE.PARAGRAPH)
82
-
83
- # Get or create the 'Body Text' style
84
- if "Body Text" not in doc.styles:
85
- body_style = doc.styles.add_style("Body Text", WD_STYLE_TYPE.PARAGRAPH)
86
- else:
87
- body_style = doc.styles["Body Text"]
88
-
89
- body_style.font.size = Pt(11)
90
-
91
- self._add_to_docx(doc, self.root, 0)
92
- doc.save(filename)
93
-
94
- def _add_to_docx(self, doc, node: TreeNode, level: int):
95
- if node.value is not None:
96
- if level == 0:
97
- doc.add_heading(str(node.value), level=level + 1)
98
- elif node.children: # If the node has children, it's not the last level
99
- para = doc.add_paragraph(str(node.value))
100
- para.style = f"Heading {level+1}"
101
- else: # If the node has no children, it's the last level (body text)
102
- para = doc.add_paragraph(str(node.value))
103
- para.style = "Body Text"
104
-
105
- # Process child nodes (moved outside the if block)
106
- for child in node.children.values():
107
- self._add_to_docx(doc, child, level + 1)
108
-
109
-
110
- # Example usage (commented out)
111
- """
112
- from edsl.results.Dataset import Dataset
113
-
114
- data = Dataset(
115
- [
116
- {"continent": ["North America", "Asia", "Europe", "North America", "Asia"]},
117
- {"country": ["US", "China", "France", "Canada", "Japan"]},
118
- {"city": ["New York", "Beijing", "Paris", "Toronto", "Tokyo"]},
119
- {"population": [8419000, 21540000, 2161000, 2930000, 13960000]},
120
- ]
121
- )
122
-
123
- tree = Tree(data)
124
-
125
- try:
126
- tree.construct_tree(["continent", "country", "city", "population"])
127
- print("Tree without key names:")
128
- tree.print_tree()
129
- print("\nTree with key names:")
130
- tree.print_tree(print_keys=True)
131
- except ValueError as e:
132
- print(f"Error: {e}")
133
-
134
- # Demonstrating validation
135
- try:
136
- tree.construct_tree(["continent", "country", "invalid_key"])
137
- except ValueError as e:
138
- print(f"\nValidation Error: {e}")
139
-
140
- tree = Tree(data)
141
- tree.construct_tree(["continent", "country", "city", "population"])
142
- tree.print_tree(print_keys=True)
143
- tree.to_docx("tree_structure.docx")
144
- print("DocX file 'tree_structure.docx' has been created.")
145
- """
1
+ from typing import Dict, List, Any, Optional
2
+ from docx import Document
3
+ from docx.shared import Inches, Pt
4
+ from docx.enum.text import WD_ALIGN_PARAGRAPH
5
+ from docx.enum.style import WD_STYLE_TYPE
6
+
7
+
8
+ class TreeNode:
9
+ def __init__(self, key=None, value=None):
10
+ self.key = key
11
+ self.value = value
12
+ self.children = {}
13
+
14
+
15
+ class Tree:
16
+ def __init__(self, data: "Dataset"):
17
+ d = {}
18
+ for entry in data:
19
+ d.update(entry)
20
+ self.data = d
21
+ self.root = None
22
+
23
+ def unique_values_by_keys(self) -> dict:
24
+ unique_values = {}
25
+ for key, values in self.data.items():
26
+ unique_values[key] = list(set(values))
27
+ return unique_values
28
+
29
+ def construct_tree(self, node_order: Optional[List[str]] = None):
30
+ # Validate node_order
31
+ if node_order is None:
32
+ unique_values = self.unique_values_by_keys()
33
+ # Sort keys by number of unique values
34
+ node_order = sorted(
35
+ unique_values, key=lambda k: len(unique_values[k]), reverse=True
36
+ )
37
+ else:
38
+ if not set(node_order).issubset(set(self.data.keys())):
39
+ invalid_keys = set(node_order) - set(self.data.keys())
40
+ raise ValueError(f"Invalid keys in node_order: {invalid_keys}")
41
+
42
+ self.root = TreeNode()
43
+
44
+ for i in range(len(self.data[node_order[0]])):
45
+ current = self.root
46
+ for level in node_order[:-1]:
47
+ value = self.data[level][i]
48
+ if value not in current.children:
49
+ current.children[value] = TreeNode(key=level, value=value)
50
+ current = current.children[value]
51
+
52
+ leaf_key = node_order[-1]
53
+ leaf_value = self.data[leaf_key][i]
54
+ if leaf_value not in current.children:
55
+ current.children[leaf_value] = TreeNode(key=leaf_key, value=leaf_value)
56
+
57
+ def print_tree(
58
+ self, node: Optional[TreeNode] = None, level: int = 0, print_keys: bool = False
59
+ ):
60
+ if node is None:
61
+ node = self.root
62
+ if node is None:
63
+ print("Tree has not been constructed yet.")
64
+ return
65
+
66
+ if node.value is not None:
67
+ if print_keys and node.key is not None:
68
+ print(" " * level + f"{node.key}: {node.value}")
69
+ else:
70
+ print(" " * level + str(node.value))
71
+ for child in node.children.values():
72
+ self.print_tree(child, level + 1, print_keys)
73
+
74
+ def to_docx(self, filename: str):
75
+ doc = Document()
76
+
77
+ # Create styles for headings
78
+ for i in range(1, 10): # Up to 9 levels of headings
79
+ style_name = f"Heading {i}"
80
+ if style_name not in doc.styles:
81
+ doc.styles.add_style(style_name, WD_STYLE_TYPE.PARAGRAPH)
82
+
83
+ # Get or create the 'Body Text' style
84
+ if "Body Text" not in doc.styles:
85
+ body_style = doc.styles.add_style("Body Text", WD_STYLE_TYPE.PARAGRAPH)
86
+ else:
87
+ body_style = doc.styles["Body Text"]
88
+
89
+ body_style.font.size = Pt(11)
90
+
91
+ self._add_to_docx(doc, self.root, 0)
92
+ doc.save(filename)
93
+
94
+ def _add_to_docx(self, doc, node: TreeNode, level: int):
95
+ if node.value is not None:
96
+ if level == 0:
97
+ doc.add_heading(str(node.value), level=level + 1)
98
+ elif node.children: # If the node has children, it's not the last level
99
+ para = doc.add_paragraph(str(node.value))
100
+ para.style = f"Heading {level+1}"
101
+ else: # If the node has no children, it's the last level (body text)
102
+ para = doc.add_paragraph(str(node.value))
103
+ para.style = "Body Text"
104
+
105
+ # Process child nodes (moved outside the if block)
106
+ for child in node.children.values():
107
+ self._add_to_docx(doc, child, level + 1)
108
+
109
+
110
+ # Example usage (commented out)
111
+ """
112
+ from edsl.results.Dataset import Dataset
113
+
114
+ data = Dataset(
115
+ [
116
+ {"continent": ["North America", "Asia", "Europe", "North America", "Asia"]},
117
+ {"country": ["US", "China", "France", "Canada", "Japan"]},
118
+ {"city": ["New York", "Beijing", "Paris", "Toronto", "Tokyo"]},
119
+ {"population": [8419000, 21540000, 2161000, 2930000, 13960000]},
120
+ ]
121
+ )
122
+
123
+ tree = Tree(data)
124
+
125
+ try:
126
+ tree.construct_tree(["continent", "country", "city", "population"])
127
+ print("Tree without key names:")
128
+ tree.print_tree()
129
+ print("\nTree with key names:")
130
+ tree.print_tree(print_keys=True)
131
+ except ValueError as e:
132
+ print(f"Error: {e}")
133
+
134
+ # Demonstrating validation
135
+ try:
136
+ tree.construct_tree(["continent", "country", "invalid_key"])
137
+ except ValueError as e:
138
+ print(f"\nValidation Error: {e}")
139
+
140
+ tree = Tree(data)
141
+ tree.construct_tree(["continent", "country", "city", "population"])
142
+ tree.print_tree(print_keys=True)
143
+ tree.to_docx("tree_structure.docx")
144
+ print("DocX file 'tree_structure.docx' has been created.")
145
+ """