svgen.color
index
/home/vkottler/src/vkottler/workspace/svgen/svgen/color/__init__.py

svgen - A module for working with colors.

 
Package Contents
       
alpha
conversion
hsl
numbers
resolve
rgb
theme (package)

 
Classes
       
builtins.tuple(builtins.object)
Color

 
class Color(builtins.tuple)
    Color(rgb: svgen.color.rgb.Rgb, hsl: svgen.color.hsl.Hsl)
 
A definition of a color.
 
 
Method resolution order:
Color
builtins.tuple
builtins.object

Methods defined here:
__eq__(self, other) -> bool
Determine if two colors are equal.
__getnewargs__(self)
Return self as a plain tuple.  Used by copy and pickle.
__repr__(self)
Return a nicely formatted representation string
__str__(self) -> str
Convert this color to a hex string.
_asdict(self)
Return a new dict which maps field names to their values.
_replace(self, /, **kwds)
Return a new Color object replacing specified fields with new values

Class methods defined here:
_make(iterable) from builtins.type
Make a new Color object from a sequence or iterable
create(value: Union[str, svgen.color.hsl.Hsl, svgen.color.rgb.Rgb, ForwardRef('Color')]) -> 'Color' from builtins.type
Create a color from a variety of possible sources.
from_ctor(value: str) -> 'Color' from builtins.type
Create a color from an hsl or rgb constructor string.
from_hex(value: str) -> 'Color' from builtins.type
Create a color from a hex value.
from_hsl(color: svgen.color.hsl.Hsl) -> 'Color' from builtins.type
Create a color from an hsl object.
from_rgb(color: svgen.color.rgb.Rgb) -> 'Color' from builtins.type
Create a color from an rgb object.

Static methods defined here:
__new__(_cls, rgb: svgen.color.rgb.Rgb, hsl: svgen.color.hsl.Hsl)
Create new instance of Color(rgb, hsl)

Data descriptors defined here:
rgb
Alias for field number 0
hsl
Alias for field number 1

Data and other attributes defined here:
__annotations__ = {'hsl': <class 'svgen.color.hsl.Hsl'>, 'rgb': <class 'svgen.color.rgb.Rgb'>}
__match_args__ = ('rgb', 'hsl')
__orig_bases__ = (<function NamedTuple>,)
_field_defaults = {}
_fields = ('rgb', 'hsl')

Methods inherited from builtins.tuple:
__add__(self, value, /)
Return self+value.
__contains__(self, key, /)
Return bool(key in self).
__ge__(self, value, /)
Return self>=value.
__getattribute__(self, name, /)
Return getattr(self, name).
__getitem__(self, key, /)
Return self[key].
__gt__(self, value, /)
Return self>value.
__hash__(self, /)
Return hash(self).
__iter__(self, /)
Implement iter(self).
__le__(self, value, /)
Return self<=value.
__len__(self, /)
Return len(self).
__lt__(self, value, /)
Return self<value.
__mul__(self, value, /)
Return self*value.
__ne__(self, value, /)
Return self!=value.
__rmul__(self, value, /)
Return value*self.
count(self, value, /)
Return number of occurrences of value.
index(self, value, start=0, stop=9223372036854775807, /)
Return first index of value.
 
Raises ValueError if the value is not present.

Class methods inherited from builtins.tuple:
__class_getitem__(...) from builtins.type
See PEP 585

 
Data
        CSS_COLORS = {'aliceblue': '#f0f8ff', 'antiquewhite': '#faebd7', 'aqua': '#00ffff', 'aquamarine': '#7fffd4', 'azure': '#f0ffff', 'beige': '#f5f5dc', 'bisque': '#ffe4c4', 'black': '#000000', 'blanchedalmond': '#ffebcd', 'blue': '#0000ff', ...}
Colorlike = typing.Union[str, svgen.color.hsl.Hsl, svgen.color.rgb.Rgb, ForwardRef('Color')]
Dict = typing.Dict
Union = typing.Union
__annotations__ = {'CSS_COLORS': typing.Dict[str, str]}