diff options
Diffstat (limited to 'docs/plugins')
| -rw-r--r-- | docs/plugins/addon_plugin.rst | 40 | ||||
| -rw-r--r-- | docs/plugins/base_plugin.rst | 16 | ||||
| -rw-r--r-- | docs/plugins/crypter_plugin.rst | 12 | ||||
| -rw-r--r-- | docs/plugins/hoster_plugin.rst | 8 |
4 files changed, 38 insertions, 38 deletions
diff --git a/docs/plugins/addon_plugin.rst b/docs/plugins/addon_plugin.rst index e18bd6b0f..bef5b115e 100644 --- a/docs/plugins/addon_plugin.rst +++ b/docs/plugins/addon_plugin.rst @@ -3,20 +3,20 @@ Addon - Add new functionality ============================= -A Hook is a python file which is located at :file:`module/plugins/hooks`. -The :class:`HookManager <module.HookManager.HookManager>` will load it automatically on startup. Only one instance exists -over the complete lifetime of pyload. Your hook can interact on various events called by the :class:`HookManager <module.HookManager.HookManager>`, -do something completely autonomic and has full access to the :class:`Api <module.Api.Api>` and every detail of pyLoad. +A Hook is a python file which is located at :file:`pyload/plugins/hooks`. +The :class:`HookManager <pyload.HookManager.HookManager>` will load it automatically on startup. Only one instance exists +over the complete lifetime of pyload. Your hook can interact on various events called by the :class:`HookManager <pyload.HookManager.HookManager>`, +do something completely autonomic and has full access to the :class:`Api <pyload.Api.Api>` and every detail of pyLoad. The UpdateManager, CaptchaTrader, UnRar and many more are implemented as hooks. Hook header ----------- -Your hook needs to subclass :class:`Hook <module.plugins.Hook.Hook>` and will inherit all of its methods, so make sure to check it's documentation! +Your hook needs to subclass :class:`Hook <pyload.plugins.Hook.Hook>` and will inherit all of its methods, so make sure to check it's documentation! All hooks should start with something like this: :: - from module.plugins.Hook import Hook + from pyload.plugins.Hook import Hook class YourHook(Hook): __name__ = "YourHook" @@ -43,16 +43,16 @@ Interacting on Events The next step is to think about where your Hook action takes place. -The easiest way is to overwrite specific methods defined by the :class:`Hook <module.plugins.Hook.Hook>` base class. +The easiest way is to overwrite specific methods defined by the :class:`Hook <pyload.plugins.Hook.Hook>` base class. The name is indicating when the function gets called. -See :class:`Hook <module.plugins.Hook.Hook>` page for a complete listing. +See :class:`Hook <pyload.plugins.Hook.Hook>` page for a complete listing. -You should be aware of the arguments the hooks are called with, whether its a :class:`PyFile <module.PyFile.PyFile>` -or :class:`PyPackage <module.PyPackage.PyPackage>` you should read the relevant documentation to know how to access it's great power and manipulate them. +You should be aware of the arguments the hooks are called with, whether its a :class:`PyFile <pyload.PyFile.PyFile>` +or :class:`PyPackage <pyload.PyPackage.PyPackage>` you should read the relevant documentation to know how to access it's great power and manipulate them. What a basic excerpt would look like: :: - from module.plugins.Hook import Hook + from pyload.plugins.Hook import Hook class YourHook(Hook): """ @@ -70,12 +70,12 @@ in a thread, in order to not block the main thread. This should be used for all Another and more flexible and powerful way is to use the event listener. All hook methods exists as event and very useful additional events are dispatched by the core. For a little overview look -at :class:`HookManager <module.HookManager.HookManager>`. Keep in mind that you can define your own events and other people may listen on them. +at :class:`HookManager <pyload.HookManager.HookManager>`. Keep in mind that you can define your own events and other people may listen on them. For your convenience it's possible to register listeners automatically via the ``event_map`` attribute. It requires a `dict` that maps event names to function names or a `list` of function names. It's important that all names are strings :: - from module.plugins.Hook import Hook + from pyload.plugins.Hook import Hook class YourHook(Hook): """ @@ -96,7 +96,7 @@ It requires a `dict` that maps event names to function names or a `list` of func An advantage of the event listener is that you are able to register and remove the listeners at runtime. Use `self.manager.addEvent("name", function)`, `self.manager.removeEvent("name", function)` and see doc for -:class:`HookManager <module.HookManager.HookManager>`. Contrary to ``event_map``, ``function`` has to be a reference +:class:`HookManager <pyload.HookManager.HookManager>`. Contrary to ``event_map``, ``function`` has to be a reference and **not** a `string`. We introduced events because it scales better if there is a huge amount of events and hooks. So all future interactions will be exclusively @@ -107,12 +107,12 @@ Providing RPC services ---------------------- -You may have noticed that pyLoad has an :class:`Api <module.Api.Api>`, which can be used internal or called by clients via RPC. +You may have noticed that pyLoad has an :class:`Api <pyload.Api.Api>`, which can be used internal or called by clients via RPC. So probably clients want to be able to interact with your hook to request it's state or invoke some action. Sounds complicated but is very easy to do. Just use the ``Expose`` decorator: :: - from module.plugins.Hook import Hook, Expose + from pyload.plugins.Hook import Hook, Expose class YourHook(Hook): """ @@ -123,7 +123,7 @@ Sounds complicated but is very easy to do. Just use the ``Expose`` decorator: :: def invoke(self, arg): print "Invoked with", arg -Thats all, it's available via the :class:`Api <module.Api.Api>` now. If you want to use it read :ref:`access_api`. +Thats all, it's available via the :class:`Api <pyload.Api.Api>` now. If you want to use it read :ref:`access_api`. Here is a basic example: :: #Assuming client is a ThriftClient or Api object @@ -133,11 +133,11 @@ Here is a basic example: :: Providing status information ---------------------------- -Your hook can store information in a ``dict`` that can easily be retrievied via the :class:`Api <module.Api.Api>`. +Your hook can store information in a ``dict`` that can easily be retrievied via the :class:`Api <pyload.Api.Api>`. Just store everything in ``self.info``. :: - from module.plugins.Hook import Hook + from pyload.plugins.Hook import Hook class YourHook(Hook): """ @@ -160,4 +160,4 @@ Example ------- Sorry but you won't find an example here ;-) - Look at :file:`module/plugins/hooks` and you will find plenty examples there. + Look at :file:`pyload/plugins/hooks` and you will find plenty examples there. diff --git a/docs/plugins/base_plugin.rst b/docs/plugins/base_plugin.rst index 3e1d5f952..5fa110fe7 100644 --- a/docs/plugins/base_plugin.rst +++ b/docs/plugins/base_plugin.rst @@ -3,8 +3,8 @@ Base Plugin - And here it begins... =================================== -A Plugin in pyLoad is a python file located at one of the subfolders in :file:`module/plugins/`. -All different plugin types inherit from :class:`Base <module.plugins.Base.Base>`, which defines basic methods +A Plugin in pyLoad is a python file located at one of the subfolders in :file:`pyload/plugins/`. +All different plugin types inherit from :class:`Base <pyload.plugins.Base.Base>`, which defines basic methods and meta data. You should read this section carefully, because it's the base for all plugin development. It is also a good idea to look at the class diagram [1]_ for all plugin types to get an overview. At last you should look at several already existing plugin to get a more detailed idea of how @@ -14,23 +14,23 @@ Meta Data --------- All important data which must be known by pyLoad is set using class attributes pre- and suffixed with ``__``. -An overview of acceptable values can be found in :class:`Base <module.plugins.Base.Base>` source code. +An overview of acceptable values can be found in :class:`Base <pyload.plugins.Base.Base>` source code. Unneeded attributes can be left out, except ``__version__``. Nevertheless please fill out most information as you can, when you want to submit your plugin to the public repository. -Additionally :class:`Crypter <module.plugins.Crypter.Crypter>` and :class:`Hoster <module.plugins.Hoster.Hoster>` +Additionally :class:`Crypter <pyload.plugins.Crypter.Crypter>` and :class:`Hoster <pyload.plugins.Hoster.Hoster>` needs to have a specific regexp [2]_ ``__pattern__``. This will be matched against input url's and if a suited plugin is found it is selected to handle the url. For localization pyLoad supports gettext [3]_, to mark strings for translation surround them with ``_("...")``. -You don't need to subclass :class:`Base <module.plugins.Base.Base>` directly, but the +You don't need to subclass :class:`Base <pyload.plugins.Base.Base>` directly, but the intermediate type according to your plugin. As an example we choose a hoster plugin, but the same is true for all plugin types. How a basic hoster plugin header could look like:: - from module.plugin.Hoster import Hoster + from pyload.plugin.Hoster import Hoster class MyFileHoster(Hoster): __version__ = "0.1" @@ -81,10 +81,10 @@ ip_check A hoster that checks ip, that can be avoided with reconnect Basic Methods ------------- -All methods can be looked up at :class:`Base <module.plugins.Base.Base>`. To note some important ones: +All methods can be looked up at :class:`Base <pyload.plugins.Base.Base>`. To note some important ones: The pyload core instance is accessible at ``self.core`` attribute -and the :class:`Api <module.Api.Api>` at ``self.core.api`` +and the :class:`Api <pyload.Api.Api>` at ``self.core.api`` With ``self.load(...)`` you can load any url and get the result. This method is only available to Hoster and Crypter. For other plugins use ``getURL(...)`` or ``getRequest()``. diff --git a/docs/plugins/crypter_plugin.rst b/docs/plugins/crypter_plugin.rst index 8c54dccb1..b10dd27f9 100644 --- a/docs/plugins/crypter_plugin.rst +++ b/docs/plugins/crypter_plugin.rst @@ -3,12 +3,12 @@ Crypter - Extract links from pages ================================== -We are starting with the simplest plugin, the :class:`Crypter <module.plugins.Crypter.Crypter>`. +We are starting with the simplest plugin, the :class:`Crypter <pyload.plugins.Crypter.Crypter>`. It's job is to take an url as input and generate a new package or links, for example by filtering the urls or loading a page and extracting links from the html code. You need to define the ``__pattern__`` to match -target urls and subclass from :class:`Crypter <module.plugins.Crypter.Crypter>`. :: +target urls and subclass from :class:`Crypter <pyload.plugins.Crypter.Crypter>`. :: - from module.plugin.Crypter import Crypter + from pyload.plugin.Crypter import Crypter class MyFileCrypter(Crypter): __pattern__ = r"mycrypter.com/id/([0-9]+)" @@ -28,7 +28,7 @@ Generating Packages When finished with decrypting just return the urls as list and they will be added to the package. You can also create new Packages if needed by instantiating a :class:`Package` instance, which will look like the following:: - from module.plugin.Crypter import Crypter, Package + from pyload.plugin.Crypter import Crypter, Package class MyFileCrypter(Crypter): @@ -52,12 +52,12 @@ your code you can use:: SimpleCrypter ------------- -For simple crypter services there is the :class:`SimpleCrypter <module.plugins.internal.SimpleCrypter.SimpleCrypter>` class which handles most of the workflow. Only the regexp +For simple crypter services there is the :class:`SimpleCrypter <pyload.plugins.internal.SimpleCrypter.SimpleCrypter>` class which handles most of the workflow. Only the regexp pattern has to be defined. Exmaple:: - from module.plugins.internal.SimpleCrypter import SimpleCrypter + from pyload.plugins.internal.SimpleCrypter import SimpleCrypter class MyFileCrypter(SimpleCrypter): diff --git a/docs/plugins/hoster_plugin.rst b/docs/plugins/hoster_plugin.rst index 9cd99a1f5..55a973463 100644 --- a/docs/plugins/hoster_plugin.rst +++ b/docs/plugins/hoster_plugin.rst @@ -7,7 +7,7 @@ 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): """ @@ -27,7 +27,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 a parameter to every pyfile. +You need to know about the :class:`PyFile <pyload.PyFile.PyFile>` class, since an instance of it is given as a parameter to every pyfile. Some tasks your plugin should handle: check if the file is online, get filename, wait if needed, download the file, etc.. Common Tasks @@ -37,7 +37,7 @@ Some hosters require you to wait a specific time. Just set the time with ``self. ``self.setWait(seconds, True)`` if you want pyLoad to perform a reconnect if needed. To handle captcha input just use ``self.decryptCaptcha(url, ...)``, it will be send to clients -or handled by :class:`Addon <module.plugins.Addon.Addon>` plugins +or handled by :class:`Addon <pyload.plugins.Addon.Addon>` plugins Online status fetching @@ -54,4 +54,4 @@ Testing Examples -------- -The best examples are the already existing plugins in :file:`module/plugins/`.
\ No newline at end of file +The best examples are the already existing plugins in :file:`pyload/plugins/`.
\ No newline at end of file |