From a268a6c5b5e312ee680cbe400d0598ad6044f51c Mon Sep 17 00:00:00 2001 From: Marcin Orlowski Date: Sun, 6 Oct 2024 11:50:58 +0200 Subject: [PATCH 1/3] Updated code docs --- transtool/const.py | 7 +++++ transtool/report/items.py | 6 +++++ transtool/report/report.py | 8 ++++++ transtool/utils.py | 55 ++++++++++++++++++++++++++++++++++++-- 4 files changed, 74 insertions(+), 2 deletions(-) diff --git a/transtool/const.py b/transtool/const.py index fdf689e..eba8ed1 100644 --- a/transtool/const.py +++ b/transtool/const.py @@ -12,9 +12,16 @@ class Const(object): + # The name of the application. APP_NAME: str = 'trans-tool' + + # The version of the application. APP_VERSION: str = '2.5.3' + + # The URL of the application's repository. APP_URL: str = 'https://github.com/MarcinOrlowski/trans-tool/' + + # The years during which the application was developed. APP_YEARS: str = '2021-2023' APP_DESCRIPTION: List[str] = [ diff --git a/transtool/report/items.py b/transtool/report/items.py index 90572db..955df38 100644 --- a/transtool/report/items.py +++ b/transtool/report/items.py @@ -24,6 +24,12 @@ def __init__(self, position: Optional[Union[str, int]], msg: str, trans_key: Opt self.trans_key = trans_key def to_string(self) -> str: + """ + Converts the report item to a string representation. + + Returns: + str: The string representation of the report item. + """ # Note trailing space! line = f'Line {self.position}: ' if self.position else '' if self.trans_key: diff --git a/transtool/report/report.py b/transtool/report/report.py index 2e0c835..741cbb8 100644 --- a/transtool/report/report.py +++ b/transtool/report/report.py @@ -11,6 +11,7 @@ from typing import List from simplelog.log import Log + from transtool.config.config import Config from transtool.utils import Utils from .group import ReportGroup @@ -66,6 +67,13 @@ def not_empty(self) -> bool: return len(self._groups) > 0 # noqa: WPS507 def dump(self): + """ + Dumps the report details, including errors and warnings, to the log. + + This method calculates the total number of errors and warnings in the report. + If the configuration is set to fatal, warnings are added to the errors count. + """ + errors = self.errors warnings = self.warnings diff --git a/transtool/utils.py b/transtool/utils.py index 1e6f15a..3fb3377 100644 --- a/transtool/utils.py +++ b/transtool/utils.py @@ -33,7 +33,8 @@ def add_if_not_in_list(target_list: List[str], items: Union[str, List[str]]) -> if isinstance(items, str): items = [items] if not isinstance(items, list): - raise TypeError(f'add_if_not_in_list() accepts str or List[str] only. {type(items)} passed') + raise TypeError( + f'add_if_not_in_list() accepts str or List[str] only. {type(items)} passed') for entry in items: if entry not in target_list: @@ -56,6 +57,15 @@ def add_if_not_in_dict(dictionary: Dict, key: str, val) -> bool: @staticmethod def remove_quotes(src: Union[str, List, Dict]): + """ + Removes quotes from the given input, which can be a string, list, or dictionary. + + :param src: The input from which to remove quotes. It can be a string, list, or dictionary. + :type src: Union[str, List, Dict] + :return: The input with quotes removed. + :rtype: Union[str, List, Dict] + :raises TypeError: If the input is not of type str, list, or dict. + """ src_type = type(src) if issubclass(src_type, str): return Utils.remove_quotes_str(src) @@ -67,6 +77,14 @@ def remove_quotes(src: Union[str, List, Dict]): @staticmethod def remove_quotes_str(src_str: str) -> str: + """ + Removes quotes from the given string. + + :param src_str: The string from which to remove quotes. + :type src_str: st + :return: The string with quotes removed. + :rtype: str + """ # FIXME: shall only removed if we have 2 quotes! if len(src_str) >= 2: if src_str[0] == '"': @@ -79,20 +97,53 @@ def remove_quotes_str(src_str: str) -> str: @staticmethod def remove_quotes_from_dict(src_dict: Dict) -> Dict: - return {Utils.remove_quotes(key): Utils.remove_quotes(value) for key, value in src_dict.items()} + """ + Removes quotes from both keys and values in the given dictionary. + + :param src_dict: The dictionary from which to remove quotes. + :type src_dict: Dict + :return: A new dictionary with quotes removed from keys and values. + :rtype: Dict + """ + return {Utils.remove_quotes(key): Utils.remove_quotes(value) for key, value in + src_dict.items()} @staticmethod def remove_quotes_from_list(src_list: List) -> List: + """ + Removes quotes from each element in the given list. + + :param src_list: The list from which to remove quotes. + :type src_list: List + :return: A new list with quotes removed from each element. + :rtype: List + """ return [Utils.remove_quotes(item) for item in src_list] @staticmethod def upper_first(src_str: Optional[str]) -> str: + """ + Converts the first character of the string to uppercase. + + :param src_str: The string to modify. + :type src_str: Optional[str] + :return: The modified string with the first character in uppercase. + :rtype: str + """ if src_str: return src_str[0].upper() + src_str[1:] return src_str @staticmethod def lower_first(src_str: Optional[str]) -> str: + """ + Converts the first character of the string to lowercase. + + :param src_str: The string to modify. + :type src_str: Optional[str] + :return: The modified string with the first character in lowercase. + :rtype: str + """ if src_str: return src_str[0].lower() + src_str[1:] return src_str From 12f226fb58f0ef7edaa79aac9f05e0394149c5ab Mon Sep 17 00:00:00 2001 From: Marcin Orlowski Date: Sun, 6 Oct 2024 11:51:57 +0200 Subject: [PATCH 2/3] Bumped copyright year --- .github/workflows/codecov.yml | 2 +- .github/workflows/linter.yml | 2 +- .github/workflows/markdown.yml | 2 +- .github/workflows/unittests.yml | 2 +- README.md | 2 +- setup.py | 2 +- tests/__init__.py | 2 +- tests/checks/__init__.py | 2 +- tests/checks/checks_test_case.py | 2 +- tests/checks/test_base_check.py | 2 +- tests/checks/test_brackets.py | 2 +- tests/checks/test_dangling_keys.py | 2 +- tests/checks/test_empty_translations.py | 2 +- tests/checks/test_formatting_values.py | 2 +- tests/checks/test_key_format.py | 2 +- tests/checks/test_missing_translations.py | 2 +- tests/checks/test_punctuation.py | 2 +- tests/checks/test_quotation_marks.py | 2 +- tests/checks/test_starts_with_the_same_case.py | 2 +- tests/checks/test_substitutions.py | 2 +- tests/checks/test_trailing_white_chars.py | 2 +- tests/checks/test_typesetting_quotation_marks.py | 2 +- tests/checks/test_white_chars_before_linefeed.py | 2 +- tests/config/__init__.py | 2 +- tests/config/test_config.py | 2 +- tests/config/test_config_builder.py | 2 +- tests/prop/__init__.py | 2 +- tests/prop/test_blank.py | 2 +- tests/prop/test_comment.py | 2 +- tests/prop/test_file.py | 2 +- tests/prop/test_prop_item.py | 2 +- tests/prop/test_translation.py | 2 +- tests/report/__init__.py | 2 +- tests/report/test_report.py | 2 +- tests/report/test_report_group.py | 2 +- tests/report/test_report_item.py | 2 +- tests/test_case.py | 2 +- tests/test_utils.py | 2 +- transtool/__init__.py | 2 +- transtool/checks/__init__.py | 2 +- transtool/checks/base/__init__.py | 2 +- transtool/checks/base/check.py | 2 +- transtool/checks/brackets.py | 2 +- transtool/checks/dangling_keys.py | 2 +- transtool/checks/empty_translations.py | 2 +- transtool/checks/formatting_values.py | 2 +- transtool/checks/key_format.py | 2 +- transtool/checks/missing_translations.py | 2 +- transtool/checks/punctuation.py | 2 +- transtool/checks/quotation_marks.py | 2 +- transtool/checks/starts_with_the_same_case.py | 2 +- transtool/checks/substitutions.py | 2 +- transtool/checks/trailing_white_chars.py | 2 +- transtool/checks/typesetting_quotation_marks.py | 2 +- transtool/checks/white_chars_before_linefeed.py | 2 +- transtool/config/__init__.py | 2 +- transtool/config/builder.py | 2 +- transtool/config/checker_info.py | 2 +- transtool/config/config.py | 2 +- transtool/config/reader.py | 2 +- transtool/const.py | 4 ++-- transtool/decorators/__init__.py | 2 +- transtool/decorators/overrides.py | 2 +- transtool/main.py | 2 +- transtool/prop/__init__.py | 2 +- transtool/prop/file.py | 2 +- transtool/prop/items.py | 2 +- transtool/report/__init__.py | 2 +- transtool/report/group.py | 2 +- transtool/report/items.py | 2 +- transtool/report/report.py | 2 +- transtool/utils.py | 2 +- 72 files changed, 73 insertions(+), 73 deletions(-) diff --git a/.github/workflows/codecov.yml b/.github/workflows/codecov.yml index 04f33cb..e0063bb 100644 --- a/.github/workflows/codecov.yml +++ b/.github/workflows/codecov.yml @@ -2,7 +2,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml index 858fc2d..c72f598 100644 --- a/.github/workflows/linter.yml +++ b/.github/workflows/linter.yml @@ -2,7 +2,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # diff --git a/.github/workflows/markdown.yml b/.github/workflows/markdown.yml index e441231..4cab20c 100644 --- a/.github/workflows/markdown.yml +++ b/.github/workflows/markdown.yml @@ -2,7 +2,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # # Runs markdownlint on all *.md files diff --git a/.github/workflows/unittests.yml b/.github/workflows/unittests.yml index c6116b8..d4f8aa3 100644 --- a/.github/workflows/unittests.yml +++ b/.github/workflows/unittests.yml @@ -2,7 +2,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # diff --git a/README.md b/README.md index 8b18ace..46aa788 100644 --- a/README.md +++ b/README.md @@ -81,7 +81,7 @@ Base: src/main/resources/resources/logisim/strings/soc/soc.properties ## License ## -* Written and copyrighted ©2021-2023 by Marcin Orlowski +* Written and copyrighted ©2021-2024 by Marcin Orlowski * trans-tool is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT). * Project logo diff --git a/setup.py b/setup.py index 29aa61c..5fc4510 100755 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # # python3 -m venv venv diff --git a/tests/__init__.py b/tests/__init__.py index 9c376f3..d146c67 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/checks/__init__.py b/tests/checks/__init__.py index 9c376f3..d146c67 100644 --- a/tests/checks/__init__.py +++ b/tests/checks/__init__.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/checks/checks_test_case.py b/tests/checks/checks_test_case.py index 623cee3..357da66 100644 --- a/tests/checks/checks_test_case.py +++ b/tests/checks/checks_test_case.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/checks/test_base_check.py b/tests/checks/test_base_check.py index 0a024c7..5864400 100644 --- a/tests/checks/test_base_check.py +++ b/tests/checks/test_base_check.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/checks/test_brackets.py b/tests/checks/test_brackets.py index c12e193..ba6e667 100644 --- a/tests/checks/test_brackets.py +++ b/tests/checks/test_brackets.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/checks/test_dangling_keys.py b/tests/checks/test_dangling_keys.py index 8d8a992..0f75be8 100644 --- a/tests/checks/test_dangling_keys.py +++ b/tests/checks/test_dangling_keys.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/checks/test_empty_translations.py b/tests/checks/test_empty_translations.py index f7f8b32..c72ed48 100644 --- a/tests/checks/test_empty_translations.py +++ b/tests/checks/test_empty_translations.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/checks/test_formatting_values.py b/tests/checks/test_formatting_values.py index 6611a55..a87907f 100644 --- a/tests/checks/test_formatting_values.py +++ b/tests/checks/test_formatting_values.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/checks/test_key_format.py b/tests/checks/test_key_format.py index aadcdf2..b90f1b0 100644 --- a/tests/checks/test_key_format.py +++ b/tests/checks/test_key_format.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/checks/test_missing_translations.py b/tests/checks/test_missing_translations.py index 9de3b86..c554b37 100644 --- a/tests/checks/test_missing_translations.py +++ b/tests/checks/test_missing_translations.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/checks/test_punctuation.py b/tests/checks/test_punctuation.py index 12cd815..bcdd8df 100644 --- a/tests/checks/test_punctuation.py +++ b/tests/checks/test_punctuation.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/checks/test_quotation_marks.py b/tests/checks/test_quotation_marks.py index eb5a5c6..6623029 100644 --- a/tests/checks/test_quotation_marks.py +++ b/tests/checks/test_quotation_marks.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/checks/test_starts_with_the_same_case.py b/tests/checks/test_starts_with_the_same_case.py index 33f9ded..928b739 100644 --- a/tests/checks/test_starts_with_the_same_case.py +++ b/tests/checks/test_starts_with_the_same_case.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/checks/test_substitutions.py b/tests/checks/test_substitutions.py index 8ead61a..2272ebd 100644 --- a/tests/checks/test_substitutions.py +++ b/tests/checks/test_substitutions.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/checks/test_trailing_white_chars.py b/tests/checks/test_trailing_white_chars.py index bc36883..9c1ad43 100644 --- a/tests/checks/test_trailing_white_chars.py +++ b/tests/checks/test_trailing_white_chars.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/checks/test_typesetting_quotation_marks.py b/tests/checks/test_typesetting_quotation_marks.py index 1494da8..3b43d3a 100644 --- a/tests/checks/test_typesetting_quotation_marks.py +++ b/tests/checks/test_typesetting_quotation_marks.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/checks/test_white_chars_before_linefeed.py b/tests/checks/test_white_chars_before_linefeed.py index f7971ef..a79bbf0 100644 --- a/tests/checks/test_white_chars_before_linefeed.py +++ b/tests/checks/test_white_chars_before_linefeed.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/config/__init__.py b/tests/config/__init__.py index 9c376f3..d146c67 100644 --- a/tests/config/__init__.py +++ b/tests/config/__init__.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/config/test_config.py b/tests/config/test_config.py index 3ddf5f4..ff94d24 100644 --- a/tests/config/test_config.py +++ b/tests/config/test_config.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/config/test_config_builder.py b/tests/config/test_config_builder.py index 7757bc3..08c1a53 100644 --- a/tests/config/test_config_builder.py +++ b/tests/config/test_config_builder.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/prop/__init__.py b/tests/prop/__init__.py index 9c376f3..d146c67 100644 --- a/tests/prop/__init__.py +++ b/tests/prop/__init__.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/prop/test_blank.py b/tests/prop/test_blank.py index 9366ec1..4650520 100644 --- a/tests/prop/test_blank.py +++ b/tests/prop/test_blank.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/prop/test_comment.py b/tests/prop/test_comment.py index eb837f0..df97ff5 100644 --- a/tests/prop/test_comment.py +++ b/tests/prop/test_comment.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/prop/test_file.py b/tests/prop/test_file.py index b653e28..1cd1fd2 100644 --- a/tests/prop/test_file.py +++ b/tests/prop/test_file.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/prop/test_prop_item.py b/tests/prop/test_prop_item.py index d0c82cf..eb402ea 100644 --- a/tests/prop/test_prop_item.py +++ b/tests/prop/test_prop_item.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/prop/test_translation.py b/tests/prop/test_translation.py index 73983ad..cbdacd2 100644 --- a/tests/prop/test_translation.py +++ b/tests/prop/test_translation.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/report/__init__.py b/tests/report/__init__.py index 9c376f3..d146c67 100644 --- a/tests/report/__init__.py +++ b/tests/report/__init__.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/report/test_report.py b/tests/report/test_report.py index 6a54e64..5781437 100644 --- a/tests/report/test_report.py +++ b/tests/report/test_report.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/report/test_report_group.py b/tests/report/test_report_group.py index e035568..a7a4eb3 100644 --- a/tests/report/test_report_group.py +++ b/tests/report/test_report_group.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/report/test_report_item.py b/tests/report/test_report_item.py index b54efeb..d044d8a 100644 --- a/tests/report/test_report_item.py +++ b/tests/report/test_report_item.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/test_case.py b/tests/test_case.py index 63b8a73..8ec866c 100644 --- a/tests/test_case.py +++ b/tests/test_case.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/tests/test_utils.py b/tests/test_utils.py index 1d8d294..878a740 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/__init__.py b/transtool/__init__.py index 9c376f3..d146c67 100644 --- a/transtool/__init__.py +++ b/transtool/__init__.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/checks/__init__.py b/transtool/checks/__init__.py index 9c376f3..d146c67 100644 --- a/transtool/checks/__init__.py +++ b/transtool/checks/__init__.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/checks/base/__init__.py b/transtool/checks/base/__init__.py index 9c376f3..d146c67 100644 --- a/transtool/checks/base/__init__.py +++ b/transtool/checks/base/__init__.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/checks/base/check.py b/transtool/checks/base/check.py index c2acc5e..1cfe96c 100644 --- a/transtool/checks/base/check.py +++ b/transtool/checks/base/check.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/checks/brackets.py b/transtool/checks/brackets.py index c5f6de8..73961a8 100644 --- a/transtool/checks/brackets.py +++ b/transtool/checks/brackets.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/checks/dangling_keys.py b/transtool/checks/dangling_keys.py index 55f5b5c..fc1326f 100644 --- a/transtool/checks/dangling_keys.py +++ b/transtool/checks/dangling_keys.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/checks/empty_translations.py b/transtool/checks/empty_translations.py index 0836a4b..392573e 100644 --- a/transtool/checks/empty_translations.py +++ b/transtool/checks/empty_translations.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/checks/formatting_values.py b/transtool/checks/formatting_values.py index 62204f5..74d635d 100644 --- a/transtool/checks/formatting_values.py +++ b/transtool/checks/formatting_values.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/checks/key_format.py b/transtool/checks/key_format.py index 3b51460..cd40639 100644 --- a/transtool/checks/key_format.py +++ b/transtool/checks/key_format.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/checks/missing_translations.py b/transtool/checks/missing_translations.py index d384ad4..edde923 100644 --- a/transtool/checks/missing_translations.py +++ b/transtool/checks/missing_translations.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/checks/punctuation.py b/transtool/checks/punctuation.py index b855702..840dda9 100644 --- a/transtool/checks/punctuation.py +++ b/transtool/checks/punctuation.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/checks/quotation_marks.py b/transtool/checks/quotation_marks.py index 9c7f0fb..b988961 100644 --- a/transtool/checks/quotation_marks.py +++ b/transtool/checks/quotation_marks.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/checks/starts_with_the_same_case.py b/transtool/checks/starts_with_the_same_case.py index 9652290..1dd00a8 100644 --- a/transtool/checks/starts_with_the_same_case.py +++ b/transtool/checks/starts_with_the_same_case.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/checks/substitutions.py b/transtool/checks/substitutions.py index 9266b93..63d0345 100644 --- a/transtool/checks/substitutions.py +++ b/transtool/checks/substitutions.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/checks/trailing_white_chars.py b/transtool/checks/trailing_white_chars.py index 275220a..2296b18 100644 --- a/transtool/checks/trailing_white_chars.py +++ b/transtool/checks/trailing_white_chars.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/checks/typesetting_quotation_marks.py b/transtool/checks/typesetting_quotation_marks.py index 760ab38..dde70db 100644 --- a/transtool/checks/typesetting_quotation_marks.py +++ b/transtool/checks/typesetting_quotation_marks.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/checks/white_chars_before_linefeed.py b/transtool/checks/white_chars_before_linefeed.py index 3ee6645..c6f8c2d 100644 --- a/transtool/checks/white_chars_before_linefeed.py +++ b/transtool/checks/white_chars_before_linefeed.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/config/__init__.py b/transtool/config/__init__.py index 9c376f3..d146c67 100644 --- a/transtool/config/__init__.py +++ b/transtool/config/__init__.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/config/builder.py b/transtool/config/builder.py index 3866291..d10e5ca 100644 --- a/transtool/config/builder.py +++ b/transtool/config/builder.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/config/checker_info.py b/transtool/config/checker_info.py index bce58c7..d63cfd0 100644 --- a/transtool/config/checker_info.py +++ b/transtool/config/checker_info.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/config/config.py b/transtool/config/config.py index 8748c83..fe1968a 100644 --- a/transtool/config/config.py +++ b/transtool/config/config.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/config/reader.py b/transtool/config/reader.py index 3efe765..62e2e6c 100644 --- a/transtool/config/reader.py +++ b/transtool/config/reader.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/const.py b/transtool/const.py index eba8ed1..55c1083 100644 --- a/transtool/const.py +++ b/transtool/const.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ @@ -22,7 +22,7 @@ class Const(object): APP_URL: str = 'https://github.com/MarcinOrlowski/trans-tool/' # The years during which the application was developed. - APP_YEARS: str = '2021-2023' + APP_YEARS: str = '2021-2024' APP_DESCRIPTION: List[str] = [ f'{APP_NAME} v{APP_VERSION} * Copyright {APP_YEARS} by Marcin Orlowski.', diff --git a/transtool/decorators/__init__.py b/transtool/decorators/__init__.py index 9c376f3..d146c67 100644 --- a/transtool/decorators/__init__.py +++ b/transtool/decorators/__init__.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/decorators/overrides.py b/transtool/decorators/overrides.py index dd3ca69..5cad568 100644 --- a/transtool/decorators/overrides.py +++ b/transtool/decorators/overrides.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/main.py b/transtool/main.py index e6b989c..aabdc2c 100644 --- a/transtool/main.py +++ b/transtool/main.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/prop/__init__.py b/transtool/prop/__init__.py index 9c376f3..d146c67 100644 --- a/transtool/prop/__init__.py +++ b/transtool/prop/__init__.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/prop/file.py b/transtool/prop/file.py index 5ad5636..fa559f2 100644 --- a/transtool/prop/file.py +++ b/transtool/prop/file.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/prop/items.py b/transtool/prop/items.py index 4df9793..61ced44 100644 --- a/transtool/prop/items.py +++ b/transtool/prop/items.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/report/__init__.py b/transtool/report/__init__.py index 9c376f3..d146c67 100644 --- a/transtool/report/__init__.py +++ b/transtool/report/__init__.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/report/group.py b/transtool/report/group.py index ad0fdd6..9de0ee3 100644 --- a/transtool/report/group.py +++ b/transtool/report/group.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/report/items.py b/transtool/report/items.py index 955df38..6189e6d 100644 --- a/transtool/report/items.py +++ b/transtool/report/items.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/report/report.py b/transtool/report/report.py index 741cbb8..f6ce4b6 100644 --- a/transtool/report/report.py +++ b/transtool/report/report.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ diff --git a/transtool/utils.py b/transtool/utils.py index 3fb3377..e350427 100644 --- a/transtool/utils.py +++ b/transtool/utils.py @@ -3,7 +3,7 @@ # trans-tool # The translation files checker and syncing tool. # -# Copyright ©2021-2023 Marcin Orlowski +# Copyright ©2021-2024 Marcin Orlowski # https://github.com/MarcinOrlowski/trans-tool/ # """ From 3c1281b2ffd58ffb78f8b501b5972c8a00ee41a6 Mon Sep 17 00:00:00 2001 From: Marcin Orlowski Date: Sun, 6 Oct 2024 11:53:59 +0200 Subject: [PATCH 3/3] Version bump --- docs/CHANGES.md | 3 +++ transtool/const.py | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/CHANGES.md b/docs/CHANGES.md index f353eea..a6c15c2 100644 --- a/docs/CHANGES.md +++ b/docs/CHANGES.md @@ -6,6 +6,9 @@ # Changelog # +* v2.5.4 (2024-10-06) + * Code and docs cleanup + * v2.5.3 (2023-10-24) * Replaced built-in logger class with external package (reinstall depdendencies!) * Updated documentation. diff --git a/transtool/const.py b/transtool/const.py index 55c1083..4ad92c8 100644 --- a/transtool/const.py +++ b/transtool/const.py @@ -16,7 +16,7 @@ class Const(object): APP_NAME: str = 'trans-tool' # The version of the application. - APP_VERSION: str = '2.5.3' + APP_VERSION: str = '2.5.4' # The URL of the application's repository. APP_URL: str = 'https://github.com/MarcinOrlowski/trans-tool/'