v3.2.1 - 23 Aug 2024

What's Changed

Test Python 3.12 in CIs by @MatthieuDartiailh in #40
Bump actions/setup-python from 4 to 5 by @dependabot in #36
Bump actions/upload-artifact from 3 to 4 by @dependabot in #38
Bump actions/download-artifact from 3 to 4 by @dependabot in #37
Fix CI by @thombashi in #41
Update the CI workflow to include a job that publishes packages to TestPyPI by @thombashi in #42
Fix coverage report by @thombashi in #45
Fix sanitize_filename truncation by @7x11x13 in #48
Fix validation functions of filepaths by @thombashi in #55
- If platform argument is windows or universal, filepaths ending with a space or a period should be detected as an error
- Fix POSIX-style absolute paths were not detected as errors with platform="windows" or platform="universal" on Python 3.12 and below
Add support for Python 3.13 by @thombashi in #56
Improve type annotations
Add a build and publish workflow
Update copyright year to include the last update year: #54 (Thanks to @Flimm)
Add CHANGELOG

New Contributors

@MatthieuDartiailh made their first contribution in #40
@dependabot made their first contribution in #36
@thombashi made their first contribution in #41
@7x11x13 made their first contribution in #48

Full Changelog: https://github.com/thombashi/pathvalidate/compare/v3.2.0...v3.2.1

Changes

v3.2.0 - 17 Sep 2023

Add reserved_name_handler argument to sanitize_filename function and sanitize_filepath function
Add NullValueHandler class and ReservedNameHandler class
Add fs_encoding property and byte_count property to ValidationError class
Add additional_reserved_names argument to validate/sanitize functions to allow custom reserved names
Modify the return value format of ValidationError.__str__ method
Improve type annotations

Full Changelog: https://github.com/thombashi/pathvalidate/compare/v3.1.0...v3.2.0

Changes

v3.1.0 - 16 Jul 2023

Fix validation error messages to show the target-platform properly: #34 (Thanks to @matanster)
Fix README: out of date with the actual error generated by validate_filename #35 (Thanks to @hXtreme)
Add description property to ErrorReason class
Add as_slog method to ValidationError class
Add docs extras
Change the type of the return value of ValidationError.reason from Optional[ErrorReason] to ErrorReason
Update [build-system]
Drop support for Python 3.6

Full Changelog: https://github.com/thombashi/pathvalidate/compare/v3.0.0...v3.1.0

Changes

v3.0.0 - 22 May 2023

What's Changed

Trim heading spaces in Windows by @eggplants in #28
Consider filesystem encoding for length calculations: #26 (Thanks to @virlos)
Fix type model: #29 (Thanks to @rogalski)
Fix sanitizing of filenames that only consist of whitespaces and periods
Add validate_unprintable_char function
Add validate_after_sanitize keyword argument to sanitize_filename and sanitize_filepath functions
Add error codes to ErrorReason
Add zip_safe=False to setup
Modify to accept pathvalidate.Platform type as platform arguments
Rename type alias from Handler to NullValueHandler
Remove InvalidLengthError to use ValidationError
Improve type annotations
Make it possible to import FileNameValidator and FilePathValidator classes from the package root
Change constructor arguments of FileNameSanitizer and FilePathSanitizer classes
- Remove min_len
- Add validator
Remove deprecated functions
Modify error messages
Refactoring

Full Changelog: https://github.com/thombashi/pathvalidate/compare/v2.5.2...v3.0.0

Changes

v2.5.2 - 20 Aug 2022

Add support for Python 3.11: #22 (Thanks to @hegjon)

Full Changelog: https://github.com/thombashi/pathvalidate/compare/v2.5.1...v2.5.2

Changes

v2.5.1 - 31 Jul 2022

What's Changed

Add __all__ by @eggplants in #24
Add DeprecationWarning to deprecated functions

New Contributors

@eggplants made their first contribution in #24

Full Changelog: https://github.com/thombashi/pathvalidate/compare/v2.5.0...v2.5.1

Changes

v2.5.0 - 26 Sep 2021

Add support for Python 3.10
Drop support for Python 3.5
Add null_value_handler argument to sanitize_filename/sanitize_filepath functions: #20 (Thanks to @ mkbloke)
Add AbstractSanitizer/AbstractValidator classes to import path
Add replace_ansi_escape function
Add setup-ci target to Makefile
Modify min_len/max_len to use default values when assigned minus values

Changes

v2.4.1 - 03 Apr 2021

Fix filename validations that include '\' (backslash) on other than Windows: #18 (Thanks to @Traktormaster)

Changes

v2.4.0 - 21 Mar 2021

Add exclude_symbols argument to replace_symbol function
Fix permissions of files included in sdist package binary (Thanks to @hegjon)

Changes

v2.3.2 - 03 Jan 2021

Fix to disallow file name/path that only white spaces for universal platform

Changes

v2.3.1 - 13 Dec 2020

Modify to accept file name/path that consists only whitespaces: #15 (Thank to @Traktormaster)

Changes

v2.3.0 - 03 May 2020

Change not to process for "."/".." by sanitization functions: #13 (Thanks to @ProfElectric)
Change to normalize with sanitize_filepath in default
Add normalize interface to sanitize_filepath

Changes

v2.2.2 - 28 Mar 2020

Improve file path validation for Windows platform: #12 (Thanks to @bschollnick)
Fix __str__ method
Fix to avoid raise an exception when an absolute path includes "."/".."
Modify an error message
Modify raising exception from NullNameError to ValidationError of validate_pathtype

Changes

v2.2.1 - 20 Mar 2020

Fix to include py.typed to the package

Changes

v2.2.0 - 12 Feb 2020

Add POSIX as a platform
Add a reserved keyword for macOS
Change platform of validate_filepath_arg/sanitize_filepath_arg to 'auto': #11 (Thanks to @freelanceAndy)

Changes

v2.1.0 - 01 Feb 2020

Add check_reserved argument to validate/sanitize functions
Add '/' as a reserved file path for Linux/macOS
Suppress errors when sanitizing null values
Fix max_len value check for file names
Include type annotation information to the package
Remove dev extras_require
Bug fixes

Changes

v2.0.0 - 13 Jan 2020

Change to be more strict validation for absolute paths
Fix argparse validator/sanitizer failed when empty inputs
Bug fixes

Changes

v1.1.0 - 04 Jan 2020

Modify validate/sanitize functions for argparse
Modify validate/sanitize functions for click
Update dev extras

Changes

v1.0.0 - 03 Jan 2020

Drop Python 2 support
Modify to use Python 3 functionality
Update extras_require
Bug fixes
Remove a deprecated property

Changes

v0.29.1 - 02 Jan 2020

Fix file path length validation: #10 (Thanks to @UncleGoogle)
Add .asc files of packages to PyPI

Changes

v0.29.0 - 16 Jun 2019

Add filename/filepath validators for argparse/click
Modify error messages

Changes

v0.28.2 - 18 May 2019

Fix to properly escape special chars for validation error messages: #9 (Thanks to @UncleGoogle)

Changes

v0.28.0 - 01 May 2019

Drop support for Python 3.4

Changes

v0.26.0 - 15 Mar 2019

Add support for NTFS reserved names
Improve drive letter handling

Changes

v0.25.0 - 14 Mar 2019

Add CLOCK$ as a reserved filename for Windows platform: #8 (Thanks to @sparr)
Improve reserved name detection
Add reserved_name property to ReservedNameError class

Changes

v0.24.1 - 12 Feb 2019

Fix improper error messages
Improve error message readability

Changes

v0.24.0 - 03 Feb 2019

Add is_valid_filename/is_valid_filepath function
Add FileNameSanitizer/FilePathSanitizer classes
Add minimum length validation support
Remove deprecated functions

Changes

v0.23.0 - 06 Jan 2019

Improve sanitization/validation for files
Add . and .. as reserved keywords for files
Add limit to max_filename_len
Fix platform specific sanitization: #7
Fix reserved keywords sanitization/validation for files
Integrate InvalidCharWindowsError into InvalidCharError
Change to use ReservedNameError instead of InvalidReservedNameError
Breaking changes
- Rename a property for FileSanitizer from platform_name to platform
- Rename methods argument from platform_name to platform

Changes

v0.22.0 - 23 Dec 2018

Add universal (platform independent) filename/filepath sanitization/validation
Treat ASCII whitespace other than normal space as invalid on Windows #6 (Thanks to @nyuszika7h)