[WIP - DO NOT USE] Pythonic and simpler refactor of `wemod-launcher` #138

shymega · 2024-11-17T21:13:28Z

Hi all!

As mentioned briefly in #100, and discussed over Discord with Marvin, this PR
is a overhaul I'm working on of wemod-launcher.

Testing is welcome once I get to a stage where it can be tested.

However, right now - it's a heavy WIP, and should not be used.

I have marked it as a draft PR.

It's worth noting that Nix is able to build this package on this PR natively,
so that is very cool.

Contributions welcome to my fork as PRs, which will then be pushed to this PR.

(Note: I will be rebasing and force-pushing. Let me know in advance before you
push to this branch if you're a maintainer, as your changes may be lost.)

Thank you!

- Set +x on prepare.py (prev. setup.py). - Set +x on wemod (symlinked to wemod.py as well). - Rename setup.py -> prepare.py - otherwise conflicts - Pythonize modules. Signed-off-by: Dom Rodriguez <[email protected]>

This commit updates the names of imports from previously renamed modules. Signed-off-by: Dom Rodriguez <[email protected]>

Signed-off-by: Dom Rodriguez <[email protected]>

Temporary commit. To be reworded. TODO! FIXME! Signed-off-by: Dom Rodriguez <[email protected]>

Signed-off-by: Dom Rodriguez <[email protected]>

TOML is easier to read, and I hated dealing with YAML. PyYAML bad. Signed-off-by: Dom Rodriguez <[email protected]>

Signed-off-by: Dom Rodriguez <[email protected]>

Also tidy up Flake, use `devenv` inside Flake (and update .envrc), as well as restructuring project layout Signed-off-by: Dom Rodriguez <[email protected]>

…+licence

Add warning for using this refactor onto the readme

Update the refactor with spell + licence change

Refactor spelling and licence update

marvin1099 · 2024-12-02T13:46:14Z

I moved the nix files into ./tools/nix/
i have changed the paths to the nix files to reflect this,
but I'm not using nix so I'm not sure if i did this correctly.
If you have the time se if you can make it work.
I would be great if the nix files could be in a subfolder.

I also pushed the newest update and the license change to the refactor.
Hopefully you can also work with this.

Oh yes there are some helper scripts for running the wemod launcher script in ./script/ now.
That's probably not that relevant for you, but cant hurt to tell you.

Replaced poetry with PDM in pyinstaller.py Added build helper script Added PDM fail check in helper scripts

This new version uses the following syntax. # First you import as usual from consts import Constants # Then you can use the name of the setting you want like this print(Constants.ConfigDir) Very simple and intuitive Some Of the constants are not jet added, right now there are only constants in here that can be defined without any other module. So, some of the important constants still have to be added

The change of the config manager makes it now use: from configuration import ConfigManager as Conf Conf.LogFolder = "/test/path/" print(Conf.LogFolder) As this just saves the provided key something like this would work: Conf.VeryLongRandomKeyHere = "mysetting" To be implemented is a custom logger In this file we still need saving and loading with the tomllib

I refactored const and configuration to work with instances, its just a bit simpler in the const and configuration files. A custom logger is now also added. Here is a example: from consts import Constants from configuration import ConfigManager from logger import Logger CT = Constants() # Get a const instance CM = ConfigManager() # Get a conf instance LG = Logger() # Get a logger instance print(CT.config_path) # print config path print(CM.log_name) # print active log file LG.info("Test message", "test") # Push a log message from module "test" CE = ConfigManager(env_vars=True,cmd=True) # load environment variables (priority) too print(CE.XDG_CACHE_HOME) # print a env var

shymega · 2024-12-07T21:48:56Z

I think I would rather you push your commits to your own branch, based off my PR, and create PRs from your branch's HEAD, to my PR. Otherwise with my force-pushing, you will lose your changes.

As for the Nix changes, this isn't how Nix works. It breaks everything. I propose you checkout a new branch locally on your machine, and once you've done that, create a PR with the base branch set to this PR and the HEAD set to your new branch. Then we can merge things into this master branch as we go.

marvin1099 · 2024-12-07T22:14:15Z

I think I would rather you push your commits to your own branch, based off my PR, and create PRs from your branch's HEAD, to my PR. Otherwise with my force-pushing, you will lose your changes.

So make changes on my copy and then merge them to this branch, shure.

As for the Nix changes, this isn't how Nix works. It breaks everything. I propose you checkout a new branch locally on your machine, and once you've done that, create a PR with the base branch set to this PR and the HEAD set to your new branch. Then we can merge things into this master branch as we go.

I expected something to break I'm not a nix expert, I was kinda hopping is was not that far off from working, and that you could make it work,
do all nix files have to be in the project root then?

Merging into master, well that is still going to take a bit i think.

Well as for the fix files can you do something to clean the root up a bit, would be great.

As shymega pointed out it breaks stuff on nix. I would still like the files to be in a subfolder but im not a nix guy. So shymega hopfully can fugure something out. But for now i will revert that.

marvin1099 · 2024-12-21T10:59:29Z

For now i reverted the nix file move, if you figure something out it would be nice if you can make it happen.

Marakai · 2025-01-13T05:13:00Z

Hi! I just forked the repo as I am interested in working on some approaches to automate and improve installation and use. Things like using Poetry and/or Docker.

Should I do that off main or this WIP branch (despite it not being fully usable right now)?

marvin1099 · 2025-01-13T07:06:53Z

Hi! I just forked the repo as I am interested in working on some approaches to automate and improve installation and use. Things like using Poetry and/or Docker.

Should I do that off main or this WIP branch (despite it not being fully usable right now)?

Hi @Marakai,
you can work on this refactor branch (WIP branch) or the Dev branch.
Keep in mind that we actually use pdm not poetry in the this branch, please use that instead.
Also keep in mind that the Dev branch is the working and currently used branch by the comity.
Also the dev / main branch will be deprecated in the future.

This branch is what the future of wemod will be but it is not only WIP I'm also pretty shure it won't run yet, so you may end up trying to figure that out how to run it.

But if you want to help for the future then help with the refactor otherwise you can try to make the old and active version in Dev and main as good as they can be, feel free to work on what you like where.

shymega · 2025-01-13T23:34:42Z

On 12.01.2025 23:07, Marvin1099 wrote: > Hi! I just forked the repo as I am interested in working on some approaches to automate and improve installation and use. Things like using Poetry and/or Docker. > > Should I do that off `main` or this WIP branch (despite it not being fully usable right now)? Hi @Marakai, you can work on this refactor branch (WIP branch) or the Dev branch. Keep in mind that we actually use pdm not poetry in the this branch, please use that instead. Also keep in mind that the Dev branch is the working and currently used branch by the comity. Also the dev / main branch will be deprecated in the future. This branch is what the future of wemod will be but it is not only WIP I'm also pretty shure it won't run yet, so you may end up trying to figure that out how to run it. But if you want to help for the future then help with the refactor otherwise you can try to make the old and active version in Dev and main as good as they can be, feel free to work on what you like where.

Hi, Following up on this: Please make PRs to this PR's HEAD branch, but be aware rebases will happen. As for the main branch, this will be changed to PRs-only, and all development separated into different branches. We are not using Poetry, and pdm will be used instead, as Marvin says. What benefit is there of using Docker for this? I can't see the benefit - for development? If you're thinking of devcontainers, the Nix stuff can do this already. Best wishes, -- Dom Rodriguez

shymega · 2025-01-13T23:36:39Z

I think I would rather you push your commits to your own branch, based off my PR, and create PRs from your branch's HEAD, to my PR. Otherwise with my force-pushing, you will lose your changes.

So make changes on my copy and then merge them to this branch, shure.

As for the Nix changes, this isn't how Nix works. It breaks everything. I propose you checkout a new branch locally on your machine, and once you've done that, create a PR with the base branch set to this PR and the HEAD set to your new branch. Then we can merge things into this master branch as we go.

I expected something to break I'm not a nix expert, I was kinda hopping is was not that far off from working, and that you could make it work, do all nix files have to be in the project root then?

Merging into master, well that is still going to take a bit i think.

Well as for the fix files can you do something to clean the root up a bit, would be great.

I've been giving this some thought.

I think, if you can create a refactor-marvin branch on this repo, based off this branch, I will then push to this PR from my commits, and rebase your commits onto this as and when it's necessary.

Otherwise, we end up pushing over each other in a PR.

Do you mind if I revert some of your commits and remove them from the commit history, just until it's in a better state - the Nix ones, for example. There's also a lot of merge conflicts that weren't there when it was just me pushing - but I can't recall precisely.

Marakai · 2025-01-14T22:47:32Z

Hi! I will reply in the Help Wanted issue.

marvin1099 · 2025-01-15T09:26:53Z

Do you mind if I revert some of your commits and remove them from the commit history, just until it's in a better state - the Nix ones, for example. There's also a lot of merge conflicts that weren't there when it was just me pushing - but I can't recall precisely.

Yep if needed you can revert some stuff, I thought I reverted far enough to make it work. I will make the refactor-marvin branch and add my changes there.

shymega added 30 commits July 13, 2024 14:52

refactor: Rename files, set executable bit

245b5b2

- Set +x on prepare.py (prev. setup.py). - Set +x on wemod (symlinked to wemod.py as well). - Rename setup.py -> prepare.py - otherwise conflicts - Pythonize modules. Signed-off-by: Dom Rodriguez <[email protected]>

refactor: Update references to renamed modules

f6d1c09

This commit updates the names of imports from previously renamed modules. Signed-off-by: Dom Rodriguez <[email protected]>

refactor: Move Python files to directory, fix some typos

97e6dc6

Signed-off-by: Dom Rodriguez <[email protected]>

refactor: Convert project to Poetry, with Nix flake

08e535b

Signed-off-by: Dom Rodriguez <[email protected]>

feat: Add initial util modules

3f69cb1

Signed-off-by: Dom Rodriguez <[email protected]>

fix: Update Poetry+Flake to work with Nix

6b24c6a

Signed-off-by: Dom Rodriguez <[email protected]>

refactor: Refactor Log and Configuration utils

087c184

Temporary commit. To be reworded. TODO! FIXME! Signed-off-by: Dom Rodriguez <[email protected]>

fix: Fix broken LoggingHandler class

ceb3683

Signed-off-by: Dom Rodriguez <[email protected]>

refactor: Begin tidy up of consts.py

2712573

Signed-off-by: Dom Rodriguez <[email protected]>

refactor: Prepare components for Python packaging

ed57407

Signed-off-by: Dom Rodriguez <[email protected]>

chore(flake): Remove unused overrides

3a8fdac

Signed-off-by: Dom Rodriguez <[email protected]>

chore: Add note for later fix

f7747f8

Signed-off-by: Dom Rodriguez <[email protected]>

feat: Add script to Poetry

660a463

Signed-off-by: Dom Rodriguez <[email protected]>

feat: Add initial start-up msg to CLI

45ea2bf

Signed-off-by: Dom Rodriguez <[email protected]>

refactor: Move from YAML to TOML

591b517

TOML is easier to read, and I hated dealing with YAML. PyYAML bad. Signed-off-by: Dom Rodriguez <[email protected]>

feat: Add initial Consts class, with pathlib support

c5674b4

Signed-off-by: Dom Rodriguez <[email protected]>

feat; Get CLI to print STEAM_COMPAT_DATA_DIR

cf0fe74

Signed-off-by: Dom Rodriguez <[email protected]>

feat(flake): Add overlay to Flake

e1fb882

Signed-off-by: Dom Rodriguez <[email protected]>

chore: Bump deps and remove deps

3e92732

Signed-off-by: Dom Rodriguez <[email protected]>

fix: Fix typo in STEAM_COMPAT_DATA_PATH env var

0e92c37

Signed-off-by: Dom Rodriguez <[email protected]>

fix: Remove debug print in Configuration class

364de04

Signed-off-by: Dom Rodriguez <[email protected]>

fix: Rename import in accordance with dependency change to stdlib

e70d570

Signed-off-by: Dom Rodriguez <[email protected]>

chore: Run black on utils/

d2da431

Signed-off-by: Dom Rodriguez <[email protected]>

fix(logger): Add optional env override for log file path

c7e7b1e

Signed-off-by: Dom Rodriguez <[email protected]>

feat: Add initial GFX module - and welcome screen

28979d4

Signed-off-by: Dom Rodriguez <[email protected]>

feat: Add initial Prefix module

28b56f1

Signed-off-by: Dom Rodriguez <[email protected]>

chore: Use Nixpkgs 24.05

270c10f

Signed-off-by: Dom Rodriguez <[email protected]>

fix: Allow for Tkinter to work

a09fa72

Signed-off-by: Dom Rodriguez <[email protected]>

chore: Remove unused print in CLI

362e784

Signed-off-by: Dom Rodriguez <[email protected]>

refactor: Simplify gfx/WelcomeScreenGfx

5c73e2b

Signed-off-by: Dom Rodriguez <[email protected]>

shymega and others added 15 commits July 13, 2024 14:52

fix(CI): Fix CI workflow with new structure for codebase

cb54e7d

Signed-off-by: Dom Rodriguez <[email protected]>

fix(WineUtils): Fix potential breakages in WinNT path test

01f059a

Signed-off-by: Dom Rodriguez <[email protected]>

feat: Add caching for WeMod logo download

60073e1

Signed-off-by: Dom Rodriguez <[email protected]>

fix(CI): Fix typo in CI

08191c9

Signed-off-by: Dom Rodriguez <[email protected]>

fix: Simplify pyinstaller.py script (Poetry)

53b691e

fix(envrc): Use devenv in envrc

1c04a30

refactor: Migrate to PDM from Poetry

8477c6d

Also tidy up Flake, use `devenv` inside Flake (and update .envrc), as well as restructuring project layout Signed-off-by: Dom Rodriguez <[email protected]>

chore: Run lints on Nix files

1b524e2

Resolve conflicts

645a12f

Add helpers and move nix files

b3a21e8

Add missing AGPL to dev.sh and move remaning nix file

3a7d1f1

Merge remote-tracking branch 'origin/refactor-up' into refactor-spell…

d05de36

…+licence

Add usage warning

3d834ff

Add warning for using this refactor onto the readme

Merge pull request #7 from marvin1099/refactor-spell+licence

af540e0

Update the refactor with spell + licence change

Merge pull request #141 from marvin1099/refactor-shymega

ad55913

Refactor spelling and licence update

marvin1099 added 4 commits December 2, 2024 15:44

Add PDM to pyinstaller and add build helper

dbc2c29

Replaced poetry with PDM in pyinstaller.py Added build helper script Added PDM fail check in helper scripts

Revert Nix file movement

41b3ec5

As shymega pointed out it breaks stuff on nix. I would still like the files to be in a subfolder but im not a nix guy. So shymega hopfully can fugure something out. But for now i will revert that.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP - DO NOT USE] Pythonic and simpler refactor of `wemod-launcher` #138

[WIP - DO NOT USE] Pythonic and simpler refactor of `wemod-launcher` #138

shymega commented Nov 17, 2024

marvin1099 commented Dec 2, 2024

shymega commented Dec 7, 2024

marvin1099 commented Dec 7, 2024

marvin1099 commented Dec 21, 2024

Marakai commented Jan 13, 2025

marvin1099 commented Jan 13, 2025

shymega commented Jan 13, 2025 via email

shymega commented Jan 13, 2025

Marakai commented Jan 14, 2025

marvin1099 commented Jan 15, 2025

[WIP - DO NOT USE] Pythonic and simpler refactor of wemod-launcher #138

Are you sure you want to change the base?

[WIP - DO NOT USE] Pythonic and simpler refactor of wemod-launcher #138

Conversation

shymega commented Nov 17, 2024

marvin1099 commented Dec 2, 2024

shymega commented Dec 7, 2024

marvin1099 commented Dec 7, 2024

marvin1099 commented Dec 21, 2024

Marakai commented Jan 13, 2025

marvin1099 commented Jan 13, 2025

shymega commented Jan 13, 2025 via email

shymega commented Jan 13, 2025

Marakai commented Jan 14, 2025

marvin1099 commented Jan 15, 2025

[WIP - DO NOT USE] Pythonic and simpler refactor of `wemod-launcher` #138

[WIP - DO NOT USE] Pythonic and simpler refactor of `wemod-launcher` #138