Merge branch 'master' into check_diff

tdgroot · web-flow · commit df37cd76a157 · 2023-10-06T09:48:02.000+02:00
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -2,7 +2,7 @@
 commit = True
 tag = True
 tag_name = {new_version}
-current_version = 0.7.16
+current_version = 0.7.17
 
 [bumpversion:file:pyproject.toml]
 search = version = "{current_version}"  # DO NOT EDIT THIS LINE MANUALLY. LET bump2version UTILITY DO IT
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -33,7 +33,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11', '3.12-dev']
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12-dev']
         os: [ubuntu-latest, macos-latest, windows-latest]
     continue-on-error: ${{ matrix.python-version == '3.12-dev' }}
 
@@ -74,7 +74,7 @@ jobs:
     - uses: actions/checkout@v3
     - uses: actions/setup-python@v3
       with:
-        python-version: '3.7'
+        python-version: '3.8'
     - name: Install build and publish tools
       run: |
         pip install build twine
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,17 +1,17 @@
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: 3298ddab3c13dd77d6ce1fc0baf97691430d84b0  # frozen: v4.3.0
+  rev: f71fa2c1f9cf5cb705f73dffe4b21f7c61470ba9  # frozen: v4.4.0
   hooks:
   - id: check-yaml
   - id: check-toml
 - repo: https://github.com/pre-commit/pygrep-hooks
-  rev: 6f51a66bba59954917140ec2eeeaa4d5e630e6ce  # frozen: v1.9.0
+  rev: 3a6eb0fadf60b3cccfd80bad9dbb6fae7e47b316  # frozen: v1.10.0
   hooks:
   - id: python-use-type-annotations
   - id: python-check-blanket-noqa
   - id: python-check-blanket-type-ignore
 - repo: https://github.com/asottile/yesqa
-  rev: 265e9ff7c83add4949f81bb5fe14f4a743ffb04c  # frozen: v1.4.0
+  rev: f2ae90cf9e1661ade79d0881186ce4fd7ba6ee79  # frozen: v1.5.0
   hooks:
   - id: yesqa
     additional_dependencies:
@@ -23,19 +23,19 @@ repos:
   hooks:
   - id: absolufy-imports
 - repo: https://github.com/PyCQA/isort
-  rev: c5e8fa75dda5f764d20f66a215d71c21cfa198e1  # frozen: 5.10.1
+  rev: dbf82f2dd09ae41d9355bcd7ab69187a19e6bf2f  # frozen: 5.12.0
   hooks:
   - id: isort
 - repo: https://github.com/psf/black
-  rev: f6c139c5215ce04fd3e73a900f1372942d58eca0  # frozen: 22.6.0
+  rev: 193ee766ca496871f93621d6b58d57a6564ff81b  # frozen: 23.7.0
   hooks:
   - id: black
 - repo: https://github.com/myint/docformatter
-  rev: e0c24db9430c0df94a077c07af2e1de536689c5f  # frozen: v1.5.0-rc1
+  rev: dfefe062799848234b4cd60b04aa633c0608025e  # frozen: v1.7.5
   hooks:
   - id: docformatter
 - repo: https://github.com/PyCQA/flake8
-  rev: f8e1b317742036ff11ff86356fd2b68147e169f7  # frozen: 5.0.4
+  rev: 10f4af6dbcf93456ba7df762278ae61ba3120dc6  # frozen: 6.1.0
   hooks:
   - id: flake8
     additional_dependencies:
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -11,6 +11,6 @@ sphinx:
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-   version: '3.7'
+   version: '3.8'
    install:
    - requirements: docs/requirements.txt
diff --git a/docs/conf.py b/docs/conf.py
@@ -23,7 +23,7 @@
 author = 'Taneli Hukkinen'
 
 # The full version, including alpha/beta/rc tags
-release = '0.7.16'  # DO NOT EDIT THIS LINE MANUALLY. LET bump2version UTILITY DO IT
+release = '0.7.17'  # DO NOT EDIT THIS LINE MANUALLY. LET bump2version UTILITY DO IT
 
 
 # -- General configuration ---------------------------------------------------
diff --git a/docs/users/changelog.md b/docs/users/changelog.md
@@ -3,6 +3,22 @@
 This log documents all Python API or CLI breaking backwards incompatible changes.
 Note that there is currently no guarantee for a stable Markdown formatting style across versions.
 
+## 0.7.17
+
+- Added
+  - Do not update mtime if formatting result is identical to the file.
+    Thank you, [Pierre Augier](https://github.com/paugier), for the issue and the PR.
+- Fixed
+  - An error on empty paragraph (Unicode space only).
+    Thank you, [Nico Schlömer](https://github.com/nschloe), for the issue.
+  - File write fails if no permissions to write to the directory.
+    Fixed by removing atomic writes.
+    Thank you, [Guy Kisel](https://github.com/guykisel), for the issue.
+  - File permissions change on rewrite.
+    Thank you, [Keiichi Watanabe](https://github.com/keiichiw), for the issue.
+- Removed
+  - Python 3.7 support
+
 ## 0.7.16
 
 - Added
diff --git a/docs/users/installation_and_usage.md b/docs/users/installation_and_usage.md
@@ -68,7 +68,7 @@ Add the following to your project's `.pre-commit-config.yaml` to enable this:
 
 ```yaml
 - repo: https://github.com/executablebooks/mdformat
-  rev: 0.7.16  # Use the ref you want to point at
+  rev: 0.7.17  # Use the ref you want to point at
   hooks:
   - id: mdformat
     # Optionally add plugins
diff --git a/pyproject.toml b/pyproject.toml
@@ -5,18 +5,17 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "mdformat"
-version = "0.7.16"  # DO NOT EDIT THIS LINE MANUALLY. LET bump2version UTILITY DO IT
+version = "0.7.17"  # DO NOT EDIT THIS LINE MANUALLY. LET bump2version UTILITY DO IT
 description = "CommonMark compliant Markdown formatter"
 authors = [
     { name = "Taneli Hukkinen", email = "hukkin@users.noreply.github.com" },
 ]
 license = { file = "LICENSE" }
-requires-python = ">=3.7"
+requires-python = ">=3.8"
 dependencies = [
+    'markdown-it-py >=1.0.0,<4.0.0',
     'tomli >=1.1.0; python_version < "3.11"',
-    'markdown-it-py >=1.0.0,<3.0.0',
     'importlib-metadata >=3.6.0; python_version < "3.10"',
-    'typing-extensions >=3.7.4; python_version < "3.8"',
 ]
 readme = "README.md"
 classifiers = [
@@ -64,10 +63,10 @@ xfail_strict = true
 legacy_tox_ini = '''
 [tox]
 # Only run pytest envs when no args given to tox
-envlist = py{37,38,39,310}
+envlist = py{38,39,310,311}
 isolated_build = True
 
-[testenv:py{37,38,39,310}]
+[testenv:py{38,39,310,311}]
 description = run tests
 deps =
     -r tests/requirements.txt
diff --git a/src/mdformat/__init__.py b/src/mdformat/__init__.py
@@ -1,4 +1,4 @@
 __all__ = ("file", "text")
-__version__ = "0.7.16"  # DO NOT EDIT THIS LINE MANUALLY. LET bump2version UTILITY DO IT
+__version__ = "0.7.17"  # DO NOT EDIT THIS LINE MANUALLY. LET bump2version UTILITY DO IT
 
 from mdformat._api import file, text
diff --git a/src/mdformat/_api.py b/src/mdformat/_api.py
@@ -7,13 +7,7 @@
 from typing import Any
 
 from mdformat._conf import DEFAULT_OPTS
-from mdformat._util import (
-    EMPTY_MAP,
-    NULL_CTX,
-    atomic_write,
-    build_mdit,
-    detect_newline_type,
-)
+from mdformat._util import EMPTY_MAP, NULL_CTX, build_mdit, detect_newline_type
 from mdformat.renderer import MDRenderer
 
 
@@ -75,4 +69,6 @@ def file(
     newline = detect_newline_type(
         original_md, options.get("end_of_line", DEFAULT_OPTS["end_of_line"])
     )
-    atomic_write(f, formatted_md, newline)
+    formatted_md = formatted_md.replace("\n", newline)
+    if formatted_md != original_md:
+        f.write_bytes(formatted_md.encode())
diff --git a/src/mdformat/_cli.py b/src/mdformat/_cli.py
@@ -7,7 +7,6 @@
 import itertools
 import logging
 from pathlib import Path
-import re
 import shutil
 import sys
 import textwrap
@@ -16,13 +15,10 @@
 from mdformat._compat import importlib_metadata
 from mdformat._conf import DEFAULT_OPTS, InvalidConfError, read_toml_opts
 from mdformat._output import diff
-from mdformat._util import atomic_write, detect_newline_type, is_md_equal
+from mdformat._util import detect_newline_type, is_md_equal
 import mdformat.plugins
 import mdformat.renderer
 
-# Match "\r" and "\n" characters that are not part of a "\r\n" sequence
-RE_NON_CRLF_LINE_END = re.compile(r"(?:[^\r]|^)\n|\r(?:[^\n]|\Z)")
-
 
 class RendererWarningPrinter(logging.Handler):
     def emit(self, record: logging.LogRecord) -> None:
@@ -84,14 +80,10 @@ def run(cli_args: Sequence[str]) -> int:  # noqa: C901
             _filename=path_str,
         )
         newline = detect_newline_type(original_str, opts["end_of_line"])
+        formatted_str = formatted_str.replace("\n", newline)
 
         if opts["check"]:
-            original_str_lf_eol = original_str.replace("\r\n", "\n").replace("\r", "\n")
-            if (
-                (formatted_str != original_str_lf_eol)
-                or (newline == "\n" and "\r" in original_str)
-                or (newline == "\r\n" and RE_NON_CRLF_LINE_END.search(original_str))
-            ):
+            if formatted_str != original_str:
                 format_errors_found = True
                 print_error(f'File "{path_str}" is not formatted.')
 
@@ -124,12 +116,10 @@ def run(cli_args: Sequence[str]) -> int:  # noqa: C901
                 )
                 return 1
             if path:
-                atomic_write(path, formatted_str, newline)
+                if formatted_str != original_str:
+                    path.write_bytes(formatted_str.encode())
             else:
-                with open(
-                    sys.stdout.fileno(), "w", closefd=False, newline=newline
-                ) as stdout:
-                    stdout.write(formatted_str)
+                sys.stdout.buffer.write(formatted_str.encode())
     if format_errors_found:
         return 1
     return 0
diff --git a/src/mdformat/_compat.py b/src/mdformat/_compat.py
@@ -1,4 +1,4 @@
-__all__ = ("importlib_metadata", "Protocol", "Literal", "tomllib")
+__all__ = ("importlib_metadata", "tomllib")
 
 import sys
 
@@ -11,8 +11,3 @@
     from importlib import metadata as importlib_metadata
 else:  # pragma: no cover
     import importlib_metadata
-
-if sys.version_info >= (3, 8):  # pragma: no cover
-    from typing import Literal, Protocol
-else:  # pragma: no cover
-    from typing_extensions import Literal, Protocol
diff --git a/src/mdformat/_util.py b/src/mdformat/_util.py
@@ -2,18 +2,13 @@
 
 from collections.abc import Iterable, Mapping
 from contextlib import nullcontext
-import filecmp
-import os
-from pathlib import Path
 import re
-import tempfile
 from types import MappingProxyType
-from typing import Any
+from typing import Any, Literal
 
 from markdown_it import MarkdownIt
 from markdown_it.renderer import RendererHTML
 
-from mdformat._compat import Literal
 import mdformat.plugins
 
 NULL_CTX = nullcontext()
@@ -107,26 +102,6 @@ def is_md_equal(
     return html_texts["md1"] == html_texts["md2"]
 
 
-def atomic_write(path: Path, text: str, newline: str) -> None:
-    """A function for atomic writes to a file.
-
-    Writes a temporary file first and then replaces the original file
-    with the temporary one. This is to avoid a moment where only empty
-    or partial content exists on disk.
-    """
-    fd, tmp_path = tempfile.mkstemp(dir=path.parent)
-    try:
-        with open(fd, "w", encoding="utf-8", newline=newline) as f:
-            f.write(text)
-        if filecmp.cmp(tmp_path, path, shallow=False):
-            os.remove(tmp_path)
-        else:
-            os.replace(tmp_path, path)
-    except BaseException:  # pragma: no cover
-        os.remove(tmp_path)
-        raise
-
-
 def detect_newline_type(md: str, eol_setting: str) -> Literal["\n", "\r\n"]:
     """Returns the newline-character to be used for output.
 
diff --git a/src/mdformat/plugins.py b/src/mdformat/plugins.py
@@ -2,10 +2,11 @@
 
 import argparse
 from collections.abc import Callable, Mapping
+from typing import Protocol
 
 from markdown_it import MarkdownIt
 
-from mdformat._compat import Protocol, importlib_metadata
+from mdformat._compat import importlib_metadata
 from mdformat.renderer.typing import Postprocess, Render
 
 
diff --git a/src/mdformat/renderer/_context.py b/src/mdformat/renderer/_context.py
@@ -7,12 +7,11 @@
 import re
 import textwrap
 from types import MappingProxyType
-from typing import TYPE_CHECKING, Any, NamedTuple
+from typing import TYPE_CHECKING, Any, Literal, NamedTuple
 
 from markdown_it.rules_block.html_block import HTML_SEQUENCES
 
 from mdformat import codepoints
-from mdformat._compat import Literal
 from mdformat._conf import DEFAULT_OPTS
 from mdformat.renderer._util import (
     RE_CHAR_REFERENCE,
