jenkins-bot has submitted this change. (
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/650461 )
Change subject: [IMPR] Allow using pywikibot as site-package without user-config.py
......................................................................
[IMPR] Allow using pywikibot as site-package without user-config.py
- also omit all warnings about missing user-config.py
- decrease nested flow statements due to coding convention
- update documentations
Bug: T270474
Change-Id: I586ba53f8eb88b9e4f60eff45d0c9228e972a19a
---
M pywikibot/config2.py
1 file changed, 15 insertions(+), 9 deletions(-)
Approvals:
JJMC89: Looks good to me, approved
jenkins-bot: Verified
diff --git a/pywikibot/config2.py b/pywikibot/config2.py
index cec6bbe..5240a3b 100644
--- a/pywikibot/config2.py
+++ b/pywikibot/config2.py
@@ -11,8 +11,9 @@
will fail to load unless the environment variable PYWIKIBOT_NO_USER_CONFIG
is set to a value other than '0'. i.e. PYWIKIBOT_NO_USER_CONFIG=1 will
allow config to load without a user-config.py. However, warnings will be
-shown if user-config.py was not loaded.
-To prevent these warnings, set PYWIKIBOT_NO_USER_CONFIG=2.
+shown if user-config.py was not loaded. To prevent these warnings, set
+PYWIKIBOT_NO_USER_CONFIG=2. If pywikibot is installed as a site-package
+the behaviour is like PYWIKIBOT_NO_USER_CONFIG=2 is set.
Provides two functions to register family classes which can be used in
the user-config:
@@ -47,6 +48,7 @@
from locale import getdefaultlocale
from os import getenv, environ
+from pathlib import Path
from textwrap import fill
from typing import Optional, Union
from warnings import warn
@@ -89,7 +91,9 @@
_imports = frozenset(name for name in globals() if not name.startswith('_'))
__no_user_config = getenv('PYWIKIBOT_NO_USER_CONFIG')
-if __no_user_config == '0':
+if __no_user_config is None and 'site-packages' in Path(__file__).parts:
+ __no_user_config = '2'
+elif __no_user_config == '0':
__no_user_config = None
@@ -294,7 +298,8 @@
'.pywikibot' directory (Unix and similar) under the user's home
directory.
- Set PYWIKIBOT_NO_USER_CONFIG=1 to disable loading user-config.py
+ Set PYWIKIBOT_NO_USER_CONFIG=1 to disable loading user-config.py or
+ install pywikibot as a site-package.
@param test_directory: Assume that a user config file exists in this
directory. Used to test whether placing a user config file in this
@@ -358,17 +363,18 @@
raise RuntimeError("Directory '%s' does not exist." %
base_dir)
# check if user-config.py is in base_dir
if not exists(base_dir):
- exc_text = "No user-config.py found in directory '%s'.\n" %
base_dir
- if __no_user_config:
- if __no_user_config != '2':
- output(exc_text)
- else:
+ exc_text = 'No user-config.py found in directory {!r}.\n'.format(
+ base_dir)
+
+ if __no_user_config is None:
exc_text += (
' Please check that user-config.py is stored in the correct '
'location.\n'
' Directory where user-config.py is searched is determined '
'as follows:\n\n ') + get_base_dir.__doc__
raise RuntimeError(exc_text)
+ elif __no_user_config != '2':
+ output(exc_text)
return base_dir
--
To view, visit
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/650461
To unsubscribe, or for help writing mail filters, visit
https://gerrit.wikimedia.org/r/settings
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Change-Id: I586ba53f8eb88b9e4f60eff45d0c9228e972a19a
Gerrit-Change-Number: 650461
Gerrit-PatchSet: 4
Gerrit-Owner: Xqt <info(a)gno.de>
Gerrit-Reviewer: JJMC89 <JJMC89.Wikimedia(a)gmail.com>
Gerrit-Reviewer: jenkins-bot
Gerrit-MessageType: merged