elaborate docstring for persistence

[mediawiki_dump_tools.git] / wikiq

diff --git a/wikiq b/wikiq
index fbe043c07a09ce1e5c403590a486bbe11ce8111f..8b741e3ee9a1f326290f3e48633c90386cb57e98 100755 (executable)
--- a/wikiq
+++ b/wikiq
@@ -3,6 +3,7 @@
 # original wikiq headers are: title articleid revid date_time anon
 # editor editor_id minor text_size text_entropy text_md5 reversion
 # additions_size deletions_size
+
 import argparse
 import sys
 import os, os.path
@@ -204,8 +205,6 @@ class WikiqParser():
                     from mw.lib import persistence
                     state = persistence.State()
 
-                
-
             # Iterate through a page's revisions
             for rev in page:
 
@@ -379,14 +378,15 @@ parser.add_argument('-s', '--stdout', dest="stdout", action="store_true",
 parser.add_argument('--collapse-user', dest="collapse_user", action="store_true",
                     help="Operate only on the final revision made by user a user within all sequences of consecutive edits made by a user. This can be useful for addressing issues with text persistence measures.")
 
-parser.add_argument('-p', '--persistence', dest="persist", default=None, const='', type=str, choices = ['','segment','sequence','legacy'], nargs='?',
-                    help="Compute and report measures of content persistent: (1) persistent token revisions, (2) tokens added, and (3) number of revision used in computing the first measure. This may by slow.  Use -p=segment for advanced persistence calculation method that is robust to content moves. This might be very slow. Use -p=legacy for legacy behavior.")
+parser.add_argument('-p', '--persistence', dest="persist", default="sequence", const='', type=str, choices = ['','segment','sequence','legacy'], nargs='?',
+                    help="Compute and report measures of content persistent: (1) persistent token revisions, (2) tokens added, and (3) number of revision used in computing the first measure. This may by slow.  The defualt is -p=sequence, which uses the same algorithm as in the past, but with improvements to wikitext parsing. Use -p=legacy for old behavior used in older research projects. Use -p=segment for advanced persistence calculation method that is robust to content moves, but prone to bugs, and slower.")
 
 parser.add_argument('-u', '--url-encode', dest="urlencode", action="store_true",
                     help="Output url encoded text strings. This works around some data issues like newlines in editor names. In the future it may be used to output other text data.")
 
-parser.add_argument('-n', '--namespace-include', dest="namespace_include", type=int, action='append',
-                    help="Id number of namspace to include.")
+parser.add_argument('-n', '--namespace-include', dest="namespace_filter", type=int, action='append',
+                    help="Id number of namspace to include. Can be specified more than once.")
+
 
 
 args = parser.parse_args()
@@ -402,8 +402,8 @@ elif args.persist == "legacy":
 else:
     persist = PersistMethod.sequence
 
-if args.namespace_include is not None:
-    namespaces = args.namespace_include
+if args.namespace_filter is not None:
+    namespaces = args.namespace_filter
 else:
     namespaces = None
 
@@ -441,7 +441,8 @@ else:
                         collapse_user=args.collapse_user,
                         persist=persist,
                         persist_legacy=args.persist_legacy,
-                        urlencode=args.urlencode)
+                        urlencode=args.urlencode,
+                        namespaces = namespaces)
     wikiq.process()
 
 # stop_words = "a,able,about,across,after,all,almost,also,am,among,an,and,any,are,as,at,be,because,been,but,by,can,cannot,could,dear,did,do,does,either,else,ever,every,for,from,get,got,had,has,have,he,her,hers,him,his,how,however,i,if,in,into,is,it,its,just,least,let,like,likely,may,me,might,most,must,my,neither,no,nor,not,of,off,often,on,only,or,other,our,own,rather,said,say,says,she,should,since,so,some,than,that,the,their,them,then,there,these,they,this,tis,to,too,twas,us,wants,was,we,were,what,when,where,which,while,who,whom,why,will,with,would,yet,you,your"