Python WebDAV Client 3

Package webdavclient3 based on https://github.com/designerror/webdav-client-python but uses requests instead of PyCURL. It provides easy way to work with WebDAV-servers.

Installation

$ pip install webdavclient3

Sample Usage

fromwebdav3.clientimportClientoptions= {
'webdav_hostname': "https://webdav.server.ru",
'webdav_login': "login",
'webdav_password': "password"
}
client=Client(options)
client.verify=False# To not check SSL certificates (Default = True)client.session.proxies(...) # To set proxy directly into the session (Optional)client.session.auth(...) # To set proxy auth directly into the session (Optional)client.execute_request("mkdir", 'directory_name')

Webdav API

Webdav API is a set of webdav actions of work with cloud storage. This set includes the following actions: check, free, info, list, mkdir, clean, copy, move, download, upload, publish and unpublish.

Configuring the client

Required key is host name or IP address of the WevDAV-server with param name webdav_hostname.
For authentication in WebDAV server use webdav_login, webdav_password.
For an anonymous login do not specify auth properties.

fromwebdav3.clientimportClientoptions= {
'webdav_hostname': "https://webdav.server.ru",
'webdav_login': "login",
'webdav_password': "password"
}
client=Client(options)

If your server does not support HEAD method or there are other reasons to override default WebDAV methods for actions use a dictionary option webdav_override_methods. The key should be in the following list: check, free, info, list, mkdir, clean, copy, move, download, upload, publish and unpublish. The value should a string name of WebDAV method, for example GET.

fromwebdav3.clientimportClientoptions= {
'webdav_hostname': "https://webdav.server.ru",
'webdav_login': "login",
'webdav_password': "password",
'webdav_override_methods': {
'check': 'GET'
}
}
client=Client(options)

For configuring a requests timeout you can use an option webdav_timeout with int value in seconds, by default the timeout is set to 30 seconds.

fromwebdav3.clientimportClientoptions= {
'webdav_hostname': "https://webdav.server.ru",
'webdav_login': "login",
'webdav_password': "password",
'webdav_timeout': 30
}
client=Client(options)

When a proxy server you need to specify settings to connect through it.

fromwebdav3.clientimportClientoptions= {
'webdav_hostname': "https://webdav.server.ru",
'webdav_login': "w_login",
'webdav_password': "w_password", 'proxy_hostname': "http://127.0.0.1:8080",
'proxy_login': "p_login",
'proxy_password': "p_password"
}
client=Client(options)

If you want to use the certificate path to certificate and private key is defined as follows:

fromwebdav3.clientimportClientoptions= {
'webdav_hostname': "https://webdav.server.ru",
'webdav_login': "w_login",
'webdav_password': "w_password",
'cert_path': "/etc/ssl/certs/certificate.crt",
'key_path': "/etc/ssl/private/certificate.key"
}
client=Client(options)

Or you want to limit the speed or turn on verbose mode:

options= {
...
'recv_speed' : 3000000,
'send_speed' : 3000000,
'verbose' : True
}
client=Client(options)

recv_speed: rate limit data download speed in Bytes per second. Defaults to unlimited speed.
send_speed: rate limit data upload speed in Bytes per second. Defaults to unlimited speed.
verbose: set verbose mode on/off. By default verbose mode is off.

Also if your server does not support check it is possible to disable it:

options= {
...
'disable_check': True
}
client=Client(options)

By default, checking of remote resources is enabled.

For configuring chunk size of content downloading use chunk_size param, by default it is 65536

options= {
...
'chunk_size': 65536
}
client=Client(options)

Synchronous methods

# Checking existence of the resourceclient.check("dir1/file1")
client.check("dir1")

# Get information about the resourceclient.info("dir1/file1")
client.info("dir1/")

# Check free spacefree_size=client.free()

# Get a list of resourcesfiles1=client.list()
files2=client.list("dir1")
files3=client.list("dir1", get_info=True) # returns a list of dictionaries with files details

# Create directoryclient.mkdir("dir1/dir2")

# Delete resourceclient.clean("dir1/dir2")

# Copy resourceclient.copy(remote_path_from="dir1/file1", remote_path_to="dir2/file1")
client.copy(remote_path_from="dir2", remote_path_to="dir3")

# Move resourceclient.move(remote_path_from="dir1/file1", remote_path_to="dir2/file1")
client.move(remote_path_from="dir2", remote_path_to="dir3")

# Download a resourceclient.download_sync(remote_path="dir1/file1", local_path="~/Downloads/file1")
client.download_sync(remote_path="dir1/dir2/", local_path="~/Downloads/dir2/")

# Upload resourceclient.upload_sync(remote_path="dir1/file1", local_path="~/Documents/file1")
client.upload_sync(remote_path="dir1/dir2/", local_path="~/Documents/dir2/")

# Publish the resourcelink=client.publish("dir1/file1")
link=client.publish("dir2")

# Unpublish resourceclient.unpublish("dir1/file1")
client.unpublish("dir2")

# Exception handlingfromwebdav3.clientimportWebDavExceptiontry:
...
exceptWebDavExceptionasexception:
...

# Get the missing filesclient.pull(remote_directory='dir1', local_directory='~/Documents/dir1')

# Send missing filesclient.push(remote_directory='dir1', local_directory='~/Documents/dir1')

Asynchronous methods

# Load resourcekwargs= {
'remote_path': "dir1/file1",
'local_path': "~/Downloads/file1",
'callback': callback
}
client.download_async(**kwargs)
kwargs= {
'remote_path': "dir1/dir2/",
'local_path': "~/Downloads/dir2/",
'callback': callback
}
client.download_async(**kwargs)

# Unload resourcekwargs= {
'remote_path': "dir1/file1",
'local_path': "~/Downloads/file1",
'callback': callback
}
client.upload_async(**kwargs)
kwargs= {
'remote_path': "dir1/dir2/",
'local_path': "~/Downloads/dir2/",
'callback': callback
}
client.upload_async(**kwargs)

Resource API

Resource API using the concept of OOP that enables cloud-level resources.

# Get a resourceres1=client.resource("dir1/file1")

# Work with the resourceres1.rename("file2")
res1.move("dir1/file2")
res1.copy("dir2/file1")
info=res1.info()
res1.read_from(buffer)
res1.read(local_path="~/Documents/file1")
res1.read_async(local_path="~/Documents/file1", callback)
res1.write_to(buffer)
res1.write(local_path="~/Downloads/file1")
res1.write_async(local_path="~/Downloads/file1", callback)

For Contributors

Prepare development environment

1. Install docker on your development machine
2. Start WebDAV server for testing by following commands from the project's root folder or change path to conf dir in second command to correct:

docker pull bytemark/webdav
docker run -d --name webdav -e AUTH_TYPE=Basic -e USERNAME=alice -e PASSWORD=secret1234 -v conf:/usr/local/apache2/conf -p 8585:80 bytemark/webdav

Code convention

Please check your code according PEP8 Style guides.

Run tests

1. Check that webdav container is started on your local machine
2. Execute following command in the project's root folder:

python -m unittest discover -s tests

Prepare a Pull Request

Please use this check list before creating PR:

1. You code should be formatted according PEP8
2. All tests should successfully pass
3. Your changes shouldn't change previous default behaviour, exclude defects
4. All changes are covered by tests