Merge pull request #136 from callowayproject/encoding

Fix encoding when reading text.

.pre-commit-config.yaml

@@ -1,13 +1,13 @@
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: 'v0.1.14'
+    rev: 'v0.2.1'
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
         exclude: test.*
   - repo: https://github.com/psf/black
-    rev: 23.12.1
+    rev: 24.1.1
     hooks:
       - id: black
   - repo: https://github.com/pre-commit/pre-commit-hooks
@@ -45,7 +45,7 @@ repos:
         args: [--no-strict-optional, --ignore-missing-imports]
         additional_dependencies: ["pydantic>2.0", "toml", "types-all"]
   - repo: https://github.com/jsh9/pydoclint
-    rev: 0.3.9
+    rev: 0.4.0
     hooks:
       - id: pydoclint
         args:
@@ -55,9 +55,6 @@ repos:
     hooks:
       - id: interrogate
         exclude: test.*
-  - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 0.27.3
-    hooks:
-      - id: check-azure-pipelines
+
 ci:
   autofix_prs: false

bumpversion/__main__.py

@@ -1,4 +1,5 @@
 """Main entrypoint for module."""
+
 from bumpversion.cli import cli
 
 cli()

bumpversion/aliases.py

@@ -1,4 +1,5 @@
 """Utilities for handling command aliases."""
+
 from typing import List, Optional
 
 import rich_click as click

bumpversion/bump.py

@@ -1,4 +1,5 @@
 """Version changing methods."""
+
 import shlex
 from pathlib import Path
 from typing import TYPE_CHECKING, ChainMap, List, Optional

bumpversion/cli.py

@@ -1,4 +1,5 @@
 """bump-my-version Command line interface."""
+
 from pathlib import Path
 from typing import List, Optional
 

bumpversion/config/__init__.py

@@ -1,4 +1,5 @@
 """Configuration management."""
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING, Union

bumpversion/config/create.py

@@ -1,4 +1,5 @@
 """Module for creating a new config file."""
+
 from pathlib import Path
 from typing import Tuple
 
@@ -57,7 +58,7 @@ def get_defaults_from_dest(destination: str) -> Tuple[dict, TOMLDocument]:
 
     config = DEFAULTS.copy()
     if Path(destination).exists():
-        destination_config = parse(Path(destination).read_text())
+        destination_config = parse(Path(destination).read_text(encoding="utf-8"))
     else:
         destination_config = document()
 

bumpversion/config/files.py

@@ -39,7 +39,11 @@ def find_config_file(explicit_file: Union[str, Path, None] = None) -> Union[Path
         [Path(explicit_file)] if explicit_file else [Path.cwd().joinpath(path) for path in CONFIG_FILE_SEARCH_ORDER]
     )
     return next(
-        (cfg_file for cfg_file in search_paths if cfg_file.exists() and "bumpversion]" in cfg_file.read_text()),
+        (
+            cfg_file
+            for cfg_file in search_paths
+            if cfg_file.exists() and "bumpversion]" in cfg_file.read_text(encoding="utf-8")
+        ),
         None,
     )
 
@@ -91,7 +95,7 @@ def read_toml_file(file_path: Path) -> Dict[str, Any]:
     import tomlkit
 
     # Load the TOML file
-    toml_data = tomlkit.parse(file_path.read_text()).unwrap()
+    toml_data = tomlkit.parse(file_path.read_text(encoding="utf-8")).unwrap()
 
     return toml_data.get("tool", {}).get("bumpversion", {})
 

bumpversion/config/files_legacy.py

@@ -1,4 +1,5 @@
 """This module handles the legacy config file format."""
+
 from __future__ import annotations
 
 import re
@@ -102,7 +103,7 @@ def update_ini_config_file(
     )
 
     config_path = Path(config_file)
-    existing_config = config_path.read_text()
+    existing_config = config_path.read_text(encoding="utf-8")
     if config_path.suffix == ".cfg" and cfg_current_version_regex.search(existing_config):
         sub_str = f"\\g<section_prefix>{new_version}"
         new_config = cfg_current_version_regex.sub(sub_str, existing_config)

bumpversion/config/models.py

@@ -1,4 +1,5 @@
 """Bump My Version configuration models."""
+
 from __future__ import annotations
 
 import re

bumpversion/config/utils.py

@@ -1,4 +1,5 @@
 """Helper functions for the config module."""
+
 from __future__ import annotations
 
 import glob

bumpversion/exceptions.py

@@ -1,4 +1,5 @@
 """Custom exceptions for BumpVersion."""
+
 from typing import Optional
 
 from click import Context, UsageError

bumpversion/files.py

@@ -1,4 +1,5 @@
 """Methods for changing files."""
+
 import os.path
 import re
 from copy import deepcopy
@@ -331,7 +332,7 @@ def _update_toml_file(
         """Update a TOML file."""
         import tomlkit
 
-        toml_data = tomlkit.parse(self.path.read_text())
+        toml_data = tomlkit.parse(self.path.read_text(encoding="utf-8"))
         value_before = get_nested_value(toml_data, self.file_change.key_path)
 
         if value_before is None:

bumpversion/indented_logger.py

@@ -1,4 +1,5 @@
 """A logger adapter that adds an indent to the beginning of each message."""
+
 import logging
 from contextvars import ContextVar
 from typing import Any, MutableMapping, Optional, Tuple

bumpversion/show.py

@@ -1,4 +1,5 @@
 """Functions for displaying information about the version."""
+
 import dataclasses
 from io import StringIO
 from pprint import pprint

bumpversion/ui.py

@@ -1,4 +1,5 @@
 """Utilities for user interface."""
+
 import logging
 
 import click

bumpversion/utils.py

@@ -1,4 +1,5 @@
 """General utilities."""
+
 import datetime
 import string
 from collections import ChainMap

bumpversion/version_part.py

@@ -1,4 +1,5 @@
 """Module for managing Versions and their internal parts."""
+
 import re
 from typing import Any, Dict, List, MutableMapping, Optional, Tuple
 

bumpversion/versioning/conventions.py

@@ -1,4 +1,5 @@
 """Standard version conventions."""
+
 from bumpversion.versioning.models import VersionComponentSpec, VersionSpec
 
 # Adapted from https://packaging.python.org/en/latest/specifications/version-specifiers/

bumpversion/versioning/functions.py

@@ -1,4 +1,5 @@
 """Generators for version parts."""
+
 import re
 from typing import List, Optional, Union
 

bumpversion/versioning/models.py

@@ -1,4 +1,5 @@
 """Models for managing versioning of software projects."""
+
 from __future__ import annotations
 
 from collections import defaultdict, deque

bumpversion/versioning/serialization.py

@@ -1,4 +1,5 @@
 """Functions for serializing and deserializing version objects."""
+
 import re
 from copy import copy
 from operator import itemgetter

bumpversion/visualize.py

@@ -1,4 +1,5 @@
 """Visualize the bumpversion process."""
+
 from dataclasses import dataclass
 from typing import List, Optional
 

bumpversion/yaml_dump.py

@@ -1,4 +1,5 @@
 """A simple YAML dumper to avoid extra dependencies."""
+
 import datetime
 from collections import UserDict
 from io import StringIO

docsrc/conf.py

@@ -1,6 +1,7 @@
 """
 Sphinx configuration.
 """
+
 # flake8: noqa
 import os
 import sys

pyproject.toml

@@ -147,22 +147,6 @@ color = true
 line-length = 119
 
 [tool.ruff]
-# Enable pycodestyle (`E`) and Pyflakes (`F`) codes by default.
-# "UP" "TRY" "PLR"
-select = ["E", "W", "F", "I", "N", "B", "BLE", "C", "D", "E", "F", "I", "N", "S", "T", "W", "RUF", "NPY", "PD", "PGH", "ANN", "C90", "PLC", "PLE", "PLW", "TCH"]
-ignore = [
-    "ANN002", "ANN003", "ANN101", "ANN102", "ANN204", "ANN401",
-    "S101", "S104",
-    "D105", "D106", "D107", "D200", "D212",
-    "PD011",
-    "PLW1510",
-]
-
-# Allow autofix for all enabled rules (when `--fix`) is provided.
-fixable = ["E", "W", "F", "I", "N", "B", "BLE", "C", "D", "E", "F", "I", "N", "S", "T", "W", "RUF", "NPY", "PD", "PGH", "ANN", "C90", "PL", "PLC", "PLE", "PLW", "TCH"]
-unfixable = []
-
-# Exclude a variety of commonly ignored directories.
 exclude = [
     ".bzr",
     ".direnv",
@@ -189,22 +173,37 @@ exclude = [
 # Same as Black.
 line-length = 119
 
+[tool.ruff.lint]
+select = ["E", "W", "F", "I", "N", "B", "BLE", "C", "D", "E", "F", "I", "N", "S", "T", "W", "RUF", "NPY", "PD", "PGH", "ANN", "C90", "PLC", "PLE", "PLW", "TCH"]
+ignore = [
+    "ANN002", "ANN003", "ANN101", "ANN102", "ANN204", "ANN401",
+    "S101", "S104",
+    "D105", "D106", "D107", "D200", "D212",
+    "PD011",
+    "PLW1510",
+]
+
+fixable = ["E", "W", "F", "I", "N", "B", "BLE", "C", "D", "E", "F", "I", "N", "S", "T", "W", "RUF", "NPY", "PD", "PGH", "ANN", "C90", "PL", "PLC", "PLE", "PLW", "TCH"]
+unfixable = []
+
+# Exclude a variety of commonly ignored directories.
+
 # Allow unused variables when underscore-prefixed.
 dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
 
 typing-modules = ["typing", "types", "typing_extensions", "mypy", "mypy_extensions"]
 
-[tool.ruff.per-file-ignores]
+[tool.ruff.lint.per-file-ignores]
 "tests/*" = ["S101", "PLR0913", "PLR0915", "PGH003", "ANN001", "ANN202", "ANN201", "PLR0912", "TRY301", "PLW0603", "PLR2004", "ANN101", "S106", "TRY201", "ANN003", "ANN002", "S105", "TRY003"]
 
-[tool.ruff.mccabe]
+[tool.ruff.lint.mccabe]
 # Unlike Flake8, default to a complexity level of 10.
 max-complexity = 10
 
-[tool.ruff.isort]
+[tool.ruff.lint.isort]
 order-by-type = true
 
-[tool.ruff.pydocstyle]
+[tool.ruff.lint.pydocstyle]
 convention = "google"
 
 [tool.bumpversion]

tests/conftest.py

@@ -1,4 +1,5 @@
 """Testing fixtures for Pytest."""
+
 import subprocess
 from contextlib import contextmanager
 from pathlib import Path

tests/test_autocast.py

@@ -1,4 +1,5 @@
 """Tests for the autocast module."""
+
 import pytest
 from pytest import param
 

tests/test_bump.py

@@ -1,4 +1,5 @@
 """Tests for the bump module."""
+
 from pathlib import Path
 from textwrap import dedent
 from unittest.mock import MagicMock, patch

tests/test_cli/test_bump.py

@@ -1,4 +1,5 @@
 """Tests the bump CLI subcommand."""
+
 import shutil
 import subprocess
 from datetime import datetime

tests/test_cli/test_replace.py

@@ -1,4 +1,5 @@
 """Tests for `bumpversion` package."""
+
 import shutil
 import traceback
 from pathlib import Path

tests/test_cli/test_show_bump.py

@@ -1,4 +1,5 @@
 """Tests the show_bump command."""
+
 import shutil
 from pathlib import Path
 

tests/test_config/test_create.py

@@ -1,4 +1,5 @@
 """Test the create function in the config module."""
+
 from pathlib import Path
 import pytest
 

tests/test_config/test_files.py

@@ -1,4 +1,5 @@
 """Test configuration parsing."""
+
 import difflib
 import json
 from pathlib import Path

tests/test_configuredfile.py

@@ -1,4 +1,5 @@
 """Tests for the ConfiguredFile class."""
+
 from bumpversion.files import ConfiguredFile, FileChange
 from bumpversion.version_part import VersionConfig
 from bumpversion.versioning.models import VersionComponentSpec

tests/test_files.py

@@ -1,4 +1,5 @@
 """File processing tests."""
+
 import os
 import shutil
 from datetime import datetime, timezone

tests/test_scm.py

@@ -1,4 +1,5 @@
 """Tests of the VCS module."""
+
 import subprocess
 from pathlib import Path
 

tests/test_utils.py

@@ -1,4 +1,5 @@
 """Tests for the utils module."""
+
 from itertools import combinations
 
 import pytest

tests/test_versioning/test_serialization.py

@@ -1,4 +1,5 @@
 """Tests for the serialization of versioned objects."""
+
 from bumpversion.versioning.serialization import parse_version, serialize
 from bumpversion.versioning.conventions import semver_spec, SEMVER_PATTERN
 from bumpversion.versioning.models import Version, VersionSpec, VersionComponentSpec

tests/test_visualize.py

@@ -1,4 +1,5 @@
 """Tests of the visualize module."""
+
 from pathlib import Path
 
 from bumpversion.visualize import Border, BOX_CHARS, connection_str, lead_string, labeled_line, visualize

tests/test_yaml.py

@@ -1,4 +1,5 @@
 """Tests for the yaml serialization module."""
+
 from pathlib import Path
 
 from bumpversion import yaml_dump