Colorized logging #2604

gurupras · 2016-08-04T21:17:52Z

Short Description: Updates to the (updated) logging system

Fixes:

Adds lost colour to the event system
Adds new methods to loggers

Some of the colours may not be the same as they were in the earlier logger.log system. I can change these if you're very particular. Some of the LCD code has also crept in. I can get rid of these if they're no longer required.

The commit in itself may have some redundant code in terms of functions that can be used like:
self.logger.red('message in red'), ...
I thought these might be useful for cases where a message doesn't necessarily fit into the usual logging levels like CRITICAL, ERROR, WARNING, INFO, DEBUG

Added new logging levels and functions

Conflicts: pokemongo_bot/api_wrapper.py pokemongo_bot/cell_workers/catch_lured_pokemon.py pokemongo_bot/cell_workers/catch_visible_pokemon.py pokemongo_bot/cell_workers/collect_level_up_reward.py pokemongo_bot/cell_workers/evolve_pokemon.py pokemongo_bot/cell_workers/handle_soft_ban.py pokemongo_bot/cell_workers/incubate_eggs.py pokemongo_bot/cell_workers/move_to_fort.py pokemongo_bot/cell_workers/nickname_pokemon.py pokemongo_bot/cell_workers/pokemon_catch_worker.py pokemongo_bot/cell_workers/recycle_items.py pokemongo_bot/cell_workers/sleep_schedule.py pokemongo_bot/cell_workers/spin_fort.py pokemongo_bot/cell_workers/transfer_pokemon.py pokemongo_bot/health_record/bot_event.py pokemongo_bot/logger.py Changes to be committed: modified: pokecli.py modified: pokemongo_bot/__init__.py modified: pokemongo_bot/cell_workers/sleep_schedule.py modified: pokemongo_bot/event_handlers/logging_handler.py modified: pokemongo_bot/event_manager.py modified: pokemongo_bot/logger.py

…zed-logging

douglascamata · 2016-08-05T08:57:48Z

@gurupras please, remember that this colors cannot be logged in files (and there will be options for the user to log every task, or a specific task, to a file), so we need to handle this.

gurupras · 2016-08-05T09:00:56Z

I see. I may have missed this, but all the code I found was only invoking logging.basicConfig without passing in a file path. Regardless, if I understood the design correctly, this is trivial to support if it involves a new handler akin to socketio_handler.py and logging_handler.py

gurupras · 2016-08-05T09:06:17Z

Oh, my bad. You're talking about getattr(logger, level)(message). We can still handle this while still providing colorized output on the console as long as the color formatter is not attached to the file handler.

ghost · 2016-08-05T12:14:08Z

input option -V[erbose] -c[olor]

raulgbcr · 2016-08-07T10:00:41Z

This NEEDS to be implemented, actual gui is shit.

gurupras · 2016-08-07T17:10:18Z

Well, not necessarily.
Actual GUI might be nice to have..especially if we can incorporate a map
and stuff.

However, you're right. I would still like colorized logging available
regardless of GUI.
You just immediately know to focus on what's important and ignore what's
not.

Let me know if this requires any additional work, I'll be happy to get it
done.

On Sun, Aug 7, 2016 at 6:00 AM, raulgbcr notifications@github.com wrote:

This NEEDS to be implemented, actual gui is shit.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#2604 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/ACzB14kUjgz5x2ujSYgm2LibsP_9iEJKks5qdazVgaJpZM4JdIdY
.

douglascamata · 2016-08-07T18:27:36Z

@raulgbcr if by actual GUI you meant the terminal, it's NOT supposed to be user friendly from the start. It's not a GUI, it's an application with logs. We have no GUI (:

douglascamata · 2016-08-07T18:44:38Z

👎

(see my comments)

@TheSavior please review this

douglascamata · 2016-08-07T18:45:28Z

pokemongo_bot/event_manager.py

            print '-'*80
            print 'Event: {}'.format(event)
+            print 'Color: {}'.format(color)


please, remove these prints.

douglascamata · 2016-08-07T18:51:13Z

pokemongo_bot/event_manager.py

@@ -29,7 +29,6 @@ def event_report(self):
        for event, (color, parameters) in self._registered_events.iteritems():
            print '-'*80
            print 'Event: {}'.format(event)


There is still this print and the print above.

I don't think those were added by me. But sure, I'll remove them.

oh shit, my bad... don't remove those, here it's the event's report... they should be here

douglascamata · 2016-08-07T19:01:16Z

@gurupras please put the event name print back, I forgot that code was inside the event report function. It should indeed be there. My bad.

gurupras · 2016-08-07T19:02:50Z

But you don't want the port print? or you want both back

douglascamata · 2016-08-07T19:03:38Z

@gurupras port? which port? colour I meant? Color is not necessary. The event report is just to help web developers create new UIs

gurupras · 2016-08-07T19:04:30Z

oops..sorry not port..it was:

        print '-'*80
        print 'Event: {}'.format(event)

I quickly saw that 80 and for some reason commented thinking it was port

BartKoppelmans · 2016-08-08T06:31:56Z

How about using different types of logging functions (e.g. error, pokémon, item) to allow for more extensibility? If we would use one logging class, we could give it multiple functions to call. Then the function could use its own color and settings (possibly shared across the class). This would make it easier to add options in the future, for example to allow setting the color or to disable certain logging.

A con is that we would have to specify a type in the code.

@douglascamata: How much work would it be to have the events use different functions, according to a given event? And what do you thing about that kind of system?

elicwhite · 2016-08-08T06:51:35Z

@BartKoppelmans When you receive an event, you know what type of event it is. Anything you could do with multiple functions you could do inside of the event handler.

BartKoppelmans · 2016-08-08T06:54:37Z

@TheSavior: Nice, so it would be possible to implement this? What do you think about it then?

douglascamata · 2016-08-08T16:22:41Z

@douglascamata: How much work would it be to have the events use different functions, according to a given event? And what do you thing about that kind of system?

We want to avoid duplicating code and be as simple as possible for the requirements we have. Why would we need multiple functions? What is so special that cannot be handled dynamically in just one function?

douglascamata · 2016-08-08T16:25:38Z

@douglascamata What if the web ui wants to start doing special things for given events. Should those be passed in the initial data too and thus sent to all listeners? The idea is that you'd be keeping handler specific functionality inside the handler instead of sending unnecessary data around.

That is not in our requirements, at least yet. So don't need to bother thinking about it because we don't know if that will ever happen (and personally, I don't think it will).

BartKoppelmans · 2016-08-08T16:59:34Z

@douglascamata

We want to avoid duplicating code and be as simple as possible for the requirements we have. Why would we need multiple functions? What is so special that cannot be handled dynamically in just one function?

This would enable us to have different functions for each type of log, and thus allow us to have separate settings for these functions. We could say no to logging the incubator and yes to logging the rest, while keeping the caught pokémon green and the transfers red. This would make it easier to extend, without having to change the old code. The common code can still be written in one function, which is called to reduce redundancy.

The biggest plus is the extensibility, as it would make it easier to add settings to the functions. Doing this dynamically would result in one method full of complex nesting and if-statements.

gurupras · 2016-08-08T17:42:21Z

The biggest plus is the extensibility, as it would make it easier to add settings to the functions. Doing this dynamically would result in one method full of complex nesting and if-statements.

Or a json array of events that we want to log

douglascamata · 2016-08-08T17:48:01Z

@BartKoppelmans @gurupras I already have plans for this and it will keep everything as dynamic as it is right now. There will be configs in every task inheriting from BaseTask to customize log level, format and destination (file or terminal). No nasty code involved.

BartKoppelmans · 2016-08-08T17:50:13Z

@douglascamata I'm curious, share it as soon as you start! 😄

douglascamata · 2016-08-08T21:21:32Z

@BartKoppelmans I will when I do it, but i'm working on more important stuff and I'm a bit overloaded.

douglascamata · 2016-08-08T21:22:16Z

@BartKoppelmans btw, can you solve merge conflicts, please?

BartKoppelmans · 2016-08-08T21:26:53Z

@douglascamata Sure, let me know if I can help with some things! And I'm sorry, but this is not my PR, otherwise I would!😅

Pinging @gurupras to resolve the merge conflicts.

BartKoppelmans · 2016-08-08T21:34:50Z

Great job, thank you very much! @gurupras

Conflicts: pokemongo_bot/__init__.py

- Cleaned up code - No more initialization upon `import logging` - The event system's `LoggingHandler` class now initializes logging framework - Early console is handled by `logging.basicConfig(...)`

…logic

There were some events where the initialization ended with a trailing comma. A color was _supposed_ to be added here but wasn't due to not falling clearly under one of the color categories.

… class In python __init__ __is__ the initialization method. So use that instead.

…_init__

…zed-logging Conflicts: pokemongo_bot/__init__.py

DanielVolz · 2016-08-09T21:01:33Z

can someone help me, getting this errors on OSX with iterm app.

Traceback (most recent call last): File "/usr/local/Cellar/python/2.7.12/Frameworks/Python.framework/Versions/2.7/lib/python2.7/logging/__init__.py", line 861, in emit msg = self.format(record) File "/usr/local/Cellar/python/2.7.12/Frameworks/Python.framework/Versions/2.7/lib/python2.7/logging/__init__.py", line 734, in format return fmt.format(record) File "/Users/danielvolz/MyPogoHeroku/PokemonGo-Bot/pokemongo_bot/logger.py", line 55, in format record.msg = '{color}{message}{reset}'.format(color=ColorizedLogFormatter.COLOR_SEQ % (color), message=record.msg, reset=ColorizedLogFormatter.RESET_SEQ) UnicodeEncodeError: 'ascii' codec can't encode character u'\xf6' in position 48: ordinal not in range(128) Logged from file logger.py, line 86 22:59:13 [RecycleItems] [Level info] [item_discarded] Discarded 1x Pokeball (maximum 100). 22:59:14 [RecycleItems] [Level info] [item_discarded] Discarded 1x Super Potion (maximum 0). Traceback (most recent call last): File "/usr/local/Cellar/python/2.7.12/Frameworks/Python.framework/Versions/2.7/lib/python2.7/logging/__init__.py", line 861, in emit msg = self.format(record) File "/usr/local/Cellar/python/2.7.12/Frameworks/Python.framework/Versions/2.7/lib/python2.7/logging/__init__.py", line 734, in format return fmt.format(record) File "/Users/danielvolz/MyPogoHeroku/PokemonGo-Bot/pokemongo_bot/logger.py", line 55, in format record.msg = '{color}{message}{reset}'.format(color=ColorizedLogFormatter.COLOR_SEQ % (color), message=record.msg, reset=ColorizedLogFormatter.RESET_SEQ) UnicodeEncodeError: 'ascii' codec can't encode character u'\xf6' in position 48: ordinal not in range(128) Logged from file logger.py, line 86 Traceback (most recent call last): File "/usr/local/Cellar/python/2.7.12/Frameworks/Python.framework/Versions/2.7/lib/python2.7/logging/__init__.py", line 861, in emit msg = self.format(record) File "/usr/local/Cellar/python/2.7.12/Frameworks/Python.framework/Versions/2.7/lib/python2.7/logging/__init__.py", line 734, in format return fmt.format(record) File "/Users/danielvolz/MyPogoHeroku/PokemonGo-Bot/pokemongo_bot/logger.py", line 55, in format record.msg = '{color}{message}{reset}'.format(color=ColorizedLogFormatter.COLOR_SEQ % (color), message=record.msg, reset=ColorizedLogFormatter.RESET_SEQ) UnicodeEncodeError: 'ascii' codec can't encode character u'\xf6' in position 48: ordinal not in range(128) Logged from file logger.py, line 86 Traceback (most recent call last): File "/usr/local/Cellar/python/2.7.12/Frameworks/Python.framework/Versions/2.7/lib/python2.7/logging/__init__.py", line 861, in emit msg = self.format(record) File "/usr/local/Cellar/python/2.7.12/Frameworks/Python.framework/Versions/2.7/lib/python2.7/logging/__init__.py", line 734, in format return fmt.format(record) File "/Users/danielvolz/MyPogoHeroku/PokemonGo-Bot/pokemongo_bot/logger.py", line 55, in format record.msg = '{color}{message}{reset}'.format(color=ColorizedLogFormatter.COLOR_SEQ % (color), message=record.msg, reset=ColorizedLogFormatter.RESET_SEQ) UnicodeEncodeError: 'ascii' codec can't encode character u'\xf6' in position 48: ordinal not in range(128) Logged from file logger.py, line 86 Traceback (most recent call last): File "/usr/local/Cellar/python/2.7.12/Frameworks/Python.framework/Versions/2.7/lib/python2.7/logging/__init__.py", line 861, in emit msg = self.format(record) File "/usr/local/Cellar/python/2.7.12/Frameworks/Python.framework/Versions/2.7/lib/python2.7/logging/__init__.py", line 734, in format return fmt.format(record) File "/Users/danielvolz/MyPogoHeroku/PokemonGo-Bot/pokemongo_bot/logger.py", line 55, in format record.msg = '{color}{message}{reset}'.format(color=ColorizedLogFormatter.COLOR_SEQ % (color), message=record.msg, reset=ColorizedLogFormatter.RESET_SEQ) UnicodeEncodeError: 'ascii' codec can't encode character u'\xf6' in position 48: ordinal not in range(128) Logged from file logger.py, line 86

gurupras · 2016-08-09T21:04:32Z

Oh boy.
I don't have access to a Mac. Could someone who uses OSX take a look at this and suggest a fixup?

douglascamata · 2016-08-09T21:08:42Z

@gurupras logger.py needs to import unicode_literals from future, probably.

DanielVolz · 2016-08-09T21:31:53Z

trying now with the new commit... looks good right now
edit: it works without the previous error now! Thank! @douglascamata @gurupras

douglascamata · 2016-08-10T00:15:55Z

@gurupras I'm sorry, but #3198 had a much more modular structure for the same features and it was merged :(

gurupras added 5 commits August 4, 2016 16:12

Initial logging changes

beea535

Added new logging levels and functions

Converted some more logger.log()s

8fc7dc6

Tiny spacing fix

2a4c95b

Fixed bug where old logging format was still in use

53312b7

elicwhite assigned douglascamata Aug 5, 2016

Merge branch 'dev' of github.com:PokemonGoF/PokemonGo-Bot into colori…

17d23a6

…zed-logging

douglascamata added the Approved label Aug 7, 2016

douglascamata added the Second Review Required label Aug 7, 2016

douglascamata reviewed Aug 7, 2016
View reviewed changes

douglascamata added the Waiting on Changes label Aug 7, 2016

douglascamata reviewed Aug 7, 2016
View reviewed changes

gurupras added 4 commits August 7, 2016 14:52

Removed extraneous print as pointed out by @douglascamata

4dd21ba

Removed all lcd reference

bdbabf2

Addded some comments

4ba146d

Removed logger.verbose()

043801c

Removed additional prints from event_manager.py

79050bb

Vvkmnn mentioned this pull request Aug 8, 2016

[QUESTION] Why is the log output no longer pretty? #3147

Closed

gurupras added 7 commits August 8, 2016 17:36

Merge branch 'dev' into colorized-logging

cbba16a

Conflicts: pokemongo_bot/__init__.py

Fixed logging system initialization

6cb0192

- Cleaned up code - No more initialization upon `import logging` - The event system's `LoggingHandler` class now initializes logging framework - Early console is handled by `logging.basicConfig(...)`

Updated EventManager() function so it more closely reflects previous …

babffeb

…logic

Fixed whitespace that crept in while refactoring

681a7d1

Removed some of the commas-without-colors

6baa70d

There were some events where the initialization ended with a trailing comma. A color was _supposed_ to be added here but wasn't due to not falling clearly under one of the color categories.

Removed additional initialize() method that was added to EventHandler…

ba5ab09

… class In python __init__ __is__ the initialization method. So use that instead.

Refactored comments and order of initialization of LoggingHandler's _…

e724c06

…_init__

eevee-github mentioned this pull request Aug 9, 2016

Add ColoredLoggingHandler #3198

Merged

Merge branch 'dev' of github.com:PokemonGoF/PokemonGo-Bot into colori…

6c14602

…zed-logging Conflicts: pokemongo_bot/__init__.py

Added import of unicode_literals from future to logger.py

3fa43b9

douglascamata closed this Aug 10, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Colorized logging #2604

Colorized logging #2604

gurupras commented Aug 4, 2016 •

edited

Loading

douglascamata commented Aug 5, 2016

gurupras commented Aug 5, 2016

gurupras commented Aug 5, 2016

ghost commented Aug 5, 2016

raulgbcr commented Aug 7, 2016

gurupras commented Aug 7, 2016

douglascamata commented Aug 7, 2016

douglascamata commented Aug 7, 2016 •

edited

Loading

douglascamata Aug 7, 2016

douglascamata Aug 7, 2016

gurupras Aug 7, 2016

douglascamata Aug 7, 2016

douglascamata commented Aug 7, 2016

gurupras commented Aug 7, 2016

douglascamata commented Aug 7, 2016 •

edited

Loading

gurupras commented Aug 7, 2016 •

edited

Loading

BartKoppelmans commented Aug 8, 2016

elicwhite commented Aug 8, 2016

BartKoppelmans commented Aug 8, 2016

douglascamata commented Aug 8, 2016

douglascamata commented Aug 8, 2016

BartKoppelmans commented Aug 8, 2016

gurupras commented Aug 8, 2016

douglascamata commented Aug 8, 2016 •

edited

Loading

BartKoppelmans commented Aug 8, 2016

douglascamata commented Aug 8, 2016

douglascamata commented Aug 8, 2016

BartKoppelmans commented Aug 8, 2016

BartKoppelmans commented Aug 8, 2016

DanielVolz commented Aug 9, 2016

gurupras commented Aug 9, 2016

douglascamata commented Aug 9, 2016

DanielVolz commented Aug 9, 2016 •

edited

Loading

douglascamata commented Aug 10, 2016 •

edited

Loading

Colorized logging #2604

Colorized logging #2604

Conversation

gurupras commented Aug 4, 2016 • edited Loading

douglascamata commented Aug 5, 2016

gurupras commented Aug 5, 2016

gurupras commented Aug 5, 2016

ghost commented Aug 5, 2016

raulgbcr commented Aug 7, 2016

gurupras commented Aug 7, 2016

douglascamata commented Aug 7, 2016

douglascamata commented Aug 7, 2016 • edited Loading

douglascamata Aug 7, 2016

Choose a reason for hiding this comment

douglascamata Aug 7, 2016

Choose a reason for hiding this comment

gurupras Aug 7, 2016

Choose a reason for hiding this comment

douglascamata Aug 7, 2016

Choose a reason for hiding this comment

douglascamata commented Aug 7, 2016

gurupras commented Aug 7, 2016

douglascamata commented Aug 7, 2016 • edited Loading

gurupras commented Aug 7, 2016 • edited Loading

BartKoppelmans commented Aug 8, 2016

elicwhite commented Aug 8, 2016

BartKoppelmans commented Aug 8, 2016

douglascamata commented Aug 8, 2016

douglascamata commented Aug 8, 2016

BartKoppelmans commented Aug 8, 2016

gurupras commented Aug 8, 2016

douglascamata commented Aug 8, 2016 • edited Loading

BartKoppelmans commented Aug 8, 2016

douglascamata commented Aug 8, 2016

douglascamata commented Aug 8, 2016

BartKoppelmans commented Aug 8, 2016

BartKoppelmans commented Aug 8, 2016

DanielVolz commented Aug 9, 2016

gurupras commented Aug 9, 2016

douglascamata commented Aug 9, 2016

DanielVolz commented Aug 9, 2016 • edited Loading

douglascamata commented Aug 10, 2016 • edited Loading

gurupras commented Aug 4, 2016 •

edited

Loading

douglascamata commented Aug 7, 2016 •

edited

Loading

douglascamata commented Aug 7, 2016 •

edited

Loading

gurupras commented Aug 7, 2016 •

edited

Loading

douglascamata commented Aug 8, 2016 •

edited

Loading

DanielVolz commented Aug 9, 2016 •

edited

Loading

douglascamata commented Aug 10, 2016 •

edited

Loading