pocketutils.tools.filesys_tools

Complexity

Total Complexity

141

Size/Duplication

Total Lines	754
Duplicated Lines	0 %

Importance

Changes

0

50 Methods

Rating	Name	Duplication	Size	Complexity
A	PathInfo.is_socket()	0	3	1
A	PathInfo.is_file()	0	3	1
A	FilesysTools.is_macos()	0	3	1
A	PathInfo.is_readable_file()	0	3	1
A	PathInfo.mod_dt()	0	9	2
B	FilesysTools.prep_dir()	0	18	6
A	FilesysTools.dt_for_filesys()	0	5	2
A	PathInfo.is_symlink()	0	3	1
A	FilesysTools.dump_error_as_dict()	0	9	2
A	FilesysTools.dump_error()	0	17	3
A	FilesysTools.tmppath()	0	12	2
A	PathInfo.is_readable_dir()	0	3	1
A	FilesysTools._expire_warning_info()	0	12	2
B	FilesysTools.open_file()	0	21	6
A	FilesysTools.delete_surefire()	0	31	4
A	PathInfo.is_char_device()	0	3	1
A	PathInfo.is_broken_symlink()	0	3	1
A	PathInfo.mod_or_create_dt()	0	10	2
A	FilesysTools._warn_expired()	0	36	4
A	FilesysTools.write_compressed_text()	0	7	1
B	FilesysTools.tmpfile()	0	17	6
A	FilesysTools.trash()	0	14	2
A	FilesysTools.tmpdir()	0	4	2
A	PathInfo.is_dir()	0	3	1
A	PathInfo.is_block_device()	0	3	1
A	PathInfo._get_dt()	0	5	2
D	FilesysTools.read_any()	0	56	12
B	FilesysTools.read_properties_file()	0	31	7
A	FilesysTools.replace_in_file()	0	10	2
A	FilesysTools.write_lines()	0	23	4
A	PathInfo.access_dt()	0	7	1
A	FilesysTools.__stat_raw()	0	8	4
A	FilesysTools.read_compressed_text()	0	7	1
A	PathInfo.is_valid_symlink()	0	3	1
A	PathInfo.is_writeable_dir()	0	3	1
B	FilesysTools.check_expired()	0	52	8
C	FilesysTools.write_properties_file()	0	31	10
A	PathInfo.is_fifo()	0	3	1
A	FilesysTools.try_cleanup()	0	11	2
A	PathInfo.exists()	0	6	1
A	FilesysTools.save_json()	0	4	2
A	FilesysTools.load_json()	0	3	1
A	FilesysTools.is_linux()	0	3	1
A	FilesysTools.prep_file()	0	12	4
B	FilesysTools.read_lines_file()	0	13	6
A	FilesysTools.hash_hex()	0	8	1
A	PathInfo.create_dt()	0	9	2
C	FilesysTools.get_info()	0	40	9
A	FilesysTools.is_windows()	0	3	1
A	PathInfo.is_writeable_file()	0	3	1

import gzip

Missing module docstring

import hashlib
import logging
import os
import pathlib
import shutil
import stat
import sys
import tempfile
from contextlib import contextmanager
from dataclasses import dataclass
from datetime import datetime, timedelta
from pathlib import Path, PurePath
from typing import (
    Any,
    Callable,
    Generator,
    Iterable,
    Mapping,
    Optional,
    Sequence,
    SupportsBytes,
    Tuple,
    Type,
    Union,
)

import numpy as np

Unable to import 'numpy'

import orjson

Unable to import 'orjson'

import pandas as pd

Unable to import 'pandas'

import regex

Unable to import 'regex'

from defusedxml import ElementTree

Unable to import 'defusedxml'

from pocketutils.core._internal import read_txt_or_gz, write_txt_or_gz

The name core does not seem to exist in module pocketutils.

from pocketutils.core.chars import Chars

The name core does not seem to exist in module pocketutils.

from pocketutils.core.exceptions import (

The name core does not seem to exist in module pocketutils.

    AlreadyUsedError,
    ContradictoryRequestError,
    DirDoesNotExistError,
    FileDoesNotExistError,
    ParsingError,
)
from pocketutils.core.input_output import OpenMode, PathLike, Writeable

The name core does not seem to exist in module pocketutils.

from pocketutils.tools.base_tools import BaseTools
from pocketutils.tools.path_tools import PathTools
from pocketutils.tools.sys_tools import SystemTools
from pocketutils.tools.unit_tools import UnitTools

logger = logging.getLogger("pocketutils")
COMPRESS_LEVEL = 9


@dataclass(frozen=True, repr=True)

Too many instance attributes (8/7)

class PathInfo:
    """
    Info about an extant or nonexistent path as it was at some time.
    Use this to avoid making repeated filesystem calls (e.g. ``.is_dir()``):
    None of the properties defined here make OS calls.

    Attributes:
        source: The original path used for lookup; may be a symlink
        resolved: The fully resolved path, or None if it does not exist
        as_of: A datetime immediately before the system calls (system timezone)
        real_stat: ``os.stat_result``, or None if the path does not exist
        link_stat: ``os.stat_result``, or None if the path is not a symlink
        has_access: Path exists and has the 'a' flag set
        has_read: Path exists and has the 'r' flag set
        has_write: Path exists and has the 'w' flag set

    All the additional properties refer to the resolved path,
    except for :meth:`is_symlink`, :meth:`is_valid_symlink`,
    and :meth:`is_broken_symlink`.
    """

    source: Path
    resolved: Optional[Path]
    as_of: datetime
    real_stat: Optional[os.stat_result]
    link_stat: Optional[os.stat_result]
    has_access: bool
    has_read: bool
    has_write: bool

    @property
    def mod_or_create_dt(self) -> Optional[datetime]:
        """
        Returns the modification or access datetime.
        Uses whichever is available: creation on Windows and modification on Unix-like.
        """
        if os.name == "nt":
            return self._get_dt("st_ctime")
        # will work on posix; on java try anyway
        return self._get_dt("st_mtime")

    @property
    def mod_dt(self) -> Optional[datetime]:
        """
        Returns the modification datetime, if known.
        Returns None on Windows or if the path does not exist.
        """
        if os.name == "nt":
            return None
        return self._get_dt("st_mtime")

    @property
    def create_dt(self) -> Optional[datetime]:
        """
        Returns the creation datetime, if known.
        Returns None on Unix-like systems or if the path does not exist.
        """
        if os.name == "posix":
            return None
        return self._get_dt("st_ctime")

    @property
    def access_dt(self) -> Optional[datetime]:
        """
        Returns the access datetime.
        *Should* never return None if the path exists, but not guaranteed.
        """
        return self._get_dt("st_atime")

    @property
    def exists(self) -> bool:
        """
        Returns whether the resolved path exists.
        """
        return self.real_stat is not None

    @property
    def is_file(self) -> bool:

Missing function or method docstring

        return self.exists and stat.S_ISREG(self.real_stat.st_mode)

    @property
    def is_dir(self) -> bool:

Missing function or method docstring

        return self.exists and stat.S_ISDIR(self.real_stat.st_mode)

    @property
    def is_readable_dir(self) -> bool:

Missing function or method docstring

        return self.is_file and self.has_access and self.has_read

    @property
    def is_writeable_dir(self) -> bool:

Missing function or method docstring

        return self.is_dir and self.has_access and self.has_write

    @property
    def is_readable_file(self) -> bool:

Missing function or method docstring

        return self.is_file and self.has_access and self.has_read

    @property
    def is_writeable_file(self) -> bool:

Missing function or method docstring

        return self.is_file and self.has_access and self.has_write

    @property
    def is_block_device(self) -> bool:

Missing function or method docstring

        return self.exists and stat.S_ISBLK(self.real_stat.st_mode)

    @property
    def is_char_device(self) -> bool:

Missing function or method docstring

        return self.exists and stat.S_ISCHR(self.real_stat.st_mode)

    @property
    def is_socket(self) -> bool:

Missing function or method docstring

        return self.exists and stat.S_ISSOCK(self.real_stat.st_mode)

    @property
    def is_fifo(self) -> bool:

Missing function or method docstring

        return self.exists and stat.S_ISFIFO(self.real_stat.st_mode)

    @property
    def is_symlink(self) -> bool:

Missing function or method docstring

        return self.link_stat is not None

    @property
    def is_valid_symlink(self) -> bool:

Missing function or method docstring

        return self.is_symlink and self.exists

    @property
    def is_broken_symlink(self) -> bool:

Missing function or method docstring

        return self.is_symlink and not self.exists

    def _get_dt(self, attr: str) -> Optional[datetime]:
        if self.real_stat is None:
            return None
        sec = getattr(self.real_stat, attr)
        return datetime.fromtimestamp(sec).astimezone()


class FilesysTools(BaseTools):

Too many public methods (28/20)

    """
    Tools for file/directory creation, etc.

    .. caution::
        Some functions may be insecure.
    """

    @classmethod
    def read_compressed_text(cls, path: PathLike) -> str:
        """
        Reads text from a text file, optionally gzipped or bz2-ed.
        Recognized suffixes for compression are ``.gz``, ``.gzip``, ``.bz2``, and ``.bzip2``.
        """
        return read_txt_or_gz(path)

    @classmethod
    def write_compressed_text(cls, txt: str, path: PathLike, *, mkdirs: bool = False) -> None:
        """
        Writes text to a text file, optionally gzipped or bz2-ed.
        Recognized suffixes for compression are ``.gz``, ``.gzip``, ``.bz2``, and ``.bzip2``.
        """
        write_txt_or_gz(txt, path, mkdirs=mkdirs)

    @classmethod
    def is_linux(cls) -> bool:

Missing function or method docstring

        return sys.platform == "linux"

    @classmethod
    def is_windows(cls) -> bool:

Missing function or method docstring

        return sys.platform == "win32"

    @classmethod
    def is_macos(cls) -> bool:

Missing function or method docstring

        return sys.platform == "darwin"

    @classmethod
    def get_info(

Missing function or method docstring

        cls, path: PathLike, *, expand_user: bool = False, strict: bool = False

Wrong hanging indentation before block (add 4 spaces).

    ) -> PathInfo:
        path = Path(path)
        has_ignore_error = hasattr(pathlib, "_ignore_error")
        if not has_ignore_error:
            logger.debug("No _ignore_error found; some OSErrors may be suppressed")
        resolved = None
        real_stat = None
        has_access = False
        has_read = False
        has_write = False
        link_stat = None
        as_of = datetime.now().astimezone()
        if has_ignore_error or path.is_symlink() or path.exists():
            link_stat = cls.__stat_raw(path)
        if link_stat is not None:
            if expand_user:
                resolved = path.expanduser().resolve(strict=strict)
            else:
                resolved = path.resolve(strict=strict)
            if stat.S_ISLNK(link_stat.st_mode):
                real_stat = cls.__stat_raw(resolved)
            else:
                real_stat = link_stat
            has_access = os.access(path, os.X_OK, follow_symlinks=True)
            has_read = os.access(path, os.R_OK, follow_symlinks=True)
            has_write = os.access(path, os.W_OK, follow_symlinks=True)
            if not stat.S_ISLNK(link_stat.st_mode):
                link_stat = None
        return PathInfo(
            source=path,
            resolved=resolved,
            as_of=as_of,
            real_stat=real_stat,
            link_stat=link_stat,
            has_access=has_access,
            has_read=has_read,
            has_write=has_write,
        )

    @classmethod
    def prep_dir(cls, path: PathLike, *, exist_ok: bool = True) -> bool:
        """
        Prepares a directory by making it if it doesn't exist.
        If exist_ok is False, calls ``logger.warning`` if ``path`` already exists
        """
        path = Path(path)
        exists = path.exists()
        # On some platforms we get generic exceptions like permissions errors,
        # so these are better
        if exists and not path.is_dir():
            raise DirDoesNotExistError(f"Path {path} exists but is not a file")
        if exists and not exist_ok:
            logger.warning(f"Directory {path} already exists")

Use lazy % formatting in logging functions

        if not exists:
            # NOTE! exist_ok in mkdir throws an error on Windows
            path.mkdir(parents=True)
        return exists

    @classmethod
    def prep_file(cls, path: PathLike, *, exist_ok: bool = True) -> None:
        """
        Prepares a file path by making its parent directory.
        Same as ``pathlib.Path.mkdir`` but makes sure ``path`` is a file if it exists.
        """
        # On some platforms we get generic exceptions like permissions errors, so these are better
        path = Path(path)
        # check for errors first; don't make the dirs and then fail
        if path.exists() and not path.is_file() and not path.is_symlink():
            raise FileDoesNotExistError(f"Path {path} exists but is not a file")
        Path(path.parent).mkdir(parents=True, exist_ok=exist_ok)

    @classmethod
    def dump_error(

Argument name "e" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        cls, e: Optional[BaseException], path: Union[None, PathLike, datetime] = None

Wrong hanging indentation before block (add 4 spaces).

    ) -> Path:
        """
        Writes a .json file containing the error message, stack trace, and sys info.
        System info is from :meth:`get_env_info`.
        """
        if path is None:
            path = f"err-dump-{cls.dt_for_filesys()}.json"
        elif isinstance(path, datetime):
            path = f"err-dump-{cls.dt_for_filesys(path)}.json"
        path = Path(path)
        data = cls.dump_error_as_dict(e)
        data = orjson.dumps(data, option=orjson.OPT_INDENT_2)
        path.write_bytes(data)
        return path

    @classmethod
    def dump_error_as_dict(cls, e: Optional[BaseException]) -> Mapping[str, Any]:

Argument name "e" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

Missing function or method docstring

        try:
            system = SystemTools.get_env_info()
        except BaseException as e2:

Catching very general exceptions such as BaseException is usually not recommended.

Variable name "e2" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

            system = f"UNKNOWN << {e2} >>"
        msg, tb = SystemTools.serialize_exception(e)

Variable name "tb" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        tb = [t.as_dict() for t in tb]

Variable name "tb" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        return dict(message=msg, stacktrace=tb, system=system)

    @classmethod
    def dt_for_filesys(cls, dt: Optional[datetime] = None) -> str:

Argument name "dt" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

Missing function or method docstring

        if dt is None:
            dt = datetime.now()
        return dt.strftime("%Y-%m-%d_%H-%M-%S")

    @classmethod
    def delete_surefire(cls, path: PathLike) -> Optional[Exception]:
        """
        Deletes files or directories cross-platform, but working around multiple issues in Windows.

        Returns:
            None, or an Exception for minor warnings

        Raises:
            IOError: If it can't delete
        """
        # we need this because of Windows
        path = Path(path)
        logger.debug(f"Permanently deleting {path} ...")

Use lazy % formatting in logging functions

        chmod_err = None
        try:
            os.chmod(str(path), stat.S_IRWXU)
        except Exception as e:

Catching very general exceptions such as Exception is usually not recommended.

Variable name "e" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

            chmod_err = e
        # another reason for returning exception:
        # We don't want to interrupt the current line being printed like in slow_delete
        if path.is_dir():
            shutil.rmtree(str(path), ignore_errors=True)  # ignore_errors because of Windows
            try:
                path.unlink(missing_ok=True)  # again, because of Windows
            except IOError:
                pass  # almost definitely because it doesn't exist
        else:
            path.unlink(missing_ok=True)
        logger.debug(f"Permanently deleted {path}")

Use lazy % formatting in logging functions

        return chmod_err

    @classmethod
    def trash(cls, path: PathLike, trash_dir: Optional[PathLike] = None) -> None:
        """
        Trash a file or directory.

        Args:
            path: The path to move to the trash
            trash_dir: If None, uses :meth:`pocketutils.tools.path_tools.PathTools.guess_trash`
        """
        if trash_dir is None:
            trash_dir = PathTools.guess_trash()
        logger.debug(f"Trashing {path} to {trash_dir} ...")

Use lazy % formatting in logging functions

        shutil.move(str(path), str(trash_dir))
        logger.debug(f"Trashed {path} to {trash_dir}")

Use lazy % formatting in logging functions

    @classmethod
    def try_cleanup(cls, path: Path, *, bound: Type[Exception] = PermissionError) -> None:
        """
        Try to delete a file (probably temp file), if it exists, and log any ``PermissionError``.
        """
        path = Path(path)
        # noinspection PyBroadException
        try:
            path.unlink(missing_ok=True)
        except bound:
            logger.error(f"Permission error preventing deleting {path}")

Use lazy % formatting in logging functions

    @classmethod
    def read_lines_file(cls, path: PathLike, *, ignore_comments: bool = False) -> Sequence[str]:
        """
        Returns a list of lines in the file.
        Optionally skips lines starting with ``#`` or that only contain whitespace.
        """
        lines = []
        with cls.open_file(path, "r") as f:

Variable name "f" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

            for line in f.readlines():
                line = line.strip()
                if not ignore_comments or not line.startswith("#") and not len(line.strip()) == 0:
                    lines.append(line)
        return lines

    @classmethod
    def read_properties_file(cls, path: PathLike) -> Mapping[str, str]:
        """
        Reads a .properties file.
        A list of lines with key=value pairs (with an equals sign).
        Lines beginning with # are ignored.
        Each line must contain exactly 1 equals sign.

        .. caution::
            The escaping is not compliant with the standard

        Args:
            path: Read the file at this local path

        Returns:
            A dict mapping keys to values, both with surrounding whitespace stripped
        """
        dct = {}
        with cls.open_file(path, "r") as f:

Variable name "f" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

            for i, line in enumerate(f.readlines()):
                line = line.strip()
                if len(line) == 0 or line.startswith("#"):
                    continue
                if line.count("=") != 1:
                    raise ParsingError(f"Bad line {i} in {path}", resource=path)
                k, v = line.split("=")

Variable name "v" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

                k, v = k.strip(), v.strip()

Variable name "v" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

                if k in dct:
                    raise AlreadyUsedError(f"Duplicate property {k} (line {i})", key=k)
                dct[k] = v
        return dct

    @classmethod
    def write_properties_file(
        cls, properties: Mapping[Any, Any], path: Union[str, PurePath], mode: str = "o"

Wrong hanging indentation before block (add 4 spaces).

    ) -> None:
        """
        Writes a .properties file.

        .. caution::
            The escaping is not compliant with the standard
        """
        if not OpenMode(mode).write:
            raise ContradictoryRequestError(f"Cannot write text to {path} in mode {mode}")
        with FilesysTools.open_file(path, mode) as f:

Variable name "f" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

            bads = []
            for k, v in properties.items():

Variable name "v" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

                if "=" in k or "=" in v or "\n" in k or "\n" in v:
                    bads.append(k)
                f.write(
                    str(k).replace("=", "--").replace("\n", "\\n")
                    + "="
                    + str(v).replace("=", "--").replace("\n", "\\n")
                    + "\n"
                )
            if 0 < len(bads) <= 10:
                logger.warning(

Use lazy % formatting in logging functions

                    "At least one properties entry contains an equals sign or newline (\\n)."
                    f"These were escaped: {', '.join(bads)}"
                )
            elif len(bads) > 0:
                logger.warning(
                    "At least one properties entry contains an equals sign or newline (\\n),"
                    "which were escaped."
                )

    @classmethod
    def save_json(cls, data: Any, path: PathLike, mode: str = "w") -> None:

Missing function or method docstring

        with cls.open_file(path, mode) as f:

Variable name "f" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

            f.write(orjson.dumps(data).decode(encoding="utf8"))

    @classmethod
    def load_json(cls, path: PathLike) -> Union[dict, list]:

Missing function or method docstring

        return orjson.loads(Path(path).read_text(encoding="utf8"))

    @classmethod
    def read_any(

Too many return statements (10/6)

        cls, path: PathLike

Wrong hanging indentation before block (add 4 spaces).

    ) -> Union[
        str,
        bytes,
        Sequence[str],
        pd.DataFrame,
        Sequence[int],
        Sequence[float],
        Sequence[str],
        Mapping[str, str],
    ]:
        """
        Reads a variety of simple formats based on filename extension.
        Includes '.txt', 'csv', .xml', '.properties', '.json'.
        Also reads '.data' (binary), '.lines' (text lines).
        And formatted lists: '.strings', '.floats', and '.ints' (ex: "[1, 2, 3]").
        """
        path = Path(path)
        ext = path.suffix.lstrip(".")

        def load_list(dtype):
            return [
                dtype(s)
                for s in FilesysTools.read_lines_file(path)[0]
                .replace(" ", "")
                .replace("[", "")
                .replace("]", "")
                .split(",")
            ]

        if ext == "lines":

Unnecessary "elif" after "return"

            return cls.read_lines_file(path)
        elif ext == "txt":
            return path.read_text(encoding="utf-8")
        elif ext == "data":
            return path.read_bytes()
        elif ext == "json":
            return cls.load_json(path)
        elif ext in ["npy", "npz"]:
            return np.load(str(path), allow_pickle=False, encoding="utf8")
        elif ext == "properties":
            return cls.read_properties_file(path)
        elif ext == "csv":
            return pd.read_csv(path, encoding="utf8")
        elif ext == "ints":
            return load_list(int)
        elif ext == "floats":
            return load_list(float)
        elif ext == "strings":
            return load_list(str)
        elif ext == "xml":
            ElementTree.parse(path).getroot()
        else:
            raise TypeError(f"Did not recognize resource file type for file {path}")

    @classmethod
    @contextmanager
    def open_file(cls, path: PathLike, mode: Union[OpenMode, str], *, mkdir: bool = False):
        """
        Opens a text file, always using utf8, optionally gzipped.

        See Also:
            :class:`pocketutils.core.input_output.OpenMode`
        """
        path = Path(path)
        mode = OpenMode(mode)
        if mode.write and mkdir:
            path.parent.mkdir(exist_ok=True, parents=True)
        if not mode.read:
            cls.prep_file(path, exist_ok=mode.overwrite or mode.append)
        if mode.gzipped:
            yield gzip.open(path, mode.internal, compresslevel=COMPRESS_LEVEL, encoding="utf8")
        elif mode.binary:
            yield open(path, mode.internal, encoding="utf8")
        else:
            yield open(path, mode.internal, encoding="utf8")

    @classmethod
    def write_lines(cls, iterable: Iterable[Any], path: PathLike, mode: str = "w") -> int:
        r"""
        Just writes an iterable line-by-line to a file, using '\n'.

        Makes the parent directory if needed.
        Checks that the iterable is a "true iterable" (not a string or bytes).

        Returns:
            The number of lines written (the same as len(iterable) if iterable has a length)

        Raises:
            FileExistsError: If the path exists and append is False
            PathIsNotFileError: If append is True, and the path exists but is not a file
        """
        if not cls.is_true_iterable(iterable):
            raise TypeError("Not a true iterable")  # TODO include iterable if small

TODO and FIXME comments should generally be avoided.

        n = 0

Variable name "n" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        with cls.open_file(path, mode) as f:

Variable name "f" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

            for x in iterable:

Variable name "x" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

                f.write(str(x) + "\n")
            n += 1

Variable name "n" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        return n

    @classmethod
    def hash_hex(cls, x: SupportsBytes, algorithm: str) -> str:

Argument name "x" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        """
        Returns the hex-encoded hash of the object (converted to bytes).
        """
        m = hashlib.new(algorithm)

Variable name "m" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

        m.update(bytes(x))
        return m.hexdigest()

    @classmethod
    def replace_in_file(cls, path: PathLike, changes: Mapping[str, str]) -> None:
        """
        Uses ``regex.sub`` repeatedly to modify (AND REPLACE) a file's content.
        """
        path = Path(path)
        data = path.read_text(encoding="utf-8")
        for key, value in changes.items():
            data = regex.sub(key, value, data, flags=regex.V1 | regex.MULTILINE | regex.DOTALL)
        path.write_text(data, encoding="utf-8")

    @classmethod
    def tmppath(cls, path: Optional[PathLike] = None, **kwargs) -> Generator[Path, None, None]:
        """
        Makes a temporary Path. Won't create ``path`` but will delete it at the end.
        If ``path`` is None, will use ``tempfile.mkstemp``.
        """
        if path is None:
            _, path = tempfile.mkstemp()
        try:
            yield Path(path, **kwargs)
        finally:
            Path(path).unlink()

    @classmethod
    def tmpfile(
        cls, path: Optional[PathLike] = None, *, spooled: bool = False, **kwargs

Wrong hanging indentation before block (add 4 spaces).

    ) -> Generator[Writeable, None, None]:
        """
        Simple wrapper around tempfile functions.
        Wraps ``TemporaryFile``, ``NamedTemporaryFile``, and ``SpooledTemporaryFile``.
        """
        if spooled:
            with tempfile.SpooledTemporaryFile(**kwargs) as x:

Variable name "x" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

                yield x
        elif path is None:
            with tempfile.TemporaryFile(**kwargs) as x:

Variable name "x" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

                yield x
        else:
            with tempfile.NamedTemporaryFile(str(path), **kwargs) as x:

Variable name "x" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

                yield x

    @classmethod
    def tmpdir(cls, **kwargs) -> Generator[Path, None, None]:

Missing function or method docstring

        with tempfile.TemporaryDirectory(**kwargs) as x:

Variable name "x" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

            yield Path(x)

    @classmethod
    def check_expired(
        cls,

Wrong hanging indentation before block (add 4 spaces).

        path: PathLike,

Wrong hanging indentation before block (add 4 spaces).

        max_sec: Union[timedelta, float],

Wrong hanging indentation before block (add 4 spaces).

        *,

Wrong hanging indentation before block (add 4 spaces).

        parent: Optional[PathLike] = None,

Wrong hanging indentation before block (add 4 spaces).

        warn_expired_fmt: str = "{path_rel} is {delta} out of date [{mod_rel}]",

Wrong hanging indentation before block (add 4 spaces).

        warn_unknown_fmt: str = "{path_rel} mod date is unknown [created: {create_rel}]",

Wrong hanging indentation before block (add 4 spaces).

        log: Optional[Callable[[str], Any]] = logger.warning,

Wrong hanging indentation before block (add 4 spaces).

    ) -> Optional[bool]:
        """
        Warns and returns True if ``path`` mod date is more than ``max_sec`` in the past.
        Returns None if it could not be determined.

        The formatting strings can refer to any of these (will be empty if unknown):
            - path: Full path
            - name: File/dir name
            - path_rel: Path relative to ``self._dir``, or full path if not under
            - now: formatted current datetime
            - [mod/create]_dt: Formatted mod/creation datetime
            - [mod/create]_rel: Mod/create datetime in terms of offset from now
            - [mod/create]_delta: Formatted timedelta from now
            - [mod/create]_delta_sec: Number of seconds from now (negative if now < mod/create dt)

        Args:
            path: A specific path to check
            max_sec: Max seconds, or a timedelta
            parent: If provided, path_rel is relative to this directory (to simplify warnings)
            warn_expired_fmt: Formatting string in terms of the variables listed above
            warn_unknown_fmt: Formatting string in terms of the variables listed above
            log: Log about problems

        Returns:
            Whether it is expired, or None if it could not be determined
        """
        path = Path(path)
        if log is None:

            def log(_):
                return None

        limit = max_sec if isinstance(max_sec, timedelta) else timedelta(seconds=max_sec)
        now = datetime.now().astimezone()
        info = FilesysTools.get_info(path)
        if info.mod_dt and now - info.mod_dt > limit:

Unnecessary "elif" after "return"

            cls._warn_expired(now, info.mod_dt, info.create_dt, path, parent, warn_expired_fmt, log)
            return True
        elif not info.mod_dt and (not info.create_dt or (now - info.create_dt) > limit):
            cls._warn_expired(now, info.mod_dt, info.create_dt, path, parent, warn_unknown_fmt, log)
            return None
        return False

    @classmethod
    def _warn_expired(

Too many arguments (8/5)

This function exceeds the maximum number of variables (20/15).

        cls,

Wrong hanging indentation before block (add 4 spaces).

        now: datetime,

Wrong hanging indentation before block (add 4 spaces).

        mod: Optional[datetime],

Wrong hanging indentation before block (add 4 spaces).

        created: Optional[datetime],

Wrong hanging indentation before block (add 4 spaces).

        path: Path,

Wrong hanging indentation before block (add 4 spaces).

        parent: Optional[Path],

Wrong hanging indentation before block (add 4 spaces).

        fmt: Optional[str],

Wrong hanging indentation before block (add 4 spaces).

        log: Callable[[str], Any],

Wrong hanging indentation before block (add 4 spaces).

    ):
        if isinstance(fmt, str):
            fmt = fmt.format
        if parent is not None and path.is_relative_to(parent):
            path_rel = str(path.relative_to(parent))
        else:
            path_rel = str(path)
        now_str, mod_str, mod_rel, mod_delta, mod_delta_sec = cls._expire_warning_info(now, mod)
        _, create_str, create_rel, create_delta, create_delta_sec = cls._expire_warning_info(
            now, created
        )
        msg = fmt(
            path=path,
            path_rel=path_rel,
            name=path.name,
            now=now_str,
            mod_dt=mod_str,
            mod_rel=mod_rel,
            mod_delta=mod_delta,
            mod_sec=mod_delta_sec,
            create_dt=create_str,
            create_rel=create_rel,
            create_delta=create_delta,
            create_sec=create_delta_sec,
        )
        log(msg)

    @classmethod
    def _expire_warning_info(
        cls, now: datetime, then: Optional[datetime]

Wrong hanging indentation before block (add 4 spaces).

    ) -> Tuple[str, str, str, str, str]:
        now_str = now.strftime("%Y-%m-%d %H:%M:%S")
        if then is None:
            return now_str, "", "", "", ""
        delta = now - then
        then_str = then.strftime("%Y-%m-%d %H:%M:%S")
        then_rel = UnitTools.approx_time_wrt(now, then)
        delta_str = UnitTools.delta_time_to_str(delta, space=Chars.narrownbsp)
        return now_str, then_str, then_rel, delta_str, str(delta.total_seconds())

    @classmethod
    def __stat_raw(cls, path: Path) -> Optional[os.stat_result]:
        try:
            return path.lstat()
        except OSError as e:

Variable name "e" doesn't conform to snake_case naming style ('([^\\W\\dA-Z][^\\WA-Z]2,|_[^\\WA-Z]*|__[^\\WA-Z\\d_][^\\WA-Z]+__)$' pattern)

            if hasattr(pathlib, "_ignore_error") and not pathlib._ignore_error(e):

The Module pathlib does not seem to have a member named _ignore_error.

It seems like _ignore_error was declared protected and should not be accessed from this context.

                raise
        return None


__all__ = ["FilesysTools", "PathInfo"]