pwb console script doesn't find scripts in the scripts folder but pwb.py does
Closed, ResolvedPublicBUG REPORT
Actions

Assigned To

Authored By

	JJMC89
	Dec 2 2022, 1:49 AM

Description

Steps to replicate the issue:

pip install pywikibot from git
pwb touch -help (or any other script in ./scripts, ./scripts/userscripts, ./scripts/maintenance)

What happens?:

ERROR: touch.py not found! Misspelling?

What should have happened instead?:
pwb finds and executes the script like python3 pwb.py.

Software version:
current (14dffb0)

Other information:
It finds scripts from ./pywikibot/scripts.

Installing scripts into a site-package instead of relying on the path should fix this.

Details

	Subject	Repo	Branch	Lines +/-
	[IMPR] Add config.base_dir to scripts search path	pywikibot/core	master	+6 -5

Customize query in gerrit

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Open	BUG REPORT	Xqt	T320851 pwb console script does not work when pip installed from git
		Resolved	BUG REPORT	Xqt	T324287 pwb console script doesn't find scripts in the scripts folder but pwb.py does

Event Timeline

JJMC89 created this task.Dec 2 2022, 1:49 AM

Restricted Application added subscribers: pywikibot-bugs-list, Aklapper. · View Herald TranscriptDec 2 2022, 1:49 AM

Don't see that scripts are installed. config.userscripts variable must be used to give access to the scripts folder-

JJMC89 renamed this task from pwb console script doesn't find scripts in the scripts folder to pwb console script doesn't find scripts in the scripts folder but pwb.py does.Dec 2 2022, 5:03 PM

JJMC89 updated the task description. (Show Details)

MarcoAurelio subscribed.Jan 24 2023, 11:40 PM

In T324287#8439494, @Xqt wrote:

Don't see that scripts are installed. config.userscripts variable must be used to give access to the scripts folder-

Thanks to @JJMC89 for pointing me to this task. I can confirm this happens today on the latest stable release as well. I followed @Xqt's suggestion and added to my user-config.py the following: user_script_paths = ['pywikibot-core.scripts.maintenance'] and it fixed it.

Not sure if this is related but calling the pwb version -v command makes the script print different outputs:

(pwbvenv) tools.xxxx@shell-yyyyy:~$ pwb version -v
Pywikibot: pywikibot/__init__.py (, -1 (unknown), 2023/01/24, 15:27:17, UNKNOWN)
`

whereas:

(pwbvenv) tools.xxxx@shell-yyyyy:~$ python3 pywikibot-core/pwb.py version -v
Pywikibot: [https] r-pywikibot-core (b678f2e, g17785, 2023/01/21, 12:29:25, stable)

Bennylin subscribed.Feb 15 2023, 7:15 AM

In T324287#8555541, @MarcoAurelio wrote:

Thanks to @JJMC89 for pointing me to this task. I can confirm this happens today on the latest stable release as well. I followed @Xqt's suggestion and added to my user-config.py the following: user_script_paths = ['pywikibot-core.scripts.maintenance'] and it fixed it.

I tried this solution today and it still didn't work

@PAWS:~$ pwb replace -start:!
ERROR: replace.py not found! Misspelling?
WARNING: /srv/paws/pywikibot-core/scripts/maintenance does not exists; remove it from user_script_paths
@PAWS:~$

In T324287#8617300, @Bennylin wrote:
I tried this solution today and it still didn't work
@PAWS:~$ pwb replace -start:!
ERROR: replace.py not found! Misspelling?
WARNING: /srv/paws/pywikibot-core/scripts/maintenance does not exists; remove it from user_script_paths
@PAWS:~$

The PAWS install of pywikibot is missing the scripts since it was updated to 8.0.0 (T326512). Also, the path is different on PAWS compared to what MarcoAurelio has.

binbot subscribed.Feb 15 2023, 8:27 AM

JJMC89 merged a task: T354084: PAWS. pwb code entry point does not invoke scripts from scripts path.Dec 28 2023, 4:55 PM

Xqt claimed this task.Dec 28 2023, 5:22 PM

Change 986520 had a related patch set uploaded (by Xqt; author: Xqt):

[pywikibot/core@master] [IMPR] Add config.base_dir to scripts search path

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

gerritbot added a project: Patch-For-Review.Dec 28 2023, 5:50 PM

Xqt closed this task as Resolved.Jan 27 2024, 6:02 PM

Change 986520 merged by jenkins-bot:

[pywikibot/core@master] [IMPR] Add config.base_dir to scripts search path

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

Maintenance_bot removed a project: Patch-For-Review.Jan 27 2024, 6:30 PM