Fix Special Formatter Issue and YAML File Implementation for Additional User Input

[nayera16]

Summary

We separated the file acquisition from the original parse function, so the code becomes modular. We added the new YAML file configuration that helps to organize the format strings that the user needs to modify into a document. We added an ‘encoding’ key in the YAML file that allows the user to specify the desired format substitution. We added code to carry out these substitutions in the core file so that the ParaFrame object displays the modifications.

Details

We separated the parse function into glob search, which searches files in the specified directory and returns the pattern used for parsing, and parse, which parses through the files and places it in the ParaFrame object. We add the YAML file, which allows the user to specify the directory to work on, and the directory path that the user wants to modify. In this file, the user can also specify the method to apply the modification, generally through a regex substitution. However, the user also has the option to pass the format string directly into the function if they don’t require a modification of the path. In the core.py file, we added code that carries out the desired regex substitution in the ‘parse’ function so that the ParaFrame object contains the modified characters. We added functions specifically designed to interact with the YAML file and perform the regex substitution, located in the helperfunctions.py file.

Testing

We added several tests to make temporary directories that have special cases in the format string that requires regex substitution. These cases include ‘+’, ‘m’ in the directory path. We also create a temporary yaml file in the temporary directory and manually write it with the path to testing functions so that the testing process is carried out systematically for each test.

Follow-on

Future modifications include adding example use cases for the 'encodings' regex substitution in the demo notebook. The next iteration of hallmark will develop the Command Line Interface to allow users further flexibility and access to this package. We will also further explore the use of one vs multiple YAML files for different user stories.

[hfoote]

Let's fix the few things I mentioned in the comments, then get this merged. After we merge this with next, we should be able to use the Repo's functionality to handle the path to the yaml file (look for a .hallmark.yaml file in the data directory by default).

[hfoote]

Nice work cleaning up the paths, I think we can finalize the path handling when we combine this with the next branch.