Page MenuHomePhabricator

Re 1843798: Add capability to remember pages to replace.py
Open, LowPublic

Description

Originally from: http://sourceforge.net/p/pywikipediabot/patches/326/
Reported by: sigmaoctantis
Created on: 2009-05-12 04:30:27
Subject: Re 1843798: Add capabiliy to remember pages to replace.py
Assigned to: nicdumz
Original description:
A new patch to implement toobaz's function with the changes suggested by wikipedian.
https://sourceforge.net/tracker/?func=detail&aid=1843798&group\_id=93107&atid=603140

\- solve\_disambiguation.py and pagegenerators.py:

1\. Generator and logging function for -primary option moved
from solve\_disambiguation.py to pagegenerators.py

2\. TODO in solve\_disambiguation.py done:
generator now starts yielding before all referring pages have been found

3\. makes use of new TextfilePageGenerator

4\. code is a few lines shorter

\- replace.py:

5\. "-exclude" option from toobaz's patch implemented.
Allows to filter generator through a list of previously edited pages.
New pages are appended to the filter file based on choices made:
-exclude: logs to filter choice "N"

6\. additional command line options for other settings:
-editonce: logs to filter choices "Y", "A"
-treatonce: logs to filter choices "Y", "A", "N"
-scanonce: logs to filter choices "Y", "A", "N"; no change

7\. uses generator and file format from solve\_disambiguation.py
\(suggested by wikipedian below\)

8\. default filter filename is the name of the fix. Files are placed
in a subdirectory "replace".


Version: unspecified
Severity: normal
See Also:
https://sourceforge.net/p/pywikipediabot/patches/326

Details

Reference
bz54574

Event Timeline

bzimport raised the priority of this task from to Needs Triage.Nov 22 2014, 2:12 AM
bzimport set Reference to bz54574.
bzimport added a subscriber: Unknown Object (????).

patch for replace.py solve_disambiguation.py pagegenerators.py

patch for replace.py solve_disambiguation.py pagegenerators.py (revised)

Thanks for the quick review. I will try to address the
various points and included a new version of the patch.

a. I added a bit more text to the source and reformatted
part of the code, but I didn't want to change existing
code more than needed.

b. generator:
\- checks if the filter file exists
\- reads it
\- runs the next generator and skips pages in memory

Previously, it first run the next generator and then deleted
from its result pages that were in the filter file

c. replace.py command line options

I added several command line options to define which
pages should be skipped the next time. One could edit
replace.py directly, but it seemed cleaner to provide
all options at command line level.

toobaz excluded pages where a replacement was manually
rejected \("N"\). The option "-exclude" will keep this
functionality.

Personally, I find it more useful to filter pages that
were edited in a previous run. This avoids that the bot
repeats the same edit later, after someone reverted
a previous edit. Option "-editonce" provides this.

"-treatonce" combines the two.

"-scanonce" avoids that the bot re-fetches the same page
in a 2nd run, even if the regex didn't match it in
the first run. \(I fixed an omission for "skipped" in
the second patch\)

Without the different options, the additions to replace.py
would be much shorter ..

d. I had to insert several "break" in replace.py to avoid
that nothing but "N" gets to the stage confusingly labeled
"choice must be 'N'" in the code.

e. FilterFileAppend is based on the function from
solve\_disambiguation. The advantage of writing each
page to the file is that it wont miss one if it's
interrupted or crashes. This mode from
solve\_disambiguation remains unchanged.

f. The same goes for the file format. Up to now, I didn't
have any problems with it and it worked ok with a
title "臺灣Taiwan&āàäà" I just tested. urlname was also
used by PrimaryIgnoreManager. For backward compatibility,
may it should be kept.

Wow, that's a big patch =\)

\* codecs is fine with me
\* can you avoid lines > 80 characters? I know that this is not something we do everywhere, but that's bad looking code. Same goes for if foo: bar. Please skip a line.
\* can you document thoroughly what's being done? parameters in the generators? In replace.py ? I find it really hard to understand the "choice" table in the docstring explaining -scanonce & others.
\* What's this:
\+ f = codecs.open\(filename, 'r', 'utf-8'\)
\+ f.close\(\)
??

I am also not convinced by the fact that after each page, FilterFileAppend is called, and \#1 path is computed, \#2 a file is opened, written in, and closed.
I'm thinking that a possible cleaner way to do this would be to have a Filter object: put everything you need in it \(an opened file descriptor, a list of titles to ignore if you need to use this, etc...\) and keep a reference to it from the replace & disambig bots. How does that sound to you?

I also know that Daniel wanted first to keep the same file format, but... a couple of things are wrong here:
\* if you output titles with page.urlname\(\) it will not be possible to read the file with TextfilePageGenerator afaik. Think of special characters, being url encoded, and not decoded.
\* if you want to use a Page title for a filename, you want Page.titleforFilename, not Page.urlname

Thank you\!

Assigning to nicdumz for processing.

Nicdumz, do you have the time to work on this? It's been stale for.... a while.

Sigmaoctantis, sorry for the very slow uptake. It's a general problem for most patches that are larger than the 'glance over it, looks ok, commit' language updates. I'll see if I can find the time to review it.

In any case, the patch does not apply cleanly currently, so it needs some more fiddling.

  • assigned_to: nobody --> nicdumz
Xqt triaged this task as Low priority.Jan 13 2019, 1:26 PM