escape / don't parse square brackets in song names

[NicoWeio]

escape / don't parse square brackets in song names

Description

• Escape log records in SpotdlFormatter.format in logging.py
  • While this could be done in each log call individually, this is sufficient since console markup does not seem to be used anywhere else.
• Escape song names before passing them as progress bar descriptions

Related Issue

#1738

Motivation and Context

Previously, progress bars and log messages would “swallow” parts of song names that happened to include square brackets, so Crywolf - [when you inhale, i fill your lungs] would become Crywolf - , because rich would try to read these as console markup (like [green], for example).

How Has This Been Tested?

• GitHub Codespaces
• tested before/after with this album: widow [OBLIVIØN Pt. 1]
• Writing a test for the progress bar descriptions seems like an unreasonably hard task.

Screenshots (if appropriate)

Types of Changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• My code follows the code style of this project
• My change requires a change to the documentation
• I have updated the documentation accordingly
• I have read the CONTRIBUTING document
• I have read the CORE VALUES document (dead link)
• I have added tests to cover my changes
• All new and existing tests passed

[xnetcat]

pull changes from dev

[NicoWeio]

Oops, thanks for the heads-up, @xnetcat!

I'm not that used to writing tests, so kindly let me know if you have any suggestions for improvements.