Skip to content
This repository was archived by the owner on Jan 17, 2026. It is now read-only.

Improvements for programmatic usage #55

Open
queengooborg wants to merge 43 commits into
base: master
Choose a base branch
from
Open

Improvements for programmatic usage #55

queengooborg wants to merge 43 commits into from
+336 −483

Conversation

@queengooborg
Copy link

@queengooborg queengooborg commented Jul 13, 2024 •
edited
Loading

This PR performs a number of changes tailored towards improving the experience when using DecompilerMC as a module, rather than as a script.

User Story

I use DecompilerMC as a dependency in a toolkit that reads the source code for Minecraft and calculates all of its items and their crafting recipes, which is then used to generate a worth.yml file for EssentialsX.

However, I had to make some adjustments to its code to get it to work in the manner I desired it to. The primary issue I ran into was that sys.exit() was used quite often throughout the code when there was an error, which means that any script that imported it as a module would also quit on error.

Solution

To improve the experience for module use, as well as to provide other minor improvements, the following changes were made:

  • Replace most instances of sys.exit() with thrown exceptions
  • Use pathlib.Path for most filepaths, rather than strings
  • Don't delete manifest.json after parsing, only when redownloading
    • This allows for partial offline use of DecompilerMC
  • Re-download version manifest if last downloaded 24 hours ago
  • Improves various messages
  • Check each potential Java path and then stop when the first match is found
  • Replace "manual" mode with "interactive" mode
    • The "interactive" mode provides a command line interface to choose the options that could be specified from command line arguments
    • This way, we can specify all the arguments first, and then run all the steps in one go, which makes programmatic usage much easier
  • Simplify command line arguments
    • Rather than having a bunch of command line arguments for each individual step, arguments are now consolidated into a few simple options (clean, force, quiet and interactive)
    • The average user will likely not be configuring most of the CLI options that were removed, and the user that would is probably going to run specific functions from their own script

mat-1 and others added 30 commits June 24, 2022 21:21
@mat-1
Use version manifest v2
35880cd
@Tisawesomeness
Update CFR
3c26e20
@queengooborg
Merge branch 'Tisawesomeness/master'
96e4abc
@queengooborg
Have download_file throw an error instead of exit the program
1a5597c
@queengooborg
Ensure manifest.json stays downloaded for offline use
130ebf4
@queengooborg
Remove excessive use of sys.exit(-1); inverse if/else for simplicity
633b2e5
@queengooborg
Update messages
33e0575
@queengooborg
Handle exceptions better
5174987
@queengooborg
Use relative path for get_latest_version()
71288d4
@queengooborg
Merge remote-tracking branch 'upstream/master'
bfb443a
@queengooborg
Use pathlib paths for all file paths
dca9d55
@queengooborg
Ensure that parent directories exist when downloading files
225516a
@queengooborg
Use str(var) instead of var.__str__()
e77159a
@queengooborg
Fix path for manifest.json
6e4b3d9
@queengooborg
Update message
ec58c45
@queengooborg
Use .get() to check if dictionary item exists
e00058d
@queengooborg
Consolidate code between interactive and non-interactive modes
90ee5d5
@queengooborg
Introduce --interactive command line argument
dc379ef
@queengooborg
Remove "delete dependencies" step
fc34a1c 
This step only happens if running in manual mode, so I can't imagine it's quite useful.
@queengooborg
Remove "manual" mode altogether
e9af7d6 
Manual mode is really only helpful for debugging, but not really, because each step can only run if the previous step had.  Implementing the ability to pick and choose steps just adds additional complexity to the program for very little gain.
@queengooborg
Rename "removal_bool" to "clean" for consistency
03c8193
@queengooborg
Cleanup variables and output
5c5239d
@queengooborg
Improve and simplify Java check function
e9585f3
@queengooborg
Print full error traceback
61d2504
@queengooborg
Remove --forceno as an argument
fd14830 
"--forceno" is on by default, but the only reason to set it to False is to enable interactivity when it detects the conflict.  This just adds more complexity to the code, and the better option is to simply have the user specify "--clean" or "--force" instead.
@queengooborg
Update command line arguments
d7ea559
@queengooborg
Ensure all file paths are relative to main.py
290b4eb
@queengooborg
Don't wait for user action to finish program
b3ee668
@queengooborg
Quiet is not on by default
a6238f7
@queengooborg
Ensure SpecialSource and CFR output to relative paths
2844581
@Nel-S Nel-S mentioned this pull request Oct 11, 2024
Merged
hube12 pushed a commit that referenced this pull request Nov 2, 2024
@Nel-S @hube12
Allow program to be run from outside its own directory + other updates
f63bd6e 
- Add the path used to open the program from to all relative paths, so program doesn't create new folders in a directory outside the one it's located within
- Replace sys.exits with exception raising (see #55)
- Replace assertion (which can be compiled out) with unskippable test + exception
- Tweak url['..._mappings'] code so correct exception is raised (#50)
- Standardize pathlib usage
- Some code restructuring to reduce the amount of indentation
- Add some typing
- Grammar fixes in code outputs/errors
- Add TODOs to mark areas for future improvement
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@queengooborg @mat-1 @Tisawesomeness