Fix comment formatting for slurm/pbs cluster directives. #960
Conversation
Update make_comment logic to ignore #SBATCH and #PBS comment directives, akin to existing logic for sphinx comment directives. Workaround for issue in which '# fmt: off' directives do not affect comment reformatting. Additionally, '#PBS' directives *must* occur immediately after shebang lines, preventing the use of '# fmt: off'.
|
Friendly ping. @JelleZijlstra @zsol, would you mind commenting on this PR? |
|
I don't feel strongly about this. On the one hand it's a pretty simple change, on the other hand it seems inelegant to hardcode support for ever more kinds of obscure pragma syntax. |
|
I agree that it's both simple and inelegant. My knee-jerk reaction here would be... configuration option, but that seems clearly clearly non-black-ish. Hard-coding a special case list here feels weird, though I firmly believe that black should do-the-right-thing somehow in this case. Hopefully this falls under "practicality beats purity", but is there anything I can do in the patch to help smooth your concern? More clearly demarcate the special case list? Add documentation? I've tried to find other pragma with the strict |
|
@JelleZijlstra I now recognize your point on comment pragma. 🙏 While the case in #1014 doesn't exactly fall under this feature I think adding a special case here opens up a significant slippery slope. I've open a meta-issue in #1024. |
This change slightly updates black's comment formatting logic for a non-PEP8 edge case frequently encountered in HPC batch schedulers.
These tools use block comments that immediately follow the
#!header to provide default configuration parameters for a batch scheduler of the form#SBATCHor#PBSand, unfortunately, don't support a pep8 compatible# SBATCHor# PBSsyntax.This change special cases comments beginning with these directives, as there isn't a clear way to resolve these requirements within black's existing syntax. As the directive must follow the shebang,
# fmt: offescape hatches aren't a viable solution and (interestingly) don't prevent block comment reformatting in black's current implementation.Though this is a low-usage edge case, I hope the precedent from #68 will apply.