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
@@ -1,7 +1,7 @@
1
- {{question_text}}
2
- {% if min_value is not none %}
3
- Minimum answer value: {{min_value}}
4
- {% endif %}
5
- {% if max_value is not none %}
6
- Maximum answer value: {{max_value}}
1
+ {{question_text}}
2
+ {% if min_value is not none %}
3
+ Minimum answer value: {{min_value}}
4
+ {% endif %}
5
+ {% if max_value is not none %}
6
+ Maximum answer value: {{max_value}}
7
7
  {% endif %}
@@ -1,11 +1,11 @@
1
- {# Answering Instructions #}
2
- {% if use_code %}
3
- Please respond only with a comma-separated list of the code of the raked options, with square brackets. E.g., [0, 1, 3]
4
- {% else %}
5
- Please respond only with a comma-separated list of the ranked options, with square brackets. E.g., ['Good', 'Bad', 'Ugly']
6
- {% endif %}
7
- {% if include_comment %}
8
- After the answer, you can put a comment explaining your choice on the next line.
9
- {% endif %}
10
-
11
-
1
+ {# Answering Instructions #}
2
+ {% if use_code %}
3
+ Please respond only with a comma-separated list of the code of the raked options, with square brackets. E.g., [0, 1, 3]
4
+ {% else %}
5
+ Please respond only with a comma-separated list of the ranked options, with square brackets. E.g., ['Good', 'Bad', 'Ugly']
6
+ {% endif %}
7
+ {% if include_comment %}
8
+ After the answer, you can put a comment explaining your choice on the next line.
9
+ {% endif %}
10
+
11
+
@@ -1,15 +1,15 @@
1
- {{question_text}}
2
- {% if use_code %}
3
- The options are
4
- {% for option in question_options %}
5
- {{ loop.index0 }}: {{option}}
6
- {% endfor %}
7
- {% else %}
8
- The options are:
9
- {% for option in question_options %}
10
- {{option}}
11
- {% endfor %}
12
- {% endif %}
13
- {% if num_selections %}
14
- You can inlcude up to {{num_selections}} options in your answer.
15
- {% endif %}
1
+ {{question_text}}
2
+ {% if use_code %}
3
+ The options are
4
+ {% for option in question_options %}
5
+ {{ loop.index0 }}: {{option}}
6
+ {% endfor %}
7
+ {% else %}
8
+ The options are:
9
+ {% for option in question_options %}
10
+ {{option}}
11
+ {% endfor %}
12
+ {% endif %}
13
+ {% if num_selections %}
14
+ You can inlcude up to {{num_selections}} options in your answer.
15
+ {% endif %}
@@ -1,8 +1,8 @@
1
- {# Answering Instructions #}
2
- Please respond with valid JSON, formatted like so:
3
- {% if include_comment %}
4
- {"answer": [<put comma-separated list here>], "comment": "<put explanation here>"}
5
- {% else %}
6
- {"answer": [<put comma-separated list here>]}
7
- {% endif %}
8
-
1
+ {# Answering Instructions #}
2
+ Please respond with valid JSON, formatted like so:
3
+ {% if include_comment %}
4
+ {"answer": [<put comma-separated list here>], "comment": "<put explanation here>"}
5
+ {% else %}
6
+ {"answer": [<put comma-separated list here>]}
7
+ {% endif %}
8
+
@@ -1,22 +1,22 @@
1
- {{question_text}}
2
- {% if use_code %}
3
- {% for option in question_options %}
4
- {{ loop.index0 }}: {{option}}
5
- {% endfor %}
6
- {% else %}
7
- {% for option in question_options %}
8
- {{ option }}
9
- {% endfor %}
10
- {% endif %}
11
-
12
- {# Restrictions #}
13
- {% if min_selections != None and max_selections != None and min_selections == max_selections %}
14
- You must select exactly {{min_selections}} options.
15
- {% elif min_selections != None and max_selections != None %}
16
- Minimum number of options that must be selected: {{min_selections}}.
17
- Maximum number of options that must be selected: {{max_selections}}.
18
- {% elif min_selections != None %}
19
- Minimum number of options that must be selected: {{min_selections}}.
20
- {% elif max_selections != None %}
21
- Maximum number of options that must be selected: {{max_selections}}.
22
- {% endif %}
1
+ {{question_text}}
2
+ {% if use_code %}
3
+ {% for option in question_options %}
4
+ {{ loop.index0 }}: {{option}}
5
+ {% endfor %}
6
+ {% else %}
7
+ {% for option in question_options %}
8
+ {{ option }}
9
+ {% endfor %}
10
+ {% endif %}
11
+
12
+ {# Restrictions #}
13
+ {% if min_selections != None and max_selections != None and min_selections == max_selections %}
14
+ You must select exactly {{min_selections}} options.
15
+ {% elif min_selections != None and max_selections != None %}
16
+ Minimum number of options that must be selected: {{min_selections}}.
17
+ Maximum number of options that must be selected: {{max_selections}}.
18
+ {% elif min_selections != None %}
19
+ Minimum number of options that must be selected: {{min_selections}}.
20
+ {% elif max_selections != None %}
21
+ Maximum number of options that must be selected: {{max_selections}}.
22
+ {% endif %}
@@ -1,6 +1,6 @@
1
- {# Answering Instructions #}
2
- Please respond with just your answer.
3
-
4
- {% if include_comment %}
5
- After the answer, you can put a comment explaining your response.
6
- {% endif %}
1
+ {# Answering Instructions #}
2
+ Please respond with just your answer.
3
+
4
+ {% if include_comment %}
5
+ After the answer, you can put a comment explaining your response.
6
+ {% endif %}
@@ -1,12 +1,12 @@
1
- {# Question Presention #}
2
- {{question_text}}
3
- {% if use_code %}
4
- {%- for option in question_options %}
5
- {{ loop.index0 }}: {{option}}
6
- {% endfor %}
7
- {% else %}
8
- {% for option in question_options %}
9
- {{option}}
10
- {% endfor %}
11
- {% endif %}
1
+ {# Question Presention #}
2
+ {{question_text}}
3
+ {% if use_code %}
4
+ {%- for option in question_options %}
5
+ {{ loop.index0 }}: {{option}}
6
+ {% endfor %}
7
+ {% else %}
8
+ {% for option in question_options %}
9
+ {{option}}
10
+ {% endfor %}
11
+ {% endif %}
12
12
  Only 1 option may be selected.
@@ -1,108 +1,108 @@
1
- import re
2
- from typing import Dict, Set, Optional
3
-
4
-
5
- class CSSParameterizer:
6
- """A utility class to parameterize CSS with custom properties (variables)."""
7
-
8
- def __init__(self, css_content: str):
9
- """
10
- Initialize with CSS content to be parameterized.
11
-
12
- Args:
13
- css_content (str): The CSS content containing var() declarations
14
- """
15
- self.css_content = css_content
16
- self._extract_variables()
17
-
18
- def _extract_variables(self) -> None:
19
- """Extract all CSS custom properties (variables) from the CSS content."""
20
- # Find all var(...) declarations in the CSS
21
- var_pattern = r"var\((--[a-zA-Z0-9-]+)\)"
22
- self.variables = set(re.findall(var_pattern, self.css_content))
23
-
24
- def _validate_parameters(self, parameters: Dict[str, str]) -> Set[str]:
25
- """
26
- Validate the provided parameters against the CSS variables.
27
-
28
- Args:
29
- parameters (Dict[str, str]): Dictionary of variable names and their values
30
-
31
- Returns:
32
- Set[str]: Set of missing variables
33
- """
34
- # Convert parameter keys to CSS variable format if they don't already have --
35
- formatted_params = {
36
- f"--{k}" if not k.startswith("--") else k for k in parameters.keys()
37
- }
38
-
39
- # print("Variables from CSS:", self.variables)
40
- # print("Formatted parameters:", formatted_params)
41
-
42
- # Find missing and extra variables
43
- missing_vars = self.variables - formatted_params
44
- extra_vars = formatted_params - self.variables
45
-
46
- if extra_vars:
47
- print(f"Warning: Found unused parameters: {extra_vars}")
48
-
49
- return missing_vars
50
-
51
- def generate_root(self, **parameters: str) -> Optional[str]:
52
- """
53
- Generate a :root block with the provided parameters.
54
-
55
- Args:
56
- **parameters: Keyword arguments where keys are variable names and values are their values
57
-
58
- Returns:
59
- str: Generated :root block with variables, or None if validation fails
60
-
61
- Example:
62
- >>> css = "body { height: var(--bodyHeight); }"
63
- >>> parameterizer = CSSParameterizer(css)
64
- >>> parameterizer.apply_parameters({'bodyHeight':"100vh"})
65
- ':root {\\n --bodyHeight: 100vh;\\n}\\n\\nbody { height: var(--bodyHeight); }'
66
- """
67
- missing_vars = self._validate_parameters(parameters)
68
-
69
- if missing_vars:
70
- print(f"Error: Missing required variables: {missing_vars}")
71
- return None
72
-
73
- # Format parameters with -- prefix if not present
74
- formatted_params = {
75
- f"--{k}" if not k.startswith("--") else k: v for k, v in parameters.items()
76
- }
77
-
78
- # Generate the :root block
79
- root_block = [":root {"]
80
- for var_name, value in sorted(formatted_params.items()):
81
- if var_name in self.variables:
82
- root_block.append(f" {var_name}: {value};")
83
- root_block.append("}")
84
-
85
- return "\n".join(root_block)
86
-
87
- def apply_parameters(self, parameters: dict) -> Optional[str]:
88
- """
89
- Generate the complete CSS with the :root block and original CSS content.
90
-
91
- Args:
92
- **parameters: Keyword arguments where keys are variable names and values are their values
93
-
94
- Returns:
95
- str: Complete CSS with :root block and original content, or None if validation fails
96
- """
97
- root_block = self.generate_root(**parameters)
98
- if root_block is None:
99
- return None
100
-
101
- return f"{root_block}\n\n{self.css_content}"
102
-
103
-
104
- # Example usage
105
- if __name__ == "__main__":
106
- import doctest
107
-
108
- doctest.testmod()
1
+ import re
2
+ from typing import Dict, Set, Optional
3
+
4
+
5
+ class CSSParameterizer:
6
+ """A utility class to parameterize CSS with custom properties (variables)."""
7
+
8
+ def __init__(self, css_content: str):
9
+ """
10
+ Initialize with CSS content to be parameterized.
11
+
12
+ Args:
13
+ css_content (str): The CSS content containing var() declarations
14
+ """
15
+ self.css_content = css_content
16
+ self._extract_variables()
17
+
18
+ def _extract_variables(self) -> None:
19
+ """Extract all CSS custom properties (variables) from the CSS content."""
20
+ # Find all var(...) declarations in the CSS
21
+ var_pattern = r"var\((--[a-zA-Z0-9-]+)\)"
22
+ self.variables = set(re.findall(var_pattern, self.css_content))
23
+
24
+ def _validate_parameters(self, parameters: Dict[str, str]) -> Set[str]:
25
+ """
26
+ Validate the provided parameters against the CSS variables.
27
+
28
+ Args:
29
+ parameters (Dict[str, str]): Dictionary of variable names and their values
30
+
31
+ Returns:
32
+ Set[str]: Set of missing variables
33
+ """
34
+ # Convert parameter keys to CSS variable format if they don't already have --
35
+ formatted_params = {
36
+ f"--{k}" if not k.startswith("--") else k for k in parameters.keys()
37
+ }
38
+
39
+ # print("Variables from CSS:", self.variables)
40
+ # print("Formatted parameters:", formatted_params)
41
+
42
+ # Find missing and extra variables
43
+ missing_vars = self.variables - formatted_params
44
+ extra_vars = formatted_params - self.variables
45
+
46
+ if extra_vars:
47
+ print(f"Warning: Found unused parameters: {extra_vars}")
48
+
49
+ return missing_vars
50
+
51
+ def generate_root(self, **parameters: str) -> Optional[str]:
52
+ """
53
+ Generate a :root block with the provided parameters.
54
+
55
+ Args:
56
+ **parameters: Keyword arguments where keys are variable names and values are their values
57
+
58
+ Returns:
59
+ str: Generated :root block with variables, or None if validation fails
60
+
61
+ Example:
62
+ >>> css = "body { height: var(--bodyHeight); }"
63
+ >>> parameterizer = CSSParameterizer(css)
64
+ >>> parameterizer.apply_parameters({'bodyHeight':"100vh"})
65
+ ':root {\\n --bodyHeight: 100vh;\\n}\\n\\nbody { height: var(--bodyHeight); }'
66
+ """
67
+ missing_vars = self._validate_parameters(parameters)
68
+
69
+ if missing_vars:
70
+ print(f"Error: Missing required variables: {missing_vars}")
71
+ return None
72
+
73
+ # Format parameters with -- prefix if not present
74
+ formatted_params = {
75
+ f"--{k}" if not k.startswith("--") else k: v for k, v in parameters.items()
76
+ }
77
+
78
+ # Generate the :root block
79
+ root_block = [":root {"]
80
+ for var_name, value in sorted(formatted_params.items()):
81
+ if var_name in self.variables:
82
+ root_block.append(f" {var_name}: {value};")
83
+ root_block.append("}")
84
+
85
+ return "\n".join(root_block)
86
+
87
+ def apply_parameters(self, parameters: dict) -> Optional[str]:
88
+ """
89
+ Generate the complete CSS with the :root block and original CSS content.
90
+
91
+ Args:
92
+ **parameters: Keyword arguments where keys are variable names and values are their values
93
+
94
+ Returns:
95
+ str: Complete CSS with :root block and original content, or None if validation fails
96
+ """
97
+ root_block = self.generate_root(**parameters)
98
+ if root_block is None:
99
+ return None
100
+
101
+ return f"{root_block}\n\n{self.css_content}"
102
+
103
+
104
+ # Example usage
105
+ if __name__ == "__main__":
106
+ import doctest
107
+
108
+ doctest.testmod()