| | |
- builtins.tuple(builtins.object)
-
- ColorToken
- collections.UserDict(collections.abc.MutableMapping)
-
- ColorTheme(collections.UserDict, vcorelib.namespace.mixin.NamespaceMixin, collections.abc.MutableMapping, typing.Generic)
- collections.abc.MutableMapping(collections.abc.Mapping)
-
- ColorTheme(collections.UserDict, vcorelib.namespace.mixin.NamespaceMixin, collections.abc.MutableMapping, typing.Generic)
- typing.Generic(builtins.object)
-
- ColorTheme(collections.UserDict, vcorelib.namespace.mixin.NamespaceMixin, collections.abc.MutableMapping, typing.Generic)
- vcorelib.namespace.mixin.NamespaceMixin(builtins.object)
-
- ColorTheme(collections.UserDict, vcorelib.namespace.mixin.NamespaceMixin, collections.abc.MutableMapping, typing.Generic)
class ColorTheme(collections.UserDict, vcorelib.namespace.mixin.NamespaceMixin, collections.abc.MutableMapping, typing.Generic) |
| |
ColorTheme(name: str, initialdata: Dict[str, Union[str, svgen.color.hsl.Hsl, svgen.color.rgb.Rgb, ForwardRef('Color')]] = None, namespace: vcorelib.namespace.base.Namespace = None) -> None
A class implementing a theme color interface.
|
| |
- Method resolution order:
- ColorTheme
- collections.UserDict
- vcorelib.namespace.mixin.NamespaceMixin
- collections.abc.MutableMapping
- collections.abc.Mapping
- collections.abc.Collection
- collections.abc.Sized
- collections.abc.Iterable
- collections.abc.Container
- typing.Generic
- builtins.object
Methods defined here:
- __getitem__(self, key: str) -> svgen.color.Color
- Get a color from this theme.
- __init__(self, name: str, initialdata: Dict[str, Union[str, svgen.color.hsl.Hsl, svgen.color.rgb.Rgb, ForwardRef('Color')]] = None, namespace: vcorelib.namespace.base.Namespace = None) -> None
- Initialize this color theme.
- add(self, key: str, color: Union[str, svgen.color.hsl.Hsl, svgen.color.rgb.Rgb, ForwardRef('Color')]) -> svgen.color.theme.ColorToken
- Add a new color to this theme.
- add_mapping(self, data: Dict[str, Any]) -> None
- Add a mapping of tokens and colors to this theme.
- create(self, color: Union[str, svgen.color.hsl.Hsl, svgen.color.rgb.Rgb, ForwardRef('Color')]) -> svgen.color.Color
- Attempt to create a color through this theme so that existing tokens
can be used as color aliases.
- lookup(self, key: str) -> Tuple[str, Optional[svgen.color.Color]]
- Attempt to find an existing color in this theme by key.
- resolve(self, key: str, strict: bool = False) -> svgen.color.theme.ColorToken
- Attempt to resolve a color key as a theme color.
Static methods defined here:
- from_path(path: Union[pathlib.Path, str, NoneType]) -> 'ColorTheme'
- Load a color theme from a data file on disk.
Readonly properties defined here:
- size
- Get the number of colors in this theme.
Data and other attributes defined here:
- __abstractmethods__ = frozenset()
- __annotations__ = {'data': typing.Dict[str, svgen.color.Color]}
- __orig_bases__ = (<class 'collections.UserDict'>, <class 'vcorelib.namespace.mixin.NamespaceMixin'>, typing.MutableMapping[str, svgen.color.Color])
- __parameters__ = ()
Methods inherited from collections.UserDict:
- __contains__(self, key)
- # Modify __contains__ and get() to work like dict
# does when __missing__ is present.
- __copy__(self)
- __delitem__(self, key)
- __ior__(self, other)
- __iter__(self)
- __len__(self)
- __or__(self, other)
- Return self|value.
- __repr__(self)
- Return repr(self).
- __ror__(self, other)
- Return value|self.
- __setitem__(self, key, item)
- copy(self)
- get(self, key, default=None)
- D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.
Class methods inherited from collections.UserDict:
- fromkeys(iterable, value=None) from abc.ABCMeta
Data descriptors inherited from collections.UserDict:
- __dict__
- dictionary for instance variables
- __weakref__
- list of weak references to the object
Methods inherited from vcorelib.namespace.mixin.NamespaceMixin:
- child_namespace(self, *names: str, namespace: vcorelib.namespace.base.Namespace = None) -> vcorelib.namespace.base.Namespace
- Obtain a child namespace.
- names_pushed(self, *names: str, namespace: vcorelib.namespace.base.Namespace = None) -> Iterator[NoneType]
- Apply some names to this object's namespace as a managed context.
- namespace(self, name: str = None, delim: str = None, namespace: vcorelib.namespace.base.Namespace = None) -> str
- Get a namespace string for this object.
- namespace_search(self, *names: str, pattern: str = '.*', namespace: vcorelib.namespace.base.Namespace = None) -> Iterator[str]
- Perform a search on the namespace.
- namespace_suggest(self, data: str, delta: bool = True, namespace: vcorelib.namespace.base.Namespace = None) -> Optional[str]
- Find the shortest name suggestion.
- pop_name(self, name: str = None, namespace: vcorelib.namespace.base.Namespace = None) -> str
- Pop the latest name off the stack.
- push_name(self, name: str, namespace: vcorelib.namespace.base.Namespace = None) -> None
- Push a name onto the stack.
Readonly properties inherited from vcorelib.namespace.mixin.NamespaceMixin:
- ns
- Get this instance's namespace.
Methods inherited from collections.abc.MutableMapping:
- clear(self)
- D.clear() -> None. Remove all items from D.
- pop(self, key, default=<object object at 0x7feae89b81c0>)
- D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
If key is not found, d is returned if given, otherwise KeyError is raised.
- popitem(self)
- D.popitem() -> (k, v), remove and return some (key, value) pair
as a 2-tuple; but raise KeyError if D is empty.
- setdefault(self, key, default=None)
- D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D
- update(self, other=(), /, **kwds)
- D.update([E, ]**F) -> None. Update D from mapping/iterable E and F.
If E present and has a .keys() method, does: for k in E: D[k] = E[k]
If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v
In either case, this is followed by: for k, v in F.items(): D[k] = v
Methods inherited from collections.abc.Mapping:
- __eq__(self, other)
- Return self==value.
- items(self)
- D.items() -> a set-like object providing a view on D's items
- keys(self)
- D.keys() -> a set-like object providing a view on D's keys
- values(self)
- D.values() -> an object providing a view on D's values
Data and other attributes inherited from collections.abc.Mapping:
- __hash__ = None
- __reversed__ = None
Class methods inherited from collections.abc.Collection:
- __subclasshook__(C) from abc.ABCMeta
- Abstract classes can override this to customize issubclass().
This is invoked early on by abc.ABCMeta.__subclasscheck__().
It should return True, False or NotImplemented. If it returns
NotImplemented, the normal algorithm is used. Otherwise, it
overrides the normal algorithm (and the outcome is cached).
Class methods inherited from collections.abc.Iterable:
- __class_getitem__ = GenericAlias(...) from abc.ABCMeta
- Represent a PEP 585 generic type
E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,).
Class methods inherited from typing.Generic:
- __init_subclass__(...) from abc.ABCMeta
- Function to initialize subclasses.
|
class ColorToken(builtins.tuple) |
| |
ColorToken(token: str, color: svgen.color.Color)
A simple pairing of a color with a token.
|
| |
- Method resolution order:
- ColorToken
- builtins.tuple
- builtins.object
Methods defined here:
- __eq__(self, other) -> bool
- Determine if a color token is equivalent to something else.
- __getnewargs__(self)
- Return self as a plain tuple. Used by copy and pickle.
- __repr__(self)
- Return a nicely formatted representation string
- __str__(self) -> str
- Get this token as a color string.
- _asdict(self)
- Return a new dict which maps field names to their values.
- _replace(self, /, **kwds)
- Return a new ColorToken object replacing specified fields with new values
Class methods defined here:
- _make(iterable) from builtins.type
- Make a new ColorToken object from a sequence or iterable
Static methods defined here:
- __new__(_cls, token: str, color: svgen.color.Color)
- Create new instance of ColorToken(token, color)
- create(key: Union[str, svgen.color.hsl.Hsl, svgen.color.rgb.Rgb, ForwardRef('Color')]) -> 'ColorToken'
- Create a color token from a color.
Data descriptors defined here:
- token
- Alias for field number 0
- color
- Alias for field number 1
Data and other attributes defined here:
- __annotations__ = {'color': <class 'svgen.color.Color'>, 'token': <class 'str'>}
- __match_args__ = ('token', 'color')
- __orig_bases__ = (<function NamedTuple>,)
- _field_defaults = {}
- _fields = ('token', 'color')
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
| |