Skip to main content

CFFI bindings for WinFSP

Project description

Appveyor CI Status https://codecov.io/gh/Scille/winfspy/branch/master/graph/badge.svg Pypi Status Code style: black

Bindings for WinFSP version 1.4 and onward.

Winfspy consists of three important modules:

  • winfspy: expose the WinFSP API
  • winfspy.memfs: a memory file system based on winfspy
  • winfspy.tests.winfsp_tests: a test suite for black box testing
  • winfspy.tests.winfstest: a lighter test suite for black box testing

Requirements and installation

WinFSP version 1.4 or higher has to be installed separately.

Then install winfspy using pip:

$ pip install winfspy

WinFSP python API

Usage:

from winfspy import (
    FileSystem,
    BaseFileSystemOperations,
    enable_debug_log,
    FILE_ATTRIBUTE,
    CREATE_FILE_CREATE_OPTIONS,
    NTStatusObjectNameNotFound,
    NTStatusDirectoryNotEmpty,
    NTStatusNotADirectory,
    NTStatusObjectNameCollision,
    NTStatusAccessDenied,
    NTStatusEndOfFile,
)

Winfspy memory file system

Usage:

# Run the memory fs as X: drive in verbose mode
$ python -m winfspy.memfs X: -v

# More information
$ python -m winfspy.memfs

Winfsp-tests test suite

This test suite integrates the external test suite of winfsp-tests.

Usage:

# Install winfspy with the test dependencies
$ pip install winfspy[test]

# Run the winfstest test suite on an existing X: drive
$ python winfspy.tests.winfsp_tests --file-system-path X:

# More information about pytest
$ python winfspy.tests.winfsp_tests -h

Winfstest test suite

This test suite is taken from secfs.test.winfstest. It is basic yet useful to test common use cases.

Usage:

# Install winfspy with the test dependencies
$ pip install winfspy[test]

# Run the winfstest test suite on an existing X: drive
$ python winfspy.tests.winfstest --file-system-path X:

# More information about pytest
$ python winfspy.tests.winfstest -h

License

Free software: BSD

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for winfspy, version 0.7.5
Filename, size File type Python version Upload date Hashes
Filename, size winfspy-0.7.5-cp36-cp36m-win32.whl (83.2 kB) File type Wheel Python version cp36 Upload date Hashes View
Filename, size winfspy-0.7.5-cp36-cp36m-win_amd64.whl (92.2 kB) File type Wheel Python version cp36 Upload date Hashes View
Filename, size winfspy-0.7.5-cp37-cp37m-win32.whl (83.2 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size winfspy-0.7.5-cp37-cp37m-win_amd64.whl (92.2 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size winfspy-0.7.5-cp38-cp38-win32.whl (83.3 kB) File type Wheel Python version cp38 Upload date Hashes View
Filename, size winfspy-0.7.5-cp38-cp38-win_amd64.whl (92.3 kB) File type Wheel Python version cp38 Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page