Skip to main content

Adding colours to Python simplified into a single class

Project description

Pypi | Read the Docs | Github Pages

Build Status PyPi Version Licence


pip install object-colors


from object_colors import Color
c = Color()



Match effects with effect and colors with text and background

keys = ["text", "effect", "background"]
values = {
    "colors": ["black", "red", "green", "yellow", "blue", "purple", "cyan", "white"]
    "effects": ['none', "bold", 'bright', "underline", "negative"]

For most versatile usage simply instantiate the class with the string argument “colors”

This will populate the instance with a subclass for every key in the “colors” object

>>> from object_colors import Color
>>> c = Color("colors")
>>> print(c.__dict__)
    'text': 7,
    'effect': 0,
    'background': 0,
    'black': <object_colors.Color object at 0x7f3302cf4b10>,
    'red': <object_colors.Color object at 0x7f3303aa5d10>,
    'green': <object_colors.Color object at 0x7f33037a7710>,
    'yellow': <object_colors.Color object at 0x7f3302bd4710>,
    'blue': <object_colors.Color object at 0x7f3302bd4d50>,
    'purple': <object_colors.Color object at 0x7f3302ce0910>,
    'cyan': <object_colors.Color object at 0x7f33037ddc10>,
    'white': <object_colors.Color object at 0x7f33005e4c10>,
    'bold': <object_colors.Color object at 0x7f3303b09a90>

This can be further enhanced with the Color.bold object, initialized when bold has not been activated

>>>"not bold")

All colors, effects and objects can be manipulated however the user pleases, provided a keyword is not used outside its purpose



Set values with keyword arguments

>>> c.set(text="red", effect="bold", background="blue")
>>> c.set("red", "bold", "blue")
>>> c.set(114)
>>> print(c.__dict__)
{'text': 1, 'effect': 1, 'background': 4}

Set a new class with a keyword (any key) followed by a dict value

>>> c.set(
        red={"text": "red"},
        bold_red={"text": "red", "effect": "bold"},
        yellow={"text": "yellow"}
>>> c.yellow.set(effect="bold")
>>> print(c.__dict__)
    'text': 1,
    'effect': 1,
    'background': 4,
    'red': <object_colors.Color object at 0x0000020C10D06080>,
    'bold_red': <object_colors.Color object at 0x0000020C10D066D8>,
    'yellow': <object_colors.Color object at 0x0000020C10D06B00>
>>> print(c.yellow.__dict__)
{'text': 3, 'effect': 1, 'background': 0}

Store values for multicolored printing

>>> bullet ="[!] ")
>>> warning = c.yellow("Warning")
>>> print(bullet + warning)

returns a string or a tuple

>>> a, b, c ="a", "b", "c")

Instance includes enhanced print() function for color output

>>> c.print("no color print")
>>>"red print", flush=True)
>>> c.yellow.print("yellow print", end="")

Remove unused attributes

>>> c.pop("bold_red")
>>> print(c.__dict__)
    'text': 1,
    'effect': 1,
    'background': 4,
    'red': <object_colors.Color object at 0x0000020C10D06080>,
    'yellow': <object_colors.Color object at 0x0000020C10D06B00>

Or create new instances

>>> red = c.pop("red")
>>> print(c.__dict__)
    'text': 1,
    'effect': 1,
    'background': 4,
    'yellow': <object_colors.Color object at 0x0000020C10D06B00>
>>> print(red.__dict__)
{'text': 1, 'effect': 0, 'background': 0}
>>> red.print()
>>> red.get()
>>> red.set()

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

object-colors-1.0.5.tar.gz (6.0 kB view hashes)

Uploaded Source

Built Distribution

object_colors-1.0.5-py3-none-any.whl (6.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page