EarwigBot

EarwigBot yra Python robotas, kuris redaguoja Vikipediją ir bendrauja su žmonėmis, nei IRC & nbsp;. Ši byla suteikia pagrindinę apžvalgą apie tai, kaip įdiegti ir sukonfigūruoti botas; Išsamesnė informacija yra įsikūręs docs / katalogą (galima rasti internete adresu PyPI).
Istorija
Plėtros prasidėjo, remiantis Pywikipedia sistemos, pradžioje 2009 patvirtinimo savo kumštį užduotį, apie autorinių teisių pažeidimą detektoriumi, buvo atliktas gegužės mėnesį, botas veikia jau nuosekliai kada, nes (su Jano / vasaris 2011, išskyrus). Šiuo metu ji tvarko keletą vykstančių užduotis, pradedant nuo statistika kartos į kategorijos valymo ir on-demand užduotis, pavyzdžiui, WikiProject šablonų žymėjimas. Kadangi ji paleista, botas padarė per 50.000 keitimus.
Projektas perrašyti iš naujo pradėjo 2011 balandžio pradžioje, taigi tolsta nuo Pywikipedia sistemą ir numatant mažiau bendro kodo, geriau integruoti tarp Bot dalių ir lengviau prižiūrėti.
Diegimas
Šis paketas yra pagrindinis earwigbot, pakankamai abstrakčių, kad ji turėtų būti bet kas, kuriame veikia ant MediaWiki svetainėje botas naudoti ir pritaikoma. Kadangi tai yra komponentas pagrįstas, IRC komponentai gali būti išjungta, jei reikia. IRC komandas ir bot uždaviniai specifiniai mano instancijos EarwigBot, kad aš nejaučiu vidutinį vartotoją reikės yra iš kapinyno earwigbot-plugins.
Tai rekomenduojama, prieš diegiant paleisti botą vieneto bandymai. Vykdyti python setup.py testą iš projekto kataloge. Atkreipkite dėmesį, kad kai kurie testai reikalauja interneto ryšį, o kiti gali užtrukti paleisti. Aprėptis šiuo metu gana neišsami.
Sąranka "
Botas saugo savo duomenis į "darbo directory", įskaitant jos konfigūracijos failo ir duomenų bazių. Tai taip pat vieta, kur jūs įdėti pasirinktinį IRC komandas ir automatinių užduotis, kurios bus paaiškinta vėliau. Nesvarbu, jei tai katalogas yra tol, kol botas gali rašyti į jį.
Pradėti botą su earwigbot kelias / iki / darbo / rež arba tiesiog earwigbot jei dirba katalogas yra einamojo katalogo. Jis bus pastebėti, kad ne config.yml failas egzistuoja ir jus per sąrankos procesą.
Šiuo metu nėra būdas redaguoti config.yml failą iš per boto kai jis jau buvo sukurta, bet yaml yra labai paprasta formatas, taigi jums turėtų būti suteikta galimybė atlikti bet kokius reikalingus pakeitimus sau. Check out YAML paaiškinimą Wikipedia pagalbos.
Po nustatymo, botas bus pradėti. Tai reiškia, kad jis bus prisijungti prie IRC serverių buvo sukonfigūruotas, grafikas Bot užduočių paleisti tam tikru laiku, o tada laukti nurodymų (kaip komandų IRC). Dėl komandų sąrašą, sako! "Pagalbos" (komandos pranešimus priešdėliu su šauktuku).
Jūs galite sustabdyti bet kuriuo metu su Ctrl + C, tuo pačiu botas, kaip jūs sustabdyti įprastą Python programą, ir jis bandys išeiti saugiai. Jūs taip pat galite naudoti "! Mesti" komandą IRC.
Pritaikyti
Botas darbiniame kataloge yra komandomis pakatalogį ir užduočių pakatalogį. Individualizuotos IRC komandos gali būti dedamas buvęs, o užsakymą wiki Bot užduotis eiti į pastarąją. Kuriant užsakymą modulius yra paaiškinta toliau, ir išsamiau per botas dokumentaciją apie PyPI (arba docs / rež).
Atkreipkite dėmesį, kad pagal užsakymą komandas pakeis įmontuotą komandas ir užduotis su tuo pačiu pavadinimu.
Bot ir BotConfig
earwigbot.bot.Bot yra pagrindinis EarwigBot klasė. Jūs neturite instancija tai sau, bet tai gerai, turi būti susipažinę su jos atributus ir metodus, nes tai yra pagrindinis būdas bendrauti su kitais dalių boto. Bot objektas yra prieinama kaip komandas ir užduotis (ty self.bot) atributas.
earwigbot.config.BotConfig parduotuvės konfigūracija informacija boto. Jo docstring paaiškina ką kiekvienas atributas naudojamas, bet iš esmės kiekvienas "mazgas" (vienas iš config.components, wiki, IRC, komandas, užduotis, ir metaduomenys) žemėlapiai prie boto anketa config.yml failo skyriuje. Pavyzdžiui, jei config.yml apima kažką panašaus į:
IRC:
& Nbsp; front:
& Nbsp; Nick: MyAwesomeBot
& nbsp; kanalai:
& Nbsp; - "## earwigbot"
& Nbsp; - "#kanalas"
& Nbsp; - "# kitą kanalų"
... Tada config.irc ["front"] ["nick"] bus "MyAwesomeBot" ir config.irc ["sąsajos"] ["kanalai"], bus ["## earwigbot", "#kanalas" "# kitą kanalo"].
Individualizuotos IRC komandos
Individualizuotos komandos poklasiai earwigbot.commands.Command, kurios yra viršesnės komandą anketa procesą () (ir pasirinktinai patikrinimas () arba sąrankos ()) metodus.
Botas turi platų įmontuotais komandų ir įskiepių veikti kaip mėginio kodą ir / ar teikti idėjas. Pradėti testą, ir tada patikrinkite chanops ir afc_status kai daugiau sudėtingų scenarijų.
Individualizuotos Bot užduotys
Individualizuotos uždaviniai yra poklasiai earwigbot.tasks.Task, kurios yra viršesnės užduotį atsivėdėti () (ir pasirinktinai sąrankos ()) metodus.
Žr built-in wikiproject_tagger užduotį gana paprasta užduotis, arba afc_statistics plugin labiau sudėtingas.
Wiki Toolset
EarwigBot atsakymas į Pywikipedia sistemoje yra wiki Toolset (earwigbot.wiki), kurį daugiausia prieigą per bot.wiki.
bot.wiki numato tris metodus Sklypai valdymas - get_site () add_site () ir remove_site (). Sklypai yra objektai, kurie tiesiog atspindinčių MediaWiki svetainėje. Vieno atvejo EarwigBot (ty ne vienoje darbo kataloge) Tikimasi, susijusios su vienoje vietoje ar grupės svetainių, naudojant tą patį prisijungimo informacija (pavyzdžiui, visų WMF wiki su CentralAuth).
Įkelti savo numatytąją vietą (vieną, kad jūs įlaipinami sąrankos metu) su tinklapiu = bot.wiki.get_site ().
Ne visi įrankių rinkinio aspektai yra įtraukti į docs. Naršyti savo kodą ir docstrings išmokti jį panaudoti daugiau praktinės mados. Dėl informacijos, bot.wiki yra iš earwigbot.wiki.SitesDB atvejis susieta su sites.db failą Bot darbinio katalogo

Reikalavimai :.

• Python