pathvalidate 0.21.4

A Python library to sanitize/validate a string such as filenames/file-paths/variable-names/etc.

pathvalidate

Summary

A Python library to sanitize/validate a string such as filenames/file-paths/variable-names/etc.

Features

• Sanitize/Validate a string as a:

  • file name

  • file path

  • variable name: Python/JavaScript

  • Labeled Tab-separated Values (LTSV) label

  • Elastic search index name

  • Excel sheet name

  • SQLite table/attribute name

Examples

Validate a filename

Sample Code:

import pathvalidate

try:
    pathvalidate.validate_filename("\0_a*b:c<d>e%f/(g)h+i_0.txt")
except ValueError:
    print("invalid filename!")

Output:

invalid filename!

Sanitize a filename

Sample Code:

import pathvalidate as pv

print(pv.sanitize_filename("f\\i:l*e?n\"a<m>e|.txt"))
print(pv.sanitize_filename("_a*b:c<d>e%f/(g)h+i_0.txt"))

Output:

_abcde%f(g)h+i_0.txt

Sanitize a filepath

Sample Code:

import pathvalidate as pv

print(pv.sanitize_filepath("fi:l*e/p\"a?t>h|.t<xt"))
print(pv.sanitize_filepath("_a*b:c<d>e%f/(g)h+i_0.txt"))

Output:

file/path.txt
_abcde%f/(g)h+i_0.txt

Sanitize a variable name

Sample Code:

import pathvalidate as pv

print(pv.sanitize_python_var_name("_a*b:c<d>e%f/(g)h+i_0.txt"))

Output:

abcdefghi_0txt

For more information

More examples are available at https://pathvalidate.rtfd.io/en/latest/pages/examples/index.html

Installation

pip install pathvalidate

Dependencies

Python 2.7+ or 3.4+ No external dependencies.

Test dependencies

• pytest

• pytest-runner

• tox

Documentation

https://pathvalidate.rtfd.io/