Manual:Pywikibot/PAWS/ja


 * 詳細は PAWS を参照してください. 

この文書では、 の簡単な概要を Wikimedia labs 環境が PAWS (PAWS: A Web Shell) を用いてホストしている notebook を使って説明します.

ウィキメディアのアカウントの作成
このウォークスルーを試すのに必要なのは、ウィキペディア/ウィキメディアのアカウントのみです. 作成するには Special:CreateAccount を使用してください.

アカウントを作成したら、https：//test.wikipedia.org/にアクセスして、右上にユーザー名が表示されることを確認してください （これはT120327で動作します）.

If you are a new user on Wikimedia log in with your account on meta.Wikimedia, Wikipedia, Wikidata, and Commons. And in each of them read and delete all pending messages you have (on the top).

notebookにサインイン
ホスティングされた notebook を開始するには、https://hub.paws.wmcloud.org/hub に遷移します.

「Sign in with MediaWiki」をクリックし、「Use OAuth for Authentication」を承認するように求められた際は「Allow」をクリックします. PAWS にアクセスするのが初めての場合は、サーバーを作成する必要があります. 緑色の"Start my Server"ボタンをクリックしてください. 新しいサーバーを開始する際、通常はしばらく時間がかかります.

これが完了すると、 https://paws.wmflabs.org/paws/user/<利用者名>/tree のような URL にリダイレクトされます.

端末の開始
新しい対話型端末を起動するには以下のようにします:
 * 1) PAWS ホームに移動します.
 * 2) 右上にある「New」をクリックします.
 * 3) 「Terminal」を選択します.

これにより https://paws.wmflabs.org/paws/user/<利用者名>/terminals/1 という URL で、Linux の「$」プロンプトがある新しいウィンドウが開きます.

この URL をブックマークに登録することで、いつでもこの端末に戻れます. ブラウザーを閉じたりご利用のコンピューターをシャットダウンした場合でも戻れます.

この端末はエミュレーターではありません. docker コンテナー上の実物の Linux インストレーションの一部である実物の bash シェルであるため、あらゆる bash コマンドを使用でき、Linux にインストール済みで利用可能なあらゆるコマンドを使用できます.

利用できるコマンドの一部を列挙するには、 を使用してください.

ウィキへのログイン
これによりサーバー上のあなたのアカウントが確立され、コマンドラインからログインできるようになります. 以下のコマンドで、テストウィキにログインできることを確認できるはずです. OAuth を使用しているため、パスワードを入力する必要はありません.

user-config.py という名前のファイルを ディレクトリ  に作成し、mylang および family の変数を追加することで、別のウィキの pywikibot に接続できます:

ページの作成
ページを作成するには、以下のコマンドの「 」をあなたの利用者名に書き換えて端末に入力し、変更内容を受理するように求められたら「Y」を押します:

これでウィキを編集できました. 変更内容を閲覧するには、ウェブ ブラウザーで https://test.wikipedia.org/wiki/User_talk:<利用者名> を開きます.

これらのコマンドライン スクリプトそれぞれについて詳細を閲覧するには、「-help」コマンドライン オプションを使用してください.

ページの取得
多数のページの取得は、「listpages」コマンドで実現できます.

前の節で作成したページの本文を取得するには、以下のコマンドを入力します:

PAWS ファイル一覧に遷移することで、保存したページを閲覧できるようになるはずです.

スクリプトの実例
ウィキペディアで使用されているウェブサイトへの外部リンクのURLが変更された際、古いリンクが新しいリンクに転送されない場合にはリンク切れが発生する場合があります. 例えばブリタニア百科事典は過去に、 http://www.britannica.com/EBchecked/media/ から http://www.britannica.com/topic/[topic name]/images-videos/* への記事ページのリンクの変更を実施しています. 外部リンク検索で検索を行うことで、古いURLが使用されたページの一覧を取得することができます. これらのリンクを全て手動で更新しようとすると、非常に大きな時間がかかります. 幸いなことにブリタニア百科事典は旧ページから新ページへのリダイレクトを設定しているためすぐに修正を実施する必要はありません.

For a simpler example, English Wikipedia currently contains links to http://britannica.com/EBchecked/ instead of http://www.britannica.com/EBchecked/ ; i.e. a 'www.' subdomain is missing in the URL.

There are currently 14 cases on English Wikipedia: w:Special:LinkSearch/http://britannica.com/EBchecked/

Wikipedia in other language also have this problem. e.g. there is one case on German Wikipedia: w:de:Spezial:Weblinksuche/http://britannica.com/EBchecked/

In order to fix those links, we can use Pywikibot replace.py script. In this demo we will use the '-simulate' argument to avoid writing to the wiki, as there are strict rules about automated editing of English Wikipedia.

First, let's list all of the pages which link to http://britannica.com/EBchecked/.

Now we check those pages actually have the literal URL in the page; i.e. they are not using a template.

Now use replace to add the missing "www."

In PAWS, and any terminal that supports color, the diff of changes will show the added "www." in green text color, making it easier to find the proposed changes.

Pywikibot の内側
Next we will use the PAWS Python session.


 * 1) Go to your PAWS home,
 * 2) click 'New' on the right hand side, and
 * 3) select 'Python 3'.

新しいウィンドウが開かれます.

以下の内容をテキストボックスに記述し、上部のメニューから「Run」ボタンを押して下さい（Shiftキー＋Enterキーを使って開くこともできます）.

下部に新たなテキストボックスが表示されます. Run the following to create an APISite object connected to https://test.wikipedia.org/:

新しいテキスト ボックスに「site」を入力して「Run」を選択することで内容を表示します.

以下のように表示されるはずです

Out[3]: APISite("test", "wikipedia")

page オブジェクトを作成します:

実行することで存在を確認します:

以下のように出力されるはずです

VERBOSE:pywiki:Found 1 wikipedia:test processes running, including this one. Out[5]: True

ページのテキストを表示します:

オブジェクト内のページ テキストを変更します:

ページをウィキに保存します:

レスポンスは以下のようになるはずです:

複数の行を並列して記述することができるPython3では、上記の内容を以下のように1つのテキストボックスにまとめて書き込むこともできます.

The log of your interactive Python session can be saved or downloaded for future reference.

Accessing online documentation in PAWS
Pywikibot documentation may be found at https://doc.wikimedia.org/pywikibot/. It is primarily sourced from docstrings, which can be loaded in the interactive Python 3 notebook using the Python built-in function help.

For example, to look at the arguments for the save method above, run either:

または

Pywikibot スクリプトの編集
The Pywikibot library and scripts are located in /srv/paws, and are read-only. The installed Pywikibot library cannot be modified in PAWS.

Scripts may be modified after copying them into your PAWS home.

For example, to run a modified "checkimages.py":

Edit the code -- for instance, just after the  code on line 1775, add a new line 1776 that will print out your name: (If no '-limit:x' defined, the program would run until all images checked, it may take long time.)
 * 1) In the terminal, enter
 * 1) In a browser, go to your PAWS home and click on the file.
 * 1) In the browser, you can edit the file.
 * 1) In the editing interface, use the File menu and click Save to save your modifications.
 * 1) In the terminal, enter

参照

 * Using Pywikibot with PAWS notebook based tutorial - A tutorial that helps users get started with using Pywikibot and PAWS
 * Example notebooks using Pywikibot - A list of notebooks hosted on PAWS that use Pywikibot
 * PAWS cheatsheet by one user (e.g. about API and database access)
 * Source code on GitHub