'''simple docstring'''

import re
import tempfile
from pathlib import Path

import pytest
import yaml

from datasets.utils.readme import ReadMe


# @pytest.fixture
# def example_yaml_structure():

UpperCamelCase__     :	Dict				=			yaml.safe_load(
    '\\nname: ""\nallow_empty: false\nallow_empty_text: true\nsubsections:\n  - name: "Dataset Card for X" # First-level markdown heading\n    allow_empty: false\n    allow_empty_text: true\n    subsections:\n      - name: "Table of Contents"\n        allow_empty: false\n        allow_empty_text: false\n        subsections: null\n      - name: "Dataset Description"\n        allow_empty: false\n        allow_empty_text: false\n        subsections:\n          - name: "Dataset Summary"\n            allow_empty: false\n            allow_empty_text: false\n            subsections: null\n          - name: "Supported Tasks and Leaderboards"\n            allow_empty: true\n            allow_empty_text: true\n            subsections: null\n          - name: Languages\n            allow_empty: false\n            allow_empty_text: true\n            subsections: null\n'
)


UpperCamelCase__     :	List[str]				=			{
    'name': 'root',
    'text': '',
    'is_empty_text': True,
    'subsections': [
        {
            'name': 'Dataset Card for My Dataset',
            'text': '',
            'is_empty_text': True,
            'subsections': [
                {'name': 'Table of Contents', 'text': 'Some text here.', 'is_empty_text': False, 'subsections': []},
                {
                    'name': 'Dataset Description',
                    'text': 'Some text here.',
                    'is_empty_text': False,
                    'subsections': [
                        {
                            'name': 'Dataset Summary',
                            'text': 'Some text here.',
                            'is_empty_text': False,
                            'subsections': [],
                        },
                        {
                            'name': 'Supported Tasks and Leaderboards',
                            'text': '',
                            'is_empty_text': True,
                            'subsections': [],
                        },
                        {'name': 'Languages', 'text': 'Language Text', 'is_empty_text': False, 'subsections': []},
                    ],
                },
            ],
        }
    ],
}


UpperCamelCase__     :	List[Any]				=			'\\n---\nlanguage:\n- zh\n- en\n---\n\n# Dataset Card for My Dataset\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\nSome text here.\n### Supported Tasks and Leaderboards\n### Languages\nLanguage Text\n'


UpperCamelCase__     :	int				=			'\\n---\nlanguage:\n- zh\n- en\n---\n\n# Dataset Card for My Dataset\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\nSome text here.\n#### Extra Ignored Subsection\n### Supported Tasks and Leaderboards\n### Languages\nLanguage Text\n'

UpperCamelCase__     :	List[str]				=			{
    'name': 'root',
    'text': '',
    'is_empty_text': True,
    'subsections': [
        {
            'name': 'Dataset Card for My Dataset',
            'text': '',
            'is_empty_text': True,
            'subsections': [
                {'name': 'Table of Contents', 'text': 'Some text here.', 'is_empty_text': False, 'subsections': []},
                {
                    'name': 'Dataset Description',
                    'text': 'Some text here.',
                    'is_empty_text': False,
                    'subsections': [
                        {
                            'name': 'Dataset Summary',
                            'text': 'Some text here.',
                            'is_empty_text': False,
                            'subsections': [
                                {
                                    'name': 'Extra Ignored Subsection',
                                    'text': '',
                                    'is_empty_text': True,
                                    'subsections': [],
                                }
                            ],
                        },
                        {
                            'name': 'Supported Tasks and Leaderboards',
                            'text': '',
                            'is_empty_text': True,
                            'subsections': [],
                        },
                        {'name': 'Languages', 'text': 'Language Text', 'is_empty_text': False, 'subsections': []},
                    ],
                },
            ],
        }
    ],
}

UpperCamelCase__     :	Any				=			'\\n---\n---\n# Dataset Card for My Dataset\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\nSome text here.\n### Supported Tasks and Leaderboards\n### Languages\nLanguage Text\n'

UpperCamelCase__     :	Any				=			(
    'The following issues were found for the README at `{path}`:\n-\tEmpty YAML markers are present in the README.'
)

UpperCamelCase__     :	Union[str, Any]				=			'\\n# Dataset Card for My Dataset\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\nSome text here.\n### Supported Tasks and Leaderboards\n### Languages\nLanguage Text\n'

UpperCamelCase__     :	List[Any]				=			(
    'The following issues were found for the README at `{path}`:\n-\tNo YAML markers are present in the README.'
)

UpperCamelCase__     :	str				=			'\\n---\n# Dataset Card for My Dataset\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\nSome text here.\n### Supported Tasks and Leaderboards\n### Languages\nLanguage Text\n'

UpperCamelCase__     :	List[str]				=			'The following issues were found for the README at `{path}`:\n-\tOnly the start of YAML tags present in the README.'

UpperCamelCase__     :	int				=			'\\n---\nlanguage:\n- zh\n- en\n---\n\n# Dataset Card for My Dataset\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\n### Supported Tasks and Leaderboards\n### Languages\nLanguage Text\n'
UpperCamelCase__     :	Tuple				=			'The following issues were found for the README at `{path}`:\n-\tExpected some content in section `Dataset Summary` but it is empty.\n-\tExpected some text in section `Dataset Summary` but it is empty (text in subsections are ignored).'


UpperCamelCase__     :	int				=			'\\n---\nlanguage:\n- zh\n- en\n---\n\n# Dataset Card for My Dataset\n'
UpperCamelCase__     :	List[Any]				=			'The following issues were found for the README at `{path}`:\n-\tExpected some content in section `Dataset Card for My Dataset` but it is empty.\n-\tSection `Dataset Card for My Dataset` expected the following subsections: `Table of Contents`, `Dataset Description`. Found \'None\'.'

UpperCamelCase__     :	List[Any]				=			'\\n---\nlanguage:\n- zh\n- en\n---\n\n# Dataset Card for My Dataset\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\nSome text here.\n### Languages\nLanguage Text\n'

UpperCamelCase__     :	Union[str, Any]				=			'The following issues were found for the README at `{path}`:\n-\tSection `Dataset Description` is missing subsection: `Supported Tasks and Leaderboards`.'


UpperCamelCase__     :	Optional[int]				=			'\\n---\nlanguage:\n- zh\n- en\n---\n\n# Dataset Card for My Dataset\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\nSome text here.\n### Supported Tasks and Leaderboards\n### Languages\n'

UpperCamelCase__     :	int				=			'The following issues were found for the README at `{path}`:\n-\tExpected some content in section `Languages` but it is empty.'

UpperCamelCase__     :	int				=			'\\n---\nlanguage:\n- zh\n- en\n---\n\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\nSome text here.\n### Supported Tasks and Leaderboards\n### Languages\nLanguage Text\n'
UpperCamelCase__     :	List[Any]				=			'The following issues were found for the README at `{path}`:\n-\tThe README has no first-level headings. One heading is expected. Skipping further validation for this README.'

UpperCamelCase__     :	Optional[int]				=			'\\n---\nlanguage:\n- zh\n- en\n---\n\n# Dataset Card for My Dataset\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\nSome text here.\n### Supported Tasks and Leaderboards\n### Languages\nLanguage Text\n# Dataset Card My Dataset\n'

UpperCamelCase__     :	Dict				=			'The following issues were found for the README at `{path}`:\n-\tThe README has several first-level headings: `Dataset Card for My Dataset`, `Dataset Card My Dataset`. Only one heading is expected. Skipping further validation for this README.'

UpperCamelCase__     :	Optional[int]				=			'\\n---\nlanguage:\n- zh\n- en\n---\n\n# Dataset Card My Dataset\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\nSome text here.\n### Supported Tasks and Leaderboards\n### Languages\nLanguage Text\n'

UpperCamelCase__     :	Optional[Any]				=			'The following issues were found for the README at `{path}`:\n-\tNo first-level heading starting with `Dataset Card for` found in README. Skipping further validation for this README.'

UpperCamelCase__     :	Any				=			''

UpperCamelCase__     :	List[Any]				=			'The following issues were found for the README at `{path}`:\n-\tThe README has no first-level headings. One heading is expected. Skipping further validation for this README.\n-\tNo YAML markers are present in the README.'

UpperCamelCase__     :	Dict				=			'\\n---\nlanguage:\n- zh\n- en\n---\n\n# Dataset Card for My Dataset\n# Dataset Card for My Dataset\n## Table of Contents\nSome text here.\n## Dataset Description\nSome text here.\n### Dataset Summary\nSome text here.\n### Supported Tasks and Leaderboards\n### Languages\nLanguage Text\n'

UpperCamelCase__     :	Optional[int]				=			'The following issues were found while parsing the README at `{path}`:\n-\tMultiple sections with the same heading `Dataset Card for My Dataset` have been found. Please keep only one of these sections.'







@pytest.mark.parametrize(
    '''readme_md, expected_dict'''  ,			[
        (README_CORRECT, CORRECT_DICT),
        (README_CORRECT_FOUR_LEVEL, CORRECT_DICT_FOUR_LEVEL),
    ]  ,			)
def __UpperCamelCase(   _A					:				List[str]  ,			_A					:				int    ):
   '''simple docstring'''
   assert ReadMe.from_string(_A  ,			_A    ).to_dict() == expected_dict







@pytest.mark.parametrize(
    '''readme_md, expected_error'''  ,			[
        (README_NO_YAML, EXPECTED_ERROR_README_NO_YAML),
        (README_EMPTY_YAML, EXPECTED_ERROR_README_EMPTY_YAML),
        (README_INCORRECT_YAML, EXPECTED_ERROR_README_INCORRECT_YAML),
        (README_EMPTY, EXPECTED_ERROR_README_EMPTY),
        (README_NONE_SUBSECTION, EXPECTED_ERROR_README_NONE_SUBSECTION),
        (README_MISSING_FIRST_LEVEL, EXPECTED_ERROR_README_MISSING_FIRST_LEVEL),
        (README_MISSING_SUBSECTION, EXPECTED_ERROR_README_MISSING_SUBSECTION),
        (README_MISSING_TEXT, EXPECTED_ERROR_README_MISSING_TEXT),
        (README_WRONG_FIRST_LEVEL, EXPECTED_ERROR_README_WRONG_FIRST_LEVEL),
        (README_MULTIPLE_WRONG_FIRST_LEVEL, EXPECTED_ERROR_README_MULTIPLE_WRONG_FIRST_LEVEL),
        (README_MISSING_CONTENT, EXPECTED_ERROR_README_MISSING_CONTENT),
    ]  ,			)
def __UpperCamelCase(   _A					:				List[Any]  ,			_A					:				Any    ):
   '''simple docstring'''
   with pytest.raises(_A  ,			match=re.escape(expected_error.format(path='''root'''    )    )    ):
      UpperCAmelCase__							:				Any   				=  ReadMe.from_string(_A  ,			_A    )
      readme.validate()







@pytest.mark.parametrize(
    '''readme_md, expected_error'''  ,			[
        (README_MULTIPLE_SAME_HEADING_1, EXPECTED_ERROR_README_MULTIPLE_SAME_HEADING_1),
    ]  ,			)
def __UpperCamelCase(   _A					:				Any  ,			_A					:				int    ):
   '''simple docstring'''
   with pytest.raises(_A  ,			match=re.escape(expected_error.format(path='''root'''    )    )    ):
      ReadMe.from_string(_A  ,			_A    )







@pytest.mark.parametrize(
    '''readme_md,'''  ,			[
        (README_MULTIPLE_SAME_HEADING_1),
    ]  ,			)
def __UpperCamelCase(   _A					:				List[Any]    ):
   '''simple docstring'''
   ReadMe.from_string(_A  ,			_A  ,			suppress_parsing_errors=_A    )







@pytest.mark.parametrize(
    '''readme_md, expected_dict'''  ,			[
        (README_CORRECT, CORRECT_DICT),
        (README_CORRECT_FOUR_LEVEL, CORRECT_DICT_FOUR_LEVEL),
    ]  ,			)
def __UpperCamelCase(   _A					:				int  ,			_A					:				str    ):
   '''simple docstring'''
   with tempfile.TemporaryDirectory() as tmp_dir:
      UpperCAmelCase__							:				List[Any]   				=  Path(_A    ) / '''README.md'''
      with open(_A  ,			'''w+'''    ) as readme_file:
         readme_file.write(_A    )
      UpperCAmelCase__							:				List[str]   				=  ReadMe.from_readme(_A  ,			_A    ).to_dict()
      assert out["name"] == path
      assert out["text"] == ""
      assert out["is_empty_text"]
      assert out["subsections"] == expected_dict["subsections"]







@pytest.mark.parametrize(
    '''readme_md, expected_error'''  ,			[
        (README_NO_YAML, EXPECTED_ERROR_README_NO_YAML),
        (README_EMPTY_YAML, EXPECTED_ERROR_README_EMPTY_YAML),
        (README_INCORRECT_YAML, EXPECTED_ERROR_README_INCORRECT_YAML),
        (README_EMPTY, EXPECTED_ERROR_README_EMPTY),
        (README_NONE_SUBSECTION, EXPECTED_ERROR_README_NONE_SUBSECTION),
        (README_MISSING_FIRST_LEVEL, EXPECTED_ERROR_README_MISSING_FIRST_LEVEL),
        (README_MISSING_SUBSECTION, EXPECTED_ERROR_README_MISSING_SUBSECTION),
        (README_MISSING_TEXT, EXPECTED_ERROR_README_MISSING_TEXT),
        (README_WRONG_FIRST_LEVEL, EXPECTED_ERROR_README_WRONG_FIRST_LEVEL),
        (README_MULTIPLE_WRONG_FIRST_LEVEL, EXPECTED_ERROR_README_MULTIPLE_WRONG_FIRST_LEVEL),
        (README_MISSING_CONTENT, EXPECTED_ERROR_README_MISSING_CONTENT),
    ]  ,			)
def __UpperCamelCase(   _A					:				Any  ,			_A					:				Tuple    ):
   '''simple docstring'''
   with tempfile.TemporaryDirectory() as tmp_dir:
      UpperCAmelCase__							:				str   				=  Path(_A    ) / '''README.md'''
      with open(_A  ,			'''w+'''    ) as readme_file:
         readme_file.write(_A    )
      UpperCAmelCase__							:				Union[str, Any]   				=  expected_error.format(path=_A    )
      with pytest.raises(_A  ,			match=re.escape(_A    )    ):
         UpperCAmelCase__							:				Union[str, Any]   				=  ReadMe.from_readme(_A  ,			_A    )
         readme.validate()







@pytest.mark.parametrize(
    '''readme_md, expected_error'''  ,			[
        (README_MULTIPLE_SAME_HEADING_1, EXPECTED_ERROR_README_MULTIPLE_SAME_HEADING_1),
    ]  ,			)
def __UpperCamelCase(   _A					:				Dict  ,			_A					:				Any    ):
   '''simple docstring'''
   with tempfile.TemporaryDirectory() as tmp_dir:
      UpperCAmelCase__							:				List[Any]   				=  Path(_A    ) / '''README.md'''
      with open(_A  ,			'''w+'''    ) as readme_file:
         readme_file.write(_A    )
      UpperCAmelCase__							:				Optional[Any]   				=  expected_error.format(path=_A    )
      with pytest.raises(_A  ,			match=re.escape(_A    )    ):
         ReadMe.from_readme(_A  ,			_A    )







@pytest.mark.parametrize(
    '''readme_md,'''  ,			[
        (README_MULTIPLE_SAME_HEADING_1),
    ]  ,			)
def __UpperCamelCase(   _A					:				List[str]    ):
   '''simple docstring'''
   with tempfile.TemporaryDirectory() as tmp_dir:
      UpperCAmelCase__							:				List[str]   				=  Path(_A    ) / '''README.md'''
      with open(_A  ,			'''w+'''    ) as readme_file:
         readme_file.write(_A    )
      ReadMe.from_readme(_A  ,			_A  ,			suppress_parsing_errors=_A    )





'''simple docstring'''

def __UpperCamelCase(   _A					:				int    ):
   '''simple docstring'''

   if length <= 0 or not isinstance(_A  ,			_A    ):
      raise ValueError('''Length must be a positive integer.'''    )
   return [n * (2 * n - 1) for n in range(_A    )]


if __name__ == "__main__":
  print(hexagonal_numbers(length=5))
  print(hexagonal_numbers(length=10))




