edsl 0.1.39.dev1__py3-none-any.whl → 0.1.39.dev3__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 (256) hide show
  1. edsl/Base.py +332 -332
  2. edsl/BaseDiff.py +260 -260
  3. edsl/TemplateLoader.py +24 -24
  4. edsl/__init__.py +49 -49
  5. edsl/__version__.py +1 -1
  6. edsl/agents/Agent.py +867 -867
  7. edsl/agents/AgentList.py +413 -413
  8. edsl/agents/Invigilator.py +233 -233
  9. edsl/agents/InvigilatorBase.py +270 -265
  10. edsl/agents/PromptConstructor.py +354 -354
  11. edsl/agents/__init__.py +3 -3
  12. edsl/agents/descriptors.py +99 -99
  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 +279 -279
  26. edsl/config.py +157 -157
  27. edsl/conversation/Conversation.py +290 -290
  28. edsl/conversation/car_buying.py +58 -58
  29. edsl/conversation/chips.py +95 -95
  30. edsl/conversation/mug_negotiation.py +81 -81
  31. edsl/conversation/next_speaker_utilities.py +93 -93
  32. edsl/coop/PriceFetcher.py +54 -54
  33. edsl/coop/__init__.py +2 -2
  34. edsl/coop/coop.py +1028 -1028
  35. edsl/coop/utils.py +131 -131
  36. edsl/data/Cache.py +555 -555
  37. edsl/data/CacheEntry.py +233 -233
  38. edsl/data/CacheHandler.py +149 -149
  39. edsl/data/RemoteCacheSync.py +78 -78
  40. edsl/data/SQLiteDict.py +292 -292
  41. edsl/data/__init__.py +4 -4
  42. edsl/data/orm.py +10 -10
  43. edsl/data_transfer_models.py +73 -73
  44. edsl/enums.py +175 -175
  45. edsl/exceptions/BaseException.py +21 -21
  46. edsl/exceptions/__init__.py +54 -54
  47. edsl/exceptions/agents.py +42 -42
  48. edsl/exceptions/cache.py +5 -5
  49. edsl/exceptions/configuration.py +16 -16
  50. edsl/exceptions/coop.py +10 -10
  51. edsl/exceptions/data.py +14 -14
  52. edsl/exceptions/general.py +34 -34
  53. edsl/exceptions/jobs.py +33 -33
  54. edsl/exceptions/language_models.py +63 -63
  55. edsl/exceptions/prompts.py +15 -15
  56. edsl/exceptions/questions.py +91 -91
  57. edsl/exceptions/results.py +29 -29
  58. edsl/exceptions/scenarios.py +22 -22
  59. edsl/exceptions/surveys.py +37 -37
  60. edsl/inference_services/AnthropicService.py +87 -87
  61. edsl/inference_services/AwsBedrock.py +120 -120
  62. edsl/inference_services/AzureAI.py +217 -217
  63. edsl/inference_services/DeepInfraService.py +18 -18
  64. edsl/inference_services/GoogleService.py +148 -148
  65. edsl/inference_services/GroqService.py +20 -20
  66. edsl/inference_services/InferenceServiceABC.py +147 -147
  67. edsl/inference_services/InferenceServicesCollection.py +97 -97
  68. edsl/inference_services/MistralAIService.py +123 -123
  69. edsl/inference_services/OllamaService.py +18 -18
  70. edsl/inference_services/OpenAIService.py +224 -224
  71. edsl/inference_services/PerplexityService.py +163 -163
  72. edsl/inference_services/TestService.py +89 -89
  73. edsl/inference_services/TogetherAIService.py +170 -170
  74. edsl/inference_services/models_available_cache.py +118 -118
  75. edsl/inference_services/rate_limits_cache.py +25 -25
  76. edsl/inference_services/registry.py +41 -41
  77. edsl/inference_services/write_available.py +10 -10
  78. edsl/jobs/Answers.py +56 -56
  79. edsl/jobs/Jobs.py +898 -898
  80. edsl/jobs/JobsChecks.py +147 -147
  81. edsl/jobs/JobsPrompts.py +268 -268
  82. edsl/jobs/JobsRemoteInferenceHandler.py +239 -239
  83. edsl/jobs/__init__.py +1 -1
  84. edsl/jobs/buckets/BucketCollection.py +63 -63
  85. edsl/jobs/buckets/ModelBuckets.py +65 -65
  86. edsl/jobs/buckets/TokenBucket.py +251 -251
  87. edsl/jobs/interviews/Interview.py +661 -661
  88. edsl/jobs/interviews/InterviewExceptionCollection.py +99 -99
  89. edsl/jobs/interviews/InterviewExceptionEntry.py +186 -186
  90. edsl/jobs/interviews/InterviewStatistic.py +63 -63
  91. edsl/jobs/interviews/InterviewStatisticsCollection.py +25 -25
  92. edsl/jobs/interviews/InterviewStatusDictionary.py +78 -78
  93. edsl/jobs/interviews/InterviewStatusLog.py +92 -92
  94. edsl/jobs/interviews/ReportErrors.py +66 -66
  95. edsl/jobs/interviews/interview_status_enum.py +9 -9
  96. edsl/jobs/runners/JobsRunnerAsyncio.py +466 -466
  97. edsl/jobs/runners/JobsRunnerStatus.py +330 -330
  98. edsl/jobs/tasks/QuestionTaskCreator.py +242 -242
  99. edsl/jobs/tasks/TaskCreators.py +64 -64
  100. edsl/jobs/tasks/TaskHistory.py +450 -450
  101. edsl/jobs/tasks/TaskStatusLog.py +23 -23
  102. edsl/jobs/tasks/task_status_enum.py +163 -163
  103. edsl/jobs/tokens/InterviewTokenUsage.py +27 -27
  104. edsl/jobs/tokens/TokenUsage.py +34 -34
  105. edsl/language_models/KeyLookup.py +30 -30
  106. edsl/language_models/LanguageModel.py +668 -668
  107. edsl/language_models/ModelList.py +155 -155
  108. edsl/language_models/RegisterLanguageModelsMeta.py +184 -184
  109. edsl/language_models/__init__.py +3 -3
  110. edsl/language_models/fake_openai_call.py +15 -15
  111. edsl/language_models/fake_openai_service.py +61 -61
  112. edsl/language_models/registry.py +190 -190
  113. edsl/language_models/repair.py +156 -156
  114. edsl/language_models/unused/ReplicateBase.py +83 -83
  115. edsl/language_models/utilities.py +64 -64
  116. edsl/notebooks/Notebook.py +258 -258
  117. edsl/notebooks/__init__.py +1 -1
  118. edsl/prompts/Prompt.py +362 -362
  119. edsl/prompts/__init__.py +2 -2
  120. edsl/questions/AnswerValidatorMixin.py +289 -289
  121. edsl/questions/QuestionBase.py +664 -664
  122. edsl/questions/QuestionBaseGenMixin.py +161 -161
  123. edsl/questions/QuestionBasePromptsMixin.py +217 -217
  124. edsl/questions/QuestionBudget.py +227 -227
  125. edsl/questions/QuestionCheckBox.py +359 -359
  126. edsl/questions/QuestionExtract.py +182 -182
  127. edsl/questions/QuestionFreeText.py +114 -114
  128. edsl/questions/QuestionFunctional.py +166 -166
  129. edsl/questions/QuestionList.py +231 -231
  130. edsl/questions/QuestionMultipleChoice.py +286 -286
  131. edsl/questions/QuestionNumerical.py +153 -153
  132. edsl/questions/QuestionRank.py +324 -324
  133. edsl/questions/Quick.py +41 -41
  134. edsl/questions/RegisterQuestionsMeta.py +71 -71
  135. edsl/questions/ResponseValidatorABC.py +174 -174
  136. edsl/questions/SimpleAskMixin.py +73 -73
  137. edsl/questions/__init__.py +26 -26
  138. edsl/questions/compose_questions.py +98 -98
  139. edsl/questions/decorators.py +21 -21
  140. edsl/questions/derived/QuestionLikertFive.py +76 -76
  141. edsl/questions/derived/QuestionLinearScale.py +87 -87
  142. edsl/questions/derived/QuestionTopK.py +93 -93
  143. edsl/questions/derived/QuestionYesNo.py +82 -82
  144. edsl/questions/descriptors.py +413 -413
  145. edsl/questions/prompt_templates/question_budget.jinja +13 -13
  146. edsl/questions/prompt_templates/question_checkbox.jinja +32 -32
  147. edsl/questions/prompt_templates/question_extract.jinja +11 -11
  148. edsl/questions/prompt_templates/question_free_text.jinja +3 -3
  149. edsl/questions/prompt_templates/question_linear_scale.jinja +11 -11
  150. edsl/questions/prompt_templates/question_list.jinja +17 -17
  151. edsl/questions/prompt_templates/question_multiple_choice.jinja +33 -33
  152. edsl/questions/prompt_templates/question_numerical.jinja +36 -36
  153. edsl/questions/question_registry.py +177 -177
  154. edsl/questions/settings.py +12 -12
  155. edsl/questions/templates/budget/answering_instructions.jinja +7 -7
  156. edsl/questions/templates/budget/question_presentation.jinja +7 -7
  157. edsl/questions/templates/checkbox/answering_instructions.jinja +10 -10
  158. edsl/questions/templates/checkbox/question_presentation.jinja +22 -22
  159. edsl/questions/templates/extract/answering_instructions.jinja +7 -7
  160. edsl/questions/templates/likert_five/answering_instructions.jinja +10 -10
  161. edsl/questions/templates/likert_five/question_presentation.jinja +11 -11
  162. edsl/questions/templates/linear_scale/answering_instructions.jinja +5 -5
  163. edsl/questions/templates/linear_scale/question_presentation.jinja +5 -5
  164. edsl/questions/templates/list/answering_instructions.jinja +3 -3
  165. edsl/questions/templates/list/question_presentation.jinja +5 -5
  166. edsl/questions/templates/multiple_choice/answering_instructions.jinja +9 -9
  167. edsl/questions/templates/multiple_choice/question_presentation.jinja +11 -11
  168. edsl/questions/templates/numerical/answering_instructions.jinja +6 -6
  169. edsl/questions/templates/numerical/question_presentation.jinja +6 -6
  170. edsl/questions/templates/rank/answering_instructions.jinja +11 -11
  171. edsl/questions/templates/rank/question_presentation.jinja +15 -15
  172. edsl/questions/templates/top_k/answering_instructions.jinja +8 -8
  173. edsl/questions/templates/top_k/question_presentation.jinja +22 -22
  174. edsl/questions/templates/yes_no/answering_instructions.jinja +6 -6
  175. edsl/questions/templates/yes_no/question_presentation.jinja +11 -11
  176. edsl/results/CSSParameterizer.py +108 -108
  177. edsl/results/Dataset.py +424 -424
  178. edsl/results/DatasetExportMixin.py +731 -731
  179. edsl/results/DatasetTree.py +275 -275
  180. edsl/results/Result.py +465 -465
  181. edsl/results/Results.py +1165 -1165
  182. edsl/results/ResultsDBMixin.py +238 -238
  183. edsl/results/ResultsExportMixin.py +43 -43
  184. edsl/results/ResultsFetchMixin.py +33 -33
  185. edsl/results/ResultsGGMixin.py +121 -121
  186. edsl/results/ResultsToolsMixin.py +98 -98
  187. edsl/results/Selector.py +135 -135
  188. edsl/results/TableDisplay.py +198 -198
  189. edsl/results/__init__.py +2 -2
  190. edsl/results/table_display.css +77 -77
  191. edsl/results/tree_explore.py +115 -115
  192. edsl/scenarios/FileStore.py +632 -632
  193. edsl/scenarios/Scenario.py +601 -601
  194. edsl/scenarios/ScenarioHtmlMixin.py +64 -64
  195. edsl/scenarios/ScenarioJoin.py +127 -127
  196. edsl/scenarios/ScenarioList.py +1287 -1287
  197. edsl/scenarios/ScenarioListExportMixin.py +52 -52
  198. edsl/scenarios/ScenarioListPdfMixin.py +261 -261
  199. edsl/scenarios/__init__.py +4 -4
  200. edsl/shared.py +1 -1
  201. edsl/study/ObjectEntry.py +173 -173
  202. edsl/study/ProofOfWork.py +113 -113
  203. edsl/study/SnapShot.py +80 -80
  204. edsl/study/Study.py +528 -528
  205. edsl/study/__init__.py +4 -4
  206. edsl/surveys/DAG.py +148 -148
  207. edsl/surveys/Memory.py +31 -31
  208. edsl/surveys/MemoryPlan.py +244 -244
  209. edsl/surveys/Rule.py +326 -326
  210. edsl/surveys/RuleCollection.py +387 -387
  211. edsl/surveys/Survey.py +1801 -1801
  212. edsl/surveys/SurveyCSS.py +261 -261
  213. edsl/surveys/SurveyExportMixin.py +259 -259
  214. edsl/surveys/SurveyFlowVisualizationMixin.py +179 -179
  215. edsl/surveys/SurveyQualtricsImport.py +284 -284
  216. edsl/surveys/__init__.py +3 -3
  217. edsl/surveys/base.py +53 -53
  218. edsl/surveys/descriptors.py +56 -56
  219. edsl/surveys/instructions/ChangeInstruction.py +49 -49
  220. edsl/surveys/instructions/Instruction.py +65 -65
  221. edsl/surveys/instructions/InstructionCollection.py +77 -77
  222. edsl/templates/error_reporting/base.html +23 -23
  223. edsl/templates/error_reporting/exceptions_by_model.html +34 -34
  224. edsl/templates/error_reporting/exceptions_by_question_name.html +16 -16
  225. edsl/templates/error_reporting/exceptions_by_type.html +16 -16
  226. edsl/templates/error_reporting/interview_details.html +115 -115
  227. edsl/templates/error_reporting/interviews.html +19 -19
  228. edsl/templates/error_reporting/overview.html +4 -4
  229. edsl/templates/error_reporting/performance_plot.html +1 -1
  230. edsl/templates/error_reporting/report.css +73 -73
  231. edsl/templates/error_reporting/report.html +117 -117
  232. edsl/templates/error_reporting/report.js +25 -25
  233. edsl/tools/__init__.py +1 -1
  234. edsl/tools/clusters.py +192 -192
  235. edsl/tools/embeddings.py +27 -27
  236. edsl/tools/embeddings_plotting.py +118 -118
  237. edsl/tools/plotting.py +112 -112
  238. edsl/tools/summarize.py +18 -18
  239. edsl/utilities/SystemInfo.py +28 -28
  240. edsl/utilities/__init__.py +22 -22
  241. edsl/utilities/ast_utilities.py +25 -25
  242. edsl/utilities/data/Registry.py +6 -6
  243. edsl/utilities/data/__init__.py +1 -1
  244. edsl/utilities/data/scooter_results.json +1 -1
  245. edsl/utilities/decorators.py +77 -77
  246. edsl/utilities/gcp_bucket/cloud_storage.py +96 -96
  247. edsl/utilities/interface.py +627 -627
  248. edsl/utilities/naming_utilities.py +263 -263
  249. edsl/utilities/repair_functions.py +28 -28
  250. edsl/utilities/restricted_python.py +70 -70
  251. edsl/utilities/utilities.py +424 -424
  252. {edsl-0.1.39.dev1.dist-info → edsl-0.1.39.dev3.dist-info}/LICENSE +21 -21
  253. {edsl-0.1.39.dev1.dist-info → edsl-0.1.39.dev3.dist-info}/METADATA +1 -1
  254. edsl-0.1.39.dev3.dist-info/RECORD +277 -0
  255. edsl-0.1.39.dev1.dist-info/RECORD +0 -277
  256. {edsl-0.1.39.dev1.dist-info → edsl-0.1.39.dev3.dist-info}/WHEEL +0 -0
edsl/results/Selector.py CHANGED
@@ -1,135 +1,135 @@
1
- from typing import Union, List, Dict, Any
2
- from collections import defaultdict
3
- from edsl.results.Dataset import Dataset
4
-
5
-
6
- class Selector:
7
- def __init__(
8
- self,
9
- known_data_types: List[str],
10
- data_type_to_keys: Dict[str, List[str]],
11
- key_to_data_type: Dict[str, str],
12
- fetch_list_func,
13
- columns: List[str],
14
- ):
15
- """Selects columns from a Results object"""
16
- self.known_data_types = known_data_types
17
- self._data_type_to_keys = data_type_to_keys
18
- self._key_to_data_type = key_to_data_type
19
- self._fetch_list = fetch_list_func
20
- self.columns = columns
21
-
22
- def select(self, *columns: Union[str, List[str]]) -> "Dataset":
23
- columns = self._normalize_columns(columns)
24
- to_fetch = self._get_columns_to_fetch(columns)
25
- # breakpoint()
26
- new_data = self._fetch_data(to_fetch)
27
- return Dataset(new_data)
28
-
29
- def _normalize_columns(self, columns: Union[str, List[str]]) -> tuple:
30
- """Normalize the columns to a tuple of strings
31
-
32
- >>> s = Selector([], {}, {}, lambda x, y: x, [])
33
- >>> s._normalize_columns([["a", "b"], ])
34
- ('a', 'b')
35
- >>> s._normalize_columns(None)
36
- ('*.*',)
37
- """
38
- if not columns or columns == ("*",) or columns == (None,):
39
- return ("*.*",)
40
- if isinstance(columns[0], list):
41
- return tuple(columns[0])
42
- return columns
43
-
44
- def _get_columns_to_fetch(self, columns: tuple) -> Dict[str, List[str]]:
45
- to_fetch = defaultdict(list)
46
- self.items_in_order = []
47
-
48
- for column in columns:
49
- matches = self._find_matching_columns(column)
50
- # breakpoint()
51
- self._validate_matches(column, matches)
52
-
53
- if len(matches) == 1:
54
- column = matches[0]
55
-
56
- data_type, key = self._parse_column(column)
57
- self._process_column(data_type, key, to_fetch)
58
-
59
- return to_fetch
60
-
61
- def _find_matching_columns(self, partial_name: str) -> list[str]:
62
- if "." in partial_name:
63
- search_in_list = self.columns
64
- else:
65
- search_in_list = [s.split(".")[1] for s in self.columns]
66
- # breakpoint()
67
- matches = [s for s in search_in_list if s.startswith(partial_name)]
68
- return [partial_name] if partial_name in matches else matches
69
-
70
- def _validate_matches(self, column: str, matches: List[str]):
71
- if len(matches) > 1:
72
- raise ValueError(
73
- f"Column '{column}' is ambiguous. Did you mean one of {matches}?"
74
- )
75
- if len(matches) == 0 and ".*" not in column:
76
- raise ValueError(f"Column '{column}' not found in data.")
77
-
78
- def _parse_column(self, column: str) -> tuple[str, str]:
79
- if "." in column:
80
- return column.split(".")
81
- try:
82
- return self._key_to_data_type[column], column
83
- except KeyError:
84
- self._raise_key_error(column)
85
-
86
- def _raise_key_error(self, column: str):
87
- import difflib
88
-
89
- close_matches = difflib.get_close_matches(column, self._key_to_data_type.keys())
90
- if close_matches:
91
- suggestions = ", ".join(close_matches)
92
- raise KeyError(
93
- f"Column '{column}' not found in data. Did you mean: {suggestions}?"
94
- )
95
- else:
96
- raise KeyError(f"Column {column} not found in data")
97
-
98
- def _process_column(self, data_type: str, key: str, to_fetch: Dict[str, List[str]]):
99
- data_types = self._get_data_types_to_return(data_type)
100
- found_once = False
101
-
102
- for dt in data_types:
103
- relevant_keys = self._data_type_to_keys[dt]
104
- for k in relevant_keys:
105
- if k == key or key == "*":
106
- found_once = True
107
- to_fetch[dt].append(k)
108
- self.items_in_order.append(f"{dt}.{k}")
109
-
110
- if not found_once:
111
- raise ValueError(f"Key {key} not found in data.")
112
-
113
- def _get_data_types_to_return(self, parsed_data_type: str) -> List[str]:
114
- if parsed_data_type == "*":
115
- return self.known_data_types
116
- if parsed_data_type not in self.known_data_types:
117
- raise ValueError(
118
- f"Data type {parsed_data_type} not found in data. Did you mean one of {self.known_data_types}"
119
- )
120
- return [parsed_data_type]
121
-
122
- def _fetch_data(self, to_fetch: Dict[str, List[str]]) -> List[Dict[str, Any]]:
123
- new_data = []
124
- for data_type, keys in to_fetch.items():
125
- for key in keys:
126
- entries = self._fetch_list(data_type, key)
127
- new_data.append({f"{data_type}.{key}": entries})
128
-
129
- return [d for key in self.items_in_order for d in new_data if key in d]
130
-
131
-
132
- if __name__ == "__main__":
133
- import doctest
134
-
135
- doctest.testmod()
1
+ from typing import Union, List, Dict, Any
2
+ from collections import defaultdict
3
+ from edsl.results.Dataset import Dataset
4
+
5
+
6
+ class Selector:
7
+ def __init__(
8
+ self,
9
+ known_data_types: List[str],
10
+ data_type_to_keys: Dict[str, List[str]],
11
+ key_to_data_type: Dict[str, str],
12
+ fetch_list_func,
13
+ columns: List[str],
14
+ ):
15
+ """Selects columns from a Results object"""
16
+ self.known_data_types = known_data_types
17
+ self._data_type_to_keys = data_type_to_keys
18
+ self._key_to_data_type = key_to_data_type
19
+ self._fetch_list = fetch_list_func
20
+ self.columns = columns
21
+
22
+ def select(self, *columns: Union[str, List[str]]) -> "Dataset":
23
+ columns = self._normalize_columns(columns)
24
+ to_fetch = self._get_columns_to_fetch(columns)
25
+ # breakpoint()
26
+ new_data = self._fetch_data(to_fetch)
27
+ return Dataset(new_data)
28
+
29
+ def _normalize_columns(self, columns: Union[str, List[str]]) -> tuple:
30
+ """Normalize the columns to a tuple of strings
31
+
32
+ >>> s = Selector([], {}, {}, lambda x, y: x, [])
33
+ >>> s._normalize_columns([["a", "b"], ])
34
+ ('a', 'b')
35
+ >>> s._normalize_columns(None)
36
+ ('*.*',)
37
+ """
38
+ if not columns or columns == ("*",) or columns == (None,):
39
+ return ("*.*",)
40
+ if isinstance(columns[0], list):
41
+ return tuple(columns[0])
42
+ return columns
43
+
44
+ def _get_columns_to_fetch(self, columns: tuple) -> Dict[str, List[str]]:
45
+ to_fetch = defaultdict(list)
46
+ self.items_in_order = []
47
+
48
+ for column in columns:
49
+ matches = self._find_matching_columns(column)
50
+ # breakpoint()
51
+ self._validate_matches(column, matches)
52
+
53
+ if len(matches) == 1:
54
+ column = matches[0]
55
+
56
+ data_type, key = self._parse_column(column)
57
+ self._process_column(data_type, key, to_fetch)
58
+
59
+ return to_fetch
60
+
61
+ def _find_matching_columns(self, partial_name: str) -> list[str]:
62
+ if "." in partial_name:
63
+ search_in_list = self.columns
64
+ else:
65
+ search_in_list = [s.split(".")[1] for s in self.columns]
66
+ # breakpoint()
67
+ matches = [s for s in search_in_list if s.startswith(partial_name)]
68
+ return [partial_name] if partial_name in matches else matches
69
+
70
+ def _validate_matches(self, column: str, matches: List[str]):
71
+ if len(matches) > 1:
72
+ raise ValueError(
73
+ f"Column '{column}' is ambiguous. Did you mean one of {matches}?"
74
+ )
75
+ if len(matches) == 0 and ".*" not in column:
76
+ raise ValueError(f"Column '{column}' not found in data.")
77
+
78
+ def _parse_column(self, column: str) -> tuple[str, str]:
79
+ if "." in column:
80
+ return column.split(".")
81
+ try:
82
+ return self._key_to_data_type[column], column
83
+ except KeyError:
84
+ self._raise_key_error(column)
85
+
86
+ def _raise_key_error(self, column: str):
87
+ import difflib
88
+
89
+ close_matches = difflib.get_close_matches(column, self._key_to_data_type.keys())
90
+ if close_matches:
91
+ suggestions = ", ".join(close_matches)
92
+ raise KeyError(
93
+ f"Column '{column}' not found in data. Did you mean: {suggestions}?"
94
+ )
95
+ else:
96
+ raise KeyError(f"Column {column} not found in data")
97
+
98
+ def _process_column(self, data_type: str, key: str, to_fetch: Dict[str, List[str]]):
99
+ data_types = self._get_data_types_to_return(data_type)
100
+ found_once = False
101
+
102
+ for dt in data_types:
103
+ relevant_keys = self._data_type_to_keys[dt]
104
+ for k in relevant_keys:
105
+ if k == key or key == "*":
106
+ found_once = True
107
+ to_fetch[dt].append(k)
108
+ self.items_in_order.append(f"{dt}.{k}")
109
+
110
+ if not found_once:
111
+ raise ValueError(f"Key {key} not found in data.")
112
+
113
+ def _get_data_types_to_return(self, parsed_data_type: str) -> List[str]:
114
+ if parsed_data_type == "*":
115
+ return self.known_data_types
116
+ if parsed_data_type not in self.known_data_types:
117
+ raise ValueError(
118
+ f"Data type {parsed_data_type} not found in data. Did you mean one of {self.known_data_types}"
119
+ )
120
+ return [parsed_data_type]
121
+
122
+ def _fetch_data(self, to_fetch: Dict[str, List[str]]) -> List[Dict[str, Any]]:
123
+ new_data = []
124
+ for data_type, keys in to_fetch.items():
125
+ for key in keys:
126
+ entries = self._fetch_list(data_type, key)
127
+ new_data.append({f"{data_type}.{key}": entries})
128
+
129
+ return [d for key in self.items_in_order for d in new_data if key in d]
130
+
131
+
132
+ if __name__ == "__main__":
133
+ import doctest
134
+
135
+ doctest.testmod()
@@ -1,198 +1,198 @@
1
- from tabulate import tabulate
2
- from pathlib import Path
3
-
4
- from edsl.results.CSSParameterizer import CSSParameterizer
5
-
6
-
7
- class TableDisplay:
8
- max_height = 400
9
- min_height = 200
10
-
11
- @classmethod
12
- def get_css(cls):
13
- """Load CSS content from the file next to this module"""
14
- css_path = Path(__file__).parent / "table_display.css"
15
- return css_path.read_text()
16
-
17
- def __init__(self, headers, data, tablefmt=None, raw_data_set=None):
18
- self.headers = headers
19
- self.data = data
20
- self.tablefmt = tablefmt
21
- self.raw_data_set = raw_data_set
22
-
23
- if hasattr(raw_data_set, "print_parameters"):
24
- if raw_data_set.print_parameters:
25
- self.printing_parameters = raw_data_set.print_parameters
26
- else:
27
- self.printing_parameters = {}
28
- else:
29
- self.printing_parameters = {}
30
-
31
- def to_csv(self, filename: str):
32
- self.raw_data_set.to_csv(filename)
33
-
34
- def write(self, filename: str):
35
- if self.tablefmt is None:
36
- table = tabulate(self.data, headers=self.headers, tablefmt="simple")
37
- else:
38
- table = tabulate(self.data, headers=self.headers, tablefmt=self.tablefmt)
39
-
40
- with open(filename, "w") as file:
41
- print("Writing table to", filename)
42
- file.write(table)
43
-
44
- def to_pandas(self):
45
- return self.raw_data_set.to_pandas()
46
-
47
- def to_list(self):
48
- return self.raw_data_set.to_list()
49
-
50
- def __repr__(self):
51
- from tabulate import tabulate
52
-
53
- if self.tablefmt is None:
54
- return tabulate(self.data, headers=self.headers, tablefmt="simple")
55
- else:
56
- return tabulate(self.data, headers=self.headers, tablefmt=self.tablefmt)
57
-
58
- def long(self):
59
- new_header = ["row", "key", "value"]
60
- new_data = []
61
- for index, row in enumerate(self.data):
62
- new_data.extend([[index, k, v] for k, v in zip(self.headers, row)])
63
- return TableDisplay(new_header, new_data)
64
-
65
- def _repr_html_(self):
66
- if self.tablefmt is not None:
67
- return (
68
- "<pre>"
69
- + tabulate(self.data, headers=self.headers, tablefmt=self.tablefmt)
70
- + "</pre>"
71
- )
72
-
73
- num_rows = len(self.data)
74
- height = min(
75
- num_rows * 30 + 50, self.max_height
76
- ) # Added extra space for header
77
-
78
- if height < self.min_height:
79
- height = self.min_height
80
-
81
- html_template = """
82
- <style>
83
- {css}
84
- </style>
85
- <div class="table-container">
86
- <div class="scroll-table-wrapper">
87
- {table}
88
- </div>
89
- </div>
90
- """
91
-
92
- html_content = tabulate(self.data, headers=self.headers, tablefmt="html")
93
- html_content = html_content.replace("<table>", '<table class="scroll-table">')
94
-
95
- height_string = f"{height}px"
96
- parameters = {"containerHeight": height_string, "headerColor": "blue"}
97
- parameters.update(self.printing_parameters)
98
- rendered_css = CSSParameterizer(self.get_css()).apply_parameters(parameters)
99
-
100
- return html_template.format(table=html_content, css=rendered_css)
101
-
102
- @classmethod
103
- def example(
104
- cls,
105
- headers=None,
106
- data=None,
107
- filename: str = "table_example.html",
108
- auto_open: bool = True,
109
- ):
110
- """
111
- Creates a standalone HTML file with an example table in an iframe and optionally opens it in a new tab.
112
-
113
- Args:
114
- cls: The class itself
115
- headers (list): List of column headers. If None, uses example headers
116
- data (list): List of data rows. If None, uses example data
117
- filename (str): The name of the HTML file to create. Defaults to "table_example.html"
118
- auto_open (bool): Whether to automatically open the file in the default web browser. Defaults to True
119
-
120
- Returns:
121
- str: The path to the created HTML file
122
- """
123
- import os
124
- import webbrowser
125
-
126
- # Use example data if none provided
127
- if headers is None:
128
- headers = ["Name", "Age", "City", "Occupation"]
129
- if data is None:
130
- data = [
131
- [
132
- "John Doe",
133
- 30,
134
- "New York",
135
- """cls: The class itself
136
- headers (list): List of column headers. If None, uses example headers
137
- data (list): List of data rows. If None, uses example data
138
- filename (str): The name of the HTML file to create. Defaults to "table_example.html"
139
- auto_open (bool): Whether to automatically open the file in the default web browser. Defaults to True
140
- """,
141
- ],
142
- ["Jane Smith", 28, "San Francisco", "Designer"],
143
- ["Bob Johnson", 35, "Chicago", "Manager"],
144
- ["Alice Brown", 25, "Boston", "Developer"],
145
- ["Charlie Wilson", 40, "Seattle", "Architect"],
146
- ]
147
-
148
- # Create instance with the data
149
- instance = cls(headers=headers, data=data)
150
-
151
- # Get the table HTML content
152
- table_html = instance._repr_html_()
153
-
154
- # Calculate the appropriate iframe height
155
- num_rows = len(data)
156
- iframe_height = min(num_rows * 140 + 50, cls.max_height)
157
- print(f"Table height: {iframe_height}px")
158
-
159
- # Create the full HTML document
160
- html_content = f"""
161
- <!DOCTYPE html>
162
- <html>
163
- <head>
164
- <title>Table Display Example</title>
165
- <style>
166
- body {{
167
- margin: 0;
168
- padding: 20px;
169
- font-family: Arial, sans-serif;
170
- }}
171
- iframe {{
172
- width: 100%;
173
- height: {iframe_height}px;
174
- border: none;
175
- overflow: hidden;
176
- }}
177
- </style>
178
- </head>
179
- <body>
180
- <iframe srcdoc='{table_html}'></iframe>
181
- </body>
182
- </html>
183
- """
184
-
185
- # Write the HTML file
186
- abs_path = os.path.abspath(filename)
187
- with open(filename, "w", encoding="utf-8") as f:
188
- f.write(html_content)
189
-
190
- # Open in browser if requested
191
- if auto_open:
192
- webbrowser.open("file://" + abs_path, new=2)
193
-
194
- return abs_path
195
-
196
-
197
- if __name__ == "__main__":
198
- TableDisplay.example()
1
+ from tabulate import tabulate
2
+ from pathlib import Path
3
+
4
+ from edsl.results.CSSParameterizer import CSSParameterizer
5
+
6
+
7
+ class TableDisplay:
8
+ max_height = 400
9
+ min_height = 200
10
+
11
+ @classmethod
12
+ def get_css(cls):
13
+ """Load CSS content from the file next to this module"""
14
+ css_path = Path(__file__).parent / "table_display.css"
15
+ return css_path.read_text()
16
+
17
+ def __init__(self, headers, data, tablefmt=None, raw_data_set=None):
18
+ self.headers = headers
19
+ self.data = data
20
+ self.tablefmt = tablefmt
21
+ self.raw_data_set = raw_data_set
22
+
23
+ if hasattr(raw_data_set, "print_parameters"):
24
+ if raw_data_set.print_parameters:
25
+ self.printing_parameters = raw_data_set.print_parameters
26
+ else:
27
+ self.printing_parameters = {}
28
+ else:
29
+ self.printing_parameters = {}
30
+
31
+ def to_csv(self, filename: str):
32
+ self.raw_data_set.to_csv(filename)
33
+
34
+ def write(self, filename: str):
35
+ if self.tablefmt is None:
36
+ table = tabulate(self.data, headers=self.headers, tablefmt="simple")
37
+ else:
38
+ table = tabulate(self.data, headers=self.headers, tablefmt=self.tablefmt)
39
+
40
+ with open(filename, "w") as file:
41
+ print("Writing table to", filename)
42
+ file.write(table)
43
+
44
+ def to_pandas(self):
45
+ return self.raw_data_set.to_pandas()
46
+
47
+ def to_list(self):
48
+ return self.raw_data_set.to_list()
49
+
50
+ def __repr__(self):
51
+ from tabulate import tabulate
52
+
53
+ if self.tablefmt is None:
54
+ return tabulate(self.data, headers=self.headers, tablefmt="simple")
55
+ else:
56
+ return tabulate(self.data, headers=self.headers, tablefmt=self.tablefmt)
57
+
58
+ def long(self):
59
+ new_header = ["row", "key", "value"]
60
+ new_data = []
61
+ for index, row in enumerate(self.data):
62
+ new_data.extend([[index, k, v] for k, v in zip(self.headers, row)])
63
+ return TableDisplay(new_header, new_data)
64
+
65
+ def _repr_html_(self):
66
+ if self.tablefmt is not None:
67
+ return (
68
+ "<pre>"
69
+ + tabulate(self.data, headers=self.headers, tablefmt=self.tablefmt)
70
+ + "</pre>"
71
+ )
72
+
73
+ num_rows = len(self.data)
74
+ height = min(
75
+ num_rows * 30 + 50, self.max_height
76
+ ) # Added extra space for header
77
+
78
+ if height < self.min_height:
79
+ height = self.min_height
80
+
81
+ html_template = """
82
+ <style>
83
+ {css}
84
+ </style>
85
+ <div class="table-container">
86
+ <div class="scroll-table-wrapper">
87
+ {table}
88
+ </div>
89
+ </div>
90
+ """
91
+
92
+ html_content = tabulate(self.data, headers=self.headers, tablefmt="html")
93
+ html_content = html_content.replace("<table>", '<table class="scroll-table">')
94
+
95
+ height_string = f"{height}px"
96
+ parameters = {"containerHeight": height_string, "headerColor": "blue"}
97
+ parameters.update(self.printing_parameters)
98
+ rendered_css = CSSParameterizer(self.get_css()).apply_parameters(parameters)
99
+
100
+ return html_template.format(table=html_content, css=rendered_css)
101
+
102
+ @classmethod
103
+ def example(
104
+ cls,
105
+ headers=None,
106
+ data=None,
107
+ filename: str = "table_example.html",
108
+ auto_open: bool = True,
109
+ ):
110
+ """
111
+ Creates a standalone HTML file with an example table in an iframe and optionally opens it in a new tab.
112
+
113
+ Args:
114
+ cls: The class itself
115
+ headers (list): List of column headers. If None, uses example headers
116
+ data (list): List of data rows. If None, uses example data
117
+ filename (str): The name of the HTML file to create. Defaults to "table_example.html"
118
+ auto_open (bool): Whether to automatically open the file in the default web browser. Defaults to True
119
+
120
+ Returns:
121
+ str: The path to the created HTML file
122
+ """
123
+ import os
124
+ import webbrowser
125
+
126
+ # Use example data if none provided
127
+ if headers is None:
128
+ headers = ["Name", "Age", "City", "Occupation"]
129
+ if data is None:
130
+ data = [
131
+ [
132
+ "John Doe",
133
+ 30,
134
+ "New York",
135
+ """cls: The class itself
136
+ headers (list): List of column headers. If None, uses example headers
137
+ data (list): List of data rows. If None, uses example data
138
+ filename (str): The name of the HTML file to create. Defaults to "table_example.html"
139
+ auto_open (bool): Whether to automatically open the file in the default web browser. Defaults to True
140
+ """,
141
+ ],
142
+ ["Jane Smith", 28, "San Francisco", "Designer"],
143
+ ["Bob Johnson", 35, "Chicago", "Manager"],
144
+ ["Alice Brown", 25, "Boston", "Developer"],
145
+ ["Charlie Wilson", 40, "Seattle", "Architect"],
146
+ ]
147
+
148
+ # Create instance with the data
149
+ instance = cls(headers=headers, data=data)
150
+
151
+ # Get the table HTML content
152
+ table_html = instance._repr_html_()
153
+
154
+ # Calculate the appropriate iframe height
155
+ num_rows = len(data)
156
+ iframe_height = min(num_rows * 140 + 50, cls.max_height)
157
+ print(f"Table height: {iframe_height}px")
158
+
159
+ # Create the full HTML document
160
+ html_content = f"""
161
+ <!DOCTYPE html>
162
+ <html>
163
+ <head>
164
+ <title>Table Display Example</title>
165
+ <style>
166
+ body {{
167
+ margin: 0;
168
+ padding: 20px;
169
+ font-family: Arial, sans-serif;
170
+ }}
171
+ iframe {{
172
+ width: 100%;
173
+ height: {iframe_height}px;
174
+ border: none;
175
+ overflow: hidden;
176
+ }}
177
+ </style>
178
+ </head>
179
+ <body>
180
+ <iframe srcdoc='{table_html}'></iframe>
181
+ </body>
182
+ </html>
183
+ """
184
+
185
+ # Write the HTML file
186
+ abs_path = os.path.abspath(filename)
187
+ with open(filename, "w", encoding="utf-8") as f:
188
+ f.write(html_content)
189
+
190
+ # Open in browser if requested
191
+ if auto_open:
192
+ webbrowser.open("file://" + abs_path, new=2)
193
+
194
+ return abs_path
195
+
196
+
197
+ if __name__ == "__main__":
198
+ TableDisplay.example()