Created dso rename command #41
Conversation
|
|
I would like to discuss if it would be of interest to automatically stash those changes for all git tracked files as well. |
| """Rename an existing stage or folder and update files accordingly.""" | ||
| if old_name is None: | ||
| old_name = Prompt.ask("[bold]Please enter the directory name of the stage or folder that shall be renamed") | ||
| if new_name is None: | ||
| new_name = Prompt.ask("[bold]Please enter the new stage or folder name") | ||
| project_root = get_project_root(Path(getcwd())) | ||
| old_path = project_root / old_name | ||
| new_path = project_root / new_name |
There was a problem hiding this comment.
This is all relative to the project root now. I would find it more intuitive if it was relative to the CWD, because or basically any shell tool works like that.
| updated_content = content.replace(old_name, new_name) | ||
| file_path.write_text(updated_content) | ||
| except Exception as e: | ||
| log.error(f"[red]Failed to update {file_path}: {e}") |
There was a problem hiding this comment.
Do you want to continue in such a case or stop the program? It seems weird that there are first failures and then the main function prints out Renamed xxx successfully.
An option would be to count errors and return the error count / list of errors and react in the main function accordingly.
| content = file_path.read_text() | ||
| updated_content = content.replace(old_name, new_name) | ||
| file_path.write_text(updated_content) | ||
| except Exception as e: |
There was a problem hiding this comment.
It's bad practice in general to catch Exception because it also contains exceptions you don't want to catch (e.g. KeyboardInterrupt. A good candidate here could be OSError.
|
|
||
| def update_references(project_root: Path, old_name: str, new_name: str): | ||
| """Update all references to the old name in the specified project files.""" | ||
| for file_path in project_root.rglob("*"): |
There was a problem hiding this comment.
Do we really want to update the entire project? it might be more cautious to just change things within the affected stage, at the risk that we miss something.
Consider e.g. this directory structure and renaming RNAseq/01_preprocessing to RNAseq/02_preprocessing
.
├── RNAseq
│ └── 01_preprocessing
└── TSO500
└── 01_preprocessing
or renaming 01_taskA to 01_taskB.
.
├── 01_taskA
└── 01_taskA_followup
There was a problem hiding this comment.
For case (2) it could help to regex match on a "whole word", but this doesn't save you in case (1).
| sys.exit(1) | ||
|
|
||
| old_path.rename(new_path) | ||
| update_references(project_root, old_name, new_name) |
There was a problem hiding this comment.
I think this function should additionally take care of renaming files within a stage, e.g. src/01_stage_name.qmd into src/new_stage_name.qmd. Basically any file within a stage directory that's called {stage_name}.*.
This is the first draft of a dso rename command. It takes a stage / folder name into account and renames it. It also renames files accordingly.
Still missing
dsorename does not pop up -> However,dso renameworks as expected