refactor(examples): replace os.system with native python libs in create_dataset.py #2102
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Refactored
examples/orderbook_data/create_dataset.pyto replaceos.systemcalls (which invoked Linux-specific shell commands likecp,tar, andchmod) with native Python libraries (shutil,tarfile,os).Key changes:
cpwithshutil.copy.tarshell command with thetarfilemodule.chmod 777withos.chmodusing safer permissions (0o755), ensuring the script doesn't grant excessive world-writable permissions.lambdahelper and a loop to handle the "SH" and "SZ" subfolders, removing code duplication.Motivation and Context
cp,tar,chmod) viaos.system, causing the script to fail on Windows environments. Native Python libraries ensure the script runs correctly on Windows, Linux, and macOS.os.systemwith shell commands can lead to command injection risks if variables are not sanitized. Additionally,chmod 777is a security risk. The new implementation follows the principle of least privilege.How Has This Been Tested?
pytest qlib/tests/test_all_pipeline.pyunder upper directory ofqlib.Test Description:
I manually ran the
create_dataset.pyscript locally to verify that:.tar.gzfiles are correctly copied to the destination.SHandSZfolders.Types of changes
NOTE: I know that this is a demo script, but is good to demonstrate with a secure code.