4.4. Validate a filename

The validate_filename() function raise ValueError if the name includes invalid character(s) for a filename.

Sample Code:

import sys
from pathvalidate import ValidationError, validate_filename

try:
    validate_filename("fi:l*e/p\"a?t>h|.t<xt")
except ValidationError as e:
    print(f"{e}\n", file=sys.stderr)

try:
    validate_filename("COM1")
except ValidationError as e:
    print(f"{e}\n", file=sys.stderr)

Output:

[PV1100] invalid characters found: platform=universal, description=invalids=('/'), value='fi:l*e/p"a?t>h|.t<xt'

[PV1002] found a reserved name by a platform: 'COM1' is a reserved name, platform=universal, reusable_name=False

4.5. Validate a file path

The validate_filepath() function raise ValueError if the name includes invalid character(s) for a file path.

Sample Code:

import sys
from pathvalidate import ValidationError, validate_filepath

try:
    validate_filepath("fi:l*e/p\"a?t>h|.t<xt")
except ValidationError as e:
    print(e, file=sys.stderr)

Output:

[PV1100] invalid characters found: invalids=(':', '*', '"', '?', '>', '|', '<'), value='fi:l*e/p"a?t>h|.t<xt', platform=Windows