store_settings() - Code Metrics - Inspection of "Refactor and polish" - michaeljoseph/changes - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#127)

by Michael

created 2017-11-12 12:03 UTC

store_settings() A

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1.125

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
cc	1
c	3
b	0
f	0
dl	0
loc	2
ccs	1
cts	2
cp	0.5
crap	1.125
rs	10

import io
import os
import sys
from os.path import exists, expanduser, expandvars, join, curdir
from pathlib import Path

import attr
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3
import click
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3
import inflection
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3
import toml
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3

from changes.models import BumpVersion
from changes import prompt
from .commands import info, note, debug

AUTH_TOKEN_ENVVAR = 'GITHUB_AUTH_TOKEN'

# via https://github.com/jakubroztocil/httpie/blob/6bdfc7a/httpie/config.py#L9
IS_WINDOWS = 'win32' in str(sys.platform).lower()
DEFAULT_CONFIG_FILE = str(os.environ.get(
    'CHANGES_CONFIG_FILE',
    expanduser('~/.changes') if not IS_WINDOWS else
    expandvars(r'%APPDATA%\\.changes')
))

PROJECT_CONFIG_FILE = '.changes.toml'
DEFAULT_RELEASES_DIRECTORY = 'docs/releases'


@attr.s
class Changes(object):
    auth_token = attr.ib()

    @classmethod
    def load(cls):
        tool_config_path = Path(str(os.environ.get(
            'CHANGES_CONFIG_FILE',
            expanduser('~/.changes') if not IS_WINDOWS else
            expandvars(r'%APPDATA%\\.changes')
        )))

        tool_settings = None
        if tool_config_path.exists():
            tool_settings = Changes(
                **(toml.load(tool_config_path.open())['changes'])
            )

        # envvar takes precedence over config file settings
        auth_token = os.environ.get(AUTH_TOKEN_ENVVAR)
        if auth_token:
            info('Found Github Auth Token in the environment')
            tool_settings = Changes(auth_token=auth_token)
        elif not (tool_settings and tool_settings.auth_token):
            while not auth_token:
                info('No auth token found, asking for it')
                # to interact with the Git*H*ub API
                note('You need a Github Auth Token for changes to create a release.')

                click.pause('Press [enter] to launch the GitHub "New personal access '

                            'token" page, to create a token for changes.')
                click.launch('https://github.com/settings/tokens/new')
                auth_token = click.prompt('Enter your changes token')

            if not tool_settings:
                tool_settings = Changes(auth_token=auth_token)

            tool_config_path.write_text(

                toml.dumps({
                    'changes': attr.asdict(tool_settings)
                })
            )

        return tool_settings


@attr.s
class Project(object):
    releases_directory = attr.ib()
    repository = attr.ib(default=None)
    bumpversion = attr.ib(default=None)
    labels = attr.ib(default=attr.Factory(dict))

    @classmethod
    def load(cls, repository):
        changes_project_config_path = Path(PROJECT_CONFIG_FILE)
        project_settings = None

        if changes_project_config_path.exists():
            # releases_directory, labels
            project_settings = Project(
                **(toml.load(changes_project_config_path.open())['changes'])
            )

        if not project_settings:
            releases_directory = Path(click.prompt(
                'Enter the directory to store your releases notes',
                DEFAULT_RELEASES_DIRECTORY,
                type=click.Path(exists=True, dir_okay=True)
            ))

            if not releases_directory.exists():
                debug('Releases directory {} not found, creating it.'.format(
                    releases_directory))
                releases_directory.mkdir(parents=True)

            project_settings = Project(
                releases_directory=str(releases_directory),
                labels=configure_labels(repository.labels),
            )
            # write config file
            changes_project_config_path.write_text(

                toml.dumps({
                    'changes': attr.asdict(project_settings)
                })
            )

        project_settings.repository = repository
        project_settings.bumpversion = BumpVersion.load(
            repository.latest_version)

        return project_settings


def configure_labels(github_labels):
    labels_keyed_by_name = {}
    for label in github_labels:
        labels_keyed_by_name[label['name']] = label

    # TODO: streamlined support for github defaults: enhancement, bug
    changelog_worthy_labels = prompt.choose_labels([
        properties['name']
        for _, properties in labels_keyed_by_name.items()
    ])

    # TODO: apply description transform in labels_prompt function
    described_labels = {}
    # auto-generate label descriptions
    for label_name in changelog_worthy_labels:
        label_properties = labels_keyed_by_name[label_name]
        # Auto-generate description as pluralised titlecase label name
        label_properties['description'] = inflection.pluralize(
            inflection.titleize(label_name)
        )

        described_labels[label_name] = label_properties

    return described_labels


# TODO: borg legacy
DEFAULTS = {
    'changelog': 'CHANGELOG.md',
    'readme': 'README.md',
    'github_auth_token': None,
}


class Config:
    """Deprecated"""
    test_command = None
    pypi = None
    skip_changelog = None
    changelog_content = None
    repo = None

    def __init__(self, module_name, dry_run, debug, no_input, requirements,
param = 5

class Foo:
    def __init__(self, param):   # "param" would be flagged here
        self.param = param
                 new_version, current_version, repo_url, version_prefix):
        self.module_name = module_name
        # module_name => project_name => curdir
        self.dry_run = dry_run
        self.debug = debug
        self.no_input = no_input
        self.requirements = requirements
        self.new_version = (
            version_prefix + new_version
            if version_prefix
            else new_version
        )
        self.current_version = current_version


def project_config():
    """Deprecated"""
    project_name = curdir

    config_path = Path(join(project_name, PROJECT_CONFIG_FILE))

    if not exists(config_path):
        store_settings(DEFAULTS.copy())
        return DEFAULTS

    return toml.load(io.open(config_path)) or {}


def store_settings(settings):
    pass


Pull Request — master (#127)

store_settings() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing Dependencies

2. Missing init.py files

1. Missing Dependencies

2. Missing init.py files

1. Missing Dependencies

2. Missing init.py files

1. Missing Dependencies

2. Missing init.py files

1	3	import io
2	3	import os
3	3	import sys
4	3	from os.path import exists, expanduser, expandvars, join, curdir
5	3	from pathlib import Path
6
7	3	import attr
		0 ignored issues – show Configuration introduced 2017-11-04 12:13 UTC by Report Bug Copy Issue Report The import `attr` 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...
8	3	import click
		0 ignored issues – show Configuration introduced 2017-11-04 12:13 UTC by Report Bug Copy Issue Report The import `click` 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	3	import inflection
		0 ignored issues – show Configuration introduced 2017-11-04 12:13 UTC by Report Bug Copy Issue Report The import `inflection` 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...
10	3	import toml
		0 ignored issues – show Configuration introduced 2017-11-04 12:13 UTC by Report Bug Copy Issue Report The import `toml` 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...
11
12	3	from changes.models import BumpVersion
13	3	from changes import prompt
14	3	from .commands import info, note, debug
15
16	3	AUTH_TOKEN_ENVVAR = 'GITHUB_AUTH_TOKEN'
17
18		# via https://github.com/jakubroztocil/httpie/blob/6bdfc7a/httpie/config.py#L9
19	3	IS_WINDOWS = 'win32' in str(sys.platform).lower()
20	3	DEFAULT_CONFIG_FILE = str(os.environ.get(
21		'CHANGES_CONFIG_FILE',
22		expanduser('~/.changes') if not IS_WINDOWS else
23		expandvars(r'%APPDATA%\\.changes')
24		))
25
26	3	PROJECT_CONFIG_FILE = '.changes.toml'
27	3	DEFAULT_RELEASES_DIRECTORY = 'docs/releases'
28
29
30	3	@attr.s
31	3	class Changes(object):
32	3	auth_token = attr.ib()
33
34	3	@classmethod
35		def load(cls):
36	3	tool_config_path = Path(str(os.environ.get(
37		'CHANGES_CONFIG_FILE',
38		expanduser('~/.changes') if not IS_WINDOWS else
39		expandvars(r'%APPDATA%\\.changes')
40		)))
41
42	3	tool_settings = None
43	3	if tool_config_path.exists():
44	3	tool_settings = Changes(
45		**(toml.load(tool_config_path.open())['changes'])
46		)
47
48		# envvar takes precedence over config file settings
49	3	auth_token = os.environ.get(AUTH_TOKEN_ENVVAR)
50	3	if auth_token:
51	3	info('Found Github Auth Token in the environment')
52	3	tool_settings = Changes(auth_token=auth_token)
53	3	elif not (tool_settings and tool_settings.auth_token):
54	3	while not auth_token:
55	3	info('No auth token found, asking for it')
56		# to interact with the GitHub API
57	3	note('You need a Github Auth Token for changes to create a release.')
		0 ignored issues – show Coding Style introduced 2017-10-18 06:53 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (85/79). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
58	3	click.pause('Press [enter] to launch the GitHub "New personal access '
		0 ignored issues – show Coding Style introduced 2017-10-18 06:53 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (86/79). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
59		'token" page, to create a token for changes.')
60	3	click.launch('https://github.com/settings/tokens/new')
61	3	auth_token = click.prompt('Enter your changes token')
62
63	3	if not tool_settings:
64	3	tool_settings = Changes(auth_token=auth_token)
65
66	3	tool_config_path.write_text(
		0 ignored issues – show Bug introduced 2017-10-18 06:53 UTC by Report Bug Copy Issue Report The Instance of `Path` does not seem to have a member named `write_text`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
67		toml.dumps({
68		'changes': attr.asdict(tool_settings)
69		})
70		)
71
72	3	return tool_settings
73
74
75	3	@attr.s
76	3	class Project(object):
77	3	releases_directory = attr.ib()
78	3	repository = attr.ib(default=None)
79	3	bumpversion = attr.ib(default=None)
80	3	labels = attr.ib(default=attr.Factory(dict))
81
82	3	@classmethod
83		def load(cls, repository):
84	3	changes_project_config_path = Path(PROJECT_CONFIG_FILE)
85	3	project_settings = None
86
87	3	if changes_project_config_path.exists():
88		# releases_directory, labels
89	3	project_settings = Project(
90		**(toml.load(changes_project_config_path.open())['changes'])
91		)
92
93	3	if not project_settings:
94	3	releases_directory = Path(click.prompt(
95		'Enter the directory to store your releases notes',
96		DEFAULT_RELEASES_DIRECTORY,
97		type=click.Path(exists=True, dir_okay=True)
98		))
99
100	3	if not releases_directory.exists():
101	3	debug('Releases directory {} not found, creating it.'.format(
102		releases_directory))
103	3	releases_directory.mkdir(parents=True)
104
105	3	project_settings = Project(
106		releases_directory=str(releases_directory),
107		labels=configure_labels(repository.labels),
108		)
109		# write config file
110	3	changes_project_config_path.write_text(
		0 ignored issues – show Bug introduced 2017-10-18 06:53 UTC by Report Bug Copy Issue Report The Instance of `Path` does not seem to have a member named `write_text`. This check looks for calls to members that are non-existent. These calls will fail. The member could have been renamed or removed. Loading history...
111		toml.dumps({
112		'changes': attr.asdict(project_settings)
113		})
114		)
115
116	3	project_settings.repository = repository
117	3	project_settings.bumpversion = BumpVersion.load(
118		repository.latest_version)
119
120	3	return project_settings
121
122
123	3	def configure_labels(github_labels):
124	3	labels_keyed_by_name = {}
125	3	for label in github_labels:
126	3	labels_keyed_by_name[label['name']] = label
127
128		# TODO: streamlined support for github defaults: enhancement, bug
129	3	changelog_worthy_labels = prompt.choose_labels([
130		properties['name']
131		for _, properties in labels_keyed_by_name.items()
132		])
133
134		# TODO: apply description transform in labels_prompt function
135	3	described_labels = {}
136		# auto-generate label descriptions
137	3	for label_name in changelog_worthy_labels:
138	3	label_properties = labels_keyed_by_name[label_name]
139		# Auto-generate description as pluralised titlecase label name
140	3	label_properties['description'] = inflection.pluralize(
141		inflection.titleize(label_name)
142		)
143
144	3	described_labels[label_name] = label_properties
145
146	3	return described_labels
147
148
149		# TODO: borg legacy
150	3	DEFAULTS = {
151		'changelog': 'CHANGELOG.md',
152		'readme': 'README.md',
153		'github_auth_token': None,
154		}
155
156
157	3	class Config:
158		"""Deprecated"""
159	3	test_command = None
160	3	pypi = None
161	3	skip_changelog = None
162	3	changelog_content = None
163	3	repo = None
164
165	3	def __init__(self, module_name, dry_run, debug, no_input, requirements,
		0 ignored issues – show Comprehensibility Bug introduced 2017-10-24 22:29 UTC by Report Bug Copy Issue Report `debug` is re-defining a name which is already available in the outer-scope (previously defined on line `14`). 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...
166		new_version, current_version, repo_url, version_prefix):
167	3	self.module_name = module_name
168		# module_name => project_name => curdir
169	3	self.dry_run = dry_run
170	3	self.debug = debug
171	3	self.no_input = no_input
172	3	self.requirements = requirements
173	3	self.new_version = (
174		version_prefix + new_version
175		if version_prefix
176		else new_version
177		)
178	3	self.current_version = current_version
179
180
181	3	def project_config():
182		"""Deprecated"""
183		project_name = curdir
184
185		config_path = Path(join(project_name, PROJECT_CONFIG_FILE))
186
187		if not exists(config_path):
188		store_settings(DEFAULTS.copy())
189		return DEFAULTS
190
191		return toml.load(io.open(config_path)) or {}
192
193
194	3	def store_settings(settings):
195		pass
196

michaeljoseph / changes

Pull Request — master (#127)

store_settings() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing Dependencies

2. Missing __init__.py files

1. Missing Dependencies

2. Missing __init__.py files

1. Missing Dependencies

2. Missing __init__.py files

1. Missing Dependencies

2. Missing __init__.py files

Duplication Side-by-Side

Filter issues like

2. Missing init.py files

2. Missing init.py files

2. Missing init.py files

2. Missing init.py files