update PythonSettings model definitions and annotations

openbb_platform/core/openbb_core/app/model/python_settings.py

@@ -17,6 +17,55 @@ class PythonSettings(BaseModel):
     docstring_max_length: Optional[PositiveInt] = Field(
         default=None, description="Maximum length of autogenerated docstrings."
     )
+    http: Optional[dict] = Field(
+        default_factory=dict,
+        description="HTTP settings covers all requests made by the internal, utility, functions."
+        + " The configuration applies to both the requests and aiohttp libraries."
+        + "\n    "
+        + """Available settings:
+            - cafile: str - Path to a CA certificate file.
+            - certfile: str - Path to a client certificate file.
+            - keyfile: str - Path to a client key file.
+            - password: str - Password for the client key file.  # aiohttp only
+            - verify_ssl: bool - Verify SSL certificates.
+            - fingerprint: str - SSL fingerprint.  # aiohttp only
+            - proxy: str - Proxy URL.
+            - proxy_auth: str | list - Proxy authentication.  # aiohttp only
+            - proxy_headers: dict - Proxy headers.  # aiohttp only
+            - timeout: int - Request timeout.
+            - auth: str | list - Basic authentication.
+            - headers: dict - Request headers.
+            - cookies: dict - Dictionary of session cookies.
+
+        Any additional keys supplied will be ignored unless explicitly implemented via custom code.
+
+        The settings are passed into the `requests.Session` object and the `aiohttp.ClientSession` object by:
+            - `openbb_core.provider.utils.helpers.make_request` - Sync
+            - `openbb_core.provider.utils.helpers.amake_request` - Async
+            - `openbb_core.provider.utils.helpers.amake_requests` - Async (multiple requests)
+            - Inserted to use with YFinance & Finviz library implementations.
+
+        Return a session object with the settings applied by:
+            - `openbb_core.provider.utils.helpers.get_requests_session`
+            - `openbb_core.provider.utils.helpers.get_async_requests_session`
+        """,
+    )
+    uvicorn: Optional[dict] = Field(
+        default_factory=dict,
+        description="Uvicorn settings, covers all the launch of FastAPI when using the following entry points:"
+        + "\n    "
+        + """
+            - Running the FastAPI as a Python module script.
+              - python -m openbb_core.api.rest_api
+            - Running the `openbb-api` command.
+                - openbb-api
+
+        All settings are passed directly to `uvicorn.run`, and can be found in the Uvicorn documentation.
+            - https://www.uvicorn.org/settings/
+
+        Keyword arguments supplied to the command line will take priority over the settings in this configuration.
+        """,
+    )
 
     def __repr__(self) -> str:
         """Return a string representation of the model."""