Source code for mimesis.providers.generic

"""Provides all at one."""

import inspect
from typing import Any, Final, List, Type

from mimesis.locales import Locale
from mimesis.providers.address import Address
from mimesis.providers.base import BaseDataProvider, BaseProvider
from mimesis.providers.binaryfile import BinaryFile
from mimesis.providers.choice import Choice
from mimesis.providers.code import Code
from mimesis.providers.cryptographic import Cryptographic
from import Datetime
from mimesis.providers.development import Development
from mimesis.providers.file import File
from import Finance
from import Food
from mimesis.providers.hardware import Hardware
from mimesis.providers.internet import Internet
from mimesis.providers.numeric import Numeric
from mimesis.providers.path import Path
from mimesis.providers.payment import Payment
from mimesis.providers.person import Person
from import Science
from mimesis.providers.text import Text
from mimesis.providers.transport import Transport
from mimesis.types import Seed

__all__ = ["Generic"]

[docs]class Generic(BaseProvider): """Class which contain all providers at one.""" _DEFAULT_PROVIDERS = ( Address, BinaryFile, Finance, Choice, Code, Choice, Datetime, Development, File, Food, Hardware, Internet, Numeric, Path, Payment, Person, Science, Text, Transport, Cryptographic, )
[docs] def __init__(self, locale: Locale = Locale.DEFAULT, seed: Seed = None) -> None: """Initialize attributes lazily.""" super().__init__(seed=seed) self.locale = locale for provider in self._DEFAULT_PROVIDERS: name = getattr(provider.Meta, "name") # type: ignore # Check if a provider is locale-dependent. if issubclass(provider, BaseDataProvider): setattr(self, f"_{name}", provider) elif issubclass(provider, BaseProvider): setattr(self, name, provider(seed=self.seed))
[docs] class Meta: """Class for metadata.""" name: Final[str] = "generic"
def __getattr__(self, attrname: str) -> Any: """Get attribute without underscore. :param attrname: Attribute name. :return: An attribute. """ attribute = object.__getattribute__(self, "_" + attrname) if attribute and callable(attribute): self.__dict__[attrname] = attribute( self.locale, self.seed, ) return self.__dict__[attrname] def __dir__(self) -> List[str]: """Available data providers. The list of result will be used in AbstractField to determine method's class. :return: List of attributes. """ attributes = [] exclude = BaseProvider().__dict__.keys() for a in self.__dict__: if a not in exclude: if a.startswith("_"): attribute = a.replace("_", "", 1) attributes.append(attribute) else: attributes.append(a) return attributes
[docs] def reseed(self, seed: Seed = None) -> None: """Reseed the internal random generator. Overrides method `BaseProvider.reseed()`. :param seed: Seed for random. """ # Ensure that we reseed the random generator on Generic itself. super().reseed(seed) for attr in self.__dir__(): try: provider = getattr(self, attr) provider.reseed(seed) except AttributeError: continue
[docs] def add_provider(self, cls: Type[BaseProvider], **kwargs: Any) -> None: """Add a custom provider to Generic() object. :param cls: Custom provider. :return: None :raises TypeError: if cls is not class or is not a subclass of BaseProvider. """ if inspect.isclass(cls): if not issubclass(cls, BaseProvider): raise TypeError( "The provider must be a " "subclass of mimesis.providers.BaseProvider" ) try: name = # type: ignore except AttributeError: name = cls.__name__.lower() if "seed" in kwargs: kwargs.pop("seed") setattr(self, name, cls(seed=self.seed, **kwargs)) else: raise TypeError("The provider must be a class")
[docs] def add_providers(self, *providers: Type[BaseProvider]) -> None: """Add a lot of custom providers to Generic() object. :param providers: Custom providers. :return: None """ for provider in providers: self.add_provider(provider)
def __str__(self) -> str: """Human-readable representation of locale.""" return f"{self.__class__.__name__} <{self.locale}>"