clear-skies 2.0.27__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.

Potentially problematic release.


This version of clear-skies might be problematic. Click here for more details.

Files changed (270) hide show
  1. clear_skies-2.0.27.dist-info/METADATA +78 -0
  2. clear_skies-2.0.27.dist-info/RECORD +270 -0
  3. clear_skies-2.0.27.dist-info/WHEEL +4 -0
  4. clear_skies-2.0.27.dist-info/licenses/LICENSE +7 -0
  5. clearskies/__init__.py +69 -0
  6. clearskies/action.py +7 -0
  7. clearskies/authentication/__init__.py +15 -0
  8. clearskies/authentication/authentication.py +44 -0
  9. clearskies/authentication/authorization.py +23 -0
  10. clearskies/authentication/authorization_pass_through.py +22 -0
  11. clearskies/authentication/jwks.py +165 -0
  12. clearskies/authentication/public.py +5 -0
  13. clearskies/authentication/secret_bearer.py +551 -0
  14. clearskies/autodoc/__init__.py +8 -0
  15. clearskies/autodoc/formats/__init__.py +5 -0
  16. clearskies/autodoc/formats/oai3_json/__init__.py +7 -0
  17. clearskies/autodoc/formats/oai3_json/oai3_json.py +87 -0
  18. clearskies/autodoc/formats/oai3_json/oai3_schema_resolver.py +15 -0
  19. clearskies/autodoc/formats/oai3_json/parameter.py +35 -0
  20. clearskies/autodoc/formats/oai3_json/request.py +68 -0
  21. clearskies/autodoc/formats/oai3_json/response.py +28 -0
  22. clearskies/autodoc/formats/oai3_json/schema/__init__.py +11 -0
  23. clearskies/autodoc/formats/oai3_json/schema/array.py +9 -0
  24. clearskies/autodoc/formats/oai3_json/schema/default.py +13 -0
  25. clearskies/autodoc/formats/oai3_json/schema/enum.py +7 -0
  26. clearskies/autodoc/formats/oai3_json/schema/object.py +35 -0
  27. clearskies/autodoc/formats/oai3_json/test.json +1985 -0
  28. clearskies/autodoc/py.typed +0 -0
  29. clearskies/autodoc/request/__init__.py +15 -0
  30. clearskies/autodoc/request/header.py +6 -0
  31. clearskies/autodoc/request/json_body.py +6 -0
  32. clearskies/autodoc/request/parameter.py +8 -0
  33. clearskies/autodoc/request/request.py +47 -0
  34. clearskies/autodoc/request/url_parameter.py +6 -0
  35. clearskies/autodoc/request/url_path.py +6 -0
  36. clearskies/autodoc/response/__init__.py +5 -0
  37. clearskies/autodoc/response/response.py +9 -0
  38. clearskies/autodoc/schema/__init__.py +31 -0
  39. clearskies/autodoc/schema/array.py +10 -0
  40. clearskies/autodoc/schema/base64.py +8 -0
  41. clearskies/autodoc/schema/boolean.py +5 -0
  42. clearskies/autodoc/schema/date.py +5 -0
  43. clearskies/autodoc/schema/datetime.py +5 -0
  44. clearskies/autodoc/schema/double.py +5 -0
  45. clearskies/autodoc/schema/enum.py +17 -0
  46. clearskies/autodoc/schema/integer.py +6 -0
  47. clearskies/autodoc/schema/long.py +5 -0
  48. clearskies/autodoc/schema/number.py +6 -0
  49. clearskies/autodoc/schema/object.py +13 -0
  50. clearskies/autodoc/schema/password.py +5 -0
  51. clearskies/autodoc/schema/schema.py +11 -0
  52. clearskies/autodoc/schema/string.py +5 -0
  53. clearskies/backends/__init__.py +67 -0
  54. clearskies/backends/api_backend.py +1194 -0
  55. clearskies/backends/backend.py +137 -0
  56. clearskies/backends/cursor_backend.py +339 -0
  57. clearskies/backends/graphql_backend.py +977 -0
  58. clearskies/backends/memory_backend.py +794 -0
  59. clearskies/backends/secrets_backend.py +100 -0
  60. clearskies/clients/__init__.py +5 -0
  61. clearskies/clients/graphql_client.py +182 -0
  62. clearskies/column.py +1221 -0
  63. clearskies/columns/__init__.py +71 -0
  64. clearskies/columns/audit.py +306 -0
  65. clearskies/columns/belongs_to_id.py +478 -0
  66. clearskies/columns/belongs_to_model.py +145 -0
  67. clearskies/columns/belongs_to_self.py +109 -0
  68. clearskies/columns/boolean.py +110 -0
  69. clearskies/columns/category_tree.py +274 -0
  70. clearskies/columns/category_tree_ancestors.py +51 -0
  71. clearskies/columns/category_tree_children.py +125 -0
  72. clearskies/columns/category_tree_descendants.py +48 -0
  73. clearskies/columns/created.py +92 -0
  74. clearskies/columns/created_by_authorization_data.py +114 -0
  75. clearskies/columns/created_by_header.py +103 -0
  76. clearskies/columns/created_by_ip.py +90 -0
  77. clearskies/columns/created_by_routing_data.py +102 -0
  78. clearskies/columns/created_by_user_agent.py +89 -0
  79. clearskies/columns/date.py +232 -0
  80. clearskies/columns/datetime.py +284 -0
  81. clearskies/columns/email.py +78 -0
  82. clearskies/columns/float.py +149 -0
  83. clearskies/columns/has_many.py +552 -0
  84. clearskies/columns/has_many_self.py +62 -0
  85. clearskies/columns/has_one.py +21 -0
  86. clearskies/columns/integer.py +158 -0
  87. clearskies/columns/json.py +126 -0
  88. clearskies/columns/many_to_many_ids.py +335 -0
  89. clearskies/columns/many_to_many_ids_with_data.py +281 -0
  90. clearskies/columns/many_to_many_models.py +163 -0
  91. clearskies/columns/many_to_many_pivots.py +132 -0
  92. clearskies/columns/phone.py +162 -0
  93. clearskies/columns/select.py +95 -0
  94. clearskies/columns/string.py +102 -0
  95. clearskies/columns/timestamp.py +164 -0
  96. clearskies/columns/updated.py +107 -0
  97. clearskies/columns/uuid.py +83 -0
  98. clearskies/configs/README.md +105 -0
  99. clearskies/configs/__init__.py +170 -0
  100. clearskies/configs/actions.py +43 -0
  101. clearskies/configs/any.py +15 -0
  102. clearskies/configs/any_dict.py +24 -0
  103. clearskies/configs/any_dict_or_callable.py +25 -0
  104. clearskies/configs/authentication.py +23 -0
  105. clearskies/configs/authorization.py +23 -0
  106. clearskies/configs/boolean.py +18 -0
  107. clearskies/configs/boolean_or_callable.py +20 -0
  108. clearskies/configs/callable_config.py +20 -0
  109. clearskies/configs/columns.py +34 -0
  110. clearskies/configs/conditions.py +30 -0
  111. clearskies/configs/config.py +26 -0
  112. clearskies/configs/datetime.py +20 -0
  113. clearskies/configs/datetime_or_callable.py +21 -0
  114. clearskies/configs/email.py +10 -0
  115. clearskies/configs/email_list.py +17 -0
  116. clearskies/configs/email_list_or_callable.py +17 -0
  117. clearskies/configs/email_or_email_list_or_callable.py +59 -0
  118. clearskies/configs/endpoint.py +23 -0
  119. clearskies/configs/endpoint_list.py +29 -0
  120. clearskies/configs/float.py +18 -0
  121. clearskies/configs/float_or_callable.py +20 -0
  122. clearskies/configs/headers.py +28 -0
  123. clearskies/configs/integer.py +18 -0
  124. clearskies/configs/integer_or_callable.py +20 -0
  125. clearskies/configs/joins.py +30 -0
  126. clearskies/configs/list_any_dict.py +32 -0
  127. clearskies/configs/list_any_dict_or_callable.py +33 -0
  128. clearskies/configs/model_class.py +35 -0
  129. clearskies/configs/model_column.py +67 -0
  130. clearskies/configs/model_columns.py +58 -0
  131. clearskies/configs/model_destination_name.py +26 -0
  132. clearskies/configs/model_to_id_column.py +45 -0
  133. clearskies/configs/readable_model_column.py +11 -0
  134. clearskies/configs/readable_model_columns.py +11 -0
  135. clearskies/configs/schema.py +23 -0
  136. clearskies/configs/searchable_model_columns.py +11 -0
  137. clearskies/configs/security_headers.py +39 -0
  138. clearskies/configs/select.py +28 -0
  139. clearskies/configs/select_list.py +49 -0
  140. clearskies/configs/string.py +31 -0
  141. clearskies/configs/string_dict.py +34 -0
  142. clearskies/configs/string_list.py +47 -0
  143. clearskies/configs/string_list_or_callable.py +48 -0
  144. clearskies/configs/string_or_callable.py +18 -0
  145. clearskies/configs/timedelta.py +20 -0
  146. clearskies/configs/timezone.py +20 -0
  147. clearskies/configs/url.py +25 -0
  148. clearskies/configs/validators.py +45 -0
  149. clearskies/configs/writeable_model_column.py +11 -0
  150. clearskies/configs/writeable_model_columns.py +11 -0
  151. clearskies/configurable.py +78 -0
  152. clearskies/contexts/__init__.py +11 -0
  153. clearskies/contexts/cli.py +130 -0
  154. clearskies/contexts/context.py +99 -0
  155. clearskies/contexts/wsgi.py +79 -0
  156. clearskies/contexts/wsgi_ref.py +87 -0
  157. clearskies/cursors/__init__.py +10 -0
  158. clearskies/cursors/cursor.py +161 -0
  159. clearskies/cursors/from_environment/__init__.py +5 -0
  160. clearskies/cursors/from_environment/mysql.py +51 -0
  161. clearskies/cursors/from_environment/postgresql.py +49 -0
  162. clearskies/cursors/from_environment/sqlite.py +35 -0
  163. clearskies/cursors/mysql.py +61 -0
  164. clearskies/cursors/postgresql.py +61 -0
  165. clearskies/cursors/sqlite.py +62 -0
  166. clearskies/decorators.py +33 -0
  167. clearskies/decorators.pyi +10 -0
  168. clearskies/di/__init__.py +15 -0
  169. clearskies/di/additional_config.py +130 -0
  170. clearskies/di/additional_config_auto_import.py +17 -0
  171. clearskies/di/di.py +948 -0
  172. clearskies/di/inject/__init__.py +25 -0
  173. clearskies/di/inject/akeyless_sdk.py +16 -0
  174. clearskies/di/inject/by_class.py +24 -0
  175. clearskies/di/inject/by_name.py +22 -0
  176. clearskies/di/inject/di.py +16 -0
  177. clearskies/di/inject/environment.py +15 -0
  178. clearskies/di/inject/input_output.py +19 -0
  179. clearskies/di/inject/logger.py +16 -0
  180. clearskies/di/inject/now.py +16 -0
  181. clearskies/di/inject/requests.py +16 -0
  182. clearskies/di/inject/secrets.py +15 -0
  183. clearskies/di/inject/utcnow.py +16 -0
  184. clearskies/di/inject/uuid.py +16 -0
  185. clearskies/di/injectable.py +32 -0
  186. clearskies/di/injectable_properties.py +131 -0
  187. clearskies/end.py +219 -0
  188. clearskies/endpoint.py +1303 -0
  189. clearskies/endpoint_group.py +333 -0
  190. clearskies/endpoints/__init__.py +25 -0
  191. clearskies/endpoints/advanced_search.py +519 -0
  192. clearskies/endpoints/callable.py +382 -0
  193. clearskies/endpoints/create.py +201 -0
  194. clearskies/endpoints/delete.py +133 -0
  195. clearskies/endpoints/get.py +267 -0
  196. clearskies/endpoints/health_check.py +181 -0
  197. clearskies/endpoints/list.py +567 -0
  198. clearskies/endpoints/restful_api.py +417 -0
  199. clearskies/endpoints/schema.py +185 -0
  200. clearskies/endpoints/simple_search.py +279 -0
  201. clearskies/endpoints/update.py +188 -0
  202. clearskies/environment.py +106 -0
  203. clearskies/exceptions/__init__.py +19 -0
  204. clearskies/exceptions/authentication.py +2 -0
  205. clearskies/exceptions/authorization.py +2 -0
  206. clearskies/exceptions/client_error.py +2 -0
  207. clearskies/exceptions/input_errors.py +4 -0
  208. clearskies/exceptions/missing_dependency.py +2 -0
  209. clearskies/exceptions/moved_permanently.py +3 -0
  210. clearskies/exceptions/moved_temporarily.py +3 -0
  211. clearskies/exceptions/not_found.py +2 -0
  212. clearskies/functional/__init__.py +7 -0
  213. clearskies/functional/json.py +47 -0
  214. clearskies/functional/routing.py +92 -0
  215. clearskies/functional/string.py +112 -0
  216. clearskies/functional/validations.py +76 -0
  217. clearskies/input_outputs/__init__.py +13 -0
  218. clearskies/input_outputs/cli.py +157 -0
  219. clearskies/input_outputs/exceptions/__init__.py +7 -0
  220. clearskies/input_outputs/exceptions/cli_input_error.py +2 -0
  221. clearskies/input_outputs/exceptions/cli_not_found.py +2 -0
  222. clearskies/input_outputs/headers.py +54 -0
  223. clearskies/input_outputs/input_output.py +116 -0
  224. clearskies/input_outputs/programmatic.py +62 -0
  225. clearskies/input_outputs/py.typed +0 -0
  226. clearskies/input_outputs/wsgi.py +80 -0
  227. clearskies/loggable.py +19 -0
  228. clearskies/model.py +2039 -0
  229. clearskies/py.typed +0 -0
  230. clearskies/query/__init__.py +12 -0
  231. clearskies/query/condition.py +228 -0
  232. clearskies/query/join.py +136 -0
  233. clearskies/query/query.py +195 -0
  234. clearskies/query/sort.py +27 -0
  235. clearskies/schema.py +82 -0
  236. clearskies/secrets/__init__.py +7 -0
  237. clearskies/secrets/additional_configs/__init__.py +32 -0
  238. clearskies/secrets/additional_configs/mysql_connection_dynamic_producer.py +61 -0
  239. clearskies/secrets/additional_configs/mysql_connection_dynamic_producer_via_ssh_cert_bastion.py +160 -0
  240. clearskies/secrets/akeyless.py +507 -0
  241. clearskies/secrets/exceptions/__init__.py +7 -0
  242. clearskies/secrets/exceptions/not_found_error.py +2 -0
  243. clearskies/secrets/exceptions/permissions_error.py +2 -0
  244. clearskies/secrets/secrets.py +39 -0
  245. clearskies/security_header.py +17 -0
  246. clearskies/security_headers/__init__.py +11 -0
  247. clearskies/security_headers/cache_control.py +68 -0
  248. clearskies/security_headers/cors.py +51 -0
  249. clearskies/security_headers/csp.py +95 -0
  250. clearskies/security_headers/hsts.py +23 -0
  251. clearskies/security_headers/x_content_type_options.py +0 -0
  252. clearskies/security_headers/x_frame_options.py +0 -0
  253. clearskies/typing.py +11 -0
  254. clearskies/validator.py +36 -0
  255. clearskies/validators/__init__.py +33 -0
  256. clearskies/validators/after_column.py +61 -0
  257. clearskies/validators/before_column.py +15 -0
  258. clearskies/validators/in_the_future.py +29 -0
  259. clearskies/validators/in_the_future_at_least.py +13 -0
  260. clearskies/validators/in_the_future_at_most.py +12 -0
  261. clearskies/validators/in_the_past.py +29 -0
  262. clearskies/validators/in_the_past_at_least.py +12 -0
  263. clearskies/validators/in_the_past_at_most.py +12 -0
  264. clearskies/validators/maximum_length.py +25 -0
  265. clearskies/validators/maximum_value.py +28 -0
  266. clearskies/validators/minimum_length.py +25 -0
  267. clearskies/validators/minimum_value.py +28 -0
  268. clearskies/validators/required.py +32 -0
  269. clearskies/validators/timedelta.py +58 -0
  270. clearskies/validators/unique.py +28 -0
clearskies/di/di.py ADDED
@@ -0,0 +1,948 @@
1
+ import datetime
2
+ import inspect
3
+ import os
4
+ from types import ModuleType
5
+ from typing import Any, Callable
6
+
7
+ import requests
8
+ from requests.adapters import HTTPAdapter
9
+ from requests.packages.urllib3.util.retry import Retry # type: ignore
10
+
11
+ import clearskies.input_outputs.input_output
12
+ from clearskies.di.additional_config import AdditionalConfig
13
+ from clearskies.di.additional_config_auto_import import AdditionalConfigAutoImport
14
+ from clearskies.environment import Environment
15
+ from clearskies.exceptions import MissingDependency
16
+ from clearskies.functional import string
17
+
18
+
19
+ class Di:
20
+ """
21
+ Build a dependency injection object.
22
+
23
+ The dependency injection (DI) container is a key part of clearskies, so understanding how to both configure
24
+ them and get dependencies for your classes is important. Note however that you don't often have
25
+ to interact with the dependency injection container directly. All of the configuration options for
26
+ the DI container are also available to all the contexts, which is typically how you will build clearskies
27
+ applications. So, while you can create a DI container and use it directly, typically you'll just follow
28
+ the same basic techniques to configure your context and use that to run your application.
29
+
30
+ These are the main ways to configure the DI container:
31
+
32
+ 1. Import classes - each imported class is assigned an injection name based on the class name.
33
+ 2. Import modules - clearskies will iterate over the module and import all the classes and AdditionalConfigAutoImport classes it finds.
34
+ 3. Import AdditionalConfig classes - these allow you to programmatically define dependencies.
35
+ 4. Specify bindings - this allows you to provide any kind of value with whatever name you want.
36
+ 5. Specify class overrides - these allow you to swap out classes directly.
37
+ 6. Extending the Di class - this allows you to provide a default set of values.
38
+
39
+ When the DI system builds a class or calls a function, those classes and functions can themselves request any value
40
+ configured inside the DI container. There are three ways to request the desired dependencies:
41
+
42
+ 1. By type hinting a class on any arguments (excluding python built-ins)
43
+ 2. By specifying the name of a registered dependency
44
+ 3. By extending the `clearskies.di.AutoFillProps` class and creating class properties from the `clearskies.di.inject_from` module
45
+
46
+ Note that when a class is built/function is called by the DI container, keyword arguments are not allowed
47
+ (because the DI container doesn't know whether or not it should provide optional arguments). In addition,
48
+ the DI container must be able to resolve all positional arguments. If the class requests an argument
49
+ that the DI system does not recognize, an error will be thrown. Finally, it's a common pattern in clearskies
50
+ for some portion of the system to accept functions that will be called by the DI container. When this happens,
51
+ it's possible for clearskies to provide additional values that may be useful when executing the function.
52
+ The areas that accept functions like this also document the additional dependency injection names that are available.
53
+
54
+ Given the variety of ways that dependencies can be specified, it's important to understand the order the priority that
55
+ clearskies uses to determine what value to provide in case there is more than one source. That order is:
56
+
57
+ 1. Positional arguments with type hints:
58
+ 1. The override class if the type-hinted class has a registered override
59
+ 2. A value provided by an AdditionalConfig that can provide the type-hinted class
60
+ 3. The class itself if the class has been added explicitly via add_classes or implicitly via add_modules
61
+ 4. A clearskies built-in for predefined types
62
+ 2. All other positional arguments will have values provided based on the argument name and will receive
63
+ 1. Things set via `add_binding(name, value)`
64
+ 2. Class added via `add_classes` or `add_modules` which are made available according to their Di name
65
+ 3. An AdditionalConfig class with a corresponding `provide_[name]` function
66
+ 4. A clearskies built-in for predefined names
67
+
68
+ Here is the list of predefined values with their names and types:
69
+
70
+ | Injection Name | Injection Type | Value |
71
+ |----------------------|---------------------------------------------------------|-------------------------------------------------------------------------------------------|
72
+ | di | - | The active Di container |
73
+ | now | - | The current time in a datetime object, without timezone |
74
+ | utcnow | - | The current time in a datetime object, with timezone set to UTC |
75
+ | requests | requests.Session | A requests object configured to allow a small number of retries |
76
+ | input_output | clearskies.input_outputs.InputOutput | The clearskies builtin used for receiving and sending data to the client |
77
+ | uuid | - | `import uuid` - the uuid module builtin to python |
78
+ | environment | clearskies.Environment | A clearskies helper that access config info from the environment or a .env file |
79
+ | sys | - | `import sys` - the sys module builtin to python |
80
+ | oai3_schema_resolver | - | Used by the autodoc system |
81
+ | connection_details | - | A dictionary containing credentials that pymysql should use when connecting to a database |
82
+ | connection | - | A pymysql connection object |
83
+ | cursor | - | A pymysql cursor object |
84
+ | endpoint_groups | - | The list of endpoint groups handling the request |
85
+
86
+ Note: for dependencies with an injection name but no injection type, this means that to inject those values you
87
+ must name your argument with the given injection name. In all of the above cases though you can still add type
88
+ hints if desired. So, for instance, you can declare an argument of `utcnow: datetime.datetime`. clearskies
89
+ will ignore the type hint (since `datetime.datetime` isn't a type with a predefined value in clearskies) and
90
+ identify the value based on the name of the argument.
91
+
92
+ Note: multiple `AdditionalConfig` classes can be added to the Di container, and so a single injection name or class
93
+ can potentially be provided by multiple AdditionalConfig classes. AdditionalConfig classes are checked in the
94
+ reverse of the order they were addded in - classes added last are checked first when trying to find values.
95
+
96
+ Note: When importing modules, any classes that inherit from `AdditionalConfigAutoImport` are automatically added
97
+ to the list of additional config classes. These classes are added at the top of the list, so they are lower
98
+ priority than any classes you add via `add_additional_configs` or the `additional_configs` argument of the Di
99
+ constructor.
100
+
101
+ Note: Once a value is constructed, it is cached by the Di container and will automatically be provided for future
102
+ references of that same Di name or class. Arguments injected in a constructor will always receive the cached
103
+ value. If you want a "fresh" value of a given dependency, you have to attach instances from the
104
+ `clearskies.di.inject` module onto class proprties. The instances in the `inject` module generally
105
+ give options for cache control.
106
+
107
+ Here's an example that brings most of these pieces together. Once again, note that we're directly using
108
+ the Di contianer to build class/call functions, while normally you configure the Di container via your context
109
+ and then clearskies itself will build your class or call your functions as needed. Full explanation comes after
110
+ the example.
111
+
112
+ ```python
113
+ from clearskies.di import Di, AdditionalConfig
114
+
115
+
116
+ class SomeClass:
117
+ def __init__(self, my_value: int):
118
+ self.my_value = my_value
119
+
120
+
121
+ class MyClass:
122
+ def __init__(self, some_specific_value: int, some_class: SomeClass):
123
+ # `some_specific_value` is defined in both `MyProvider` and `MyOtherProvider`
124
+ # `some_class` will be injected from the type hint, and the actual instance is made by our
125
+ # `MyProvider`
126
+ self.final_value = some_specific_value * some_class.my_value
127
+
128
+
129
+ class VeryNeedy:
130
+ def __init__(self, my_class, some_other_value: str):
131
+ # We're relying on the automatic conversion of class names to snake_case, so clearskies
132
+ # will connect `my_class` to `MyClass`, which we provided directly to the Di container.
133
+
134
+ # some_other_value is specified as a binding
135
+ self.my_class = my_class
136
+ self.some_other_value = some_other_value
137
+
138
+
139
+ class MyOtherProvider(AdditionalConfig):
140
+ def provide_some_specific_value(self):
141
+ # the order of additional configs will cause this function to be invoked
142
+ # (and hence some_specific_value will be `10`) despite the fact that MyProvider
143
+ # also has a `provide_` function with the same name.
144
+ return 10
145
+
146
+
147
+ class MyProvider(AdditionalConfig):
148
+ def provide_some_specific_value(self):
149
+ # note that the name of our function matches the name of the argument
150
+ # expected by MyClass.__init__. Again though, we won't get called because
151
+ # the order the AdditionalConfigs are loaded gives `MyOtherProvider` priority.
152
+ return 5
153
+
154
+ def can_build_class(self, class_to_check: type) -> bool:
155
+ # this lets the DI container know that if someone wants an instance
156
+ # of SomeClass, we can build it.
157
+ return class_to_check == SomeClass
158
+
159
+ def build_class(self, class_to_provide: type, argument_name: str, di, context: str = ""):
160
+ if class_to_provide == SomeClass:
161
+ return SomeClass(5)
162
+ raise ValueError(
163
+ f"I was asked to build a class I didn't expect '{class_to_provide.__name__}'"
164
+ )
165
+
166
+
167
+ di = Di(
168
+ classes=[MyClass, VeryNeedy, SomeClass],
169
+ additional_configs=[MyProvider(), MyOtherProvider()],
170
+ bindings={
171
+ "some_other_value": "dog",
172
+ },
173
+ )
174
+
175
+
176
+ def my_function(my_fancy_argument: VeryNeedy):
177
+ print(f"Jane owns {my_fancy_argument.my_class.final_value}:")
178
+ print(f"{my_fancy_argument.some_other_value}s")
179
+
180
+
181
+ print(di.call_function(my_function))
182
+ # prints 'Jane owns 50 dogs'
183
+ ```
184
+
185
+ When `call_function` is executed on `my_function`, the di system checks the calling arguments of `my_function`
186
+ and runs through the priority list above to populate them. `my_function` has one argument -
187
+ `my_fancy_argument: VeryNeedy`, which it resolves as so:
188
+
189
+ 1. The type hint (`VeryNeedy`) matches an imported class. Therefore, clearskies will build an instance of VeryNeedy and
190
+ provide it for `my_fancy_argument`.
191
+ 2. clearskies inpsects the constructor for `VeryNeedy` and finds two arguments, `my_class` and `some_other_value: str`,
192
+ which it attempts to build.
193
+ 1. `my_class` has no type hint, so clearskies falls back on name-based resolution. A class called `MyClass` was imported,
194
+ and per standard naming convention, this automatically becomes available via the name `my_class`. Thus, clearskies
195
+ prepares to build an instance of `MyClass`. `MyClass` has two arguments: `some_specific_value: int` and
196
+ `some_class: SomeClass`
197
+ 1. For `some_specific_value`, the Di service falls back on named-based resolution (because it will never try to
198
+ provide values for type-hints of built-in types). Both `MyOtherProvider` and `MyProvider` have a method called
199
+ `provide_some_specific_value`, so both can be used to provide this value. Since `MyOtherProvider` was added to
200
+ the Di container last, it takes priority. Therefore, clearskies calls `MyOtherProvider.provide_some_specific_value`
201
+ to create the value that it will populate into the `some_specific_value` parameter.
202
+ 2. For `some_class: SomeClass`, clearskies evaluates the type-hint. It works through the additional configs and, since
203
+ `MyProvider` returns True when `can_build_class` is called with `SomeClass`, the Di container will use this
204
+ additional config to create the value for the `some_class` argument. Therefore, clearskies calls
205
+ `MyProvider.build_class(SomeClass, 'some_class', di)` and the return value is used for the `some_class` argument.
206
+ 2. `some_other_value` uses a built-in for a type hint, so clearskies falls back on name-based resolution. It falls back
207
+ on the registered binding of `"dog"` to the name `"some_other_value"`, so clearskies provides `"dog"`.
208
+ """
209
+
210
+ _added_modules: dict[int, bool] = {}
211
+ _additional_configs: list[AdditionalConfig] = []
212
+ _bindings: dict[str, Any] = {}
213
+ _from_bindings: dict[str, bool] = {}
214
+ _building: dict[int, str] = {}
215
+ _classes: dict[str, dict[str, int | type]] = {}
216
+ _prepared: dict[str, Any] = {}
217
+ _class_overrides_by_name: dict[str, type] = {}
218
+ _class_overrides_by_class: dict[type, Any] = {}
219
+ _type_hint_disallow_list = [int, float, str, dict, list, datetime.datetime]
220
+ _now: datetime.datetime | None = None
221
+ _utcnow: datetime.datetime | None = None
222
+ _predefined_classes_name_map: dict[type, str] = {
223
+ requests.Session: "requests",
224
+ clearskies.input_outputs.input_output.InputOutput: "input_output",
225
+ Environment: "environment",
226
+ }
227
+
228
+ def __init__(
229
+ self,
230
+ classes: type | list[type] = [],
231
+ modules: ModuleType | list[ModuleType] = [],
232
+ bindings: dict[str, Any] = {},
233
+ additional_configs: AdditionalConfig | list[AdditionalConfig] = [],
234
+ class_overrides: dict[type, Any] = {},
235
+ overrides: dict[str, type] = {},
236
+ now: datetime.datetime | None = None,
237
+ utcnow: datetime.datetime | None = None,
238
+ ):
239
+ """
240
+ Create a dependency injection container.
241
+
242
+ For details on the parameters, see the related methods:
243
+
244
+ classes -> di.add_classes()
245
+ modules -> di.add_modules()
246
+ bindings -> di.add_binding()
247
+ additional_configs -> di.add_additional_configs()
248
+ class_overrides -> di.add_class_override()
249
+ """
250
+ self._added_modules = {}
251
+ self._additional_configs = []
252
+ self._bindings = {}
253
+ self._from_bindings = {}
254
+ self._building = {}
255
+ self._classes = {}
256
+ self._class_overrides_by_name = {}
257
+ self._class_overrides_by_class = {}
258
+ self._prepared = {}
259
+ if classes is not None:
260
+ self.add_classes(classes)
261
+ if modules is not None:
262
+ self.add_modules(modules)
263
+ if bindings is not None:
264
+ for key, value in bindings.items():
265
+ self.add_binding(key, value)
266
+ if additional_configs is not None:
267
+ self.add_additional_configs(additional_configs)
268
+ if class_overrides:
269
+ for key, value in class_overrides.items(): # type: ignore
270
+ self.add_class_override(key, value) # type: ignore
271
+ if overrides:
272
+ for key, value in overrides.items():
273
+ self.add_override(key, value)
274
+ if now:
275
+ self.set_now(now)
276
+ if utcnow:
277
+ self.set_utcnow(utcnow)
278
+
279
+ def add_classes(self, classes: type | list[type]) -> None:
280
+ """
281
+ Record any class that should be made available for injection.
282
+
283
+ All classes that come in here become available via their injection name, which is calculated
284
+ by converting the class name from TitleCase to snake_case. e.g. the following class:
285
+
286
+ ```python
287
+ class MyClass:
288
+ pass
289
+ ```
290
+
291
+ gets an injection name of `my_class`. Also, clearskies will only resolve and reject based on type hints
292
+ if those classes are first added via `add_classes`. See the following example:
293
+
294
+ ```python
295
+ from clearskies.di import Di
296
+
297
+ class MyClass:
298
+ name = "Simple Demo"
299
+
300
+ di = Di(classes=[MyClass])
301
+ # equivalent: di.add_classes(MyClass), di.add_classes([MyClass])
302
+
303
+ def my_function(my_class):
304
+ print(my_class.name)
305
+
306
+ def my_function_with_type_hinting(the_name_no_longer_matters: MyClass):
307
+ print(my-class.name)
308
+
309
+ # both print 'Simple Demo'
310
+ di.call_function(my_function)
311
+ di.call_function(my_function_with_type_hinting)
312
+ ```
313
+ """
314
+ if not isinstance(classes, list):
315
+ classes = [classes]
316
+ for add_class in classes:
317
+ name = string.camel_case_to_snake_case(add_class.__name__)
318
+ self._classes[name] = {"id": id(add_class), "class": add_class}
319
+ self._classes[add_class] = {"id": id(add_class), "class": add_class} # type: ignore
320
+
321
+ # if this is a model class then also add a plural version of its name
322
+ # to the DI configuration
323
+ if hasattr(add_class, "id_column_name"):
324
+ self._classes[string.make_plural(name)] = {"id": id(add_class), "class": add_class}
325
+
326
+ def add_modules(
327
+ self, modules: ModuleType | list[ModuleType], root: str | None = None, is_root: bool = True
328
+ ) -> None:
329
+ """
330
+ Add a module to the dependency injection container.
331
+
332
+ clearskies will iterate through the module, adding all imported classes into the dependency injection container.
333
+
334
+ So, consider the following file structure inside a module:
335
+
336
+ ```
337
+ my_module/
338
+ __init__.py
339
+ my_sub_module/
340
+ __init__.py
341
+ my_class.py
342
+ ```
343
+
344
+ Assuming that the submodule and class are imported at each level (e.g. my_module/__init__.py imports my_sub_module,
345
+ and my_sub_module/__init__.py imports my_class.py) then you can:
346
+
347
+ ```python
348
+ from clearksies.di import Di
349
+ import my_module
350
+
351
+ di = Di()
352
+ di.add_modules(
353
+ [my_module]
354
+ ) # also equivalent: di.add_modules(my_module), or Di(modules=[my_module])
355
+
356
+
357
+ def my_function(my_class):
358
+ pass
359
+
360
+
361
+ di.call_function(my_function)
362
+ ```
363
+
364
+ `my_function` will be called and `my_class` will automatically be populated with an instance of
365
+ `my_module.sub_module.my_class.MyClass`.
366
+
367
+ Note that MyClass will be able to declare its own dependencies per normal dependency injection rules.
368
+ See the main docblock in the clearskies.di.Di class for more details about how all the pieces work together.
369
+ """
370
+ if not isinstance(modules, list):
371
+ modules = [modules]
372
+
373
+ for module in modules:
374
+ # skip internal python modules
375
+ if not hasattr(module, "__file__") or not module.__file__:
376
+ continue
377
+ module_id = id(module)
378
+ if is_root:
379
+ root = os.path.dirname(module.__file__)
380
+ root_len = len(root) if root else 0
381
+ if module_id in self._added_modules:
382
+ continue
383
+ self._added_modules[module_id] = True
384
+
385
+ for name, item in module.__dict__.items():
386
+ if inspect.isclass(item):
387
+ try:
388
+ class_root = os.path.dirname(inspect.getfile(item))
389
+ except TypeError:
390
+ # built-ins will end up here
391
+ continue
392
+ if class_root[:root_len] != root:
393
+ continue
394
+ if issubclass(item, AdditionalConfigAutoImport):
395
+ init_args = inspect.getfullargspec(item)
396
+ nargs = len(init_args.args) if init_args.args else 0
397
+ nkwargs = len(init_args.defaults) if init_args.defaults else 0
398
+ if nargs - 1 - nkwargs > 0:
399
+ raise ValueError(
400
+ "Error auto-importing additional config "
401
+ + item.__name__
402
+ + ": auto imported configs can only have keyword arguments."
403
+ )
404
+ self.add_additional_configs([item()])
405
+ continue
406
+ self.add_classes([item])
407
+ if inspect.ismodule(item):
408
+ if not hasattr(item, "__file__") or not item.__file__:
409
+ continue
410
+ child_root = os.path.dirname(item.__file__)
411
+ if child_root[:root_len] != root:
412
+ continue
413
+ if module.__name__ == "clearskies":
414
+ break
415
+ self.add_modules([item], root=root, is_root=False)
416
+
417
+ def add_additional_configs(self, additional_configs: AdditionalConfig | list[AdditionalConfig]) -> None:
418
+ """
419
+ Add an additional config instance to the dependency injection container.
420
+
421
+ Additional config class provide an additional way to provide dependencies into the dependency
422
+ injection system. For more details about how to use them, see both base classes:
423
+
424
+ 1. clearskies.di.additional_config.AdditionalConfig
425
+ 2. clearskies.di.additional_config_auto_import.AdditionalConfigAutoImport
426
+
427
+ To use this method:
428
+
429
+ ```python
430
+ import clearskies.di
431
+
432
+
433
+ class MyConfig(clearskies.di.AdditionalConfig):
434
+ def provide_some_value(self):
435
+ return 2
436
+
437
+ def provide_another_value(self, some_value):
438
+ return some_value * 2
439
+
440
+
441
+ di = clearskies.di.Di()
442
+ di.add_additional_configs([MyConfig()])
443
+ # equivalents:
444
+ # di.add_additional_configs(MyConfig())
445
+ # di = clearskies.di.Di(additional_configs=[MyConfig()])
446
+
447
+
448
+ def my_function(another_value):
449
+ print(another_value) # prints 4
450
+
451
+
452
+ di.call_function(my_function)
453
+ ```
454
+ """
455
+ if not isinstance(additional_configs, list):
456
+ additional_configs = [additional_configs]
457
+ self._additional_configs.extend(additional_configs)
458
+
459
+ def add_binding(self, key, value):
460
+ """
461
+ Provide a specific value for name-based injection.
462
+
463
+ This method attaches a value to a specific dependency injection name.
464
+
465
+ ```python
466
+ import clearskies.di
467
+
468
+ di = clearskies.di.Di()
469
+ di.add_binding("my_name", 12345)
470
+ # equivalent:
471
+ # di = clearskies.di.Di(bindings={"my_name": 12345})
472
+
473
+
474
+ def my_function(my_name):
475
+ print(my_name) # prints 12345
476
+
477
+
478
+ di.call_function(my_function)
479
+ ```
480
+ """
481
+ if key in self._building:
482
+ raise KeyError(f"Attempt to set binding for '{key}' while '{key}' was already being built")
483
+
484
+ # classes are placed in self._bindings, but any other prepared value goes straight into self._prepared
485
+ self._from_bindings[key] = True
486
+ if inspect.isclass(value):
487
+ self._bindings[key] = value
488
+ if key in self._prepared:
489
+ del self._prepared[key]
490
+ else:
491
+ self._prepared[key] = value
492
+
493
+ def add_class_override(self, class_to_override: type, replacement: Any) -> None:
494
+ """
495
+ Override a class for type-based injection.
496
+
497
+ This function allows you to replace/mock class provided when relying on type hinting for injection.
498
+ This is most often (but not exclusively) used for mocking out classes during texting. Note that
499
+ this only overrides that specific class - not classes that extend it.
500
+
501
+ Example:
502
+ ```python
503
+ from clearskies.import Di
504
+
505
+ class TypeHintedClass:
506
+ my_value = 5
507
+
508
+ class ReplacementClass:
509
+ my_value = 10
510
+
511
+ di = Di()
512
+ di.add_classes(TypeHintedClass)
513
+ di.add_class_override(TypeHintedClass, ReplacementClass)
514
+ # also di = Di(class_overrides={TypeHintedClass: ReplacementClass})
515
+
516
+ def my_function(some_value: TypeHintedClass):
517
+ print(some_value.my_value) # prints 10
518
+
519
+ di.call_function(my_function)
520
+ ```
521
+ """
522
+ if not inspect.isclass(class_to_override):
523
+ raise ValueError(
524
+ "Invalid value passed to add_class_override for 'class_to_override' parameter: it was not a class."
525
+ )
526
+
527
+ self._class_overrides_by_class[class_to_override] = replacement
528
+
529
+ def has_class_override(self, class_to_check: type) -> bool:
530
+ return class_to_check in self._class_overrides_by_class
531
+
532
+ def get_override_by_class(self, object_to_override: Any) -> Any:
533
+ if object_to_override.__class__ not in self._class_overrides_by_class:
534
+ return object_to_override
535
+
536
+ override = self._class_overrides_by_class[object_to_override.__class__]
537
+ if inspect.isclass(override):
538
+ return self.build_class(override)
539
+ self.inject_properties(override.__class__)
540
+ return override
541
+
542
+ def add_override(self, name: str, replacement_class: type) -> None:
543
+ """Override a specific injection name by specifying a class that should be injected in its place."""
544
+ if not inspect.isclass(replacement_class):
545
+ raise ValueError(
546
+ "Invalid value passed to add_override for 'replacement_class' parameter: a class should be passed but I got a "
547
+ + str(type(replacement_class))
548
+ )
549
+
550
+ self._class_overrides_by_name[name] = replacement_class
551
+
552
+ def set_now(self, now: datetime.datetime) -> None:
553
+ """Set the current time which will be passed along to any dependency arguments named `now`."""
554
+ if now.tzinfo is not None:
555
+ raise ValueError(
556
+ "set_now() was passed a datetime object with timezone information - it should only be given timezone-naive datetime objects. Maybe you meant to use di.set_utcnow()"
557
+ )
558
+ self._now = now
559
+
560
+ def set_utcnow(self, utcnow: datetime.datetime) -> None:
561
+ """Set the current time which will be passed along to any dependency arguments named `utcnow`."""
562
+ if not utcnow.tzinfo:
563
+ raise ValueError(
564
+ "set_utcnow() was passed a datetime object without timezone information - it should only be given timezone-aware datetime objects. Maybe you meant to use di.set_now()"
565
+ )
566
+ self._utcnow = utcnow
567
+
568
+ def build(self, thing: Any, context: str | None = None, cache: bool = False) -> Any:
569
+ """
570
+ Have the dependency injection container build a value for you.
571
+
572
+ This will accept either a dependency injection name or a class.
573
+ """
574
+ if inspect.isclass(thing):
575
+ return self.build_class(thing, context=context, cache=cache)
576
+ elif type(thing) == str:
577
+ return self.build_from_name(thing, context=context, cache=cache)
578
+ elif callable(thing):
579
+ raise ValueError("build received a callable: you probably want to use di.call_function()")
580
+
581
+ # if we got here then our thing is already and object of some sort and doesn't need anything further
582
+ return thing
583
+
584
+ def build_from_name(self, name: str, context: str | None = None, cache: bool = False) -> Any:
585
+ """
586
+ Build a dependency based on its name.
587
+
588
+ Order of priority:
589
+ 1. Things set via `add_binding(name, value)`
590
+ 2. Class added via `add_classes` or `add_modules` which are made available according to their Di name
591
+ 3. An AdditionalConfig class with a corresponding `provide_[name]` function
592
+ 4. The Di class itself if it has a matching `provide_[name]` function (aka the builtins)
593
+ """
594
+ if name in self._prepared and (cache or name in self._from_bindings):
595
+ self.inject_properties(self._prepared[name].__class__)
596
+ return self._prepared[name]
597
+
598
+ if name in self._bindings:
599
+ built_value = self.build(self._bindings[name], context=context)
600
+ if cache:
601
+ self._prepared[name] = built_value
602
+ return built_value
603
+
604
+ if name in self._classes or name in self._class_overrides_by_name:
605
+ class_to_build = (
606
+ self._class_overrides_by_name[name]
607
+ if name in self._class_overrides_by_name
608
+ else self._classes[name]["class"]
609
+ ) # type: ignore
610
+ built_value = self.build_class(class_to_build, context=context) # type: ignore
611
+ if cache:
612
+ self._prepared[name] = built_value # type: ignore
613
+ return built_value
614
+
615
+ # additional configs are meant to override ones that come before, with most recent ones
616
+ # taking precedence. Therefore, start at the end (e.g. FILO instead of FIFO, except nothing actually leaves)
617
+ for index in range(len(self._additional_configs) - 1, -1, -1):
618
+ additional_config = self._additional_configs[index]
619
+ if not additional_config.can_build(name):
620
+ continue
621
+ built_value = additional_config.build(name, self, context if context else "")
622
+ self.inject_properties(built_value.__class__)
623
+ if cache and additional_config.can_cache(name, self, context if context else ""):
624
+ self._prepared[name] = built_value
625
+ return built_value
626
+
627
+ if hasattr(self, f"provide_{name}"):
628
+ built_value = self.call_function(getattr(self, f"provide_{name}"))
629
+ self.inject_properties(built_value.__class__)
630
+ if cache and self.can_cache(name, context if context else ""):
631
+ self._prepared[name] = built_value
632
+ return built_value
633
+
634
+ # why twice? When a "concrete" value is bound directly to a DI name, it is just
635
+ # put directly in the cache. Therefore, if cache=False, we won't find it (which is a bug).
636
+ # Therefore, if we get to the very bottom, haven't found anything, but it is in the
637
+ # cache: well, it's time to use the cache.
638
+ if name in self._prepared:
639
+ return self._prepared[name]
640
+
641
+ context_note = f" for {context}" if context else ""
642
+ raise MissingDependency(
643
+ f"I was asked to build {name}{context_note} but there is no added class, configured binding, "
644
+ + f"or a corresponding 'provide_{name}' method for this name."
645
+ )
646
+
647
+ def build_argument(self, argument_name: str, type_hint: type | None, context: str = "", cache: bool = True) -> Any:
648
+ """
649
+ Build an argument given the name and type hint.
650
+
651
+ Runs through the resolution order described in the docblock at the top of the Di class to build an argument given
652
+ its name and type-hint.
653
+ """
654
+ built_value = self.build_class_from_type_hint(argument_name, type_hint, context=context, cache=True)
655
+ if built_value is not None:
656
+ return built_value
657
+ return self.build_from_name(argument_name, context=context, cache=True)
658
+
659
+ def build_class(self, class_to_build: type, context=None, cache=True) -> Any:
660
+ """
661
+ Build a class.
662
+
663
+ The class constructor cannot accept any kwargs. See self._disallow_kwargs for more details
664
+ """
665
+ if class_to_build in self._prepared and cache:
666
+ return self._prepared[class_to_build] # type: ignore
667
+ my_class_name = class_to_build.__name__
668
+
669
+ init_args = inspect.getfullargspec(class_to_build)
670
+ if init_args.defaults is not None:
671
+ self._disallow_kwargs(f"build class '{class_to_build.__name__}'")
672
+
673
+ # ignore the first argument because that is just `self`
674
+ build_arguments = init_args.args[1:]
675
+ if not build_arguments:
676
+ self.inject_properties(class_to_build)
677
+ built_value = class_to_build()
678
+ if cache:
679
+ self._prepared[class_to_build] = built_value # type: ignore
680
+ return built_value
681
+
682
+ # self._building will help us keep track of what we're already building, and what we are building it for.
683
+ # This is partly to give better error messages, but mainly to detect cyclical dependency trees.
684
+ # We use id(class_to_build) because this uniquely identifies a class (while the name won't, since two
685
+ # different classes can have the same name but be in different modules). Therefore, before we start
686
+ # building a class, see if its id is in self._building, raise an error if so, or continue if not.
687
+ class_id = id(class_to_build)
688
+ if class_id in self._building:
689
+ original_context_label = (
690
+ f"'{self._building[class_id]}'" if self._building[class_id] is not None else "itself"
691
+ )
692
+ raise ValueError(
693
+ f"Circular dependencies detected while building '{my_class_name}' because '"
694
+ + f"{my_class_name} is a dependency of both '{context}' and {original_context_label}"
695
+ )
696
+
697
+ self._building[class_id] = context
698
+ # Turn on caching when building the automatic dependencies that get injected into a class constructor
699
+ args = [
700
+ self.build_argument(
701
+ build_argument, init_args.annotations.get(build_argument, None), context=my_class_name, cache=True
702
+ )
703
+ for build_argument in build_arguments
704
+ ]
705
+
706
+ del self._building[class_id]
707
+
708
+ self.inject_properties(class_to_build)
709
+ built_value = class_to_build(*args)
710
+ if cache:
711
+ self._prepared[class_to_build] = built_value # type: ignore
712
+ return built_value
713
+
714
+ def build_class_from_type_hint(
715
+ self, argument_name: str, class_to_build: type | None, context: str = "", cache: bool = True
716
+ ) -> Any | None:
717
+ """
718
+ Build an argument from a type hint.
719
+
720
+ Note that in many cases we can't actually build the thing. It may be a type hint of a built-in or some other value
721
+ that we're not configured to deal with. In that case, just return None and the calling method will deal with it.
722
+
723
+ This follows the resolution order defined in the docblock of the Di class.
724
+ """
725
+ # these first checks just verify that it is something that we can actually build
726
+ if not class_to_build:
727
+ return None
728
+ if not callable(class_to_build):
729
+ return None
730
+
731
+ # check our class overrides
732
+ if class_to_build in self._class_overrides_by_class:
733
+ replacement = self._class_overrides_by_class[class_to_build]
734
+ if not inspect.isclass(replacement):
735
+ return replacement
736
+ return self.build_class(replacement, context=context, cache=cache)
737
+
738
+ # generally we can't build abstract classes, so if the class is abstract then we should pass.
739
+ # However, this is not the case if it has an override - then the developer has given us specific guidance
740
+ if inspect.isabstract(class_to_build):
741
+ return None
742
+
743
+ # next check our additional config classes
744
+ built_value = None
745
+ can_cache = False
746
+ for index in range(len(self._additional_configs) - 1, -1, -1):
747
+ additional_config = self._additional_configs[index]
748
+ if not additional_config.can_build_class(class_to_build):
749
+ continue
750
+
751
+ built_value = additional_config.build_class(class_to_build, argument_name, self, context=context)
752
+ can_cache = additional_config.can_cache_class(class_to_build, self, context)
753
+ break
754
+
755
+ # a small handful of predefined classes
756
+ if class_to_build in self._predefined_classes_name_map:
757
+ dependency_name = self._predefined_classes_name_map[class_to_build]
758
+ built_value = self.call_function(getattr(self, f"provide_{dependency_name}"))
759
+ can_cache = self.can_cache(dependency_name, context if context else "")
760
+
761
+ # finally, if we found something, cache and/or return it
762
+ if built_value is not None:
763
+ if cache and can_cache:
764
+ self._prepared[class_to_build] = built_value # type: ignore
765
+ return built_value
766
+
767
+ # last but not least we build the class itself as long as it has been imported into the Di system
768
+ if class_to_build in self._classes:
769
+ return self.build_class(class_to_build, context=context, cache=cache)
770
+
771
+ return None
772
+
773
+ def call_function(self, callable_to_execute: Callable, **kwargs):
774
+ """
775
+ Call a function, building any positional arguments and providing them.
776
+
777
+ Any kwargs passed to call_function will populate the equivalent dependencies.
778
+
779
+ ```python
780
+ from clearskies.di import Di
781
+
782
+ di = Di(bindings={"some_name": "hello"})
783
+
784
+
785
+ def my_function(some_name, some_other_name):
786
+ print(f"{some_name} {some_other_value}") # prints 'hello world'
787
+
788
+
789
+ di.call_function(my_function, some_other_value="world")
790
+ ```
791
+ """
792
+ args_data = inspect.getfullargspec(callable_to_execute)
793
+
794
+ # we need to decide if we've been passed a bound method, because then we need to ignore the
795
+ # first argument (aka `self`). The simplest way to do this is to check for the `__self__` attr,
796
+ # but this will be fooled by methods with decorators. There doesn't seem to be a good solution to this
797
+ # that works in all cases: https://stackoverflow.com/a/50074581/1921979
798
+ call_arguments = args_data.args
799
+ if hasattr(callable_to_execute, "__self__"):
800
+ call_arguments = call_arguments[1:]
801
+
802
+ # separate out args and kwargs. kwargs for the function are only allowed to come out of the kwargs
803
+ # we were passed. If the function has a kwarg that we don't have, then ignore it.
804
+ # args come out of dependencies or the kwargs passed to us. If an arg is missing, then throw an error.
805
+ nargs = len(call_arguments)
806
+ nkwargs = len(args_data.defaults) if args_data.defaults else 0
807
+ arg_names = call_arguments[: nargs - nkwargs]
808
+ kwarg_names = call_arguments[nargs - nkwargs :]
809
+
810
+ callable_args = [
811
+ (
812
+ kwargs[arg]
813
+ if arg in kwargs
814
+ else self.build_argument(
815
+ arg, args_data.annotations.get(arg, None), context=callable_to_execute.__name__, cache=True
816
+ )
817
+ )
818
+ for arg in arg_names
819
+ ]
820
+ callable_kwargs = {}
821
+ for kwarg_name in kwarg_names:
822
+ if kwarg_name not in kwargs:
823
+ continue
824
+ callable_kwargs[kwarg_name] = kwargs[kwarg_name]
825
+
826
+ return callable_to_execute(*callable_args, **callable_kwargs)
827
+
828
+ def _disallow_kwargs(self, action):
829
+ """
830
+ Raise an exception.
831
+
832
+ This is used to raise an exception and stop building a class if its constructor accepts kwargs. To be clear,
833
+ we actually can support kwargs - it just doesn't make much sense. The issue is that keywords are
834
+ optional, so a dependency injection framework doesn't know what to do with them. Ignore them? Provide them?
835
+ The behavior is unclear, and therefore, bug prone.
836
+
837
+ If you need to create a class that accepts kwargs in its constructor you can do that though - just override
838
+ this method in your DI class and don't raise an exception. If you do that, everything will still work but
839
+ nothing will be provided for your kwargs.
840
+
841
+ Another option would be to do a self.build_from_name on the kwargs names, but only provide the kwarg
842
+ if the name is something that the DI container can actually provide (and otherwise just let it fall back
843
+ on the default). However, I'm not convinced that will be a helpful use case, so I'm not implementing
844
+ it right now.
845
+ """
846
+ raise ValueError(f"Cannot {action} because it has keyword arguments.")
847
+
848
+ def can_cache(self, name: str, context: str) -> bool:
849
+ """Control whether or not to cache a value built by the DI container."""
850
+ if name == "now" or name == "utcnow":
851
+ return False
852
+ return True
853
+
854
+ def inject_properties(self, cls):
855
+ if hasattr(cls, "injectable_properties"):
856
+ cls.injectable_properties(self)
857
+ return
858
+
859
+ if not hasattr(cls, "__injectable_properties_sanity_check"):
860
+ return
861
+
862
+ for attribute_name in dir(cls):
863
+ attribute = getattr(cls, attribute_name)
864
+ if hasattr(attribute, "initiated_guard") and hasattr(attribute, "set_di"):
865
+ raise ValueError(
866
+ f"Class '{cls.__name__}' has an injectable property attached, but does not include clearskies.di.injectable_properties.InjectableProperties in it's parent classes. You must include this as a parent class."
867
+ )
868
+ cls.__injectable_properties_sanity_check = True
869
+ return
870
+
871
+ def provide_di(self):
872
+ return self
873
+
874
+ def provide_requests(self):
875
+ retry_strategy = Retry(
876
+ total=3,
877
+ status_forcelist=[429, 500, 502, 503, 504],
878
+ backoff_factor=1,
879
+ allowed_methods=["GET", "POST", "DELETE", "OPTIONS", "PATCH"],
880
+ )
881
+ adapter = HTTPAdapter(max_retries=retry_strategy)
882
+ session = requests.Session()
883
+ session.mount("https://", adapter)
884
+ session.mount("http://", adapter)
885
+ return session
886
+
887
+ def provide_sys(self):
888
+ import sys
889
+
890
+ return sys
891
+
892
+ def provide_environment(self):
893
+ return Environment(os.getcwd() + "/.env", os.environ, {})
894
+
895
+ def provide_grahpql_client(self):
896
+ from clearskies.clients import GraphQLClient
897
+
898
+ return GraphQLClient()
899
+
900
+ def provide_cursor(self):
901
+ from clearskies.cursors.from_environment import MySql
902
+
903
+ return MySql()
904
+
905
+ def provide_now(self):
906
+ return datetime.datetime.now() if self._now is None else self._now
907
+
908
+ def provide_utcnow(self):
909
+ return datetime.datetime.now(datetime.timezone.utc) if self._utcnow is None else self._utcnow
910
+
911
+ def provide_input_output(self):
912
+ raise AttributeError(
913
+ "The dependency injector requested an InputOutput but none has been configured. Alternatively, if you directly called `di.build('input_output')` then try again with `di.build('input_output', cache=True)`"
914
+ )
915
+
916
+ def provide_oai3_schema_resolver(self):
917
+ from clearskies import autodoc
918
+
919
+ return autodoc.formats.oai3_json.OAI3SchemaResolver()
920
+
921
+ def provide_uuid(self):
922
+ import uuid
923
+
924
+ return uuid
925
+
926
+ def provide_secrets(self):
927
+ import clearskies.secrets
928
+
929
+ return clearskies.secrets.Secrets()
930
+
931
+ def provide_memory_backend_default_data(self):
932
+ return []
933
+
934
+ def provide_global_table_prefix(self):
935
+ return ""
936
+
937
+ def provide_akeyless_sdk(self):
938
+ import akeyless # type: ignore[import-untyped]
939
+
940
+ return akeyless
941
+
942
+ def provide_endpoint_groups(self):
943
+ return []
944
+
945
+ def provide_logger(self):
946
+ import logging
947
+
948
+ return logging.getLogger()