#!/usr/bin/env python

import argparse
import os
import re
import sys

import readchar

BOLD = "\033[1m"
NORMAL = "\033[0m"
UNDERLINE = "\033[4m"
PURPLE = "\033[95m"
CYAN = "\033[96m"
DARKCYAN = "\033[36m"
BLUE = "\033[94m"
GREEN = "\033[92m"


def _token_to_str(token):
    if isinstance(token, str):
        return token
    else:
        return token.group(0)


def _matched_portion(match):
    a, b, c = match.group(2, 3, 4)
    return a or b or c


def color(text, color_code):
    return "%s%s%s" % (color_code, text, NORMAL)


def highlighted(line_tokens, match_idx, group):

    match = line_tokens[match_idx]
    display_of_match = (
        BOLD
        + color(
            match.group(0).replace(
                _matched_portion(match), color(_matched_portion(match), CYAN)
            ),
            PURPLE,
        )
        + NORMAL
    )

    return (
        "".join(_token_to_str(tok) for tok in line_tokens[0:match_idx])
        + display_of_match
        + "".join(_token_to_str(tok) for tok in line_tokens[match_idx + 1 :])
    )


def prompt(
    fname,
    state,
    lines,
    linenum,
    line_tokens,
    token_idx,
    rec,
    replacements,
    app_state,
):
    """Present the prompt screen for a single token in a line in a file and
    receive user input.

    handle_line() calls this function repeated times for a given token
    in a loop until the user command indicates we are done working with
    this particular token.

    """

    if app_state.get("do_prompt", True) and rec.get("do_prompt", True):
        context_lines = 12
        print("\033c")
        print(
            "-----------------------------------------------------------------"
        )
        print(UNDERLINE + fname + NORMAL)
        print("")
        for index in range(
            linenum - context_lines // 2, linenum + context_lines // 2
        ):
            if index >= 0 and index <= len(lines):
                if index == linenum:
                    content = highlighted(line_tokens, token_idx, 0).rstrip()
                else:
                    content = lines[index].rstrip()
                print("%4.d: %s" % (index + 1, content))
        print(
            "-----------------------------------------------------------------"
        )

        print(
            "EXISTING SYMBOL TO REPLACE: %s"
            % color(_matched_portion(line_tokens[token_idx]), CYAN)
        )
        print(
            "REPLACEMENTS: %s"
            % " ".join(
                "[%d] %s" % (num, text)
                for num, text in enumerate(replacements, 1)
            )
        )
        print(
            "-----------------------------------------------------------------"
        )

        sys.stdout.write(
            "[s]kip  skip [a]ll of these   skip [f]ile  "
            "[w]rite file and go to next  \n"
            "[A]pply all current non-ambiguous replacements from state\n"
            "[F]inish all files with current "
            "instructions "
            "[e]nter new replacement  \n"
            "[u]se numbered replacement for all "
            "future occurrences [p]db  [q]uit  [s]? "
        )
        sys.stdout.flush()
        cmd = readchar.readchar()
        print("")
        if ord(cmd) in (10, 13):
            cmd = "s"
    else:
        if "apply_all" in rec:
            return rec["apply_all"]
        else:
            return "s"

    if cmd == "q":
        sys.exit()
    elif cmd == "A":
        for rec in state.values():
            if len(rec["replacements"]) == 1 and "apply_all" not in rec:
                rec["apply_all"] = 0
                rec["do_prompt"] = False
        return True
    elif cmd == "F":
        app_state["do_prompt"] = False
        return "s"
    elif cmd in ("s", "f", "a", "w"):
        return cmd
    elif cmd == "p":
        import pdb

        pdb.set_trace()
    elif cmd == "e":
        replacement_text = input(
            "Enter replacement text for the portion in "
            + CYAN
            + "CYAN"
            + NORMAL
            + ": "
        ).strip()
        replacements.append(replacement_text)
        return True
    elif cmd == "u" or re.match(r"\d+", cmd):

        if cmd == "u":
            num = input("Enter number of replacement: ")
            if re.match(r"\d+", num):
                replacement_index = int(num)
            else:
                input("not a number: %s, press enter" % num)
        else:
            replacement_index = int(cmd)

        try:
            replacements[replacement_index - 1]
        except IndexError:
            input(
                "no such replacement %d; press enter to continue"
                % replacement_index
            )
        else:
            if cmd == "u":
                rec["apply_all"] = replacement_index - 1
                rec["do_prompt"] = False
            return replacement_index - 1


# reg = re.compile(r"\:(class|attr|func|meth|obj|paramref)\:`~?(\.\w+).*?`")

# reg = re.compile(r"\:(class|attr|func|meth|obj|paramref)\:`~?([\.a-z]+)`")

# one token alone, to the end, we want the whole thing
#     :func:`.foo`
#     :class:`.Foo`
#
# two tokens, we want the first
#
#   :func:`.foo.bar`
#   :meth:`.Foo.bar`
#
# three tokens, we want the first two.
#
#   :func:`.sql.expression.select`
#
#

reg = re.compile(
    r"\:(class|attr|func|meth|obj|paramref)\:"
    r"`~?(?:(\.\w+)|(?:(\.\w+)\.\w+)|(?:(\.[a-z]+\.[a-z]+)\.\w+))(?:\(\))?`"
)


def tokenize_line(app_state, line):
    """Search a line for py references.

    Return the line as as list of tokens, with non matched portions
    and matched portions together, using Match objects for the matches
    and plain strings for the non matched.

    max_missing_package_tokens indicates which xrefs we will prompt
    for, based on how many package tokens are not present.  zero means
    only xrefs that are straight class, class + method, function etc.
    with no package qualification at all.

    """

    search_reg = app_state["opts"].search
    tokens = []
    start = -1
    mend = 0
    has_tokens = False
    for match in reg.finditer(line):

        if search_reg and not re.match(search_reg, match.group(0)):
            continue

        has_tokens = True
        mstart, mend = match.span(0)
        if start == -1:
            start = 0

        # extend w/ non match tokens.  keep commas and periods
        # as separate tokens so that they don't get linebroken.
        tokens.extend(re.split(r"([.,])", line[start:mstart]))

        tokens.append(match)

        start = mend
    tokens.extend(re.split(r"([.,])", line[mend:]))

    if has_tokens:
        return tokens
    else:
        return None


def process(fname, state, app_state):
    """Parse, process, and write a single file.

    Creates a list of lines and then passes each one off to handle_line().
    handle_line() then has the option to replace that line in the list
    of lines.   The list of lines is then rejoined to write out the new file.

    """

    write = False
    with open(fname) as file_:
        lines = list(file_)

    result = None
    for linenum, line in enumerate(lines):
        result = handle_line(fname, state, lines, linenum, line, app_state)
        if result == "f":  # skipfile
            return
        elif result == "w":  # write and finish
            write = True
            break
        elif result == "c":  # has changes but keep going
            write = True
    if write:
        sys.stdout.write("Writing %s..\n" % fname)
        sys.stdout.flush()
        with open(fname, "w") as file_:
            file_.write("".join(lines))

    return result


def handle_line(fname, state, lines, linenum, line, app_state):
    """Parse, process and replace a single line in a list of lines."""

    # skip comments
    if re.match(r"^ *#", line):
        return "n"

    # skip function decorators that are inline, these are too hard
    elif re.match(r"^ *@", line):
        return "n"

    # skip keyword arguments that are also too hard to format
    elif re.match(r"^ *\w+ *= *", line):
        return "n"

    line_tokens = tokenize_line(app_state, line)

    if not line_tokens:
        return "n"

    has_replacements = False

    for idx, token in enumerate(line_tokens):
        if isinstance(token, str):
            continue

        if _matched_portion(token) not in state:
            rec = state[_matched_portion(token)] = {
                "replacements": [],
                "cmd": None,
            }
        else:
            rec = state[_matched_portion(token)]

        if rec.get("cmd") == "a":
            # skip all of these, don't do prompt
            result = "s"
        else:
            # do prompt
            local_replacements = list(rec["replacements"])

            while True:
                result = prompt(
                    fname,
                    state,
                    lines,
                    linenum,
                    line_tokens,
                    idx,
                    rec,
                    local_replacements,
                    app_state,
                )
                if result is True:
                    continue
                else:
                    break

        if result in ("f", "w"):
            return result  # skipfile
        elif result == "s":
            continue  # skip this token
        elif result == "a":
            rec["cmd"] = "a"  # skip all of these
            continue
        elif result == "F":
            # continue without prompting
            continue

        elif isinstance(result, int):
            replacement_text = local_replacements[result]
            if replacement_text not in rec["replacements"]:
                rec["replacements"].append(replacement_text)
                write_replacement_rec(
                    app_state["fixes_file"],
                    _matched_portion(token),
                    replacement_text,
                )
            has_replacements = True
            line_tokens[idx] = (
                token.group(0)
                .replace(_matched_portion(token), replacement_text)
                .replace("~", "")
            )

    if has_replacements:

        if fname.endswith(".py"):

            # reformatting lines for max line length is VERY hard.  Give
            # ourselves a break by not enforcing it for .rst files right now.
            # python is hard enough.  still rst docstrings in the py files
            # though
            reformat_py_line(lines, linenum, line_tokens)
        else:
            reformat_rst_line(lines, linenum, line_tokens)
        return "c"


def reformat_rst_line(lines, linenum, line_tokens):
    newline = "".join(_token_to_str(token) for token in line_tokens)

    if linenum == len(lines) - 1:
        subsequent_line = None
    else:
        subsequent_line = lines[linenum + 1]

    # find an rst underline and rewrite it to be the same length
    # as the new line
    if subsequent_line and subsequent_line[0] in ("=-~^"):
        underline_token = subsequent_line[0]
        if subsequent_line.strip() == underline_token * len(
            subsequent_line.strip()
        ):
            lines[linenum + 1] = underline_token * len(newline)

    lines[linenum] = newline


def reformat_py_line(lines, linenum, line_tokens, length=79):
    """Given line tokens where one or more of the tokens has been replaced,
    write out a new line, while ensuring that the max length is maintained.

    When the resulting line would be longer than the length, the line is
    split at that point.    Heuristics are used to determine what the
    left-leading indentation should be, as well as if individual lines
    have quotes on both sides.

    """
    if linenum == len(lines) - 1:
        subsequent_line = None
    else:
        subsequent_line = lines[linenum + 1]

    line_tokens = [_token_to_str(token) for token in line_tokens]
    printed_line = "".join(line_tokens)
    if len(printed_line) <= length:
        lines[linenum] = printed_line
        return

    quote_char = ""
    stripped = printed_line.strip()
    lq = re.match(r'^("""|"|\'|\'' ")", stripped)
    rq = re.match(r'.*?("""|"|\'|\'' ")(,)?$", stripped)

    if lq and rq and lq.group(1) == rq.group(1):
        quote_char = lq.group(1)
    else:
        quote_char = ""

    # figure out current line whitespace. looking for zero or more whitespace,
    # then optional markup that suggests the next line needs to be futher
    # indented, such as numbering, bullet, :return:, :param: or "..
    # rstdirective" of some kind
    whitespace_match = re.match(
        r"^( *)(\d+[\:\.] |\* |\:param .+?\:|\:return\:|\.\. \w+)?",
        printed_line,
    )
    if whitespace_match:
        whitespace = whitespace_match.group(1) + (
            " " * len(whitespace_match.group(2) or "")
        )
    else:
        whitespace = ""

    # if it looks like we're a bullet or a paramref or something, see if
    # we can get the indentation from the next line.
    if (
        whitespace_match
        and not quote_char
        and subsequent_line.strip()
        and whitespace_match.group(2)
    ):
        # make sure we match :param <name>: and not
        # :paramref: that happens to be inline :)
        subsq_whitespace_match = re.match(
            r"^( +)(\d+\: |\* |\:param .+?\:)?", subsequent_line
        )

        # if we have the next line, anb it does not look like it is
        # itself a bullet or param, and it has indentation that is the
        # same or greater than ours, we will use that indentation.
        if (
            subsq_whitespace_match
            and not subsq_whitespace_match.group(2)
            and len(subsq_whitespace_match.group(0))
            >= len(whitespace_match.group(1))
        ):
            whitespace = subsq_whitespace_match.group(1)

    len_ = 0

    for idx, token in enumerate(line_tokens):

        len_ += len(token)
        if len_ >= length:
            len_ = 0

            if idx > 0:
                line_tokens[idx - 1] = (
                    line_tokens[idx - 1].rstrip()
                    + (" " if quote_char else "")
                    + quote_char
                )
            if token.strip() != quote_char:
                token = "\n" + whitespace + quote_char + token.lstrip()
            else:
                token = "\n"
        line_tokens[idx] = token

    newline = "".join(line_tokens)
    lines[linenum] = newline


def restore_state_file(state_file_name):
    """Read the state file if any and restore existing replacement tokens
    that were established from a previous run.

    """
    state = {}
    if not os.path.exists(state_file_name):
        return state

    with open(state_file_name, "r") as file_:
        for line in file_:
            old, new = line.strip().split(" ", 1)
            if old not in state:
                state[old] = rec = {
                    "replacements": [],
                    "cmd": None,
                }
            else:
                rec = state[old]

            if new not in rec["replacements"]:
                rec["replacements"].append(new)

    return state


def write_replacement_rec(state_file_name, old, new):
    """Write a single replacement token to the state file."""
    with open(state_file_name, "a") as file_:
        file_.write("%s %s\n" % (old, new))


def main(argv=None):
    parser = argparse.ArgumentParser()
    parser.add_argument("filespec", help="file or directory", nargs="+")
    parser.add_argument(
        "-f",
        "--fixes-file",
        help="path to the current list of fixes",
        default="fix_xref_state.txt",
    )
    parser.add_argument(
        "--search", help="only work with symbols matching this regexp"
    )
    args = parser.parse_args()

    state = restore_state_file(args.fixes_file)
    app_state = {"opts": args, "symbols": state, "fixes_file": args.fixes_file}

    for filespec in args.filespec:
        file_ = os.path.abspath(filespec)
        if os.path.isdir(file_):
            for root, dirs, files in os.walk(file_):
                for fname in files:
                    if not fname.endswith(".py") and not fname.endswith(
                        ".rst"
                    ):
                        continue
                    process(os.path.join(root, fname), state, app_state)
        else:
            process(file_, state, app_state)


if __name__ == "__main__":
    main()

#!/usr/bin/env python

import argparse
import os
import re
import sys

import readchar

BOLD = "\033[1m"
NORMAL = "\033[0m"
UNDERLINE = "\033[4m"
PURPLE = "\033[95m"
CYAN = "\033[96m"
DARKCYAN = "\033[36m"
BLUE = "\033[94m"
GREEN = "\033[92m"


def _token_to_str(token):
    if isinstance(token, str):
        return token
    else:
        return token.group(0)


def _matched_portion(match):
    a, b, c = match.group(2, 3, 4)
    return a or b or c


def color(text, color_code):
    return "%s%s%s" % (color_code, text, NORMAL)


def highlighted(line_tokens, match_idx, group):

    match = line_tokens[match_idx]
    display_of_match = (
        BOLD
        + color(
            match.group(0).replace(
                _matched_portion(match), color(_matched_portion(match), CYAN)
            ),
            PURPLE,
        )
        + NORMAL
    )

    return (
        "".join(_token_to_str(tok) for tok in line_tokens[0:match_idx])
        + display_of_match
        + "".join(_token_to_str(tok) for tok in line_tokens[match_idx + 1 :])
    )


def prompt(
    fname,
    state,
    lines,
    linenum,
    line_tokens,
    token_idx,
    rec,
    replacements,
    app_state,
):
    """Present the prompt screen for a single token in a line in a file and
    receive user input.

    handle_line() calls this function repeated times for a given token
    in a loop until the user command indicates we are done working with
    this particular token.

    """

    if app_state.get("do_prompt", True) and rec.get("do_prompt", True):
        context_lines = 12
        print("\033c")
        print(
            "-----------------------------------------------------------------"
        )
        print(UNDERLINE + fname + NORMAL)
        print("")
        for index in range(
            linenum - context_lines // 2, linenum + context_lines // 2
        ):
            if index >= 0 and index <= len(lines):
                if index == linenum:
                    content = highlighted(line_tokens, token_idx, 0).rstrip()
                else:
                    content = lines[index].rstrip()
                print("%4.d: %s" % (index + 1, content))
        print(
            "-----------------------------------------------------------------"
        )

        print(
            "EXISTING SYMBOL TO REPLACE: %s"
            % color(_matched_portion(line_tokens[token_idx]), CYAN)
        )
        print(
            "REPLACEMENTS: %s"
            % " ".join(
                "[%d] %s" % (num, text)
                for num, text in enumerate(replacements, 1)
            )
        )
        print(
            "-----------------------------------------------------------------"
        )

        sys.stdout.write(
            "[s]kip  skip [a]ll of these   skip [f]ile  "
            "[w]rite file and go to next  \n"
            "[A]pply all current non-ambiguous replacements from state\n"
            "[F]inish all files with current "
            "instructions "
            "[e]nter new replacement  \n"
            "[u]se numbered replacement for all "
            "future occurrences [p]db  [q]uit  [s]? "
        )
        sys.stdout.flush()
        cmd = readchar.readchar()
        print("")
        if ord(cmd) in (10, 13):
            cmd = "s"
    else:
        if "apply_all" in rec:
            return rec["apply_all"]
        else:
            return "s"

    if cmd == "q":
        sys.exit()
    elif cmd == "A":
        for rec in state.values():
            if len(rec["replacements"]) == 1 and "apply_all" not in rec:
                rec["apply_all"] = 0
                rec["do_prompt"] = False
        return True
    elif cmd == "F":
        app_state["do_prompt"] = False
        return "s"
    elif cmd in ("s", "f", "a", "w"):
        return cmd
    elif cmd == "p":
        import pdb

        pdb.set_trace()
    elif cmd == "e":
        replacement_text = input(
            "Enter replacement text for the portion in "
            + CYAN
            + "CYAN"
            + NORMAL
            + ": "
        ).strip()
        replacements.append(replacement_text)
        return True
    elif cmd == "u" or re.match(r"\d+", cmd):

        if cmd == "u":
            num = input("Enter number of replacement: ")
            if re.match(r"\d+", num):
                replacement_index = int(num)
            else:
                input("not a number: %s, press enter" % num)
        else:
            replacement_index = int(cmd)

        try:
            replacements[replacement_index - 1]
        except IndexError:
            input(
                "no such replacement %d; press enter to continue"
                % replacement_index
            )
        else:
            if cmd == "u":
                rec["apply_all"] = replacement_index - 1
                rec["do_prompt"] = False
            return replacement_index - 1


# reg = re.compile(r"\:(class|attr|func|meth|obj|paramref)\:`~?(\.\w+).*?`")

# reg = re.compile(r"\:(class|attr|func|meth|obj|paramref)\:`~?([\.a-z]+)`")

# one token alone, to the end, we want the whole thing
#     :func:`.foo`
#     :class:`.Foo`
#
# two tokens, we want the first
#
#   :func:`.foo.bar`
#   :meth:`.Foo.bar`
#
# three tokens, we want the first two.
#
#   :func:`.sql.expression.select`
#
#

reg = re.compile(
    r"\:(class|attr|func|meth|obj|paramref)\:"
    r"`~?(?:(\.\w+)|(?:(\.\w+)\.\w+)|(?:(\.[a-z]+\.[a-z]+)\.\w+))(?:\(\))?`"
)


def tokenize_line(app_state, line):
    """Search a line for py references.

    Return the line as as list of tokens, with non matched portions
    and matched portions together, using Match objects for the matches
    and plain strings for the non matched.

    max_missing_package_tokens indicates which xrefs we will prompt
    for, based on how many package tokens are not present.  zero means
    only xrefs that are straight class, class + method, function etc.
    with no package qualification at all.

    """

    search_reg = app_state["opts"].search
    tokens = []
    start = -1
    mend = 0
    has_tokens = False
    for match in reg.finditer(line):

        if search_reg and not re.match(search_reg, match.group(0)):
            continue

        has_tokens = True
        mstart, mend = match.span(0)
        if start == -1:
            start = 0

        # extend w/ non match tokens.  keep commas and periods
        # as separate tokens so that they don't get linebroken.
        tokens.extend(re.split(r"([.,])", line[start:mstart]))

        tokens.append(match)

        start = mend
    tokens.extend(re.split(r"([.,])", line[mend:]))

    if has_tokens:
        return tokens
    else:
        return None


def process(fname, state, app_state):
    """Parse, process, and write a single file.

    Creates a list of lines and then passes each one off to handle_line().
    handle_line() then has the option to replace that line in the list
    of lines.   The list of lines is then rejoined to write out the new file.

    """

    write = False
    with open(fname) as file_:
        lines = list(file_)

    result = None
    for linenum, line in enumerate(lines):
        result = handle_line(fname, state, lines, linenum, line, app_state)
        if result == "f":  # skipfile
            return
        elif result == "w":  # write and finish
            write = True
            break
        elif result == "c":  # has changes but keep going
            write = True
    if write:
        sys.stdout.write("Writing %s..\n" % fname)
        sys.stdout.flush()
        with open(fname, "w") as file_:
            file_.write("".join(lines))

    return result


def handle_line(fname, state, lines, linenum, line, app_state):
    """Parse, process and replace a single line in a list of lines."""

    # skip comments
    if re.match(r"^ *#", line):
        return "n"

    # skip function decorators that are inline, these are too hard
    elif re.match(r"^ *@", line):
        return "n"

    # skip keyword arguments that are also too hard to format
    elif re.match(r"^ *\w+ *= *", line):
        return "n"

    line_tokens = tokenize_line(app_state, line)

    if not line_tokens:
        return "n"

    has_replacements = False

    for idx, token in enumerate(line_tokens):
        if isinstance(token, str):
            continue

        if _matched_portion(token) not in state:
            rec = state[_matched_portion(token)] = {
                "replacements": [],
                "cmd": None,
            }
        else:
            rec = state[_matched_portion(token)]

        if rec.get("cmd") == "a":
            # skip all of these, don't do prompt
            result = "s"
        else:
            # do prompt
            local_replacements = list(rec["replacements"])

            while True:
                result = prompt(
                    fname,
                    state,
                    lines,
                    linenum,
                    line_tokens,
                    idx,
                    rec,
                    local_replacements,
                    app_state,
                )
                if result is True:
                    continue
                else:
                    break

        if result in ("f", "w"):
            return result  # skipfile
        elif result == "s":
            continue  # skip this token
        elif result == "a":
            rec["cmd"] = "a"  # skip all of these
            continue
        elif result == "F":
            # continue without prompting
            continue

        elif isinstance(result, int):
            replacement_text = local_replacements[result]
            if replacement_text not in rec["replacements"]:
                rec["replacements"].append(replacement_text)
                write_replacement_rec(
                    app_state["fixes_file"],
                    _matched_portion(token),
                    replacement_text,
                )
            has_replacements = True
            line_tokens[idx] = (
                token.group(0)
                .replace(_matched_portion(token), replacement_text)
                .replace("~", "")
            )

    if has_replacements:

        if fname.endswith(".py"):

            # reformatting lines for max line length is VERY hard.  Give
            # ourselves a break by not enforcing it for .rst files right now.
            # python is hard enough.  still rst docstrings in the py files
            # though
            reformat_py_line(lines, linenum, line_tokens)
        else:
            reformat_rst_line(lines, linenum, line_tokens)
        return "c"


def reformat_rst_line(lines, linenum, line_tokens):
    newline = "".join(_token_to_str(token) for token in line_tokens)

    if linenum == len(lines) - 1:
        subsequent_line = None
    else:
        subsequent_line = lines[linenum + 1]

    # find an rst underline and rewrite it to be the same length
    # as the new line
    if subsequent_line and subsequent_line[0] in ("=-~^"):
        underline_token = subsequent_line[0]
        if subsequent_line.strip() == underline_token * len(
            subsequent_line.strip()
        ):
            lines[linenum + 1] = underline_token * len(newline)

    lines[linenum] = newline


def reformat_py_line(lines, linenum, line_tokens, length=79):
    """Given line tokens where one or more of the tokens has been replaced,
    write out a new line, while ensuring that the max length is maintained.

    When the resulting line would be longer than the length, the line is
    split at that point.    Heuristics are used to determine what the
    left-leading indentation should be, as well as if individual lines
    have quotes on both sides.

    """
    if linenum == len(lines) - 1:
        subsequent_line = None
    else:
        subsequent_line = lines[linenum + 1]

    line_tokens = [_token_to_str(token) for token in line_tokens]
    printed_line = "".join(line_tokens)
    if len(printed_line) <= length:
        lines[linenum] = printed_line
        return

    quote_char = ""
    stripped = printed_line.strip()
    lq = re.match(r'^("""|"|\'|\'' ")", stripped)
    rq = re.match(r'.*?("""|"|\'|\'' ")(,)?$", stripped)

    if lq and rq and lq.group(1) == rq.group(1):
        quote_char = lq.group(1)
    else:
        quote_char = ""

    # figure out current line whitespace. looking for zero or more whitespace,
    # then optional markup that suggests the next line needs to be futher
    # indented, such as numbering, bullet, :return:, :param: or "..
    # rstdirective" of some kind
    whitespace_match = re.match(
        r"^( *)(\d+[\:\.] |\* |\:param .+?\:|\:return\:|\.\. \w+)?",
        printed_line,
    )
    if whitespace_match:
        whitespace = whitespace_match.group(1) + (
            " " * len(whitespace_match.group(2) or "")
        )
    else:
        whitespace = ""

    # if it looks like we're a bullet or a paramref or something, see if
    # we can get the indentation from the next line.
    if (
        whitespace_match
        and not quote_char
        and subsequent_line.strip()
        and whitespace_match.group(2)
    ):
        # make sure we match :param <name>: and not
        # :paramref: that happens to be inline :)
        subsq_whitespace_match = re.match(
            r"^( +)(\d+\: |\* |\:param .+?\:)?", subsequent_line
        )

        # if we have the next line, anb it does not look like it is
        # itself a bullet or param, and it has indentation that is the
        # same or greater than ours, we will use that indentation.
        if (
            subsq_whitespace_match
            and not subsq_whitespace_match.group(2)
            and len(subsq_whitespace_match.group(0))
            >= len(whitespace_match.group(1))
        ):
            whitespace = subsq_whitespace_match.group(1)

    len_ = 0

    for idx, token in enumerate(line_tokens):

        len_ += len(token)
        if len_ >= length:
            len_ = 0

            if idx > 0:
                line_tokens[idx - 1] = (
                    line_tokens[idx - 1].rstrip()
                    + (" " if quote_char else "")
                    + quote_char
                )
            if token.strip() != quote_char:
                token = "\n" + whitespace + quote_char + token.lstrip()
            else:
                token = "\n"
        line_tokens[idx] = token

    newline = "".join(line_tokens)
    lines[linenum] = newline


def restore_state_file(state_file_name):
    """Read the state file if any and restore existing replacement tokens
    that were established from a previous run.

    """
    state = {}
    if not os.path.exists(state_file_name):
        return state

    with open(state_file_name, "r") as file_:
        for line in file_:
            old, new = line.strip().split(" ", 1)
            if old not in state:
                state[old] = rec = {
                    "replacements": [],
                    "cmd": None,
                }
            else:
                rec = state[old]

            if new not in rec["replacements"]:
                rec["replacements"].append(new)

    return state


def write_replacement_rec(state_file_name, old, new):
    """Write a single replacement token to the state file."""
    with open(state_file_name, "a") as file_:
        file_.write("%s %s\n" % (old, new))


def main(argv=None):
    parser = argparse.ArgumentParser()
    parser.add_argument("filespec", help="file or directory", nargs="+")
    parser.add_argument(
        "-f",
        "--fixes-file",
        help="path to the current list of fixes",
        default="fix_xref_state.txt",
    )
    parser.add_argument(
        "--search", help="only work with symbols matching this regexp"
    )
    args = parser.parse_args()

    state = restore_state_file(args.fixes_file)
    app_state = {"opts": args, "symbols": state, "fixes_file": args.fixes_file}

    for filespec in args.filespec:
        file_ = os.path.abspath(filespec)
        if os.path.isdir(file_):
            for root, dirs, files in os.walk(file_):
                for fname in files:
                    if not fname.endswith(".py") and not fname.endswith(
                        ".rst"
                    ):
                        continue
                    process(os.path.join(root, fname), state, app_state)
        else:
            process(file_, state, app_state)


if __name__ == "__main__":
    main()

#!/usr/bin/env python Present the prompt screen for a single token in a line in a file and     receive user input.      handle_line() calls this function repeated times for a given token     in a loop until the user command indicates we are done working with     this particular token. # reg = re.compile(r"\:(class|attr|func|meth|obj|paramref)\:`~?(\.\w+).*?`") # reg = re.compile(r"\:(class|attr|func|meth|obj|paramref)\:`~?([\.a-z]+)`") # one token alone, to the end, we want the whole thing #     :func:`.foo` #     :class:`.Foo` # # two tokens, we want the first # #   :func:`.foo.bar` #   :meth:`.Foo.bar` # # three tokens, we want the first two. # #   :func:`.sql.expression.select` # # Search a line for py references.      Return the line as as list of tokens, with non matched portions     and matched portions together, using Match objects for the matches     and plain strings for the non matched.      max_missing_package_tokens indicates which xrefs we will prompt     for, based on how many package tokens are not present.  zero means     only xrefs that are straight class, class + method, function etc.     with no package qualification at all. # extend w/ non match tokens.  keep commas and periods # as separate tokens so that they don't get linebroken. Parse, process, and write a single file.      Creates a list of lines and then passes each one off to handle_line().     handle_line() then has the option to replace that line in the list     of lines.   The list of lines is then rejoined to write out the new file. # skipfile # write and finish # has changes but keep going Parse, process and replace a single line in a list of lines. # skip comments #", line): # skip function decorators that are inline, these are too hard # skip keyword arguments that are also too hard to format # skip all of these, don't do prompt # do prompt # skipfile # skip this token # skip all of these # continue without prompting # reformatting lines for max line length is VERY hard.  Give # ourselves a break by not enforcing it for .rst files right now. # python is hard enough.  still rst docstrings in the py files # though # find an rst underline and rewrite it to be the same length # as the new line Given line tokens where one or more of the tokens has been replaced,     write out a new line, while ensuring that the max length is maintained.      When the resulting line would be longer than the length, the line is     split at that point.    Heuristics are used to determine what the     left-leading indentation should be, as well as if individual lines     have quotes on both sides. |"|\'|\'' ")", stripped)     rq = re.match(r'.*?( # figure out current line whitespace. looking for zero or more whitespace, # then optional markup that suggests the next line needs to be futher # indented, such as numbering, bullet, :return:, :param: or ".. # rstdirective" of some kind # if it looks like we're a bullet or a paramref or something, see if # we can get the indentation from the next line. # make sure we match :param <name>: and not # :paramref: that happens to be inline :) # if we have the next line, anb it does not look like it is # itself a bullet or param, and it has indentation that is the # same or greater than ours, we will use that indentation. Read the state file if any and restore existing replacement tokens     that were established from a previous run. Write a single replacement token to the state file.