Feat/configuration module #215
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… module. This commit only moves the functions, and is thus breaking.
Rename from pyflowline_create_basin_template_configuration_file to pyflowline_create_template_basin_configuration_file for consistency with the main method. This has no side effects.
This fixes the imports of the read_configuration_file, change_json_key_value, and other configuration functions used to set json file parameters in the demos with the new module syntax. This also fixes various smaller bugs in the mpas example so it runs without error. The overall layout of the mpas example was also updated so all the parameters are defined up top so its clearer to users what values need to be modified. A subsequent commit will programmatically update the paths to make it easier, but this commit serves as a marker of a working set of demos using the new configuration module syntax.
This will enable programmatic setting of project paths in the examples and demos and json files.
…fects. This refactor writes to a tempfile in case the function errors early. This should be os agnostic.
The purpose is to handle both realpath (str) and Path objects. With Path objects its easier to use the joinpath method, but a dedicated function will help ensure compatibility if path_manager is adopted more widely in the project.
This replaces realpath with Path and converts to str where needed, however, the Path objects are fully compatible with the configuration module functions. Conversion to string was only done for compatibility with the Hungarian notation convention e.g., sFolder_output is now oFolder_output.
It is necessary to check if optional path inputs are Path if they are set to None by default, unlike the required inputs which can be converted to str without any isinstance
|
@mgcooper |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request adds a
configurationsubpackage to simplify setting up and managing paths within pyflowline.Key Changes
pyflowline.configuration.path_managermodule withinconfiguration, to programmatically retrieve and build paths:pyflowline_project_root(): Returns the top-level project path.pyflowline_package_root(): Returns the package path, akin to howpkg_resourcesmanages package roots.Usage Examples:
path_manager returns Path objects, so I added conversions to str() in the configuration functions. I tried to ensure the updates are platform / os agnostic, but happy to revisit if the previous use of
realpathis preferable.