Manual:Pywikibot/archivebot.py

archivebot.py は、議論ページを過去ログ化するために使用される Pywikibot スクリプトです。

使用法

$ python3 archivebot.py [オプション] テンプレートページ

Bot examines backlinks (Special:Whatlinkshere) to TEMPLATE_PAGE. Then goes through all pages (unless a specific page specified using options) and archives old discussions. This is done by breaking a page into threads, then scanning each thread for timestamps. Threads older than a specified threshold are then moved to another page (the archive), which can be named either basing on the thread's name or then name can contain a counter which will be incremented when the archive reaches a certain size. For a documentation on on-wiki setup, please see archivebot.py/setup .

Options (may be omitted)

パラメーター	説明
-help	show this help message and exit
-calc:ページ	calculate key for PAGE and exit
-file:ファイル	load list of pages from FILE
-force	override security options
-locale:ロケール	switch to locale LOCALE
-namespace:名前空間	only archive pages from a given namespace
-page:ページ	archive a single PAGE, default ns is a user talk page
-salt:ソルト	specify salt

利用できるグローバル引数

以下のオプションを用いることで、user-config.py の設定を上書きすることができます。

グローバル オプション

パラメーター	説明	設定変数名
-dir:パス	既定のディレクトリではなく、PATH で指定されたディレクトリからボットの設定データを読み込みます。
-config:ファイル	The user config filename. Default is user-config.py.	user-config.py
-lang:xx	user-config.py の設定を上書きする形で、作業するウィキの言語を設定します。xx には設定する適切な言語コードに置き換えてください。	mylang
-family:xyz	作業するウィキのファミリーを設定します。xyz には wikipedia、wiktionary、wikitravel などを指定します。 This will override the configuration in user-config.py.	family
-user:xyz	既定の利用者名ではなく、利用者 'xyz' としてログインします。	usernames
-daemonize:xyz	直ちにターミナルへ操作を返し、stdout と stderr をファイル xyz にリダイレクトします。これは stdin からの入力を必要としないボットのみで使用します。
-help	ヘルプ テキストを表示します。
-log	ログファイル (ファイル名は既定で「スクリプト名-bot.log」の形式になります) の出力を有効にします。ログは logs の下位ディレクトリに保存されます。	log
-log:xyz	ファイル xyz へのログの出力を有効にします。xyz にはファイル名を指定します。	logfilename
-nolog	ログ ファイルの出力を無効にします (既定で有効になっている場合)。
-maxlag	maxlag パラメータの秒数を新しく設定します。 データベース サーバーが遅延している間、ボットの編集を遅らせます。既定値は config.py で設定できます。	maxlag
-putthrottle:n -pt:n -put_throttle:n	ページを保存するまでの最小時間（秒）を設定します。	put_throttle
-debug:item -debug	コンポーネント "item" の拡張デバッグデータをログファイルに出力します。item にはデバッグの対象を指定します。item を指定しない場合、すべてのコンポーネントが対象になります。	debug_log
-verbose -v	デバッグに役立つ、より詳細なメッセージをコンソールに出力するようにします。	verbose_output
-cosmeticchanges -cc	config.py あるいは user-config.py での cosmetic_changes 設定を逆にし、無効にします。 その他の設定や制限はそのまま使用されます。	cosmetic_changes
-simulate	サーバーへの書き込みを無効にします。 これは、コードのテストやデバッグに有用です (このオプションを使用時、変更される内容は表示されますが、実際に変更されることはありません)。	simulate
-<設定変数>:n	任意の設定変数と数値をオプションとして使用し、それをコマンドラインで変更できるようにします。