jenkins-bot merged this change.

View Change

[IMPR] move specialbots.py to its own folder

Currently specialbots holds BaseBot templates for UploadRobot used by
several scripts and BaseUnlinkBotused by selflink.py and unlink.py
scripts. But there are other scripts like add_txt, cache, category,
image, imagerecat, noreferences, replace which are reused several by
other scripts and should be places here.

Change-Id: I1379ced2f0e04ae484101edfef13da08111c2eff
---
M docs/api_ref/pywikibot.rst
A docs/api_ref/pywikibot.specialbots.rst
M pywikibot/CONTENT.rst
M pywikibot/DIRECTORIES.rst
R pywikibot/specialbots/__init__.py
M tox.ini
6 files changed, 15 insertions(+), 8 deletions(-)

diff --git a/docs/api_ref/pywikibot.rst b/docs/api_ref/pywikibot.rst
index 5c05135..aaaf2f3 100644
--- a/docs/api_ref/pywikibot.rst
+++ b/docs/api_ref/pywikibot.rst
@@ -13,6 +13,7 @@
     pywikibot.families
     pywikibot.page
     pywikibot.site
+    pywikibot.specialbots
     pywikibot.tools
     pywikibot.userinterfaces
 
@@ -129,11 +130,6 @@
 
 .. automodule:: pywikibot.site_detect
 
-pywikibot.specialbots module
-----------------------------
-
-.. automodule:: pywikibot.specialbots
-
 pywikibot.textlib module
 ------------------------
 
diff --git a/docs/api_ref/pywikibot.specialbots.rst b/docs/api_ref/pywikibot.specialbots.rst
new file mode 100644
index 0000000..901605d
--- /dev/null
+++ b/docs/api_ref/pywikibot.specialbots.rst
@@ -0,0 +1,4 @@
+pywikibot.specialbots package
+=============================
+
+.. automodule:: pywikibot.specialbots
diff --git a/pywikibot/CONTENT.rst b/pywikibot/CONTENT.rst
index d0ae901..5c8669f 100644
--- a/pywikibot/CONTENT.rst
+++ b/pywikibot/CONTENT.rst
@@ -59,8 +59,6 @@
     +----------------------------+------------------------------------------------------+
     | site_detect.py             | Classes for detecting a MediaWiki site               |
     +----------------------------+------------------------------------------------------+
-    | specialbots.py             | Predefined special bot classes                       |
-    +----------------------------+------------------------------------------------------+
     | textlib.py                 | Functions for manipulating wiki-text                 |
     +----------------------------+------------------------------------------------------+
     | throttle.py                | Mechanics to slow down wiki read and/or write rate   |
@@ -114,6 +112,13 @@
 
 
     +----------------------------+------------------------------------------------------+
+    | specialbots                | Module containing special bots reusable by scripts   |
+    +============================+======================================================+
+    | __init__.py                | Predefined special bot classes                       |
+    +----------------------------+------------------------------------------------------+
+
+
+    +----------------------------+------------------------------------------------------+
     | tools                      | Miscellaneous helper functions (not wiki-dependent). |
     +============================+======================================================+
     | __init__.py                | several classes and methods                          |
diff --git a/pywikibot/DIRECTORIES.rst b/pywikibot/DIRECTORIES.rst
index 3e1fe86..d2b3c1b 100644
--- a/pywikibot/DIRECTORIES.rst
+++ b/pywikibot/DIRECTORIES.rst
@@ -16,6 +16,8 @@
     +---------------------------+------------------------------------------------------+
     |  pywikibot/site           | Module with classes for MediaWiki sites              |
     +---------------------------+------------------------------------------------------+
+    |  pywikibot/specialbots    | Module containing special bots reusable by scripts   |
+    +---------------------------+------------------------------------------------------+
     |  pywikibot/tools          | Miscellaneous helper functions (not wiki-dependent)  |
     +---------------------------+------------------------------------------------------+
     |  pywikibot/userinterfaces | GUI and terminal interface                           |
diff --git a/pywikibot/specialbots.py b/pywikibot/specialbots/__init__.py
similarity index 100%
rename from pywikibot/specialbots.py
rename to pywikibot/specialbots/__init__.py
diff --git a/tox.ini b/tox.ini
index b0c26f8..7eb1bd2 100644
--- a/tox.ini
+++ b/tox.ini
@@ -144,7 +144,7 @@
     pywikibot/page/__init__.py: N802
     pywikibot/pagegenerators.py : N802, N803, N806, N816
     pywikibot/site/__init__.py: N802, N815
-    pywikibot/specialbots.py : N803, N806, N802
+    pywikibot/specialbots/__init__.py : N803, N806, N802
     pywikibot/textlib.py : N801, N802, N803, N806, N816
     pywikibot/throttle.py: N802
     pywikibot/tools/_logging.py: N802

To view, visit change 591032. To unsubscribe, or for help writing mail filters, visit settings.