fz0x1/jrnl
1
0
Fork 0
mirror of https://github.com/jrnl-org/jrnl.git synced 2025-06-30 22:46:12 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Allow users to disable colorization of output

Browse source
This commit is contained in:
Aaron Lichtman 2019-11-06 18:25:57 +01:00
parent 1a0847b38d
commit a23a818106
No known key found for this signature in database
GPG key ID: 22368077DE9F9903
2 changed files with 15 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/advanced.md
View file

@ -33,7 +33,7 @@ and can be edited with any plain text editor.
- `linewrap` - `linewrap`
controls the width of the output. Set to `false` if you don't want to wrap long lines. controls the width of the output. Set to `false` if you don't want to wrap long lines.
- `colors` - `colors`
dictionary that controls the colors used to display journal entries. It has two subkeys, which are: `date` and `title`. Current valid values are: `BLACK`, `RED`, `GREEN`, `YELLOW`, `BLUE`, `MAGENTA`, `CYAN`, and `WHITE`. `colorama.Fore` is used for colorization, and you can find the [docs here](https://github.com/tartley/colorama#colored-output). dictionary that controls the colors used to display journal entries. It has two subkeys, which are: `date` and `title`. Current valid values are: `BLACK`, `RED`, `GREEN`, `YELLOW`, `BLUE`, `MAGENTA`, `CYAN`, and `WHITE`. `colorama.Fore` is used for colorization, and you can find the [docs here](https://github.com/tartley/colorama#colored-output). To disable colored output, set the value to `NONE`.
!!! note !!! note
Although it seems intuitive to use the `#` Although it seems intuitive to use the `#`

20
jrnl/util.py
View file

@ -164,12 +164,15 @@ def scope_config(config, journal_name):
def verify_config(config): def verify_config(config):
""" """
Ensures the keys set for colors are valid colorama.Fore attributes. Ensures the keys set for colors are valid colorama.Fore attributes, or "None"
:return: True if all keys are set correctly, False otherwise :return: True if all keys are set correctly, False otherwise
""" """
all_valid_colors = True all_valid_colors = True
for key, color in config["colors"].items(): for key, color in config["colors"].items():
if not getattr(colorama.Fore, color.upper(), None): upper_color = color.upper()
if upper_color == "NONE":
pass
if not getattr(colorama.Fore, upper_color, None):
# TODO: Not sure whether both of these should stay or not. # TODO: Not sure whether both of these should stay or not.
print("[{2}ERROR{3}: {0} set to invalid color: {1}]".format(key, color, ERROR_COLOR, RESET_COLOR)) print("[{2}ERROR{3}: {0} set to invalid color: {1}]".format(key, color, ERROR_COLOR, RESET_COLOR))
log.error("Invalid color configuration value for '{0}'.".format(key)) log.error("Invalid color configuration value for '{0}'.".format(key))
@ -196,10 +199,15 @@ def get_text_from_editor(config, template=""):
def colorize(string, color, bold=False): def colorize(string, color, bold=False):
"""Returns the string colored with colorama.Fore.color. If the color set """Returns the string colored with colorama.Fore.color. If the color set by
by the user doesn't exist in the colorama.Fore attributes, the colorization the user is "NONE", it returns the string without any modification. Otherwise,
is done with WHITE.""" If the color set by the user doesn't exist in the colorama.Fore attributes,
color_escape = getattr(colorama.Fore, color.upper(), colorama.Fore.WHITE) the colorization is done with WHITE."""
upper_color = color.upper()
if upper_color == "NONE":
return string
color_escape = getattr(colorama.Fore, upper_color, colorama.Fore.WHITE)
if not bold: if not bold:
return color_escape + string + colorama.Fore.RESET return color_escape + string + colorama.Fore.RESET
else: else: