config

App Configurations.

get_api_host()

Get API server’s host address.

Return type

str

get_api_port()

Get API server’s host port.

Return type

int

get_api_url()

Get API server’s full url.

Return type

str

get_db_connect_args()

Get db connection arguments for SQLAlchemy’s engine creation.

Example

For SQLite dbs, it could be:

{'check_same_thread': False}
Return type

dict[str, Any]

get_db_poolclass()

Get db poolclass arguemnt for SQLAlchemy’s engine creation.

Return type

Optional[Pool]

Returns

A pool class

get_db_url()

Get API server’s db uri.

The url format should conform the SQLAlchemy’s url scheme.

Return type

str