EarwigBot

.

EarwigBot Wikipedia edits və IRC insanlar ilə qarşılıqlı & nbsp bir Python robot deyil, Bu fayl bot qurmaq və quraşdırma üçün necə bir əsas ümumi təmin edir; daha ətraflı məlumat docs / kataloq (PyPI mövcud online) yerləşir.
History
İnkişaf onun ilk məsələ, bir müəllif hüquqları pozuntusu detector üçün erkən 2009-cu Təsdiq, Pywikipedia çərçivəsində əsasında, başladı may ayında həyata keçirilib və bot (Jan / Feb 2011 istisna olmaqla)-ci ildən ardıcıl heç çalışan edilmişdir. Hal-hazırda belə Maraqlar şablon etiketleme kimi bir neçə davam edən statistika nəsil kateqoriya təmizləmə qədər vəzifələri, və on-demand vəzifələri yapar. Çalışan başladı, bot 50.000 redaktələri artıq olmuşdur.
Sıfırdan yeniden yazmaq üçün layihə beləliklə üz Pywikipedia çərçivəsində hərəkət və daha az ümumi kodu bot hissələri arasında daha yaxşı inteqrasiya, və daha asan saxlanılması üçün imkan erkən aprel 2011-ci ildə başladı.
Quraşdırma
Bu paket bir MediaWiki saytda bir bot çalışan hər kəs tərəfindən istifadə və özelleştirilebilir olmalıdır ki, kifayət qədər Abstrak əsas earwigbot ehtiva edir. Bu komponent-based olduğundan İstənilən halda, IRC komponentləri əlil ola bilər. Mən lazım olacaq orta istifadəçi hiss etmir EarwigBot mənim Məsələn xüsusi IRC əmrləri və bot vəzifələri depo earwigbot-plugins mövcuddur.
Bu yüklemeden əvvəl bot vahid test run etmək tövsiyə olunur. Layihənin kök kataloq python setup.py test Run. Bəzi testlər internet bağlantısı tələb edir, və s çalıştırmak üçün bir müddət bilər unutmayın. Əhatə hazırda daha tam deyil.
Quraşdırma
bot onun konfiqurasiya faylını və verilənlər bazası, o cümlədən "iş kataloq" öz data saklar. Bu da xüsusi IRC əmrləri və sonra izah ediləcək bot vəzifələri, olacaq yeridir. Bu kataloq kimi uzun bot yazmaq kimi, olduğu əhəmiyyətli deyil.
Earwigbot yolu ilə bot başlamaq / / iş / dir, və ya iş directory cari kataloq əgər yalnız earwigbot üçün. Bu, heç bir config.yml fayl var ki, qeyd və quraşdırma prosesi vasitəsilə götürür.
Orada yaradılmışdır sonra bot ərzində config.yml fayl redaktə etmək üçün heç bir yol hazırda, lakin hər hansı bir zəruri dəyişikliklər özünüz etmək lazımdır, belə ki, YAML, bir çox sadə format edir. Kömək Vikipediya haqqında yaml izahı oldu.
Quraşdırma sonra, bot başlayacaq. Bu (IRC əmrləri kimi) müəyyən vaxtlarda çalıştırmak üçün cədvəli bot vəzifələri üçün yapılandırılmış edilmişdir IRC server qoşulmaq və sonra təlimatlar üçün gözləmək deməkdir. Əmrləri bir siyahısı üçün, "yardım" (əmrləri bir nida işarəsi ilə prefixed mesajlarıdır) deyirlər.
Bir normal Python proqramını dayandırmaq kimi eyni Control + C, heç bir zaman bot dayandıra bilər və bu, təhlükəsiz çıxmaq üçün çalışacağıq. Siz həmçinin IRC "istefa" funksiyanı istifadə edə bilərsiniz.
Customizing
bot iş directory bir əmrləri alt və vəzifələri alt ehtiva edir. Xüsusi wiki bot vəzifələri sonuncu daxil isə xüsusi IRC əmrləri, köhnə yerləşdirilə bilər. PyPI haqqında bot sənədlərə aşağıda izah, və daha ətraflı xüsusi modulları edir İnkişaf (və ya docs / dir).
Xüsusi əmrləri eyni adı ilə daxili əmrləri və vəzifələri yalnış düçar edər ki, unutmayın.
Bot və BotConfig
earwigbot.bot.Bot EarwigBot əsas sinif edir. Bu özünüzü instantiate yoxdur, lakin bot digər hissələri ilə ünsiyyət üçün əsas yoldur, çünki, onun atributları və metodları ilə tanış olmaq üçün yaxşı deyil. A Bot obyekt əmrləri və vəzifələri (yəni, self.bot) bir atributu kimi erişilebilir.
bot üçün earwigbot.config.BotConfig mağazaları konfiqurasiya məlumat. Onun docstring hər atribut üçün istifadə olunur, lakin mahiyyətcə hər bir "node" (config.components, wiki, irc, əmrləri, vəzifələrdən biridir, və metadata) bot config.yml faylı bir hissəsində xəritələr nə izah edir. Məsələn, əgər config.yml kimi bir şey daxildir:
irc:
& Nbsp; Ön:
& Nbsp; yol: MyAwesomeBot
& Nbsp; kanalları:
& Nbsp; - "## earwigbot"
& Nbsp; - "#channel"
& Nbsp; - "#, digər kanal"
... Sonra config.irc ["Ön"] ["yol"] "MyAwesomeBot" və config.irc ["Ön"] ["kanallar"] olmağa "[## earwigbot", "#channel" olacaq, "#, digər kanal"].
Xüsusi IRC əmrləri
Xüsusi əmrləri Komandanlığının prosesi () (və isteğe yoxlamaq () və ya quraşdırma ()) üsulları yalnış earwigbot.commands.Command subclasses var.
bot örnek kod kimi çıxış etmək və / və ya fikir vermək üçün daxili əmrləri və plugins geniş seçim var. Test ilə başlamaq, və sonra bir daha mürəkkəb scripts üçün chanops və afc_status oldu.
Xüsusi bot vəzifələri
Xüsusi vəzifələri Task run () (və isteğe quraşdırma ()) üsulları yalnış earwigbot.tasks.Task subclasses var.
Nisbətən sadə vəzifə üçün daxili wikiproject_tagger vəzifəsi baxın, və ya afc_statistics daha mürəkkəb bir plugin.
Wiki araç qrupu
Pywikipedia çərçivəsində EarwigBot cavab əsasən bot.wiki vasitəsilə daxil olacaq Wiki araç qrupu (earwigbot.wiki) edir.
bot.wiki üç Saytlar idarə üsulları təqdim edir - get_site (), add_site () və remove_site (). Saytlar sadəcə bir MediaWiki site təmsil obyektləri. EarwigBot vahid instansiya (yəni bir iş kataloq) bir site və ya (centralauth bütün WMF wikis kimi) eyni giriş info istifadə saytlar qrupuna aid gözlənilir.
U mənim site site = bot.wiki.get_site ilə (Əgər quraşdırma zamanı seçilmiş bir) bərpa edin ().
Araç qrupu bütün aspektləri docs əhatə olunur. Daha hands-on moda istifadə etmək necə öyrənmək üçün kodu və docstrings keşfedin. Sened üçün, bot.wiki bot iş kataloq sites.db fayl bağlıdır earwigbot.wiki.SitesDB bir misal edir