minrecord.config

minrecord.config

Contain functionalities to configure the records.

minrecord.config.Config

Config class to configure the records.

Example

>>> from minrecord.config import Config
>>> c = Config()
>>> c.get_max_size()
10
>>> c.set_max_size(5)
>>> c.get_max_size()
5

minrecord.config.Config.get_max_size

get_max_size() -> int

Get the current default maximum size of values to track in each record.

Returns:

Type	Description
int	The current default maximum size of values to track in each record.

Example

>>> from minrecord.config import Config
>>> c = Config()
>>> c.get_max_size()
10

minrecord.config.Config.reset_max_size

reset_max_size() -> None

Reset max_size to its default value.

Example

>>> from minrecord.config import Config
>>> c = Config()
>>> c.set_max_size(5)
>>> c.get_max_size()
5
>>> c.reset_max_size()
>>> c.get_max_size()
10

minrecord.config.Config.set_max_size

set_max_size(max_size: int) -> None

Set the default maximum size of values to track in each record.

This function does not change the maximum size of records that are already created. It only changes the maximum size of records that will be created after the call of this function.

Parameters:

Name	Type	Description	Default
max_size	int	The new default maximum size of values to track in each record. Must be a positive integer.	required

Raises:

Type	Description
ValueError	If max_size is not a positive integer.

Example

>>> from minrecord.config import Config
>>> c = Config()
>>> c.get_max_size()
10
>>> c.set_max_size(5)
>>> c.get_max_size()
5

minrecord.config.get_default_config

get_default_config() -> Config

Get the default global config instance.

This function uses a singleton pattern to ensure the same config instance is returned on all calls. The config is created lazily on the first call and cached for subsequent calls.

Returns:

Type	Description
Config	The singleton Config instance.

Note

Since this returns a singleton, modifications to the config will persist across all calls and affect the entire application. To use an isolated config, create a new Config instance directly with Config().

Example

>>> from minrecord.config import get_default_config
>>> c1 = get_default_config()
>>> c1.get_max_size()
10
>>> c1.set_max_size(5)
>>> # The change persists across calls
>>> c2 = get_default_config()
>>> c2.get_max_size()
5
>>> c1 is c2  # Same instance
True
>>> c1.reset_max_size()

minrecord.config.get_max_size

get_max_size() -> int

Get the current default maximum size of values to track in each record.

Returns:

Type	Description
int	The current default maximum size of values to track in each record.

This value can be changed by using set_max_size.

Example

>>> from minrecord.config import get_max_size
>>> get_max_size()
10

minrecord.config.reset_max_size

reset_max_size() -> None

Reset maximum size to its default value.

Example

>>> from minrecord.config import get_max_size, set_max_size, reset_max_size
>>> set_max_size(5)
>>> get_max_size()
5
>>> reset_max_size()
>>> get_max_size()
10

minrecord.config.set_max_size

set_max_size(max_size: int) -> None

Set the default maximum size of values to track in each record.

This function does not change the maximum size of records that are already created. It only changes the maximum size of records that will be created after the call of this function.

Parameters:

Name	Type	Description	Default
max_size	int	The new default maximum size of values to track in each record.	required

Example

>>> from minrecord.config import get_max_size, set_max_size
>>> get_max_size()
10
>>> set_max_size(5)
>>> get_max_size()
5