وEarwigBot هو الروبوت بيثون أن التعديلات ويكيبيديا ويتفاعل مع الناس على IRC & nbsp؛ يمكنك يوفر هذا الملف لمحة الأساسية لكيفية تثبيت وإعداد بوت. يقع معلومات أكثر تفصيلا في مستندات / الدليل (متوفر على الإنترنت على PyPI).
تاريخ
بدأت التنمية، استنادا إلى إطار Pywikipedia، في أوائل عام 2009. الموافقة على مهمتها قبضة، للكشف عن انتهاك حقوق الطبع والنشر، أجريت في شهر مايو، وتم بوت تشغيل باستمرار منذ ذلك الحين (باستثناء يناير / فبراير 2011). وهو يتولى حاليا عدة مهام الجارية التي تتراوح من جيل الإحصاءات لفئة التنظيف، والمهام عند الطلب مثل مشروع ويكي قالب العلامات. منذ أن بدأت تشغيل، جعلت بوت أكثر من 50،000 التعديلات.
وبدأ مشروع لإعادة كتابة من الصفر في أوائل نيسان 2011، وبالتالي الابتعاد عن الإطار Pywikipedia والسماح لأقل كود العام، تكامل أفضل بين أجزاء بوت، وسهولة الصيانة.
تركيب
تحتوي هذه الحزمة على earwigbot الأساسية، المستخرجة بما فيه الكفاية أنه ينبغي أن تكون قابلة للاستخدام وقابلة للتخصيص من قبل أي شخص يعمل على بوت على موقع ميدياويكي. لأنه قائم على مكون، يمكن تعطيل مكونات IRC اذا شئت. تتوفر من مستودع earwigbot-الإضافات الأوامر IRC والمهام بوت محددة لبلدي مثيل EarwigBot أنني لا يشعر المستخدم العادي سوف تحتاج إليها.
من المستحسن لتشغيل وحدة الاختبارات بوت قبل تركيب. تشغيل الثعبان اختبار setup.py من الدليل الجذر للمشروع. لاحظ أن بعض الاختبارات تتطلب اتصال بالإنترنت، والبعض الآخر قد يستغرق بعض الوقت لتشغيل. التغطية حاليا غير مكتملة إلى حد ما.
نصب
بوت بتخزين البيانات الخاصة به في "دليل العمل"، بما في ذلك ملف التكوين وقواعد البيانات. وهذا أيضا هو المكان الذي سوف تضع أوامر IRC العرف والمهام بوت، الذي سيتم شرحه لاحقا. لا يهم أين هذا الدليل هو، طالما بوت يمكن أن يكتب لها.
بدء تشغيل بوت مع مسار earwigbot / إلى / العمل / دير، أو earwigbot فقط إذا كان دليل العمل هو الدليل الحالي. وسوف تلاحظ أن أي ملف config.yml موجود ويأخذك من خلال عملية الإعداد.
لا يوجد حاليا أي وسيلة لتحرير الملف config.yml من داخل بوت بعد أن تم إنشاؤه، ولكن YAML هو تنسيق واضحة جدا، لذلك يجب أن تكون قادرة على إجراء أية تغييرات ضرورية نفسك. تحقق من شرح YAML في ويكيبيديا للحصول على المساعدة.
بعد الإعداد، ستبدأ بوت. هذا يعني أنه سيربط إلى خوادم IRC تم تكوينه ل، جدولة المهام بوت للتشغيل في أوقات محددة، ومن ثم الانتظار للحصول على تعليمات (كأوامر على IRC). للحصول على قائمة من الأوامر، ويقول "مساعدة!" (أوامر هي عبارة عن رسائل مسبوقة مع علامة تعجب).
يمكنك إيقاف بوت في أي وقت مع التحكم + C، نفس إيقاف برنامج بيثون العادي، وانها ستحاول الخروج بأمان. يمكنك أيضا استخدام "! الإقلاع عن التدخين" أمر على IRC.
تخصيص
يحتوي على دليل العمل بوت في دليل فرعي الأوامر ودليل فرعي المهام. يمكن وضع أوامر IRC مخصصة في السابق، في حين مخصصة المهام يكي بوت الخوض في الأخير. تطوير وحدات مخصصة وأوضح أدناه، وبمزيد من التفصيل من خلال وثائق بوت على PyPI (أو في مستندات / دير).
لاحظ أن أوامر مخصصة ستتجاوز المدمج في الأوامر والمهام بنفس الاسم.
بوت وBotConfig
earwigbot.bot.Bot هي الطبقة الرئيسية EarwigBot ل. لم يكن لديك لإنشاء مثيل هذا بنفسك، ولكن من الجيد أن يكون على دراية خصائصها وطرق، لأنه هو السبيل الرئيسي للتواصل مع أجزاء أخرى من بوت. كائن بوت يمكن الوصول إليه كسمة من الأوامر والمهام (أي self.bot).
earwigbot.config.BotConfig المعلومات مخازن التكوين لبوت. يشرح docstring لها ما يستخدم لكل سمة ل، ولكن أساسا كل "عقدة" (واحدة من config.components، ويكي، المركز، الأوامر والمهام والفوقية) خرائط لقسم من ملف config.yml بوت ل. على سبيل المثال، إذا config.yml يتضمن شيئا مثل:
IRC:
على & nbsp؛ الواجهة:
على & nbsp؛ نيك: MyAwesomeBot
وعنبسة، قنوات:
على & nbsp؛ - "## earwigbot"
على & nbsp؛ - "القناة #"
على & nbsp؛ - "# غيرها من القنوات"
... ثم سوف config.irc ["الواجهة"] ["نيك"] يكون "MyAwesomeBot" وconfig.irc ["الواجهة"] ["قنوات"] سيكون ["## earwigbot"، "القناة #"، "# غيرها من قناة"].
أوامر IRC مخصصة
أوامر مخصصة هي الفئات الفرعية من earwigbot.commands.Command أن تجاوز عملية القيادة و() (والاختيار اختياريا () أو الإعداد ()) الأساليب.
بوت لديها تشكيلة واسعة من المدمج في الأوامر والإضافات ليكون بمثابة نموذج التعليمات البرمجية و / أو لإعطاء الأفكار. تبدأ مع اختبار، ومن ثم تحقق من chanops وafc_status لبعض النصوص أكثر تعقيدا.
المهام بوت مخصصة
المهام المخصصة هي الفئات الفرعية من earwigbot.tasks.Task أن تجاوز المدى المهمة () (والإعداد اختياريا ()) الأساليب.
رؤية مهمة wikiproject_tagger المدمج في لمهمة بسيطة نسبيا، أو afc_statistics المساعد لواحد أكثر تعقيدا.
ويكي مجموعة أدوات
الجواب EarwigBot في إطار Pywikipedia هي ويكي مجموعة أدوات (earwigbot.wiki)، والتي سوف الوصول بشكل رئيسي من خلال bot.wiki.
يوفر bot.wiki ثلاث طرق لإدارة مواقع - get_site ()، add_site ()، وremove_site (). المواقع هي الكائنات التي تمثل ببساطة موقع ميدياويكي. ومن المتوقع أن تتصل موقع واحد أو مجموعة من المواقع التي تستخدم نفس معلومات الدخول (مثل كل الويكي WMF مع CentralAuth) طبعة واحدة من EarwigBot (أي دليل عمل واحد).
تحميل الموقع الافتراضي الخاص بك (احد ان كنت التقطت أثناء الإعداد) مع الموقع = bot.wiki.get_site ().
لا يغطي جميع جوانب مجموعة أدوات في مستندات. استكشاف رمزها وجمل التوثيق لمعرفة كيفية استخدامها في أكثر من التدريب العملي على الموضة. للإشارة، bot.wiki هو مثيل earwigbot.wiki.SitesDB مرتبطة الملف sites.db في دليل العمل بوت ل
المتطلبات:.
بيثون
لم يتم العثور على التعليقات