





import os
import tempfile
from pathlib import Path
from unittest import TestCase

import pyarrow as pa
import pytest

from datasets.arrow_dataset import Dataset
from datasets.arrow_reader import ArrowReader, BaseReader, FileInstructions, ReadInstruction, make_file_instructions
from datasets.info import DatasetInfo
from datasets.splits import NamedSplit, Split, SplitDict, SplitInfo

from .utils import assert_arrow_memory_doesnt_increase, assert_arrow_memory_increases





class 						_A( snake_case__       ):


				"""simple docstring"""


				def  UpperCAmelCase_		(      self					, _A					, _A=False					):
									__A   ,    __A   ,    __A     :						List[str]          =    (
									    filename_skip_take['filename'],
									    filename_skip_take['skip'] if 'skip' in filename_skip_take else None,
									    filename_skip_take['take'] if 'take' in filename_skip_take else None,
									)
									open(os.path.join(_A					)					, 'wb'					).close()
									__A     :						Dict          =    pa.Table.from_pydict({'filename': [Path(_A					).name] * 100}					)
									if take == -1:
														__A     :						Union[str, Any]          =    len(_A					) - skip
									if skip is not None and take is not None:
														__A     :						int          =    pa_table.slice(_A					, _A					)
									return pa_table





class 						_A( snake_case__       ):


				"""simple docstring"""


				def  UpperCAmelCase_		(      self					):
									__A     :						Dict          =    'my_name'
									__A     :						str          =    SplitInfo(name='train'					, num_examples=100					)
									__A     :						List[Any]          =    SplitInfo(name='test'					, num_examples=100					)
									__A     :						Any          =    [train_info, test_info]
									__A     :						Tuple          =    SplitDict()
									split_dict.add(_A					)
									split_dict.add(_A					)
									__A     :						Optional[Any]          =    DatasetInfo(splits=_A					)

									with tempfile.TemporaryDirectory() as tmp_dir:
														__A     :						Optional[Any]          =    ReaderTest(_A					, _A					)

														__A     :						int          =    'test[:33%]'
														__A     :						Optional[int]          =    Dataset(**reader.read(_A					, _A					, _A					)					)
														self.assertEqual(dset['filename'][0]					, F"""{name}-test"""					)
														self.assertEqual(dset.num_rows					, 33					)
														self.assertEqual(dset.num_columns					, 1					)

														__A     :						List[Any]          =    ['train', 'test[:33%]']
														__A     :						List[Any]          =    [Split.TRAIN, ReadInstruction.from_spec('test[:33%]'					)]
														for instructions in [instructionsa, instructionsa]:
																			__A     :						Union[str, Any]          =    [reader.read(_A					, _A					, _A					) for instr in instructions]
																			__A   ,    __A     :						Tuple          =    (Dataset(**_A					) for dataset_kwargs in datasets_kwargs)
																			self.assertEqual(train_dset['filename'][0]					, F"""{name}-train"""					)
																			self.assertEqual(train_dset.num_rows					, 100					)
																			self.assertEqual(train_dset.num_columns					, 1					)
																			self.assertIsInstance(train_dset.split					, _A					)
																			self.assertEqual(str(train_dset.split					)					, 'train'					)
																			self.assertEqual(test_dset['filename'][0]					, F"""{name}-test"""					)
																			self.assertEqual(test_dset.num_rows					, 33					)
																			self.assertEqual(test_dset.num_columns					, 1					)
																			self.assertIsInstance(test_dset.split					, _A					)
																			self.assertEqual(str(test_dset.split					)					, 'test[:33%]'					)
																			del train_dset, test_dset



				def  UpperCAmelCase_		(      self					):
									__A     :						Any          =    'my_name'
									__A     :						List[Any]          =    SplitInfo(name='train'					, num_examples=1000					, shard_lengths=[100] * 10					)
									__A     :						Dict          =    [train_info]
									__A     :						Optional[Any]          =    SplitDict()
									split_dict.add(_A					)
									__A     :						Dict          =    DatasetInfo(splits=_A					)

									with tempfile.TemporaryDirectory() as tmp_dir:
														__A     :						List[Any]          =    ReaderTest(_A					, _A					)

														__A     :						Any          =    'train[:33%]'
														__A     :						int          =    Dataset(**reader.read(_A					, _A					, _A					)					)
														self.assertEqual(dset['filename'][0]					, F"""{name}-train-00000-of-00010"""					)
														self.assertEqual(dset['filename'][-1]					, F"""{name}-train-00003-of-00010"""					)
														self.assertEqual(dset.num_rows					, 330					)
														self.assertEqual(dset.num_columns					, 1					)





				def  UpperCAmelCase_		(      self					):
									__A     :						str          =    SplitInfo(name='train'					, num_examples=100					)
									__A     :						List[str]          =    SplitInfo(name='test'					, num_examples=100					)
									__A     :						Tuple          =    SplitDict()
									split_dict.add(_A					)
									split_dict.add(_A					)
									__A     :						Any          =    DatasetInfo(splits=_A					)

									with tempfile.TemporaryDirectory() as tmp_dir:
														__A     :						Dict          =    ReaderTest(_A					, _A					)

														__A     :						int          =    [
														    {'filename': os.path.join(_A					, 'train'					)},
														    {'filename': os.path.join(_A					, 'test'					), 'skip': 10, 'take': 10},
														]
														__A     :						List[str]          =    Dataset(**reader.read_files(_A					, original_instructions='train+test[10:20]'					)					)
														self.assertEqual(dset.num_rows					, 110					)
														self.assertEqual(dset.num_columns					, 1					)
														del dset







@pytest.mark.parametrize('in_memory' ,						[False, True]  )
def 			_SCREAMING_SNAKE_CASE    (       a ,						a ,						a  )				->				Union[str, Any]:
					__A     :						List[str]          =    arrow_file
					with assert_arrow_memory_increases() if in_memory else assert_arrow_memory_doesnt_increase():
										__A     :						Tuple          =    ArrowReader.read_table(a ,						in_memory=a  )
					assert table.shape == dataset.data.shape
					assert set(table.column_names  ) == set(dataset.data.column_names  )
					assert dict(table.to_pydict()  ) == dict(dataset.data.to_pydict()  )  # to_pydict returns OrderedDict







@pytest.mark.parametrize('in_memory' ,						[False, True]  )
def 			_SCREAMING_SNAKE_CASE    (       a ,						a ,						a  )				->				Dict:
					__A     :						List[str]          =    arrow_file
					__A     :						int          =    ArrowReader('' ,						a  )
					with assert_arrow_memory_increases() if in_memory else assert_arrow_memory_doesnt_increase():
										__A     :						Dict          =    reader.read_files([{'filename': filename}] ,						in_memory=a  )
					assert dataset_kwargs.keys() == {"arrow_table", "info", "split"}
					__A     :						Tuple          =    dataset_kwargs['arrow_table']
					assert table.shape == dataset.data.shape
					assert set(table.column_names  ) == set(dataset.data.column_names  )
					assert dict(table.to_pydict()  ) == dict(dataset.data.to_pydict()  )  # to_pydict returns OrderedDict







def 			_SCREAMING_SNAKE_CASE    (       )				->				Optional[int]:
					assert ReadInstruction('train' ,						to=10 ,						unit='abs'  ).to_spec() == "train[:10]"
					assert ReadInstruction('train' ,						from_=-80 ,						to=10 ,						unit='%'  ).to_spec() == "train[-80%:10%]"

					__A     :						Dict          =    'train+test'
					assert ReadInstruction.from_spec(a  ).to_spec() == spec_train_test

					__A     :						Dict          =    'train[2:10]'
					assert ReadInstruction.from_spec(a  ).to_spec() == spec_train_abs

					__A     :						List[Any]          =    'train[15%:-20%]'
					assert ReadInstruction.from_spec(a  ).to_spec() == spec_train_pct

					__A     :						int          =    'train[:10%](closest)'
					assert ReadInstruction.from_spec(a  ).to_spec() == "train[:10%]"

					__A     :						List[Any]          =    'train[:10%](pct1_dropremainder)'
					assert ReadInstruction.from_spec(a  ).to_spec() == spec_train_pct_rounding

					__A     :						Optional[int]          =    'train[:10%](pct1_dropremainder)+test[-10%:](pct1_dropremainder)'
					assert ReadInstruction.from_spec(a  ).to_spec() == spec_train_test_pct_rounding







def 			_SCREAMING_SNAKE_CASE    (       )				->				Dict:
					__A     :						Dict          =    'dummy'
					__A     :						Any          =    [SplitInfo(name='train' ,						num_examples=1_00  )]
					__A     :						Any          =    'train[:33%]'
					__A     :						List[str]          =    'arrow'
					__A     :						Tuple          =    'prefix'

					__A     :						Any          =    make_file_instructions(a ,						a ,						a ,						a ,						a  )
					assert isinstance(a ,						a  )
					assert file_instructions.num_examples == 33
					assert file_instructions.file_instructions == [
					    {"filename": os.path.join(a ,						F"""{name}-train.arrow"""  ), "skip": 0, "take": 33}
					]

					__A     :						str          =    [SplitInfo(name='train' ,						num_examples=1_00 ,						shard_lengths=[10] * 10  )]
					__A     :						Optional[int]          =    make_file_instructions(a ,						a ,						a ,						a ,						a  )
					assert isinstance(a ,						a  )
					assert file_instructions.num_examples == 33
					assert file_instructions.file_instructions == [
					    {"filename": os.path.join(a ,						F"""{name}-train-00000-of-00010.arrow"""  ), "skip": 0, "take": -1},
					    {"filename": os.path.join(a ,						F"""{name}-train-00001-of-00010.arrow"""  ), "skip": 0, "take": -1},
					    {"filename": os.path.join(a ,						F"""{name}-train-00002-of-00010.arrow"""  ), "skip": 0, "take": -1},
					    {"filename": os.path.join(a ,						F"""{name}-train-00003-of-00010.arrow"""  ), "skip": 0, "take": 3},
					]







@pytest.mark.parametrize('name, expected_exception' ,						[(None, TypeError), ('', ValueError)]  )
def 			_SCREAMING_SNAKE_CASE    (       a ,						a  )				->				int:
					__A     :						List[str]          =    [SplitInfo(name='train' ,						num_examples=1_00  )]
					__A     :						str          =    'train'
					__A     :						Dict          =    'arrow'
					__A     :						List[str]          =    'prefix_path'
					with pytest.raises(a  ):
										__A     :						List[Any]          =    make_file_instructions(a ,						a ,						a ,						a ,						a  )











import logging
from pathlib import Path
from typing import Any, List, Tuple

import yaml


# loading package files: https://stackoverflow.com/a/20885799
try:
				import importlib.resources as pkg_resources
except ImportError:
				# Try backported to PY<37 `importlib_resources`.
				import importlib_resources as pkg_resources

from . import resources


UpperCAmelCase						:       Optional[Any]        =					'''https://github.com/huggingface/datasets/tree/main/src/datasets/utils'''
UpperCAmelCase						:       Any        =					F"""{BASE_REF_URL}/{__file__}"""
UpperCAmelCase						:       int        =					logging.getLogger(__name__)







def 			_SCREAMING_SNAKE_CASE    (       a  )				->				Tuple[Any, str]:
					__A     :						List[Any]          =    pkg_resources.read_text(a ,						a  )
					return yaml.safe_load(a  ), F"""{BASE_REF_URL}/resources/{resource}"""


UpperCAmelCase  ,			UpperCAmelCase						:       Tuple        =					load_yaml_resource('''readme_structure.yaml''')

UpperCAmelCase						:       List[Any]        =					[
    '''[Needs More Information]''',
    '''[More Information Needed]''',
    '''(https://github.com/huggingface/datasets/blob/main/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)''',
]

# Dictionary representation of section/readme, error_list, warning_list
UpperCAmelCase						:       Union[str, Any]        =					Tuple[dict, List[str], List[str]]





class 						_A:


				"""simple docstring"""


				def __init__(      self					, _A					, _A					, _A = None					, _A = False					):
									__A     :						Dict          =    name
									__A     :						str          =    level
									__A     :						List[str]          =    lines
									__A     :						List[Any]          =    ''
									__A     :						Optional[Any]          =    True
									__A     :						List[Any]          =    {}
									__A     :						Optional[Any]          =    []
									__A     :						Optional[int]          =    []
									if self.lines is not None:
														self.parse(suppress_parsing_errors=_A					)



				def  UpperCAmelCase_		(      self					, _A = False					):
									__A     :						Any          =    ''
									__A     :						Union[str, Any]          =    []
									__A     :						Tuple          =    False
									for line in self.lines:
														if line.strip(' \n'					) == "":
																			continue
														elif line.strip(' \n'					)[:3] == "```":
																			__A     :						int          =    not code_start
														elif line.split()[0] == self.level + "#" and not code_start:
																			if current_sub_level != "":
																								__A     :						Dict          =    Section(_A					, self.level + '#'					, _A					)
																								__A     :						Optional[int]          =    []
																			else:
																								if current_lines != []:
																													self.text += "".join(_A					).strip()
																													if self.text != "" and self.text not in FILLER_TEXT:
																																		__A     :						Union[str, Any]          =    False
																													__A     :						Dict          =    []

																			__A     :						Optional[Any]          =    ' '.join(line.split()[1:]					).strip(' \n'					)
														else:
																			current_lines.append(_A					)
									else:
														if current_sub_level != "":
																			if current_sub_level in self.content:
																								self.parsing_error_list.append(
																								    F"""Multiple sections with the same heading `{current_sub_level}` have been found. Please keep only one of these sections."""					)
																			__A     :						Any          =    Section(_A					, self.level + '#'					, _A					)
														else:
																			if current_lines != []:
																								self.text += "".join(_A					).strip()
																								if self.text != "" and self.text not in FILLER_TEXT:
																													__A     :						str          =    False

									if self.level == "" and not suppress_parsing_errors:
														if self.parsing_error_list != [] or self.parsing_warning_list != []:
																			__A     :						Optional[int]          =    '\n'.join('-\t' + x for x in self.parsing_error_list + self.parsing_warning_list					)
																			__A     :						List[Any]          =    F"""The following issues were found while parsing the README at `{self.name}`:\n""" + errors
																			raise ValueError(_A					)



				def  UpperCAmelCase_		(      self					, _A					):
									__A     :						Any          =    []
									__A     :						Tuple          =    []
									if structure["allow_empty"] is False:
														# If content is expected
														if self.is_empty_text and self.content == {}:
																			# If no content is found, mention it in the error_list
																			error_list.append(F"""Expected some content in section `{self.name}` but it is empty."""					)

									if structure["allow_empty_text"] is False:
														# If some text is expected
														if self.is_empty_text:
																			# If no text is found, mention it in the error_list
																			error_list.append(
																			    F"""Expected some text in section `{self.name}` but it is empty (text in subsections are ignored)."""					)
        # Subsections Validation
									if structure["subsections"] is not None:
														# If subsections are expected
														if self.content == {}:
																			# If no subsections are present
																			__A     :						int          =    [subsection['name'] for subsection in structure['subsections']]
																			# Mention the expected values in the error_list
																			error_list.append(
																			    F"""Section `{self.name}` expected the following subsections: {", ".join(["`"+x+"`" for x in values]					)}. Found 'None'."""					)
														else:
																			# If some subsections are present
																			__A     :						Optional[Any]          =    [subsection['name'] for subsection in structure['subsections']]
																			__A     :						str          =    False
																			for idx, name in enumerate(_A					):
																								if name not in self.content:
																													# If the expected subsection is not present
																													error_list.append(F"""Section `{self.name}` is missing subsection: `{name}`."""					)
																													__A     :						Optional[Any]          =    True
																								else:
																													# If the subsection is present, validate subsection, return the result
																													# and concat the errors from subsection to section error_list

																													# Skip sublevel validation if current level is `###`
																													if self.level == "###":
																																		continue
																													else:
																																		__A   ,    __A   ,    __A     :						Optional[int]          =    self.content[name].validate(
																																		    structure['subsections'][idx]					)
																													error_list += subsec_error_list
																													warning_list += subsec_warning_list

																			if has_missing_subsections:  # we only allow to have extra subsections if all the other ones are here
																								for name in self.content:
																													if name not in structure_names:
																																		# If an extra subsection is present
																																		warning_list.append(
																																		    F"""`{self.name}` has an extra subsection: `{name}`. Skipping further validation checks for this subsection as expected structure is unknown."""					)
									if error_list:
														# If there are errors, do not return the dictionary as it is invalid
														return {}, error_list, warning_list
									else:
														return self.to_dict(), error_list, warning_list





				def  UpperCAmelCase_		(      self					):
									return {
									    "name": self.name,
									    "text": self.text,
									    "is_empty_text": self.is_empty_text,
									    "subsections": [value.to_dict() for value in self.content.values()],
									}





class 						_A( snake_case__       ):  # Level 0


				"""simple docstring"""


				def __init__(      self					, _A					, _A					, _A = None					, _A = False					):
									super().__init__(name=_A					, level=''					)  # Not using lines here as we need to use a child class parse
									__A     :						List[str]          =    structure
									__A     :						str          =    -2
									__A     :						Tuple          =    0
									__A     :						Dict          =    lines
									if self.lines is not None:
														self.parse(suppress_parsing_errors=_A					)



				def  UpperCAmelCase_		(      self					):
									if self.structure is None:
														__A   ,    __A   ,    __A     :						List[Any]          =    self._validate(_A					)
									else:
														__A   ,    __A   ,    __A     :						Any          =    self._validate(self.structure					)
									if error_list != [] or warning_list != []:
														__A     :						Optional[Any]          =    '\n'.join(['-\t' + x for x in error_list + warning_list]					)
														__A     :						Union[str, Any]          =    F"""The following issues were found for the README at `{self.name}`:\n""" + errors
														raise ValueError(_A					)



				@classmethod
				def  UpperCAmelCase_		(      cls					, _A					, _A = None					, _A = False					):
									with open(_A					, encoding='utf-8'					) as f:
														__A     :						str          =    f.readlines()
									return cls(_A					, _A					, _A					, suppress_parsing_errors=_A					)



				@classmethod
				def  UpperCAmelCase_		(      cls					, _A					, _A = None					, _A = "root"					, _A = False					):
									__A     :						Any          =    string.split('\n'					)
									return cls(_A					, _A					, _A					, suppress_parsing_errors=_A					)



				def  UpperCAmelCase_		(      self					, _A = False					):
									# Skip Tags
									__A     :						Any          =    0

									for line in self.lines:
														self.yaml_tags_line_count += 1
														if line.strip(' \n'					) == "---":
																			self.tag_count += 1
																			if self.tag_count == 2:
																								break
														line_count += 1
									if self.tag_count == 2:
														__A     :						List[str]          =    self.lines[line_count + 1 :]  # Get the last + 1 th item.
									else:
														__A     :						List[Any]          =    self.lines[self.tag_count :]
									super().parse(suppress_parsing_errors=_A					)



				def __str__(      self					):
									return str(self.to_dict()					)





				def  UpperCAmelCase_		(      self					, _A					):
									__A     :						List[str]          =    []
									__A     :						List[Any]          =    []
									if self.yaml_tags_line_count == 0:
														warning_list.append('Empty YAML markers are present in the README.'					)
									elif self.tag_count == 0:
														warning_list.append('No YAML markers are present in the README.'					)
									elif self.tag_count == 1:
														warning_list.append('Only the start of YAML tags present in the README.'					)
									# Check how many first level sections are present.
									__A     :						Optional[int]          =    len(self.content.keys()					)
									if num_first_level_keys > 1:
														# If more than one, add to the error list, continue
														error_list.append(
														    F"""The README has several first-level headings: {", ".join(["`"+x+"`" for x in list(self.content.keys()					)]					)}. Only one heading is expected. Skipping further validation for this README."""					)
									elif num_first_level_keys < 1:
														# If less than one, append error.
														error_list.append(
														    'The README has no first-level headings. One heading is expected. Skipping further validation for this README.'					)

									else:
														# If one exactly
														__A     :						List[Any]          =    list(self.content.keys()					)[0]  # Get the key
														if start_key.startswith('Dataset Card for'					):  # Check correct start
																			# If the starting is correct, validate all the sections
																			__A   ,    __A   ,    __A     :						List[str]          =    self.content[start_key].validate(
																			    readme_structure['subsections'][0]					)
																			error_list += sec_error_list
																			warning_list += sec_warning_list
														else:
																			# If not found, append error
																			error_list.append(
																			    'No first-level heading starting with `Dataset Card for` found in README. Skipping further validation for this README.'					)
									if error_list:
														# If there are errors, do not return the dictionary as it is invalid
														return {}, error_list, warning_list
									else:
														return self.to_dict(), error_list, warning_list


if __name__ == "__main__":
				from argparse import ArgumentParser

				UpperCAmelCase						:       Dict        =					ArgumentParser(usage='''Validate the content (excluding YAML tags) of a README.md file.''')
				ap.add_argument('''readme_filepath''')
				UpperCAmelCase						:       Tuple        =					ap.parse_args()
				UpperCAmelCase						:       List[str]        =					Path(args.readme_filepath)
				UpperCAmelCase						:       int        =					ReadMe.from_readme(readme_filepath)




