Allow using pywikibot without user-config.py and PYWIKIBOT_NO_USER_CONFIG=1
Closed, ResolvedPublicFeature
Actions

Assigned To

Authored By

	Seppl2013
	Dec 18 2020, 7:01 AM

Description

Current behavior:

When using pywikibot in an import statement the check for user-config.py is immediately done and throw a runtime error even if pywikibot is never called. It is explained that an Environment variable needs to be set to avoid this behavior.

Set PYWIKIBOT_NO_USER_CONFIG=1 to disable loading user-config.py

Expected behavior:

It should be possible to import pywikibot even it no user-config is available.
It should be possible to use pywikibot and disable the user-config.py check via API (not via Environment variable!)

Reasoning** When deploying a library like https://github.com/WolfgangFahl/py-3rdparty-mediawiki and make it available for the general public that has a choice of using either mwclient or pywikibot as the API channel to MediaWiki it does not make sens to throw an error by pywikibot when people choose mwclient. In fact this makes offering pywikibot as a library impossible in the long run.

Please fix this issue so that py-3rdparty-mediawiki will be able to offer a pywikibot. With the current state of affairs I'd have to remove the pywikibot support for the inconvenience it introduces for users.

Details

	Subject	Repo	Branch	Lines +/-
	[IMPR] Allow using pywikibot as site-package without user-config.py	pywikibot/core	master	+15 -9

Customize query in gerrit

Related Objects
Search...

Status	Subtype	Assigned	Task
Declined		None	T164095 pypi package does not contain scripts folder
Resolved		Xqt	T107629 generate_user_files and generate_family_file helper scripts aren't installed via pip
Resolved	Feature	Xqt	T270480 add version.py script to pywikibot pypi package
Open		Xqt	T139144 Making a pypi package pywikibot-scripts for officially supported scripts
Declined		None	T115784 pip install . in pywikibot should install scripts/ in /usr/local/bin
Open		Xqt	T139143 Make a pywikibot entry point for scripts
Resolved		Xqt	T260646 Pywikibot's missing config-file check blocks access to module documentation
Resolved	Feature	Xqt	T270474 Allow using pywikibot without user-config.py and PYWIKIBOT_NO_USER_CONFIG=1

Event Timeline

Seppl2013 created this task.Dec 18 2020, 7:01 AM

Restricted Application added subscribers: pywikibot-bugs-list, Danmichaelo, Aklapper. · View Herald TranscriptDec 18 2020, 7:01 AM

JJMC89 renamed this task from RuntimeError: No user-config.py found to Allow using pywikibot without user-config.py and PYWIKIBOT_NO_USER_CONFIG=1.Dec 18 2020, 7:08 AM

JJMC89 updated the task description. (Show Details)

JJMC89 changed the subtype of this task from "Task" to "Feature Request".

Xqt merged a task: T244684: Allow pywikibot import without presence of user-config.py.Dec 18 2020, 8:18 AM

Xqt added a parent task: T139143: Make a pywikibot entry point for scripts.

Xqt subscribed.

Xqt triaged this task as High priority.Dec 18 2020, 8:53 AM

Xqt added a parent task: T260646: Pywikibot's missing config-file check blocks access to module documentation.

Change 650461 had a related patch set uploaded (by Xqt; owner: Xqt):
[pywikibot/core@master] [IMPR] Allow using pywikibot as site-package without user-config.py

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

gerritbot added a project: Patch-For-Review.Dec 18 2020, 9:05 AM

Xqt claimed this task.Dec 18 2020, 9:05 AM

New behaviour after this patch:

C:\Users\xqt>python
Python 3.9.0 (tags/v3.9.0:9cf6752, Oct  5 2020, 15:34:40) [MSC v.1927 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import pywikibot
family and mylang are not set.
Defaulting to family='wikipedia' and mylang='test'.
>>> pywikibot.__version__
'5.3.0.dev0'
>>>

Xqt added a subscriber: FeRDNYC.Dec 18 2020, 9:27 AM

looks great. How do i get rid of the "family and mylang ar not set ..." messages?

In T270474#6700982, @Seppl2013 wrote:

looks great. How do i get rid of the "family and mylang ar not set ..." messages?

Done in PS2

Curiously the output statement in line 365 does not print the message but the warning in line1131 does if pywikibot is a site-package

Xqt mentioned this in T270483: logging.output does not print if pywikibot is a site-package.Dec 18 2020, 12:00 PM

Change 650461 merged by jenkins-bot:
[pywikibot/core@master] [IMPR] Allow using pywikibot as site-package without user-config.py

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

Xqt mentioned this in rPWBCb804528ceebd: [IMPR] Allow using pywikibot as site-package without user-config.py.Dec 18 2020, 7:58 PM

Maintenance_bot removed a project: Patch-For-Review.Dec 18 2020, 8:10 PM

Xqt closed this task as Resolved.Dec 18 2020, 8:20 PM

https://github.com/WolfgangFahl/py-3rdparty-mediawiki/issues/35 will have to wait for the release on pypi see https://pypi.org/project/pywikibot/

Seppl2013 mentioned this in T278076: pywikibot cannot collect family files from zip folder e.g. from py2app collection.Mar 22 2021, 6:24 AM

Allow using pywikibot without user-config.py and PYWIKIBOT_NO_USER_CONFIG=1Closed, ResolvedPublicFeatureActions

Description

Details

Related ObjectsSearch...

Event Timeline

Allow using pywikibot without user-config.py and PYWIKIBOT_NO_USER_CONFIG=1
Closed, ResolvedPublicFeature
Actions

Related Objects
Search...