/usr/lib/python3/dist-packages/colour.py is in python3-colour 0.1.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 | # -*- coding: utf-8 -*-
"""Color Library
.. :doctest:
This module defines several color formats that can be converted to one or
another.
Formats
-------
HSL:
3-uple of Hue, Saturation, Lightness all between 0.0 and 1.0
RGB:
3-uple of Red, Green, Blue all between 0.0 and 1.0
HEX:
string object beginning with '#' and with red, green, blue value.
This format accept color in 3 or 6 value ex: '#fff' or '#ffffff'
WEB:
string object that defaults to HEX representation or human if possible
Usage
-----
Several function exists to convert from one format to another. But all
function are not written. So the best way is to use the object Color.
Please see the documentation of this object for more information.
.. note:: Some constants are defined for convenience in HSL, RGB, HEX
"""
from __future__ import with_statement, print_function
import hashlib
import re
import sys
##
## Some Constants
##
## Soften inequalities and some rounding issue based on float
FLOAT_ERROR = 0.0000005
RGB_TO_COLOR_NAMES = {
(0, 0, 0): ['Black'],
(0, 0, 128): ['Navy', 'NavyBlue'],
(0, 0, 139): ['DarkBlue'],
(0, 0, 205): ['MediumBlue'],
(0, 0, 255): ['Blue'],
(0, 100, 0): ['DarkGreen'],
(0, 128, 0): ['Green'],
(0, 139, 139): ['DarkCyan'],
(0, 191, 255): ['DeepSkyBlue'],
(0, 206, 209): ['DarkTurquoise'],
(0, 250, 154): ['MediumSpringGreen'],
(0, 255, 0): ['Lime'],
(0, 255, 127): ['SpringGreen'],
(0, 255, 255): ['Cyan', 'Aqua'],
(25, 25, 112): ['MidnightBlue'],
(30, 144, 255): ['DodgerBlue'],
(32, 178, 170): ['LightSeaGreen'],
(34, 139, 34): ['ForestGreen'],
(46, 139, 87): ['SeaGreen'],
(47, 79, 79): ['DarkSlateGray', 'DarkSlateGrey'],
(50, 205, 50): ['LimeGreen'],
(60, 179, 113): ['MediumSeaGreen'],
(64, 224, 208): ['Turquoise'],
(65, 105, 225): ['RoyalBlue'],
(70, 130, 180): ['SteelBlue'],
(72, 61, 139): ['DarkSlateBlue'],
(72, 209, 204): ['MediumTurquoise'],
(75, 0, 130): ['Indigo'],
(85, 107, 47): ['DarkOliveGreen'],
(95, 158, 160): ['CadetBlue'],
(100, 149, 237): ['CornflowerBlue'],
(102, 205, 170): ['MediumAquamarine'],
(105, 105, 105): ['DimGray', 'DimGrey'],
(106, 90, 205): ['SlateBlue'],
(107, 142, 35): ['OliveDrab'],
(112, 128, 144): ['SlateGray', 'SlateGrey'],
(119, 136, 153): ['LightSlateGray', 'LightSlateGrey'],
(123, 104, 238): ['MediumSlateBlue'],
(124, 252, 0): ['LawnGreen'],
(127, 255, 0): ['Chartreuse'],
(127, 255, 212): ['Aquamarine'],
(128, 0, 0): ['Maroon'],
(128, 0, 128): ['Purple'],
(128, 128, 0): ['Olive'],
(128, 128, 128): ['Gray', 'Grey'],
(132, 112, 255): ['LightSlateBlue'],
(135, 206, 235): ['SkyBlue'],
(135, 206, 250): ['LightSkyBlue'],
(138, 43, 226): ['BlueViolet'],
(139, 0, 0): ['DarkRed'],
(139, 0, 139): ['DarkMagenta'],
(139, 69, 19): ['SaddleBrown'],
(143, 188, 143): ['DarkSeaGreen'],
(144, 238, 144): ['LightGreen'],
(147, 112, 219): ['MediumPurple'],
(148, 0, 211): ['DarkViolet'],
(152, 251, 152): ['PaleGreen'],
(153, 50, 204): ['DarkOrchid'],
(154, 205, 50): ['YellowGreen'],
(160, 82, 45): ['Sienna'],
(165, 42, 42): ['Brown'],
(169, 169, 169): ['DarkGray', 'DarkGrey'],
(173, 216, 230): ['LightBlue'],
(173, 255, 47): ['GreenYellow'],
(175, 238, 238): ['PaleTurquoise'],
(176, 196, 222): ['LightSteelBlue'],
(176, 224, 230): ['PowderBlue'],
(178, 34, 34): ['Firebrick'],
(184, 134, 11): ['DarkGoldenrod'],
(186, 85, 211): ['MediumOrchid'],
(188, 143, 143): ['RosyBrown'],
(189, 183, 107): ['DarkKhaki'],
(192, 192, 192): ['Silver'],
(199, 21, 133): ['MediumVioletRed'],
(205, 92, 92): ['IndianRed'],
(205, 133, 63): ['Peru'],
(208, 32, 144): ['VioletRed'],
(210, 105, 30): ['Chocolate'],
(210, 180, 140): ['Tan'],
(211, 211, 211): ['LightGray', 'LightGrey'],
(216, 191, 216): ['Thistle'],
(218, 112, 214): ['Orchid'],
(218, 165, 32): ['Goldenrod'],
(219, 112, 147): ['PaleVioletRed'],
(220, 20, 60): ['Crimson'],
(220, 220, 220): ['Gainsboro'],
(221, 160, 221): ['Plum'],
(222, 184, 135): ['Burlywood'],
(224, 255, 255): ['LightCyan'],
(230, 230, 250): ['Lavender'],
(233, 150, 122): ['DarkSalmon'],
(238, 130, 238): ['Violet'],
(238, 221, 130): ['LightGoldenrod'],
(238, 232, 170): ['PaleGoldenrod'],
(240, 128, 128): ['LightCoral'],
(240, 230, 140): ['Khaki'],
(240, 248, 255): ['AliceBlue'],
(240, 255, 240): ['Honeydew'],
(240, 255, 255): ['Azure'],
(244, 164, 96): ['SandyBrown'],
(245, 222, 179): ['Wheat'],
(245, 245, 220): ['Beige'],
(245, 245, 245): ['WhiteSmoke'],
(245, 255, 250): ['MintCream'],
(248, 248, 255): ['GhostWhite'],
(250, 128, 114): ['Salmon'],
(250, 235, 215): ['AntiqueWhite'],
(250, 240, 230): ['Linen'],
(250, 250, 210): ['LightGoldenrodYellow'],
(253, 245, 230): ['OldLace'],
(255, 0, 0): ['Red'],
(255, 0, 255): ['Magenta', 'Fuchsia'],
(255, 20, 147): ['DeepPink'],
(255, 69, 0): ['OrangeRed'],
(255, 99, 71): ['Tomato'],
(255, 105, 180): ['HotPink'],
(255, 127, 80): ['Coral'],
(255, 140, 0): ['DarkOrange'],
(255, 160, 122): ['LightSalmon'],
(255, 165, 0): ['Orange'],
(255, 182, 193): ['LightPink'],
(255, 192, 203): ['Pink'],
(255, 215, 0): ['Gold'],
(255, 218, 185): ['PeachPuff'],
(255, 222, 173): ['NavajoWhite'],
(255, 228, 181): ['Moccasin'],
(255, 228, 196): ['Bisque'],
(255, 228, 225): ['MistyRose'],
(255, 235, 205): ['BlanchedAlmond'],
(255, 239, 213): ['PapayaWhip'],
(255, 240, 245): ['LavenderBlush'],
(255, 245, 238): ['Seashell'],
(255, 248, 220): ['Cornsilk'],
(255, 250, 205): ['LemonChiffon'],
(255, 250, 240): ['FloralWhite'],
(255, 250, 250): ['Snow'],
(255, 255, 0): ['Yellow'],
(255, 255, 224): ['LightYellow'],
(255, 255, 240): ['Ivory'],
(255, 255, 255): ['White']
}
## Building inverse relation
COLOR_NAME_TO_RGB = dict(
(name.lower(), rgb)
for rgb, names in RGB_TO_COLOR_NAMES.items()
for name in names)
LONG_HEX_COLOR = re.compile(r'^#[0-9a-fA-F]{6}$')
SHORT_HEX_COLOR = re.compile(r'^#[0-9a-fA-F]{3}$')
class C_HSL:
def __getattr__(self, value):
label = value.lower()
if label in COLOR_NAME_TO_RGB:
return rgb2hsl(tuple(v / 255. for v in COLOR_NAME_TO_RGB[label]))
raise AttributeError("%s instance has no attribute %r"
% (self.__class__, value))
HSL = C_HSL()
class C_RGB:
"""RGB colors container
Provides a quick color access.
>>> from colour import RGB
>>> RGB.WHITE
(1.0, 1.0, 1.0)
>>> RGB.BLUE
(0.0, 0.0, 1.0)
>>> RGB.DONOTEXISTS # doctest: +ELLIPSIS
Traceback (most recent call last):
...
AttributeError: ... has no attribute 'DONOTEXISTS'
"""
def __getattr__(self, value):
return hsl2rgb(getattr(HSL, value))
class C_HEX:
"""RGB colors container
Provides a quick color access.
>>> from colour import HEX
>>> HEX.WHITE
'#fff'
>>> HEX.BLUE
'#00f'
>>> HEX.DONOTEXISTS # doctest: +ELLIPSIS
Traceback (most recent call last):
...
AttributeError: ... has no attribute 'DONOTEXISTS'
"""
def __getattr__(self, value):
return rgb2hex(getattr(RGB, value))
RGB = C_RGB()
HEX = C_HEX()
##
## Conversion function
##
def hsl2rgb(hsl):
"""Convert HSL representation towards RGB
:param h: Hue, position around the chromatic circle (h=1 equiv h=0)
:param s: Saturation, color saturation (0=full gray, 1=full color)
:param l: Ligthness, Overhaul lightness (0=full black, 1=full white)
:rtype: 3-uple for RGB values in float between 0 and 1
Hue, Saturation, Range from Lightness is a float between 0 and 1
Note that Hue can be set to any value but as it is a rotation
around the chromatic circle, any value above 1 or below 0 can
be expressed by a value between 0 and 1 (Note that h=0 is equiv
to h=1).
This algorithm came from:
http://www.easyrgb.com/index.php?X=MATH&H=19#text19
Here are some quick notion of HSL to RGB conversion:
>>> from colour import hsl2rgb
With a lightness put at 0, RGB is always rgbblack
>>> hsl2rgb((0.0, 0.0, 0.0))
(0.0, 0.0, 0.0)
>>> hsl2rgb((0.5, 0.0, 0.0))
(0.0, 0.0, 0.0)
>>> hsl2rgb((0.5, 0.5, 0.0))
(0.0, 0.0, 0.0)
Same for lightness put at 1, RGB is always rgbwhite
>>> hsl2rgb((0.0, 0.0, 1.0))
(1.0, 1.0, 1.0)
>>> hsl2rgb((0.5, 0.0, 1.0))
(1.0, 1.0, 1.0)
>>> hsl2rgb((0.5, 0.5, 1.0))
(1.0, 1.0, 1.0)
With saturation put at 0, the RGB should be equal to Lightness:
>>> hsl2rgb((0.0, 0.0, 0.25))
(0.25, 0.25, 0.25)
>>> hsl2rgb((0.5, 0.0, 0.5))
(0.5, 0.5, 0.5)
>>> hsl2rgb((0.5, 0.0, 0.75))
(0.75, 0.75, 0.75)
With saturation put at 1, and lightness put to 0.5, we can find
normal full red, green, blue colors:
>>> hsl2rgb((0 , 1.0, 0.5))
(1.0, 0.0, 0.0)
>>> hsl2rgb((1 , 1.0, 0.5))
(1.0, 0.0, 0.0)
>>> hsl2rgb((1.0/3 , 1.0, 0.5))
(0.0, 1.0, 0.0)
>>> hsl2rgb((2.0/3 , 1.0, 0.5))
(0.0, 0.0, 1.0)
Of course:
>>> hsl2rgb((0.0, 2.0, 0.5)) # doctest: +ELLIPSIS
Traceback (most recent call last):
...
ValueError: Saturation must be between 0 and 1.
And:
>>> hsl2rgb((0.0, 0.0, 1.5)) # doctest: +ELLIPSIS
Traceback (most recent call last):
...
ValueError: Lightness must be between 0 and 1.
"""
h, s, l = [float(v) for v in hsl]
if not (0.0 - FLOAT_ERROR <= s <= 1.0 + FLOAT_ERROR):
raise ValueError("Saturation must be between 0 and 1.")
if not (0.0 - FLOAT_ERROR <= l <= 1.0 + FLOAT_ERROR):
raise ValueError("Lightness must be between 0 and 1.")
if s == 0:
return l, l, l
if l < 0.5:
v2 = l * (1.0 + s)
else:
v2 = (l + s) - (s * l)
v1 = 2.0 * l - v2
r = _hue2rgb(v1, v2, h + (1.0 / 3))
g = _hue2rgb(v1, v2, h)
b = _hue2rgb(v1, v2, h - (1.0 / 3))
return r, g, b
def rgb2hsl(rgb):
"""Convert RGB representation towards HSL
:param r: Red amount (float between 0 and 1)
:param g: Green amount (float between 0 and 1)
:param b: Blue amount (float between 0 and 1)
:rtype: 3-uple for HSL values in float between 0 and 1
This algorithm came from:
http://www.easyrgb.com/index.php?X=MATH&H=19#text19
Here are some quick notion of RGB to HSL conversion:
>>> from colour import rgb2hsl
Note that if red amount is equal to green and blue, then you
should have a gray value (from black to white).
>>> rgb2hsl((1.0, 1.0, 1.0)) # doctest: +ELLIPSIS
(..., 0.0, 1.0)
>>> rgb2hsl((0.5, 0.5, 0.5)) # doctest: +ELLIPSIS
(..., 0.0, 0.5)
>>> rgb2hsl((0.0, 0.0, 0.0)) # doctest: +ELLIPSIS
(..., 0.0, 0.0)
If only one color is different from the others, it defines the
direct Hue:
>>> rgb2hsl((0.5, 0.5, 1.0)) # doctest: +ELLIPSIS
(0.66..., 1.0, 0.75)
>>> rgb2hsl((0.2, 0.1, 0.1)) # doctest: +ELLIPSIS
(0.0, 0.33..., 0.15...)
Having only one value set, you can check that:
>>> rgb2hsl((1.0, 0.0, 0.0))
(0.0, 1.0, 0.5)
>>> rgb2hsl((0.0, 1.0, 0.0)) # doctest: +ELLIPSIS
(0.33..., 1.0, 0.5)
>>> rgb2hsl((0.0, 0.0, 1.0)) # doctest: +ELLIPSIS
(0.66..., 1.0, 0.5)
Regression check upon very close values in every component of
red, green and blue:
>>> rgb2hsl((0.9999999999999999, 1.0, 0.9999999999999994))
(0.0, 0.0, 0.999...)
Of course:
>>> rgb2hsl((0.0, 2.0, 0.5)) # doctest: +ELLIPSIS
Traceback (most recent call last):
...
ValueError: Green must be between 0 and 1. You provided 2.0.
And:
>>> rgb2hsl((0.0, 0.0, 1.5)) # doctest: +ELLIPSIS
Traceback (most recent call last):
...
ValueError: Blue must be between 0 and 1. You provided 1.5.
"""
r, g, b = [float(v) for v in rgb]
for name, v in {'Red': r, 'Green': g, 'Blue': b}.items():
if not (0 - FLOAT_ERROR <= v <= 1 + FLOAT_ERROR):
raise ValueError("%s must be between 0 and 1. You provided %r."
% (name, v))
vmin = min(r, g, b) ## Min. value of RGB
vmax = max(r, g, b) ## Max. value of RGB
diff = vmax - vmin ## Delta RGB value
vsum = vmin + vmax
l = vsum / 2
if diff < FLOAT_ERROR: ## This is a gray, no chroma...
return (0.0, 0.0, l)
##
## Chromatic data...
##
## Saturation
if l < 0.5:
s = diff / vsum
else:
s = diff / (2.0 - vsum)
dr = (((vmax - r) / 6) + (diff / 2)) / diff
dg = (((vmax - g) / 6) + (diff / 2)) / diff
db = (((vmax - b) / 6) + (diff / 2)) / diff
if r == vmax:
h = db - dg
elif g == vmax:
h = (1.0 / 3) + dr - db
elif b == vmax:
h = (2.0 / 3) + dg - dr
if h < 0: h += 1
if h > 1: h -= 1
return (h, s, l)
def _hue2rgb(v1, v2, vH):
"""Private helper function (Do not call directly)
:param vH: rotation around the chromatic circle (between 0..1)
"""
while vH < 0: vH += 1
while vH > 1: vH -= 1
if 6 * vH < 1: return v1 + (v2 - v1) * 6 * vH
if 2 * vH < 1: return v2
if 3 * vH < 2: return v1 + (v2 - v1) * ((2.0 / 3) - vH) * 6
return v1
def rgb2hex(rgb, force_long=False):
"""Transform RGB tuple to hex RGB representation
:param rgb: RGB 3-uple of float between 0 and 1
:rtype: 3 hex char or 6 hex char string representation
Usage
-----
>>> from colour import rgb2hex
>>> rgb2hex((0.0,1.0,0.0))
'#0f0'
Rounding try to be as natural as possible:
>>> rgb2hex((0.0,0.999999,1.0))
'#0ff'
And if not possible, the 6 hex char representation is used:
>>> rgb2hex((0.23,1.0,1.0))
'#3bffff'
>>> rgb2hex((0.0,0.999999,1.0), force_long=True)
'#00ffff'
"""
hx = ''.join(["%02x" % int(c * 255 + 0.5 - FLOAT_ERROR)
for c in rgb])
if not force_long and hx[0::2] == hx[1::2]:
hx = ''.join(hx[0::2])
return "#%s" % hx
def hex2rgb(str_rgb):
"""Transform hex RGB representation to RGB tuple
:param str_rgb: 3 hex char or 6 hex char string representation
:rtype: RGB 3-uple of float between 0 and 1
>>> from colour import hex2rgb
>>> hex2rgb('#00ff00')
(0.0, 1.0, 0.0)
>>> hex2rgb('#0f0')
(0.0, 1.0, 0.0)
>>> hex2rgb('#aaa') # doctest: +ELLIPSIS
(0.66..., 0.66..., 0.66...)
>>> hex2rgb('#aa') # doctest: +ELLIPSIS
Traceback (most recent call last):
...
ValueError: Invalid value '#aa' provided for rgb color.
"""
try:
rgb = str_rgb[1:]
if len(rgb) == 6:
r, g, b = rgb[0:2], rgb[2:4], rgb[4:6]
elif len(rgb) == 3:
r, g, b = rgb[0] * 2, rgb[1] * 2, rgb[2] * 2
else:
raise ValueError()
except:
raise ValueError("Invalid value %r provided for rgb color."
% str_rgb)
return tuple([float(int(v, 16)) / 255 for v in (r, g, b)])
def hex2web(hex):
"""Converts HEX representation to WEB
:param rgb: 3 hex char or 6 hex char string representation
:rtype: web string representation (human readable if possible)
WEB representation uses X11 rgb.txt to define conversion
between RGB and english color names.
Usage
=====
>>> from colour import hex2web
>>> hex2web('#ff0000')
'red'
>>> hex2web('#aaaaaa')
'#aaa'
>>> hex2web('#abc')
'#abc'
>>> hex2web('#acacac')
'#acacac'
"""
dec_rgb = tuple(int(v * 255) for v in hex2rgb(hex))
if dec_rgb in RGB_TO_COLOR_NAMES:
## take the first one
color_name = RGB_TO_COLOR_NAMES[dec_rgb][0]
## Enforce full lowercase for single worded color name.
return color_name if len(re.sub(r"[^A-Z]", "", color_name)) > 1 \
else color_name.lower()
# Hex format is verified by hex2rgb function. And should be 3 or 6 digit
if len(hex) == 7:
if hex[1] == hex[2] and \
hex[3] == hex[4] and \
hex[5] == hex[6]:
return '#' + hex[1] + hex[3] + hex[5]
return hex
def web2hex(web, force_long=False):
"""Converts WEB representation to HEX
:param rgb: web string representation (human readable if possible)
:rtype: 3 hex char or 6 hex char string representation
WEB representation uses X11 rgb.txt to define conversion
between RGB and english color names.
Usage
=====
>>> from colour import web2hex
>>> web2hex('red')
'#f00'
>>> web2hex('#aaa')
'#aaa'
>>> web2hex('#foo') # doctest: +ELLIPSIS
Traceback (most recent call last):
...
AttributeError: '#foo' is not in web format. Need 3 or 6 hex digit.
>>> web2hex('#aaa', force_long=True)
'#aaaaaa'
>>> web2hex('#aaaaaa')
'#aaaaaa'
>>> web2hex('#aaaa') # doctest: +ELLIPSIS
Traceback (most recent call last):
...
AttributeError: '#aaaa' is not in web format. Need 3 or 6 hex digit.
>>> web2hex('pinky') # doctest: +ELLIPSIS
Traceback (most recent call last):
...
ValueError: 'pinky' is not a recognized color.
And color names are case insensitive:
>>> Color('RED')
<Color red>
"""
if web.startswith('#'):
if (LONG_HEX_COLOR.match(web) or
(not force_long and SHORT_HEX_COLOR.match(web))):
return web.lower()
elif SHORT_HEX_COLOR.match(web) and force_long:
return '#' + ''.join([("%s" % (t, )) * 2 for t in web[1:]])
raise AttributeError(
"%r is not in web format. Need 3 or 6 hex digit." % web)
web = web.lower()
if web not in COLOR_NAME_TO_RGB:
raise ValueError("%r is not a recognized color." % web)
## convert dec to hex:
return rgb2hex([float(int(v)) / 255 for v in COLOR_NAME_TO_RGB[web]],
force_long)
## Missing functions conversion
hsl2hex = lambda x: rgb2hex(hsl2rgb(x))
hex2hsl = lambda x: rgb2hsl(hex2rgb(x))
rgb2web = lambda x: hex2web(rgb2hex(x))
web2rgb = lambda x: hex2rgb(web2hex(x))
web2hsl = lambda x: rgb2hsl(web2rgb(x))
hsl2web = lambda x: rgb2web(hsl2rgb(x))
def color_scale(begin_hsl, end_hsl, nb):
"""Returns a list of nb color HSL tuples between begin_hsl and end_hsl
>>> from colour import color_scale
>>> [rgb2hex(hsl2rgb(hsl)) for hsl in color_scale((0, 1, 0.5),
... (1, 1, 0.5), 3)]
['#f00', '#0f0', '#00f', '#f00']
>>> [rgb2hex(hsl2rgb(hsl))
... for hsl in color_scale((0, 0, 0),
... (0, 0, 1),
... 15)] # doctest: +ELLIPSIS
['#000', '#111', '#222', ..., '#ccc', '#ddd', '#eee', '#fff']
Of course, asking for negative values is not supported:
>>> color_scale((0, 1, 0.5), (1, 1, 0.5), -2)
Traceback (most recent call last):
...
ValueError: Unsupported negative number of colors (nb=-2).
"""
if nb < 0:
raise ValueError(
"Unsupported negative number of colors (nb=%r)." % nb)
step = tuple([float(end_hsl[i] - begin_hsl[i]) / nb for i in range(0, 3)]) \
if nb > 0 else (0, 0, 0)
def mul(step, value):
return tuple([v * value for v in step])
def add_v(step, step2):
return tuple([v + step2[i] for i, v in enumerate(step)])
return [add_v(begin_hsl, mul(step, r)) for r in range(0, nb + 1)]
##
## Color Pickers
##
def RGB_color_picker(obj):
"""Build a color representation from the string representation of an object
This allows to quickly get a color from some data, with the
additional benefit that the color will be the same as long as the
(string representation of the) data is the same::
>>> from colour import RGB_color_picker, Color
Same inputs produce the same result::
>>> RGB_color_picker("Something") == RGB_color_picker("Something")
True
... but different inputs produce different colors::
>>> RGB_color_picker("Something") != RGB_color_picker("Something else")
True
In any case, we still get a ``Color`` object::
>>> isinstance(RGB_color_picker("Something"), Color)
True
"""
## Turn the input into a by 3-dividable string. SHA-384 is good because it
## divides into 3 components of the same size, which will be used to
## represent the RGB values of the color.
digest = hashlib.sha384(str(obj).encode('utf-8')).hexdigest()
## Split the digest into 3 sub-strings of equivalent size.
subsize = int(len(digest) / 3)
splitted_digest = [digest[i * subsize: (i + 1) * subsize]
for i in range(3)]
## Convert those hexadecimal sub-strings into integer and scale them down
## to the 0..1 range.
max_value = float(int("f" * subsize, 16))
components = (
int(d, 16) ## Make a number from a list with hex digits
/ max_value ## Scale it down to [0.0, 1.0]
for d in splitted_digest)
return Color(rgb2hex(components)) ## Profit!
def hash_or_str(obj):
try:
return hash((type(obj).__name__, obj))
except TypeError:
## Adds the type name to make sure two object of different type but
## identical string representation get distinguished.
return type(obj).__name__ + str(obj)
##
## All purpose object
##
class Color(object):
"""Abstraction of a color object
Color object keeps information of a color. It can input/output to different
format (HSL, RGB, HEX, WEB) and their partial representation.
>>> from colour import Color, HSL
>>> b = Color()
>>> b.hsl = HSL.BLUE
Access values
-------------
>>> b.hue # doctest: +ELLIPSIS
0.66...
>>> b.saturation
1.0
>>> b.luminance
0.5
>>> b.red
0.0
>>> b.blue
1.0
>>> b.green
0.0
>>> b.rgb
(0.0, 0.0, 1.0)
>>> b.hsl # doctest: +ELLIPSIS
(0.66..., 1.0, 0.5)
>>> b.hex
'#00f'
Change values
-------------
Let's change Hue toward red tint:
>>> b.hue = 0.0
>>> b.hex
'#f00'
>>> b.hue = 2.0/3
>>> b.hex
'#00f'
In the other way round:
>>> b.hex = '#f00'
>>> b.hsl
(0.0, 1.0, 0.5)
Long hex can be accessed directly:
>>> b.hex_l = '#123456'
>>> b.hex_l
'#123456'
>>> b.hex
'#123456'
>>> b.hex_l = '#ff0000'
>>> b.hex_l
'#ff0000'
>>> b.hex
'#f00'
Convenience
-----------
>>> c = Color('blue')
>>> c
<Color blue>
>>> c.hue = 0
>>> c
<Color red>
>>> c.saturation = 0.0
>>> c.hsl # doctest: +ELLIPSIS
(..., 0.0, 0.5)
>>> c.rgb
(0.5, 0.5, 0.5)
>>> c.hex
'#7f7f7f'
>>> c
<Color #7f7f7f>
>>> c.luminance = 0.0
>>> c
<Color black>
>>> c.hex
'#000'
>>> c.green = 1.0
>>> c.blue = 1.0
>>> c.hex
'#0ff'
>>> c
<Color cyan>
>>> c = Color('blue', luminance=0.75)
>>> c
<Color #7f7fff>
>>> c = Color('red', red=0.5)
>>> c
<Color #7f0000>
>>> print(c)
#7f0000
You can try to query unexisting attributes:
>>> c.lightness # doctest: +ELLIPSIS
Traceback (most recent call last):
...
AttributeError: 'lightness' not found
TODO: could add HSV, CMYK, YUV conversion.
# >>> b.hsv
# >>> b.value
# >>> b.cyan
# >>> b.magenta
# >>> b.yellow
# >>> b.key
# >>> b.cmyk
Recursive init
--------------
To support blind conversion of web strings (or already converted object),
the Color object supports instantiation with another Color object.
>>> Color(Color(Color('red')))
<Color red>
Equality support
----------------
Default equality is RGB hex comparison:
>>> Color('red') == Color('blue')
False
>>> Color('red') == Color('red')
True
>>> Color('red') != Color('blue')
True
>>> Color('red') != Color('red')
False
But this can be changed:
>>> saturation_equality = lambda c1, c2: c1.luminance == c2.luminance
>>> Color('red', equality=saturation_equality) == Color('blue')
True
Subclassing support
-------------------
You should be able to subclass ``Color`` object without any issues::
>>> class Tint(Color):
... pass
And keep the internal API working::
>>> Tint("red").hsl
(0.0, 1.0, 0.5)
"""
_hsl = None ## internal representation
def __init__(self, color=None,
pick_for=None, picker=RGB_color_picker, pick_key=hash_or_str,
**kwargs):
if pick_key is None:
pick_key = lambda x: x
if pick_for is not None:
color = picker(pick_key(pick_for))
if isinstance(color, Color):
self.web = color.web
else:
self.web = color if color else 'black'
self.equality = RGB_equivalence
for k, v in kwargs.items():
setattr(self, k, v)
def __getattr__(self, label):
if label.startswith("get_"):
raise AttributeError("'%s' not found" % label)
try:
return getattr(self, 'get_' + label)()
except AttributeError:
raise AttributeError("'%s' not found" % label)
def __setattr__(self, label, value):
if label not in ["_hsl", "equality"]:
fc = getattr(self, 'set_' + label)
fc(value)
else:
self.__dict__[label] = value
##
## Get
##
def get_hsl(self):
return tuple(self._hsl)
def get_hex(self):
return rgb2hex(self.rgb)
def get_hex_l(self):
return rgb2hex(self.rgb, force_long=True)
def get_rgb(self):
return hsl2rgb(self.hsl)
def get_hue(self):
return self.hsl[0]
def get_saturation(self):
return self.hsl[1]
def get_luminance(self):
return self.hsl[2]
def get_red(self):
return self.rgb[0]
def get_green(self):
return self.rgb[1]
def get_blue(self):
return self.rgb[2]
def get_web(self):
return hex2web(self.hex)
##
## Set
##
def set_hsl(self, value):
self._hsl = list(value)
def set_rgb(self, value):
self.hsl = rgb2hsl(value)
def set_hue(self, value):
self._hsl[0] = value
def set_saturation(self, value):
self._hsl[1] = value
def set_luminance(self, value):
self._hsl[2] = value
def set_red(self, value):
_, g, b = self.rgb
self.rgb = (value, g, b)
def set_green(self, value):
r, _, b = self.rgb
self.rgb = (r, value, b)
def set_blue(self, value):
r, g, _ = self.rgb
self.rgb = (r, g, value)
def set_hex(self, value):
self.rgb = hex2rgb(value)
set_hex_l = set_hex
def set_web(self, value):
self.hex = web2hex(value)
## range of color generation
def range_to(self, value, steps):
for hsl in color_scale(self._hsl, Color(value).hsl, steps - 1):
yield Color(hsl=hsl)
##
## Convenience
##
def __str__(self):
return "%s" % self.web
def __repr__(self):
return "<Color %s>" % self.web
def __eq__(self, other):
if isinstance(other, Color):
return self.equality(self, other)
return NotImplemented
if sys.version_info[0] == 2:
## Note: intended to be a backport of python 3 behavior
def __ne__(self, other):
equal = self.__eq__(other)
return equal if equal is NotImplemented else not equal
RGB_equivalence = lambda c1, c2: c1.hex_l == c2.hex_l
HSL_equivalence = lambda c1, c2: c1._hsl == c2._hsl
def make_color_factory(**kwargs_defaults):
def ColorFactory(*args, **kwargs):
new_kwargs = kwargs_defaults.copy()
new_kwargs.update(kwargs)
return Color(*args, **new_kwargs)
return ColorFactory
|