k7iI`%SrSSKrSSKrSSKrSSKrSSKrSSKJr SSK J r J r SSKJ r SSK JrJr SSKJrJrJrJr SS KJrJrJrJr SS KJrJrJrJr SS KJ r J!r! SS K"J#r#J$r$ SS K%J&r&J'r'J(r(J)r)J*r* SSK+J,r,J-r- \R\"S\R^"\R`5SS3\Rb5r2\\3S'\R\"S\R^"\Rh5SS3\Rb5r5\\3S'"SS\5r6"SS\5r7S\SSSS4S\#S\\$S\8S\\8S\\9S\:S\\\9S S4S!jjr;S\SSSS4S\#S\\$S\8S\\8S\\9S\:S\\\9S \:4S"jjr<S)S\#S#\9S\\$S\\8S\\9S\\:S$\\-S%\\-S\\\9S&\:S'\:S \#4S(jjr=g)*zA .. codeauthor:: Tsuyoshi Hombashi N)Sequence)PathPurePath)Pattern)FinalOptional)AbstractSanitizerAbstractValidatorBaseFile BaseValidator)findall_to_str is_nt_abspathto_strvalidate_pathtype)_NTFS_RESERVED_FILE_NAMESDEFAULT_MIN_LENINVALID_CHAR_ERR_MSG_TMPLPlatform)FileNameSanitizerFileNameValidator)PathType PlatformType) ErrorAttrKey ErrorReasonInvalidCharErrorReservedNameErrorValidationError)ReservedNameHandlerValidationErrorHandler[s]_RE_INVALID_PATH_RE_INVALID_WIN_PATHc^\rSrSrSS\S\\S\\S\\S\\S\\ \S \ S \ S \\ S S4U4S jjjr SS\ S\S \ 4SjjrS \\4SjrS \4SjrSrU=r$)FilePathSanitizerNmax_len fs_encodingplatformnull_value_handlerreserved_name_handleradditional_reserved_names normalizevalidate_after_sanitize validatorreturnc j>U (aU n O[[UUSUUS9n [T U] UUU UUUUUS9 UR 5Ul[ URUUUUURUS9Ul Xpl URSS9(a[RUlg[RUlg)NTmin_lenr)r*check_reservedr.r+)r)r*r1r,r-r.r+r0)r)r*r,r-r.r+r0include_universal)FilePathValidatorrsuper__init___get_sanitize_regexp_sanitize_regexprr)r+#_FilePathSanitizer__fname_sanitizer_FilePathSanitizer__normalize _is_windowsntpath splitdrive_FilePathSanitizer__split_drive posixpath) selfr)r*r+r,r-r.r/r0r1fpath_validator __class__s P/home/james-whalen/.local/lib/python3.13/site-packages/pathvalidate/_filepath.pyr;FilePathSanitizer.__init__s 'O/''#*C! O #%1"7&?$;  !% 9 9 ;!2LL#1"7&?]]$;" %   d  3!'!2!2D !*!5!5D valuereplacement_textc[XRSS9(+S9 [U5nURU5upTURRX$5nUR(a&U(a[RR!U5nUn/nU(aUR#U5 UR%SS5R'S5HwnU[(;aUR#US35 M#[+UR,R/XS95n U (dU(dUR#S5 MfUR#U 5 My UR15R3U5nUR4R7U5 UR8(aUR4R7U5 [ U[5(a [;U5$U$![aPnUR[R :Xa,[ U[5(aeURU5sSnA$eSnAff=f![a9nUR[R :XaURU5nSnANSnAff=f) NTr7allow_whitespaces\/_)rL)rr@rreasonr NULL_NAME isinstancer_null_value_handlerrrCr=subr?ospathnormpathappendreplacesplitrstrr>sanitize&_FilePathSanitizer__get_path_separatorjoin _validatorvalidate_validate_after_sanitizer) rErKrLeunicode_filepathdrivesanitized_pathsanitized_entriesentrysanitized_entrys rHr`FilePathSanitizer.sanitizeRs  e;K;K^b;K;c7c d"%="&"4"45E"F00445EX    0!ww//0@A )')   $ $U +#++D#6<? 16$,HSM#:1616"&16-.16 1616f1h1#1x1f gcl crJr'c`^\rSrSr%\R "SR S\55\R5r \ \ S'Sr \ \ S'\ S\\S44U4S jj5r\S S S S S 4S \S\S\\S\\S\S\\\SS 4U4SjjjrS\SS 4SjrS\SS 4SjrS\SS 4SjrS\SS 4SjrSrU=r$)r9|c#V# UHnS[R"U5S3v M! g7f)z^/$N)reescape).0patterns rH FilePathValidator.s%U;T2bii()+;Ts')_RE_NTFS_RESERVED)rQ:_MACOS_RESERVED_FILE_PATHSr2.c>[TU]n[UR5UR 5UR 5/5(aXR -$UR5(aUS-$U$)N)rQ)r:reserved_keywordsany _is_universal _is_posix _is_macosr _is_linux)rEcommon_keywordsrGs rHr#FilePathValidator.reserved_keywordssc'3 ""$dnn&68HI J J"%D%DD D >>  "V+ +rJrwNTr5r)r*r+r6r.c >[TU]UUUUUUS9 [UURUUUUS9UlUR SS9(a[ RUlg[RUlg)Nr4Tr7) r:r;rr)#_FilePathValidator__fname_validatorr@rArB_FilePathValidator__split_driverD)rEr5r)r*r+r6r.rGs rHr;FilePathValidator.__init__s} #)&?  "3LL#)&? "    d  3!'!2!2D !*!5!5D rJrKc [XRSS9(+S9 URU5 URU5up#U(dg[ U5n[ UR UR55n[R[R[RUR[RUR[RU[R U0nXPR":a [%SUR"SSUSS3/40UD6eXPR&:a'[%SR)UR&U5/40UD6eUR+U5 UR-S S 5nUR/S 5H-nU(aUS ;aMUR0R3U5 M/ URSS9(aUR5U5 gUR7U5 g) NTr7rNz!file path is too long: expected<=dz bytes, actual=z bytesz?file path is too short: expected>={:d} bytes, actual={:d} bytesrPrQ).z..)rr@validate_abspathrrlenencode _fs_encodingrREASONrINVALID_LENGTHPLATFORMr+ FS_ENCODING BYTE_COUNTVALUEr)rr5format_validate_reserved_keywordsr]r^rrd)_FilePathValidator__validate_win_filepath*_FilePathValidator__validate_unix_filepath)rErK_drivetailrgbyte_ct err_kwargsrks rHrdFilePathValidator.validates%7G7GZ^7G7_3_` e$))%0  !$<&--d.?.?@A   !;!;  ! !4==  $ $d&7&7  # #W    0   \\ !!7 Q7GW^_`Vaagh   \\ !!U\\ g    (()9:+33D#>%++C0EE[0  " " + +E 2 1   d  3  ( ()9 :  ) )*: ;rJc[R"U5n[[U55n[ UR 5=(a UUR 5=(a U/5(agUR5(a4[ X2/5(a#[SUR[RS9 [SU<SURRS3S-S-UR[RS9nUR S S 9(a U(aUeUR 5(d*[R"U5upVU(a U(aUeggg) Nz8platform-independent absolute file path is not supported)r+rTzan invalid absolute file path (z) for the platform (z).zE to avoid the error, specify an appropriate platform corresponding toz the path format or 'auto'.) descriptionr+rTTr7)rDisabsrrrr@rrrr+rMALFORMED_ABS_PATHrKrArB)rErK is_posix_abs is_nt_abs err_objectrh_tails rHr"FilePathValidator.validate_abspaths# u- !&-0   "0y$..2B2S|T U U      C(A$B$B J"55  %1%:Nt}}ObObNccefYZ/0]]11    d  3  !!!,,U3LE  #u"rJrgc[RU5nU(a%[[R"[ U5S9US9eg)Ninvalid)rK)r$findallrrrr)rErgmatchs rH__validate_unix_filepath*FilePathValidator.__validate_unix_filepaths> (()9: ")009NO&  rJcr[RU5nU(a4[[R"[ U5S9[ RUS9eURU5up4U(aMURRU5nU(a*UR5n[SUS3SUURS9egg)Nr)r+rK'z' is a reserved nameF) reusable_name reserved_namer+)r%rrrrrrWINDOWSrrsearchgrouprr+)rErgrrrKmatch_reservedrs rH__validate_win_filepath)FilePathValidator.__validate_win_filepaths$,,-=> ")009NO!))&  **+;<  !33::5AN . 4 4 6 ' &:;"'"/!]]  rJ)__fname_validatorrv)rxryrzr{rcompilerbr IGNORECASErr__annotations__rpropertytupler_rrr|rrr}rr;rrdrrrr~rrs@rHr9r9s)!zz U;TUU  u)32  5c?  '%)+/#=A666c] 6 <( 6  6$,HSM#:6 66@.`__ Nrwr+r5r)r*r6r.)r9rdrr+r5r)r*r6r.s rHvalidate_filepathr3s1ro7%"; hyrJc F[UUUcSOUUUUS9RU5$)a Check whether the ``file_path`` is a valid name or not. Args: file_path: A filepath to be checked. platform: Target platform name of the file path. Example: :ref:`example-is-valid-filepath` See Also: :py:func:`.validate_filepath()` rwr)r9is_validrs rHis_valid_filepathrvs50 o7%";  hyrJrLr,r-r/r0c Ub0[R"S[5 USLa[Rn[ UUcSOUUU UUUU S9R X5$)a Make a valid file path from a string. To make a valid file path, the function does the following: - Replace invalid characters for a file path within the ``file_path`` with the ``replacement_text``. Invalid characters are as follows: - unprintable characters - |invalid_file_path_chars| - for Windows (or universal) only: |invalid_win_file_path_chars| - Replace a value if a sanitized value is a reserved name by operating systems with a specified handler by ``reserved_name_handler``. Args: file_path: File path to sanitize. replacement_text: Replacement text for invalid characters. Defaults to ``""``. platform: Target platform name of the file path. .. include:: platform.txt max_len: Maximum byte length of the file path. Truncate the path if the value length exceeds the `max_len`. If the value is |None| or minus, ``max_len`` will automatically determined by the ``platform``: - ``Linux``: 4096 - ``macOS``: 1024 - ``Windows``: 260 - ``universal``: 260 fs_encoding: Filesystem encoding that is used to calculate the byte length of the file path. 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 one of the reserved names. 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. normalize: If |True|, normalize the the file path. validate_after_sanitize: Execute validation after sanitization to the file path. Returns: Same type as the argument (str or PathLike object): Sanitized filepath. Raises: ValueError: If the ``file_path`` is an invalid file path. Example: :ref:`example-sanitize-file-path` zD'check_reserved' is deprecated. Use 'reserved_name_handler' instead.Frw)r+r)r*r/r,r-r.r0)warningswarnDeprecationWarningras_isr'r`) rrLr+r)r*r6r,r-r.r/r0s rHsanitize_filepathrsjt! R  U "$7$=$= ! o7-3"; 7 hy+ ,rJ) rSNNNNNNNTF)>__doc__rAos.pathrYrDrrcollections.abcrpathlibrrrtypingrr_baser r r r _commonrrrr_constrrrr _filenamerr_typesrrerrorrrrrrhandlerrr rr_INVALID_PATH_CHARSUNICODEr$r_INVALID_WIN_PATH_CHARSr%r'r9r|r_r}rrrrJrHrs $""PPMMcc;*bb@**q83O3O)PQR(SST%UWYWaWab%b jj (223A6a8"**e q)qh^ ^F(,"!!%9=@@|$@@c] @ # @  @ ( 6@ @J(,"!!%9=|$c]  #    ( 6 H'+!!%%);?>B9=$)l,l,l,|$l,c] l, # l, TN l,!!78l,$$:;l, ( 6l,l,"l,l,rJ