lionagi 0.4.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (584) hide show
  1. lionagi/__init__.py +14 -46
  2. lionagi/core/__init__.py +3 -1
  3. lionagi/core/_class_registry.py +69 -0
  4. lionagi/core/action/__init__.py +3 -13
  5. lionagi/core/action/action_manager.py +287 -0
  6. lionagi/core/action/base.py +109 -0
  7. lionagi/core/action/function_calling.py +127 -92
  8. lionagi/core/action/tool.py +172 -70
  9. lionagi/core/action/types.py +16 -0
  10. lionagi/core/communication/__init__.py +3 -0
  11. lionagi/core/communication/action_request.py +163 -0
  12. lionagi/core/communication/action_response.py +149 -0
  13. lionagi/core/communication/assistant_response.py +161 -0
  14. lionagi/core/communication/base_mail.py +49 -0
  15. lionagi/core/communication/instruction.py +376 -0
  16. lionagi/core/communication/message.py +286 -0
  17. lionagi/core/communication/message_manager.py +530 -0
  18. lionagi/core/communication/system.py +116 -0
  19. lionagi/core/communication/templates/README.md +28 -0
  20. lionagi/core/communication/templates/action_request.jinja2 +5 -0
  21. lionagi/core/communication/templates/action_response.jinja2 +9 -0
  22. lionagi/core/communication/templates/assistant_response.jinja2 +2 -0
  23. lionagi/core/communication/templates/instruction_message.jinja2 +61 -0
  24. lionagi/core/communication/templates/system_message.jinja2 +11 -0
  25. lionagi/core/communication/templates/tool_schemas.jinja2 +7 -0
  26. lionagi/core/communication/types.py +27 -0
  27. lionagi/core/communication/utils.py +254 -0
  28. lionagi/core/forms/__init__.py +3 -0
  29. lionagi/core/forms/base.py +232 -0
  30. lionagi/core/forms/form.py +791 -0
  31. lionagi/core/forms/report.py +321 -0
  32. lionagi/core/forms/types.py +13 -0
  33. lionagi/core/forms/utils.py +26 -0
  34. lionagi/core/generic/__init__.py +3 -6
  35. lionagi/core/generic/component.py +422 -0
  36. lionagi/core/generic/edge.py +143 -101
  37. lionagi/core/generic/element.py +195 -0
  38. lionagi/core/generic/graph.py +297 -180
  39. lionagi/core/generic/log.py +151 -0
  40. lionagi/core/generic/log_manager.py +320 -0
  41. lionagi/core/generic/node.py +7 -229
  42. lionagi/core/generic/pile.py +1017 -0
  43. lionagi/core/generic/progression.py +388 -0
  44. lionagi/core/generic/types.py +23 -0
  45. lionagi/core/generic/utils.py +50 -0
  46. lionagi/core/models/__init__.py +5 -0
  47. lionagi/core/models/base.py +85 -0
  48. lionagi/core/models/field_model.py +122 -0
  49. lionagi/core/models/new_model_params.py +195 -0
  50. lionagi/core/models/note.py +351 -0
  51. lionagi/core/models/operable_model.py +392 -0
  52. lionagi/core/models/schema_model.py +50 -0
  53. lionagi/core/models/types.py +10 -0
  54. lionagi/core/session/__init__.py +3 -0
  55. lionagi/core/session/branch.py +115 -415
  56. lionagi/core/session/branch_mixins.py +507 -0
  57. lionagi/core/session/session.py +122 -257
  58. lionagi/core/session/types.py +8 -0
  59. lionagi/core/typing/__init__.py +9 -0
  60. lionagi/core/typing/concepts.py +132 -0
  61. lionagi/core/typing/config.py +15 -0
  62. lionagi/core/typing/id.py +221 -0
  63. lionagi/core/typing/pydantic_.py +33 -0
  64. lionagi/core/typing/typing_.py +54 -0
  65. lionagi/integrations/__init__.py +0 -1
  66. lionagi/integrations/anthropic_/AnthropicModel.py +268 -0
  67. lionagi/integrations/anthropic_/AnthropicService.py +113 -0
  68. lionagi/integrations/anthropic_/__init__.py +3 -0
  69. lionagi/integrations/anthropic_/anthropic_max_output_token_data.yaml +7 -0
  70. lionagi/integrations/anthropic_/anthropic_price_data.yaml +14 -0
  71. lionagi/integrations/anthropic_/api_endpoints/__init__.py +3 -0
  72. lionagi/integrations/anthropic_/api_endpoints/api_request.py +277 -0
  73. lionagi/integrations/anthropic_/api_endpoints/data_models.py +40 -0
  74. lionagi/integrations/anthropic_/api_endpoints/match_response.py +119 -0
  75. lionagi/integrations/anthropic_/api_endpoints/messages/__init__.py +3 -0
  76. lionagi/integrations/anthropic_/api_endpoints/messages/request/__init__.py +3 -0
  77. lionagi/integrations/anthropic_/api_endpoints/messages/request/message_models.py +14 -0
  78. lionagi/integrations/anthropic_/api_endpoints/messages/request/request_body.py +74 -0
  79. lionagi/integrations/anthropic_/api_endpoints/messages/response/content_models.py +32 -0
  80. lionagi/integrations/anthropic_/api_endpoints/messages/response/response_body.py +101 -0
  81. lionagi/integrations/anthropic_/api_endpoints/messages/response/usage_models.py +25 -0
  82. lionagi/integrations/anthropic_/version.py +5 -0
  83. lionagi/integrations/groq_/GroqModel.py +318 -0
  84. lionagi/integrations/groq_/GroqService.py +147 -0
  85. lionagi/integrations/groq_/__init__.py +3 -0
  86. lionagi/integrations/groq_/api_endpoints/data_models.py +187 -0
  87. lionagi/integrations/groq_/api_endpoints/groq_request.py +288 -0
  88. lionagi/integrations/groq_/api_endpoints/match_response.py +106 -0
  89. lionagi/integrations/groq_/api_endpoints/response_utils.py +105 -0
  90. lionagi/integrations/groq_/groq_max_output_token_data.yaml +21 -0
  91. lionagi/integrations/groq_/groq_price_data.yaml +58 -0
  92. lionagi/integrations/groq_/groq_rate_limits.yaml +105 -0
  93. lionagi/integrations/groq_/version.py +5 -0
  94. lionagi/integrations/litellm_/__init__.py +3 -0
  95. lionagi/integrations/litellm_/imodel.py +69 -0
  96. lionagi/integrations/ollama_/OllamaModel.py +244 -0
  97. lionagi/integrations/ollama_/OllamaService.py +138 -0
  98. lionagi/integrations/ollama_/__init__.py +3 -0
  99. lionagi/integrations/ollama_/api_endpoints/__init__.py +3 -0
  100. lionagi/integrations/ollama_/api_endpoints/api_request.py +179 -0
  101. lionagi/integrations/ollama_/api_endpoints/chat_completion/__init__.py +3 -0
  102. lionagi/integrations/ollama_/api_endpoints/chat_completion/message_models.py +31 -0
  103. lionagi/integrations/ollama_/api_endpoints/chat_completion/request_body.py +46 -0
  104. lionagi/integrations/ollama_/api_endpoints/chat_completion/response_body.py +67 -0
  105. lionagi/integrations/ollama_/api_endpoints/chat_completion/tool_models.py +49 -0
  106. lionagi/integrations/ollama_/api_endpoints/completion/request_body.py +72 -0
  107. lionagi/integrations/ollama_/api_endpoints/completion/response_body.py +59 -0
  108. lionagi/integrations/ollama_/api_endpoints/data_models.py +15 -0
  109. lionagi/integrations/ollama_/api_endpoints/embedding/request_body.py +33 -0
  110. lionagi/integrations/ollama_/api_endpoints/embedding/response_body.py +29 -0
  111. lionagi/integrations/ollama_/api_endpoints/match_data_model.py +62 -0
  112. lionagi/integrations/ollama_/api_endpoints/match_response.py +190 -0
  113. lionagi/integrations/ollama_/api_endpoints/model/__init__.py +3 -0
  114. lionagi/integrations/ollama_/api_endpoints/model/copy_model.py +13 -0
  115. lionagi/integrations/ollama_/api_endpoints/model/create_model.py +28 -0
  116. lionagi/integrations/ollama_/api_endpoints/model/delete_model.py +11 -0
  117. lionagi/integrations/ollama_/api_endpoints/model/list_model.py +60 -0
  118. lionagi/integrations/ollama_/api_endpoints/model/pull_model.py +34 -0
  119. lionagi/integrations/ollama_/api_endpoints/model/push_model.py +35 -0
  120. lionagi/integrations/ollama_/api_endpoints/model/show_model.py +36 -0
  121. lionagi/integrations/ollama_/api_endpoints/option_models.py +68 -0
  122. lionagi/integrations/openai_/OpenAIModel.py +414 -0
  123. lionagi/integrations/openai_/OpenAIService.py +426 -0
  124. lionagi/integrations/openai_/api_endpoints/__init__.py +3 -0
  125. lionagi/integrations/openai_/api_endpoints/api_request.py +277 -0
  126. lionagi/integrations/openai_/api_endpoints/audio/__init__.py +9 -0
  127. lionagi/integrations/openai_/api_endpoints/audio/speech_models.py +34 -0
  128. lionagi/integrations/openai_/api_endpoints/audio/transcription_models.py +136 -0
  129. lionagi/integrations/openai_/api_endpoints/audio/translation_models.py +41 -0
  130. lionagi/integrations/openai_/api_endpoints/audio/types.py +41 -0
  131. lionagi/integrations/openai_/api_endpoints/batch/__init__.py +17 -0
  132. lionagi/integrations/openai_/api_endpoints/batch/batch_models.py +146 -0
  133. lionagi/integrations/openai_/api_endpoints/batch/cancel_batch.py +7 -0
  134. lionagi/integrations/openai_/api_endpoints/batch/create_batch.py +26 -0
  135. lionagi/integrations/openai_/api_endpoints/batch/list_batch.py +37 -0
  136. lionagi/integrations/openai_/api_endpoints/batch/request_object_models.py +65 -0
  137. lionagi/integrations/openai_/api_endpoints/batch/retrieve_batch.py +7 -0
  138. lionagi/integrations/openai_/api_endpoints/batch/types.py +4 -0
  139. lionagi/integrations/openai_/api_endpoints/chat_completions/__init__.py +1 -0
  140. lionagi/integrations/openai_/api_endpoints/chat_completions/request/__init__.py +39 -0
  141. lionagi/integrations/openai_/api_endpoints/chat_completions/request/message_models.py +121 -0
  142. lionagi/integrations/openai_/api_endpoints/chat_completions/request/request_body.py +221 -0
  143. lionagi/integrations/openai_/api_endpoints/chat_completions/request/response_format.py +71 -0
  144. lionagi/integrations/openai_/api_endpoints/chat_completions/request/stream_options.py +14 -0
  145. lionagi/integrations/openai_/api_endpoints/chat_completions/request/tool_choice_models.py +17 -0
  146. lionagi/integrations/openai_/api_endpoints/chat_completions/request/tool_models.py +54 -0
  147. lionagi/integrations/openai_/api_endpoints/chat_completions/request/types.py +18 -0
  148. lionagi/integrations/openai_/api_endpoints/chat_completions/response/choice_models.py +62 -0
  149. lionagi/integrations/openai_/api_endpoints/chat_completions/response/function_models.py +16 -0
  150. lionagi/integrations/openai_/api_endpoints/chat_completions/response/log_prob_models.py +47 -0
  151. lionagi/integrations/openai_/api_endpoints/chat_completions/response/message_models.py +25 -0
  152. lionagi/integrations/openai_/api_endpoints/chat_completions/response/response_body.py +99 -0
  153. lionagi/integrations/openai_/api_endpoints/chat_completions/response/types.py +8 -0
  154. lionagi/integrations/openai_/api_endpoints/chat_completions/response/usage_models.py +24 -0
  155. lionagi/integrations/openai_/api_endpoints/chat_completions/util.py +46 -0
  156. lionagi/integrations/openai_/api_endpoints/data_models.py +23 -0
  157. lionagi/integrations/openai_/api_endpoints/embeddings/__init__.py +3 -0
  158. lionagi/integrations/openai_/api_endpoints/embeddings/request_body.py +79 -0
  159. lionagi/integrations/openai_/api_endpoints/embeddings/response_body.py +67 -0
  160. lionagi/integrations/openai_/api_endpoints/files/__init__.py +11 -0
  161. lionagi/integrations/openai_/api_endpoints/files/delete_file.py +20 -0
  162. lionagi/integrations/openai_/api_endpoints/files/file_models.py +56 -0
  163. lionagi/integrations/openai_/api_endpoints/files/list_files.py +27 -0
  164. lionagi/integrations/openai_/api_endpoints/files/retrieve_file.py +9 -0
  165. lionagi/integrations/openai_/api_endpoints/files/upload_file.py +38 -0
  166. lionagi/integrations/openai_/api_endpoints/fine_tuning/__init__.py +37 -0
  167. lionagi/integrations/openai_/api_endpoints/fine_tuning/cancel_jobs.py +9 -0
  168. lionagi/integrations/openai_/api_endpoints/fine_tuning/create_jobs.py +133 -0
  169. lionagi/integrations/openai_/api_endpoints/fine_tuning/fine_tuning_job_checkpoint_models.py +58 -0
  170. lionagi/integrations/openai_/api_endpoints/fine_tuning/fine_tuning_job_event_models.py +31 -0
  171. lionagi/integrations/openai_/api_endpoints/fine_tuning/fine_tuning_job_models.py +140 -0
  172. lionagi/integrations/openai_/api_endpoints/fine_tuning/list_fine_tuning_checkpoints.py +51 -0
  173. lionagi/integrations/openai_/api_endpoints/fine_tuning/list_fine_tuning_events.py +42 -0
  174. lionagi/integrations/openai_/api_endpoints/fine_tuning/list_fine_tuning_jobs.py +31 -0
  175. lionagi/integrations/openai_/api_endpoints/fine_tuning/retrieve_jobs.py +9 -0
  176. lionagi/integrations/openai_/api_endpoints/fine_tuning/training_format.py +30 -0
  177. lionagi/integrations/openai_/api_endpoints/images/__init__.py +9 -0
  178. lionagi/integrations/openai_/api_endpoints/images/image_edit_models.py +69 -0
  179. lionagi/integrations/openai_/api_endpoints/images/image_models.py +56 -0
  180. lionagi/integrations/openai_/api_endpoints/images/image_variation_models.py +56 -0
  181. lionagi/integrations/openai_/api_endpoints/images/response_body.py +30 -0
  182. lionagi/integrations/openai_/api_endpoints/match_data_model.py +197 -0
  183. lionagi/integrations/openai_/api_endpoints/match_response.py +336 -0
  184. lionagi/integrations/openai_/api_endpoints/models/__init__.py +7 -0
  185. lionagi/integrations/openai_/api_endpoints/models/delete_fine_tuned_model.py +17 -0
  186. lionagi/integrations/openai_/api_endpoints/models/models_models.py +31 -0
  187. lionagi/integrations/openai_/api_endpoints/models/retrieve_model.py +9 -0
  188. lionagi/integrations/openai_/api_endpoints/moderations/__init__.py +3 -0
  189. lionagi/integrations/openai_/api_endpoints/moderations/request_body.py +20 -0
  190. lionagi/integrations/openai_/api_endpoints/moderations/response_body.py +139 -0
  191. lionagi/integrations/openai_/api_endpoints/uploads/__init__.py +19 -0
  192. lionagi/integrations/openai_/api_endpoints/uploads/add_upload_part.py +11 -0
  193. lionagi/integrations/openai_/api_endpoints/uploads/cancel_upload.py +7 -0
  194. lionagi/integrations/openai_/api_endpoints/uploads/complete_upload.py +18 -0
  195. lionagi/integrations/openai_/api_endpoints/uploads/create_upload.py +17 -0
  196. lionagi/integrations/openai_/api_endpoints/uploads/uploads_models.py +52 -0
  197. lionagi/integrations/openai_/image_token_calculator/image_token_calculator.py +92 -0
  198. lionagi/integrations/openai_/image_token_calculator/openai_image_token_data.yaml +15 -0
  199. lionagi/integrations/openai_/openai_max_output_token_data.yaml +12 -0
  200. lionagi/integrations/openai_/openai_price_data.yaml +26 -0
  201. lionagi/integrations/openai_/version.py +1 -0
  202. lionagi/integrations/pandas_/__init__.py +24 -0
  203. lionagi/integrations/pandas_/extend_df.py +61 -0
  204. lionagi/integrations/pandas_/read.py +103 -0
  205. lionagi/integrations/pandas_/remove_rows.py +61 -0
  206. lionagi/integrations/pandas_/replace_keywords.py +65 -0
  207. lionagi/integrations/pandas_/save.py +131 -0
  208. lionagi/integrations/pandas_/search_keywords.py +69 -0
  209. lionagi/integrations/pandas_/to_df.py +196 -0
  210. lionagi/integrations/pandas_/update_cells.py +54 -0
  211. lionagi/integrations/perplexity_/PerplexityModel.py +269 -0
  212. lionagi/integrations/perplexity_/PerplexityService.py +109 -0
  213. lionagi/integrations/perplexity_/__init__.py +3 -0
  214. lionagi/integrations/perplexity_/api_endpoints/api_request.py +171 -0
  215. lionagi/integrations/perplexity_/api_endpoints/chat_completions/request/request_body.py +121 -0
  216. lionagi/integrations/perplexity_/api_endpoints/chat_completions/response/response_body.py +146 -0
  217. lionagi/integrations/perplexity_/api_endpoints/data_models.py +63 -0
  218. lionagi/integrations/perplexity_/api_endpoints/match_response.py +26 -0
  219. lionagi/integrations/perplexity_/perplexity_max_output_token_data.yaml +3 -0
  220. lionagi/integrations/perplexity_/perplexity_price_data.yaml +10 -0
  221. lionagi/integrations/perplexity_/version.py +1 -0
  222. lionagi/integrations/pydantic_/__init__.py +8 -0
  223. lionagi/integrations/pydantic_/break_down_annotation.py +81 -0
  224. lionagi/integrations/pydantic_/new_model.py +208 -0
  225. lionagi/integrations/services.py +17 -0
  226. lionagi/libs/__init__.py +0 -55
  227. lionagi/libs/compress/models.py +62 -0
  228. lionagi/libs/compress/utils.py +81 -0
  229. lionagi/libs/constants.py +98 -0
  230. lionagi/libs/file/chunk.py +265 -0
  231. lionagi/libs/file/file_ops.py +114 -0
  232. lionagi/libs/file/params.py +212 -0
  233. lionagi/libs/file/path.py +301 -0
  234. lionagi/libs/file/process.py +139 -0
  235. lionagi/libs/file/save.py +90 -0
  236. lionagi/libs/file/types.py +22 -0
  237. lionagi/libs/func/async_calls/__init__.py +21 -0
  238. lionagi/libs/func/async_calls/alcall.py +157 -0
  239. lionagi/libs/func/async_calls/bcall.py +82 -0
  240. lionagi/libs/func/async_calls/mcall.py +134 -0
  241. lionagi/libs/func/async_calls/pcall.py +149 -0
  242. lionagi/libs/func/async_calls/rcall.py +185 -0
  243. lionagi/libs/func/async_calls/tcall.py +114 -0
  244. lionagi/libs/func/async_calls/ucall.py +85 -0
  245. lionagi/libs/func/decorators.py +277 -0
  246. lionagi/libs/func/lcall.py +57 -0
  247. lionagi/libs/func/params.py +64 -0
  248. lionagi/libs/func/throttle.py +119 -0
  249. lionagi/libs/func/types.py +39 -0
  250. lionagi/libs/func/utils.py +96 -0
  251. lionagi/libs/package/imports.py +162 -0
  252. lionagi/libs/package/management.py +58 -0
  253. lionagi/libs/package/params.py +26 -0
  254. lionagi/libs/package/system.py +18 -0
  255. lionagi/libs/package/types.py +26 -0
  256. lionagi/libs/parse/__init__.py +1 -0
  257. lionagi/libs/parse/flatten/__init__.py +9 -0
  258. lionagi/libs/parse/flatten/flatten.py +168 -0
  259. lionagi/libs/parse/flatten/params.py +52 -0
  260. lionagi/libs/parse/flatten/unflatten.py +79 -0
  261. lionagi/libs/parse/json/__init__.py +27 -0
  262. lionagi/libs/parse/json/as_readable.py +104 -0
  263. lionagi/libs/parse/json/extract.py +102 -0
  264. lionagi/libs/parse/json/parse.py +179 -0
  265. lionagi/libs/parse/json/schema.py +227 -0
  266. lionagi/libs/parse/json/to_json.py +71 -0
  267. lionagi/libs/parse/nested/__init__.py +33 -0
  268. lionagi/libs/parse/nested/nfilter.py +55 -0
  269. lionagi/libs/parse/nested/nget.py +40 -0
  270. lionagi/libs/parse/nested/ninsert.py +103 -0
  271. lionagi/libs/parse/nested/nmerge.py +155 -0
  272. lionagi/libs/parse/nested/npop.py +66 -0
  273. lionagi/libs/parse/nested/nset.py +89 -0
  274. lionagi/libs/parse/nested/to_flat_list.py +64 -0
  275. lionagi/libs/parse/nested/utils.py +185 -0
  276. lionagi/libs/parse/string_parse/__init__.py +11 -0
  277. lionagi/libs/parse/string_parse/code_block.py +73 -0
  278. lionagi/libs/parse/string_parse/docstring.py +179 -0
  279. lionagi/libs/parse/string_parse/function_.py +92 -0
  280. lionagi/libs/parse/type_convert/__init__.py +19 -0
  281. lionagi/libs/parse/type_convert/params.py +145 -0
  282. lionagi/libs/parse/type_convert/to_dict.py +333 -0
  283. lionagi/libs/parse/type_convert/to_list.py +186 -0
  284. lionagi/libs/parse/type_convert/to_num.py +358 -0
  285. lionagi/libs/parse/type_convert/to_str.py +195 -0
  286. lionagi/libs/parse/types.py +9 -0
  287. lionagi/libs/parse/validate/__init__.py +14 -0
  288. lionagi/libs/parse/validate/boolean.py +96 -0
  289. lionagi/libs/parse/validate/keys.py +150 -0
  290. lionagi/libs/parse/validate/mapping.py +109 -0
  291. lionagi/libs/parse/validate/params.py +62 -0
  292. lionagi/libs/parse/xml/__init__.py +10 -0
  293. lionagi/libs/parse/xml/convert.py +56 -0
  294. lionagi/libs/parse/xml/parser.py +93 -0
  295. lionagi/libs/string_similarity/__init__.py +32 -0
  296. lionagi/libs/string_similarity/algorithms.py +219 -0
  297. lionagi/libs/string_similarity/matcher.py +102 -0
  298. lionagi/libs/string_similarity/utils.py +15 -0
  299. lionagi/libs/utils.py +255 -0
  300. lionagi/operations/__init__.py +3 -6
  301. lionagi/operations/brainstorm/__init__.py +3 -0
  302. lionagi/operations/brainstorm/brainstorm.py +204 -0
  303. lionagi/operations/brainstorm/prompt.py +1 -0
  304. lionagi/operations/plan/__init__.py +3 -0
  305. lionagi/operations/plan/plan.py +172 -0
  306. lionagi/operations/plan/prompt.py +21 -0
  307. lionagi/operations/select/__init__.py +3 -0
  308. lionagi/operations/select/prompt.py +1 -0
  309. lionagi/operations/select/select.py +100 -0
  310. lionagi/operations/select/utils.py +107 -0
  311. lionagi/operations/utils.py +35 -0
  312. lionagi/protocols/adapters/adapter.py +79 -0
  313. lionagi/protocols/adapters/json_adapter.py +43 -0
  314. lionagi/protocols/adapters/pandas_adapter.py +96 -0
  315. lionagi/protocols/configs/__init__.py +15 -0
  316. lionagi/protocols/configs/branch_config.py +86 -0
  317. lionagi/protocols/configs/id_config.py +15 -0
  318. lionagi/protocols/configs/imodel_config.py +73 -0
  319. lionagi/protocols/configs/log_config.py +93 -0
  320. lionagi/protocols/configs/retry_config.py +29 -0
  321. lionagi/protocols/operatives/__init__.py +15 -0
  322. lionagi/protocols/operatives/action.py +181 -0
  323. lionagi/protocols/operatives/instruct.py +196 -0
  324. lionagi/protocols/operatives/operative.py +182 -0
  325. lionagi/protocols/operatives/prompts.py +232 -0
  326. lionagi/protocols/operatives/reason.py +56 -0
  327. lionagi/protocols/operatives/step.py +217 -0
  328. lionagi/protocols/registries/_component_registry.py +19 -0
  329. lionagi/protocols/registries/_pile_registry.py +26 -0
  330. lionagi/service/__init__.py +13 -0
  331. lionagi/service/complete_request_info.py +11 -0
  332. lionagi/service/imodel.py +110 -0
  333. lionagi/service/rate_limiter.py +108 -0
  334. lionagi/service/service.py +37 -0
  335. lionagi/service/service_match_util.py +131 -0
  336. lionagi/service/service_util.py +72 -0
  337. lionagi/service/token_calculator.py +51 -0
  338. lionagi/settings.py +136 -0
  339. lionagi/strategies/base.py +53 -0
  340. lionagi/strategies/concurrent.py +71 -0
  341. lionagi/strategies/concurrent_chunk.py +43 -0
  342. lionagi/strategies/concurrent_sequential_chunk.py +104 -0
  343. lionagi/strategies/params.py +128 -0
  344. lionagi/strategies/sequential.py +23 -0
  345. lionagi/strategies/sequential_chunk.py +89 -0
  346. lionagi/strategies/sequential_concurrent_chunk.py +100 -0
  347. lionagi/strategies/types.py +21 -0
  348. lionagi/strategies/utils.py +49 -0
  349. lionagi/version.py +1 -1
  350. lionagi-0.5.0.dist-info/METADATA +348 -0
  351. lionagi-0.5.0.dist-info/RECORD +373 -0
  352. {lionagi-0.4.0.dist-info → lionagi-0.5.0.dist-info}/WHEEL +1 -1
  353. lionagi/core/_setting/_setting.py +0 -59
  354. lionagi/core/action/README.md +0 -20
  355. lionagi/core/action/manual.py +0 -1
  356. lionagi/core/action/node.py +0 -94
  357. lionagi/core/action/tool_manager.py +0 -342
  358. lionagi/core/agent/README.md +0 -1
  359. lionagi/core/agent/base_agent.py +0 -82
  360. lionagi/core/agent/eval/README.md +0 -1
  361. lionagi/core/agent/eval/evaluator.py +0 -1
  362. lionagi/core/agent/eval/vote.py +0 -40
  363. lionagi/core/agent/learn/learner.py +0 -59
  364. lionagi/core/agent/plan/unit_template.py +0 -1
  365. lionagi/core/collections/README.md +0 -23
  366. lionagi/core/collections/__init__.py +0 -16
  367. lionagi/core/collections/_logger.py +0 -312
  368. lionagi/core/collections/abc/README.md +0 -63
  369. lionagi/core/collections/abc/__init__.py +0 -53
  370. lionagi/core/collections/abc/component.py +0 -620
  371. lionagi/core/collections/abc/concepts.py +0 -277
  372. lionagi/core/collections/abc/exceptions.py +0 -136
  373. lionagi/core/collections/abc/util.py +0 -45
  374. lionagi/core/collections/exchange.py +0 -146
  375. lionagi/core/collections/flow.py +0 -416
  376. lionagi/core/collections/model.py +0 -465
  377. lionagi/core/collections/pile.py +0 -1232
  378. lionagi/core/collections/progression.py +0 -221
  379. lionagi/core/collections/util.py +0 -73
  380. lionagi/core/director/README.md +0 -1
  381. lionagi/core/director/direct.py +0 -298
  382. lionagi/core/director/director.py +0 -2
  383. lionagi/core/director/operations/select.py +0 -3
  384. lionagi/core/director/operations/utils.py +0 -6
  385. lionagi/core/engine/branch_engine.py +0 -361
  386. lionagi/core/engine/instruction_map_engine.py +0 -213
  387. lionagi/core/engine/sandbox_.py +0 -16
  388. lionagi/core/engine/script_engine.py +0 -89
  389. lionagi/core/executor/base_executor.py +0 -97
  390. lionagi/core/executor/graph_executor.py +0 -335
  391. lionagi/core/executor/neo4j_executor.py +0 -394
  392. lionagi/core/generic/README.md +0 -0
  393. lionagi/core/generic/edge_condition.py +0 -17
  394. lionagi/core/generic/hyperedge.py +0 -1
  395. lionagi/core/generic/tree.py +0 -49
  396. lionagi/core/generic/tree_node.py +0 -85
  397. lionagi/core/mail/__init__.py +0 -11
  398. lionagi/core/mail/mail.py +0 -26
  399. lionagi/core/mail/mail_manager.py +0 -185
  400. lionagi/core/mail/package.py +0 -49
  401. lionagi/core/mail/start_mail.py +0 -36
  402. lionagi/core/message/__init__.py +0 -18
  403. lionagi/core/message/action_request.py +0 -114
  404. lionagi/core/message/action_response.py +0 -121
  405. lionagi/core/message/assistant_response.py +0 -80
  406. lionagi/core/message/instruction.py +0 -194
  407. lionagi/core/message/message.py +0 -86
  408. lionagi/core/message/system.py +0 -71
  409. lionagi/core/message/util.py +0 -274
  410. lionagi/core/report/__init__.py +0 -4
  411. lionagi/core/report/base.py +0 -201
  412. lionagi/core/report/form.py +0 -212
  413. lionagi/core/report/report.py +0 -150
  414. lionagi/core/report/util.py +0 -15
  415. lionagi/core/rule/_default.py +0 -17
  416. lionagi/core/rule/action.py +0 -87
  417. lionagi/core/rule/base.py +0 -234
  418. lionagi/core/rule/boolean.py +0 -56
  419. lionagi/core/rule/choice.py +0 -48
  420. lionagi/core/rule/mapping.py +0 -82
  421. lionagi/core/rule/number.py +0 -73
  422. lionagi/core/rule/rulebook.py +0 -45
  423. lionagi/core/rule/string.py +0 -43
  424. lionagi/core/rule/util.py +0 -0
  425. lionagi/core/session/directive_mixin.py +0 -307
  426. lionagi/core/structure/__init__.py +0 -1
  427. lionagi/core/structure/chain.py +0 -1
  428. lionagi/core/structure/forest.py +0 -1
  429. lionagi/core/structure/graph.py +0 -1
  430. lionagi/core/structure/tree.py +0 -1
  431. lionagi/core/unit/__init__.py +0 -4
  432. lionagi/core/unit/parallel_unit.py +0 -234
  433. lionagi/core/unit/template/action.py +0 -65
  434. lionagi/core/unit/template/base.py +0 -35
  435. lionagi/core/unit/template/plan.py +0 -69
  436. lionagi/core/unit/template/predict.py +0 -95
  437. lionagi/core/unit/template/score.py +0 -108
  438. lionagi/core/unit/template/select.py +0 -91
  439. lionagi/core/unit/unit.py +0 -452
  440. lionagi/core/unit/unit_form.py +0 -290
  441. lionagi/core/unit/unit_mixin.py +0 -1166
  442. lionagi/core/unit/util.py +0 -103
  443. lionagi/core/validator/validator.py +0 -376
  444. lionagi/core/work/work.py +0 -59
  445. lionagi/core/work/work_edge.py +0 -102
  446. lionagi/core/work/work_function.py +0 -114
  447. lionagi/core/work/work_function_node.py +0 -50
  448. lionagi/core/work/work_queue.py +0 -90
  449. lionagi/core/work/work_task.py +0 -151
  450. lionagi/core/work/worker.py +0 -410
  451. lionagi/core/work/worker_engine.py +0 -208
  452. lionagi/core/work/worklog.py +0 -108
  453. lionagi/experimental/compressor/base.py +0 -47
  454. lionagi/experimental/compressor/llm_compressor.py +0 -265
  455. lionagi/experimental/compressor/llm_summarizer.py +0 -61
  456. lionagi/experimental/compressor/util.py +0 -70
  457. lionagi/experimental/directive/README.md +0 -1
  458. lionagi/experimental/directive/__init__.py +0 -19
  459. lionagi/experimental/directive/parser/base_parser.py +0 -294
  460. lionagi/experimental/directive/parser/base_syntax.txt +0 -200
  461. lionagi/experimental/directive/template/base_template.py +0 -71
  462. lionagi/experimental/directive/template/schema.py +0 -36
  463. lionagi/experimental/directive/tokenizer.py +0 -59
  464. lionagi/experimental/evaluator/README.md +0 -1
  465. lionagi/experimental/evaluator/ast_evaluator.py +0 -119
  466. lionagi/experimental/evaluator/base_evaluator.py +0 -213
  467. lionagi/experimental/knowledge/__init__.py +0 -0
  468. lionagi/experimental/knowledge/base.py +0 -10
  469. lionagi/experimental/knowledge/graph.py +0 -0
  470. lionagi/experimental/memory/__init__.py +0 -0
  471. lionagi/experimental/strategies/__init__.py +0 -0
  472. lionagi/experimental/strategies/base.py +0 -1
  473. lionagi/integrations/bridge/__init__.py +0 -4
  474. lionagi/integrations/bridge/autogen_/__init__.py +0 -0
  475. lionagi/integrations/bridge/autogen_/autogen_.py +0 -127
  476. lionagi/integrations/bridge/langchain_/__init__.py +0 -0
  477. lionagi/integrations/bridge/langchain_/documents.py +0 -138
  478. lionagi/integrations/bridge/langchain_/langchain_bridge.py +0 -68
  479. lionagi/integrations/bridge/llamaindex_/__init__.py +0 -0
  480. lionagi/integrations/bridge/llamaindex_/index.py +0 -36
  481. lionagi/integrations/bridge/llamaindex_/llama_index_bridge.py +0 -108
  482. lionagi/integrations/bridge/llamaindex_/llama_pack.py +0 -256
  483. lionagi/integrations/bridge/llamaindex_/node_parser.py +0 -92
  484. lionagi/integrations/bridge/llamaindex_/reader.py +0 -201
  485. lionagi/integrations/bridge/llamaindex_/textnode.py +0 -59
  486. lionagi/integrations/bridge/pydantic_/__init__.py +0 -0
  487. lionagi/integrations/bridge/pydantic_/pydantic_bridge.py +0 -7
  488. lionagi/integrations/bridge/transformers_/__init__.py +0 -0
  489. lionagi/integrations/bridge/transformers_/install_.py +0 -39
  490. lionagi/integrations/chunker/__init__.py +0 -0
  491. lionagi/integrations/chunker/chunk.py +0 -314
  492. lionagi/integrations/config/__init__.py +0 -4
  493. lionagi/integrations/config/mlx_configs.py +0 -1
  494. lionagi/integrations/config/oai_configs.py +0 -154
  495. lionagi/integrations/config/ollama_configs.py +0 -1
  496. lionagi/integrations/config/openrouter_configs.py +0 -74
  497. lionagi/integrations/langchain_/__init__.py +0 -0
  498. lionagi/integrations/llamaindex_/__init__.py +0 -0
  499. lionagi/integrations/loader/__init__.py +0 -0
  500. lionagi/integrations/loader/load.py +0 -257
  501. lionagi/integrations/loader/load_util.py +0 -214
  502. lionagi/integrations/provider/__init__.py +0 -11
  503. lionagi/integrations/provider/_mapping.py +0 -47
  504. lionagi/integrations/provider/litellm.py +0 -53
  505. lionagi/integrations/provider/mistralai.py +0 -1
  506. lionagi/integrations/provider/mlx_service.py +0 -55
  507. lionagi/integrations/provider/oai.py +0 -196
  508. lionagi/integrations/provider/ollama.py +0 -55
  509. lionagi/integrations/provider/openrouter.py +0 -170
  510. lionagi/integrations/provider/services.py +0 -138
  511. lionagi/integrations/provider/transformers.py +0 -108
  512. lionagi/integrations/storage/__init__.py +0 -3
  513. lionagi/integrations/storage/neo4j.py +0 -681
  514. lionagi/integrations/storage/storage_util.py +0 -302
  515. lionagi/integrations/storage/structure_excel.py +0 -291
  516. lionagi/integrations/storage/to_csv.py +0 -70
  517. lionagi/integrations/storage/to_excel.py +0 -91
  518. lionagi/libs/ln_api.py +0 -944
  519. lionagi/libs/ln_async.py +0 -208
  520. lionagi/libs/ln_context.py +0 -37
  521. lionagi/libs/ln_convert.py +0 -671
  522. lionagi/libs/ln_dataframe.py +0 -187
  523. lionagi/libs/ln_func_call.py +0 -1328
  524. lionagi/libs/ln_image.py +0 -114
  525. lionagi/libs/ln_knowledge_graph.py +0 -422
  526. lionagi/libs/ln_nested.py +0 -822
  527. lionagi/libs/ln_parse.py +0 -750
  528. lionagi/libs/ln_queue.py +0 -107
  529. lionagi/libs/ln_tokenize.py +0 -179
  530. lionagi/libs/ln_validate.py +0 -299
  531. lionagi/libs/special_tokens.py +0 -172
  532. lionagi/libs/sys_util.py +0 -710
  533. lionagi/lions/__init__.py +0 -0
  534. lionagi/lions/coder/__init__.py +0 -0
  535. lionagi/lions/coder/add_feature.py +0 -20
  536. lionagi/lions/coder/base_prompts.py +0 -22
  537. lionagi/lions/coder/code_form.py +0 -15
  538. lionagi/lions/coder/coder.py +0 -184
  539. lionagi/lions/coder/util.py +0 -101
  540. lionagi/lions/director/__init__.py +0 -0
  541. lionagi/lions/judge/__init__.py +0 -0
  542. lionagi/lions/judge/config.py +0 -8
  543. lionagi/lions/judge/data/__init__.py +0 -0
  544. lionagi/lions/judge/data/sample_codes.py +0 -526
  545. lionagi/lions/judge/data/sample_rurbic.py +0 -48
  546. lionagi/lions/judge/forms/__init__.py +0 -0
  547. lionagi/lions/judge/forms/code_analysis_form.py +0 -126
  548. lionagi/lions/judge/rubric.py +0 -34
  549. lionagi/lions/judge/services/__init__.py +0 -0
  550. lionagi/lions/judge/services/judge_code.py +0 -49
  551. lionagi/lions/researcher/__init__.py +0 -0
  552. lionagi/lions/researcher/data_source/__init__.py +0 -0
  553. lionagi/lions/researcher/data_source/finhub_.py +0 -192
  554. lionagi/lions/researcher/data_source/google_.py +0 -207
  555. lionagi/lions/researcher/data_source/wiki_.py +0 -98
  556. lionagi/lions/researcher/data_source/yfinance_.py +0 -21
  557. lionagi/operations/brainstorm.py +0 -87
  558. lionagi/operations/config.py +0 -6
  559. lionagi/operations/rank.py +0 -102
  560. lionagi/operations/score.py +0 -144
  561. lionagi/operations/select.py +0 -141
  562. lionagi-0.4.0.dist-info/METADATA +0 -241
  563. lionagi-0.4.0.dist-info/RECORD +0 -249
  564. /lionagi/{core/_setting → integrations/anthropic_/api_endpoints/messages/response}/__init__.py +0 -0
  565. /lionagi/{core/agent → integrations/groq_/api_endpoints}/__init__.py +0 -0
  566. /lionagi/{core/agent/eval → integrations/ollama_/api_endpoints/completion}/__init__.py +0 -0
  567. /lionagi/{core/agent/learn → integrations/ollama_/api_endpoints/embedding}/__init__.py +0 -0
  568. /lionagi/{core/agent/plan → integrations/openai_}/__init__.py +0 -0
  569. /lionagi/{core/director → integrations/openai_/api_endpoints/chat_completions/response}/__init__.py +0 -0
  570. /lionagi/{core/director/operations → integrations/openai_/image_token_calculator}/__init__.py +0 -0
  571. /lionagi/{core/engine → integrations/perplexity_/api_endpoints}/__init__.py +0 -0
  572. /lionagi/{core/executor → integrations/perplexity_/api_endpoints/chat_completions}/__init__.py +0 -0
  573. /lionagi/{core/generic/registry/component_registry → integrations/perplexity_/api_endpoints/chat_completions/request}/__init__.py +0 -0
  574. /lionagi/{core/rule → integrations/perplexity_/api_endpoints/chat_completions/response}/__init__.py +0 -0
  575. /lionagi/{core/unit/template → libs/compress}/__init__.py +0 -0
  576. /lionagi/{core/validator → libs/file}/__init__.py +0 -0
  577. /lionagi/{core/work → libs/func}/__init__.py +0 -0
  578. /lionagi/{experimental → libs/package}/__init__.py +0 -0
  579. /lionagi/{core/agent/plan/plan.py → libs/parse/params.py} +0 -0
  580. /lionagi/{experimental/compressor → protocols}/__init__.py +0 -0
  581. /lionagi/{experimental/directive/parser → protocols/adapters}/__init__.py +0 -0
  582. /lionagi/{experimental/directive/template → protocols/registries}/__init__.py +0 -0
  583. /lionagi/{experimental/evaluator → strategies}/__init__.py +0 -0
  584. {lionagi-0.4.0.dist-info → lionagi-0.5.0.dist-info/licenses}/LICENSE +0 -0
lionagi/libs/ln_nested.py DELETED
@@ -1,822 +0,0 @@
1
- from collections import defaultdict
2
- from collections.abc import Callable, Generator
3
- from itertools import chain
4
- from typing import Any
5
-
6
- import lionagi.libs.ln_convert as convert
7
- from lionagi.libs.sys_util import SysUtil
8
-
9
-
10
- def nset(
11
- nested_structure: dict | list, indices: list[int | str], value: Any
12
- ) -> None:
13
- """
14
- sets a value within a nested structure at the specified path defined by indices.
15
-
16
- this method allows setting a value deep within a nested dictionary or list by
17
- specifying a path to the target location using a list of indices. each index in
18
- the list represents a level in the nested structure, with integers used for
19
- list indices and strings for dictionary keys.
20
-
21
- Args: nested_structure (dict | list): The nested structure where the value will
22
- be set. indices (list[int | str]): The path of indices leading to where the
23
- value should be set. value (Any): The value to set at the specified location in
24
- the nested structure.
25
-
26
- Raises: ValueError: Raised if the indices list is empty. TypeError: Raised if
27
- the target container is not a list or dictionary, or if the index type is
28
- incorrect.
29
-
30
- Examples:
31
- >>> data = {'a': {'b': [10, 20]}}
32
- >>> nset(data, ['a', 'b', 1], 99)
33
- >>> assert data == {'a': {'b': [10, 99]}}
34
-
35
- >>> data = [0, [1, 2], 3]
36
- >>> nset(data, [1, 1], 99)
37
- >>> assert data == [0, [1, 99], 3]
38
- """
39
- if not indices:
40
- raise ValueError(
41
- "Indices list is empty, cannot determine target container"
42
- )
43
-
44
- _indices = convert.to_list(indices)
45
- target_container = _get_target_container(nested_structure, _indices[:-1])
46
- last_index = _indices[-1]
47
-
48
- if isinstance(target_container, list):
49
- _ensure_list_index(target_container, last_index)
50
- target_container[last_index] = value
51
- elif isinstance(target_container, dict):
52
- target_container[last_index] = value
53
- else:
54
- raise TypeError("Cannot set value on non-list/dict element")
55
-
56
-
57
- def nget(
58
- nested_structure: dict | list,
59
- indices: list[int | str],
60
- default=...,
61
- ) -> Any:
62
- """
63
- retrieves a value from a nested list or dictionary structure, with an option to
64
- specify a default value.
65
-
66
- navigates through the nested structure using the specified indices and
67
- retrieves the value at the target location. the indices can be integers for
68
- lists and strings for dictionaries. if the target cannot be reached or does not
69
- exist, it returns the specified default value or raises an error if no default
70
- is provided.
71
-
72
- Args: nested_structure (dict | list): The nested list or dictionary structure.
73
- indices (list[int | str]): A list of indices to navigate through the structure.
74
- default (Any | None): The default value to return if the target cannot be
75
- reached. if `default` is not provided and the target cannot be reached,
76
- a LookupError is raised.
77
-
78
- Returns: Any: The value at the target location, the default value if provided
79
- and the target cannot be reached, or raises an error.
80
-
81
- Raises: LookupError: If the target location cannot be reached or does not exist
82
- and no default value is provided.
83
-
84
- Examples:
85
- >>> data = {'a': {'b': [10, 20]}}
86
- >>> assert nget(data, ['a', 'b', 1]) == 20
87
- >>> nget(data, ['a', 'b', 2])
88
- Traceback (most recent call last):
89
- ...
90
- LookupError: Target not found and no default value provided.
91
- """
92
-
93
- try:
94
- target_container = _get_target_container(
95
- nested_structure, indices[:-1]
96
- )
97
- last_index = indices[-1]
98
-
99
- if (
100
- isinstance(target_container, list)
101
- and isinstance(last_index, int)
102
- and last_index < len(target_container)
103
- ):
104
-
105
- return target_container[last_index]
106
- elif (
107
- isinstance(target_container, dict)
108
- and last_index in target_container
109
- ):
110
- return target_container[last_index]
111
- elif default is not ...:
112
- return default
113
- else:
114
- raise LookupError(
115
- "Target not found and no default value provided."
116
- )
117
- except (IndexError, KeyError, TypeError):
118
- if default is not ...:
119
- return default
120
- else:
121
- raise LookupError(
122
- "Target not found and no default value provided."
123
- )
124
-
125
-
126
- # nested merge
127
- def nmerge(
128
- nested_structure: list[dict | list],
129
- /,
130
- *,
131
- overwrite: bool = False,
132
- dict_sequence: bool = False,
133
- sequence_separator: str = "[^_^]",
134
- sort_list: bool = False,
135
- custom_sort: Callable[[Any], Any] | None = None,
136
- ) -> dict | list:
137
- """
138
- merges multiple dictionaries, lists, or sequences into a unified structure.
139
-
140
- this method intelligently merges a nested_structure of iterable objects (
141
- dictionaries or lists) into a single cohesive dictionary or list. it offers
142
- flexibility in handling key conflicts for dictionaries and can optionally sort
143
- merged sequences.
144
-
145
- Args: nested_structure: A list containing dictionaries, lists, or other
146
- iterable objects to merge. dict_update: Determines whether to overwrite
147
- existing keys in dictionaries with those from subsequent dictionaries. defaults
148
- to False, preserving original keys. dict_sequence: Enables unique key
149
- generation for duplicate keys by appending a sequence number,
150
- using `sequence_separator` as the delimiter. applicable only if `dict_update`
151
- is False. sequence_separator: The sep used when generating unique keys
152
- for duplicate dictionary keys. sort_list: When true, sort the resulting list
153
- after merging. it Does not affect dictionaries. custom_sort: An optional Callable
154
- that defines custom sorting logic for the merged list.
155
-
156
- Returns:
157
- A merged dictionary or list,
158
- depending on the types present in `iterables`.
159
-
160
- Raises:
161
- TypeError:
162
- If `iterables`
163
- contains objects of incompatible types that cannot be merged.
164
-
165
- examples:
166
- >>> nmerge([{'a': 1}, {'b': 2}], overwrite=True)
167
- {'a': 1, 'b': 2}
168
-
169
- >>> nmerge([[1, 2], [3, 4]], sort_list=True)
170
- [1, 2, 3, 4]
171
- """
172
- if convert.is_homogeneous(nested_structure, dict):
173
- return _merge_dicts(
174
- nested_structure, overwrite, dict_sequence, sequence_separator
175
- )
176
- elif convert.is_homogeneous(nested_structure, list) and not any(
177
- isinstance(it, (dict, str)) for it in nested_structure
178
- ):
179
- return _merge_sequences(nested_structure, sort_list, custom_sort)
180
- else:
181
- raise TypeError(
182
- "All items in the input_ list must be of the same type, "
183
- "either dict, list, or Iterable."
184
- )
185
-
186
-
187
- # flatten dictionary
188
- def flatten(
189
- nested_structure: Any,
190
- /,
191
- *,
192
- parent_key: str = "",
193
- sep: str = "[^_^]",
194
- max_depth: int | None = None,
195
- inplace: bool = False,
196
- dict_only: bool = False,
197
- ) -> dict | None:
198
- """
199
- flattens a nested structure into a dictionary with composite keys.
200
-
201
- this method transforms a nested dictionary or list into a single-level
202
- dictionary with keys representing the path to each value. it is configurable
203
- with respect to depth, in-place modification, and handling of lists.
204
-
205
- Args: nested_structure: The nested dictionary or list to flatten. parent_key: A
206
- prefix for all keys in the flattened dictionary, useful for nested calls. sep:
207
- The sep used between levels in composite keys. max_depth: The maximum
208
- depth to flatten; if None, flattens completely. inplace: If True, modifies
209
- `nested_structure` in place; otherwise, returns a new dictionary. dict_only: If
210
- True, only flattens nested dictionaries, leaving lists intact.
211
-
212
- Returns:
213
- A flattened dictionary, or None if `inplace` is True.
214
-
215
- Raises:
216
- ValueError: If `inplace` is True but `nested_structure` is not a dictionary.
217
-
218
- examples:
219
- >>> nested_dict = {'a': {'b': {'c': 1}}}
220
- >>> flatten(nested_dict)
221
- {'a_b_c': 1}
222
-
223
- >>> nested_list = [{'a': 1}, {'b': 2}]
224
- >>> flatten(nested_list)
225
- {'0_a': 1, '1_b': 2}
226
- """
227
- if inplace:
228
- if not isinstance(nested_structure, dict):
229
- raise ValueError(
230
- "Object must be a dictionary when 'inplace' is True."
231
- )
232
- _dynamic_flatten_in_place(
233
- nested_structure,
234
- parent_key=parent_key,
235
- sep=sep,
236
- max_depth=max_depth,
237
- dict_only=dict_only,
238
- )
239
- else:
240
- parent_key_tuple = tuple(parent_key.split(sep)) if parent_key else ()
241
- return convert.to_dict(
242
- _dynamic_flatten_generator(
243
- nested_structure,
244
- parent_key=parent_key_tuple,
245
- sep=sep,
246
- max_depth=max_depth,
247
- dict_only=dict_only,
248
- )
249
- )
250
-
251
-
252
- # unflatten dictionary
253
- def unflatten(
254
- flat_dict: dict[str, Any],
255
- /,
256
- *,
257
- sep: str = "[^_^]",
258
- custom_logic: Callable[[str], Any] | None = None,
259
- max_depth: int | None = None,
260
- ) -> dict | list:
261
- """
262
- reconstructs a nested structure from a flat dictionary with composite keys.
263
-
264
- given a flat dictionary with keys representing paths, this method rebuilds the
265
- original nested dictionary or list.it supports custom logic for interpreting
266
- keys and can limit the reconstruction depth.
267
-
268
- Args:
269
- flat_dict: A flat dictionary with composite keys to unflatten.
270
- sep: The sep used in composite keys, indicating nested levels.
271
- custom_logic: An optional function to process each part of the composite keys.
272
- max_depth: The maximum depth for nesting during reconstruction.
273
-
274
- Returns:
275
- The reconstructed nested dictionary or list.
276
-
277
- examples:
278
- >>> flat_dict_ = {'a_b_c': 1}
279
- >>> unflatten(flat_dict_)
280
- {'a': {'b': {'c': 1}}}
281
-
282
- >>> flat_dict_ = {'0_a': 1, '1_b': 2}
283
- >>> unflatten(flat_dict_)
284
- [{'a': 1}, {'b': 2}]
285
- """
286
- unflattened = {}
287
- for composite_key, value in flat_dict.items():
288
- parts = composite_key.split(sep)
289
- if custom_logic:
290
- parts = [custom_logic(part) for part in parts]
291
- else:
292
- parts = [int(part) if part.isdigit() else part for part in parts]
293
-
294
- if not unflattened and all(isinstance(part, int) for part in parts):
295
- unflattened = []
296
-
297
- ninsert(
298
- unflattened,
299
- indices=parts,
300
- value=value,
301
- sep=sep,
302
- max_depth=max_depth,
303
- )
304
-
305
- if isinstance(unflattened, dict) and all(
306
- isinstance(k, int) for k in unflattened.keys()
307
- ):
308
- max_index = max(unflattened.keys(), default=-1)
309
- return [unflattened.get(i) for i in range(max_index + 1)]
310
- return unflattened or {}
311
-
312
-
313
- def nfilter(
314
- nested_structure: dict | list, /, condition: Callable[[Any], bool]
315
- ) -> dict | list:
316
- """
317
- filters items in a dictionary or list based on a specified condition.
318
-
319
- iterates through the given collection, applying a condition to each element.
320
- for dictionaries, the condition receives key-value pairs as tuples. for lists,
321
- it directly receives the elements. only items for which the condition returns
322
- True are included in the resulting collection.
323
-
324
- Args: nested_structure (dict | list): The collection to filter, either a
325
- dictionary or a list. condition (Callable[[Any], bool]): A function that
326
- evaluates each input_ (or key-value pair in the case of dictionaries) against a
327
- condition. returns True to include the input_ in the result, False otherwise.
328
-
329
- Returns: dict | list: A new collection of the same types as `collection`,
330
- containing only items that meet the condition.
331
-
332
- Raises:
333
- TypeError: Raised if `collection` is not a dictionary or a list.
334
-
335
- Examples:
336
- >>> nfilter({'a': 1, 'b': 2, 'c': 3}, lambda x: x[1] > 1)
337
- {'b': 2, 'c': 3}
338
- >>> nfilter([1, 2, 3, 4], lambda x: x % 2 == 0)
339
- [2, 4]
340
- """
341
- if isinstance(nested_structure, dict):
342
- return _filter_dict(nested_structure, condition)
343
- elif isinstance(nested_structure, list):
344
- return _filter_list(nested_structure, condition)
345
- else:
346
- raise TypeError(
347
- "The nested_structure must be either a dict or a list."
348
- )
349
-
350
-
351
- def ninsert(
352
- nested_structure: dict | list,
353
- /,
354
- indices: list[str | int],
355
- value: Any,
356
- *,
357
- sep: str = "[^_^]",
358
- max_depth: int | None = None,
359
- current_depth: int = 0,
360
- ) -> None:
361
- """
362
- inserts a value into a nested structure at a specified path.
363
-
364
- navigates a nested dictionary or list based on a sequence of indices or keys (
365
- `indices`) and inserts `value` at the final location. this method can create
366
- intermediate dictionaries or lists as needed.
367
-
368
- Args: nested_structure (dict | list): The nested structure to modify. indices (
369
- list[str | int]): The sequence of keys (str for dicts) or indices (int for
370
- lists) defining the path to the insertion point. value (Any): The value to
371
- insert at the specified location within `subject`. sep (str): A sep used
372
- when concatenating indices to form composite keys in case of ambiguity. defaults
373
- to '_'. max_depth (int | None): Limits the depth of insertion. if `None`,
374
- no limit is applied. current_depth (int): Internal use only; tracks the current
375
- depth during recursive calls.
376
-
377
- Examples:
378
- >>> subject_ = {'a': {'b': [1, 2]}}
379
- >>> ninsert(subject_, ['a', 'b', 2], 3)
380
- >>> assert subject_ == {'a': {'b': [1, 2, 3]}}
381
-
382
- >>> subject_ = []
383
- >>> ninsert(subject_, [0, 'a'], 1)
384
- >>> assert subject_ == [{'a': 1}]
385
- """
386
- indices = convert.to_list(indices)
387
- parts_len = len(indices)
388
- parts_depth = 0
389
- for i, part in enumerate(indices[:-1]):
390
- if max_depth is not None and current_depth >= max_depth:
391
- break
392
-
393
- if isinstance(part, int):
394
- while len(nested_structure) <= part:
395
- nested_structure.append(None)
396
- if nested_structure[part] is None or not isinstance(
397
- nested_structure[part], (dict, list)
398
- ):
399
- next_part = indices[i + 1]
400
- nested_structure[part] = (
401
- [] if isinstance(next_part, int) else {}
402
- )
403
- elif part not in nested_structure:
404
- next_part = indices[i + 1]
405
- nested_structure[part] = [] if isinstance(next_part, int) else {}
406
- nested_structure = nested_structure[part]
407
- current_depth += 1
408
- parts_depth += 1
409
-
410
- if parts_depth < parts_len - 1:
411
- last_part = sep.join([str(part) for part in indices[parts_depth:]])
412
- else:
413
- last_part = indices[-1]
414
- if isinstance(last_part, int):
415
- _handle_list_insert(nested_structure, last_part, value)
416
- elif isinstance(nested_structure, list):
417
- nested_structure.append({last_part: value})
418
- else:
419
- nested_structure[last_part] = value
420
-
421
-
422
- def get_flattened_keys(
423
- nested_structure: Any,
424
- /,
425
- *,
426
- sep: str = "[^_^]",
427
- max_depth: int | None = None,
428
- dict_only: bool = False,
429
- inplace: bool = False,
430
- ) -> list[str]:
431
- """
432
- retrieves keys from a nested structure after flattening.
433
-
434
- this method generates a list of all keys that would exist in a flattened
435
- representation of the given nested structure. it supports custom depth,
436
- in-place modifications, and can be limited to processing dictionaries only.
437
-
438
- Args: nested_structure: The nested dictionary or list to process. sep: The
439
- sep used between nested keys in the flattened keys. defaults to '_'.
440
- max_depth: The maximum depth to flatten. if None, flattens the structure
441
- completely. dict_only: If True, only processes nested dictionaries, leaving
442
- lists as values. inplace: If True, flattens `nested_structure` in place,
443
- modifying the original object.
444
-
445
- Returns:
446
- A list of strings representing the keys in the flattened structure.
447
-
448
- Raises:
449
- ValueError: If `inplace` is True but `nested_structure` is not a dictionary.
450
-
451
- Examples:
452
- >>> nested_dict = {'a': 1, 'b': {'c': 2, 'd': {'e': 3}}}
453
- >>> keys = get_flattened_keys(nested_dict)
454
- >>> assert keys == ['a', 'b_c', 'b_d_e']
455
-
456
- >>> nested_list = [{'a': 1}, {'b': 2}]
457
- >>> keys = get_flattened_keys(nested_list)
458
- >>> assert keys == ['0_a', '1_b']
459
- """
460
- if not inplace:
461
- return convert.to_list(
462
- flatten(
463
- nested_structure,
464
- sep=sep,
465
- max_depth=max_depth,
466
- dict_only=dict_only,
467
- ).keys()
468
- )
469
- obj_copy = SysUtil.create_copy(nested_structure, num=1)
470
- flatten(
471
- obj_copy,
472
- sep=sep,
473
- max_depth=max_depth,
474
- inplace=True,
475
- dict_only=dict_only,
476
- )
477
- return convert.to_list(obj_copy.keys())
478
-
479
-
480
- def _dynamic_flatten_in_place(
481
- nested_structure: Any,
482
- /,
483
- *,
484
- parent_key: str = "",
485
- sep: str = "[^_^]",
486
- max_depth: int | None = None,
487
- current_depth: int = 0,
488
- dict_only: bool = False,
489
- ) -> None:
490
- """
491
- Flattens a nested structure in place up to a specified depth.
492
-
493
- This internal helper function recursively flattens a nested dictionary or list,
494
- modifying the original structure. It can be limited to processing only
495
- dictionaries and to a certain depth.
496
-
497
- Args:
498
- nested_structure: The structure to flatten.
499
- parent_key: Initial key prefix for all keys in the flattened structure.
500
- sep: Separator for nested keys.
501
- max_depth: Limits the flattening to a specific depth.
502
- current_depth: Tracks the current depth in the recursion.
503
- dict_only: Limits the flattening to dictionaries only, ignoring lists.
504
-
505
- Note:
506
- This function modifies `nested_structure` in place.
507
-
508
- Examples:
509
- Given a nested dictionary `nested_dict` with the appropriate structure,
510
- `_dynamic_flatten_in_place(nested_dict)` will modify it to a flattened form.
511
- """
512
- if isinstance(nested_structure, dict):
513
- keys_to_delete = []
514
- items = convert.to_list(
515
- nested_structure.items()
516
- ) # Create a copy of the dictionary
517
- # items
518
-
519
- for k, v in items:
520
- new_key = f"{parent_key}{sep}{k}" if parent_key else k
521
-
522
- if isinstance(v, dict) and (
523
- max_depth is None or current_depth < max_depth
524
- ):
525
- _dynamic_flatten_in_place(
526
- v,
527
- parent_key=new_key,
528
- sep=sep,
529
- max_depth=max_depth,
530
- current_depth=(current_depth + 1),
531
- dict_only=dict_only,
532
- )
533
- keys_to_delete.append(k)
534
- nested_structure.update(v)
535
- elif not dict_only and (
536
- isinstance(v, list) or not isinstance(v, (dict, list))
537
- ):
538
- nested_structure[new_key] = v
539
- if parent_key:
540
- keys_to_delete.append(k)
541
-
542
- for k in keys_to_delete:
543
- del nested_structure[k]
544
-
545
-
546
- def _handle_list_insert(nested_structure: list, part: int, value: Any) -> None:
547
- """
548
- Ensures a specified index in a list is occupied by a given value, extending the
549
- list if necessary.
550
-
551
- This method modifies a list by inserting or replacing an element at a specified
552
- index. If the index is beyond the current list size, the list is extended with
553
- `None` values up to the index, then the specified value is inserted.
554
-
555
- Args:
556
- nested_structure: The list to modify.
557
- part: The target index for inserting or replacing the value.
558
- value: The value to be inserted or to replace an existing value in the list.
559
-
560
- Note:
561
- This function directly modifies the input list in place.
562
- """
563
- while len(nested_structure) <= part:
564
- nested_structure.append(None)
565
- nested_structure[part] = value
566
-
567
-
568
- def _ensure_list_index(lst_: list, index: int, default: Any = None) -> None:
569
- """
570
- Extends a list to ensure it has a minimum length, appending a default value as
571
- needed.
572
-
573
- This utility method ensures that a list is extended to at least a specified
574
- index plus one. If the list's length is less than this target, it is appended
575
- with a specified default value until it reaches the required length.
576
-
577
- Args:
578
- lst_: The list to extend.
579
- index: The target index that the list should reach or exceed.
580
- default: The value to append to the list for extension. Defaults to None.
581
-
582
- Note: Modifies the list in place, ensuring it can safely be indexed at `index`
583
- without raising an IndexError.
584
- """
585
- while len(lst_) <= index:
586
- lst_.append(default)
587
-
588
-
589
- def _deep_update(original: dict, update: dict) -> dict:
590
- """
591
- Recursively merges two dictionaries, updating nested dictionaries instead of
592
- overwriting them.
593
-
594
- For each key in the `update` dictionary, if the corresponding value is a
595
- dictionary and the same key exists in `original` with a dictionary value,
596
- this method recursively updates the dictionary. Otherwise, it updates or adds
597
- the key-value pair to `original`.
598
-
599
- Args:
600
- original: The dictionary to update.
601
- update: The dictionary containing updates to apply to `original`.
602
-
603
- Returns:
604
- The `original` dictionary after applying updates from `update`.
605
-
606
- Note:
607
- This method modifies the `original` dictionary in place.
608
- """
609
- for key, value in update.items():
610
- if isinstance(value, dict) and key in original:
611
- original[key] = _deep_update(original.get(key, {}), value)
612
- else:
613
- original[key] = value
614
- return original
615
-
616
-
617
- def _dynamic_flatten_generator(
618
- nested_structure: Any,
619
- parent_key: tuple[str, ...],
620
- sep: str = "[^_^]",
621
- max_depth: int | None = None,
622
- current_depth: int = 0,
623
- dict_only: bool = False,
624
- ) -> Generator[tuple[str, Any], None, None]:
625
- """
626
- Generates flattened key-value pairs from a nested structure.
627
-
628
- Recursively traverses a nested dictionary or list, yielding key-value pairs
629
- with keys representing the path to each value. This method allows for selective
630
- flattening of dictionaries within mixed structures and can be limited to a
631
- certain depth.
632
-
633
- Args: nested_structure: The nested object to flatten, which can be either a
634
- dictionary or a list. parent_key: A tuple of keys representing the path to the
635
- current position within the nested structure. sep: The sep to use between
636
- keys in the flattened keys. Defaults to '_'. max_depth: The maximum depth to
637
- traverse. If None, no limit is applied. Defaults to None. current_depth:
638
- Current depth in the nested structure, used internally for recursive depth
639
- tracking. dict_only: If True, flattens only nested dictionaries, leaving lists
640
- intact.
641
-
642
- Yields: Flattened key-value pairs, where the key is a string representing the
643
- path to the value in the nested structure, and the value is the corresponding
644
- value in that path.
645
- """
646
- if max_depth is not None and current_depth > max_depth:
647
- yield sep.join(parent_key), nested_structure
648
- return
649
-
650
- if isinstance(nested_structure, dict):
651
- for k, v in nested_structure.items():
652
- new_key = parent_key + (k,)
653
- yield from _dynamic_flatten_generator(
654
- v, new_key, sep, max_depth, current_depth + 1, dict_only
655
- )
656
- elif isinstance(nested_structure, list) and not dict_only:
657
- for i, item in enumerate(nested_structure):
658
- new_key = parent_key + (str(i),)
659
- yield from _dynamic_flatten_generator(
660
- item, new_key, sep, max_depth, current_depth + 1, dict_only
661
- )
662
- else:
663
- yield sep.join(parent_key), nested_structure
664
-
665
-
666
- def _deep_merge_dicts(dict1: dict, dict2: dict) -> dict:
667
- """
668
- Deeply merges two dictionaries, combining nested dictionaries instead of
669
- overwriting them.
670
-
671
- When encountering a key in both dictionaries that has a dictionary as its
672
- value, this function recursively merges the nested dictionaries. For other
673
- types of values or unique keys, it simply updates `dict1` with the key-value
674
- pairs from `dict2`.
675
-
676
- Args:
677
- dict1: The target dictionary to update with values from `dict2`.
678
- dict2: The source dictionary providing updates and additional key-value pairs.
679
-
680
- Returns:
681
- The updated dictionary `dict1` with deeply merged values from `dict2`.
682
-
683
- Note:
684
- Modifies `dict1` in place, reflecting merged changes from `dict2`.
685
- """
686
- for key in dict2:
687
- if key in dict1:
688
- if isinstance(dict1[key], dict) and isinstance(dict2[key], dict):
689
- _deep_merge_dicts(dict1[key], dict2[key])
690
- else:
691
- dict1[key] = dict2[key]
692
- else:
693
- dict1[key] = dict2[key]
694
- return dict1
695
-
696
-
697
- def _merge_dicts(
698
- iterables: list[dict[Any, Any]],
699
- dict_update: bool,
700
- dict_sequence: bool,
701
- sequence_separator: str,
702
- ) -> dict[Any, Any]:
703
- """
704
- Merges a list of dictionaries into a single dictionary.
705
-
706
- Args: iterables: A list of dictionaries to be merged.overwrite: If True,
707
- the value of a key in a later dictionary overwrites the previous one.
708
- dict_sequence: If True, instead of overwriting, keys are made unique by
709
- appending a sequence number. sequence_separator: The sep to use when
710
- creating unique keys in case of dict_sequence.
711
-
712
- Returns: A merged dictionary containing the combined key-value pairs from all
713
- dictionaries in the list.
714
- """
715
- merged_dict = {}
716
- sequence_counters = defaultdict(int)
717
-
718
- for d in iterables:
719
- for key, value in d.items():
720
- if key not in merged_dict or dict_update:
721
- merged_dict[key] = value
722
- elif dict_sequence:
723
- sequence_counters[key] += 1
724
- new_key = f"{key}{sequence_separator}{sequence_counters[key]}"
725
- merged_dict[new_key] = value
726
-
727
- return merged_dict
728
-
729
-
730
- def _merge_sequences(
731
- iterables: list,
732
- sort_list: bool,
733
- custom_sort: Callable[[Any], Any] | None = None,
734
- ) -> list[Any]:
735
- """
736
- Concatenates multiple sequences into a single list, with optional sorting.
737
-
738
- This function merges various iterable sequences into a unified list. It can
739
- optionally sort the resulting list either according to Python's default sorting
740
- mechanism or a custom sorting function provided by the user.
741
-
742
- Args:
743
- iterables: A collection of iterable sequences to be merged.
744
- sort_list: Determines whether to sort the merged list.
745
- custom_sort: Optional. A function defining custom sort criteria.
746
-
747
- Returns: list[Any]: The merged (and potentially sorted) list of elements from
748
- all provided iterables.
749
-
750
- Note: The sorting behavior is defined by `sort_list` and `custom_sort`. If
751
- `sort_list` is False, `custom_sort` is ignored. If True, the list is sorted
752
- using Python's default sort unless `custom_sort` is provided.
753
- """
754
- merged_list = convert.to_list(chain(*iterables))
755
- if sort_list:
756
- if custom_sort:
757
- return sorted(merged_list, key=custom_sort)
758
-
759
- else:
760
- return sorted(merged_list, key=lambda x: (isinstance(x, str), x))
761
- return merged_list
762
-
763
-
764
- def _filter_dict(
765
- dictionary: dict[Any, Any], condition: Callable[[tuple[Any, Any]], bool]
766
- ) -> dict[Any, Any]:
767
- """
768
- Filters the entries in a dictionary based on a specified condition.
769
-
770
- Evaluates each key-value pair in the dictionary with the provided condition.
771
- If the condition returns True, the key-value pair is retained in the resulting
772
- dictionary.
773
-
774
- Args: dictionary: The dictionary to be filtered. condition: A function that
775
- accepts a key-value pair (as a tuple) and returns a boolean. Key-value pairs
776
- for which the function returns True are included in the output dictionary.
777
-
778
- Returns: dict[Any, Any]: A new dictionary containing only the entries that
779
- satisfy the condition.
780
- """
781
- return {k: v for k, v in dictionary.items() if condition((k, v))}
782
-
783
-
784
- def _filter_list(
785
- lst: list[Any], condition: Callable[[Any], bool]
786
- ) -> list[Any]:
787
- """
788
- Filters elements in a list based on a specified condition.
789
-
790
- Applies the provided condition to each element in the list. Elements for which
791
- the condition returns True are included in the resulting list.
792
-
793
- Args: lst: The list to be filtered. condition: A function that evaluates each
794
- element in the list. If the function returns True, the element is included in
795
- the filtered list.
796
-
797
- Returns:
798
- list[Any]: A new list comprising elements that meet the condition.
799
- """
800
- return [item for item in lst if condition(item)]
801
-
802
-
803
- def _get_target_container(
804
- nested_list: list | dict, indices: list[int | str]
805
- ) -> list | dict:
806
- current_element = nested_list
807
- for index in indices:
808
- if isinstance(current_element, list):
809
- if isinstance(index, int) and 0 <= index < len(current_element):
810
- current_element = current_element[index]
811
- else:
812
- raise IndexError("list index out of range")
813
- elif isinstance(current_element, dict):
814
- if index in current_element:
815
- current_element = current_element[index]
816
- else:
817
- raise KeyError("Key not found in dictionary")
818
- else:
819
- raise TypeError(
820
- "Current element is neither a list nor a dictionary"
821
- )
822
- return current_element