
'''simple docstring'''







import os
import shutil
import sys
import tempfile
import unittest
from pathlib import Path

import pytest

import transformers
from transformers import (
    BERT_PRETRAINED_CONFIG_ARCHIVE_MAP,
    GPT2_PRETRAINED_CONFIG_ARCHIVE_MAP,
    AutoTokenizer,
    BertConfig,
    BertTokenizer,
    BertTokenizerFast,
    CTRLTokenizer,
    GPTaTokenizer,
    GPTaTokenizerFast,
    PreTrainedTokenizerFast,
    RobertaTokenizer,
    RobertaTokenizerFast,
    is_tokenizers_available,
)
from transformers.models.auto.configuration_auto import CONFIG_MAPPING, AutoConfig
from transformers.models.auto.tokenization_auto import (
    TOKENIZER_MAPPING,
    get_tokenizer_config,
    tokenizer_class_from_name,
)
from transformers.models.roberta.configuration_roberta import RobertaConfig
from transformers.testing_utils import (
    DUMMY_DIFF_TOKENIZER_IDENTIFIER,
    DUMMY_UNKNOWN_IDENTIFIER,
    SMALL_MODEL_IDENTIFIER,
    RequestCounter,
    require_tokenizers,
    slow,
)


sys.path.append(str(Path(__file__).parent.parent.parent.parent / "utils"))

from test_module.custom_configuration import CustomConfig  # noqa E402
from test_module.custom_tokenization import CustomTokenizer  # noqa E402


if is_tokenizers_available():
					from test_module.custom_tokenization_fast import CustomTokenizerFast


class 						__UpperCAmelCase      (					unittest.TestCase						):


							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								_snake_case   						=		0


							@slow
							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								for model_name in (x for x in BERT_PRETRAINED_CONFIG_ARCHIVE_MAP.keys() if "japanese" not in x):
									_snake_case   						=		AutoTokenizer.from_pretrained(lowerCAmelCase_  )
									self.assertIsNotNone(lowerCAmelCase_  )
									self.assertIsInstance(lowerCAmelCase_    ,   (BertTokenizer, BertTokenizerFast)  )
									self.assertGreater(len(lowerCAmelCase_  )    ,   0  )

								for model_name in GPT2_PRETRAINED_CONFIG_ARCHIVE_MAP.keys():
									_snake_case   						=		AutoTokenizer.from_pretrained(lowerCAmelCase_  )
									self.assertIsNotNone(lowerCAmelCase_  )
									self.assertIsInstance(lowerCAmelCase_    ,   (GPTaTokenizer, GPTaTokenizerFast)  )
									self.assertGreater(len(lowerCAmelCase_  )    ,   0  )


							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								_snake_case   						=		AutoTokenizer.from_pretrained(lowerCAmelCase_  )
								self.assertIsInstance(lowerCAmelCase_    ,   (BertTokenizer, BertTokenizerFast)  )
								self.assertEqual(tokenizer.vocab_size    ,   12  )


							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								_snake_case   						=		AutoTokenizer.from_pretrained(lowerCAmelCase_  )
								self.assertIsInstance(lowerCAmelCase_    ,   (RobertaTokenizer, RobertaTokenizerFast)  )
								self.assertEqual(tokenizer.vocab_size    ,   20  )


							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								_snake_case   						=		AutoConfig.from_pretrained(lowerCAmelCase_  )
								self.assertIsInstance(lowerCAmelCase_    ,   lowerCAmelCase_  )
								# Check that tokenizer_type ≠ model_type
								_snake_case   						=		AutoTokenizer.from_pretrained(lowerCAmelCase_    ,   config=lowerCAmelCase_  )
								self.assertIsInstance(lowerCAmelCase_    ,   (BertTokenizer, BertTokenizerFast)  )
								self.assertEqual(tokenizer.vocab_size    ,   12  )


							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								with tempfile.TemporaryDirectory() as tmp_dir:
									shutil.copy('./tests/fixtures/vocab.txt'    ,   os.path.join(lowerCAmelCase_    ,   'vocab.txt'  )  )

									_snake_case   						=		AutoTokenizer.from_pretrained(lowerCAmelCase_    ,   tokenizer_type='bert'    ,   use_fast=lowerCAmelCase_  )
									self.assertIsInstance(lowerCAmelCase_    ,   lowerCAmelCase_  )

								with tempfile.TemporaryDirectory() as tmp_dir:
									shutil.copy('./tests/fixtures/vocab.json'    ,   os.path.join(lowerCAmelCase_    ,   'vocab.json'  )  )
									shutil.copy('./tests/fixtures/merges.txt'    ,   os.path.join(lowerCAmelCase_    ,   'merges.txt'  )  )

									_snake_case   						=		AutoTokenizer.from_pretrained(lowerCAmelCase_    ,   tokenizer_type='gpt2'    ,   use_fast=lowerCAmelCase_  )
									self.assertIsInstance(lowerCAmelCase_    ,   lowerCAmelCase_  )


							@require_tokenizers
							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								with tempfile.TemporaryDirectory() as tmp_dir:
									shutil.copy('./tests/fixtures/vocab.txt'    ,   os.path.join(lowerCAmelCase_    ,   'vocab.txt'  )  )

									_snake_case   						=		AutoTokenizer.from_pretrained(lowerCAmelCase_    ,   tokenizer_type='bert'  )
									self.assertIsInstance(lowerCAmelCase_    ,   lowerCAmelCase_  )

								with tempfile.TemporaryDirectory() as tmp_dir:
									shutil.copy('./tests/fixtures/vocab.json'    ,   os.path.join(lowerCAmelCase_    ,   'vocab.json'  )  )
									shutil.copy('./tests/fixtures/merges.txt'    ,   os.path.join(lowerCAmelCase_    ,   'merges.txt'  )  )

									_snake_case   						=		AutoTokenizer.from_pretrained(lowerCAmelCase_    ,   tokenizer_type='gpt2'  )
									self.assertIsInstance(lowerCAmelCase_    ,   lowerCAmelCase_  )


							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								with pytest.raises(lowerCAmelCase_  ):
									AutoTokenizer.from_pretrained('./'    ,   tokenizer_type='xxx'  )


							@require_tokenizers
							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								for tokenizer_class in [BertTokenizer, BertTokenizerFast, AutoTokenizer]:
									_snake_case   						=		tokenizer_class.from_pretrained('wietsedv/bert-base-dutch-cased'  )
									self.assertIsInstance(lowerCAmelCase_    ,   (BertTokenizer, BertTokenizerFast)  )

									if isinstance(lowerCAmelCase_    ,   lowerCAmelCase_  ):
										self.assertEqual(tokenizer.basic_tokenizer.do_lower_case    ,   lowerCAmelCase_  )
									else:
										self.assertEqual(tokenizer.do_lower_case    ,   lowerCAmelCase_  )

									self.assertEqual(tokenizer.model_max_length    ,   5_12  )


							@require_tokenizers
							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								for tokenizer_class in [BertTokenizer, BertTokenizerFast, AutoTokenizer]:
									with self.assertRaisesRegex(
									    lowerCAmelCase_    ,   'julien-c/herlolip-not-exists is not a local folder and is not a valid model identifier'    ,   ):
										_snake_case   						=		tokenizer_class.from_pretrained('julien-c/herlolip-not-exists'  )


							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								_snake_case   						=		TOKENIZER_MAPPING.values()
								_snake_case   						=		[]

								for slow_tok, fast_tok in tokenizers:
									if slow_tok is not None:
										tokenizer_names.append(slow_tok.__name__  )

									if fast_tok is not None:
										tokenizer_names.append(fast_tok.__name__  )

								for tokenizer_name in tokenizer_names:
									# must find the right class
									tokenizer_class_from_name(lowerCAmelCase_  )


							@require_tokenizers
							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								self.assertIsInstance(AutoTokenizer.from_pretrained('bert-base-cased'    ,   use_fast=lowerCAmelCase_  )    ,   lowerCAmelCase_  )
								self.assertIsInstance(AutoTokenizer.from_pretrained('bert-base-cased'  )    ,   lowerCAmelCase_  )


							@require_tokenizers
							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								_snake_case   						=		AutoTokenizer.from_pretrained('distilbert-base-uncased'    ,   do_lower_case=lowerCAmelCase_  )
								_snake_case   						=		'Hello, world. How are you?'
								_snake_case   						=		tokenizer.tokenize(lowerCAmelCase_  )
								self.assertEqual('[UNK]'    ,   tokens[0]  )

								_snake_case   						=		AutoTokenizer.from_pretrained('microsoft/mpnet-base'    ,   do_lower_case=lowerCAmelCase_  )
								_snake_case   						=		tokenizer.tokenize(lowerCAmelCase_  )
								self.assertEqual('[UNK]'    ,   tokens[0]  )


							@require_tokenizers
							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								_snake_case   						=		AutoTokenizer.from_pretrained('robot-test/dummy-tokenizer-fast-with-model-config'  )
								self.assertEqual(type(lowerCAmelCase_  )    ,   lowerCAmelCase_  )
								self.assertEqual(tokenizer.model_max_length    ,   5_12  )
								self.assertEqual(tokenizer.vocab_size    ,   3_00_00  )
								self.assertEqual(tokenizer.unk_token    ,   '[UNK]'  )
								self.assertEqual(tokenizer.padding_side    ,   'right'  )
								self.assertEqual(tokenizer.truncation_side    ,   'right'  )


							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								_snake_case   						=		AutoTokenizer.from_pretrained(lowerCAmelCase_  )
								self.assertIsInstance(lowerCAmelCase_    ,   (BertTokenizer, BertTokenizerFast)  )
								with tempfile.TemporaryDirectory() as tmp_dir:
									tokenizer.save_pretrained(lowerCAmelCase_  )
									_snake_case   						=		AutoTokenizer.from_pretrained(lowerCAmelCase_  )

								self.assertIsInstance(lowerCAmelCase_    ,   tokenizer.__class__  )
								self.assertEqual(tokenizera.vocab_size    ,   12  )


							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								_snake_case   						=		AutoTokenizer.from_pretrained('ctrl'  )
								# There is no fast CTRL so this always gives us a slow tokenizer.
								self.assertIsInstance(lowerCAmelCase_    ,   lowerCAmelCase_  )


							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								_snake_case   						=		get_tokenizer_config('bert-base-cased'  )
								_snake_case   						=		config.pop('_commit_hash'    ,   lowerCAmelCase_  )
								# If we ever update bert-base-cased tokenizer config, this dict here will need to be updated.
								self.assertEqual(lowerCAmelCase_    ,   {'do_lower_case': False}  )

								# This model does not have a tokenizer_config so we get back an empty dict.
								_snake_case   						=		get_tokenizer_config(lowerCAmelCase_  )
								self.assertDictEqual(lowerCAmelCase_    ,   {}  )

								# A tokenizer saved with `save_pretrained` always creates a tokenizer config.
								_snake_case   						=		AutoTokenizer.from_pretrained(lowerCAmelCase_  )
								with tempfile.TemporaryDirectory() as tmp_dir:
									tokenizer.save_pretrained(lowerCAmelCase_  )
									_snake_case   						=		get_tokenizer_config(lowerCAmelCase_  )

								# Check the class of the tokenizer was properly saved (note that it always saves the slow class).
								self.assertEqual(config['tokenizer_class']    ,   'BertTokenizer'  )


							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								try:
									AutoConfig.register('custom'    ,   lowerCAmelCase_  )

									AutoTokenizer.register(lowerCAmelCase_    ,   slow_tokenizer_class=lowerCAmelCase_  )
									# Trying to register something existing in the Transformers library will raise an error
									with self.assertRaises(lowerCAmelCase_  ):
										AutoTokenizer.register(lowerCAmelCase_    ,   slow_tokenizer_class=lowerCAmelCase_  )

									_snake_case   						=		CustomTokenizer.from_pretrained(lowerCAmelCase_  )
									with tempfile.TemporaryDirectory() as tmp_dir:
										tokenizer.save_pretrained(lowerCAmelCase_  )

										_snake_case   						=		AutoTokenizer.from_pretrained(lowerCAmelCase_  )
										self.assertIsInstance(lowerCAmelCase_    ,   lowerCAmelCase_  )

								finally:
									if "custom" in CONFIG_MAPPING._extra_content:
										del CONFIG_MAPPING._extra_content["custom"]
									if CustomConfig in TOKENIZER_MAPPING._extra_content:
										del TOKENIZER_MAPPING._extra_content[CustomConfig]


							@require_tokenizers
							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								try:
									AutoConfig.register('custom'    ,   lowerCAmelCase_  )

									# Can register in two steps
									AutoTokenizer.register(lowerCAmelCase_    ,   slow_tokenizer_class=lowerCAmelCase_  )
									self.assertEqual(TOKENIZER_MAPPING[CustomConfig]    ,   (CustomTokenizer, None)  )
									AutoTokenizer.register(lowerCAmelCase_    ,   fast_tokenizer_class=lowerCAmelCase_  )
									self.assertEqual(TOKENIZER_MAPPING[CustomConfig]    ,   (CustomTokenizer, CustomTokenizerFast)  )

									del TOKENIZER_MAPPING._extra_content[CustomConfig]
									# Can register in one step
									AutoTokenizer.register(
									    lowerCAmelCase_    ,   slow_tokenizer_class=lowerCAmelCase_    ,   fast_tokenizer_class=lowerCAmelCase_  )
									self.assertEqual(TOKENIZER_MAPPING[CustomConfig]    ,   (CustomTokenizer, CustomTokenizerFast)  )

									# Trying to register something existing in the Transformers library will raise an error
									with self.assertRaises(lowerCAmelCase_  ):
										AutoTokenizer.register(lowerCAmelCase_    ,   fast_tokenizer_class=lowerCAmelCase_  )

									# We pass through a bert tokenizer fast cause there is no converter slow to fast for our new toknizer
									# and that model does not have a tokenizer.json
									with tempfile.TemporaryDirectory() as tmp_dir:
										_snake_case   						=		BertTokenizerFast.from_pretrained(lowerCAmelCase_  )
										bert_tokenizer.save_pretrained(lowerCAmelCase_  )
										_snake_case   						=		CustomTokenizerFast.from_pretrained(lowerCAmelCase_  )

									with tempfile.TemporaryDirectory() as tmp_dir:
										tokenizer.save_pretrained(lowerCAmelCase_  )

										_snake_case   						=		AutoTokenizer.from_pretrained(lowerCAmelCase_  )
										self.assertIsInstance(lowerCAmelCase_    ,   lowerCAmelCase_  )

										_snake_case   						=		AutoTokenizer.from_pretrained(lowerCAmelCase_    ,   use_fast=lowerCAmelCase_  )
										self.assertIsInstance(lowerCAmelCase_    ,   lowerCAmelCase_  )

								finally:
									if "custom" in CONFIG_MAPPING._extra_content:
										del CONFIG_MAPPING._extra_content["custom"]
									if CustomConfig in TOKENIZER_MAPPING._extra_content:
										del TOKENIZER_MAPPING._extra_content[CustomConfig]


							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								with self.assertRaises(lowerCAmelCase_  ):
									_snake_case   						=		AutoTokenizer.from_pretrained('hf-internal-testing/test_dynamic_tokenizer'  )
								# If remote code is disabled, we can't load this config.
								with self.assertRaises(lowerCAmelCase_  ):
									_snake_case   						=		AutoTokenizer.from_pretrained(
									    'hf-internal-testing/test_dynamic_tokenizer'    ,   trust_remote_code=lowerCAmelCase_  )

								_snake_case   						=		AutoTokenizer.from_pretrained('hf-internal-testing/test_dynamic_tokenizer'    ,   trust_remote_code=lowerCAmelCase_  )
								self.assertTrue(tokenizer.special_attribute_present  )
								# Test tokenizer can be reloaded.
								with tempfile.TemporaryDirectory() as tmp_dir:
									tokenizer.save_pretrained(lowerCAmelCase_  )
									_snake_case   						=		AutoTokenizer.from_pretrained(lowerCAmelCase_    ,   trust_remote_code=lowerCAmelCase_  )
								self.assertTrue(reloaded_tokenizer.special_attribute_present  )

								if is_tokenizers_available():
									self.assertEqual(tokenizer.__class__.__name__    ,   'NewTokenizerFast'  )
									self.assertEqual(reloaded_tokenizer.__class__.__name__    ,   'NewTokenizerFast'  )

									# Test we can also load the slow version
									_snake_case   						=		AutoTokenizer.from_pretrained(
									    'hf-internal-testing/test_dynamic_tokenizer'    ,   trust_remote_code=lowerCAmelCase_    ,   use_fast=lowerCAmelCase_  )
									self.assertTrue(tokenizer.special_attribute_present  )
									self.assertEqual(tokenizer.__class__.__name__    ,   'NewTokenizer'  )
									# Test tokenizer can be reloaded.
									with tempfile.TemporaryDirectory() as tmp_dir:
										tokenizer.save_pretrained(lowerCAmelCase_  )
										_snake_case   						=		AutoTokenizer.from_pretrained(lowerCAmelCase_    ,   trust_remote_code=lowerCAmelCase_    ,   use_fast=lowerCAmelCase_  )
									self.assertEqual(reloaded_tokenizer.__class__.__name__    ,   'NewTokenizer'  )
									self.assertTrue(reloaded_tokenizer.special_attribute_present  )
								else:
									self.assertEqual(tokenizer.__class__.__name__    ,   'NewTokenizer'  )
									self.assertEqual(reloaded_tokenizer.__class__.__name__    ,   'NewTokenizer'  )


							@require_tokenizers
							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								class 						__UpperCAmelCase      (					_lowerCamelCase						):
															__lowercase      		=       False


								class 						__UpperCAmelCase      (					_lowerCamelCase						):
															__lowercase      		=       NewTokenizer
															__lowercase      		=       False

								try:
									AutoConfig.register('custom'    ,   lowerCAmelCase_  )
									AutoTokenizer.register(lowerCAmelCase_    ,   slow_tokenizer_class=lowerCAmelCase_  )
									AutoTokenizer.register(lowerCAmelCase_    ,   fast_tokenizer_class=lowerCAmelCase_  )
									# If remote code is not set, the default is to use local
									_snake_case   						=		AutoTokenizer.from_pretrained('hf-internal-testing/test_dynamic_tokenizer'  )
									self.assertEqual(tokenizer.__class__.__name__    ,   'NewTokenizerFast'  )
									self.assertFalse(tokenizer.special_attribute_present  )
									_snake_case   						=		AutoTokenizer.from_pretrained('hf-internal-testing/test_dynamic_tokenizer'    ,   use_fast=lowerCAmelCase_  )
									self.assertEqual(tokenizer.__class__.__name__    ,   'NewTokenizer'  )
									self.assertFalse(tokenizer.special_attribute_present  )

									# If remote code is disabled, we load the local one.
									_snake_case   						=		AutoTokenizer.from_pretrained(
									    'hf-internal-testing/test_dynamic_tokenizer'    ,   trust_remote_code=lowerCAmelCase_  )
									self.assertEqual(tokenizer.__class__.__name__    ,   'NewTokenizerFast'  )
									self.assertFalse(tokenizer.special_attribute_present  )
									_snake_case   						=		AutoTokenizer.from_pretrained(
									    'hf-internal-testing/test_dynamic_tokenizer'    ,   trust_remote_code=lowerCAmelCase_    ,   use_fast=lowerCAmelCase_  )
									self.assertEqual(tokenizer.__class__.__name__    ,   'NewTokenizer'  )
									self.assertFalse(tokenizer.special_attribute_present  )

									# If remote is enabled, we load from the Hub
									_snake_case   						=		AutoTokenizer.from_pretrained(
									    'hf-internal-testing/test_dynamic_tokenizer'    ,   trust_remote_code=lowerCAmelCase_  )
									self.assertEqual(tokenizer.__class__.__name__    ,   'NewTokenizerFast'  )
									self.assertTrue(tokenizer.special_attribute_present  )
									_snake_case   						=		AutoTokenizer.from_pretrained(
									    'hf-internal-testing/test_dynamic_tokenizer'    ,   trust_remote_code=lowerCAmelCase_    ,   use_fast=lowerCAmelCase_  )
									self.assertEqual(tokenizer.__class__.__name__    ,   'NewTokenizer'  )
									self.assertTrue(tokenizer.special_attribute_present  )

								finally:
									if "custom" in CONFIG_MAPPING._extra_content:
										del CONFIG_MAPPING._extra_content["custom"]
									if CustomConfig in TOKENIZER_MAPPING._extra_content:
										del TOKENIZER_MAPPING._extra_content[CustomConfig]


							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								_snake_case   						=		AutoTokenizer.from_pretrained(
								    'hf-internal-testing/test_dynamic_tokenizer_legacy'    ,   trust_remote_code=lowerCAmelCase_  )
								self.assertTrue(tokenizer.special_attribute_present  )
								if is_tokenizers_available():
									self.assertEqual(tokenizer.__class__.__name__    ,   'NewTokenizerFast'  )

									# Test we can also load the slow version
									_snake_case   						=		AutoTokenizer.from_pretrained(
									    'hf-internal-testing/test_dynamic_tokenizer_legacy'    ,   trust_remote_code=lowerCAmelCase_    ,   use_fast=lowerCAmelCase_  )
									self.assertTrue(tokenizer.special_attribute_present  )
									self.assertEqual(tokenizer.__class__.__name__    ,   'NewTokenizer'  )
								else:
									self.assertEqual(tokenizer.__class__.__name__    ,   'NewTokenizer'  )


							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								with self.assertRaisesRegex(
								    lowerCAmelCase_    ,   'bert-base is not a local folder and is not a valid model identifier'  ):
									_snake_case   						=		AutoTokenizer.from_pretrained('bert-base'  )


							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								with self.assertRaisesRegex(
								    lowerCAmelCase_    ,   R'aaaaaa is not a valid git identifier \(branch name, tag name or commit id\)'  ):
									_snake_case   						=		AutoTokenizer.from_pretrained(lowerCAmelCase_    ,   revision='aaaaaa'  )




							def  lowerCamelCase				(       self  ):





								"""simple docstring"""






								_snake_case   						=		AutoTokenizer.from_pretrained('hf-internal-testing/tiny-random-bert'  )
								with RequestCounter() as counter:
									_snake_case   						=		AutoTokenizer.from_pretrained('hf-internal-testing/tiny-random-bert'  )
									self.assertEqual(counter.get_request_count    ,   0  )
									self.assertEqual(counter.head_request_count    ,   1  )
									self.assertEqual(counter.other_request_count    ,   0  )



import bza
import gzip
import lzma
import os
import shutil
import struct
import tarfile
import warnings
import zipfile
from abc import ABC, abstractmethod
from pathlib import Path
from typing import Dict, List, Optional, Type, Union

from .. import config
from .filelock import FileLock
from .logging import get_logger


__lowerCAmelCase			:     Any           =   get_logger(__name__)




class        UpperCAmelCase_			:


  '''simple docstring'''







  def __init__( self			: List[Any]			,							UpperCamelCase__			: Optional[str] = None    )			->	Optional[Any]:







    """simple docstring"""






    __magic_name__				     =       (
        os.path.join(UpperCamelCase__			,							config.EXTRACTED_DATASETS_DIR    ) if cache_dir else config.EXTRACTED_DATASETS_PATH
    )
    __magic_name__				     =       Extractor
  def 							_lowercase							( self			: Optional[Any]			,							UpperCamelCase__			: str    )			->	str:







    """simple docstring"""






    from .file_utils import hash_url_to_filename

    # Path where we extract compressed archives
    # We extract in the cache dir, and get the extracted path name by hashing the original path"
    __magic_name__				     =       os.path.abspath(UpperCamelCase__    )
    return os.path.join(self.extract_dir			,							hash_url_to_filename(UpperCamelCase__    )    )
  def 							_lowercase							( self			: List[Any]			,							UpperCamelCase__			: str			,							UpperCamelCase__			: bool    )			->	bool:







    """simple docstring"""






    return force_extract or (
        not os.path.isfile(UpperCamelCase__    ) and not (os.path.isdir(UpperCamelCase__    ) and os.listdir(UpperCamelCase__    ))
    )





  def 							_lowercase							( self			: Dict			,							UpperCamelCase__			: str			,							UpperCamelCase__			: bool = False    )			->	str:







    """simple docstring"""






    __magic_name__				     =       self.extractor.infer_extractor_format(UpperCamelCase__    )
    if not extractor_format:
      return input_path
    __magic_name__				     =       self._get_output_path(UpperCamelCase__    )
    if self._do_extract(UpperCamelCase__			,							UpperCamelCase__    ):
      self.extractor.extract(UpperCamelCase__			,							UpperCamelCase__			,							UpperCamelCase__    )
    return output_path







class        UpperCAmelCase_			( _A     ):


  '''simple docstring'''







  @classmethod
  @abstractmethod
  def 							_lowercase							( cls			: List[str]			,							UpperCamelCase__			: Union[Path, str]			,							**UpperCamelCase__			: Union[str, Any]    )			->	bool:







    """simple docstring"""






    ...





  @staticmethod
  @abstractmethod
  def 							_lowercase							( UpperCamelCase__			: Union[Path, str]			,							UpperCamelCase__			: Union[Path, str]    )			->	None:







    """simple docstring"""






    ...







class        UpperCAmelCase_			( _A  ,       _A     ):


  '''simple docstring'''







  a__           =		[]
  @staticmethod
  def 							_lowercase							( UpperCamelCase__			: Union[Path, str]			,							UpperCamelCase__			: int    )			->	List[str]:







    """simple docstring"""






    with open(UpperCamelCase__			,							"""rb"""    ) as f:
      return f.read(UpperCamelCase__    )





  @classmethod
  def 							_lowercase							( cls			: List[Any]			,							UpperCamelCase__			: Union[Path, str]			,							UpperCamelCase__			: bytes = b""    )			->	bool:







    """simple docstring"""






    if not magic_number:
      __magic_name__				     =       max(len(UpperCamelCase__    ) for cls_magic_number in cls.magic_numbers    )
      try:
        __magic_name__				     =       cls.read_magic_number(UpperCamelCase__			,							UpperCamelCase__    )
      except OSError:
        return False
    return any(magic_number.startswith(UpperCamelCase__    ) for cls_magic_number in cls.magic_numbers    )







class        UpperCAmelCase_			( _A     ):


  '''simple docstring'''







  @classmethod
  def 							_lowercase							( cls			: Optional[Any]			,							UpperCamelCase__			: Union[Path, str]			,							**UpperCamelCase__			: int    )			->	bool:







    """simple docstring"""






    return tarfile.is_tarfile(UpperCamelCase__    )
  @staticmethod
  def 							_lowercase							( UpperCamelCase__			: Optional[Any]			,							UpperCamelCase__			: Optional[int]    )			->	Union[str, Any]:







    """simple docstring"""






    def resolved(UpperCamelCase__			: str    ) -> str:
      return os.path.realpath(os.path.abspath(UpperCamelCase__    )    )

    def badpath(UpperCamelCase__			: str			,							UpperCamelCase__			: str    ) -> bool:
      # joinpath will ignore base if path is absolute
      return not resolved(os.path.join(UpperCamelCase__			,							UpperCamelCase__    )    ).startswith(UpperCamelCase__    )

    def badlink(UpperCamelCase__			: Optional[int]			,							UpperCamelCase__			: str    ) -> bool:
      # Links are interpreted relative to the directory containing the link
      __magic_name__				     =       resolved(os.path.join(UpperCamelCase__			,							os.path.dirname(info.name    )    )    )
      return badpath(info.linkname			,							base=UpperCamelCase__    )

    __magic_name__				     =       resolved(UpperCamelCase__    )

    for finfo in members:
      if badpath(finfo.name			,							UpperCamelCase__    ):
        logger.error(F'''Extraction of {finfo.name} is blocked (illegal path)'''    )
      elif finfo.issym() and badlink(UpperCamelCase__			,							UpperCamelCase__    ):
        logger.error(F'''Extraction of {finfo.name} is blocked: Symlink to {finfo.linkname}'''    )
      elif finfo.islnk() and badlink(UpperCamelCase__			,							UpperCamelCase__    ):
        logger.error(F'''Extraction of {finfo.name} is blocked: Hard link to {finfo.linkname}'''    )
      else:
        yield finfo





  @staticmethod
  def 							_lowercase							( UpperCamelCase__			: Union[Path, str]			,							UpperCamelCase__			: Union[Path, str]    )			->	None:







    """simple docstring"""






    os.makedirs(UpperCamelCase__			,							exist_ok=UpperCamelCase__    )
    __magic_name__				     =       tarfile.open(UpperCamelCase__    )
    tar_file.extractall(UpperCamelCase__			,							members=TarExtractor.safemembers(UpperCamelCase__			,							UpperCamelCase__    )    )
    tar_file.close()







class        UpperCAmelCase_			( _A     ):


  '''simple docstring'''







  a__           =		[B"""\x1F\x8B"""]
  @staticmethod
  def 							_lowercase							( UpperCamelCase__			: Union[Path, str]			,							UpperCamelCase__			: Union[Path, str]    )			->	None:







    """simple docstring"""






    with gzip.open(UpperCamelCase__			,							"""rb"""    ) as gzip_file:
      with open(UpperCamelCase__			,							"""wb"""    ) as extracted_file:
        shutil.copyfileobj(UpperCamelCase__			,							UpperCamelCase__    )







class        UpperCAmelCase_			( _A     ):


  '''simple docstring'''







  a__           =		[
      B"""PK\x03\x04""",
      B"""PK\x05\x06""",  # empty archive
      B"""PK\x07\x08""",  # spanned archive
  ]
  @classmethod
  def 							_lowercase							( cls			: Union[str, Any]			,							UpperCamelCase__			: Union[Path, str]			,							UpperCamelCase__			: bytes = b""    )			->	bool:







    """simple docstring"""






    if super().is_extractable(UpperCamelCase__			,							magic_number=UpperCamelCase__    ):
      return True
    try:
      # Alternative version of zipfile.is_zipfile that has less false positives, but misses executable zip archives.
      # From: https://github.com/python/cpython/pull/5053
      from zipfile import (
          _CD_SIGNATURE,
          _ECD_DISK_NUMBER,
          _ECD_DISK_START,
          _ECD_ENTRIES_TOTAL,
          _ECD_OFFSET,
          _ECD_SIZE,
          _EndRecData,
          sizeCentralDir,
          stringCentralDir,
          structCentralDir,
      )

      with open(UpperCamelCase__			,							"""rb"""    ) as fp:
        __magic_name__				     =       _EndRecData(UpperCamelCase__    )
        if endrec:
          if endrec[_ECD_ENTRIES_TOTAL] == 0 and endrec[_ECD_SIZE] == 0 and endrec[_ECD_OFFSET] == 0:
            return True  # Empty zipfiles are still zipfiles
          elif endrec[_ECD_DISK_NUMBER] == endrec[_ECD_DISK_START]:
            fp.seek(endrec[_ECD_OFFSET]    )  # Central directory is on the same disk
            if fp.tell() == endrec[_ECD_OFFSET] and endrec[_ECD_SIZE] >= sizeCentralDir:
              __magic_name__				     =       fp.read(UpperCamelCase__    )  # CD is where we expect it to be
              if len(UpperCamelCase__    ) == sizeCentralDir:
                __magic_name__				     =       struct.unpack(UpperCamelCase__			,							UpperCamelCase__    )  # CD is the right size
                if centdir[_CD_SIGNATURE] == stringCentralDir:
                  return True  # First central directory entry  has correct magic number
      return False
    except Exception:  # catch all errors in case future python versions change the zipfile internals
      return False





  @staticmethod
  def 							_lowercase							( UpperCamelCase__			: Union[Path, str]			,							UpperCamelCase__			: Union[Path, str]    )			->	None:







    """simple docstring"""






    os.makedirs(UpperCamelCase__			,							exist_ok=UpperCamelCase__    )
    with zipfile.ZipFile(UpperCamelCase__			,							"""r"""    ) as zip_file:
      zip_file.extractall(UpperCamelCase__    )
      zip_file.close()







class        UpperCAmelCase_			( _A     ):


  '''simple docstring'''







  a__           =		[B"""\xFD\x37\x7A\x58\x5A\x00"""]
  @staticmethod
  def 							_lowercase							( UpperCamelCase__			: Union[Path, str]			,							UpperCamelCase__			: Union[Path, str]    )			->	None:







    """simple docstring"""






    with lzma.open(UpperCamelCase__    ) as compressed_file:
      with open(UpperCamelCase__			,							"""wb"""    ) as extracted_file:
        shutil.copyfileobj(UpperCamelCase__			,							UpperCamelCase__    )







class        UpperCAmelCase_			( _A     ):


  '''simple docstring'''







  a__           =		[B"""Rar!\x1a\x07\x00""", B"""Rar!\x1a\x07\x01\x00"""]  # RAR_ID  # RAR5_ID
  @staticmethod
  def 							_lowercase							( UpperCamelCase__			: Union[Path, str]			,							UpperCamelCase__			: Union[Path, str]    )			->	None:







    """simple docstring"""






    if not config.RARFILE_AVAILABLE:
      raise ImportError("""Please pip install rarfile"""    )
    import rarfile

    os.makedirs(UpperCamelCase__			,							exist_ok=UpperCamelCase__    )
    __magic_name__				     =       rarfile.RarFile(UpperCamelCase__    )
    rf.extractall(UpperCamelCase__    )
    rf.close()







class        UpperCAmelCase_			( _A     ):


  '''simple docstring'''







  a__           =		[B"""\x28\xb5\x2F\xFD"""]
  @staticmethod
  def 							_lowercase							( UpperCamelCase__			: Union[Path, str]			,							UpperCamelCase__			: Union[Path, str]    )			->	None:







    """simple docstring"""






    if not config.ZSTANDARD_AVAILABLE:
      raise ImportError("""Please pip install zstandard"""    )
    import zstandard as zstd

    __magic_name__				     =       zstd.ZstdDecompressor()
    with open(UpperCamelCase__			,							"""rb"""    ) as ifh, open(UpperCamelCase__			,							"""wb"""    ) as ofh:
      dctx.copy_stream(UpperCamelCase__			,							UpperCamelCase__    )







class        UpperCAmelCase_			( _A     ):


  '''simple docstring'''







  a__           =		[B"""\x42\x5A\x68"""]
  @staticmethod
  def 							_lowercase							( UpperCamelCase__			: Union[Path, str]			,							UpperCamelCase__			: Union[Path, str]    )			->	None:







    """simple docstring"""






    with bza.open(UpperCamelCase__			,							"""rb"""    ) as compressed_file:
      with open(UpperCamelCase__			,							"""wb"""    ) as extracted_file:
        shutil.copyfileobj(UpperCamelCase__			,							UpperCamelCase__    )







class        UpperCAmelCase_			( _A     ):


  '''simple docstring'''







  a__           =		[B"""\x37\x7A\xBC\xAF\x27\x1C"""]
  @staticmethod
  def 							_lowercase							( UpperCamelCase__			: Union[Path, str]			,							UpperCamelCase__			: Union[Path, str]    )			->	None:







    """simple docstring"""






    if not config.PY7ZR_AVAILABLE:
      raise ImportError("""Please pip install py7zr"""    )
    import pyazr

    os.makedirs(UpperCamelCase__			,							exist_ok=UpperCamelCase__    )
    with pyazr.SevenZipFile(UpperCamelCase__			,							"""r"""    ) as archive:
      archive.extractall(UpperCamelCase__    )







class        UpperCAmelCase_			( _A     ):


  '''simple docstring'''







  a__           =		[B"""\x04\x22\x4D\x18"""]
  @staticmethod
  def 							_lowercase							( UpperCamelCase__			: Union[Path, str]			,							UpperCamelCase__			: Union[Path, str]    )			->	None:







    """simple docstring"""






    if not config.LZ4_AVAILABLE:
      raise ImportError("""Please pip install lz4"""    )
    import lza.frame

    with lza.frame.open(UpperCamelCase__			,							"""rb"""    ) as compressed_file:
      with open(UpperCamelCase__			,							"""wb"""    ) as extracted_file:
        shutil.copyfileobj(UpperCamelCase__			,							UpperCamelCase__    )







class        UpperCAmelCase_			:


  '''simple docstring'''







  a__           =		{
      "tar": TarExtractor,
      "gzip": GzipExtractor,
      "zip": ZipExtractor,
      "xz": XzExtractor,
      "rar": RarExtractor,
      "zstd": ZstdExtractor,
      "bz2": BzipaExtractor,
      "7z": SevenZipExtractor,  # <Added version="2.4.0"/>
      "lz4": LzaExtractor,  # <Added version="2.4.0"/>
  }
  @classmethod
  def 							_lowercase							( cls			: Tuple    )			->	Tuple:







    """simple docstring"""






    return max(
        len(UpperCamelCase__    )
        for extractor in cls.extractors.values()
        if issubclass(UpperCamelCase__			,							UpperCamelCase__    )
        for extractor_magic_number in extractor.magic_numbers    )
  @staticmethod
  def 							_lowercase							( UpperCamelCase__			: Union[Path, str]			,							UpperCamelCase__			: int    )			->	Union[str, Any]:







    """simple docstring"""






    try:
      return MagicNumberBaseExtractor.read_magic_number(UpperCamelCase__			,							magic_number_length=UpperCamelCase__    )
    except OSError:
      return b""
  @classmethod
  def 							_lowercase							( cls			: List[Any]			,							UpperCamelCase__			: Union[Path, str]			,							UpperCamelCase__			: bool = False    )			->	bool:







    """simple docstring"""






    warnings.warn(
        """Method 'is_extractable' was deprecated in version 2.4.0 and will be removed in 3.0.0. """
        """Use 'infer_extractor_format' instead."""			,							category=UpperCamelCase__			,							)
    __magic_name__				     =       cls.infer_extractor_format(UpperCamelCase__    )
    if extractor_format:
      return True if not return_extractor else (True, cls.extractors[extractor_format])
    return False if not return_extractor else (False, None)
  @classmethod
  def 							_lowercase							( cls			: Dict			,							UpperCamelCase__			: Union[Path, str]    )			->	str:  # <Added version="2.4.0"/>







    """simple docstring"""






    __magic_name__				     =       cls._get_magic_number_max_length()
    __magic_name__				     =       cls._read_magic_number(UpperCamelCase__			,							UpperCamelCase__    )
    for extractor_format, extractor in cls.extractors.items():
      if extractor.is_extractable(UpperCamelCase__			,							magic_number=UpperCamelCase__    ):
        return extractor_format





  @classmethod
  def 							_lowercase							( cls			: Union[str, Any]			,							UpperCamelCase__			: Union[Path, str]			,							UpperCamelCase__			: Union[Path, str]			,							UpperCamelCase__			: Optional[str] = None			,							UpperCamelCase__			: Optional[BaseExtractor] = "deprecated"			,							)			->	None:







    """simple docstring"""






    os.makedirs(os.path.dirname(UpperCamelCase__    )			,							exist_ok=UpperCamelCase__    )
    # Prevent parallel extractions
    __magic_name__				     =       str(Path(UpperCamelCase__    ).with_suffix(""".lock"""    )    )
    with FileLock(UpperCamelCase__    ):
      shutil.rmtree(UpperCamelCase__			,							ignore_errors=UpperCamelCase__    )
      if extractor_format or extractor != "deprecated":
        if extractor != "deprecated" or not isinstance(UpperCamelCase__			,							UpperCamelCase__    ):  # passed as positional arg
          warnings.warn(
              """Parameter 'extractor' was deprecated in version 2.4.0 and will be removed in 3.0.0. """
              """Use 'extractor_format' instead."""			,							category=UpperCamelCase__			,							)
          __magic_name__				     =       extractor if extractor != """deprecated""" else extractor_format
        else:
          __magic_name__				     =       cls.extractors[extractor_format]
        return extractor.extract(UpperCamelCase__			,							UpperCamelCase__    )
      else:
        warnings.warn(
            """Parameter 'extractor_format' was made required in version 2.4.0 and not passing it will raise an """
            """exception in 3.0.0."""			,							category=UpperCamelCase__			,							)
        for extractor in cls.extractors.values():
          if extractor.is_extractable(UpperCamelCase__    ):
            return extractor.extract(UpperCamelCase__			,							UpperCamelCase__    )

