Maniphest T85321

Update BaseSite.urlEncode and create tests
Closed, ResolvedPublic
Actions

Description

The method BaseSite.urlEncode from Pywikibot-compat was copied to Pywikibot as deprecated, and core uses urlencode as its implementation.

In the compat , BaseSite.urlEncode moved wpEditToken to the last arg as recommended by the API documentation, and it did utf8 encoding.

POST parameter encoding in core is now performed mostly in pywikibot.data.api.Request. This class does encoding properly, but does not re-order the parameters. To fix this, any parameter named '*token' should be moved to the end.

The deprecated BaseSite.urlEncode in core also needs to be updated so it is backwards compatible.

Tests need to be created to verify that pywikibot.data.api.Request and BaseSite.urlEncode re-order parameters, and very basic tests are needed to verify that BaseSite.urlEncode encodes the parameters correctly.

Mentor: @jayvdb
Difficulty: Medium

Details

	Subject	Repo	Branch	Lines +/-
	Fix encode_url dict support on Python 3	pywikibot/core	master	+4 -3
	Add encode_url to pywikibot.data.api	pywikibot/core	master	+69 -3

Customize query in gerrit

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Invalid		None	T60941 Missing unit tests for pywikibot library (tracking)
		Resolved		murfel	T85321 Update BaseSite.urlEncode and create tests

Event Timeline

jayvdb created this task.Dec 25 2014, 4:19 PM

jayvdb raised the priority of this task from to Medium.

jayvdb updated the task description. (Show Details)

jayvdb added projects: Pywikibot, good first task, Pywikibot-tests.

jayvdb added subscribers: Unknown Object (MLST), jayvdb.

I'm not sure, but applying UTF8 encoding on a url-encoded string?

jayvdb added a project: Pywikibot-compat-to-core.Jun 8 2015, 9:01 AM

jayvdb moved this task from Backlog to New tests needed on the Pywikibot-tests board.Jun 9 2015, 6:28 AM

jayvdb merged a task: T117935: token should be last parameter sent to server.Nov 18 2015, 12:05 AM

jayvdb added a subscriber: StudiesWorld.

jayvdb updated the task description. (Show Details)Nov 18 2015, 12:23 AM

jayvdb added projects: Regression, Pywikibot-network, Google-Code-In-2015.

Aklapper renamed this task from BaseSite.urlEncode to Update BaseSite.urlEncode and create tests.Dec 1 2015, 2:41 PM

https://codein.withgoogle.com/dashboard/tasks/6610549118861312/

Aklapper moved this task from Proposed to Imported into GCI site on the Google-Code-In-2015 board.Dec 3 2015, 6:24 PM

murfel claimed this task.Dec 11 2015, 8:30 AM

Change 258433 had a related patch set uploaded (by Murfel):
Add encode_url to pywikibot.data.api

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

gerritbot added a project: Patch-For-Review.Dec 11 2015, 11:12 AM

Change 258433 merged by jenkins-bot:
Add encode_url to pywikibot.data.api

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

murfel closed this task as Resolved.Dec 12 2015, 6:51 AM

Change 258683 had a related patch set uploaded (by John Vandenberg):
Fix encode_url dict support on Python 3

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

Change 258683 merged by jenkins-bot:
Fix encode_url dict support on Python 3

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

jayvdb mentioned this in T121318: UnicodeDecodeError in encode_url.Dec 12 2015, 6:34 PM

jayvdb mentioned this in T121310: broken Page().text ?.Dec 12 2015, 6:43 PM

jayvdb mentioned this in T121948: Pywikibot 2.0rc5.Dec 19 2015, 1:03 AM