File: read_text.py

package info (click to toggle)
python-refurb 1.27.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,700 kB
  • sloc: python: 9,468; makefile: 40; sh: 6
file content (80 lines) | stat: -rw-r--r-- 2,204 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
from dataclasses import dataclass

from mypy.nodes import AssignmentStmt, Block, CallExpr, MemberExpr, NameExpr, StrExpr, WithStmt

from refurb.error import Error


@dataclass
class ErrorInfo(Error):
    """
    When you just want to save the contents of a file to a variable, using a
    `with` block is a bit overkill. A simpler alternative is to use pathlib's
    `read_text()` function:

    Bad:

    ```
    with open(filename) as f:
        contents = f.read()
    ```

    Good:

    ```
    contents = Path(filename).read_text()
    ```
    """

    name = "use-pathlib-read-text-read-bytes"
    code = 101
    categories = ("pathlib",)


def check(node: WithStmt, errors: list[Error]) -> None:
    match node:
        case WithStmt(
            expr=[
                CallExpr(
                    callee=NameExpr(name="open"),
                    args=args,
                    arg_names=arg_names,
                )
            ],
            target=[NameExpr(name=with_name)],
            body=Block(
                body=[
                    AssignmentStmt(
                        rvalue=CallExpr(
                            callee=MemberExpr(expr=NameExpr(name=read_name), name="read"),
                            args=[],
                        )
                    )
                ]
            ),
        ) if with_name == read_name:
            func = "read_text"
            read_text_params = ""
            with_params = ""

            for i, name in enumerate(arg_names[1:], start=1):
                if name in {None, "mode"}:
                    with_params = ", ..."

                    match args[i]:
                        case StrExpr(value=mode) if "b" in mode:
                            func = "read_bytes"

                elif name in {"encoding", "errors"}:
                    read_text_params = "..."
                    with_params = ", ..."

                else:
                    return

            errors.append(
                ErrorInfo.from_node(
                    node,
                    f"Replace `with open(x{with_params}) as f: y = f.read()` with `y = Path(x).{func}({read_text_params})`",  # noqa: E501
                )
            )