file_sync_tool.utility.helper.dict_to_args() - Code Metrics - jackd248/file-sync-tool - Measure and Improve Code Quality continuously with Scrutinizer

file_sync_tool.utility.helper.dict_to_args() A
last analyzed 2025-04-10 06:33 UTC

↳ Parent: file_sync_tool.utility.helper

Complexity

Conditions

Size

Total Lines	17
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
eloc	11
nop	1
dl	0
loc	17
rs	9.3333
c	0
b	0
f	0

#!/usr/bin/env python3

# -*- coding: future_fstrings -*-

import sys

import os

import re
from db_sync_tool.utility import mode, system, output
from file_sync_tool.transfer import utility



def check_rsync_version():
    """
    Check rsync version
    :return:
    """
    _raw_version = mode.run_command(
        'rsync --version',
        mode.Client.LOCAL,
        True
    )
    _version = parse_version(_raw_version)
    output.message(
        output.Subject.LOCAL,
        f'rsync version {_version}'
    )


def check_sshpass_version():

    """
    Check sshpass version
    :return:
    """
    system.config['use_sshpass'] = False
    _raw_version = mode.run_command(
        'sshpass -V',
        mode.Client.LOCAL,
        force_output=True,
        allow_fail=True
    )
    _version = parse_version(_raw_version)

    if _version:
        output.message(
            output.Subject.LOCAL,
            f'sshpass version {_version}'
        )
        system.config['use_sshpass'] = True
        return True


def parse_version(output):
param = 5

class Foo:
    def __init__(self, param):   # "param" would be flagged here
        self.param = param
    """
    Parse version out of console output
    https://stackoverflow.com/a/60730346
    :param output: String
    :return:
    """
    _version_pattern = r'\d+(=?\.(\d+(=?\.(\d+)*)*)*)*'
    _regex_matcher = re.compile(_version_pattern)
    _version = _regex_matcher.search(output)
    if _version:

        return _version.group(0)
    else:
        return None


def check_authorizations():
    """
    Check authorization for clients
    :return:
    """
    if system.config['use_sshpass']:
        # When using sshpass, check for passwords
        system.check_authorization(mode.Client.ORIGIN)
        system.check_authorization(mode.Client.TARGET)
    elif not 'ssh_key' in system.config[mode.Client.ORIGIN] and \
            not 'ssh_key' in system.config[mode.Client.TARGET] and \
            (mode.get_sync_mode() == mode.SyncMode.PROXY or len(system.config['files']['config']) > 1):

        # Suggest to install sshpass
        output.message(
            output.Subject.INFO,
            f'Suggestion: Install {output.CliFormat.BOLD}sshpass{output.CliFormat.ENDC} to avoid multiple input of ssh passwords'

        )


def dict_to_args(dict):

    """
    Convert an dictionary to a args list
    :param dict: Dictionary
    :return: List
    """
    _args = []
    for key, val in dict.items():
        if isinstance(val, bool):
            if val:
                _args.append(f'--{key}')
        else:
            _args.append(f'--{key}')
            _args.append(str(val))
    if len(_args) == 0:
        return None
    return _args


def adjust_sync_mode():
    """

    :return:
    """
    if mode.get_sync_mode() == mode.SyncMode.DUMP_LOCAL:
        mode.sync_mode = mode.SyncMode.SYNC_LOCAL
    if mode.get_sync_mode() == mode.SyncMode.DUMP_REMOTE:
        mode.sync_mode = mode.SyncMode.SYNC_REMOTE


def extend_config(args):
    """
    Extending optional config
    :param args:
    :return:
    """
    config = system.config

    if args is None or not args:
        return config

    if not args.target_host is None:
        config['target']['host'] = args.target_host

    if not args.target_user is None:
        config['target']['user'] = args.target_user

    if not args.target_password is None:
        config['target']['password'] = args.target_password

    if not args.target_key is None:
        config['target']['ssh_key'] = args.target_key

    if not args.target_port is None:
        config['target']['port'] = args.target_port

    if not args.origin_host is None:
        config['origin']['host'] = args.origin_host

    if not args.origin_user is None:
        config['origin']['user'] = args.origin_user

    if not args.origin_password is None:
        config['origin']['password'] = args.origin_password

    if not args.origin_key is None:
        config['origin']['ssh_key'] = args.origin_key

    if not args.origin_port is None:
        config['origin']['port'] = args.origin_port

    if not args.files_origin is None:
        if 'config' not in config['files']:
            config['files']['config'] = []
            config['files']['config'].append({})
        config['files']['config'][0]['origin'] = args.files_origin

    if not args.files_target is None:
        if 'config' not in config['files']:
            config['files']['config'] = []
            config['files']['config'].append({})
        config['files']['config'][0]['target'] = args.files_target

    if not args.files_exclude is None:
        config['files']['config'][0]['exclude'] = args.files_exclude.split(',')

    if not args.files_option is None:
        config['files']['option'] = args.files_option.split(',')

    return config


1			#!/usr/bin/env python3
			0 ignored issues – show introduced 2020-12-28 17:01 UTC by Report Bug Copy Issue Report Missing module docstring Loading history...
2			# -- coding: future_fstrings --
3
4			import sys
			0 ignored issues – show Unused Code introduced 2020-12-28 17:01 UTC by Report Bug Copy Issue Report The import `sys` seems to be unused. Loading history...
5			import os
			0 ignored issues – show Unused Code introduced 2020-12-28 17:01 UTC by Report Bug Copy Issue Report The import `os` seems to be unused. Loading history...
6			import re
7			from db_sync_tool.utility import mode, system, output
8			from file_sync_tool.transfer import utility
			0 ignored issues – show Unused Code introduced 2020-12-28 17:01 UTC by Report Bug Copy Issue Report Unused utility imported from file_sync_tool.transfer Loading history...
9
10
11			def check_rsync_version():
12			"""
13			Check rsync version
14			:return:
15			"""
16			_raw_version = mode.run_command(
17			'rsync --version',
18			mode.Client.LOCAL,
19			True
20			)
21			_version = parse_version(_raw_version)
22			output.message(
23			output.Subject.LOCAL,
24			f'rsync version {_version}'
25			)
26
27
28			def check_sshpass_version():
			0 ignored issues – show Unused Code introduced 2020-12-28 17:01 UTC by Report Bug Copy Issue Report Either all return statements in a function should return an expression, or none of them should. Loading history...
29			"""
30			Check sshpass version
31			:return:
32			"""
33			system.config['use_sshpass'] = False
34			_raw_version = mode.run_command(
35			'sshpass -V',
36			mode.Client.LOCAL,
37			force_output=True,
38			allow_fail=True
39			)
40			_version = parse_version(_raw_version)
41
42			if _version:
43			output.message(
44			output.Subject.LOCAL,
45			f'sshpass version {_version}'
46			)
47			system.config['use_sshpass'] = True
48			return True
49
50
51			def parse_version(output):
			0 ignored issues – show Comprehensibility Bug introduced 2020-12-28 17:01 UTC by Report Bug Copy Issue Report `output` is re-defining a name which is already available in the outer-scope (previously defined on line `7`). It is generally a bad practice to shadow variables from the outer-scope. In most cases, this is done unintentionally and might lead to unexpected behavior: param = 5 class Foo: def __init__(self, param): # "param" would be flagged here self.param = param Loading history...
52			"""
53			Parse version out of console output
54			https://stackoverflow.com/a/60730346
55			:param output: String
56			:return:
57			"""
58			_version_pattern = r'\d+(=?\.(\d+(=?\.(\d+))))'
59			_regex_matcher = re.compile(_version_pattern)
60			_version = _regex_matcher.search(output)
61			if _version:
			0 ignored issues – show unused-code introduced 2020-12-28 17:01 UTC by Report Bug Copy Issue Report Unnecessary "else" after "return" Loading history...
62			return _version.group(0)
63			else:
64			return None
65
66
67			def check_authorizations():
68			"""
69			Check authorization for clients
70			:return:
71			"""
72			if system.config['use_sshpass']:
73			# When using sshpass, check for passwords
74			system.check_authorization(mode.Client.ORIGIN)
75			system.check_authorization(mode.Client.TARGET)
76			elif not 'ssh_key' in system.config[mode.Client.ORIGIN] and \
77			not 'ssh_key' in system.config[mode.Client.TARGET] and \
78			(mode.get_sync_mode() == mode.SyncMode.PROXY or len(system.config['files']['config']) > 1):
			0 ignored issues – show Coding Style introduced 2020-12-28 17:01 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (103/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
79			# Suggest to install sshpass
80			output.message(
81			output.Subject.INFO,
82			f'Suggestion: Install {output.CliFormat.BOLD}sshpass{output.CliFormat.ENDC} to avoid multiple input of ssh passwords'
			0 ignored issues – show Coding Style introduced 2020-12-28 17:01 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (129/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
83			)
84
85
86			def dict_to_args(dict):
			0 ignored issues – show Bug Best Practice introduced 2022-05-04 14:50 UTC by Report Bug Copy Issue Report This seems to re-define the built-in `dict`. It is generally discouraged to redefine built-ins as this makes code very hard to read. Loading history...
87			"""
88			Convert an dictionary to a args list
89			:param dict: Dictionary
90			:return: List
91			"""
92			_args = []
93			for key, val in dict.items():
94			if isinstance(val, bool):
95			if val:
96			_args.append(f'--{key}')
97			else:
98			_args.append(f'--{key}')
99			_args.append(str(val))
100			if len(_args) == 0:
101			return None
102			return _args
103
104
105			def adjust_sync_mode():
106			"""
107
108			:return:
109			"""
110			if mode.get_sync_mode() == mode.SyncMode.DUMP_LOCAL:
111			mode.sync_mode = mode.SyncMode.SYNC_LOCAL
112			if mode.get_sync_mode() == mode.SyncMode.DUMP_REMOTE:
113			mode.sync_mode = mode.SyncMode.SYNC_REMOTE
114
115
116			def extend_config(args):
117			"""
118			Extending optional config
119			:param args:
120			:return:
121			"""
122			config = system.config
123
124			if args is None or not args:
125			return config
126
127			if not args.target_host is None:
128			config['target']['host'] = args.target_host
129
130			if not args.target_user is None:
131			config['target']['user'] = args.target_user
132
133			if not args.target_password is None:
134			config['target']['password'] = args.target_password
135
136			if not args.target_key is None:
137			config['target']['ssh_key'] = args.target_key
138
139			if not args.target_port is None:
140			config['target']['port'] = args.target_port
141
142			if not args.origin_host is None:
143			config['origin']['host'] = args.origin_host
144
145			if not args.origin_user is None:
146			config['origin']['user'] = args.origin_user
147
148			if not args.origin_password is None:
149			config['origin']['password'] = args.origin_password
150
151			if not args.origin_key is None:
152			config['origin']['ssh_key'] = args.origin_key
153
154			if not args.origin_port is None:
155			config['origin']['port'] = args.origin_port
156
157			if not args.files_origin is None:
158			if 'config' not in config['files']:
159			config['files']['config'] = []
160			config['files']['config'].append({})
161			config['files']['config'][0]['origin'] = args.files_origin
162
163			if not args.files_target is None:
164			if 'config' not in config['files']:
165			config['files']['config'] = []
166			config['files']['config'].append({})
167			config['files']['config'][0]['target'] = args.files_target
168
169			if not args.files_exclude is None:
170			config['files']['config'][0]['exclude'] = args.files_exclude.split(',')
171
172			if not args.files_option is None:
173			config['files']['option'] = args.files_option.split(',')
174
175			return config
176

jackd248 / file-sync-tool

file_sync_tool.utility.helper.dict_to_args() A last analyzed 2025-04-10 06:33 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

file_sync_tool.utility.helper.dict_to_args() A
last analyzed 2025-04-10 06:33 UTC