Skip to main content

CFFI bindings for WinFSP

Project description

GitHub Actions 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.

Source Distribution

winfspy-0.8.4.tar.gz (58.7 kB view hashes)

Uploaded Source

Built Distributions

winfspy-0.8.4-cp311-cp311-win_amd64.whl (95.1 kB view hashes)

Uploaded CPython 3.11 Windows x86-64

winfspy-0.8.4-cp311-cp311-win32.whl (86.5 kB view hashes)

Uploaded CPython 3.11 Windows x86

winfspy-0.8.4-cp310-cp310-win_amd64.whl (95.1 kB view hashes)

Uploaded CPython 3.10 Windows x86-64

winfspy-0.8.4-cp310-cp310-win32.whl (86.5 kB view hashes)

Uploaded CPython 3.10 Windows x86

winfspy-0.8.4-cp39-cp39-win_amd64.whl (95.1 kB view hashes)

Uploaded CPython 3.9 Windows x86-64

winfspy-0.8.4-cp39-cp39-win32.whl (86.5 kB view hashes)

Uploaded CPython 3.9 Windows x86

winfspy-0.8.4-cp38-cp38-win_amd64.whl (95.1 kB view hashes)

Uploaded CPython 3.8 Windows x86-64

winfspy-0.8.4-cp38-cp38-win32.whl (86.5 kB view hashes)

Uploaded CPython 3.8 Windows x86

winfspy-0.8.4-cp37-cp37m-win_amd64.whl (95.1 kB view hashes)

Uploaded CPython 3.7m Windows x86-64

winfspy-0.8.4-cp37-cp37m-win32.whl (86.5 kB view hashes)

Uploaded CPython 3.7m Windows x86

winfspy-0.8.4-cp36-cp36m-win_amd64.whl (96.4 kB view hashes)

Uploaded CPython 3.6m Windows x86-64

winfspy-0.8.4-cp36-cp36m-win32.whl (87.0 kB view hashes)

Uploaded CPython 3.6m Windows x86

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page