KiITUdZddlZddlZddlZddlZddlZddlmZddl m Z m Z ddlm Z ddl mZmZddlmZmZmZmZdd lmZmZmZmZdd lmZmZmZmZdd lm Z m!Z!dd l"m#Z#m$Z$dd l%m&Z&m'Z'm(Z(m)Z)m*Z*ddl+m,Z,m-Z-ej\dej^ej`ddejbZ2ee3d<ej\dej^ejhddejbZ5ee3d<GddeZ6GddeZ7deddddfde#dee$de8dee8dee9de:deee9d dfd!Z;deddddfde#dee$de8dee8dee9de:deee9d e:fd"Z< d)de#d#e9dee$dee8dee9dee:d$ee-d%ee-deee9d&e:d'e:d e#fd(Z=y)*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_PATHceZdZ ddedeedeedeedeedeeede d e d ee d dffd Z dd e ded e fdZ d eefdZd efdZxZS)FilePathSanitizerNmax_len fs_encodingplatformnull_value_handlerreserved_name_handleradditional_reserved_names normalizevalidate_after_sanitize validatorreturnc p| r| } ntt||d||} t | ||| ||||||j |_t |j|||||j||_ ||_ |jdrtj|_ytj|_y)NTmin_lenr(r)check_reservedr-r*)r(r)r0r+r,r-r*r/)r(r)r+r,r-r*r/include_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.r/r0fpath_validator __class__s b/home/jay/workspace/scripts/.codegraph-venv/lib/python3.12/site-packages/pathvalidate/_filepath.pyr:zFilePathSanitizer.__init__s 'O/''#*C! O #%1"7&?$;  !% 9 9 ;!2LL#1"7&?]]$;" %   d  3!'!2!2D !*!5!5D valuereplacement_textc t||jd t|}|j|\}}|jj||}|jr!|rtjj!|}|}g}|r|j#||j%ddj'dD]l}|t(vr|j#|d t+|j,j/||} | s|s|j#d\|j#| n|j1j3|} |j4j7||j8r|j4j7|t |tr t;|S|S#t$rJ}|jtj k(r't |tr|j|cYd}~Sd}~wwxYw#t$r8}|jtj k(r|j|}Yd}~d}~wwxYw) NTr6allow_whitespaces\/_)rJ)rr?rreasonr NULL_NAME isinstancer_null_value_handlerrrBr<subr>ospathnormpathappendreplacesplitrstrr=sanitize&_FilePathSanitizer__get_path_separatorjoin _validatorvalidate_validate_after_sanitizer) rDrIrJeunicode_filepathdrivesanitized_pathsanitized_entriesentrysanitized_entrys rGr^zFilePathSanitizer.sanitizeRs  e4;K;K^b;K;c7c d"%="&"4"45E"F00445EGWX    0!ww//0@A )')   $ $U +#++D#6<G<5H;G<<H I .IIc>|jdrtStS)NTr6)r?r%r$rDs rGr;z&FilePathSanitizer._get_sanitize_regexps   d  3' 'rHc&|jryy)NrNrO)r?rls rG__get_path_separatorz&FilePathSanitizer.__get_path_separators    rH) NNNNNTFN)rQ)__name__ __module__ __qualname__intrr]rr rboolr r:rr^rr;r_ __classcell__rFs@rGr'r's%)+/?CBF=A(-151616c]16<( 16 %%;< 16 ((>? 16$,HSM#:1616"&16-.16 16f1h1#1x1f gcl crHr'cFeZdZUejdj deDejZe e d<dZ e e d<e de edfffd Zed d d d d fd ed edeedeededeeedd ffd Zdedd fdZdedd fdZdedd fdZdedd fdZxZS)r8|c#NK|]}dtj|dyw)z^/$N)reescape).0patterns rG zFilePathValidator.s#U2bii()+Us#%_RE_NTFS_RESERVED)rO:_MACOS_RESERVED_FILE_PATHSr1.ct|}t|j|j |j gr||j zS|jr|dzS|S)N)rO)r9reserved_keywordsany _is_universal _is_posix _is_macosr _is_linux)rDcommon_keywordsrFs rGrz#FilePathValidator.reserved_keywordss_'3 ""$dnn&68HI J"T%D%DD D >> "V+ +rHroNTr4r(r)r*r5r-ct|||||||t||j|||||_|j drt j|_ytj|_y)Nr3Tr6) r9r:rr(#_FilePathValidator__fname_validatorr?r@rA_FilePathValidator__split_driverC)rDr4r(r)r*r5r-rFs rGr:zFilePathValidator.__init__s} #)&?  "3LL#)&? "    d  3!'!2!2D !*!5!5D rHrIc t||jd |j||j|\}}|syt |}t |j |j}tjtjtj|jtj|jtj|tj |i}||j"kDr t%d|j"dd|ddgfi|||j&kr't%dj)|j&|gfi||j+||j-d d }|j/d D]$}|r|d vr |j0j3|&|jdr|j5|y|j7|y) NTr6rLz!file path is too long: expected<=dz bytes, actual=z bytesz?file path is too short: expected>={:d} bytes, actual={:d} bytesrNrO).z..)rr?validate_abspathrrlenencode _fs_encodingrREASONrINVALID_LENGTHPLATFORMr* FS_ENCODING BYTE_COUNTVALUEr(rr4format_validate_reserved_keywordsr[r\rrb)_FilePathValidator__validate_win_filepath*_FilePathValidator__validate_unix_filepath)rDrI_drivetailrebyte_ct err_kwargsris rGrbzFilePathValidator.validates%t7G7GZ^7G7_3_` e$))%0  !$<&--d.?.?@A   !;!;  ! !4==  $ $d&7&7  # #W    0   T\\ !!7 Q7GW^_`Vaagh   T\\ !!U\\ g    (()9:+33D#>%++C0 3EE[0  " " + +E 2  3   d  3  ( ()9 :  ) )*: ;rHcZtj|}tt|}t |j xr||j xr|gry|jr3t ||gr&td|jtjtd|d|jjddzdz|jtj}|j d r|r||j s tj|\}}|r|r|yyy) Nz8platform-independent absolute file path is not supported)r*rRzan 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*rRTr6)rCisabsrrrr?rrrr*rMALFORMED_ABS_PATHrIr@rA)rDrI is_posix_abs is_nt_abs err_objectrf_tails rGrz"FilePathValidator.validate_abspaths u- !&-0   "0y$..2B2S|T U     CL(A$B J"55  %1%:Nt}}ObObNccefYZ/0]]11    d  3  !!,,U3LE5  #u"rHrectj|}|r*ttjt ||y)Ninvalid)rI)r$findallrrrr)rDrematchs rG__validate_unix_filepathz*FilePathValidator.__validate_unix_filepaths> (()9: ")009NO&  rHcftj|}|r9ttjt |t j||j|\}}|rK|jj|}|r-|j}td|dd||jyy)Nr)r*rI'z' is a reserved nameF) reusable_name reserved_namer*)r%rrrrrrWINDOWSrrsearchgrouprr*)rDrerrrImatch_reservedrs rG__validate_win_filepathz)FilePathValidator.__validate_win_filepaths$,,-=> ")009NO!))&  **+;<  !33::5AN . 4 4 6 ' &:;"'"/!]]  rH)rprqrrr{compiler`r IGNORECASErr__annotations__rpropertytupler]rrrsrrrtrr:rrbrrrrurvs@rGr8r8s!)rzz U;TUU  u)32  5c?  '%)+/#=A666c] 6 <( 6  6$,HSM#:6 6@.`__ Nror*r4r(r)r5r-)r8rbrr*r4r(r)r5r-s rGvalidate_filepathr3s1ro7%"; hyrHcJt|||dn||||j|S)a3Check 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()` ror)r8is_validrs rGis_valid_filepathrvs50 o7%";  hyrHrJr+r,r.r/c |.tjdt|durtj}t ||dn||| |||| j ||S)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.Fro)r*r(r)r.r+r,r-r/)warningswarnDeprecationWarningras_isr'r^) rrJr*r(r)r5r+r,r-r.r/s rGsanitize_filepathrsmt! R  U "$7$=$= ! o7-3"; 7 hy*+ ,rH) rQNNNNNNNTF)>__doc__r@os.pathrWrCr{rcollections.abcrpathlibrrrtypingrr_baser r r r _commonrrrr_constrrrr _filenamerr_typesrrerrorrrrrrhandlerrr rr|_INVALID_PATH_CHARSUNICODEr$r_INVALID_WIN_PATH_CHARSr%r'r8rsr]rtrrrrHrGrs $""PPMMcc;*bb@%"**q83O3O)PQR(SST%UWYWaWab%b(bjj  (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,rH