Pywikibot/사용법 편집하기

위키 자동편집도구 [[Pywikibot]] 사용법에 관한 문서이다.

== 주요 스크립트 ==
{{참고|mw:Manual:Pywikibot/Scripts}}
[[리브레 위키]]에서도 사용하는데 유용한 스크립트와 각 스크립트의 기능에 대해 소개하겠다. 일부 스크립트들은 영어 위키백과의 편집에 맞추어져 있어 리브레 위키에서 사용하기 불편한 면이 있다는 것도 주의하자. 또한 category.py나 replace.py 같이 단독작업으로도 상당히 많은 일처리를 할 수 있는 일부 스크립트를 제외하면 상당수의 스크립트들이 단순한 일을 하는데 그치기에 cmd창에서 일일히 실행시키기보다는 직접 CMD 스크립트나 파이썬으로 프로그래밍을 해서 반복적으로 실행하는 방법을 사용할 것을 권장한다.

스크립트 사용방법은 cd 명령어를 이용해 CMD창에 Pywikibot이 설치된 경로로 이동한 뒤 

<syntaxhighlight lang="Powershell">
 > python pwb.py (스크립트명) (부속조건명)
</syntaxhighlight> 
이런 식으로 입력해서 사용할 수 있다.

{|class="wikitable"
|-
! 스크립트명 !! 설명
|-
| [[mw:Manual:Pywikibot/login.py|login.py]] || Pywikibot에 로그인할 때 필요하다. user-config.py에 lang, family, usernames를 지정한 뒤에 로그인할 것을 권장한다.
|-
| [[mw:Manual:Pywikibot/listpages.py|listpages.py]] || Pywikibot이 user-config.py에 설정된 위키의 페이지를 검색하거나 검색한 문서들을 내려받을 때 사용하는 스크립트이다. 편집 스크립트가 아니기에 login.py를 실행시키지 않아도 사용 가능하다.
|-
| [[mw:Manual:Pywikibot/add-texts.py|add_texts.py]] || 지정한 문서 목록의 맨 앞부분, 혹은 맨 뒷부분에 사용자가 입력하고 싶은 문구를 추가할 수 있다.
|-
| [[mw:Manual:Pywikibot/category.py|category.py]] || 지정된 문서의 분류를 바꾸고 싶을 때 사용할 수 있다.
|-
| [[mw:Manual:Pywikibot/movepages.py|movepages.py]] || 위키에서 여러 파일을 한번에 옮길 수 있다.
|-
| [[mw:Manual:Pywikibot/pagefromfile.py|pagefromfile.py]] || 위키 내부에 위키텍스트를 포함하는 파일을 컴퓨터에 저장한 파일에서 위키로 가져올 수 있다.

|-
| [[mw:Manual:Pywikibot/redirect.py|redirect.py]] || 이중 넘겨주기나 깨진 넘겨주기 등 부적절한 형태의 넘겨주기를 정리할 때 사용한다.
|-
| [[mw:Manual:Pywikibot/replace.py|replace.py]] || 위키 내부의 특정한 문구를 다른 문구로 바꿔준다. 가장 많이 사용하며, 그 자체로도 상당히 설명할 것이 많다. 아래 찾아바꾸기 사용방법도 참조.

|-
| [[mw:Manual:Pywikibot/revertbots.py|revertbots.py]] || 봇 편집이 잘못됐을 때 자신의 봇 계정의 편집을 되돌리거나 문서 훼손을 자행하는 이용자의 마지막 편집을 되돌릴 때 사용할 수 있다.

|-
| [[mw:Manual:Pywikibot/table2wiki.py|table2wiki.py]] || HTML 표 문법을 미디어위키에 걸맞는 문법 형태로 바꿔준다.
|-
| [[mw:Manual:Pywikibot/upload.py|upload.py]] || 파일을 위키에 업로드할 때 사용한다.
|-
| [[mw:Manual:Pywikibot/weblinkchecker.py|weblinkchecker.py]] || 깨진 URL을 검사할 때 사용한다.
|}

== 찾아바꾸기 전략 ==
=== 기본 ===
{{참조|mw:Manual:Pywikibot/replace.py}}
기본적으로 replace.py를 사용한다. 간단한 사용법은 다음과 같다.

<pre>> python pwb.py replace (파일 검색 옵션) "(바꾸기전1)" "(바꾼후1)" "(바꾸기전2)" "(바꾼후2)" ... </pre>

참고로 파일 검색 옵션은 다음과 같은데, 아래에 설명하는 것을 포함해 적어도 하나의 한정자는 반드시 사용해야 한다. 
* <code>-cat:(분류명)</code> - 특정 분류 안에 있는 문서들을 대상으로 수행한다. <code>-catr:(분류명)</code>으로 쓰면 해당 분류의 하위 분류에 있는 문서들까지 모두 고려하며, <code>-subcats:(분류명)</code>라 쓰면 해당 분류의 바로 하위 분류들에(-subcats:A는 분류 A에 연결된 분류들) 연결된 문서들만 검색한다.
* <code>-file:(로컬 txt파일명)</code> - 로컬 디렉토리에 저장된 텍스트 문서 안에 적힌 문서들을 대상으로 수행한다. 텍스트 파일에서 찾아바꾸기 대상 문서를 지정하려면 반드시 <code>[[(문서명)]]</code>처럼 미디어위키 문서 링크 기호인 대괄호 2개로 둘러싸야만 한다.
* <code>-links:(문서명)</code> - 지정한 문서 내부에서 링크로 연결된 문서들을 대상으로 수행한다.
* <code>-page:(문서명)</code> - 지정한 문서 하나를 대상으로 작업을 수행한다.
* <code>-ref:(문서명)</code> - 지정한 문서를 연결하는 링크를 포함하는 문서들들 대상으로 수행한다.
* <code>-start:(문서명)</code> - 위키 내에서 지정한 문서명을 시작으로 모든 문서들을 대상으로 수행한다. <code>-start:!</code>라고 표시하면 모든 문서에 대해 찾아 바꾸기를 수행할 수 있다.
* <code>-search:(키워드명)</code> - 위키 내에서 특정 키워드명을 포함하는 모든 문서를 대상으로 수행한다. 한 개의 단어만 찾아 바꾸기할 때는 이 조건을 명시하는 것이 효율적이다.
* <code>-xml:(로컬 xml파일명)</code> - [[특수:내보내기]]를 통해 작성된 로컬 디렉토리 안의 xml 파일 안에 있는 문서들을 대상으로 수행한다. XML 파일 내용을 바꾸는 것이 아닌 원본 위키의 문서들을 대상으로 찾아바꾸기 작업을 한다.

여기서 중요한 것은 스크립트 문구에 바꿀 내용은 큰따옴표를 반드시 '''포함한''' 형식이어야 한다. 특히 큰따옴표가 반드시 예약어로 사용하지 않는 명령 프롬프트(CMD) 환경에서는 큰 문제가 안 되지만 Powershell에서는 반드시 작은따옴표로 감싼 형태인 '"(내용)"'으로 표현해야 제대로 작동하는 것을 알 수 있다. 큰따옴표 내부에서 큰따옴표를 쓰고 싶다면 큰따옴표 두 번 입력해서 사용해야 한다.

찾아바꾸기 입력 조건은 <code>"찾을 키워드" "바꿀 키워드" "찾을 키워드2" "바꿀 키워드2" ...</code> 형식으로 입력하면 된다. 따라서 따옴표로 둘러싸인 부분은 반드시 '''짝수 개''' 입력해야 제대로 작동한다.

=== 정규표현식 사용 === 
정규표현식 사용할 때에는 -regex 문구를 앞에 집어넣는다.
<pre>> python pwb.py replace (파일 검색 옵션) -regex "(바꾸기전1)" "(바꾼후1)" "(바꾸기전2)" "(바꾼후2)" ... </pre>

역시 Powershell 환경에서는 큰따옴표 안에 큰따옴표를 집어넣고 싶으면 따옴표를 두 개 붙인 형태 ""로 사용하면 된다.

=== fix 패턴 사용 ===
특정한 fix 패턴을 사용할 때에는 -fix:(패턴명) 형태의 문구를 다음과 같이 집어넣는다. 기본적으로 다음과 같은 패턴이 예약되어 있으며, pywikibot 모듈 안의 fixes.py의 패턴을 불러오거나 없으면 메인 디렉토리의 user-fixes.py에 있는 변경패턴을 불러올 수 있다. 사용할 때는 아래처럼 -fix:(조건명) 형태로 붙여주면 된다.
<pre>> python pwb.py replace (파일 검색 옵션) -fix:(패턴명) "(바꾸기전1)" "(바꾼후1)" "(바꾸기전2)" "(바꾼후2)" ... </pre>

fixes.py에는 기본적으로 다음과 같은 패턴이 저장되어 있다. 다른 패턴은 독일어 관련이기에 생략.
* HTML - HTML로 파싱된 문서를 위키 문법으로 변경해준다.
* isbn - 오류가 있는 isbn 링크를 정정한다.
* syntax-safe - 오류가 있는 위키 마크업을 교정할 때 사용한다.

==== fix 패턴 사용하는 방법 ====
fixes라는 이름의 딕셔너리<ref>참고로 파이썬에서 딕셔너리는 각 키의 명칭이 별도로 지정된 리스트를 의미한다. 예를 들면 {"a":['apple', 'ant'], "b":['bread']}처럼 단순히 숫자로 위치값만 있는 리스트가 아닌 a, b처럼 각 요소들의 위치 이름(키값)이 별도로 지정된 것이다.</ref>는 키값이 패턴명, 키값에 대응하는 값(value)은 다른 형태의 딕셔너리로 되어 있다. 즉,
fixes = {'패턴명' : ({변환 패턴 딕셔너리}), ...}

다시 변환 패턴도 fixes의 하위 딕셔너리인데, 이것도 다음과 같이 구성되어 있음을 알 수 있다.

<syntaxhighlight lang='python'>
(변환 패턴) = {'regex' : False,  # 정규표현식 사용 여부
               'recursive' : False, #패턴이 없어질 때까지 반복실행할지 여부. 보통 사용하지 않는다.
               'nocase' : False, #로마자/키릴 문자 사용할 때만 유효. 한국어에는 영향이 없다.

               'msg' : '(편집 요약)', # 편집요약을 자동으로 입력 가능하다.
               'replacements' : [ ('(변환 전1)', '(변환 후1)'), #replacement 자체는 리스트,
                                  ('(변환 전2)', '(변환 후2)'), ... # 각 요소는 (변경 전, 변경 후) 형태로 입력
                                 ],
               'exceptions':{'inside-tags' : ['(변환 예외 태그명)', ... #태그 내부에서는 변환이 이루어지지 않음.
                                               ],
                            'text-contains' : ['(변환 예외 패턴)', ... #변환 패턴이 특정 텍스트 패턴을 포함하면 변환 없음
                                               ],
                            'inside' : ['(변환 예외 패턴)', ... #특정한 패턴 내부에 있으면 변환되지 않음.
                                       ],
                             'title' : ['(변환 예외 문서명)', ... #변환하지 않을 문서명
                                       ], #title 대신 required-title이라고 지정하면 리스트 안의 문서면 변환 가능하다.
                             'include' : (변환 예외 패턴 딕셔너리명)  #문서 내부 혹은 외부에 지정된 딕셔너리 패턴을 고스란히 포함한다.
                                          #각 패턴도 키값이 inside-tags, text-contains, inside, title 등을 포함해야 한다.
                             },
              }
</syntaxhighlight>
여기서 변환 후 패턴은 일반 문자열 패턴/정규표현식 포함 문자열 패턴을 나열하거나 아니면 함수를 사용할 수도 있다. 함수를 사용할 때에는 일단 'regex':True를 지정해서 정규표현식을 사용하는 방식을 사용하고, 입력 변수명을 반드시 변수명을 match라는 이름으로 사용해야 하며, 반드시 string을 리턴하는 함수여야 한다.

<syntaxhighlight lang="python">
def methodname(match):
    (함수 정의)
    return res #반드시 스트링을 반환.
</syntaxhighlight>
여기서 match 클래스에서 사용할 수 있는 인스턴스/메소드 몇 개만 소개한다.
* match.string - 해당 패턴이 있는 문서 '''전체'''의 위키 텍스트를 반환한다.
* match.group(num) - 해당 정규식 패턴의 괄호 안의 패턴명. num에 아무것도 없으면 바꾸고자 하는 정규식 패턴 전체 스트링을 반환한다.
* match.start() - 해당 정규식 패턴의 시작 문자에 대해 위키텍스트 내부의 위치하는 값을 반환한다. 일례로 match.string[:match.start()]는 해당 패턴이 발견된 텍스트를 빼고 앞부분을 의미하며, match.string[match.start():]는 발견 패턴을 맨 앞에 두는 텍스트 뒷부분을 의미한다.
* match.end() - 해당 정규식 패턴의 끝 문자에 대해 위키텍스트 내부의 위치하는 값을 반환한다.

참조 : [https://hu.wikipedia.org/wiki/Szerkeszt%C5%91:Bin%C3%A1ris/Fixes_and_functions_HOWTO 헝가리 위키백과 Bináris 사용자의 Fixes_and_functions_HOWTO 문서]

== 커스텀 스크립트 짜는 방법 ==
때로는 기존에 있는 Pywikibot 스크립트 대신에 (Pywikibot이 설치된 디렉토리)/scripts/userscripts에 자신이 저장한 스크립트를 실행시킬 수 있다. 간단한 스크립트 파일 예시로 pywikibot을 통해 로그인한 후에 텍스트를 바꾸는 예시이다. 다음과 같이 스크립트를 준비한 뒤, text_change.py로 지정한다.
<syntaxhighlight lang="python">
#파일 이름은 text_change.py
import pywikbot #Pywikibot의 내부 모듈을 사용할 때 사용한다.

# Pywikibot에서 문서 편집 시에는 pywikibot.Site('언여명', '패밀리명')로 사이트 지정.
# pywikibot.Site()이면 login.py로 지정된 사이트만 확인
site = pywikibot.Site('ko', 'libre')
# 사이트 로그인하고 싶을 때는 다음과 같이 사용한다. 먼저 user-password.py에서 비밀번호 정보를 지정해야 한다.
site.login()
#페이지 조회할 때는 pywikibot.Page() 함수사용
page= pywikibot.Page(site, 'Pywikibot')
# 페이지 텍스트 추출할 때는 page.text 명령어 사용
txt = page.text 
# 페이지를 변경하고 싶으면 page.text를 변경한 후 page.save('편집 요약문') 사용
page.text = txt.replace('pywikibot', '파이위키봇')
page.save('한글로 바꾸기')
# 로그아웃할 때는 다음과 같이 이용해보자.
site.logout()
</syntaxhighlight>
그 다음에 다음과 같은 명령어를 이용하면 텍스트 변환이 가능하다.
<pre>> python pwb.py text_change</pre>

{{각주}}
[[분류:미디어위키]]
[[분류:위키 소프트웨어]]