edsl 0.1.37.dev2__py3-none-any.whl → 0.1.37.dev4__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 (257) 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 -48
  5. edsl/__version__.py +1 -1
  6. edsl/agents/Agent.py +804 -804
  7. edsl/agents/AgentList.py +345 -345
  8. edsl/agents/Invigilator.py +222 -222
  9. edsl/agents/InvigilatorBase.py +305 -305
  10. edsl/agents/PromptConstructor.py +312 -312
  11. edsl/agents/__init__.py +3 -3
  12. edsl/agents/descriptors.py +86 -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 +152 -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 +238 -238
  43. edsl/conversation/car_buying.py +58 -58
  44. edsl/conversation/mug_negotiation.py +81 -81
  45. edsl/conversation/next_speaker_utilities.py +93 -93
  46. edsl/coop/PriceFetcher.py +54 -54
  47. edsl/coop/__init__.py +2 -2
  48. edsl/coop/coop.py +827 -824
  49. edsl/coop/utils.py +131 -131
  50. edsl/data/Cache.py +527 -527
  51. edsl/data/CacheEntry.py +228 -228
  52. edsl/data/CacheHandler.py +149 -149
  53. edsl/data/RemoteCacheSync.py +97 -97
  54. edsl/data/SQLiteDict.py +292 -292
  55. edsl/data/__init__.py +4 -4
  56. edsl/data/orm.py +10 -10
  57. edsl/data_transfer_models.py +73 -73
  58. edsl/enums.py +173 -173
  59. edsl/exceptions/__init__.py +50 -50
  60. edsl/exceptions/agents.py +40 -40
  61. edsl/exceptions/configuration.py +16 -16
  62. edsl/exceptions/coop.py +10 -10
  63. edsl/exceptions/data.py +14 -14
  64. edsl/exceptions/general.py +34 -34
  65. edsl/exceptions/jobs.py +33 -33
  66. edsl/exceptions/language_models.py +63 -63
  67. edsl/exceptions/prompts.py +15 -15
  68. edsl/exceptions/questions.py +91 -91
  69. edsl/exceptions/results.py +26 -26
  70. edsl/exceptions/surveys.py +34 -34
  71. edsl/inference_services/AnthropicService.py +87 -87
  72. edsl/inference_services/AwsBedrock.py +120 -115
  73. edsl/inference_services/AzureAI.py +217 -217
  74. edsl/inference_services/DeepInfraService.py +18 -18
  75. edsl/inference_services/GoogleService.py +156 -156
  76. edsl/inference_services/GroqService.py +20 -20
  77. edsl/inference_services/InferenceServiceABC.py +147 -147
  78. edsl/inference_services/InferenceServicesCollection.py +74 -74
  79. edsl/inference_services/MistralAIService.py +123 -123
  80. edsl/inference_services/OllamaService.py +18 -18
  81. edsl/inference_services/OpenAIService.py +224 -224
  82. edsl/inference_services/TestService.py +89 -89
  83. edsl/inference_services/TogetherAIService.py +170 -170
  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 +39 -39
  87. edsl/inference_services/write_available.py +10 -10
  88. edsl/jobs/Answers.py +56 -56
  89. edsl/jobs/Jobs.py +1135 -1112
  90. edsl/jobs/__init__.py +1 -1
  91. edsl/jobs/buckets/BucketCollection.py +63 -63
  92. edsl/jobs/buckets/ModelBuckets.py +65 -65
  93. edsl/jobs/buckets/TokenBucket.py +248 -248
  94. edsl/jobs/interviews/Interview.py +661 -661
  95. edsl/jobs/interviews/InterviewExceptionCollection.py +99 -99
  96. edsl/jobs/interviews/InterviewExceptionEntry.py +182 -182
  97. edsl/jobs/interviews/InterviewStatistic.py +63 -63
  98. edsl/jobs/interviews/InterviewStatisticsCollection.py +25 -25
  99. edsl/jobs/interviews/InterviewStatusDictionary.py +78 -78
  100. edsl/jobs/interviews/InterviewStatusLog.py +92 -92
  101. edsl/jobs/interviews/ReportErrors.py +66 -66
  102. edsl/jobs/interviews/interview_status_enum.py +9 -9
  103. edsl/jobs/runners/JobsRunnerAsyncio.py +338 -338
  104. edsl/jobs/runners/JobsRunnerStatus.py +332 -332
  105. edsl/jobs/tasks/QuestionTaskCreator.py +242 -242
  106. edsl/jobs/tasks/TaskCreators.py +64 -64
  107. edsl/jobs/tasks/TaskHistory.py +441 -441
  108. edsl/jobs/tasks/TaskStatusLog.py +23 -23
  109. edsl/jobs/tasks/task_status_enum.py +163 -163
  110. edsl/jobs/tokens/InterviewTokenUsage.py +27 -27
  111. edsl/jobs/tokens/TokenUsage.py +34 -34
  112. edsl/language_models/LanguageModel.py +718 -718
  113. edsl/language_models/ModelList.py +102 -102
  114. edsl/language_models/RegisterLanguageModelsMeta.py +184 -184
  115. edsl/language_models/__init__.py +2 -2
  116. edsl/language_models/fake_openai_call.py +15 -15
  117. edsl/language_models/fake_openai_service.py +61 -61
  118. edsl/language_models/registry.py +137 -137
  119. edsl/language_models/repair.py +156 -156
  120. edsl/language_models/unused/ReplicateBase.py +83 -83
  121. edsl/language_models/utilities.py +64 -64
  122. edsl/notebooks/Notebook.py +259 -259
  123. edsl/notebooks/__init__.py +1 -1
  124. edsl/prompts/Prompt.py +353 -353
  125. edsl/prompts/__init__.py +2 -2
  126. edsl/questions/AnswerValidatorMixin.py +289 -289
  127. edsl/questions/QuestionBase.py +616 -616
  128. edsl/questions/QuestionBaseGenMixin.py +161 -161
  129. edsl/questions/QuestionBasePromptsMixin.py +266 -266
  130. edsl/questions/QuestionBudget.py +227 -227
  131. edsl/questions/QuestionCheckBox.py +359 -359
  132. edsl/questions/QuestionExtract.py +183 -183
  133. edsl/questions/QuestionFreeText.py +114 -114
  134. edsl/questions/QuestionFunctional.py +159 -159
  135. edsl/questions/QuestionList.py +231 -231
  136. edsl/questions/QuestionMultipleChoice.py +286 -286
  137. edsl/questions/QuestionNumerical.py +153 -153
  138. edsl/questions/QuestionRank.py +324 -324
  139. edsl/questions/Quick.py +41 -41
  140. edsl/questions/RegisterQuestionsMeta.py +71 -71
  141. edsl/questions/ResponseValidatorABC.py +174 -174
  142. edsl/questions/SimpleAskMixin.py +73 -73
  143. edsl/questions/__init__.py +26 -26
  144. edsl/questions/compose_questions.py +98 -98
  145. edsl/questions/decorators.py +21 -21
  146. edsl/questions/derived/QuestionLikertFive.py +76 -76
  147. edsl/questions/derived/QuestionLinearScale.py +87 -87
  148. edsl/questions/derived/QuestionTopK.py +91 -91
  149. edsl/questions/derived/QuestionYesNo.py +82 -82
  150. edsl/questions/descriptors.py +418 -418
  151. edsl/questions/prompt_templates/question_budget.jinja +13 -13
  152. edsl/questions/prompt_templates/question_checkbox.jinja +32 -32
  153. edsl/questions/prompt_templates/question_extract.jinja +11 -11
  154. edsl/questions/prompt_templates/question_free_text.jinja +3 -3
  155. edsl/questions/prompt_templates/question_linear_scale.jinja +11 -11
  156. edsl/questions/prompt_templates/question_list.jinja +17 -17
  157. edsl/questions/prompt_templates/question_multiple_choice.jinja +33 -33
  158. edsl/questions/prompt_templates/question_numerical.jinja +36 -36
  159. edsl/questions/question_registry.py +147 -147
  160. edsl/questions/settings.py +12 -12
  161. edsl/questions/templates/budget/answering_instructions.jinja +7 -7
  162. edsl/questions/templates/budget/question_presentation.jinja +7 -7
  163. edsl/questions/templates/checkbox/answering_instructions.jinja +10 -10
  164. edsl/questions/templates/checkbox/question_presentation.jinja +22 -22
  165. edsl/questions/templates/extract/answering_instructions.jinja +7 -7
  166. edsl/questions/templates/likert_five/answering_instructions.jinja +10 -10
  167. edsl/questions/templates/likert_five/question_presentation.jinja +11 -11
  168. edsl/questions/templates/linear_scale/answering_instructions.jinja +5 -5
  169. edsl/questions/templates/linear_scale/question_presentation.jinja +5 -5
  170. edsl/questions/templates/list/answering_instructions.jinja +3 -3
  171. edsl/questions/templates/list/question_presentation.jinja +5 -5
  172. edsl/questions/templates/multiple_choice/answering_instructions.jinja +9 -9
  173. edsl/questions/templates/multiple_choice/question_presentation.jinja +11 -11
  174. edsl/questions/templates/numerical/answering_instructions.jinja +6 -6
  175. edsl/questions/templates/numerical/question_presentation.jinja +6 -6
  176. edsl/questions/templates/rank/answering_instructions.jinja +11 -11
  177. edsl/questions/templates/rank/question_presentation.jinja +15 -15
  178. edsl/questions/templates/top_k/answering_instructions.jinja +8 -8
  179. edsl/questions/templates/top_k/question_presentation.jinja +22 -22
  180. edsl/questions/templates/yes_no/answering_instructions.jinja +6 -6
  181. edsl/questions/templates/yes_no/question_presentation.jinja +11 -11
  182. edsl/results/Dataset.py +293 -293
  183. edsl/results/DatasetExportMixin.py +693 -693
  184. edsl/results/DatasetTree.py +145 -145
  185. edsl/results/Result.py +435 -435
  186. edsl/results/Results.py +1160 -1160
  187. edsl/results/ResultsDBMixin.py +238 -238
  188. edsl/results/ResultsExportMixin.py +43 -43
  189. edsl/results/ResultsFetchMixin.py +33 -33
  190. edsl/results/ResultsGGMixin.py +121 -121
  191. edsl/results/ResultsToolsMixin.py +98 -98
  192. edsl/results/Selector.py +118 -118
  193. edsl/results/__init__.py +2 -2
  194. edsl/results/tree_explore.py +115 -115
  195. edsl/scenarios/FileStore.py +458 -458
  196. edsl/scenarios/Scenario.py +510 -510
  197. edsl/scenarios/ScenarioHtmlMixin.py +59 -59
  198. edsl/scenarios/ScenarioList.py +1101 -1101
  199. edsl/scenarios/ScenarioListExportMixin.py +52 -52
  200. edsl/scenarios/ScenarioListPdfMixin.py +261 -261
  201. edsl/scenarios/__init__.py +4 -4
  202. edsl/shared.py +1 -1
  203. edsl/study/ObjectEntry.py +173 -173
  204. edsl/study/ProofOfWork.py +113 -113
  205. edsl/study/SnapShot.py +80 -80
  206. edsl/study/Study.py +528 -528
  207. edsl/study/__init__.py +4 -4
  208. edsl/surveys/DAG.py +148 -148
  209. edsl/surveys/Memory.py +31 -31
  210. edsl/surveys/MemoryPlan.py +244 -244
  211. edsl/surveys/Rule.py +324 -324
  212. edsl/surveys/RuleCollection.py +387 -387
  213. edsl/surveys/Survey.py +1772 -1772
  214. edsl/surveys/SurveyCSS.py +261 -261
  215. edsl/surveys/SurveyExportMixin.py +259 -259
  216. edsl/surveys/SurveyFlowVisualizationMixin.py +121 -121
  217. edsl/surveys/SurveyQualtricsImport.py +284 -284
  218. edsl/surveys/__init__.py +3 -3
  219. edsl/surveys/base.py +53 -53
  220. edsl/surveys/descriptors.py +56 -56
  221. edsl/surveys/instructions/ChangeInstruction.py +47 -47
  222. edsl/surveys/instructions/Instruction.py +51 -51
  223. edsl/surveys/instructions/InstructionCollection.py +77 -77
  224. edsl/templates/error_reporting/base.html +23 -23
  225. edsl/templates/error_reporting/exceptions_by_model.html +34 -34
  226. edsl/templates/error_reporting/exceptions_by_question_name.html +16 -16
  227. edsl/templates/error_reporting/exceptions_by_type.html +16 -16
  228. edsl/templates/error_reporting/interview_details.html +115 -115
  229. edsl/templates/error_reporting/interviews.html +9 -9
  230. edsl/templates/error_reporting/overview.html +4 -4
  231. edsl/templates/error_reporting/performance_plot.html +1 -1
  232. edsl/templates/error_reporting/report.css +73 -73
  233. edsl/templates/error_reporting/report.html +117 -117
  234. edsl/templates/error_reporting/report.js +25 -25
  235. edsl/tools/__init__.py +1 -1
  236. edsl/tools/clusters.py +192 -192
  237. edsl/tools/embeddings.py +27 -27
  238. edsl/tools/embeddings_plotting.py +118 -118
  239. edsl/tools/plotting.py +112 -112
  240. edsl/tools/summarize.py +18 -18
  241. edsl/utilities/SystemInfo.py +28 -28
  242. edsl/utilities/__init__.py +22 -22
  243. edsl/utilities/ast_utilities.py +25 -25
  244. edsl/utilities/data/Registry.py +6 -6
  245. edsl/utilities/data/__init__.py +1 -1
  246. edsl/utilities/data/scooter_results.json +1 -1
  247. edsl/utilities/decorators.py +77 -77
  248. edsl/utilities/gcp_bucket/cloud_storage.py +96 -96
  249. edsl/utilities/interface.py +627 -627
  250. edsl/utilities/repair_functions.py +28 -28
  251. edsl/utilities/restricted_python.py +70 -70
  252. edsl/utilities/utilities.py +391 -391
  253. {edsl-0.1.37.dev2.dist-info → edsl-0.1.37.dev4.dist-info}/LICENSE +21 -21
  254. {edsl-0.1.37.dev2.dist-info → edsl-0.1.37.dev4.dist-info}/METADATA +1 -1
  255. edsl-0.1.37.dev4.dist-info/RECORD +279 -0
  256. edsl-0.1.37.dev2.dist-info/RECORD +0 -279
  257. {edsl-0.1.37.dev2.dist-info → edsl-0.1.37.dev4.dist-info}/WHEEL +0 -0
edsl/surveys/SurveyCSS.py CHANGED
@@ -1,261 +1,261 @@
1
- from typing import Optional
2
- from edsl.utilities.decorators import add_edsl_version, remove_edsl_version
3
-
4
-
5
- class CSSRuleMeta(type):
6
- _instances = []
7
-
8
- def __init__(cls, name, bases, dct):
9
- super().__init__(name, bases, dct)
10
-
11
- def __call__(cls, *args, **kwargs):
12
- instance = super().__call__(*args, **kwargs)
13
- cls._instances.append(instance)
14
- return instance
15
-
16
- @classmethod
17
- def get_instances(cls):
18
- return cls._instances
19
-
20
-
21
- class CSSRule(metaclass=CSSRuleMeta):
22
- def __init__(self, selector: str, properties: Optional[dict[str, str]] = None):
23
- """
24
- A CSS rule object that represents a CSS rule with a selector and properties.
25
-
26
- >>> rule = CSSRule("survey_container", {"width": "80%", "margin": "0 auto"})
27
- >>> rule.generate_rule()
28
- '.survey_container {\\n width: 80%;\\n margin: 0 auto;\\n}'
29
- """
30
- self.selector = selector
31
- self.properties = properties if properties else {}
32
-
33
- def add_property(self, property_name: str, value: str) -> "CSSRule":
34
- """
35
- >>> rule = CSSRule("survey_container")
36
- >>> rule.add_property("width", "80%")
37
- CSSRule(select = survey_container, properties = {'width': '80%'})
38
- """
39
- self.properties[property_name] = value
40
- return self
41
-
42
- def remove_property(self, property_name) -> "CSSRule":
43
- """
44
- >>> rule = CSSRule("survey_container", {"width": "80%", "margin": "0 auto"})
45
- >>> rule.remove_property("margin")
46
- CSSRule(select = survey_container, properties = {'width': '80%'})
47
- """
48
- if property_name in self.properties:
49
- del self.properties[property_name]
50
- return self
51
-
52
- def generate_rule(self) -> str:
53
- """
54
- >>> rule = CSSRule("survey_container", {"width": "80%", "margin": "0 auto"})
55
- >>> rule.generate_rule()
56
- '.survey_container {\\n width: 80%;\\n margin: 0 auto;\\n}'
57
- """
58
- rule_lines = [f".{self.selector} {{"]
59
- for prop, value in self.properties.items():
60
- rule_lines.append(f" {prop}: {value};")
61
- rule_lines.append("}")
62
- return "\n".join(rule_lines)
63
-
64
- def __repr__(self) -> str:
65
- return f"CSSRule(select = {self.selector}, properties = {self.properties})"
66
-
67
- @add_edsl_version
68
- def to_dict(self) -> dict:
69
- """
70
- >>> rule = CSSRule("survey_container", {"width": "80%", "margin": "0 auto"})
71
- >>> rule.to_dict()
72
- {'selector': 'survey_container', 'properties': {'width': '80%', 'margin': '0 auto'}, 'edsl_version': '...', 'edsl_class_name': 'CSSRule'}
73
- """
74
- return {"selector": self.selector, "properties": self.properties}
75
-
76
- @classmethod
77
- @remove_edsl_version
78
- def from_dict(cls, rule_dict) -> "CSSRule":
79
- """
80
- >>> rule_dict = {'selector': 'survey_container', 'properties': {'width': '80%', 'margin': '0 auto'}}
81
- >>> CSSRule.from_dict(rule_dict)
82
- CSSRule(select = survey_container, properties = {'width': '80%', 'margin': '0 auto'})
83
- """
84
- return CSSRule(
85
- selector=rule_dict["selector"], properties=rule_dict["properties"]
86
- )
87
-
88
- @classmethod
89
- def example(cls):
90
- """
91
- >>> CSSRule.example()
92
- CSSRule(select = survey_container, properties = {'width': '80%', 'margin': '0 auto'})
93
- """
94
- return CSSRule(
95
- selector="survey_container",
96
- properties={
97
- "width": "80%",
98
- "margin": "0 auto",
99
- },
100
- )
101
-
102
- def __str__(self):
103
- return self.generate_rule()
104
-
105
-
106
- survey_container = CSSRule(
107
- selector="survey_container",
108
- properties={
109
- "width": "80%",
110
- "margin": "0 auto",
111
- "padding": "20px",
112
- "background-color": "#f9f9f9",
113
- "border": "1px solid #ddd",
114
- "border-radius": "8px",
115
- "box-shadow": "0 2px 4px rgba(0, 0, 0, 0.1)",
116
- },
117
- )
118
-
119
- survey_question = CSSRule(
120
- selector="survey_question",
121
- properties={
122
- "margin-bottom": "20px",
123
- "padding": "15px",
124
- "background-color": "#fff",
125
- "border": "1px solid #ddd",
126
- "border-radius": "8px",
127
- },
128
- )
129
-
130
- question_text = CSSRule(
131
- selector="question_text",
132
- properties={
133
- "font-size": "18px",
134
- "font-weight": "bold",
135
- "margin-bottom": "10px",
136
- "color": "#333",
137
- },
138
- )
139
-
140
- question_options = CSSRule(
141
- selector="question_options",
142
- properties={
143
- "list-style-type": "none",
144
- "padding": "0",
145
- "margin": "0",
146
- },
147
- )
148
-
149
- question_options_li = CSSRule(
150
- selector="question_options li",
151
- properties={
152
- "margin-bottom": "10px",
153
- "font-size": "16px",
154
- "color": "#555",
155
- },
156
- )
157
-
158
- question_options_radio = CSSRule(
159
- selector="question_options input[type='radio']",
160
- properties={
161
- "margin-right": "10px",
162
- },
163
- )
164
-
165
- question_options_checkbox = CSSRule(
166
- selector="question_options input[type='checkbox']",
167
- properties={
168
- "margin-right": "10px",
169
- },
170
- )
171
-
172
- input_text = CSSRule(
173
- selector="input[type='text']",
174
- properties={
175
- "width": "100%",
176
- "padding": "10px",
177
- "font-size": "16px",
178
- "border": "1px solid #ddd",
179
- "border-radius": "4px",
180
- "box-sizing": "border-box",
181
- },
182
- )
183
-
184
-
185
- class SurveyCSS:
186
- def __init__(self, rules: Optional[list["CSSRule"]] = None):
187
- self.rules = {rule.selector: rule for rule in rules} if rules else {}
188
-
189
- def update_style(self, selector, property_name, new_value):
190
- """
191
- >>> css = SurveyCSS()
192
- >>> css.update_style("survey_container", "width", "100%").rules["survey_container"].properties["width"]
193
- '100%'
194
- """
195
- if selector not in self.rules:
196
- self.rules[selector] = CSSRule(selector)
197
- self.rules[selector].add_property(property_name, new_value)
198
- return self
199
-
200
- def remove_style(self, selector, property_name):
201
- """
202
- >>> css = SurveyCSS().update_style("survey_container", "width", "100%")
203
- >>> css.remove_style("survey_container", "width").rules["survey_container"].properties
204
- {}
205
- """
206
- if selector in self.rules:
207
- self.rules[selector].remove_property(property_name)
208
- return self
209
-
210
- def generate_css(self):
211
- """
212
- >>> SurveyCSS(rules = []).update_style("survey_container", "width", "100%").generate_css()
213
- '.survey_container {\\n width: 100%;\\n}'
214
-
215
- """
216
- css_lines = []
217
- for rule in self.rules.values():
218
- css_lines.append(rule.generate_rule())
219
- return "\n".join(css_lines)
220
-
221
- @add_edsl_version
222
- def to_dict(self) -> dict:
223
- """
224
- >>> css = SurveyCSS(rules = []).update_style("survey_container", "width", "100%")
225
- >>> css.to_dict()
226
- {'rules': [{'selector': 'survey_container', 'properties': {'width': '100%'}, 'edsl_version': '...', 'edsl_class_name': 'CSSRule'}], 'edsl_version': '...', 'edsl_class_name': 'SurveyCSS'}
227
- """
228
- return {"rules": [rule.to_dict() for rule in self.rules.values()]}
229
-
230
- def __repr__(self) -> str:
231
- return f"SurveyCSS(rules = {[rule for rule in self.rules.values()]})"
232
-
233
- @classmethod
234
- @remove_edsl_version
235
- def from_dict(cls, css_dict) -> "SurveyCSS":
236
- """
237
- >>> s = SurveyCSS.example()
238
- >>> SurveyCSS.from_dict(s.to_dict())
239
- SurveyCSS(rules = [CSSRule(select = survey_container, properties = {'width': '80%', 'margin': '0 auto', 'padding': '20px', 'background-color': '#f9f9f9', 'border': '1px solid #ddd', 'border-radius': '8px', 'box-shadow': '0 2px 4px rgba(0, 0, 0, 0.1)'})])
240
- """
241
- return SurveyCSS(
242
- rules=[CSSRule.from_dict(rule_dict) for rule_dict in css_dict["rules"]]
243
- )
244
-
245
- @classmethod
246
- def default_style(cls):
247
- return SurveyCSS(rules=CSSRuleMeta.get_instances())
248
-
249
- @classmethod
250
- def example(cls):
251
- """
252
- >>> SurveyCSS.example()
253
- SurveyCSS(rules = [CSSRule(select = survey_container, properties = {'width': '80%', 'margin': '0 auto', 'padding': '20px', 'background-color': '#f9f9f9', 'border': '1px solid #ddd', 'border-radius': '8px', 'box-shadow': '0 2px 4px rgba(0, 0, 0, 0.1)'})])
254
- """
255
- return SurveyCSS(rules=[survey_container])
256
-
257
-
258
- if __name__ == "__main__":
259
- import doctest
260
-
261
- doctest.testmod(optionflags=doctest.ELLIPSIS)
1
+ from typing import Optional
2
+ from edsl.utilities.decorators import add_edsl_version, remove_edsl_version
3
+
4
+
5
+ class CSSRuleMeta(type):
6
+ _instances = []
7
+
8
+ def __init__(cls, name, bases, dct):
9
+ super().__init__(name, bases, dct)
10
+
11
+ def __call__(cls, *args, **kwargs):
12
+ instance = super().__call__(*args, **kwargs)
13
+ cls._instances.append(instance)
14
+ return instance
15
+
16
+ @classmethod
17
+ def get_instances(cls):
18
+ return cls._instances
19
+
20
+
21
+ class CSSRule(metaclass=CSSRuleMeta):
22
+ def __init__(self, selector: str, properties: Optional[dict[str, str]] = None):
23
+ """
24
+ A CSS rule object that represents a CSS rule with a selector and properties.
25
+
26
+ >>> rule = CSSRule("survey_container", {"width": "80%", "margin": "0 auto"})
27
+ >>> rule.generate_rule()
28
+ '.survey_container {\\n width: 80%;\\n margin: 0 auto;\\n}'
29
+ """
30
+ self.selector = selector
31
+ self.properties = properties if properties else {}
32
+
33
+ def add_property(self, property_name: str, value: str) -> "CSSRule":
34
+ """
35
+ >>> rule = CSSRule("survey_container")
36
+ >>> rule.add_property("width", "80%")
37
+ CSSRule(select = survey_container, properties = {'width': '80%'})
38
+ """
39
+ self.properties[property_name] = value
40
+ return self
41
+
42
+ def remove_property(self, property_name) -> "CSSRule":
43
+ """
44
+ >>> rule = CSSRule("survey_container", {"width": "80%", "margin": "0 auto"})
45
+ >>> rule.remove_property("margin")
46
+ CSSRule(select = survey_container, properties = {'width': '80%'})
47
+ """
48
+ if property_name in self.properties:
49
+ del self.properties[property_name]
50
+ return self
51
+
52
+ def generate_rule(self) -> str:
53
+ """
54
+ >>> rule = CSSRule("survey_container", {"width": "80%", "margin": "0 auto"})
55
+ >>> rule.generate_rule()
56
+ '.survey_container {\\n width: 80%;\\n margin: 0 auto;\\n}'
57
+ """
58
+ rule_lines = [f".{self.selector} {{"]
59
+ for prop, value in self.properties.items():
60
+ rule_lines.append(f" {prop}: {value};")
61
+ rule_lines.append("}")
62
+ return "\n".join(rule_lines)
63
+
64
+ def __repr__(self) -> str:
65
+ return f"CSSRule(select = {self.selector}, properties = {self.properties})"
66
+
67
+ @add_edsl_version
68
+ def to_dict(self) -> dict:
69
+ """
70
+ >>> rule = CSSRule("survey_container", {"width": "80%", "margin": "0 auto"})
71
+ >>> rule.to_dict()
72
+ {'selector': 'survey_container', 'properties': {'width': '80%', 'margin': '0 auto'}, 'edsl_version': '...', 'edsl_class_name': 'CSSRule'}
73
+ """
74
+ return {"selector": self.selector, "properties": self.properties}
75
+
76
+ @classmethod
77
+ @remove_edsl_version
78
+ def from_dict(cls, rule_dict) -> "CSSRule":
79
+ """
80
+ >>> rule_dict = {'selector': 'survey_container', 'properties': {'width': '80%', 'margin': '0 auto'}}
81
+ >>> CSSRule.from_dict(rule_dict)
82
+ CSSRule(select = survey_container, properties = {'width': '80%', 'margin': '0 auto'})
83
+ """
84
+ return CSSRule(
85
+ selector=rule_dict["selector"], properties=rule_dict["properties"]
86
+ )
87
+
88
+ @classmethod
89
+ def example(cls):
90
+ """
91
+ >>> CSSRule.example()
92
+ CSSRule(select = survey_container, properties = {'width': '80%', 'margin': '0 auto'})
93
+ """
94
+ return CSSRule(
95
+ selector="survey_container",
96
+ properties={
97
+ "width": "80%",
98
+ "margin": "0 auto",
99
+ },
100
+ )
101
+
102
+ def __str__(self):
103
+ return self.generate_rule()
104
+
105
+
106
+ survey_container = CSSRule(
107
+ selector="survey_container",
108
+ properties={
109
+ "width": "80%",
110
+ "margin": "0 auto",
111
+ "padding": "20px",
112
+ "background-color": "#f9f9f9",
113
+ "border": "1px solid #ddd",
114
+ "border-radius": "8px",
115
+ "box-shadow": "0 2px 4px rgba(0, 0, 0, 0.1)",
116
+ },
117
+ )
118
+
119
+ survey_question = CSSRule(
120
+ selector="survey_question",
121
+ properties={
122
+ "margin-bottom": "20px",
123
+ "padding": "15px",
124
+ "background-color": "#fff",
125
+ "border": "1px solid #ddd",
126
+ "border-radius": "8px",
127
+ },
128
+ )
129
+
130
+ question_text = CSSRule(
131
+ selector="question_text",
132
+ properties={
133
+ "font-size": "18px",
134
+ "font-weight": "bold",
135
+ "margin-bottom": "10px",
136
+ "color": "#333",
137
+ },
138
+ )
139
+
140
+ question_options = CSSRule(
141
+ selector="question_options",
142
+ properties={
143
+ "list-style-type": "none",
144
+ "padding": "0",
145
+ "margin": "0",
146
+ },
147
+ )
148
+
149
+ question_options_li = CSSRule(
150
+ selector="question_options li",
151
+ properties={
152
+ "margin-bottom": "10px",
153
+ "font-size": "16px",
154
+ "color": "#555",
155
+ },
156
+ )
157
+
158
+ question_options_radio = CSSRule(
159
+ selector="question_options input[type='radio']",
160
+ properties={
161
+ "margin-right": "10px",
162
+ },
163
+ )
164
+
165
+ question_options_checkbox = CSSRule(
166
+ selector="question_options input[type='checkbox']",
167
+ properties={
168
+ "margin-right": "10px",
169
+ },
170
+ )
171
+
172
+ input_text = CSSRule(
173
+ selector="input[type='text']",
174
+ properties={
175
+ "width": "100%",
176
+ "padding": "10px",
177
+ "font-size": "16px",
178
+ "border": "1px solid #ddd",
179
+ "border-radius": "4px",
180
+ "box-sizing": "border-box",
181
+ },
182
+ )
183
+
184
+
185
+ class SurveyCSS:
186
+ def __init__(self, rules: Optional[list["CSSRule"]] = None):
187
+ self.rules = {rule.selector: rule for rule in rules} if rules else {}
188
+
189
+ def update_style(self, selector, property_name, new_value):
190
+ """
191
+ >>> css = SurveyCSS()
192
+ >>> css.update_style("survey_container", "width", "100%").rules["survey_container"].properties["width"]
193
+ '100%'
194
+ """
195
+ if selector not in self.rules:
196
+ self.rules[selector] = CSSRule(selector)
197
+ self.rules[selector].add_property(property_name, new_value)
198
+ return self
199
+
200
+ def remove_style(self, selector, property_name):
201
+ """
202
+ >>> css = SurveyCSS().update_style("survey_container", "width", "100%")
203
+ >>> css.remove_style("survey_container", "width").rules["survey_container"].properties
204
+ {}
205
+ """
206
+ if selector in self.rules:
207
+ self.rules[selector].remove_property(property_name)
208
+ return self
209
+
210
+ def generate_css(self):
211
+ """
212
+ >>> SurveyCSS(rules = []).update_style("survey_container", "width", "100%").generate_css()
213
+ '.survey_container {\\n width: 100%;\\n}'
214
+
215
+ """
216
+ css_lines = []
217
+ for rule in self.rules.values():
218
+ css_lines.append(rule.generate_rule())
219
+ return "\n".join(css_lines)
220
+
221
+ @add_edsl_version
222
+ def to_dict(self) -> dict:
223
+ """
224
+ >>> css = SurveyCSS(rules = []).update_style("survey_container", "width", "100%")
225
+ >>> css.to_dict()
226
+ {'rules': [{'selector': 'survey_container', 'properties': {'width': '100%'}, 'edsl_version': '...', 'edsl_class_name': 'CSSRule'}], 'edsl_version': '...', 'edsl_class_name': 'SurveyCSS'}
227
+ """
228
+ return {"rules": [rule.to_dict() for rule in self.rules.values()]}
229
+
230
+ def __repr__(self) -> str:
231
+ return f"SurveyCSS(rules = {[rule for rule in self.rules.values()]})"
232
+
233
+ @classmethod
234
+ @remove_edsl_version
235
+ def from_dict(cls, css_dict) -> "SurveyCSS":
236
+ """
237
+ >>> s = SurveyCSS.example()
238
+ >>> SurveyCSS.from_dict(s.to_dict())
239
+ SurveyCSS(rules = [CSSRule(select = survey_container, properties = {'width': '80%', 'margin': '0 auto', 'padding': '20px', 'background-color': '#f9f9f9', 'border': '1px solid #ddd', 'border-radius': '8px', 'box-shadow': '0 2px 4px rgba(0, 0, 0, 0.1)'})])
240
+ """
241
+ return SurveyCSS(
242
+ rules=[CSSRule.from_dict(rule_dict) for rule_dict in css_dict["rules"]]
243
+ )
244
+
245
+ @classmethod
246
+ def default_style(cls):
247
+ return SurveyCSS(rules=CSSRuleMeta.get_instances())
248
+
249
+ @classmethod
250
+ def example(cls):
251
+ """
252
+ >>> SurveyCSS.example()
253
+ SurveyCSS(rules = [CSSRule(select = survey_container, properties = {'width': '80%', 'margin': '0 auto', 'padding': '20px', 'background-color': '#f9f9f9', 'border': '1px solid #ddd', 'border-radius': '8px', 'box-shadow': '0 2px 4px rgba(0, 0, 0, 0.1)'})])
254
+ """
255
+ return SurveyCSS(rules=[survey_container])
256
+
257
+
258
+ if __name__ == "__main__":
259
+ import doctest
260
+
261
+ doctest.testmod(optionflags=doctest.ELLIPSIS)