Rooba
/
pydu
mirror of https://github.com/flaggo/pydu.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add doc for request.check_connect

This commit is contained in:
Prodesire 2017-12-05 22:15:27 +08:00
parent 72cdcf31bd
commit 780c7b72a1
2 changed files with 25 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/request.rst
View File

@ -3,23 +3,34 @@ Request
.. py:class:: pydu.request.Filename .. py:class:: pydu.request.Filename
Supply several methods to get filename. Supply several methods to get filename.
.. py:staticmethod:: from_url(url): .. py:staticmethod:: from_url(url):
Detected filename as unicode or None. Detected filename as unicode or None.
.. py:staticmethod:: from_headers(headers): .. py:staticmethod:: from_headers(headers):
Detect filename from Content-Disposition headers if present. Detect filename from Content-Disposition headers if present.
``headers`` could be a dict, list or string. ``headers`` could be a dict, list or string.
.. py:function:: pydu.request.download(url, dst=None) .. py:function:: pydu.request.download(url, dst=None)
High level function, which downloads URL into tmp file in current High level function, which downloads URL into tmp file in current
directory and then renames it to filename autodetected from either URL directory and then renames it to filename autodetected from either URL
or HTTP headers. or HTTP headers.
``url`` indicates which url to download. ``url`` indicates which url to download.
``dst`` is the filename or directory of destination. ``None`` as default, means ``dst`` is the filename or directory of destination. ``None`` as default, means
download to current directory. download to current directory.
.. py:function:: pydu.request.check_connect(p, port, retry=1, timeout=0.5)
Check whether given ``ip`` and ``port`` could connect or not.
It will ``retry`` and ``timeout`` on given.
>>> from pydu.request import check_connect
>>> check_connect('http://www.baidu.com', 80)
'192.168.3.8'
>>>

4
pydu/request.py
View File

@ -104,8 +104,8 @@ def download(url, dst=None):
def check_connect(ip, port, retry=1, timeout=0.5): def check_connect(ip, port, retry=1, timeout=0.5):
""" """
Check whether given ip and port could connect or not. Check whether given ``ip`` and ``port`` could connect or not.
It will retry and timeout on given. It will ``retry`` and ``timeout`` on given.
""" """
while retry: while retry:
try: try: