Source code for mimesis.providers.text

"""Provides data related to text."""

import typing as t

from import SAFE_COLORS
from mimesis.providers.base import BaseDataProvider

__all__ = ["Text"]

[docs]class Text(BaseDataProvider): """Class for generating text data.""" class Meta: name = "text" datafile = f"{name}.json"
[docs] def alphabet(self, lower_case: bool = False) -> t.List[str]: """Get an alphabet for current locale. :param lower_case: Return alphabet in lower case. :return: Alphabet. """ case = "uppercase" if not lower_case else "lowercase" alpha: t.List[str] = self.extract(["alphabet", case]) return alpha
[docs] def level(self) -> str: """Generate a random level of danger or something else. :return: Level. :Example: critical. """ levels: t.List[str] = self.extract(["level"]) return self.random.choice(levels)
[docs] def text(self, quantity: int = 5) -> str: """Generate the text. :param quantity: Quantity of sentences. :return: Text. """ text = self.extract(["text"]) return " ".join(self.random.choices(text, k=quantity))
[docs] def sentence(self) -> str: """Get a random sentence from text. :return: Sentence. """ return self.text(quantity=1)
[docs] def title(self) -> str: """Get a random title. :return: The title. """ return self.text(quantity=1)
[docs] def words(self, quantity: int = 5) -> t.List[str]: """Generate a list of random words. :param quantity: Quantity of words. Default is 5. :return: Word list. :Example: [science, network, god, octopus, love] """ words = self.extract(["words"]) return self.random.choices(words, k=quantity)
[docs] def word(self) -> str: """Get a random word. :return: Single word. :Example: Science. """ return self.words(quantity=1)[0]
[docs] def quote(self) -> str: """Get a random quote. :return: Quote from movie. :Example: "Bond... James Bond." """ quotes: t.List[str] = self.extract(["quotes"]) return self.random.choice(quotes)
[docs] def color(self) -> str: """Get a random name of color. :return: Color name. :Example: Red. """ colors: t.List[str] = self.extract(["color"]) return self.random.choice(colors)
@staticmethod def _hex_to_rgb(color: str) -> t.Tuple[int, ...]: """Convert hex color to RGB format. :param color: Hex color. :return: RGB tuple. """ color = color.lstrip("#") if color.startswith("#") else color return tuple(int(color[i : i + 2], 16) for i in (0, 2, 4))
[docs] def hex_color(self, safe: bool = False) -> str: """Generate a random hex color. :param safe: Get safe Flat UI hex color. :return: Hex color code. :Example: #d8346b """ if safe: return self.random.choice(SAFE_COLORS) return f"#{self.random.randint(0x000000, 0xFFFFFF):06x}"
[docs] def rgb_color(self, safe: bool = False) -> t.Tuple[int, ...]: """Generate a random rgb color tuple. :param safe: Get safe RGB tuple. :return: RGB tuple. :Example: (252, 85, 32) """ color = self.hex_color(safe) return self._hex_to_rgb(color)
[docs] def answer(self) -> str: """Get a random answer in current language. :return: An answer. :Example: No """ answers: t.List[str] = self.extract(["answers"]) return self.random.choice(answers)