edsl 0.1.39.dev3__py3-none-any.whl → 0.1.39.dev5__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 (341) hide show
  1. edsl/Base.py +413 -332
  2. edsl/BaseDiff.py +260 -260
  3. edsl/TemplateLoader.py +24 -24
  4. edsl/__init__.py +57 -49
  5. edsl/__version__.py +1 -1
  6. edsl/agents/Agent.py +1071 -867
  7. edsl/agents/AgentList.py +551 -413
  8. edsl/agents/Invigilator.py +284 -233
  9. edsl/agents/InvigilatorBase.py +257 -270
  10. edsl/agents/PromptConstructor.py +272 -354
  11. edsl/agents/QuestionInstructionPromptBuilder.py +128 -0
  12. edsl/agents/QuestionTemplateReplacementsBuilder.py +137 -0
  13. edsl/agents/__init__.py +2 -3
  14. edsl/agents/descriptors.py +99 -99
  15. edsl/agents/prompt_helpers.py +129 -129
  16. edsl/agents/question_option_processor.py +172 -0
  17. edsl/auto/AutoStudy.py +130 -117
  18. edsl/auto/StageBase.py +243 -230
  19. edsl/auto/StageGenerateSurvey.py +178 -178
  20. edsl/auto/StageLabelQuestions.py +125 -125
  21. edsl/auto/StagePersona.py +61 -61
  22. edsl/auto/StagePersonaDimensionValueRanges.py +88 -88
  23. edsl/auto/StagePersonaDimensionValues.py +74 -74
  24. edsl/auto/StagePersonaDimensions.py +69 -69
  25. edsl/auto/StageQuestions.py +74 -73
  26. edsl/auto/SurveyCreatorPipeline.py +21 -21
  27. edsl/auto/utilities.py +218 -224
  28. edsl/base/Base.py +279 -279
  29. edsl/config.py +177 -157
  30. edsl/conversation/Conversation.py +290 -290
  31. edsl/conversation/car_buying.py +59 -58
  32. edsl/conversation/chips.py +95 -95
  33. edsl/conversation/mug_negotiation.py +81 -81
  34. edsl/conversation/next_speaker_utilities.py +93 -93
  35. edsl/coop/CoopFunctionsMixin.py +15 -0
  36. edsl/coop/ExpectedParrotKeyHandler.py +125 -0
  37. edsl/coop/PriceFetcher.py +54 -54
  38. edsl/coop/__init__.py +2 -2
  39. edsl/coop/coop.py +1106 -1028
  40. edsl/coop/utils.py +131 -131
  41. edsl/data/Cache.py +573 -555
  42. edsl/data/CacheEntry.py +230 -233
  43. edsl/data/CacheHandler.py +168 -149
  44. edsl/data/RemoteCacheSync.py +186 -78
  45. edsl/data/SQLiteDict.py +292 -292
  46. edsl/data/__init__.py +5 -4
  47. edsl/data/orm.py +10 -10
  48. edsl/data_transfer_models.py +74 -73
  49. edsl/enums.py +202 -175
  50. edsl/exceptions/BaseException.py +21 -21
  51. edsl/exceptions/__init__.py +54 -54
  52. edsl/exceptions/agents.py +54 -42
  53. edsl/exceptions/cache.py +5 -5
  54. edsl/exceptions/configuration.py +16 -16
  55. edsl/exceptions/coop.py +10 -10
  56. edsl/exceptions/data.py +14 -14
  57. edsl/exceptions/general.py +34 -34
  58. edsl/exceptions/inference_services.py +5 -0
  59. edsl/exceptions/jobs.py +33 -33
  60. edsl/exceptions/language_models.py +63 -63
  61. edsl/exceptions/prompts.py +15 -15
  62. edsl/exceptions/questions.py +109 -91
  63. edsl/exceptions/results.py +29 -29
  64. edsl/exceptions/scenarios.py +29 -22
  65. edsl/exceptions/surveys.py +37 -37
  66. edsl/inference_services/AnthropicService.py +106 -87
  67. edsl/inference_services/AvailableModelCacheHandler.py +184 -0
  68. edsl/inference_services/AvailableModelFetcher.py +215 -0
  69. edsl/inference_services/AwsBedrock.py +118 -120
  70. edsl/inference_services/AzureAI.py +215 -217
  71. edsl/inference_services/DeepInfraService.py +18 -18
  72. edsl/inference_services/GoogleService.py +143 -148
  73. edsl/inference_services/GroqService.py +20 -20
  74. edsl/inference_services/InferenceServiceABC.py +80 -147
  75. edsl/inference_services/InferenceServicesCollection.py +138 -97
  76. edsl/inference_services/MistralAIService.py +120 -123
  77. edsl/inference_services/OllamaService.py +18 -18
  78. edsl/inference_services/OpenAIService.py +236 -224
  79. edsl/inference_services/PerplexityService.py +160 -163
  80. edsl/inference_services/ServiceAvailability.py +135 -0
  81. edsl/inference_services/TestService.py +90 -89
  82. edsl/inference_services/TogetherAIService.py +172 -170
  83. edsl/inference_services/data_structures.py +134 -0
  84. edsl/inference_services/models_available_cache.py +118 -118
  85. edsl/inference_services/rate_limits_cache.py +25 -25
  86. edsl/inference_services/registry.py +41 -41
  87. edsl/inference_services/write_available.py +10 -10
  88. edsl/jobs/AnswerQuestionFunctionConstructor.py +223 -0
  89. edsl/jobs/Answers.py +43 -56
  90. edsl/jobs/FetchInvigilator.py +47 -0
  91. edsl/jobs/InterviewTaskManager.py +98 -0
  92. edsl/jobs/InterviewsConstructor.py +50 -0
  93. edsl/jobs/Jobs.py +823 -898
  94. edsl/jobs/JobsChecks.py +172 -147
  95. edsl/jobs/JobsComponentConstructor.py +189 -0
  96. edsl/jobs/JobsPrompts.py +270 -268
  97. edsl/jobs/JobsRemoteInferenceHandler.py +311 -239
  98. edsl/jobs/JobsRemoteInferenceLogger.py +239 -0
  99. edsl/jobs/RequestTokenEstimator.py +30 -0
  100. edsl/jobs/__init__.py +1 -1
  101. edsl/jobs/async_interview_runner.py +138 -0
  102. edsl/jobs/buckets/BucketCollection.py +104 -63
  103. edsl/jobs/buckets/ModelBuckets.py +65 -65
  104. edsl/jobs/buckets/TokenBucket.py +283 -251
  105. edsl/jobs/buckets/TokenBucketAPI.py +211 -0
  106. edsl/jobs/buckets/TokenBucketClient.py +191 -0
  107. edsl/jobs/check_survey_scenario_compatibility.py +85 -0
  108. edsl/jobs/data_structures.py +120 -0
  109. edsl/jobs/decorators.py +35 -0
  110. edsl/jobs/interviews/Interview.py +396 -661
  111. edsl/jobs/interviews/InterviewExceptionCollection.py +99 -99
  112. edsl/jobs/interviews/InterviewExceptionEntry.py +186 -186
  113. edsl/jobs/interviews/InterviewStatistic.py +63 -63
  114. edsl/jobs/interviews/InterviewStatisticsCollection.py +25 -25
  115. edsl/jobs/interviews/InterviewStatusDictionary.py +78 -78
  116. edsl/jobs/interviews/InterviewStatusLog.py +92 -92
  117. edsl/jobs/interviews/ReportErrors.py +66 -66
  118. edsl/jobs/interviews/interview_status_enum.py +9 -9
  119. edsl/jobs/jobs_status_enums.py +9 -0
  120. edsl/jobs/loggers/HTMLTableJobLogger.py +304 -0
  121. edsl/jobs/results_exceptions_handler.py +98 -0
  122. edsl/jobs/runners/JobsRunnerAsyncio.py +151 -466
  123. edsl/jobs/runners/JobsRunnerStatus.py +297 -330
  124. edsl/jobs/tasks/QuestionTaskCreator.py +244 -242
  125. edsl/jobs/tasks/TaskCreators.py +64 -64
  126. edsl/jobs/tasks/TaskHistory.py +470 -450
  127. edsl/jobs/tasks/TaskStatusLog.py +23 -23
  128. edsl/jobs/tasks/task_status_enum.py +161 -163
  129. edsl/jobs/tokens/InterviewTokenUsage.py +27 -27
  130. edsl/jobs/tokens/TokenUsage.py +34 -34
  131. edsl/language_models/ComputeCost.py +63 -0
  132. edsl/language_models/LanguageModel.py +626 -668
  133. edsl/language_models/ModelList.py +164 -155
  134. edsl/language_models/PriceManager.py +127 -0
  135. edsl/language_models/RawResponseHandler.py +106 -0
  136. edsl/language_models/RegisterLanguageModelsMeta.py +184 -184
  137. edsl/language_models/ServiceDataSources.py +0 -0
  138. edsl/language_models/__init__.py +2 -3
  139. edsl/language_models/fake_openai_call.py +15 -15
  140. edsl/language_models/fake_openai_service.py +61 -61
  141. edsl/language_models/key_management/KeyLookup.py +63 -0
  142. edsl/language_models/key_management/KeyLookupBuilder.py +273 -0
  143. edsl/language_models/key_management/KeyLookupCollection.py +38 -0
  144. edsl/language_models/key_management/__init__.py +0 -0
  145. edsl/language_models/key_management/models.py +131 -0
  146. edsl/language_models/model.py +256 -0
  147. edsl/language_models/repair.py +156 -156
  148. edsl/language_models/utilities.py +65 -64
  149. edsl/notebooks/Notebook.py +263 -258
  150. edsl/notebooks/NotebookToLaTeX.py +142 -0
  151. edsl/notebooks/__init__.py +1 -1
  152. edsl/prompts/Prompt.py +352 -362
  153. edsl/prompts/__init__.py +2 -2
  154. edsl/questions/ExceptionExplainer.py +77 -0
  155. edsl/questions/HTMLQuestion.py +103 -0
  156. edsl/questions/QuestionBase.py +518 -664
  157. edsl/questions/QuestionBasePromptsMixin.py +221 -217
  158. edsl/questions/QuestionBudget.py +227 -227
  159. edsl/questions/QuestionCheckBox.py +359 -359
  160. edsl/questions/QuestionExtract.py +180 -182
  161. edsl/questions/QuestionFreeText.py +113 -114
  162. edsl/questions/QuestionFunctional.py +166 -166
  163. edsl/questions/QuestionList.py +223 -231
  164. edsl/questions/QuestionMatrix.py +265 -0
  165. edsl/questions/QuestionMultipleChoice.py +330 -286
  166. edsl/questions/QuestionNumerical.py +151 -153
  167. edsl/questions/QuestionRank.py +314 -324
  168. edsl/questions/Quick.py +41 -41
  169. edsl/questions/SimpleAskMixin.py +74 -73
  170. edsl/questions/__init__.py +27 -26
  171. edsl/questions/{AnswerValidatorMixin.py → answer_validator_mixin.py} +334 -289
  172. edsl/questions/compose_questions.py +98 -98
  173. edsl/questions/data_structures.py +20 -0
  174. edsl/questions/decorators.py +21 -21
  175. edsl/questions/derived/QuestionLikertFive.py +76 -76
  176. edsl/questions/derived/QuestionLinearScale.py +90 -87
  177. edsl/questions/derived/QuestionTopK.py +93 -93
  178. edsl/questions/derived/QuestionYesNo.py +82 -82
  179. edsl/questions/descriptors.py +427 -413
  180. edsl/questions/loop_processor.py +149 -0
  181. edsl/questions/prompt_templates/question_budget.jinja +13 -13
  182. edsl/questions/prompt_templates/question_checkbox.jinja +32 -32
  183. edsl/questions/prompt_templates/question_extract.jinja +11 -11
  184. edsl/questions/prompt_templates/question_free_text.jinja +3 -3
  185. edsl/questions/prompt_templates/question_linear_scale.jinja +11 -11
  186. edsl/questions/prompt_templates/question_list.jinja +17 -17
  187. edsl/questions/prompt_templates/question_multiple_choice.jinja +33 -33
  188. edsl/questions/prompt_templates/question_numerical.jinja +36 -36
  189. edsl/questions/{QuestionBaseGenMixin.py → question_base_gen_mixin.py} +168 -161
  190. edsl/questions/question_registry.py +177 -177
  191. edsl/questions/{RegisterQuestionsMeta.py → register_questions_meta.py} +71 -71
  192. edsl/questions/{ResponseValidatorABC.py → response_validator_abc.py} +188 -174
  193. edsl/questions/response_validator_factory.py +34 -0
  194. edsl/questions/settings.py +12 -12
  195. edsl/questions/templates/budget/answering_instructions.jinja +7 -7
  196. edsl/questions/templates/budget/question_presentation.jinja +7 -7
  197. edsl/questions/templates/checkbox/answering_instructions.jinja +10 -10
  198. edsl/questions/templates/checkbox/question_presentation.jinja +22 -22
  199. edsl/questions/templates/extract/answering_instructions.jinja +7 -7
  200. edsl/questions/templates/likert_five/answering_instructions.jinja +10 -10
  201. edsl/questions/templates/likert_five/question_presentation.jinja +11 -11
  202. edsl/questions/templates/linear_scale/answering_instructions.jinja +5 -5
  203. edsl/questions/templates/linear_scale/question_presentation.jinja +5 -5
  204. edsl/questions/templates/list/answering_instructions.jinja +3 -3
  205. edsl/questions/templates/list/question_presentation.jinja +5 -5
  206. edsl/questions/templates/matrix/__init__.py +1 -0
  207. edsl/questions/templates/matrix/answering_instructions.jinja +5 -0
  208. edsl/questions/templates/matrix/question_presentation.jinja +20 -0
  209. edsl/questions/templates/multiple_choice/answering_instructions.jinja +9 -9
  210. edsl/questions/templates/multiple_choice/question_presentation.jinja +11 -11
  211. edsl/questions/templates/numerical/answering_instructions.jinja +6 -6
  212. edsl/questions/templates/numerical/question_presentation.jinja +6 -6
  213. edsl/questions/templates/rank/answering_instructions.jinja +11 -11
  214. edsl/questions/templates/rank/question_presentation.jinja +15 -15
  215. edsl/questions/templates/top_k/answering_instructions.jinja +8 -8
  216. edsl/questions/templates/top_k/question_presentation.jinja +22 -22
  217. edsl/questions/templates/yes_no/answering_instructions.jinja +6 -6
  218. edsl/questions/templates/yes_no/question_presentation.jinja +11 -11
  219. edsl/results/CSSParameterizer.py +108 -108
  220. edsl/results/Dataset.py +587 -424
  221. edsl/results/DatasetExportMixin.py +594 -731
  222. edsl/results/DatasetTree.py +295 -275
  223. edsl/results/MarkdownToDocx.py +122 -0
  224. edsl/results/MarkdownToPDF.py +111 -0
  225. edsl/results/Result.py +557 -465
  226. edsl/results/Results.py +1183 -1165
  227. edsl/results/ResultsExportMixin.py +45 -43
  228. edsl/results/ResultsGGMixin.py +121 -121
  229. edsl/results/TableDisplay.py +125 -198
  230. edsl/results/TextEditor.py +50 -0
  231. edsl/results/__init__.py +2 -2
  232. edsl/results/file_exports.py +252 -0
  233. edsl/results/{ResultsFetchMixin.py → results_fetch_mixin.py} +33 -33
  234. edsl/results/{Selector.py → results_selector.py} +145 -135
  235. edsl/results/{ResultsToolsMixin.py → results_tools_mixin.py} +98 -98
  236. edsl/results/smart_objects.py +96 -0
  237. edsl/results/table_data_class.py +12 -0
  238. edsl/results/table_display.css +77 -77
  239. edsl/results/table_renderers.py +118 -0
  240. edsl/results/tree_explore.py +115 -115
  241. edsl/scenarios/ConstructDownloadLink.py +109 -0
  242. edsl/scenarios/DocumentChunker.py +102 -0
  243. edsl/scenarios/DocxScenario.py +16 -0
  244. edsl/scenarios/FileStore.py +511 -632
  245. edsl/scenarios/PdfExtractor.py +40 -0
  246. edsl/scenarios/Scenario.py +498 -601
  247. edsl/scenarios/ScenarioHtmlMixin.py +65 -64
  248. edsl/scenarios/ScenarioList.py +1458 -1287
  249. edsl/scenarios/ScenarioListExportMixin.py +45 -52
  250. edsl/scenarios/ScenarioListPdfMixin.py +239 -261
  251. edsl/scenarios/__init__.py +3 -4
  252. edsl/scenarios/directory_scanner.py +96 -0
  253. edsl/scenarios/file_methods.py +85 -0
  254. edsl/scenarios/handlers/__init__.py +13 -0
  255. edsl/scenarios/handlers/csv.py +38 -0
  256. edsl/scenarios/handlers/docx.py +76 -0
  257. edsl/scenarios/handlers/html.py +37 -0
  258. edsl/scenarios/handlers/json.py +111 -0
  259. edsl/scenarios/handlers/latex.py +5 -0
  260. edsl/scenarios/handlers/md.py +51 -0
  261. edsl/scenarios/handlers/pdf.py +68 -0
  262. edsl/scenarios/handlers/png.py +39 -0
  263. edsl/scenarios/handlers/pptx.py +105 -0
  264. edsl/scenarios/handlers/py.py +294 -0
  265. edsl/scenarios/handlers/sql.py +313 -0
  266. edsl/scenarios/handlers/sqlite.py +149 -0
  267. edsl/scenarios/handlers/txt.py +33 -0
  268. edsl/scenarios/{ScenarioJoin.py → scenario_join.py} +131 -127
  269. edsl/scenarios/scenario_selector.py +156 -0
  270. edsl/shared.py +1 -1
  271. edsl/study/ObjectEntry.py +173 -173
  272. edsl/study/ProofOfWork.py +113 -113
  273. edsl/study/SnapShot.py +80 -80
  274. edsl/study/Study.py +521 -528
  275. edsl/study/__init__.py +4 -4
  276. edsl/surveys/ConstructDAG.py +92 -0
  277. edsl/surveys/DAG.py +148 -148
  278. edsl/surveys/EditSurvey.py +221 -0
  279. edsl/surveys/InstructionHandler.py +100 -0
  280. edsl/surveys/Memory.py +31 -31
  281. edsl/surveys/MemoryManagement.py +72 -0
  282. edsl/surveys/MemoryPlan.py +244 -244
  283. edsl/surveys/Rule.py +327 -326
  284. edsl/surveys/RuleCollection.py +385 -387
  285. edsl/surveys/RuleManager.py +172 -0
  286. edsl/surveys/Simulator.py +75 -0
  287. edsl/surveys/Survey.py +1280 -1801
  288. edsl/surveys/SurveyCSS.py +273 -261
  289. edsl/surveys/SurveyExportMixin.py +259 -259
  290. edsl/surveys/{SurveyFlowVisualizationMixin.py → SurveyFlowVisualization.py} +181 -179
  291. edsl/surveys/SurveyQualtricsImport.py +284 -284
  292. edsl/surveys/SurveyToApp.py +141 -0
  293. edsl/surveys/__init__.py +5 -3
  294. edsl/surveys/base.py +53 -53
  295. edsl/surveys/descriptors.py +60 -56
  296. edsl/surveys/instructions/ChangeInstruction.py +48 -49
  297. edsl/surveys/instructions/Instruction.py +56 -65
  298. edsl/surveys/instructions/InstructionCollection.py +82 -77
  299. edsl/templates/error_reporting/base.html +23 -23
  300. edsl/templates/error_reporting/exceptions_by_model.html +34 -34
  301. edsl/templates/error_reporting/exceptions_by_question_name.html +16 -16
  302. edsl/templates/error_reporting/exceptions_by_type.html +16 -16
  303. edsl/templates/error_reporting/interview_details.html +115 -115
  304. edsl/templates/error_reporting/interviews.html +19 -19
  305. edsl/templates/error_reporting/overview.html +4 -4
  306. edsl/templates/error_reporting/performance_plot.html +1 -1
  307. edsl/templates/error_reporting/report.css +73 -73
  308. edsl/templates/error_reporting/report.html +117 -117
  309. edsl/templates/error_reporting/report.js +25 -25
  310. edsl/tools/__init__.py +1 -1
  311. edsl/tools/clusters.py +192 -192
  312. edsl/tools/embeddings.py +27 -27
  313. edsl/tools/embeddings_plotting.py +118 -118
  314. edsl/tools/plotting.py +112 -112
  315. edsl/tools/summarize.py +18 -18
  316. edsl/utilities/PrettyList.py +56 -0
  317. edsl/utilities/SystemInfo.py +28 -28
  318. edsl/utilities/__init__.py +22 -22
  319. edsl/utilities/ast_utilities.py +25 -25
  320. edsl/utilities/data/Registry.py +6 -6
  321. edsl/utilities/data/__init__.py +1 -1
  322. edsl/utilities/data/scooter_results.json +1 -1
  323. edsl/utilities/decorators.py +77 -77
  324. edsl/utilities/gcp_bucket/cloud_storage.py +96 -96
  325. edsl/utilities/interface.py +627 -627
  326. edsl/utilities/is_notebook.py +18 -0
  327. edsl/utilities/is_valid_variable_name.py +11 -0
  328. edsl/utilities/naming_utilities.py +263 -263
  329. edsl/utilities/remove_edsl_version.py +24 -0
  330. edsl/utilities/repair_functions.py +28 -28
  331. edsl/utilities/restricted_python.py +70 -70
  332. edsl/utilities/utilities.py +436 -424
  333. {edsl-0.1.39.dev3.dist-info → edsl-0.1.39.dev5.dist-info}/LICENSE +21 -21
  334. {edsl-0.1.39.dev3.dist-info → edsl-0.1.39.dev5.dist-info}/METADATA +13 -11
  335. edsl-0.1.39.dev5.dist-info/RECORD +358 -0
  336. {edsl-0.1.39.dev3.dist-info → edsl-0.1.39.dev5.dist-info}/WHEEL +1 -1
  337. edsl/language_models/KeyLookup.py +0 -30
  338. edsl/language_models/registry.py +0 -190
  339. edsl/language_models/unused/ReplicateBase.py +0 -83
  340. edsl/results/ResultsDBMixin.py +0 -238
  341. edsl-0.1.39.dev3.dist-info/RECORD +0 -277
@@ -0,0 +1,50 @@
1
+ try:
2
+ import gradio as gr
3
+ except ImportError:
4
+ print("Gradio is not installed. Please install it using `pip install gradio`")
5
+
6
+ import time
7
+
8
+
9
+ class TextEditor:
10
+ def __init__(self, initial_text=""):
11
+ self.text = initial_text
12
+ self._text_saved = False
13
+
14
+ def save_text(self, new_text):
15
+ self.text = new_text
16
+ self._text_saved = True
17
+ return "Text saved successfully!"
18
+
19
+ def edit_gui(self):
20
+ js_code = """
21
+ async (text) => {
22
+ await navigator.clipboard.writeText(text);
23
+ return "Copied to clipboard!";
24
+ }
25
+ """
26
+
27
+ with gr.Blocks() as interface:
28
+ text_area = gr.Textbox(
29
+ value=self.text, lines=10, label="Edit Text", placeholder="Type here..."
30
+ )
31
+
32
+ with gr.Row():
33
+ save_btn = gr.Button("Save")
34
+ copy_btn = gr.Button("Copy to Clipboard")
35
+
36
+ output = gr.Textbox(label="Status")
37
+
38
+ save_btn.click(fn=self.save_text, inputs=[text_area], outputs=[output])
39
+
40
+ # Add copy functionality
41
+ copy_btn.click(
42
+ fn=None, inputs=text_area, outputs=output, api_name=False, js=js_code
43
+ )
44
+
45
+ interface.launch(share=False, prevent_thread_lock=True)
46
+
47
+ while not self._text_saved:
48
+ time.sleep(0.1)
49
+
50
+ return self.text
edsl/results/__init__.py CHANGED
@@ -1,2 +1,2 @@
1
- from edsl.results.Result import Result
2
- from edsl.results.Results import Results
1
+ # from edsl.results.Result import Result
2
+ from edsl.results.Results import Results
@@ -0,0 +1,252 @@
1
+ from abc import ABC, abstractmethod
2
+ import io
3
+ import csv
4
+ import base64
5
+ from typing import Optional, Union, Tuple, List, Any, Dict
6
+ from openpyxl import Workbook
7
+
8
+ from edsl.scenarios.FileStore import FileStore
9
+
10
+
11
+ class FileExport(ABC):
12
+ def __init__(
13
+ self,
14
+ data: Any,
15
+ filename: Optional[str] = None,
16
+ remove_prefix: bool = False,
17
+ pretty_labels: Optional[Dict[str, str]] = None,
18
+ ):
19
+ self.data = data
20
+ self.filename = filename # or self._get_default_filename()
21
+ self.remove_prefix = remove_prefix
22
+ self.pretty_labels = pretty_labels
23
+
24
+ @property
25
+ def mime_type(self) -> str:
26
+ """Return the MIME type for this export format."""
27
+ return self.__class__.mime_type
28
+
29
+ @property
30
+ def suffix(self) -> str:
31
+ """Return the file suffix for this format."""
32
+ return self.__class__.suffix
33
+
34
+ @property
35
+ def is_binary(self) -> bool:
36
+ """Whether the format is binary or text-based."""
37
+ return self.__class__.is_binary
38
+
39
+ def _get_default_filename(self) -> str:
40
+ """Generate default filename for this format."""
41
+ return f"results.{self.suffix}"
42
+
43
+ def _create_filestore(self, data: Union[str, bytes]) -> "FileStore":
44
+ """Create a FileStore instance with encoded data."""
45
+ if isinstance(data, str):
46
+ base64_string = base64.b64encode(data.encode()).decode()
47
+ else:
48
+ base64_string = base64.b64encode(data).decode()
49
+
50
+ from edsl.scenarios.FileStore import FileStore
51
+
52
+ path = self.filename or self._get_default_filename()
53
+
54
+ fs = FileStore(
55
+ path=path,
56
+ mime_type=self.mime_type,
57
+ binary=self.is_binary,
58
+ suffix=self.suffix,
59
+ base64_string=base64_string,
60
+ )
61
+
62
+ if self.filename is not None:
63
+ fs.write(self.filename)
64
+ return None
65
+ return fs
66
+
67
+ @abstractmethod
68
+ def format_data(self) -> Union[str, bytes]:
69
+ """Convert the input data to the target format."""
70
+ pass
71
+
72
+ def export(self) -> Optional["FileStore"]:
73
+ """Export the data to a FileStore instance."""
74
+ formatted_data = self.format_data()
75
+ return self._create_filestore(formatted_data)
76
+
77
+
78
+ class JSONLExport(FileExport):
79
+ mime_type = "application/jsonl"
80
+ suffix = "jsonl"
81
+ is_binary = False
82
+
83
+ def format_data(self) -> str:
84
+ output = io.StringIO()
85
+ for entry in self.data:
86
+ key, values = list(entry.items())[0]
87
+ output.write(f'{{"{key}": {values}}}\n')
88
+ return output.getvalue()
89
+
90
+
91
+ class TabularExport(FileExport, ABC):
92
+ """Base class for exports that use tabular data."""
93
+
94
+ def __init__(self, *args, **kwargs):
95
+ super().__init__(*args, **kwargs)
96
+ self.header, self.rows = self.data._get_tabular_data(
97
+ remove_prefix=self.remove_prefix, pretty_labels=self.pretty_labels
98
+ )
99
+
100
+
101
+ class CSVExport(TabularExport):
102
+ mime_type = "text/csv"
103
+ suffix = "csv"
104
+ is_binary = False
105
+
106
+ def format_data(self) -> str:
107
+ output = io.StringIO()
108
+ writer = csv.writer(output)
109
+ writer.writerow(self.header)
110
+ writer.writerows(self.rows)
111
+ return output.getvalue()
112
+
113
+
114
+ class ExcelExport(TabularExport):
115
+ mime_type = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
116
+ suffix = "xlsx"
117
+ is_binary = True
118
+
119
+ def __init__(self, *args, sheet_name: Optional[str] = None, **kwargs):
120
+ super().__init__(*args, **kwargs)
121
+ self.sheet_name = sheet_name or "Results"
122
+
123
+ def format_data(self) -> bytes:
124
+ wb = Workbook()
125
+ ws = wb.active
126
+ ws.title = self.sheet_name
127
+
128
+ # Write header
129
+ for col, value in enumerate(self.header, 1):
130
+ ws.cell(row=1, column=col, value=value)
131
+
132
+ # Write data rows
133
+ for row_idx, row_data in enumerate(self.rows, 2):
134
+ for col, value in enumerate(row_data, 1):
135
+ ws.cell(row=row_idx, column=col, value=value)
136
+
137
+ # Save to bytes buffer
138
+ buffer = io.BytesIO()
139
+ wb.save(buffer)
140
+ buffer.seek(0)
141
+ return buffer.getvalue()
142
+
143
+
144
+ import sqlite3
145
+ from typing import Any
146
+
147
+
148
+ class SQLiteExport(TabularExport):
149
+ mime_type = "application/x-sqlite3"
150
+ suffix = "db"
151
+ is_binary = True
152
+
153
+ def __init__(
154
+ self, *args, table_name: str = "results", if_exists: str = "replace", **kwargs
155
+ ):
156
+ """
157
+ Initialize SQLite export.
158
+
159
+ Args:
160
+ table_name: Name of the table to create
161
+ if_exists: How to handle existing table ('fail', 'replace', or 'append')
162
+ """
163
+ super().__init__(*args, **kwargs)
164
+ self.table_name = table_name
165
+ self.if_exists = if_exists
166
+
167
+ def _get_column_types(self) -> list[tuple[str, str]]:
168
+ """Infer SQL column types from the data."""
169
+ column_types = []
170
+
171
+ # Check first row of data for types
172
+ if self.rows:
173
+ first_row = self.rows[0]
174
+ for header, value in zip(self.header, first_row):
175
+ if isinstance(value, bool):
176
+ sql_type = "BOOLEAN"
177
+ elif isinstance(value, int):
178
+ sql_type = "INTEGER"
179
+ elif isinstance(value, float):
180
+ sql_type = "REAL"
181
+ else:
182
+ sql_type = "TEXT"
183
+ column_types.append((header, sql_type))
184
+ else:
185
+ # If no data, default to TEXT
186
+ column_types = [(header, "TEXT") for header in self.header]
187
+
188
+ return column_types
189
+
190
+ def _create_table(self, cursor: sqlite3.Cursor) -> None:
191
+ """Create the table with appropriate schema."""
192
+ column_types = self._get_column_types()
193
+
194
+ # Drop existing table if replace mode
195
+ if self.if_exists == "replace":
196
+ cursor.execute(f"DROP TABLE IF EXISTS {self.table_name}")
197
+ elif self.if_exists == "fail":
198
+ cursor.execute(
199
+ f"SELECT name FROM sqlite_master WHERE type='table' AND name=?",
200
+ (self.table_name,),
201
+ )
202
+ if cursor.fetchone():
203
+ raise ValueError(f"Table {self.table_name} already exists")
204
+
205
+ # Create table
206
+ columns = ", ".join(f'"{col}" {dtype}' for col, dtype in column_types)
207
+ create_table_sql = f"""
208
+ CREATE TABLE IF NOT EXISTS {self.table_name} (
209
+ {columns}
210
+ )
211
+ """
212
+ cursor.execute(create_table_sql)
213
+
214
+ def format_data(self) -> bytes:
215
+ """Convert the data to a SQLite database file."""
216
+ buffer = io.BytesIO()
217
+
218
+ # Create in-memory database
219
+ conn = sqlite3.connect(":memory:")
220
+ cursor = conn.cursor()
221
+
222
+ # Create table and insert data
223
+ self._create_table(cursor)
224
+
225
+ # Prepare placeholders for INSERT
226
+ placeholders = ",".join(["?" for _ in self.header])
227
+ insert_sql = f"INSERT INTO {self.table_name} ({','.join(self.header)}) VALUES ({placeholders})"
228
+
229
+ # Insert data
230
+ cursor.executemany(insert_sql, self.rows)
231
+ conn.commit()
232
+
233
+ # Save to file buffer
234
+ conn.backup(sqlite3.connect(buffer))
235
+ conn.close()
236
+
237
+ buffer.seek(0)
238
+ return buffer.getvalue()
239
+
240
+ def _validate_params(self) -> None:
241
+ """Validate initialization parameters."""
242
+ valid_if_exists = {"fail", "replace", "append"}
243
+ if self.if_exists not in valid_if_exists:
244
+ raise ValueError(
245
+ f"if_exists must be one of {valid_if_exists}, got {self.if_exists}"
246
+ )
247
+
248
+ # Validate table name (basic SQLite identifier validation)
249
+ if not self.table_name.isalnum() and not all(c in "_" for c in self.table_name):
250
+ raise ValueError(
251
+ f"Invalid table name: {self.table_name}. Must contain only alphanumeric characters and underscores."
252
+ )
@@ -1,33 +1,33 @@
1
- """Mixin for fetching data from results."""
2
-
3
- from functools import partial
4
- from itertools import chain
5
-
6
-
7
- class ResultsFetchMixin:
8
- """Mixin for fetching data from results."""
9
-
10
- def _fetch_list(self, data_type: str, key: str) -> list:
11
- """
12
- Return a list of values from the data for a given data type and key.
13
-
14
- Uses the filtered data, not the original data.
15
-
16
- Example:
17
-
18
- >>> from edsl.results import Results
19
- >>> r = Results.example()
20
- >>> r._fetch_list('answer', 'how_feeling')
21
- ['OK', 'Great', 'Terrible', 'OK']
22
- """
23
- returned_list = []
24
- for row in self.data:
25
- returned_list.append(row.sub_dicts[data_type].get(key, None))
26
-
27
- return returned_list
28
-
29
-
30
- if __name__ == "__main__":
31
- import doctest
32
-
33
- doctest.testmod(optionflags=doctest.ELLIPSIS)
1
+ """Mixin for fetching data from results."""
2
+
3
+ from functools import partial
4
+ from itertools import chain
5
+
6
+
7
+ class ResultsFetchMixin:
8
+ """Mixin for fetching data from results."""
9
+
10
+ def _fetch_list(self, data_type: str, key: str) -> list:
11
+ """
12
+ Return a list of values from the data for a given data type and key.
13
+
14
+ Uses the filtered data, not the original data.
15
+
16
+ Example:
17
+
18
+ >>> from edsl.results import Results
19
+ >>> r = Results.example()
20
+ >>> r._fetch_list('answer', 'how_feeling')
21
+ ['OK', 'Great', 'Terrible', 'OK']
22
+ """
23
+ returned_list = []
24
+ for row in self.data:
25
+ returned_list.append(row.sub_dicts[data_type].get(key, None))
26
+
27
+ return returned_list
28
+
29
+
30
+ if __name__ == "__main__":
31
+ import doctest
32
+
33
+ doctest.testmod(optionflags=doctest.ELLIPSIS)
@@ -1,135 +1,145 @@
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, Optional
2
+ import sys
3
+ from collections import defaultdict
4
+ from edsl.results.Dataset import Dataset
5
+
6
+ from edsl.exceptions.results import ResultsColumnNotFoundError
7
+
8
+ from edsl.utilities.is_notebook import is_notebook
9
+
10
+
11
+ class Selector:
12
+ def __init__(
13
+ self,
14
+ known_data_types: List[str],
15
+ data_type_to_keys: Dict[str, List[str]],
16
+ key_to_data_type: Dict[str, str],
17
+ fetch_list_func,
18
+ columns: List[str],
19
+ ):
20
+ """Selects columns from a Results object"""
21
+ self.known_data_types = known_data_types
22
+ self._data_type_to_keys = data_type_to_keys
23
+ self._key_to_data_type = key_to_data_type
24
+ self._fetch_list = fetch_list_func
25
+ self.columns = columns
26
+
27
+ def select(self, *columns: Union[str, List[str]]) -> Optional[Dataset]:
28
+ try:
29
+ columns = self._normalize_columns(columns)
30
+ to_fetch = self._get_columns_to_fetch(columns)
31
+ new_data = self._fetch_data(to_fetch)
32
+ except ResultsColumnNotFoundError as e:
33
+ if is_notebook():
34
+ print("Error:", e, file=sys.stderr)
35
+ return None
36
+ else:
37
+ raise e
38
+ return Dataset(new_data)
39
+
40
+ def _normalize_columns(self, columns: Union[str, List[str]]) -> tuple:
41
+ """Normalize the columns to a tuple of strings
42
+
43
+ >>> s = Selector([], {}, {}, lambda x, y: x, [])
44
+ >>> s._normalize_columns([["a", "b"], ])
45
+ ('a', 'b')
46
+ >>> s._normalize_columns(None)
47
+ ('*.*',)
48
+ """
49
+ if not columns or columns == ("*",) or columns == (None,):
50
+ return ("*.*",)
51
+ if isinstance(columns[0], list):
52
+ return tuple(columns[0])
53
+ return columns
54
+
55
+ def _get_columns_to_fetch(self, columns: tuple) -> Dict[str, List[str]]:
56
+ to_fetch = defaultdict(list)
57
+ self.items_in_order = []
58
+
59
+ for column in columns:
60
+ matches = self._find_matching_columns(column)
61
+ # breakpoint()
62
+ self._validate_matches(column, matches)
63
+
64
+ if len(matches) == 1:
65
+ column = matches[0]
66
+
67
+ data_type, key = self._parse_column(column)
68
+ self._process_column(data_type, key, to_fetch)
69
+
70
+ return to_fetch
71
+
72
+ def _find_matching_columns(self, partial_name: str) -> list[str]:
73
+ if "." in partial_name:
74
+ search_in_list = self.columns
75
+ else:
76
+ search_in_list = [s.split(".")[1] for s in self.columns]
77
+ matches = [s for s in search_in_list if s.startswith(partial_name)]
78
+ return [partial_name] if partial_name in matches else matches
79
+
80
+ def _validate_matches(self, column: str, matches: List[str]):
81
+ if len(matches) > 1:
82
+ raise ResultsColumnNotFoundError(
83
+ f"Column '{column}' is ambiguous. Did you mean one of {matches}?"
84
+ )
85
+ if len(matches) == 0 and ".*" not in column:
86
+ raise ResultsColumnNotFoundError(f"Column '{column}' not found in data.")
87
+
88
+ def _parse_column(self, column: str) -> tuple[str, str]:
89
+ if "." in column:
90
+ return column.split(".")
91
+ try:
92
+ return self._key_to_data_type[column], column
93
+ except KeyError:
94
+ self._raise_key_error(column)
95
+
96
+ def _raise_key_error(self, column: str):
97
+ import difflib
98
+
99
+ close_matches = difflib.get_close_matches(column, self._key_to_data_type.keys())
100
+ if close_matches:
101
+ suggestions = ", ".join(close_matches)
102
+ raise ResultsColumnNotFoundError(
103
+ f"Column '{column}' not found in data. Did you mean: {suggestions}?"
104
+ )
105
+ else:
106
+ raise ResultsColumnNotFoundError(f"Column {column} not found in data")
107
+
108
+ def _process_column(self, data_type: str, key: str, to_fetch: Dict[str, List[str]]):
109
+ data_types = self._get_data_types_to_return(data_type)
110
+ found_once = False
111
+
112
+ for dt in data_types:
113
+ relevant_keys = self._data_type_to_keys[dt]
114
+ for k in relevant_keys:
115
+ if k == key or key == "*":
116
+ found_once = True
117
+ to_fetch[dt].append(k)
118
+ self.items_in_order.append(f"{dt}.{k}")
119
+
120
+ if not found_once:
121
+ raise ResultsColumnNotFoundError(f"Key {key} not found in data.")
122
+
123
+ def _get_data_types_to_return(self, parsed_data_type: str) -> List[str]:
124
+ if parsed_data_type == "*":
125
+ return self.known_data_types
126
+ if parsed_data_type not in self.known_data_types:
127
+ raise ResultsColumnNotFoundError(
128
+ f"Data type {parsed_data_type} not found in data. Did you mean one of {self.known_data_types}"
129
+ )
130
+ return [parsed_data_type]
131
+
132
+ def _fetch_data(self, to_fetch: Dict[str, List[str]]) -> List[Dict[str, Any]]:
133
+ new_data = []
134
+ for data_type, keys in to_fetch.items():
135
+ for key in keys:
136
+ entries = self._fetch_list(data_type, key)
137
+ new_data.append({f"{data_type}.{key}": entries})
138
+
139
+ return [d for key in self.items_in_order for d in new_data if key in d]
140
+
141
+
142
+ if __name__ == "__main__":
143
+ import doctest
144
+
145
+ doctest.testmod()