qianfan.utils package

summary of utils

class qianfan.utils.AsyncLock[source]

Bases: object

wrapper of asyncio.Lock

qianfan.utils.disable_log() → None[source]

Disables logging.

This function turns off the logging feature, preventing the recording of log messages.

Parameters:: None

qianfan.utils.enable_log(log_level: int = 20) → None[source]

Set the logging level for the qianfan sdk.

This function allows you to configure the logging level for the sdk’s logging system. The logging level determines the verbosity of log messages that will be recorded. By default, it is set to ‘WARN’, which logs only important information.

Parameters:

log_level (int, optional):

The logging level to set for the application. It controls the granularity of log messages. You can specify one of the following integer values or str like “INFO”:

logging.CRITICAL (50): Logs only critical messages.
logging.ERROR (40): Logs error and critical messages.
logging.WARNING (30): Logs warnings, errors, and critical messages.
logging.INFO (20): Logs general information, warnings, errors, and critical messages.
logging.DEBUG (10): Logs detailed debugging information, in addition to all the above log levels.

Example Usage: To enable detailed debugging, you can call the function like this: enable_log(logging.DEBUG)

To set the logging level to only log errors and critical messages, use: enable_log(“ERROR”)

qianfan.utils.log_debug(message: object, *args: object, **params: Any) → None

DEBUG level log

Args:: message (object): message content
Returns:: None

qianfan.utils.log_error(message: object, *args: object, **params: Any) → None

ERROR level log

Args:: message (object): message content
Returns:: None

qianfan.utils.log_info(message: object, *args: object, **params: Any) → None

INFO level log

Args:: message (object): message content
Returns:: None

qianfan.utils.log_warn(message: object, *args: object, **params: Any) → None

WARN level log

Args:: message (object): message content
Returns:: None

Submodules

qianfan.utils.bos_uploader module

utility for uploading content to bos

qianfan.utils.bos_uploader.generate_bos_file_path(bucket_name: str, absolute_path: str) → str[source]

qianfan.utils.bos_uploader.upload_content_to_bos(data: str, remote_file_path: str, bucket_name: str, region: str, ak: str, sk: str) → None[source]

qianfan.utils.helper module

helper class

class qianfan.utils.helper.Singleton[source]

Bases: type

Singleton metaclass

qianfan.utils.logging module

utils for logging

class qianfan.utils.logging.Logger(name: str = 'qianfan', format: str = '[%(levelname)s] [%(asctime)s] %(filename)s:%(lineno)d [t:%(thread)d]: %(message)s', datefmt: str = '%m-%d %H:%M:%S')[source]

Bases: object

debug(message: object, *args: object, **params: Any) → None[source]

DEBUG level log

Args:: message (object): message content
Returns:: None

error(message: object, *args: object, **params: Any) → None[source]

ERROR level log

Args:: message (object): message content
Returns:: None

info(message: object, *args: object, **params: Any) → None[source]

INFO level log

Args:: message (object): message content
Returns:: None

warn(message: object, *args: object, **params: Any) → None[source]

WARN level log

Args:: message (object): message content
Returns:: None

qianfan.utils.logging.disable_log() → None[source]

Disables logging.

This function turns off the logging feature, preventing the recording of log messages.

Parameters:: None

qianfan.utils.logging.enable_log(log_level: int = 20) → None[source]

Set the logging level for the qianfan sdk.

This function allows you to configure the logging level for the sdk’s logging system. The logging level determines the verbosity of log messages that will be recorded. By default, it is set to ‘WARN’, which logs only important information.

Parameters:

log_level (int, optional):

The logging level to set for the application. It controls the granularity of log messages. You can specify one of the following integer values or str like “INFO”:

logging.CRITICAL (50): Logs only critical messages.
logging.ERROR (40): Logs error and critical messages.
logging.WARNING (30): Logs warnings, errors, and critical messages.
logging.INFO (20): Logs general information, warnings, errors, and critical messages.
logging.DEBUG (10): Logs detailed debugging information, in addition to all the above log levels.

Example Usage: To enable detailed debugging, you can call the function like this: enable_log(logging.DEBUG)

To set the logging level to only log errors and critical messages, use: enable_log(“ERROR”)

qianfan.utils.logging.log_debug(message: object, *args: object, **params: Any) → None

DEBUG level log

Args:: message (object): message content
Returns:: None

qianfan.utils.logging.log_error(message: object, *args: object, **params: Any) → None

ERROR level log

Args:: message (object): message content
Returns:: None

qianfan.utils.logging.log_info(message: object, *args: object, **params: Any) → None

INFO level log

Args:: message (object): message content
Returns:: None

qianfan.utils.logging.log_warn(message: object, *args: object, **params: Any) → None

WARN level log

Args:: message (object): message content
Returns:: None

qianfan.utils.utils module

class qianfan.utils.utils.AsyncLock[source]

Bases: object

wrapper of asyncio.Lock

qianfan.utils.utils.generate_letter_num_random_id(len: int = 10) → str[source]

qianfan.utils.utils.uuid() → str[source]