Skip to content

REF: extract dialect validation #37332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 23, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 48 additions & 25 deletions pandas/io/parsers.py
Original file line number Diff line number Diff line change
Expand Up @@ -794,10 +794,8 @@ def __init__(self, f, engine=None, **kwds):

_validate_skipfooter(kwds)

if kwds.get("dialect") is not None:
dialect = kwds["dialect"]
if dialect in csv.list_dialects():
dialect = csv.get_dialect(dialect)
dialect = _extract_dialect(kwds)
if dialect is not None:
kwds = _merge_with_dialect_properties(dialect, kwds)

if kwds.get("header", "infer") == "infer":
Expand Down Expand Up @@ -3739,6 +3737,50 @@ def _refine_defaults_read(
return kwds


def _extract_dialect(kwds: Dict[str, Any]) -> Optional[csv.Dialect]:
"""
Extract concrete csv dialect instance.

Returns
-------
csv.Dialect or None
"""
if kwds.get("dialect") is None:
return None

dialect = kwds["dialect"]
if dialect in csv.list_dialects():
dialect = csv.get_dialect(dialect)

_validate_dialect(dialect)

return dialect


MANDATORY_DIALECT_ATTRS = (
"delimiter",
"doublequote",
"escapechar",
"skipinitialspace",
"quotechar",
"quoting",
)


def _validate_dialect(dialect: csv.Dialect) -> None:
"""
Validate csv dialect instance.

Raises
------
ValueError
If incorrect dialect is provided.
"""
for param in MANDATORY_DIALECT_ATTRS:
if not hasattr(dialect, param):
raise ValueError(f"Invalid dialect {dialect} provided")


def _merge_with_dialect_properties(
dialect: csv.Dialect,
defaults: Dict[str, Any],
Expand All @@ -3757,30 +3799,11 @@ def _merge_with_dialect_properties(
-------
kwds : dict
Updated keyword arguments, merged with dialect parameters.

Raises
------
ValueError
If incorrect dialect is provided.
"""
kwds = defaults.copy()

# Any valid dialect should have these attributes.
# If any are missing, we will raise automatically.
mandatory_dialect_attrs = (
"delimiter",
"doublequote",
"escapechar",
"skipinitialspace",
"quotechar",
"quoting",
)

for param in mandatory_dialect_attrs:
try:
dialect_val = getattr(dialect, param)
except AttributeError as err:
raise ValueError(f"Invalid dialect {dialect} provided") from err
for param in MANDATORY_DIALECT_ATTRS:
dialect_val = getattr(dialect, param)

parser_default = _parser_defaults[param]
provided = kwds.get(param, parser_default)
Expand Down