k7iLEF%SrSSKrSSKrSSKrSSKrSSKJr SSKJrJ r SSKJ r SSK J r J r SSKJrJrJrJr SS KJrJrJrJrJr SS KJrJrJr SS KJrJr SS K J!r!J"r"J#r#J$r$ SS K%J&r&J'r' Sr(\ \)S'\RT"S\RV"\RX5SS3\RZ5r.\ \)S'\RT"S\RV"\R^5SS3\RZ5r0\ \)S'"SS\5r1"SS\5r2S\\(SSS4S\S\ \S\3S\3S\ \4S\5S \ \\4S!S4S"jjr6S\SSSS4S\S\ \S\3S\ \3S\ \4S\5S \ \\4S!\54S#jjr7S$S\(SSSSSS%4 S\S&\4S\ \S\ \3S\ \4S\ \5S'\ \'S(\ \'S \ \\4S)\5S!\4S*jjr8g)+zA .. codeauthor:: Tsuyoshi Hombashi N)Sequence)PathPurePath)Pattern)FinalOptional)AbstractSanitizerAbstractValidatorBaseFile BaseValidator)findall_to_str is_nt_abspathto_str truncate_strvalidate_pathtype)DEFAULT_MIN_LENINVALID_CHAR_ERR_MSG_TMPLPlatform)PathType PlatformType) ErrorAttrKey ErrorReasonInvalidCharErrorValidationError)ReservedNameHandlerValidationErrorHandler_DEFAULT_MAX_FILENAME_LEN[s]_RE_INVALID_FILENAME_RE_INVALID_WIN_FILENAMEc^\rSrSr\SSSSSSS4S\S\\S\\S\\ S\\ S \\ \S \ S \\ S S4U4S jjjr SS\S\S \4SjjrS \\4SjrSrU=r$)FileNameSanitizerNFmax_len fs_encodingplatformnull_value_handlerreserved_name_handleradditional_reserved_namesvalidate_after_sanitize validatorreturnc >U(aUn O[[UUSUUS9n [T U] UUUUUUUU S9 UR 5Ulg)NTmin_lenr(r)check_reservedr-r*)r(r)r+r,r-r*r.r/)FileNameValidatorrsuper__init___get_sanitize_regexp_sanitize_regexp) selfr(r)r*r+r,r-r.r/fname_validator __class__s P/home/james-whalen/.local/lib/python3.13/site-packages/pathvalidate/_filename.pyr7FileNameSanitizer.__init__ sh 'O/''#*C! O #1"7&?$;%  !% 9 9 ;valuereplacement_textc6[XRSS9(+S9 URRU[U55n[X@RUR5nURR!U5 UR2(aURR!U5 [ U[5(a [9U5$U$![aPnUR[R :Xa,[ U[5(aeURU5sSnA$eSnAff=f![Ga%nUR[R":Xa\UR%U5nUR&U:wa5[(R"[(R*"UR&5XT5nSnAGN1UR[R,:XaSURSS9(a?UR/S5nUR1S5nUS;aUR1S5nSnAGNUR[R :XaURU5nSnAGNSnAff=f![a1n[[U5[R4UR6S9eSnAff=f)NTinclude_universalallow_whitespaces .z..z .) descriptionreasonr*)r _is_windowsrrKr NULL_NAME isinstancer_null_value_handlerr9substrr _fs_encodingr( _validatorvalidate RESERVED_NAME_reserved_name_handler reserved_namereescapeINVALID_CHARACTERlstriprstrip_validate_after_sanitizeINVALID_AFTER_SANITIZEr*r)r:r@rAesanitized_filenamereplacement_words r=sanitizeFileNameSanitizer.sanitizeDs-  e;K;K^b;K;c7c d"22667GUT)*<>O>OQUQ]Q]^ A OO $ $%7 8*  ( ( (();< eX & &*+ +!!] xx;000eX..//22    Axx;444#'#>#>q#A ??&66)+ !//24D*&[:::t?O?O"&@P@&8%>%>s%C"&8%>%>s%C"%[8);)B)B4)H&[222%)%=%=a%@"% A.# % #A&==!]] sbC #D*I D'AD"D'!D""D'* I5A4I/A+I /II J',JJcBURSS9(a[$[$)NTrC)rLr$r#)r:s r=r8&FileNameSanitizer._get_sanitize_regexpws   d  3+ +##r?)r9))__name__ __module__ __qualname____firstlineno__rintrrQrrrboolr r7rrbrr8__static_attributes__ __classcell__r<s@r=r&r&s1%)+/?CBF=A(-15"<"<c]"<<( "< %%;< "< ((>? "<$,HSM#:"<"&"<-."< "<"FileNameValidator.s!d4cyt4(3q'"4c)COMLPTr c#6# UHupUSUS3v M g7f)r!Nrx)ryrzssds r=r|r}s*  Ahs1g r~)¹²³_WINDOWS_RESERVED_FILE_NAMES):_MACOS_RESERVED_FILE_NAMESr0.c>[TU]nUR5(a&[UUR-UR -5nOzUR 5(a[XR-5nOMUR5(dUR5(a[XR -5nO [U5n[[U55$)N) r6reserved_keywords _is_universalsetrrrL _is_posix _is_macostuplesorted)r:common_keywordsword_setr<s r=r#FileNameValidator.reserved_keywordss'3     334112H     ?-N-NNOH ^^  !1!1?-L-LLMH?+HVH%&&r?NTr3r(r)r*r4r-c *>[TU]UUUUUUS9 g)Nr2)r6r7)r:r3r(r)r*r4r-r<s r=r7FileNameValidator.__init__s) #)&?  r?r@c [XRSS9(+S9 [U5n[UR UR 55nUR U5 [R[R[RUR[RUR [RU[RU0nX0R :a [#SUR SSUSS3/40UD6eX0R$:a [#SUR$SSUSS3/40UD6eUR'U5 UR)U5 URSS9(aUR+U5 gg) NTrCrEz filename is too long: expected<=rwz bytes, actual=z bytesz!filename is too short: expected>=)rrLrlenencoderRvalidate_abspathrREASONrINVALID_LENGTHPLATFORMr* FS_ENCODING BYTE_COUNTVALUEr(rr3_validate_reserved_keywords/_FileNameValidator__validate_universal_filename)_FileNameValidator__validate_win_filename)r:r@unicode_filenamebyte_ct err_kwargss r=rTFileNameValidator.validatesu%7G7GZ^7G7_3_`!%=&--d.?.?@A ./   !;!;  ! !4==  $ $d&7&7  # #W    0   \\ !!6t||A6FoV]^_U``fg   \\ !!7 Q7GW^_`Vaagh   (()9: **+;<   d  3  ( ()9 : 4r?c[SU<S3UR[RS9nUR SS9(a[ U5(aUe[ R"U5(aUeg)Nzfound an absolute path (z), expected a filename)rJr*rKTrC)rr*rFOUND_ABS_PATHrLr posixpathisabs)r:r@errs r=r"FileNameValidator.validate_abspathse25);QR]]--    d  3U## ??5 ! !I "r?rc[RU5nU(a4[[R"[ U5S9[ RUS9eg)Ninvalidr*r@)r#findallrrformatrr UNIVERSAL)r:rmatchs r=__validate_universal_filename/FileNameValidator.__validate_universal_filenamesL$,,-=> ")00*51"++&   r?cR[RU5nU(a4[[R"[ U5S9[ RUS9eUS;agSn[R[ R[RU0nUSS;aF[[R"[R"US5S94SUR S50UD6eUS S ;aF[[R"[R"US 5S94SUR S 50UD6eg) NrrrHz{}. Refer: https://learn.microsoft.com/en-us/troubleshoot/windows-client/shell-experience/file-folder-name-whitespace-characters)rGrIrJz[UUUUUUS9RU5 g)aVerifying whether the ``filename`` is a valid file name or not. Args: filename: Filename to validate. platform: Target platform name of the filename. .. include:: platform.txt min_len: Minimum byte length of the ``filename``. The value must be greater or equal to one. Defaults to ``1``. max_len: Maximum byte length of the ``filename``. The value must be lower than: - ``Linux``: 4096 - ``macOS``: 1024 - ``Windows``: 260 - ``universal``: 260 Defaults to ``255``. fs_encoding: Filesystem encoding that is used to calculate the byte length of the filename. If |None|, get the encoding from the execution environment. check_reserved: If |True|, check the reserved names of the ``platform``. additional_reserved_names: Additional reserved names to check. Case insensitive. Raises: ValidationError (ErrorReason.INVALID_LENGTH): If the ``filename`` is longer than ``max_len`` characters. ValidationError (ErrorReason.INVALID_CHARACTER): If the ``filename`` includes invalid character(s) for a filename: |invalid_filename_chars|. The following characters are also invalid for Windows platforms: |invalid_win_filename_chars|. ValidationError (ErrorReason.RESERVED_NAME): If the ``filename`` equals the reserved name by OS. Windows reserved name is as follows: ``"CON"``, ``"PRN"``, ``"AUX"``, ``"NUL"``, ``"COM[1-9]"``, ``"LPT[1-9]"``. Example: :ref:`example-validate-filename` See Also: `Naming Files, Paths, and Namespaces - Win32 apps | Microsoft Docs `__ r*r3r(r)r4r-N)r5rTrr*r3r(r)r4r-s r=validate_filenamers+x%"; hxr?c F[UUUcSOUUUUS9RU5$)aCheck whether the ``filename`` is a valid name or not. Args: filename: A filename to be checked. platform: Target platform name of the filename. Example: :ref:`example-is-valid-filename` See Also: :py:func:`.validate_filename()` rr)r5is_validrs r=is_valid_filenamer[s50 o7%";  hxr?rfFrAr+r,r.c Ub0[R"S[5 USLa[Rn[ UUcSOUUUUUU S9R X5$)a Make a valid filename from a string. To make a valid filename, the function does the following: - Replace invalid characters as file names included in the ``filename`` with the ``replacement_text``. Invalid characters are: - unprintable characters - |invalid_filename_chars| - for Windows (or universal) only: |invalid_win_filename_chars| - Replace a value if a sanitized value is a reserved name by operating systems with a specified handler by ``reserved_name_handler``. Args: filename: Filename to sanitize. replacement_text: Replacement text for invalid characters. Defaults to ``""``. platform: Target platform name of the filename. .. include:: platform.txt max_len: Maximum byte length of the ``filename``. Truncate the name length if the ``filename`` length exceeds this value. Defaults to ``255``. fs_encoding: Filesystem encoding that is used to calculate the byte length of the filename. If |None|, get the encoding from the execution environment. check_reserved: [Deprecated] Use 'reserved_name_handler' instead. null_value_handler: Function called when a value after sanitization is an empty string. You can specify predefined handlers: - :py:func:`~.handler.NullValueHandler.return_null_string` - :py:func:`~.handler.NullValueHandler.return_timestamp` - :py:func:`~.handler.raise_error` Defaults to :py:func:`.handler.NullValueHandler.return_null_string` that just return ``""``. reserved_name_handler: Function called when a value after sanitization is a reserved name. You can specify predefined handlers: - :py:meth:`~.handler.ReservedNameHandler.add_leading_underscore` - :py:meth:`~.handler.ReservedNameHandler.add_trailing_underscore` - :py:meth:`~.handler.ReservedNameHandler.as_is` - :py:func:`~.handler.raise_error` Defaults to :py:func:`.handler.add_trailing_underscore`. additional_reserved_names: Additional reserved names to sanitize. Case insensitive. validate_after_sanitize: Execute validation after sanitization to the file name. Returns: Same type as the ``filename`` (str or PathLike object): Sanitized filename. Raises: ValueError: If the ``filename`` is an invalid filename. Example: :ref:`example-sanitize-filename` zD'check_reserved' is deprecated. Use 'reserved_name_handler' instead.Fr)r*r(r)r+r,r-r.)warningswarnDeprecationWarningras_isr&rb) rrAr*r(r)r4r+r,r-r.s r=sanitize_filenamer}sg`! R  U "$7$=$= ! o7-3"; 7 hx*+r?)9__doc__rrrXrcollections.abcrpathlibrrrtypingrr_baser r r r _commonrrrrr_constrrr_typesrrerrorrrrrhandlerrrrrcompilerY_INVALID_FILENAME_CHARSUNICODEr#_INVALID_WIN_FILENAME_CHARSr$r&r5rkrQrlrrrrxr?r=rs $""PP[[HH*OO@$'5& jj (223A6a8"**e#%** (667:!B9=$)a+a+a+|$a+c] a+ # a+ TN a+!!78a+$$:;a+ ( 6a+"a+a+r?