Formatter instability: lines after comment at module level

[charliermarsh]

Given:

import random;

# Defaults for arguments are defined here
# args.threshold = None;


logger = logging.getLogger("FastProject");

We're reformatting as:

# -*- coding: utf-8 -*-
import random

# Defaults for arguments are defined here
# args.threshold = None;


logger = logging.getLogger("FastProject")

Formatted twice:

import random

# Defaults for arguments are defined here
# args.threshold = None;

logger = logging.getLogger("FastProject")

--- Formatted once
+++ Formatted twice
@@ -3,5 +3,4 @@
 # Defaults for arguments are defined here
 # args.threshold = None;
 
-
 logger = logging.getLogger("FastProject")

(That is: removing a newline before logger =.)

This leads to an instability.

Sourced from #7590 (A_3703355012074323529.py).

[charliermarsh]

For posterity, the original source code here (which doesn't strip the newline) is:

# -*- coding: utf-8 -*-
"""Contains information that is useful to share
across all modules.

Right now, mainly command-line arguments, logging
and resource locations.
"""
from __future__ import absolute_import, print_function, division;
import logging;
import sys
import os
import random;

# Defaults for arguments are defined here
# These are all overwritten if called from the command line
# However, by putting defaults here, it makes it easier to
#    call FastProject from within other scripts
# These should be kept in sync with arguments in __main__.py
# args = namedtuple("defalt_args",  ["data_file",  "housekeeping",
#                                    "signatures",  "precomputed",  "output",
#                                    "nofilter",  "nomodel",  "pca_filter",
#                                    "qc",  "subsample_size",
#                                    "min_signature_genes",  "projections",
#                                    "weights",  "threshold"]);
# 
# args.data_file = "";
# args.housekeeping = "";
# args.signatures = [];
# args.precomputed = [];
# args.output = "";
# args.nofilter = False;
# args.nomodel = False;
# args.pca_filter = False;
# args.qc = False;
# args.subsample_size = None;
# args.min_signature_genes = 5;
# args.projections = [];
# args.weights = "";
# args.threshold = None;


logger = logging.getLogger("FastProject");

So everything is suffixed with a semicolon.

[MichaReiser]

This seems to be fixed on main (creating a snapshot test and running our test suite passes without an instability error)

[MichaReiser]

Okay, the case with semicolons isn't fixed ;)