Source.update_files() - Code Metrics - Inspection of "Fail sooner when an invalid repository is detected" - jacebrowning/gitman - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#144)

by Jace

created 2017-01-11 18:50 UTC

Source.update_files() C

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	7.2694

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	7
c	2
b	0
f	0
dl	0
loc	30
ccs	14
cts	17
cp	0.8235
crap	7.2694
rs	5.5

"""Wrappers for the dependency configuration files."""

import os
import logging
import warnings

import yorm
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3
from yorm.types import String, AttributeDictionary
# .scrutinizer.yml
before_commands:
    - sudo pip install abc # Python2
    - sudo pip3 install abc # Python3

from .. import common
from .. import git
from .. import shell
from ..exceptions import InvalidConfig, InvalidRepository, UncommittedChanges


log = logging.getLogger(__name__)



@yorm.attr(name=String)
@yorm.attr(link=String)
@yorm.attr(repo=String)
@yorm.attr(rev=String)
class Source(AttributeDictionary):
    """A dictionary of `git` and `ln` arguments."""

    DIRTY = '<dirty>'
    UNKNOWN = '<unknown>'

    def __init__(self, repo, name, rev='master', link=None):
        super().__init__()
        self.repo = repo
        self.name = name
        self.rev = rev
        self.link = link
        if not self.repo:
            raise InvalidConfig("'repo' missing on {}".format(repr(self)))
        if not self.name:
            raise InvalidConfig("'name' missing on {}".format(repr(self)))

    def __repr__(self):
        return "<source {}>".format(self)

    def __str__(self):
        pattern = "'{r}' @ '{v}' in '{d}'"
        if self.link:
            pattern += " <- '{s}'"
        return pattern.format(r=self.repo, v=self.rev, d=self.name, s=self.link)

    def __eq__(self, other):
        return self.name == other.name

    def __ne__(self, other):
        return self.name != other.name

    def __lt__(self, other):
        return self.name < other.name

    def update_files(self, force=False, fetch=False, clean=True):
        """Ensure the source matches the specified revision."""
        log.info("Updating source files...")

        # Clone the repository if needed
        if not os.path.exists(self.name):
            log.debug("Creating a new repository...")
            git.clone(self.repo, self.name)

        # Enter the working tree
        shell.cd(self.name)
        if not git.valid():
            raise self._invalid_repository

        # Check for uncommitted changes
        if not force:
            log.debug("Confirming there are no uncommitted changes...")
            if git.changes(include_untracked=clean):
                common.show()
                msg = "Uncommitted changes in {}".format(os.getcwd())
                raise UncommittedChanges(msg)

        # Fetch the desired revision
        if fetch or self.rev not in (git.get_branch(),
                                     git.get_hash(),
                                     git.get_tag()):
            git.fetch(self.repo, self.rev)

        # Update the working tree to the desired revision
        git.update(self.rev, fetch=fetch, clean=clean)

    def create_link(self, root, force=False):
        """Create a link from the target name to the current directory."""
        if not self.link:
            return

        log.info("Creating a symbolic link...")

        if os.name == 'nt':
            warnings.warn("Symbolic links are not supported on Windows")
            return

        target = os.path.join(root, self.link)
        source = os.path.relpath(os.getcwd(), os.path.dirname(target))

        if os.path.islink(target):
            os.remove(target)
        elif os.path.exists(target):
            if force:
                shell.rm(target)
            else:
                common.show()
                msg = "Preexisting link location at {}".format(target)
                raise UncommittedChanges(msg)

        shell.ln(source, target)

    def identify(self, allow_dirty=True, allow_missing=True):
        """Get the path and current repository URL and hash."""
        if os.path.isdir(self.name):

            shell.cd(self.name)
            if not git.valid():
                raise self._invalid_repository

            path = os.getcwd()
            url = git.get_url()
            if git.changes(display_status=not allow_dirty, _show=True):
                if not allow_dirty:
                    common.show()
                    msg = "Uncommitted changes in {}".format(os.getcwd())
                    raise UncommittedChanges(msg)

                common.show(self.DIRTY, color='dirty', log=False)
                return path, url, self.DIRTY
            else:
                revision = git.get_hash(_show=True)
                common.show(revision, color='revision', log=False)
                return path, url, revision

        elif allow_missing:

            return os.getcwd(), '<missing>', self.UNKNOWN

        else:

            raise self._invalid_repository

    def lock(self):
        """Return a locked version of the current source."""
        _, _, revision = self.identify(allow_dirty=False, allow_missing=False)
        source = self.__class__(self.repo, self.name, revision, self.link)
        return source

    @property
    def _invalid_repository(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        path = os.path.join(os.getcwd(), self.name)
        msg = "Not a valid repository: {}".format(path)
        return InvalidRepository(msg)


1		"""Wrappers for the dependency configuration files."""
2
3	1	import os
4	1	import logging
5	1	import warnings
6
7	1	import yorm
		0 ignored issues – show Configuration introduced 2016-03-14 20:50 UTC by Report Bug Copy Issue Report The import `yorm` 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	1	from yorm.types import String, AttributeDictionary
		0 ignored issues – show Configuration introduced 2016-03-31 00:54 UTC by Report Bug Copy Issue Report The import `yorm.types` 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	1	from .. import common
11	1	from .. import git
12	1	from .. import shell
13	1	from ..exceptions import InvalidConfig, InvalidRepository, UncommittedChanges
14
15
16	1	log = logging.getLogger(__name__)
		0 ignored issues – show Coding Style Naming introduced 2016-04-22 01:39 UTC by Report Bug Copy Issue Report The name `log` does not conform to the constant naming conventions (`(([A-Z_][A-Z0-9_])\|(__.__))$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
17
18
19	1	@yorm.attr(name=String)
20	1	@yorm.attr(link=String)
21	1	@yorm.attr(repo=String)
22	1	@yorm.attr(rev=String)
23	1	class Source(AttributeDictionary):
24		"""A dictionary of `git` and `ln` arguments."""
25
26	1	DIRTY = '<dirty>'
27	1	UNKNOWN = '<unknown>'
28
29	1	def __init__(self, repo, name, rev='master', link=None):
30	1	super().__init__()
31	1	self.repo = repo
32	1	self.name = name
33	1	self.rev = rev
34	1	self.link = link
35	1	if not self.repo:
36	1	raise InvalidConfig("'repo' missing on {}".format(repr(self)))
37	1	if not self.name:
38	1	raise InvalidConfig("'name' missing on {}".format(repr(self)))
39
40	1	def __repr__(self):
41	1	return "<source {}>".format(self)
42
43	1	def __str__(self):
44	1	pattern = "'{r}' @ '{v}' in '{d}'"
45	1	if self.link:
46	1	pattern += " <- '{s}'"
47	1	return pattern.format(r=self.repo, v=self.rev, d=self.name, s=self.link)
48
49	1	def __eq__(self, other):
50	1	return self.name == other.name
51
52	1	def __ne__(self, other):
53	1	return self.name != other.name
54
55	1	def __lt__(self, other):
56	1	return self.name < other.name
57
58	1	def update_files(self, force=False, fetch=False, clean=True):
59		"""Ensure the source matches the specified revision."""
60	1	log.info("Updating source files...")
61
62		# Clone the repository if needed
63	1	if not os.path.exists(self.name):
64	1	log.debug("Creating a new repository...")
65	1	git.clone(self.repo, self.name)
66
67		# Enter the working tree
68	1	shell.cd(self.name)
69	1	if not git.valid():
70	1	raise self._invalid_repository
71
72		# Check for uncommitted changes
73	1	if not force:
74	1	log.debug("Confirming there are no uncommitted changes...")
75	1	if git.changes(include_untracked=clean):
76		common.show()
77		msg = "Uncommitted changes in {}".format(os.getcwd())
78		raise UncommittedChanges(msg)
79
80		# Fetch the desired revision
81	1	if fetch or self.rev not in (git.get_branch(),
82		git.get_hash(),
83		git.get_tag()):
84	1	git.fetch(self.repo, self.rev)
85
86		# Update the working tree to the desired revision
87	1	git.update(self.rev, fetch=fetch, clean=clean)
88
89	1	def create_link(self, root, force=False):
90		"""Create a link from the target name to the current directory."""
91	1	if not self.link:
92	1	return
93
94	1	log.info("Creating a symbolic link...")
95
96	1	if os.name == 'nt':
97		warnings.warn("Symbolic links are not supported on Windows")
98		return
99
100	1	target = os.path.join(root, self.link)
101	1	source = os.path.relpath(os.getcwd(), os.path.dirname(target))
102
103	1	if os.path.islink(target):
104	1	os.remove(target)
105	1	elif os.path.exists(target):
106	1	if force:
107	1	shell.rm(target)
108		else:
109	1	common.show()
110	1	msg = "Preexisting link location at {}".format(target)
111	1	raise UncommittedChanges(msg)
112
113	1	shell.ln(source, target)
114
115	1	def identify(self, allow_dirty=True, allow_missing=True):
116		"""Get the path and current repository URL and hash."""
117	1	if os.path.isdir(self.name):
118
119	1	shell.cd(self.name)
120	1	if not git.valid():
121	1	raise self._invalid_repository
122
123	1	path = os.getcwd()
124	1	url = git.get_url()
125	1	if git.changes(display_status=not allow_dirty, _show=True):
126	1	if not allow_dirty:
127	1	common.show()
128	1	msg = "Uncommitted changes in {}".format(os.getcwd())
129	1	raise UncommittedChanges(msg)
130
131		common.show(self.DIRTY, color='dirty', log=False)
132		return path, url, self.DIRTY
133		else:
134	1	revision = git.get_hash(_show=True)
135	1	common.show(revision, color='revision', log=False)
136	1	return path, url, revision
137
138	1	elif allow_missing:
139
140	1	return os.getcwd(), '<missing>', self.UNKNOWN
141
142		else:
143
144	1	raise self._invalid_repository
145
146	1	def lock(self):
147		"""Return a locked version of the current source."""
148	1	_, _, revision = self.identify(allow_dirty=False, allow_missing=False)
149	1	source = self.__class__(self.repo, self.name, revision, self.link)
150	1	return source
151
152	1	@property
153		def _invalid_repository(self):
		0 ignored issues – show Coding Style introduced 2017-01-11 18:37 UTC by Report Bug Copy Issue Report This method should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
154	1	path = os.path.join(os.getcwd(), self.name)
155	1	msg = "Not a valid repository: {}".format(path)
156		return InvalidRepository(msg)
157

Pull Request — develop (#144)

Source.update_files() C

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing Dependencies

2. Missing init.py files

1. Missing Dependencies

2. Missing init.py files

jacebrowning / gitman

Pull Request — develop (#144)

Source.update_files() C

Complexity

Size

Duplication

Code Coverage

Importance

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