Source code for mimesis.providers.transport

"""Provides data related to transports."""

from mimesis.datasets import (
    AIRPLANES,
    AUTO_MANUFACTURERS,
    CARS,
    VR_CODES,
    VRC_BY_LOCALES,
)
from mimesis.locales import Locale
from mimesis.providers.base import BaseProvider

__all__ = ["Transport"]




[docs]
class Transport(BaseProvider):
    """Class for generating data related to transports."""

    class Meta:
        name = "transport"



[docs]
    def manufacturer(self) -> str:
        """Generates a random car manufacturer.

        :return: A car manufacturer

        :Example:
            Tesla.
        """
        return self.random.choice(AUTO_MANUFACTURERS)





[docs]
    def car(self) -> str:
        """Generates a random vehicle name.

        :return: A vehicle.

        :Example:
            Tesla Model S.
        """
        return self.random.choice(CARS)





[docs]
    def airplane(self) -> str:
        """Generates a random airplane model name.

        :return: Airplane model.

        :Example:
            Boeing 727.
        """
        return self.random.choice(AIRPLANES)





[docs]
    def vehicle_registration_code(self, locale: Locale | None = None) -> str:
        """Returns vehicle registration code.

        :param locale: Registration code for locale (country).
        :return: Vehicle registration code.
        """
        if locale:
            return VRC_BY_LOCALES[locale.value]

        return self.random.choice(VR_CODES)