API¶
Wpull was designed as a command line program and most users do not need to read this section. However, you may be using the scripting hook interface or you may want to reuse a component.
Since Wpull is generally not a library, API backwards compatibility is provided on a best-effort basis; there is no guarantee on whether public or private functions will remain the same. This rule does not include the scripting hook interface which is designed for backwards compatibility.
Here lists all documented classes and functions. Not all members are documented yet. Some members, such as the backported modules, are not documented here.
If the documentation is not sufficient, please take a look at the source code. Suggestions and improvements are welcomed.
Note
The API is not thread-safe. It is intended to be run asynchronously with Asyncio.
Many functions also are decorated with the asyncio.coroutine()
decorator. For more information, see https://docs.python.org/3/library/asyncio.html.
wpull Package¶
application
Moduleapplication.app
Moduleapplication.builder
Moduleapplication.factory
Moduleapplication.hook
Moduleapplication.main
Moduleapplication.options
Moduleapplication.plugin
Moduleapplication.plugins
Moduleapplication.plugins.arg_warning.plugin
Moduleapplication.plugins.debug_console.plugin
Moduleapplication.plugins.download_progress.plugin
Moduleapplication.plugins.server_response.plugin
Moduleapplication.tasks
Moduleapplication.tasks.conversion
Moduleapplication.tasks.database
Moduleapplication.tasks.download
Moduleapplication.tasks.log
Moduleapplication.tasks.network
Moduleapplication.tasks.plugin
Moduleapplication.tasks.resmon
Moduleapplication.tasks.rule
Moduleapplication.tasks.shutdown
Moduleapplication.tasks.sslcontext
Moduleapplication.tasks.stats
Moduleapplication.tasks.warc
Moduleapplication.tasks.writer
Modulebody
Modulecache
Modulecollections
Moduleconverter
Modulecookie
Modulecookiewrapper
Moduledatabase
Moduledatabase.base
Moduledatabase.sqlmodel
Moduledatabase.sqltable
Moduledatabase.wrap
Moduledebug
Moduledecompression
Moduledocument
Moduledocument.base
Moduledocument.css
Moduledocument.html
Moduledocument.htmlparse
Moduledocument.htmlparse.base
Moduledocument.htmlparse.element
Moduledocument.htmlparse.html5lib_
Moduledocument.htmlparse.lxml_
Moduledocument.javascript
Moduledocument.sitemap
Moduledocument.util
Moduledocument.xml
Moduledriver
Moduledriver.phantomjs
Moduledriver.process
Moduleerrors
Modulenamevalue
Modulenetwork
Modulenetwork.bandwidth
Modulenetwork.connection
Modulenetwork.dns
Modulenetwork.pool
Moduleobserver
Modulepath
Modulepipeline
Modulepipeline.app
Modulepipeline.item
Modulepipeline.pipeline
Modulepipeline.progress
Modulepipeline.session
Moduleprocessor
Moduleprocessor.base
Moduleprocessor.coprocessor
Moduleprocessor.coprocessor.phantomjs
Moduleprocessor.coprocessor.proxy
Moduleprocessor.coprocessor.youtubedl
Moduleprocessor.delegate
Moduleprocessor.ftp
Moduleprocessor.rule
Moduleprocessor.web
Moduleprotocol
Moduleprotocol.abstract
Moduleprotocol.abstract.client
Moduleprotocol.abstract.request
Moduleprotocol.abstract.stream
Moduleprotocol.ftp
Moduleprotocol.ftp.client
Moduleprotocol.ftp.command
Moduleprotocol.ftp.ls
Moduleprotocol.ftp.ls.date
Moduleprotocol.ftp.ls.listing
Moduleprotocol.ftp.request
Moduleprotocol.ftp.stream
Moduleprotocol.ftp.util
Moduleprotocol.http
Moduleprotocol.http.chunked
Moduleprotocol.http.client
Moduleprotocol.http.redirect
Moduleprotocol.http.request
Moduleprotocol.http.robots
Moduleprotocol.http.stream
Moduleprotocol.http.util
Moduleprotocol.http.web
Moduleproxy
Moduleproxy.client
Moduleproxy.hostfilter
Moduleproxy.server
Moduleregexstream
Moduleresmon
Modulerobotstxt
Modulescraper
Modulescraper.base
Modulescraper.css
Modulescraper.html
Modulescraper.javascript
Modulescraper.sitemap
Modulescraper.util
Modulestats
Modulestring
Moduleurl
Moduleurlfilter
Moduleurlrewrite
Moduleutil
Moduleversion
Modulewaiter
Modulewarc
Modulewarc.format
Modulewarc.recorder
Modulewriter
Module