Skip to content

Adding encoding specification parameter when opening yaml file #86

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Adding encoding specification parameter when opening yaml file #86

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 11 additions & 3 deletions src/mkdocs_table_reader_plugin/readers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,15 +133,23 @@ def read_excel(*args, **kwargs) -> str:

@ParseArgs
def pd_read_yaml(*args, **kwargs) -> str:
defaultEncoding = "UTF-8"
if "encoding" in kwargs:
defaultEncoding = kwargs["encoding"]
del kwargs["encoding"]
Comment on lines +137 to +139
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's move this below the json_kwargs line. If pd.json_normalize() ever adds an encoding parameter, we would still be able to processs it.

Even better would be to just use: with open(args[0], "r", encoding=kwargs.get("encoding","UTF-8") as f:

json_kwargs = kwargs_in_func(kwargs, pd.json_normalize)
with open(args[0]) as f:
with open(args[0], "r", encoding=defaultEncoding) as f:
df = pd.json_normalize(yaml.safe_load(f), **json_kwargs)
return df

@ParseArgs
def read_yaml(*args, **kwargs) -> str:
defaultEncoding = "UTF-8"
if "encoding" in kwargs:
defaultEncoding = kwargs["encoding"]
del kwargs["encoding"]
Comment on lines +147 to +150
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same, just use encoding=kwargs.get("encoding","UTF-8") directly.

json_kwargs = kwargs_in_func(kwargs, pd.json_normalize)
with open(args[0]) as f:
with open(args[0], "r", encoding=defaultEncoding) as f:
df = pd.json_normalize(yaml.safe_load(f), **json_kwargs)

markdown_kwargs = kwargs_not_in_func(kwargs, pd.json_normalize)
Expand Down Expand Up @@ -194,4 +202,4 @@ def read_raw(*args, **kwargs) -> str:
"pd_read_json": pd_read_json,
"pd_read_feather": pd_read_feather,
}
MACROS = {**READERS, **MACRO_ONLY}
MACROS = {**READERS, **MACRO_ONLY}
Loading