Skip to content
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

Suggestion for fixing the unintentional situation that since v0.6 the… #404

Merged
merged 6 commits into from
Aug 26, 2024

Conversation

mkuehbach
Copy link
Collaborator

… dataconverter required a config file if it was called the classical way and in case no parameter yaml file was provided. For programmatically use of the converter the creation of an additional params file with only a few entries is unnecessary overhead especially when all cli arguments are available in the callers scope and thus the CLI call can be issues directly using the classical way dataconverter convert [INPUTFILES] options

… dataconverter required a config file if it was called the classical way and in case no parameter yaml file was provided. For programmatically use of the converter the creation of an additional params file with only a few entries is unnecessary overhead especially when all cli arguments are available in the callers scope and thus the CLI call can be issues directly using the classical way dataconverter convert [INPUTFILES] options
@mkuehbach mkuehbach requested review from sherjeelshabih and lukaspie and removed request for sherjeelshabih August 21, 2024 08:17
@mkuehbach
Copy link
Collaborator Author

I also removed the outdated documentation of the command line options as it is a second place where changes have to be applied constantly and the instructions for empowering people to find these are already given in the readme plus follow the typical style how to get help for command line calls

…is passed via cli but instead have their own configurations for the respective formats they support as part of the plugin source code, hence calling these readers with kwargs config is unnecessary and incorrect, this commit fixes this bug
src/pynxtools/dataconverter/convert.py Outdated Show resolved Hide resolved
src/pynxtools/dataconverter/convert.py Outdated Show resolved Hide resolved
src/pynxtools/dataconverter/convert.py Outdated Show resolved Hide resolved
src/pynxtools/dataconverter/convert.py Outdated Show resolved Hide resolved
@mkuehbach
Copy link
Collaborator Author

Tested 30ad68c of this branch solves the problems @sherjeelshabih

Copy link
Collaborator

@lukaspie lukaspie left a comment

Choose a reason for hiding this comment

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

I tested with

  • pynxtools-xps, both with and w/o a config file
  • pyntools-mpes, always uses config file
  • pynxtools-stm
  • pynxtools-em, with the example @mkuehbach send me
  • json_map -> with examples in example/json-map

@mkuehbach feel free to merge if your examples still run through (wasn't sure if you tested something else as well). Thanks for the fix!

@mkuehbach mkuehbach dismissed sherjeelshabih’s stale review August 26, 2024 09:43

Outdated conflicts were resolved

@mkuehbach mkuehbach merged commit 2610b60 into master Aug 26, 2024
12 checks passed
RonHildebrandt pushed a commit that referenced this pull request Aug 30, 2024
lukaspie pushed a commit that referenced this pull request Aug 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants