
"""simple docstring"""

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


SCREAMING_SNAKE_CASE_            =    get_logger(__name__)
class   _UpperCAmelCase				:




      def __init__(				self ,							lowercase_ = None				)    ->       str:
          UpperCAmelCase          =       (
              os.path.join(lowercase_ ,							config.EXTRACTED_DATASETS_DIR				) if cache_dir else config.EXTRACTED_DATASETS_PATH
          )
          UpperCAmelCase          =       Extractor




      def      a_   (				self ,							lowercase_				)    ->       str:
          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"
          UpperCAmelCase          =       os.path.abspath(lowercase_				)
          return os.path.join(self.extract_dir ,							hash_url_to_filename(lowercase_				)				)




      def      a_   (				self ,							lowercase_ ,							lowercase_				)    ->       bool:
          return force_extract or (
              not os.path.isfile(lowercase_				) and not (os.path.isdir(lowercase_				) and os.listdir(lowercase_				))
          )




      def      a_   (				self ,							lowercase_ ,							lowercase_ = False				)    ->       str:
          UpperCAmelCase          =       self.extractor.infer_extractor_format(lowercase_				)
          if not extractor_format:
              return input_path
          UpperCAmelCase          =       self._get_output_path(lowercase_				)
          if self._do_extract(lowercase_ ,							lowercase_				):
              self.extractor.extract(lowercase_ ,							lowercase_ ,							lowercase_				)
          return output_path

class   _UpperCAmelCase				(		SCREAMING_SNAKE_CASE_				):




      @classmethod
      @abstractmethod
      def      a_   (				cls ,							lowercase_ ,							**lowercase_				)    ->       bool:
          ...




      @staticmethod
      @abstractmethod
      def      a_   (				lowercase_ ,							lowercase_				)    ->       None:
          ...

class   _UpperCAmelCase				(		SCREAMING_SNAKE_CASE_  ,      SCREAMING_SNAKE_CASE_				):
      __SCREAMING_SNAKE_CASE :				List[bytes]				   =						[]




      @staticmethod
      def      a_   (				lowercase_ ,							lowercase_				)    ->       Any:
          with open(lowercase_ ,							'rb'				) as f:
              return f.read(lowercase_				)




      @classmethod
      def      a_   (				cls ,							lowercase_ ,							lowercase_ = b""				)    ->       bool:
          if not magic_number:
              UpperCAmelCase          =       max(len(lowercase_				) for cls_magic_number in cls.magic_numbers				)
              try:
                  UpperCAmelCase          =       cls.read_magic_number(lowercase_ ,							lowercase_				)
              except OSError:
                  return False
          return any(magic_number.startswith(lowercase_				) for cls_magic_number in cls.magic_numbers				)

class   _UpperCAmelCase				(		SCREAMING_SNAKE_CASE_				):




      @classmethod
      def      a_   (				cls ,							lowercase_ ,							**lowercase_				)    ->       bool:
          return tarfile.is_tarfile(lowercase_				)




      @staticmethod
      def      a_   (				lowercase_ ,							lowercase_				)    ->       Optional[Any]:

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

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

          def badlink(lowercase_ ,							lowercase_				) -> bool:
              # Links are interpreted relative to the directory containing the link
              UpperCAmelCase          =       resolved(os.path.join(lowercase_ ,							os.path.dirname(info.name				)				)				)
              return badpath(info.linkname ,							base=lowercase_				)

          UpperCAmelCase          =       resolved(lowercase_				)

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




      @staticmethod
      def      a_   (				lowercase_ ,							lowercase_				)    ->       None:
          os.makedirs(lowercase_ ,							exist_ok=lowercase_				)
          UpperCAmelCase          =       tarfile.open(lowercase_				)
          tar_file.extractall(lowercase_ ,							members=TarExtractor.safemembers(lowercase_ ,							lowercase_				)				)
          tar_file.close()

class   _UpperCAmelCase				(		SCREAMING_SNAKE_CASE_				):
      __SCREAMING_SNAKE_CASE :				Optional[Any]				   =						[B"\x1F\x8B"]




      @staticmethod
      def      a_   (				lowercase_ ,							lowercase_				)    ->       None:
          with gzip.open(lowercase_ ,							'rb'				) as gzip_file:
              with open(lowercase_ ,							'wb'				) as extracted_file:
                  shutil.copyfileobj(lowercase_ ,							lowercase_				)

class   _UpperCAmelCase				(		SCREAMING_SNAKE_CASE_				):
      __SCREAMING_SNAKE_CASE :				int				   =						[
          B"PK\x03\x04",
          B"PK\x05\x06",  # empty archive
          B"PK\x07\x08",  # spanned archive
      ]




      @classmethod
      def      a_   (				cls ,							lowercase_ ,							lowercase_ = b""				)    ->       bool:
          if super().is_extractable(lowercase_ ,							magic_number=lowercase_				):
              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(lowercase_ ,							'rb'				) as fp:
                  UpperCAmelCase          =       _EndRecData(lowercase_				)
                  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:
                              UpperCAmelCase          =       fp.read(lowercase_				)  # CD is where we expect it to be
                              if len(lowercase_				) == sizeCentralDir:
                                  UpperCAmelCase          =       struct.unpack(lowercase_ ,							lowercase_				)  # 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      a_   (				lowercase_ ,							lowercase_				)    ->       None:
          os.makedirs(lowercase_ ,							exist_ok=lowercase_				)
          with zipfile.ZipFile(lowercase_ ,							'r'				) as zip_file:
              zip_file.extractall(lowercase_				)
              zip_file.close()

class   _UpperCAmelCase				(		SCREAMING_SNAKE_CASE_				):
      __SCREAMING_SNAKE_CASE :				List[Any]				   =						[B"\xFD\x37\x7A\x58\x5A\x00"]




      @staticmethod
      def      a_   (				lowercase_ ,							lowercase_				)    ->       None:
          with lzma.open(lowercase_				) as compressed_file:
              with open(lowercase_ ,							'wb'				) as extracted_file:
                  shutil.copyfileobj(lowercase_ ,							lowercase_				)

class   _UpperCAmelCase				(		SCREAMING_SNAKE_CASE_				):
      __SCREAMING_SNAKE_CASE :				Optional[int]				   =						[B"Rar!\x1a\x07\x00", B"Rar!\x1a\x07\x01\x00"]  # RAR_ID  # RAR5_ID




      @staticmethod
      def      a_   (				lowercase_ ,							lowercase_				)    ->       None:
          if not config.RARFILE_AVAILABLE:
              raise ImportError('Please pip install rarfile'				)
          import rarfile

          os.makedirs(lowercase_ ,							exist_ok=lowercase_				)
          UpperCAmelCase          =       rarfile.RarFile(lowercase_				)
          rf.extractall(lowercase_				)
          rf.close()

class   _UpperCAmelCase				(		SCREAMING_SNAKE_CASE_				):
      __SCREAMING_SNAKE_CASE :				Dict				   =						[B"\x28\xb5\x2F\xFD"]




      @staticmethod
      def      a_   (				lowercase_ ,							lowercase_				)    ->       None:
          if not config.ZSTANDARD_AVAILABLE:
              raise ImportError('Please pip install zstandard'				)
          import zstandard as zstd

          UpperCAmelCase          =       zstd.ZstdDecompressor()
          with open(lowercase_ ,							'rb'				) as ifh, open(lowercase_ ,							'wb'				) as ofh:
              dctx.copy_stream(lowercase_ ,							lowercase_				)

class   _UpperCAmelCase				(		SCREAMING_SNAKE_CASE_				):
      __SCREAMING_SNAKE_CASE :				Union[str, Any]				   =						[B"\x42\x5A\x68"]




      @staticmethod
      def      a_   (				lowercase_ ,							lowercase_				)    ->       None:
          with bza.open(lowercase_ ,							'rb'				) as compressed_file:
              with open(lowercase_ ,							'wb'				) as extracted_file:
                  shutil.copyfileobj(lowercase_ ,							lowercase_				)

class   _UpperCAmelCase				(		SCREAMING_SNAKE_CASE_				):
      __SCREAMING_SNAKE_CASE :				Union[str, Any]				   =						[B"\x37\x7A\xBC\xAF\x27\x1C"]




      @staticmethod
      def      a_   (				lowercase_ ,							lowercase_				)    ->       None:
          if not config.PY7ZR_AVAILABLE:
              raise ImportError('Please pip install py7zr'				)
          import pyazr

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

class   _UpperCAmelCase				(		SCREAMING_SNAKE_CASE_				):
      __SCREAMING_SNAKE_CASE :				Optional[Any]				   =						[B"\x04\x22\x4D\x18"]




      @staticmethod
      def      a_   (				lowercase_ ,							lowercase_				)    ->       None:
          if not config.LZ4_AVAILABLE:
              raise ImportError('Please pip install lz4'				)
          import lza.frame

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

class   _UpperCAmelCase				:
      #  Put zip file to the last, b/c it is possible wrongly detected as zip (I guess it means: as tar or gzip)
      __SCREAMING_SNAKE_CASE :				Dict[str, Type[BaseExtractor]]				   =						{
          "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      a_   (				cls				)    ->       Optional[int]:
          return max(
              len(lowercase_				)
              for extractor in cls.extractors.values()
              if issubclass(lowercase_ ,							lowercase_				)
              for extractor_magic_number in extractor.magic_numbers				)




      @staticmethod
      def      a_   (				lowercase_ ,							lowercase_				)    ->       List[str]:
          try:
              return MagicNumberBaseExtractor.read_magic_number(lowercase_ ,							magic_number_length=lowercase_				)
          except OSError:
              return b""




      @classmethod
      def      a_   (				cls ,							lowercase_ ,							lowercase_ = False				)    ->       bool:
          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=lowercase_ ,							)
          UpperCAmelCase          =       cls.infer_extractor_format(lowercase_				)
          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      a_   (				cls ,							lowercase_				)    ->       str:  # <Added version="2.4.0"/>
          UpperCAmelCase          =       cls._get_magic_number_max_length()
          UpperCAmelCase          =       cls._read_magic_number(lowercase_ ,							lowercase_				)
          for extractor_format, extractor in cls.extractors.items():
              if extractor.is_extractable(lowercase_ ,							magic_number=lowercase_				):
                  return extractor_format




      @classmethod
      def      a_   (				cls ,							lowercase_ ,							lowercase_ ,							lowercase_ = None ,							lowercase_ = "deprecated" ,							)    ->       None:
          os.makedirs(os.path.dirname(lowercase_				) ,							exist_ok=lowercase_				)
          # Prevent parallel extractions
          UpperCAmelCase          =       str(Path(lowercase_				).with_suffix('.lock'				)				)
          with FileLock(lowercase_				):
              shutil.rmtree(lowercase_ ,							ignore_errors=lowercase_				)
              if extractor_format or extractor != "deprecated":
                  if extractor != "deprecated" or not isinstance(lowercase_ ,							lowercase_				):  # 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=lowercase_ ,							)
                      UpperCAmelCase          =       extractor if extractor != 'deprecated' else extractor_format
                  else:
                      UpperCAmelCase          =       cls.extractors[extractor_format]
                  return extractor.extract(lowercase_ ,							lowercase_				)
              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=lowercase_ ,							)
                  for extractor in cls.extractors.values():
                      if extractor.is_extractable(lowercase_				):
                          return extractor.extract(lowercase_ ,							lowercase_				)





"""simple docstring"""

from ...configuration_utils import PretrainedConfig
from ...utils import logging


SCREAMING_SNAKE_CASE_            =    logging.get_logger(__name__)

SCREAMING_SNAKE_CASE_            =    {
    '''tiiuae/falcon-40b''': '''https://huggingface.co/tiiuae/falcon-40b/resolve/main/config.json''',
    '''tiiuae/falcon-7b''': '''https://huggingface.co/tiiuae/falcon-7b/resolve/main/config.json''',
}
class   _UpperCAmelCase				(		SCREAMING_SNAKE_CASE_				):
      __SCREAMING_SNAKE_CASE :				Optional[Any]				   =						"falcon"
      __SCREAMING_SNAKE_CASE :				List[Any]				   =						["past_key_values"]




      def __init__(				self ,							lowercase_=6_5_0_2_4 ,							lowercase_=4_5_4_4 ,							lowercase_=3_2 ,							lowercase_=7_1 ,							lowercase_=1E-5 ,							lowercase_=0.0_2 ,							lowercase_=True ,							lowercase_=0.0 ,							lowercase_=0.0 ,							lowercase_=None ,							lowercase_=False ,							lowercase_=False ,							lowercase_=True ,							lowercase_=True ,							lowercase_=False ,							lowercase_=1_1 ,							lowercase_=1_1 ,							**lowercase_ ,							)    ->       Any:
          UpperCAmelCase          =       vocab_size
          # Backward compatibility with n_embed kwarg
          UpperCAmelCase          =       kwargs.pop('n_embed' ,							lowercase_				)
          UpperCAmelCase          =       hidden_size if n_embed is None else n_embed
          UpperCAmelCase          =       num_hidden_layers
          UpperCAmelCase          =       num_attention_heads
          UpperCAmelCase          =       layer_norm_epsilon
          UpperCAmelCase          =       initializer_range
          UpperCAmelCase          =       use_cache
          UpperCAmelCase          =       hidden_dropout
          UpperCAmelCase          =       attention_dropout

          UpperCAmelCase          =       bos_token_id
          UpperCAmelCase          =       eos_token_id
          UpperCAmelCase          =       num_attention_heads if num_kv_heads is None else num_kv_heads
          UpperCAmelCase          =       alibi
          UpperCAmelCase          =       new_decoder_architecture
          UpperCAmelCase          =       multi_query  # Ignored when new_decoder_architecture is True
          UpperCAmelCase          =       parallel_attn
          UpperCAmelCase          =       bias

          super().__init__(bos_token_id=lowercase_ ,							eos_token_id=lowercase_ ,							**lowercase_				)




      @property
      def      a_   (				self				)    ->       List[Any]:
          return self.hidden_size // self.num_attention_heads




      @property
      def      a_   (				self				)    ->       List[str]:
          return not self.alibi



