Number models

django_rubble.models.number_models.NumberedModel

Bases: Model

Adds a number field that uses DocumentNumber to generate values.

Adds a natural_key method to the model, but no manager that uses it.

Example:

class Invoice(NumberedModel):
    number_config = SerialNumberConfig(
            prefix="INV",
            width=4,
            initial_value=1,
            step=1
        )

Attributes:

Name	Type	Description
number_config	SerialNumberConfig	A SerialNumberConfig instance.

Source code in django_rubble\models\number_models.py

class NumberedModel(models.Model):
    """Adds a `number` field that uses `DocumentNumber` to generate values.

    Adds a `natural_key` method to the model, but no manager that uses it.

    Example:

        class Invoice(NumberedModel):
            number_config = SerialNumberConfig(
                    prefix="INV",
                    width=4,
                    initial_value=1,
                    step=1
                )

    Attributes:
        number_config: A SerialNumberConfig instance.
    """

    number = models.CharField(_("number"), unique=True, max_length=10, editable=False)
    number_config: SerialNumberConfig

    class Meta:
        abstract = True

    def save(self, *args, **kwargs) -> None:
        if self._state.adding:
            self.number, _ = NamedSerialNumber.objects.get_serial_number(self)
            msg = f"New number is: {self.number}"
            logger.debug(msg)
        return super().save(*args, **kwargs)

    def natural_key(self):
        return (self.number,)

    @classmethod
    def check(cls, **kwargs):
        errors = super().check(**kwargs)
        errors.extend(cls._check_number_config(**kwargs))
        return errors

    @classmethod
    def _check_number_config(cls, **kwargs):
        if not hasattr(cls, "number_config"):
            return must_be(
                "a SerialNumberConfig instance",
                option="number_config",
                obj=cls,
                error_id="rubble.M003",
            )
        if not isinstance(cls.number_config, SerialNumberConfig):
            return must_be(
                "a SerialNumberConfig instance",
                option="number_config",
                obj=cls,
                error_id="rubble.M003",
            )
        return []

django_rubble.models.number_models.SerialNumberConfig

Bases: BaseModel

Configuration for NumberModel numbering.

Example

SerialNumberConfig(prefix="INV", width=4, initial_value=1, step=1) -> INV0001, INV0002, etc.

Attributes:

Name	Type	Description
name	str | None	The name of the model, used for NamedSerialNumber.
initial_value	int	The starting value for the serial number.
step	int	The increment value for the serial number.
prefix	str	The prefix for the serial number.

Source code in django_rubble\models\number_models.py

class SerialNumberConfig(BaseModel):
    """Configuration for NumberModel numbering.

    Example:
        `SerialNumberConfig(prefix="INV", width=4, initial_value=1, step=1)` ->
        `INV0001`, `INV0002`, etc.

    Attributes:
        name: The name of the model, used for NamedSerialNumber.
        initial_value: The starting value for the serial number.
        step: The increment value for the serial number.
        prefix: The prefix for the serial number."""

    name: str | None = None
    initial_value: int = 1
    step: int = 1
    prefix: str
    width: int