pre-commit-crocodile 2.0.0__py3-none-any.whl

pre_commit_crocodile/cli/main.py

@@ -0,0 +1,269 @@
+#!/usr/bin/env python3
+
+# Standard libraries
+from argparse import (
+    _ArgumentGroup,
+    _MutuallyExclusiveGroup,
+    ArgumentParser,
+    Namespace,
+    RawTextHelpFormatter,
+)
+from os import environ
+from shutil import get_terminal_size
+from sys import exit as sys_exit
+
+# Components
+from ..package.bundle import Bundle
+from ..package.settings import Settings
+from ..package.updates import Updates
+from ..package.version import Version
+from ..prints.colors import Colors
+from ..system.platform import Platform
+from ..types.environments import Environments
+from .entrypoint import Entrypoint
+
+# Constants
+HELP_POSITION: int = 23
+
+# Main, pylint: disable=too-many-branches,too-many-statements
+def main() -> None:
+
+    # Variables
+    environments: Environments
+    group: _ArgumentGroup
+    result: Entrypoint.Result = Entrypoint.Result.ERROR
+    subgroup: _MutuallyExclusiveGroup
+
+    # Configure environment variables
+    environments = Environments()
+
+    # Arguments creation
+    parser: ArgumentParser = ArgumentParser(
+        prog=Bundle.NAME,
+        description=f'{Bundle.NAME}: {Bundle.DESCRIPTION}',
+        epilog=environments.help(HELP_POSITION),
+        add_help=False,
+        formatter_class=lambda prog: RawTextHelpFormatter(
+            prog,
+            max_help_position=HELP_POSITION,
+            width=min(
+                120,
+                get_terminal_size().columns - 2,
+            ),
+        ),
+    )
+
+    # Arguments internal definitions
+    group = parser.add_argument_group('internal arguments')
+    group.add_argument(
+        '-h',
+        '--help',
+        dest='help',
+        action='store_true',
+        help='Show this help message',
+    )
+    group.add_argument(
+        '--version',
+        dest='version',
+        action='store_true',
+        help='Show the current version',
+    )
+    group.add_argument(
+        '--no-color',
+        dest='no_color',
+        action='store_true',
+        help=f'Disable colors outputs with \'{Bundle.ENV_NO_COLOR}=1\'\n'
+        '(or default settings: [themes] > no_color)',
+    )
+    group.add_argument(
+        '--update-check',
+        dest='update_check',
+        action='store_true',
+        help='Check for newer package updates',
+    )
+    group.add_argument(
+        '--settings',
+        dest='settings',
+        action='store_true',
+        help='Show the current settings path and contents',
+    )
+    group.add_argument(
+        '--set',
+        dest='set',
+        action='store',
+        metavar=('GROUP', 'KEY', 'VAL'),
+        nargs=3,
+        help='Set settings specific \'VAL\' value to [GROUP] > KEY\n' \
+             'or unset by using \'UNSET\' as \'VAL\'',
+    )
+
+    # Arguments modes definitions
+    group = parser.add_argument_group('modes arguments')
+    subgroup = group.add_mutually_exclusive_group()
+    subgroup.add_argument(
+        '-l',
+        '--list',
+        dest='list',
+        action='store_true',
+        help='List Git hooks installed in sources',
+    )
+    subgroup.add_argument(
+        '-i',
+        '--install',
+        dest='install',
+        action='store_true',
+        help='Install dependencies for pre-commit hooks',
+    )
+    subgroup.add_argument(
+        '-c',
+        '--configure',
+        dest='configure',
+        action='store_true',
+        help='Update sources with hooks configurations',
+    )
+    subgroup.add_argument(
+        '-e',
+        '--enable',
+        dest='enable',
+        action='store_true',
+        help='Enable pre-commit hooks',
+    )
+    subgroup.add_argument(
+        '-d',
+        '--disable',
+        dest='disable',
+        action='store_true',
+        help='Disable pre-commit hooks',
+    )
+    subgroup.add_argument(
+        '-a',
+        '--autoupdate',
+        dest='autoupdate',
+        action='store_true',
+        help='Autoupdate pre-commit hooks',
+    )
+    subgroup.add_argument(
+        '-r',
+        '--run',
+        dest='run',
+        action='store_true',
+        help='Run pre-commit hooks',
+    )
+
+    # Arguments positional definitions
+    group = parser.add_argument_group('positional arguments')
+    group.add_argument(
+        '--',
+        dest='double_dash',
+        action='store_true',
+        help='Positional arguments separator (recommended)',
+    )
+
+    # Arguments parser
+    options: Namespace = parser.parse_args()
+
+    # Help informations
+    if options.help:
+        print(' ')
+        parser.print_help()
+        print(' ')
+        Platform.flush()
+        sys_exit(0)
+
+    # Instantiate settings
+    settings: Settings = Settings(name=Bundle.NAME)
+
+    # Prepare no_color
+    if not options.no_color:
+        if settings.has('themes', 'no_color'):
+            options.no_color = settings.get_bool('themes', 'no_color')
+        else:
+            options.no_color = False
+            settings.set_bool('themes', 'no_color', options.no_color)
+
+    # Configure no_color
+    if options.no_color:
+        environ[Bundle.ENV_NO_COLOR] = '1'
+
+    # Prepare colors
+    Colors.prepare()
+
+    # Settings setter
+    if options.set:
+        settings.set(options.set[0], options.set[1], options.set[2])
+        settings.show()
+        sys_exit(0)
+
+    # Settings informations
+    if options.settings:
+        settings.show()
+        sys_exit(0)
+
+    # Instantiate updates
+    updates: Updates = Updates(
+        name=Bundle.NAME,
+        settings=settings,
+    )
+
+    # Version informations
+    if options.version:
+        print(
+            f'{Bundle.NAME} {Version.get()} from {Version.path()} (python {Version.python()})'
+        )
+        Platform.flush()
+        sys_exit(0)
+
+    # Check for current updates
+    if options.update_check:
+        if not updates.check():
+            updates.check(older=True)
+        sys_exit(0)
+
+    # Arguments modes
+    if options.enable:
+        options.run = True
+    elif options.autoupdate:
+        options.enable = True
+    elif not (options.list or options.install or options.configure or options.disable
+              or options.run):
+        result = Entrypoint.Result.CRITICAL
+
+    # Header
+    print(' ')
+    Platform.flush()
+
+    # Tool identifier
+    if result != Entrypoint.Result.CRITICAL:
+        print(f'{Colors.BOLD} {Bundle.NAME}'
+              f'{Colors.YELLOW_LIGHT} ({Version.get()})'
+              f'{Colors.RESET}')
+        Platform.flush()
+
+    # CLI entrypoint
+    if result != Entrypoint.Result.CRITICAL:
+        result = Entrypoint.cli(options)
+
+    # CLI helper
+    else:
+        parser.print_help()
+
+    # Footer
+    print(' ')
+    Platform.flush()
+
+    # Check for daily updates
+    if updates.enabled and updates.daily:
+        updates.check()
+
+    # Result
+    if result in [
+            Entrypoint.Result.SUCCESS,
+            Entrypoint.Result.FINALIZE,
+    ]:
+        sys_exit(0)
+    else:
+        sys_exit(1)
+
+# Entrypoint
+if __name__ == '__main__': # pragma: no cover
+    main()

pre_commit_crocodile/hooks/configurations.py

@@ -0,0 +1,322 @@
+#!/usr/bin/env python3
+
+# Standard libraries
+from typing import List, NamedTuple
+
+# Changes regex type
+ChangesRegex = str
+
+# Changes parsers class
+class ChangesParsers(NamedTuple):
+    match: str
+    groups: List[int]
+    commit_type: str
+
+# Changes evaluator class
+class ChangesEvaluator(NamedTuple):
+    changes: List[ChangesRegex]
+    parsers: List[ChangesParsers]
+
+# Changes types class
+class ChangesType(NamedTuple):
+    commit_type: str
+    changes: List[ChangesRegex]
+
+# Changes matcher class
+class ChangesMatcher(NamedTuple):
+    commit_scope: str
+    types: List[ChangesType]
+
+# Commits changes constants
+COMMITS_CHANGES_PATTERN: str = r'^#\s*(new file|modified|deleted|renamed|copied):\s*(.+)$'
+COMMITS_CHANGES_SECTION: str = '# Changes to be committed:'
+
+# Commits comments constants
+COMMITS_COMMENTS_PREFIX: str = '#'
+
+# Commits default constants
+COMMITS_DEFAULT_BODY: str = '# Issue: #...'
+COMMITS_DEFAULT_SCOPE: str = 'scope'
+COMMITS_DEFAULT_SUBJECT: str = ''
+COMMITS_DEFAULT_TYPE: str = 'type'
+
+# Commits footers constants
+COMMITS_FOOTER_SIGNOFF: str = 'Signed-off-by: '
+
+# Commits message constants
+COMMITS_MESSAGE_EOL: str = '\n'
+
+# Regex constants
+REGEX_EXT: str = r'[^/.]*'
+REGEX_FOLDER: str = r'[^/]+?'
+REGEX_STEM: str = r'[^/]+?'
+REGEX_STEM_VISIBLE: str = r'[^/_\.]{1}[^/]+?'
+
+# Changes evaluators constants # pylint: disable=line-too-long
+CHANGES_EVALUATORS: List[ChangesEvaluator] = [
+    # Sources
+    ChangesEvaluator(
+        changes=[
+            r'^sources|^src',
+        ],
+        parsers=[
+            ChangesParsers(
+                match=
+                fr'(({REGEX_FOLDER})/)??(({REGEX_FOLDER})/)?({REGEX_STEM_VISIBLE})\.{REGEX_EXT}$',
+                groups=[5, 4, 2],
+                commit_type='fix',
+            ),
+        ],
+    ),
+    # Documentations
+    ChangesEvaluator(
+        changes=[
+            r'^docs/',
+        ],
+        parsers=[
+            ChangesParsers(
+                match=
+                fr'(({REGEX_FOLDER})/)??(({REGEX_FOLDER})/)?({REGEX_STEM_VISIBLE})(\.{REGEX_EXT})?$',
+                groups=[5, 4, 2],
+                commit_type='docs',
+            ),
+        ],
+    ),
+    # Containers
+    ChangesEvaluator(
+        changes=[
+            r'^containers/',
+        ],
+        parsers=[
+            ChangesParsers(
+                match=
+                fr'(({REGEX_FOLDER})/)??(({REGEX_FOLDER})/)?({REGEX_STEM_VISIBLE})(\.{REGEX_EXT})?$',
+                groups=[4, 2],
+                commit_type='build',
+            ),
+        ],
+    ),
+    # Templates
+    ChangesEvaluator(
+        changes=[
+            r'^templates/',
+        ],
+        parsers=[
+            ChangesParsers(
+                match=
+                fr'(({REGEX_FOLDER})/)??(({REGEX_FOLDER})/)?({REGEX_STEM_VISIBLE})(\.{REGEX_EXT})?$',
+                groups=[5, 4, 2],
+                commit_type='ci',
+            ),
+        ],
+    ),
+    # Tests
+    ChangesEvaluator(
+        changes=[
+            r'^test[s]?/',
+        ],
+        parsers=[
+            ChangesParsers(
+                match=
+                fr'(({REGEX_FOLDER})/)??(({REGEX_FOLDER})/)?({REGEX_STEM_VISIBLE})(\.{REGEX_EXT})?$',
+                groups=[5, 4, 2],
+                commit_type='test',
+            ),
+        ],
+    ),
+    # Yocto
+    ChangesEvaluator(
+        changes=[
+            fr'conf/(distro|machine)|recipes-{REGEX_STEM}',
+        ],
+        parsers=[
+            ChangesParsers(
+                match=fr'conf/(distro|machine)/{REGEX_STEM}.conf$',
+                groups=[1],
+                commit_type='fix',
+            ),
+            ChangesParsers(
+                match=fr'({REGEX_STEM})/{REGEX_STEM}\.(bb[^/.]*|inc)$',
+                groups=[1],
+                commit_type='fix',
+            ),
+            ChangesParsers(
+                match=fr'recipes-{REGEX_STEM}/({REGEX_STEM})/.*',
+                groups=[1],
+                commit_type='fix',
+            ),
+        ],
+    ),
+]
+
+# Changes matchers constant
+CHANGES_MATCHERS: List[ChangesMatcher] = [
+    ChangesMatcher(
+        commit_scope='gitlab-ci',
+        types=[
+            ChangesType(
+                commit_type='ci',
+                changes=[
+                    r'\.gitlab-ci\.yml$',
+                    r'\.gitlab-ci\.d$',
+                ],
+            ),
+        ],
+    ),
+    ChangesMatcher(
+        commit_scope='hooks',
+        types=[
+            ChangesType(
+                commit_type='chore',
+                changes=[
+                    r'^\.hooks',
+                ],
+            ),
+        ],
+    ),
+    ChangesMatcher(
+        commit_scope='gitignore',
+        types=[
+            ChangesType(
+                commit_type='chore',
+                changes=[
+                    r'\.gitignore$',
+                ],
+            ),
+        ],
+    ),
+    ChangesMatcher(
+        commit_scope='makefile',
+        types=[
+            ChangesType(
+                commit_type='build',
+                changes=[
+                    r'Makefile$',
+                    r'\.make$',
+                ],
+            ),
+        ],
+    ),
+    ChangesMatcher(
+        commit_scope='commitizen',
+        types=[
+            ChangesType(
+                commit_type='chore',
+                changes=[
+                    r'\.cz.*$',
+                ],
+            ),
+        ],
+    ),
+    ChangesMatcher(
+        commit_scope='coveragerc',
+        types=[
+            ChangesType(
+                commit_type='chore',
+                changes=[
+                    r'.coveragerc$',
+                ],
+            ),
+        ],
+    ),
+    ChangesMatcher(
+        commit_scope='mkdocs',
+        types=[
+            ChangesType(
+                commit_type='docs',
+                changes=[
+                    r'^mkdocs\.yml$',
+                ],
+            ),
+        ],
+    ),
+    ChangesMatcher(
+        commit_scope='mypy',
+        types=[
+            ChangesType(
+                commit_type='chore',
+                changes=[
+                    r'mypy\.ini$',
+                ],
+            ),
+        ],
+    ),
+    ChangesMatcher(
+        commit_scope='pre-commit',
+        types=[
+            ChangesType(
+                commit_type='chore',
+                changes=[
+                    r'\.pre-commit.*$',
+                    r'^pre_commit_hooks/',
+                ],
+            ),
+        ],
+    ),
+    ChangesMatcher(
+        commit_scope='requirements',
+        types=[
+            ChangesType(
+                commit_type='build',
+                changes=[
+                    r'^requirements/',
+                ],
+            ),
+        ],
+    ),
+    ChangesMatcher(
+        commit_scope='setup',
+        types=[
+            ChangesType(
+                commit_type='chore',
+                changes=[
+                    r'setup\.py$',
+                ],
+            ),
+        ],
+    ),
+    ChangesMatcher(
+        commit_scope='vscode',
+        types=[
+            ChangesType(
+                commit_type='chore',
+                changes=[
+                    r'\.vscode/',
+                ],
+            ),
+        ],
+    ),
+    ChangesMatcher(
+        commit_scope='license',
+        types=[
+            ChangesType(
+                commit_type='docs',
+                changes=[
+                    r'LICENSE.*$',
+                ],
+            ),
+        ],
+    ),
+    ChangesMatcher(
+        commit_scope='readme',
+        types=[
+            ChangesType(
+                commit_type='docs',
+                changes=[
+                    r'README.*$',
+                ],
+            ),
+        ],
+    ),
+    ChangesMatcher(
+        commit_scope='changelog',
+        types=[
+            ChangesType(
+                commit_type='docs',
+                changes=[
+                    r'CHANGELOG.*$',
+                ],
+            ),
+        ],
+    ),
+]