faker.providers.color

class faker.providers.color.Provider(generator)

Bases: faker.providers.BaseProvider

Implement default color provider for Faker.

color(hue=None, luminosity=None, color_format='hex')

Generate a color in a human-friendly way.

Under the hood, this method first creates a color represented in the HSV color model and then converts it to the desired color_format. The argument hue controls the H value according to the following rules:

  • If the value is a number from 0 to 360, it will serve as the H value of the generated color.
  • If the value is a tuple/list of 2 numbers from 0 to 360, the color’s H value will be randomly selected from that range.
  • If the value is a valid string, the color’s H value will be randomly selected from the H range corresponding to the supplied string. Valid values are 'monochrome', 'red', 'orange', 'yellow', 'green', 'blue', 'purple', and 'pink'.

The argument luminosity influences both S and V values and is partially affected by hue as well. The finer details of this relationship are somewhat involved, so please refer to the source code instead if you wish to dig deeper. To keep the interface simple, this argument either can be omitted or can accept the following string values:'bright', 'dark', 'light', or 'random'.

The argument color_format controls in which color model the color is represented. Valid values are 'hsv', 'hsl', 'rgb', or 'hex' (default).

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.color(hue='red')
...
'#af2f33'
'#e02141'
'#ef6466'
'#a80a14'
'#ed9e95'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.color(luminosity='light')
...
'#79c3e0'
'#89ffa1'
'#96cbf7'
'#aafaff'
'#e3f495'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.color(hue=(100, 200), color_format='rgb')
...
'rgb(26, 155, 88)'
'rgb(9, 193, 49)'
'rgb(73, 229, 154)'
'rgb(107, 249, 166)'
'rgb(76, 204, 69)'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.color(hue='orange', luminosity='bright')
...
'#efc332'
'#edae65'
'#d1861d'
'#ffcc42'
'#e09533'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.color(hue=135, luminosity='dark', color_format='hsv')
...
'hsv(135, 96, 45)'
'hsv(135, 98, 57)'
'hsv(135, 94, 61)'
'hsv(135, 99, 47)'
'hsv(135, 94, 50)'
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.color(hue=(300, 20), luminosity='random', color_format='hsl')
...
'hsl(217, 94, 27)'
'hsl(40, 23, 54)'
'hsl(268, 100, 74)'
'hsl(175, 43, 31)'
'hsl(131, 47, 11)'
color_name()

Generate a color name.

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.color_name()
...
'SandyBrown'
'PapayaWhip'
'Khaki'
'DarkTurquoise'
'LightSeaGreen'
hex_color()

Generate a color formatted as a hex triplet.

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.hex_color()
...
'#d82c08'
'#629f70'
'#c2094d'
'#e3e707'
'#6baa95'
rgb_color()

Generate a color formatted as a comma-separated RGB value.

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.rgb_color()
...
'197,215,20'
'132,248,207'
'155,244,183'
'111,71,144'
'71,48,128'
rgb_css_color()

Generate a color formatted as a CSS rgb() function.

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.rgb_css_color()
...
'rgb(197,215,20)'
'rgb(132,248,207)'
'rgb(155,244,183)'
'rgb(111,71,144)'
'rgb(71,48,128)'
safe_color_name()

Generate a web-safe color name.

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.safe_color_name()
...
'fuchsia'
'yellow'
'teal'
'navy'
'lime'
safe_hex_color()

Generate a web-safe color formatted as a hex triplet.

Examples:
>>> Faker.seed(0)
>>> for _ in range(5):
...     fake.safe_hex_color()
...
'#cc5500'
'#dd7700'
'#114400'
'#884400'
'#ff8800'