diff options
Diffstat (limited to 'docs/write_plugins.rst')
| -rw-r--r-- | docs/write_plugins.rst | 46 |
1 files changed, 25 insertions, 21 deletions
diff --git a/docs/write_plugins.rst b/docs/write_plugins.rst index b513a5978..0b568f74c 100644 --- a/docs/write_plugins.rst +++ b/docs/write_plugins.rst @@ -3,15 +3,15 @@ Plugins ======= -A Plugin is a python file located at one of the subfolders in :file:`module/plugins/`. Either :file:`hoster`, :file:`crypter` +A Plugin is a python file located at one of the subfolders in :file:`pyload/plugin/`. Either :file:`hoster`, :file:`crypter` or :file:`container`, depending of it's type. There are three kinds of different plugins: **Hoster**, **Crypter**, **Container**. -All kind of plugins inherit from the base :class:`Plugin <module.plugins.Plugin.Plugin>`. You should know its +All kind of plugins inherit from the base :class:`Plugin <pyload.plugin.Plugin.Plugin>`. You should know its convenient methods, they make your work easier ;-) -Every plugin defines a ``__pattern__`` and when the user adds urls, every url is matched against the pattern defined in -the plugin. In case the ``__pattern__`` matched on the url the plugin will be assigned to handle it and instanciated when +Every plugin defines a ``__pattern`` and when the user adds urls, every url is matched against the pattern defined in +the plugin. In case the ``__pattern`` matched on the url the plugin will be assigned to handle it and instanciated when pyLoad begins to download/decrypt the url. Plugin header @@ -19,18 +19,19 @@ Plugin header How basic hoster plugin header could look like: :: - from module.plugin.Hoster import Hoster + from pyload.plugin.Hoster import Hoster + class MyFileHoster(Hoster): - __name__ = "MyFileHoster" - __version__ = "0.1" - __pattern__ = r"http://myfilehoster.example.com/file_id/[0-9]+" - __config__ = [] + __name = "MyFileHoster" + __version = "0.1" + __pattern = r"http://myfilehoster.example.com/file_id/[0-9]+" + __config = [] -You have to define these meta-data, ``__pattern__`` has to be a regexp that sucessfully compiles with -``re.compile(__pattern__)``. +You have to define these meta-data, ``__pattern`` has to be a regexp that sucessfully compiles with +``re.compile(__pattern)``. -Just like :ref:`write_hooks` you can add and use config values exatly the same way. +Just like :ref:`write_addons` you can add and use config values exatly the same way. If you want a Crypter or Container plugin, just replace the word Hoster with your desired plugin type. @@ -41,15 +42,16 @@ We head to the next important section, the ``process`` method of your plugin. In fact the ``process`` method is the only functionality your plugin has to provide, but its always a good idea to split up tasks to not produce spaghetti code. An example ``process`` function could look like this :: - from module.plugin.Hoster import Hoster + from pyload.plugin.Hoster import Hoster + class MyFileHoster(Hoster): """ plugin code """ - + def process(self, pyfile): - html = self.load(pyfile.url) # load the content of the orginal pyfile.url to html + html = self.load(pyfile.url) #: load the content of the orginal pyfile.url to html # parse the name from the site and set attribute in pyfile pyfile.name = self.myFunctionToParseTheName(html) @@ -58,7 +60,7 @@ An example ``process`` function could look like this :: # download the file, destination is determined by pyLoad self.download(parsed_url) -You need to know about the :class:`PyFile <module.PyFile.PyFile>` class, since an instance of it is given as parameter to every pyfile. +You need to know about the :class:`PyFile <pyload.Datatype.File.PyFile>` class, since an instance of it is given as parameter to every pyfile. Some tasks your plugin should handle: proof if file is online, get filename, wait if needed, download the file, etc.. Wait times @@ -71,7 +73,7 @@ Captcha decrypting __________________ To handle captcha input just use ``self.decryptCaptcha(url, ...)``, it will be send to clients -or handled by :class:`Hook <module.plugins.Hook.Hook>` plugins +or handled by :class:`Addon <pyload.plugin.Addon.Addon>` plugins Crypter ------- @@ -81,23 +83,25 @@ Well, they work nearly the same, only that the function they have to provide is Example: :: - from module.plugin.Crypter import Crypter + from pyload.plugin.Crypter import Crypter + class MyFileCrypter(Crypter): """ plugin code """ + def decrypt(self, pyfile): urls = ["http://get.pyload.org/src", "http://get.pyload.org/debian", "http://get.pyload.org/win"] - self.packages.append(("pyLoad packages", urls, "pyLoad packages")) # urls list of urls + self.packages.append(("pyLoad packages", urls, "pyLoad packages")) #: urls list of urls -They can access all the methods from :class:`Plugin <module.plugins.Plugin.Plugin>`, but the important thing is they +They can access all the methods from :class:`Plugin <pyload.plugin.Plugin.Plugin>`, but the important thing is they have to append all packages they parsed to the `self.packages` list. Simply append tuples with `(name, urls, folder)`, where urls is the list of urls contained in the packages. Thats all of your work, pyLoad will know what to do with them. Examples -------- -Best examples are already existing plugins in :file:`module/plugins/`.
\ No newline at end of file +Best examples are already existing plugins in :file:`pyload/plugin/`. |