Change option `--color` choices to auto/always/never #1701

riccardomurri · 2016-03-25T15:21:47Z

The option values are as in ls --color and grep --color,
except that "auto" is the default which colorizes logs and output
whenever EB's STDOUT is connected to a terminal.

Note that this requires PR ~~hpcugent/vsc-base#225~~ to be merged!
(Otherwise fancylogger.logToScreen() does not have a color parameter.)

The option values are as in `ls --color` and `grep --color`, except that "auto" is the default which colorizes logs and output whenever EB's STDOUT is connected to a terminal.

hpcugentbot · 2016-03-25T15:21:48Z

Automatic reply from Jenkins: Can I test this?

… be used. This is necessary after the recent API changes in PR easybuilders#225 on `vsc-base`: now the colorization options in `fancylogger` use a three-value enum `auto`/`always`/`never`.

…ly` is not available. We detect if STDOUT/STDERR is connected to a terminal and then just assume that everyone is using an ANSI-compatible one these days...

boegel · 2016-03-25T22:40:33Z

setup.py

@@ -112,7 +112,8 @@ def find_rel_test():
    zip_safe=False,
    install_requires=[
        'setuptools >= 0.6',
-        "vsc-base >= 2.4.18",
+        "vsc-base >= 2.5.0",
+        'humanfriendly',  # determine whether terminal supports ANSI color


this should be moved down into extras_require, only the packages that are strictly required to make eb work should be listed in install_requires

boegel · 2016-03-25T22:47:39Z

Jenkins: ok to test

hpcugentbot · 2016-03-25T22:48:01Z

EasyBuild framework unit test suite FAILed.

See https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/2912/console for more details.

Please fix the reported issues by pushing additional commits to the branch corresponding with this pull request; contact @boegel if you're not sure what to do.

boegel · 2016-03-25T23:07:14Z

easybuild/main.py

@@ -208,7 +233,8 @@ def main(args=None, logfile=None, do_build=None, testing=False):

    # initialise logging for main
    global _log
-    _log, logfile = init_logging(logfile, logtostdout=options.logtostdout, silent=testing or options.terse)
+    _log, logfile = init_logging(logfile, logtostdout=options.logtostdout,
+                                 silent=(testing or options.terse)), color=options.color)


the )) here should be ), syntax error

@riccardomurri you didn't test this, did you? Did you?! ;-)

(Kenneth Hoste, Fri, Mar 25, 2016 at 04:07:15PM -0700:)

@@ -208,7 +233,8 @@ def main(args=None, logfile=None, do_build=None, testing=False):

# initialise logging for main global _log

_log, logfile = init_logging(logfile, logtostdout=options.logtostdout, silent=testing or options.terse)

_log, logfile = init_logging(logfile, logtostdout=options.logtostdout,

silent=(testing or options.terse)), color=options.color)

the )) here should be ), syntax error

@riccardomurri you didn't test this, did you? Did you?! ;-)

Damn Jenkins, you caught me!

pforai · 2016-03-26T04:24:52Z

+1 for this!

…ogs` package feature.

…zation.

hpcugentbot · 2016-03-29T10:00:33Z

EasyBuild framework unit test suite FAILed.

See https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/2918/console for more details.

Please fix the reported issues by pushing additional commits to the branch corresponding with this pull request; contact @boegel if you're not sure what to do.

hpcugentbot · 2016-03-29T10:24:37Z

EasyBuild framework unit test suite FAILed.

See https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/2919/console for more details.

Please fix the reported issues by pushing additional commits to the branch corresponding with this pull request; contact @boegel if you're not sure what to do.

boegel · 2016-03-29T13:08:03Z

easybuild/tools/options.py

+    for their meaning.
+    """
+    # turn color=auto/yes/no into a boolean value
+    if options.color == 'auto':


@riccardomurri this should use colorize rather than options.color?

…ns.py`

hpcugentbot · 2016-03-29T13:27:43Z

EasyBuild framework unit test suite FAILed.

See https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/2920/console for more details.

Please fix the reported issues by pushing additional commits to the branch corresponding with this pull request; contact @boegel if you're not sure what to do.

riccardomurri · 2016-03-29T14:02:07Z

@boegel I cannot reproduce the failure that Jenkins reported on my laptop, and I cannot understand what part of the code has actually failed from the traceback.... help?

boegel · 2016-03-29T14:11:44Z

@riccardomurri The failing test is probably because the PR is not being tested against the updated vsc-base, i.e. fancylogger.logToScreen doesn't consume a named argument colorize yet

In other words: #225 needs to be merged first.

hpcugentbot · 2016-03-30T05:06:33Z

EasyBuild framework unit test suite FAILed.

See https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/2921/console for more details.

Please fix the reported issues by pushing additional commits to the branch corresponding with this pull request; contact @boegel if you're not sure what to do.

boegel · 2016-09-02T09:11:28Z

@riccardomurri please merge riccardomurri#26 to sync this with current develop

sync with develop & resolve conflicts in main.py

riccardomurri · 2016-09-02T09:12:54Z

@boegel done.

boegel · 2016-09-02T10:30:20Z

setup.py

@@ -126,6 +126,11 @@ def find_rel_test():
    ],
    extras_require = {
        'yeb': ["PyYAML >= 3.11"],
+        'coloredlogs': [
+            'vsc-base[coloredlogs] >= 2.5.0',


@riccardomurri please bump to 2.5.3 as minimal required version

Version 2.5.3 of `vsc-base` adds log colorization support.

riccardomurri · 2016-09-02T12:34:54Z

@boegel bumped vsc-base requirement in commit 544563f

boegel · 2016-09-05T11:46:13Z

lgtm, thanks @riccardomurri!

Change option --color choices to auto/always/never

7dfd9ca

The option values are as in `ls --color` and `grep --color`, except that "auto" is the default which colorizes logs and output whenever EB's STDOUT is connected to a terminal.

riccardomurri added 3 commits March 25, 2016 18:22

Explicitly provide a function to determine whether ANSI colors should…

381eecb

… be used. This is necessary after the recent API changes in PR easybuilders#225 on `vsc-base`: now the colorization options in `fancylogger` use a three-value enum `auto`/`always`/`never`.

Make color terminal detection work even if Python module `humanfriend…

3ed593b

…ly` is not available. We detect if STDOUT/STDERR is connected to a terminal and then just assume that everyone is using an ANSI-compatible one these days...

Require vsc-base >= 2.5.0 to get log colorization support.

d9f6a39

boegel reviewed Mar 25, 2016
View reviewed changes

boegel added this to the v2.8.0 milestone Mar 25, 2016

boegel reviewed Mar 25, 2016
View reviewed changes

riccardomurri added 3 commits March 29, 2016 11:11

Move all dependencies for log colorization into an optional `coloredl…

f24104e

…ogs` package feature.

Move helper function use_color to tools/options.py.

f5897cd

Consistently use colorize for parameter names related to log colori…

d8c1ade

…zation.

Change --disable-color to --color=never in tests.

34749a3

boegel reviewed Mar 29, 2016
View reviewed changes

Fix "NameError: global name 'options' is not defined" in `tools/optio…

0caeab5

…ns.py`

Use fancylogger's named constants for 'colorize' values

5492aab

boegel removed this from the v2.8.0 milestone May 10, 2016

boegel modified the milestones: v2.x, v2.8.0 May 10, 2016

Merge branch 'develop' into coloredlogs

750d15a

boegel mentioned this pull request Sep 2, 2016

sync with develop & resolve conflicts in main.py riccardomurri/easybuild-framework#26

Merged

Merge pull request #26 from boegel/coloredlogs

3eae210

sync with develop & resolve conflicts in main.py

boegel modified the milestones: v2.9.0, v2.x Sep 2, 2016

boegel reviewed Sep 2, 2016
View reviewed changes

Require vsc-base at least version 2.5.3

544563f

Version 2.5.3 of `vsc-base` adds log colorization support.

boegel merged commit 6a519d8 into easybuilders:develop Sep 5, 2016

riccardomurri deleted the coloredlogs branch September 5, 2016 11:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Change option `--color` choices to auto/always/never #1701

Change option `--color` choices to auto/always/never #1701

riccardomurri commented Mar 25, 2016 •

edited by boegel

hpcugentbot commented Mar 25, 2016

boegel Mar 25, 2016

boegel commented Mar 25, 2016

hpcugentbot commented Mar 25, 2016

boegel Mar 25, 2016

riccardomurri Mar 29, 2016

pforai commented Mar 26, 2016

hpcugentbot commented Mar 29, 2016

hpcugentbot commented Mar 29, 2016

boegel Mar 29, 2016

hpcugentbot commented Mar 29, 2016

riccardomurri commented Mar 29, 2016

boegel commented Mar 29, 2016

hpcugentbot commented Mar 30, 2016

boegel commented Sep 2, 2016

riccardomurri commented Sep 2, 2016

boegel Sep 2, 2016

riccardomurri commented Sep 2, 2016

boegel commented Sep 5, 2016

Change option --color choices to auto/always/never #1701

Change option --color choices to auto/always/never #1701

Conversation

riccardomurri commented Mar 25, 2016 • edited by boegel

hpcugentbot commented Mar 25, 2016

boegel Mar 25, 2016

Choose a reason for hiding this comment

boegel commented Mar 25, 2016

hpcugentbot commented Mar 25, 2016

boegel Mar 25, 2016

Choose a reason for hiding this comment

riccardomurri Mar 29, 2016

Choose a reason for hiding this comment

pforai commented Mar 26, 2016

hpcugentbot commented Mar 29, 2016

hpcugentbot commented Mar 29, 2016

boegel Mar 29, 2016

Choose a reason for hiding this comment

hpcugentbot commented Mar 29, 2016

riccardomurri commented Mar 29, 2016

boegel commented Mar 29, 2016

hpcugentbot commented Mar 30, 2016

boegel commented Sep 2, 2016

riccardomurri commented Sep 2, 2016

boegel Sep 2, 2016

Choose a reason for hiding this comment

riccardomurri commented Sep 2, 2016

boegel commented Sep 5, 2016

Change option `--color` choices to auto/always/never #1701

Change option `--color` choices to auto/always/never #1701

riccardomurri commented Mar 25, 2016 •

edited by boegel