o
    ­ƒðjLE  ã                   @   s\  U d Z ddlZddlZddlZddlZddlmZ ddlmZm	Z	 ddlm
Z
 ddlmZmZ ddlmZmZmZmZ dd	lmZmZmZmZmZ dd
lmZmZmZ ddlmZmZ ddl m!Z!m"Z"m#Z#m$Z$ ddl%m&Z&m'Z' dZ(ee)d< e *de +ej,¡d›d�ej-¡Z.ee)d< e *de +ej/¡d›d�ej-¡Z0ee)d< G dd„ deƒZ1G dd„ deƒZ2dee(dddfdedee de3de3dee4 de5d eee4  d!dfd"d#„Z6deddddfdedee de3dee3 dee4 de5d eee4  d!e5fd$d%„Z7d&de(dddddd'f	ded(e4dee dee3 dee4 dee5 d)ee' d*ee' d eee4  d+e5d!efd,d-„Z8dS ).zA
.. codeauthor:: Tsuyoshi Hombashi <tsuyoshi.hombashi@gmail.com>
é    N)ÚSequence)ÚPathÚPurePath)ÚPattern)ÚFinalÚOptionalé   )ÚAbstractSanitizerÚAbstractValidatorÚBaseFileÚBaseValidator)Úfindall_to_strÚis_nt_abspathÚto_strÚtruncate_strÚvalidate_pathtype)ÚDEFAULT_MIN_LENÚINVALID_CHAR_ERR_MSG_TMPLÚPlatform)ÚPathTypeÚPlatformType)ÚErrorAttrKeyÚErrorReasonÚInvalidCharErrorÚValidationError)ÚReservedNameHandlerÚValidationErrorHandleréÿ   Ú_DEFAULT_MAX_FILENAME_LENú[Úsú]Ú_RE_INVALID_FILENAMEÚ_RE_INVALID_WIN_FILENAMEc                       sš   e Zd Zedddddddfdedee dee dee dee dee	e  d	e
d
ee ddf‡ fdd„Zddededefdd„Zdee fdd„Z‡  ZS )ÚFileNameSanitizerNFÚmax_lenÚfs_encodingÚplatformÚnull_value_handlerÚreserved_name_handlerÚadditional_reserved_namesÚvalidate_after_sanitizeÚ	validatorÚreturnc	           
   
      sH   |r|}	n
t t||d||d�}	tƒ j||||||||	d� |  ¡ | _d S )NT©Úmin_lenr%   r&   Úcheck_reservedr*   r'   )r%   r&   r(   r)   r*   r'   r+   r,   )ÚFileNameValidatorr   ÚsuperÚ__init__Ú_get_sanitize_regexpÚ_sanitize_regexp)
Úselfr%   r&   r'   r(   r)   r*   r+   r,   Úfname_validator©Ú	__class__© ú˜/tmp/claude-1000/-var-www-html-academy/3f42efd1-c2b7-4d08-9b05-30d86bb35479/scratchpad/piper/venv/lib/python3.10/site-packages/pathvalidate/_filename.pyr3       s*   ú	øzFileNameSanitizer.__init__Ú ÚvalueÚreplacement_textc              
   C   s¦  zt || jdd� d� W n$ ty1 } z|jtjkr,t|tƒr!‚ |  |¡W  Y d }~S ‚ d }~ww | j	 
|t|ƒ¡}t|| j| jƒ}z| j |¡ W nY ty¤ } zM|jtjkro|  |¡}|j|krnt 
t |j¡||¡}n+|jtjkr�| jdd�r�| d¡}| d¡}|dvrŽ| d¡}n|jtjkrš|  |¡}W Y d }~nd }~ww | jrÈz| j |¡ W n tyÇ } ztt|ƒtj| jd�‚d }~ww t|tƒrÑt|ƒS |S )NT©Úinclude_universal©Úallow_whitespacesú ©Ú.z..z .)ÚdescriptionÚreasonr'   )r   Ú_is_windowsr   rG   r   Ú	NULL_NAMEÚ
isinstancer   Ú_null_value_handlerr5   ÚsubÚstrr   Ú_fs_encodingr%   Ú
_validatorÚvalidateÚRESERVED_NAMEÚ_reserved_name_handlerÚreserved_nameÚreÚescapeÚINVALID_CHARACTERÚlstripÚrstripÚ_validate_after_sanitizeÚINVALID_AFTER_SANITIZEr'   r   )r6   r=   r>   ÚeÚsanitized_filenameÚreplacement_wordr:   r:   r;   ÚsanitizeD   s`   
€ú

ÿ€ÿ


€
€îý€ÿ
zFileNameSanitizer.sanitizec                 C   s   | j dd�rtS tS )NTr?   )rH   r#   r"   )r6   r:   r:   r;   r4   w   s   z&FileNameSanitizer._get_sanitize_regexp)r<   )Ú__name__Ú
__module__Ú__qualname__r   Úintr   rM   r   r   r   Úboolr
   r3   r   r^   r   r4   Ú__classcell__r:   r:   r8   r;   r$      s<    ÷þýüûú
ùø	÷
ö$3r$   c                       s  e Zd ZU dedd„ e deddƒ¡D ƒƒ edd„ e dd¡D ƒƒ Zee	d	< d
Z
ee	d< edeedf f‡ fdd„ƒZeeddddfdededee dee dedeee  ddf‡ fdd„Zdeddfdd„Zdeddfdd„Zdeddfd d!„Zdeddfd"d#„Z‡  ZS )$r1   )ÚCONÚPRNÚAUXzCLOCK$ÚNULc                 c   s$   � | ]\}}|d ›|d›�V  qdS )r    ÚdNr:   )Ú.0ÚnameÚnumr:   r:   r;   Ú	<genexpr>�   s   €" zFileNameValidator.<genexpr>)ÚCOMÚLPTr   é
   c                 c   s$   � | ]\}}|d ›|d ›�V  qdS )r    Nr:   )rj   rk   Ússdr:   r:   r;   rm   ‚   s
   € ÿ
ÿ)õ   Â¹õ   Â²õ   Â³Ú_WINDOWS_RESERVED_FILE_NAMES)ú:Ú_MACOS_RESERVED_FILE_NAMESr-   .c                    sr   t ƒ j}|  ¡ rt|| j | j ƒ}n |  ¡ rt|| j ƒ}n|  ¡ s'|  ¡ r/t|| j ƒ}nt|ƒ}t	t
|ƒƒS )N)r2   Úreserved_keywordsÚ_is_universalÚsetru   rw   rH   Ú	_is_posixÚ	_is_macosÚtupleÚsorted)r6   Úcommon_keywordsÚword_setr8   r:   r;   rx   Œ   s   ÿþÿz#FileNameValidator.reserved_keywordsNTr/   r%   r&   r'   r0   r*   c                    s   t ƒ j||||||d� d S )Nr.   )r2   r3   )r6   r/   r%   r&   r'   r0   r*   r8   r:   r;   r3   Ÿ   s   	
úzFileNameValidator.__init__r=   c              
   C   sò   t || jdd� d� t|ƒ}t| | j¡ƒ}|  |¡ tjt	j
tj| jtj| jtj|tj|i}|| jkrHtd| jd›d|d›d�gfi |¤Ž‚|| jk r`td| jd›d|d›d�gfi |¤Ž‚|  |¡ |  |¡ | jdd�rw|  |¡ d S d S )	NTr?   rA   z filename is too long: expected<=ri   z bytes, actual=z bytesz!filename is too short: expected>=)r   rH   r   ÚlenÚencoderN   Úvalidate_abspathr   ÚREASONr   ÚINVALID_LENGTHÚPLATFORMr'   ÚFS_ENCODINGÚ
BYTE_COUNTÚVALUEr%   r   r/   Ú_validate_reserved_keywordsÚ/_FileNameValidator__validate_universal_filenameÚ)_FileNameValidator__validate_win_filename)r6   r=   Úunicode_filenameÚbyte_ctÚ
err_kwargsr:   r:   r;   rP   ±   s:   
û
ÿÿü
ÿÿü

ÿzFileNameValidator.validatec                 C   sD   t d|›d�| jtjd�}| jdd�rt|ƒr|‚t |¡r |‚d S )Nzfound an absolute path (z), expected a filename)rF   r'   rG   Tr?   )r   r'   r   ÚFOUND_ABS_PATHrH   r   Ú	posixpathÚisabs)r6   r=   Úerrr:   r:   r;   rƒ   Õ   s   
ý
ÿz"FileNameValidator.validate_abspathr�   c                 C   s.   t  |¡}|rttjt|ƒd�tj|d�‚d S )N©Úinvalid©r'   r=   )r"   Úfindallr   r   Úformatr   r   Ú	UNIVERSAL)r6   r�   Úmatchr:   r:   r;   Ú__validate_universal_filenameã   s   
ÿûÿz/FileNameValidator.__validate_universal_filenamec                 C   sÀ   t  |¡}|rttjt|ƒd�tj|d�‚|dv rd S d}tj	tjtj
|i}|d dv rBttjt |d ¡d�fd| d¡i|¤Ž‚|d	 d
v r^ttjt |d	 ¡d�fd| d¡i|¤Ž‚d S )Nr”   r–   rD   z€{}. Refer: https://learn.microsoft.com/en-us/troubleshoot/windows-client/shell-experience/file-folder-name-whitespace-characterséÿÿÿÿ)rC   rE   rF   z<Do not end a file or directory name with a space or a periodr   rC   z2Do not start a file or directory name with a space)r#   r—   r   r   r˜   r   r   ÚWINDOWSr   r†   r‰   rT   rU   )r6   r�   rš   ÚKB2829981_err_tmplr�   r:   r:   r;   Ú__validate_win_filenameî   sH   
ÿûþÿÿþûÿÿþûÿz)FileNameValidator.__validate_win_filename)r_   r`   ra   r}   Ú	itertoolsÚproductÚrangeru   r   Ú__annotations__rw   ÚpropertyrM   rx   r   r   rb   r   r   rc   r   r3   r   rP   rƒ   r‹   rŒ   rd   r:   r:   r8   r;   r1   ~   sP   
 ÿþþþ
ÿùþýüûú
ùø$r1   TÚfilenamer'   r/   r%   r&   r0   r*   r-   c                 C   s   t ||||||d� | ¡ dS )a¥  Verifying 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
        <https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file>`__
    ©r'   r/   r%   r&   r0   r*   N)r1   rP   ©r¥   r'   r/   r%   r&   r0   r*   r:   r:   r;   Úvalidate_filename  s   <úr¨   c                 C   s&   t |||du r	dn||||d� | ¡S )a0  Check 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()`
    Nrœ   r¦   )r1   Úis_validr§   r:   r:   r;   Úis_valid_filename[  s   úùrª   r<   Fr>   r(   r)   r+   c
           
   	   C   sL   |durt  dt¡ |du rtj}t||du rdn||||||	d� | |¡S )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`
    NzD'check_reserved' is deprecated. Use 'reserved_name_handler' instead.Frœ   )r'   r%   r&   r(   r)   r*   r+   )ÚwarningsÚwarnÚDeprecationWarningr   Úas_isr$   r^   )
r¥   r>   r'   r%   r&   r0   r(   r)   r*   r+   r:   r:   r;   Úsanitize_filename}  s$   Pþùør¯   )9Ú__doc__r    r‘   rT   r«   Úcollections.abcr   Úpathlibr   r   r   Útypingr   r   Ú_baser	   r
   r   r   Ú_commonr   r   r   r   r   Ú_constr   r   r   Ú_typesr   r   Úerrorr   r   r   r   Úhandlerr   r   r   r£   ÚcompilerU   Ú_INVALID_FILENAME_CHARSÚUNICODEr"   Ú_INVALID_WIN_FILENAME_CHARSr#   r$   r1   rb   rM   rc   r¨   rª   r¯   r:   r:   r:   r;   Ú<module>   sÎ    ÿÿ_ ùÿþýüûú
ù
øHùÿþýüûú
ù
ø$öÿþýüûúùø
	÷
öõ