


'''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():

_lowerCAmelCase  :		List[str]		     =	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'
)


_lowerCAmelCase  :		List[Any]		     =	{
    '''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''': []},
                    ],
                },
            ],
        }
    ],
}


_lowerCAmelCase  :		Dict		     =	'''\
---
language:
- zh
- en
---

# Dataset Card for My Dataset
## Table of Contents
Some text here.
## Dataset Description
Some text here.
### Dataset Summary
Some text here.
### Supported Tasks and Leaderboards
### Languages
Language Text
'''


_lowerCAmelCase  :		Any		     =	'''\
---
language:
- zh
- en
---

# Dataset Card for My Dataset
## Table of Contents
Some text here.
## Dataset Description
Some text here.
### Dataset Summary
Some text here.
#### Extra Ignored Subsection
### Supported Tasks and Leaderboards
### Languages
Language Text
'''

_lowerCAmelCase  :		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''': []},
                    ],
                },
            ],
        }
    ],
}

_lowerCAmelCase  :		Tuple		     =	'''\
---
---
# Dataset Card for My Dataset
## Table of Contents
Some text here.
## Dataset Description
Some text here.
### Dataset Summary
Some text here.
### Supported Tasks and Leaderboards
### Languages
Language Text
'''

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

_lowerCAmelCase  :		Optional[int]		     =	'''\
# Dataset Card for My Dataset
## Table of Contents
Some text here.
## Dataset Description
Some text here.
### Dataset Summary
Some text here.
### Supported Tasks and Leaderboards
### Languages
Language Text
'''

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

_lowerCAmelCase  :		Optional[int]		     =	'''\
---
# Dataset Card for My Dataset
## Table of Contents
Some text here.
## Dataset Description
Some text here.
### Dataset Summary
Some text here.
### Supported Tasks and Leaderboards
### Languages
Language Text
'''

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

_lowerCAmelCase  :		Optional[Any]		     =	'''\
---
language:
- zh
- en
---

# Dataset Card for My Dataset
## Table of Contents
Some text here.
## Dataset Description
Some text here.
### Dataset Summary
### Supported Tasks and Leaderboards
### Languages
Language Text
'''
_lowerCAmelCase  :		Dict		     =	'''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).'''


_lowerCAmelCase  :		str		     =	'''\
---
language:
- zh
- en
---

# Dataset Card for My Dataset
'''
_lowerCAmelCase  :		List[str]		     =	'''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\'.'''

_lowerCAmelCase  :		int		     =	'''\
---
language:
- zh
- en
---

# Dataset Card for My Dataset
## Table of Contents
Some text here.
## Dataset Description
Some text here.
### Dataset Summary
Some text here.
### Languages
Language Text
'''

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


_lowerCAmelCase  :		Optional[Any]		     =	'''\
---
language:
- zh
- en
---

# Dataset Card for My Dataset
## Table of Contents
Some text here.
## Dataset Description
Some text here.
### Dataset Summary
Some text here.
### Supported Tasks and Leaderboards
### Languages
'''

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

_lowerCAmelCase  :		Optional[Any]		     =	'''\
---
language:
- zh
- en
---

## Table of Contents
Some text here.
## Dataset Description
Some text here.
### Dataset Summary
Some text here.
### Supported Tasks and Leaderboards
### Languages
Language Text
'''
_lowerCAmelCase  :		Tuple		     =	'''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.'''

_lowerCAmelCase  :		int		     =	'''\
---
language:
- zh
- en
---

# Dataset Card for My Dataset
## Table of Contents
Some text here.
## Dataset Description
Some text here.
### Dataset Summary
Some text here.
### Supported Tasks and Leaderboards
### Languages
Language Text
# Dataset Card My Dataset
'''

_lowerCAmelCase  :		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.'''

_lowerCAmelCase  :		Dict		     =	'''\
---
language:
- zh
- en
---

# Dataset Card My Dataset
## Table of Contents
Some text here.
## Dataset Description
Some text here.
### Dataset Summary
Some text here.
### Supported Tasks and Leaderboards
### Languages
Language Text
'''

_lowerCAmelCase  :		str		     =	'''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.'''

_lowerCAmelCase  :		str		     =	''''''

_lowerCAmelCase  :		List[str]		     =	'''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.'''

_lowerCAmelCase  :		Optional[Any]		     =	'''\
---
language:
- zh
- en
---

# Dataset Card for My Dataset
# Dataset Card for My Dataset
## Table of Contents
Some text here.
## Dataset Description
Some text here.
### Dataset Summary
Some text here.
### Supported Tasks and Leaderboards
### Languages
Language Text
'''

_lowerCAmelCase  :		List[Any]		     =	'''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    :				Union[str, Any]					,   _A    :				Optional[Any]				)    ->      Optional[Any]:




	"""simple docstring"""





	assert ReadMe.from_string(UpperCAmelCase__					,   UpperCAmelCase__				).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    :				Dict					,   _A    :				int				)    ->      Any:




	"""simple docstring"""





	with pytest.raises(UpperCAmelCase__					,   match=re.escape(expected_error.format(path='root'				)				)				):
		lowerCAmelCase					:    Dict      							= ReadMe.from_string(UpperCAmelCase__					,   UpperCAmelCase__				)
		readme.validate()

@pytest.mark.parametrize(
    'readme_md, expected_error'					,   [
        (README_MULTIPLE_SAME_HEADING_1, EXPECTED_ERROR_README_MULTIPLE_SAME_HEADING_1),
    ]					,   )
def 			__UpperCamelCase    (    _A    :				str					,   _A    :				Optional[Any]				)    ->      List[Any]:




	"""simple docstring"""





	with pytest.raises(UpperCAmelCase__					,   match=re.escape(expected_error.format(path='root'				)				)				):
		ReadMe.from_string(UpperCAmelCase__					,   UpperCAmelCase__				)

@pytest.mark.parametrize(
    'readme_md,'					,   [
        (README_MULTIPLE_SAME_HEADING_1),
    ]					,   )
def 			__UpperCamelCase    (    _A    :				str				)    ->      Union[str, Any]:




	"""simple docstring"""





	ReadMe.from_string(UpperCAmelCase__					,   UpperCAmelCase__					,   suppress_parsing_errors=UpperCAmelCase__				)

@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				)    ->      Any:




	"""simple docstring"""





	with tempfile.TemporaryDirectory() as tmp_dir:
		lowerCAmelCase					:    Dict      							= Path(UpperCAmelCase__				) / 'README.md'
		with open(UpperCAmelCase__					,   'w+'				) as readme_file:
			readme_file.write(UpperCAmelCase__				)
		lowerCAmelCase					:    List[str]      							= ReadMe.from_readme(UpperCAmelCase__					,   UpperCAmelCase__				).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    :				Optional[int]					,   _A    :				str				)    ->      List[str]:




	"""simple docstring"""





	with tempfile.TemporaryDirectory() as tmp_dir:
		lowerCAmelCase					:    int      							= Path(UpperCAmelCase__				) / 'README.md'
		with open(UpperCAmelCase__					,   'w+'				) as readme_file:
			readme_file.write(UpperCAmelCase__				)
		lowerCAmelCase					:    Optional[int]      							= expected_error.format(path=UpperCAmelCase__				)
		with pytest.raises(UpperCAmelCase__					,   match=re.escape(UpperCAmelCase__				)				):
			lowerCAmelCase					:    Optional[Any]      							= ReadMe.from_readme(UpperCAmelCase__					,   UpperCAmelCase__				)
			readme.validate()

@pytest.mark.parametrize(
    'readme_md, expected_error'					,   [
        (README_MULTIPLE_SAME_HEADING_1, EXPECTED_ERROR_README_MULTIPLE_SAME_HEADING_1),
    ]					,   )
def 			__UpperCamelCase    (    _A    :				Optional[Any]					,   _A    :				int				)    ->      str:




	"""simple docstring"""





	with tempfile.TemporaryDirectory() as tmp_dir:
		lowerCAmelCase					:    Optional[Any]      							= Path(UpperCAmelCase__				) / 'README.md'
		with open(UpperCAmelCase__					,   'w+'				) as readme_file:
			readme_file.write(UpperCAmelCase__				)
		lowerCAmelCase					:    Dict      							= expected_error.format(path=UpperCAmelCase__				)
		with pytest.raises(UpperCAmelCase__					,   match=re.escape(UpperCAmelCase__				)				):
			ReadMe.from_readme(UpperCAmelCase__					,   UpperCAmelCase__				)






@pytest.mark.parametrize(
    'readme_md,'					,   [
        (README_MULTIPLE_SAME_HEADING_1),
    ]					,   )
def 			__UpperCamelCase    (    _A    :				Optional[Any]				)    ->      List[Any]:




	"""simple docstring"""





	with tempfile.TemporaryDirectory() as tmp_dir:
		lowerCAmelCase					:    Union[str, Any]      							= Path(UpperCAmelCase__				) / 'README.md'
		with open(UpperCAmelCase__					,   'w+'				) as readme_file:
			readme_file.write(UpperCAmelCase__				)
		ReadMe.from_readme(UpperCAmelCase__					,   UpperCAmelCase__					,   suppress_parsing_errors=UpperCAmelCase__				)




'''simple docstring'''




def 			__UpperCamelCase    (    _A    :				int				)    ->      bool:




	"""simple docstring"""





	return number & 1 == 0


if __name__ == "__main__":
				import doctest

				doctest.testmod()
