Implement a basic __main__.py file able to process a --excavator arg. #5
Conversation
This file contains hidden or 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
This commit adds a package level main file which uses argparse to expose a CLI. Given a filename and a named excavator will perform an excavation and output the usual HTML files. Default to writing to the classic /tmp output path, but provide support for specifying a -d option to relocate the output directory. allow a directory argument of "." which will cause outputting output folder in the cwd: ./output/_autoarchaologist In order to ensure things are working include tests of the new command line as well as the basic operation of excavating the example file. The tests check the expected HTML files were written for this known input and assert some basic properties of the excavated artifacts. While here repair the example excavation which was not functional after recent renaming. In addition, multiple runs of the test suite showed that the temporary file cleanup placed in __del__ could occur as such a point as to cause an exception opening the file. Move the removal to such that it occurs after its content is consumed and is safe to remove.
alexjeffburke
force-pushed
the
dunder-main-groundwork
branch
from
cd9f204 to
d589ed4
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 commit adds a basic argparse based package level main file which given a filename and a named excavator will perform an excavation and output the usual HTML files.
By default this uses the standard temporary path, but additionally support specifying -d and allow a directory argument of "." which will cause outputting output folder in the cwd: ./output/_autoarchaologist
In order to ensure things are working include tests of the new command line as well as the basic operation of excavating the example file. The tests check the expected HTML files were written for this known input and assert some basic properties of the excavated artifacts.
While here repair the example excavation. The excavation it executes is explicitly declared thus CLI selectable as --excavator examples.showcase