IntRField

Resource field for storing integer values.

IntRField stores integer values with automatic validation and configurable storage. By default, integers are stored in the DATABASE for efficient querying and indexing.

This is useful for: - Counts, indices, and identifiers - Numeric metadata (age, quantity, version) - Flags represented as integers - Small numeric values that need to be searchable

Storage behavior: - Stored in DATABASE by default (searchable and queryable) - Included in dict views by default - Automatically validated as integer on load/save

Example: ```python class MyResource(Resource): # Simple counter count = IntRField()

    # With default value
    version = IntRField(default_value=1)

    # Stored in KV_STORE instead
    large_id = IntRField(storage=RFieldStorage.KV_STORE)

    # Not included in dict view
    internal_flag = IntRField(include_in_dict_view=False)
```

Attributes

include_in_dict_view: boolstorage: RFieldStoragevalidator: Validator

Functions

__init__

Initialize an IntRField for storing integer values.

default_value : int | None

Default integer value. Can be: - int: A specific integer value - Type or Callable: Called to generate default (e.g., int for 0) - None: Field has no default value Defaults to None

include_in_dict_view : bool - True

If True, included in dict/JSON representations. Defaults to True for primitive fields

storage : RFieldStorage - RFieldStorage.DATABASE

Storage backend (DATABASE for searchable, KV_STORE for simple storage, NONE for transient). Defaults to DATABASE for integers

deserialize

Deserialize and validate a value from storage.

Validates the stored value using the field's validator before returning it.

r_field_value : Any

The raw value from storage

Return type : Any

get_default_value

Get the default value for this field.

If the default value is a Type or Callable, it will be called to generate a new default value. Otherwise, the default value is returned directly.

This ensures that mutable defaults (like lists or dicts) are not shared between Resource instances.

Return type : Any

serialize

Serialize and validate a value for storage.

Validates the value using the field's validator before storing it.

r_field_value : Any

The runtime value to serialize

Return type : Any

Have you developed a brick?