process_homepath() - Code Metrics - Inspection of "add remote option for ota scan" - thurask/bbarchivist - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a42aad...9def7b )

by John

created 2018-01-20 18:46 UTC

process_homepath() B

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	4

Importance

Changes

Metric	Value
cc	4
dl	0
loc	22
ccs	8
cts	8
cp	1
crap	4
rs	8.9197
c	0
b	0
f	0

#!/usr/bin/env python3
"""This module is used for generic configuration parsing."""

import configparser  # config parsing, duh
import os  # path work
import shutil  # moving

from appdirs import AppDirs  # folders
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3

__author__ = "Thurask"
__license__ = "WTFPL v2"
__copyright__ = "2016-2018 Thurask"


def config_emptysection(config, section):
    """
    Create empty configuration section.

    :param config: Configuration dictionary.
    :type config: configparser.ConfigParser

    :param section: Section of ini file to return.
    :type section: str
    """
    if not config.has_section(section):
        config[section] = {}
    return config


def config_homepath(homepath, logpath=False, cachepath=False):
    """
    Fix path for ini file.

    :param homepath: Path to ini file.
    :type homepath: str

    :param logpath: True if processing log folder, False if not. Default is False.
    :type logpath: bool

    :param cachepath: True if processing cache folder, False if not. Default is False.
    :type cachepath: bool
    """
    if homepath is None:
        rawpath = config_rawdir(logpath, cachepath)
        homepath = process_homepath(rawpath, logpath, cachepath)
    return homepath


def config_rawdir(logpath=False, cachepath=False):
    """
    Get new config dir.

    :param logpath: True if processing log folder, False if not. Default is False.
    :type logpath: bool

    :param cachepath: True if processing cache folder, False if not. Default is False.
    :type cachepath: bool
    """
    apdi = AppDirs("bbarchivist", "bbarchivist")
    if logpath:
        rawpath = apdi.user_log_dir
    elif cachepath:
        rawpath = apdi.user_cache_dir
    else:
        rawpath = apdi.user_data_dir
    return rawpath


def process_homepath(homepath, logpath=False, cachepath=False):
    """
    Prepare homepath if it doesn't exist.

    :param homepath: Path to data directory.
    :type homepath: str

    :param logpath: True if processing log folder, False if not. Default is False.
    :type logpath: bool

    :param cachepath: True if processing cache folder, False if not. Default is False.
    :type cachepath: bool
    """
    if not os.path.exists(homepath):
        os.makedirs(homepath)
    if logpath:
        migrate_logs(homepath)
    elif not cachepath:
        migrate_files(homepath)
    else:
        pass
    return homepath


def migrate_files(homepath):
    """
    Prepare ini file and SQL DB for new homepath.

    :param homepath: Path to data directory.
    :type homepath: str
    """
    files = ("bbarchivist.ini", "bbarchivist.db")
    for file in files:
        oldfile = os.path.join(os.path.expanduser("~"), file)
        newfile = os.path.join(homepath, file)
        conditional_move(oldfile, newfile)


def migrate_logs(homepath):
    """
    Prepare log directory for new homepath.

    :param homepath: Path to data directory.
    :type homepath: str
    """
    olddir = os.path.join(os.path.expanduser("~"), "lookuplogs")
    if os.path.exists(olddir):
        log_move(olddir, homepath)
        shutil.rmtree(olddir)


def conditional_move(oldfile, newfile):
    """
    Migrate from user directory to dedicated appdata/.local dir.

    :param oldfile: Path to old config file.
    :type oldfile: str

    :param newfile: Path to new config file.
    :type newfile: str
    """
    if os.path.exists(oldfile):
        if os.path.exists(newfile):
            os.remove(oldfile)  # remove old
        else:
            shutil.move(oldfile, newfile)  # migrate to new


def log_move(olddir, homepath):
    """
    Migrate logs from user directory subfolder to dedicated appdata/.local dir.

    :param olddir: Path to old log dir.
    :type olddir: str

    :param homepath: Path to new log directory.
    :type homepath: str
    """
    oldlogs = [os.path.join(olddir, logfile) for logfile in os.listdir(olddir)]
    if oldlogs:
        for log in oldlogs:
            shutil.move(log, os.path.abspath(homepath))


def config_conffile(conffile):
    """
    Create ini file if it doesn't exist.

    :param conffile: Path to config ini file.
    :type conffile: str
    """
    if not os.path.exists(conffile):
        open(conffile, 'w').close()


def config_location(homepath=None):
    """
    Return config location.

    :param homepath: Folder containing ini file. Default is user directory.
    :type homepath: str
    """
    homepath = config_homepath(homepath)
    conffile = os.path.join(homepath, "bbarchivist.ini")
    return conffile


def generic_preamble(section, homepath=None):
    """
    Read a ConfigParser file, return whole config.

    :param section: Section of ini file to return.
    :type section: str

    :param homepath: Folder containing ini file. Default is user directory.
    :type homepath: str
    """
    config = configparser.ConfigParser()
    conffile = config_location(homepath)
    config_conffile(conffile)
    config.read(conffile)
    config = config_emptysection(config, section)
    return config


def generic_loader(section, homepath=None):
    """
    Read a ConfigParser file, return section.

    :param section: Section of ini file to return.
    :type section: str

    :param homepath: Folder containing ini file. Default is user directory.
    :type homepath: str
    """
    config = generic_preamble(section, homepath)
    ini = config[section]
    return ini


def generic_writer(section, resultdict, homepath=None):
    """
    Write a ConfigParser file.

    :param section: Section of ini file to write.
    :type section: str

    :param resultdict: Dictionary of configs: {key: value}
    :type resultdict: dict({str, bool})

    :param homepath: Folder containing ini file. Default is user directory.
    :type homepath: str
    """
    config = generic_preamble(section, homepath)
    for key, value in resultdict.items():
        config.set(section, key, str(value))
    conffile = config_location(homepath)
    with open(conffile, "w") as configfile:
        config.write(configfile)


Push — master ( a42aad...9def7b )

process_homepath() B

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing Dependencies

2. Missing init.py files

1		#!/usr/bin/env python3
2	5	"""This module is used for generic configuration parsing."""
3
4	5	import configparser # config parsing, duh
5	5	import os # path work
6	5	import shutil # moving
7
8	5	from appdirs import AppDirs # folders
		0 ignored issues – show Configuration introduced 2018-01-19 19:34 UTC by Report Bug Copy Issue Report The import `appdirs` could not be resolved. This can be caused by one of the following: 1. Missing Dependencies This error could indicate a configuration issue of Pylint. Make sure that your libraries are available by adding the necessary commands. # .scrutinizer.yml before_commands: - sudo pip install abc # Python2 - sudo pip3 install abc # Python3 Tip: We are currently not using virtualenv to run pylint, when installing your modules make sure to use the command for the correct version. 2. Missing __init__.py files This error could also result from missing `__init__.py` files in your module folders. Make sure that you place one file in each sub-folder. Loading history...
9
10	5	__author__ = "Thurask"
11	5	__license__ = "WTFPL v2"
12	5	__copyright__ = "2016-2018 Thurask"
13
14
15	5	def config_emptysection(config, section):
16		"""
17		Create empty configuration section.
18
19		:param config: Configuration dictionary.
20		:type config: configparser.ConfigParser
21
22		:param section: Section of ini file to return.
23		:type section: str
24		"""
25	5	if not config.has_section(section):
26	5	config[section] = {}
27	5	return config
28
29
30	5	def config_homepath(homepath, logpath=False, cachepath=False):
31		"""
32		Fix path for ini file.
33
34		:param homepath: Path to ini file.
35		:type homepath: str
36
37		:param logpath: True if processing log folder, False if not. Default is False.
38		:type logpath: bool
39
40		:param cachepath: True if processing cache folder, False if not. Default is False.
41		:type cachepath: bool
42		"""
43	5	if homepath is None:
44	5	rawpath = config_rawdir(logpath, cachepath)
45	5	homepath = process_homepath(rawpath, logpath, cachepath)
46	5	return homepath
47
48
49	5	def config_rawdir(logpath=False, cachepath=False):
50		"""
51		Get new config dir.
52
53		:param logpath: True if processing log folder, False if not. Default is False.
54		:type logpath: bool
55
56		:param cachepath: True if processing cache folder, False if not. Default is False.
57		:type cachepath: bool
58		"""
59	5	apdi = AppDirs("bbarchivist", "bbarchivist")
60	5	if logpath:
61	5	rawpath = apdi.user_log_dir
62	5	elif cachepath:
63	5	rawpath = apdi.user_cache_dir
64		else:
65	5	rawpath = apdi.user_data_dir
66	5	return rawpath
67
68
69	5	def process_homepath(homepath, logpath=False, cachepath=False):
70		"""
71		Prepare homepath if it doesn't exist.
72
73		:param homepath: Path to data directory.
74		:type homepath: str
75
76		:param logpath: True if processing log folder, False if not. Default is False.
77		:type logpath: bool
78
79		:param cachepath: True if processing cache folder, False if not. Default is False.
80		:type cachepath: bool
81		"""
82	5	if not os.path.exists(homepath):
83	5	os.makedirs(homepath)
84	5	if logpath:
85	5	migrate_logs(homepath)
86	5	elif not cachepath:
87	5	migrate_files(homepath)
88		else:
89		pass
90	5	return homepath
91
92
93	5	def migrate_files(homepath):
94		"""
95		Prepare ini file and SQL DB for new homepath.
96
97		:param homepath: Path to data directory.
98		:type homepath: str
99		"""
100	5	files = ("bbarchivist.ini", "bbarchivist.db")
101	5	for file in files:
102	5	oldfile = os.path.join(os.path.expanduser("~"), file)
103	5	newfile = os.path.join(homepath, file)
104	5	conditional_move(oldfile, newfile)
105
106
107	5	def migrate_logs(homepath):
108		"""
109		Prepare log directory for new homepath.
110
111		:param homepath: Path to data directory.
112		:type homepath: str
113		"""
114	5	olddir = os.path.join(os.path.expanduser("~"), "lookuplogs")
115	5	if os.path.exists(olddir):
116	5	log_move(olddir, homepath)
117	5	shutil.rmtree(olddir)
118
119
120	5	def conditional_move(oldfile, newfile):
121		"""
122		Migrate from user directory to dedicated appdata/.local dir.
123
124		:param oldfile: Path to old config file.
125		:type oldfile: str
126
127		:param newfile: Path to new config file.
128		:type newfile: str
129		"""
130	5	if os.path.exists(oldfile):
131	5	if os.path.exists(newfile):
132	5	os.remove(oldfile) # remove old
133		else:
134	5	shutil.move(oldfile, newfile) # migrate to new
135
136
137	5	def log_move(olddir, homepath):
138		"""
139		Migrate logs from user directory subfolder to dedicated appdata/.local dir.
140
141		:param olddir: Path to old log dir.
142		:type olddir: str
143
144		:param homepath: Path to new log directory.
145		:type homepath: str
146		"""
147	5	oldlogs = [os.path.join(olddir, logfile) for logfile in os.listdir(olddir)]
148	5	if oldlogs:
149	5	for log in oldlogs:
150	5	shutil.move(log, os.path.abspath(homepath))
151
152
153	5	def config_conffile(conffile):
154		"""
155		Create ini file if it doesn't exist.
156
157		:param conffile: Path to config ini file.
158		:type conffile: str
159		"""
160	5	if not os.path.exists(conffile):
161	5	open(conffile, 'w').close()
162
163
164	5	def config_location(homepath=None):
165		"""
166		Return config location.
167
168		:param homepath: Folder containing ini file. Default is user directory.
169		:type homepath: str
170		"""
171	5	homepath = config_homepath(homepath)
172	5	conffile = os.path.join(homepath, "bbarchivist.ini")
173	5	return conffile
174
175
176	5	def generic_preamble(section, homepath=None):
177		"""
178		Read a ConfigParser file, return whole config.
179
180		:param section: Section of ini file to return.
181		:type section: str
182
183		:param homepath: Folder containing ini file. Default is user directory.
184		:type homepath: str
185		"""
186	5	config = configparser.ConfigParser()
187	5	conffile = config_location(homepath)
188	5	config_conffile(conffile)
189	5	config.read(conffile)
190	5	config = config_emptysection(config, section)
191	5	return config
192
193
194	5	def generic_loader(section, homepath=None):
195		"""
196		Read a ConfigParser file, return section.
197
198		:param section: Section of ini file to return.
199		:type section: str
200
201		:param homepath: Folder containing ini file. Default is user directory.
202		:type homepath: str
203		"""
204	5	config = generic_preamble(section, homepath)
205	5	ini = config[section]
206	5	return ini
207
208
209	5	def generic_writer(section, resultdict, homepath=None):
210		"""
211		Write a ConfigParser file.
212
213		:param section: Section of ini file to write.
214		:type section: str
215
216		:param resultdict: Dictionary of configs: {key: value}
217		:type resultdict: dict({str, bool})
218
219		:param homepath: Folder containing ini file. Default is user directory.
220		:type homepath: str
221		"""
222	5	config = generic_preamble(section, homepath)
223	5	for key, value in resultdict.items():
224	5	config.set(section, key, str(value))
225	5	conffile = config_location(homepath)
226	5	with open(conffile, "w") as configfile:
227		config.write(configfile)
228

thurask / bbarchivist

Push — master ( a42aad...9def7b )

process_homepath() B

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing Dependencies

2. Missing __init__.py files

Duplication Side-by-Side

Filter issues like

2. Missing init.py files