make logging interface consistent
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	valhallasw
	Dec 31 2014, 3:51 PM

Description

bot.debug has a different interface from all other logging functions:

def debug(text, layer, decoder=None, newline=True, **kwargs):

versus

def error(text, decoder=None, newline=True, **kwargs):

We should deprecate layer, for _logger, passed as kwarg (in debug) or the other way around (for all other functions).

Details

Subject	Repo	Branch	Lines +/-
[IMPR] make logging interface consistent	pywikibot/core	master	+277 -216
[IMPR] make debug layer optional	pywikibot/core	master	+78 -164
[cleanup] Show a FutureWarning for output stdout parameter	pywikibot/core	master	+4 -3

Customize query in gerrit

Related Objects

Mentioned In: T326650: pywikibot library should not attach logging handlers
T299309: debug() missing 1 required positional argument: 'layer'
rPWBC93f225af3c49: [cleanup] Show a FutureWarning for output stdout parameter

Event Timeline

valhallasw created this task.Dec 31 2014, 3:51 PM

valhallasw raised the priority of this task from to Needs Triage.

valhallasw updated the task description. (Show Details)

valhallasw added a project: Pywikibot.

valhallasw subscribed.

valhallasw triaged this task as Low priority.Jan 29 2015, 9:38 PM

ha! I actually had included exactly this (deprecating 'layer') in my warnings patch, but didnt submit it for https://gerrit.wikimedia.org/r/#/c/187106/ , and partly because I suspected that adding layer to all of them would be a better approach.

Change 630209 had a related patch set uploaded (by Xqt; owner: Xqt):
[pywikibot/core@master] [IMPR] make logging interface consistent

https://gerrit.wikimedia.org/r/630209

gerritbot added a project: Patch-For-Review.Sep 25 2020, 4:18 PM

Change 649823 had a related patch set uploaded (by Xqt; owner: Xqt):
[pywikibot/core@master] [cleanup] Show a FutureWarning for output stdout parameter

https://gerrit.wikimedia.org/r/649823

Change 649823 merged by jenkins-bot:
[pywikibot/core@master] [cleanup] Show a FutureWarning for output stdout parameter

https://gerrit.wikimedia.org/r/649823

Xqt mentioned this in rPWBC93f225af3c49: [cleanup] Show a FutureWarning for output stdout parameter.Dec 19 2020, 11:19 AM

Xqt mentioned this in T299309: debug() missing 1 required positional argument: 'layer'.Jan 16 2022, 5:16 PM

Change 783860 merged by jenkins-bot:

[pywikibot/core@master] [IMPR] make debug layer optional

https://gerrit.wikimedia.org/r/783860

Xqt moved this task from Backlog to Logging on the Pywikibot board.Apr 25 2022, 7:55 AM

Change 630209 merged by Xqt:

[pywikibot/core@master] [IMPR] make logging interface consistent

https://gerrit.wikimedia.org/r/630209